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

v1_json.tmpl 651KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "https",
  12. "http"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "{{AppVer | JSEscape}}"
  23. },
  24. "basePath": "{{AppSubUrl | JSEscape}}/api/v1",
  25. "paths": {
  26. "/activitypub/user-id/{user-id}": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "activitypub"
  33. ],
  34. "summary": "Returns the Person actor for a user",
  35. "operationId": "activitypubPerson",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "user ID of the user",
  40. "name": "user-id",
  41. "in": "path",
  42. "required": true
  43. }
  44. ],
  45. "responses": {
  46. "200": {
  47. "$ref": "#/responses/ActivityPub"
  48. }
  49. }
  50. }
  51. },
  52. "/activitypub/user-id/{user-id}/inbox": {
  53. "post": {
  54. "produces": [
  55. "application/json"
  56. ],
  57. "tags": [
  58. "activitypub"
  59. ],
  60. "summary": "Send to the inbox",
  61. "operationId": "activitypubPersonInbox",
  62. "parameters": [
  63. {
  64. "type": "integer",
  65. "description": "user ID of the user",
  66. "name": "user-id",
  67. "in": "path",
  68. "required": true
  69. }
  70. ],
  71. "responses": {
  72. "204": {
  73. "$ref": "#/responses/empty"
  74. }
  75. }
  76. }
  77. },
  78. "/admin/cron": {
  79. "get": {
  80. "produces": [
  81. "application/json"
  82. ],
  83. "tags": [
  84. "admin"
  85. ],
  86. "summary": "List cron tasks",
  87. "operationId": "adminCronList",
  88. "parameters": [
  89. {
  90. "type": "integer",
  91. "description": "page number of results to return (1-based)",
  92. "name": "page",
  93. "in": "query"
  94. },
  95. {
  96. "type": "integer",
  97. "description": "page size of results",
  98. "name": "limit",
  99. "in": "query"
  100. }
  101. ],
  102. "responses": {
  103. "200": {
  104. "$ref": "#/responses/CronList"
  105. },
  106. "403": {
  107. "$ref": "#/responses/forbidden"
  108. }
  109. }
  110. }
  111. },
  112. "/admin/cron/{task}": {
  113. "post": {
  114. "produces": [
  115. "application/json"
  116. ],
  117. "tags": [
  118. "admin"
  119. ],
  120. "summary": "Run cron task",
  121. "operationId": "adminCronRun",
  122. "parameters": [
  123. {
  124. "type": "string",
  125. "description": "task to run",
  126. "name": "task",
  127. "in": "path",
  128. "required": true
  129. }
  130. ],
  131. "responses": {
  132. "204": {
  133. "$ref": "#/responses/empty"
  134. },
  135. "404": {
  136. "$ref": "#/responses/notFound"
  137. }
  138. }
  139. }
  140. },
  141. "/admin/emails": {
  142. "get": {
  143. "produces": [
  144. "application/json"
  145. ],
  146. "tags": [
  147. "admin"
  148. ],
  149. "summary": "List all emails",
  150. "operationId": "adminGetAllEmails",
  151. "parameters": [
  152. {
  153. "type": "integer",
  154. "description": "page number of results to return (1-based)",
  155. "name": "page",
  156. "in": "query"
  157. },
  158. {
  159. "type": "integer",
  160. "description": "page size of results",
  161. "name": "limit",
  162. "in": "query"
  163. }
  164. ],
  165. "responses": {
  166. "200": {
  167. "$ref": "#/responses/EmailList"
  168. },
  169. "403": {
  170. "$ref": "#/responses/forbidden"
  171. }
  172. }
  173. }
  174. },
  175. "/admin/emails/search": {
  176. "get": {
  177. "produces": [
  178. "application/json"
  179. ],
  180. "tags": [
  181. "admin"
  182. ],
  183. "summary": "Search all emails",
  184. "operationId": "adminSearchEmails",
  185. "parameters": [
  186. {
  187. "type": "string",
  188. "description": "keyword",
  189. "name": "q",
  190. "in": "query"
  191. },
  192. {
  193. "type": "integer",
  194. "description": "page number of results to return (1-based)",
  195. "name": "page",
  196. "in": "query"
  197. },
  198. {
  199. "type": "integer",
  200. "description": "page size of results",
  201. "name": "limit",
  202. "in": "query"
  203. }
  204. ],
  205. "responses": {
  206. "200": {
  207. "$ref": "#/responses/EmailList"
  208. },
  209. "403": {
  210. "$ref": "#/responses/forbidden"
  211. }
  212. }
  213. }
  214. },
  215. "/admin/hooks": {
  216. "get": {
  217. "produces": [
  218. "application/json"
  219. ],
  220. "tags": [
  221. "admin"
  222. ],
  223. "summary": "List system's webhooks",
  224. "operationId": "adminListHooks",
  225. "parameters": [
  226. {
  227. "type": "integer",
  228. "description": "page number of results to return (1-based)",
  229. "name": "page",
  230. "in": "query"
  231. },
  232. {
  233. "type": "integer",
  234. "description": "page size of results",
  235. "name": "limit",
  236. "in": "query"
  237. }
  238. ],
  239. "responses": {
  240. "200": {
  241. "$ref": "#/responses/HookList"
  242. }
  243. }
  244. },
  245. "post": {
  246. "consumes": [
  247. "application/json"
  248. ],
  249. "produces": [
  250. "application/json"
  251. ],
  252. "tags": [
  253. "admin"
  254. ],
  255. "summary": "Create a hook",
  256. "operationId": "adminCreateHook",
  257. "parameters": [
  258. {
  259. "name": "body",
  260. "in": "body",
  261. "required": true,
  262. "schema": {
  263. "$ref": "#/definitions/CreateHookOption"
  264. }
  265. }
  266. ],
  267. "responses": {
  268. "201": {
  269. "$ref": "#/responses/Hook"
  270. }
  271. }
  272. }
  273. },
  274. "/admin/hooks/{id}": {
  275. "get": {
  276. "produces": [
  277. "application/json"
  278. ],
  279. "tags": [
  280. "admin"
  281. ],
  282. "summary": "Get a hook",
  283. "operationId": "adminGetHook",
  284. "parameters": [
  285. {
  286. "type": "integer",
  287. "format": "int64",
  288. "description": "id of the hook to get",
  289. "name": "id",
  290. "in": "path",
  291. "required": true
  292. }
  293. ],
  294. "responses": {
  295. "200": {
  296. "$ref": "#/responses/Hook"
  297. }
  298. }
  299. },
  300. "delete": {
  301. "produces": [
  302. "application/json"
  303. ],
  304. "tags": [
  305. "admin"
  306. ],
  307. "summary": "Delete a hook",
  308. "operationId": "adminDeleteHook",
  309. "parameters": [
  310. {
  311. "type": "integer",
  312. "format": "int64",
  313. "description": "id of the hook to delete",
  314. "name": "id",
  315. "in": "path",
  316. "required": true
  317. }
  318. ],
  319. "responses": {
  320. "204": {
  321. "$ref": "#/responses/empty"
  322. }
  323. }
  324. },
  325. "patch": {
  326. "consumes": [
  327. "application/json"
  328. ],
  329. "produces": [
  330. "application/json"
  331. ],
  332. "tags": [
  333. "admin"
  334. ],
  335. "summary": "Update a hook",
  336. "operationId": "adminEditHook",
  337. "parameters": [
  338. {
  339. "type": "integer",
  340. "format": "int64",
  341. "description": "id of the hook to update",
  342. "name": "id",
  343. "in": "path",
  344. "required": true
  345. },
  346. {
  347. "name": "body",
  348. "in": "body",
  349. "schema": {
  350. "$ref": "#/definitions/EditHookOption"
  351. }
  352. }
  353. ],
  354. "responses": {
  355. "200": {
  356. "$ref": "#/responses/Hook"
  357. }
  358. }
  359. }
  360. },
  361. "/admin/orgs": {
  362. "get": {
  363. "produces": [
  364. "application/json"
  365. ],
  366. "tags": [
  367. "admin"
  368. ],
  369. "summary": "List all organizations",
  370. "operationId": "adminGetAllOrgs",
  371. "parameters": [
  372. {
  373. "type": "integer",
  374. "description": "page number of results to return (1-based)",
  375. "name": "page",
  376. "in": "query"
  377. },
  378. {
  379. "type": "integer",
  380. "description": "page size of results",
  381. "name": "limit",
  382. "in": "query"
  383. }
  384. ],
  385. "responses": {
  386. "200": {
  387. "$ref": "#/responses/OrganizationList"
  388. },
  389. "403": {
  390. "$ref": "#/responses/forbidden"
  391. }
  392. }
  393. }
  394. },
  395. "/admin/runners/registration-token": {
  396. "get": {
  397. "produces": [
  398. "application/json"
  399. ],
  400. "tags": [
  401. "admin"
  402. ],
  403. "summary": "Get an global actions runner registration token",
  404. "operationId": "adminGetRunnerRegistrationToken",
  405. "responses": {
  406. "200": {
  407. "$ref": "#/responses/RegistrationToken"
  408. }
  409. }
  410. }
  411. },
  412. "/admin/unadopted": {
  413. "get": {
  414. "produces": [
  415. "application/json"
  416. ],
  417. "tags": [
  418. "admin"
  419. ],
  420. "summary": "List unadopted repositories",
  421. "operationId": "adminUnadoptedList",
  422. "parameters": [
  423. {
  424. "type": "integer",
  425. "description": "page number of results to return (1-based)",
  426. "name": "page",
  427. "in": "query"
  428. },
  429. {
  430. "type": "integer",
  431. "description": "page size of results",
  432. "name": "limit",
  433. "in": "query"
  434. },
  435. {
  436. "type": "string",
  437. "description": "pattern of repositories to search for",
  438. "name": "pattern",
  439. "in": "query"
  440. }
  441. ],
  442. "responses": {
  443. "200": {
  444. "$ref": "#/responses/StringSlice"
  445. },
  446. "403": {
  447. "$ref": "#/responses/forbidden"
  448. }
  449. }
  450. }
  451. },
  452. "/admin/unadopted/{owner}/{repo}": {
  453. "post": {
  454. "produces": [
  455. "application/json"
  456. ],
  457. "tags": [
  458. "admin"
  459. ],
  460. "summary": "Adopt unadopted files as a repository",
  461. "operationId": "adminAdoptRepository",
  462. "parameters": [
  463. {
  464. "type": "string",
  465. "description": "owner of the repo",
  466. "name": "owner",
  467. "in": "path",
  468. "required": true
  469. },
  470. {
  471. "type": "string",
  472. "description": "name of the repo",
  473. "name": "repo",
  474. "in": "path",
  475. "required": true
  476. }
  477. ],
  478. "responses": {
  479. "204": {
  480. "$ref": "#/responses/empty"
  481. },
  482. "403": {
  483. "$ref": "#/responses/forbidden"
  484. },
  485. "404": {
  486. "$ref": "#/responses/notFound"
  487. }
  488. }
  489. },
  490. "delete": {
  491. "produces": [
  492. "application/json"
  493. ],
  494. "tags": [
  495. "admin"
  496. ],
  497. "summary": "Delete unadopted files",
  498. "operationId": "adminDeleteUnadoptedRepository",
  499. "parameters": [
  500. {
  501. "type": "string",
  502. "description": "owner of the repo",
  503. "name": "owner",
  504. "in": "path",
  505. "required": true
  506. },
  507. {
  508. "type": "string",
  509. "description": "name of the repo",
  510. "name": "repo",
  511. "in": "path",
  512. "required": true
  513. }
  514. ],
  515. "responses": {
  516. "204": {
  517. "$ref": "#/responses/empty"
  518. },
  519. "403": {
  520. "$ref": "#/responses/forbidden"
  521. }
  522. }
  523. }
  524. },
  525. "/admin/users": {
  526. "get": {
  527. "produces": [
  528. "application/json"
  529. ],
  530. "tags": [
  531. "admin"
  532. ],
  533. "summary": "Search users according filter conditions",
  534. "operationId": "adminSearchUsers",
  535. "parameters": [
  536. {
  537. "type": "integer",
  538. "format": "int64",
  539. "description": "ID of the user's login source to search for",
  540. "name": "source_id",
  541. "in": "query"
  542. },
  543. {
  544. "type": "string",
  545. "description": "user's login name to search for",
  546. "name": "login_name",
  547. "in": "query"
  548. },
  549. {
  550. "type": "integer",
  551. "description": "page number of results to return (1-based)",
  552. "name": "page",
  553. "in": "query"
  554. },
  555. {
  556. "type": "integer",
  557. "description": "page size of results",
  558. "name": "limit",
  559. "in": "query"
  560. }
  561. ],
  562. "responses": {
  563. "200": {
  564. "$ref": "#/responses/UserList"
  565. },
  566. "403": {
  567. "$ref": "#/responses/forbidden"
  568. }
  569. }
  570. },
  571. "post": {
  572. "consumes": [
  573. "application/json"
  574. ],
  575. "produces": [
  576. "application/json"
  577. ],
  578. "tags": [
  579. "admin"
  580. ],
  581. "summary": "Create a user",
  582. "operationId": "adminCreateUser",
  583. "parameters": [
  584. {
  585. "name": "body",
  586. "in": "body",
  587. "schema": {
  588. "$ref": "#/definitions/CreateUserOption"
  589. }
  590. }
  591. ],
  592. "responses": {
  593. "201": {
  594. "$ref": "#/responses/User"
  595. },
  596. "400": {
  597. "$ref": "#/responses/error"
  598. },
  599. "403": {
  600. "$ref": "#/responses/forbidden"
  601. },
  602. "422": {
  603. "$ref": "#/responses/validationError"
  604. }
  605. }
  606. }
  607. },
  608. "/admin/users/{username}": {
  609. "delete": {
  610. "produces": [
  611. "application/json"
  612. ],
  613. "tags": [
  614. "admin"
  615. ],
  616. "summary": "Delete a user",
  617. "operationId": "adminDeleteUser",
  618. "parameters": [
  619. {
  620. "type": "string",
  621. "description": "username of user to delete",
  622. "name": "username",
  623. "in": "path",
  624. "required": true
  625. },
  626. {
  627. "type": "boolean",
  628. "description": "purge the user from the system completely",
  629. "name": "purge",
  630. "in": "query"
  631. }
  632. ],
  633. "responses": {
  634. "204": {
  635. "$ref": "#/responses/empty"
  636. },
  637. "403": {
  638. "$ref": "#/responses/forbidden"
  639. },
  640. "404": {
  641. "$ref": "#/responses/notFound"
  642. },
  643. "422": {
  644. "$ref": "#/responses/validationError"
  645. }
  646. }
  647. },
  648. "patch": {
  649. "consumes": [
  650. "application/json"
  651. ],
  652. "produces": [
  653. "application/json"
  654. ],
  655. "tags": [
  656. "admin"
  657. ],
  658. "summary": "Edit an existing user",
  659. "operationId": "adminEditUser",
  660. "parameters": [
  661. {
  662. "type": "string",
  663. "description": "username of user to edit",
  664. "name": "username",
  665. "in": "path",
  666. "required": true
  667. },
  668. {
  669. "name": "body",
  670. "in": "body",
  671. "schema": {
  672. "$ref": "#/definitions/EditUserOption"
  673. }
  674. }
  675. ],
  676. "responses": {
  677. "200": {
  678. "$ref": "#/responses/User"
  679. },
  680. "400": {
  681. "$ref": "#/responses/error"
  682. },
  683. "403": {
  684. "$ref": "#/responses/forbidden"
  685. },
  686. "422": {
  687. "$ref": "#/responses/validationError"
  688. }
  689. }
  690. }
  691. },
  692. "/admin/users/{username}/badges": {
  693. "get": {
  694. "produces": [
  695. "application/json"
  696. ],
  697. "tags": [
  698. "admin"
  699. ],
  700. "summary": "List a user's badges",
  701. "operationId": "adminListUserBadges",
  702. "parameters": [
  703. {
  704. "type": "string",
  705. "description": "username of user",
  706. "name": "username",
  707. "in": "path",
  708. "required": true
  709. }
  710. ],
  711. "responses": {
  712. "200": {
  713. "$ref": "#/responses/BadgeList"
  714. },
  715. "404": {
  716. "$ref": "#/responses/notFound"
  717. }
  718. }
  719. },
  720. "post": {
  721. "consumes": [
  722. "application/json"
  723. ],
  724. "produces": [
  725. "application/json"
  726. ],
  727. "tags": [
  728. "admin"
  729. ],
  730. "summary": "Add a badge to a user",
  731. "operationId": "adminAddUserBadges",
  732. "parameters": [
  733. {
  734. "type": "string",
  735. "description": "username of user",
  736. "name": "username",
  737. "in": "path",
  738. "required": true
  739. },
  740. {
  741. "name": "body",
  742. "in": "body",
  743. "schema": {
  744. "$ref": "#/definitions/UserBadgeOption"
  745. }
  746. }
  747. ],
  748. "responses": {
  749. "204": {
  750. "$ref": "#/responses/empty"
  751. },
  752. "403": {
  753. "$ref": "#/responses/forbidden"
  754. }
  755. }
  756. },
  757. "delete": {
  758. "produces": [
  759. "application/json"
  760. ],
  761. "tags": [
  762. "admin"
  763. ],
  764. "summary": "Remove a badge from a user",
  765. "operationId": "adminDeleteUserBadges",
  766. "parameters": [
  767. {
  768. "type": "string",
  769. "description": "username of user",
  770. "name": "username",
  771. "in": "path",
  772. "required": true
  773. },
  774. {
  775. "name": "body",
  776. "in": "body",
  777. "schema": {
  778. "$ref": "#/definitions/UserBadgeOption"
  779. }
  780. }
  781. ],
  782. "responses": {
  783. "204": {
  784. "$ref": "#/responses/empty"
  785. },
  786. "403": {
  787. "$ref": "#/responses/forbidden"
  788. },
  789. "422": {
  790. "$ref": "#/responses/validationError"
  791. }
  792. }
  793. }
  794. },
  795. "/admin/users/{username}/keys": {
  796. "post": {
  797. "consumes": [
  798. "application/json"
  799. ],
  800. "produces": [
  801. "application/json"
  802. ],
  803. "tags": [
  804. "admin"
  805. ],
  806. "summary": "Add a public key on behalf of a user",
  807. "operationId": "adminCreatePublicKey",
  808. "parameters": [
  809. {
  810. "type": "string",
  811. "description": "username of the user",
  812. "name": "username",
  813. "in": "path",
  814. "required": true
  815. },
  816. {
  817. "name": "key",
  818. "in": "body",
  819. "schema": {
  820. "$ref": "#/definitions/CreateKeyOption"
  821. }
  822. }
  823. ],
  824. "responses": {
  825. "201": {
  826. "$ref": "#/responses/PublicKey"
  827. },
  828. "403": {
  829. "$ref": "#/responses/forbidden"
  830. },
  831. "422": {
  832. "$ref": "#/responses/validationError"
  833. }
  834. }
  835. }
  836. },
  837. "/admin/users/{username}/keys/{id}": {
  838. "delete": {
  839. "produces": [
  840. "application/json"
  841. ],
  842. "tags": [
  843. "admin"
  844. ],
  845. "summary": "Delete a user's public key",
  846. "operationId": "adminDeleteUserPublicKey",
  847. "parameters": [
  848. {
  849. "type": "string",
  850. "description": "username of user",
  851. "name": "username",
  852. "in": "path",
  853. "required": true
  854. },
  855. {
  856. "type": "integer",
  857. "format": "int64",
  858. "description": "id of the key to delete",
  859. "name": "id",
  860. "in": "path",
  861. "required": true
  862. }
  863. ],
  864. "responses": {
  865. "204": {
  866. "$ref": "#/responses/empty"
  867. },
  868. "403": {
  869. "$ref": "#/responses/forbidden"
  870. },
  871. "404": {
  872. "$ref": "#/responses/notFound"
  873. }
  874. }
  875. }
  876. },
  877. "/admin/users/{username}/orgs": {
  878. "post": {
  879. "consumes": [
  880. "application/json"
  881. ],
  882. "produces": [
  883. "application/json"
  884. ],
  885. "tags": [
  886. "admin"
  887. ],
  888. "summary": "Create an organization",
  889. "operationId": "adminCreateOrg",
  890. "parameters": [
  891. {
  892. "type": "string",
  893. "description": "username of the user that will own the created organization",
  894. "name": "username",
  895. "in": "path",
  896. "required": true
  897. },
  898. {
  899. "name": "organization",
  900. "in": "body",
  901. "required": true,
  902. "schema": {
  903. "$ref": "#/definitions/CreateOrgOption"
  904. }
  905. }
  906. ],
  907. "responses": {
  908. "201": {
  909. "$ref": "#/responses/Organization"
  910. },
  911. "403": {
  912. "$ref": "#/responses/forbidden"
  913. },
  914. "422": {
  915. "$ref": "#/responses/validationError"
  916. }
  917. }
  918. }
  919. },
  920. "/admin/users/{username}/rename": {
  921. "post": {
  922. "produces": [
  923. "application/json"
  924. ],
  925. "tags": [
  926. "admin"
  927. ],
  928. "summary": "Rename a user",
  929. "operationId": "adminRenameUser",
  930. "parameters": [
  931. {
  932. "type": "string",
  933. "description": "existing username of user",
  934. "name": "username",
  935. "in": "path",
  936. "required": true
  937. },
  938. {
  939. "name": "body",
  940. "in": "body",
  941. "required": true,
  942. "schema": {
  943. "$ref": "#/definitions/RenameUserOption"
  944. }
  945. }
  946. ],
  947. "responses": {
  948. "204": {
  949. "$ref": "#/responses/empty"
  950. },
  951. "403": {
  952. "$ref": "#/responses/forbidden"
  953. },
  954. "422": {
  955. "$ref": "#/responses/validationError"
  956. }
  957. }
  958. }
  959. },
  960. "/admin/users/{username}/repos": {
  961. "post": {
  962. "consumes": [
  963. "application/json"
  964. ],
  965. "produces": [
  966. "application/json"
  967. ],
  968. "tags": [
  969. "admin"
  970. ],
  971. "summary": "Create a repository on behalf of a user",
  972. "operationId": "adminCreateRepo",
  973. "parameters": [
  974. {
  975. "type": "string",
  976. "description": "username of the user. This user will own the created repository",
  977. "name": "username",
  978. "in": "path",
  979. "required": true
  980. },
  981. {
  982. "name": "repository",
  983. "in": "body",
  984. "required": true,
  985. "schema": {
  986. "$ref": "#/definitions/CreateRepoOption"
  987. }
  988. }
  989. ],
  990. "responses": {
  991. "201": {
  992. "$ref": "#/responses/Repository"
  993. },
  994. "400": {
  995. "$ref": "#/responses/error"
  996. },
  997. "403": {
  998. "$ref": "#/responses/forbidden"
  999. },
  1000. "404": {
  1001. "$ref": "#/responses/notFound"
  1002. },
  1003. "409": {
  1004. "$ref": "#/responses/error"
  1005. },
  1006. "422": {
  1007. "$ref": "#/responses/validationError"
  1008. }
  1009. }
  1010. }
  1011. },
  1012. "/gitignore/templates": {
  1013. "get": {
  1014. "produces": [
  1015. "application/json"
  1016. ],
  1017. "tags": [
  1018. "miscellaneous"
  1019. ],
  1020. "summary": "Returns a list of all gitignore templates",
  1021. "operationId": "listGitignoresTemplates",
  1022. "responses": {
  1023. "200": {
  1024. "$ref": "#/responses/GitignoreTemplateList"
  1025. }
  1026. }
  1027. }
  1028. },
  1029. "/gitignore/templates/{name}": {
  1030. "get": {
  1031. "produces": [
  1032. "application/json"
  1033. ],
  1034. "tags": [
  1035. "miscellaneous"
  1036. ],
  1037. "summary": "Returns information about a gitignore template",
  1038. "operationId": "getGitignoreTemplateInfo",
  1039. "parameters": [
  1040. {
  1041. "type": "string",
  1042. "description": "name of the template",
  1043. "name": "name",
  1044. "in": "path",
  1045. "required": true
  1046. }
  1047. ],
  1048. "responses": {
  1049. "200": {
  1050. "$ref": "#/responses/GitignoreTemplateInfo"
  1051. },
  1052. "404": {
  1053. "$ref": "#/responses/notFound"
  1054. }
  1055. }
  1056. }
  1057. },
  1058. "/label/templates": {
  1059. "get": {
  1060. "produces": [
  1061. "application/json"
  1062. ],
  1063. "tags": [
  1064. "miscellaneous"
  1065. ],
  1066. "summary": "Returns a list of all label templates",
  1067. "operationId": "listLabelTemplates",
  1068. "responses": {
  1069. "200": {
  1070. "$ref": "#/responses/LabelTemplateList"
  1071. }
  1072. }
  1073. }
  1074. },
  1075. "/label/templates/{name}": {
  1076. "get": {
  1077. "produces": [
  1078. "application/json"
  1079. ],
  1080. "tags": [
  1081. "miscellaneous"
  1082. ],
  1083. "summary": "Returns all labels in a template",
  1084. "operationId": "getLabelTemplateInfo",
  1085. "parameters": [
  1086. {
  1087. "type": "string",
  1088. "description": "name of the template",
  1089. "name": "name",
  1090. "in": "path",
  1091. "required": true
  1092. }
  1093. ],
  1094. "responses": {
  1095. "200": {
  1096. "$ref": "#/responses/LabelTemplateInfo"
  1097. },
  1098. "404": {
  1099. "$ref": "#/responses/notFound"
  1100. }
  1101. }
  1102. }
  1103. },
  1104. "/licenses": {
  1105. "get": {
  1106. "produces": [
  1107. "application/json"
  1108. ],
  1109. "tags": [
  1110. "miscellaneous"
  1111. ],
  1112. "summary": "Returns a list of all license templates",
  1113. "operationId": "listLicenseTemplates",
  1114. "responses": {
  1115. "200": {
  1116. "$ref": "#/responses/LicenseTemplateList"
  1117. }
  1118. }
  1119. }
  1120. },
  1121. "/licenses/{name}": {
  1122. "get": {
  1123. "produces": [
  1124. "application/json"
  1125. ],
  1126. "tags": [
  1127. "miscellaneous"
  1128. ],
  1129. "summary": "Returns information about a license template",
  1130. "operationId": "getLicenseTemplateInfo",
  1131. "parameters": [
  1132. {
  1133. "type": "string",
  1134. "description": "name of the license",
  1135. "name": "name",
  1136. "in": "path",
  1137. "required": true
  1138. }
  1139. ],
  1140. "responses": {
  1141. "200": {
  1142. "$ref": "#/responses/LicenseTemplateInfo"
  1143. },
  1144. "404": {
  1145. "$ref": "#/responses/notFound"
  1146. }
  1147. }
  1148. }
  1149. },
  1150. "/markdown": {
  1151. "post": {
  1152. "consumes": [
  1153. "application/json"
  1154. ],
  1155. "produces": [
  1156. "text/html"
  1157. ],
  1158. "tags": [
  1159. "miscellaneous"
  1160. ],
  1161. "summary": "Render a markdown document as HTML",
  1162. "operationId": "renderMarkdown",
  1163. "parameters": [
  1164. {
  1165. "name": "body",
  1166. "in": "body",
  1167. "schema": {
  1168. "$ref": "#/definitions/MarkdownOption"
  1169. }
  1170. }
  1171. ],
  1172. "responses": {
  1173. "200": {
  1174. "$ref": "#/responses/MarkdownRender"
  1175. },
  1176. "422": {
  1177. "$ref": "#/responses/validationError"
  1178. }
  1179. }
  1180. }
  1181. },
  1182. "/markdown/raw": {
  1183. "post": {
  1184. "consumes": [
  1185. "text/plain"
  1186. ],
  1187. "produces": [
  1188. "text/html"
  1189. ],
  1190. "tags": [
  1191. "miscellaneous"
  1192. ],
  1193. "summary": "Render raw markdown as HTML",
  1194. "operationId": "renderMarkdownRaw",
  1195. "parameters": [
  1196. {
  1197. "description": "Request body to render",
  1198. "name": "body",
  1199. "in": "body",
  1200. "required": true,
  1201. "schema": {
  1202. "type": "string"
  1203. }
  1204. }
  1205. ],
  1206. "responses": {
  1207. "200": {
  1208. "$ref": "#/responses/MarkdownRender"
  1209. },
  1210. "422": {
  1211. "$ref": "#/responses/validationError"
  1212. }
  1213. }
  1214. }
  1215. },
  1216. "/markup": {
  1217. "post": {
  1218. "consumes": [
  1219. "application/json"
  1220. ],
  1221. "produces": [
  1222. "text/html"
  1223. ],
  1224. "tags": [
  1225. "miscellaneous"
  1226. ],
  1227. "summary": "Render a markup document as HTML",
  1228. "operationId": "renderMarkup",
  1229. "parameters": [
  1230. {
  1231. "name": "body",
  1232. "in": "body",
  1233. "schema": {
  1234. "$ref": "#/definitions/MarkupOption"
  1235. }
  1236. }
  1237. ],
  1238. "responses": {
  1239. "200": {
  1240. "$ref": "#/responses/MarkupRender"
  1241. },
  1242. "422": {
  1243. "$ref": "#/responses/validationError"
  1244. }
  1245. }
  1246. }
  1247. },
  1248. "/nodeinfo": {
  1249. "get": {
  1250. "produces": [
  1251. "application/json"
  1252. ],
  1253. "tags": [
  1254. "miscellaneous"
  1255. ],
  1256. "summary": "Returns the nodeinfo of the Gitea application",
  1257. "operationId": "getNodeInfo",
  1258. "responses": {
  1259. "200": {
  1260. "$ref": "#/responses/NodeInfo"
  1261. }
  1262. }
  1263. }
  1264. },
  1265. "/notifications": {
  1266. "get": {
  1267. "consumes": [
  1268. "application/json"
  1269. ],
  1270. "produces": [
  1271. "application/json"
  1272. ],
  1273. "tags": [
  1274. "notification"
  1275. ],
  1276. "summary": "List users's notification threads",
  1277. "operationId": "notifyGetList",
  1278. "parameters": [
  1279. {
  1280. "type": "boolean",
  1281. "description": "If true, show notifications marked as read. Default value is false",
  1282. "name": "all",
  1283. "in": "query"
  1284. },
  1285. {
  1286. "type": "array",
  1287. "items": {
  1288. "type": "string"
  1289. },
  1290. "collectionFormat": "multi",
  1291. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
  1292. "name": "status-types",
  1293. "in": "query"
  1294. },
  1295. {
  1296. "type": "array",
  1297. "items": {
  1298. "enum": [
  1299. "issue",
  1300. "pull",
  1301. "commit",
  1302. "repository"
  1303. ],
  1304. "type": "string"
  1305. },
  1306. "collectionFormat": "multi",
  1307. "description": "filter notifications by subject type",
  1308. "name": "subject-type",
  1309. "in": "query"
  1310. },
  1311. {
  1312. "type": "string",
  1313. "format": "date-time",
  1314. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  1315. "name": "since",
  1316. "in": "query"
  1317. },
  1318. {
  1319. "type": "string",
  1320. "format": "date-time",
  1321. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  1322. "name": "before",
  1323. "in": "query"
  1324. },
  1325. {
  1326. "type": "integer",
  1327. "description": "page number of results to return (1-based)",
  1328. "name": "page",
  1329. "in": "query"
  1330. },
  1331. {
  1332. "type": "integer",
  1333. "description": "page size of results",
  1334. "name": "limit",
  1335. "in": "query"
  1336. }
  1337. ],
  1338. "responses": {
  1339. "200": {
  1340. "$ref": "#/responses/NotificationThreadList"
  1341. }
  1342. }
  1343. },
  1344. "put": {
  1345. "consumes": [
  1346. "application/json"
  1347. ],
  1348. "produces": [
  1349. "application/json"
  1350. ],
  1351. "tags": [
  1352. "notification"
  1353. ],
  1354. "summary": "Mark notification threads as read, pinned or unread",
  1355. "operationId": "notifyReadList",
  1356. "parameters": [
  1357. {
  1358. "type": "string",
  1359. "format": "date-time",
  1360. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  1361. "name": "last_read_at",
  1362. "in": "query"
  1363. },
  1364. {
  1365. "type": "string",
  1366. "description": "If true, mark all notifications on this repo. Default value is false",
  1367. "name": "all",
  1368. "in": "query"
  1369. },
  1370. {
  1371. "type": "array",
  1372. "items": {
  1373. "type": "string"
  1374. },
  1375. "collectionFormat": "multi",
  1376. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  1377. "name": "status-types",
  1378. "in": "query"
  1379. },
  1380. {
  1381. "type": "string",
  1382. "description": "Status to mark notifications as, Defaults to read.",
  1383. "name": "to-status",
  1384. "in": "query"
  1385. }
  1386. ],
  1387. "responses": {
  1388. "205": {
  1389. "$ref": "#/responses/NotificationThreadList"
  1390. }
  1391. }
  1392. }
  1393. },
  1394. "/notifications/new": {
  1395. "get": {
  1396. "tags": [
  1397. "notification"
  1398. ],
  1399. "summary": "Check if unread notifications exist",
  1400. "operationId": "notifyNewAvailable",
  1401. "responses": {
  1402. "200": {
  1403. "$ref": "#/responses/NotificationCount"
  1404. }
  1405. }
  1406. }
  1407. },
  1408. "/notifications/threads/{id}": {
  1409. "get": {
  1410. "consumes": [
  1411. "application/json"
  1412. ],
  1413. "produces": [
  1414. "application/json"
  1415. ],
  1416. "tags": [
  1417. "notification"
  1418. ],
  1419. "summary": "Get notification thread by ID",
  1420. "operationId": "notifyGetThread",
  1421. "parameters": [
  1422. {
  1423. "type": "string",
  1424. "description": "id of notification thread",
  1425. "name": "id",
  1426. "in": "path",
  1427. "required": true
  1428. }
  1429. ],
  1430. "responses": {
  1431. "200": {
  1432. "$ref": "#/responses/NotificationThread"
  1433. },
  1434. "403": {
  1435. "$ref": "#/responses/forbidden"
  1436. },
  1437. "404": {
  1438. "$ref": "#/responses/notFound"
  1439. }
  1440. }
  1441. },
  1442. "patch": {
  1443. "consumes": [
  1444. "application/json"
  1445. ],
  1446. "produces": [
  1447. "application/json"
  1448. ],
  1449. "tags": [
  1450. "notification"
  1451. ],
  1452. "summary": "Mark notification thread as read by ID",
  1453. "operationId": "notifyReadThread",
  1454. "parameters": [
  1455. {
  1456. "type": "string",
  1457. "description": "id of notification thread",
  1458. "name": "id",
  1459. "in": "path",
  1460. "required": true
  1461. },
  1462. {
  1463. "type": "string",
  1464. "default": "read",
  1465. "description": "Status to mark notifications as",
  1466. "name": "to-status",
  1467. "in": "query"
  1468. }
  1469. ],
  1470. "responses": {
  1471. "205": {
  1472. "$ref": "#/responses/NotificationThread"
  1473. },
  1474. "403": {
  1475. "$ref": "#/responses/forbidden"
  1476. },
  1477. "404": {
  1478. "$ref": "#/responses/notFound"
  1479. }
  1480. }
  1481. }
  1482. },
  1483. "/org/{org}/repos": {
  1484. "post": {
  1485. "consumes": [
  1486. "application/json"
  1487. ],
  1488. "produces": [
  1489. "application/json"
  1490. ],
  1491. "tags": [
  1492. "organization"
  1493. ],
  1494. "summary": "Create a repository in an organization",
  1495. "operationId": "createOrgRepoDeprecated",
  1496. "deprecated": true,
  1497. "parameters": [
  1498. {
  1499. "type": "string",
  1500. "description": "name of organization",
  1501. "name": "org",
  1502. "in": "path",
  1503. "required": true
  1504. },
  1505. {
  1506. "name": "body",
  1507. "in": "body",
  1508. "schema": {
  1509. "$ref": "#/definitions/CreateRepoOption"
  1510. }
  1511. }
  1512. ],
  1513. "responses": {
  1514. "201": {
  1515. "$ref": "#/responses/Repository"
  1516. },
  1517. "403": {
  1518. "$ref": "#/responses/forbidden"
  1519. },
  1520. "404": {
  1521. "$ref": "#/responses/notFound"
  1522. },
  1523. "422": {
  1524. "$ref": "#/responses/validationError"
  1525. }
  1526. }
  1527. }
  1528. },
  1529. "/orgs": {
  1530. "get": {
  1531. "produces": [
  1532. "application/json"
  1533. ],
  1534. "tags": [
  1535. "organization"
  1536. ],
  1537. "summary": "Get list of organizations",
  1538. "operationId": "orgGetAll",
  1539. "parameters": [
  1540. {
  1541. "type": "integer",
  1542. "description": "page number of results to return (1-based)",
  1543. "name": "page",
  1544. "in": "query"
  1545. },
  1546. {
  1547. "type": "integer",
  1548. "description": "page size of results",
  1549. "name": "limit",
  1550. "in": "query"
  1551. }
  1552. ],
  1553. "responses": {
  1554. "200": {
  1555. "$ref": "#/responses/OrganizationList"
  1556. }
  1557. }
  1558. },
  1559. "post": {
  1560. "consumes": [
  1561. "application/json"
  1562. ],
  1563. "produces": [
  1564. "application/json"
  1565. ],
  1566. "tags": [
  1567. "organization"
  1568. ],
  1569. "summary": "Create an organization",
  1570. "operationId": "orgCreate",
  1571. "parameters": [
  1572. {
  1573. "name": "organization",
  1574. "in": "body",
  1575. "required": true,
  1576. "schema": {
  1577. "$ref": "#/definitions/CreateOrgOption"
  1578. }
  1579. }
  1580. ],
  1581. "responses": {
  1582. "201": {
  1583. "$ref": "#/responses/Organization"
  1584. },
  1585. "403": {
  1586. "$ref": "#/responses/forbidden"
  1587. },
  1588. "422": {
  1589. "$ref": "#/responses/validationError"
  1590. }
  1591. }
  1592. }
  1593. },
  1594. "/orgs/{org}": {
  1595. "get": {
  1596. "produces": [
  1597. "application/json"
  1598. ],
  1599. "tags": [
  1600. "organization"
  1601. ],
  1602. "summary": "Get an organization",
  1603. "operationId": "orgGet",
  1604. "parameters": [
  1605. {
  1606. "type": "string",
  1607. "description": "name of the organization to get",
  1608. "name": "org",
  1609. "in": "path",
  1610. "required": true
  1611. }
  1612. ],
  1613. "responses": {
  1614. "200": {
  1615. "$ref": "#/responses/Organization"
  1616. },
  1617. "404": {
  1618. "$ref": "#/responses/notFound"
  1619. }
  1620. }
  1621. },
  1622. "delete": {
  1623. "produces": [
  1624. "application/json"
  1625. ],
  1626. "tags": [
  1627. "organization"
  1628. ],
  1629. "summary": "Delete an organization",
  1630. "operationId": "orgDelete",
  1631. "parameters": [
  1632. {
  1633. "type": "string",
  1634. "description": "organization that is to be deleted",
  1635. "name": "org",
  1636. "in": "path",
  1637. "required": true
  1638. }
  1639. ],
  1640. "responses": {
  1641. "204": {
  1642. "$ref": "#/responses/empty"
  1643. },
  1644. "404": {
  1645. "$ref": "#/responses/notFound"
  1646. }
  1647. }
  1648. },
  1649. "patch": {
  1650. "consumes": [
  1651. "application/json"
  1652. ],
  1653. "produces": [
  1654. "application/json"
  1655. ],
  1656. "tags": [
  1657. "organization"
  1658. ],
  1659. "summary": "Edit an organization",
  1660. "operationId": "orgEdit",
  1661. "parameters": [
  1662. {
  1663. "type": "string",
  1664. "description": "name of the organization to edit",
  1665. "name": "org",
  1666. "in": "path",
  1667. "required": true
  1668. },
  1669. {
  1670. "name": "body",
  1671. "in": "body",
  1672. "required": true,
  1673. "schema": {
  1674. "$ref": "#/definitions/EditOrgOption"
  1675. }
  1676. }
  1677. ],
  1678. "responses": {
  1679. "200": {
  1680. "$ref": "#/responses/Organization"
  1681. },
  1682. "404": {
  1683. "$ref": "#/responses/notFound"
  1684. }
  1685. }
  1686. }
  1687. },
  1688. "/orgs/{org}/actions/runners/registration-token": {
  1689. "get": {
  1690. "produces": [
  1691. "application/json"
  1692. ],
  1693. "tags": [
  1694. "organization"
  1695. ],
  1696. "summary": "Get an organization's actions runner registration token",
  1697. "operationId": "orgGetRunnerRegistrationToken",
  1698. "parameters": [
  1699. {
  1700. "type": "string",
  1701. "description": "name of the organization",
  1702. "name": "org",
  1703. "in": "path",
  1704. "required": true
  1705. }
  1706. ],
  1707. "responses": {
  1708. "200": {
  1709. "$ref": "#/responses/RegistrationToken"
  1710. }
  1711. }
  1712. }
  1713. },
  1714. "/orgs/{org}/actions/secrets": {
  1715. "get": {
  1716. "produces": [
  1717. "application/json"
  1718. ],
  1719. "tags": [
  1720. "organization"
  1721. ],
  1722. "summary": "List an organization's actions secrets",
  1723. "operationId": "orgListActionsSecrets",
  1724. "parameters": [
  1725. {
  1726. "type": "string",
  1727. "description": "name of the organization",
  1728. "name": "org",
  1729. "in": "path",
  1730. "required": true
  1731. },
  1732. {
  1733. "type": "integer",
  1734. "description": "page number of results to return (1-based)",
  1735. "name": "page",
  1736. "in": "query"
  1737. },
  1738. {
  1739. "type": "integer",
  1740. "description": "page size of results",
  1741. "name": "limit",
  1742. "in": "query"
  1743. }
  1744. ],
  1745. "responses": {
  1746. "200": {
  1747. "$ref": "#/responses/SecretList"
  1748. },
  1749. "404": {
  1750. "$ref": "#/responses/notFound"
  1751. }
  1752. }
  1753. }
  1754. },
  1755. "/orgs/{org}/actions/secrets/{secretname}": {
  1756. "put": {
  1757. "consumes": [
  1758. "application/json"
  1759. ],
  1760. "produces": [
  1761. "application/json"
  1762. ],
  1763. "tags": [
  1764. "organization"
  1765. ],
  1766. "summary": "Create or Update a secret value in an organization",
  1767. "operationId": "updateOrgSecret",
  1768. "parameters": [
  1769. {
  1770. "type": "string",
  1771. "description": "name of organization",
  1772. "name": "org",
  1773. "in": "path",
  1774. "required": true
  1775. },
  1776. {
  1777. "type": "string",
  1778. "description": "name of the secret",
  1779. "name": "secretname",
  1780. "in": "path",
  1781. "required": true
  1782. },
  1783. {
  1784. "name": "body",
  1785. "in": "body",
  1786. "schema": {
  1787. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  1788. }
  1789. }
  1790. ],
  1791. "responses": {
  1792. "201": {
  1793. "description": "response when creating a secret"
  1794. },
  1795. "204": {
  1796. "description": "response when updating a secret"
  1797. },
  1798. "400": {
  1799. "$ref": "#/responses/error"
  1800. },
  1801. "404": {
  1802. "$ref": "#/responses/notFound"
  1803. }
  1804. }
  1805. },
  1806. "delete": {
  1807. "consumes": [
  1808. "application/json"
  1809. ],
  1810. "produces": [
  1811. "application/json"
  1812. ],
  1813. "tags": [
  1814. "organization"
  1815. ],
  1816. "summary": "Delete a secret in an organization",
  1817. "operationId": "deleteOrgSecret",
  1818. "parameters": [
  1819. {
  1820. "type": "string",
  1821. "description": "name of organization",
  1822. "name": "org",
  1823. "in": "path",
  1824. "required": true
  1825. },
  1826. {
  1827. "type": "string",
  1828. "description": "name of the secret",
  1829. "name": "secretname",
  1830. "in": "path",
  1831. "required": true
  1832. }
  1833. ],
  1834. "responses": {
  1835. "204": {
  1836. "description": "delete one secret of the organization"
  1837. },
  1838. "400": {
  1839. "$ref": "#/responses/error"
  1840. },
  1841. "404": {
  1842. "$ref": "#/responses/notFound"
  1843. }
  1844. }
  1845. }
  1846. },
  1847. "/orgs/{org}/actions/variables": {
  1848. "get": {
  1849. "produces": [
  1850. "application/json"
  1851. ],
  1852. "tags": [
  1853. "organization"
  1854. ],
  1855. "summary": "Get an org-level variables list",
  1856. "operationId": "getOrgVariablesList",
  1857. "parameters": [
  1858. {
  1859. "type": "string",
  1860. "description": "name of the organization",
  1861. "name": "org",
  1862. "in": "path",
  1863. "required": true
  1864. },
  1865. {
  1866. "type": "integer",
  1867. "description": "page number of results to return (1-based)",
  1868. "name": "page",
  1869. "in": "query"
  1870. },
  1871. {
  1872. "type": "integer",
  1873. "description": "page size of results",
  1874. "name": "limit",
  1875. "in": "query"
  1876. }
  1877. ],
  1878. "responses": {
  1879. "200": {
  1880. "$ref": "#/responses/VariableList"
  1881. },
  1882. "400": {
  1883. "$ref": "#/responses/error"
  1884. },
  1885. "404": {
  1886. "$ref": "#/responses/notFound"
  1887. }
  1888. }
  1889. }
  1890. },
  1891. "/orgs/{org}/actions/variables/{variablename}": {
  1892. "get": {
  1893. "produces": [
  1894. "application/json"
  1895. ],
  1896. "tags": [
  1897. "organization"
  1898. ],
  1899. "summary": "Get an org-level variable",
  1900. "operationId": "getOrgVariable",
  1901. "parameters": [
  1902. {
  1903. "type": "string",
  1904. "description": "name of the organization",
  1905. "name": "org",
  1906. "in": "path",
  1907. "required": true
  1908. },
  1909. {
  1910. "type": "string",
  1911. "description": "name of the variable",
  1912. "name": "variablename",
  1913. "in": "path",
  1914. "required": true
  1915. }
  1916. ],
  1917. "responses": {
  1918. "200": {
  1919. "$ref": "#/responses/ActionVariable"
  1920. },
  1921. "400": {
  1922. "$ref": "#/responses/error"
  1923. },
  1924. "404": {
  1925. "$ref": "#/responses/notFound"
  1926. }
  1927. }
  1928. },
  1929. "put": {
  1930. "consumes": [
  1931. "application/json"
  1932. ],
  1933. "produces": [
  1934. "application/json"
  1935. ],
  1936. "tags": [
  1937. "organization"
  1938. ],
  1939. "summary": "Update an org-level variable",
  1940. "operationId": "updateOrgVariable",
  1941. "parameters": [
  1942. {
  1943. "type": "string",
  1944. "description": "name of the organization",
  1945. "name": "org",
  1946. "in": "path",
  1947. "required": true
  1948. },
  1949. {
  1950. "type": "string",
  1951. "description": "name of the variable",
  1952. "name": "variablename",
  1953. "in": "path",
  1954. "required": true
  1955. },
  1956. {
  1957. "name": "body",
  1958. "in": "body",
  1959. "schema": {
  1960. "$ref": "#/definitions/UpdateVariableOption"
  1961. }
  1962. }
  1963. ],
  1964. "responses": {
  1965. "201": {
  1966. "description": "response when updating an org-level variable"
  1967. },
  1968. "204": {
  1969. "description": "response when updating an org-level variable"
  1970. },
  1971. "400": {
  1972. "$ref": "#/responses/error"
  1973. },
  1974. "404": {
  1975. "$ref": "#/responses/notFound"
  1976. }
  1977. }
  1978. },
  1979. "post": {
  1980. "consumes": [
  1981. "application/json"
  1982. ],
  1983. "produces": [
  1984. "application/json"
  1985. ],
  1986. "tags": [
  1987. "organization"
  1988. ],
  1989. "summary": "Create an org-level variable",
  1990. "operationId": "createOrgVariable",
  1991. "parameters": [
  1992. {
  1993. "type": "string",
  1994. "description": "name of the organization",
  1995. "name": "org",
  1996. "in": "path",
  1997. "required": true
  1998. },
  1999. {
  2000. "type": "string",
  2001. "description": "name of the variable",
  2002. "name": "variablename",
  2003. "in": "path",
  2004. "required": true
  2005. },
  2006. {
  2007. "name": "body",
  2008. "in": "body",
  2009. "schema": {
  2010. "$ref": "#/definitions/CreateVariableOption"
  2011. }
  2012. }
  2013. ],
  2014. "responses": {
  2015. "201": {
  2016. "description": "response when creating an org-level variable"
  2017. },
  2018. "204": {
  2019. "description": "response when creating an org-level variable"
  2020. },
  2021. "400": {
  2022. "$ref": "#/responses/error"
  2023. },
  2024. "404": {
  2025. "$ref": "#/responses/notFound"
  2026. }
  2027. }
  2028. },
  2029. "delete": {
  2030. "produces": [
  2031. "application/json"
  2032. ],
  2033. "tags": [
  2034. "organization"
  2035. ],
  2036. "summary": "Delete an org-level variable",
  2037. "operationId": "deleteOrgVariable",
  2038. "parameters": [
  2039. {
  2040. "type": "string",
  2041. "description": "name of the organization",
  2042. "name": "org",
  2043. "in": "path",
  2044. "required": true
  2045. },
  2046. {
  2047. "type": "string",
  2048. "description": "name of the variable",
  2049. "name": "variablename",
  2050. "in": "path",
  2051. "required": true
  2052. }
  2053. ],
  2054. "responses": {
  2055. "200": {
  2056. "$ref": "#/responses/ActionVariable"
  2057. },
  2058. "201": {
  2059. "description": "response when deleting a variable"
  2060. },
  2061. "204": {
  2062. "description": "response when deleting a variable"
  2063. },
  2064. "400": {
  2065. "$ref": "#/responses/error"
  2066. },
  2067. "404": {
  2068. "$ref": "#/responses/notFound"
  2069. }
  2070. }
  2071. }
  2072. },
  2073. "/orgs/{org}/activities/feeds": {
  2074. "get": {
  2075. "produces": [
  2076. "application/json"
  2077. ],
  2078. "tags": [
  2079. "organization"
  2080. ],
  2081. "summary": "List an organization's activity feeds",
  2082. "operationId": "orgListActivityFeeds",
  2083. "parameters": [
  2084. {
  2085. "type": "string",
  2086. "description": "name of the org",
  2087. "name": "org",
  2088. "in": "path",
  2089. "required": true
  2090. },
  2091. {
  2092. "type": "string",
  2093. "format": "date",
  2094. "description": "the date of the activities to be found",
  2095. "name": "date",
  2096. "in": "query"
  2097. },
  2098. {
  2099. "type": "integer",
  2100. "description": "page number of results to return (1-based)",
  2101. "name": "page",
  2102. "in": "query"
  2103. },
  2104. {
  2105. "type": "integer",
  2106. "description": "page size of results",
  2107. "name": "limit",
  2108. "in": "query"
  2109. }
  2110. ],
  2111. "responses": {
  2112. "200": {
  2113. "$ref": "#/responses/ActivityFeedsList"
  2114. },
  2115. "404": {
  2116. "$ref": "#/responses/notFound"
  2117. }
  2118. }
  2119. }
  2120. },
  2121. "/orgs/{org}/avatar": {
  2122. "post": {
  2123. "produces": [
  2124. "application/json"
  2125. ],
  2126. "tags": [
  2127. "organization"
  2128. ],
  2129. "summary": "Update Avatar",
  2130. "operationId": "orgUpdateAvatar",
  2131. "parameters": [
  2132. {
  2133. "type": "string",
  2134. "description": "name of the organization",
  2135. "name": "org",
  2136. "in": "path",
  2137. "required": true
  2138. },
  2139. {
  2140. "name": "body",
  2141. "in": "body",
  2142. "schema": {
  2143. "$ref": "#/definitions/UpdateUserAvatarOption"
  2144. }
  2145. }
  2146. ],
  2147. "responses": {
  2148. "204": {
  2149. "$ref": "#/responses/empty"
  2150. },
  2151. "404": {
  2152. "$ref": "#/responses/notFound"
  2153. }
  2154. }
  2155. },
  2156. "delete": {
  2157. "produces": [
  2158. "application/json"
  2159. ],
  2160. "tags": [
  2161. "organization"
  2162. ],
  2163. "summary": "Delete Avatar",
  2164. "operationId": "orgDeleteAvatar",
  2165. "parameters": [
  2166. {
  2167. "type": "string",
  2168. "description": "name of the organization",
  2169. "name": "org",
  2170. "in": "path",
  2171. "required": true
  2172. }
  2173. ],
  2174. "responses": {
  2175. "204": {
  2176. "$ref": "#/responses/empty"
  2177. },
  2178. "404": {
  2179. "$ref": "#/responses/notFound"
  2180. }
  2181. }
  2182. }
  2183. },
  2184. "/orgs/{org}/blocks": {
  2185. "get": {
  2186. "produces": [
  2187. "application/json"
  2188. ],
  2189. "tags": [
  2190. "organization"
  2191. ],
  2192. "summary": "List users blocked by the organization",
  2193. "operationId": "organizationListBlocks",
  2194. "parameters": [
  2195. {
  2196. "type": "string",
  2197. "description": "name of the organization",
  2198. "name": "org",
  2199. "in": "path",
  2200. "required": true
  2201. },
  2202. {
  2203. "type": "integer",
  2204. "description": "page number of results to return (1-based)",
  2205. "name": "page",
  2206. "in": "query"
  2207. },
  2208. {
  2209. "type": "integer",
  2210. "description": "page size of results",
  2211. "name": "limit",
  2212. "in": "query"
  2213. }
  2214. ],
  2215. "responses": {
  2216. "200": {
  2217. "$ref": "#/responses/UserList"
  2218. }
  2219. }
  2220. }
  2221. },
  2222. "/orgs/{org}/blocks/{username}": {
  2223. "get": {
  2224. "tags": [
  2225. "organization"
  2226. ],
  2227. "summary": "Check if a user is blocked by the organization",
  2228. "operationId": "organizationCheckUserBlock",
  2229. "parameters": [
  2230. {
  2231. "type": "string",
  2232. "description": "name of the organization",
  2233. "name": "org",
  2234. "in": "path",
  2235. "required": true
  2236. },
  2237. {
  2238. "type": "string",
  2239. "description": "user to check",
  2240. "name": "username",
  2241. "in": "path",
  2242. "required": true
  2243. }
  2244. ],
  2245. "responses": {
  2246. "204": {
  2247. "$ref": "#/responses/empty"
  2248. },
  2249. "404": {
  2250. "$ref": "#/responses/notFound"
  2251. }
  2252. }
  2253. },
  2254. "put": {
  2255. "tags": [
  2256. "organization"
  2257. ],
  2258. "summary": "Block a user",
  2259. "operationId": "organizationBlockUser",
  2260. "parameters": [
  2261. {
  2262. "type": "string",
  2263. "description": "name of the organization",
  2264. "name": "org",
  2265. "in": "path",
  2266. "required": true
  2267. },
  2268. {
  2269. "type": "string",
  2270. "description": "user to block",
  2271. "name": "username",
  2272. "in": "path",
  2273. "required": true
  2274. },
  2275. {
  2276. "type": "string",
  2277. "description": "optional note for the block",
  2278. "name": "note",
  2279. "in": "query"
  2280. }
  2281. ],
  2282. "responses": {
  2283. "204": {
  2284. "$ref": "#/responses/empty"
  2285. },
  2286. "404": {
  2287. "$ref": "#/responses/notFound"
  2288. },
  2289. "422": {
  2290. "$ref": "#/responses/validationError"
  2291. }
  2292. }
  2293. },
  2294. "delete": {
  2295. "tags": [
  2296. "organization"
  2297. ],
  2298. "summary": "Unblock a user",
  2299. "operationId": "organizationUnblockUser",
  2300. "parameters": [
  2301. {
  2302. "type": "string",
  2303. "description": "name of the organization",
  2304. "name": "org",
  2305. "in": "path",
  2306. "required": true
  2307. },
  2308. {
  2309. "type": "string",
  2310. "description": "user to unblock",
  2311. "name": "username",
  2312. "in": "path",
  2313. "required": true
  2314. }
  2315. ],
  2316. "responses": {
  2317. "204": {
  2318. "$ref": "#/responses/empty"
  2319. },
  2320. "404": {
  2321. "$ref": "#/responses/notFound"
  2322. },
  2323. "422": {
  2324. "$ref": "#/responses/validationError"
  2325. }
  2326. }
  2327. }
  2328. },
  2329. "/orgs/{org}/hooks": {
  2330. "get": {
  2331. "produces": [
  2332. "application/json"
  2333. ],
  2334. "tags": [
  2335. "organization"
  2336. ],
  2337. "summary": "List an organization's webhooks",
  2338. "operationId": "orgListHooks",
  2339. "parameters": [
  2340. {
  2341. "type": "string",
  2342. "description": "name of the organization",
  2343. "name": "org",
  2344. "in": "path",
  2345. "required": true
  2346. },
  2347. {
  2348. "type": "integer",
  2349. "description": "page number of results to return (1-based)",
  2350. "name": "page",
  2351. "in": "query"
  2352. },
  2353. {
  2354. "type": "integer",
  2355. "description": "page size of results",
  2356. "name": "limit",
  2357. "in": "query"
  2358. }
  2359. ],
  2360. "responses": {
  2361. "200": {
  2362. "$ref": "#/responses/HookList"
  2363. },
  2364. "404": {
  2365. "$ref": "#/responses/notFound"
  2366. }
  2367. }
  2368. },
  2369. "post": {
  2370. "consumes": [
  2371. "application/json"
  2372. ],
  2373. "produces": [
  2374. "application/json"
  2375. ],
  2376. "tags": [
  2377. "organization"
  2378. ],
  2379. "summary": "Create a hook",
  2380. "operationId": "orgCreateHook",
  2381. "parameters": [
  2382. {
  2383. "type": "string",
  2384. "description": "name of the organization",
  2385. "name": "org",
  2386. "in": "path",
  2387. "required": true
  2388. },
  2389. {
  2390. "name": "body",
  2391. "in": "body",
  2392. "required": true,
  2393. "schema": {
  2394. "$ref": "#/definitions/CreateHookOption"
  2395. }
  2396. }
  2397. ],
  2398. "responses": {
  2399. "201": {
  2400. "$ref": "#/responses/Hook"
  2401. },
  2402. "404": {
  2403. "$ref": "#/responses/notFound"
  2404. }
  2405. }
  2406. }
  2407. },
  2408. "/orgs/{org}/hooks/{id}": {
  2409. "get": {
  2410. "produces": [
  2411. "application/json"
  2412. ],
  2413. "tags": [
  2414. "organization"
  2415. ],
  2416. "summary": "Get a hook",
  2417. "operationId": "orgGetHook",
  2418. "parameters": [
  2419. {
  2420. "type": "string",
  2421. "description": "name of the organization",
  2422. "name": "org",
  2423. "in": "path",
  2424. "required": true
  2425. },
  2426. {
  2427. "type": "integer",
  2428. "format": "int64",
  2429. "description": "id of the hook to get",
  2430. "name": "id",
  2431. "in": "path",
  2432. "required": true
  2433. }
  2434. ],
  2435. "responses": {
  2436. "200": {
  2437. "$ref": "#/responses/Hook"
  2438. },
  2439. "404": {
  2440. "$ref": "#/responses/notFound"
  2441. }
  2442. }
  2443. },
  2444. "delete": {
  2445. "produces": [
  2446. "application/json"
  2447. ],
  2448. "tags": [
  2449. "organization"
  2450. ],
  2451. "summary": "Delete a hook",
  2452. "operationId": "orgDeleteHook",
  2453. "parameters": [
  2454. {
  2455. "type": "string",
  2456. "description": "name of the organization",
  2457. "name": "org",
  2458. "in": "path",
  2459. "required": true
  2460. },
  2461. {
  2462. "type": "integer",
  2463. "format": "int64",
  2464. "description": "id of the hook to delete",
  2465. "name": "id",
  2466. "in": "path",
  2467. "required": true
  2468. }
  2469. ],
  2470. "responses": {
  2471. "204": {
  2472. "$ref": "#/responses/empty"
  2473. },
  2474. "404": {
  2475. "$ref": "#/responses/notFound"
  2476. }
  2477. }
  2478. },
  2479. "patch": {
  2480. "consumes": [
  2481. "application/json"
  2482. ],
  2483. "produces": [
  2484. "application/json"
  2485. ],
  2486. "tags": [
  2487. "organization"
  2488. ],
  2489. "summary": "Update a hook",
  2490. "operationId": "orgEditHook",
  2491. "parameters": [
  2492. {
  2493. "type": "string",
  2494. "description": "name of the organization",
  2495. "name": "org",
  2496. "in": "path",
  2497. "required": true
  2498. },
  2499. {
  2500. "type": "integer",
  2501. "format": "int64",
  2502. "description": "id of the hook to update",
  2503. "name": "id",
  2504. "in": "path",
  2505. "required": true
  2506. },
  2507. {
  2508. "name": "body",
  2509. "in": "body",
  2510. "schema": {
  2511. "$ref": "#/definitions/EditHookOption"
  2512. }
  2513. }
  2514. ],
  2515. "responses": {
  2516. "200": {
  2517. "$ref": "#/responses/Hook"
  2518. },
  2519. "404": {
  2520. "$ref": "#/responses/notFound"
  2521. }
  2522. }
  2523. }
  2524. },
  2525. "/orgs/{org}/labels": {
  2526. "get": {
  2527. "produces": [
  2528. "application/json"
  2529. ],
  2530. "tags": [
  2531. "organization"
  2532. ],
  2533. "summary": "List an organization's labels",
  2534. "operationId": "orgListLabels",
  2535. "parameters": [
  2536. {
  2537. "type": "string",
  2538. "description": "name of the organization",
  2539. "name": "org",
  2540. "in": "path",
  2541. "required": true
  2542. },
  2543. {
  2544. "type": "integer",
  2545. "description": "page number of results to return (1-based)",
  2546. "name": "page",
  2547. "in": "query"
  2548. },
  2549. {
  2550. "type": "integer",
  2551. "description": "page size of results",
  2552. "name": "limit",
  2553. "in": "query"
  2554. }
  2555. ],
  2556. "responses": {
  2557. "200": {
  2558. "$ref": "#/responses/LabelList"
  2559. },
  2560. "404": {
  2561. "$ref": "#/responses/notFound"
  2562. }
  2563. }
  2564. },
  2565. "post": {
  2566. "consumes": [
  2567. "application/json"
  2568. ],
  2569. "produces": [
  2570. "application/json"
  2571. ],
  2572. "tags": [
  2573. "organization"
  2574. ],
  2575. "summary": "Create a label for an organization",
  2576. "operationId": "orgCreateLabel",
  2577. "parameters": [
  2578. {
  2579. "type": "string",
  2580. "description": "name of the organization",
  2581. "name": "org",
  2582. "in": "path",
  2583. "required": true
  2584. },
  2585. {
  2586. "name": "body",
  2587. "in": "body",
  2588. "schema": {
  2589. "$ref": "#/definitions/CreateLabelOption"
  2590. }
  2591. }
  2592. ],
  2593. "responses": {
  2594. "201": {
  2595. "$ref": "#/responses/Label"
  2596. },
  2597. "404": {
  2598. "$ref": "#/responses/notFound"
  2599. },
  2600. "422": {
  2601. "$ref": "#/responses/validationError"
  2602. }
  2603. }
  2604. }
  2605. },
  2606. "/orgs/{org}/labels/{id}": {
  2607. "get": {
  2608. "produces": [
  2609. "application/json"
  2610. ],
  2611. "tags": [
  2612. "organization"
  2613. ],
  2614. "summary": "Get a single label",
  2615. "operationId": "orgGetLabel",
  2616. "parameters": [
  2617. {
  2618. "type": "string",
  2619. "description": "name of the organization",
  2620. "name": "org",
  2621. "in": "path",
  2622. "required": true
  2623. },
  2624. {
  2625. "type": "integer",
  2626. "format": "int64",
  2627. "description": "id of the label to get",
  2628. "name": "id",
  2629. "in": "path",
  2630. "required": true
  2631. }
  2632. ],
  2633. "responses": {
  2634. "200": {
  2635. "$ref": "#/responses/Label"
  2636. },
  2637. "404": {
  2638. "$ref": "#/responses/notFound"
  2639. }
  2640. }
  2641. },
  2642. "delete": {
  2643. "tags": [
  2644. "organization"
  2645. ],
  2646. "summary": "Delete a label",
  2647. "operationId": "orgDeleteLabel",
  2648. "parameters": [
  2649. {
  2650. "type": "string",
  2651. "description": "name of the organization",
  2652. "name": "org",
  2653. "in": "path",
  2654. "required": true
  2655. },
  2656. {
  2657. "type": "integer",
  2658. "format": "int64",
  2659. "description": "id of the label to delete",
  2660. "name": "id",
  2661. "in": "path",
  2662. "required": true
  2663. }
  2664. ],
  2665. "responses": {
  2666. "204": {
  2667. "$ref": "#/responses/empty"
  2668. },
  2669. "404": {
  2670. "$ref": "#/responses/notFound"
  2671. }
  2672. }
  2673. },
  2674. "patch": {
  2675. "consumes": [
  2676. "application/json"
  2677. ],
  2678. "produces": [
  2679. "application/json"
  2680. ],
  2681. "tags": [
  2682. "organization"
  2683. ],
  2684. "summary": "Update a label",
  2685. "operationId": "orgEditLabel",
  2686. "parameters": [
  2687. {
  2688. "type": "string",
  2689. "description": "name of the organization",
  2690. "name": "org",
  2691. "in": "path",
  2692. "required": true
  2693. },
  2694. {
  2695. "type": "integer",
  2696. "format": "int64",
  2697. "description": "id of the label to edit",
  2698. "name": "id",
  2699. "in": "path",
  2700. "required": true
  2701. },
  2702. {
  2703. "name": "body",
  2704. "in": "body",
  2705. "schema": {
  2706. "$ref": "#/definitions/EditLabelOption"
  2707. }
  2708. }
  2709. ],
  2710. "responses": {
  2711. "200": {
  2712. "$ref": "#/responses/Label"
  2713. },
  2714. "404": {
  2715. "$ref": "#/responses/notFound"
  2716. },
  2717. "422": {
  2718. "$ref": "#/responses/validationError"
  2719. }
  2720. }
  2721. }
  2722. },
  2723. "/orgs/{org}/members": {
  2724. "get": {
  2725. "produces": [
  2726. "application/json"
  2727. ],
  2728. "tags": [
  2729. "organization"
  2730. ],
  2731. "summary": "List an organization's members",
  2732. "operationId": "orgListMembers",
  2733. "parameters": [
  2734. {
  2735. "type": "string",
  2736. "description": "name of the organization",
  2737. "name": "org",
  2738. "in": "path",
  2739. "required": true
  2740. },
  2741. {
  2742. "type": "integer",
  2743. "description": "page number of results to return (1-based)",
  2744. "name": "page",
  2745. "in": "query"
  2746. },
  2747. {
  2748. "type": "integer",
  2749. "description": "page size of results",
  2750. "name": "limit",
  2751. "in": "query"
  2752. }
  2753. ],
  2754. "responses": {
  2755. "200": {
  2756. "$ref": "#/responses/UserList"
  2757. },
  2758. "404": {
  2759. "$ref": "#/responses/notFound"
  2760. }
  2761. }
  2762. }
  2763. },
  2764. "/orgs/{org}/members/{username}": {
  2765. "get": {
  2766. "tags": [
  2767. "organization"
  2768. ],
  2769. "summary": "Check if a user is a member of an organization",
  2770. "operationId": "orgIsMember",
  2771. "parameters": [
  2772. {
  2773. "type": "string",
  2774. "description": "name of the organization",
  2775. "name": "org",
  2776. "in": "path",
  2777. "required": true
  2778. },
  2779. {
  2780. "type": "string",
  2781. "description": "username of the user",
  2782. "name": "username",
  2783. "in": "path",
  2784. "required": true
  2785. }
  2786. ],
  2787. "responses": {
  2788. "204": {
  2789. "description": "user is a member"
  2790. },
  2791. "303": {
  2792. "description": "redirection to /orgs/{org}/public_members/{username}"
  2793. },
  2794. "404": {
  2795. "description": "user is not a member"
  2796. }
  2797. }
  2798. },
  2799. "delete": {
  2800. "produces": [
  2801. "application/json"
  2802. ],
  2803. "tags": [
  2804. "organization"
  2805. ],
  2806. "summary": "Remove a member from an organization",
  2807. "operationId": "orgDeleteMember",
  2808. "parameters": [
  2809. {
  2810. "type": "string",
  2811. "description": "name of the organization",
  2812. "name": "org",
  2813. "in": "path",
  2814. "required": true
  2815. },
  2816. {
  2817. "type": "string",
  2818. "description": "username of the user",
  2819. "name": "username",
  2820. "in": "path",
  2821. "required": true
  2822. }
  2823. ],
  2824. "responses": {
  2825. "204": {
  2826. "description": "member removed"
  2827. },
  2828. "404": {
  2829. "$ref": "#/responses/notFound"
  2830. }
  2831. }
  2832. }
  2833. },
  2834. "/orgs/{org}/public_members": {
  2835. "get": {
  2836. "produces": [
  2837. "application/json"
  2838. ],
  2839. "tags": [
  2840. "organization"
  2841. ],
  2842. "summary": "List an organization's public members",
  2843. "operationId": "orgListPublicMembers",
  2844. "parameters": [
  2845. {
  2846. "type": "string",
  2847. "description": "name of the organization",
  2848. "name": "org",
  2849. "in": "path",
  2850. "required": true
  2851. },
  2852. {
  2853. "type": "integer",
  2854. "description": "page number of results to return (1-based)",
  2855. "name": "page",
  2856. "in": "query"
  2857. },
  2858. {
  2859. "type": "integer",
  2860. "description": "page size of results",
  2861. "name": "limit",
  2862. "in": "query"
  2863. }
  2864. ],
  2865. "responses": {
  2866. "200": {
  2867. "$ref": "#/responses/UserList"
  2868. },
  2869. "404": {
  2870. "$ref": "#/responses/notFound"
  2871. }
  2872. }
  2873. }
  2874. },
  2875. "/orgs/{org}/public_members/{username}": {
  2876. "get": {
  2877. "tags": [
  2878. "organization"
  2879. ],
  2880. "summary": "Check if a user is a public member of an organization",
  2881. "operationId": "orgIsPublicMember",
  2882. "parameters": [
  2883. {
  2884. "type": "string",
  2885. "description": "name of the organization",
  2886. "name": "org",
  2887. "in": "path",
  2888. "required": true
  2889. },
  2890. {
  2891. "type": "string",
  2892. "description": "username of the user",
  2893. "name": "username",
  2894. "in": "path",
  2895. "required": true
  2896. }
  2897. ],
  2898. "responses": {
  2899. "204": {
  2900. "description": "user is a public member"
  2901. },
  2902. "404": {
  2903. "description": "user is not a public member"
  2904. }
  2905. }
  2906. },
  2907. "put": {
  2908. "produces": [
  2909. "application/json"
  2910. ],
  2911. "tags": [
  2912. "organization"
  2913. ],
  2914. "summary": "Publicize a user's membership",
  2915. "operationId": "orgPublicizeMember",
  2916. "parameters": [
  2917. {
  2918. "type": "string",
  2919. "description": "name of the organization",
  2920. "name": "org",
  2921. "in": "path",
  2922. "required": true
  2923. },
  2924. {
  2925. "type": "string",
  2926. "description": "username of the user",
  2927. "name": "username",
  2928. "in": "path",
  2929. "required": true
  2930. }
  2931. ],
  2932. "responses": {
  2933. "204": {
  2934. "description": "membership publicized"
  2935. },
  2936. "403": {
  2937. "$ref": "#/responses/forbidden"
  2938. },
  2939. "404": {
  2940. "$ref": "#/responses/notFound"
  2941. }
  2942. }
  2943. },
  2944. "delete": {
  2945. "produces": [
  2946. "application/json"
  2947. ],
  2948. "tags": [
  2949. "organization"
  2950. ],
  2951. "summary": "Conceal a user's membership",
  2952. "operationId": "orgConcealMember",
  2953. "parameters": [
  2954. {
  2955. "type": "string",
  2956. "description": "name of the organization",
  2957. "name": "org",
  2958. "in": "path",
  2959. "required": true
  2960. },
  2961. {
  2962. "type": "string",
  2963. "description": "username of the user",
  2964. "name": "username",
  2965. "in": "path",
  2966. "required": true
  2967. }
  2968. ],
  2969. "responses": {
  2970. "204": {
  2971. "$ref": "#/responses/empty"
  2972. },
  2973. "403": {
  2974. "$ref": "#/responses/forbidden"
  2975. },
  2976. "404": {
  2977. "$ref": "#/responses/notFound"
  2978. }
  2979. }
  2980. }
  2981. },
  2982. "/orgs/{org}/repos": {
  2983. "get": {
  2984. "produces": [
  2985. "application/json"
  2986. ],
  2987. "tags": [
  2988. "organization"
  2989. ],
  2990. "summary": "List an organization's repos",
  2991. "operationId": "orgListRepos",
  2992. "parameters": [
  2993. {
  2994. "type": "string",
  2995. "description": "name of the organization",
  2996. "name": "org",
  2997. "in": "path",
  2998. "required": true
  2999. },
  3000. {
  3001. "type": "integer",
  3002. "description": "page number of results to return (1-based)",
  3003. "name": "page",
  3004. "in": "query"
  3005. },
  3006. {
  3007. "type": "integer",
  3008. "description": "page size of results",
  3009. "name": "limit",
  3010. "in": "query"
  3011. }
  3012. ],
  3013. "responses": {
  3014. "200": {
  3015. "$ref": "#/responses/RepositoryList"
  3016. },
  3017. "404": {
  3018. "$ref": "#/responses/notFound"
  3019. }
  3020. }
  3021. },
  3022. "post": {
  3023. "consumes": [
  3024. "application/json"
  3025. ],
  3026. "produces": [
  3027. "application/json"
  3028. ],
  3029. "tags": [
  3030. "organization"
  3031. ],
  3032. "summary": "Create a repository in an organization",
  3033. "operationId": "createOrgRepo",
  3034. "parameters": [
  3035. {
  3036. "type": "string",
  3037. "description": "name of organization",
  3038. "name": "org",
  3039. "in": "path",
  3040. "required": true
  3041. },
  3042. {
  3043. "name": "body",
  3044. "in": "body",
  3045. "schema": {
  3046. "$ref": "#/definitions/CreateRepoOption"
  3047. }
  3048. }
  3049. ],
  3050. "responses": {
  3051. "201": {
  3052. "$ref": "#/responses/Repository"
  3053. },
  3054. "400": {
  3055. "$ref": "#/responses/error"
  3056. },
  3057. "403": {
  3058. "$ref": "#/responses/forbidden"
  3059. },
  3060. "404": {
  3061. "$ref": "#/responses/notFound"
  3062. }
  3063. }
  3064. }
  3065. },
  3066. "/orgs/{org}/teams": {
  3067. "get": {
  3068. "produces": [
  3069. "application/json"
  3070. ],
  3071. "tags": [
  3072. "organization"
  3073. ],
  3074. "summary": "List an organization's teams",
  3075. "operationId": "orgListTeams",
  3076. "parameters": [
  3077. {
  3078. "type": "string",
  3079. "description": "name of the organization",
  3080. "name": "org",
  3081. "in": "path",
  3082. "required": true
  3083. },
  3084. {
  3085. "type": "integer",
  3086. "description": "page number of results to return (1-based)",
  3087. "name": "page",
  3088. "in": "query"
  3089. },
  3090. {
  3091. "type": "integer",
  3092. "description": "page size of results",
  3093. "name": "limit",
  3094. "in": "query"
  3095. }
  3096. ],
  3097. "responses": {
  3098. "200": {
  3099. "$ref": "#/responses/TeamList"
  3100. },
  3101. "404": {
  3102. "$ref": "#/responses/notFound"
  3103. }
  3104. }
  3105. },
  3106. "post": {
  3107. "consumes": [
  3108. "application/json"
  3109. ],
  3110. "produces": [
  3111. "application/json"
  3112. ],
  3113. "tags": [
  3114. "organization"
  3115. ],
  3116. "summary": "Create a team",
  3117. "operationId": "orgCreateTeam",
  3118. "parameters": [
  3119. {
  3120. "type": "string",
  3121. "description": "name of the organization",
  3122. "name": "org",
  3123. "in": "path",
  3124. "required": true
  3125. },
  3126. {
  3127. "name": "body",
  3128. "in": "body",
  3129. "schema": {
  3130. "$ref": "#/definitions/CreateTeamOption"
  3131. }
  3132. }
  3133. ],
  3134. "responses": {
  3135. "201": {
  3136. "$ref": "#/responses/Team"
  3137. },
  3138. "404": {
  3139. "$ref": "#/responses/notFound"
  3140. },
  3141. "422": {
  3142. "$ref": "#/responses/validationError"
  3143. }
  3144. }
  3145. }
  3146. },
  3147. "/orgs/{org}/teams/search": {
  3148. "get": {
  3149. "produces": [
  3150. "application/json"
  3151. ],
  3152. "tags": [
  3153. "organization"
  3154. ],
  3155. "summary": "Search for teams within an organization",
  3156. "operationId": "teamSearch",
  3157. "parameters": [
  3158. {
  3159. "type": "string",
  3160. "description": "name of the organization",
  3161. "name": "org",
  3162. "in": "path",
  3163. "required": true
  3164. },
  3165. {
  3166. "type": "string",
  3167. "description": "keywords to search",
  3168. "name": "q",
  3169. "in": "query"
  3170. },
  3171. {
  3172. "type": "boolean",
  3173. "description": "include search within team description (defaults to true)",
  3174. "name": "include_desc",
  3175. "in": "query"
  3176. },
  3177. {
  3178. "type": "integer",
  3179. "description": "page number of results to return (1-based)",
  3180. "name": "page",
  3181. "in": "query"
  3182. },
  3183. {
  3184. "type": "integer",
  3185. "description": "page size of results",
  3186. "name": "limit",
  3187. "in": "query"
  3188. }
  3189. ],
  3190. "responses": {
  3191. "200": {
  3192. "description": "SearchResults of a successful search",
  3193. "schema": {
  3194. "type": "object",
  3195. "properties": {
  3196. "data": {
  3197. "type": "array",
  3198. "items": {
  3199. "$ref": "#/definitions/Team"
  3200. }
  3201. },
  3202. "ok": {
  3203. "type": "boolean"
  3204. }
  3205. }
  3206. }
  3207. },
  3208. "404": {
  3209. "$ref": "#/responses/notFound"
  3210. }
  3211. }
  3212. }
  3213. },
  3214. "/packages/{owner}": {
  3215. "get": {
  3216. "produces": [
  3217. "application/json"
  3218. ],
  3219. "tags": [
  3220. "package"
  3221. ],
  3222. "summary": "Gets all packages of an owner",
  3223. "operationId": "listPackages",
  3224. "parameters": [
  3225. {
  3226. "type": "string",
  3227. "description": "owner of the packages",
  3228. "name": "owner",
  3229. "in": "path",
  3230. "required": true
  3231. },
  3232. {
  3233. "type": "integer",
  3234. "description": "page number of results to return (1-based)",
  3235. "name": "page",
  3236. "in": "query"
  3237. },
  3238. {
  3239. "type": "integer",
  3240. "description": "page size of results",
  3241. "name": "limit",
  3242. "in": "query"
  3243. },
  3244. {
  3245. "enum": [
  3246. "alpine",
  3247. "cargo",
  3248. "chef",
  3249. "composer",
  3250. "conan",
  3251. "conda",
  3252. "container",
  3253. "cran",
  3254. "debian",
  3255. "generic",
  3256. "go",
  3257. "helm",
  3258. "maven",
  3259. "npm",
  3260. "nuget",
  3261. "pub",
  3262. "pypi",
  3263. "rpm",
  3264. "rubygems",
  3265. "swift",
  3266. "vagrant"
  3267. ],
  3268. "type": "string",
  3269. "description": "package type filter",
  3270. "name": "type",
  3271. "in": "query"
  3272. },
  3273. {
  3274. "type": "string",
  3275. "description": "name filter",
  3276. "name": "q",
  3277. "in": "query"
  3278. }
  3279. ],
  3280. "responses": {
  3281. "200": {
  3282. "$ref": "#/responses/PackageList"
  3283. },
  3284. "404": {
  3285. "$ref": "#/responses/notFound"
  3286. }
  3287. }
  3288. }
  3289. },
  3290. "/packages/{owner}/{type}/{name}/{version}": {
  3291. "get": {
  3292. "produces": [
  3293. "application/json"
  3294. ],
  3295. "tags": [
  3296. "package"
  3297. ],
  3298. "summary": "Gets a package",
  3299. "operationId": "getPackage",
  3300. "parameters": [
  3301. {
  3302. "type": "string",
  3303. "description": "owner of the package",
  3304. "name": "owner",
  3305. "in": "path",
  3306. "required": true
  3307. },
  3308. {
  3309. "type": "string",
  3310. "description": "type of the package",
  3311. "name": "type",
  3312. "in": "path",
  3313. "required": true
  3314. },
  3315. {
  3316. "type": "string",
  3317. "description": "name of the package",
  3318. "name": "name",
  3319. "in": "path",
  3320. "required": true
  3321. },
  3322. {
  3323. "type": "string",
  3324. "description": "version of the package",
  3325. "name": "version",
  3326. "in": "path",
  3327. "required": true
  3328. }
  3329. ],
  3330. "responses": {
  3331. "200": {
  3332. "$ref": "#/responses/Package"
  3333. },
  3334. "404": {
  3335. "$ref": "#/responses/notFound"
  3336. }
  3337. }
  3338. },
  3339. "delete": {
  3340. "tags": [
  3341. "package"
  3342. ],
  3343. "summary": "Delete a package",
  3344. "operationId": "deletePackage",
  3345. "parameters": [
  3346. {
  3347. "type": "string",
  3348. "description": "owner of the package",
  3349. "name": "owner",
  3350. "in": "path",
  3351. "required": true
  3352. },
  3353. {
  3354. "type": "string",
  3355. "description": "type of the package",
  3356. "name": "type",
  3357. "in": "path",
  3358. "required": true
  3359. },
  3360. {
  3361. "type": "string",
  3362. "description": "name of the package",
  3363. "name": "name",
  3364. "in": "path",
  3365. "required": true
  3366. },
  3367. {
  3368. "type": "string",
  3369. "description": "version of the package",
  3370. "name": "version",
  3371. "in": "path",
  3372. "required": true
  3373. }
  3374. ],
  3375. "responses": {
  3376. "204": {
  3377. "$ref": "#/responses/empty"
  3378. },
  3379. "404": {
  3380. "$ref": "#/responses/notFound"
  3381. }
  3382. }
  3383. }
  3384. },
  3385. "/packages/{owner}/{type}/{name}/{version}/files": {
  3386. "get": {
  3387. "produces": [
  3388. "application/json"
  3389. ],
  3390. "tags": [
  3391. "package"
  3392. ],
  3393. "summary": "Gets all files of a package",
  3394. "operationId": "listPackageFiles",
  3395. "parameters": [
  3396. {
  3397. "type": "string",
  3398. "description": "owner of the package",
  3399. "name": "owner",
  3400. "in": "path",
  3401. "required": true
  3402. },
  3403. {
  3404. "type": "string",
  3405. "description": "type of the package",
  3406. "name": "type",
  3407. "in": "path",
  3408. "required": true
  3409. },
  3410. {
  3411. "type": "string",
  3412. "description": "name of the package",
  3413. "name": "name",
  3414. "in": "path",
  3415. "required": true
  3416. },
  3417. {
  3418. "type": "string",
  3419. "description": "version of the package",
  3420. "name": "version",
  3421. "in": "path",
  3422. "required": true
  3423. }
  3424. ],
  3425. "responses": {
  3426. "200": {
  3427. "$ref": "#/responses/PackageFileList"
  3428. },
  3429. "404": {
  3430. "$ref": "#/responses/notFound"
  3431. }
  3432. }
  3433. }
  3434. },
  3435. "/repos/issues/search": {
  3436. "get": {
  3437. "produces": [
  3438. "application/json"
  3439. ],
  3440. "tags": [
  3441. "issue"
  3442. ],
  3443. "summary": "Search for issues across the repositories that the user has access to",
  3444. "operationId": "issueSearchIssues",
  3445. "parameters": [
  3446. {
  3447. "type": "string",
  3448. "description": "whether issue is open or closed",
  3449. "name": "state",
  3450. "in": "query"
  3451. },
  3452. {
  3453. "type": "string",
  3454. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3455. "name": "labels",
  3456. "in": "query"
  3457. },
  3458. {
  3459. "type": "string",
  3460. "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
  3461. "name": "milestones",
  3462. "in": "query"
  3463. },
  3464. {
  3465. "type": "string",
  3466. "description": "search string",
  3467. "name": "q",
  3468. "in": "query"
  3469. },
  3470. {
  3471. "type": "integer",
  3472. "format": "int64",
  3473. "description": "repository to prioritize in the results",
  3474. "name": "priority_repo_id",
  3475. "in": "query"
  3476. },
  3477. {
  3478. "type": "string",
  3479. "description": "filter by type (issues / pulls) if set",
  3480. "name": "type",
  3481. "in": "query"
  3482. },
  3483. {
  3484. "type": "string",
  3485. "format": "date-time",
  3486. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  3487. "name": "since",
  3488. "in": "query"
  3489. },
  3490. {
  3491. "type": "string",
  3492. "format": "date-time",
  3493. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  3494. "name": "before",
  3495. "in": "query"
  3496. },
  3497. {
  3498. "type": "boolean",
  3499. "description": "filter (issues / pulls) assigned to you, default is false",
  3500. "name": "assigned",
  3501. "in": "query"
  3502. },
  3503. {
  3504. "type": "boolean",
  3505. "description": "filter (issues / pulls) created by you, default is false",
  3506. "name": "created",
  3507. "in": "query"
  3508. },
  3509. {
  3510. "type": "boolean",
  3511. "description": "filter (issues / pulls) mentioning you, default is false",
  3512. "name": "mentioned",
  3513. "in": "query"
  3514. },
  3515. {
  3516. "type": "boolean",
  3517. "description": "filter pulls requesting your review, default is false",
  3518. "name": "review_requested",
  3519. "in": "query"
  3520. },
  3521. {
  3522. "type": "boolean",
  3523. "description": "filter pulls reviewed by you, default is false",
  3524. "name": "reviewed",
  3525. "in": "query"
  3526. },
  3527. {
  3528. "type": "string",
  3529. "description": "filter by owner",
  3530. "name": "owner",
  3531. "in": "query"
  3532. },
  3533. {
  3534. "type": "string",
  3535. "description": "filter by team (requires organization owner parameter to be provided)",
  3536. "name": "team",
  3537. "in": "query"
  3538. },
  3539. {
  3540. "type": "integer",
  3541. "description": "page number of results to return (1-based)",
  3542. "name": "page",
  3543. "in": "query"
  3544. },
  3545. {
  3546. "type": "integer",
  3547. "description": "page size of results",
  3548. "name": "limit",
  3549. "in": "query"
  3550. }
  3551. ],
  3552. "responses": {
  3553. "200": {
  3554. "$ref": "#/responses/IssueList"
  3555. }
  3556. }
  3557. }
  3558. },
  3559. "/repos/migrate": {
  3560. "post": {
  3561. "consumes": [
  3562. "application/json"
  3563. ],
  3564. "produces": [
  3565. "application/json"
  3566. ],
  3567. "tags": [
  3568. "repository"
  3569. ],
  3570. "summary": "Migrate a remote git repository",
  3571. "operationId": "repoMigrate",
  3572. "parameters": [
  3573. {
  3574. "name": "body",
  3575. "in": "body",
  3576. "schema": {
  3577. "$ref": "#/definitions/MigrateRepoOptions"
  3578. }
  3579. }
  3580. ],
  3581. "responses": {
  3582. "201": {
  3583. "$ref": "#/responses/Repository"
  3584. },
  3585. "403": {
  3586. "$ref": "#/responses/forbidden"
  3587. },
  3588. "409": {
  3589. "description": "The repository with the same name already exists."
  3590. },
  3591. "422": {
  3592. "$ref": "#/responses/validationError"
  3593. }
  3594. }
  3595. }
  3596. },
  3597. "/repos/search": {
  3598. "get": {
  3599. "produces": [
  3600. "application/json"
  3601. ],
  3602. "tags": [
  3603. "repository"
  3604. ],
  3605. "summary": "Search for repositories",
  3606. "operationId": "repoSearch",
  3607. "parameters": [
  3608. {
  3609. "type": "string",
  3610. "description": "keyword",
  3611. "name": "q",
  3612. "in": "query"
  3613. },
  3614. {
  3615. "type": "boolean",
  3616. "description": "Limit search to repositories with keyword as topic",
  3617. "name": "topic",
  3618. "in": "query"
  3619. },
  3620. {
  3621. "type": "boolean",
  3622. "description": "include search of keyword within repository description",
  3623. "name": "includeDesc",
  3624. "in": "query"
  3625. },
  3626. {
  3627. "type": "integer",
  3628. "format": "int64",
  3629. "description": "search only for repos that the user with the given id owns or contributes to",
  3630. "name": "uid",
  3631. "in": "query"
  3632. },
  3633. {
  3634. "type": "integer",
  3635. "format": "int64",
  3636. "description": "repo owner to prioritize in the results",
  3637. "name": "priority_owner_id",
  3638. "in": "query"
  3639. },
  3640. {
  3641. "type": "integer",
  3642. "format": "int64",
  3643. "description": "search only for repos that belong to the given team id",
  3644. "name": "team_id",
  3645. "in": "query"
  3646. },
  3647. {
  3648. "type": "integer",
  3649. "format": "int64",
  3650. "description": "search only for repos that the user with the given id has starred",
  3651. "name": "starredBy",
  3652. "in": "query"
  3653. },
  3654. {
  3655. "type": "boolean",
  3656. "description": "include private repositories this user has access to (defaults to true)",
  3657. "name": "private",
  3658. "in": "query"
  3659. },
  3660. {
  3661. "type": "boolean",
  3662. "description": "show only pubic, private or all repositories (defaults to all)",
  3663. "name": "is_private",
  3664. "in": "query"
  3665. },
  3666. {
  3667. "type": "boolean",
  3668. "description": "include template repositories this user has access to (defaults to true)",
  3669. "name": "template",
  3670. "in": "query"
  3671. },
  3672. {
  3673. "type": "boolean",
  3674. "description": "show only archived, non-archived or all repositories (defaults to all)",
  3675. "name": "archived",
  3676. "in": "query"
  3677. },
  3678. {
  3679. "type": "string",
  3680. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  3681. "name": "mode",
  3682. "in": "query"
  3683. },
  3684. {
  3685. "type": "boolean",
  3686. "description": "if `uid` is given, search only for repos that the user owns",
  3687. "name": "exclusive",
  3688. "in": "query"
  3689. },
  3690. {
  3691. "type": "string",
  3692. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", \"git_size\", \"lfs_size\", \"stars\", \"forks\" and \"id\". Default is \"alpha\"",
  3693. "name": "sort",
  3694. "in": "query"
  3695. },
  3696. {
  3697. "type": "string",
  3698. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  3699. "name": "order",
  3700. "in": "query"
  3701. },
  3702. {
  3703. "type": "integer",
  3704. "description": "page number of results to return (1-based)",
  3705. "name": "page",
  3706. "in": "query"
  3707. },
  3708. {
  3709. "type": "integer",
  3710. "description": "page size of results",
  3711. "name": "limit",
  3712. "in": "query"
  3713. }
  3714. ],
  3715. "responses": {
  3716. "200": {
  3717. "$ref": "#/responses/SearchResults"
  3718. },
  3719. "422": {
  3720. "$ref": "#/responses/validationError"
  3721. }
  3722. }
  3723. }
  3724. },
  3725. "/repos/{owner}/{repo}": {
  3726. "get": {
  3727. "produces": [
  3728. "application/json"
  3729. ],
  3730. "tags": [
  3731. "repository"
  3732. ],
  3733. "summary": "Get a repository",
  3734. "operationId": "repoGet",
  3735. "parameters": [
  3736. {
  3737. "type": "string",
  3738. "description": "owner of the repo",
  3739. "name": "owner",
  3740. "in": "path",
  3741. "required": true
  3742. },
  3743. {
  3744. "type": "string",
  3745. "description": "name of the repo",
  3746. "name": "repo",
  3747. "in": "path",
  3748. "required": true
  3749. }
  3750. ],
  3751. "responses": {
  3752. "200": {
  3753. "$ref": "#/responses/Repository"
  3754. },
  3755. "404": {
  3756. "$ref": "#/responses/notFound"
  3757. }
  3758. }
  3759. },
  3760. "delete": {
  3761. "produces": [
  3762. "application/json"
  3763. ],
  3764. "tags": [
  3765. "repository"
  3766. ],
  3767. "summary": "Delete a repository",
  3768. "operationId": "repoDelete",
  3769. "parameters": [
  3770. {
  3771. "type": "string",
  3772. "description": "owner of the repo to delete",
  3773. "name": "owner",
  3774. "in": "path",
  3775. "required": true
  3776. },
  3777. {
  3778. "type": "string",
  3779. "description": "name of the repo to delete",
  3780. "name": "repo",
  3781. "in": "path",
  3782. "required": true
  3783. }
  3784. ],
  3785. "responses": {
  3786. "204": {
  3787. "$ref": "#/responses/empty"
  3788. },
  3789. "403": {
  3790. "$ref": "#/responses/forbidden"
  3791. },
  3792. "404": {
  3793. "$ref": "#/responses/notFound"
  3794. }
  3795. }
  3796. },
  3797. "patch": {
  3798. "produces": [
  3799. "application/json"
  3800. ],
  3801. "tags": [
  3802. "repository"
  3803. ],
  3804. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  3805. "operationId": "repoEdit",
  3806. "parameters": [
  3807. {
  3808. "type": "string",
  3809. "description": "owner of the repo to edit",
  3810. "name": "owner",
  3811. "in": "path",
  3812. "required": true
  3813. },
  3814. {
  3815. "type": "string",
  3816. "description": "name of the repo to edit",
  3817. "name": "repo",
  3818. "in": "path",
  3819. "required": true
  3820. },
  3821. {
  3822. "description": "Properties of a repo that you can edit",
  3823. "name": "body",
  3824. "in": "body",
  3825. "schema": {
  3826. "$ref": "#/definitions/EditRepoOption"
  3827. }
  3828. }
  3829. ],
  3830. "responses": {
  3831. "200": {
  3832. "$ref": "#/responses/Repository"
  3833. },
  3834. "403": {
  3835. "$ref": "#/responses/forbidden"
  3836. },
  3837. "404": {
  3838. "$ref": "#/responses/notFound"
  3839. },
  3840. "422": {
  3841. "$ref": "#/responses/validationError"
  3842. }
  3843. }
  3844. }
  3845. },
  3846. "/repos/{owner}/{repo}/actions/secrets": {
  3847. "get": {
  3848. "produces": [
  3849. "application/json"
  3850. ],
  3851. "tags": [
  3852. "repository"
  3853. ],
  3854. "summary": "List an repo's actions secrets",
  3855. "operationId": "repoListActionsSecrets",
  3856. "parameters": [
  3857. {
  3858. "type": "string",
  3859. "description": "owner of the repository",
  3860. "name": "owner",
  3861. "in": "path",
  3862. "required": true
  3863. },
  3864. {
  3865. "type": "string",
  3866. "description": "name of the repository",
  3867. "name": "repo",
  3868. "in": "path",
  3869. "required": true
  3870. },
  3871. {
  3872. "type": "integer",
  3873. "description": "page number of results to return (1-based)",
  3874. "name": "page",
  3875. "in": "query"
  3876. },
  3877. {
  3878. "type": "integer",
  3879. "description": "page size of results",
  3880. "name": "limit",
  3881. "in": "query"
  3882. }
  3883. ],
  3884. "responses": {
  3885. "200": {
  3886. "$ref": "#/responses/SecretList"
  3887. },
  3888. "404": {
  3889. "$ref": "#/responses/notFound"
  3890. }
  3891. }
  3892. }
  3893. },
  3894. "/repos/{owner}/{repo}/actions/secrets/{secretname}": {
  3895. "put": {
  3896. "consumes": [
  3897. "application/json"
  3898. ],
  3899. "produces": [
  3900. "application/json"
  3901. ],
  3902. "tags": [
  3903. "repository"
  3904. ],
  3905. "summary": "Create or Update a secret value in a repository",
  3906. "operationId": "updateRepoSecret",
  3907. "parameters": [
  3908. {
  3909. "type": "string",
  3910. "description": "owner of the repository",
  3911. "name": "owner",
  3912. "in": "path",
  3913. "required": true
  3914. },
  3915. {
  3916. "type": "string",
  3917. "description": "name of the repository",
  3918. "name": "repo",
  3919. "in": "path",
  3920. "required": true
  3921. },
  3922. {
  3923. "type": "string",
  3924. "description": "name of the secret",
  3925. "name": "secretname",
  3926. "in": "path",
  3927. "required": true
  3928. },
  3929. {
  3930. "name": "body",
  3931. "in": "body",
  3932. "schema": {
  3933. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  3934. }
  3935. }
  3936. ],
  3937. "responses": {
  3938. "201": {
  3939. "description": "response when creating a secret"
  3940. },
  3941. "204": {
  3942. "description": "response when updating a secret"
  3943. },
  3944. "400": {
  3945. "$ref": "#/responses/error"
  3946. },
  3947. "404": {
  3948. "$ref": "#/responses/notFound"
  3949. }
  3950. }
  3951. },
  3952. "delete": {
  3953. "consumes": [
  3954. "application/json"
  3955. ],
  3956. "produces": [
  3957. "application/json"
  3958. ],
  3959. "tags": [
  3960. "repository"
  3961. ],
  3962. "summary": "Delete a secret in a repository",
  3963. "operationId": "deleteRepoSecret",
  3964. "parameters": [
  3965. {
  3966. "type": "string",
  3967. "description": "owner of the repository",
  3968. "name": "owner",
  3969. "in": "path",
  3970. "required": true
  3971. },
  3972. {
  3973. "type": "string",
  3974. "description": "name of the repository",
  3975. "name": "repo",
  3976. "in": "path",
  3977. "required": true
  3978. },
  3979. {
  3980. "type": "string",
  3981. "description": "name of the secret",
  3982. "name": "secretname",
  3983. "in": "path",
  3984. "required": true
  3985. }
  3986. ],
  3987. "responses": {
  3988. "204": {
  3989. "description": "delete one secret of the organization"
  3990. },
  3991. "400": {
  3992. "$ref": "#/responses/error"
  3993. },
  3994. "404": {
  3995. "$ref": "#/responses/notFound"
  3996. }
  3997. }
  3998. }
  3999. },
  4000. "/repos/{owner}/{repo}/actions/tasks": {
  4001. "get": {
  4002. "produces": [
  4003. "application/json"
  4004. ],
  4005. "tags": [
  4006. "repository"
  4007. ],
  4008. "summary": "List a repository's action tasks",
  4009. "operationId": "ListActionTasks",
  4010. "parameters": [
  4011. {
  4012. "type": "string",
  4013. "description": "owner of the repo",
  4014. "name": "owner",
  4015. "in": "path",
  4016. "required": true
  4017. },
  4018. {
  4019. "type": "string",
  4020. "description": "name of the repo",
  4021. "name": "repo",
  4022. "in": "path",
  4023. "required": true
  4024. },
  4025. {
  4026. "type": "integer",
  4027. "description": "page number of results to return (1-based)",
  4028. "name": "page",
  4029. "in": "query"
  4030. },
  4031. {
  4032. "type": "integer",
  4033. "description": "page size of results, default maximum page size is 50",
  4034. "name": "limit",
  4035. "in": "query"
  4036. }
  4037. ],
  4038. "responses": {
  4039. "200": {
  4040. "$ref": "#/responses/TasksList"
  4041. },
  4042. "400": {
  4043. "$ref": "#/responses/error"
  4044. },
  4045. "403": {
  4046. "$ref": "#/responses/forbidden"
  4047. },
  4048. "404": {
  4049. "$ref": "#/responses/notFound"
  4050. },
  4051. "409": {
  4052. "$ref": "#/responses/conflict"
  4053. },
  4054. "422": {
  4055. "$ref": "#/responses/validationError"
  4056. }
  4057. }
  4058. }
  4059. },
  4060. "/repos/{owner}/{repo}/actions/variables": {
  4061. "get": {
  4062. "produces": [
  4063. "application/json"
  4064. ],
  4065. "tags": [
  4066. "repository"
  4067. ],
  4068. "summary": "Get repo-level variables list",
  4069. "operationId": "getRepoVariablesList",
  4070. "parameters": [
  4071. {
  4072. "type": "string",
  4073. "description": "name of the owner",
  4074. "name": "owner",
  4075. "in": "path",
  4076. "required": true
  4077. },
  4078. {
  4079. "type": "string",
  4080. "description": "name of the repository",
  4081. "name": "repo",
  4082. "in": "path",
  4083. "required": true
  4084. },
  4085. {
  4086. "type": "integer",
  4087. "description": "page number of results to return (1-based)",
  4088. "name": "page",
  4089. "in": "query"
  4090. },
  4091. {
  4092. "type": "integer",
  4093. "description": "page size of results",
  4094. "name": "limit",
  4095. "in": "query"
  4096. }
  4097. ],
  4098. "responses": {
  4099. "200": {
  4100. "$ref": "#/responses/VariableList"
  4101. },
  4102. "400": {
  4103. "$ref": "#/responses/error"
  4104. },
  4105. "404": {
  4106. "$ref": "#/responses/notFound"
  4107. }
  4108. }
  4109. }
  4110. },
  4111. "/repos/{owner}/{repo}/actions/variables/{variablename}": {
  4112. "get": {
  4113. "produces": [
  4114. "application/json"
  4115. ],
  4116. "tags": [
  4117. "repository"
  4118. ],
  4119. "summary": "Get a repo-level variable",
  4120. "operationId": "getRepoVariable",
  4121. "parameters": [
  4122. {
  4123. "type": "string",
  4124. "description": "name of the owner",
  4125. "name": "owner",
  4126. "in": "path",
  4127. "required": true
  4128. },
  4129. {
  4130. "type": "string",
  4131. "description": "name of the repository",
  4132. "name": "repo",
  4133. "in": "path",
  4134. "required": true
  4135. },
  4136. {
  4137. "type": "string",
  4138. "description": "name of the variable",
  4139. "name": "variablename",
  4140. "in": "path",
  4141. "required": true
  4142. }
  4143. ],
  4144. "responses": {
  4145. "200": {
  4146. "$ref": "#/responses/ActionVariable"
  4147. },
  4148. "400": {
  4149. "$ref": "#/responses/error"
  4150. },
  4151. "404": {
  4152. "$ref": "#/responses/notFound"
  4153. }
  4154. }
  4155. },
  4156. "put": {
  4157. "produces": [
  4158. "application/json"
  4159. ],
  4160. "tags": [
  4161. "repository"
  4162. ],
  4163. "summary": "Update a repo-level variable",
  4164. "operationId": "updateRepoVariable",
  4165. "parameters": [
  4166. {
  4167. "type": "string",
  4168. "description": "name of the owner",
  4169. "name": "owner",
  4170. "in": "path",
  4171. "required": true
  4172. },
  4173. {
  4174. "type": "string",
  4175. "description": "name of the repository",
  4176. "name": "repo",
  4177. "in": "path",
  4178. "required": true
  4179. },
  4180. {
  4181. "type": "string",
  4182. "description": "name of the variable",
  4183. "name": "variablename",
  4184. "in": "path",
  4185. "required": true
  4186. },
  4187. {
  4188. "name": "body",
  4189. "in": "body",
  4190. "schema": {
  4191. "$ref": "#/definitions/UpdateVariableOption"
  4192. }
  4193. }
  4194. ],
  4195. "responses": {
  4196. "201": {
  4197. "description": "response when updating a repo-level variable"
  4198. },
  4199. "204": {
  4200. "description": "response when updating a repo-level variable"
  4201. },
  4202. "400": {
  4203. "$ref": "#/responses/error"
  4204. },
  4205. "404": {
  4206. "$ref": "#/responses/notFound"
  4207. }
  4208. }
  4209. },
  4210. "post": {
  4211. "produces": [
  4212. "application/json"
  4213. ],
  4214. "tags": [
  4215. "repository"
  4216. ],
  4217. "summary": "Create a repo-level variable",
  4218. "operationId": "createRepoVariable",
  4219. "parameters": [
  4220. {
  4221. "type": "string",
  4222. "description": "name of the owner",
  4223. "name": "owner",
  4224. "in": "path",
  4225. "required": true
  4226. },
  4227. {
  4228. "type": "string",
  4229. "description": "name of the repository",
  4230. "name": "repo",
  4231. "in": "path",
  4232. "required": true
  4233. },
  4234. {
  4235. "type": "string",
  4236. "description": "name of the variable",
  4237. "name": "variablename",
  4238. "in": "path",
  4239. "required": true
  4240. },
  4241. {
  4242. "name": "body",
  4243. "in": "body",
  4244. "schema": {
  4245. "$ref": "#/definitions/CreateVariableOption"
  4246. }
  4247. }
  4248. ],
  4249. "responses": {
  4250. "201": {
  4251. "description": "response when creating a repo-level variable"
  4252. },
  4253. "204": {
  4254. "description": "response when creating a repo-level variable"
  4255. },
  4256. "400": {
  4257. "$ref": "#/responses/error"
  4258. },
  4259. "404": {
  4260. "$ref": "#/responses/notFound"
  4261. }
  4262. }
  4263. },
  4264. "delete": {
  4265. "produces": [
  4266. "application/json"
  4267. ],
  4268. "tags": [
  4269. "repository"
  4270. ],
  4271. "summary": "Delete a repo-level variable",
  4272. "operationId": "deleteRepoVariable",
  4273. "parameters": [
  4274. {
  4275. "type": "string",
  4276. "description": "name of the owner",
  4277. "name": "owner",
  4278. "in": "path",
  4279. "required": true
  4280. },
  4281. {
  4282. "type": "string",
  4283. "description": "name of the repository",
  4284. "name": "repo",
  4285. "in": "path",
  4286. "required": true
  4287. },
  4288. {
  4289. "type": "string",
  4290. "description": "name of the variable",
  4291. "name": "variablename",
  4292. "in": "path",
  4293. "required": true
  4294. }
  4295. ],
  4296. "responses": {
  4297. "200": {
  4298. "$ref": "#/responses/ActionVariable"
  4299. },
  4300. "201": {
  4301. "description": "response when deleting a variable"
  4302. },
  4303. "204": {
  4304. "description": "response when deleting a variable"
  4305. },
  4306. "400": {
  4307. "$ref": "#/responses/error"
  4308. },
  4309. "404": {
  4310. "$ref": "#/responses/notFound"
  4311. }
  4312. }
  4313. }
  4314. },
  4315. "/repos/{owner}/{repo}/activities/feeds": {
  4316. "get": {
  4317. "produces": [
  4318. "application/json"
  4319. ],
  4320. "tags": [
  4321. "repository"
  4322. ],
  4323. "summary": "List a repository's activity feeds",
  4324. "operationId": "repoListActivityFeeds",
  4325. "parameters": [
  4326. {
  4327. "type": "string",
  4328. "description": "owner of the repo",
  4329. "name": "owner",
  4330. "in": "path",
  4331. "required": true
  4332. },
  4333. {
  4334. "type": "string",
  4335. "description": "name of the repo",
  4336. "name": "repo",
  4337. "in": "path",
  4338. "required": true
  4339. },
  4340. {
  4341. "type": "string",
  4342. "format": "date",
  4343. "description": "the date of the activities to be found",
  4344. "name": "date",
  4345. "in": "query"
  4346. },
  4347. {
  4348. "type": "integer",
  4349. "description": "page number of results to return (1-based)",
  4350. "name": "page",
  4351. "in": "query"
  4352. },
  4353. {
  4354. "type": "integer",
  4355. "description": "page size of results",
  4356. "name": "limit",
  4357. "in": "query"
  4358. }
  4359. ],
  4360. "responses": {
  4361. "200": {
  4362. "$ref": "#/responses/ActivityFeedsList"
  4363. },
  4364. "404": {
  4365. "$ref": "#/responses/notFound"
  4366. }
  4367. }
  4368. }
  4369. },
  4370. "/repos/{owner}/{repo}/archive/{archive}": {
  4371. "get": {
  4372. "produces": [
  4373. "application/json"
  4374. ],
  4375. "tags": [
  4376. "repository"
  4377. ],
  4378. "summary": "Get an archive of a repository",
  4379. "operationId": "repoGetArchive",
  4380. "parameters": [
  4381. {
  4382. "type": "string",
  4383. "description": "owner of the repo",
  4384. "name": "owner",
  4385. "in": "path",
  4386. "required": true
  4387. },
  4388. {
  4389. "type": "string",
  4390. "description": "name of the repo",
  4391. "name": "repo",
  4392. "in": "path",
  4393. "required": true
  4394. },
  4395. {
  4396. "type": "string",
  4397. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  4398. "name": "archive",
  4399. "in": "path",
  4400. "required": true
  4401. }
  4402. ],
  4403. "responses": {
  4404. "200": {
  4405. "description": "success"
  4406. },
  4407. "404": {
  4408. "$ref": "#/responses/notFound"
  4409. }
  4410. }
  4411. }
  4412. },
  4413. "/repos/{owner}/{repo}/assignees": {
  4414. "get": {
  4415. "produces": [
  4416. "application/json"
  4417. ],
  4418. "tags": [
  4419. "repository"
  4420. ],
  4421. "summary": "Return all users that have write access and can be assigned to issues",
  4422. "operationId": "repoGetAssignees",
  4423. "parameters": [
  4424. {
  4425. "type": "string",
  4426. "description": "owner of the repo",
  4427. "name": "owner",
  4428. "in": "path",
  4429. "required": true
  4430. },
  4431. {
  4432. "type": "string",
  4433. "description": "name of the repo",
  4434. "name": "repo",
  4435. "in": "path",
  4436. "required": true
  4437. }
  4438. ],
  4439. "responses": {
  4440. "200": {
  4441. "$ref": "#/responses/UserList"
  4442. },
  4443. "404": {
  4444. "$ref": "#/responses/notFound"
  4445. }
  4446. }
  4447. }
  4448. },
  4449. "/repos/{owner}/{repo}/avatar": {
  4450. "post": {
  4451. "produces": [
  4452. "application/json"
  4453. ],
  4454. "tags": [
  4455. "repository"
  4456. ],
  4457. "summary": "Update avatar",
  4458. "operationId": "repoUpdateAvatar",
  4459. "parameters": [
  4460. {
  4461. "type": "string",
  4462. "description": "owner of the repo",
  4463. "name": "owner",
  4464. "in": "path",
  4465. "required": true
  4466. },
  4467. {
  4468. "type": "string",
  4469. "description": "name of the repo",
  4470. "name": "repo",
  4471. "in": "path",
  4472. "required": true
  4473. },
  4474. {
  4475. "name": "body",
  4476. "in": "body",
  4477. "schema": {
  4478. "$ref": "#/definitions/UpdateRepoAvatarOption"
  4479. }
  4480. }
  4481. ],
  4482. "responses": {
  4483. "204": {
  4484. "$ref": "#/responses/empty"
  4485. },
  4486. "404": {
  4487. "$ref": "#/responses/notFound"
  4488. }
  4489. }
  4490. },
  4491. "delete": {
  4492. "produces": [
  4493. "application/json"
  4494. ],
  4495. "tags": [
  4496. "repository"
  4497. ],
  4498. "summary": "Delete avatar",
  4499. "operationId": "repoDeleteAvatar",
  4500. "parameters": [
  4501. {
  4502. "type": "string",
  4503. "description": "owner of the repo",
  4504. "name": "owner",
  4505. "in": "path",
  4506. "required": true
  4507. },
  4508. {
  4509. "type": "string",
  4510. "description": "name of the repo",
  4511. "name": "repo",
  4512. "in": "path",
  4513. "required": true
  4514. }
  4515. ],
  4516. "responses": {
  4517. "204": {
  4518. "$ref": "#/responses/empty"
  4519. },
  4520. "404": {
  4521. "$ref": "#/responses/notFound"
  4522. }
  4523. }
  4524. }
  4525. },
  4526. "/repos/{owner}/{repo}/branch_protections": {
  4527. "get": {
  4528. "produces": [
  4529. "application/json"
  4530. ],
  4531. "tags": [
  4532. "repository"
  4533. ],
  4534. "summary": "List branch protections for a repository",
  4535. "operationId": "repoListBranchProtection",
  4536. "parameters": [
  4537. {
  4538. "type": "string",
  4539. "description": "owner of the repo",
  4540. "name": "owner",
  4541. "in": "path",
  4542. "required": true
  4543. },
  4544. {
  4545. "type": "string",
  4546. "description": "name of the repo",
  4547. "name": "repo",
  4548. "in": "path",
  4549. "required": true
  4550. }
  4551. ],
  4552. "responses": {
  4553. "200": {
  4554. "$ref": "#/responses/BranchProtectionList"
  4555. }
  4556. }
  4557. },
  4558. "post": {
  4559. "consumes": [
  4560. "application/json"
  4561. ],
  4562. "produces": [
  4563. "application/json"
  4564. ],
  4565. "tags": [
  4566. "repository"
  4567. ],
  4568. "summary": "Create a branch protections for a repository",
  4569. "operationId": "repoCreateBranchProtection",
  4570. "parameters": [
  4571. {
  4572. "type": "string",
  4573. "description": "owner of the repo",
  4574. "name": "owner",
  4575. "in": "path",
  4576. "required": true
  4577. },
  4578. {
  4579. "type": "string",
  4580. "description": "name of the repo",
  4581. "name": "repo",
  4582. "in": "path",
  4583. "required": true
  4584. },
  4585. {
  4586. "name": "body",
  4587. "in": "body",
  4588. "schema": {
  4589. "$ref": "#/definitions/CreateBranchProtectionOption"
  4590. }
  4591. }
  4592. ],
  4593. "responses": {
  4594. "201": {
  4595. "$ref": "#/responses/BranchProtection"
  4596. },
  4597. "403": {
  4598. "$ref": "#/responses/forbidden"
  4599. },
  4600. "404": {
  4601. "$ref": "#/responses/notFound"
  4602. },
  4603. "422": {
  4604. "$ref": "#/responses/validationError"
  4605. },
  4606. "423": {
  4607. "$ref": "#/responses/repoArchivedError"
  4608. }
  4609. }
  4610. }
  4611. },
  4612. "/repos/{owner}/{repo}/branch_protections/{name}": {
  4613. "get": {
  4614. "produces": [
  4615. "application/json"
  4616. ],
  4617. "tags": [
  4618. "repository"
  4619. ],
  4620. "summary": "Get a specific branch protection for the repository",
  4621. "operationId": "repoGetBranchProtection",
  4622. "parameters": [
  4623. {
  4624. "type": "string",
  4625. "description": "owner of the repo",
  4626. "name": "owner",
  4627. "in": "path",
  4628. "required": true
  4629. },
  4630. {
  4631. "type": "string",
  4632. "description": "name of the repo",
  4633. "name": "repo",
  4634. "in": "path",
  4635. "required": true
  4636. },
  4637. {
  4638. "type": "string",
  4639. "description": "name of protected branch",
  4640. "name": "name",
  4641. "in": "path",
  4642. "required": true
  4643. }
  4644. ],
  4645. "responses": {
  4646. "200": {
  4647. "$ref": "#/responses/BranchProtection"
  4648. },
  4649. "404": {
  4650. "$ref": "#/responses/notFound"
  4651. }
  4652. }
  4653. },
  4654. "delete": {
  4655. "produces": [
  4656. "application/json"
  4657. ],
  4658. "tags": [
  4659. "repository"
  4660. ],
  4661. "summary": "Delete a specific branch protection for the repository",
  4662. "operationId": "repoDeleteBranchProtection",
  4663. "parameters": [
  4664. {
  4665. "type": "string",
  4666. "description": "owner of the repo",
  4667. "name": "owner",
  4668. "in": "path",
  4669. "required": true
  4670. },
  4671. {
  4672. "type": "string",
  4673. "description": "name of the repo",
  4674. "name": "repo",
  4675. "in": "path",
  4676. "required": true
  4677. },
  4678. {
  4679. "type": "string",
  4680. "description": "name of protected branch",
  4681. "name": "name",
  4682. "in": "path",
  4683. "required": true
  4684. }
  4685. ],
  4686. "responses": {
  4687. "204": {
  4688. "$ref": "#/responses/empty"
  4689. },
  4690. "404": {
  4691. "$ref": "#/responses/notFound"
  4692. }
  4693. }
  4694. },
  4695. "patch": {
  4696. "consumes": [
  4697. "application/json"
  4698. ],
  4699. "produces": [
  4700. "application/json"
  4701. ],
  4702. "tags": [
  4703. "repository"
  4704. ],
  4705. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  4706. "operationId": "repoEditBranchProtection",
  4707. "parameters": [
  4708. {
  4709. "type": "string",
  4710. "description": "owner of the repo",
  4711. "name": "owner",
  4712. "in": "path",
  4713. "required": true
  4714. },
  4715. {
  4716. "type": "string",
  4717. "description": "name of the repo",
  4718. "name": "repo",
  4719. "in": "path",
  4720. "required": true
  4721. },
  4722. {
  4723. "type": "string",
  4724. "description": "name of protected branch",
  4725. "name": "name",
  4726. "in": "path",
  4727. "required": true
  4728. },
  4729. {
  4730. "name": "body",
  4731. "in": "body",
  4732. "schema": {
  4733. "$ref": "#/definitions/EditBranchProtectionOption"
  4734. }
  4735. }
  4736. ],
  4737. "responses": {
  4738. "200": {
  4739. "$ref": "#/responses/BranchProtection"
  4740. },
  4741. "404": {
  4742. "$ref": "#/responses/notFound"
  4743. },
  4744. "422": {
  4745. "$ref": "#/responses/validationError"
  4746. },
  4747. "423": {
  4748. "$ref": "#/responses/repoArchivedError"
  4749. }
  4750. }
  4751. }
  4752. },
  4753. "/repos/{owner}/{repo}/branches": {
  4754. "get": {
  4755. "produces": [
  4756. "application/json"
  4757. ],
  4758. "tags": [
  4759. "repository"
  4760. ],
  4761. "summary": "List a repository's branches",
  4762. "operationId": "repoListBranches",
  4763. "parameters": [
  4764. {
  4765. "type": "string",
  4766. "description": "owner of the repo",
  4767. "name": "owner",
  4768. "in": "path",
  4769. "required": true
  4770. },
  4771. {
  4772. "type": "string",
  4773. "description": "name of the repo",
  4774. "name": "repo",
  4775. "in": "path",
  4776. "required": true
  4777. },
  4778. {
  4779. "type": "integer",
  4780. "description": "page number of results to return (1-based)",
  4781. "name": "page",
  4782. "in": "query"
  4783. },
  4784. {
  4785. "type": "integer",
  4786. "description": "page size of results",
  4787. "name": "limit",
  4788. "in": "query"
  4789. }
  4790. ],
  4791. "responses": {
  4792. "200": {
  4793. "$ref": "#/responses/BranchList"
  4794. }
  4795. }
  4796. },
  4797. "post": {
  4798. "consumes": [
  4799. "application/json"
  4800. ],
  4801. "produces": [
  4802. "application/json"
  4803. ],
  4804. "tags": [
  4805. "repository"
  4806. ],
  4807. "summary": "Create a branch",
  4808. "operationId": "repoCreateBranch",
  4809. "parameters": [
  4810. {
  4811. "type": "string",
  4812. "description": "owner of the repo",
  4813. "name": "owner",
  4814. "in": "path",
  4815. "required": true
  4816. },
  4817. {
  4818. "type": "string",
  4819. "description": "name of the repo",
  4820. "name": "repo",
  4821. "in": "path",
  4822. "required": true
  4823. },
  4824. {
  4825. "name": "body",
  4826. "in": "body",
  4827. "schema": {
  4828. "$ref": "#/definitions/CreateBranchRepoOption"
  4829. }
  4830. }
  4831. ],
  4832. "responses": {
  4833. "201": {
  4834. "$ref": "#/responses/Branch"
  4835. },
  4836. "403": {
  4837. "description": "The branch is archived or a mirror."
  4838. },
  4839. "404": {
  4840. "description": "The old branch does not exist."
  4841. },
  4842. "409": {
  4843. "description": "The branch with the same name already exists."
  4844. },
  4845. "423": {
  4846. "$ref": "#/responses/repoArchivedError"
  4847. }
  4848. }
  4849. }
  4850. },
  4851. "/repos/{owner}/{repo}/branches/{branch}": {
  4852. "get": {
  4853. "produces": [
  4854. "application/json"
  4855. ],
  4856. "tags": [
  4857. "repository"
  4858. ],
  4859. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  4860. "operationId": "repoGetBranch",
  4861. "parameters": [
  4862. {
  4863. "type": "string",
  4864. "description": "owner of the repo",
  4865. "name": "owner",
  4866. "in": "path",
  4867. "required": true
  4868. },
  4869. {
  4870. "type": "string",
  4871. "description": "name of the repo",
  4872. "name": "repo",
  4873. "in": "path",
  4874. "required": true
  4875. },
  4876. {
  4877. "type": "string",
  4878. "description": "branch to get",
  4879. "name": "branch",
  4880. "in": "path",
  4881. "required": true
  4882. }
  4883. ],
  4884. "responses": {
  4885. "200": {
  4886. "$ref": "#/responses/Branch"
  4887. },
  4888. "404": {
  4889. "$ref": "#/responses/notFound"
  4890. }
  4891. }
  4892. },
  4893. "delete": {
  4894. "produces": [
  4895. "application/json"
  4896. ],
  4897. "tags": [
  4898. "repository"
  4899. ],
  4900. "summary": "Delete a specific branch from a repository",
  4901. "operationId": "repoDeleteBranch",
  4902. "parameters": [
  4903. {
  4904. "type": "string",
  4905. "description": "owner of the repo",
  4906. "name": "owner",
  4907. "in": "path",
  4908. "required": true
  4909. },
  4910. {
  4911. "type": "string",
  4912. "description": "name of the repo",
  4913. "name": "repo",
  4914. "in": "path",
  4915. "required": true
  4916. },
  4917. {
  4918. "type": "string",
  4919. "description": "branch to delete",
  4920. "name": "branch",
  4921. "in": "path",
  4922. "required": true
  4923. }
  4924. ],
  4925. "responses": {
  4926. "204": {
  4927. "$ref": "#/responses/empty"
  4928. },
  4929. "403": {
  4930. "$ref": "#/responses/error"
  4931. },
  4932. "404": {
  4933. "$ref": "#/responses/notFound"
  4934. },
  4935. "423": {
  4936. "$ref": "#/responses/repoArchivedError"
  4937. }
  4938. }
  4939. }
  4940. },
  4941. "/repos/{owner}/{repo}/collaborators": {
  4942. "get": {
  4943. "produces": [
  4944. "application/json"
  4945. ],
  4946. "tags": [
  4947. "repository"
  4948. ],
  4949. "summary": "List a repository's collaborators",
  4950. "operationId": "repoListCollaborators",
  4951. "parameters": [
  4952. {
  4953. "type": "string",
  4954. "description": "owner of the repo",
  4955. "name": "owner",
  4956. "in": "path",
  4957. "required": true
  4958. },
  4959. {
  4960. "type": "string",
  4961. "description": "name of the repo",
  4962. "name": "repo",
  4963. "in": "path",
  4964. "required": true
  4965. },
  4966. {
  4967. "type": "integer",
  4968. "description": "page number of results to return (1-based)",
  4969. "name": "page",
  4970. "in": "query"
  4971. },
  4972. {
  4973. "type": "integer",
  4974. "description": "page size of results",
  4975. "name": "limit",
  4976. "in": "query"
  4977. }
  4978. ],
  4979. "responses": {
  4980. "200": {
  4981. "$ref": "#/responses/UserList"
  4982. },
  4983. "404": {
  4984. "$ref": "#/responses/notFound"
  4985. }
  4986. }
  4987. }
  4988. },
  4989. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  4990. "get": {
  4991. "produces": [
  4992. "application/json"
  4993. ],
  4994. "tags": [
  4995. "repository"
  4996. ],
  4997. "summary": "Check if a user is a collaborator of a repository",
  4998. "operationId": "repoCheckCollaborator",
  4999. "parameters": [
  5000. {
  5001. "type": "string",
  5002. "description": "owner of the repo",
  5003. "name": "owner",
  5004. "in": "path",
  5005. "required": true
  5006. },
  5007. {
  5008. "type": "string",
  5009. "description": "name of the repo",
  5010. "name": "repo",
  5011. "in": "path",
  5012. "required": true
  5013. },
  5014. {
  5015. "type": "string",
  5016. "description": "username of the collaborator",
  5017. "name": "collaborator",
  5018. "in": "path",
  5019. "required": true
  5020. }
  5021. ],
  5022. "responses": {
  5023. "204": {
  5024. "$ref": "#/responses/empty"
  5025. },
  5026. "404": {
  5027. "$ref": "#/responses/notFound"
  5028. },
  5029. "422": {
  5030. "$ref": "#/responses/validationError"
  5031. }
  5032. }
  5033. },
  5034. "put": {
  5035. "produces": [
  5036. "application/json"
  5037. ],
  5038. "tags": [
  5039. "repository"
  5040. ],
  5041. "summary": "Add a collaborator to a repository",
  5042. "operationId": "repoAddCollaborator",
  5043. "parameters": [
  5044. {
  5045. "type": "string",
  5046. "description": "owner of the repo",
  5047. "name": "owner",
  5048. "in": "path",
  5049. "required": true
  5050. },
  5051. {
  5052. "type": "string",
  5053. "description": "name of the repo",
  5054. "name": "repo",
  5055. "in": "path",
  5056. "required": true
  5057. },
  5058. {
  5059. "type": "string",
  5060. "description": "username of the collaborator to add",
  5061. "name": "collaborator",
  5062. "in": "path",
  5063. "required": true
  5064. },
  5065. {
  5066. "name": "body",
  5067. "in": "body",
  5068. "schema": {
  5069. "$ref": "#/definitions/AddCollaboratorOption"
  5070. }
  5071. }
  5072. ],
  5073. "responses": {
  5074. "204": {
  5075. "$ref": "#/responses/empty"
  5076. },
  5077. "403": {
  5078. "$ref": "#/responses/forbidden"
  5079. },
  5080. "404": {
  5081. "$ref": "#/responses/notFound"
  5082. },
  5083. "422": {
  5084. "$ref": "#/responses/validationError"
  5085. }
  5086. }
  5087. },
  5088. "delete": {
  5089. "produces": [
  5090. "application/json"
  5091. ],
  5092. "tags": [
  5093. "repository"
  5094. ],
  5095. "summary": "Delete a collaborator from a repository",
  5096. "operationId": "repoDeleteCollaborator",
  5097. "parameters": [
  5098. {
  5099. "type": "string",
  5100. "description": "owner of the repo",
  5101. "name": "owner",
  5102. "in": "path",
  5103. "required": true
  5104. },
  5105. {
  5106. "type": "string",
  5107. "description": "name of the repo",
  5108. "name": "repo",
  5109. "in": "path",
  5110. "required": true
  5111. },
  5112. {
  5113. "type": "string",
  5114. "description": "username of the collaborator to delete",
  5115. "name": "collaborator",
  5116. "in": "path",
  5117. "required": true
  5118. }
  5119. ],
  5120. "responses": {
  5121. "204": {
  5122. "$ref": "#/responses/empty"
  5123. },
  5124. "404": {
  5125. "$ref": "#/responses/notFound"
  5126. },
  5127. "422": {
  5128. "$ref": "#/responses/validationError"
  5129. }
  5130. }
  5131. }
  5132. },
  5133. "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
  5134. "get": {
  5135. "produces": [
  5136. "application/json"
  5137. ],
  5138. "tags": [
  5139. "repository"
  5140. ],
  5141. "summary": "Get repository permissions for a user",
  5142. "operationId": "repoGetRepoPermissions",
  5143. "parameters": [
  5144. {
  5145. "type": "string",
  5146. "description": "owner of the repo",
  5147. "name": "owner",
  5148. "in": "path",
  5149. "required": true
  5150. },
  5151. {
  5152. "type": "string",
  5153. "description": "name of the repo",
  5154. "name": "repo",
  5155. "in": "path",
  5156. "required": true
  5157. },
  5158. {
  5159. "type": "string",
  5160. "description": "username of the collaborator",
  5161. "name": "collaborator",
  5162. "in": "path",
  5163. "required": true
  5164. }
  5165. ],
  5166. "responses": {
  5167. "200": {
  5168. "$ref": "#/responses/RepoCollaboratorPermission"
  5169. },
  5170. "403": {
  5171. "$ref": "#/responses/forbidden"
  5172. },
  5173. "404": {
  5174. "$ref": "#/responses/notFound"
  5175. }
  5176. }
  5177. }
  5178. },
  5179. "/repos/{owner}/{repo}/commits": {
  5180. "get": {
  5181. "produces": [
  5182. "application/json"
  5183. ],
  5184. "tags": [
  5185. "repository"
  5186. ],
  5187. "summary": "Get a list of all commits from a repository",
  5188. "operationId": "repoGetAllCommits",
  5189. "parameters": [
  5190. {
  5191. "type": "string",
  5192. "description": "owner of the repo",
  5193. "name": "owner",
  5194. "in": "path",
  5195. "required": true
  5196. },
  5197. {
  5198. "type": "string",
  5199. "description": "name of the repo",
  5200. "name": "repo",
  5201. "in": "path",
  5202. "required": true
  5203. },
  5204. {
  5205. "type": "string",
  5206. "description": "SHA or branch to start listing commits from (usually 'master')",
  5207. "name": "sha",
  5208. "in": "query"
  5209. },
  5210. {
  5211. "type": "string",
  5212. "description": "filepath of a file/dir",
  5213. "name": "path",
  5214. "in": "query"
  5215. },
  5216. {
  5217. "type": "boolean",
  5218. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  5219. "name": "stat",
  5220. "in": "query"
  5221. },
  5222. {
  5223. "type": "boolean",
  5224. "description": "include verification for every commit (disable for speedup, default 'true')",
  5225. "name": "verification",
  5226. "in": "query"
  5227. },
  5228. {
  5229. "type": "boolean",
  5230. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5231. "name": "files",
  5232. "in": "query"
  5233. },
  5234. {
  5235. "type": "integer",
  5236. "description": "page number of results to return (1-based)",
  5237. "name": "page",
  5238. "in": "query"
  5239. },
  5240. {
  5241. "type": "integer",
  5242. "description": "page size of results (ignored if used with 'path')",
  5243. "name": "limit",
  5244. "in": "query"
  5245. },
  5246. {
  5247. "type": "string",
  5248. "description": "commits that match the given specifier will not be listed.",
  5249. "name": "not",
  5250. "in": "query"
  5251. }
  5252. ],
  5253. "responses": {
  5254. "200": {
  5255. "$ref": "#/responses/CommitList"
  5256. },
  5257. "404": {
  5258. "$ref": "#/responses/notFound"
  5259. },
  5260. "409": {
  5261. "$ref": "#/responses/EmptyRepository"
  5262. }
  5263. }
  5264. }
  5265. },
  5266. "/repos/{owner}/{repo}/commits/{ref}/status": {
  5267. "get": {
  5268. "produces": [
  5269. "application/json"
  5270. ],
  5271. "tags": [
  5272. "repository"
  5273. ],
  5274. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  5275. "operationId": "repoGetCombinedStatusByRef",
  5276. "parameters": [
  5277. {
  5278. "type": "string",
  5279. "description": "owner of the repo",
  5280. "name": "owner",
  5281. "in": "path",
  5282. "required": true
  5283. },
  5284. {
  5285. "type": "string",
  5286. "description": "name of the repo",
  5287. "name": "repo",
  5288. "in": "path",
  5289. "required": true
  5290. },
  5291. {
  5292. "type": "string",
  5293. "description": "name of branch/tag/commit",
  5294. "name": "ref",
  5295. "in": "path",
  5296. "required": true
  5297. },
  5298. {
  5299. "type": "integer",
  5300. "description": "page number of results to return (1-based)",
  5301. "name": "page",
  5302. "in": "query"
  5303. },
  5304. {
  5305. "type": "integer",
  5306. "description": "page size of results",
  5307. "name": "limit",
  5308. "in": "query"
  5309. }
  5310. ],
  5311. "responses": {
  5312. "200": {
  5313. "$ref": "#/responses/CombinedStatus"
  5314. },
  5315. "400": {
  5316. "$ref": "#/responses/error"
  5317. },
  5318. "404": {
  5319. "$ref": "#/responses/notFound"
  5320. }
  5321. }
  5322. }
  5323. },
  5324. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  5325. "get": {
  5326. "produces": [
  5327. "application/json"
  5328. ],
  5329. "tags": [
  5330. "repository"
  5331. ],
  5332. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  5333. "operationId": "repoListStatusesByRef",
  5334. "parameters": [
  5335. {
  5336. "type": "string",
  5337. "description": "owner of the repo",
  5338. "name": "owner",
  5339. "in": "path",
  5340. "required": true
  5341. },
  5342. {
  5343. "type": "string",
  5344. "description": "name of the repo",
  5345. "name": "repo",
  5346. "in": "path",
  5347. "required": true
  5348. },
  5349. {
  5350. "type": "string",
  5351. "description": "name of branch/tag/commit",
  5352. "name": "ref",
  5353. "in": "path",
  5354. "required": true
  5355. },
  5356. {
  5357. "enum": [
  5358. "oldest",
  5359. "recentupdate",
  5360. "leastupdate",
  5361. "leastindex",
  5362. "highestindex"
  5363. ],
  5364. "type": "string",
  5365. "description": "type of sort",
  5366. "name": "sort",
  5367. "in": "query"
  5368. },
  5369. {
  5370. "enum": [
  5371. "pending",
  5372. "success",
  5373. "error",
  5374. "failure",
  5375. "warning"
  5376. ],
  5377. "type": "string",
  5378. "description": "type of state",
  5379. "name": "state",
  5380. "in": "query"
  5381. },
  5382. {
  5383. "type": "integer",
  5384. "description": "page number of results to return (1-based)",
  5385. "name": "page",
  5386. "in": "query"
  5387. },
  5388. {
  5389. "type": "integer",
  5390. "description": "page size of results",
  5391. "name": "limit",
  5392. "in": "query"
  5393. }
  5394. ],
  5395. "responses": {
  5396. "200": {
  5397. "$ref": "#/responses/CommitStatusList"
  5398. },
  5399. "400": {
  5400. "$ref": "#/responses/error"
  5401. },
  5402. "404": {
  5403. "$ref": "#/responses/notFound"
  5404. }
  5405. }
  5406. }
  5407. },
  5408. "/repos/{owner}/{repo}/commits/{sha}/pull": {
  5409. "get": {
  5410. "produces": [
  5411. "application/json"
  5412. ],
  5413. "tags": [
  5414. "repository"
  5415. ],
  5416. "summary": "Get the pull request of the commit",
  5417. "operationId": "repoGetCommitPullRequest",
  5418. "parameters": [
  5419. {
  5420. "type": "string",
  5421. "description": "owner of the repo",
  5422. "name": "owner",
  5423. "in": "path",
  5424. "required": true
  5425. },
  5426. {
  5427. "type": "string",
  5428. "description": "name of the repo",
  5429. "name": "repo",
  5430. "in": "path",
  5431. "required": true
  5432. },
  5433. {
  5434. "type": "string",
  5435. "description": "SHA of the commit to get",
  5436. "name": "sha",
  5437. "in": "path",
  5438. "required": true
  5439. }
  5440. ],
  5441. "responses": {
  5442. "200": {
  5443. "$ref": "#/responses/PullRequest"
  5444. },
  5445. "404": {
  5446. "$ref": "#/responses/notFound"
  5447. }
  5448. }
  5449. }
  5450. },
  5451. "/repos/{owner}/{repo}/compare/{basehead}": {
  5452. "get": {
  5453. "produces": [
  5454. "application/json"
  5455. ],
  5456. "tags": [
  5457. "repository"
  5458. ],
  5459. "summary": "Get commit comparison information",
  5460. "operationId": "repoCompareDiff",
  5461. "parameters": [
  5462. {
  5463. "type": "string",
  5464. "description": "owner of the repo",
  5465. "name": "owner",
  5466. "in": "path",
  5467. "required": true
  5468. },
  5469. {
  5470. "type": "string",
  5471. "description": "name of the repo",
  5472. "name": "repo",
  5473. "in": "path",
  5474. "required": true
  5475. },
  5476. {
  5477. "type": "string",
  5478. "description": "compare two branches or commits",
  5479. "name": "basehead",
  5480. "in": "path",
  5481. "required": true
  5482. }
  5483. ],
  5484. "responses": {
  5485. "200": {
  5486. "$ref": "#/responses/Compare"
  5487. },
  5488. "404": {
  5489. "$ref": "#/responses/notFound"
  5490. }
  5491. }
  5492. }
  5493. },
  5494. "/repos/{owner}/{repo}/contents": {
  5495. "get": {
  5496. "produces": [
  5497. "application/json"
  5498. ],
  5499. "tags": [
  5500. "repository"
  5501. ],
  5502. "summary": "Gets the metadata of all the entries of the root dir",
  5503. "operationId": "repoGetContentsList",
  5504. "parameters": [
  5505. {
  5506. "type": "string",
  5507. "description": "owner of the repo",
  5508. "name": "owner",
  5509. "in": "path",
  5510. "required": true
  5511. },
  5512. {
  5513. "type": "string",
  5514. "description": "name of the repo",
  5515. "name": "repo",
  5516. "in": "path",
  5517. "required": true
  5518. },
  5519. {
  5520. "type": "string",
  5521. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  5522. "name": "ref",
  5523. "in": "query"
  5524. }
  5525. ],
  5526. "responses": {
  5527. "200": {
  5528. "$ref": "#/responses/ContentsListResponse"
  5529. },
  5530. "404": {
  5531. "$ref": "#/responses/notFound"
  5532. }
  5533. }
  5534. },
  5535. "post": {
  5536. "consumes": [
  5537. "application/json"
  5538. ],
  5539. "produces": [
  5540. "application/json"
  5541. ],
  5542. "tags": [
  5543. "repository"
  5544. ],
  5545. "summary": "Modify multiple files in a repository",
  5546. "operationId": "repoChangeFiles",
  5547. "parameters": [
  5548. {
  5549. "type": "string",
  5550. "description": "owner of the repo",
  5551. "name": "owner",
  5552. "in": "path",
  5553. "required": true
  5554. },
  5555. {
  5556. "type": "string",
  5557. "description": "name of the repo",
  5558. "name": "repo",
  5559. "in": "path",
  5560. "required": true
  5561. },
  5562. {
  5563. "name": "body",
  5564. "in": "body",
  5565. "required": true,
  5566. "schema": {
  5567. "$ref": "#/definitions/ChangeFilesOptions"
  5568. }
  5569. }
  5570. ],
  5571. "responses": {
  5572. "201": {
  5573. "$ref": "#/responses/FilesResponse"
  5574. },
  5575. "403": {
  5576. "$ref": "#/responses/error"
  5577. },
  5578. "404": {
  5579. "$ref": "#/responses/notFound"
  5580. },
  5581. "422": {
  5582. "$ref": "#/responses/error"
  5583. },
  5584. "423": {
  5585. "$ref": "#/responses/repoArchivedError"
  5586. }
  5587. }
  5588. }
  5589. },
  5590. "/repos/{owner}/{repo}/contents/{filepath}": {
  5591. "get": {
  5592. "produces": [
  5593. "application/json"
  5594. ],
  5595. "tags": [
  5596. "repository"
  5597. ],
  5598. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  5599. "operationId": "repoGetContents",
  5600. "parameters": [
  5601. {
  5602. "type": "string",
  5603. "description": "owner of the repo",
  5604. "name": "owner",
  5605. "in": "path",
  5606. "required": true
  5607. },
  5608. {
  5609. "type": "string",
  5610. "description": "name of the repo",
  5611. "name": "repo",
  5612. "in": "path",
  5613. "required": true
  5614. },
  5615. {
  5616. "type": "string",
  5617. "description": "path of the dir, file, symlink or submodule in the repo",
  5618. "name": "filepath",
  5619. "in": "path",
  5620. "required": true
  5621. },
  5622. {
  5623. "type": "string",
  5624. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  5625. "name": "ref",
  5626. "in": "query"
  5627. }
  5628. ],
  5629. "responses": {
  5630. "200": {
  5631. "$ref": "#/responses/ContentsResponse"
  5632. },
  5633. "404": {
  5634. "$ref": "#/responses/notFound"
  5635. }
  5636. }
  5637. },
  5638. "put": {
  5639. "consumes": [
  5640. "application/json"
  5641. ],
  5642. "produces": [
  5643. "application/json"
  5644. ],
  5645. "tags": [
  5646. "repository"
  5647. ],
  5648. "summary": "Update a file in a repository",
  5649. "operationId": "repoUpdateFile",
  5650. "parameters": [
  5651. {
  5652. "type": "string",
  5653. "description": "owner of the repo",
  5654. "name": "owner",
  5655. "in": "path",
  5656. "required": true
  5657. },
  5658. {
  5659. "type": "string",
  5660. "description": "name of the repo",
  5661. "name": "repo",
  5662. "in": "path",
  5663. "required": true
  5664. },
  5665. {
  5666. "type": "string",
  5667. "description": "path of the file to update",
  5668. "name": "filepath",
  5669. "in": "path",
  5670. "required": true
  5671. },
  5672. {
  5673. "name": "body",
  5674. "in": "body",
  5675. "required": true,
  5676. "schema": {
  5677. "$ref": "#/definitions/UpdateFileOptions"
  5678. }
  5679. }
  5680. ],
  5681. "responses": {
  5682. "200": {
  5683. "$ref": "#/responses/FileResponse"
  5684. },
  5685. "403": {
  5686. "$ref": "#/responses/error"
  5687. },
  5688. "404": {
  5689. "$ref": "#/responses/notFound"
  5690. },
  5691. "422": {
  5692. "$ref": "#/responses/error"
  5693. },
  5694. "423": {
  5695. "$ref": "#/responses/repoArchivedError"
  5696. }
  5697. }
  5698. },
  5699. "post": {
  5700. "consumes": [
  5701. "application/json"
  5702. ],
  5703. "produces": [
  5704. "application/json"
  5705. ],
  5706. "tags": [
  5707. "repository"
  5708. ],
  5709. "summary": "Create a file in a repository",
  5710. "operationId": "repoCreateFile",
  5711. "parameters": [
  5712. {
  5713. "type": "string",
  5714. "description": "owner of the repo",
  5715. "name": "owner",
  5716. "in": "path",
  5717. "required": true
  5718. },
  5719. {
  5720. "type": "string",
  5721. "description": "name of the repo",
  5722. "name": "repo",
  5723. "in": "path",
  5724. "required": true
  5725. },
  5726. {
  5727. "type": "string",
  5728. "description": "path of the file to create",
  5729. "name": "filepath",
  5730. "in": "path",
  5731. "required": true
  5732. },
  5733. {
  5734. "name": "body",
  5735. "in": "body",
  5736. "required": true,
  5737. "schema": {
  5738. "$ref": "#/definitions/CreateFileOptions"
  5739. }
  5740. }
  5741. ],
  5742. "responses": {
  5743. "201": {
  5744. "$ref": "#/responses/FileResponse"
  5745. },
  5746. "403": {
  5747. "$ref": "#/responses/error"
  5748. },
  5749. "404": {
  5750. "$ref": "#/responses/notFound"
  5751. },
  5752. "422": {
  5753. "$ref": "#/responses/error"
  5754. },
  5755. "423": {
  5756. "$ref": "#/responses/repoArchivedError"
  5757. }
  5758. }
  5759. },
  5760. "delete": {
  5761. "consumes": [
  5762. "application/json"
  5763. ],
  5764. "produces": [
  5765. "application/json"
  5766. ],
  5767. "tags": [
  5768. "repository"
  5769. ],
  5770. "summary": "Delete a file in a repository",
  5771. "operationId": "repoDeleteFile",
  5772. "parameters": [
  5773. {
  5774. "type": "string",
  5775. "description": "owner of the repo",
  5776. "name": "owner",
  5777. "in": "path",
  5778. "required": true
  5779. },
  5780. {
  5781. "type": "string",
  5782. "description": "name of the repo",
  5783. "name": "repo",
  5784. "in": "path",
  5785. "required": true
  5786. },
  5787. {
  5788. "type": "string",
  5789. "description": "path of the file to delete",
  5790. "name": "filepath",
  5791. "in": "path",
  5792. "required": true
  5793. },
  5794. {
  5795. "name": "body",
  5796. "in": "body",
  5797. "required": true,
  5798. "schema": {
  5799. "$ref": "#/definitions/DeleteFileOptions"
  5800. }
  5801. }
  5802. ],
  5803. "responses": {
  5804. "200": {
  5805. "$ref": "#/responses/FileDeleteResponse"
  5806. },
  5807. "400": {
  5808. "$ref": "#/responses/error"
  5809. },
  5810. "403": {
  5811. "$ref": "#/responses/error"
  5812. },
  5813. "404": {
  5814. "$ref": "#/responses/error"
  5815. },
  5816. "423": {
  5817. "$ref": "#/responses/repoArchivedError"
  5818. }
  5819. }
  5820. }
  5821. },
  5822. "/repos/{owner}/{repo}/diffpatch": {
  5823. "post": {
  5824. "consumes": [
  5825. "application/json"
  5826. ],
  5827. "produces": [
  5828. "application/json"
  5829. ],
  5830. "tags": [
  5831. "repository"
  5832. ],
  5833. "summary": "Apply diff patch to repository",
  5834. "operationId": "repoApplyDiffPatch",
  5835. "parameters": [
  5836. {
  5837. "type": "string",
  5838. "description": "owner of the repo",
  5839. "name": "owner",
  5840. "in": "path",
  5841. "required": true
  5842. },
  5843. {
  5844. "type": "string",
  5845. "description": "name of the repo",
  5846. "name": "repo",
  5847. "in": "path",
  5848. "required": true
  5849. },
  5850. {
  5851. "name": "body",
  5852. "in": "body",
  5853. "required": true,
  5854. "schema": {
  5855. "$ref": "#/definitions/UpdateFileOptions"
  5856. }
  5857. }
  5858. ],
  5859. "responses": {
  5860. "200": {
  5861. "$ref": "#/responses/FileResponse"
  5862. },
  5863. "404": {
  5864. "$ref": "#/responses/notFound"
  5865. },
  5866. "423": {
  5867. "$ref": "#/responses/repoArchivedError"
  5868. }
  5869. }
  5870. }
  5871. },
  5872. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  5873. "get": {
  5874. "produces": [
  5875. "application/json"
  5876. ],
  5877. "tags": [
  5878. "repository"
  5879. ],
  5880. "summary": "Get the EditorConfig definitions of a file in a repository",
  5881. "operationId": "repoGetEditorConfig",
  5882. "parameters": [
  5883. {
  5884. "type": "string",
  5885. "description": "owner of the repo",
  5886. "name": "owner",
  5887. "in": "path",
  5888. "required": true
  5889. },
  5890. {
  5891. "type": "string",
  5892. "description": "name of the repo",
  5893. "name": "repo",
  5894. "in": "path",
  5895. "required": true
  5896. },
  5897. {
  5898. "type": "string",
  5899. "description": "filepath of file to get",
  5900. "name": "filepath",
  5901. "in": "path",
  5902. "required": true
  5903. },
  5904. {
  5905. "type": "string",
  5906. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  5907. "name": "ref",
  5908. "in": "query"
  5909. }
  5910. ],
  5911. "responses": {
  5912. "200": {
  5913. "description": "success"
  5914. },
  5915. "404": {
  5916. "$ref": "#/responses/notFound"
  5917. }
  5918. }
  5919. }
  5920. },
  5921. "/repos/{owner}/{repo}/forks": {
  5922. "get": {
  5923. "produces": [
  5924. "application/json"
  5925. ],
  5926. "tags": [
  5927. "repository"
  5928. ],
  5929. "summary": "List a repository's forks",
  5930. "operationId": "listForks",
  5931. "parameters": [
  5932. {
  5933. "type": "string",
  5934. "description": "owner of the repo",
  5935. "name": "owner",
  5936. "in": "path",
  5937. "required": true
  5938. },
  5939. {
  5940. "type": "string",
  5941. "description": "name of the repo",
  5942. "name": "repo",
  5943. "in": "path",
  5944. "required": true
  5945. },
  5946. {
  5947. "type": "integer",
  5948. "description": "page number of results to return (1-based)",
  5949. "name": "page",
  5950. "in": "query"
  5951. },
  5952. {
  5953. "type": "integer",
  5954. "description": "page size of results",
  5955. "name": "limit",
  5956. "in": "query"
  5957. }
  5958. ],
  5959. "responses": {
  5960. "200": {
  5961. "$ref": "#/responses/RepositoryList"
  5962. },
  5963. "404": {
  5964. "$ref": "#/responses/notFound"
  5965. }
  5966. }
  5967. },
  5968. "post": {
  5969. "produces": [
  5970. "application/json"
  5971. ],
  5972. "tags": [
  5973. "repository"
  5974. ],
  5975. "summary": "Fork a repository",
  5976. "operationId": "createFork",
  5977. "parameters": [
  5978. {
  5979. "type": "string",
  5980. "description": "owner of the repo to fork",
  5981. "name": "owner",
  5982. "in": "path",
  5983. "required": true
  5984. },
  5985. {
  5986. "type": "string",
  5987. "description": "name of the repo to fork",
  5988. "name": "repo",
  5989. "in": "path",
  5990. "required": true
  5991. },
  5992. {
  5993. "name": "body",
  5994. "in": "body",
  5995. "schema": {
  5996. "$ref": "#/definitions/CreateForkOption"
  5997. }
  5998. }
  5999. ],
  6000. "responses": {
  6001. "202": {
  6002. "$ref": "#/responses/Repository"
  6003. },
  6004. "403": {
  6005. "$ref": "#/responses/forbidden"
  6006. },
  6007. "404": {
  6008. "$ref": "#/responses/notFound"
  6009. },
  6010. "409": {
  6011. "description": "The repository with the same name already exists."
  6012. },
  6013. "422": {
  6014. "$ref": "#/responses/validationError"
  6015. }
  6016. }
  6017. }
  6018. },
  6019. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  6020. "get": {
  6021. "produces": [
  6022. "application/json"
  6023. ],
  6024. "tags": [
  6025. "repository"
  6026. ],
  6027. "summary": "Gets the blob of a repository.",
  6028. "operationId": "GetBlob",
  6029. "parameters": [
  6030. {
  6031. "type": "string",
  6032. "description": "owner of the repo",
  6033. "name": "owner",
  6034. "in": "path",
  6035. "required": true
  6036. },
  6037. {
  6038. "type": "string",
  6039. "description": "name of the repo",
  6040. "name": "repo",
  6041. "in": "path",
  6042. "required": true
  6043. },
  6044. {
  6045. "type": "string",
  6046. "description": "sha of the commit",
  6047. "name": "sha",
  6048. "in": "path",
  6049. "required": true
  6050. }
  6051. ],
  6052. "responses": {
  6053. "200": {
  6054. "$ref": "#/responses/GitBlobResponse"
  6055. },
  6056. "400": {
  6057. "$ref": "#/responses/error"
  6058. },
  6059. "404": {
  6060. "$ref": "#/responses/notFound"
  6061. }
  6062. }
  6063. }
  6064. },
  6065. "/repos/{owner}/{repo}/git/commits/{sha}": {
  6066. "get": {
  6067. "produces": [
  6068. "application/json"
  6069. ],
  6070. "tags": [
  6071. "repository"
  6072. ],
  6073. "summary": "Get a single commit from a repository",
  6074. "operationId": "repoGetSingleCommit",
  6075. "parameters": [
  6076. {
  6077. "type": "string",
  6078. "description": "owner of the repo",
  6079. "name": "owner",
  6080. "in": "path",
  6081. "required": true
  6082. },
  6083. {
  6084. "type": "string",
  6085. "description": "name of the repo",
  6086. "name": "repo",
  6087. "in": "path",
  6088. "required": true
  6089. },
  6090. {
  6091. "type": "string",
  6092. "description": "a git ref or commit sha",
  6093. "name": "sha",
  6094. "in": "path",
  6095. "required": true
  6096. },
  6097. {
  6098. "type": "boolean",
  6099. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  6100. "name": "stat",
  6101. "in": "query"
  6102. },
  6103. {
  6104. "type": "boolean",
  6105. "description": "include verification for every commit (disable for speedup, default 'true')",
  6106. "name": "verification",
  6107. "in": "query"
  6108. },
  6109. {
  6110. "type": "boolean",
  6111. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  6112. "name": "files",
  6113. "in": "query"
  6114. }
  6115. ],
  6116. "responses": {
  6117. "200": {
  6118. "$ref": "#/responses/Commit"
  6119. },
  6120. "404": {
  6121. "$ref": "#/responses/notFound"
  6122. },
  6123. "422": {
  6124. "$ref": "#/responses/validationError"
  6125. }
  6126. }
  6127. }
  6128. },
  6129. "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
  6130. "get": {
  6131. "produces": [
  6132. "text/plain"
  6133. ],
  6134. "tags": [
  6135. "repository"
  6136. ],
  6137. "summary": "Get a commit's diff or patch",
  6138. "operationId": "repoDownloadCommitDiffOrPatch",
  6139. "parameters": [
  6140. {
  6141. "type": "string",
  6142. "description": "owner of the repo",
  6143. "name": "owner",
  6144. "in": "path",
  6145. "required": true
  6146. },
  6147. {
  6148. "type": "string",
  6149. "description": "name of the repo",
  6150. "name": "repo",
  6151. "in": "path",
  6152. "required": true
  6153. },
  6154. {
  6155. "type": "string",
  6156. "description": "SHA of the commit to get",
  6157. "name": "sha",
  6158. "in": "path",
  6159. "required": true
  6160. },
  6161. {
  6162. "enum": [
  6163. "diff",
  6164. "patch"
  6165. ],
  6166. "type": "string",
  6167. "description": "whether the output is diff or patch",
  6168. "name": "diffType",
  6169. "in": "path",
  6170. "required": true
  6171. }
  6172. ],
  6173. "responses": {
  6174. "200": {
  6175. "$ref": "#/responses/string"
  6176. },
  6177. "404": {
  6178. "$ref": "#/responses/notFound"
  6179. }
  6180. }
  6181. }
  6182. },
  6183. "/repos/{owner}/{repo}/git/notes/{sha}": {
  6184. "get": {
  6185. "produces": [
  6186. "application/json"
  6187. ],
  6188. "tags": [
  6189. "repository"
  6190. ],
  6191. "summary": "Get a note corresponding to a single commit from a repository",
  6192. "operationId": "repoGetNote",
  6193. "parameters": [
  6194. {
  6195. "type": "string",
  6196. "description": "owner of the repo",
  6197. "name": "owner",
  6198. "in": "path",
  6199. "required": true
  6200. },
  6201. {
  6202. "type": "string",
  6203. "description": "name of the repo",
  6204. "name": "repo",
  6205. "in": "path",
  6206. "required": true
  6207. },
  6208. {
  6209. "type": "string",
  6210. "description": "a git ref or commit sha",
  6211. "name": "sha",
  6212. "in": "path",
  6213. "required": true
  6214. },
  6215. {
  6216. "type": "boolean",
  6217. "description": "include verification for every commit (disable for speedup, default 'true')",
  6218. "name": "verification",
  6219. "in": "query"
  6220. },
  6221. {
  6222. "type": "boolean",
  6223. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  6224. "name": "files",
  6225. "in": "query"
  6226. }
  6227. ],
  6228. "responses": {
  6229. "200": {
  6230. "$ref": "#/responses/Note"
  6231. },
  6232. "404": {
  6233. "$ref": "#/responses/notFound"
  6234. },
  6235. "422": {
  6236. "$ref": "#/responses/validationError"
  6237. }
  6238. }
  6239. }
  6240. },
  6241. "/repos/{owner}/{repo}/git/refs": {
  6242. "get": {
  6243. "produces": [
  6244. "application/json"
  6245. ],
  6246. "tags": [
  6247. "repository"
  6248. ],
  6249. "summary": "Get specified ref or filtered repository's refs",
  6250. "operationId": "repoListAllGitRefs",
  6251. "parameters": [
  6252. {
  6253. "type": "string",
  6254. "description": "owner of the repo",
  6255. "name": "owner",
  6256. "in": "path",
  6257. "required": true
  6258. },
  6259. {
  6260. "type": "string",
  6261. "description": "name of the repo",
  6262. "name": "repo",
  6263. "in": "path",
  6264. "required": true
  6265. }
  6266. ],
  6267. "responses": {
  6268. "200": {
  6269. "$ref": "#/responses/ReferenceList"
  6270. },
  6271. "404": {
  6272. "$ref": "#/responses/notFound"
  6273. }
  6274. }
  6275. }
  6276. },
  6277. "/repos/{owner}/{repo}/git/refs/{ref}": {
  6278. "get": {
  6279. "produces": [
  6280. "application/json"
  6281. ],
  6282. "tags": [
  6283. "repository"
  6284. ],
  6285. "summary": "Get specified ref or filtered repository's refs",
  6286. "operationId": "repoListGitRefs",
  6287. "parameters": [
  6288. {
  6289. "type": "string",
  6290. "description": "owner of the repo",
  6291. "name": "owner",
  6292. "in": "path",
  6293. "required": true
  6294. },
  6295. {
  6296. "type": "string",
  6297. "description": "name of the repo",
  6298. "name": "repo",
  6299. "in": "path",
  6300. "required": true
  6301. },
  6302. {
  6303. "type": "string",
  6304. "description": "part or full name of the ref",
  6305. "name": "ref",
  6306. "in": "path",
  6307. "required": true
  6308. }
  6309. ],
  6310. "responses": {
  6311. "200": {
  6312. "$ref": "#/responses/ReferenceList"
  6313. },
  6314. "404": {
  6315. "$ref": "#/responses/notFound"
  6316. }
  6317. }
  6318. }
  6319. },
  6320. "/repos/{owner}/{repo}/git/tags/{sha}": {
  6321. "get": {
  6322. "produces": [
  6323. "application/json"
  6324. ],
  6325. "tags": [
  6326. "repository"
  6327. ],
  6328. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  6329. "operationId": "GetAnnotatedTag",
  6330. "parameters": [
  6331. {
  6332. "type": "string",
  6333. "description": "owner of the repo",
  6334. "name": "owner",
  6335. "in": "path",
  6336. "required": true
  6337. },
  6338. {
  6339. "type": "string",
  6340. "description": "name of the repo",
  6341. "name": "repo",
  6342. "in": "path",
  6343. "required": true
  6344. },
  6345. {
  6346. "type": "string",
  6347. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  6348. "name": "sha",
  6349. "in": "path",
  6350. "required": true
  6351. }
  6352. ],
  6353. "responses": {
  6354. "200": {
  6355. "$ref": "#/responses/AnnotatedTag"
  6356. },
  6357. "400": {
  6358. "$ref": "#/responses/error"
  6359. },
  6360. "404": {
  6361. "$ref": "#/responses/notFound"
  6362. }
  6363. }
  6364. }
  6365. },
  6366. "/repos/{owner}/{repo}/git/trees/{sha}": {
  6367. "get": {
  6368. "produces": [
  6369. "application/json"
  6370. ],
  6371. "tags": [
  6372. "repository"
  6373. ],
  6374. "summary": "Gets the tree of a repository.",
  6375. "operationId": "GetTree",
  6376. "parameters": [
  6377. {
  6378. "type": "string",
  6379. "description": "owner of the repo",
  6380. "name": "owner",
  6381. "in": "path",
  6382. "required": true
  6383. },
  6384. {
  6385. "type": "string",
  6386. "description": "name of the repo",
  6387. "name": "repo",
  6388. "in": "path",
  6389. "required": true
  6390. },
  6391. {
  6392. "type": "string",
  6393. "description": "sha of the commit",
  6394. "name": "sha",
  6395. "in": "path",
  6396. "required": true
  6397. },
  6398. {
  6399. "type": "boolean",
  6400. "description": "show all directories and files",
  6401. "name": "recursive",
  6402. "in": "query"
  6403. },
  6404. {
  6405. "type": "integer",
  6406. "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page",
  6407. "name": "page",
  6408. "in": "query"
  6409. },
  6410. {
  6411. "type": "integer",
  6412. "description": "number of items per page",
  6413. "name": "per_page",
  6414. "in": "query"
  6415. }
  6416. ],
  6417. "responses": {
  6418. "200": {
  6419. "$ref": "#/responses/GitTreeResponse"
  6420. },
  6421. "400": {
  6422. "$ref": "#/responses/error"
  6423. },
  6424. "404": {
  6425. "$ref": "#/responses/notFound"
  6426. }
  6427. }
  6428. }
  6429. },
  6430. "/repos/{owner}/{repo}/hooks": {
  6431. "get": {
  6432. "produces": [
  6433. "application/json"
  6434. ],
  6435. "tags": [
  6436. "repository"
  6437. ],
  6438. "summary": "List the hooks in a repository",
  6439. "operationId": "repoListHooks",
  6440. "parameters": [
  6441. {
  6442. "type": "string",
  6443. "description": "owner of the repo",
  6444. "name": "owner",
  6445. "in": "path",
  6446. "required": true
  6447. },
  6448. {
  6449. "type": "string",
  6450. "description": "name of the repo",
  6451. "name": "repo",
  6452. "in": "path",
  6453. "required": true
  6454. },
  6455. {
  6456. "type": "integer",
  6457. "description": "page number of results to return (1-based)",
  6458. "name": "page",
  6459. "in": "query"
  6460. },
  6461. {
  6462. "type": "integer",
  6463. "description": "page size of results",
  6464. "name": "limit",
  6465. "in": "query"
  6466. }
  6467. ],
  6468. "responses": {
  6469. "200": {
  6470. "$ref": "#/responses/HookList"
  6471. },
  6472. "404": {
  6473. "$ref": "#/responses/notFound"
  6474. }
  6475. }
  6476. },
  6477. "post": {
  6478. "consumes": [
  6479. "application/json"
  6480. ],
  6481. "produces": [
  6482. "application/json"
  6483. ],
  6484. "tags": [
  6485. "repository"
  6486. ],
  6487. "summary": "Create a hook",
  6488. "operationId": "repoCreateHook",
  6489. "parameters": [
  6490. {
  6491. "type": "string",
  6492. "description": "owner of the repo",
  6493. "name": "owner",
  6494. "in": "path",
  6495. "required": true
  6496. },
  6497. {
  6498. "type": "string",
  6499. "description": "name of the repo",
  6500. "name": "repo",
  6501. "in": "path",
  6502. "required": true
  6503. },
  6504. {
  6505. "name": "body",
  6506. "in": "body",
  6507. "schema": {
  6508. "$ref": "#/definitions/CreateHookOption"
  6509. }
  6510. }
  6511. ],
  6512. "responses": {
  6513. "201": {
  6514. "$ref": "#/responses/Hook"
  6515. },
  6516. "404": {
  6517. "$ref": "#/responses/notFound"
  6518. }
  6519. }
  6520. }
  6521. },
  6522. "/repos/{owner}/{repo}/hooks/git": {
  6523. "get": {
  6524. "produces": [
  6525. "application/json"
  6526. ],
  6527. "tags": [
  6528. "repository"
  6529. ],
  6530. "summary": "List the Git hooks in a repository",
  6531. "operationId": "repoListGitHooks",
  6532. "parameters": [
  6533. {
  6534. "type": "string",
  6535. "description": "owner of the repo",
  6536. "name": "owner",
  6537. "in": "path",
  6538. "required": true
  6539. },
  6540. {
  6541. "type": "string",
  6542. "description": "name of the repo",
  6543. "name": "repo",
  6544. "in": "path",
  6545. "required": true
  6546. }
  6547. ],
  6548. "responses": {
  6549. "200": {
  6550. "$ref": "#/responses/GitHookList"
  6551. },
  6552. "404": {
  6553. "$ref": "#/responses/notFound"
  6554. }
  6555. }
  6556. }
  6557. },
  6558. "/repos/{owner}/{repo}/hooks/git/{id}": {
  6559. "get": {
  6560. "produces": [
  6561. "application/json"
  6562. ],
  6563. "tags": [
  6564. "repository"
  6565. ],
  6566. "summary": "Get a Git hook",
  6567. "operationId": "repoGetGitHook",
  6568. "parameters": [
  6569. {
  6570. "type": "string",
  6571. "description": "owner of the repo",
  6572. "name": "owner",
  6573. "in": "path",
  6574. "required": true
  6575. },
  6576. {
  6577. "type": "string",
  6578. "description": "name of the repo",
  6579. "name": "repo",
  6580. "in": "path",
  6581. "required": true
  6582. },
  6583. {
  6584. "type": "string",
  6585. "description": "id of the hook to get",
  6586. "name": "id",
  6587. "in": "path",
  6588. "required": true
  6589. }
  6590. ],
  6591. "responses": {
  6592. "200": {
  6593. "$ref": "#/responses/GitHook"
  6594. },
  6595. "404": {
  6596. "$ref": "#/responses/notFound"
  6597. }
  6598. }
  6599. },
  6600. "delete": {
  6601. "produces": [
  6602. "application/json"
  6603. ],
  6604. "tags": [
  6605. "repository"
  6606. ],
  6607. "summary": "Delete a Git hook in a repository",
  6608. "operationId": "repoDeleteGitHook",
  6609. "parameters": [
  6610. {
  6611. "type": "string",
  6612. "description": "owner of the repo",
  6613. "name": "owner",
  6614. "in": "path",
  6615. "required": true
  6616. },
  6617. {
  6618. "type": "string",
  6619. "description": "name of the repo",
  6620. "name": "repo",
  6621. "in": "path",
  6622. "required": true
  6623. },
  6624. {
  6625. "type": "string",
  6626. "description": "id of the hook to get",
  6627. "name": "id",
  6628. "in": "path",
  6629. "required": true
  6630. }
  6631. ],
  6632. "responses": {
  6633. "204": {
  6634. "$ref": "#/responses/empty"
  6635. },
  6636. "404": {
  6637. "$ref": "#/responses/notFound"
  6638. }
  6639. }
  6640. },
  6641. "patch": {
  6642. "produces": [
  6643. "application/json"
  6644. ],
  6645. "tags": [
  6646. "repository"
  6647. ],
  6648. "summary": "Edit a Git hook in a repository",
  6649. "operationId": "repoEditGitHook",
  6650. "parameters": [
  6651. {
  6652. "type": "string",
  6653. "description": "owner of the repo",
  6654. "name": "owner",
  6655. "in": "path",
  6656. "required": true
  6657. },
  6658. {
  6659. "type": "string",
  6660. "description": "name of the repo",
  6661. "name": "repo",
  6662. "in": "path",
  6663. "required": true
  6664. },
  6665. {
  6666. "type": "string",
  6667. "description": "id of the hook to get",
  6668. "name": "id",
  6669. "in": "path",
  6670. "required": true
  6671. },
  6672. {
  6673. "name": "body",
  6674. "in": "body",
  6675. "schema": {
  6676. "$ref": "#/definitions/EditGitHookOption"
  6677. }
  6678. }
  6679. ],
  6680. "responses": {
  6681. "200": {
  6682. "$ref": "#/responses/GitHook"
  6683. },
  6684. "404": {
  6685. "$ref": "#/responses/notFound"
  6686. }
  6687. }
  6688. }
  6689. },
  6690. "/repos/{owner}/{repo}/hooks/{id}": {
  6691. "get": {
  6692. "produces": [
  6693. "application/json"
  6694. ],
  6695. "tags": [
  6696. "repository"
  6697. ],
  6698. "summary": "Get a hook",
  6699. "operationId": "repoGetHook",
  6700. "parameters": [
  6701. {
  6702. "type": "string",
  6703. "description": "owner of the repo",
  6704. "name": "owner",
  6705. "in": "path",
  6706. "required": true
  6707. },
  6708. {
  6709. "type": "string",
  6710. "description": "name of the repo",
  6711. "name": "repo",
  6712. "in": "path",
  6713. "required": true
  6714. },
  6715. {
  6716. "type": "integer",
  6717. "format": "int64",
  6718. "description": "id of the hook to get",
  6719. "name": "id",
  6720. "in": "path",
  6721. "required": true
  6722. }
  6723. ],
  6724. "responses": {
  6725. "200": {
  6726. "$ref": "#/responses/Hook"
  6727. },
  6728. "404": {
  6729. "$ref": "#/responses/notFound"
  6730. }
  6731. }
  6732. },
  6733. "delete": {
  6734. "produces": [
  6735. "application/json"
  6736. ],
  6737. "tags": [
  6738. "repository"
  6739. ],
  6740. "summary": "Delete a hook in a repository",
  6741. "operationId": "repoDeleteHook",
  6742. "parameters": [
  6743. {
  6744. "type": "string",
  6745. "description": "owner of the repo",
  6746. "name": "owner",
  6747. "in": "path",
  6748. "required": true
  6749. },
  6750. {
  6751. "type": "string",
  6752. "description": "name of the repo",
  6753. "name": "repo",
  6754. "in": "path",
  6755. "required": true
  6756. },
  6757. {
  6758. "type": "integer",
  6759. "format": "int64",
  6760. "description": "id of the hook to delete",
  6761. "name": "id",
  6762. "in": "path",
  6763. "required": true
  6764. }
  6765. ],
  6766. "responses": {
  6767. "204": {
  6768. "$ref": "#/responses/empty"
  6769. },
  6770. "404": {
  6771. "$ref": "#/responses/notFound"
  6772. }
  6773. }
  6774. },
  6775. "patch": {
  6776. "produces": [
  6777. "application/json"
  6778. ],
  6779. "tags": [
  6780. "repository"
  6781. ],
  6782. "summary": "Edit a hook in a repository",
  6783. "operationId": "repoEditHook",
  6784. "parameters": [
  6785. {
  6786. "type": "string",
  6787. "description": "owner of the repo",
  6788. "name": "owner",
  6789. "in": "path",
  6790. "required": true
  6791. },
  6792. {
  6793. "type": "string",
  6794. "description": "name of the repo",
  6795. "name": "repo",
  6796. "in": "path",
  6797. "required": true
  6798. },
  6799. {
  6800. "type": "integer",
  6801. "format": "int64",
  6802. "description": "index of the hook",
  6803. "name": "id",
  6804. "in": "path",
  6805. "required": true
  6806. },
  6807. {
  6808. "name": "body",
  6809. "in": "body",
  6810. "schema": {
  6811. "$ref": "#/definitions/EditHookOption"
  6812. }
  6813. }
  6814. ],
  6815. "responses": {
  6816. "200": {
  6817. "$ref": "#/responses/Hook"
  6818. },
  6819. "404": {
  6820. "$ref": "#/responses/notFound"
  6821. }
  6822. }
  6823. }
  6824. },
  6825. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  6826. "post": {
  6827. "produces": [
  6828. "application/json"
  6829. ],
  6830. "tags": [
  6831. "repository"
  6832. ],
  6833. "summary": "Test a push webhook",
  6834. "operationId": "repoTestHook",
  6835. "parameters": [
  6836. {
  6837. "type": "string",
  6838. "description": "owner of the repo",
  6839. "name": "owner",
  6840. "in": "path",
  6841. "required": true
  6842. },
  6843. {
  6844. "type": "string",
  6845. "description": "name of the repo",
  6846. "name": "repo",
  6847. "in": "path",
  6848. "required": true
  6849. },
  6850. {
  6851. "type": "integer",
  6852. "format": "int64",
  6853. "description": "id of the hook to test",
  6854. "name": "id",
  6855. "in": "path",
  6856. "required": true
  6857. },
  6858. {
  6859. "type": "string",
  6860. "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
  6861. "name": "ref",
  6862. "in": "query"
  6863. }
  6864. ],
  6865. "responses": {
  6866. "204": {
  6867. "$ref": "#/responses/empty"
  6868. },
  6869. "404": {
  6870. "$ref": "#/responses/notFound"
  6871. }
  6872. }
  6873. }
  6874. },
  6875. "/repos/{owner}/{repo}/issue_config": {
  6876. "get": {
  6877. "produces": [
  6878. "application/json"
  6879. ],
  6880. "tags": [
  6881. "repository"
  6882. ],
  6883. "summary": "Returns the issue config for a repo",
  6884. "operationId": "repoGetIssueConfig",
  6885. "parameters": [
  6886. {
  6887. "type": "string",
  6888. "description": "owner of the repo",
  6889. "name": "owner",
  6890. "in": "path",
  6891. "required": true
  6892. },
  6893. {
  6894. "type": "string",
  6895. "description": "name of the repo",
  6896. "name": "repo",
  6897. "in": "path",
  6898. "required": true
  6899. }
  6900. ],
  6901. "responses": {
  6902. "200": {
  6903. "$ref": "#/responses/RepoIssueConfig"
  6904. },
  6905. "404": {
  6906. "$ref": "#/responses/notFound"
  6907. }
  6908. }
  6909. }
  6910. },
  6911. "/repos/{owner}/{repo}/issue_config/validate": {
  6912. "get": {
  6913. "produces": [
  6914. "application/json"
  6915. ],
  6916. "tags": [
  6917. "repository"
  6918. ],
  6919. "summary": "Returns the validation information for a issue config",
  6920. "operationId": "repoValidateIssueConfig",
  6921. "parameters": [
  6922. {
  6923. "type": "string",
  6924. "description": "owner of the repo",
  6925. "name": "owner",
  6926. "in": "path",
  6927. "required": true
  6928. },
  6929. {
  6930. "type": "string",
  6931. "description": "name of the repo",
  6932. "name": "repo",
  6933. "in": "path",
  6934. "required": true
  6935. }
  6936. ],
  6937. "responses": {
  6938. "200": {
  6939. "$ref": "#/responses/RepoIssueConfigValidation"
  6940. },
  6941. "404": {
  6942. "$ref": "#/responses/notFound"
  6943. }
  6944. }
  6945. }
  6946. },
  6947. "/repos/{owner}/{repo}/issue_templates": {
  6948. "get": {
  6949. "produces": [
  6950. "application/json"
  6951. ],
  6952. "tags": [
  6953. "repository"
  6954. ],
  6955. "summary": "Get available issue templates for a repository",
  6956. "operationId": "repoGetIssueTemplates",
  6957. "parameters": [
  6958. {
  6959. "type": "string",
  6960. "description": "owner of the repo",
  6961. "name": "owner",
  6962. "in": "path",
  6963. "required": true
  6964. },
  6965. {
  6966. "type": "string",
  6967. "description": "name of the repo",
  6968. "name": "repo",
  6969. "in": "path",
  6970. "required": true
  6971. }
  6972. ],
  6973. "responses": {
  6974. "200": {
  6975. "$ref": "#/responses/IssueTemplates"
  6976. },
  6977. "404": {
  6978. "$ref": "#/responses/notFound"
  6979. }
  6980. }
  6981. }
  6982. },
  6983. "/repos/{owner}/{repo}/issues": {
  6984. "get": {
  6985. "produces": [
  6986. "application/json"
  6987. ],
  6988. "tags": [
  6989. "issue"
  6990. ],
  6991. "summary": "List a repository's issues",
  6992. "operationId": "issueListIssues",
  6993. "parameters": [
  6994. {
  6995. "type": "string",
  6996. "description": "owner of the repo",
  6997. "name": "owner",
  6998. "in": "path",
  6999. "required": true
  7000. },
  7001. {
  7002. "type": "string",
  7003. "description": "name of the repo",
  7004. "name": "repo",
  7005. "in": "path",
  7006. "required": true
  7007. },
  7008. {
  7009. "enum": [
  7010. "closed",
  7011. "open",
  7012. "all"
  7013. ],
  7014. "type": "string",
  7015. "description": "whether issue is open or closed",
  7016. "name": "state",
  7017. "in": "query"
  7018. },
  7019. {
  7020. "type": "string",
  7021. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  7022. "name": "labels",
  7023. "in": "query"
  7024. },
  7025. {
  7026. "type": "string",
  7027. "description": "search string",
  7028. "name": "q",
  7029. "in": "query"
  7030. },
  7031. {
  7032. "enum": [
  7033. "issues",
  7034. "pulls"
  7035. ],
  7036. "type": "string",
  7037. "description": "filter by type (issues / pulls) if set",
  7038. "name": "type",
  7039. "in": "query"
  7040. },
  7041. {
  7042. "type": "string",
  7043. "description": "comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded",
  7044. "name": "milestones",
  7045. "in": "query"
  7046. },
  7047. {
  7048. "type": "string",
  7049. "format": "date-time",
  7050. "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
  7051. "name": "since",
  7052. "in": "query"
  7053. },
  7054. {
  7055. "type": "string",
  7056. "format": "date-time",
  7057. "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
  7058. "name": "before",
  7059. "in": "query"
  7060. },
  7061. {
  7062. "type": "string",
  7063. "description": "Only show items which were created by the given user",
  7064. "name": "created_by",
  7065. "in": "query"
  7066. },
  7067. {
  7068. "type": "string",
  7069. "description": "Only show items for which the given user is assigned",
  7070. "name": "assigned_by",
  7071. "in": "query"
  7072. },
  7073. {
  7074. "type": "string",
  7075. "description": "Only show items in which the given user was mentioned",
  7076. "name": "mentioned_by",
  7077. "in": "query"
  7078. },
  7079. {
  7080. "type": "integer",
  7081. "description": "page number of results to return (1-based)",
  7082. "name": "page",
  7083. "in": "query"
  7084. },
  7085. {
  7086. "type": "integer",
  7087. "description": "page size of results",
  7088. "name": "limit",
  7089. "in": "query"
  7090. }
  7091. ],
  7092. "responses": {
  7093. "200": {
  7094. "$ref": "#/responses/IssueList"
  7095. },
  7096. "404": {
  7097. "$ref": "#/responses/notFound"
  7098. }
  7099. }
  7100. },
  7101. "post": {
  7102. "consumes": [
  7103. "application/json"
  7104. ],
  7105. "produces": [
  7106. "application/json"
  7107. ],
  7108. "tags": [
  7109. "issue"
  7110. ],
  7111. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  7112. "operationId": "issueCreateIssue",
  7113. "parameters": [
  7114. {
  7115. "type": "string",
  7116. "description": "owner of the repo",
  7117. "name": "owner",
  7118. "in": "path",
  7119. "required": true
  7120. },
  7121. {
  7122. "type": "string",
  7123. "description": "name of the repo",
  7124. "name": "repo",
  7125. "in": "path",
  7126. "required": true
  7127. },
  7128. {
  7129. "name": "body",
  7130. "in": "body",
  7131. "schema": {
  7132. "$ref": "#/definitions/CreateIssueOption"
  7133. }
  7134. }
  7135. ],
  7136. "responses": {
  7137. "201": {
  7138. "$ref": "#/responses/Issue"
  7139. },
  7140. "403": {
  7141. "$ref": "#/responses/forbidden"
  7142. },
  7143. "404": {
  7144. "$ref": "#/responses/notFound"
  7145. },
  7146. "412": {
  7147. "$ref": "#/responses/error"
  7148. },
  7149. "422": {
  7150. "$ref": "#/responses/validationError"
  7151. },
  7152. "423": {
  7153. "$ref": "#/responses/repoArchivedError"
  7154. }
  7155. }
  7156. }
  7157. },
  7158. "/repos/{owner}/{repo}/issues/comments": {
  7159. "get": {
  7160. "produces": [
  7161. "application/json"
  7162. ],
  7163. "tags": [
  7164. "issue"
  7165. ],
  7166. "summary": "List all comments in a repository",
  7167. "operationId": "issueGetRepoComments",
  7168. "parameters": [
  7169. {
  7170. "type": "string",
  7171. "description": "owner of the repo",
  7172. "name": "owner",
  7173. "in": "path",
  7174. "required": true
  7175. },
  7176. {
  7177. "type": "string",
  7178. "description": "name of the repo",
  7179. "name": "repo",
  7180. "in": "path",
  7181. "required": true
  7182. },
  7183. {
  7184. "type": "string",
  7185. "format": "date-time",
  7186. "description": "if provided, only comments updated since the provided time are returned.",
  7187. "name": "since",
  7188. "in": "query"
  7189. },
  7190. {
  7191. "type": "string",
  7192. "format": "date-time",
  7193. "description": "if provided, only comments updated before the provided time are returned.",
  7194. "name": "before",
  7195. "in": "query"
  7196. },
  7197. {
  7198. "type": "integer",
  7199. "description": "page number of results to return (1-based)",
  7200. "name": "page",
  7201. "in": "query"
  7202. },
  7203. {
  7204. "type": "integer",
  7205. "description": "page size of results",
  7206. "name": "limit",
  7207. "in": "query"
  7208. }
  7209. ],
  7210. "responses": {
  7211. "200": {
  7212. "$ref": "#/responses/CommentList"
  7213. },
  7214. "404": {
  7215. "$ref": "#/responses/notFound"
  7216. }
  7217. }
  7218. }
  7219. },
  7220. "/repos/{owner}/{repo}/issues/comments/{id}": {
  7221. "get": {
  7222. "consumes": [
  7223. "application/json"
  7224. ],
  7225. "produces": [
  7226. "application/json"
  7227. ],
  7228. "tags": [
  7229. "issue"
  7230. ],
  7231. "summary": "Get a comment",
  7232. "operationId": "issueGetComment",
  7233. "parameters": [
  7234. {
  7235. "type": "string",
  7236. "description": "owner of the repo",
  7237. "name": "owner",
  7238. "in": "path",
  7239. "required": true
  7240. },
  7241. {
  7242. "type": "string",
  7243. "description": "name of the repo",
  7244. "name": "repo",
  7245. "in": "path",
  7246. "required": true
  7247. },
  7248. {
  7249. "type": "integer",
  7250. "format": "int64",
  7251. "description": "id of the comment",
  7252. "name": "id",
  7253. "in": "path",
  7254. "required": true
  7255. }
  7256. ],
  7257. "responses": {
  7258. "200": {
  7259. "$ref": "#/responses/Comment"
  7260. },
  7261. "204": {
  7262. "$ref": "#/responses/empty"
  7263. },
  7264. "403": {
  7265. "$ref": "#/responses/forbidden"
  7266. },
  7267. "404": {
  7268. "$ref": "#/responses/notFound"
  7269. }
  7270. }
  7271. },
  7272. "delete": {
  7273. "tags": [
  7274. "issue"
  7275. ],
  7276. "summary": "Delete a comment",
  7277. "operationId": "issueDeleteComment",
  7278. "parameters": [
  7279. {
  7280. "type": "string",
  7281. "description": "owner of the repo",
  7282. "name": "owner",
  7283. "in": "path",
  7284. "required": true
  7285. },
  7286. {
  7287. "type": "string",
  7288. "description": "name of the repo",
  7289. "name": "repo",
  7290. "in": "path",
  7291. "required": true
  7292. },
  7293. {
  7294. "type": "integer",
  7295. "format": "int64",
  7296. "description": "id of comment to delete",
  7297. "name": "id",
  7298. "in": "path",
  7299. "required": true
  7300. }
  7301. ],
  7302. "responses": {
  7303. "204": {
  7304. "$ref": "#/responses/empty"
  7305. },
  7306. "403": {
  7307. "$ref": "#/responses/forbidden"
  7308. },
  7309. "404": {
  7310. "$ref": "#/responses/notFound"
  7311. }
  7312. }
  7313. },
  7314. "patch": {
  7315. "consumes": [
  7316. "application/json"
  7317. ],
  7318. "produces": [
  7319. "application/json"
  7320. ],
  7321. "tags": [
  7322. "issue"
  7323. ],
  7324. "summary": "Edit a comment",
  7325. "operationId": "issueEditComment",
  7326. "parameters": [
  7327. {
  7328. "type": "string",
  7329. "description": "owner of the repo",
  7330. "name": "owner",
  7331. "in": "path",
  7332. "required": true
  7333. },
  7334. {
  7335. "type": "string",
  7336. "description": "name of the repo",
  7337. "name": "repo",
  7338. "in": "path",
  7339. "required": true
  7340. },
  7341. {
  7342. "type": "integer",
  7343. "format": "int64",
  7344. "description": "id of the comment to edit",
  7345. "name": "id",
  7346. "in": "path",
  7347. "required": true
  7348. },
  7349. {
  7350. "name": "body",
  7351. "in": "body",
  7352. "schema": {
  7353. "$ref": "#/definitions/EditIssueCommentOption"
  7354. }
  7355. }
  7356. ],
  7357. "responses": {
  7358. "200": {
  7359. "$ref": "#/responses/Comment"
  7360. },
  7361. "204": {
  7362. "$ref": "#/responses/empty"
  7363. },
  7364. "403": {
  7365. "$ref": "#/responses/forbidden"
  7366. },
  7367. "404": {
  7368. "$ref": "#/responses/notFound"
  7369. },
  7370. "423": {
  7371. "$ref": "#/responses/repoArchivedError"
  7372. }
  7373. }
  7374. }
  7375. },
  7376. "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
  7377. "get": {
  7378. "produces": [
  7379. "application/json"
  7380. ],
  7381. "tags": [
  7382. "issue"
  7383. ],
  7384. "summary": "List comment's attachments",
  7385. "operationId": "issueListIssueCommentAttachments",
  7386. "parameters": [
  7387. {
  7388. "type": "string",
  7389. "description": "owner of the repo",
  7390. "name": "owner",
  7391. "in": "path",
  7392. "required": true
  7393. },
  7394. {
  7395. "type": "string",
  7396. "description": "name of the repo",
  7397. "name": "repo",
  7398. "in": "path",
  7399. "required": true
  7400. },
  7401. {
  7402. "type": "integer",
  7403. "format": "int64",
  7404. "description": "id of the comment",
  7405. "name": "id",
  7406. "in": "path",
  7407. "required": true
  7408. }
  7409. ],
  7410. "responses": {
  7411. "200": {
  7412. "$ref": "#/responses/AttachmentList"
  7413. },
  7414. "404": {
  7415. "$ref": "#/responses/error"
  7416. }
  7417. }
  7418. },
  7419. "post": {
  7420. "consumes": [
  7421. "multipart/form-data"
  7422. ],
  7423. "produces": [
  7424. "application/json"
  7425. ],
  7426. "tags": [
  7427. "issue"
  7428. ],
  7429. "summary": "Create a comment attachment",
  7430. "operationId": "issueCreateIssueCommentAttachment",
  7431. "parameters": [
  7432. {
  7433. "type": "string",
  7434. "description": "owner of the repo",
  7435. "name": "owner",
  7436. "in": "path",
  7437. "required": true
  7438. },
  7439. {
  7440. "type": "string",
  7441. "description": "name of the repo",
  7442. "name": "repo",
  7443. "in": "path",
  7444. "required": true
  7445. },
  7446. {
  7447. "type": "integer",
  7448. "format": "int64",
  7449. "description": "id of the comment",
  7450. "name": "id",
  7451. "in": "path",
  7452. "required": true
  7453. },
  7454. {
  7455. "type": "string",
  7456. "description": "name of the attachment",
  7457. "name": "name",
  7458. "in": "query"
  7459. },
  7460. {
  7461. "type": "file",
  7462. "description": "attachment to upload",
  7463. "name": "attachment",
  7464. "in": "formData",
  7465. "required": true
  7466. }
  7467. ],
  7468. "responses": {
  7469. "201": {
  7470. "$ref": "#/responses/Attachment"
  7471. },
  7472. "400": {
  7473. "$ref": "#/responses/error"
  7474. },
  7475. "403": {
  7476. "$ref": "#/responses/forbidden"
  7477. },
  7478. "404": {
  7479. "$ref": "#/responses/error"
  7480. },
  7481. "422": {
  7482. "$ref": "#/responses/validationError"
  7483. },
  7484. "423": {
  7485. "$ref": "#/responses/repoArchivedError"
  7486. }
  7487. }
  7488. }
  7489. },
  7490. "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
  7491. "get": {
  7492. "produces": [
  7493. "application/json"
  7494. ],
  7495. "tags": [
  7496. "issue"
  7497. ],
  7498. "summary": "Get a comment attachment",
  7499. "operationId": "issueGetIssueCommentAttachment",
  7500. "parameters": [
  7501. {
  7502. "type": "string",
  7503. "description": "owner of the repo",
  7504. "name": "owner",
  7505. "in": "path",
  7506. "required": true
  7507. },
  7508. {
  7509. "type": "string",
  7510. "description": "name of the repo",
  7511. "name": "repo",
  7512. "in": "path",
  7513. "required": true
  7514. },
  7515. {
  7516. "type": "integer",
  7517. "format": "int64",
  7518. "description": "id of the comment",
  7519. "name": "id",
  7520. "in": "path",
  7521. "required": true
  7522. },
  7523. {
  7524. "type": "integer",
  7525. "format": "int64",
  7526. "description": "id of the attachment to get",
  7527. "name": "attachment_id",
  7528. "in": "path",
  7529. "required": true
  7530. }
  7531. ],
  7532. "responses": {
  7533. "200": {
  7534. "$ref": "#/responses/Attachment"
  7535. },
  7536. "404": {
  7537. "$ref": "#/responses/error"
  7538. }
  7539. }
  7540. },
  7541. "delete": {
  7542. "produces": [
  7543. "application/json"
  7544. ],
  7545. "tags": [
  7546. "issue"
  7547. ],
  7548. "summary": "Delete a comment attachment",
  7549. "operationId": "issueDeleteIssueCommentAttachment",
  7550. "parameters": [
  7551. {
  7552. "type": "string",
  7553. "description": "owner of the repo",
  7554. "name": "owner",
  7555. "in": "path",
  7556. "required": true
  7557. },
  7558. {
  7559. "type": "string",
  7560. "description": "name of the repo",
  7561. "name": "repo",
  7562. "in": "path",
  7563. "required": true
  7564. },
  7565. {
  7566. "type": "integer",
  7567. "format": "int64",
  7568. "description": "id of the comment",
  7569. "name": "id",
  7570. "in": "path",
  7571. "required": true
  7572. },
  7573. {
  7574. "type": "integer",
  7575. "format": "int64",
  7576. "description": "id of the attachment to delete",
  7577. "name": "attachment_id",
  7578. "in": "path",
  7579. "required": true
  7580. }
  7581. ],
  7582. "responses": {
  7583. "204": {
  7584. "$ref": "#/responses/empty"
  7585. },
  7586. "404": {
  7587. "$ref": "#/responses/error"
  7588. },
  7589. "423": {
  7590. "$ref": "#/responses/repoArchivedError"
  7591. }
  7592. }
  7593. },
  7594. "patch": {
  7595. "consumes": [
  7596. "application/json"
  7597. ],
  7598. "produces": [
  7599. "application/json"
  7600. ],
  7601. "tags": [
  7602. "issue"
  7603. ],
  7604. "summary": "Edit a comment attachment",
  7605. "operationId": "issueEditIssueCommentAttachment",
  7606. "parameters": [
  7607. {
  7608. "type": "string",
  7609. "description": "owner of the repo",
  7610. "name": "owner",
  7611. "in": "path",
  7612. "required": true
  7613. },
  7614. {
  7615. "type": "string",
  7616. "description": "name of the repo",
  7617. "name": "repo",
  7618. "in": "path",
  7619. "required": true
  7620. },
  7621. {
  7622. "type": "integer",
  7623. "format": "int64",
  7624. "description": "id of the comment",
  7625. "name": "id",
  7626. "in": "path",
  7627. "required": true
  7628. },
  7629. {
  7630. "type": "integer",
  7631. "format": "int64",
  7632. "description": "id of the attachment to edit",
  7633. "name": "attachment_id",
  7634. "in": "path",
  7635. "required": true
  7636. },
  7637. {
  7638. "name": "body",
  7639. "in": "body",
  7640. "schema": {
  7641. "$ref": "#/definitions/EditAttachmentOptions"
  7642. }
  7643. }
  7644. ],
  7645. "responses": {
  7646. "201": {
  7647. "$ref": "#/responses/Attachment"
  7648. },
  7649. "404": {
  7650. "$ref": "#/responses/error"
  7651. },
  7652. "423": {
  7653. "$ref": "#/responses/repoArchivedError"
  7654. }
  7655. }
  7656. }
  7657. },
  7658. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  7659. "get": {
  7660. "consumes": [
  7661. "application/json"
  7662. ],
  7663. "produces": [
  7664. "application/json"
  7665. ],
  7666. "tags": [
  7667. "issue"
  7668. ],
  7669. "summary": "Get a list of reactions from a comment of an issue",
  7670. "operationId": "issueGetCommentReactions",
  7671. "parameters": [
  7672. {
  7673. "type": "string",
  7674. "description": "owner of the repo",
  7675. "name": "owner",
  7676. "in": "path",
  7677. "required": true
  7678. },
  7679. {
  7680. "type": "string",
  7681. "description": "name of the repo",
  7682. "name": "repo",
  7683. "in": "path",
  7684. "required": true
  7685. },
  7686. {
  7687. "type": "integer",
  7688. "format": "int64",
  7689. "description": "id of the comment to edit",
  7690. "name": "id",
  7691. "in": "path",
  7692. "required": true
  7693. }
  7694. ],
  7695. "responses": {
  7696. "200": {
  7697. "$ref": "#/responses/ReactionList"
  7698. },
  7699. "403": {
  7700. "$ref": "#/responses/forbidden"
  7701. },
  7702. "404": {
  7703. "$ref": "#/responses/notFound"
  7704. }
  7705. }
  7706. },
  7707. "post": {
  7708. "consumes": [
  7709. "application/json"
  7710. ],
  7711. "produces": [
  7712. "application/json"
  7713. ],
  7714. "tags": [
  7715. "issue"
  7716. ],
  7717. "summary": "Add a reaction to a comment of an issue",
  7718. "operationId": "issuePostCommentReaction",
  7719. "parameters": [
  7720. {
  7721. "type": "string",
  7722. "description": "owner of the repo",
  7723. "name": "owner",
  7724. "in": "path",
  7725. "required": true
  7726. },
  7727. {
  7728. "type": "string",
  7729. "description": "name of the repo",
  7730. "name": "repo",
  7731. "in": "path",
  7732. "required": true
  7733. },
  7734. {
  7735. "type": "integer",
  7736. "format": "int64",
  7737. "description": "id of the comment to edit",
  7738. "name": "id",
  7739. "in": "path",
  7740. "required": true
  7741. },
  7742. {
  7743. "name": "content",
  7744. "in": "body",
  7745. "schema": {
  7746. "$ref": "#/definitions/EditReactionOption"
  7747. }
  7748. }
  7749. ],
  7750. "responses": {
  7751. "200": {
  7752. "$ref": "#/responses/Reaction"
  7753. },
  7754. "201": {
  7755. "$ref": "#/responses/Reaction"
  7756. },
  7757. "403": {
  7758. "$ref": "#/responses/forbidden"
  7759. },
  7760. "404": {
  7761. "$ref": "#/responses/notFound"
  7762. }
  7763. }
  7764. },
  7765. "delete": {
  7766. "consumes": [
  7767. "application/json"
  7768. ],
  7769. "produces": [
  7770. "application/json"
  7771. ],
  7772. "tags": [
  7773. "issue"
  7774. ],
  7775. "summary": "Remove a reaction from a comment of an issue",
  7776. "operationId": "issueDeleteCommentReaction",
  7777. "parameters": [
  7778. {
  7779. "type": "string",
  7780. "description": "owner of the repo",
  7781. "name": "owner",
  7782. "in": "path",
  7783. "required": true
  7784. },
  7785. {
  7786. "type": "string",
  7787. "description": "name of the repo",
  7788. "name": "repo",
  7789. "in": "path",
  7790. "required": true
  7791. },
  7792. {
  7793. "type": "integer",
  7794. "format": "int64",
  7795. "description": "id of the comment to edit",
  7796. "name": "id",
  7797. "in": "path",
  7798. "required": true
  7799. },
  7800. {
  7801. "name": "content",
  7802. "in": "body",
  7803. "schema": {
  7804. "$ref": "#/definitions/EditReactionOption"
  7805. }
  7806. }
  7807. ],
  7808. "responses": {
  7809. "200": {
  7810. "$ref": "#/responses/empty"
  7811. },
  7812. "403": {
  7813. "$ref": "#/responses/forbidden"
  7814. },
  7815. "404": {
  7816. "$ref": "#/responses/notFound"
  7817. }
  7818. }
  7819. }
  7820. },
  7821. "/repos/{owner}/{repo}/issues/pinned": {
  7822. "get": {
  7823. "produces": [
  7824. "application/json"
  7825. ],
  7826. "tags": [
  7827. "repository"
  7828. ],
  7829. "summary": "List a repo's pinned issues",
  7830. "operationId": "repoListPinnedIssues",
  7831. "parameters": [
  7832. {
  7833. "type": "string",
  7834. "description": "owner of the repo",
  7835. "name": "owner",
  7836. "in": "path",
  7837. "required": true
  7838. },
  7839. {
  7840. "type": "string",
  7841. "description": "name of the repo",
  7842. "name": "repo",
  7843. "in": "path",
  7844. "required": true
  7845. }
  7846. ],
  7847. "responses": {
  7848. "200": {
  7849. "$ref": "#/responses/IssueList"
  7850. },
  7851. "404": {
  7852. "$ref": "#/responses/notFound"
  7853. }
  7854. }
  7855. }
  7856. },
  7857. "/repos/{owner}/{repo}/issues/{index}": {
  7858. "get": {
  7859. "produces": [
  7860. "application/json"
  7861. ],
  7862. "tags": [
  7863. "issue"
  7864. ],
  7865. "summary": "Get an issue",
  7866. "operationId": "issueGetIssue",
  7867. "parameters": [
  7868. {
  7869. "type": "string",
  7870. "description": "owner of the repo",
  7871. "name": "owner",
  7872. "in": "path",
  7873. "required": true
  7874. },
  7875. {
  7876. "type": "string",
  7877. "description": "name of the repo",
  7878. "name": "repo",
  7879. "in": "path",
  7880. "required": true
  7881. },
  7882. {
  7883. "type": "integer",
  7884. "format": "int64",
  7885. "description": "index of the issue to get",
  7886. "name": "index",
  7887. "in": "path",
  7888. "required": true
  7889. }
  7890. ],
  7891. "responses": {
  7892. "200": {
  7893. "$ref": "#/responses/Issue"
  7894. },
  7895. "404": {
  7896. "$ref": "#/responses/notFound"
  7897. }
  7898. }
  7899. },
  7900. "delete": {
  7901. "tags": [
  7902. "issue"
  7903. ],
  7904. "summary": "Delete an issue",
  7905. "operationId": "issueDelete",
  7906. "parameters": [
  7907. {
  7908. "type": "string",
  7909. "description": "owner of the repo",
  7910. "name": "owner",
  7911. "in": "path",
  7912. "required": true
  7913. },
  7914. {
  7915. "type": "string",
  7916. "description": "name of the repo",
  7917. "name": "repo",
  7918. "in": "path",
  7919. "required": true
  7920. },
  7921. {
  7922. "type": "integer",
  7923. "format": "int64",
  7924. "description": "index of issue to delete",
  7925. "name": "index",
  7926. "in": "path",
  7927. "required": true
  7928. }
  7929. ],
  7930. "responses": {
  7931. "204": {
  7932. "$ref": "#/responses/empty"
  7933. },
  7934. "403": {
  7935. "$ref": "#/responses/forbidden"
  7936. },
  7937. "404": {
  7938. "$ref": "#/responses/notFound"
  7939. }
  7940. }
  7941. },
  7942. "patch": {
  7943. "consumes": [
  7944. "application/json"
  7945. ],
  7946. "produces": [
  7947. "application/json"
  7948. ],
  7949. "tags": [
  7950. "issue"
  7951. ],
  7952. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  7953. "operationId": "issueEditIssue",
  7954. "parameters": [
  7955. {
  7956. "type": "string",
  7957. "description": "owner of the repo",
  7958. "name": "owner",
  7959. "in": "path",
  7960. "required": true
  7961. },
  7962. {
  7963. "type": "string",
  7964. "description": "name of the repo",
  7965. "name": "repo",
  7966. "in": "path",
  7967. "required": true
  7968. },
  7969. {
  7970. "type": "integer",
  7971. "format": "int64",
  7972. "description": "index of the issue to edit",
  7973. "name": "index",
  7974. "in": "path",
  7975. "required": true
  7976. },
  7977. {
  7978. "name": "body",
  7979. "in": "body",
  7980. "schema": {
  7981. "$ref": "#/definitions/EditIssueOption"
  7982. }
  7983. }
  7984. ],
  7985. "responses": {
  7986. "201": {
  7987. "$ref": "#/responses/Issue"
  7988. },
  7989. "403": {
  7990. "$ref": "#/responses/forbidden"
  7991. },
  7992. "404": {
  7993. "$ref": "#/responses/notFound"
  7994. },
  7995. "412": {
  7996. "$ref": "#/responses/error"
  7997. }
  7998. }
  7999. }
  8000. },
  8001. "/repos/{owner}/{repo}/issues/{index}/assets": {
  8002. "get": {
  8003. "produces": [
  8004. "application/json"
  8005. ],
  8006. "tags": [
  8007. "issue"
  8008. ],
  8009. "summary": "List issue's attachments",
  8010. "operationId": "issueListIssueAttachments",
  8011. "parameters": [
  8012. {
  8013. "type": "string",
  8014. "description": "owner of the repo",
  8015. "name": "owner",
  8016. "in": "path",
  8017. "required": true
  8018. },
  8019. {
  8020. "type": "string",
  8021. "description": "name of the repo",
  8022. "name": "repo",
  8023. "in": "path",
  8024. "required": true
  8025. },
  8026. {
  8027. "type": "integer",
  8028. "format": "int64",
  8029. "description": "index of the issue",
  8030. "name": "index",
  8031. "in": "path",
  8032. "required": true
  8033. }
  8034. ],
  8035. "responses": {
  8036. "200": {
  8037. "$ref": "#/responses/AttachmentList"
  8038. },
  8039. "404": {
  8040. "$ref": "#/responses/error"
  8041. }
  8042. }
  8043. },
  8044. "post": {
  8045. "consumes": [
  8046. "multipart/form-data"
  8047. ],
  8048. "produces": [
  8049. "application/json"
  8050. ],
  8051. "tags": [
  8052. "issue"
  8053. ],
  8054. "summary": "Create an issue attachment",
  8055. "operationId": "issueCreateIssueAttachment",
  8056. "parameters": [
  8057. {
  8058. "type": "string",
  8059. "description": "owner of the repo",
  8060. "name": "owner",
  8061. "in": "path",
  8062. "required": true
  8063. },
  8064. {
  8065. "type": "string",
  8066. "description": "name of the repo",
  8067. "name": "repo",
  8068. "in": "path",
  8069. "required": true
  8070. },
  8071. {
  8072. "type": "integer",
  8073. "format": "int64",
  8074. "description": "index of the issue",
  8075. "name": "index",
  8076. "in": "path",
  8077. "required": true
  8078. },
  8079. {
  8080. "type": "string",
  8081. "description": "name of the attachment",
  8082. "name": "name",
  8083. "in": "query"
  8084. },
  8085. {
  8086. "type": "file",
  8087. "description": "attachment to upload",
  8088. "name": "attachment",
  8089. "in": "formData",
  8090. "required": true
  8091. }
  8092. ],
  8093. "responses": {
  8094. "201": {
  8095. "$ref": "#/responses/Attachment"
  8096. },
  8097. "400": {
  8098. "$ref": "#/responses/error"
  8099. },
  8100. "404": {
  8101. "$ref": "#/responses/error"
  8102. },
  8103. "422": {
  8104. "$ref": "#/responses/validationError"
  8105. },
  8106. "423": {
  8107. "$ref": "#/responses/repoArchivedError"
  8108. }
  8109. }
  8110. }
  8111. },
  8112. "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
  8113. "get": {
  8114. "produces": [
  8115. "application/json"
  8116. ],
  8117. "tags": [
  8118. "issue"
  8119. ],
  8120. "summary": "Get an issue attachment",
  8121. "operationId": "issueGetIssueAttachment",
  8122. "parameters": [
  8123. {
  8124. "type": "string",
  8125. "description": "owner of the repo",
  8126. "name": "owner",
  8127. "in": "path",
  8128. "required": true
  8129. },
  8130. {
  8131. "type": "string",
  8132. "description": "name of the repo",
  8133. "name": "repo",
  8134. "in": "path",
  8135. "required": true
  8136. },
  8137. {
  8138. "type": "integer",
  8139. "format": "int64",
  8140. "description": "index of the issue",
  8141. "name": "index",
  8142. "in": "path",
  8143. "required": true
  8144. },
  8145. {
  8146. "type": "integer",
  8147. "format": "int64",
  8148. "description": "id of the attachment to get",
  8149. "name": "attachment_id",
  8150. "in": "path",
  8151. "required": true
  8152. }
  8153. ],
  8154. "responses": {
  8155. "200": {
  8156. "$ref": "#/responses/Attachment"
  8157. },
  8158. "404": {
  8159. "$ref": "#/responses/error"
  8160. }
  8161. }
  8162. },
  8163. "delete": {
  8164. "produces": [
  8165. "application/json"
  8166. ],
  8167. "tags": [
  8168. "issue"
  8169. ],
  8170. "summary": "Delete an issue attachment",
  8171. "operationId": "issueDeleteIssueAttachment",
  8172. "parameters": [
  8173. {
  8174. "type": "string",
  8175. "description": "owner of the repo",
  8176. "name": "owner",
  8177. "in": "path",
  8178. "required": true
  8179. },
  8180. {
  8181. "type": "string",
  8182. "description": "name of the repo",
  8183. "name": "repo",
  8184. "in": "path",
  8185. "required": true
  8186. },
  8187. {
  8188. "type": "integer",
  8189. "format": "int64",
  8190. "description": "index of the issue",
  8191. "name": "index",
  8192. "in": "path",
  8193. "required": true
  8194. },
  8195. {
  8196. "type": "integer",
  8197. "format": "int64",
  8198. "description": "id of the attachment to delete",
  8199. "name": "attachment_id",
  8200. "in": "path",
  8201. "required": true
  8202. }
  8203. ],
  8204. "responses": {
  8205. "204": {
  8206. "$ref": "#/responses/empty"
  8207. },
  8208. "404": {
  8209. "$ref": "#/responses/error"
  8210. },
  8211. "423": {
  8212. "$ref": "#/responses/repoArchivedError"
  8213. }
  8214. }
  8215. },
  8216. "patch": {
  8217. "consumes": [
  8218. "application/json"
  8219. ],
  8220. "produces": [
  8221. "application/json"
  8222. ],
  8223. "tags": [
  8224. "issue"
  8225. ],
  8226. "summary": "Edit an issue attachment",
  8227. "operationId": "issueEditIssueAttachment",
  8228. "parameters": [
  8229. {
  8230. "type": "string",
  8231. "description": "owner of the repo",
  8232. "name": "owner",
  8233. "in": "path",
  8234. "required": true
  8235. },
  8236. {
  8237. "type": "string",
  8238. "description": "name of the repo",
  8239. "name": "repo",
  8240. "in": "path",
  8241. "required": true
  8242. },
  8243. {
  8244. "type": "integer",
  8245. "format": "int64",
  8246. "description": "index of the issue",
  8247. "name": "index",
  8248. "in": "path",
  8249. "required": true
  8250. },
  8251. {
  8252. "type": "integer",
  8253. "format": "int64",
  8254. "description": "id of the attachment to edit",
  8255. "name": "attachment_id",
  8256. "in": "path",
  8257. "required": true
  8258. },
  8259. {
  8260. "name": "body",
  8261. "in": "body",
  8262. "schema": {
  8263. "$ref": "#/definitions/EditAttachmentOptions"
  8264. }
  8265. }
  8266. ],
  8267. "responses": {
  8268. "201": {
  8269. "$ref": "#/responses/Attachment"
  8270. },
  8271. "404": {
  8272. "$ref": "#/responses/error"
  8273. },
  8274. "423": {
  8275. "$ref": "#/responses/repoArchivedError"
  8276. }
  8277. }
  8278. }
  8279. },
  8280. "/repos/{owner}/{repo}/issues/{index}/blocks": {
  8281. "get": {
  8282. "produces": [
  8283. "application/json"
  8284. ],
  8285. "tags": [
  8286. "issue"
  8287. ],
  8288. "summary": "List issues that are blocked by this issue",
  8289. "operationId": "issueListBlocks",
  8290. "parameters": [
  8291. {
  8292. "type": "string",
  8293. "description": "owner of the repo",
  8294. "name": "owner",
  8295. "in": "path",
  8296. "required": true
  8297. },
  8298. {
  8299. "type": "string",
  8300. "description": "name of the repo",
  8301. "name": "repo",
  8302. "in": "path",
  8303. "required": true
  8304. },
  8305. {
  8306. "type": "string",
  8307. "description": "index of the issue",
  8308. "name": "index",
  8309. "in": "path",
  8310. "required": true
  8311. },
  8312. {
  8313. "type": "integer",
  8314. "description": "page number of results to return (1-based)",
  8315. "name": "page",
  8316. "in": "query"
  8317. },
  8318. {
  8319. "type": "integer",
  8320. "description": "page size of results",
  8321. "name": "limit",
  8322. "in": "query"
  8323. }
  8324. ],
  8325. "responses": {
  8326. "200": {
  8327. "$ref": "#/responses/IssueList"
  8328. },
  8329. "404": {
  8330. "$ref": "#/responses/notFound"
  8331. }
  8332. }
  8333. },
  8334. "post": {
  8335. "produces": [
  8336. "application/json"
  8337. ],
  8338. "tags": [
  8339. "issue"
  8340. ],
  8341. "summary": "Block the issue given in the body by the issue in path",
  8342. "operationId": "issueCreateIssueBlocking",
  8343. "parameters": [
  8344. {
  8345. "type": "string",
  8346. "description": "owner of the repo",
  8347. "name": "owner",
  8348. "in": "path",
  8349. "required": true
  8350. },
  8351. {
  8352. "type": "string",
  8353. "description": "name of the repo",
  8354. "name": "repo",
  8355. "in": "path",
  8356. "required": true
  8357. },
  8358. {
  8359. "type": "string",
  8360. "description": "index of the issue",
  8361. "name": "index",
  8362. "in": "path",
  8363. "required": true
  8364. },
  8365. {
  8366. "name": "body",
  8367. "in": "body",
  8368. "schema": {
  8369. "$ref": "#/definitions/IssueMeta"
  8370. }
  8371. }
  8372. ],
  8373. "responses": {
  8374. "201": {
  8375. "$ref": "#/responses/Issue"
  8376. },
  8377. "404": {
  8378. "description": "the issue does not exist"
  8379. }
  8380. }
  8381. },
  8382. "delete": {
  8383. "produces": [
  8384. "application/json"
  8385. ],
  8386. "tags": [
  8387. "issue"
  8388. ],
  8389. "summary": "Unblock the issue given in the body by the issue in path",
  8390. "operationId": "issueRemoveIssueBlocking",
  8391. "parameters": [
  8392. {
  8393. "type": "string",
  8394. "description": "owner of the repo",
  8395. "name": "owner",
  8396. "in": "path",
  8397. "required": true
  8398. },
  8399. {
  8400. "type": "string",
  8401. "description": "name of the repo",
  8402. "name": "repo",
  8403. "in": "path",
  8404. "required": true
  8405. },
  8406. {
  8407. "type": "string",
  8408. "description": "index of the issue",
  8409. "name": "index",
  8410. "in": "path",
  8411. "required": true
  8412. },
  8413. {
  8414. "name": "body",
  8415. "in": "body",
  8416. "schema": {
  8417. "$ref": "#/definitions/IssueMeta"
  8418. }
  8419. }
  8420. ],
  8421. "responses": {
  8422. "200": {
  8423. "$ref": "#/responses/Issue"
  8424. },
  8425. "404": {
  8426. "$ref": "#/responses/notFound"
  8427. }
  8428. }
  8429. }
  8430. },
  8431. "/repos/{owner}/{repo}/issues/{index}/comments": {
  8432. "get": {
  8433. "produces": [
  8434. "application/json"
  8435. ],
  8436. "tags": [
  8437. "issue"
  8438. ],
  8439. "summary": "List all comments on an issue",
  8440. "operationId": "issueGetComments",
  8441. "parameters": [
  8442. {
  8443. "type": "string",
  8444. "description": "owner of the repo",
  8445. "name": "owner",
  8446. "in": "path",
  8447. "required": true
  8448. },
  8449. {
  8450. "type": "string",
  8451. "description": "name of the repo",
  8452. "name": "repo",
  8453. "in": "path",
  8454. "required": true
  8455. },
  8456. {
  8457. "type": "integer",
  8458. "format": "int64",
  8459. "description": "index of the issue",
  8460. "name": "index",
  8461. "in": "path",
  8462. "required": true
  8463. },
  8464. {
  8465. "type": "string",
  8466. "format": "date-time",
  8467. "description": "if provided, only comments updated since the specified time are returned.",
  8468. "name": "since",
  8469. "in": "query"
  8470. },
  8471. {
  8472. "type": "string",
  8473. "format": "date-time",
  8474. "description": "if provided, only comments updated before the provided time are returned.",
  8475. "name": "before",
  8476. "in": "query"
  8477. }
  8478. ],
  8479. "responses": {
  8480. "200": {
  8481. "$ref": "#/responses/CommentList"
  8482. },
  8483. "404": {
  8484. "$ref": "#/responses/notFound"
  8485. }
  8486. }
  8487. },
  8488. "post": {
  8489. "consumes": [
  8490. "application/json"
  8491. ],
  8492. "produces": [
  8493. "application/json"
  8494. ],
  8495. "tags": [
  8496. "issue"
  8497. ],
  8498. "summary": "Add a comment to an issue",
  8499. "operationId": "issueCreateComment",
  8500. "parameters": [
  8501. {
  8502. "type": "string",
  8503. "description": "owner of the repo",
  8504. "name": "owner",
  8505. "in": "path",
  8506. "required": true
  8507. },
  8508. {
  8509. "type": "string",
  8510. "description": "name of the repo",
  8511. "name": "repo",
  8512. "in": "path",
  8513. "required": true
  8514. },
  8515. {
  8516. "type": "integer",
  8517. "format": "int64",
  8518. "description": "index of the issue",
  8519. "name": "index",
  8520. "in": "path",
  8521. "required": true
  8522. },
  8523. {
  8524. "name": "body",
  8525. "in": "body",
  8526. "schema": {
  8527. "$ref": "#/definitions/CreateIssueCommentOption"
  8528. }
  8529. }
  8530. ],
  8531. "responses": {
  8532. "201": {
  8533. "$ref": "#/responses/Comment"
  8534. },
  8535. "403": {
  8536. "$ref": "#/responses/forbidden"
  8537. },
  8538. "404": {
  8539. "$ref": "#/responses/notFound"
  8540. },
  8541. "423": {
  8542. "$ref": "#/responses/repoArchivedError"
  8543. }
  8544. }
  8545. }
  8546. },
  8547. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  8548. "delete": {
  8549. "tags": [
  8550. "issue"
  8551. ],
  8552. "summary": "Delete a comment",
  8553. "operationId": "issueDeleteCommentDeprecated",
  8554. "deprecated": true,
  8555. "parameters": [
  8556. {
  8557. "type": "string",
  8558. "description": "owner of the repo",
  8559. "name": "owner",
  8560. "in": "path",
  8561. "required": true
  8562. },
  8563. {
  8564. "type": "string",
  8565. "description": "name of the repo",
  8566. "name": "repo",
  8567. "in": "path",
  8568. "required": true
  8569. },
  8570. {
  8571. "type": "integer",
  8572. "description": "this parameter is ignored",
  8573. "name": "index",
  8574. "in": "path",
  8575. "required": true
  8576. },
  8577. {
  8578. "type": "integer",
  8579. "format": "int64",
  8580. "description": "id of comment to delete",
  8581. "name": "id",
  8582. "in": "path",
  8583. "required": true
  8584. }
  8585. ],
  8586. "responses": {
  8587. "204": {
  8588. "$ref": "#/responses/empty"
  8589. },
  8590. "403": {
  8591. "$ref": "#/responses/forbidden"
  8592. },
  8593. "404": {
  8594. "$ref": "#/responses/notFound"
  8595. }
  8596. }
  8597. },
  8598. "patch": {
  8599. "consumes": [
  8600. "application/json"
  8601. ],
  8602. "produces": [
  8603. "application/json"
  8604. ],
  8605. "tags": [
  8606. "issue"
  8607. ],
  8608. "summary": "Edit a comment",
  8609. "operationId": "issueEditCommentDeprecated",
  8610. "deprecated": true,
  8611. "parameters": [
  8612. {
  8613. "type": "string",
  8614. "description": "owner of the repo",
  8615. "name": "owner",
  8616. "in": "path",
  8617. "required": true
  8618. },
  8619. {
  8620. "type": "string",
  8621. "description": "name of the repo",
  8622. "name": "repo",
  8623. "in": "path",
  8624. "required": true
  8625. },
  8626. {
  8627. "type": "integer",
  8628. "description": "this parameter is ignored",
  8629. "name": "index",
  8630. "in": "path",
  8631. "required": true
  8632. },
  8633. {
  8634. "type": "integer",
  8635. "format": "int64",
  8636. "description": "id of the comment to edit",
  8637. "name": "id",
  8638. "in": "path",
  8639. "required": true
  8640. },
  8641. {
  8642. "name": "body",
  8643. "in": "body",
  8644. "schema": {
  8645. "$ref": "#/definitions/EditIssueCommentOption"
  8646. }
  8647. }
  8648. ],
  8649. "responses": {
  8650. "200": {
  8651. "$ref": "#/responses/Comment"
  8652. },
  8653. "204": {
  8654. "$ref": "#/responses/empty"
  8655. },
  8656. "403": {
  8657. "$ref": "#/responses/forbidden"
  8658. },
  8659. "404": {
  8660. "$ref": "#/responses/notFound"
  8661. }
  8662. }
  8663. }
  8664. },
  8665. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  8666. "post": {
  8667. "consumes": [
  8668. "application/json"
  8669. ],
  8670. "produces": [
  8671. "application/json"
  8672. ],
  8673. "tags": [
  8674. "issue"
  8675. ],
  8676. "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.",
  8677. "operationId": "issueEditIssueDeadline",
  8678. "parameters": [
  8679. {
  8680. "type": "string",
  8681. "description": "owner of the repo",
  8682. "name": "owner",
  8683. "in": "path",
  8684. "required": true
  8685. },
  8686. {
  8687. "type": "string",
  8688. "description": "name of the repo",
  8689. "name": "repo",
  8690. "in": "path",
  8691. "required": true
  8692. },
  8693. {
  8694. "type": "integer",
  8695. "format": "int64",
  8696. "description": "index of the issue to create or update a deadline on",
  8697. "name": "index",
  8698. "in": "path",
  8699. "required": true
  8700. },
  8701. {
  8702. "name": "body",
  8703. "in": "body",
  8704. "schema": {
  8705. "$ref": "#/definitions/EditDeadlineOption"
  8706. }
  8707. }
  8708. ],
  8709. "responses": {
  8710. "201": {
  8711. "$ref": "#/responses/IssueDeadline"
  8712. },
  8713. "403": {
  8714. "$ref": "#/responses/forbidden"
  8715. },
  8716. "404": {
  8717. "$ref": "#/responses/notFound"
  8718. }
  8719. }
  8720. }
  8721. },
  8722. "/repos/{owner}/{repo}/issues/{index}/dependencies": {
  8723. "get": {
  8724. "produces": [
  8725. "application/json"
  8726. ],
  8727. "tags": [
  8728. "issue"
  8729. ],
  8730. "summary": "List an issue's dependencies, i.e all issues that block this issue.",
  8731. "operationId": "issueListIssueDependencies",
  8732. "parameters": [
  8733. {
  8734. "type": "string",
  8735. "description": "owner of the repo",
  8736. "name": "owner",
  8737. "in": "path",
  8738. "required": true
  8739. },
  8740. {
  8741. "type": "string",
  8742. "description": "name of the repo",
  8743. "name": "repo",
  8744. "in": "path",
  8745. "required": true
  8746. },
  8747. {
  8748. "type": "string",
  8749. "description": "index of the issue",
  8750. "name": "index",
  8751. "in": "path",
  8752. "required": true
  8753. },
  8754. {
  8755. "type": "integer",
  8756. "description": "page number of results to return (1-based)",
  8757. "name": "page",
  8758. "in": "query"
  8759. },
  8760. {
  8761. "type": "integer",
  8762. "description": "page size of results",
  8763. "name": "limit",
  8764. "in": "query"
  8765. }
  8766. ],
  8767. "responses": {
  8768. "200": {
  8769. "$ref": "#/responses/IssueList"
  8770. },
  8771. "404": {
  8772. "$ref": "#/responses/notFound"
  8773. }
  8774. }
  8775. },
  8776. "post": {
  8777. "produces": [
  8778. "application/json"
  8779. ],
  8780. "tags": [
  8781. "issue"
  8782. ],
  8783. "summary": "Make the issue in the url depend on the issue in the form.",
  8784. "operationId": "issueCreateIssueDependencies",
  8785. "parameters": [
  8786. {
  8787. "type": "string",
  8788. "description": "owner of the repo",
  8789. "name": "owner",
  8790. "in": "path",
  8791. "required": true
  8792. },
  8793. {
  8794. "type": "string",
  8795. "description": "name of the repo",
  8796. "name": "repo",
  8797. "in": "path",
  8798. "required": true
  8799. },
  8800. {
  8801. "type": "string",
  8802. "description": "index of the issue",
  8803. "name": "index",
  8804. "in": "path",
  8805. "required": true
  8806. },
  8807. {
  8808. "name": "body",
  8809. "in": "body",
  8810. "schema": {
  8811. "$ref": "#/definitions/IssueMeta"
  8812. }
  8813. }
  8814. ],
  8815. "responses": {
  8816. "201": {
  8817. "$ref": "#/responses/Issue"
  8818. },
  8819. "404": {
  8820. "description": "the issue does not exist"
  8821. },
  8822. "423": {
  8823. "$ref": "#/responses/repoArchivedError"
  8824. }
  8825. }
  8826. },
  8827. "delete": {
  8828. "produces": [
  8829. "application/json"
  8830. ],
  8831. "tags": [
  8832. "issue"
  8833. ],
  8834. "summary": "Remove an issue dependency",
  8835. "operationId": "issueRemoveIssueDependencies",
  8836. "parameters": [
  8837. {
  8838. "type": "string",
  8839. "description": "owner of the repo",
  8840. "name": "owner",
  8841. "in": "path",
  8842. "required": true
  8843. },
  8844. {
  8845. "type": "string",
  8846. "description": "name of the repo",
  8847. "name": "repo",
  8848. "in": "path",
  8849. "required": true
  8850. },
  8851. {
  8852. "type": "string",
  8853. "description": "index of the issue",
  8854. "name": "index",
  8855. "in": "path",
  8856. "required": true
  8857. },
  8858. {
  8859. "name": "body",
  8860. "in": "body",
  8861. "schema": {
  8862. "$ref": "#/definitions/IssueMeta"
  8863. }
  8864. }
  8865. ],
  8866. "responses": {
  8867. "200": {
  8868. "$ref": "#/responses/Issue"
  8869. },
  8870. "404": {
  8871. "$ref": "#/responses/notFound"
  8872. },
  8873. "423": {
  8874. "$ref": "#/responses/repoArchivedError"
  8875. }
  8876. }
  8877. }
  8878. },
  8879. "/repos/{owner}/{repo}/issues/{index}/labels": {
  8880. "get": {
  8881. "produces": [
  8882. "application/json"
  8883. ],
  8884. "tags": [
  8885. "issue"
  8886. ],
  8887. "summary": "Get an issue's labels",
  8888. "operationId": "issueGetLabels",
  8889. "parameters": [
  8890. {
  8891. "type": "string",
  8892. "description": "owner of the repo",
  8893. "name": "owner",
  8894. "in": "path",
  8895. "required": true
  8896. },
  8897. {
  8898. "type": "string",
  8899. "description": "name of the repo",
  8900. "name": "repo",
  8901. "in": "path",
  8902. "required": true
  8903. },
  8904. {
  8905. "type": "integer",
  8906. "format": "int64",
  8907. "description": "index of the issue",
  8908. "name": "index",
  8909. "in": "path",
  8910. "required": true
  8911. }
  8912. ],
  8913. "responses": {
  8914. "200": {
  8915. "$ref": "#/responses/LabelList"
  8916. },
  8917. "404": {
  8918. "$ref": "#/responses/notFound"
  8919. }
  8920. }
  8921. },
  8922. "put": {
  8923. "consumes": [
  8924. "application/json"
  8925. ],
  8926. "produces": [
  8927. "application/json"
  8928. ],
  8929. "tags": [
  8930. "issue"
  8931. ],
  8932. "summary": "Replace an issue's labels",
  8933. "operationId": "issueReplaceLabels",
  8934. "parameters": [
  8935. {
  8936. "type": "string",
  8937. "description": "owner of the repo",
  8938. "name": "owner",
  8939. "in": "path",
  8940. "required": true
  8941. },
  8942. {
  8943. "type": "string",
  8944. "description": "name of the repo",
  8945. "name": "repo",
  8946. "in": "path",
  8947. "required": true
  8948. },
  8949. {
  8950. "type": "integer",
  8951. "format": "int64",
  8952. "description": "index of the issue",
  8953. "name": "index",
  8954. "in": "path",
  8955. "required": true
  8956. },
  8957. {
  8958. "name": "body",
  8959. "in": "body",
  8960. "schema": {
  8961. "$ref": "#/definitions/IssueLabelsOption"
  8962. }
  8963. }
  8964. ],
  8965. "responses": {
  8966. "200": {
  8967. "$ref": "#/responses/LabelList"
  8968. },
  8969. "403": {
  8970. "$ref": "#/responses/forbidden"
  8971. },
  8972. "404": {
  8973. "$ref": "#/responses/notFound"
  8974. }
  8975. }
  8976. },
  8977. "post": {
  8978. "consumes": [
  8979. "application/json"
  8980. ],
  8981. "produces": [
  8982. "application/json"
  8983. ],
  8984. "tags": [
  8985. "issue"
  8986. ],
  8987. "summary": "Add a label to an issue",
  8988. "operationId": "issueAddLabel",
  8989. "parameters": [
  8990. {
  8991. "type": "string",
  8992. "description": "owner of the repo",
  8993. "name": "owner",
  8994. "in": "path",
  8995. "required": true
  8996. },
  8997. {
  8998. "type": "string",
  8999. "description": "name of the repo",
  9000. "name": "repo",
  9001. "in": "path",
  9002. "required": true
  9003. },
  9004. {
  9005. "type": "integer",
  9006. "format": "int64",
  9007. "description": "index of the issue",
  9008. "name": "index",
  9009. "in": "path",
  9010. "required": true
  9011. },
  9012. {
  9013. "name": "body",
  9014. "in": "body",
  9015. "schema": {
  9016. "$ref": "#/definitions/IssueLabelsOption"
  9017. }
  9018. }
  9019. ],
  9020. "responses": {
  9021. "200": {
  9022. "$ref": "#/responses/LabelList"
  9023. },
  9024. "403": {
  9025. "$ref": "#/responses/forbidden"
  9026. },
  9027. "404": {
  9028. "$ref": "#/responses/notFound"
  9029. }
  9030. }
  9031. },
  9032. "delete": {
  9033. "produces": [
  9034. "application/json"
  9035. ],
  9036. "tags": [
  9037. "issue"
  9038. ],
  9039. "summary": "Remove all labels from an issue",
  9040. "operationId": "issueClearLabels",
  9041. "parameters": [
  9042. {
  9043. "type": "string",
  9044. "description": "owner of the repo",
  9045. "name": "owner",
  9046. "in": "path",
  9047. "required": true
  9048. },
  9049. {
  9050. "type": "string",
  9051. "description": "name of the repo",
  9052. "name": "repo",
  9053. "in": "path",
  9054. "required": true
  9055. },
  9056. {
  9057. "type": "integer",
  9058. "format": "int64",
  9059. "description": "index of the issue",
  9060. "name": "index",
  9061. "in": "path",
  9062. "required": true
  9063. }
  9064. ],
  9065. "responses": {
  9066. "204": {
  9067. "$ref": "#/responses/empty"
  9068. },
  9069. "403": {
  9070. "$ref": "#/responses/forbidden"
  9071. },
  9072. "404": {
  9073. "$ref": "#/responses/notFound"
  9074. }
  9075. }
  9076. }
  9077. },
  9078. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  9079. "delete": {
  9080. "produces": [
  9081. "application/json"
  9082. ],
  9083. "tags": [
  9084. "issue"
  9085. ],
  9086. "summary": "Remove a label from an issue",
  9087. "operationId": "issueRemoveLabel",
  9088. "parameters": [
  9089. {
  9090. "type": "string",
  9091. "description": "owner of the repo",
  9092. "name": "owner",
  9093. "in": "path",
  9094. "required": true
  9095. },
  9096. {
  9097. "type": "string",
  9098. "description": "name of the repo",
  9099. "name": "repo",
  9100. "in": "path",
  9101. "required": true
  9102. },
  9103. {
  9104. "type": "integer",
  9105. "format": "int64",
  9106. "description": "index of the issue",
  9107. "name": "index",
  9108. "in": "path",
  9109. "required": true
  9110. },
  9111. {
  9112. "type": "integer",
  9113. "format": "int64",
  9114. "description": "id of the label to remove",
  9115. "name": "id",
  9116. "in": "path",
  9117. "required": true
  9118. }
  9119. ],
  9120. "responses": {
  9121. "204": {
  9122. "$ref": "#/responses/empty"
  9123. },
  9124. "403": {
  9125. "$ref": "#/responses/forbidden"
  9126. },
  9127. "404": {
  9128. "$ref": "#/responses/notFound"
  9129. },
  9130. "422": {
  9131. "$ref": "#/responses/validationError"
  9132. }
  9133. }
  9134. }
  9135. },
  9136. "/repos/{owner}/{repo}/issues/{index}/pin": {
  9137. "post": {
  9138. "tags": [
  9139. "issue"
  9140. ],
  9141. "summary": "Pin an Issue",
  9142. "operationId": "pinIssue",
  9143. "parameters": [
  9144. {
  9145. "type": "string",
  9146. "description": "owner of the repo",
  9147. "name": "owner",
  9148. "in": "path",
  9149. "required": true
  9150. },
  9151. {
  9152. "type": "string",
  9153. "description": "name of the repo",
  9154. "name": "repo",
  9155. "in": "path",
  9156. "required": true
  9157. },
  9158. {
  9159. "type": "integer",
  9160. "format": "int64",
  9161. "description": "index of issue to pin",
  9162. "name": "index",
  9163. "in": "path",
  9164. "required": true
  9165. }
  9166. ],
  9167. "responses": {
  9168. "204": {
  9169. "$ref": "#/responses/empty"
  9170. },
  9171. "403": {
  9172. "$ref": "#/responses/forbidden"
  9173. },
  9174. "404": {
  9175. "$ref": "#/responses/notFound"
  9176. }
  9177. }
  9178. },
  9179. "delete": {
  9180. "tags": [
  9181. "issue"
  9182. ],
  9183. "summary": "Unpin an Issue",
  9184. "operationId": "unpinIssue",
  9185. "parameters": [
  9186. {
  9187. "type": "string",
  9188. "description": "owner of the repo",
  9189. "name": "owner",
  9190. "in": "path",
  9191. "required": true
  9192. },
  9193. {
  9194. "type": "string",
  9195. "description": "name of the repo",
  9196. "name": "repo",
  9197. "in": "path",
  9198. "required": true
  9199. },
  9200. {
  9201. "type": "integer",
  9202. "format": "int64",
  9203. "description": "index of issue to unpin",
  9204. "name": "index",
  9205. "in": "path",
  9206. "required": true
  9207. }
  9208. ],
  9209. "responses": {
  9210. "204": {
  9211. "$ref": "#/responses/empty"
  9212. },
  9213. "403": {
  9214. "$ref": "#/responses/forbidden"
  9215. },
  9216. "404": {
  9217. "$ref": "#/responses/notFound"
  9218. }
  9219. }
  9220. }
  9221. },
  9222. "/repos/{owner}/{repo}/issues/{index}/pin/{position}": {
  9223. "patch": {
  9224. "tags": [
  9225. "issue"
  9226. ],
  9227. "summary": "Moves the Pin to the given Position",
  9228. "operationId": "moveIssuePin",
  9229. "parameters": [
  9230. {
  9231. "type": "string",
  9232. "description": "owner of the repo",
  9233. "name": "owner",
  9234. "in": "path",
  9235. "required": true
  9236. },
  9237. {
  9238. "type": "string",
  9239. "description": "name of the repo",
  9240. "name": "repo",
  9241. "in": "path",
  9242. "required": true
  9243. },
  9244. {
  9245. "type": "integer",
  9246. "format": "int64",
  9247. "description": "index of issue",
  9248. "name": "index",
  9249. "in": "path",
  9250. "required": true
  9251. },
  9252. {
  9253. "type": "integer",
  9254. "format": "int64",
  9255. "description": "the new position",
  9256. "name": "position",
  9257. "in": "path",
  9258. "required": true
  9259. }
  9260. ],
  9261. "responses": {
  9262. "204": {
  9263. "$ref": "#/responses/empty"
  9264. },
  9265. "403": {
  9266. "$ref": "#/responses/forbidden"
  9267. },
  9268. "404": {
  9269. "$ref": "#/responses/notFound"
  9270. }
  9271. }
  9272. }
  9273. },
  9274. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  9275. "get": {
  9276. "consumes": [
  9277. "application/json"
  9278. ],
  9279. "produces": [
  9280. "application/json"
  9281. ],
  9282. "tags": [
  9283. "issue"
  9284. ],
  9285. "summary": "Get a list reactions of an issue",
  9286. "operationId": "issueGetIssueReactions",
  9287. "parameters": [
  9288. {
  9289. "type": "string",
  9290. "description": "owner of the repo",
  9291. "name": "owner",
  9292. "in": "path",
  9293. "required": true
  9294. },
  9295. {
  9296. "type": "string",
  9297. "description": "name of the repo",
  9298. "name": "repo",
  9299. "in": "path",
  9300. "required": true
  9301. },
  9302. {
  9303. "type": "integer",
  9304. "format": "int64",
  9305. "description": "index of the issue",
  9306. "name": "index",
  9307. "in": "path",
  9308. "required": true
  9309. },
  9310. {
  9311. "type": "integer",
  9312. "description": "page number of results to return (1-based)",
  9313. "name": "page",
  9314. "in": "query"
  9315. },
  9316. {
  9317. "type": "integer",
  9318. "description": "page size of results",
  9319. "name": "limit",
  9320. "in": "query"
  9321. }
  9322. ],
  9323. "responses": {
  9324. "200": {
  9325. "$ref": "#/responses/ReactionList"
  9326. },
  9327. "403": {
  9328. "$ref": "#/responses/forbidden"
  9329. },
  9330. "404": {
  9331. "$ref": "#/responses/notFound"
  9332. }
  9333. }
  9334. },
  9335. "post": {
  9336. "consumes": [
  9337. "application/json"
  9338. ],
  9339. "produces": [
  9340. "application/json"
  9341. ],
  9342. "tags": [
  9343. "issue"
  9344. ],
  9345. "summary": "Add a reaction to an issue",
  9346. "operationId": "issuePostIssueReaction",
  9347. "parameters": [
  9348. {
  9349. "type": "string",
  9350. "description": "owner of the repo",
  9351. "name": "owner",
  9352. "in": "path",
  9353. "required": true
  9354. },
  9355. {
  9356. "type": "string",
  9357. "description": "name of the repo",
  9358. "name": "repo",
  9359. "in": "path",
  9360. "required": true
  9361. },
  9362. {
  9363. "type": "integer",
  9364. "format": "int64",
  9365. "description": "index of the issue",
  9366. "name": "index",
  9367. "in": "path",
  9368. "required": true
  9369. },
  9370. {
  9371. "name": "content",
  9372. "in": "body",
  9373. "schema": {
  9374. "$ref": "#/definitions/EditReactionOption"
  9375. }
  9376. }
  9377. ],
  9378. "responses": {
  9379. "200": {
  9380. "$ref": "#/responses/Reaction"
  9381. },
  9382. "201": {
  9383. "$ref": "#/responses/Reaction"
  9384. },
  9385. "403": {
  9386. "$ref": "#/responses/forbidden"
  9387. },
  9388. "404": {
  9389. "$ref": "#/responses/notFound"
  9390. }
  9391. }
  9392. },
  9393. "delete": {
  9394. "consumes": [
  9395. "application/json"
  9396. ],
  9397. "produces": [
  9398. "application/json"
  9399. ],
  9400. "tags": [
  9401. "issue"
  9402. ],
  9403. "summary": "Remove a reaction from an issue",
  9404. "operationId": "issueDeleteIssueReaction",
  9405. "parameters": [
  9406. {
  9407. "type": "string",
  9408. "description": "owner of the repo",
  9409. "name": "owner",
  9410. "in": "path",
  9411. "required": true
  9412. },
  9413. {
  9414. "type": "string",
  9415. "description": "name of the repo",
  9416. "name": "repo",
  9417. "in": "path",
  9418. "required": true
  9419. },
  9420. {
  9421. "type": "integer",
  9422. "format": "int64",
  9423. "description": "index of the issue",
  9424. "name": "index",
  9425. "in": "path",
  9426. "required": true
  9427. },
  9428. {
  9429. "name": "content",
  9430. "in": "body",
  9431. "schema": {
  9432. "$ref": "#/definitions/EditReactionOption"
  9433. }
  9434. }
  9435. ],
  9436. "responses": {
  9437. "200": {
  9438. "$ref": "#/responses/empty"
  9439. },
  9440. "403": {
  9441. "$ref": "#/responses/forbidden"
  9442. },
  9443. "404": {
  9444. "$ref": "#/responses/notFound"
  9445. }
  9446. }
  9447. }
  9448. },
  9449. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  9450. "delete": {
  9451. "consumes": [
  9452. "application/json"
  9453. ],
  9454. "produces": [
  9455. "application/json"
  9456. ],
  9457. "tags": [
  9458. "issue"
  9459. ],
  9460. "summary": "Delete an issue's existing stopwatch.",
  9461. "operationId": "issueDeleteStopWatch",
  9462. "parameters": [
  9463. {
  9464. "type": "string",
  9465. "description": "owner of the repo",
  9466. "name": "owner",
  9467. "in": "path",
  9468. "required": true
  9469. },
  9470. {
  9471. "type": "string",
  9472. "description": "name of the repo",
  9473. "name": "repo",
  9474. "in": "path",
  9475. "required": true
  9476. },
  9477. {
  9478. "type": "integer",
  9479. "format": "int64",
  9480. "description": "index of the issue to stop the stopwatch on",
  9481. "name": "index",
  9482. "in": "path",
  9483. "required": true
  9484. }
  9485. ],
  9486. "responses": {
  9487. "204": {
  9488. "$ref": "#/responses/empty"
  9489. },
  9490. "403": {
  9491. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  9492. },
  9493. "404": {
  9494. "$ref": "#/responses/notFound"
  9495. },
  9496. "409": {
  9497. "description": "Cannot cancel a non existent stopwatch"
  9498. }
  9499. }
  9500. }
  9501. },
  9502. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  9503. "post": {
  9504. "consumes": [
  9505. "application/json"
  9506. ],
  9507. "produces": [
  9508. "application/json"
  9509. ],
  9510. "tags": [
  9511. "issue"
  9512. ],
  9513. "summary": "Start stopwatch on an issue.",
  9514. "operationId": "issueStartStopWatch",
  9515. "parameters": [
  9516. {
  9517. "type": "string",
  9518. "description": "owner of the repo",
  9519. "name": "owner",
  9520. "in": "path",
  9521. "required": true
  9522. },
  9523. {
  9524. "type": "string",
  9525. "description": "name of the repo",
  9526. "name": "repo",
  9527. "in": "path",
  9528. "required": true
  9529. },
  9530. {
  9531. "type": "integer",
  9532. "format": "int64",
  9533. "description": "index of the issue to create the stopwatch on",
  9534. "name": "index",
  9535. "in": "path",
  9536. "required": true
  9537. }
  9538. ],
  9539. "responses": {
  9540. "201": {
  9541. "$ref": "#/responses/empty"
  9542. },
  9543. "403": {
  9544. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  9545. },
  9546. "404": {
  9547. "$ref": "#/responses/notFound"
  9548. },
  9549. "409": {
  9550. "description": "Cannot start a stopwatch again if it already exists"
  9551. }
  9552. }
  9553. }
  9554. },
  9555. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  9556. "post": {
  9557. "consumes": [
  9558. "application/json"
  9559. ],
  9560. "produces": [
  9561. "application/json"
  9562. ],
  9563. "tags": [
  9564. "issue"
  9565. ],
  9566. "summary": "Stop an issue's existing stopwatch.",
  9567. "operationId": "issueStopStopWatch",
  9568. "parameters": [
  9569. {
  9570. "type": "string",
  9571. "description": "owner of the repo",
  9572. "name": "owner",
  9573. "in": "path",
  9574. "required": true
  9575. },
  9576. {
  9577. "type": "string",
  9578. "description": "name of the repo",
  9579. "name": "repo",
  9580. "in": "path",
  9581. "required": true
  9582. },
  9583. {
  9584. "type": "integer",
  9585. "format": "int64",
  9586. "description": "index of the issue to stop the stopwatch on",
  9587. "name": "index",
  9588. "in": "path",
  9589. "required": true
  9590. }
  9591. ],
  9592. "responses": {
  9593. "201": {
  9594. "$ref": "#/responses/empty"
  9595. },
  9596. "403": {
  9597. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  9598. },
  9599. "404": {
  9600. "$ref": "#/responses/notFound"
  9601. },
  9602. "409": {
  9603. "description": "Cannot stop a non existent stopwatch"
  9604. }
  9605. }
  9606. }
  9607. },
  9608. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  9609. "get": {
  9610. "consumes": [
  9611. "application/json"
  9612. ],
  9613. "produces": [
  9614. "application/json"
  9615. ],
  9616. "tags": [
  9617. "issue"
  9618. ],
  9619. "summary": "Get users who subscribed on an issue.",
  9620. "operationId": "issueSubscriptions",
  9621. "parameters": [
  9622. {
  9623. "type": "string",
  9624. "description": "owner of the repo",
  9625. "name": "owner",
  9626. "in": "path",
  9627. "required": true
  9628. },
  9629. {
  9630. "type": "string",
  9631. "description": "name of the repo",
  9632. "name": "repo",
  9633. "in": "path",
  9634. "required": true
  9635. },
  9636. {
  9637. "type": "integer",
  9638. "format": "int64",
  9639. "description": "index of the issue",
  9640. "name": "index",
  9641. "in": "path",
  9642. "required": true
  9643. },
  9644. {
  9645. "type": "integer",
  9646. "description": "page number of results to return (1-based)",
  9647. "name": "page",
  9648. "in": "query"
  9649. },
  9650. {
  9651. "type": "integer",
  9652. "description": "page size of results",
  9653. "name": "limit",
  9654. "in": "query"
  9655. }
  9656. ],
  9657. "responses": {
  9658. "200": {
  9659. "$ref": "#/responses/UserList"
  9660. },
  9661. "404": {
  9662. "$ref": "#/responses/notFound"
  9663. }
  9664. }
  9665. }
  9666. },
  9667. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  9668. "get": {
  9669. "consumes": [
  9670. "application/json"
  9671. ],
  9672. "produces": [
  9673. "application/json"
  9674. ],
  9675. "tags": [
  9676. "issue"
  9677. ],
  9678. "summary": "Check if user is subscribed to an issue",
  9679. "operationId": "issueCheckSubscription",
  9680. "parameters": [
  9681. {
  9682. "type": "string",
  9683. "description": "owner of the repo",
  9684. "name": "owner",
  9685. "in": "path",
  9686. "required": true
  9687. },
  9688. {
  9689. "type": "string",
  9690. "description": "name of the repo",
  9691. "name": "repo",
  9692. "in": "path",
  9693. "required": true
  9694. },
  9695. {
  9696. "type": "integer",
  9697. "format": "int64",
  9698. "description": "index of the issue",
  9699. "name": "index",
  9700. "in": "path",
  9701. "required": true
  9702. }
  9703. ],
  9704. "responses": {
  9705. "200": {
  9706. "$ref": "#/responses/WatchInfo"
  9707. },
  9708. "404": {
  9709. "$ref": "#/responses/notFound"
  9710. }
  9711. }
  9712. }
  9713. },
  9714. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  9715. "put": {
  9716. "consumes": [
  9717. "application/json"
  9718. ],
  9719. "produces": [
  9720. "application/json"
  9721. ],
  9722. "tags": [
  9723. "issue"
  9724. ],
  9725. "summary": "Subscribe user to issue",
  9726. "operationId": "issueAddSubscription",
  9727. "parameters": [
  9728. {
  9729. "type": "string",
  9730. "description": "owner of the repo",
  9731. "name": "owner",
  9732. "in": "path",
  9733. "required": true
  9734. },
  9735. {
  9736. "type": "string",
  9737. "description": "name of the repo",
  9738. "name": "repo",
  9739. "in": "path",
  9740. "required": true
  9741. },
  9742. {
  9743. "type": "integer",
  9744. "format": "int64",
  9745. "description": "index of the issue",
  9746. "name": "index",
  9747. "in": "path",
  9748. "required": true
  9749. },
  9750. {
  9751. "type": "string",
  9752. "description": "user to subscribe",
  9753. "name": "user",
  9754. "in": "path",
  9755. "required": true
  9756. }
  9757. ],
  9758. "responses": {
  9759. "200": {
  9760. "description": "Already subscribed"
  9761. },
  9762. "201": {
  9763. "description": "Successfully Subscribed"
  9764. },
  9765. "304": {
  9766. "description": "User can only subscribe itself if he is no admin"
  9767. },
  9768. "404": {
  9769. "$ref": "#/responses/notFound"
  9770. }
  9771. }
  9772. },
  9773. "delete": {
  9774. "consumes": [
  9775. "application/json"
  9776. ],
  9777. "produces": [
  9778. "application/json"
  9779. ],
  9780. "tags": [
  9781. "issue"
  9782. ],
  9783. "summary": "Unsubscribe user from issue",
  9784. "operationId": "issueDeleteSubscription",
  9785. "parameters": [
  9786. {
  9787. "type": "string",
  9788. "description": "owner of the repo",
  9789. "name": "owner",
  9790. "in": "path",
  9791. "required": true
  9792. },
  9793. {
  9794. "type": "string",
  9795. "description": "name of the repo",
  9796. "name": "repo",
  9797. "in": "path",
  9798. "required": true
  9799. },
  9800. {
  9801. "type": "integer",
  9802. "format": "int64",
  9803. "description": "index of the issue",
  9804. "name": "index",
  9805. "in": "path",
  9806. "required": true
  9807. },
  9808. {
  9809. "type": "string",
  9810. "description": "user witch unsubscribe",
  9811. "name": "user",
  9812. "in": "path",
  9813. "required": true
  9814. }
  9815. ],
  9816. "responses": {
  9817. "200": {
  9818. "description": "Already unsubscribed"
  9819. },
  9820. "201": {
  9821. "description": "Successfully Unsubscribed"
  9822. },
  9823. "304": {
  9824. "description": "User can only subscribe itself if he is no admin"
  9825. },
  9826. "404": {
  9827. "$ref": "#/responses/notFound"
  9828. }
  9829. }
  9830. }
  9831. },
  9832. "/repos/{owner}/{repo}/issues/{index}/timeline": {
  9833. "get": {
  9834. "produces": [
  9835. "application/json"
  9836. ],
  9837. "tags": [
  9838. "issue"
  9839. ],
  9840. "summary": "List all comments and events on an issue",
  9841. "operationId": "issueGetCommentsAndTimeline",
  9842. "parameters": [
  9843. {
  9844. "type": "string",
  9845. "description": "owner of the repo",
  9846. "name": "owner",
  9847. "in": "path",
  9848. "required": true
  9849. },
  9850. {
  9851. "type": "string",
  9852. "description": "name of the repo",
  9853. "name": "repo",
  9854. "in": "path",
  9855. "required": true
  9856. },
  9857. {
  9858. "type": "integer",
  9859. "format": "int64",
  9860. "description": "index of the issue",
  9861. "name": "index",
  9862. "in": "path",
  9863. "required": true
  9864. },
  9865. {
  9866. "type": "string",
  9867. "format": "date-time",
  9868. "description": "if provided, only comments updated since the specified time are returned.",
  9869. "name": "since",
  9870. "in": "query"
  9871. },
  9872. {
  9873. "type": "integer",
  9874. "description": "page number of results to return (1-based)",
  9875. "name": "page",
  9876. "in": "query"
  9877. },
  9878. {
  9879. "type": "integer",
  9880. "description": "page size of results",
  9881. "name": "limit",
  9882. "in": "query"
  9883. },
  9884. {
  9885. "type": "string",
  9886. "format": "date-time",
  9887. "description": "if provided, only comments updated before the provided time are returned.",
  9888. "name": "before",
  9889. "in": "query"
  9890. }
  9891. ],
  9892. "responses": {
  9893. "200": {
  9894. "$ref": "#/responses/TimelineList"
  9895. },
  9896. "404": {
  9897. "$ref": "#/responses/notFound"
  9898. }
  9899. }
  9900. }
  9901. },
  9902. "/repos/{owner}/{repo}/issues/{index}/times": {
  9903. "get": {
  9904. "produces": [
  9905. "application/json"
  9906. ],
  9907. "tags": [
  9908. "issue"
  9909. ],
  9910. "summary": "List an issue's tracked times",
  9911. "operationId": "issueTrackedTimes",
  9912. "parameters": [
  9913. {
  9914. "type": "string",
  9915. "description": "owner of the repo",
  9916. "name": "owner",
  9917. "in": "path",
  9918. "required": true
  9919. },
  9920. {
  9921. "type": "string",
  9922. "description": "name of the repo",
  9923. "name": "repo",
  9924. "in": "path",
  9925. "required": true
  9926. },
  9927. {
  9928. "type": "integer",
  9929. "format": "int64",
  9930. "description": "index of the issue",
  9931. "name": "index",
  9932. "in": "path",
  9933. "required": true
  9934. },
  9935. {
  9936. "type": "string",
  9937. "description": "optional filter by user (available for issue managers)",
  9938. "name": "user",
  9939. "in": "query"
  9940. },
  9941. {
  9942. "type": "string",
  9943. "format": "date-time",
  9944. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9945. "name": "since",
  9946. "in": "query"
  9947. },
  9948. {
  9949. "type": "string",
  9950. "format": "date-time",
  9951. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9952. "name": "before",
  9953. "in": "query"
  9954. },
  9955. {
  9956. "type": "integer",
  9957. "description": "page number of results to return (1-based)",
  9958. "name": "page",
  9959. "in": "query"
  9960. },
  9961. {
  9962. "type": "integer",
  9963. "description": "page size of results",
  9964. "name": "limit",
  9965. "in": "query"
  9966. }
  9967. ],
  9968. "responses": {
  9969. "200": {
  9970. "$ref": "#/responses/TrackedTimeList"
  9971. },
  9972. "404": {
  9973. "$ref": "#/responses/notFound"
  9974. }
  9975. }
  9976. },
  9977. "post": {
  9978. "consumes": [
  9979. "application/json"
  9980. ],
  9981. "produces": [
  9982. "application/json"
  9983. ],
  9984. "tags": [
  9985. "issue"
  9986. ],
  9987. "summary": "Add tracked time to a issue",
  9988. "operationId": "issueAddTime",
  9989. "parameters": [
  9990. {
  9991. "type": "string",
  9992. "description": "owner of the repo",
  9993. "name": "owner",
  9994. "in": "path",
  9995. "required": true
  9996. },
  9997. {
  9998. "type": "string",
  9999. "description": "name of the repo",
  10000. "name": "repo",
  10001. "in": "path",
  10002. "required": true
  10003. },
  10004. {
  10005. "type": "integer",
  10006. "format": "int64",
  10007. "description": "index of the issue",
  10008. "name": "index",
  10009. "in": "path",
  10010. "required": true
  10011. },
  10012. {
  10013. "name": "body",
  10014. "in": "body",
  10015. "schema": {
  10016. "$ref": "#/definitions/AddTimeOption"
  10017. }
  10018. }
  10019. ],
  10020. "responses": {
  10021. "200": {
  10022. "$ref": "#/responses/TrackedTime"
  10023. },
  10024. "400": {
  10025. "$ref": "#/responses/error"
  10026. },
  10027. "403": {
  10028. "$ref": "#/responses/forbidden"
  10029. },
  10030. "404": {
  10031. "$ref": "#/responses/notFound"
  10032. }
  10033. }
  10034. },
  10035. "delete": {
  10036. "consumes": [
  10037. "application/json"
  10038. ],
  10039. "produces": [
  10040. "application/json"
  10041. ],
  10042. "tags": [
  10043. "issue"
  10044. ],
  10045. "summary": "Reset a tracked time of an issue",
  10046. "operationId": "issueResetTime",
  10047. "parameters": [
  10048. {
  10049. "type": "string",
  10050. "description": "owner of the repo",
  10051. "name": "owner",
  10052. "in": "path",
  10053. "required": true
  10054. },
  10055. {
  10056. "type": "string",
  10057. "description": "name of the repo",
  10058. "name": "repo",
  10059. "in": "path",
  10060. "required": true
  10061. },
  10062. {
  10063. "type": "integer",
  10064. "format": "int64",
  10065. "description": "index of the issue to add tracked time to",
  10066. "name": "index",
  10067. "in": "path",
  10068. "required": true
  10069. }
  10070. ],
  10071. "responses": {
  10072. "204": {
  10073. "$ref": "#/responses/empty"
  10074. },
  10075. "400": {
  10076. "$ref": "#/responses/error"
  10077. },
  10078. "403": {
  10079. "$ref": "#/responses/forbidden"
  10080. },
  10081. "404": {
  10082. "$ref": "#/responses/notFound"
  10083. }
  10084. }
  10085. }
  10086. },
  10087. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  10088. "delete": {
  10089. "consumes": [
  10090. "application/json"
  10091. ],
  10092. "produces": [
  10093. "application/json"
  10094. ],
  10095. "tags": [
  10096. "issue"
  10097. ],
  10098. "summary": "Delete specific tracked time",
  10099. "operationId": "issueDeleteTime",
  10100. "parameters": [
  10101. {
  10102. "type": "string",
  10103. "description": "owner of the repo",
  10104. "name": "owner",
  10105. "in": "path",
  10106. "required": true
  10107. },
  10108. {
  10109. "type": "string",
  10110. "description": "name of the repo",
  10111. "name": "repo",
  10112. "in": "path",
  10113. "required": true
  10114. },
  10115. {
  10116. "type": "integer",
  10117. "format": "int64",
  10118. "description": "index of the issue",
  10119. "name": "index",
  10120. "in": "path",
  10121. "required": true
  10122. },
  10123. {
  10124. "type": "integer",
  10125. "format": "int64",
  10126. "description": "id of time to delete",
  10127. "name": "id",
  10128. "in": "path",
  10129. "required": true
  10130. }
  10131. ],
  10132. "responses": {
  10133. "204": {
  10134. "$ref": "#/responses/empty"
  10135. },
  10136. "400": {
  10137. "$ref": "#/responses/error"
  10138. },
  10139. "403": {
  10140. "$ref": "#/responses/forbidden"
  10141. },
  10142. "404": {
  10143. "$ref": "#/responses/notFound"
  10144. }
  10145. }
  10146. }
  10147. },
  10148. "/repos/{owner}/{repo}/keys": {
  10149. "get": {
  10150. "produces": [
  10151. "application/json"
  10152. ],
  10153. "tags": [
  10154. "repository"
  10155. ],
  10156. "summary": "List a repository's keys",
  10157. "operationId": "repoListKeys",
  10158. "parameters": [
  10159. {
  10160. "type": "string",
  10161. "description": "owner of the repo",
  10162. "name": "owner",
  10163. "in": "path",
  10164. "required": true
  10165. },
  10166. {
  10167. "type": "string",
  10168. "description": "name of the repo",
  10169. "name": "repo",
  10170. "in": "path",
  10171. "required": true
  10172. },
  10173. {
  10174. "type": "integer",
  10175. "description": "the key_id to search for",
  10176. "name": "key_id",
  10177. "in": "query"
  10178. },
  10179. {
  10180. "type": "string",
  10181. "description": "fingerprint of the key",
  10182. "name": "fingerprint",
  10183. "in": "query"
  10184. },
  10185. {
  10186. "type": "integer",
  10187. "description": "page number of results to return (1-based)",
  10188. "name": "page",
  10189. "in": "query"
  10190. },
  10191. {
  10192. "type": "integer",
  10193. "description": "page size of results",
  10194. "name": "limit",
  10195. "in": "query"
  10196. }
  10197. ],
  10198. "responses": {
  10199. "200": {
  10200. "$ref": "#/responses/DeployKeyList"
  10201. },
  10202. "404": {
  10203. "$ref": "#/responses/notFound"
  10204. }
  10205. }
  10206. },
  10207. "post": {
  10208. "consumes": [
  10209. "application/json"
  10210. ],
  10211. "produces": [
  10212. "application/json"
  10213. ],
  10214. "tags": [
  10215. "repository"
  10216. ],
  10217. "summary": "Add a key to a repository",
  10218. "operationId": "repoCreateKey",
  10219. "parameters": [
  10220. {
  10221. "type": "string",
  10222. "description": "owner of the repo",
  10223. "name": "owner",
  10224. "in": "path",
  10225. "required": true
  10226. },
  10227. {
  10228. "type": "string",
  10229. "description": "name of the repo",
  10230. "name": "repo",
  10231. "in": "path",
  10232. "required": true
  10233. },
  10234. {
  10235. "name": "body",
  10236. "in": "body",
  10237. "schema": {
  10238. "$ref": "#/definitions/CreateKeyOption"
  10239. }
  10240. }
  10241. ],
  10242. "responses": {
  10243. "201": {
  10244. "$ref": "#/responses/DeployKey"
  10245. },
  10246. "404": {
  10247. "$ref": "#/responses/notFound"
  10248. },
  10249. "422": {
  10250. "$ref": "#/responses/validationError"
  10251. }
  10252. }
  10253. }
  10254. },
  10255. "/repos/{owner}/{repo}/keys/{id}": {
  10256. "get": {
  10257. "produces": [
  10258. "application/json"
  10259. ],
  10260. "tags": [
  10261. "repository"
  10262. ],
  10263. "summary": "Get a repository's key by id",
  10264. "operationId": "repoGetKey",
  10265. "parameters": [
  10266. {
  10267. "type": "string",
  10268. "description": "owner of the repo",
  10269. "name": "owner",
  10270. "in": "path",
  10271. "required": true
  10272. },
  10273. {
  10274. "type": "string",
  10275. "description": "name of the repo",
  10276. "name": "repo",
  10277. "in": "path",
  10278. "required": true
  10279. },
  10280. {
  10281. "type": "integer",
  10282. "format": "int64",
  10283. "description": "id of the key to get",
  10284. "name": "id",
  10285. "in": "path",
  10286. "required": true
  10287. }
  10288. ],
  10289. "responses": {
  10290. "200": {
  10291. "$ref": "#/responses/DeployKey"
  10292. },
  10293. "404": {
  10294. "$ref": "#/responses/notFound"
  10295. }
  10296. }
  10297. },
  10298. "delete": {
  10299. "tags": [
  10300. "repository"
  10301. ],
  10302. "summary": "Delete a key from a repository",
  10303. "operationId": "repoDeleteKey",
  10304. "parameters": [
  10305. {
  10306. "type": "string",
  10307. "description": "owner of the repo",
  10308. "name": "owner",
  10309. "in": "path",
  10310. "required": true
  10311. },
  10312. {
  10313. "type": "string",
  10314. "description": "name of the repo",
  10315. "name": "repo",
  10316. "in": "path",
  10317. "required": true
  10318. },
  10319. {
  10320. "type": "integer",
  10321. "format": "int64",
  10322. "description": "id of the key to delete",
  10323. "name": "id",
  10324. "in": "path",
  10325. "required": true
  10326. }
  10327. ],
  10328. "responses": {
  10329. "204": {
  10330. "$ref": "#/responses/empty"
  10331. },
  10332. "403": {
  10333. "$ref": "#/responses/forbidden"
  10334. },
  10335. "404": {
  10336. "$ref": "#/responses/notFound"
  10337. }
  10338. }
  10339. }
  10340. },
  10341. "/repos/{owner}/{repo}/labels": {
  10342. "get": {
  10343. "produces": [
  10344. "application/json"
  10345. ],
  10346. "tags": [
  10347. "issue"
  10348. ],
  10349. "summary": "Get all of a repository's labels",
  10350. "operationId": "issueListLabels",
  10351. "parameters": [
  10352. {
  10353. "type": "string",
  10354. "description": "owner of the repo",
  10355. "name": "owner",
  10356. "in": "path",
  10357. "required": true
  10358. },
  10359. {
  10360. "type": "string",
  10361. "description": "name of the repo",
  10362. "name": "repo",
  10363. "in": "path",
  10364. "required": true
  10365. },
  10366. {
  10367. "type": "integer",
  10368. "description": "page number of results to return (1-based)",
  10369. "name": "page",
  10370. "in": "query"
  10371. },
  10372. {
  10373. "type": "integer",
  10374. "description": "page size of results",
  10375. "name": "limit",
  10376. "in": "query"
  10377. }
  10378. ],
  10379. "responses": {
  10380. "200": {
  10381. "$ref": "#/responses/LabelList"
  10382. },
  10383. "404": {
  10384. "$ref": "#/responses/notFound"
  10385. }
  10386. }
  10387. },
  10388. "post": {
  10389. "consumes": [
  10390. "application/json"
  10391. ],
  10392. "produces": [
  10393. "application/json"
  10394. ],
  10395. "tags": [
  10396. "issue"
  10397. ],
  10398. "summary": "Create a label",
  10399. "operationId": "issueCreateLabel",
  10400. "parameters": [
  10401. {
  10402. "type": "string",
  10403. "description": "owner of the repo",
  10404. "name": "owner",
  10405. "in": "path",
  10406. "required": true
  10407. },
  10408. {
  10409. "type": "string",
  10410. "description": "name of the repo",
  10411. "name": "repo",
  10412. "in": "path",
  10413. "required": true
  10414. },
  10415. {
  10416. "name": "body",
  10417. "in": "body",
  10418. "schema": {
  10419. "$ref": "#/definitions/CreateLabelOption"
  10420. }
  10421. }
  10422. ],
  10423. "responses": {
  10424. "201": {
  10425. "$ref": "#/responses/Label"
  10426. },
  10427. "404": {
  10428. "$ref": "#/responses/notFound"
  10429. },
  10430. "422": {
  10431. "$ref": "#/responses/validationError"
  10432. }
  10433. }
  10434. }
  10435. },
  10436. "/repos/{owner}/{repo}/labels/{id}": {
  10437. "get": {
  10438. "produces": [
  10439. "application/json"
  10440. ],
  10441. "tags": [
  10442. "issue"
  10443. ],
  10444. "summary": "Get a single label",
  10445. "operationId": "issueGetLabel",
  10446. "parameters": [
  10447. {
  10448. "type": "string",
  10449. "description": "owner of the repo",
  10450. "name": "owner",
  10451. "in": "path",
  10452. "required": true
  10453. },
  10454. {
  10455. "type": "string",
  10456. "description": "name of the repo",
  10457. "name": "repo",
  10458. "in": "path",
  10459. "required": true
  10460. },
  10461. {
  10462. "type": "integer",
  10463. "format": "int64",
  10464. "description": "id of the label to get",
  10465. "name": "id",
  10466. "in": "path",
  10467. "required": true
  10468. }
  10469. ],
  10470. "responses": {
  10471. "200": {
  10472. "$ref": "#/responses/Label"
  10473. },
  10474. "404": {
  10475. "$ref": "#/responses/notFound"
  10476. }
  10477. }
  10478. },
  10479. "delete": {
  10480. "tags": [
  10481. "issue"
  10482. ],
  10483. "summary": "Delete a label",
  10484. "operationId": "issueDeleteLabel",
  10485. "parameters": [
  10486. {
  10487. "type": "string",
  10488. "description": "owner of the repo",
  10489. "name": "owner",
  10490. "in": "path",
  10491. "required": true
  10492. },
  10493. {
  10494. "type": "string",
  10495. "description": "name of the repo",
  10496. "name": "repo",
  10497. "in": "path",
  10498. "required": true
  10499. },
  10500. {
  10501. "type": "integer",
  10502. "format": "int64",
  10503. "description": "id of the label to delete",
  10504. "name": "id",
  10505. "in": "path",
  10506. "required": true
  10507. }
  10508. ],
  10509. "responses": {
  10510. "204": {
  10511. "$ref": "#/responses/empty"
  10512. },
  10513. "404": {
  10514. "$ref": "#/responses/notFound"
  10515. }
  10516. }
  10517. },
  10518. "patch": {
  10519. "consumes": [
  10520. "application/json"
  10521. ],
  10522. "produces": [
  10523. "application/json"
  10524. ],
  10525. "tags": [
  10526. "issue"
  10527. ],
  10528. "summary": "Update a label",
  10529. "operationId": "issueEditLabel",
  10530. "parameters": [
  10531. {
  10532. "type": "string",
  10533. "description": "owner of the repo",
  10534. "name": "owner",
  10535. "in": "path",
  10536. "required": true
  10537. },
  10538. {
  10539. "type": "string",
  10540. "description": "name of the repo",
  10541. "name": "repo",
  10542. "in": "path",
  10543. "required": true
  10544. },
  10545. {
  10546. "type": "integer",
  10547. "format": "int64",
  10548. "description": "id of the label to edit",
  10549. "name": "id",
  10550. "in": "path",
  10551. "required": true
  10552. },
  10553. {
  10554. "name": "body",
  10555. "in": "body",
  10556. "schema": {
  10557. "$ref": "#/definitions/EditLabelOption"
  10558. }
  10559. }
  10560. ],
  10561. "responses": {
  10562. "200": {
  10563. "$ref": "#/responses/Label"
  10564. },
  10565. "404": {
  10566. "$ref": "#/responses/notFound"
  10567. },
  10568. "422": {
  10569. "$ref": "#/responses/validationError"
  10570. }
  10571. }
  10572. }
  10573. },
  10574. "/repos/{owner}/{repo}/languages": {
  10575. "get": {
  10576. "produces": [
  10577. "application/json"
  10578. ],
  10579. "tags": [
  10580. "repository"
  10581. ],
  10582. "summary": "Get languages and number of bytes of code written",
  10583. "operationId": "repoGetLanguages",
  10584. "parameters": [
  10585. {
  10586. "type": "string",
  10587. "description": "owner of the repo",
  10588. "name": "owner",
  10589. "in": "path",
  10590. "required": true
  10591. },
  10592. {
  10593. "type": "string",
  10594. "description": "name of the repo",
  10595. "name": "repo",
  10596. "in": "path",
  10597. "required": true
  10598. }
  10599. ],
  10600. "responses": {
  10601. "200": {
  10602. "$ref": "#/responses/LanguageStatistics"
  10603. },
  10604. "404": {
  10605. "$ref": "#/responses/notFound"
  10606. }
  10607. }
  10608. }
  10609. },
  10610. "/repos/{owner}/{repo}/media/{filepath}": {
  10611. "get": {
  10612. "tags": [
  10613. "repository"
  10614. ],
  10615. "summary": "Get a file or it's LFS object from a repository",
  10616. "operationId": "repoGetRawFileOrLFS",
  10617. "parameters": [
  10618. {
  10619. "type": "string",
  10620. "description": "owner of the repo",
  10621. "name": "owner",
  10622. "in": "path",
  10623. "required": true
  10624. },
  10625. {
  10626. "type": "string",
  10627. "description": "name of the repo",
  10628. "name": "repo",
  10629. "in": "path",
  10630. "required": true
  10631. },
  10632. {
  10633. "type": "string",
  10634. "description": "filepath of the file to get",
  10635. "name": "filepath",
  10636. "in": "path",
  10637. "required": true
  10638. },
  10639. {
  10640. "type": "string",
  10641. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  10642. "name": "ref",
  10643. "in": "query"
  10644. }
  10645. ],
  10646. "responses": {
  10647. "200": {
  10648. "description": "Returns raw file content."
  10649. },
  10650. "404": {
  10651. "$ref": "#/responses/notFound"
  10652. }
  10653. }
  10654. }
  10655. },
  10656. "/repos/{owner}/{repo}/milestones": {
  10657. "get": {
  10658. "produces": [
  10659. "application/json"
  10660. ],
  10661. "tags": [
  10662. "issue"
  10663. ],
  10664. "summary": "Get all of a repository's opened milestones",
  10665. "operationId": "issueGetMilestonesList",
  10666. "parameters": [
  10667. {
  10668. "type": "string",
  10669. "description": "owner of the repo",
  10670. "name": "owner",
  10671. "in": "path",
  10672. "required": true
  10673. },
  10674. {
  10675. "type": "string",
  10676. "description": "name of the repo",
  10677. "name": "repo",
  10678. "in": "path",
  10679. "required": true
  10680. },
  10681. {
  10682. "type": "string",
  10683. "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
  10684. "name": "state",
  10685. "in": "query"
  10686. },
  10687. {
  10688. "type": "string",
  10689. "description": "filter by milestone name",
  10690. "name": "name",
  10691. "in": "query"
  10692. },
  10693. {
  10694. "type": "integer",
  10695. "description": "page number of results to return (1-based)",
  10696. "name": "page",
  10697. "in": "query"
  10698. },
  10699. {
  10700. "type": "integer",
  10701. "description": "page size of results",
  10702. "name": "limit",
  10703. "in": "query"
  10704. }
  10705. ],
  10706. "responses": {
  10707. "200": {
  10708. "$ref": "#/responses/MilestoneList"
  10709. },
  10710. "404": {
  10711. "$ref": "#/responses/notFound"
  10712. }
  10713. }
  10714. },
  10715. "post": {
  10716. "consumes": [
  10717. "application/json"
  10718. ],
  10719. "produces": [
  10720. "application/json"
  10721. ],
  10722. "tags": [
  10723. "issue"
  10724. ],
  10725. "summary": "Create a milestone",
  10726. "operationId": "issueCreateMilestone",
  10727. "parameters": [
  10728. {
  10729. "type": "string",
  10730. "description": "owner of the repo",
  10731. "name": "owner",
  10732. "in": "path",
  10733. "required": true
  10734. },
  10735. {
  10736. "type": "string",
  10737. "description": "name of the repo",
  10738. "name": "repo",
  10739. "in": "path",
  10740. "required": true
  10741. },
  10742. {
  10743. "name": "body",
  10744. "in": "body",
  10745. "schema": {
  10746. "$ref": "#/definitions/CreateMilestoneOption"
  10747. }
  10748. }
  10749. ],
  10750. "responses": {
  10751. "201": {
  10752. "$ref": "#/responses/Milestone"
  10753. },
  10754. "404": {
  10755. "$ref": "#/responses/notFound"
  10756. }
  10757. }
  10758. }
  10759. },
  10760. "/repos/{owner}/{repo}/milestones/{id}": {
  10761. "get": {
  10762. "produces": [
  10763. "application/json"
  10764. ],
  10765. "tags": [
  10766. "issue"
  10767. ],
  10768. "summary": "Get a milestone",
  10769. "operationId": "issueGetMilestone",
  10770. "parameters": [
  10771. {
  10772. "type": "string",
  10773. "description": "owner of the repo",
  10774. "name": "owner",
  10775. "in": "path",
  10776. "required": true
  10777. },
  10778. {
  10779. "type": "string",
  10780. "description": "name of the repo",
  10781. "name": "repo",
  10782. "in": "path",
  10783. "required": true
  10784. },
  10785. {
  10786. "type": "string",
  10787. "description": "the milestone to get, identified by ID and if not available by name",
  10788. "name": "id",
  10789. "in": "path",
  10790. "required": true
  10791. }
  10792. ],
  10793. "responses": {
  10794. "200": {
  10795. "$ref": "#/responses/Milestone"
  10796. },
  10797. "404": {
  10798. "$ref": "#/responses/notFound"
  10799. }
  10800. }
  10801. },
  10802. "delete": {
  10803. "tags": [
  10804. "issue"
  10805. ],
  10806. "summary": "Delete a milestone",
  10807. "operationId": "issueDeleteMilestone",
  10808. "parameters": [
  10809. {
  10810. "type": "string",
  10811. "description": "owner of the repo",
  10812. "name": "owner",
  10813. "in": "path",
  10814. "required": true
  10815. },
  10816. {
  10817. "type": "string",
  10818. "description": "name of the repo",
  10819. "name": "repo",
  10820. "in": "path",
  10821. "required": true
  10822. },
  10823. {
  10824. "type": "string",
  10825. "description": "the milestone to delete, identified by ID and if not available by name",
  10826. "name": "id",
  10827. "in": "path",
  10828. "required": true
  10829. }
  10830. ],
  10831. "responses": {
  10832. "204": {
  10833. "$ref": "#/responses/empty"
  10834. },
  10835. "404": {
  10836. "$ref": "#/responses/notFound"
  10837. }
  10838. }
  10839. },
  10840. "patch": {
  10841. "consumes": [
  10842. "application/json"
  10843. ],
  10844. "produces": [
  10845. "application/json"
  10846. ],
  10847. "tags": [
  10848. "issue"
  10849. ],
  10850. "summary": "Update a milestone",
  10851. "operationId": "issueEditMilestone",
  10852. "parameters": [
  10853. {
  10854. "type": "string",
  10855. "description": "owner of the repo",
  10856. "name": "owner",
  10857. "in": "path",
  10858. "required": true
  10859. },
  10860. {
  10861. "type": "string",
  10862. "description": "name of the repo",
  10863. "name": "repo",
  10864. "in": "path",
  10865. "required": true
  10866. },
  10867. {
  10868. "type": "string",
  10869. "description": "the milestone to edit, identified by ID and if not available by name",
  10870. "name": "id",
  10871. "in": "path",
  10872. "required": true
  10873. },
  10874. {
  10875. "name": "body",
  10876. "in": "body",
  10877. "schema": {
  10878. "$ref": "#/definitions/EditMilestoneOption"
  10879. }
  10880. }
  10881. ],
  10882. "responses": {
  10883. "200": {
  10884. "$ref": "#/responses/Milestone"
  10885. },
  10886. "404": {
  10887. "$ref": "#/responses/notFound"
  10888. }
  10889. }
  10890. }
  10891. },
  10892. "/repos/{owner}/{repo}/mirror-sync": {
  10893. "post": {
  10894. "produces": [
  10895. "application/json"
  10896. ],
  10897. "tags": [
  10898. "repository"
  10899. ],
  10900. "summary": "Sync a mirrored repository",
  10901. "operationId": "repoMirrorSync",
  10902. "parameters": [
  10903. {
  10904. "type": "string",
  10905. "description": "owner of the repo to sync",
  10906. "name": "owner",
  10907. "in": "path",
  10908. "required": true
  10909. },
  10910. {
  10911. "type": "string",
  10912. "description": "name of the repo to sync",
  10913. "name": "repo",
  10914. "in": "path",
  10915. "required": true
  10916. }
  10917. ],
  10918. "responses": {
  10919. "200": {
  10920. "$ref": "#/responses/empty"
  10921. },
  10922. "403": {
  10923. "$ref": "#/responses/forbidden"
  10924. },
  10925. "404": {
  10926. "$ref": "#/responses/notFound"
  10927. }
  10928. }
  10929. }
  10930. },
  10931. "/repos/{owner}/{repo}/new_pin_allowed": {
  10932. "get": {
  10933. "produces": [
  10934. "application/json"
  10935. ],
  10936. "tags": [
  10937. "repository"
  10938. ],
  10939. "summary": "Returns if new Issue Pins are allowed",
  10940. "operationId": "repoNewPinAllowed",
  10941. "parameters": [
  10942. {
  10943. "type": "string",
  10944. "description": "owner of the repo",
  10945. "name": "owner",
  10946. "in": "path",
  10947. "required": true
  10948. },
  10949. {
  10950. "type": "string",
  10951. "description": "name of the repo",
  10952. "name": "repo",
  10953. "in": "path",
  10954. "required": true
  10955. }
  10956. ],
  10957. "responses": {
  10958. "200": {
  10959. "$ref": "#/responses/RepoNewIssuePinsAllowed"
  10960. },
  10961. "404": {
  10962. "$ref": "#/responses/notFound"
  10963. }
  10964. }
  10965. }
  10966. },
  10967. "/repos/{owner}/{repo}/notifications": {
  10968. "get": {
  10969. "consumes": [
  10970. "application/json"
  10971. ],
  10972. "produces": [
  10973. "application/json"
  10974. ],
  10975. "tags": [
  10976. "notification"
  10977. ],
  10978. "summary": "List users's notification threads on a specific repo",
  10979. "operationId": "notifyGetRepoList",
  10980. "parameters": [
  10981. {
  10982. "type": "string",
  10983. "description": "owner of the repo",
  10984. "name": "owner",
  10985. "in": "path",
  10986. "required": true
  10987. },
  10988. {
  10989. "type": "string",
  10990. "description": "name of the repo",
  10991. "name": "repo",
  10992. "in": "path",
  10993. "required": true
  10994. },
  10995. {
  10996. "type": "boolean",
  10997. "description": "If true, show notifications marked as read. Default value is false",
  10998. "name": "all",
  10999. "in": "query"
  11000. },
  11001. {
  11002. "type": "array",
  11003. "items": {
  11004. "type": "string"
  11005. },
  11006. "collectionFormat": "multi",
  11007. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  11008. "name": "status-types",
  11009. "in": "query"
  11010. },
  11011. {
  11012. "type": "array",
  11013. "items": {
  11014. "enum": [
  11015. "issue",
  11016. "pull",
  11017. "commit",
  11018. "repository"
  11019. ],
  11020. "type": "string"
  11021. },
  11022. "collectionFormat": "multi",
  11023. "description": "filter notifications by subject type",
  11024. "name": "subject-type",
  11025. "in": "query"
  11026. },
  11027. {
  11028. "type": "string",
  11029. "format": "date-time",
  11030. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  11031. "name": "since",
  11032. "in": "query"
  11033. },
  11034. {
  11035. "type": "string",
  11036. "format": "date-time",
  11037. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  11038. "name": "before",
  11039. "in": "query"
  11040. },
  11041. {
  11042. "type": "integer",
  11043. "description": "page number of results to return (1-based)",
  11044. "name": "page",
  11045. "in": "query"
  11046. },
  11047. {
  11048. "type": "integer",
  11049. "description": "page size of results",
  11050. "name": "limit",
  11051. "in": "query"
  11052. }
  11053. ],
  11054. "responses": {
  11055. "200": {
  11056. "$ref": "#/responses/NotificationThreadList"
  11057. }
  11058. }
  11059. },
  11060. "put": {
  11061. "consumes": [
  11062. "application/json"
  11063. ],
  11064. "produces": [
  11065. "application/json"
  11066. ],
  11067. "tags": [
  11068. "notification"
  11069. ],
  11070. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  11071. "operationId": "notifyReadRepoList",
  11072. "parameters": [
  11073. {
  11074. "type": "string",
  11075. "description": "owner of the repo",
  11076. "name": "owner",
  11077. "in": "path",
  11078. "required": true
  11079. },
  11080. {
  11081. "type": "string",
  11082. "description": "name of the repo",
  11083. "name": "repo",
  11084. "in": "path",
  11085. "required": true
  11086. },
  11087. {
  11088. "type": "string",
  11089. "description": "If true, mark all notifications on this repo. Default value is false",
  11090. "name": "all",
  11091. "in": "query"
  11092. },
  11093. {
  11094. "type": "array",
  11095. "items": {
  11096. "type": "string"
  11097. },
  11098. "collectionFormat": "multi",
  11099. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  11100. "name": "status-types",
  11101. "in": "query"
  11102. },
  11103. {
  11104. "type": "string",
  11105. "description": "Status to mark notifications as. Defaults to read.",
  11106. "name": "to-status",
  11107. "in": "query"
  11108. },
  11109. {
  11110. "type": "string",
  11111. "format": "date-time",
  11112. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  11113. "name": "last_read_at",
  11114. "in": "query"
  11115. }
  11116. ],
  11117. "responses": {
  11118. "205": {
  11119. "$ref": "#/responses/NotificationThreadList"
  11120. }
  11121. }
  11122. }
  11123. },
  11124. "/repos/{owner}/{repo}/pulls": {
  11125. "get": {
  11126. "produces": [
  11127. "application/json"
  11128. ],
  11129. "tags": [
  11130. "repository"
  11131. ],
  11132. "summary": "List a repo's pull requests",
  11133. "operationId": "repoListPullRequests",
  11134. "parameters": [
  11135. {
  11136. "type": "string",
  11137. "description": "owner of the repo",
  11138. "name": "owner",
  11139. "in": "path",
  11140. "required": true
  11141. },
  11142. {
  11143. "type": "string",
  11144. "description": "name of the repo",
  11145. "name": "repo",
  11146. "in": "path",
  11147. "required": true
  11148. },
  11149. {
  11150. "enum": [
  11151. "closed",
  11152. "open",
  11153. "all"
  11154. ],
  11155. "type": "string",
  11156. "description": "State of pull request: open or closed (optional)",
  11157. "name": "state",
  11158. "in": "query"
  11159. },
  11160. {
  11161. "enum": [
  11162. "oldest",
  11163. "recentupdate",
  11164. "leastupdate",
  11165. "mostcomment",
  11166. "leastcomment",
  11167. "priority"
  11168. ],
  11169. "type": "string",
  11170. "description": "Type of sort",
  11171. "name": "sort",
  11172. "in": "query"
  11173. },
  11174. {
  11175. "type": "integer",
  11176. "format": "int64",
  11177. "description": "ID of the milestone",
  11178. "name": "milestone",
  11179. "in": "query"
  11180. },
  11181. {
  11182. "type": "array",
  11183. "items": {
  11184. "type": "integer",
  11185. "format": "int64"
  11186. },
  11187. "collectionFormat": "multi",
  11188. "description": "Label IDs",
  11189. "name": "labels",
  11190. "in": "query"
  11191. },
  11192. {
  11193. "type": "integer",
  11194. "description": "page number of results to return (1-based)",
  11195. "name": "page",
  11196. "in": "query"
  11197. },
  11198. {
  11199. "type": "integer",
  11200. "description": "page size of results",
  11201. "name": "limit",
  11202. "in": "query"
  11203. }
  11204. ],
  11205. "responses": {
  11206. "200": {
  11207. "$ref": "#/responses/PullRequestList"
  11208. },
  11209. "404": {
  11210. "$ref": "#/responses/notFound"
  11211. }
  11212. }
  11213. },
  11214. "post": {
  11215. "consumes": [
  11216. "application/json"
  11217. ],
  11218. "produces": [
  11219. "application/json"
  11220. ],
  11221. "tags": [
  11222. "repository"
  11223. ],
  11224. "summary": "Create a pull request",
  11225. "operationId": "repoCreatePullRequest",
  11226. "parameters": [
  11227. {
  11228. "type": "string",
  11229. "description": "owner of the repo",
  11230. "name": "owner",
  11231. "in": "path",
  11232. "required": true
  11233. },
  11234. {
  11235. "type": "string",
  11236. "description": "name of the repo",
  11237. "name": "repo",
  11238. "in": "path",
  11239. "required": true
  11240. },
  11241. {
  11242. "name": "body",
  11243. "in": "body",
  11244. "schema": {
  11245. "$ref": "#/definitions/CreatePullRequestOption"
  11246. }
  11247. }
  11248. ],
  11249. "responses": {
  11250. "201": {
  11251. "$ref": "#/responses/PullRequest"
  11252. },
  11253. "403": {
  11254. "$ref": "#/responses/forbidden"
  11255. },
  11256. "404": {
  11257. "$ref": "#/responses/notFound"
  11258. },
  11259. "409": {
  11260. "$ref": "#/responses/error"
  11261. },
  11262. "422": {
  11263. "$ref": "#/responses/validationError"
  11264. },
  11265. "423": {
  11266. "$ref": "#/responses/repoArchivedError"
  11267. }
  11268. }
  11269. }
  11270. },
  11271. "/repos/{owner}/{repo}/pulls/pinned": {
  11272. "get": {
  11273. "produces": [
  11274. "application/json"
  11275. ],
  11276. "tags": [
  11277. "repository"
  11278. ],
  11279. "summary": "List a repo's pinned pull requests",
  11280. "operationId": "repoListPinnedPullRequests",
  11281. "parameters": [
  11282. {
  11283. "type": "string",
  11284. "description": "owner of the repo",
  11285. "name": "owner",
  11286. "in": "path",
  11287. "required": true
  11288. },
  11289. {
  11290. "type": "string",
  11291. "description": "name of the repo",
  11292. "name": "repo",
  11293. "in": "path",
  11294. "required": true
  11295. }
  11296. ],
  11297. "responses": {
  11298. "200": {
  11299. "$ref": "#/responses/PullRequestList"
  11300. },
  11301. "404": {
  11302. "$ref": "#/responses/notFound"
  11303. }
  11304. }
  11305. }
  11306. },
  11307. "/repos/{owner}/{repo}/pulls/{base}/{head}": {
  11308. "get": {
  11309. "produces": [
  11310. "application/json"
  11311. ],
  11312. "tags": [
  11313. "repository"
  11314. ],
  11315. "summary": "Get a pull request by base and head",
  11316. "operationId": "repoGetPullRequestByBaseHead",
  11317. "parameters": [
  11318. {
  11319. "type": "string",
  11320. "description": "owner of the repo",
  11321. "name": "owner",
  11322. "in": "path",
  11323. "required": true
  11324. },
  11325. {
  11326. "type": "string",
  11327. "description": "name of the repo",
  11328. "name": "repo",
  11329. "in": "path",
  11330. "required": true
  11331. },
  11332. {
  11333. "type": "string",
  11334. "description": "base of the pull request to get",
  11335. "name": "base",
  11336. "in": "path",
  11337. "required": true
  11338. },
  11339. {
  11340. "type": "string",
  11341. "description": "head of the pull request to get",
  11342. "name": "head",
  11343. "in": "path",
  11344. "required": true
  11345. }
  11346. ],
  11347. "responses": {
  11348. "200": {
  11349. "$ref": "#/responses/PullRequest"
  11350. },
  11351. "404": {
  11352. "$ref": "#/responses/notFound"
  11353. }
  11354. }
  11355. }
  11356. },
  11357. "/repos/{owner}/{repo}/pulls/{index}": {
  11358. "get": {
  11359. "produces": [
  11360. "application/json"
  11361. ],
  11362. "tags": [
  11363. "repository"
  11364. ],
  11365. "summary": "Get a pull request",
  11366. "operationId": "repoGetPullRequest",
  11367. "parameters": [
  11368. {
  11369. "type": "string",
  11370. "description": "owner of the repo",
  11371. "name": "owner",
  11372. "in": "path",
  11373. "required": true
  11374. },
  11375. {
  11376. "type": "string",
  11377. "description": "name of the repo",
  11378. "name": "repo",
  11379. "in": "path",
  11380. "required": true
  11381. },
  11382. {
  11383. "type": "integer",
  11384. "format": "int64",
  11385. "description": "index of the pull request to get",
  11386. "name": "index",
  11387. "in": "path",
  11388. "required": true
  11389. }
  11390. ],
  11391. "responses": {
  11392. "200": {
  11393. "$ref": "#/responses/PullRequest"
  11394. },
  11395. "404": {
  11396. "$ref": "#/responses/notFound"
  11397. }
  11398. }
  11399. },
  11400. "patch": {
  11401. "consumes": [
  11402. "application/json"
  11403. ],
  11404. "produces": [
  11405. "application/json"
  11406. ],
  11407. "tags": [
  11408. "repository"
  11409. ],
  11410. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  11411. "operationId": "repoEditPullRequest",
  11412. "parameters": [
  11413. {
  11414. "type": "string",
  11415. "description": "owner of the repo",
  11416. "name": "owner",
  11417. "in": "path",
  11418. "required": true
  11419. },
  11420. {
  11421. "type": "string",
  11422. "description": "name of the repo",
  11423. "name": "repo",
  11424. "in": "path",
  11425. "required": true
  11426. },
  11427. {
  11428. "type": "integer",
  11429. "format": "int64",
  11430. "description": "index of the pull request to edit",
  11431. "name": "index",
  11432. "in": "path",
  11433. "required": true
  11434. },
  11435. {
  11436. "name": "body",
  11437. "in": "body",
  11438. "schema": {
  11439. "$ref": "#/definitions/EditPullRequestOption"
  11440. }
  11441. }
  11442. ],
  11443. "responses": {
  11444. "201": {
  11445. "$ref": "#/responses/PullRequest"
  11446. },
  11447. "403": {
  11448. "$ref": "#/responses/forbidden"
  11449. },
  11450. "404": {
  11451. "$ref": "#/responses/notFound"
  11452. },
  11453. "409": {
  11454. "$ref": "#/responses/error"
  11455. },
  11456. "412": {
  11457. "$ref": "#/responses/error"
  11458. },
  11459. "422": {
  11460. "$ref": "#/responses/validationError"
  11461. }
  11462. }
  11463. }
  11464. },
  11465. "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
  11466. "get": {
  11467. "produces": [
  11468. "text/plain"
  11469. ],
  11470. "tags": [
  11471. "repository"
  11472. ],
  11473. "summary": "Get a pull request diff or patch",
  11474. "operationId": "repoDownloadPullDiffOrPatch",
  11475. "parameters": [
  11476. {
  11477. "type": "string",
  11478. "description": "owner of the repo",
  11479. "name": "owner",
  11480. "in": "path",
  11481. "required": true
  11482. },
  11483. {
  11484. "type": "string",
  11485. "description": "name of the repo",
  11486. "name": "repo",
  11487. "in": "path",
  11488. "required": true
  11489. },
  11490. {
  11491. "type": "integer",
  11492. "format": "int64",
  11493. "description": "index of the pull request to get",
  11494. "name": "index",
  11495. "in": "path",
  11496. "required": true
  11497. },
  11498. {
  11499. "enum": [
  11500. "diff",
  11501. "patch"
  11502. ],
  11503. "type": "string",
  11504. "description": "whether the output is diff or patch",
  11505. "name": "diffType",
  11506. "in": "path",
  11507. "required": true
  11508. },
  11509. {
  11510. "type": "boolean",
  11511. "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
  11512. "name": "binary",
  11513. "in": "query"
  11514. }
  11515. ],
  11516. "responses": {
  11517. "200": {
  11518. "$ref": "#/responses/string"
  11519. },
  11520. "404": {
  11521. "$ref": "#/responses/notFound"
  11522. }
  11523. }
  11524. }
  11525. },
  11526. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  11527. "get": {
  11528. "produces": [
  11529. "application/json"
  11530. ],
  11531. "tags": [
  11532. "repository"
  11533. ],
  11534. "summary": "Get commits for a pull request",
  11535. "operationId": "repoGetPullRequestCommits",
  11536. "parameters": [
  11537. {
  11538. "type": "string",
  11539. "description": "owner of the repo",
  11540. "name": "owner",
  11541. "in": "path",
  11542. "required": true
  11543. },
  11544. {
  11545. "type": "string",
  11546. "description": "name of the repo",
  11547. "name": "repo",
  11548. "in": "path",
  11549. "required": true
  11550. },
  11551. {
  11552. "type": "integer",
  11553. "format": "int64",
  11554. "description": "index of the pull request to get",
  11555. "name": "index",
  11556. "in": "path",
  11557. "required": true
  11558. },
  11559. {
  11560. "type": "integer",
  11561. "description": "page number of results to return (1-based)",
  11562. "name": "page",
  11563. "in": "query"
  11564. },
  11565. {
  11566. "type": "integer",
  11567. "description": "page size of results",
  11568. "name": "limit",
  11569. "in": "query"
  11570. },
  11571. {
  11572. "type": "boolean",
  11573. "description": "include verification for every commit (disable for speedup, default 'true')",
  11574. "name": "verification",
  11575. "in": "query"
  11576. },
  11577. {
  11578. "type": "boolean",
  11579. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  11580. "name": "files",
  11581. "in": "query"
  11582. }
  11583. ],
  11584. "responses": {
  11585. "200": {
  11586. "$ref": "#/responses/CommitList"
  11587. },
  11588. "404": {
  11589. "$ref": "#/responses/notFound"
  11590. }
  11591. }
  11592. }
  11593. },
  11594. "/repos/{owner}/{repo}/pulls/{index}/files": {
  11595. "get": {
  11596. "produces": [
  11597. "application/json"
  11598. ],
  11599. "tags": [
  11600. "repository"
  11601. ],
  11602. "summary": "Get changed files for a pull request",
  11603. "operationId": "repoGetPullRequestFiles",
  11604. "parameters": [
  11605. {
  11606. "type": "string",
  11607. "description": "owner of the repo",
  11608. "name": "owner",
  11609. "in": "path",
  11610. "required": true
  11611. },
  11612. {
  11613. "type": "string",
  11614. "description": "name of the repo",
  11615. "name": "repo",
  11616. "in": "path",
  11617. "required": true
  11618. },
  11619. {
  11620. "type": "integer",
  11621. "format": "int64",
  11622. "description": "index of the pull request to get",
  11623. "name": "index",
  11624. "in": "path",
  11625. "required": true
  11626. },
  11627. {
  11628. "type": "string",
  11629. "description": "skip to given file",
  11630. "name": "skip-to",
  11631. "in": "query"
  11632. },
  11633. {
  11634. "enum": [
  11635. "ignore-all",
  11636. "ignore-change",
  11637. "ignore-eol",
  11638. "show-all"
  11639. ],
  11640. "type": "string",
  11641. "description": "whitespace behavior",
  11642. "name": "whitespace",
  11643. "in": "query"
  11644. },
  11645. {
  11646. "type": "integer",
  11647. "description": "page number of results to return (1-based)",
  11648. "name": "page",
  11649. "in": "query"
  11650. },
  11651. {
  11652. "type": "integer",
  11653. "description": "page size of results",
  11654. "name": "limit",
  11655. "in": "query"
  11656. }
  11657. ],
  11658. "responses": {
  11659. "200": {
  11660. "$ref": "#/responses/ChangedFileList"
  11661. },
  11662. "404": {
  11663. "$ref": "#/responses/notFound"
  11664. }
  11665. }
  11666. }
  11667. },
  11668. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  11669. "get": {
  11670. "produces": [
  11671. "application/json"
  11672. ],
  11673. "tags": [
  11674. "repository"
  11675. ],
  11676. "summary": "Check if a pull request has been merged",
  11677. "operationId": "repoPullRequestIsMerged",
  11678. "parameters": [
  11679. {
  11680. "type": "string",
  11681. "description": "owner of the repo",
  11682. "name": "owner",
  11683. "in": "path",
  11684. "required": true
  11685. },
  11686. {
  11687. "type": "string",
  11688. "description": "name of the repo",
  11689. "name": "repo",
  11690. "in": "path",
  11691. "required": true
  11692. },
  11693. {
  11694. "type": "integer",
  11695. "format": "int64",
  11696. "description": "index of the pull request",
  11697. "name": "index",
  11698. "in": "path",
  11699. "required": true
  11700. }
  11701. ],
  11702. "responses": {
  11703. "204": {
  11704. "description": "pull request has been merged"
  11705. },
  11706. "404": {
  11707. "description": "pull request has not been merged"
  11708. }
  11709. }
  11710. },
  11711. "post": {
  11712. "produces": [
  11713. "application/json"
  11714. ],
  11715. "tags": [
  11716. "repository"
  11717. ],
  11718. "summary": "Merge a pull request",
  11719. "operationId": "repoMergePullRequest",
  11720. "parameters": [
  11721. {
  11722. "type": "string",
  11723. "description": "owner of the repo",
  11724. "name": "owner",
  11725. "in": "path",
  11726. "required": true
  11727. },
  11728. {
  11729. "type": "string",
  11730. "description": "name of the repo",
  11731. "name": "repo",
  11732. "in": "path",
  11733. "required": true
  11734. },
  11735. {
  11736. "type": "integer",
  11737. "format": "int64",
  11738. "description": "index of the pull request to merge",
  11739. "name": "index",
  11740. "in": "path",
  11741. "required": true
  11742. },
  11743. {
  11744. "name": "body",
  11745. "in": "body",
  11746. "schema": {
  11747. "$ref": "#/definitions/MergePullRequestOption"
  11748. }
  11749. }
  11750. ],
  11751. "responses": {
  11752. "200": {
  11753. "$ref": "#/responses/empty"
  11754. },
  11755. "404": {
  11756. "$ref": "#/responses/notFound"
  11757. },
  11758. "405": {
  11759. "$ref": "#/responses/empty"
  11760. },
  11761. "409": {
  11762. "$ref": "#/responses/error"
  11763. },
  11764. "423": {
  11765. "$ref": "#/responses/repoArchivedError"
  11766. }
  11767. }
  11768. },
  11769. "delete": {
  11770. "produces": [
  11771. "application/json"
  11772. ],
  11773. "tags": [
  11774. "repository"
  11775. ],
  11776. "summary": "Cancel the scheduled auto merge for the given pull request",
  11777. "operationId": "repoCancelScheduledAutoMerge",
  11778. "parameters": [
  11779. {
  11780. "type": "string",
  11781. "description": "owner of the repo",
  11782. "name": "owner",
  11783. "in": "path",
  11784. "required": true
  11785. },
  11786. {
  11787. "type": "string",
  11788. "description": "name of the repo",
  11789. "name": "repo",
  11790. "in": "path",
  11791. "required": true
  11792. },
  11793. {
  11794. "type": "integer",
  11795. "format": "int64",
  11796. "description": "index of the pull request to merge",
  11797. "name": "index",
  11798. "in": "path",
  11799. "required": true
  11800. }
  11801. ],
  11802. "responses": {
  11803. "204": {
  11804. "$ref": "#/responses/empty"
  11805. },
  11806. "403": {
  11807. "$ref": "#/responses/forbidden"
  11808. },
  11809. "404": {
  11810. "$ref": "#/responses/notFound"
  11811. },
  11812. "423": {
  11813. "$ref": "#/responses/repoArchivedError"
  11814. }
  11815. }
  11816. }
  11817. },
  11818. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  11819. "post": {
  11820. "produces": [
  11821. "application/json"
  11822. ],
  11823. "tags": [
  11824. "repository"
  11825. ],
  11826. "summary": "create review requests for a pull request",
  11827. "operationId": "repoCreatePullReviewRequests",
  11828. "parameters": [
  11829. {
  11830. "type": "string",
  11831. "description": "owner of the repo",
  11832. "name": "owner",
  11833. "in": "path",
  11834. "required": true
  11835. },
  11836. {
  11837. "type": "string",
  11838. "description": "name of the repo",
  11839. "name": "repo",
  11840. "in": "path",
  11841. "required": true
  11842. },
  11843. {
  11844. "type": "integer",
  11845. "format": "int64",
  11846. "description": "index of the pull request",
  11847. "name": "index",
  11848. "in": "path",
  11849. "required": true
  11850. },
  11851. {
  11852. "name": "body",
  11853. "in": "body",
  11854. "required": true,
  11855. "schema": {
  11856. "$ref": "#/definitions/PullReviewRequestOptions"
  11857. }
  11858. }
  11859. ],
  11860. "responses": {
  11861. "201": {
  11862. "$ref": "#/responses/PullReviewList"
  11863. },
  11864. "404": {
  11865. "$ref": "#/responses/notFound"
  11866. },
  11867. "422": {
  11868. "$ref": "#/responses/validationError"
  11869. }
  11870. }
  11871. },
  11872. "delete": {
  11873. "produces": [
  11874. "application/json"
  11875. ],
  11876. "tags": [
  11877. "repository"
  11878. ],
  11879. "summary": "cancel review requests for a pull request",
  11880. "operationId": "repoDeletePullReviewRequests",
  11881. "parameters": [
  11882. {
  11883. "type": "string",
  11884. "description": "owner of the repo",
  11885. "name": "owner",
  11886. "in": "path",
  11887. "required": true
  11888. },
  11889. {
  11890. "type": "string",
  11891. "description": "name of the repo",
  11892. "name": "repo",
  11893. "in": "path",
  11894. "required": true
  11895. },
  11896. {
  11897. "type": "integer",
  11898. "format": "int64",
  11899. "description": "index of the pull request",
  11900. "name": "index",
  11901. "in": "path",
  11902. "required": true
  11903. },
  11904. {
  11905. "name": "body",
  11906. "in": "body",
  11907. "required": true,
  11908. "schema": {
  11909. "$ref": "#/definitions/PullReviewRequestOptions"
  11910. }
  11911. }
  11912. ],
  11913. "responses": {
  11914. "204": {
  11915. "$ref": "#/responses/empty"
  11916. },
  11917. "403": {
  11918. "$ref": "#/responses/forbidden"
  11919. },
  11920. "404": {
  11921. "$ref": "#/responses/notFound"
  11922. },
  11923. "422": {
  11924. "$ref": "#/responses/validationError"
  11925. }
  11926. }
  11927. }
  11928. },
  11929. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  11930. "get": {
  11931. "produces": [
  11932. "application/json"
  11933. ],
  11934. "tags": [
  11935. "repository"
  11936. ],
  11937. "summary": "List all reviews for a pull request",
  11938. "operationId": "repoListPullReviews",
  11939. "parameters": [
  11940. {
  11941. "type": "string",
  11942. "description": "owner of the repo",
  11943. "name": "owner",
  11944. "in": "path",
  11945. "required": true
  11946. },
  11947. {
  11948. "type": "string",
  11949. "description": "name of the repo",
  11950. "name": "repo",
  11951. "in": "path",
  11952. "required": true
  11953. },
  11954. {
  11955. "type": "integer",
  11956. "format": "int64",
  11957. "description": "index of the pull request",
  11958. "name": "index",
  11959. "in": "path",
  11960. "required": true
  11961. },
  11962. {
  11963. "type": "integer",
  11964. "description": "page number of results to return (1-based)",
  11965. "name": "page",
  11966. "in": "query"
  11967. },
  11968. {
  11969. "type": "integer",
  11970. "description": "page size of results",
  11971. "name": "limit",
  11972. "in": "query"
  11973. }
  11974. ],
  11975. "responses": {
  11976. "200": {
  11977. "$ref": "#/responses/PullReviewList"
  11978. },
  11979. "404": {
  11980. "$ref": "#/responses/notFound"
  11981. }
  11982. }
  11983. },
  11984. "post": {
  11985. "produces": [
  11986. "application/json"
  11987. ],
  11988. "tags": [
  11989. "repository"
  11990. ],
  11991. "summary": "Create a review to an pull request",
  11992. "operationId": "repoCreatePullReview",
  11993. "parameters": [
  11994. {
  11995. "type": "string",
  11996. "description": "owner of the repo",
  11997. "name": "owner",
  11998. "in": "path",
  11999. "required": true
  12000. },
  12001. {
  12002. "type": "string",
  12003. "description": "name of the repo",
  12004. "name": "repo",
  12005. "in": "path",
  12006. "required": true
  12007. },
  12008. {
  12009. "type": "integer",
  12010. "format": "int64",
  12011. "description": "index of the pull request",
  12012. "name": "index",
  12013. "in": "path",
  12014. "required": true
  12015. },
  12016. {
  12017. "name": "body",
  12018. "in": "body",
  12019. "required": true,
  12020. "schema": {
  12021. "$ref": "#/definitions/CreatePullReviewOptions"
  12022. }
  12023. }
  12024. ],
  12025. "responses": {
  12026. "200": {
  12027. "$ref": "#/responses/PullReview"
  12028. },
  12029. "404": {
  12030. "$ref": "#/responses/notFound"
  12031. },
  12032. "422": {
  12033. "$ref": "#/responses/validationError"
  12034. }
  12035. }
  12036. }
  12037. },
  12038. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  12039. "get": {
  12040. "produces": [
  12041. "application/json"
  12042. ],
  12043. "tags": [
  12044. "repository"
  12045. ],
  12046. "summary": "Get a specific review for a pull request",
  12047. "operationId": "repoGetPullReview",
  12048. "parameters": [
  12049. {
  12050. "type": "string",
  12051. "description": "owner of the repo",
  12052. "name": "owner",
  12053. "in": "path",
  12054. "required": true
  12055. },
  12056. {
  12057. "type": "string",
  12058. "description": "name of the repo",
  12059. "name": "repo",
  12060. "in": "path",
  12061. "required": true
  12062. },
  12063. {
  12064. "type": "integer",
  12065. "format": "int64",
  12066. "description": "index of the pull request",
  12067. "name": "index",
  12068. "in": "path",
  12069. "required": true
  12070. },
  12071. {
  12072. "type": "integer",
  12073. "format": "int64",
  12074. "description": "id of the review",
  12075. "name": "id",
  12076. "in": "path",
  12077. "required": true
  12078. }
  12079. ],
  12080. "responses": {
  12081. "200": {
  12082. "$ref": "#/responses/PullReview"
  12083. },
  12084. "404": {
  12085. "$ref": "#/responses/notFound"
  12086. }
  12087. }
  12088. },
  12089. "post": {
  12090. "produces": [
  12091. "application/json"
  12092. ],
  12093. "tags": [
  12094. "repository"
  12095. ],
  12096. "summary": "Submit a pending review to an pull request",
  12097. "operationId": "repoSubmitPullReview",
  12098. "parameters": [
  12099. {
  12100. "type": "string",
  12101. "description": "owner of the repo",
  12102. "name": "owner",
  12103. "in": "path",
  12104. "required": true
  12105. },
  12106. {
  12107. "type": "string",
  12108. "description": "name of the repo",
  12109. "name": "repo",
  12110. "in": "path",
  12111. "required": true
  12112. },
  12113. {
  12114. "type": "integer",
  12115. "format": "int64",
  12116. "description": "index of the pull request",
  12117. "name": "index",
  12118. "in": "path",
  12119. "required": true
  12120. },
  12121. {
  12122. "type": "integer",
  12123. "format": "int64",
  12124. "description": "id of the review",
  12125. "name": "id",
  12126. "in": "path",
  12127. "required": true
  12128. },
  12129. {
  12130. "name": "body",
  12131. "in": "body",
  12132. "required": true,
  12133. "schema": {
  12134. "$ref": "#/definitions/SubmitPullReviewOptions"
  12135. }
  12136. }
  12137. ],
  12138. "responses": {
  12139. "200": {
  12140. "$ref": "#/responses/PullReview"
  12141. },
  12142. "404": {
  12143. "$ref": "#/responses/notFound"
  12144. },
  12145. "422": {
  12146. "$ref": "#/responses/validationError"
  12147. }
  12148. }
  12149. },
  12150. "delete": {
  12151. "produces": [
  12152. "application/json"
  12153. ],
  12154. "tags": [
  12155. "repository"
  12156. ],
  12157. "summary": "Delete a specific review from a pull request",
  12158. "operationId": "repoDeletePullReview",
  12159. "parameters": [
  12160. {
  12161. "type": "string",
  12162. "description": "owner of the repo",
  12163. "name": "owner",
  12164. "in": "path",
  12165. "required": true
  12166. },
  12167. {
  12168. "type": "string",
  12169. "description": "name of the repo",
  12170. "name": "repo",
  12171. "in": "path",
  12172. "required": true
  12173. },
  12174. {
  12175. "type": "integer",
  12176. "format": "int64",
  12177. "description": "index of the pull request",
  12178. "name": "index",
  12179. "in": "path",
  12180. "required": true
  12181. },
  12182. {
  12183. "type": "integer",
  12184. "format": "int64",
  12185. "description": "id of the review",
  12186. "name": "id",
  12187. "in": "path",
  12188. "required": true
  12189. }
  12190. ],
  12191. "responses": {
  12192. "204": {
  12193. "$ref": "#/responses/empty"
  12194. },
  12195. "403": {
  12196. "$ref": "#/responses/forbidden"
  12197. },
  12198. "404": {
  12199. "$ref": "#/responses/notFound"
  12200. }
  12201. }
  12202. }
  12203. },
  12204. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  12205. "get": {
  12206. "produces": [
  12207. "application/json"
  12208. ],
  12209. "tags": [
  12210. "repository"
  12211. ],
  12212. "summary": "Get a specific review for a pull request",
  12213. "operationId": "repoGetPullReviewComments",
  12214. "parameters": [
  12215. {
  12216. "type": "string",
  12217. "description": "owner of the repo",
  12218. "name": "owner",
  12219. "in": "path",
  12220. "required": true
  12221. },
  12222. {
  12223. "type": "string",
  12224. "description": "name of the repo",
  12225. "name": "repo",
  12226. "in": "path",
  12227. "required": true
  12228. },
  12229. {
  12230. "type": "integer",
  12231. "format": "int64",
  12232. "description": "index of the pull request",
  12233. "name": "index",
  12234. "in": "path",
  12235. "required": true
  12236. },
  12237. {
  12238. "type": "integer",
  12239. "format": "int64",
  12240. "description": "id of the review",
  12241. "name": "id",
  12242. "in": "path",
  12243. "required": true
  12244. }
  12245. ],
  12246. "responses": {
  12247. "200": {
  12248. "$ref": "#/responses/PullReviewCommentList"
  12249. },
  12250. "404": {
  12251. "$ref": "#/responses/notFound"
  12252. }
  12253. }
  12254. }
  12255. },
  12256. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  12257. "post": {
  12258. "produces": [
  12259. "application/json"
  12260. ],
  12261. "tags": [
  12262. "repository"
  12263. ],
  12264. "summary": "Dismiss a review for a pull request",
  12265. "operationId": "repoDismissPullReview",
  12266. "parameters": [
  12267. {
  12268. "type": "string",
  12269. "description": "owner of the repo",
  12270. "name": "owner",
  12271. "in": "path",
  12272. "required": true
  12273. },
  12274. {
  12275. "type": "string",
  12276. "description": "name of the repo",
  12277. "name": "repo",
  12278. "in": "path",
  12279. "required": true
  12280. },
  12281. {
  12282. "type": "integer",
  12283. "format": "int64",
  12284. "description": "index of the pull request",
  12285. "name": "index",
  12286. "in": "path",
  12287. "required": true
  12288. },
  12289. {
  12290. "type": "integer",
  12291. "format": "int64",
  12292. "description": "id of the review",
  12293. "name": "id",
  12294. "in": "path",
  12295. "required": true
  12296. },
  12297. {
  12298. "name": "body",
  12299. "in": "body",
  12300. "required": true,
  12301. "schema": {
  12302. "$ref": "#/definitions/DismissPullReviewOptions"
  12303. }
  12304. }
  12305. ],
  12306. "responses": {
  12307. "200": {
  12308. "$ref": "#/responses/PullReview"
  12309. },
  12310. "403": {
  12311. "$ref": "#/responses/forbidden"
  12312. },
  12313. "404": {
  12314. "$ref": "#/responses/notFound"
  12315. },
  12316. "422": {
  12317. "$ref": "#/responses/validationError"
  12318. }
  12319. }
  12320. }
  12321. },
  12322. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  12323. "post": {
  12324. "produces": [
  12325. "application/json"
  12326. ],
  12327. "tags": [
  12328. "repository"
  12329. ],
  12330. "summary": "Cancel to dismiss a review for a pull request",
  12331. "operationId": "repoUnDismissPullReview",
  12332. "parameters": [
  12333. {
  12334. "type": "string",
  12335. "description": "owner of the repo",
  12336. "name": "owner",
  12337. "in": "path",
  12338. "required": true
  12339. },
  12340. {
  12341. "type": "string",
  12342. "description": "name of the repo",
  12343. "name": "repo",
  12344. "in": "path",
  12345. "required": true
  12346. },
  12347. {
  12348. "type": "integer",
  12349. "format": "int64",
  12350. "description": "index of the pull request",
  12351. "name": "index",
  12352. "in": "path",
  12353. "required": true
  12354. },
  12355. {
  12356. "type": "integer",
  12357. "format": "int64",
  12358. "description": "id of the review",
  12359. "name": "id",
  12360. "in": "path",
  12361. "required": true
  12362. }
  12363. ],
  12364. "responses": {
  12365. "200": {
  12366. "$ref": "#/responses/PullReview"
  12367. },
  12368. "403": {
  12369. "$ref": "#/responses/forbidden"
  12370. },
  12371. "404": {
  12372. "$ref": "#/responses/notFound"
  12373. },
  12374. "422": {
  12375. "$ref": "#/responses/validationError"
  12376. }
  12377. }
  12378. }
  12379. },
  12380. "/repos/{owner}/{repo}/pulls/{index}/update": {
  12381. "post": {
  12382. "produces": [
  12383. "application/json"
  12384. ],
  12385. "tags": [
  12386. "repository"
  12387. ],
  12388. "summary": "Merge PR's baseBranch into headBranch",
  12389. "operationId": "repoUpdatePullRequest",
  12390. "parameters": [
  12391. {
  12392. "type": "string",
  12393. "description": "owner of the repo",
  12394. "name": "owner",
  12395. "in": "path",
  12396. "required": true
  12397. },
  12398. {
  12399. "type": "string",
  12400. "description": "name of the repo",
  12401. "name": "repo",
  12402. "in": "path",
  12403. "required": true
  12404. },
  12405. {
  12406. "type": "integer",
  12407. "format": "int64",
  12408. "description": "index of the pull request to get",
  12409. "name": "index",
  12410. "in": "path",
  12411. "required": true
  12412. },
  12413. {
  12414. "enum": [
  12415. "merge",
  12416. "rebase"
  12417. ],
  12418. "type": "string",
  12419. "description": "how to update pull request",
  12420. "name": "style",
  12421. "in": "query"
  12422. }
  12423. ],
  12424. "responses": {
  12425. "200": {
  12426. "$ref": "#/responses/empty"
  12427. },
  12428. "403": {
  12429. "$ref": "#/responses/forbidden"
  12430. },
  12431. "404": {
  12432. "$ref": "#/responses/notFound"
  12433. },
  12434. "409": {
  12435. "$ref": "#/responses/error"
  12436. },
  12437. "422": {
  12438. "$ref": "#/responses/validationError"
  12439. }
  12440. }
  12441. }
  12442. },
  12443. "/repos/{owner}/{repo}/push_mirrors": {
  12444. "get": {
  12445. "produces": [
  12446. "application/json"
  12447. ],
  12448. "tags": [
  12449. "repository"
  12450. ],
  12451. "summary": "Get all push mirrors of the repository",
  12452. "operationId": "repoListPushMirrors",
  12453. "parameters": [
  12454. {
  12455. "type": "string",
  12456. "description": "owner of the repo",
  12457. "name": "owner",
  12458. "in": "path",
  12459. "required": true
  12460. },
  12461. {
  12462. "type": "string",
  12463. "description": "name of the repo",
  12464. "name": "repo",
  12465. "in": "path",
  12466. "required": true
  12467. },
  12468. {
  12469. "type": "integer",
  12470. "description": "page number of results to return (1-based)",
  12471. "name": "page",
  12472. "in": "query"
  12473. },
  12474. {
  12475. "type": "integer",
  12476. "description": "page size of results",
  12477. "name": "limit",
  12478. "in": "query"
  12479. }
  12480. ],
  12481. "responses": {
  12482. "200": {
  12483. "$ref": "#/responses/PushMirrorList"
  12484. },
  12485. "400": {
  12486. "$ref": "#/responses/error"
  12487. },
  12488. "403": {
  12489. "$ref": "#/responses/forbidden"
  12490. },
  12491. "404": {
  12492. "$ref": "#/responses/notFound"
  12493. }
  12494. }
  12495. },
  12496. "post": {
  12497. "consumes": [
  12498. "application/json"
  12499. ],
  12500. "produces": [
  12501. "application/json"
  12502. ],
  12503. "tags": [
  12504. "repository"
  12505. ],
  12506. "summary": "add a push mirror to the repository",
  12507. "operationId": "repoAddPushMirror",
  12508. "parameters": [
  12509. {
  12510. "type": "string",
  12511. "description": "owner of the repo",
  12512. "name": "owner",
  12513. "in": "path",
  12514. "required": true
  12515. },
  12516. {
  12517. "type": "string",
  12518. "description": "name of the repo",
  12519. "name": "repo",
  12520. "in": "path",
  12521. "required": true
  12522. },
  12523. {
  12524. "name": "body",
  12525. "in": "body",
  12526. "schema": {
  12527. "$ref": "#/definitions/CreatePushMirrorOption"
  12528. }
  12529. }
  12530. ],
  12531. "responses": {
  12532. "200": {
  12533. "$ref": "#/responses/PushMirror"
  12534. },
  12535. "400": {
  12536. "$ref": "#/responses/error"
  12537. },
  12538. "403": {
  12539. "$ref": "#/responses/forbidden"
  12540. },
  12541. "404": {
  12542. "$ref": "#/responses/notFound"
  12543. }
  12544. }
  12545. }
  12546. },
  12547. "/repos/{owner}/{repo}/push_mirrors-sync": {
  12548. "post": {
  12549. "produces": [
  12550. "application/json"
  12551. ],
  12552. "tags": [
  12553. "repository"
  12554. ],
  12555. "summary": "Sync all push mirrored repository",
  12556. "operationId": "repoPushMirrorSync",
  12557. "parameters": [
  12558. {
  12559. "type": "string",
  12560. "description": "owner of the repo to sync",
  12561. "name": "owner",
  12562. "in": "path",
  12563. "required": true
  12564. },
  12565. {
  12566. "type": "string",
  12567. "description": "name of the repo to sync",
  12568. "name": "repo",
  12569. "in": "path",
  12570. "required": true
  12571. }
  12572. ],
  12573. "responses": {
  12574. "200": {
  12575. "$ref": "#/responses/empty"
  12576. },
  12577. "400": {
  12578. "$ref": "#/responses/error"
  12579. },
  12580. "403": {
  12581. "$ref": "#/responses/forbidden"
  12582. },
  12583. "404": {
  12584. "$ref": "#/responses/notFound"
  12585. }
  12586. }
  12587. }
  12588. },
  12589. "/repos/{owner}/{repo}/push_mirrors/{name}": {
  12590. "get": {
  12591. "produces": [
  12592. "application/json"
  12593. ],
  12594. "tags": [
  12595. "repository"
  12596. ],
  12597. "summary": "Get push mirror of the repository by remoteName",
  12598. "operationId": "repoGetPushMirrorByRemoteName",
  12599. "parameters": [
  12600. {
  12601. "type": "string",
  12602. "description": "owner of the repo",
  12603. "name": "owner",
  12604. "in": "path",
  12605. "required": true
  12606. },
  12607. {
  12608. "type": "string",
  12609. "description": "name of the repo",
  12610. "name": "repo",
  12611. "in": "path",
  12612. "required": true
  12613. },
  12614. {
  12615. "type": "string",
  12616. "description": "remote name of push mirror",
  12617. "name": "name",
  12618. "in": "path",
  12619. "required": true
  12620. }
  12621. ],
  12622. "responses": {
  12623. "200": {
  12624. "$ref": "#/responses/PushMirror"
  12625. },
  12626. "400": {
  12627. "$ref": "#/responses/error"
  12628. },
  12629. "403": {
  12630. "$ref": "#/responses/forbidden"
  12631. },
  12632. "404": {
  12633. "$ref": "#/responses/notFound"
  12634. }
  12635. }
  12636. },
  12637. "delete": {
  12638. "produces": [
  12639. "application/json"
  12640. ],
  12641. "tags": [
  12642. "repository"
  12643. ],
  12644. "summary": "deletes a push mirror from a repository by remoteName",
  12645. "operationId": "repoDeletePushMirror",
  12646. "parameters": [
  12647. {
  12648. "type": "string",
  12649. "description": "owner of the repo",
  12650. "name": "owner",
  12651. "in": "path",
  12652. "required": true
  12653. },
  12654. {
  12655. "type": "string",
  12656. "description": "name of the repo",
  12657. "name": "repo",
  12658. "in": "path",
  12659. "required": true
  12660. },
  12661. {
  12662. "type": "string",
  12663. "description": "remote name of the pushMirror",
  12664. "name": "name",
  12665. "in": "path",
  12666. "required": true
  12667. }
  12668. ],
  12669. "responses": {
  12670. "204": {
  12671. "$ref": "#/responses/empty"
  12672. },
  12673. "400": {
  12674. "$ref": "#/responses/error"
  12675. },
  12676. "404": {
  12677. "$ref": "#/responses/notFound"
  12678. }
  12679. }
  12680. }
  12681. },
  12682. "/repos/{owner}/{repo}/raw/{filepath}": {
  12683. "get": {
  12684. "produces": [
  12685. "application/json"
  12686. ],
  12687. "tags": [
  12688. "repository"
  12689. ],
  12690. "summary": "Get a file from a repository",
  12691. "operationId": "repoGetRawFile",
  12692. "parameters": [
  12693. {
  12694. "type": "string",
  12695. "description": "owner of the repo",
  12696. "name": "owner",
  12697. "in": "path",
  12698. "required": true
  12699. },
  12700. {
  12701. "type": "string",
  12702. "description": "name of the repo",
  12703. "name": "repo",
  12704. "in": "path",
  12705. "required": true
  12706. },
  12707. {
  12708. "type": "string",
  12709. "description": "filepath of the file to get",
  12710. "name": "filepath",
  12711. "in": "path",
  12712. "required": true
  12713. },
  12714. {
  12715. "type": "string",
  12716. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  12717. "name": "ref",
  12718. "in": "query"
  12719. }
  12720. ],
  12721. "responses": {
  12722. "200": {
  12723. "description": "Returns raw file content."
  12724. },
  12725. "404": {
  12726. "$ref": "#/responses/notFound"
  12727. }
  12728. }
  12729. }
  12730. },
  12731. "/repos/{owner}/{repo}/releases": {
  12732. "get": {
  12733. "produces": [
  12734. "application/json"
  12735. ],
  12736. "tags": [
  12737. "repository"
  12738. ],
  12739. "summary": "List a repo's releases",
  12740. "operationId": "repoListReleases",
  12741. "parameters": [
  12742. {
  12743. "type": "string",
  12744. "description": "owner of the repo",
  12745. "name": "owner",
  12746. "in": "path",
  12747. "required": true
  12748. },
  12749. {
  12750. "type": "string",
  12751. "description": "name of the repo",
  12752. "name": "repo",
  12753. "in": "path",
  12754. "required": true
  12755. },
  12756. {
  12757. "type": "boolean",
  12758. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  12759. "name": "draft",
  12760. "in": "query"
  12761. },
  12762. {
  12763. "type": "boolean",
  12764. "description": "filter (exclude / include) pre-releases",
  12765. "name": "pre-release",
  12766. "in": "query"
  12767. },
  12768. {
  12769. "type": "integer",
  12770. "description": "page number of results to return (1-based)",
  12771. "name": "page",
  12772. "in": "query"
  12773. },
  12774. {
  12775. "type": "integer",
  12776. "description": "page size of results",
  12777. "name": "limit",
  12778. "in": "query"
  12779. }
  12780. ],
  12781. "responses": {
  12782. "200": {
  12783. "$ref": "#/responses/ReleaseList"
  12784. },
  12785. "404": {
  12786. "$ref": "#/responses/notFound"
  12787. }
  12788. }
  12789. },
  12790. "post": {
  12791. "consumes": [
  12792. "application/json"
  12793. ],
  12794. "produces": [
  12795. "application/json"
  12796. ],
  12797. "tags": [
  12798. "repository"
  12799. ],
  12800. "summary": "Create a release",
  12801. "operationId": "repoCreateRelease",
  12802. "parameters": [
  12803. {
  12804. "type": "string",
  12805. "description": "owner of the repo",
  12806. "name": "owner",
  12807. "in": "path",
  12808. "required": true
  12809. },
  12810. {
  12811. "type": "string",
  12812. "description": "name of the repo",
  12813. "name": "repo",
  12814. "in": "path",
  12815. "required": true
  12816. },
  12817. {
  12818. "name": "body",
  12819. "in": "body",
  12820. "schema": {
  12821. "$ref": "#/definitions/CreateReleaseOption"
  12822. }
  12823. }
  12824. ],
  12825. "responses": {
  12826. "201": {
  12827. "$ref": "#/responses/Release"
  12828. },
  12829. "404": {
  12830. "$ref": "#/responses/notFound"
  12831. },
  12832. "409": {
  12833. "$ref": "#/responses/error"
  12834. }
  12835. }
  12836. }
  12837. },
  12838. "/repos/{owner}/{repo}/releases/latest": {
  12839. "get": {
  12840. "produces": [
  12841. "application/json"
  12842. ],
  12843. "tags": [
  12844. "repository"
  12845. ],
  12846. "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
  12847. "operationId": "repoGetLatestRelease",
  12848. "parameters": [
  12849. {
  12850. "type": "string",
  12851. "description": "owner of the repo",
  12852. "name": "owner",
  12853. "in": "path",
  12854. "required": true
  12855. },
  12856. {
  12857. "type": "string",
  12858. "description": "name of the repo",
  12859. "name": "repo",
  12860. "in": "path",
  12861. "required": true
  12862. }
  12863. ],
  12864. "responses": {
  12865. "200": {
  12866. "$ref": "#/responses/Release"
  12867. },
  12868. "404": {
  12869. "$ref": "#/responses/notFound"
  12870. }
  12871. }
  12872. }
  12873. },
  12874. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  12875. "get": {
  12876. "produces": [
  12877. "application/json"
  12878. ],
  12879. "tags": [
  12880. "repository"
  12881. ],
  12882. "summary": "Get a release by tag name",
  12883. "operationId": "repoGetReleaseByTag",
  12884. "parameters": [
  12885. {
  12886. "type": "string",
  12887. "description": "owner of the repo",
  12888. "name": "owner",
  12889. "in": "path",
  12890. "required": true
  12891. },
  12892. {
  12893. "type": "string",
  12894. "description": "name of the repo",
  12895. "name": "repo",
  12896. "in": "path",
  12897. "required": true
  12898. },
  12899. {
  12900. "type": "string",
  12901. "description": "tag name of the release to get",
  12902. "name": "tag",
  12903. "in": "path",
  12904. "required": true
  12905. }
  12906. ],
  12907. "responses": {
  12908. "200": {
  12909. "$ref": "#/responses/Release"
  12910. },
  12911. "404": {
  12912. "$ref": "#/responses/notFound"
  12913. }
  12914. }
  12915. },
  12916. "delete": {
  12917. "tags": [
  12918. "repository"
  12919. ],
  12920. "summary": "Delete a release by tag name",
  12921. "operationId": "repoDeleteReleaseByTag",
  12922. "parameters": [
  12923. {
  12924. "type": "string",
  12925. "description": "owner of the repo",
  12926. "name": "owner",
  12927. "in": "path",
  12928. "required": true
  12929. },
  12930. {
  12931. "type": "string",
  12932. "description": "name of the repo",
  12933. "name": "repo",
  12934. "in": "path",
  12935. "required": true
  12936. },
  12937. {
  12938. "type": "string",
  12939. "description": "tag name of the release to delete",
  12940. "name": "tag",
  12941. "in": "path",
  12942. "required": true
  12943. }
  12944. ],
  12945. "responses": {
  12946. "204": {
  12947. "$ref": "#/responses/empty"
  12948. },
  12949. "404": {
  12950. "$ref": "#/responses/notFound"
  12951. },
  12952. "405": {
  12953. "$ref": "#/responses/empty"
  12954. }
  12955. }
  12956. }
  12957. },
  12958. "/repos/{owner}/{repo}/releases/{id}": {
  12959. "get": {
  12960. "produces": [
  12961. "application/json"
  12962. ],
  12963. "tags": [
  12964. "repository"
  12965. ],
  12966. "summary": "Get a release",
  12967. "operationId": "repoGetRelease",
  12968. "parameters": [
  12969. {
  12970. "type": "string",
  12971. "description": "owner of the repo",
  12972. "name": "owner",
  12973. "in": "path",
  12974. "required": true
  12975. },
  12976. {
  12977. "type": "string",
  12978. "description": "name of the repo",
  12979. "name": "repo",
  12980. "in": "path",
  12981. "required": true
  12982. },
  12983. {
  12984. "type": "integer",
  12985. "format": "int64",
  12986. "description": "id of the release to get",
  12987. "name": "id",
  12988. "in": "path",
  12989. "required": true
  12990. }
  12991. ],
  12992. "responses": {
  12993. "200": {
  12994. "$ref": "#/responses/Release"
  12995. },
  12996. "404": {
  12997. "$ref": "#/responses/notFound"
  12998. }
  12999. }
  13000. },
  13001. "delete": {
  13002. "tags": [
  13003. "repository"
  13004. ],
  13005. "summary": "Delete a release",
  13006. "operationId": "repoDeleteRelease",
  13007. "parameters": [
  13008. {
  13009. "type": "string",
  13010. "description": "owner of the repo",
  13011. "name": "owner",
  13012. "in": "path",
  13013. "required": true
  13014. },
  13015. {
  13016. "type": "string",
  13017. "description": "name of the repo",
  13018. "name": "repo",
  13019. "in": "path",
  13020. "required": true
  13021. },
  13022. {
  13023. "type": "integer",
  13024. "format": "int64",
  13025. "description": "id of the release to delete",
  13026. "name": "id",
  13027. "in": "path",
  13028. "required": true
  13029. }
  13030. ],
  13031. "responses": {
  13032. "204": {
  13033. "$ref": "#/responses/empty"
  13034. },
  13035. "404": {
  13036. "$ref": "#/responses/notFound"
  13037. },
  13038. "405": {
  13039. "$ref": "#/responses/empty"
  13040. }
  13041. }
  13042. },
  13043. "patch": {
  13044. "consumes": [
  13045. "application/json"
  13046. ],
  13047. "produces": [
  13048. "application/json"
  13049. ],
  13050. "tags": [
  13051. "repository"
  13052. ],
  13053. "summary": "Update a release",
  13054. "operationId": "repoEditRelease",
  13055. "parameters": [
  13056. {
  13057. "type": "string",
  13058. "description": "owner of the repo",
  13059. "name": "owner",
  13060. "in": "path",
  13061. "required": true
  13062. },
  13063. {
  13064. "type": "string",
  13065. "description": "name of the repo",
  13066. "name": "repo",
  13067. "in": "path",
  13068. "required": true
  13069. },
  13070. {
  13071. "type": "integer",
  13072. "format": "int64",
  13073. "description": "id of the release to edit",
  13074. "name": "id",
  13075. "in": "path",
  13076. "required": true
  13077. },
  13078. {
  13079. "name": "body",
  13080. "in": "body",
  13081. "schema": {
  13082. "$ref": "#/definitions/EditReleaseOption"
  13083. }
  13084. }
  13085. ],
  13086. "responses": {
  13087. "200": {
  13088. "$ref": "#/responses/Release"
  13089. },
  13090. "404": {
  13091. "$ref": "#/responses/notFound"
  13092. }
  13093. }
  13094. }
  13095. },
  13096. "/repos/{owner}/{repo}/releases/{id}/assets": {
  13097. "get": {
  13098. "produces": [
  13099. "application/json"
  13100. ],
  13101. "tags": [
  13102. "repository"
  13103. ],
  13104. "summary": "List release's attachments",
  13105. "operationId": "repoListReleaseAttachments",
  13106. "parameters": [
  13107. {
  13108. "type": "string",
  13109. "description": "owner of the repo",
  13110. "name": "owner",
  13111. "in": "path",
  13112. "required": true
  13113. },
  13114. {
  13115. "type": "string",
  13116. "description": "name of the repo",
  13117. "name": "repo",
  13118. "in": "path",
  13119. "required": true
  13120. },
  13121. {
  13122. "type": "integer",
  13123. "format": "int64",
  13124. "description": "id of the release",
  13125. "name": "id",
  13126. "in": "path",
  13127. "required": true
  13128. }
  13129. ],
  13130. "responses": {
  13131. "200": {
  13132. "$ref": "#/responses/AttachmentList"
  13133. },
  13134. "404": {
  13135. "$ref": "#/responses/notFound"
  13136. }
  13137. }
  13138. },
  13139. "post": {
  13140. "consumes": [
  13141. "multipart/form-data",
  13142. "application/octet-stream"
  13143. ],
  13144. "produces": [
  13145. "application/json"
  13146. ],
  13147. "tags": [
  13148. "repository"
  13149. ],
  13150. "summary": "Create a release attachment",
  13151. "operationId": "repoCreateReleaseAttachment",
  13152. "parameters": [
  13153. {
  13154. "type": "string",
  13155. "description": "owner of the repo",
  13156. "name": "owner",
  13157. "in": "path",
  13158. "required": true
  13159. },
  13160. {
  13161. "type": "string",
  13162. "description": "name of the repo",
  13163. "name": "repo",
  13164. "in": "path",
  13165. "required": true
  13166. },
  13167. {
  13168. "type": "integer",
  13169. "format": "int64",
  13170. "description": "id of the release",
  13171. "name": "id",
  13172. "in": "path",
  13173. "required": true
  13174. },
  13175. {
  13176. "type": "string",
  13177. "description": "name of the attachment",
  13178. "name": "name",
  13179. "in": "query"
  13180. },
  13181. {
  13182. "type": "file",
  13183. "description": "attachment to upload",
  13184. "name": "attachment",
  13185. "in": "formData"
  13186. }
  13187. ],
  13188. "responses": {
  13189. "201": {
  13190. "$ref": "#/responses/Attachment"
  13191. },
  13192. "400": {
  13193. "$ref": "#/responses/error"
  13194. },
  13195. "404": {
  13196. "$ref": "#/responses/notFound"
  13197. }
  13198. }
  13199. }
  13200. },
  13201. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  13202. "get": {
  13203. "produces": [
  13204. "application/json"
  13205. ],
  13206. "tags": [
  13207. "repository"
  13208. ],
  13209. "summary": "Get a release attachment",
  13210. "operationId": "repoGetReleaseAttachment",
  13211. "parameters": [
  13212. {
  13213. "type": "string",
  13214. "description": "owner of the repo",
  13215. "name": "owner",
  13216. "in": "path",
  13217. "required": true
  13218. },
  13219. {
  13220. "type": "string",
  13221. "description": "name of the repo",
  13222. "name": "repo",
  13223. "in": "path",
  13224. "required": true
  13225. },
  13226. {
  13227. "type": "integer",
  13228. "format": "int64",
  13229. "description": "id of the release",
  13230. "name": "id",
  13231. "in": "path",
  13232. "required": true
  13233. },
  13234. {
  13235. "type": "integer",
  13236. "format": "int64",
  13237. "description": "id of the attachment to get",
  13238. "name": "attachment_id",
  13239. "in": "path",
  13240. "required": true
  13241. }
  13242. ],
  13243. "responses": {
  13244. "200": {
  13245. "$ref": "#/responses/Attachment"
  13246. },
  13247. "404": {
  13248. "$ref": "#/responses/notFound"
  13249. }
  13250. }
  13251. },
  13252. "delete": {
  13253. "produces": [
  13254. "application/json"
  13255. ],
  13256. "tags": [
  13257. "repository"
  13258. ],
  13259. "summary": "Delete a release attachment",
  13260. "operationId": "repoDeleteReleaseAttachment",
  13261. "parameters": [
  13262. {
  13263. "type": "string",
  13264. "description": "owner of the repo",
  13265. "name": "owner",
  13266. "in": "path",
  13267. "required": true
  13268. },
  13269. {
  13270. "type": "string",
  13271. "description": "name of the repo",
  13272. "name": "repo",
  13273. "in": "path",
  13274. "required": true
  13275. },
  13276. {
  13277. "type": "integer",
  13278. "format": "int64",
  13279. "description": "id of the release",
  13280. "name": "id",
  13281. "in": "path",
  13282. "required": true
  13283. },
  13284. {
  13285. "type": "integer",
  13286. "format": "int64",
  13287. "description": "id of the attachment to delete",
  13288. "name": "attachment_id",
  13289. "in": "path",
  13290. "required": true
  13291. }
  13292. ],
  13293. "responses": {
  13294. "204": {
  13295. "$ref": "#/responses/empty"
  13296. },
  13297. "404": {
  13298. "$ref": "#/responses/notFound"
  13299. }
  13300. }
  13301. },
  13302. "patch": {
  13303. "consumes": [
  13304. "application/json"
  13305. ],
  13306. "produces": [
  13307. "application/json"
  13308. ],
  13309. "tags": [
  13310. "repository"
  13311. ],
  13312. "summary": "Edit a release attachment",
  13313. "operationId": "repoEditReleaseAttachment",
  13314. "parameters": [
  13315. {
  13316. "type": "string",
  13317. "description": "owner of the repo",
  13318. "name": "owner",
  13319. "in": "path",
  13320. "required": true
  13321. },
  13322. {
  13323. "type": "string",
  13324. "description": "name of the repo",
  13325. "name": "repo",
  13326. "in": "path",
  13327. "required": true
  13328. },
  13329. {
  13330. "type": "integer",
  13331. "format": "int64",
  13332. "description": "id of the release",
  13333. "name": "id",
  13334. "in": "path",
  13335. "required": true
  13336. },
  13337. {
  13338. "type": "integer",
  13339. "format": "int64",
  13340. "description": "id of the attachment to edit",
  13341. "name": "attachment_id",
  13342. "in": "path",
  13343. "required": true
  13344. },
  13345. {
  13346. "name": "body",
  13347. "in": "body",
  13348. "schema": {
  13349. "$ref": "#/definitions/EditAttachmentOptions"
  13350. }
  13351. }
  13352. ],
  13353. "responses": {
  13354. "201": {
  13355. "$ref": "#/responses/Attachment"
  13356. },
  13357. "404": {
  13358. "$ref": "#/responses/notFound"
  13359. }
  13360. }
  13361. }
  13362. },
  13363. "/repos/{owner}/{repo}/reviewers": {
  13364. "get": {
  13365. "produces": [
  13366. "application/json"
  13367. ],
  13368. "tags": [
  13369. "repository"
  13370. ],
  13371. "summary": "Return all users that can be requested to review in this repo",
  13372. "operationId": "repoGetReviewers",
  13373. "parameters": [
  13374. {
  13375. "type": "string",
  13376. "description": "owner of the repo",
  13377. "name": "owner",
  13378. "in": "path",
  13379. "required": true
  13380. },
  13381. {
  13382. "type": "string",
  13383. "description": "name of the repo",
  13384. "name": "repo",
  13385. "in": "path",
  13386. "required": true
  13387. }
  13388. ],
  13389. "responses": {
  13390. "200": {
  13391. "$ref": "#/responses/UserList"
  13392. },
  13393. "404": {
  13394. "$ref": "#/responses/notFound"
  13395. }
  13396. }
  13397. }
  13398. },
  13399. "/repos/{owner}/{repo}/runners/registration-token": {
  13400. "get": {
  13401. "produces": [
  13402. "application/json"
  13403. ],
  13404. "tags": [
  13405. "repository"
  13406. ],
  13407. "summary": "Get a repository's actions runner registration token",
  13408. "operationId": "repoGetRunnerRegistrationToken",
  13409. "parameters": [
  13410. {
  13411. "type": "string",
  13412. "description": "owner of the repo",
  13413. "name": "owner",
  13414. "in": "path",
  13415. "required": true
  13416. },
  13417. {
  13418. "type": "string",
  13419. "description": "name of the repo",
  13420. "name": "repo",
  13421. "in": "path",
  13422. "required": true
  13423. }
  13424. ],
  13425. "responses": {
  13426. "200": {
  13427. "$ref": "#/responses/RegistrationToken"
  13428. }
  13429. }
  13430. }
  13431. },
  13432. "/repos/{owner}/{repo}/signing-key.gpg": {
  13433. "get": {
  13434. "produces": [
  13435. "text/plain"
  13436. ],
  13437. "tags": [
  13438. "repository"
  13439. ],
  13440. "summary": "Get signing-key.gpg for given repository",
  13441. "operationId": "repoSigningKey",
  13442. "parameters": [
  13443. {
  13444. "type": "string",
  13445. "description": "owner of the repo",
  13446. "name": "owner",
  13447. "in": "path",
  13448. "required": true
  13449. },
  13450. {
  13451. "type": "string",
  13452. "description": "name of the repo",
  13453. "name": "repo",
  13454. "in": "path",
  13455. "required": true
  13456. }
  13457. ],
  13458. "responses": {
  13459. "200": {
  13460. "description": "GPG armored public key",
  13461. "schema": {
  13462. "type": "string"
  13463. }
  13464. }
  13465. }
  13466. }
  13467. },
  13468. "/repos/{owner}/{repo}/stargazers": {
  13469. "get": {
  13470. "produces": [
  13471. "application/json"
  13472. ],
  13473. "tags": [
  13474. "repository"
  13475. ],
  13476. "summary": "List a repo's stargazers",
  13477. "operationId": "repoListStargazers",
  13478. "parameters": [
  13479. {
  13480. "type": "string",
  13481. "description": "owner of the repo",
  13482. "name": "owner",
  13483. "in": "path",
  13484. "required": true
  13485. },
  13486. {
  13487. "type": "string",
  13488. "description": "name of the repo",
  13489. "name": "repo",
  13490. "in": "path",
  13491. "required": true
  13492. },
  13493. {
  13494. "type": "integer",
  13495. "description": "page number of results to return (1-based)",
  13496. "name": "page",
  13497. "in": "query"
  13498. },
  13499. {
  13500. "type": "integer",
  13501. "description": "page size of results",
  13502. "name": "limit",
  13503. "in": "query"
  13504. }
  13505. ],
  13506. "responses": {
  13507. "200": {
  13508. "$ref": "#/responses/UserList"
  13509. },
  13510. "404": {
  13511. "$ref": "#/responses/notFound"
  13512. }
  13513. }
  13514. }
  13515. },
  13516. "/repos/{owner}/{repo}/statuses/{sha}": {
  13517. "get": {
  13518. "produces": [
  13519. "application/json"
  13520. ],
  13521. "tags": [
  13522. "repository"
  13523. ],
  13524. "summary": "Get a commit's statuses",
  13525. "operationId": "repoListStatuses",
  13526. "parameters": [
  13527. {
  13528. "type": "string",
  13529. "description": "owner of the repo",
  13530. "name": "owner",
  13531. "in": "path",
  13532. "required": true
  13533. },
  13534. {
  13535. "type": "string",
  13536. "description": "name of the repo",
  13537. "name": "repo",
  13538. "in": "path",
  13539. "required": true
  13540. },
  13541. {
  13542. "type": "string",
  13543. "description": "sha of the commit",
  13544. "name": "sha",
  13545. "in": "path",
  13546. "required": true
  13547. },
  13548. {
  13549. "enum": [
  13550. "oldest",
  13551. "recentupdate",
  13552. "leastupdate",
  13553. "leastindex",
  13554. "highestindex"
  13555. ],
  13556. "type": "string",
  13557. "description": "type of sort",
  13558. "name": "sort",
  13559. "in": "query"
  13560. },
  13561. {
  13562. "enum": [
  13563. "pending",
  13564. "success",
  13565. "error",
  13566. "failure",
  13567. "warning"
  13568. ],
  13569. "type": "string",
  13570. "description": "type of state",
  13571. "name": "state",
  13572. "in": "query"
  13573. },
  13574. {
  13575. "type": "integer",
  13576. "description": "page number of results to return (1-based)",
  13577. "name": "page",
  13578. "in": "query"
  13579. },
  13580. {
  13581. "type": "integer",
  13582. "description": "page size of results",
  13583. "name": "limit",
  13584. "in": "query"
  13585. }
  13586. ],
  13587. "responses": {
  13588. "200": {
  13589. "$ref": "#/responses/CommitStatusList"
  13590. },
  13591. "400": {
  13592. "$ref": "#/responses/error"
  13593. },
  13594. "404": {
  13595. "$ref": "#/responses/notFound"
  13596. }
  13597. }
  13598. },
  13599. "post": {
  13600. "produces": [
  13601. "application/json"
  13602. ],
  13603. "tags": [
  13604. "repository"
  13605. ],
  13606. "summary": "Create a commit status",
  13607. "operationId": "repoCreateStatus",
  13608. "parameters": [
  13609. {
  13610. "type": "string",
  13611. "description": "owner of the repo",
  13612. "name": "owner",
  13613. "in": "path",
  13614. "required": true
  13615. },
  13616. {
  13617. "type": "string",
  13618. "description": "name of the repo",
  13619. "name": "repo",
  13620. "in": "path",
  13621. "required": true
  13622. },
  13623. {
  13624. "type": "string",
  13625. "description": "sha of the commit",
  13626. "name": "sha",
  13627. "in": "path",
  13628. "required": true
  13629. },
  13630. {
  13631. "name": "body",
  13632. "in": "body",
  13633. "schema": {
  13634. "$ref": "#/definitions/CreateStatusOption"
  13635. }
  13636. }
  13637. ],
  13638. "responses": {
  13639. "201": {
  13640. "$ref": "#/responses/CommitStatus"
  13641. },
  13642. "400": {
  13643. "$ref": "#/responses/error"
  13644. },
  13645. "404": {
  13646. "$ref": "#/responses/notFound"
  13647. }
  13648. }
  13649. }
  13650. },
  13651. "/repos/{owner}/{repo}/subscribers": {
  13652. "get": {
  13653. "produces": [
  13654. "application/json"
  13655. ],
  13656. "tags": [
  13657. "repository"
  13658. ],
  13659. "summary": "List a repo's watchers",
  13660. "operationId": "repoListSubscribers",
  13661. "parameters": [
  13662. {
  13663. "type": "string",
  13664. "description": "owner of the repo",
  13665. "name": "owner",
  13666. "in": "path",
  13667. "required": true
  13668. },
  13669. {
  13670. "type": "string",
  13671. "description": "name of the repo",
  13672. "name": "repo",
  13673. "in": "path",
  13674. "required": true
  13675. },
  13676. {
  13677. "type": "integer",
  13678. "description": "page number of results to return (1-based)",
  13679. "name": "page",
  13680. "in": "query"
  13681. },
  13682. {
  13683. "type": "integer",
  13684. "description": "page size of results",
  13685. "name": "limit",
  13686. "in": "query"
  13687. }
  13688. ],
  13689. "responses": {
  13690. "200": {
  13691. "$ref": "#/responses/UserList"
  13692. },
  13693. "404": {
  13694. "$ref": "#/responses/notFound"
  13695. }
  13696. }
  13697. }
  13698. },
  13699. "/repos/{owner}/{repo}/subscription": {
  13700. "get": {
  13701. "tags": [
  13702. "repository"
  13703. ],
  13704. "summary": "Check if the current user is watching a repo",
  13705. "operationId": "userCurrentCheckSubscription",
  13706. "parameters": [
  13707. {
  13708. "type": "string",
  13709. "description": "owner of the repo",
  13710. "name": "owner",
  13711. "in": "path",
  13712. "required": true
  13713. },
  13714. {
  13715. "type": "string",
  13716. "description": "name of the repo",
  13717. "name": "repo",
  13718. "in": "path",
  13719. "required": true
  13720. }
  13721. ],
  13722. "responses": {
  13723. "200": {
  13724. "$ref": "#/responses/WatchInfo"
  13725. },
  13726. "404": {
  13727. "description": "User is not watching this repo or repo do not exist"
  13728. }
  13729. }
  13730. },
  13731. "put": {
  13732. "tags": [
  13733. "repository"
  13734. ],
  13735. "summary": "Watch a repo",
  13736. "operationId": "userCurrentPutSubscription",
  13737. "parameters": [
  13738. {
  13739. "type": "string",
  13740. "description": "owner of the repo",
  13741. "name": "owner",
  13742. "in": "path",
  13743. "required": true
  13744. },
  13745. {
  13746. "type": "string",
  13747. "description": "name of the repo",
  13748. "name": "repo",
  13749. "in": "path",
  13750. "required": true
  13751. }
  13752. ],
  13753. "responses": {
  13754. "200": {
  13755. "$ref": "#/responses/WatchInfo"
  13756. },
  13757. "403": {
  13758. "$ref": "#/responses/forbidden"
  13759. },
  13760. "404": {
  13761. "$ref": "#/responses/notFound"
  13762. }
  13763. }
  13764. },
  13765. "delete": {
  13766. "tags": [
  13767. "repository"
  13768. ],
  13769. "summary": "Unwatch a repo",
  13770. "operationId": "userCurrentDeleteSubscription",
  13771. "parameters": [
  13772. {
  13773. "type": "string",
  13774. "description": "owner of the repo",
  13775. "name": "owner",
  13776. "in": "path",
  13777. "required": true
  13778. },
  13779. {
  13780. "type": "string",
  13781. "description": "name of the repo",
  13782. "name": "repo",
  13783. "in": "path",
  13784. "required": true
  13785. }
  13786. ],
  13787. "responses": {
  13788. "204": {
  13789. "$ref": "#/responses/empty"
  13790. },
  13791. "404": {
  13792. "$ref": "#/responses/notFound"
  13793. }
  13794. }
  13795. }
  13796. },
  13797. "/repos/{owner}/{repo}/tags": {
  13798. "get": {
  13799. "produces": [
  13800. "application/json"
  13801. ],
  13802. "tags": [
  13803. "repository"
  13804. ],
  13805. "summary": "List a repository's tags",
  13806. "operationId": "repoListTags",
  13807. "parameters": [
  13808. {
  13809. "type": "string",
  13810. "description": "owner of the repo",
  13811. "name": "owner",
  13812. "in": "path",
  13813. "required": true
  13814. },
  13815. {
  13816. "type": "string",
  13817. "description": "name of the repo",
  13818. "name": "repo",
  13819. "in": "path",
  13820. "required": true
  13821. },
  13822. {
  13823. "type": "integer",
  13824. "description": "page number of results to return (1-based)",
  13825. "name": "page",
  13826. "in": "query"
  13827. },
  13828. {
  13829. "type": "integer",
  13830. "description": "page size of results, default maximum page size is 50",
  13831. "name": "limit",
  13832. "in": "query"
  13833. }
  13834. ],
  13835. "responses": {
  13836. "200": {
  13837. "$ref": "#/responses/TagList"
  13838. },
  13839. "404": {
  13840. "$ref": "#/responses/notFound"
  13841. }
  13842. }
  13843. },
  13844. "post": {
  13845. "produces": [
  13846. "application/json"
  13847. ],
  13848. "tags": [
  13849. "repository"
  13850. ],
  13851. "summary": "Create a new git tag in a repository",
  13852. "operationId": "repoCreateTag",
  13853. "parameters": [
  13854. {
  13855. "type": "string",
  13856. "description": "owner of the repo",
  13857. "name": "owner",
  13858. "in": "path",
  13859. "required": true
  13860. },
  13861. {
  13862. "type": "string",
  13863. "description": "name of the repo",
  13864. "name": "repo",
  13865. "in": "path",
  13866. "required": true
  13867. },
  13868. {
  13869. "name": "body",
  13870. "in": "body",
  13871. "schema": {
  13872. "$ref": "#/definitions/CreateTagOption"
  13873. }
  13874. }
  13875. ],
  13876. "responses": {
  13877. "200": {
  13878. "$ref": "#/responses/Tag"
  13879. },
  13880. "404": {
  13881. "$ref": "#/responses/notFound"
  13882. },
  13883. "405": {
  13884. "$ref": "#/responses/empty"
  13885. },
  13886. "409": {
  13887. "$ref": "#/responses/conflict"
  13888. },
  13889. "423": {
  13890. "$ref": "#/responses/repoArchivedError"
  13891. }
  13892. }
  13893. }
  13894. },
  13895. "/repos/{owner}/{repo}/tags/{tag}": {
  13896. "get": {
  13897. "produces": [
  13898. "application/json"
  13899. ],
  13900. "tags": [
  13901. "repository"
  13902. ],
  13903. "summary": "Get the tag of a repository by tag name",
  13904. "operationId": "repoGetTag",
  13905. "parameters": [
  13906. {
  13907. "type": "string",
  13908. "description": "owner of the repo",
  13909. "name": "owner",
  13910. "in": "path",
  13911. "required": true
  13912. },
  13913. {
  13914. "type": "string",
  13915. "description": "name of the repo",
  13916. "name": "repo",
  13917. "in": "path",
  13918. "required": true
  13919. },
  13920. {
  13921. "type": "string",
  13922. "description": "name of tag",
  13923. "name": "tag",
  13924. "in": "path",
  13925. "required": true
  13926. }
  13927. ],
  13928. "responses": {
  13929. "200": {
  13930. "$ref": "#/responses/Tag"
  13931. },
  13932. "404": {
  13933. "$ref": "#/responses/notFound"
  13934. }
  13935. }
  13936. },
  13937. "delete": {
  13938. "produces": [
  13939. "application/json"
  13940. ],
  13941. "tags": [
  13942. "repository"
  13943. ],
  13944. "summary": "Delete a repository's tag by name",
  13945. "operationId": "repoDeleteTag",
  13946. "parameters": [
  13947. {
  13948. "type": "string",
  13949. "description": "owner of the repo",
  13950. "name": "owner",
  13951. "in": "path",
  13952. "required": true
  13953. },
  13954. {
  13955. "type": "string",
  13956. "description": "name of the repo",
  13957. "name": "repo",
  13958. "in": "path",
  13959. "required": true
  13960. },
  13961. {
  13962. "type": "string",
  13963. "description": "name of tag to delete",
  13964. "name": "tag",
  13965. "in": "path",
  13966. "required": true
  13967. }
  13968. ],
  13969. "responses": {
  13970. "204": {
  13971. "$ref": "#/responses/empty"
  13972. },
  13973. "404": {
  13974. "$ref": "#/responses/notFound"
  13975. },
  13976. "405": {
  13977. "$ref": "#/responses/empty"
  13978. },
  13979. "409": {
  13980. "$ref": "#/responses/conflict"
  13981. },
  13982. "423": {
  13983. "$ref": "#/responses/repoArchivedError"
  13984. }
  13985. }
  13986. }
  13987. },
  13988. "/repos/{owner}/{repo}/teams": {
  13989. "get": {
  13990. "produces": [
  13991. "application/json"
  13992. ],
  13993. "tags": [
  13994. "repository"
  13995. ],
  13996. "summary": "List a repository's teams",
  13997. "operationId": "repoListTeams",
  13998. "parameters": [
  13999. {
  14000. "type": "string",
  14001. "description": "owner of the repo",
  14002. "name": "owner",
  14003. "in": "path",
  14004. "required": true
  14005. },
  14006. {
  14007. "type": "string",
  14008. "description": "name of the repo",
  14009. "name": "repo",
  14010. "in": "path",
  14011. "required": true
  14012. }
  14013. ],
  14014. "responses": {
  14015. "200": {
  14016. "$ref": "#/responses/TeamList"
  14017. },
  14018. "404": {
  14019. "$ref": "#/responses/notFound"
  14020. }
  14021. }
  14022. }
  14023. },
  14024. "/repos/{owner}/{repo}/teams/{team}": {
  14025. "get": {
  14026. "produces": [
  14027. "application/json"
  14028. ],
  14029. "tags": [
  14030. "repository"
  14031. ],
  14032. "summary": "Check if a team is assigned to a repository",
  14033. "operationId": "repoCheckTeam",
  14034. "parameters": [
  14035. {
  14036. "type": "string",
  14037. "description": "owner of the repo",
  14038. "name": "owner",
  14039. "in": "path",
  14040. "required": true
  14041. },
  14042. {
  14043. "type": "string",
  14044. "description": "name of the repo",
  14045. "name": "repo",
  14046. "in": "path",
  14047. "required": true
  14048. },
  14049. {
  14050. "type": "string",
  14051. "description": "team name",
  14052. "name": "team",
  14053. "in": "path",
  14054. "required": true
  14055. }
  14056. ],
  14057. "responses": {
  14058. "200": {
  14059. "$ref": "#/responses/Team"
  14060. },
  14061. "404": {
  14062. "$ref": "#/responses/notFound"
  14063. },
  14064. "405": {
  14065. "$ref": "#/responses/error"
  14066. }
  14067. }
  14068. },
  14069. "put": {
  14070. "produces": [
  14071. "application/json"
  14072. ],
  14073. "tags": [
  14074. "repository"
  14075. ],
  14076. "summary": "Add a team to a repository",
  14077. "operationId": "repoAddTeam",
  14078. "parameters": [
  14079. {
  14080. "type": "string",
  14081. "description": "owner of the repo",
  14082. "name": "owner",
  14083. "in": "path",
  14084. "required": true
  14085. },
  14086. {
  14087. "type": "string",
  14088. "description": "name of the repo",
  14089. "name": "repo",
  14090. "in": "path",
  14091. "required": true
  14092. },
  14093. {
  14094. "type": "string",
  14095. "description": "team name",
  14096. "name": "team",
  14097. "in": "path",
  14098. "required": true
  14099. }
  14100. ],
  14101. "responses": {
  14102. "204": {
  14103. "$ref": "#/responses/empty"
  14104. },
  14105. "404": {
  14106. "$ref": "#/responses/notFound"
  14107. },
  14108. "405": {
  14109. "$ref": "#/responses/error"
  14110. },
  14111. "422": {
  14112. "$ref": "#/responses/validationError"
  14113. }
  14114. }
  14115. },
  14116. "delete": {
  14117. "produces": [
  14118. "application/json"
  14119. ],
  14120. "tags": [
  14121. "repository"
  14122. ],
  14123. "summary": "Delete a team from a repository",
  14124. "operationId": "repoDeleteTeam",
  14125. "parameters": [
  14126. {
  14127. "type": "string",
  14128. "description": "owner of the repo",
  14129. "name": "owner",
  14130. "in": "path",
  14131. "required": true
  14132. },
  14133. {
  14134. "type": "string",
  14135. "description": "name of the repo",
  14136. "name": "repo",
  14137. "in": "path",
  14138. "required": true
  14139. },
  14140. {
  14141. "type": "string",
  14142. "description": "team name",
  14143. "name": "team",
  14144. "in": "path",
  14145. "required": true
  14146. }
  14147. ],
  14148. "responses": {
  14149. "204": {
  14150. "$ref": "#/responses/empty"
  14151. },
  14152. "404": {
  14153. "$ref": "#/responses/notFound"
  14154. },
  14155. "405": {
  14156. "$ref": "#/responses/error"
  14157. },
  14158. "422": {
  14159. "$ref": "#/responses/validationError"
  14160. }
  14161. }
  14162. }
  14163. },
  14164. "/repos/{owner}/{repo}/times": {
  14165. "get": {
  14166. "produces": [
  14167. "application/json"
  14168. ],
  14169. "tags": [
  14170. "repository"
  14171. ],
  14172. "summary": "List a repo's tracked times",
  14173. "operationId": "repoTrackedTimes",
  14174. "parameters": [
  14175. {
  14176. "type": "string",
  14177. "description": "owner of the repo",
  14178. "name": "owner",
  14179. "in": "path",
  14180. "required": true
  14181. },
  14182. {
  14183. "type": "string",
  14184. "description": "name of the repo",
  14185. "name": "repo",
  14186. "in": "path",
  14187. "required": true
  14188. },
  14189. {
  14190. "type": "string",
  14191. "description": "optional filter by user (available for issue managers)",
  14192. "name": "user",
  14193. "in": "query"
  14194. },
  14195. {
  14196. "type": "string",
  14197. "format": "date-time",
  14198. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  14199. "name": "since",
  14200. "in": "query"
  14201. },
  14202. {
  14203. "type": "string",
  14204. "format": "date-time",
  14205. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  14206. "name": "before",
  14207. "in": "query"
  14208. },
  14209. {
  14210. "type": "integer",
  14211. "description": "page number of results to return (1-based)",
  14212. "name": "page",
  14213. "in": "query"
  14214. },
  14215. {
  14216. "type": "integer",
  14217. "description": "page size of results",
  14218. "name": "limit",
  14219. "in": "query"
  14220. }
  14221. ],
  14222. "responses": {
  14223. "200": {
  14224. "$ref": "#/responses/TrackedTimeList"
  14225. },
  14226. "400": {
  14227. "$ref": "#/responses/error"
  14228. },
  14229. "403": {
  14230. "$ref": "#/responses/forbidden"
  14231. },
  14232. "404": {
  14233. "$ref": "#/responses/notFound"
  14234. }
  14235. }
  14236. }
  14237. },
  14238. "/repos/{owner}/{repo}/times/{user}": {
  14239. "get": {
  14240. "produces": [
  14241. "application/json"
  14242. ],
  14243. "tags": [
  14244. "repository"
  14245. ],
  14246. "summary": "List a user's tracked times in a repo",
  14247. "operationId": "userTrackedTimes",
  14248. "deprecated": true,
  14249. "parameters": [
  14250. {
  14251. "type": "string",
  14252. "description": "owner of the repo",
  14253. "name": "owner",
  14254. "in": "path",
  14255. "required": true
  14256. },
  14257. {
  14258. "type": "string",
  14259. "description": "name of the repo",
  14260. "name": "repo",
  14261. "in": "path",
  14262. "required": true
  14263. },
  14264. {
  14265. "type": "string",
  14266. "description": "username of user",
  14267. "name": "user",
  14268. "in": "path",
  14269. "required": true
  14270. }
  14271. ],
  14272. "responses": {
  14273. "200": {
  14274. "$ref": "#/responses/TrackedTimeList"
  14275. },
  14276. "400": {
  14277. "$ref": "#/responses/error"
  14278. },
  14279. "403": {
  14280. "$ref": "#/responses/forbidden"
  14281. },
  14282. "404": {
  14283. "$ref": "#/responses/notFound"
  14284. }
  14285. }
  14286. }
  14287. },
  14288. "/repos/{owner}/{repo}/topics": {
  14289. "get": {
  14290. "produces": [
  14291. "application/json"
  14292. ],
  14293. "tags": [
  14294. "repository"
  14295. ],
  14296. "summary": "Get list of topics that a repository has",
  14297. "operationId": "repoListTopics",
  14298. "parameters": [
  14299. {
  14300. "type": "string",
  14301. "description": "owner of the repo",
  14302. "name": "owner",
  14303. "in": "path",
  14304. "required": true
  14305. },
  14306. {
  14307. "type": "string",
  14308. "description": "name of the repo",
  14309. "name": "repo",
  14310. "in": "path",
  14311. "required": true
  14312. },
  14313. {
  14314. "type": "integer",
  14315. "description": "page number of results to return (1-based)",
  14316. "name": "page",
  14317. "in": "query"
  14318. },
  14319. {
  14320. "type": "integer",
  14321. "description": "page size of results",
  14322. "name": "limit",
  14323. "in": "query"
  14324. }
  14325. ],
  14326. "responses": {
  14327. "200": {
  14328. "$ref": "#/responses/TopicNames"
  14329. },
  14330. "404": {
  14331. "$ref": "#/responses/notFound"
  14332. }
  14333. }
  14334. },
  14335. "put": {
  14336. "produces": [
  14337. "application/json"
  14338. ],
  14339. "tags": [
  14340. "repository"
  14341. ],
  14342. "summary": "Replace list of topics for a repository",
  14343. "operationId": "repoUpdateTopics",
  14344. "parameters": [
  14345. {
  14346. "type": "string",
  14347. "description": "owner of the repo",
  14348. "name": "owner",
  14349. "in": "path",
  14350. "required": true
  14351. },
  14352. {
  14353. "type": "string",
  14354. "description": "name of the repo",
  14355. "name": "repo",
  14356. "in": "path",
  14357. "required": true
  14358. },
  14359. {
  14360. "name": "body",
  14361. "in": "body",
  14362. "schema": {
  14363. "$ref": "#/definitions/RepoTopicOptions"
  14364. }
  14365. }
  14366. ],
  14367. "responses": {
  14368. "204": {
  14369. "$ref": "#/responses/empty"
  14370. },
  14371. "404": {
  14372. "$ref": "#/responses/notFound"
  14373. },
  14374. "422": {
  14375. "$ref": "#/responses/invalidTopicsError"
  14376. }
  14377. }
  14378. }
  14379. },
  14380. "/repos/{owner}/{repo}/topics/{topic}": {
  14381. "put": {
  14382. "produces": [
  14383. "application/json"
  14384. ],
  14385. "tags": [
  14386. "repository"
  14387. ],
  14388. "summary": "Add a topic to a repository",
  14389. "operationId": "repoAddTopic",
  14390. "parameters": [
  14391. {
  14392. "type": "string",
  14393. "description": "owner of the repo",
  14394. "name": "owner",
  14395. "in": "path",
  14396. "required": true
  14397. },
  14398. {
  14399. "type": "string",
  14400. "description": "name of the repo",
  14401. "name": "repo",
  14402. "in": "path",
  14403. "required": true
  14404. },
  14405. {
  14406. "type": "string",
  14407. "description": "name of the topic to add",
  14408. "name": "topic",
  14409. "in": "path",
  14410. "required": true
  14411. }
  14412. ],
  14413. "responses": {
  14414. "204": {
  14415. "$ref": "#/responses/empty"
  14416. },
  14417. "404": {
  14418. "$ref": "#/responses/notFound"
  14419. },
  14420. "422": {
  14421. "$ref": "#/responses/invalidTopicsError"
  14422. }
  14423. }
  14424. },
  14425. "delete": {
  14426. "produces": [
  14427. "application/json"
  14428. ],
  14429. "tags": [
  14430. "repository"
  14431. ],
  14432. "summary": "Delete a topic from a repository",
  14433. "operationId": "repoDeleteTopic",
  14434. "parameters": [
  14435. {
  14436. "type": "string",
  14437. "description": "owner of the repo",
  14438. "name": "owner",
  14439. "in": "path",
  14440. "required": true
  14441. },
  14442. {
  14443. "type": "string",
  14444. "description": "name of the repo",
  14445. "name": "repo",
  14446. "in": "path",
  14447. "required": true
  14448. },
  14449. {
  14450. "type": "string",
  14451. "description": "name of the topic to delete",
  14452. "name": "topic",
  14453. "in": "path",
  14454. "required": true
  14455. }
  14456. ],
  14457. "responses": {
  14458. "204": {
  14459. "$ref": "#/responses/empty"
  14460. },
  14461. "404": {
  14462. "$ref": "#/responses/notFound"
  14463. },
  14464. "422": {
  14465. "$ref": "#/responses/invalidTopicsError"
  14466. }
  14467. }
  14468. }
  14469. },
  14470. "/repos/{owner}/{repo}/transfer": {
  14471. "post": {
  14472. "produces": [
  14473. "application/json"
  14474. ],
  14475. "tags": [
  14476. "repository"
  14477. ],
  14478. "summary": "Transfer a repo ownership",
  14479. "operationId": "repoTransfer",
  14480. "parameters": [
  14481. {
  14482. "type": "string",
  14483. "description": "owner of the repo to transfer",
  14484. "name": "owner",
  14485. "in": "path",
  14486. "required": true
  14487. },
  14488. {
  14489. "type": "string",
  14490. "description": "name of the repo to transfer",
  14491. "name": "repo",
  14492. "in": "path",
  14493. "required": true
  14494. },
  14495. {
  14496. "description": "Transfer Options",
  14497. "name": "body",
  14498. "in": "body",
  14499. "required": true,
  14500. "schema": {
  14501. "$ref": "#/definitions/TransferRepoOption"
  14502. }
  14503. }
  14504. ],
  14505. "responses": {
  14506. "202": {
  14507. "$ref": "#/responses/Repository"
  14508. },
  14509. "403": {
  14510. "$ref": "#/responses/forbidden"
  14511. },
  14512. "404": {
  14513. "$ref": "#/responses/notFound"
  14514. },
  14515. "422": {
  14516. "$ref": "#/responses/validationError"
  14517. }
  14518. }
  14519. }
  14520. },
  14521. "/repos/{owner}/{repo}/transfer/accept": {
  14522. "post": {
  14523. "produces": [
  14524. "application/json"
  14525. ],
  14526. "tags": [
  14527. "repository"
  14528. ],
  14529. "summary": "Accept a repo transfer",
  14530. "operationId": "acceptRepoTransfer",
  14531. "parameters": [
  14532. {
  14533. "type": "string",
  14534. "description": "owner of the repo to transfer",
  14535. "name": "owner",
  14536. "in": "path",
  14537. "required": true
  14538. },
  14539. {
  14540. "type": "string",
  14541. "description": "name of the repo to transfer",
  14542. "name": "repo",
  14543. "in": "path",
  14544. "required": true
  14545. }
  14546. ],
  14547. "responses": {
  14548. "202": {
  14549. "$ref": "#/responses/Repository"
  14550. },
  14551. "403": {
  14552. "$ref": "#/responses/forbidden"
  14553. },
  14554. "404": {
  14555. "$ref": "#/responses/notFound"
  14556. }
  14557. }
  14558. }
  14559. },
  14560. "/repos/{owner}/{repo}/transfer/reject": {
  14561. "post": {
  14562. "produces": [
  14563. "application/json"
  14564. ],
  14565. "tags": [
  14566. "repository"
  14567. ],
  14568. "summary": "Reject a repo transfer",
  14569. "operationId": "rejectRepoTransfer",
  14570. "parameters": [
  14571. {
  14572. "type": "string",
  14573. "description": "owner of the repo to transfer",
  14574. "name": "owner",
  14575. "in": "path",
  14576. "required": true
  14577. },
  14578. {
  14579. "type": "string",
  14580. "description": "name of the repo to transfer",
  14581. "name": "repo",
  14582. "in": "path",
  14583. "required": true
  14584. }
  14585. ],
  14586. "responses": {
  14587. "200": {
  14588. "$ref": "#/responses/Repository"
  14589. },
  14590. "403": {
  14591. "$ref": "#/responses/forbidden"
  14592. },
  14593. "404": {
  14594. "$ref": "#/responses/notFound"
  14595. }
  14596. }
  14597. }
  14598. },
  14599. "/repos/{owner}/{repo}/wiki/new": {
  14600. "post": {
  14601. "consumes": [
  14602. "application/json"
  14603. ],
  14604. "tags": [
  14605. "repository"
  14606. ],
  14607. "summary": "Create a wiki page",
  14608. "operationId": "repoCreateWikiPage",
  14609. "parameters": [
  14610. {
  14611. "type": "string",
  14612. "description": "owner of the repo",
  14613. "name": "owner",
  14614. "in": "path",
  14615. "required": true
  14616. },
  14617. {
  14618. "type": "string",
  14619. "description": "name of the repo",
  14620. "name": "repo",
  14621. "in": "path",
  14622. "required": true
  14623. },
  14624. {
  14625. "name": "body",
  14626. "in": "body",
  14627. "schema": {
  14628. "$ref": "#/definitions/CreateWikiPageOptions"
  14629. }
  14630. }
  14631. ],
  14632. "responses": {
  14633. "201": {
  14634. "$ref": "#/responses/WikiPage"
  14635. },
  14636. "400": {
  14637. "$ref": "#/responses/error"
  14638. },
  14639. "403": {
  14640. "$ref": "#/responses/forbidden"
  14641. },
  14642. "404": {
  14643. "$ref": "#/responses/notFound"
  14644. },
  14645. "423": {
  14646. "$ref": "#/responses/repoArchivedError"
  14647. }
  14648. }
  14649. }
  14650. },
  14651. "/repos/{owner}/{repo}/wiki/page/{pageName}": {
  14652. "get": {
  14653. "produces": [
  14654. "application/json"
  14655. ],
  14656. "tags": [
  14657. "repository"
  14658. ],
  14659. "summary": "Get a wiki page",
  14660. "operationId": "repoGetWikiPage",
  14661. "parameters": [
  14662. {
  14663. "type": "string",
  14664. "description": "owner of the repo",
  14665. "name": "owner",
  14666. "in": "path",
  14667. "required": true
  14668. },
  14669. {
  14670. "type": "string",
  14671. "description": "name of the repo",
  14672. "name": "repo",
  14673. "in": "path",
  14674. "required": true
  14675. },
  14676. {
  14677. "type": "string",
  14678. "description": "name of the page",
  14679. "name": "pageName",
  14680. "in": "path",
  14681. "required": true
  14682. }
  14683. ],
  14684. "responses": {
  14685. "200": {
  14686. "$ref": "#/responses/WikiPage"
  14687. },
  14688. "404": {
  14689. "$ref": "#/responses/notFound"
  14690. }
  14691. }
  14692. },
  14693. "delete": {
  14694. "tags": [
  14695. "repository"
  14696. ],
  14697. "summary": "Delete a wiki page",
  14698. "operationId": "repoDeleteWikiPage",
  14699. "parameters": [
  14700. {
  14701. "type": "string",
  14702. "description": "owner of the repo",
  14703. "name": "owner",
  14704. "in": "path",
  14705. "required": true
  14706. },
  14707. {
  14708. "type": "string",
  14709. "description": "name of the repo",
  14710. "name": "repo",
  14711. "in": "path",
  14712. "required": true
  14713. },
  14714. {
  14715. "type": "string",
  14716. "description": "name of the page",
  14717. "name": "pageName",
  14718. "in": "path",
  14719. "required": true
  14720. }
  14721. ],
  14722. "responses": {
  14723. "204": {
  14724. "$ref": "#/responses/empty"
  14725. },
  14726. "403": {
  14727. "$ref": "#/responses/forbidden"
  14728. },
  14729. "404": {
  14730. "$ref": "#/responses/notFound"
  14731. },
  14732. "423": {
  14733. "$ref": "#/responses/repoArchivedError"
  14734. }
  14735. }
  14736. },
  14737. "patch": {
  14738. "consumes": [
  14739. "application/json"
  14740. ],
  14741. "tags": [
  14742. "repository"
  14743. ],
  14744. "summary": "Edit a wiki page",
  14745. "operationId": "repoEditWikiPage",
  14746. "parameters": [
  14747. {
  14748. "type": "string",
  14749. "description": "owner of the repo",
  14750. "name": "owner",
  14751. "in": "path",
  14752. "required": true
  14753. },
  14754. {
  14755. "type": "string",
  14756. "description": "name of the repo",
  14757. "name": "repo",
  14758. "in": "path",
  14759. "required": true
  14760. },
  14761. {
  14762. "type": "string",
  14763. "description": "name of the page",
  14764. "name": "pageName",
  14765. "in": "path",
  14766. "required": true
  14767. },
  14768. {
  14769. "name": "body",
  14770. "in": "body",
  14771. "schema": {
  14772. "$ref": "#/definitions/CreateWikiPageOptions"
  14773. }
  14774. }
  14775. ],
  14776. "responses": {
  14777. "200": {
  14778. "$ref": "#/responses/WikiPage"
  14779. },
  14780. "400": {
  14781. "$ref": "#/responses/error"
  14782. },
  14783. "403": {
  14784. "$ref": "#/responses/forbidden"
  14785. },
  14786. "404": {
  14787. "$ref": "#/responses/notFound"
  14788. },
  14789. "423": {
  14790. "$ref": "#/responses/repoArchivedError"
  14791. }
  14792. }
  14793. }
  14794. },
  14795. "/repos/{owner}/{repo}/wiki/pages": {
  14796. "get": {
  14797. "produces": [
  14798. "application/json"
  14799. ],
  14800. "tags": [
  14801. "repository"
  14802. ],
  14803. "summary": "Get all wiki pages",
  14804. "operationId": "repoGetWikiPages",
  14805. "parameters": [
  14806. {
  14807. "type": "string",
  14808. "description": "owner of the repo",
  14809. "name": "owner",
  14810. "in": "path",
  14811. "required": true
  14812. },
  14813. {
  14814. "type": "string",
  14815. "description": "name of the repo",
  14816. "name": "repo",
  14817. "in": "path",
  14818. "required": true
  14819. },
  14820. {
  14821. "type": "integer",
  14822. "description": "page number of results to return (1-based)",
  14823. "name": "page",
  14824. "in": "query"
  14825. },
  14826. {
  14827. "type": "integer",
  14828. "description": "page size of results",
  14829. "name": "limit",
  14830. "in": "query"
  14831. }
  14832. ],
  14833. "responses": {
  14834. "200": {
  14835. "$ref": "#/responses/WikiPageList"
  14836. },
  14837. "404": {
  14838. "$ref": "#/responses/notFound"
  14839. }
  14840. }
  14841. }
  14842. },
  14843. "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
  14844. "get": {
  14845. "produces": [
  14846. "application/json"
  14847. ],
  14848. "tags": [
  14849. "repository"
  14850. ],
  14851. "summary": "Get revisions of a wiki page",
  14852. "operationId": "repoGetWikiPageRevisions",
  14853. "parameters": [
  14854. {
  14855. "type": "string",
  14856. "description": "owner of the repo",
  14857. "name": "owner",
  14858. "in": "path",
  14859. "required": true
  14860. },
  14861. {
  14862. "type": "string",
  14863. "description": "name of the repo",
  14864. "name": "repo",
  14865. "in": "path",
  14866. "required": true
  14867. },
  14868. {
  14869. "type": "string",
  14870. "description": "name of the page",
  14871. "name": "pageName",
  14872. "in": "path",
  14873. "required": true
  14874. },
  14875. {
  14876. "type": "integer",
  14877. "description": "page number of results to return (1-based)",
  14878. "name": "page",
  14879. "in": "query"
  14880. }
  14881. ],
  14882. "responses": {
  14883. "200": {
  14884. "$ref": "#/responses/WikiCommitList"
  14885. },
  14886. "404": {
  14887. "$ref": "#/responses/notFound"
  14888. }
  14889. }
  14890. }
  14891. },
  14892. "/repos/{template_owner}/{template_repo}/generate": {
  14893. "post": {
  14894. "consumes": [
  14895. "application/json"
  14896. ],
  14897. "produces": [
  14898. "application/json"
  14899. ],
  14900. "tags": [
  14901. "repository"
  14902. ],
  14903. "summary": "Create a repository using a template",
  14904. "operationId": "generateRepo",
  14905. "parameters": [
  14906. {
  14907. "type": "string",
  14908. "description": "name of the template repository owner",
  14909. "name": "template_owner",
  14910. "in": "path",
  14911. "required": true
  14912. },
  14913. {
  14914. "type": "string",
  14915. "description": "name of the template repository",
  14916. "name": "template_repo",
  14917. "in": "path",
  14918. "required": true
  14919. },
  14920. {
  14921. "name": "body",
  14922. "in": "body",
  14923. "schema": {
  14924. "$ref": "#/definitions/GenerateRepoOption"
  14925. }
  14926. }
  14927. ],
  14928. "responses": {
  14929. "201": {
  14930. "$ref": "#/responses/Repository"
  14931. },
  14932. "403": {
  14933. "$ref": "#/responses/forbidden"
  14934. },
  14935. "404": {
  14936. "$ref": "#/responses/notFound"
  14937. },
  14938. "409": {
  14939. "description": "The repository with the same name already exists."
  14940. },
  14941. "422": {
  14942. "$ref": "#/responses/validationError"
  14943. }
  14944. }
  14945. }
  14946. },
  14947. "/repositories/{id}": {
  14948. "get": {
  14949. "produces": [
  14950. "application/json"
  14951. ],
  14952. "tags": [
  14953. "repository"
  14954. ],
  14955. "summary": "Get a repository by id",
  14956. "operationId": "repoGetByID",
  14957. "parameters": [
  14958. {
  14959. "type": "integer",
  14960. "format": "int64",
  14961. "description": "id of the repo to get",
  14962. "name": "id",
  14963. "in": "path",
  14964. "required": true
  14965. }
  14966. ],
  14967. "responses": {
  14968. "200": {
  14969. "$ref": "#/responses/Repository"
  14970. },
  14971. "404": {
  14972. "$ref": "#/responses/notFound"
  14973. }
  14974. }
  14975. }
  14976. },
  14977. "/settings/api": {
  14978. "get": {
  14979. "produces": [
  14980. "application/json"
  14981. ],
  14982. "tags": [
  14983. "settings"
  14984. ],
  14985. "summary": "Get instance's global settings for api",
  14986. "operationId": "getGeneralAPISettings",
  14987. "responses": {
  14988. "200": {
  14989. "$ref": "#/responses/GeneralAPISettings"
  14990. }
  14991. }
  14992. }
  14993. },
  14994. "/settings/attachment": {
  14995. "get": {
  14996. "produces": [
  14997. "application/json"
  14998. ],
  14999. "tags": [
  15000. "settings"
  15001. ],
  15002. "summary": "Get instance's global settings for Attachment",
  15003. "operationId": "getGeneralAttachmentSettings",
  15004. "responses": {
  15005. "200": {
  15006. "$ref": "#/responses/GeneralAttachmentSettings"
  15007. }
  15008. }
  15009. }
  15010. },
  15011. "/settings/repository": {
  15012. "get": {
  15013. "produces": [
  15014. "application/json"
  15015. ],
  15016. "tags": [
  15017. "settings"
  15018. ],
  15019. "summary": "Get instance's global settings for repositories",
  15020. "operationId": "getGeneralRepositorySettings",
  15021. "responses": {
  15022. "200": {
  15023. "$ref": "#/responses/GeneralRepoSettings"
  15024. }
  15025. }
  15026. }
  15027. },
  15028. "/settings/ui": {
  15029. "get": {
  15030. "produces": [
  15031. "application/json"
  15032. ],
  15033. "tags": [
  15034. "settings"
  15035. ],
  15036. "summary": "Get instance's global settings for ui",
  15037. "operationId": "getGeneralUISettings",
  15038. "responses": {
  15039. "200": {
  15040. "$ref": "#/responses/GeneralUISettings"
  15041. }
  15042. }
  15043. }
  15044. },
  15045. "/signing-key.gpg": {
  15046. "get": {
  15047. "produces": [
  15048. "text/plain"
  15049. ],
  15050. "tags": [
  15051. "miscellaneous"
  15052. ],
  15053. "summary": "Get default signing-key.gpg",
  15054. "operationId": "getSigningKey",
  15055. "responses": {
  15056. "200": {
  15057. "description": "GPG armored public key",
  15058. "schema": {
  15059. "type": "string"
  15060. }
  15061. }
  15062. }
  15063. }
  15064. },
  15065. "/teams/{id}": {
  15066. "get": {
  15067. "produces": [
  15068. "application/json"
  15069. ],
  15070. "tags": [
  15071. "organization"
  15072. ],
  15073. "summary": "Get a team",
  15074. "operationId": "orgGetTeam",
  15075. "parameters": [
  15076. {
  15077. "type": "integer",
  15078. "format": "int64",
  15079. "description": "id of the team to get",
  15080. "name": "id",
  15081. "in": "path",
  15082. "required": true
  15083. }
  15084. ],
  15085. "responses": {
  15086. "200": {
  15087. "$ref": "#/responses/Team"
  15088. },
  15089. "404": {
  15090. "$ref": "#/responses/notFound"
  15091. }
  15092. }
  15093. },
  15094. "delete": {
  15095. "tags": [
  15096. "organization"
  15097. ],
  15098. "summary": "Delete a team",
  15099. "operationId": "orgDeleteTeam",
  15100. "parameters": [
  15101. {
  15102. "type": "integer",
  15103. "format": "int64",
  15104. "description": "id of the team to delete",
  15105. "name": "id",
  15106. "in": "path",
  15107. "required": true
  15108. }
  15109. ],
  15110. "responses": {
  15111. "204": {
  15112. "description": "team deleted"
  15113. },
  15114. "404": {
  15115. "$ref": "#/responses/notFound"
  15116. }
  15117. }
  15118. },
  15119. "patch": {
  15120. "consumes": [
  15121. "application/json"
  15122. ],
  15123. "produces": [
  15124. "application/json"
  15125. ],
  15126. "tags": [
  15127. "organization"
  15128. ],
  15129. "summary": "Edit a team",
  15130. "operationId": "orgEditTeam",
  15131. "parameters": [
  15132. {
  15133. "type": "integer",
  15134. "description": "id of the team to edit",
  15135. "name": "id",
  15136. "in": "path",
  15137. "required": true
  15138. },
  15139. {
  15140. "name": "body",
  15141. "in": "body",
  15142. "schema": {
  15143. "$ref": "#/definitions/EditTeamOption"
  15144. }
  15145. }
  15146. ],
  15147. "responses": {
  15148. "200": {
  15149. "$ref": "#/responses/Team"
  15150. },
  15151. "404": {
  15152. "$ref": "#/responses/notFound"
  15153. }
  15154. }
  15155. }
  15156. },
  15157. "/teams/{id}/activities/feeds": {
  15158. "get": {
  15159. "produces": [
  15160. "application/json"
  15161. ],
  15162. "tags": [
  15163. "organization"
  15164. ],
  15165. "summary": "List a team's activity feeds",
  15166. "operationId": "orgListTeamActivityFeeds",
  15167. "parameters": [
  15168. {
  15169. "type": "integer",
  15170. "format": "int64",
  15171. "description": "id of the team",
  15172. "name": "id",
  15173. "in": "path",
  15174. "required": true
  15175. },
  15176. {
  15177. "type": "string",
  15178. "format": "date",
  15179. "description": "the date of the activities to be found",
  15180. "name": "date",
  15181. "in": "query"
  15182. },
  15183. {
  15184. "type": "integer",
  15185. "description": "page number of results to return (1-based)",
  15186. "name": "page",
  15187. "in": "query"
  15188. },
  15189. {
  15190. "type": "integer",
  15191. "description": "page size of results",
  15192. "name": "limit",
  15193. "in": "query"
  15194. }
  15195. ],
  15196. "responses": {
  15197. "200": {
  15198. "$ref": "#/responses/ActivityFeedsList"
  15199. },
  15200. "404": {
  15201. "$ref": "#/responses/notFound"
  15202. }
  15203. }
  15204. }
  15205. },
  15206. "/teams/{id}/members": {
  15207. "get": {
  15208. "produces": [
  15209. "application/json"
  15210. ],
  15211. "tags": [
  15212. "organization"
  15213. ],
  15214. "summary": "List a team's members",
  15215. "operationId": "orgListTeamMembers",
  15216. "parameters": [
  15217. {
  15218. "type": "integer",
  15219. "format": "int64",
  15220. "description": "id of the team",
  15221. "name": "id",
  15222. "in": "path",
  15223. "required": true
  15224. },
  15225. {
  15226. "type": "integer",
  15227. "description": "page number of results to return (1-based)",
  15228. "name": "page",
  15229. "in": "query"
  15230. },
  15231. {
  15232. "type": "integer",
  15233. "description": "page size of results",
  15234. "name": "limit",
  15235. "in": "query"
  15236. }
  15237. ],
  15238. "responses": {
  15239. "200": {
  15240. "$ref": "#/responses/UserList"
  15241. },
  15242. "404": {
  15243. "$ref": "#/responses/notFound"
  15244. }
  15245. }
  15246. }
  15247. },
  15248. "/teams/{id}/members/{username}": {
  15249. "get": {
  15250. "produces": [
  15251. "application/json"
  15252. ],
  15253. "tags": [
  15254. "organization"
  15255. ],
  15256. "summary": "List a particular member of team",
  15257. "operationId": "orgListTeamMember",
  15258. "parameters": [
  15259. {
  15260. "type": "integer",
  15261. "format": "int64",
  15262. "description": "id of the team",
  15263. "name": "id",
  15264. "in": "path",
  15265. "required": true
  15266. },
  15267. {
  15268. "type": "string",
  15269. "description": "username of the member to list",
  15270. "name": "username",
  15271. "in": "path",
  15272. "required": true
  15273. }
  15274. ],
  15275. "responses": {
  15276. "200": {
  15277. "$ref": "#/responses/User"
  15278. },
  15279. "404": {
  15280. "$ref": "#/responses/notFound"
  15281. }
  15282. }
  15283. },
  15284. "put": {
  15285. "produces": [
  15286. "application/json"
  15287. ],
  15288. "tags": [
  15289. "organization"
  15290. ],
  15291. "summary": "Add a team member",
  15292. "operationId": "orgAddTeamMember",
  15293. "parameters": [
  15294. {
  15295. "type": "integer",
  15296. "format": "int64",
  15297. "description": "id of the team",
  15298. "name": "id",
  15299. "in": "path",
  15300. "required": true
  15301. },
  15302. {
  15303. "type": "string",
  15304. "description": "username of the user to add",
  15305. "name": "username",
  15306. "in": "path",
  15307. "required": true
  15308. }
  15309. ],
  15310. "responses": {
  15311. "204": {
  15312. "$ref": "#/responses/empty"
  15313. },
  15314. "403": {
  15315. "$ref": "#/responses/forbidden"
  15316. },
  15317. "404": {
  15318. "$ref": "#/responses/notFound"
  15319. }
  15320. }
  15321. },
  15322. "delete": {
  15323. "produces": [
  15324. "application/json"
  15325. ],
  15326. "tags": [
  15327. "organization"
  15328. ],
  15329. "summary": "Remove a team member",
  15330. "operationId": "orgRemoveTeamMember",
  15331. "parameters": [
  15332. {
  15333. "type": "integer",
  15334. "format": "int64",
  15335. "description": "id of the team",
  15336. "name": "id",
  15337. "in": "path",
  15338. "required": true
  15339. },
  15340. {
  15341. "type": "string",
  15342. "description": "username of the user to remove",
  15343. "name": "username",
  15344. "in": "path",
  15345. "required": true
  15346. }
  15347. ],
  15348. "responses": {
  15349. "204": {
  15350. "$ref": "#/responses/empty"
  15351. },
  15352. "404": {
  15353. "$ref": "#/responses/notFound"
  15354. }
  15355. }
  15356. }
  15357. },
  15358. "/teams/{id}/repos": {
  15359. "get": {
  15360. "produces": [
  15361. "application/json"
  15362. ],
  15363. "tags": [
  15364. "organization"
  15365. ],
  15366. "summary": "List a team's repos",
  15367. "operationId": "orgListTeamRepos",
  15368. "parameters": [
  15369. {
  15370. "type": "integer",
  15371. "format": "int64",
  15372. "description": "id of the team",
  15373. "name": "id",
  15374. "in": "path",
  15375. "required": true
  15376. },
  15377. {
  15378. "type": "integer",
  15379. "description": "page number of results to return (1-based)",
  15380. "name": "page",
  15381. "in": "query"
  15382. },
  15383. {
  15384. "type": "integer",
  15385. "description": "page size of results",
  15386. "name": "limit",
  15387. "in": "query"
  15388. }
  15389. ],
  15390. "responses": {
  15391. "200": {
  15392. "$ref": "#/responses/RepositoryList"
  15393. },
  15394. "404": {
  15395. "$ref": "#/responses/notFound"
  15396. }
  15397. }
  15398. }
  15399. },
  15400. "/teams/{id}/repos/{org}/{repo}": {
  15401. "get": {
  15402. "produces": [
  15403. "application/json"
  15404. ],
  15405. "tags": [
  15406. "organization"
  15407. ],
  15408. "summary": "List a particular repo of team",
  15409. "operationId": "orgListTeamRepo",
  15410. "parameters": [
  15411. {
  15412. "type": "integer",
  15413. "format": "int64",
  15414. "description": "id of the team",
  15415. "name": "id",
  15416. "in": "path",
  15417. "required": true
  15418. },
  15419. {
  15420. "type": "string",
  15421. "description": "organization that owns the repo to list",
  15422. "name": "org",
  15423. "in": "path",
  15424. "required": true
  15425. },
  15426. {
  15427. "type": "string",
  15428. "description": "name of the repo to list",
  15429. "name": "repo",
  15430. "in": "path",
  15431. "required": true
  15432. }
  15433. ],
  15434. "responses": {
  15435. "200": {
  15436. "$ref": "#/responses/Repository"
  15437. },
  15438. "404": {
  15439. "$ref": "#/responses/notFound"
  15440. }
  15441. }
  15442. },
  15443. "put": {
  15444. "produces": [
  15445. "application/json"
  15446. ],
  15447. "tags": [
  15448. "organization"
  15449. ],
  15450. "summary": "Add a repository to a team",
  15451. "operationId": "orgAddTeamRepository",
  15452. "parameters": [
  15453. {
  15454. "type": "integer",
  15455. "format": "int64",
  15456. "description": "id of the team",
  15457. "name": "id",
  15458. "in": "path",
  15459. "required": true
  15460. },
  15461. {
  15462. "type": "string",
  15463. "description": "organization that owns the repo to add",
  15464. "name": "org",
  15465. "in": "path",
  15466. "required": true
  15467. },
  15468. {
  15469. "type": "string",
  15470. "description": "name of the repo to add",
  15471. "name": "repo",
  15472. "in": "path",
  15473. "required": true
  15474. }
  15475. ],
  15476. "responses": {
  15477. "204": {
  15478. "$ref": "#/responses/empty"
  15479. },
  15480. "403": {
  15481. "$ref": "#/responses/forbidden"
  15482. },
  15483. "404": {
  15484. "$ref": "#/responses/notFound"
  15485. }
  15486. }
  15487. },
  15488. "delete": {
  15489. "description": "This does not delete the repository, it only removes the repository from the team.",
  15490. "produces": [
  15491. "application/json"
  15492. ],
  15493. "tags": [
  15494. "organization"
  15495. ],
  15496. "summary": "Remove a repository from a team",
  15497. "operationId": "orgRemoveTeamRepository",
  15498. "parameters": [
  15499. {
  15500. "type": "integer",
  15501. "format": "int64",
  15502. "description": "id of the team",
  15503. "name": "id",
  15504. "in": "path",
  15505. "required": true
  15506. },
  15507. {
  15508. "type": "string",
  15509. "description": "organization that owns the repo to remove",
  15510. "name": "org",
  15511. "in": "path",
  15512. "required": true
  15513. },
  15514. {
  15515. "type": "string",
  15516. "description": "name of the repo to remove",
  15517. "name": "repo",
  15518. "in": "path",
  15519. "required": true
  15520. }
  15521. ],
  15522. "responses": {
  15523. "204": {
  15524. "$ref": "#/responses/empty"
  15525. },
  15526. "403": {
  15527. "$ref": "#/responses/forbidden"
  15528. },
  15529. "404": {
  15530. "$ref": "#/responses/notFound"
  15531. }
  15532. }
  15533. }
  15534. },
  15535. "/topics/search": {
  15536. "get": {
  15537. "produces": [
  15538. "application/json"
  15539. ],
  15540. "tags": [
  15541. "repository"
  15542. ],
  15543. "summary": "search topics via keyword",
  15544. "operationId": "topicSearch",
  15545. "parameters": [
  15546. {
  15547. "type": "string",
  15548. "description": "keywords to search",
  15549. "name": "q",
  15550. "in": "query",
  15551. "required": true
  15552. },
  15553. {
  15554. "type": "integer",
  15555. "description": "page number of results to return (1-based)",
  15556. "name": "page",
  15557. "in": "query"
  15558. },
  15559. {
  15560. "type": "integer",
  15561. "description": "page size of results",
  15562. "name": "limit",
  15563. "in": "query"
  15564. }
  15565. ],
  15566. "responses": {
  15567. "200": {
  15568. "$ref": "#/responses/TopicListResponse"
  15569. },
  15570. "403": {
  15571. "$ref": "#/responses/forbidden"
  15572. },
  15573. "404": {
  15574. "$ref": "#/responses/notFound"
  15575. }
  15576. }
  15577. }
  15578. },
  15579. "/user": {
  15580. "get": {
  15581. "produces": [
  15582. "application/json"
  15583. ],
  15584. "tags": [
  15585. "user"
  15586. ],
  15587. "summary": "Get the authenticated user",
  15588. "operationId": "userGetCurrent",
  15589. "responses": {
  15590. "200": {
  15591. "$ref": "#/responses/User"
  15592. }
  15593. }
  15594. }
  15595. },
  15596. "/user/actions/runners/registration-token": {
  15597. "get": {
  15598. "produces": [
  15599. "application/json"
  15600. ],
  15601. "tags": [
  15602. "user"
  15603. ],
  15604. "summary": "Get an user's actions runner registration token",
  15605. "operationId": "userGetRunnerRegistrationToken",
  15606. "responses": {
  15607. "200": {
  15608. "$ref": "#/responses/RegistrationToken"
  15609. }
  15610. }
  15611. }
  15612. },
  15613. "/user/actions/secrets/{secretname}": {
  15614. "put": {
  15615. "consumes": [
  15616. "application/json"
  15617. ],
  15618. "produces": [
  15619. "application/json"
  15620. ],
  15621. "tags": [
  15622. "user"
  15623. ],
  15624. "summary": "Create or Update a secret value in a user scope",
  15625. "operationId": "updateUserSecret",
  15626. "parameters": [
  15627. {
  15628. "type": "string",
  15629. "description": "name of the secret",
  15630. "name": "secretname",
  15631. "in": "path",
  15632. "required": true
  15633. },
  15634. {
  15635. "name": "body",
  15636. "in": "body",
  15637. "schema": {
  15638. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  15639. }
  15640. }
  15641. ],
  15642. "responses": {
  15643. "201": {
  15644. "description": "response when creating a secret"
  15645. },
  15646. "204": {
  15647. "description": "response when updating a secret"
  15648. },
  15649. "400": {
  15650. "$ref": "#/responses/error"
  15651. },
  15652. "404": {
  15653. "$ref": "#/responses/notFound"
  15654. }
  15655. }
  15656. },
  15657. "delete": {
  15658. "consumes": [
  15659. "application/json"
  15660. ],
  15661. "produces": [
  15662. "application/json"
  15663. ],
  15664. "tags": [
  15665. "user"
  15666. ],
  15667. "summary": "Delete a secret in a user scope",
  15668. "operationId": "deleteUserSecret",
  15669. "parameters": [
  15670. {
  15671. "type": "string",
  15672. "description": "name of the secret",
  15673. "name": "secretname",
  15674. "in": "path",
  15675. "required": true
  15676. }
  15677. ],
  15678. "responses": {
  15679. "204": {
  15680. "description": "delete one secret of the user"
  15681. },
  15682. "400": {
  15683. "$ref": "#/responses/error"
  15684. },
  15685. "404": {
  15686. "$ref": "#/responses/notFound"
  15687. }
  15688. }
  15689. }
  15690. },
  15691. "/user/actions/variables": {
  15692. "get": {
  15693. "produces": [
  15694. "application/json"
  15695. ],
  15696. "tags": [
  15697. "user"
  15698. ],
  15699. "summary": "Get the user-level list of variables which is created by current doer",
  15700. "operationId": "getUserVariablesList",
  15701. "parameters": [
  15702. {
  15703. "type": "integer",
  15704. "description": "page number of results to return (1-based)",
  15705. "name": "page",
  15706. "in": "query"
  15707. },
  15708. {
  15709. "type": "integer",
  15710. "description": "page size of results",
  15711. "name": "limit",
  15712. "in": "query"
  15713. }
  15714. ],
  15715. "responses": {
  15716. "200": {
  15717. "$ref": "#/responses/VariableList"
  15718. },
  15719. "400": {
  15720. "$ref": "#/responses/error"
  15721. },
  15722. "404": {
  15723. "$ref": "#/responses/notFound"
  15724. }
  15725. }
  15726. }
  15727. },
  15728. "/user/actions/variables/{variablename}": {
  15729. "get": {
  15730. "produces": [
  15731. "application/json"
  15732. ],
  15733. "tags": [
  15734. "user"
  15735. ],
  15736. "summary": "Get a user-level variable which is created by current doer",
  15737. "operationId": "getUserVariable",
  15738. "parameters": [
  15739. {
  15740. "type": "string",
  15741. "description": "name of the variable",
  15742. "name": "variablename",
  15743. "in": "path",
  15744. "required": true
  15745. }
  15746. ],
  15747. "responses": {
  15748. "200": {
  15749. "$ref": "#/responses/ActionVariable"
  15750. },
  15751. "400": {
  15752. "$ref": "#/responses/error"
  15753. },
  15754. "404": {
  15755. "$ref": "#/responses/notFound"
  15756. }
  15757. }
  15758. },
  15759. "put": {
  15760. "consumes": [
  15761. "application/json"
  15762. ],
  15763. "produces": [
  15764. "application/json"
  15765. ],
  15766. "tags": [
  15767. "user"
  15768. ],
  15769. "summary": "Update a user-level variable which is created by current doer",
  15770. "operationId": "updateUserVariable",
  15771. "parameters": [
  15772. {
  15773. "type": "string",
  15774. "description": "name of the variable",
  15775. "name": "variablename",
  15776. "in": "path",
  15777. "required": true
  15778. },
  15779. {
  15780. "name": "body",
  15781. "in": "body",
  15782. "schema": {
  15783. "$ref": "#/definitions/UpdateVariableOption"
  15784. }
  15785. }
  15786. ],
  15787. "responses": {
  15788. "201": {
  15789. "description": "response when updating a variable"
  15790. },
  15791. "204": {
  15792. "description": "response when updating a variable"
  15793. },
  15794. "400": {
  15795. "$ref": "#/responses/error"
  15796. },
  15797. "404": {
  15798. "$ref": "#/responses/notFound"
  15799. }
  15800. }
  15801. },
  15802. "post": {
  15803. "consumes": [
  15804. "application/json"
  15805. ],
  15806. "produces": [
  15807. "application/json"
  15808. ],
  15809. "tags": [
  15810. "user"
  15811. ],
  15812. "summary": "Create a user-level variable",
  15813. "operationId": "createUserVariable",
  15814. "parameters": [
  15815. {
  15816. "type": "string",
  15817. "description": "name of the variable",
  15818. "name": "variablename",
  15819. "in": "path",
  15820. "required": true
  15821. },
  15822. {
  15823. "name": "body",
  15824. "in": "body",
  15825. "schema": {
  15826. "$ref": "#/definitions/CreateVariableOption"
  15827. }
  15828. }
  15829. ],
  15830. "responses": {
  15831. "201": {
  15832. "description": "response when creating a variable"
  15833. },
  15834. "204": {
  15835. "description": "response when creating a variable"
  15836. },
  15837. "400": {
  15838. "$ref": "#/responses/error"
  15839. },
  15840. "404": {
  15841. "$ref": "#/responses/notFound"
  15842. }
  15843. }
  15844. },
  15845. "delete": {
  15846. "produces": [
  15847. "application/json"
  15848. ],
  15849. "tags": [
  15850. "user"
  15851. ],
  15852. "summary": "Delete a user-level variable which is created by current doer",
  15853. "operationId": "deleteUserVariable",
  15854. "parameters": [
  15855. {
  15856. "type": "string",
  15857. "description": "name of the variable",
  15858. "name": "variablename",
  15859. "in": "path",
  15860. "required": true
  15861. }
  15862. ],
  15863. "responses": {
  15864. "201": {
  15865. "description": "response when deleting a variable"
  15866. },
  15867. "204": {
  15868. "description": "response when deleting a variable"
  15869. },
  15870. "400": {
  15871. "$ref": "#/responses/error"
  15872. },
  15873. "404": {
  15874. "$ref": "#/responses/notFound"
  15875. }
  15876. }
  15877. }
  15878. },
  15879. "/user/applications/oauth2": {
  15880. "get": {
  15881. "produces": [
  15882. "application/json"
  15883. ],
  15884. "tags": [
  15885. "user"
  15886. ],
  15887. "summary": "List the authenticated user's oauth2 applications",
  15888. "operationId": "userGetOauth2Application",
  15889. "parameters": [
  15890. {
  15891. "type": "integer",
  15892. "description": "page number of results to return (1-based)",
  15893. "name": "page",
  15894. "in": "query"
  15895. },
  15896. {
  15897. "type": "integer",
  15898. "description": "page size of results",
  15899. "name": "limit",
  15900. "in": "query"
  15901. }
  15902. ],
  15903. "responses": {
  15904. "200": {
  15905. "$ref": "#/responses/OAuth2ApplicationList"
  15906. }
  15907. }
  15908. },
  15909. "post": {
  15910. "produces": [
  15911. "application/json"
  15912. ],
  15913. "tags": [
  15914. "user"
  15915. ],
  15916. "summary": "creates a new OAuth2 application",
  15917. "operationId": "userCreateOAuth2Application",
  15918. "parameters": [
  15919. {
  15920. "name": "body",
  15921. "in": "body",
  15922. "required": true,
  15923. "schema": {
  15924. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  15925. }
  15926. }
  15927. ],
  15928. "responses": {
  15929. "201": {
  15930. "$ref": "#/responses/OAuth2Application"
  15931. },
  15932. "400": {
  15933. "$ref": "#/responses/error"
  15934. }
  15935. }
  15936. }
  15937. },
  15938. "/user/applications/oauth2/{id}": {
  15939. "get": {
  15940. "produces": [
  15941. "application/json"
  15942. ],
  15943. "tags": [
  15944. "user"
  15945. ],
  15946. "summary": "get an OAuth2 Application",
  15947. "operationId": "userGetOAuth2Application",
  15948. "parameters": [
  15949. {
  15950. "type": "integer",
  15951. "format": "int64",
  15952. "description": "Application ID to be found",
  15953. "name": "id",
  15954. "in": "path",
  15955. "required": true
  15956. }
  15957. ],
  15958. "responses": {
  15959. "200": {
  15960. "$ref": "#/responses/OAuth2Application"
  15961. },
  15962. "404": {
  15963. "$ref": "#/responses/notFound"
  15964. }
  15965. }
  15966. },
  15967. "delete": {
  15968. "produces": [
  15969. "application/json"
  15970. ],
  15971. "tags": [
  15972. "user"
  15973. ],
  15974. "summary": "delete an OAuth2 Application",
  15975. "operationId": "userDeleteOAuth2Application",
  15976. "parameters": [
  15977. {
  15978. "type": "integer",
  15979. "format": "int64",
  15980. "description": "token to be deleted",
  15981. "name": "id",
  15982. "in": "path",
  15983. "required": true
  15984. }
  15985. ],
  15986. "responses": {
  15987. "204": {
  15988. "$ref": "#/responses/empty"
  15989. },
  15990. "404": {
  15991. "$ref": "#/responses/notFound"
  15992. }
  15993. }
  15994. },
  15995. "patch": {
  15996. "produces": [
  15997. "application/json"
  15998. ],
  15999. "tags": [
  16000. "user"
  16001. ],
  16002. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  16003. "operationId": "userUpdateOAuth2Application",
  16004. "parameters": [
  16005. {
  16006. "type": "integer",
  16007. "format": "int64",
  16008. "description": "application to be updated",
  16009. "name": "id",
  16010. "in": "path",
  16011. "required": true
  16012. },
  16013. {
  16014. "name": "body",
  16015. "in": "body",
  16016. "required": true,
  16017. "schema": {
  16018. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  16019. }
  16020. }
  16021. ],
  16022. "responses": {
  16023. "200": {
  16024. "$ref": "#/responses/OAuth2Application"
  16025. },
  16026. "404": {
  16027. "$ref": "#/responses/notFound"
  16028. }
  16029. }
  16030. }
  16031. },
  16032. "/user/avatar": {
  16033. "post": {
  16034. "produces": [
  16035. "application/json"
  16036. ],
  16037. "tags": [
  16038. "user"
  16039. ],
  16040. "summary": "Update Avatar",
  16041. "operationId": "userUpdateAvatar",
  16042. "parameters": [
  16043. {
  16044. "name": "body",
  16045. "in": "body",
  16046. "schema": {
  16047. "$ref": "#/definitions/UpdateUserAvatarOption"
  16048. }
  16049. }
  16050. ],
  16051. "responses": {
  16052. "204": {
  16053. "$ref": "#/responses/empty"
  16054. }
  16055. }
  16056. },
  16057. "delete": {
  16058. "produces": [
  16059. "application/json"
  16060. ],
  16061. "tags": [
  16062. "user"
  16063. ],
  16064. "summary": "Delete Avatar",
  16065. "operationId": "userDeleteAvatar",
  16066. "responses": {
  16067. "204": {
  16068. "$ref": "#/responses/empty"
  16069. }
  16070. }
  16071. }
  16072. },
  16073. "/user/blocks": {
  16074. "get": {
  16075. "produces": [
  16076. "application/json"
  16077. ],
  16078. "tags": [
  16079. "user"
  16080. ],
  16081. "summary": "List users blocked by the authenticated user",
  16082. "operationId": "userListBlocks",
  16083. "parameters": [
  16084. {
  16085. "type": "integer",
  16086. "description": "page number of results to return (1-based)",
  16087. "name": "page",
  16088. "in": "query"
  16089. },
  16090. {
  16091. "type": "integer",
  16092. "description": "page size of results",
  16093. "name": "limit",
  16094. "in": "query"
  16095. }
  16096. ],
  16097. "responses": {
  16098. "200": {
  16099. "$ref": "#/responses/UserList"
  16100. }
  16101. }
  16102. }
  16103. },
  16104. "/user/blocks/{username}": {
  16105. "get": {
  16106. "tags": [
  16107. "user"
  16108. ],
  16109. "summary": "Check if a user is blocked by the authenticated user",
  16110. "operationId": "userCheckUserBlock",
  16111. "parameters": [
  16112. {
  16113. "type": "string",
  16114. "description": "user to check",
  16115. "name": "username",
  16116. "in": "path",
  16117. "required": true
  16118. }
  16119. ],
  16120. "responses": {
  16121. "204": {
  16122. "$ref": "#/responses/empty"
  16123. },
  16124. "404": {
  16125. "$ref": "#/responses/notFound"
  16126. }
  16127. }
  16128. },
  16129. "put": {
  16130. "tags": [
  16131. "user"
  16132. ],
  16133. "summary": "Block a user",
  16134. "operationId": "userBlockUser",
  16135. "parameters": [
  16136. {
  16137. "type": "string",
  16138. "description": "user to block",
  16139. "name": "username",
  16140. "in": "path",
  16141. "required": true
  16142. },
  16143. {
  16144. "type": "string",
  16145. "description": "optional note for the block",
  16146. "name": "note",
  16147. "in": "query"
  16148. }
  16149. ],
  16150. "responses": {
  16151. "204": {
  16152. "$ref": "#/responses/empty"
  16153. },
  16154. "404": {
  16155. "$ref": "#/responses/notFound"
  16156. },
  16157. "422": {
  16158. "$ref": "#/responses/validationError"
  16159. }
  16160. }
  16161. },
  16162. "delete": {
  16163. "tags": [
  16164. "user"
  16165. ],
  16166. "summary": "Unblock a user",
  16167. "operationId": "userUnblockUser",
  16168. "parameters": [
  16169. {
  16170. "type": "string",
  16171. "description": "user to unblock",
  16172. "name": "username",
  16173. "in": "path",
  16174. "required": true
  16175. }
  16176. ],
  16177. "responses": {
  16178. "204": {
  16179. "$ref": "#/responses/empty"
  16180. },
  16181. "404": {
  16182. "$ref": "#/responses/notFound"
  16183. },
  16184. "422": {
  16185. "$ref": "#/responses/validationError"
  16186. }
  16187. }
  16188. }
  16189. },
  16190. "/user/emails": {
  16191. "get": {
  16192. "produces": [
  16193. "application/json"
  16194. ],
  16195. "tags": [
  16196. "user"
  16197. ],
  16198. "summary": "List the authenticated user's email addresses",
  16199. "operationId": "userListEmails",
  16200. "responses": {
  16201. "200": {
  16202. "$ref": "#/responses/EmailList"
  16203. }
  16204. }
  16205. },
  16206. "post": {
  16207. "produces": [
  16208. "application/json"
  16209. ],
  16210. "tags": [
  16211. "user"
  16212. ],
  16213. "summary": "Add email addresses",
  16214. "operationId": "userAddEmail",
  16215. "parameters": [
  16216. {
  16217. "name": "body",
  16218. "in": "body",
  16219. "schema": {
  16220. "$ref": "#/definitions/CreateEmailOption"
  16221. }
  16222. }
  16223. ],
  16224. "responses": {
  16225. "201": {
  16226. "$ref": "#/responses/EmailList"
  16227. },
  16228. "422": {
  16229. "$ref": "#/responses/validationError"
  16230. }
  16231. }
  16232. },
  16233. "delete": {
  16234. "produces": [
  16235. "application/json"
  16236. ],
  16237. "tags": [
  16238. "user"
  16239. ],
  16240. "summary": "Delete email addresses",
  16241. "operationId": "userDeleteEmail",
  16242. "parameters": [
  16243. {
  16244. "name": "body",
  16245. "in": "body",
  16246. "schema": {
  16247. "$ref": "#/definitions/DeleteEmailOption"
  16248. }
  16249. }
  16250. ],
  16251. "responses": {
  16252. "204": {
  16253. "$ref": "#/responses/empty"
  16254. },
  16255. "404": {
  16256. "$ref": "#/responses/notFound"
  16257. }
  16258. }
  16259. }
  16260. },
  16261. "/user/followers": {
  16262. "get": {
  16263. "produces": [
  16264. "application/json"
  16265. ],
  16266. "tags": [
  16267. "user"
  16268. ],
  16269. "summary": "List the authenticated user's followers",
  16270. "operationId": "userCurrentListFollowers",
  16271. "parameters": [
  16272. {
  16273. "type": "integer",
  16274. "description": "page number of results to return (1-based)",
  16275. "name": "page",
  16276. "in": "query"
  16277. },
  16278. {
  16279. "type": "integer",
  16280. "description": "page size of results",
  16281. "name": "limit",
  16282. "in": "query"
  16283. }
  16284. ],
  16285. "responses": {
  16286. "200": {
  16287. "$ref": "#/responses/UserList"
  16288. }
  16289. }
  16290. }
  16291. },
  16292. "/user/following": {
  16293. "get": {
  16294. "produces": [
  16295. "application/json"
  16296. ],
  16297. "tags": [
  16298. "user"
  16299. ],
  16300. "summary": "List the users that the authenticated user is following",
  16301. "operationId": "userCurrentListFollowing",
  16302. "parameters": [
  16303. {
  16304. "type": "integer",
  16305. "description": "page number of results to return (1-based)",
  16306. "name": "page",
  16307. "in": "query"
  16308. },
  16309. {
  16310. "type": "integer",
  16311. "description": "page size of results",
  16312. "name": "limit",
  16313. "in": "query"
  16314. }
  16315. ],
  16316. "responses": {
  16317. "200": {
  16318. "$ref": "#/responses/UserList"
  16319. }
  16320. }
  16321. }
  16322. },
  16323. "/user/following/{username}": {
  16324. "get": {
  16325. "tags": [
  16326. "user"
  16327. ],
  16328. "summary": "Check whether a user is followed by the authenticated user",
  16329. "operationId": "userCurrentCheckFollowing",
  16330. "parameters": [
  16331. {
  16332. "type": "string",
  16333. "description": "username of followed user",
  16334. "name": "username",
  16335. "in": "path",
  16336. "required": true
  16337. }
  16338. ],
  16339. "responses": {
  16340. "204": {
  16341. "$ref": "#/responses/empty"
  16342. },
  16343. "404": {
  16344. "$ref": "#/responses/notFound"
  16345. }
  16346. }
  16347. },
  16348. "put": {
  16349. "tags": [
  16350. "user"
  16351. ],
  16352. "summary": "Follow a user",
  16353. "operationId": "userCurrentPutFollow",
  16354. "parameters": [
  16355. {
  16356. "type": "string",
  16357. "description": "username of user to follow",
  16358. "name": "username",
  16359. "in": "path",
  16360. "required": true
  16361. }
  16362. ],
  16363. "responses": {
  16364. "204": {
  16365. "$ref": "#/responses/empty"
  16366. },
  16367. "403": {
  16368. "$ref": "#/responses/forbidden"
  16369. },
  16370. "404": {
  16371. "$ref": "#/responses/notFound"
  16372. }
  16373. }
  16374. },
  16375. "delete": {
  16376. "tags": [
  16377. "user"
  16378. ],
  16379. "summary": "Unfollow a user",
  16380. "operationId": "userCurrentDeleteFollow",
  16381. "parameters": [
  16382. {
  16383. "type": "string",
  16384. "description": "username of user to unfollow",
  16385. "name": "username",
  16386. "in": "path",
  16387. "required": true
  16388. }
  16389. ],
  16390. "responses": {
  16391. "204": {
  16392. "$ref": "#/responses/empty"
  16393. },
  16394. "404": {
  16395. "$ref": "#/responses/notFound"
  16396. }
  16397. }
  16398. }
  16399. },
  16400. "/user/gpg_key_token": {
  16401. "get": {
  16402. "produces": [
  16403. "text/plain"
  16404. ],
  16405. "tags": [
  16406. "user"
  16407. ],
  16408. "summary": "Get a Token to verify",
  16409. "operationId": "getVerificationToken",
  16410. "responses": {
  16411. "200": {
  16412. "$ref": "#/responses/string"
  16413. },
  16414. "404": {
  16415. "$ref": "#/responses/notFound"
  16416. }
  16417. }
  16418. }
  16419. },
  16420. "/user/gpg_key_verify": {
  16421. "post": {
  16422. "consumes": [
  16423. "application/json"
  16424. ],
  16425. "produces": [
  16426. "application/json"
  16427. ],
  16428. "tags": [
  16429. "user"
  16430. ],
  16431. "summary": "Verify a GPG key",
  16432. "operationId": "userVerifyGPGKey",
  16433. "responses": {
  16434. "201": {
  16435. "$ref": "#/responses/GPGKey"
  16436. },
  16437. "404": {
  16438. "$ref": "#/responses/notFound"
  16439. },
  16440. "422": {
  16441. "$ref": "#/responses/validationError"
  16442. }
  16443. }
  16444. }
  16445. },
  16446. "/user/gpg_keys": {
  16447. "get": {
  16448. "produces": [
  16449. "application/json"
  16450. ],
  16451. "tags": [
  16452. "user"
  16453. ],
  16454. "summary": "List the authenticated user's GPG keys",
  16455. "operationId": "userCurrentListGPGKeys",
  16456. "parameters": [
  16457. {
  16458. "type": "integer",
  16459. "description": "page number of results to return (1-based)",
  16460. "name": "page",
  16461. "in": "query"
  16462. },
  16463. {
  16464. "type": "integer",
  16465. "description": "page size of results",
  16466. "name": "limit",
  16467. "in": "query"
  16468. }
  16469. ],
  16470. "responses": {
  16471. "200": {
  16472. "$ref": "#/responses/GPGKeyList"
  16473. }
  16474. }
  16475. },
  16476. "post": {
  16477. "consumes": [
  16478. "application/json"
  16479. ],
  16480. "produces": [
  16481. "application/json"
  16482. ],
  16483. "tags": [
  16484. "user"
  16485. ],
  16486. "summary": "Create a GPG key",
  16487. "operationId": "userCurrentPostGPGKey",
  16488. "parameters": [
  16489. {
  16490. "name": "Form",
  16491. "in": "body",
  16492. "schema": {
  16493. "$ref": "#/definitions/CreateGPGKeyOption"
  16494. }
  16495. }
  16496. ],
  16497. "responses": {
  16498. "201": {
  16499. "$ref": "#/responses/GPGKey"
  16500. },
  16501. "404": {
  16502. "$ref": "#/responses/notFound"
  16503. },
  16504. "422": {
  16505. "$ref": "#/responses/validationError"
  16506. }
  16507. }
  16508. }
  16509. },
  16510. "/user/gpg_keys/{id}": {
  16511. "get": {
  16512. "produces": [
  16513. "application/json"
  16514. ],
  16515. "tags": [
  16516. "user"
  16517. ],
  16518. "summary": "Get a GPG key",
  16519. "operationId": "userCurrentGetGPGKey",
  16520. "parameters": [
  16521. {
  16522. "type": "integer",
  16523. "format": "int64",
  16524. "description": "id of key to get",
  16525. "name": "id",
  16526. "in": "path",
  16527. "required": true
  16528. }
  16529. ],
  16530. "responses": {
  16531. "200": {
  16532. "$ref": "#/responses/GPGKey"
  16533. },
  16534. "404": {
  16535. "$ref": "#/responses/notFound"
  16536. }
  16537. }
  16538. },
  16539. "delete": {
  16540. "produces": [
  16541. "application/json"
  16542. ],
  16543. "tags": [
  16544. "user"
  16545. ],
  16546. "summary": "Remove a GPG key",
  16547. "operationId": "userCurrentDeleteGPGKey",
  16548. "parameters": [
  16549. {
  16550. "type": "integer",
  16551. "format": "int64",
  16552. "description": "id of key to delete",
  16553. "name": "id",
  16554. "in": "path",
  16555. "required": true
  16556. }
  16557. ],
  16558. "responses": {
  16559. "204": {
  16560. "$ref": "#/responses/empty"
  16561. },
  16562. "403": {
  16563. "$ref": "#/responses/forbidden"
  16564. },
  16565. "404": {
  16566. "$ref": "#/responses/notFound"
  16567. }
  16568. }
  16569. }
  16570. },
  16571. "/user/hooks": {
  16572. "get": {
  16573. "produces": [
  16574. "application/json"
  16575. ],
  16576. "tags": [
  16577. "user"
  16578. ],
  16579. "summary": "List the authenticated user's webhooks",
  16580. "operationId": "userListHooks",
  16581. "parameters": [
  16582. {
  16583. "type": "integer",
  16584. "description": "page number of results to return (1-based)",
  16585. "name": "page",
  16586. "in": "query"
  16587. },
  16588. {
  16589. "type": "integer",
  16590. "description": "page size of results",
  16591. "name": "limit",
  16592. "in": "query"
  16593. }
  16594. ],
  16595. "responses": {
  16596. "200": {
  16597. "$ref": "#/responses/HookList"
  16598. }
  16599. }
  16600. },
  16601. "post": {
  16602. "consumes": [
  16603. "application/json"
  16604. ],
  16605. "produces": [
  16606. "application/json"
  16607. ],
  16608. "tags": [
  16609. "user"
  16610. ],
  16611. "summary": "Create a hook",
  16612. "operationId": "userCreateHook",
  16613. "parameters": [
  16614. {
  16615. "name": "body",
  16616. "in": "body",
  16617. "required": true,
  16618. "schema": {
  16619. "$ref": "#/definitions/CreateHookOption"
  16620. }
  16621. }
  16622. ],
  16623. "responses": {
  16624. "201": {
  16625. "$ref": "#/responses/Hook"
  16626. }
  16627. }
  16628. }
  16629. },
  16630. "/user/hooks/{id}": {
  16631. "get": {
  16632. "produces": [
  16633. "application/json"
  16634. ],
  16635. "tags": [
  16636. "user"
  16637. ],
  16638. "summary": "Get a hook",
  16639. "operationId": "userGetHook",
  16640. "parameters": [
  16641. {
  16642. "type": "integer",
  16643. "format": "int64",
  16644. "description": "id of the hook to get",
  16645. "name": "id",
  16646. "in": "path",
  16647. "required": true
  16648. }
  16649. ],
  16650. "responses": {
  16651. "200": {
  16652. "$ref": "#/responses/Hook"
  16653. }
  16654. }
  16655. },
  16656. "delete": {
  16657. "produces": [
  16658. "application/json"
  16659. ],
  16660. "tags": [
  16661. "user"
  16662. ],
  16663. "summary": "Delete a hook",
  16664. "operationId": "userDeleteHook",
  16665. "parameters": [
  16666. {
  16667. "type": "integer",
  16668. "format": "int64",
  16669. "description": "id of the hook to delete",
  16670. "name": "id",
  16671. "in": "path",
  16672. "required": true
  16673. }
  16674. ],
  16675. "responses": {
  16676. "204": {
  16677. "$ref": "#/responses/empty"
  16678. }
  16679. }
  16680. },
  16681. "patch": {
  16682. "consumes": [
  16683. "application/json"
  16684. ],
  16685. "produces": [
  16686. "application/json"
  16687. ],
  16688. "tags": [
  16689. "user"
  16690. ],
  16691. "summary": "Update a hook",
  16692. "operationId": "userEditHook",
  16693. "parameters": [
  16694. {
  16695. "type": "integer",
  16696. "format": "int64",
  16697. "description": "id of the hook to update",
  16698. "name": "id",
  16699. "in": "path",
  16700. "required": true
  16701. },
  16702. {
  16703. "name": "body",
  16704. "in": "body",
  16705. "schema": {
  16706. "$ref": "#/definitions/EditHookOption"
  16707. }
  16708. }
  16709. ],
  16710. "responses": {
  16711. "200": {
  16712. "$ref": "#/responses/Hook"
  16713. }
  16714. }
  16715. }
  16716. },
  16717. "/user/keys": {
  16718. "get": {
  16719. "produces": [
  16720. "application/json"
  16721. ],
  16722. "tags": [
  16723. "user"
  16724. ],
  16725. "summary": "List the authenticated user's public keys",
  16726. "operationId": "userCurrentListKeys",
  16727. "parameters": [
  16728. {
  16729. "type": "string",
  16730. "description": "fingerprint of the key",
  16731. "name": "fingerprint",
  16732. "in": "query"
  16733. },
  16734. {
  16735. "type": "integer",
  16736. "description": "page number of results to return (1-based)",
  16737. "name": "page",
  16738. "in": "query"
  16739. },
  16740. {
  16741. "type": "integer",
  16742. "description": "page size of results",
  16743. "name": "limit",
  16744. "in": "query"
  16745. }
  16746. ],
  16747. "responses": {
  16748. "200": {
  16749. "$ref": "#/responses/PublicKeyList"
  16750. }
  16751. }
  16752. },
  16753. "post": {
  16754. "consumes": [
  16755. "application/json"
  16756. ],
  16757. "produces": [
  16758. "application/json"
  16759. ],
  16760. "tags": [
  16761. "user"
  16762. ],
  16763. "summary": "Create a public key",
  16764. "operationId": "userCurrentPostKey",
  16765. "parameters": [
  16766. {
  16767. "name": "body",
  16768. "in": "body",
  16769. "schema": {
  16770. "$ref": "#/definitions/CreateKeyOption"
  16771. }
  16772. }
  16773. ],
  16774. "responses": {
  16775. "201": {
  16776. "$ref": "#/responses/PublicKey"
  16777. },
  16778. "422": {
  16779. "$ref": "#/responses/validationError"
  16780. }
  16781. }
  16782. }
  16783. },
  16784. "/user/keys/{id}": {
  16785. "get": {
  16786. "produces": [
  16787. "application/json"
  16788. ],
  16789. "tags": [
  16790. "user"
  16791. ],
  16792. "summary": "Get a public key",
  16793. "operationId": "userCurrentGetKey",
  16794. "parameters": [
  16795. {
  16796. "type": "integer",
  16797. "format": "int64",
  16798. "description": "id of key to get",
  16799. "name": "id",
  16800. "in": "path",
  16801. "required": true
  16802. }
  16803. ],
  16804. "responses": {
  16805. "200": {
  16806. "$ref": "#/responses/PublicKey"
  16807. },
  16808. "404": {
  16809. "$ref": "#/responses/notFound"
  16810. }
  16811. }
  16812. },
  16813. "delete": {
  16814. "produces": [
  16815. "application/json"
  16816. ],
  16817. "tags": [
  16818. "user"
  16819. ],
  16820. "summary": "Delete a public key",
  16821. "operationId": "userCurrentDeleteKey",
  16822. "parameters": [
  16823. {
  16824. "type": "integer",
  16825. "format": "int64",
  16826. "description": "id of key to delete",
  16827. "name": "id",
  16828. "in": "path",
  16829. "required": true
  16830. }
  16831. ],
  16832. "responses": {
  16833. "204": {
  16834. "$ref": "#/responses/empty"
  16835. },
  16836. "403": {
  16837. "$ref": "#/responses/forbidden"
  16838. },
  16839. "404": {
  16840. "$ref": "#/responses/notFound"
  16841. }
  16842. }
  16843. }
  16844. },
  16845. "/user/orgs": {
  16846. "get": {
  16847. "produces": [
  16848. "application/json"
  16849. ],
  16850. "tags": [
  16851. "organization"
  16852. ],
  16853. "summary": "List the current user's organizations",
  16854. "operationId": "orgListCurrentUserOrgs",
  16855. "parameters": [
  16856. {
  16857. "type": "integer",
  16858. "description": "page number of results to return (1-based)",
  16859. "name": "page",
  16860. "in": "query"
  16861. },
  16862. {
  16863. "type": "integer",
  16864. "description": "page size of results",
  16865. "name": "limit",
  16866. "in": "query"
  16867. }
  16868. ],
  16869. "responses": {
  16870. "200": {
  16871. "$ref": "#/responses/OrganizationList"
  16872. },
  16873. "404": {
  16874. "$ref": "#/responses/notFound"
  16875. }
  16876. }
  16877. }
  16878. },
  16879. "/user/repos": {
  16880. "get": {
  16881. "produces": [
  16882. "application/json"
  16883. ],
  16884. "tags": [
  16885. "user"
  16886. ],
  16887. "summary": "List the repos that the authenticated user owns",
  16888. "operationId": "userCurrentListRepos",
  16889. "parameters": [
  16890. {
  16891. "type": "integer",
  16892. "description": "page number of results to return (1-based)",
  16893. "name": "page",
  16894. "in": "query"
  16895. },
  16896. {
  16897. "type": "integer",
  16898. "description": "page size of results",
  16899. "name": "limit",
  16900. "in": "query"
  16901. }
  16902. ],
  16903. "responses": {
  16904. "200": {
  16905. "$ref": "#/responses/RepositoryList"
  16906. }
  16907. }
  16908. },
  16909. "post": {
  16910. "consumes": [
  16911. "application/json"
  16912. ],
  16913. "produces": [
  16914. "application/json"
  16915. ],
  16916. "tags": [
  16917. "repository",
  16918. "user"
  16919. ],
  16920. "summary": "Create a repository",
  16921. "operationId": "createCurrentUserRepo",
  16922. "parameters": [
  16923. {
  16924. "name": "body",
  16925. "in": "body",
  16926. "schema": {
  16927. "$ref": "#/definitions/CreateRepoOption"
  16928. }
  16929. }
  16930. ],
  16931. "responses": {
  16932. "201": {
  16933. "$ref": "#/responses/Repository"
  16934. },
  16935. "400": {
  16936. "$ref": "#/responses/error"
  16937. },
  16938. "409": {
  16939. "description": "The repository with the same name already exists."
  16940. },
  16941. "422": {
  16942. "$ref": "#/responses/validationError"
  16943. }
  16944. }
  16945. }
  16946. },
  16947. "/user/settings": {
  16948. "get": {
  16949. "produces": [
  16950. "application/json"
  16951. ],
  16952. "tags": [
  16953. "user"
  16954. ],
  16955. "summary": "Get user settings",
  16956. "operationId": "getUserSettings",
  16957. "responses": {
  16958. "200": {
  16959. "$ref": "#/responses/UserSettings"
  16960. }
  16961. }
  16962. },
  16963. "patch": {
  16964. "produces": [
  16965. "application/json"
  16966. ],
  16967. "tags": [
  16968. "user"
  16969. ],
  16970. "summary": "Update user settings",
  16971. "operationId": "updateUserSettings",
  16972. "parameters": [
  16973. {
  16974. "name": "body",
  16975. "in": "body",
  16976. "schema": {
  16977. "$ref": "#/definitions/UserSettingsOptions"
  16978. }
  16979. }
  16980. ],
  16981. "responses": {
  16982. "200": {
  16983. "$ref": "#/responses/UserSettings"
  16984. }
  16985. }
  16986. }
  16987. },
  16988. "/user/starred": {
  16989. "get": {
  16990. "produces": [
  16991. "application/json"
  16992. ],
  16993. "tags": [
  16994. "user"
  16995. ],
  16996. "summary": "The repos that the authenticated user has starred",
  16997. "operationId": "userCurrentListStarred",
  16998. "parameters": [
  16999. {
  17000. "type": "integer",
  17001. "description": "page number of results to return (1-based)",
  17002. "name": "page",
  17003. "in": "query"
  17004. },
  17005. {
  17006. "type": "integer",
  17007. "description": "page size of results",
  17008. "name": "limit",
  17009. "in": "query"
  17010. }
  17011. ],
  17012. "responses": {
  17013. "200": {
  17014. "$ref": "#/responses/RepositoryList"
  17015. }
  17016. }
  17017. }
  17018. },
  17019. "/user/starred/{owner}/{repo}": {
  17020. "get": {
  17021. "tags": [
  17022. "user"
  17023. ],
  17024. "summary": "Whether the authenticated is starring the repo",
  17025. "operationId": "userCurrentCheckStarring",
  17026. "parameters": [
  17027. {
  17028. "type": "string",
  17029. "description": "owner of the repo",
  17030. "name": "owner",
  17031. "in": "path",
  17032. "required": true
  17033. },
  17034. {
  17035. "type": "string",
  17036. "description": "name of the repo",
  17037. "name": "repo",
  17038. "in": "path",
  17039. "required": true
  17040. }
  17041. ],
  17042. "responses": {
  17043. "204": {
  17044. "$ref": "#/responses/empty"
  17045. },
  17046. "404": {
  17047. "$ref": "#/responses/notFound"
  17048. }
  17049. }
  17050. },
  17051. "put": {
  17052. "tags": [
  17053. "user"
  17054. ],
  17055. "summary": "Star the given repo",
  17056. "operationId": "userCurrentPutStar",
  17057. "parameters": [
  17058. {
  17059. "type": "string",
  17060. "description": "owner of the repo to star",
  17061. "name": "owner",
  17062. "in": "path",
  17063. "required": true
  17064. },
  17065. {
  17066. "type": "string",
  17067. "description": "name of the repo to star",
  17068. "name": "repo",
  17069. "in": "path",
  17070. "required": true
  17071. }
  17072. ],
  17073. "responses": {
  17074. "204": {
  17075. "$ref": "#/responses/empty"
  17076. },
  17077. "403": {
  17078. "$ref": "#/responses/forbidden"
  17079. },
  17080. "404": {
  17081. "$ref": "#/responses/notFound"
  17082. }
  17083. }
  17084. },
  17085. "delete": {
  17086. "tags": [
  17087. "user"
  17088. ],
  17089. "summary": "Unstar the given repo",
  17090. "operationId": "userCurrentDeleteStar",
  17091. "parameters": [
  17092. {
  17093. "type": "string",
  17094. "description": "owner of the repo to unstar",
  17095. "name": "owner",
  17096. "in": "path",
  17097. "required": true
  17098. },
  17099. {
  17100. "type": "string",
  17101. "description": "name of the repo to unstar",
  17102. "name": "repo",
  17103. "in": "path",
  17104. "required": true
  17105. }
  17106. ],
  17107. "responses": {
  17108. "204": {
  17109. "$ref": "#/responses/empty"
  17110. },
  17111. "404": {
  17112. "$ref": "#/responses/notFound"
  17113. }
  17114. }
  17115. }
  17116. },
  17117. "/user/stopwatches": {
  17118. "get": {
  17119. "consumes": [
  17120. "application/json"
  17121. ],
  17122. "produces": [
  17123. "application/json"
  17124. ],
  17125. "tags": [
  17126. "user"
  17127. ],
  17128. "summary": "Get list of all existing stopwatches",
  17129. "operationId": "userGetStopWatches",
  17130. "parameters": [
  17131. {
  17132. "type": "integer",
  17133. "description": "page number of results to return (1-based)",
  17134. "name": "page",
  17135. "in": "query"
  17136. },
  17137. {
  17138. "type": "integer",
  17139. "description": "page size of results",
  17140. "name": "limit",
  17141. "in": "query"
  17142. }
  17143. ],
  17144. "responses": {
  17145. "200": {
  17146. "$ref": "#/responses/StopWatchList"
  17147. }
  17148. }
  17149. }
  17150. },
  17151. "/user/subscriptions": {
  17152. "get": {
  17153. "produces": [
  17154. "application/json"
  17155. ],
  17156. "tags": [
  17157. "user"
  17158. ],
  17159. "summary": "List repositories watched by the authenticated user",
  17160. "operationId": "userCurrentListSubscriptions",
  17161. "parameters": [
  17162. {
  17163. "type": "integer",
  17164. "description": "page number of results to return (1-based)",
  17165. "name": "page",
  17166. "in": "query"
  17167. },
  17168. {
  17169. "type": "integer",
  17170. "description": "page size of results",
  17171. "name": "limit",
  17172. "in": "query"
  17173. }
  17174. ],
  17175. "responses": {
  17176. "200": {
  17177. "$ref": "#/responses/RepositoryList"
  17178. }
  17179. }
  17180. }
  17181. },
  17182. "/user/teams": {
  17183. "get": {
  17184. "produces": [
  17185. "application/json"
  17186. ],
  17187. "tags": [
  17188. "user"
  17189. ],
  17190. "summary": "List all the teams a user belongs to",
  17191. "operationId": "userListTeams",
  17192. "parameters": [
  17193. {
  17194. "type": "integer",
  17195. "description": "page number of results to return (1-based)",
  17196. "name": "page",
  17197. "in": "query"
  17198. },
  17199. {
  17200. "type": "integer",
  17201. "description": "page size of results",
  17202. "name": "limit",
  17203. "in": "query"
  17204. }
  17205. ],
  17206. "responses": {
  17207. "200": {
  17208. "$ref": "#/responses/TeamList"
  17209. }
  17210. }
  17211. }
  17212. },
  17213. "/user/times": {
  17214. "get": {
  17215. "produces": [
  17216. "application/json"
  17217. ],
  17218. "tags": [
  17219. "user"
  17220. ],
  17221. "summary": "List the current user's tracked times",
  17222. "operationId": "userCurrentTrackedTimes",
  17223. "parameters": [
  17224. {
  17225. "type": "integer",
  17226. "description": "page number of results to return (1-based)",
  17227. "name": "page",
  17228. "in": "query"
  17229. },
  17230. {
  17231. "type": "integer",
  17232. "description": "page size of results",
  17233. "name": "limit",
  17234. "in": "query"
  17235. },
  17236. {
  17237. "type": "string",
  17238. "format": "date-time",
  17239. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  17240. "name": "since",
  17241. "in": "query"
  17242. },
  17243. {
  17244. "type": "string",
  17245. "format": "date-time",
  17246. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  17247. "name": "before",
  17248. "in": "query"
  17249. }
  17250. ],
  17251. "responses": {
  17252. "200": {
  17253. "$ref": "#/responses/TrackedTimeList"
  17254. }
  17255. }
  17256. }
  17257. },
  17258. "/users/search": {
  17259. "get": {
  17260. "produces": [
  17261. "application/json"
  17262. ],
  17263. "tags": [
  17264. "user"
  17265. ],
  17266. "summary": "Search for users",
  17267. "operationId": "userSearch",
  17268. "parameters": [
  17269. {
  17270. "type": "string",
  17271. "description": "keyword",
  17272. "name": "q",
  17273. "in": "query"
  17274. },
  17275. {
  17276. "type": "integer",
  17277. "format": "int64",
  17278. "description": "ID of the user to search for",
  17279. "name": "uid",
  17280. "in": "query"
  17281. },
  17282. {
  17283. "type": "integer",
  17284. "description": "page number of results to return (1-based)",
  17285. "name": "page",
  17286. "in": "query"
  17287. },
  17288. {
  17289. "type": "integer",
  17290. "description": "page size of results",
  17291. "name": "limit",
  17292. "in": "query"
  17293. }
  17294. ],
  17295. "responses": {
  17296. "200": {
  17297. "description": "SearchResults of a successful search",
  17298. "schema": {
  17299. "type": "object",
  17300. "properties": {
  17301. "data": {
  17302. "type": "array",
  17303. "items": {
  17304. "$ref": "#/definitions/User"
  17305. }
  17306. },
  17307. "ok": {
  17308. "type": "boolean"
  17309. }
  17310. }
  17311. }
  17312. }
  17313. }
  17314. }
  17315. },
  17316. "/users/{username}": {
  17317. "get": {
  17318. "produces": [
  17319. "application/json"
  17320. ],
  17321. "tags": [
  17322. "user"
  17323. ],
  17324. "summary": "Get a user",
  17325. "operationId": "userGet",
  17326. "parameters": [
  17327. {
  17328. "type": "string",
  17329. "description": "username of user to get",
  17330. "name": "username",
  17331. "in": "path",
  17332. "required": true
  17333. }
  17334. ],
  17335. "responses": {
  17336. "200": {
  17337. "$ref": "#/responses/User"
  17338. },
  17339. "404": {
  17340. "$ref": "#/responses/notFound"
  17341. }
  17342. }
  17343. }
  17344. },
  17345. "/users/{username}/activities/feeds": {
  17346. "get": {
  17347. "produces": [
  17348. "application/json"
  17349. ],
  17350. "tags": [
  17351. "user"
  17352. ],
  17353. "summary": "List a user's activity feeds",
  17354. "operationId": "userListActivityFeeds",
  17355. "parameters": [
  17356. {
  17357. "type": "string",
  17358. "description": "username of user",
  17359. "name": "username",
  17360. "in": "path",
  17361. "required": true
  17362. },
  17363. {
  17364. "type": "boolean",
  17365. "description": "if true, only show actions performed by the requested user",
  17366. "name": "only-performed-by",
  17367. "in": "query"
  17368. },
  17369. {
  17370. "type": "string",
  17371. "format": "date",
  17372. "description": "the date of the activities to be found",
  17373. "name": "date",
  17374. "in": "query"
  17375. },
  17376. {
  17377. "type": "integer",
  17378. "description": "page number of results to return (1-based)",
  17379. "name": "page",
  17380. "in": "query"
  17381. },
  17382. {
  17383. "type": "integer",
  17384. "description": "page size of results",
  17385. "name": "limit",
  17386. "in": "query"
  17387. }
  17388. ],
  17389. "responses": {
  17390. "200": {
  17391. "$ref": "#/responses/ActivityFeedsList"
  17392. },
  17393. "404": {
  17394. "$ref": "#/responses/notFound"
  17395. }
  17396. }
  17397. }
  17398. },
  17399. "/users/{username}/followers": {
  17400. "get": {
  17401. "produces": [
  17402. "application/json"
  17403. ],
  17404. "tags": [
  17405. "user"
  17406. ],
  17407. "summary": "List the given user's followers",
  17408. "operationId": "userListFollowers",
  17409. "parameters": [
  17410. {
  17411. "type": "string",
  17412. "description": "username of user",
  17413. "name": "username",
  17414. "in": "path",
  17415. "required": true
  17416. },
  17417. {
  17418. "type": "integer",
  17419. "description": "page number of results to return (1-based)",
  17420. "name": "page",
  17421. "in": "query"
  17422. },
  17423. {
  17424. "type": "integer",
  17425. "description": "page size of results",
  17426. "name": "limit",
  17427. "in": "query"
  17428. }
  17429. ],
  17430. "responses": {
  17431. "200": {
  17432. "$ref": "#/responses/UserList"
  17433. },
  17434. "404": {
  17435. "$ref": "#/responses/notFound"
  17436. }
  17437. }
  17438. }
  17439. },
  17440. "/users/{username}/following": {
  17441. "get": {
  17442. "produces": [
  17443. "application/json"
  17444. ],
  17445. "tags": [
  17446. "user"
  17447. ],
  17448. "summary": "List the users that the given user is following",
  17449. "operationId": "userListFollowing",
  17450. "parameters": [
  17451. {
  17452. "type": "string",
  17453. "description": "username of user",
  17454. "name": "username",
  17455. "in": "path",
  17456. "required": true
  17457. },
  17458. {
  17459. "type": "integer",
  17460. "description": "page number of results to return (1-based)",
  17461. "name": "page",
  17462. "in": "query"
  17463. },
  17464. {
  17465. "type": "integer",
  17466. "description": "page size of results",
  17467. "name": "limit",
  17468. "in": "query"
  17469. }
  17470. ],
  17471. "responses": {
  17472. "200": {
  17473. "$ref": "#/responses/UserList"
  17474. },
  17475. "404": {
  17476. "$ref": "#/responses/notFound"
  17477. }
  17478. }
  17479. }
  17480. },
  17481. "/users/{username}/following/{target}": {
  17482. "get": {
  17483. "tags": [
  17484. "user"
  17485. ],
  17486. "summary": "Check if one user is following another user",
  17487. "operationId": "userCheckFollowing",
  17488. "parameters": [
  17489. {
  17490. "type": "string",
  17491. "description": "username of following user",
  17492. "name": "username",
  17493. "in": "path",
  17494. "required": true
  17495. },
  17496. {
  17497. "type": "string",
  17498. "description": "username of followed user",
  17499. "name": "target",
  17500. "in": "path",
  17501. "required": true
  17502. }
  17503. ],
  17504. "responses": {
  17505. "204": {
  17506. "$ref": "#/responses/empty"
  17507. },
  17508. "404": {
  17509. "$ref": "#/responses/notFound"
  17510. }
  17511. }
  17512. }
  17513. },
  17514. "/users/{username}/gpg_keys": {
  17515. "get": {
  17516. "produces": [
  17517. "application/json"
  17518. ],
  17519. "tags": [
  17520. "user"
  17521. ],
  17522. "summary": "List the given user's GPG keys",
  17523. "operationId": "userListGPGKeys",
  17524. "parameters": [
  17525. {
  17526. "type": "string",
  17527. "description": "username of user",
  17528. "name": "username",
  17529. "in": "path",
  17530. "required": true
  17531. },
  17532. {
  17533. "type": "integer",
  17534. "description": "page number of results to return (1-based)",
  17535. "name": "page",
  17536. "in": "query"
  17537. },
  17538. {
  17539. "type": "integer",
  17540. "description": "page size of results",
  17541. "name": "limit",
  17542. "in": "query"
  17543. }
  17544. ],
  17545. "responses": {
  17546. "200": {
  17547. "$ref": "#/responses/GPGKeyList"
  17548. },
  17549. "404": {
  17550. "$ref": "#/responses/notFound"
  17551. }
  17552. }
  17553. }
  17554. },
  17555. "/users/{username}/heatmap": {
  17556. "get": {
  17557. "produces": [
  17558. "application/json"
  17559. ],
  17560. "tags": [
  17561. "user"
  17562. ],
  17563. "summary": "Get a user's heatmap",
  17564. "operationId": "userGetHeatmapData",
  17565. "parameters": [
  17566. {
  17567. "type": "string",
  17568. "description": "username of user to get",
  17569. "name": "username",
  17570. "in": "path",
  17571. "required": true
  17572. }
  17573. ],
  17574. "responses": {
  17575. "200": {
  17576. "$ref": "#/responses/UserHeatmapData"
  17577. },
  17578. "404": {
  17579. "$ref": "#/responses/notFound"
  17580. }
  17581. }
  17582. }
  17583. },
  17584. "/users/{username}/keys": {
  17585. "get": {
  17586. "produces": [
  17587. "application/json"
  17588. ],
  17589. "tags": [
  17590. "user"
  17591. ],
  17592. "summary": "List the given user's public keys",
  17593. "operationId": "userListKeys",
  17594. "parameters": [
  17595. {
  17596. "type": "string",
  17597. "description": "username of user",
  17598. "name": "username",
  17599. "in": "path",
  17600. "required": true
  17601. },
  17602. {
  17603. "type": "string",
  17604. "description": "fingerprint of the key",
  17605. "name": "fingerprint",
  17606. "in": "query"
  17607. },
  17608. {
  17609. "type": "integer",
  17610. "description": "page number of results to return (1-based)",
  17611. "name": "page",
  17612. "in": "query"
  17613. },
  17614. {
  17615. "type": "integer",
  17616. "description": "page size of results",
  17617. "name": "limit",
  17618. "in": "query"
  17619. }
  17620. ],
  17621. "responses": {
  17622. "200": {
  17623. "$ref": "#/responses/PublicKeyList"
  17624. },
  17625. "404": {
  17626. "$ref": "#/responses/notFound"
  17627. }
  17628. }
  17629. }
  17630. },
  17631. "/users/{username}/orgs": {
  17632. "get": {
  17633. "produces": [
  17634. "application/json"
  17635. ],
  17636. "tags": [
  17637. "organization"
  17638. ],
  17639. "summary": "List a user's organizations",
  17640. "operationId": "orgListUserOrgs",
  17641. "parameters": [
  17642. {
  17643. "type": "string",
  17644. "description": "username of user",
  17645. "name": "username",
  17646. "in": "path",
  17647. "required": true
  17648. },
  17649. {
  17650. "type": "integer",
  17651. "description": "page number of results to return (1-based)",
  17652. "name": "page",
  17653. "in": "query"
  17654. },
  17655. {
  17656. "type": "integer",
  17657. "description": "page size of results",
  17658. "name": "limit",
  17659. "in": "query"
  17660. }
  17661. ],
  17662. "responses": {
  17663. "200": {
  17664. "$ref": "#/responses/OrganizationList"
  17665. },
  17666. "404": {
  17667. "$ref": "#/responses/notFound"
  17668. }
  17669. }
  17670. }
  17671. },
  17672. "/users/{username}/orgs/{org}/permissions": {
  17673. "get": {
  17674. "produces": [
  17675. "application/json"
  17676. ],
  17677. "tags": [
  17678. "organization"
  17679. ],
  17680. "summary": "Get user permissions in organization",
  17681. "operationId": "orgGetUserPermissions",
  17682. "parameters": [
  17683. {
  17684. "type": "string",
  17685. "description": "username of user",
  17686. "name": "username",
  17687. "in": "path",
  17688. "required": true
  17689. },
  17690. {
  17691. "type": "string",
  17692. "description": "name of the organization",
  17693. "name": "org",
  17694. "in": "path",
  17695. "required": true
  17696. }
  17697. ],
  17698. "responses": {
  17699. "200": {
  17700. "$ref": "#/responses/OrganizationPermissions"
  17701. },
  17702. "403": {
  17703. "$ref": "#/responses/forbidden"
  17704. },
  17705. "404": {
  17706. "$ref": "#/responses/notFound"
  17707. }
  17708. }
  17709. }
  17710. },
  17711. "/users/{username}/repos": {
  17712. "get": {
  17713. "produces": [
  17714. "application/json"
  17715. ],
  17716. "tags": [
  17717. "user"
  17718. ],
  17719. "summary": "List the repos owned by the given user",
  17720. "operationId": "userListRepos",
  17721. "parameters": [
  17722. {
  17723. "type": "string",
  17724. "description": "username of user",
  17725. "name": "username",
  17726. "in": "path",
  17727. "required": true
  17728. },
  17729. {
  17730. "type": "integer",
  17731. "description": "page number of results to return (1-based)",
  17732. "name": "page",
  17733. "in": "query"
  17734. },
  17735. {
  17736. "type": "integer",
  17737. "description": "page size of results",
  17738. "name": "limit",
  17739. "in": "query"
  17740. }
  17741. ],
  17742. "responses": {
  17743. "200": {
  17744. "$ref": "#/responses/RepositoryList"
  17745. },
  17746. "404": {
  17747. "$ref": "#/responses/notFound"
  17748. }
  17749. }
  17750. }
  17751. },
  17752. "/users/{username}/starred": {
  17753. "get": {
  17754. "produces": [
  17755. "application/json"
  17756. ],
  17757. "tags": [
  17758. "user"
  17759. ],
  17760. "summary": "The repos that the given user has starred",
  17761. "operationId": "userListStarred",
  17762. "parameters": [
  17763. {
  17764. "type": "string",
  17765. "description": "username of user",
  17766. "name": "username",
  17767. "in": "path",
  17768. "required": true
  17769. },
  17770. {
  17771. "type": "integer",
  17772. "description": "page number of results to return (1-based)",
  17773. "name": "page",
  17774. "in": "query"
  17775. },
  17776. {
  17777. "type": "integer",
  17778. "description": "page size of results",
  17779. "name": "limit",
  17780. "in": "query"
  17781. }
  17782. ],
  17783. "responses": {
  17784. "200": {
  17785. "$ref": "#/responses/RepositoryList"
  17786. },
  17787. "404": {
  17788. "$ref": "#/responses/notFound"
  17789. }
  17790. }
  17791. }
  17792. },
  17793. "/users/{username}/subscriptions": {
  17794. "get": {
  17795. "produces": [
  17796. "application/json"
  17797. ],
  17798. "tags": [
  17799. "user"
  17800. ],
  17801. "summary": "List the repositories watched by a user",
  17802. "operationId": "userListSubscriptions",
  17803. "parameters": [
  17804. {
  17805. "type": "string",
  17806. "description": "username of the user",
  17807. "name": "username",
  17808. "in": "path",
  17809. "required": true
  17810. },
  17811. {
  17812. "type": "integer",
  17813. "description": "page number of results to return (1-based)",
  17814. "name": "page",
  17815. "in": "query"
  17816. },
  17817. {
  17818. "type": "integer",
  17819. "description": "page size of results",
  17820. "name": "limit",
  17821. "in": "query"
  17822. }
  17823. ],
  17824. "responses": {
  17825. "200": {
  17826. "$ref": "#/responses/RepositoryList"
  17827. },
  17828. "404": {
  17829. "$ref": "#/responses/notFound"
  17830. }
  17831. }
  17832. }
  17833. },
  17834. "/users/{username}/tokens": {
  17835. "get": {
  17836. "produces": [
  17837. "application/json"
  17838. ],
  17839. "tags": [
  17840. "user"
  17841. ],
  17842. "summary": "List the authenticated user's access tokens",
  17843. "operationId": "userGetTokens",
  17844. "parameters": [
  17845. {
  17846. "type": "string",
  17847. "description": "username of user",
  17848. "name": "username",
  17849. "in": "path",
  17850. "required": true
  17851. },
  17852. {
  17853. "type": "integer",
  17854. "description": "page number of results to return (1-based)",
  17855. "name": "page",
  17856. "in": "query"
  17857. },
  17858. {
  17859. "type": "integer",
  17860. "description": "page size of results",
  17861. "name": "limit",
  17862. "in": "query"
  17863. }
  17864. ],
  17865. "responses": {
  17866. "200": {
  17867. "$ref": "#/responses/AccessTokenList"
  17868. },
  17869. "403": {
  17870. "$ref": "#/responses/forbidden"
  17871. }
  17872. }
  17873. },
  17874. "post": {
  17875. "consumes": [
  17876. "application/json"
  17877. ],
  17878. "produces": [
  17879. "application/json"
  17880. ],
  17881. "tags": [
  17882. "user"
  17883. ],
  17884. "summary": "Create an access token",
  17885. "operationId": "userCreateToken",
  17886. "parameters": [
  17887. {
  17888. "type": "string",
  17889. "description": "username of user",
  17890. "name": "username",
  17891. "in": "path",
  17892. "required": true
  17893. },
  17894. {
  17895. "name": "body",
  17896. "in": "body",
  17897. "schema": {
  17898. "$ref": "#/definitions/CreateAccessTokenOption"
  17899. }
  17900. }
  17901. ],
  17902. "responses": {
  17903. "201": {
  17904. "$ref": "#/responses/AccessToken"
  17905. },
  17906. "400": {
  17907. "$ref": "#/responses/error"
  17908. },
  17909. "403": {
  17910. "$ref": "#/responses/forbidden"
  17911. }
  17912. }
  17913. }
  17914. },
  17915. "/users/{username}/tokens/{token}": {
  17916. "delete": {
  17917. "produces": [
  17918. "application/json"
  17919. ],
  17920. "tags": [
  17921. "user"
  17922. ],
  17923. "summary": "delete an access token",
  17924. "operationId": "userDeleteAccessToken",
  17925. "parameters": [
  17926. {
  17927. "type": "string",
  17928. "description": "username of user",
  17929. "name": "username",
  17930. "in": "path",
  17931. "required": true
  17932. },
  17933. {
  17934. "type": "string",
  17935. "description": "token to be deleted, identified by ID and if not available by name",
  17936. "name": "token",
  17937. "in": "path",
  17938. "required": true
  17939. }
  17940. ],
  17941. "responses": {
  17942. "204": {
  17943. "$ref": "#/responses/empty"
  17944. },
  17945. "403": {
  17946. "$ref": "#/responses/forbidden"
  17947. },
  17948. "404": {
  17949. "$ref": "#/responses/notFound"
  17950. },
  17951. "422": {
  17952. "$ref": "#/responses/error"
  17953. }
  17954. }
  17955. }
  17956. },
  17957. "/version": {
  17958. "get": {
  17959. "produces": [
  17960. "application/json"
  17961. ],
  17962. "tags": [
  17963. "miscellaneous"
  17964. ],
  17965. "summary": "Returns the version of the Gitea application",
  17966. "operationId": "getVersion",
  17967. "responses": {
  17968. "200": {
  17969. "$ref": "#/responses/ServerVersion"
  17970. }
  17971. }
  17972. }
  17973. }
  17974. },
  17975. "definitions": {
  17976. "APIError": {
  17977. "description": "APIError is an api error with a message",
  17978. "type": "object",
  17979. "properties": {
  17980. "message": {
  17981. "type": "string",
  17982. "x-go-name": "Message"
  17983. },
  17984. "url": {
  17985. "type": "string",
  17986. "x-go-name": "URL"
  17987. }
  17988. },
  17989. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17990. },
  17991. "AccessToken": {
  17992. "type": "object",
  17993. "title": "AccessToken represents an API access token.",
  17994. "properties": {
  17995. "id": {
  17996. "type": "integer",
  17997. "format": "int64",
  17998. "x-go-name": "ID"
  17999. },
  18000. "name": {
  18001. "type": "string",
  18002. "x-go-name": "Name"
  18003. },
  18004. "scopes": {
  18005. "type": "array",
  18006. "items": {
  18007. "type": "string"
  18008. },
  18009. "x-go-name": "Scopes"
  18010. },
  18011. "sha1": {
  18012. "type": "string",
  18013. "x-go-name": "Token"
  18014. },
  18015. "token_last_eight": {
  18016. "type": "string",
  18017. "x-go-name": "TokenLastEight"
  18018. }
  18019. },
  18020. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18021. },
  18022. "ActionTask": {
  18023. "description": "ActionTask represents a ActionTask",
  18024. "type": "object",
  18025. "properties": {
  18026. "created_at": {
  18027. "type": "string",
  18028. "format": "date-time",
  18029. "x-go-name": "CreatedAt"
  18030. },
  18031. "display_title": {
  18032. "type": "string",
  18033. "x-go-name": "DisplayTitle"
  18034. },
  18035. "event": {
  18036. "type": "string",
  18037. "x-go-name": "Event"
  18038. },
  18039. "head_branch": {
  18040. "type": "string",
  18041. "x-go-name": "HeadBranch"
  18042. },
  18043. "head_sha": {
  18044. "type": "string",
  18045. "x-go-name": "HeadSHA"
  18046. },
  18047. "id": {
  18048. "type": "integer",
  18049. "format": "int64",
  18050. "x-go-name": "ID"
  18051. },
  18052. "name": {
  18053. "type": "string",
  18054. "x-go-name": "Name"
  18055. },
  18056. "run_number": {
  18057. "type": "integer",
  18058. "format": "int64",
  18059. "x-go-name": "RunNumber"
  18060. },
  18061. "run_started_at": {
  18062. "type": "string",
  18063. "format": "date-time",
  18064. "x-go-name": "RunStartedAt"
  18065. },
  18066. "status": {
  18067. "type": "string",
  18068. "x-go-name": "Status"
  18069. },
  18070. "updated_at": {
  18071. "type": "string",
  18072. "format": "date-time",
  18073. "x-go-name": "UpdatedAt"
  18074. },
  18075. "url": {
  18076. "type": "string",
  18077. "x-go-name": "URL"
  18078. },
  18079. "workflow_id": {
  18080. "type": "string",
  18081. "x-go-name": "WorkflowID"
  18082. }
  18083. },
  18084. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18085. },
  18086. "ActionTaskResponse": {
  18087. "description": "ActionTaskResponse returns a ActionTask",
  18088. "type": "object",
  18089. "properties": {
  18090. "total_count": {
  18091. "type": "integer",
  18092. "format": "int64",
  18093. "x-go-name": "TotalCount"
  18094. },
  18095. "workflow_runs": {
  18096. "type": "array",
  18097. "items": {
  18098. "$ref": "#/definitions/ActionTask"
  18099. },
  18100. "x-go-name": "Entries"
  18101. }
  18102. },
  18103. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18104. },
  18105. "ActionVariable": {
  18106. "description": "ActionVariable return value of the query API",
  18107. "type": "object",
  18108. "properties": {
  18109. "data": {
  18110. "description": "the value of the variable",
  18111. "type": "string",
  18112. "x-go-name": "Data"
  18113. },
  18114. "name": {
  18115. "description": "the name of the variable",
  18116. "type": "string",
  18117. "x-go-name": "Name"
  18118. },
  18119. "owner_id": {
  18120. "description": "the owner to which the variable belongs",
  18121. "type": "integer",
  18122. "format": "int64",
  18123. "x-go-name": "OwnerID"
  18124. },
  18125. "repo_id": {
  18126. "description": "the repository to which the variable belongs",
  18127. "type": "integer",
  18128. "format": "int64",
  18129. "x-go-name": "RepoID"
  18130. }
  18131. },
  18132. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18133. },
  18134. "Activity": {
  18135. "type": "object",
  18136. "properties": {
  18137. "act_user": {
  18138. "$ref": "#/definitions/User"
  18139. },
  18140. "act_user_id": {
  18141. "type": "integer",
  18142. "format": "int64",
  18143. "x-go-name": "ActUserID"
  18144. },
  18145. "comment": {
  18146. "$ref": "#/definitions/Comment"
  18147. },
  18148. "comment_id": {
  18149. "type": "integer",
  18150. "format": "int64",
  18151. "x-go-name": "CommentID"
  18152. },
  18153. "content": {
  18154. "type": "string",
  18155. "x-go-name": "Content"
  18156. },
  18157. "created": {
  18158. "type": "string",
  18159. "format": "date-time",
  18160. "x-go-name": "Created"
  18161. },
  18162. "id": {
  18163. "type": "integer",
  18164. "format": "int64",
  18165. "x-go-name": "ID"
  18166. },
  18167. "is_private": {
  18168. "type": "boolean",
  18169. "x-go-name": "IsPrivate"
  18170. },
  18171. "op_type": {
  18172. "type": "string",
  18173. "x-go-name": "OpType"
  18174. },
  18175. "ref_name": {
  18176. "type": "string",
  18177. "x-go-name": "RefName"
  18178. },
  18179. "repo": {
  18180. "$ref": "#/definitions/Repository"
  18181. },
  18182. "repo_id": {
  18183. "type": "integer",
  18184. "format": "int64",
  18185. "x-go-name": "RepoID"
  18186. },
  18187. "user_id": {
  18188. "type": "integer",
  18189. "format": "int64",
  18190. "x-go-name": "UserID"
  18191. }
  18192. },
  18193. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18194. },
  18195. "ActivityPub": {
  18196. "description": "ActivityPub type",
  18197. "type": "object",
  18198. "properties": {
  18199. "@context": {
  18200. "type": "string",
  18201. "x-go-name": "Context"
  18202. }
  18203. },
  18204. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18205. },
  18206. "AddCollaboratorOption": {
  18207. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  18208. "type": "object",
  18209. "properties": {
  18210. "permission": {
  18211. "type": "string",
  18212. "x-go-name": "Permission"
  18213. }
  18214. },
  18215. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18216. },
  18217. "AddTimeOption": {
  18218. "description": "AddTimeOption options for adding time to an issue",
  18219. "type": "object",
  18220. "required": [
  18221. "time"
  18222. ],
  18223. "properties": {
  18224. "created": {
  18225. "type": "string",
  18226. "format": "date-time",
  18227. "x-go-name": "Created"
  18228. },
  18229. "time": {
  18230. "description": "time in seconds",
  18231. "type": "integer",
  18232. "format": "int64",
  18233. "x-go-name": "Time"
  18234. },
  18235. "user_name": {
  18236. "description": "User who spent the time (optional)",
  18237. "type": "string",
  18238. "x-go-name": "User"
  18239. }
  18240. },
  18241. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18242. },
  18243. "AnnotatedTag": {
  18244. "description": "AnnotatedTag represents an annotated tag",
  18245. "type": "object",
  18246. "properties": {
  18247. "message": {
  18248. "type": "string",
  18249. "x-go-name": "Message"
  18250. },
  18251. "object": {
  18252. "$ref": "#/definitions/AnnotatedTagObject"
  18253. },
  18254. "sha": {
  18255. "type": "string",
  18256. "x-go-name": "SHA"
  18257. },
  18258. "tag": {
  18259. "type": "string",
  18260. "x-go-name": "Tag"
  18261. },
  18262. "tagger": {
  18263. "$ref": "#/definitions/CommitUser"
  18264. },
  18265. "url": {
  18266. "type": "string",
  18267. "x-go-name": "URL"
  18268. },
  18269. "verification": {
  18270. "$ref": "#/definitions/PayloadCommitVerification"
  18271. }
  18272. },
  18273. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18274. },
  18275. "AnnotatedTagObject": {
  18276. "description": "AnnotatedTagObject contains meta information of the tag object",
  18277. "type": "object",
  18278. "properties": {
  18279. "sha": {
  18280. "type": "string",
  18281. "x-go-name": "SHA"
  18282. },
  18283. "type": {
  18284. "type": "string",
  18285. "x-go-name": "Type"
  18286. },
  18287. "url": {
  18288. "type": "string",
  18289. "x-go-name": "URL"
  18290. }
  18291. },
  18292. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18293. },
  18294. "Attachment": {
  18295. "description": "Attachment a generic attachment",
  18296. "type": "object",
  18297. "properties": {
  18298. "browser_download_url": {
  18299. "type": "string",
  18300. "x-go-name": "DownloadURL"
  18301. },
  18302. "created_at": {
  18303. "type": "string",
  18304. "format": "date-time",
  18305. "x-go-name": "Created"
  18306. },
  18307. "download_count": {
  18308. "type": "integer",
  18309. "format": "int64",
  18310. "x-go-name": "DownloadCount"
  18311. },
  18312. "id": {
  18313. "type": "integer",
  18314. "format": "int64",
  18315. "x-go-name": "ID"
  18316. },
  18317. "name": {
  18318. "type": "string",
  18319. "x-go-name": "Name"
  18320. },
  18321. "size": {
  18322. "type": "integer",
  18323. "format": "int64",
  18324. "x-go-name": "Size"
  18325. },
  18326. "uuid": {
  18327. "type": "string",
  18328. "x-go-name": "UUID"
  18329. }
  18330. },
  18331. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18332. },
  18333. "Badge": {
  18334. "description": "Badge represents a user badge",
  18335. "type": "object",
  18336. "properties": {
  18337. "description": {
  18338. "type": "string",
  18339. "x-go-name": "Description"
  18340. },
  18341. "id": {
  18342. "type": "integer",
  18343. "format": "int64",
  18344. "x-go-name": "ID"
  18345. },
  18346. "image_url": {
  18347. "type": "string",
  18348. "x-go-name": "ImageURL"
  18349. },
  18350. "slug": {
  18351. "type": "string",
  18352. "x-go-name": "Slug"
  18353. }
  18354. },
  18355. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18356. },
  18357. "Branch": {
  18358. "description": "Branch represents a repository branch",
  18359. "type": "object",
  18360. "properties": {
  18361. "commit": {
  18362. "$ref": "#/definitions/PayloadCommit"
  18363. },
  18364. "effective_branch_protection_name": {
  18365. "type": "string",
  18366. "x-go-name": "EffectiveBranchProtectionName"
  18367. },
  18368. "enable_status_check": {
  18369. "type": "boolean",
  18370. "x-go-name": "EnableStatusCheck"
  18371. },
  18372. "name": {
  18373. "type": "string",
  18374. "x-go-name": "Name"
  18375. },
  18376. "protected": {
  18377. "type": "boolean",
  18378. "x-go-name": "Protected"
  18379. },
  18380. "required_approvals": {
  18381. "type": "integer",
  18382. "format": "int64",
  18383. "x-go-name": "RequiredApprovals"
  18384. },
  18385. "status_check_contexts": {
  18386. "type": "array",
  18387. "items": {
  18388. "type": "string"
  18389. },
  18390. "x-go-name": "StatusCheckContexts"
  18391. },
  18392. "user_can_merge": {
  18393. "type": "boolean",
  18394. "x-go-name": "UserCanMerge"
  18395. },
  18396. "user_can_push": {
  18397. "type": "boolean",
  18398. "x-go-name": "UserCanPush"
  18399. }
  18400. },
  18401. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18402. },
  18403. "BranchProtection": {
  18404. "description": "BranchProtection represents a branch protection for a repository",
  18405. "type": "object",
  18406. "properties": {
  18407. "approvals_whitelist_teams": {
  18408. "type": "array",
  18409. "items": {
  18410. "type": "string"
  18411. },
  18412. "x-go-name": "ApprovalsWhitelistTeams"
  18413. },
  18414. "approvals_whitelist_username": {
  18415. "type": "array",
  18416. "items": {
  18417. "type": "string"
  18418. },
  18419. "x-go-name": "ApprovalsWhitelistUsernames"
  18420. },
  18421. "block_on_official_review_requests": {
  18422. "type": "boolean",
  18423. "x-go-name": "BlockOnOfficialReviewRequests"
  18424. },
  18425. "block_on_outdated_branch": {
  18426. "type": "boolean",
  18427. "x-go-name": "BlockOnOutdatedBranch"
  18428. },
  18429. "block_on_rejected_reviews": {
  18430. "type": "boolean",
  18431. "x-go-name": "BlockOnRejectedReviews"
  18432. },
  18433. "branch_name": {
  18434. "description": "Deprecated: true",
  18435. "type": "string",
  18436. "x-go-name": "BranchName"
  18437. },
  18438. "created_at": {
  18439. "type": "string",
  18440. "format": "date-time",
  18441. "x-go-name": "Created"
  18442. },
  18443. "dismiss_stale_approvals": {
  18444. "type": "boolean",
  18445. "x-go-name": "DismissStaleApprovals"
  18446. },
  18447. "enable_approvals_whitelist": {
  18448. "type": "boolean",
  18449. "x-go-name": "EnableApprovalsWhitelist"
  18450. },
  18451. "enable_merge_whitelist": {
  18452. "type": "boolean",
  18453. "x-go-name": "EnableMergeWhitelist"
  18454. },
  18455. "enable_push": {
  18456. "type": "boolean",
  18457. "x-go-name": "EnablePush"
  18458. },
  18459. "enable_push_whitelist": {
  18460. "type": "boolean",
  18461. "x-go-name": "EnablePushWhitelist"
  18462. },
  18463. "enable_status_check": {
  18464. "type": "boolean",
  18465. "x-go-name": "EnableStatusCheck"
  18466. },
  18467. "ignore_stale_approvals": {
  18468. "type": "boolean",
  18469. "x-go-name": "IgnoreStaleApprovals"
  18470. },
  18471. "merge_whitelist_teams": {
  18472. "type": "array",
  18473. "items": {
  18474. "type": "string"
  18475. },
  18476. "x-go-name": "MergeWhitelistTeams"
  18477. },
  18478. "merge_whitelist_usernames": {
  18479. "type": "array",
  18480. "items": {
  18481. "type": "string"
  18482. },
  18483. "x-go-name": "MergeWhitelistUsernames"
  18484. },
  18485. "protected_file_patterns": {
  18486. "type": "string",
  18487. "x-go-name": "ProtectedFilePatterns"
  18488. },
  18489. "push_whitelist_deploy_keys": {
  18490. "type": "boolean",
  18491. "x-go-name": "PushWhitelistDeployKeys"
  18492. },
  18493. "push_whitelist_teams": {
  18494. "type": "array",
  18495. "items": {
  18496. "type": "string"
  18497. },
  18498. "x-go-name": "PushWhitelistTeams"
  18499. },
  18500. "push_whitelist_usernames": {
  18501. "type": "array",
  18502. "items": {
  18503. "type": "string"
  18504. },
  18505. "x-go-name": "PushWhitelistUsernames"
  18506. },
  18507. "require_signed_commits": {
  18508. "type": "boolean",
  18509. "x-go-name": "RequireSignedCommits"
  18510. },
  18511. "required_approvals": {
  18512. "type": "integer",
  18513. "format": "int64",
  18514. "x-go-name": "RequiredApprovals"
  18515. },
  18516. "rule_name": {
  18517. "type": "string",
  18518. "x-go-name": "RuleName"
  18519. },
  18520. "status_check_contexts": {
  18521. "type": "array",
  18522. "items": {
  18523. "type": "string"
  18524. },
  18525. "x-go-name": "StatusCheckContexts"
  18526. },
  18527. "unprotected_file_patterns": {
  18528. "type": "string",
  18529. "x-go-name": "UnprotectedFilePatterns"
  18530. },
  18531. "updated_at": {
  18532. "type": "string",
  18533. "format": "date-time",
  18534. "x-go-name": "Updated"
  18535. }
  18536. },
  18537. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18538. },
  18539. "ChangeFileOperation": {
  18540. "description": "ChangeFileOperation for creating, updating or deleting a file",
  18541. "type": "object",
  18542. "required": [
  18543. "operation",
  18544. "path"
  18545. ],
  18546. "properties": {
  18547. "content": {
  18548. "description": "new or updated file content, must be base64 encoded",
  18549. "type": "string",
  18550. "x-go-name": "ContentBase64"
  18551. },
  18552. "from_path": {
  18553. "description": "old path of the file to move",
  18554. "type": "string",
  18555. "x-go-name": "FromPath"
  18556. },
  18557. "operation": {
  18558. "description": "indicates what to do with the file",
  18559. "type": "string",
  18560. "enum": [
  18561. "create",
  18562. "update",
  18563. "delete"
  18564. ],
  18565. "x-go-name": "Operation"
  18566. },
  18567. "path": {
  18568. "description": "path to the existing or new file",
  18569. "type": "string",
  18570. "x-go-name": "Path"
  18571. },
  18572. "sha": {
  18573. "description": "sha is the SHA for the file that already exists, required for update or delete",
  18574. "type": "string",
  18575. "x-go-name": "SHA"
  18576. }
  18577. },
  18578. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18579. },
  18580. "ChangeFilesOptions": {
  18581. "description": "ChangeFilesOptions options for creating, updating or deleting multiple files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  18582. "type": "object",
  18583. "required": [
  18584. "files"
  18585. ],
  18586. "properties": {
  18587. "author": {
  18588. "$ref": "#/definitions/Identity"
  18589. },
  18590. "branch": {
  18591. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  18592. "type": "string",
  18593. "x-go-name": "BranchName"
  18594. },
  18595. "committer": {
  18596. "$ref": "#/definitions/Identity"
  18597. },
  18598. "dates": {
  18599. "$ref": "#/definitions/CommitDateOptions"
  18600. },
  18601. "files": {
  18602. "description": "list of file operations",
  18603. "type": "array",
  18604. "items": {
  18605. "$ref": "#/definitions/ChangeFileOperation"
  18606. },
  18607. "x-go-name": "Files"
  18608. },
  18609. "message": {
  18610. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  18611. "type": "string",
  18612. "x-go-name": "Message"
  18613. },
  18614. "new_branch": {
  18615. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  18616. "type": "string",
  18617. "x-go-name": "NewBranchName"
  18618. },
  18619. "signoff": {
  18620. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  18621. "type": "boolean",
  18622. "x-go-name": "Signoff"
  18623. }
  18624. },
  18625. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18626. },
  18627. "ChangedFile": {
  18628. "description": "ChangedFile store information about files affected by the pull request",
  18629. "type": "object",
  18630. "properties": {
  18631. "additions": {
  18632. "type": "integer",
  18633. "format": "int64",
  18634. "x-go-name": "Additions"
  18635. },
  18636. "changes": {
  18637. "type": "integer",
  18638. "format": "int64",
  18639. "x-go-name": "Changes"
  18640. },
  18641. "contents_url": {
  18642. "type": "string",
  18643. "x-go-name": "ContentsURL"
  18644. },
  18645. "deletions": {
  18646. "type": "integer",
  18647. "format": "int64",
  18648. "x-go-name": "Deletions"
  18649. },
  18650. "filename": {
  18651. "type": "string",
  18652. "x-go-name": "Filename"
  18653. },
  18654. "html_url": {
  18655. "type": "string",
  18656. "x-go-name": "HTMLURL"
  18657. },
  18658. "previous_filename": {
  18659. "type": "string",
  18660. "x-go-name": "PreviousFilename"
  18661. },
  18662. "raw_url": {
  18663. "type": "string",
  18664. "x-go-name": "RawURL"
  18665. },
  18666. "status": {
  18667. "type": "string",
  18668. "x-go-name": "Status"
  18669. }
  18670. },
  18671. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18672. },
  18673. "CombinedStatus": {
  18674. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  18675. "type": "object",
  18676. "properties": {
  18677. "commit_url": {
  18678. "type": "string",
  18679. "x-go-name": "CommitURL"
  18680. },
  18681. "repository": {
  18682. "$ref": "#/definitions/Repository"
  18683. },
  18684. "sha": {
  18685. "type": "string",
  18686. "x-go-name": "SHA"
  18687. },
  18688. "state": {
  18689. "$ref": "#/definitions/CommitStatusState"
  18690. },
  18691. "statuses": {
  18692. "type": "array",
  18693. "items": {
  18694. "$ref": "#/definitions/CommitStatus"
  18695. },
  18696. "x-go-name": "Statuses"
  18697. },
  18698. "total_count": {
  18699. "type": "integer",
  18700. "format": "int64",
  18701. "x-go-name": "TotalCount"
  18702. },
  18703. "url": {
  18704. "type": "string",
  18705. "x-go-name": "URL"
  18706. }
  18707. },
  18708. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18709. },
  18710. "Comment": {
  18711. "description": "Comment represents a comment on a commit or issue",
  18712. "type": "object",
  18713. "properties": {
  18714. "assets": {
  18715. "type": "array",
  18716. "items": {
  18717. "$ref": "#/definitions/Attachment"
  18718. },
  18719. "x-go-name": "Attachments"
  18720. },
  18721. "body": {
  18722. "type": "string",
  18723. "x-go-name": "Body"
  18724. },
  18725. "created_at": {
  18726. "type": "string",
  18727. "format": "date-time",
  18728. "x-go-name": "Created"
  18729. },
  18730. "html_url": {
  18731. "type": "string",
  18732. "x-go-name": "HTMLURL"
  18733. },
  18734. "id": {
  18735. "type": "integer",
  18736. "format": "int64",
  18737. "x-go-name": "ID"
  18738. },
  18739. "issue_url": {
  18740. "type": "string",
  18741. "x-go-name": "IssueURL"
  18742. },
  18743. "original_author": {
  18744. "type": "string",
  18745. "x-go-name": "OriginalAuthor"
  18746. },
  18747. "original_author_id": {
  18748. "type": "integer",
  18749. "format": "int64",
  18750. "x-go-name": "OriginalAuthorID"
  18751. },
  18752. "pull_request_url": {
  18753. "type": "string",
  18754. "x-go-name": "PRURL"
  18755. },
  18756. "updated_at": {
  18757. "type": "string",
  18758. "format": "date-time",
  18759. "x-go-name": "Updated"
  18760. },
  18761. "user": {
  18762. "$ref": "#/definitions/User"
  18763. }
  18764. },
  18765. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18766. },
  18767. "Commit": {
  18768. "type": "object",
  18769. "title": "Commit contains information generated from a Git commit.",
  18770. "properties": {
  18771. "author": {
  18772. "$ref": "#/definitions/User"
  18773. },
  18774. "commit": {
  18775. "$ref": "#/definitions/RepoCommit"
  18776. },
  18777. "committer": {
  18778. "$ref": "#/definitions/User"
  18779. },
  18780. "created": {
  18781. "type": "string",
  18782. "format": "date-time",
  18783. "x-go-name": "Created"
  18784. },
  18785. "files": {
  18786. "type": "array",
  18787. "items": {
  18788. "$ref": "#/definitions/CommitAffectedFiles"
  18789. },
  18790. "x-go-name": "Files"
  18791. },
  18792. "html_url": {
  18793. "type": "string",
  18794. "x-go-name": "HTMLURL"
  18795. },
  18796. "parents": {
  18797. "type": "array",
  18798. "items": {
  18799. "$ref": "#/definitions/CommitMeta"
  18800. },
  18801. "x-go-name": "Parents"
  18802. },
  18803. "sha": {
  18804. "type": "string",
  18805. "x-go-name": "SHA"
  18806. },
  18807. "stats": {
  18808. "$ref": "#/definitions/CommitStats"
  18809. },
  18810. "url": {
  18811. "type": "string",
  18812. "x-go-name": "URL"
  18813. }
  18814. },
  18815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18816. },
  18817. "CommitAffectedFiles": {
  18818. "description": "CommitAffectedFiles store information about files affected by the commit",
  18819. "type": "object",
  18820. "properties": {
  18821. "filename": {
  18822. "type": "string",
  18823. "x-go-name": "Filename"
  18824. },
  18825. "status": {
  18826. "type": "string",
  18827. "x-go-name": "Status"
  18828. }
  18829. },
  18830. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18831. },
  18832. "CommitDateOptions": {
  18833. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  18834. "type": "object",
  18835. "properties": {
  18836. "author": {
  18837. "type": "string",
  18838. "format": "date-time",
  18839. "x-go-name": "Author"
  18840. },
  18841. "committer": {
  18842. "type": "string",
  18843. "format": "date-time",
  18844. "x-go-name": "Committer"
  18845. }
  18846. },
  18847. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18848. },
  18849. "CommitMeta": {
  18850. "type": "object",
  18851. "title": "CommitMeta contains meta information of a commit in terms of API.",
  18852. "properties": {
  18853. "created": {
  18854. "type": "string",
  18855. "format": "date-time",
  18856. "x-go-name": "Created"
  18857. },
  18858. "sha": {
  18859. "type": "string",
  18860. "x-go-name": "SHA"
  18861. },
  18862. "url": {
  18863. "type": "string",
  18864. "x-go-name": "URL"
  18865. }
  18866. },
  18867. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18868. },
  18869. "CommitStats": {
  18870. "description": "CommitStats is statistics for a RepoCommit",
  18871. "type": "object",
  18872. "properties": {
  18873. "additions": {
  18874. "type": "integer",
  18875. "format": "int64",
  18876. "x-go-name": "Additions"
  18877. },
  18878. "deletions": {
  18879. "type": "integer",
  18880. "format": "int64",
  18881. "x-go-name": "Deletions"
  18882. },
  18883. "total": {
  18884. "type": "integer",
  18885. "format": "int64",
  18886. "x-go-name": "Total"
  18887. }
  18888. },
  18889. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18890. },
  18891. "CommitStatus": {
  18892. "description": "CommitStatus holds a single status of a single Commit",
  18893. "type": "object",
  18894. "properties": {
  18895. "context": {
  18896. "type": "string",
  18897. "x-go-name": "Context"
  18898. },
  18899. "created_at": {
  18900. "type": "string",
  18901. "format": "date-time",
  18902. "x-go-name": "Created"
  18903. },
  18904. "creator": {
  18905. "$ref": "#/definitions/User"
  18906. },
  18907. "description": {
  18908. "type": "string",
  18909. "x-go-name": "Description"
  18910. },
  18911. "id": {
  18912. "type": "integer",
  18913. "format": "int64",
  18914. "x-go-name": "ID"
  18915. },
  18916. "status": {
  18917. "$ref": "#/definitions/CommitStatusState"
  18918. },
  18919. "target_url": {
  18920. "type": "string",
  18921. "x-go-name": "TargetURL"
  18922. },
  18923. "updated_at": {
  18924. "type": "string",
  18925. "format": "date-time",
  18926. "x-go-name": "Updated"
  18927. },
  18928. "url": {
  18929. "type": "string",
  18930. "x-go-name": "URL"
  18931. }
  18932. },
  18933. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18934. },
  18935. "CommitStatusState": {
  18936. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"",
  18937. "type": "string",
  18938. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18939. },
  18940. "CommitUser": {
  18941. "type": "object",
  18942. "title": "CommitUser contains information of a user in the context of a commit.",
  18943. "properties": {
  18944. "date": {
  18945. "type": "string",
  18946. "x-go-name": "Date"
  18947. },
  18948. "email": {
  18949. "type": "string",
  18950. "format": "email",
  18951. "x-go-name": "Email"
  18952. },
  18953. "name": {
  18954. "type": "string",
  18955. "x-go-name": "Name"
  18956. }
  18957. },
  18958. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18959. },
  18960. "Compare": {
  18961. "type": "object",
  18962. "title": "Compare represents a comparison between two commits.",
  18963. "properties": {
  18964. "commits": {
  18965. "type": "array",
  18966. "items": {
  18967. "$ref": "#/definitions/Commit"
  18968. },
  18969. "x-go-name": "Commits"
  18970. },
  18971. "total_commits": {
  18972. "type": "integer",
  18973. "format": "int64",
  18974. "x-go-name": "TotalCommits"
  18975. }
  18976. },
  18977. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18978. },
  18979. "ContentsResponse": {
  18980. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  18981. "type": "object",
  18982. "properties": {
  18983. "_links": {
  18984. "$ref": "#/definitions/FileLinksResponse"
  18985. },
  18986. "content": {
  18987. "description": "`content` is populated when `type` is `file`, otherwise null",
  18988. "type": "string",
  18989. "x-go-name": "Content"
  18990. },
  18991. "download_url": {
  18992. "type": "string",
  18993. "x-go-name": "DownloadURL"
  18994. },
  18995. "encoding": {
  18996. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  18997. "type": "string",
  18998. "x-go-name": "Encoding"
  18999. },
  19000. "git_url": {
  19001. "type": "string",
  19002. "x-go-name": "GitURL"
  19003. },
  19004. "html_url": {
  19005. "type": "string",
  19006. "x-go-name": "HTMLURL"
  19007. },
  19008. "last_commit_sha": {
  19009. "type": "string",
  19010. "x-go-name": "LastCommitSHA"
  19011. },
  19012. "name": {
  19013. "type": "string",
  19014. "x-go-name": "Name"
  19015. },
  19016. "path": {
  19017. "type": "string",
  19018. "x-go-name": "Path"
  19019. },
  19020. "sha": {
  19021. "type": "string",
  19022. "x-go-name": "SHA"
  19023. },
  19024. "size": {
  19025. "type": "integer",
  19026. "format": "int64",
  19027. "x-go-name": "Size"
  19028. },
  19029. "submodule_git_url": {
  19030. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  19031. "type": "string",
  19032. "x-go-name": "SubmoduleGitURL"
  19033. },
  19034. "target": {
  19035. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  19036. "type": "string",
  19037. "x-go-name": "Target"
  19038. },
  19039. "type": {
  19040. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  19041. "type": "string",
  19042. "x-go-name": "Type"
  19043. },
  19044. "url": {
  19045. "type": "string",
  19046. "x-go-name": "URL"
  19047. }
  19048. },
  19049. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19050. },
  19051. "CreateAccessTokenOption": {
  19052. "description": "CreateAccessTokenOption options when create access token",
  19053. "type": "object",
  19054. "required": [
  19055. "name"
  19056. ],
  19057. "properties": {
  19058. "name": {
  19059. "type": "string",
  19060. "x-go-name": "Name"
  19061. },
  19062. "scopes": {
  19063. "type": "array",
  19064. "items": {
  19065. "type": "string"
  19066. },
  19067. "x-go-name": "Scopes"
  19068. }
  19069. },
  19070. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19071. },
  19072. "CreateBranchProtectionOption": {
  19073. "description": "CreateBranchProtectionOption options for creating a branch protection",
  19074. "type": "object",
  19075. "properties": {
  19076. "approvals_whitelist_teams": {
  19077. "type": "array",
  19078. "items": {
  19079. "type": "string"
  19080. },
  19081. "x-go-name": "ApprovalsWhitelistTeams"
  19082. },
  19083. "approvals_whitelist_username": {
  19084. "type": "array",
  19085. "items": {
  19086. "type": "string"
  19087. },
  19088. "x-go-name": "ApprovalsWhitelistUsernames"
  19089. },
  19090. "block_on_official_review_requests": {
  19091. "type": "boolean",
  19092. "x-go-name": "BlockOnOfficialReviewRequests"
  19093. },
  19094. "block_on_outdated_branch": {
  19095. "type": "boolean",
  19096. "x-go-name": "BlockOnOutdatedBranch"
  19097. },
  19098. "block_on_rejected_reviews": {
  19099. "type": "boolean",
  19100. "x-go-name": "BlockOnRejectedReviews"
  19101. },
  19102. "branch_name": {
  19103. "description": "Deprecated: true",
  19104. "type": "string",
  19105. "x-go-name": "BranchName"
  19106. },
  19107. "dismiss_stale_approvals": {
  19108. "type": "boolean",
  19109. "x-go-name": "DismissStaleApprovals"
  19110. },
  19111. "enable_approvals_whitelist": {
  19112. "type": "boolean",
  19113. "x-go-name": "EnableApprovalsWhitelist"
  19114. },
  19115. "enable_merge_whitelist": {
  19116. "type": "boolean",
  19117. "x-go-name": "EnableMergeWhitelist"
  19118. },
  19119. "enable_push": {
  19120. "type": "boolean",
  19121. "x-go-name": "EnablePush"
  19122. },
  19123. "enable_push_whitelist": {
  19124. "type": "boolean",
  19125. "x-go-name": "EnablePushWhitelist"
  19126. },
  19127. "enable_status_check": {
  19128. "type": "boolean",
  19129. "x-go-name": "EnableStatusCheck"
  19130. },
  19131. "ignore_stale_approvals": {
  19132. "type": "boolean",
  19133. "x-go-name": "IgnoreStaleApprovals"
  19134. },
  19135. "merge_whitelist_teams": {
  19136. "type": "array",
  19137. "items": {
  19138. "type": "string"
  19139. },
  19140. "x-go-name": "MergeWhitelistTeams"
  19141. },
  19142. "merge_whitelist_usernames": {
  19143. "type": "array",
  19144. "items": {
  19145. "type": "string"
  19146. },
  19147. "x-go-name": "MergeWhitelistUsernames"
  19148. },
  19149. "protected_file_patterns": {
  19150. "type": "string",
  19151. "x-go-name": "ProtectedFilePatterns"
  19152. },
  19153. "push_whitelist_deploy_keys": {
  19154. "type": "boolean",
  19155. "x-go-name": "PushWhitelistDeployKeys"
  19156. },
  19157. "push_whitelist_teams": {
  19158. "type": "array",
  19159. "items": {
  19160. "type": "string"
  19161. },
  19162. "x-go-name": "PushWhitelistTeams"
  19163. },
  19164. "push_whitelist_usernames": {
  19165. "type": "array",
  19166. "items": {
  19167. "type": "string"
  19168. },
  19169. "x-go-name": "PushWhitelistUsernames"
  19170. },
  19171. "require_signed_commits": {
  19172. "type": "boolean",
  19173. "x-go-name": "RequireSignedCommits"
  19174. },
  19175. "required_approvals": {
  19176. "type": "integer",
  19177. "format": "int64",
  19178. "x-go-name": "RequiredApprovals"
  19179. },
  19180. "rule_name": {
  19181. "type": "string",
  19182. "x-go-name": "RuleName"
  19183. },
  19184. "status_check_contexts": {
  19185. "type": "array",
  19186. "items": {
  19187. "type": "string"
  19188. },
  19189. "x-go-name": "StatusCheckContexts"
  19190. },
  19191. "unprotected_file_patterns": {
  19192. "type": "string",
  19193. "x-go-name": "UnprotectedFilePatterns"
  19194. }
  19195. },
  19196. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19197. },
  19198. "CreateBranchRepoOption": {
  19199. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  19200. "type": "object",
  19201. "required": [
  19202. "new_branch_name"
  19203. ],
  19204. "properties": {
  19205. "new_branch_name": {
  19206. "description": "Name of the branch to create",
  19207. "type": "string",
  19208. "uniqueItems": true,
  19209. "x-go-name": "BranchName"
  19210. },
  19211. "old_branch_name": {
  19212. "description": "Deprecated: true\nName of the old branch to create from",
  19213. "type": "string",
  19214. "uniqueItems": true,
  19215. "x-go-name": "OldBranchName"
  19216. },
  19217. "old_ref_name": {
  19218. "description": "Name of the old branch/tag/commit to create from",
  19219. "type": "string",
  19220. "uniqueItems": true,
  19221. "x-go-name": "OldRefName"
  19222. }
  19223. },
  19224. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19225. },
  19226. "CreateEmailOption": {
  19227. "description": "CreateEmailOption options when creating email addresses",
  19228. "type": "object",
  19229. "properties": {
  19230. "emails": {
  19231. "description": "email addresses to add",
  19232. "type": "array",
  19233. "items": {
  19234. "type": "string"
  19235. },
  19236. "x-go-name": "Emails"
  19237. }
  19238. },
  19239. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19240. },
  19241. "CreateFileOptions": {
  19242. "description": "CreateFileOptions options for creating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  19243. "type": "object",
  19244. "required": [
  19245. "content"
  19246. ],
  19247. "properties": {
  19248. "author": {
  19249. "$ref": "#/definitions/Identity"
  19250. },
  19251. "branch": {
  19252. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  19253. "type": "string",
  19254. "x-go-name": "BranchName"
  19255. },
  19256. "committer": {
  19257. "$ref": "#/definitions/Identity"
  19258. },
  19259. "content": {
  19260. "description": "content must be base64 encoded",
  19261. "type": "string",
  19262. "x-go-name": "ContentBase64"
  19263. },
  19264. "dates": {
  19265. "$ref": "#/definitions/CommitDateOptions"
  19266. },
  19267. "message": {
  19268. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  19269. "type": "string",
  19270. "x-go-name": "Message"
  19271. },
  19272. "new_branch": {
  19273. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  19274. "type": "string",
  19275. "x-go-name": "NewBranchName"
  19276. },
  19277. "signoff": {
  19278. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  19279. "type": "boolean",
  19280. "x-go-name": "Signoff"
  19281. }
  19282. },
  19283. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19284. },
  19285. "CreateForkOption": {
  19286. "description": "CreateForkOption options for creating a fork",
  19287. "type": "object",
  19288. "properties": {
  19289. "name": {
  19290. "description": "name of the forked repository",
  19291. "type": "string",
  19292. "x-go-name": "Name"
  19293. },
  19294. "organization": {
  19295. "description": "organization name, if forking into an organization",
  19296. "type": "string",
  19297. "x-go-name": "Organization"
  19298. }
  19299. },
  19300. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19301. },
  19302. "CreateGPGKeyOption": {
  19303. "description": "CreateGPGKeyOption options create user GPG key",
  19304. "type": "object",
  19305. "required": [
  19306. "armored_public_key"
  19307. ],
  19308. "properties": {
  19309. "armored_public_key": {
  19310. "description": "An armored GPG key to add",
  19311. "type": "string",
  19312. "uniqueItems": true,
  19313. "x-go-name": "ArmoredKey"
  19314. },
  19315. "armored_signature": {
  19316. "type": "string",
  19317. "x-go-name": "Signature"
  19318. }
  19319. },
  19320. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19321. },
  19322. "CreateHookOption": {
  19323. "description": "CreateHookOption options when create a hook",
  19324. "type": "object",
  19325. "required": [
  19326. "type",
  19327. "config"
  19328. ],
  19329. "properties": {
  19330. "active": {
  19331. "type": "boolean",
  19332. "default": false,
  19333. "x-go-name": "Active"
  19334. },
  19335. "authorization_header": {
  19336. "type": "string",
  19337. "x-go-name": "AuthorizationHeader"
  19338. },
  19339. "branch_filter": {
  19340. "type": "string",
  19341. "x-go-name": "BranchFilter"
  19342. },
  19343. "config": {
  19344. "$ref": "#/definitions/CreateHookOptionConfig"
  19345. },
  19346. "events": {
  19347. "type": "array",
  19348. "items": {
  19349. "type": "string"
  19350. },
  19351. "x-go-name": "Events"
  19352. },
  19353. "type": {
  19354. "type": "string",
  19355. "enum": [
  19356. "dingtalk",
  19357. "discord",
  19358. "gitea",
  19359. "gogs",
  19360. "msteams",
  19361. "slack",
  19362. "telegram",
  19363. "feishu",
  19364. "wechatwork",
  19365. "packagist"
  19366. ],
  19367. "x-go-name": "Type"
  19368. }
  19369. },
  19370. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19371. },
  19372. "CreateHookOptionConfig": {
  19373. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  19374. "type": "object",
  19375. "additionalProperties": {
  19376. "type": "string"
  19377. },
  19378. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19379. },
  19380. "CreateIssueCommentOption": {
  19381. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  19382. "type": "object",
  19383. "required": [
  19384. "body"
  19385. ],
  19386. "properties": {
  19387. "body": {
  19388. "type": "string",
  19389. "x-go-name": "Body"
  19390. }
  19391. },
  19392. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19393. },
  19394. "CreateIssueOption": {
  19395. "description": "CreateIssueOption options to create one issue",
  19396. "type": "object",
  19397. "required": [
  19398. "title"
  19399. ],
  19400. "properties": {
  19401. "assignee": {
  19402. "description": "deprecated",
  19403. "type": "string",
  19404. "x-go-name": "Assignee"
  19405. },
  19406. "assignees": {
  19407. "type": "array",
  19408. "items": {
  19409. "type": "string"
  19410. },
  19411. "x-go-name": "Assignees"
  19412. },
  19413. "body": {
  19414. "type": "string",
  19415. "x-go-name": "Body"
  19416. },
  19417. "closed": {
  19418. "type": "boolean",
  19419. "x-go-name": "Closed"
  19420. },
  19421. "due_date": {
  19422. "type": "string",
  19423. "format": "date-time",
  19424. "x-go-name": "Deadline"
  19425. },
  19426. "labels": {
  19427. "description": "list of label ids",
  19428. "type": "array",
  19429. "items": {
  19430. "type": "integer",
  19431. "format": "int64"
  19432. },
  19433. "x-go-name": "Labels"
  19434. },
  19435. "milestone": {
  19436. "description": "milestone id",
  19437. "type": "integer",
  19438. "format": "int64",
  19439. "x-go-name": "Milestone"
  19440. },
  19441. "ref": {
  19442. "type": "string",
  19443. "x-go-name": "Ref"
  19444. },
  19445. "title": {
  19446. "type": "string",
  19447. "x-go-name": "Title"
  19448. }
  19449. },
  19450. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19451. },
  19452. "CreateKeyOption": {
  19453. "description": "CreateKeyOption options when creating a key",
  19454. "type": "object",
  19455. "required": [
  19456. "title",
  19457. "key"
  19458. ],
  19459. "properties": {
  19460. "key": {
  19461. "description": "An armored SSH key to add",
  19462. "type": "string",
  19463. "uniqueItems": true,
  19464. "x-go-name": "Key"
  19465. },
  19466. "read_only": {
  19467. "description": "Describe if the key has only read access or read/write",
  19468. "type": "boolean",
  19469. "x-go-name": "ReadOnly"
  19470. },
  19471. "title": {
  19472. "description": "Title of the key to add",
  19473. "type": "string",
  19474. "uniqueItems": true,
  19475. "x-go-name": "Title"
  19476. }
  19477. },
  19478. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19479. },
  19480. "CreateLabelOption": {
  19481. "description": "CreateLabelOption options for creating a label",
  19482. "type": "object",
  19483. "required": [
  19484. "name",
  19485. "color"
  19486. ],
  19487. "properties": {
  19488. "color": {
  19489. "type": "string",
  19490. "x-go-name": "Color",
  19491. "example": "#00aabb"
  19492. },
  19493. "description": {
  19494. "type": "string",
  19495. "x-go-name": "Description"
  19496. },
  19497. "exclusive": {
  19498. "type": "boolean",
  19499. "x-go-name": "Exclusive",
  19500. "example": false
  19501. },
  19502. "is_archived": {
  19503. "type": "boolean",
  19504. "x-go-name": "IsArchived",
  19505. "example": false
  19506. },
  19507. "name": {
  19508. "type": "string",
  19509. "x-go-name": "Name"
  19510. }
  19511. },
  19512. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19513. },
  19514. "CreateMilestoneOption": {
  19515. "description": "CreateMilestoneOption options for creating a milestone",
  19516. "type": "object",
  19517. "properties": {
  19518. "description": {
  19519. "type": "string",
  19520. "x-go-name": "Description"
  19521. },
  19522. "due_on": {
  19523. "type": "string",
  19524. "format": "date-time",
  19525. "x-go-name": "Deadline"
  19526. },
  19527. "state": {
  19528. "type": "string",
  19529. "enum": [
  19530. "open",
  19531. "closed"
  19532. ],
  19533. "x-go-name": "State"
  19534. },
  19535. "title": {
  19536. "type": "string",
  19537. "x-go-name": "Title"
  19538. }
  19539. },
  19540. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19541. },
  19542. "CreateOAuth2ApplicationOptions": {
  19543. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  19544. "type": "object",
  19545. "properties": {
  19546. "confidential_client": {
  19547. "type": "boolean",
  19548. "x-go-name": "ConfidentialClient"
  19549. },
  19550. "name": {
  19551. "type": "string",
  19552. "x-go-name": "Name"
  19553. },
  19554. "redirect_uris": {
  19555. "type": "array",
  19556. "items": {
  19557. "type": "string"
  19558. },
  19559. "x-go-name": "RedirectURIs"
  19560. }
  19561. },
  19562. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19563. },
  19564. "CreateOrUpdateSecretOption": {
  19565. "description": "CreateOrUpdateSecretOption options when creating or updating secret",
  19566. "type": "object",
  19567. "required": [
  19568. "data"
  19569. ],
  19570. "properties": {
  19571. "data": {
  19572. "description": "Data of the secret to update",
  19573. "type": "string",
  19574. "x-go-name": "Data"
  19575. }
  19576. },
  19577. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19578. },
  19579. "CreateOrgOption": {
  19580. "description": "CreateOrgOption options for creating an organization",
  19581. "type": "object",
  19582. "required": [
  19583. "username"
  19584. ],
  19585. "properties": {
  19586. "description": {
  19587. "type": "string",
  19588. "x-go-name": "Description"
  19589. },
  19590. "email": {
  19591. "type": "string",
  19592. "x-go-name": "Email"
  19593. },
  19594. "full_name": {
  19595. "type": "string",
  19596. "x-go-name": "FullName"
  19597. },
  19598. "location": {
  19599. "type": "string",
  19600. "x-go-name": "Location"
  19601. },
  19602. "repo_admin_change_team_access": {
  19603. "type": "boolean",
  19604. "x-go-name": "RepoAdminChangeTeamAccess"
  19605. },
  19606. "username": {
  19607. "type": "string",
  19608. "x-go-name": "UserName"
  19609. },
  19610. "visibility": {
  19611. "description": "possible values are `public` (default), `limited` or `private`",
  19612. "type": "string",
  19613. "enum": [
  19614. "public",
  19615. "limited",
  19616. "private"
  19617. ],
  19618. "x-go-name": "Visibility"
  19619. },
  19620. "website": {
  19621. "type": "string",
  19622. "x-go-name": "Website"
  19623. }
  19624. },
  19625. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19626. },
  19627. "CreatePullRequestOption": {
  19628. "description": "CreatePullRequestOption options when creating a pull request",
  19629. "type": "object",
  19630. "properties": {
  19631. "assignee": {
  19632. "type": "string",
  19633. "x-go-name": "Assignee"
  19634. },
  19635. "assignees": {
  19636. "type": "array",
  19637. "items": {
  19638. "type": "string"
  19639. },
  19640. "x-go-name": "Assignees"
  19641. },
  19642. "base": {
  19643. "type": "string",
  19644. "x-go-name": "Base"
  19645. },
  19646. "body": {
  19647. "type": "string",
  19648. "x-go-name": "Body"
  19649. },
  19650. "due_date": {
  19651. "type": "string",
  19652. "format": "date-time",
  19653. "x-go-name": "Deadline"
  19654. },
  19655. "head": {
  19656. "type": "string",
  19657. "x-go-name": "Head"
  19658. },
  19659. "labels": {
  19660. "type": "array",
  19661. "items": {
  19662. "type": "integer",
  19663. "format": "int64"
  19664. },
  19665. "x-go-name": "Labels"
  19666. },
  19667. "milestone": {
  19668. "type": "integer",
  19669. "format": "int64",
  19670. "x-go-name": "Milestone"
  19671. },
  19672. "title": {
  19673. "type": "string",
  19674. "x-go-name": "Title"
  19675. }
  19676. },
  19677. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19678. },
  19679. "CreatePullReviewComment": {
  19680. "description": "CreatePullReviewComment represent a review comment for creation api",
  19681. "type": "object",
  19682. "properties": {
  19683. "body": {
  19684. "type": "string",
  19685. "x-go-name": "Body"
  19686. },
  19687. "new_position": {
  19688. "description": "if comment to new file line or 0",
  19689. "type": "integer",
  19690. "format": "int64",
  19691. "x-go-name": "NewLineNum"
  19692. },
  19693. "old_position": {
  19694. "description": "if comment to old file line or 0",
  19695. "type": "integer",
  19696. "format": "int64",
  19697. "x-go-name": "OldLineNum"
  19698. },
  19699. "path": {
  19700. "description": "the tree path",
  19701. "type": "string",
  19702. "x-go-name": "Path"
  19703. }
  19704. },
  19705. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19706. },
  19707. "CreatePullReviewOptions": {
  19708. "description": "CreatePullReviewOptions are options to create a pull review",
  19709. "type": "object",
  19710. "properties": {
  19711. "body": {
  19712. "type": "string",
  19713. "x-go-name": "Body"
  19714. },
  19715. "comments": {
  19716. "type": "array",
  19717. "items": {
  19718. "$ref": "#/definitions/CreatePullReviewComment"
  19719. },
  19720. "x-go-name": "Comments"
  19721. },
  19722. "commit_id": {
  19723. "type": "string",
  19724. "x-go-name": "CommitID"
  19725. },
  19726. "event": {
  19727. "$ref": "#/definitions/ReviewStateType"
  19728. }
  19729. },
  19730. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19731. },
  19732. "CreatePushMirrorOption": {
  19733. "type": "object",
  19734. "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
  19735. "properties": {
  19736. "interval": {
  19737. "type": "string",
  19738. "x-go-name": "Interval"
  19739. },
  19740. "remote_address": {
  19741. "type": "string",
  19742. "x-go-name": "RemoteAddress"
  19743. },
  19744. "remote_password": {
  19745. "type": "string",
  19746. "x-go-name": "RemotePassword"
  19747. },
  19748. "remote_username": {
  19749. "type": "string",
  19750. "x-go-name": "RemoteUsername"
  19751. },
  19752. "sync_on_commit": {
  19753. "type": "boolean",
  19754. "x-go-name": "SyncOnCommit"
  19755. }
  19756. },
  19757. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19758. },
  19759. "CreateReleaseOption": {
  19760. "description": "CreateReleaseOption options when creating a release",
  19761. "type": "object",
  19762. "required": [
  19763. "tag_name"
  19764. ],
  19765. "properties": {
  19766. "body": {
  19767. "type": "string",
  19768. "x-go-name": "Note"
  19769. },
  19770. "draft": {
  19771. "type": "boolean",
  19772. "x-go-name": "IsDraft"
  19773. },
  19774. "name": {
  19775. "type": "string",
  19776. "x-go-name": "Title"
  19777. },
  19778. "prerelease": {
  19779. "type": "boolean",
  19780. "x-go-name": "IsPrerelease"
  19781. },
  19782. "tag_name": {
  19783. "type": "string",
  19784. "x-go-name": "TagName"
  19785. },
  19786. "target_commitish": {
  19787. "type": "string",
  19788. "x-go-name": "Target"
  19789. }
  19790. },
  19791. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19792. },
  19793. "CreateRepoOption": {
  19794. "description": "CreateRepoOption options when creating repository",
  19795. "type": "object",
  19796. "required": [
  19797. "name"
  19798. ],
  19799. "properties": {
  19800. "auto_init": {
  19801. "description": "Whether the repository should be auto-initialized?",
  19802. "type": "boolean",
  19803. "x-go-name": "AutoInit"
  19804. },
  19805. "default_branch": {
  19806. "description": "DefaultBranch of the repository (used when initializes and in template)",
  19807. "type": "string",
  19808. "x-go-name": "DefaultBranch"
  19809. },
  19810. "description": {
  19811. "description": "Description of the repository to create",
  19812. "type": "string",
  19813. "x-go-name": "Description"
  19814. },
  19815. "gitignores": {
  19816. "description": "Gitignores to use",
  19817. "type": "string",
  19818. "x-go-name": "Gitignores"
  19819. },
  19820. "issue_labels": {
  19821. "description": "Label-Set to use",
  19822. "type": "string",
  19823. "x-go-name": "IssueLabels"
  19824. },
  19825. "license": {
  19826. "description": "License to use",
  19827. "type": "string",
  19828. "x-go-name": "License"
  19829. },
  19830. "name": {
  19831. "description": "Name of the repository to create",
  19832. "type": "string",
  19833. "uniqueItems": true,
  19834. "x-go-name": "Name"
  19835. },
  19836. "object_format_name": {
  19837. "description": "ObjectFormatName of the underlying git repository",
  19838. "type": "string",
  19839. "enum": [
  19840. "sha1",
  19841. "sha256"
  19842. ],
  19843. "x-go-name": "ObjectFormatName"
  19844. },
  19845. "private": {
  19846. "description": "Whether the repository is private",
  19847. "type": "boolean",
  19848. "x-go-name": "Private"
  19849. },
  19850. "readme": {
  19851. "description": "Readme of the repository to create",
  19852. "type": "string",
  19853. "x-go-name": "Readme"
  19854. },
  19855. "template": {
  19856. "description": "Whether the repository is template",
  19857. "type": "boolean",
  19858. "x-go-name": "Template"
  19859. },
  19860. "trust_model": {
  19861. "description": "TrustModel of the repository",
  19862. "type": "string",
  19863. "enum": [
  19864. "default",
  19865. "collaborator",
  19866. "committer",
  19867. "collaboratorcommitter"
  19868. ],
  19869. "x-go-name": "TrustModel"
  19870. }
  19871. },
  19872. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19873. },
  19874. "CreateStatusOption": {
  19875. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  19876. "type": "object",
  19877. "properties": {
  19878. "context": {
  19879. "type": "string",
  19880. "x-go-name": "Context"
  19881. },
  19882. "description": {
  19883. "type": "string",
  19884. "x-go-name": "Description"
  19885. },
  19886. "state": {
  19887. "$ref": "#/definitions/CommitStatusState"
  19888. },
  19889. "target_url": {
  19890. "type": "string",
  19891. "x-go-name": "TargetURL"
  19892. }
  19893. },
  19894. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19895. },
  19896. "CreateTagOption": {
  19897. "description": "CreateTagOption options when creating a tag",
  19898. "type": "object",
  19899. "required": [
  19900. "tag_name"
  19901. ],
  19902. "properties": {
  19903. "message": {
  19904. "type": "string",
  19905. "x-go-name": "Message"
  19906. },
  19907. "tag_name": {
  19908. "type": "string",
  19909. "x-go-name": "TagName"
  19910. },
  19911. "target": {
  19912. "type": "string",
  19913. "x-go-name": "Target"
  19914. }
  19915. },
  19916. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19917. },
  19918. "CreateTeamOption": {
  19919. "description": "CreateTeamOption options for creating a team",
  19920. "type": "object",
  19921. "required": [
  19922. "name"
  19923. ],
  19924. "properties": {
  19925. "can_create_org_repo": {
  19926. "type": "boolean",
  19927. "x-go-name": "CanCreateOrgRepo"
  19928. },
  19929. "description": {
  19930. "type": "string",
  19931. "x-go-name": "Description"
  19932. },
  19933. "includes_all_repositories": {
  19934. "type": "boolean",
  19935. "x-go-name": "IncludesAllRepositories"
  19936. },
  19937. "name": {
  19938. "type": "string",
  19939. "x-go-name": "Name"
  19940. },
  19941. "permission": {
  19942. "type": "string",
  19943. "enum": [
  19944. "read",
  19945. "write",
  19946. "admin"
  19947. ],
  19948. "x-go-name": "Permission"
  19949. },
  19950. "units": {
  19951. "type": "array",
  19952. "items": {
  19953. "type": "string"
  19954. },
  19955. "x-go-name": "Units",
  19956. "example": [
  19957. "repo.actions",
  19958. "repo.code",
  19959. "repo.issues",
  19960. "repo.ext_issues",
  19961. "repo.wiki",
  19962. "repo.ext_wiki",
  19963. "repo.pulls",
  19964. "repo.releases",
  19965. "repo.projects",
  19966. "repo.ext_wiki"
  19967. ]
  19968. },
  19969. "units_map": {
  19970. "type": "object",
  19971. "additionalProperties": {
  19972. "type": "string"
  19973. },
  19974. "x-go-name": "UnitsMap",
  19975. "example": "{\"repo.actions\",\"repo.packages\",\"repo.code\":\"read\",\"repo.issues\":\"write\",\"repo.ext_issues\":\"none\",\"repo.wiki\":\"admin\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.projects\":\"none\",\"repo.ext_wiki\":\"none\"}"
  19976. }
  19977. },
  19978. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19979. },
  19980. "CreateUserOption": {
  19981. "description": "CreateUserOption create user options",
  19982. "type": "object",
  19983. "required": [
  19984. "username",
  19985. "email"
  19986. ],
  19987. "properties": {
  19988. "created_at": {
  19989. "description": "For explicitly setting the user creation timestamp. Useful when users are\nmigrated from other systems. When omitted, the user's creation timestamp\nwill be set to \"now\".",
  19990. "type": "string",
  19991. "format": "date-time",
  19992. "x-go-name": "Created"
  19993. },
  19994. "email": {
  19995. "type": "string",
  19996. "format": "email",
  19997. "x-go-name": "Email"
  19998. },
  19999. "full_name": {
  20000. "type": "string",
  20001. "x-go-name": "FullName"
  20002. },
  20003. "login_name": {
  20004. "type": "string",
  20005. "x-go-name": "LoginName"
  20006. },
  20007. "must_change_password": {
  20008. "type": "boolean",
  20009. "x-go-name": "MustChangePassword"
  20010. },
  20011. "password": {
  20012. "type": "string",
  20013. "x-go-name": "Password"
  20014. },
  20015. "restricted": {
  20016. "type": "boolean",
  20017. "x-go-name": "Restricted"
  20018. },
  20019. "send_notify": {
  20020. "type": "boolean",
  20021. "x-go-name": "SendNotify"
  20022. },
  20023. "source_id": {
  20024. "type": "integer",
  20025. "format": "int64",
  20026. "x-go-name": "SourceID"
  20027. },
  20028. "username": {
  20029. "type": "string",
  20030. "x-go-name": "Username"
  20031. },
  20032. "visibility": {
  20033. "type": "string",
  20034. "x-go-name": "Visibility"
  20035. }
  20036. },
  20037. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20038. },
  20039. "CreateVariableOption": {
  20040. "description": "CreateVariableOption the option when creating variable",
  20041. "type": "object",
  20042. "required": [
  20043. "value"
  20044. ],
  20045. "properties": {
  20046. "value": {
  20047. "description": "Value of the variable to create",
  20048. "type": "string",
  20049. "x-go-name": "Value"
  20050. }
  20051. },
  20052. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20053. },
  20054. "CreateWikiPageOptions": {
  20055. "description": "CreateWikiPageOptions form for creating wiki",
  20056. "type": "object",
  20057. "properties": {
  20058. "content_base64": {
  20059. "description": "content must be base64 encoded",
  20060. "type": "string",
  20061. "x-go-name": "ContentBase64"
  20062. },
  20063. "message": {
  20064. "description": "optional commit message summarizing the change",
  20065. "type": "string",
  20066. "x-go-name": "Message"
  20067. },
  20068. "title": {
  20069. "description": "page title. leave empty to keep unchanged",
  20070. "type": "string",
  20071. "x-go-name": "Title"
  20072. }
  20073. },
  20074. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20075. },
  20076. "Cron": {
  20077. "description": "Cron represents a Cron task",
  20078. "type": "object",
  20079. "properties": {
  20080. "exec_times": {
  20081. "type": "integer",
  20082. "format": "int64",
  20083. "x-go-name": "ExecTimes"
  20084. },
  20085. "name": {
  20086. "type": "string",
  20087. "x-go-name": "Name"
  20088. },
  20089. "next": {
  20090. "type": "string",
  20091. "format": "date-time",
  20092. "x-go-name": "Next"
  20093. },
  20094. "prev": {
  20095. "type": "string",
  20096. "format": "date-time",
  20097. "x-go-name": "Prev"
  20098. },
  20099. "schedule": {
  20100. "type": "string",
  20101. "x-go-name": "Schedule"
  20102. }
  20103. },
  20104. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20105. },
  20106. "DeleteEmailOption": {
  20107. "description": "DeleteEmailOption options when deleting email addresses",
  20108. "type": "object",
  20109. "properties": {
  20110. "emails": {
  20111. "description": "email addresses to delete",
  20112. "type": "array",
  20113. "items": {
  20114. "type": "string"
  20115. },
  20116. "x-go-name": "Emails"
  20117. }
  20118. },
  20119. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20120. },
  20121. "DeleteFileOptions": {
  20122. "description": "DeleteFileOptions options for deleting files (used for other File structs below)\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  20123. "type": "object",
  20124. "required": [
  20125. "sha"
  20126. ],
  20127. "properties": {
  20128. "author": {
  20129. "$ref": "#/definitions/Identity"
  20130. },
  20131. "branch": {
  20132. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  20133. "type": "string",
  20134. "x-go-name": "BranchName"
  20135. },
  20136. "committer": {
  20137. "$ref": "#/definitions/Identity"
  20138. },
  20139. "dates": {
  20140. "$ref": "#/definitions/CommitDateOptions"
  20141. },
  20142. "message": {
  20143. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  20144. "type": "string",
  20145. "x-go-name": "Message"
  20146. },
  20147. "new_branch": {
  20148. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  20149. "type": "string",
  20150. "x-go-name": "NewBranchName"
  20151. },
  20152. "sha": {
  20153. "description": "sha is the SHA for the file that already exists",
  20154. "type": "string",
  20155. "x-go-name": "SHA"
  20156. },
  20157. "signoff": {
  20158. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  20159. "type": "boolean",
  20160. "x-go-name": "Signoff"
  20161. }
  20162. },
  20163. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20164. },
  20165. "DeployKey": {
  20166. "description": "DeployKey a deploy key",
  20167. "type": "object",
  20168. "properties": {
  20169. "created_at": {
  20170. "type": "string",
  20171. "format": "date-time",
  20172. "x-go-name": "Created"
  20173. },
  20174. "fingerprint": {
  20175. "type": "string",
  20176. "x-go-name": "Fingerprint"
  20177. },
  20178. "id": {
  20179. "type": "integer",
  20180. "format": "int64",
  20181. "x-go-name": "ID"
  20182. },
  20183. "key": {
  20184. "type": "string",
  20185. "x-go-name": "Key"
  20186. },
  20187. "key_id": {
  20188. "type": "integer",
  20189. "format": "int64",
  20190. "x-go-name": "KeyID"
  20191. },
  20192. "read_only": {
  20193. "type": "boolean",
  20194. "x-go-name": "ReadOnly"
  20195. },
  20196. "repository": {
  20197. "$ref": "#/definitions/Repository"
  20198. },
  20199. "title": {
  20200. "type": "string",
  20201. "x-go-name": "Title"
  20202. },
  20203. "url": {
  20204. "type": "string",
  20205. "x-go-name": "URL"
  20206. }
  20207. },
  20208. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20209. },
  20210. "DismissPullReviewOptions": {
  20211. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  20212. "type": "object",
  20213. "properties": {
  20214. "message": {
  20215. "type": "string",
  20216. "x-go-name": "Message"
  20217. },
  20218. "priors": {
  20219. "type": "boolean",
  20220. "x-go-name": "Priors"
  20221. }
  20222. },
  20223. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20224. },
  20225. "EditAttachmentOptions": {
  20226. "description": "EditAttachmentOptions options for editing attachments",
  20227. "type": "object",
  20228. "properties": {
  20229. "name": {
  20230. "type": "string",
  20231. "x-go-name": "Name"
  20232. }
  20233. },
  20234. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20235. },
  20236. "EditBranchProtectionOption": {
  20237. "description": "EditBranchProtectionOption options for editing a branch protection",
  20238. "type": "object",
  20239. "properties": {
  20240. "approvals_whitelist_teams": {
  20241. "type": "array",
  20242. "items": {
  20243. "type": "string"
  20244. },
  20245. "x-go-name": "ApprovalsWhitelistTeams"
  20246. },
  20247. "approvals_whitelist_username": {
  20248. "type": "array",
  20249. "items": {
  20250. "type": "string"
  20251. },
  20252. "x-go-name": "ApprovalsWhitelistUsernames"
  20253. },
  20254. "block_on_official_review_requests": {
  20255. "type": "boolean",
  20256. "x-go-name": "BlockOnOfficialReviewRequests"
  20257. },
  20258. "block_on_outdated_branch": {
  20259. "type": "boolean",
  20260. "x-go-name": "BlockOnOutdatedBranch"
  20261. },
  20262. "block_on_rejected_reviews": {
  20263. "type": "boolean",
  20264. "x-go-name": "BlockOnRejectedReviews"
  20265. },
  20266. "dismiss_stale_approvals": {
  20267. "type": "boolean",
  20268. "x-go-name": "DismissStaleApprovals"
  20269. },
  20270. "enable_approvals_whitelist": {
  20271. "type": "boolean",
  20272. "x-go-name": "EnableApprovalsWhitelist"
  20273. },
  20274. "enable_merge_whitelist": {
  20275. "type": "boolean",
  20276. "x-go-name": "EnableMergeWhitelist"
  20277. },
  20278. "enable_push": {
  20279. "type": "boolean",
  20280. "x-go-name": "EnablePush"
  20281. },
  20282. "enable_push_whitelist": {
  20283. "type": "boolean",
  20284. "x-go-name": "EnablePushWhitelist"
  20285. },
  20286. "enable_status_check": {
  20287. "type": "boolean",
  20288. "x-go-name": "EnableStatusCheck"
  20289. },
  20290. "ignore_stale_approvals": {
  20291. "type": "boolean",
  20292. "x-go-name": "IgnoreStaleApprovals"
  20293. },
  20294. "merge_whitelist_teams": {
  20295. "type": "array",
  20296. "items": {
  20297. "type": "string"
  20298. },
  20299. "x-go-name": "MergeWhitelistTeams"
  20300. },
  20301. "merge_whitelist_usernames": {
  20302. "type": "array",
  20303. "items": {
  20304. "type": "string"
  20305. },
  20306. "x-go-name": "MergeWhitelistUsernames"
  20307. },
  20308. "protected_file_patterns": {
  20309. "type": "string",
  20310. "x-go-name": "ProtectedFilePatterns"
  20311. },
  20312. "push_whitelist_deploy_keys": {
  20313. "type": "boolean",
  20314. "x-go-name": "PushWhitelistDeployKeys"
  20315. },
  20316. "push_whitelist_teams": {
  20317. "type": "array",
  20318. "items": {
  20319. "type": "string"
  20320. },
  20321. "x-go-name": "PushWhitelistTeams"
  20322. },
  20323. "push_whitelist_usernames": {
  20324. "type": "array",
  20325. "items": {
  20326. "type": "string"
  20327. },
  20328. "x-go-name": "PushWhitelistUsernames"
  20329. },
  20330. "require_signed_commits": {
  20331. "type": "boolean",
  20332. "x-go-name": "RequireSignedCommits"
  20333. },
  20334. "required_approvals": {
  20335. "type": "integer",
  20336. "format": "int64",
  20337. "x-go-name": "RequiredApprovals"
  20338. },
  20339. "status_check_contexts": {
  20340. "type": "array",
  20341. "items": {
  20342. "type": "string"
  20343. },
  20344. "x-go-name": "StatusCheckContexts"
  20345. },
  20346. "unprotected_file_patterns": {
  20347. "type": "string",
  20348. "x-go-name": "UnprotectedFilePatterns"
  20349. }
  20350. },
  20351. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20352. },
  20353. "EditDeadlineOption": {
  20354. "description": "EditDeadlineOption options for creating a deadline",
  20355. "type": "object",
  20356. "required": [
  20357. "due_date"
  20358. ],
  20359. "properties": {
  20360. "due_date": {
  20361. "type": "string",
  20362. "format": "date-time",
  20363. "x-go-name": "Deadline"
  20364. }
  20365. },
  20366. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20367. },
  20368. "EditGitHookOption": {
  20369. "description": "EditGitHookOption options when modifying one Git hook",
  20370. "type": "object",
  20371. "properties": {
  20372. "content": {
  20373. "type": "string",
  20374. "x-go-name": "Content"
  20375. }
  20376. },
  20377. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20378. },
  20379. "EditHookOption": {
  20380. "description": "EditHookOption options when modify one hook",
  20381. "type": "object",
  20382. "properties": {
  20383. "active": {
  20384. "type": "boolean",
  20385. "x-go-name": "Active"
  20386. },
  20387. "authorization_header": {
  20388. "type": "string",
  20389. "x-go-name": "AuthorizationHeader"
  20390. },
  20391. "branch_filter": {
  20392. "type": "string",
  20393. "x-go-name": "BranchFilter"
  20394. },
  20395. "config": {
  20396. "type": "object",
  20397. "additionalProperties": {
  20398. "type": "string"
  20399. },
  20400. "x-go-name": "Config"
  20401. },
  20402. "events": {
  20403. "type": "array",
  20404. "items": {
  20405. "type": "string"
  20406. },
  20407. "x-go-name": "Events"
  20408. }
  20409. },
  20410. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20411. },
  20412. "EditIssueCommentOption": {
  20413. "description": "EditIssueCommentOption options for editing a comment",
  20414. "type": "object",
  20415. "required": [
  20416. "body"
  20417. ],
  20418. "properties": {
  20419. "body": {
  20420. "type": "string",
  20421. "x-go-name": "Body"
  20422. }
  20423. },
  20424. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20425. },
  20426. "EditIssueOption": {
  20427. "description": "EditIssueOption options for editing an issue",
  20428. "type": "object",
  20429. "properties": {
  20430. "assignee": {
  20431. "description": "deprecated",
  20432. "type": "string",
  20433. "x-go-name": "Assignee"
  20434. },
  20435. "assignees": {
  20436. "type": "array",
  20437. "items": {
  20438. "type": "string"
  20439. },
  20440. "x-go-name": "Assignees"
  20441. },
  20442. "body": {
  20443. "type": "string",
  20444. "x-go-name": "Body"
  20445. },
  20446. "due_date": {
  20447. "type": "string",
  20448. "format": "date-time",
  20449. "x-go-name": "Deadline"
  20450. },
  20451. "milestone": {
  20452. "type": "integer",
  20453. "format": "int64",
  20454. "x-go-name": "Milestone"
  20455. },
  20456. "ref": {
  20457. "type": "string",
  20458. "x-go-name": "Ref"
  20459. },
  20460. "state": {
  20461. "type": "string",
  20462. "x-go-name": "State"
  20463. },
  20464. "title": {
  20465. "type": "string",
  20466. "x-go-name": "Title"
  20467. },
  20468. "unset_due_date": {
  20469. "type": "boolean",
  20470. "x-go-name": "RemoveDeadline"
  20471. }
  20472. },
  20473. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20474. },
  20475. "EditLabelOption": {
  20476. "description": "EditLabelOption options for editing a label",
  20477. "type": "object",
  20478. "properties": {
  20479. "color": {
  20480. "type": "string",
  20481. "x-go-name": "Color",
  20482. "example": "#00aabb"
  20483. },
  20484. "description": {
  20485. "type": "string",
  20486. "x-go-name": "Description"
  20487. },
  20488. "exclusive": {
  20489. "type": "boolean",
  20490. "x-go-name": "Exclusive",
  20491. "example": false
  20492. },
  20493. "is_archived": {
  20494. "type": "boolean",
  20495. "x-go-name": "IsArchived",
  20496. "example": false
  20497. },
  20498. "name": {
  20499. "type": "string",
  20500. "x-go-name": "Name"
  20501. }
  20502. },
  20503. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20504. },
  20505. "EditMilestoneOption": {
  20506. "description": "EditMilestoneOption options for editing a milestone",
  20507. "type": "object",
  20508. "properties": {
  20509. "description": {
  20510. "type": "string",
  20511. "x-go-name": "Description"
  20512. },
  20513. "due_on": {
  20514. "type": "string",
  20515. "format": "date-time",
  20516. "x-go-name": "Deadline"
  20517. },
  20518. "state": {
  20519. "type": "string",
  20520. "x-go-name": "State"
  20521. },
  20522. "title": {
  20523. "type": "string",
  20524. "x-go-name": "Title"
  20525. }
  20526. },
  20527. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20528. },
  20529. "EditOrgOption": {
  20530. "description": "EditOrgOption options for editing an organization",
  20531. "type": "object",
  20532. "properties": {
  20533. "description": {
  20534. "type": "string",
  20535. "x-go-name": "Description"
  20536. },
  20537. "email": {
  20538. "type": "string",
  20539. "x-go-name": "Email"
  20540. },
  20541. "full_name": {
  20542. "type": "string",
  20543. "x-go-name": "FullName"
  20544. },
  20545. "location": {
  20546. "type": "string",
  20547. "x-go-name": "Location"
  20548. },
  20549. "repo_admin_change_team_access": {
  20550. "type": "boolean",
  20551. "x-go-name": "RepoAdminChangeTeamAccess"
  20552. },
  20553. "visibility": {
  20554. "description": "possible values are `public`, `limited` or `private`",
  20555. "type": "string",
  20556. "enum": [
  20557. "public",
  20558. "limited",
  20559. "private"
  20560. ],
  20561. "x-go-name": "Visibility"
  20562. },
  20563. "website": {
  20564. "type": "string",
  20565. "x-go-name": "Website"
  20566. }
  20567. },
  20568. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20569. },
  20570. "EditPullRequestOption": {
  20571. "description": "EditPullRequestOption options when modify pull request",
  20572. "type": "object",
  20573. "properties": {
  20574. "allow_maintainer_edit": {
  20575. "type": "boolean",
  20576. "x-go-name": "AllowMaintainerEdit"
  20577. },
  20578. "assignee": {
  20579. "type": "string",
  20580. "x-go-name": "Assignee"
  20581. },
  20582. "assignees": {
  20583. "type": "array",
  20584. "items": {
  20585. "type": "string"
  20586. },
  20587. "x-go-name": "Assignees"
  20588. },
  20589. "base": {
  20590. "type": "string",
  20591. "x-go-name": "Base"
  20592. },
  20593. "body": {
  20594. "type": "string",
  20595. "x-go-name": "Body"
  20596. },
  20597. "due_date": {
  20598. "type": "string",
  20599. "format": "date-time",
  20600. "x-go-name": "Deadline"
  20601. },
  20602. "labels": {
  20603. "type": "array",
  20604. "items": {
  20605. "type": "integer",
  20606. "format": "int64"
  20607. },
  20608. "x-go-name": "Labels"
  20609. },
  20610. "milestone": {
  20611. "type": "integer",
  20612. "format": "int64",
  20613. "x-go-name": "Milestone"
  20614. },
  20615. "state": {
  20616. "type": "string",
  20617. "x-go-name": "State"
  20618. },
  20619. "title": {
  20620. "type": "string",
  20621. "x-go-name": "Title"
  20622. },
  20623. "unset_due_date": {
  20624. "type": "boolean",
  20625. "x-go-name": "RemoveDeadline"
  20626. }
  20627. },
  20628. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20629. },
  20630. "EditReactionOption": {
  20631. "description": "EditReactionOption contain the reaction type",
  20632. "type": "object",
  20633. "properties": {
  20634. "content": {
  20635. "type": "string",
  20636. "x-go-name": "Reaction"
  20637. }
  20638. },
  20639. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20640. },
  20641. "EditReleaseOption": {
  20642. "description": "EditReleaseOption options when editing a release",
  20643. "type": "object",
  20644. "properties": {
  20645. "body": {
  20646. "type": "string",
  20647. "x-go-name": "Note"
  20648. },
  20649. "draft": {
  20650. "type": "boolean",
  20651. "x-go-name": "IsDraft"
  20652. },
  20653. "name": {
  20654. "type": "string",
  20655. "x-go-name": "Title"
  20656. },
  20657. "prerelease": {
  20658. "type": "boolean",
  20659. "x-go-name": "IsPrerelease"
  20660. },
  20661. "tag_name": {
  20662. "type": "string",
  20663. "x-go-name": "TagName"
  20664. },
  20665. "target_commitish": {
  20666. "type": "string",
  20667. "x-go-name": "Target"
  20668. }
  20669. },
  20670. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20671. },
  20672. "EditRepoOption": {
  20673. "description": "EditRepoOption options when editing a repository's properties",
  20674. "type": "object",
  20675. "properties": {
  20676. "allow_fast_forward_only_merge": {
  20677. "description": "either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging.",
  20678. "type": "boolean",
  20679. "x-go-name": "AllowFastForwardOnly"
  20680. },
  20681. "allow_manual_merge": {
  20682. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
  20683. "type": "boolean",
  20684. "x-go-name": "AllowManualMerge"
  20685. },
  20686. "allow_merge_commits": {
  20687. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  20688. "type": "boolean",
  20689. "x-go-name": "AllowMerge"
  20690. },
  20691. "allow_rebase": {
  20692. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  20693. "type": "boolean",
  20694. "x-go-name": "AllowRebase"
  20695. },
  20696. "allow_rebase_explicit": {
  20697. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
  20698. "type": "boolean",
  20699. "x-go-name": "AllowRebaseMerge"
  20700. },
  20701. "allow_rebase_update": {
  20702. "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
  20703. "type": "boolean",
  20704. "x-go-name": "AllowRebaseUpdate"
  20705. },
  20706. "allow_squash_merge": {
  20707. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  20708. "type": "boolean",
  20709. "x-go-name": "AllowSquash"
  20710. },
  20711. "archived": {
  20712. "description": "set to `true` to archive this repository.",
  20713. "type": "boolean",
  20714. "x-go-name": "Archived"
  20715. },
  20716. "autodetect_manual_merge": {
  20717. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
  20718. "type": "boolean",
  20719. "x-go-name": "AutodetectManualMerge"
  20720. },
  20721. "default_allow_maintainer_edit": {
  20722. "description": "set to `true` to allow edits from maintainers by default",
  20723. "type": "boolean",
  20724. "x-go-name": "DefaultAllowMaintainerEdit"
  20725. },
  20726. "default_branch": {
  20727. "description": "sets the default branch for this repository.",
  20728. "type": "string",
  20729. "x-go-name": "DefaultBranch"
  20730. },
  20731. "default_delete_branch_after_merge": {
  20732. "description": "set to `true` to delete pr branch after merge by default",
  20733. "type": "boolean",
  20734. "x-go-name": "DefaultDeleteBranchAfterMerge"
  20735. },
  20736. "default_merge_style": {
  20737. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", \"squash\", or \"fast-forward-only\".",
  20738. "type": "string",
  20739. "x-go-name": "DefaultMergeStyle"
  20740. },
  20741. "description": {
  20742. "description": "a short description of the repository.",
  20743. "type": "string",
  20744. "x-go-name": "Description"
  20745. },
  20746. "enable_prune": {
  20747. "description": "enable prune - remove obsolete remote-tracking references",
  20748. "type": "boolean",
  20749. "x-go-name": "EnablePrune"
  20750. },
  20751. "external_tracker": {
  20752. "$ref": "#/definitions/ExternalTracker"
  20753. },
  20754. "external_wiki": {
  20755. "$ref": "#/definitions/ExternalWiki"
  20756. },
  20757. "has_actions": {
  20758. "description": "either `true` to enable actions unit, or `false` to disable them.",
  20759. "type": "boolean",
  20760. "x-go-name": "HasActions"
  20761. },
  20762. "has_issues": {
  20763. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  20764. "type": "boolean",
  20765. "x-go-name": "HasIssues"
  20766. },
  20767. "has_packages": {
  20768. "description": "either `true` to enable packages unit, or `false` to disable them.",
  20769. "type": "boolean",
  20770. "x-go-name": "HasPackages"
  20771. },
  20772. "has_projects": {
  20773. "description": "either `true` to enable project unit, or `false` to disable them.",
  20774. "type": "boolean",
  20775. "x-go-name": "HasProjects"
  20776. },
  20777. "has_pull_requests": {
  20778. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  20779. "type": "boolean",
  20780. "x-go-name": "HasPullRequests"
  20781. },
  20782. "has_releases": {
  20783. "description": "either `true` to enable releases unit, or `false` to disable them.",
  20784. "type": "boolean",
  20785. "x-go-name": "HasReleases"
  20786. },
  20787. "has_wiki": {
  20788. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  20789. "type": "boolean",
  20790. "x-go-name": "HasWiki"
  20791. },
  20792. "ignore_whitespace_conflicts": {
  20793. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
  20794. "type": "boolean",
  20795. "x-go-name": "IgnoreWhitespaceConflicts"
  20796. },
  20797. "internal_tracker": {
  20798. "$ref": "#/definitions/InternalTracker"
  20799. },
  20800. "mirror_interval": {
  20801. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  20802. "type": "string",
  20803. "x-go-name": "MirrorInterval"
  20804. },
  20805. "name": {
  20806. "description": "name of the repository",
  20807. "type": "string",
  20808. "uniqueItems": true,
  20809. "x-go-name": "Name"
  20810. },
  20811. "private": {
  20812. "description": "either `true` to make the repository private or `false` to make it public.\nNote: you will get a 422 error if the organization restricts changing repository visibility to organization\nowners and a non-owner tries to change the value of private.",
  20813. "type": "boolean",
  20814. "x-go-name": "Private"
  20815. },
  20816. "projects_mode": {
  20817. "description": "`repo` to only allow repo-level projects, `owner` to only allow owner projects, `all` to allow both.",
  20818. "type": "string",
  20819. "x-go-name": "ProjectsMode"
  20820. },
  20821. "template": {
  20822. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  20823. "type": "boolean",
  20824. "x-go-name": "Template"
  20825. },
  20826. "website": {
  20827. "description": "a URL with more information about the repository.",
  20828. "type": "string",
  20829. "x-go-name": "Website"
  20830. }
  20831. },
  20832. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20833. },
  20834. "EditTeamOption": {
  20835. "description": "EditTeamOption options for editing a team",
  20836. "type": "object",
  20837. "required": [
  20838. "name"
  20839. ],
  20840. "properties": {
  20841. "can_create_org_repo": {
  20842. "type": "boolean",
  20843. "x-go-name": "CanCreateOrgRepo"
  20844. },
  20845. "description": {
  20846. "type": "string",
  20847. "x-go-name": "Description"
  20848. },
  20849. "includes_all_repositories": {
  20850. "type": "boolean",
  20851. "x-go-name": "IncludesAllRepositories"
  20852. },
  20853. "name": {
  20854. "type": "string",
  20855. "x-go-name": "Name"
  20856. },
  20857. "permission": {
  20858. "type": "string",
  20859. "enum": [
  20860. "read",
  20861. "write",
  20862. "admin"
  20863. ],
  20864. "x-go-name": "Permission"
  20865. },
  20866. "units": {
  20867. "type": "array",
  20868. "items": {
  20869. "type": "string"
  20870. },
  20871. "x-go-name": "Units",
  20872. "example": [
  20873. "repo.code",
  20874. "repo.issues",
  20875. "repo.ext_issues",
  20876. "repo.wiki",
  20877. "repo.pulls",
  20878. "repo.releases",
  20879. "repo.projects",
  20880. "repo.ext_wiki"
  20881. ]
  20882. },
  20883. "units_map": {
  20884. "type": "object",
  20885. "additionalProperties": {
  20886. "type": "string"
  20887. },
  20888. "x-go-name": "UnitsMap",
  20889. "example": {
  20890. "repo.code": "read",
  20891. "repo.ext_issues": "none",
  20892. "repo.ext_wiki": "none",
  20893. "repo.issues": "write",
  20894. "repo.projects": "none",
  20895. "repo.pulls": "owner",
  20896. "repo.releases": "none",
  20897. "repo.wiki": "admin"
  20898. }
  20899. }
  20900. },
  20901. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20902. },
  20903. "EditUserOption": {
  20904. "description": "EditUserOption edit user options",
  20905. "type": "object",
  20906. "required": [
  20907. "source_id",
  20908. "login_name"
  20909. ],
  20910. "properties": {
  20911. "active": {
  20912. "type": "boolean",
  20913. "x-go-name": "Active"
  20914. },
  20915. "admin": {
  20916. "type": "boolean",
  20917. "x-go-name": "Admin"
  20918. },
  20919. "allow_create_organization": {
  20920. "type": "boolean",
  20921. "x-go-name": "AllowCreateOrganization"
  20922. },
  20923. "allow_git_hook": {
  20924. "type": "boolean",
  20925. "x-go-name": "AllowGitHook"
  20926. },
  20927. "allow_import_local": {
  20928. "type": "boolean",
  20929. "x-go-name": "AllowImportLocal"
  20930. },
  20931. "description": {
  20932. "type": "string",
  20933. "x-go-name": "Description"
  20934. },
  20935. "email": {
  20936. "type": "string",
  20937. "format": "email",
  20938. "x-go-name": "Email"
  20939. },
  20940. "full_name": {
  20941. "type": "string",
  20942. "x-go-name": "FullName"
  20943. },
  20944. "location": {
  20945. "type": "string",
  20946. "x-go-name": "Location"
  20947. },
  20948. "login_name": {
  20949. "type": "string",
  20950. "x-go-name": "LoginName"
  20951. },
  20952. "max_repo_creation": {
  20953. "type": "integer",
  20954. "format": "int64",
  20955. "x-go-name": "MaxRepoCreation"
  20956. },
  20957. "must_change_password": {
  20958. "type": "boolean",
  20959. "x-go-name": "MustChangePassword"
  20960. },
  20961. "password": {
  20962. "type": "string",
  20963. "x-go-name": "Password"
  20964. },
  20965. "prohibit_login": {
  20966. "type": "boolean",
  20967. "x-go-name": "ProhibitLogin"
  20968. },
  20969. "restricted": {
  20970. "type": "boolean",
  20971. "x-go-name": "Restricted"
  20972. },
  20973. "source_id": {
  20974. "type": "integer",
  20975. "format": "int64",
  20976. "x-go-name": "SourceID"
  20977. },
  20978. "visibility": {
  20979. "type": "string",
  20980. "x-go-name": "Visibility"
  20981. },
  20982. "website": {
  20983. "type": "string",
  20984. "x-go-name": "Website"
  20985. }
  20986. },
  20987. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20988. },
  20989. "Email": {
  20990. "description": "Email an email address belonging to a user",
  20991. "type": "object",
  20992. "properties": {
  20993. "email": {
  20994. "type": "string",
  20995. "format": "email",
  20996. "x-go-name": "Email"
  20997. },
  20998. "primary": {
  20999. "type": "boolean",
  21000. "x-go-name": "Primary"
  21001. },
  21002. "user_id": {
  21003. "type": "integer",
  21004. "format": "int64",
  21005. "x-go-name": "UserID"
  21006. },
  21007. "username": {
  21008. "type": "string",
  21009. "x-go-name": "UserName"
  21010. },
  21011. "verified": {
  21012. "type": "boolean",
  21013. "x-go-name": "Verified"
  21014. }
  21015. },
  21016. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21017. },
  21018. "ExternalTracker": {
  21019. "description": "ExternalTracker represents settings for external tracker",
  21020. "type": "object",
  21021. "properties": {
  21022. "external_tracker_format": {
  21023. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  21024. "type": "string",
  21025. "x-go-name": "ExternalTrackerFormat"
  21026. },
  21027. "external_tracker_regexp_pattern": {
  21028. "description": "External Issue Tracker issue regular expression",
  21029. "type": "string",
  21030. "x-go-name": "ExternalTrackerRegexpPattern"
  21031. },
  21032. "external_tracker_style": {
  21033. "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
  21034. "type": "string",
  21035. "x-go-name": "ExternalTrackerStyle"
  21036. },
  21037. "external_tracker_url": {
  21038. "description": "URL of external issue tracker.",
  21039. "type": "string",
  21040. "x-go-name": "ExternalTrackerURL"
  21041. }
  21042. },
  21043. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21044. },
  21045. "ExternalWiki": {
  21046. "description": "ExternalWiki represents setting for external wiki",
  21047. "type": "object",
  21048. "properties": {
  21049. "external_wiki_url": {
  21050. "description": "URL of external wiki.",
  21051. "type": "string",
  21052. "x-go-name": "ExternalWikiURL"
  21053. }
  21054. },
  21055. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21056. },
  21057. "FileCommitResponse": {
  21058. "type": "object",
  21059. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  21060. "properties": {
  21061. "author": {
  21062. "$ref": "#/definitions/CommitUser"
  21063. },
  21064. "committer": {
  21065. "$ref": "#/definitions/CommitUser"
  21066. },
  21067. "created": {
  21068. "type": "string",
  21069. "format": "date-time",
  21070. "x-go-name": "Created"
  21071. },
  21072. "html_url": {
  21073. "type": "string",
  21074. "x-go-name": "HTMLURL"
  21075. },
  21076. "message": {
  21077. "type": "string",
  21078. "x-go-name": "Message"
  21079. },
  21080. "parents": {
  21081. "type": "array",
  21082. "items": {
  21083. "$ref": "#/definitions/CommitMeta"
  21084. },
  21085. "x-go-name": "Parents"
  21086. },
  21087. "sha": {
  21088. "type": "string",
  21089. "x-go-name": "SHA"
  21090. },
  21091. "tree": {
  21092. "$ref": "#/definitions/CommitMeta"
  21093. },
  21094. "url": {
  21095. "type": "string",
  21096. "x-go-name": "URL"
  21097. }
  21098. },
  21099. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21100. },
  21101. "FileDeleteResponse": {
  21102. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  21103. "type": "object",
  21104. "properties": {
  21105. "commit": {
  21106. "$ref": "#/definitions/FileCommitResponse"
  21107. },
  21108. "content": {
  21109. "x-go-name": "Content"
  21110. },
  21111. "verification": {
  21112. "$ref": "#/definitions/PayloadCommitVerification"
  21113. }
  21114. },
  21115. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21116. },
  21117. "FileLinksResponse": {
  21118. "description": "FileLinksResponse contains the links for a repo's file",
  21119. "type": "object",
  21120. "properties": {
  21121. "git": {
  21122. "type": "string",
  21123. "x-go-name": "GitURL"
  21124. },
  21125. "html": {
  21126. "type": "string",
  21127. "x-go-name": "HTMLURL"
  21128. },
  21129. "self": {
  21130. "type": "string",
  21131. "x-go-name": "Self"
  21132. }
  21133. },
  21134. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21135. },
  21136. "FileResponse": {
  21137. "description": "FileResponse contains information about a repo's file",
  21138. "type": "object",
  21139. "properties": {
  21140. "commit": {
  21141. "$ref": "#/definitions/FileCommitResponse"
  21142. },
  21143. "content": {
  21144. "$ref": "#/definitions/ContentsResponse"
  21145. },
  21146. "verification": {
  21147. "$ref": "#/definitions/PayloadCommitVerification"
  21148. }
  21149. },
  21150. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21151. },
  21152. "FilesResponse": {
  21153. "description": "FilesResponse contains information about multiple files from a repo",
  21154. "type": "object",
  21155. "properties": {
  21156. "commit": {
  21157. "$ref": "#/definitions/FileCommitResponse"
  21158. },
  21159. "files": {
  21160. "type": "array",
  21161. "items": {
  21162. "$ref": "#/definitions/ContentsResponse"
  21163. },
  21164. "x-go-name": "Files"
  21165. },
  21166. "verification": {
  21167. "$ref": "#/definitions/PayloadCommitVerification"
  21168. }
  21169. },
  21170. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21171. },
  21172. "GPGKey": {
  21173. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  21174. "type": "object",
  21175. "properties": {
  21176. "can_certify": {
  21177. "type": "boolean",
  21178. "x-go-name": "CanCertify"
  21179. },
  21180. "can_encrypt_comms": {
  21181. "type": "boolean",
  21182. "x-go-name": "CanEncryptComms"
  21183. },
  21184. "can_encrypt_storage": {
  21185. "type": "boolean",
  21186. "x-go-name": "CanEncryptStorage"
  21187. },
  21188. "can_sign": {
  21189. "type": "boolean",
  21190. "x-go-name": "CanSign"
  21191. },
  21192. "created_at": {
  21193. "type": "string",
  21194. "format": "date-time",
  21195. "x-go-name": "Created"
  21196. },
  21197. "emails": {
  21198. "type": "array",
  21199. "items": {
  21200. "$ref": "#/definitions/GPGKeyEmail"
  21201. },
  21202. "x-go-name": "Emails"
  21203. },
  21204. "expires_at": {
  21205. "type": "string",
  21206. "format": "date-time",
  21207. "x-go-name": "Expires"
  21208. },
  21209. "id": {
  21210. "type": "integer",
  21211. "format": "int64",
  21212. "x-go-name": "ID"
  21213. },
  21214. "key_id": {
  21215. "type": "string",
  21216. "x-go-name": "KeyID"
  21217. },
  21218. "primary_key_id": {
  21219. "type": "string",
  21220. "x-go-name": "PrimaryKeyID"
  21221. },
  21222. "public_key": {
  21223. "type": "string",
  21224. "x-go-name": "PublicKey"
  21225. },
  21226. "subkeys": {
  21227. "type": "array",
  21228. "items": {
  21229. "$ref": "#/definitions/GPGKey"
  21230. },
  21231. "x-go-name": "SubsKey"
  21232. },
  21233. "verified": {
  21234. "type": "boolean",
  21235. "x-go-name": "Verified"
  21236. }
  21237. },
  21238. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21239. },
  21240. "GPGKeyEmail": {
  21241. "description": "GPGKeyEmail an email attached to a GPGKey",
  21242. "type": "object",
  21243. "properties": {
  21244. "email": {
  21245. "type": "string",
  21246. "x-go-name": "Email"
  21247. },
  21248. "verified": {
  21249. "type": "boolean",
  21250. "x-go-name": "Verified"
  21251. }
  21252. },
  21253. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21254. },
  21255. "GeneralAPISettings": {
  21256. "description": "GeneralAPISettings contains global api settings exposed by it",
  21257. "type": "object",
  21258. "properties": {
  21259. "default_git_trees_per_page": {
  21260. "type": "integer",
  21261. "format": "int64",
  21262. "x-go-name": "DefaultGitTreesPerPage"
  21263. },
  21264. "default_max_blob_size": {
  21265. "type": "integer",
  21266. "format": "int64",
  21267. "x-go-name": "DefaultMaxBlobSize"
  21268. },
  21269. "default_paging_num": {
  21270. "type": "integer",
  21271. "format": "int64",
  21272. "x-go-name": "DefaultPagingNum"
  21273. },
  21274. "max_response_items": {
  21275. "type": "integer",
  21276. "format": "int64",
  21277. "x-go-name": "MaxResponseItems"
  21278. }
  21279. },
  21280. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21281. },
  21282. "GeneralAttachmentSettings": {
  21283. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  21284. "type": "object",
  21285. "properties": {
  21286. "allowed_types": {
  21287. "type": "string",
  21288. "x-go-name": "AllowedTypes"
  21289. },
  21290. "enabled": {
  21291. "type": "boolean",
  21292. "x-go-name": "Enabled"
  21293. },
  21294. "max_files": {
  21295. "type": "integer",
  21296. "format": "int64",
  21297. "x-go-name": "MaxFiles"
  21298. },
  21299. "max_size": {
  21300. "type": "integer",
  21301. "format": "int64",
  21302. "x-go-name": "MaxSize"
  21303. }
  21304. },
  21305. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21306. },
  21307. "GeneralRepoSettings": {
  21308. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  21309. "type": "object",
  21310. "properties": {
  21311. "http_git_disabled": {
  21312. "type": "boolean",
  21313. "x-go-name": "HTTPGitDisabled"
  21314. },
  21315. "lfs_disabled": {
  21316. "type": "boolean",
  21317. "x-go-name": "LFSDisabled"
  21318. },
  21319. "migrations_disabled": {
  21320. "type": "boolean",
  21321. "x-go-name": "MigrationsDisabled"
  21322. },
  21323. "mirrors_disabled": {
  21324. "type": "boolean",
  21325. "x-go-name": "MirrorsDisabled"
  21326. },
  21327. "stars_disabled": {
  21328. "type": "boolean",
  21329. "x-go-name": "StarsDisabled"
  21330. },
  21331. "time_tracking_disabled": {
  21332. "type": "boolean",
  21333. "x-go-name": "TimeTrackingDisabled"
  21334. }
  21335. },
  21336. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21337. },
  21338. "GeneralUISettings": {
  21339. "description": "GeneralUISettings contains global ui settings exposed by API",
  21340. "type": "object",
  21341. "properties": {
  21342. "allowed_reactions": {
  21343. "type": "array",
  21344. "items": {
  21345. "type": "string"
  21346. },
  21347. "x-go-name": "AllowedReactions"
  21348. },
  21349. "custom_emojis": {
  21350. "type": "array",
  21351. "items": {
  21352. "type": "string"
  21353. },
  21354. "x-go-name": "CustomEmojis"
  21355. },
  21356. "default_theme": {
  21357. "type": "string",
  21358. "x-go-name": "DefaultTheme"
  21359. }
  21360. },
  21361. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21362. },
  21363. "GenerateRepoOption": {
  21364. "description": "GenerateRepoOption options when creating repository using a template",
  21365. "type": "object",
  21366. "required": [
  21367. "owner",
  21368. "name"
  21369. ],
  21370. "properties": {
  21371. "avatar": {
  21372. "description": "include avatar of the template repo",
  21373. "type": "boolean",
  21374. "x-go-name": "Avatar"
  21375. },
  21376. "default_branch": {
  21377. "description": "Default branch of the new repository",
  21378. "type": "string",
  21379. "x-go-name": "DefaultBranch"
  21380. },
  21381. "description": {
  21382. "description": "Description of the repository to create",
  21383. "type": "string",
  21384. "x-go-name": "Description"
  21385. },
  21386. "git_content": {
  21387. "description": "include git content of default branch in template repo",
  21388. "type": "boolean",
  21389. "x-go-name": "GitContent"
  21390. },
  21391. "git_hooks": {
  21392. "description": "include git hooks in template repo",
  21393. "type": "boolean",
  21394. "x-go-name": "GitHooks"
  21395. },
  21396. "labels": {
  21397. "description": "include labels in template repo",
  21398. "type": "boolean",
  21399. "x-go-name": "Labels"
  21400. },
  21401. "name": {
  21402. "description": "Name of the repository to create",
  21403. "type": "string",
  21404. "uniqueItems": true,
  21405. "x-go-name": "Name"
  21406. },
  21407. "owner": {
  21408. "description": "The organization or person who will own the new repository",
  21409. "type": "string",
  21410. "x-go-name": "Owner"
  21411. },
  21412. "private": {
  21413. "description": "Whether the repository is private",
  21414. "type": "boolean",
  21415. "x-go-name": "Private"
  21416. },
  21417. "protected_branch": {
  21418. "description": "include protected branches in template repo",
  21419. "type": "boolean",
  21420. "x-go-name": "ProtectedBranch"
  21421. },
  21422. "topics": {
  21423. "description": "include topics in template repo",
  21424. "type": "boolean",
  21425. "x-go-name": "Topics"
  21426. },
  21427. "webhooks": {
  21428. "description": "include webhooks in template repo",
  21429. "type": "boolean",
  21430. "x-go-name": "Webhooks"
  21431. }
  21432. },
  21433. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21434. },
  21435. "GitBlobResponse": {
  21436. "description": "GitBlobResponse represents a git blob",
  21437. "type": "object",
  21438. "properties": {
  21439. "content": {
  21440. "type": "string",
  21441. "x-go-name": "Content"
  21442. },
  21443. "encoding": {
  21444. "type": "string",
  21445. "x-go-name": "Encoding"
  21446. },
  21447. "sha": {
  21448. "type": "string",
  21449. "x-go-name": "SHA"
  21450. },
  21451. "size": {
  21452. "type": "integer",
  21453. "format": "int64",
  21454. "x-go-name": "Size"
  21455. },
  21456. "url": {
  21457. "type": "string",
  21458. "x-go-name": "URL"
  21459. }
  21460. },
  21461. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21462. },
  21463. "GitEntry": {
  21464. "description": "GitEntry represents a git tree",
  21465. "type": "object",
  21466. "properties": {
  21467. "mode": {
  21468. "type": "string",
  21469. "x-go-name": "Mode"
  21470. },
  21471. "path": {
  21472. "type": "string",
  21473. "x-go-name": "Path"
  21474. },
  21475. "sha": {
  21476. "type": "string",
  21477. "x-go-name": "SHA"
  21478. },
  21479. "size": {
  21480. "type": "integer",
  21481. "format": "int64",
  21482. "x-go-name": "Size"
  21483. },
  21484. "type": {
  21485. "type": "string",
  21486. "x-go-name": "Type"
  21487. },
  21488. "url": {
  21489. "type": "string",
  21490. "x-go-name": "URL"
  21491. }
  21492. },
  21493. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21494. },
  21495. "GitHook": {
  21496. "description": "GitHook represents a Git repository hook",
  21497. "type": "object",
  21498. "properties": {
  21499. "content": {
  21500. "type": "string",
  21501. "x-go-name": "Content"
  21502. },
  21503. "is_active": {
  21504. "type": "boolean",
  21505. "x-go-name": "IsActive"
  21506. },
  21507. "name": {
  21508. "type": "string",
  21509. "x-go-name": "Name"
  21510. }
  21511. },
  21512. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21513. },
  21514. "GitObject": {
  21515. "type": "object",
  21516. "title": "GitObject represents a Git object.",
  21517. "properties": {
  21518. "sha": {
  21519. "type": "string",
  21520. "x-go-name": "SHA"
  21521. },
  21522. "type": {
  21523. "type": "string",
  21524. "x-go-name": "Type"
  21525. },
  21526. "url": {
  21527. "type": "string",
  21528. "x-go-name": "URL"
  21529. }
  21530. },
  21531. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21532. },
  21533. "GitTreeResponse": {
  21534. "description": "GitTreeResponse returns a git tree",
  21535. "type": "object",
  21536. "properties": {
  21537. "page": {
  21538. "type": "integer",
  21539. "format": "int64",
  21540. "x-go-name": "Page"
  21541. },
  21542. "sha": {
  21543. "type": "string",
  21544. "x-go-name": "SHA"
  21545. },
  21546. "total_count": {
  21547. "type": "integer",
  21548. "format": "int64",
  21549. "x-go-name": "TotalCount"
  21550. },
  21551. "tree": {
  21552. "type": "array",
  21553. "items": {
  21554. "$ref": "#/definitions/GitEntry"
  21555. },
  21556. "x-go-name": "Entries"
  21557. },
  21558. "truncated": {
  21559. "type": "boolean",
  21560. "x-go-name": "Truncated"
  21561. },
  21562. "url": {
  21563. "type": "string",
  21564. "x-go-name": "URL"
  21565. }
  21566. },
  21567. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21568. },
  21569. "GitignoreTemplateInfo": {
  21570. "description": "GitignoreTemplateInfo name and text of a gitignore template",
  21571. "type": "object",
  21572. "properties": {
  21573. "name": {
  21574. "type": "string",
  21575. "x-go-name": "Name"
  21576. },
  21577. "source": {
  21578. "type": "string",
  21579. "x-go-name": "Source"
  21580. }
  21581. },
  21582. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21583. },
  21584. "Hook": {
  21585. "description": "Hook a hook is a web hook when one repository changed",
  21586. "type": "object",
  21587. "properties": {
  21588. "active": {
  21589. "type": "boolean",
  21590. "x-go-name": "Active"
  21591. },
  21592. "authorization_header": {
  21593. "type": "string",
  21594. "x-go-name": "AuthorizationHeader"
  21595. },
  21596. "branch_filter": {
  21597. "type": "string",
  21598. "x-go-name": "BranchFilter"
  21599. },
  21600. "config": {
  21601. "type": "object",
  21602. "additionalProperties": {
  21603. "type": "string"
  21604. },
  21605. "x-go-name": "Config"
  21606. },
  21607. "created_at": {
  21608. "type": "string",
  21609. "format": "date-time",
  21610. "x-go-name": "Created"
  21611. },
  21612. "events": {
  21613. "type": "array",
  21614. "items": {
  21615. "type": "string"
  21616. },
  21617. "x-go-name": "Events"
  21618. },
  21619. "id": {
  21620. "type": "integer",
  21621. "format": "int64",
  21622. "x-go-name": "ID"
  21623. },
  21624. "type": {
  21625. "type": "string",
  21626. "x-go-name": "Type"
  21627. },
  21628. "updated_at": {
  21629. "type": "string",
  21630. "format": "date-time",
  21631. "x-go-name": "Updated"
  21632. }
  21633. },
  21634. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21635. },
  21636. "Identity": {
  21637. "description": "Identity for a person's identity like an author or committer",
  21638. "type": "object",
  21639. "properties": {
  21640. "email": {
  21641. "type": "string",
  21642. "format": "email",
  21643. "x-go-name": "Email"
  21644. },
  21645. "name": {
  21646. "type": "string",
  21647. "x-go-name": "Name"
  21648. }
  21649. },
  21650. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21651. },
  21652. "InternalTracker": {
  21653. "description": "InternalTracker represents settings for internal tracker",
  21654. "type": "object",
  21655. "properties": {
  21656. "allow_only_contributors_to_track_time": {
  21657. "description": "Let only contributors track time (Built-in issue tracker)",
  21658. "type": "boolean",
  21659. "x-go-name": "AllowOnlyContributorsToTrackTime"
  21660. },
  21661. "enable_issue_dependencies": {
  21662. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  21663. "type": "boolean",
  21664. "x-go-name": "EnableIssueDependencies"
  21665. },
  21666. "enable_time_tracker": {
  21667. "description": "Enable time tracking (Built-in issue tracker)",
  21668. "type": "boolean",
  21669. "x-go-name": "EnableTimeTracker"
  21670. }
  21671. },
  21672. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21673. },
  21674. "Issue": {
  21675. "description": "Issue represents an issue in a repository",
  21676. "type": "object",
  21677. "properties": {
  21678. "assets": {
  21679. "type": "array",
  21680. "items": {
  21681. "$ref": "#/definitions/Attachment"
  21682. },
  21683. "x-go-name": "Attachments"
  21684. },
  21685. "assignee": {
  21686. "$ref": "#/definitions/User"
  21687. },
  21688. "assignees": {
  21689. "type": "array",
  21690. "items": {
  21691. "$ref": "#/definitions/User"
  21692. },
  21693. "x-go-name": "Assignees"
  21694. },
  21695. "body": {
  21696. "type": "string",
  21697. "x-go-name": "Body"
  21698. },
  21699. "closed_at": {
  21700. "type": "string",
  21701. "format": "date-time",
  21702. "x-go-name": "Closed"
  21703. },
  21704. "comments": {
  21705. "type": "integer",
  21706. "format": "int64",
  21707. "x-go-name": "Comments"
  21708. },
  21709. "created_at": {
  21710. "type": "string",
  21711. "format": "date-time",
  21712. "x-go-name": "Created"
  21713. },
  21714. "due_date": {
  21715. "type": "string",
  21716. "format": "date-time",
  21717. "x-go-name": "Deadline"
  21718. },
  21719. "html_url": {
  21720. "type": "string",
  21721. "x-go-name": "HTMLURL"
  21722. },
  21723. "id": {
  21724. "type": "integer",
  21725. "format": "int64",
  21726. "x-go-name": "ID"
  21727. },
  21728. "is_locked": {
  21729. "type": "boolean",
  21730. "x-go-name": "IsLocked"
  21731. },
  21732. "labels": {
  21733. "type": "array",
  21734. "items": {
  21735. "$ref": "#/definitions/Label"
  21736. },
  21737. "x-go-name": "Labels"
  21738. },
  21739. "milestone": {
  21740. "$ref": "#/definitions/Milestone"
  21741. },
  21742. "number": {
  21743. "type": "integer",
  21744. "format": "int64",
  21745. "x-go-name": "Index"
  21746. },
  21747. "original_author": {
  21748. "type": "string",
  21749. "x-go-name": "OriginalAuthor"
  21750. },
  21751. "original_author_id": {
  21752. "type": "integer",
  21753. "format": "int64",
  21754. "x-go-name": "OriginalAuthorID"
  21755. },
  21756. "pin_order": {
  21757. "type": "integer",
  21758. "format": "int64",
  21759. "x-go-name": "PinOrder"
  21760. },
  21761. "pull_request": {
  21762. "$ref": "#/definitions/PullRequestMeta"
  21763. },
  21764. "ref": {
  21765. "type": "string",
  21766. "x-go-name": "Ref"
  21767. },
  21768. "repository": {
  21769. "$ref": "#/definitions/RepositoryMeta"
  21770. },
  21771. "state": {
  21772. "$ref": "#/definitions/StateType"
  21773. },
  21774. "title": {
  21775. "type": "string",
  21776. "x-go-name": "Title"
  21777. },
  21778. "updated_at": {
  21779. "type": "string",
  21780. "format": "date-time",
  21781. "x-go-name": "Updated"
  21782. },
  21783. "url": {
  21784. "type": "string",
  21785. "x-go-name": "URL"
  21786. },
  21787. "user": {
  21788. "$ref": "#/definitions/User"
  21789. }
  21790. },
  21791. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21792. },
  21793. "IssueConfig": {
  21794. "type": "object",
  21795. "properties": {
  21796. "blank_issues_enabled": {
  21797. "type": "boolean",
  21798. "x-go-name": "BlankIssuesEnabled"
  21799. },
  21800. "contact_links": {
  21801. "type": "array",
  21802. "items": {
  21803. "$ref": "#/definitions/IssueConfigContactLink"
  21804. },
  21805. "x-go-name": "ContactLinks"
  21806. }
  21807. },
  21808. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21809. },
  21810. "IssueConfigContactLink": {
  21811. "type": "object",
  21812. "properties": {
  21813. "about": {
  21814. "type": "string",
  21815. "x-go-name": "About"
  21816. },
  21817. "name": {
  21818. "type": "string",
  21819. "x-go-name": "Name"
  21820. },
  21821. "url": {
  21822. "type": "string",
  21823. "x-go-name": "URL"
  21824. }
  21825. },
  21826. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21827. },
  21828. "IssueConfigValidation": {
  21829. "type": "object",
  21830. "properties": {
  21831. "message": {
  21832. "type": "string",
  21833. "x-go-name": "Message"
  21834. },
  21835. "valid": {
  21836. "type": "boolean",
  21837. "x-go-name": "Valid"
  21838. }
  21839. },
  21840. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21841. },
  21842. "IssueDeadline": {
  21843. "description": "IssueDeadline represents an issue deadline",
  21844. "type": "object",
  21845. "properties": {
  21846. "due_date": {
  21847. "type": "string",
  21848. "format": "date-time",
  21849. "x-go-name": "Deadline"
  21850. }
  21851. },
  21852. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21853. },
  21854. "IssueFormField": {
  21855. "description": "IssueFormField represents a form field",
  21856. "type": "object",
  21857. "properties": {
  21858. "attributes": {
  21859. "type": "object",
  21860. "additionalProperties": {},
  21861. "x-go-name": "Attributes"
  21862. },
  21863. "id": {
  21864. "type": "string",
  21865. "x-go-name": "ID"
  21866. },
  21867. "type": {
  21868. "$ref": "#/definitions/IssueFormFieldType"
  21869. },
  21870. "validations": {
  21871. "type": "object",
  21872. "additionalProperties": {},
  21873. "x-go-name": "Validations"
  21874. },
  21875. "visible": {
  21876. "type": "array",
  21877. "items": {
  21878. "$ref": "#/definitions/IssueFormFieldVisible"
  21879. },
  21880. "x-go-name": "Visible"
  21881. }
  21882. },
  21883. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21884. },
  21885. "IssueFormFieldType": {
  21886. "type": "string",
  21887. "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
  21888. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21889. },
  21890. "IssueFormFieldVisible": {
  21891. "description": "IssueFormFieldVisible defines issue form field visible",
  21892. "type": "string",
  21893. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21894. },
  21895. "IssueLabelsOption": {
  21896. "description": "IssueLabelsOption a collection of labels",
  21897. "type": "object",
  21898. "properties": {
  21899. "labels": {
  21900. "description": "list of label IDs",
  21901. "type": "array",
  21902. "items": {
  21903. "type": "integer",
  21904. "format": "int64"
  21905. },
  21906. "x-go-name": "Labels"
  21907. }
  21908. },
  21909. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21910. },
  21911. "IssueMeta": {
  21912. "description": "IssueMeta basic issue information",
  21913. "type": "object",
  21914. "properties": {
  21915. "index": {
  21916. "type": "integer",
  21917. "format": "int64",
  21918. "x-go-name": "Index"
  21919. },
  21920. "owner": {
  21921. "type": "string",
  21922. "x-go-name": "Owner"
  21923. },
  21924. "repo": {
  21925. "type": "string",
  21926. "x-go-name": "Name"
  21927. }
  21928. },
  21929. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21930. },
  21931. "IssueTemplate": {
  21932. "description": "IssueTemplate represents an issue template for a repository",
  21933. "type": "object",
  21934. "properties": {
  21935. "about": {
  21936. "type": "string",
  21937. "x-go-name": "About"
  21938. },
  21939. "body": {
  21940. "type": "array",
  21941. "items": {
  21942. "$ref": "#/definitions/IssueFormField"
  21943. },
  21944. "x-go-name": "Fields"
  21945. },
  21946. "content": {
  21947. "type": "string",
  21948. "x-go-name": "Content"
  21949. },
  21950. "file_name": {
  21951. "type": "string",
  21952. "x-go-name": "FileName"
  21953. },
  21954. "labels": {
  21955. "$ref": "#/definitions/IssueTemplateLabels"
  21956. },
  21957. "name": {
  21958. "type": "string",
  21959. "x-go-name": "Name"
  21960. },
  21961. "ref": {
  21962. "type": "string",
  21963. "x-go-name": "Ref"
  21964. },
  21965. "title": {
  21966. "type": "string",
  21967. "x-go-name": "Title"
  21968. }
  21969. },
  21970. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21971. },
  21972. "IssueTemplateLabels": {
  21973. "type": "array",
  21974. "items": {
  21975. "type": "string"
  21976. },
  21977. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21978. },
  21979. "Label": {
  21980. "description": "Label a label to an issue or a pr",
  21981. "type": "object",
  21982. "properties": {
  21983. "color": {
  21984. "type": "string",
  21985. "x-go-name": "Color",
  21986. "example": "00aabb"
  21987. },
  21988. "description": {
  21989. "type": "string",
  21990. "x-go-name": "Description"
  21991. },
  21992. "exclusive": {
  21993. "type": "boolean",
  21994. "x-go-name": "Exclusive",
  21995. "example": false
  21996. },
  21997. "id": {
  21998. "type": "integer",
  21999. "format": "int64",
  22000. "x-go-name": "ID"
  22001. },
  22002. "is_archived": {
  22003. "type": "boolean",
  22004. "x-go-name": "IsArchived",
  22005. "example": false
  22006. },
  22007. "name": {
  22008. "type": "string",
  22009. "x-go-name": "Name"
  22010. },
  22011. "url": {
  22012. "type": "string",
  22013. "x-go-name": "URL"
  22014. }
  22015. },
  22016. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22017. },
  22018. "LabelTemplate": {
  22019. "description": "LabelTemplate info of a Label template",
  22020. "type": "object",
  22021. "properties": {
  22022. "color": {
  22023. "type": "string",
  22024. "x-go-name": "Color",
  22025. "example": "00aabb"
  22026. },
  22027. "description": {
  22028. "type": "string",
  22029. "x-go-name": "Description"
  22030. },
  22031. "exclusive": {
  22032. "type": "boolean",
  22033. "x-go-name": "Exclusive",
  22034. "example": false
  22035. },
  22036. "name": {
  22037. "type": "string",
  22038. "x-go-name": "Name"
  22039. }
  22040. },
  22041. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22042. },
  22043. "LicenseTemplateInfo": {
  22044. "description": "LicensesInfo contains information about a License",
  22045. "type": "object",
  22046. "properties": {
  22047. "body": {
  22048. "type": "string",
  22049. "x-go-name": "Body"
  22050. },
  22051. "implementation": {
  22052. "type": "string",
  22053. "x-go-name": "Implementation"
  22054. },
  22055. "key": {
  22056. "type": "string",
  22057. "x-go-name": "Key"
  22058. },
  22059. "name": {
  22060. "type": "string",
  22061. "x-go-name": "Name"
  22062. },
  22063. "url": {
  22064. "type": "string",
  22065. "x-go-name": "URL"
  22066. }
  22067. },
  22068. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22069. },
  22070. "LicensesTemplateListEntry": {
  22071. "description": "LicensesListEntry is used for the API",
  22072. "type": "object",
  22073. "properties": {
  22074. "key": {
  22075. "type": "string",
  22076. "x-go-name": "Key"
  22077. },
  22078. "name": {
  22079. "type": "string",
  22080. "x-go-name": "Name"
  22081. },
  22082. "url": {
  22083. "type": "string",
  22084. "x-go-name": "URL"
  22085. }
  22086. },
  22087. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22088. },
  22089. "MarkdownOption": {
  22090. "description": "MarkdownOption markdown options",
  22091. "type": "object",
  22092. "properties": {
  22093. "Context": {
  22094. "description": "Context to render\n\nin: body",
  22095. "type": "string"
  22096. },
  22097. "Mode": {
  22098. "description": "Mode to render (comment, gfm, markdown)\n\nin: body",
  22099. "type": "string"
  22100. },
  22101. "Text": {
  22102. "description": "Text markdown to render\n\nin: body",
  22103. "type": "string"
  22104. },
  22105. "Wiki": {
  22106. "description": "Is it a wiki page ?\n\nin: body",
  22107. "type": "boolean"
  22108. }
  22109. },
  22110. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22111. },
  22112. "MarkupOption": {
  22113. "description": "MarkupOption markup options",
  22114. "type": "object",
  22115. "properties": {
  22116. "Context": {
  22117. "description": "Context to render\n\nin: body",
  22118. "type": "string"
  22119. },
  22120. "FilePath": {
  22121. "description": "File path for detecting extension in file mode\n\nin: body",
  22122. "type": "string"
  22123. },
  22124. "Mode": {
  22125. "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body",
  22126. "type": "string"
  22127. },
  22128. "Text": {
  22129. "description": "Text markup to render\n\nin: body",
  22130. "type": "string"
  22131. },
  22132. "Wiki": {
  22133. "description": "Is it a wiki page ?\n\nin: body",
  22134. "type": "boolean"
  22135. }
  22136. },
  22137. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22138. },
  22139. "MergePullRequestOption": {
  22140. "description": "MergePullRequestForm form for merging Pull Request",
  22141. "type": "object",
  22142. "required": [
  22143. "Do"
  22144. ],
  22145. "properties": {
  22146. "Do": {
  22147. "type": "string",
  22148. "enum": [
  22149. "merge",
  22150. "rebase",
  22151. "rebase-merge",
  22152. "squash",
  22153. "fast-forward-only",
  22154. "manually-merged"
  22155. ]
  22156. },
  22157. "MergeCommitID": {
  22158. "type": "string"
  22159. },
  22160. "MergeMessageField": {
  22161. "type": "string"
  22162. },
  22163. "MergeTitleField": {
  22164. "type": "string"
  22165. },
  22166. "delete_branch_after_merge": {
  22167. "type": "boolean",
  22168. "x-go-name": "DeleteBranchAfterMerge"
  22169. },
  22170. "force_merge": {
  22171. "type": "boolean",
  22172. "x-go-name": "ForceMerge"
  22173. },
  22174. "head_commit_id": {
  22175. "type": "string",
  22176. "x-go-name": "HeadCommitID"
  22177. },
  22178. "merge_when_checks_succeed": {
  22179. "type": "boolean",
  22180. "x-go-name": "MergeWhenChecksSucceed"
  22181. }
  22182. },
  22183. "x-go-name": "MergePullRequestForm",
  22184. "x-go-package": "code.gitea.io/gitea/services/forms"
  22185. },
  22186. "MigrateRepoOptions": {
  22187. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  22188. "type": "object",
  22189. "required": [
  22190. "clone_addr",
  22191. "repo_name"
  22192. ],
  22193. "properties": {
  22194. "auth_password": {
  22195. "type": "string",
  22196. "x-go-name": "AuthPassword"
  22197. },
  22198. "auth_token": {
  22199. "type": "string",
  22200. "x-go-name": "AuthToken"
  22201. },
  22202. "auth_username": {
  22203. "type": "string",
  22204. "x-go-name": "AuthUsername"
  22205. },
  22206. "clone_addr": {
  22207. "type": "string",
  22208. "x-go-name": "CloneAddr"
  22209. },
  22210. "description": {
  22211. "type": "string",
  22212. "x-go-name": "Description"
  22213. },
  22214. "issues": {
  22215. "type": "boolean",
  22216. "x-go-name": "Issues"
  22217. },
  22218. "labels": {
  22219. "type": "boolean",
  22220. "x-go-name": "Labels"
  22221. },
  22222. "lfs": {
  22223. "type": "boolean",
  22224. "x-go-name": "LFS"
  22225. },
  22226. "lfs_endpoint": {
  22227. "type": "string",
  22228. "x-go-name": "LFSEndpoint"
  22229. },
  22230. "milestones": {
  22231. "type": "boolean",
  22232. "x-go-name": "Milestones"
  22233. },
  22234. "mirror": {
  22235. "type": "boolean",
  22236. "x-go-name": "Mirror"
  22237. },
  22238. "mirror_interval": {
  22239. "type": "string",
  22240. "x-go-name": "MirrorInterval"
  22241. },
  22242. "private": {
  22243. "type": "boolean",
  22244. "x-go-name": "Private"
  22245. },
  22246. "pull_requests": {
  22247. "type": "boolean",
  22248. "x-go-name": "PullRequests"
  22249. },
  22250. "releases": {
  22251. "type": "boolean",
  22252. "x-go-name": "Releases"
  22253. },
  22254. "repo_name": {
  22255. "type": "string",
  22256. "x-go-name": "RepoName"
  22257. },
  22258. "repo_owner": {
  22259. "description": "Name of User or Organisation who will own Repo after migration",
  22260. "type": "string",
  22261. "x-go-name": "RepoOwner"
  22262. },
  22263. "service": {
  22264. "type": "string",
  22265. "enum": [
  22266. "git",
  22267. "github",
  22268. "gitea",
  22269. "gitlab",
  22270. "gogs",
  22271. "onedev",
  22272. "gitbucket",
  22273. "codebase"
  22274. ],
  22275. "x-go-name": "Service"
  22276. },
  22277. "uid": {
  22278. "description": "deprecated (only for backwards compatibility)",
  22279. "type": "integer",
  22280. "format": "int64",
  22281. "x-go-name": "RepoOwnerID"
  22282. },
  22283. "wiki": {
  22284. "type": "boolean",
  22285. "x-go-name": "Wiki"
  22286. }
  22287. },
  22288. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22289. },
  22290. "Milestone": {
  22291. "description": "Milestone milestone is a collection of issues on one repository",
  22292. "type": "object",
  22293. "properties": {
  22294. "closed_at": {
  22295. "type": "string",
  22296. "format": "date-time",
  22297. "x-go-name": "Closed"
  22298. },
  22299. "closed_issues": {
  22300. "type": "integer",
  22301. "format": "int64",
  22302. "x-go-name": "ClosedIssues"
  22303. },
  22304. "created_at": {
  22305. "type": "string",
  22306. "format": "date-time",
  22307. "x-go-name": "Created"
  22308. },
  22309. "description": {
  22310. "type": "string",
  22311. "x-go-name": "Description"
  22312. },
  22313. "due_on": {
  22314. "type": "string",
  22315. "format": "date-time",
  22316. "x-go-name": "Deadline"
  22317. },
  22318. "id": {
  22319. "type": "integer",
  22320. "format": "int64",
  22321. "x-go-name": "ID"
  22322. },
  22323. "open_issues": {
  22324. "type": "integer",
  22325. "format": "int64",
  22326. "x-go-name": "OpenIssues"
  22327. },
  22328. "state": {
  22329. "$ref": "#/definitions/StateType"
  22330. },
  22331. "title": {
  22332. "type": "string",
  22333. "x-go-name": "Title"
  22334. },
  22335. "updated_at": {
  22336. "type": "string",
  22337. "format": "date-time",
  22338. "x-go-name": "Updated"
  22339. }
  22340. },
  22341. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22342. },
  22343. "NewIssuePinsAllowed": {
  22344. "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed",
  22345. "type": "object",
  22346. "properties": {
  22347. "issues": {
  22348. "type": "boolean",
  22349. "x-go-name": "Issues"
  22350. },
  22351. "pull_requests": {
  22352. "type": "boolean",
  22353. "x-go-name": "PullRequests"
  22354. }
  22355. },
  22356. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22357. },
  22358. "NodeInfo": {
  22359. "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
  22360. "type": "object",
  22361. "properties": {
  22362. "metadata": {
  22363. "type": "object",
  22364. "x-go-name": "Metadata"
  22365. },
  22366. "openRegistrations": {
  22367. "type": "boolean",
  22368. "x-go-name": "OpenRegistrations"
  22369. },
  22370. "protocols": {
  22371. "type": "array",
  22372. "items": {
  22373. "type": "string"
  22374. },
  22375. "x-go-name": "Protocols"
  22376. },
  22377. "services": {
  22378. "$ref": "#/definitions/NodeInfoServices"
  22379. },
  22380. "software": {
  22381. "$ref": "#/definitions/NodeInfoSoftware"
  22382. },
  22383. "usage": {
  22384. "$ref": "#/definitions/NodeInfoUsage"
  22385. },
  22386. "version": {
  22387. "type": "string",
  22388. "x-go-name": "Version"
  22389. }
  22390. },
  22391. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22392. },
  22393. "NodeInfoServices": {
  22394. "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
  22395. "type": "object",
  22396. "properties": {
  22397. "inbound": {
  22398. "type": "array",
  22399. "items": {
  22400. "type": "string"
  22401. },
  22402. "x-go-name": "Inbound"
  22403. },
  22404. "outbound": {
  22405. "type": "array",
  22406. "items": {
  22407. "type": "string"
  22408. },
  22409. "x-go-name": "Outbound"
  22410. }
  22411. },
  22412. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22413. },
  22414. "NodeInfoSoftware": {
  22415. "description": "NodeInfoSoftware contains Metadata about server software in use",
  22416. "type": "object",
  22417. "properties": {
  22418. "homepage": {
  22419. "type": "string",
  22420. "x-go-name": "Homepage"
  22421. },
  22422. "name": {
  22423. "type": "string",
  22424. "x-go-name": "Name"
  22425. },
  22426. "repository": {
  22427. "type": "string",
  22428. "x-go-name": "Repository"
  22429. },
  22430. "version": {
  22431. "type": "string",
  22432. "x-go-name": "Version"
  22433. }
  22434. },
  22435. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22436. },
  22437. "NodeInfoUsage": {
  22438. "description": "NodeInfoUsage contains usage statistics for this server",
  22439. "type": "object",
  22440. "properties": {
  22441. "localComments": {
  22442. "type": "integer",
  22443. "format": "int64",
  22444. "x-go-name": "LocalComments"
  22445. },
  22446. "localPosts": {
  22447. "type": "integer",
  22448. "format": "int64",
  22449. "x-go-name": "LocalPosts"
  22450. },
  22451. "users": {
  22452. "$ref": "#/definitions/NodeInfoUsageUsers"
  22453. }
  22454. },
  22455. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22456. },
  22457. "NodeInfoUsageUsers": {
  22458. "description": "NodeInfoUsageUsers contains statistics about the users of this server",
  22459. "type": "object",
  22460. "properties": {
  22461. "activeHalfyear": {
  22462. "type": "integer",
  22463. "format": "int64",
  22464. "x-go-name": "ActiveHalfyear"
  22465. },
  22466. "activeMonth": {
  22467. "type": "integer",
  22468. "format": "int64",
  22469. "x-go-name": "ActiveMonth"
  22470. },
  22471. "total": {
  22472. "type": "integer",
  22473. "format": "int64",
  22474. "x-go-name": "Total"
  22475. }
  22476. },
  22477. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22478. },
  22479. "Note": {
  22480. "description": "Note contains information related to a git note",
  22481. "type": "object",
  22482. "properties": {
  22483. "commit": {
  22484. "$ref": "#/definitions/Commit"
  22485. },
  22486. "message": {
  22487. "type": "string",
  22488. "x-go-name": "Message"
  22489. }
  22490. },
  22491. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22492. },
  22493. "NotificationCount": {
  22494. "description": "NotificationCount number of unread notifications",
  22495. "type": "object",
  22496. "properties": {
  22497. "new": {
  22498. "type": "integer",
  22499. "format": "int64",
  22500. "x-go-name": "New"
  22501. }
  22502. },
  22503. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22504. },
  22505. "NotificationSubject": {
  22506. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  22507. "type": "object",
  22508. "properties": {
  22509. "html_url": {
  22510. "type": "string",
  22511. "x-go-name": "HTMLURL"
  22512. },
  22513. "latest_comment_html_url": {
  22514. "type": "string",
  22515. "x-go-name": "LatestCommentHTMLURL"
  22516. },
  22517. "latest_comment_url": {
  22518. "type": "string",
  22519. "x-go-name": "LatestCommentURL"
  22520. },
  22521. "state": {
  22522. "$ref": "#/definitions/StateType"
  22523. },
  22524. "title": {
  22525. "type": "string",
  22526. "x-go-name": "Title"
  22527. },
  22528. "type": {
  22529. "$ref": "#/definitions/NotifySubjectType"
  22530. },
  22531. "url": {
  22532. "type": "string",
  22533. "x-go-name": "URL"
  22534. }
  22535. },
  22536. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22537. },
  22538. "NotificationThread": {
  22539. "description": "NotificationThread expose Notification on API",
  22540. "type": "object",
  22541. "properties": {
  22542. "id": {
  22543. "type": "integer",
  22544. "format": "int64",
  22545. "x-go-name": "ID"
  22546. },
  22547. "pinned": {
  22548. "type": "boolean",
  22549. "x-go-name": "Pinned"
  22550. },
  22551. "repository": {
  22552. "$ref": "#/definitions/Repository"
  22553. },
  22554. "subject": {
  22555. "$ref": "#/definitions/NotificationSubject"
  22556. },
  22557. "unread": {
  22558. "type": "boolean",
  22559. "x-go-name": "Unread"
  22560. },
  22561. "updated_at": {
  22562. "type": "string",
  22563. "format": "date-time",
  22564. "x-go-name": "UpdatedAt"
  22565. },
  22566. "url": {
  22567. "type": "string",
  22568. "x-go-name": "URL"
  22569. }
  22570. },
  22571. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22572. },
  22573. "NotifySubjectType": {
  22574. "description": "NotifySubjectType represent type of notification subject",
  22575. "type": "string",
  22576. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22577. },
  22578. "OAuth2Application": {
  22579. "type": "object",
  22580. "title": "OAuth2Application represents an OAuth2 application.",
  22581. "properties": {
  22582. "client_id": {
  22583. "type": "string",
  22584. "x-go-name": "ClientID"
  22585. },
  22586. "client_secret": {
  22587. "type": "string",
  22588. "x-go-name": "ClientSecret"
  22589. },
  22590. "confidential_client": {
  22591. "type": "boolean",
  22592. "x-go-name": "ConfidentialClient"
  22593. },
  22594. "created": {
  22595. "type": "string",
  22596. "format": "date-time",
  22597. "x-go-name": "Created"
  22598. },
  22599. "id": {
  22600. "type": "integer",
  22601. "format": "int64",
  22602. "x-go-name": "ID"
  22603. },
  22604. "name": {
  22605. "type": "string",
  22606. "x-go-name": "Name"
  22607. },
  22608. "redirect_uris": {
  22609. "type": "array",
  22610. "items": {
  22611. "type": "string"
  22612. },
  22613. "x-go-name": "RedirectURIs"
  22614. }
  22615. },
  22616. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22617. },
  22618. "Organization": {
  22619. "description": "Organization represents an organization",
  22620. "type": "object",
  22621. "properties": {
  22622. "avatar_url": {
  22623. "type": "string",
  22624. "x-go-name": "AvatarURL"
  22625. },
  22626. "description": {
  22627. "type": "string",
  22628. "x-go-name": "Description"
  22629. },
  22630. "email": {
  22631. "type": "string",
  22632. "x-go-name": "Email"
  22633. },
  22634. "full_name": {
  22635. "type": "string",
  22636. "x-go-name": "FullName"
  22637. },
  22638. "id": {
  22639. "type": "integer",
  22640. "format": "int64",
  22641. "x-go-name": "ID"
  22642. },
  22643. "location": {
  22644. "type": "string",
  22645. "x-go-name": "Location"
  22646. },
  22647. "name": {
  22648. "type": "string",
  22649. "x-go-name": "Name"
  22650. },
  22651. "repo_admin_change_team_access": {
  22652. "type": "boolean",
  22653. "x-go-name": "RepoAdminChangeTeamAccess"
  22654. },
  22655. "username": {
  22656. "description": "deprecated",
  22657. "type": "string",
  22658. "x-go-name": "UserName"
  22659. },
  22660. "visibility": {
  22661. "type": "string",
  22662. "x-go-name": "Visibility"
  22663. },
  22664. "website": {
  22665. "type": "string",
  22666. "x-go-name": "Website"
  22667. }
  22668. },
  22669. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22670. },
  22671. "OrganizationPermissions": {
  22672. "description": "OrganizationPermissions list different users permissions on an organization",
  22673. "type": "object",
  22674. "properties": {
  22675. "can_create_repository": {
  22676. "type": "boolean",
  22677. "x-go-name": "CanCreateRepository"
  22678. },
  22679. "can_read": {
  22680. "type": "boolean",
  22681. "x-go-name": "CanRead"
  22682. },
  22683. "can_write": {
  22684. "type": "boolean",
  22685. "x-go-name": "CanWrite"
  22686. },
  22687. "is_admin": {
  22688. "type": "boolean",
  22689. "x-go-name": "IsAdmin"
  22690. },
  22691. "is_owner": {
  22692. "type": "boolean",
  22693. "x-go-name": "IsOwner"
  22694. }
  22695. },
  22696. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22697. },
  22698. "PRBranchInfo": {
  22699. "description": "PRBranchInfo information about a branch",
  22700. "type": "object",
  22701. "properties": {
  22702. "label": {
  22703. "type": "string",
  22704. "x-go-name": "Name"
  22705. },
  22706. "ref": {
  22707. "type": "string",
  22708. "x-go-name": "Ref"
  22709. },
  22710. "repo": {
  22711. "$ref": "#/definitions/Repository"
  22712. },
  22713. "repo_id": {
  22714. "type": "integer",
  22715. "format": "int64",
  22716. "x-go-name": "RepoID"
  22717. },
  22718. "sha": {
  22719. "type": "string",
  22720. "x-go-name": "Sha"
  22721. }
  22722. },
  22723. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22724. },
  22725. "Package": {
  22726. "description": "Package represents a package",
  22727. "type": "object",
  22728. "properties": {
  22729. "created_at": {
  22730. "type": "string",
  22731. "format": "date-time",
  22732. "x-go-name": "CreatedAt"
  22733. },
  22734. "creator": {
  22735. "$ref": "#/definitions/User"
  22736. },
  22737. "html_url": {
  22738. "type": "string",
  22739. "x-go-name": "HTMLURL"
  22740. },
  22741. "id": {
  22742. "type": "integer",
  22743. "format": "int64",
  22744. "x-go-name": "ID"
  22745. },
  22746. "name": {
  22747. "type": "string",
  22748. "x-go-name": "Name"
  22749. },
  22750. "owner": {
  22751. "$ref": "#/definitions/User"
  22752. },
  22753. "repository": {
  22754. "$ref": "#/definitions/Repository"
  22755. },
  22756. "type": {
  22757. "type": "string",
  22758. "x-go-name": "Type"
  22759. },
  22760. "version": {
  22761. "type": "string",
  22762. "x-go-name": "Version"
  22763. }
  22764. },
  22765. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22766. },
  22767. "PackageFile": {
  22768. "description": "PackageFile represents a package file",
  22769. "type": "object",
  22770. "properties": {
  22771. "Size": {
  22772. "type": "integer",
  22773. "format": "int64"
  22774. },
  22775. "id": {
  22776. "type": "integer",
  22777. "format": "int64",
  22778. "x-go-name": "ID"
  22779. },
  22780. "md5": {
  22781. "type": "string",
  22782. "x-go-name": "HashMD5"
  22783. },
  22784. "name": {
  22785. "type": "string",
  22786. "x-go-name": "Name"
  22787. },
  22788. "sha1": {
  22789. "type": "string",
  22790. "x-go-name": "HashSHA1"
  22791. },
  22792. "sha256": {
  22793. "type": "string",
  22794. "x-go-name": "HashSHA256"
  22795. },
  22796. "sha512": {
  22797. "type": "string",
  22798. "x-go-name": "HashSHA512"
  22799. }
  22800. },
  22801. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22802. },
  22803. "PayloadCommit": {
  22804. "description": "PayloadCommit represents a commit",
  22805. "type": "object",
  22806. "properties": {
  22807. "added": {
  22808. "type": "array",
  22809. "items": {
  22810. "type": "string"
  22811. },
  22812. "x-go-name": "Added"
  22813. },
  22814. "author": {
  22815. "$ref": "#/definitions/PayloadUser"
  22816. },
  22817. "committer": {
  22818. "$ref": "#/definitions/PayloadUser"
  22819. },
  22820. "id": {
  22821. "description": "sha1 hash of the commit",
  22822. "type": "string",
  22823. "x-go-name": "ID"
  22824. },
  22825. "message": {
  22826. "type": "string",
  22827. "x-go-name": "Message"
  22828. },
  22829. "modified": {
  22830. "type": "array",
  22831. "items": {
  22832. "type": "string"
  22833. },
  22834. "x-go-name": "Modified"
  22835. },
  22836. "removed": {
  22837. "type": "array",
  22838. "items": {
  22839. "type": "string"
  22840. },
  22841. "x-go-name": "Removed"
  22842. },
  22843. "timestamp": {
  22844. "type": "string",
  22845. "format": "date-time",
  22846. "x-go-name": "Timestamp"
  22847. },
  22848. "url": {
  22849. "type": "string",
  22850. "x-go-name": "URL"
  22851. },
  22852. "verification": {
  22853. "$ref": "#/definitions/PayloadCommitVerification"
  22854. }
  22855. },
  22856. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22857. },
  22858. "PayloadCommitVerification": {
  22859. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  22860. "type": "object",
  22861. "properties": {
  22862. "payload": {
  22863. "type": "string",
  22864. "x-go-name": "Payload"
  22865. },
  22866. "reason": {
  22867. "type": "string",
  22868. "x-go-name": "Reason"
  22869. },
  22870. "signature": {
  22871. "type": "string",
  22872. "x-go-name": "Signature"
  22873. },
  22874. "signer": {
  22875. "$ref": "#/definitions/PayloadUser"
  22876. },
  22877. "verified": {
  22878. "type": "boolean",
  22879. "x-go-name": "Verified"
  22880. }
  22881. },
  22882. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22883. },
  22884. "PayloadUser": {
  22885. "description": "PayloadUser represents the author or committer of a commit",
  22886. "type": "object",
  22887. "properties": {
  22888. "email": {
  22889. "type": "string",
  22890. "format": "email",
  22891. "x-go-name": "Email"
  22892. },
  22893. "name": {
  22894. "description": "Full name of the commit author",
  22895. "type": "string",
  22896. "x-go-name": "Name"
  22897. },
  22898. "username": {
  22899. "type": "string",
  22900. "x-go-name": "UserName"
  22901. }
  22902. },
  22903. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22904. },
  22905. "Permission": {
  22906. "description": "Permission represents a set of permissions",
  22907. "type": "object",
  22908. "properties": {
  22909. "admin": {
  22910. "type": "boolean",
  22911. "x-go-name": "Admin"
  22912. },
  22913. "pull": {
  22914. "type": "boolean",
  22915. "x-go-name": "Pull"
  22916. },
  22917. "push": {
  22918. "type": "boolean",
  22919. "x-go-name": "Push"
  22920. }
  22921. },
  22922. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22923. },
  22924. "PublicKey": {
  22925. "description": "PublicKey publickey is a user key to push code to repository",
  22926. "type": "object",
  22927. "properties": {
  22928. "created_at": {
  22929. "type": "string",
  22930. "format": "date-time",
  22931. "x-go-name": "Created"
  22932. },
  22933. "fingerprint": {
  22934. "type": "string",
  22935. "x-go-name": "Fingerprint"
  22936. },
  22937. "id": {
  22938. "type": "integer",
  22939. "format": "int64",
  22940. "x-go-name": "ID"
  22941. },
  22942. "key": {
  22943. "type": "string",
  22944. "x-go-name": "Key"
  22945. },
  22946. "key_type": {
  22947. "type": "string",
  22948. "x-go-name": "KeyType"
  22949. },
  22950. "read_only": {
  22951. "type": "boolean",
  22952. "x-go-name": "ReadOnly"
  22953. },
  22954. "title": {
  22955. "type": "string",
  22956. "x-go-name": "Title"
  22957. },
  22958. "url": {
  22959. "type": "string",
  22960. "x-go-name": "URL"
  22961. },
  22962. "user": {
  22963. "$ref": "#/definitions/User"
  22964. }
  22965. },
  22966. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22967. },
  22968. "PullRequest": {
  22969. "description": "PullRequest represents a pull request",
  22970. "type": "object",
  22971. "properties": {
  22972. "allow_maintainer_edit": {
  22973. "type": "boolean",
  22974. "x-go-name": "AllowMaintainerEdit"
  22975. },
  22976. "assignee": {
  22977. "$ref": "#/definitions/User"
  22978. },
  22979. "assignees": {
  22980. "type": "array",
  22981. "items": {
  22982. "$ref": "#/definitions/User"
  22983. },
  22984. "x-go-name": "Assignees"
  22985. },
  22986. "base": {
  22987. "$ref": "#/definitions/PRBranchInfo"
  22988. },
  22989. "body": {
  22990. "type": "string",
  22991. "x-go-name": "Body"
  22992. },
  22993. "closed_at": {
  22994. "type": "string",
  22995. "format": "date-time",
  22996. "x-go-name": "Closed"
  22997. },
  22998. "comments": {
  22999. "type": "integer",
  23000. "format": "int64",
  23001. "x-go-name": "Comments"
  23002. },
  23003. "created_at": {
  23004. "type": "string",
  23005. "format": "date-time",
  23006. "x-go-name": "Created"
  23007. },
  23008. "diff_url": {
  23009. "type": "string",
  23010. "x-go-name": "DiffURL"
  23011. },
  23012. "due_date": {
  23013. "type": "string",
  23014. "format": "date-time",
  23015. "x-go-name": "Deadline"
  23016. },
  23017. "head": {
  23018. "$ref": "#/definitions/PRBranchInfo"
  23019. },
  23020. "html_url": {
  23021. "type": "string",
  23022. "x-go-name": "HTMLURL"
  23023. },
  23024. "id": {
  23025. "type": "integer",
  23026. "format": "int64",
  23027. "x-go-name": "ID"
  23028. },
  23029. "is_locked": {
  23030. "type": "boolean",
  23031. "x-go-name": "IsLocked"
  23032. },
  23033. "labels": {
  23034. "type": "array",
  23035. "items": {
  23036. "$ref": "#/definitions/Label"
  23037. },
  23038. "x-go-name": "Labels"
  23039. },
  23040. "merge_base": {
  23041. "type": "string",
  23042. "x-go-name": "MergeBase"
  23043. },
  23044. "merge_commit_sha": {
  23045. "type": "string",
  23046. "x-go-name": "MergedCommitID"
  23047. },
  23048. "mergeable": {
  23049. "type": "boolean",
  23050. "x-go-name": "Mergeable"
  23051. },
  23052. "merged": {
  23053. "type": "boolean",
  23054. "x-go-name": "HasMerged"
  23055. },
  23056. "merged_at": {
  23057. "type": "string",
  23058. "format": "date-time",
  23059. "x-go-name": "Merged"
  23060. },
  23061. "merged_by": {
  23062. "$ref": "#/definitions/User"
  23063. },
  23064. "milestone": {
  23065. "$ref": "#/definitions/Milestone"
  23066. },
  23067. "number": {
  23068. "type": "integer",
  23069. "format": "int64",
  23070. "x-go-name": "Index"
  23071. },
  23072. "patch_url": {
  23073. "type": "string",
  23074. "x-go-name": "PatchURL"
  23075. },
  23076. "pin_order": {
  23077. "type": "integer",
  23078. "format": "int64",
  23079. "x-go-name": "PinOrder"
  23080. },
  23081. "requested_reviewers": {
  23082. "type": "array",
  23083. "items": {
  23084. "$ref": "#/definitions/User"
  23085. },
  23086. "x-go-name": "RequestedReviewers"
  23087. },
  23088. "state": {
  23089. "$ref": "#/definitions/StateType"
  23090. },
  23091. "title": {
  23092. "type": "string",
  23093. "x-go-name": "Title"
  23094. },
  23095. "updated_at": {
  23096. "type": "string",
  23097. "format": "date-time",
  23098. "x-go-name": "Updated"
  23099. },
  23100. "url": {
  23101. "type": "string",
  23102. "x-go-name": "URL"
  23103. },
  23104. "user": {
  23105. "$ref": "#/definitions/User"
  23106. }
  23107. },
  23108. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23109. },
  23110. "PullRequestMeta": {
  23111. "description": "PullRequestMeta PR info if an issue is a PR",
  23112. "type": "object",
  23113. "properties": {
  23114. "draft": {
  23115. "type": "boolean",
  23116. "x-go-name": "IsWorkInProgress"
  23117. },
  23118. "merged": {
  23119. "type": "boolean",
  23120. "x-go-name": "HasMerged"
  23121. },
  23122. "merged_at": {
  23123. "type": "string",
  23124. "format": "date-time",
  23125. "x-go-name": "Merged"
  23126. }
  23127. },
  23128. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23129. },
  23130. "PullReview": {
  23131. "description": "PullReview represents a pull request review",
  23132. "type": "object",
  23133. "properties": {
  23134. "body": {
  23135. "type": "string",
  23136. "x-go-name": "Body"
  23137. },
  23138. "comments_count": {
  23139. "type": "integer",
  23140. "format": "int64",
  23141. "x-go-name": "CodeCommentsCount"
  23142. },
  23143. "commit_id": {
  23144. "type": "string",
  23145. "x-go-name": "CommitID"
  23146. },
  23147. "dismissed": {
  23148. "type": "boolean",
  23149. "x-go-name": "Dismissed"
  23150. },
  23151. "html_url": {
  23152. "type": "string",
  23153. "x-go-name": "HTMLURL"
  23154. },
  23155. "id": {
  23156. "type": "integer",
  23157. "format": "int64",
  23158. "x-go-name": "ID"
  23159. },
  23160. "official": {
  23161. "type": "boolean",
  23162. "x-go-name": "Official"
  23163. },
  23164. "pull_request_url": {
  23165. "type": "string",
  23166. "x-go-name": "HTMLPullURL"
  23167. },
  23168. "stale": {
  23169. "type": "boolean",
  23170. "x-go-name": "Stale"
  23171. },
  23172. "state": {
  23173. "$ref": "#/definitions/ReviewStateType"
  23174. },
  23175. "submitted_at": {
  23176. "type": "string",
  23177. "format": "date-time",
  23178. "x-go-name": "Submitted"
  23179. },
  23180. "team": {
  23181. "$ref": "#/definitions/Team"
  23182. },
  23183. "updated_at": {
  23184. "type": "string",
  23185. "format": "date-time",
  23186. "x-go-name": "Updated"
  23187. },
  23188. "user": {
  23189. "$ref": "#/definitions/User"
  23190. }
  23191. },
  23192. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23193. },
  23194. "PullReviewComment": {
  23195. "description": "PullReviewComment represents a comment on a pull request review",
  23196. "type": "object",
  23197. "properties": {
  23198. "body": {
  23199. "type": "string",
  23200. "x-go-name": "Body"
  23201. },
  23202. "commit_id": {
  23203. "type": "string",
  23204. "x-go-name": "CommitID"
  23205. },
  23206. "created_at": {
  23207. "type": "string",
  23208. "format": "date-time",
  23209. "x-go-name": "Created"
  23210. },
  23211. "diff_hunk": {
  23212. "type": "string",
  23213. "x-go-name": "DiffHunk"
  23214. },
  23215. "html_url": {
  23216. "type": "string",
  23217. "x-go-name": "HTMLURL"
  23218. },
  23219. "id": {
  23220. "type": "integer",
  23221. "format": "int64",
  23222. "x-go-name": "ID"
  23223. },
  23224. "original_commit_id": {
  23225. "type": "string",
  23226. "x-go-name": "OrigCommitID"
  23227. },
  23228. "original_position": {
  23229. "type": "integer",
  23230. "format": "uint64",
  23231. "x-go-name": "OldLineNum"
  23232. },
  23233. "path": {
  23234. "type": "string",
  23235. "x-go-name": "Path"
  23236. },
  23237. "position": {
  23238. "type": "integer",
  23239. "format": "uint64",
  23240. "x-go-name": "LineNum"
  23241. },
  23242. "pull_request_review_id": {
  23243. "type": "integer",
  23244. "format": "int64",
  23245. "x-go-name": "ReviewID"
  23246. },
  23247. "pull_request_url": {
  23248. "type": "string",
  23249. "x-go-name": "HTMLPullURL"
  23250. },
  23251. "resolver": {
  23252. "$ref": "#/definitions/User"
  23253. },
  23254. "updated_at": {
  23255. "type": "string",
  23256. "format": "date-time",
  23257. "x-go-name": "Updated"
  23258. },
  23259. "user": {
  23260. "$ref": "#/definitions/User"
  23261. }
  23262. },
  23263. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23264. },
  23265. "PullReviewRequestOptions": {
  23266. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  23267. "type": "object",
  23268. "properties": {
  23269. "reviewers": {
  23270. "type": "array",
  23271. "items": {
  23272. "type": "string"
  23273. },
  23274. "x-go-name": "Reviewers"
  23275. },
  23276. "team_reviewers": {
  23277. "type": "array",
  23278. "items": {
  23279. "type": "string"
  23280. },
  23281. "x-go-name": "TeamReviewers"
  23282. }
  23283. },
  23284. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23285. },
  23286. "PushMirror": {
  23287. "description": "PushMirror represents information of a push mirror",
  23288. "type": "object",
  23289. "properties": {
  23290. "created": {
  23291. "type": "string",
  23292. "format": "date-time",
  23293. "x-go-name": "CreatedUnix"
  23294. },
  23295. "interval": {
  23296. "type": "string",
  23297. "x-go-name": "Interval"
  23298. },
  23299. "last_error": {
  23300. "type": "string",
  23301. "x-go-name": "LastError"
  23302. },
  23303. "last_update": {
  23304. "type": "string",
  23305. "format": "date-time",
  23306. "x-go-name": "LastUpdateUnix"
  23307. },
  23308. "remote_address": {
  23309. "type": "string",
  23310. "x-go-name": "RemoteAddress"
  23311. },
  23312. "remote_name": {
  23313. "type": "string",
  23314. "x-go-name": "RemoteName"
  23315. },
  23316. "repo_name": {
  23317. "type": "string",
  23318. "x-go-name": "RepoName"
  23319. },
  23320. "sync_on_commit": {
  23321. "type": "boolean",
  23322. "x-go-name": "SyncOnCommit"
  23323. }
  23324. },
  23325. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23326. },
  23327. "Reaction": {
  23328. "description": "Reaction contain one reaction",
  23329. "type": "object",
  23330. "properties": {
  23331. "content": {
  23332. "type": "string",
  23333. "x-go-name": "Reaction"
  23334. },
  23335. "created_at": {
  23336. "type": "string",
  23337. "format": "date-time",
  23338. "x-go-name": "Created"
  23339. },
  23340. "user": {
  23341. "$ref": "#/definitions/User"
  23342. }
  23343. },
  23344. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23345. },
  23346. "Reference": {
  23347. "type": "object",
  23348. "title": "Reference represents a Git reference.",
  23349. "properties": {
  23350. "object": {
  23351. "$ref": "#/definitions/GitObject"
  23352. },
  23353. "ref": {
  23354. "type": "string",
  23355. "x-go-name": "Ref"
  23356. },
  23357. "url": {
  23358. "type": "string",
  23359. "x-go-name": "URL"
  23360. }
  23361. },
  23362. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23363. },
  23364. "Release": {
  23365. "description": "Release represents a repository release",
  23366. "type": "object",
  23367. "properties": {
  23368. "assets": {
  23369. "type": "array",
  23370. "items": {
  23371. "$ref": "#/definitions/Attachment"
  23372. },
  23373. "x-go-name": "Attachments"
  23374. },
  23375. "author": {
  23376. "$ref": "#/definitions/User"
  23377. },
  23378. "body": {
  23379. "type": "string",
  23380. "x-go-name": "Note"
  23381. },
  23382. "created_at": {
  23383. "type": "string",
  23384. "format": "date-time",
  23385. "x-go-name": "CreatedAt"
  23386. },
  23387. "draft": {
  23388. "type": "boolean",
  23389. "x-go-name": "IsDraft"
  23390. },
  23391. "html_url": {
  23392. "type": "string",
  23393. "x-go-name": "HTMLURL"
  23394. },
  23395. "id": {
  23396. "type": "integer",
  23397. "format": "int64",
  23398. "x-go-name": "ID"
  23399. },
  23400. "name": {
  23401. "type": "string",
  23402. "x-go-name": "Title"
  23403. },
  23404. "prerelease": {
  23405. "type": "boolean",
  23406. "x-go-name": "IsPrerelease"
  23407. },
  23408. "published_at": {
  23409. "type": "string",
  23410. "format": "date-time",
  23411. "x-go-name": "PublishedAt"
  23412. },
  23413. "tag_name": {
  23414. "type": "string",
  23415. "x-go-name": "TagName"
  23416. },
  23417. "tarball_url": {
  23418. "type": "string",
  23419. "x-go-name": "TarURL"
  23420. },
  23421. "target_commitish": {
  23422. "type": "string",
  23423. "x-go-name": "Target"
  23424. },
  23425. "upload_url": {
  23426. "type": "string",
  23427. "x-go-name": "UploadURL"
  23428. },
  23429. "url": {
  23430. "type": "string",
  23431. "x-go-name": "URL"
  23432. },
  23433. "zipball_url": {
  23434. "type": "string",
  23435. "x-go-name": "ZipURL"
  23436. }
  23437. },
  23438. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23439. },
  23440. "RenameUserOption": {
  23441. "description": "RenameUserOption options when renaming a user",
  23442. "type": "object",
  23443. "required": [
  23444. "new_username"
  23445. ],
  23446. "properties": {
  23447. "new_username": {
  23448. "description": "New username for this user. This name cannot be in use yet by any other user.",
  23449. "type": "string",
  23450. "uniqueItems": true,
  23451. "x-go-name": "NewName"
  23452. }
  23453. },
  23454. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23455. },
  23456. "RepoCollaboratorPermission": {
  23457. "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
  23458. "type": "object",
  23459. "properties": {
  23460. "permission": {
  23461. "type": "string",
  23462. "x-go-name": "Permission"
  23463. },
  23464. "role_name": {
  23465. "type": "string",
  23466. "x-go-name": "RoleName"
  23467. },
  23468. "user": {
  23469. "$ref": "#/definitions/User"
  23470. }
  23471. },
  23472. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23473. },
  23474. "RepoCommit": {
  23475. "type": "object",
  23476. "title": "RepoCommit contains information of a commit in the context of a repository.",
  23477. "properties": {
  23478. "author": {
  23479. "$ref": "#/definitions/CommitUser"
  23480. },
  23481. "committer": {
  23482. "$ref": "#/definitions/CommitUser"
  23483. },
  23484. "message": {
  23485. "type": "string",
  23486. "x-go-name": "Message"
  23487. },
  23488. "tree": {
  23489. "$ref": "#/definitions/CommitMeta"
  23490. },
  23491. "url": {
  23492. "type": "string",
  23493. "x-go-name": "URL"
  23494. },
  23495. "verification": {
  23496. "$ref": "#/definitions/PayloadCommitVerification"
  23497. }
  23498. },
  23499. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23500. },
  23501. "RepoTopicOptions": {
  23502. "description": "RepoTopicOptions a collection of repo topic names",
  23503. "type": "object",
  23504. "properties": {
  23505. "topics": {
  23506. "description": "list of topic names",
  23507. "type": "array",
  23508. "items": {
  23509. "type": "string"
  23510. },
  23511. "x-go-name": "Topics"
  23512. }
  23513. },
  23514. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23515. },
  23516. "RepoTransfer": {
  23517. "description": "RepoTransfer represents a pending repo transfer",
  23518. "type": "object",
  23519. "properties": {
  23520. "doer": {
  23521. "$ref": "#/definitions/User"
  23522. },
  23523. "recipient": {
  23524. "$ref": "#/definitions/User"
  23525. },
  23526. "teams": {
  23527. "type": "array",
  23528. "items": {
  23529. "$ref": "#/definitions/Team"
  23530. },
  23531. "x-go-name": "Teams"
  23532. }
  23533. },
  23534. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23535. },
  23536. "Repository": {
  23537. "description": "Repository represents a repository",
  23538. "type": "object",
  23539. "properties": {
  23540. "allow_fast_forward_only_merge": {
  23541. "type": "boolean",
  23542. "x-go-name": "AllowFastForwardOnly"
  23543. },
  23544. "allow_merge_commits": {
  23545. "type": "boolean",
  23546. "x-go-name": "AllowMerge"
  23547. },
  23548. "allow_rebase": {
  23549. "type": "boolean",
  23550. "x-go-name": "AllowRebase"
  23551. },
  23552. "allow_rebase_explicit": {
  23553. "type": "boolean",
  23554. "x-go-name": "AllowRebaseMerge"
  23555. },
  23556. "allow_rebase_update": {
  23557. "type": "boolean",
  23558. "x-go-name": "AllowRebaseUpdate"
  23559. },
  23560. "allow_squash_merge": {
  23561. "type": "boolean",
  23562. "x-go-name": "AllowSquash"
  23563. },
  23564. "archived": {
  23565. "type": "boolean",
  23566. "x-go-name": "Archived"
  23567. },
  23568. "archived_at": {
  23569. "type": "string",
  23570. "format": "date-time",
  23571. "x-go-name": "ArchivedAt"
  23572. },
  23573. "avatar_url": {
  23574. "type": "string",
  23575. "x-go-name": "AvatarURL"
  23576. },
  23577. "clone_url": {
  23578. "type": "string",
  23579. "x-go-name": "CloneURL"
  23580. },
  23581. "created_at": {
  23582. "type": "string",
  23583. "format": "date-time",
  23584. "x-go-name": "Created"
  23585. },
  23586. "default_allow_maintainer_edit": {
  23587. "type": "boolean",
  23588. "x-go-name": "DefaultAllowMaintainerEdit"
  23589. },
  23590. "default_branch": {
  23591. "type": "string",
  23592. "x-go-name": "DefaultBranch"
  23593. },
  23594. "default_delete_branch_after_merge": {
  23595. "type": "boolean",
  23596. "x-go-name": "DefaultDeleteBranchAfterMerge"
  23597. },
  23598. "default_merge_style": {
  23599. "type": "string",
  23600. "x-go-name": "DefaultMergeStyle"
  23601. },
  23602. "description": {
  23603. "type": "string",
  23604. "x-go-name": "Description"
  23605. },
  23606. "empty": {
  23607. "type": "boolean",
  23608. "x-go-name": "Empty"
  23609. },
  23610. "external_tracker": {
  23611. "$ref": "#/definitions/ExternalTracker"
  23612. },
  23613. "external_wiki": {
  23614. "$ref": "#/definitions/ExternalWiki"
  23615. },
  23616. "fork": {
  23617. "type": "boolean",
  23618. "x-go-name": "Fork"
  23619. },
  23620. "forks_count": {
  23621. "type": "integer",
  23622. "format": "int64",
  23623. "x-go-name": "Forks"
  23624. },
  23625. "full_name": {
  23626. "type": "string",
  23627. "x-go-name": "FullName"
  23628. },
  23629. "has_actions": {
  23630. "type": "boolean",
  23631. "x-go-name": "HasActions"
  23632. },
  23633. "has_issues": {
  23634. "type": "boolean",
  23635. "x-go-name": "HasIssues"
  23636. },
  23637. "has_packages": {
  23638. "type": "boolean",
  23639. "x-go-name": "HasPackages"
  23640. },
  23641. "has_projects": {
  23642. "type": "boolean",
  23643. "x-go-name": "HasProjects"
  23644. },
  23645. "has_pull_requests": {
  23646. "type": "boolean",
  23647. "x-go-name": "HasPullRequests"
  23648. },
  23649. "has_releases": {
  23650. "type": "boolean",
  23651. "x-go-name": "HasReleases"
  23652. },
  23653. "has_wiki": {
  23654. "type": "boolean",
  23655. "x-go-name": "HasWiki"
  23656. },
  23657. "html_url": {
  23658. "type": "string",
  23659. "x-go-name": "HTMLURL"
  23660. },
  23661. "id": {
  23662. "type": "integer",
  23663. "format": "int64",
  23664. "x-go-name": "ID"
  23665. },
  23666. "ignore_whitespace_conflicts": {
  23667. "type": "boolean",
  23668. "x-go-name": "IgnoreWhitespaceConflicts"
  23669. },
  23670. "internal": {
  23671. "type": "boolean",
  23672. "x-go-name": "Internal"
  23673. },
  23674. "internal_tracker": {
  23675. "$ref": "#/definitions/InternalTracker"
  23676. },
  23677. "language": {
  23678. "type": "string",
  23679. "x-go-name": "Language"
  23680. },
  23681. "languages_url": {
  23682. "type": "string",
  23683. "x-go-name": "LanguagesURL"
  23684. },
  23685. "link": {
  23686. "type": "string",
  23687. "x-go-name": "Link"
  23688. },
  23689. "mirror": {
  23690. "type": "boolean",
  23691. "x-go-name": "Mirror"
  23692. },
  23693. "mirror_interval": {
  23694. "type": "string",
  23695. "x-go-name": "MirrorInterval"
  23696. },
  23697. "mirror_updated": {
  23698. "type": "string",
  23699. "format": "date-time",
  23700. "x-go-name": "MirrorUpdated"
  23701. },
  23702. "name": {
  23703. "type": "string",
  23704. "x-go-name": "Name"
  23705. },
  23706. "object_format_name": {
  23707. "description": "ObjectFormatName of the underlying git repository",
  23708. "type": "string",
  23709. "enum": [
  23710. "sha1",
  23711. "sha256"
  23712. ],
  23713. "x-go-name": "ObjectFormatName"
  23714. },
  23715. "open_issues_count": {
  23716. "type": "integer",
  23717. "format": "int64",
  23718. "x-go-name": "OpenIssues"
  23719. },
  23720. "open_pr_counter": {
  23721. "type": "integer",
  23722. "format": "int64",
  23723. "x-go-name": "OpenPulls"
  23724. },
  23725. "original_url": {
  23726. "type": "string",
  23727. "x-go-name": "OriginalURL"
  23728. },
  23729. "owner": {
  23730. "$ref": "#/definitions/User"
  23731. },
  23732. "parent": {
  23733. "$ref": "#/definitions/Repository"
  23734. },
  23735. "permissions": {
  23736. "$ref": "#/definitions/Permission"
  23737. },
  23738. "private": {
  23739. "type": "boolean",
  23740. "x-go-name": "Private"
  23741. },
  23742. "projects_mode": {
  23743. "type": "string",
  23744. "x-go-name": "ProjectsMode"
  23745. },
  23746. "release_counter": {
  23747. "type": "integer",
  23748. "format": "int64",
  23749. "x-go-name": "Releases"
  23750. },
  23751. "repo_transfer": {
  23752. "$ref": "#/definitions/RepoTransfer"
  23753. },
  23754. "size": {
  23755. "type": "integer",
  23756. "format": "int64",
  23757. "x-go-name": "Size"
  23758. },
  23759. "ssh_url": {
  23760. "type": "string",
  23761. "x-go-name": "SSHURL"
  23762. },
  23763. "stars_count": {
  23764. "type": "integer",
  23765. "format": "int64",
  23766. "x-go-name": "Stars"
  23767. },
  23768. "template": {
  23769. "type": "boolean",
  23770. "x-go-name": "Template"
  23771. },
  23772. "updated_at": {
  23773. "type": "string",
  23774. "format": "date-time",
  23775. "x-go-name": "Updated"
  23776. },
  23777. "url": {
  23778. "type": "string",
  23779. "x-go-name": "URL"
  23780. },
  23781. "watchers_count": {
  23782. "type": "integer",
  23783. "format": "int64",
  23784. "x-go-name": "Watchers"
  23785. },
  23786. "website": {
  23787. "type": "string",
  23788. "x-go-name": "Website"
  23789. }
  23790. },
  23791. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23792. },
  23793. "RepositoryMeta": {
  23794. "description": "RepositoryMeta basic repository information",
  23795. "type": "object",
  23796. "properties": {
  23797. "full_name": {
  23798. "type": "string",
  23799. "x-go-name": "FullName"
  23800. },
  23801. "id": {
  23802. "type": "integer",
  23803. "format": "int64",
  23804. "x-go-name": "ID"
  23805. },
  23806. "name": {
  23807. "type": "string",
  23808. "x-go-name": "Name"
  23809. },
  23810. "owner": {
  23811. "type": "string",
  23812. "x-go-name": "Owner"
  23813. }
  23814. },
  23815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23816. },
  23817. "ReviewStateType": {
  23818. "description": "ReviewStateType review state type",
  23819. "type": "string",
  23820. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23821. },
  23822. "SearchResults": {
  23823. "description": "SearchResults results of a successful search",
  23824. "type": "object",
  23825. "properties": {
  23826. "data": {
  23827. "type": "array",
  23828. "items": {
  23829. "$ref": "#/definitions/Repository"
  23830. },
  23831. "x-go-name": "Data"
  23832. },
  23833. "ok": {
  23834. "type": "boolean",
  23835. "x-go-name": "OK"
  23836. }
  23837. },
  23838. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23839. },
  23840. "Secret": {
  23841. "description": "Secret represents a secret",
  23842. "type": "object",
  23843. "properties": {
  23844. "created_at": {
  23845. "type": "string",
  23846. "format": "date-time",
  23847. "x-go-name": "Created"
  23848. },
  23849. "name": {
  23850. "description": "the secret's name",
  23851. "type": "string",
  23852. "x-go-name": "Name"
  23853. }
  23854. },
  23855. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23856. },
  23857. "ServerVersion": {
  23858. "description": "ServerVersion wraps the version of the server",
  23859. "type": "object",
  23860. "properties": {
  23861. "version": {
  23862. "type": "string",
  23863. "x-go-name": "Version"
  23864. }
  23865. },
  23866. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23867. },
  23868. "StateType": {
  23869. "description": "StateType issue state type",
  23870. "type": "string",
  23871. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23872. },
  23873. "StopWatch": {
  23874. "description": "StopWatch represent a running stopwatch",
  23875. "type": "object",
  23876. "properties": {
  23877. "created": {
  23878. "type": "string",
  23879. "format": "date-time",
  23880. "x-go-name": "Created"
  23881. },
  23882. "duration": {
  23883. "type": "string",
  23884. "x-go-name": "Duration"
  23885. },
  23886. "issue_index": {
  23887. "type": "integer",
  23888. "format": "int64",
  23889. "x-go-name": "IssueIndex"
  23890. },
  23891. "issue_title": {
  23892. "type": "string",
  23893. "x-go-name": "IssueTitle"
  23894. },
  23895. "repo_name": {
  23896. "type": "string",
  23897. "x-go-name": "RepoName"
  23898. },
  23899. "repo_owner_name": {
  23900. "type": "string",
  23901. "x-go-name": "RepoOwnerName"
  23902. },
  23903. "seconds": {
  23904. "type": "integer",
  23905. "format": "int64",
  23906. "x-go-name": "Seconds"
  23907. }
  23908. },
  23909. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23910. },
  23911. "SubmitPullReviewOptions": {
  23912. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  23913. "type": "object",
  23914. "properties": {
  23915. "body": {
  23916. "type": "string",
  23917. "x-go-name": "Body"
  23918. },
  23919. "event": {
  23920. "$ref": "#/definitions/ReviewStateType"
  23921. }
  23922. },
  23923. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23924. },
  23925. "Tag": {
  23926. "description": "Tag represents a repository tag",
  23927. "type": "object",
  23928. "properties": {
  23929. "commit": {
  23930. "$ref": "#/definitions/CommitMeta"
  23931. },
  23932. "id": {
  23933. "type": "string",
  23934. "x-go-name": "ID"
  23935. },
  23936. "message": {
  23937. "type": "string",
  23938. "x-go-name": "Message"
  23939. },
  23940. "name": {
  23941. "type": "string",
  23942. "x-go-name": "Name"
  23943. },
  23944. "tarball_url": {
  23945. "type": "string",
  23946. "x-go-name": "TarballURL"
  23947. },
  23948. "zipball_url": {
  23949. "type": "string",
  23950. "x-go-name": "ZipballURL"
  23951. }
  23952. },
  23953. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23954. },
  23955. "Team": {
  23956. "description": "Team represents a team in an organization",
  23957. "type": "object",
  23958. "properties": {
  23959. "can_create_org_repo": {
  23960. "type": "boolean",
  23961. "x-go-name": "CanCreateOrgRepo"
  23962. },
  23963. "description": {
  23964. "type": "string",
  23965. "x-go-name": "Description"
  23966. },
  23967. "id": {
  23968. "type": "integer",
  23969. "format": "int64",
  23970. "x-go-name": "ID"
  23971. },
  23972. "includes_all_repositories": {
  23973. "type": "boolean",
  23974. "x-go-name": "IncludesAllRepositories"
  23975. },
  23976. "name": {
  23977. "type": "string",
  23978. "x-go-name": "Name"
  23979. },
  23980. "organization": {
  23981. "$ref": "#/definitions/Organization"
  23982. },
  23983. "permission": {
  23984. "type": "string",
  23985. "enum": [
  23986. "none",
  23987. "read",
  23988. "write",
  23989. "admin",
  23990. "owner"
  23991. ],
  23992. "x-go-name": "Permission"
  23993. },
  23994. "units": {
  23995. "type": "array",
  23996. "items": {
  23997. "type": "string"
  23998. },
  23999. "x-go-name": "Units",
  24000. "example": [
  24001. "repo.code",
  24002. "repo.issues",
  24003. "repo.ext_issues",
  24004. "repo.wiki",
  24005. "repo.pulls",
  24006. "repo.releases",
  24007. "repo.projects",
  24008. "repo.ext_wiki"
  24009. ]
  24010. },
  24011. "units_map": {
  24012. "type": "object",
  24013. "additionalProperties": {
  24014. "type": "string"
  24015. },
  24016. "x-go-name": "UnitsMap",
  24017. "example": {
  24018. "repo.code": "read",
  24019. "repo.ext_issues": "none",
  24020. "repo.ext_wiki": "none",
  24021. "repo.issues": "write",
  24022. "repo.projects": "none",
  24023. "repo.pulls": "owner",
  24024. "repo.releases": "none",
  24025. "repo.wiki": "admin"
  24026. }
  24027. }
  24028. },
  24029. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24030. },
  24031. "TimeStamp": {
  24032. "description": "TimeStamp defines a timestamp",
  24033. "type": "integer",
  24034. "format": "int64",
  24035. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  24036. },
  24037. "TimelineComment": {
  24038. "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
  24039. "type": "object",
  24040. "properties": {
  24041. "assignee": {
  24042. "$ref": "#/definitions/User"
  24043. },
  24044. "assignee_team": {
  24045. "$ref": "#/definitions/Team"
  24046. },
  24047. "body": {
  24048. "type": "string",
  24049. "x-go-name": "Body"
  24050. },
  24051. "created_at": {
  24052. "type": "string",
  24053. "format": "date-time",
  24054. "x-go-name": "Created"
  24055. },
  24056. "dependent_issue": {
  24057. "$ref": "#/definitions/Issue"
  24058. },
  24059. "html_url": {
  24060. "type": "string",
  24061. "x-go-name": "HTMLURL"
  24062. },
  24063. "id": {
  24064. "type": "integer",
  24065. "format": "int64",
  24066. "x-go-name": "ID"
  24067. },
  24068. "issue_url": {
  24069. "type": "string",
  24070. "x-go-name": "IssueURL"
  24071. },
  24072. "label": {
  24073. "$ref": "#/definitions/Label"
  24074. },
  24075. "milestone": {
  24076. "$ref": "#/definitions/Milestone"
  24077. },
  24078. "new_ref": {
  24079. "type": "string",
  24080. "x-go-name": "NewRef"
  24081. },
  24082. "new_title": {
  24083. "type": "string",
  24084. "x-go-name": "NewTitle"
  24085. },
  24086. "old_milestone": {
  24087. "$ref": "#/definitions/Milestone"
  24088. },
  24089. "old_project_id": {
  24090. "type": "integer",
  24091. "format": "int64",
  24092. "x-go-name": "OldProjectID"
  24093. },
  24094. "old_ref": {
  24095. "type": "string",
  24096. "x-go-name": "OldRef"
  24097. },
  24098. "old_title": {
  24099. "type": "string",
  24100. "x-go-name": "OldTitle"
  24101. },
  24102. "project_id": {
  24103. "type": "integer",
  24104. "format": "int64",
  24105. "x-go-name": "ProjectID"
  24106. },
  24107. "pull_request_url": {
  24108. "type": "string",
  24109. "x-go-name": "PRURL"
  24110. },
  24111. "ref_action": {
  24112. "type": "string",
  24113. "x-go-name": "RefAction"
  24114. },
  24115. "ref_comment": {
  24116. "$ref": "#/definitions/Comment"
  24117. },
  24118. "ref_commit_sha": {
  24119. "description": "commit SHA where issue/PR was referenced",
  24120. "type": "string",
  24121. "x-go-name": "RefCommitSHA"
  24122. },
  24123. "ref_issue": {
  24124. "$ref": "#/definitions/Issue"
  24125. },
  24126. "removed_assignee": {
  24127. "description": "whether the assignees were removed or added",
  24128. "type": "boolean",
  24129. "x-go-name": "RemovedAssignee"
  24130. },
  24131. "resolve_doer": {
  24132. "$ref": "#/definitions/User"
  24133. },
  24134. "review_id": {
  24135. "type": "integer",
  24136. "format": "int64",
  24137. "x-go-name": "ReviewID"
  24138. },
  24139. "tracked_time": {
  24140. "$ref": "#/definitions/TrackedTime"
  24141. },
  24142. "type": {
  24143. "type": "string",
  24144. "x-go-name": "Type"
  24145. },
  24146. "updated_at": {
  24147. "type": "string",
  24148. "format": "date-time",
  24149. "x-go-name": "Updated"
  24150. },
  24151. "user": {
  24152. "$ref": "#/definitions/User"
  24153. }
  24154. },
  24155. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24156. },
  24157. "TopicName": {
  24158. "description": "TopicName a list of repo topic names",
  24159. "type": "object",
  24160. "properties": {
  24161. "topics": {
  24162. "type": "array",
  24163. "items": {
  24164. "type": "string"
  24165. },
  24166. "x-go-name": "TopicNames"
  24167. }
  24168. },
  24169. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24170. },
  24171. "TopicResponse": {
  24172. "description": "TopicResponse for returning topics",
  24173. "type": "object",
  24174. "properties": {
  24175. "created": {
  24176. "type": "string",
  24177. "format": "date-time",
  24178. "x-go-name": "Created"
  24179. },
  24180. "id": {
  24181. "type": "integer",
  24182. "format": "int64",
  24183. "x-go-name": "ID"
  24184. },
  24185. "repo_count": {
  24186. "type": "integer",
  24187. "format": "int64",
  24188. "x-go-name": "RepoCount"
  24189. },
  24190. "topic_name": {
  24191. "type": "string",
  24192. "x-go-name": "Name"
  24193. },
  24194. "updated": {
  24195. "type": "string",
  24196. "format": "date-time",
  24197. "x-go-name": "Updated"
  24198. }
  24199. },
  24200. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24201. },
  24202. "TrackedTime": {
  24203. "description": "TrackedTime worked time for an issue / pr",
  24204. "type": "object",
  24205. "properties": {
  24206. "created": {
  24207. "type": "string",
  24208. "format": "date-time",
  24209. "x-go-name": "Created"
  24210. },
  24211. "id": {
  24212. "type": "integer",
  24213. "format": "int64",
  24214. "x-go-name": "ID"
  24215. },
  24216. "issue": {
  24217. "$ref": "#/definitions/Issue"
  24218. },
  24219. "issue_id": {
  24220. "description": "deprecated (only for backwards compatibility)",
  24221. "type": "integer",
  24222. "format": "int64",
  24223. "x-go-name": "IssueID"
  24224. },
  24225. "time": {
  24226. "description": "Time in seconds",
  24227. "type": "integer",
  24228. "format": "int64",
  24229. "x-go-name": "Time"
  24230. },
  24231. "user_id": {
  24232. "description": "deprecated (only for backwards compatibility)",
  24233. "type": "integer",
  24234. "format": "int64",
  24235. "x-go-name": "UserID"
  24236. },
  24237. "user_name": {
  24238. "type": "string",
  24239. "x-go-name": "UserName"
  24240. }
  24241. },
  24242. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24243. },
  24244. "TransferRepoOption": {
  24245. "description": "TransferRepoOption options when transfer a repository's ownership",
  24246. "type": "object",
  24247. "required": [
  24248. "new_owner"
  24249. ],
  24250. "properties": {
  24251. "new_owner": {
  24252. "type": "string",
  24253. "x-go-name": "NewOwner"
  24254. },
  24255. "team_ids": {
  24256. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  24257. "type": "array",
  24258. "items": {
  24259. "type": "integer",
  24260. "format": "int64"
  24261. },
  24262. "x-go-name": "TeamIDs"
  24263. }
  24264. },
  24265. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24266. },
  24267. "UpdateFileOptions": {
  24268. "description": "UpdateFileOptions options for updating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  24269. "type": "object",
  24270. "required": [
  24271. "sha",
  24272. "content"
  24273. ],
  24274. "properties": {
  24275. "author": {
  24276. "$ref": "#/definitions/Identity"
  24277. },
  24278. "branch": {
  24279. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  24280. "type": "string",
  24281. "x-go-name": "BranchName"
  24282. },
  24283. "committer": {
  24284. "$ref": "#/definitions/Identity"
  24285. },
  24286. "content": {
  24287. "description": "content must be base64 encoded",
  24288. "type": "string",
  24289. "x-go-name": "ContentBase64"
  24290. },
  24291. "dates": {
  24292. "$ref": "#/definitions/CommitDateOptions"
  24293. },
  24294. "from_path": {
  24295. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  24296. "type": "string",
  24297. "x-go-name": "FromPath"
  24298. },
  24299. "message": {
  24300. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  24301. "type": "string",
  24302. "x-go-name": "Message"
  24303. },
  24304. "new_branch": {
  24305. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  24306. "type": "string",
  24307. "x-go-name": "NewBranchName"
  24308. },
  24309. "sha": {
  24310. "description": "sha is the SHA for the file that already exists",
  24311. "type": "string",
  24312. "x-go-name": "SHA"
  24313. },
  24314. "signoff": {
  24315. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  24316. "type": "boolean",
  24317. "x-go-name": "Signoff"
  24318. }
  24319. },
  24320. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24321. },
  24322. "UpdateRepoAvatarOption": {
  24323. "description": "UpdateRepoAvatarUserOption options when updating the repo avatar",
  24324. "type": "object",
  24325. "properties": {
  24326. "image": {
  24327. "description": "image must be base64 encoded",
  24328. "type": "string",
  24329. "x-go-name": "Image"
  24330. }
  24331. },
  24332. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24333. },
  24334. "UpdateUserAvatarOption": {
  24335. "description": "UpdateUserAvatarUserOption options when updating the user avatar",
  24336. "type": "object",
  24337. "properties": {
  24338. "image": {
  24339. "description": "image must be base64 encoded",
  24340. "type": "string",
  24341. "x-go-name": "Image"
  24342. }
  24343. },
  24344. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24345. },
  24346. "UpdateVariableOption": {
  24347. "description": "UpdateVariableOption the option when updating variable",
  24348. "type": "object",
  24349. "required": [
  24350. "value"
  24351. ],
  24352. "properties": {
  24353. "name": {
  24354. "description": "New name for the variable. If the field is empty, the variable name won't be updated.",
  24355. "type": "string",
  24356. "x-go-name": "Name"
  24357. },
  24358. "value": {
  24359. "description": "Value of the variable to update",
  24360. "type": "string",
  24361. "x-go-name": "Value"
  24362. }
  24363. },
  24364. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24365. },
  24366. "User": {
  24367. "description": "User represents a user",
  24368. "type": "object",
  24369. "properties": {
  24370. "active": {
  24371. "description": "Is user active",
  24372. "type": "boolean",
  24373. "x-go-name": "IsActive"
  24374. },
  24375. "avatar_url": {
  24376. "description": "URL to the user's avatar",
  24377. "type": "string",
  24378. "x-go-name": "AvatarURL"
  24379. },
  24380. "created": {
  24381. "type": "string",
  24382. "format": "date-time",
  24383. "x-go-name": "Created"
  24384. },
  24385. "description": {
  24386. "description": "the user's description",
  24387. "type": "string",
  24388. "x-go-name": "Description"
  24389. },
  24390. "email": {
  24391. "type": "string",
  24392. "format": "email",
  24393. "x-go-name": "Email"
  24394. },
  24395. "followers_count": {
  24396. "description": "user counts",
  24397. "type": "integer",
  24398. "format": "int64",
  24399. "x-go-name": "Followers"
  24400. },
  24401. "following_count": {
  24402. "type": "integer",
  24403. "format": "int64",
  24404. "x-go-name": "Following"
  24405. },
  24406. "full_name": {
  24407. "description": "the user's full name",
  24408. "type": "string",
  24409. "x-go-name": "FullName"
  24410. },
  24411. "id": {
  24412. "description": "the user's id",
  24413. "type": "integer",
  24414. "format": "int64",
  24415. "x-go-name": "ID"
  24416. },
  24417. "is_admin": {
  24418. "description": "Is the user an administrator",
  24419. "type": "boolean",
  24420. "x-go-name": "IsAdmin"
  24421. },
  24422. "language": {
  24423. "description": "User locale",
  24424. "type": "string",
  24425. "x-go-name": "Language"
  24426. },
  24427. "last_login": {
  24428. "type": "string",
  24429. "format": "date-time",
  24430. "x-go-name": "LastLogin"
  24431. },
  24432. "location": {
  24433. "description": "the user's location",
  24434. "type": "string",
  24435. "x-go-name": "Location"
  24436. },
  24437. "login": {
  24438. "description": "the user's username",
  24439. "type": "string",
  24440. "x-go-name": "UserName"
  24441. },
  24442. "login_name": {
  24443. "description": "the user's authentication sign-in name.",
  24444. "type": "string",
  24445. "default": "empty",
  24446. "x-go-name": "LoginName"
  24447. },
  24448. "prohibit_login": {
  24449. "description": "Is user login prohibited",
  24450. "type": "boolean",
  24451. "x-go-name": "ProhibitLogin"
  24452. },
  24453. "restricted": {
  24454. "description": "Is user restricted",
  24455. "type": "boolean",
  24456. "x-go-name": "Restricted"
  24457. },
  24458. "source_id": {
  24459. "description": "The ID of the user's Authentication Source",
  24460. "type": "integer",
  24461. "format": "int64",
  24462. "x-go-name": "SourceID"
  24463. },
  24464. "starred_repos_count": {
  24465. "type": "integer",
  24466. "format": "int64",
  24467. "x-go-name": "StarredRepos"
  24468. },
  24469. "visibility": {
  24470. "description": "User visibility level option: public, limited, private",
  24471. "type": "string",
  24472. "x-go-name": "Visibility"
  24473. },
  24474. "website": {
  24475. "description": "the user's website",
  24476. "type": "string",
  24477. "x-go-name": "Website"
  24478. }
  24479. },
  24480. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24481. },
  24482. "UserBadgeOption": {
  24483. "description": "UserBadgeOption options for link between users and badges",
  24484. "type": "object",
  24485. "properties": {
  24486. "badge_slugs": {
  24487. "type": "array",
  24488. "items": {
  24489. "type": "string"
  24490. },
  24491. "x-go-name": "BadgeSlugs",
  24492. "example": [
  24493. "badge1",
  24494. "badge2"
  24495. ]
  24496. }
  24497. },
  24498. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24499. },
  24500. "UserHeatmapData": {
  24501. "description": "UserHeatmapData represents the data needed to create a heatmap",
  24502. "type": "object",
  24503. "properties": {
  24504. "contributions": {
  24505. "type": "integer",
  24506. "format": "int64",
  24507. "x-go-name": "Contributions"
  24508. },
  24509. "timestamp": {
  24510. "$ref": "#/definitions/TimeStamp"
  24511. }
  24512. },
  24513. "x-go-package": "code.gitea.io/gitea/models/activities"
  24514. },
  24515. "UserSettings": {
  24516. "description": "UserSettings represents user settings",
  24517. "type": "object",
  24518. "properties": {
  24519. "description": {
  24520. "type": "string",
  24521. "x-go-name": "Description"
  24522. },
  24523. "diff_view_style": {
  24524. "type": "string",
  24525. "x-go-name": "DiffViewStyle"
  24526. },
  24527. "full_name": {
  24528. "type": "string",
  24529. "x-go-name": "FullName"
  24530. },
  24531. "hide_activity": {
  24532. "type": "boolean",
  24533. "x-go-name": "HideActivity"
  24534. },
  24535. "hide_email": {
  24536. "description": "Privacy",
  24537. "type": "boolean",
  24538. "x-go-name": "HideEmail"
  24539. },
  24540. "language": {
  24541. "type": "string",
  24542. "x-go-name": "Language"
  24543. },
  24544. "location": {
  24545. "type": "string",
  24546. "x-go-name": "Location"
  24547. },
  24548. "theme": {
  24549. "type": "string",
  24550. "x-go-name": "Theme"
  24551. },
  24552. "website": {
  24553. "type": "string",
  24554. "x-go-name": "Website"
  24555. }
  24556. },
  24557. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24558. },
  24559. "UserSettingsOptions": {
  24560. "description": "UserSettingsOptions represents options to change user settings",
  24561. "type": "object",
  24562. "properties": {
  24563. "description": {
  24564. "type": "string",
  24565. "x-go-name": "Description"
  24566. },
  24567. "diff_view_style": {
  24568. "type": "string",
  24569. "x-go-name": "DiffViewStyle"
  24570. },
  24571. "full_name": {
  24572. "type": "string",
  24573. "x-go-name": "FullName"
  24574. },
  24575. "hide_activity": {
  24576. "type": "boolean",
  24577. "x-go-name": "HideActivity"
  24578. },
  24579. "hide_email": {
  24580. "description": "Privacy",
  24581. "type": "boolean",
  24582. "x-go-name": "HideEmail"
  24583. },
  24584. "language": {
  24585. "type": "string",
  24586. "x-go-name": "Language"
  24587. },
  24588. "location": {
  24589. "type": "string",
  24590. "x-go-name": "Location"
  24591. },
  24592. "theme": {
  24593. "type": "string",
  24594. "x-go-name": "Theme"
  24595. },
  24596. "website": {
  24597. "type": "string",
  24598. "x-go-name": "Website"
  24599. }
  24600. },
  24601. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24602. },
  24603. "WatchInfo": {
  24604. "description": "WatchInfo represents an API watch status of one repository",
  24605. "type": "object",
  24606. "properties": {
  24607. "created_at": {
  24608. "type": "string",
  24609. "format": "date-time",
  24610. "x-go-name": "CreatedAt"
  24611. },
  24612. "ignored": {
  24613. "type": "boolean",
  24614. "x-go-name": "Ignored"
  24615. },
  24616. "reason": {
  24617. "x-go-name": "Reason"
  24618. },
  24619. "repository_url": {
  24620. "type": "string",
  24621. "x-go-name": "RepositoryURL"
  24622. },
  24623. "subscribed": {
  24624. "type": "boolean",
  24625. "x-go-name": "Subscribed"
  24626. },
  24627. "url": {
  24628. "type": "string",
  24629. "x-go-name": "URL"
  24630. }
  24631. },
  24632. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24633. },
  24634. "WikiCommit": {
  24635. "description": "WikiCommit page commit/revision",
  24636. "type": "object",
  24637. "properties": {
  24638. "author": {
  24639. "$ref": "#/definitions/CommitUser"
  24640. },
  24641. "commiter": {
  24642. "$ref": "#/definitions/CommitUser"
  24643. },
  24644. "message": {
  24645. "type": "string",
  24646. "x-go-name": "Message"
  24647. },
  24648. "sha": {
  24649. "type": "string",
  24650. "x-go-name": "ID"
  24651. }
  24652. },
  24653. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24654. },
  24655. "WikiCommitList": {
  24656. "description": "WikiCommitList commit/revision list",
  24657. "type": "object",
  24658. "properties": {
  24659. "commits": {
  24660. "type": "array",
  24661. "items": {
  24662. "$ref": "#/definitions/WikiCommit"
  24663. },
  24664. "x-go-name": "WikiCommits"
  24665. },
  24666. "count": {
  24667. "type": "integer",
  24668. "format": "int64",
  24669. "x-go-name": "Count"
  24670. }
  24671. },
  24672. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24673. },
  24674. "WikiPage": {
  24675. "description": "WikiPage a wiki page",
  24676. "type": "object",
  24677. "properties": {
  24678. "commit_count": {
  24679. "type": "integer",
  24680. "format": "int64",
  24681. "x-go-name": "CommitCount"
  24682. },
  24683. "content_base64": {
  24684. "description": "Page content, base64 encoded",
  24685. "type": "string",
  24686. "x-go-name": "ContentBase64"
  24687. },
  24688. "footer": {
  24689. "type": "string",
  24690. "x-go-name": "Footer"
  24691. },
  24692. "html_url": {
  24693. "type": "string",
  24694. "x-go-name": "HTMLURL"
  24695. },
  24696. "last_commit": {
  24697. "$ref": "#/definitions/WikiCommit"
  24698. },
  24699. "sidebar": {
  24700. "type": "string",
  24701. "x-go-name": "Sidebar"
  24702. },
  24703. "sub_url": {
  24704. "type": "string",
  24705. "x-go-name": "SubURL"
  24706. },
  24707. "title": {
  24708. "type": "string",
  24709. "x-go-name": "Title"
  24710. }
  24711. },
  24712. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24713. },
  24714. "WikiPageMetaData": {
  24715. "description": "WikiPageMetaData wiki page meta information",
  24716. "type": "object",
  24717. "properties": {
  24718. "html_url": {
  24719. "type": "string",
  24720. "x-go-name": "HTMLURL"
  24721. },
  24722. "last_commit": {
  24723. "$ref": "#/definitions/WikiCommit"
  24724. },
  24725. "sub_url": {
  24726. "type": "string",
  24727. "x-go-name": "SubURL"
  24728. },
  24729. "title": {
  24730. "type": "string",
  24731. "x-go-name": "Title"
  24732. }
  24733. },
  24734. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24735. }
  24736. },
  24737. "responses": {
  24738. "AccessToken": {
  24739. "description": "AccessToken represents an API access token.",
  24740. "schema": {
  24741. "$ref": "#/definitions/AccessToken"
  24742. }
  24743. },
  24744. "AccessTokenList": {
  24745. "description": "AccessTokenList represents a list of API access token.",
  24746. "schema": {
  24747. "type": "array",
  24748. "items": {
  24749. "$ref": "#/definitions/AccessToken"
  24750. }
  24751. }
  24752. },
  24753. "ActionVariable": {
  24754. "description": "ActionVariable",
  24755. "schema": {
  24756. "$ref": "#/definitions/ActionVariable"
  24757. }
  24758. },
  24759. "ActivityFeedsList": {
  24760. "description": "ActivityFeedsList",
  24761. "schema": {
  24762. "type": "array",
  24763. "items": {
  24764. "$ref": "#/definitions/Activity"
  24765. }
  24766. }
  24767. },
  24768. "ActivityPub": {
  24769. "description": "ActivityPub",
  24770. "schema": {
  24771. "$ref": "#/definitions/ActivityPub"
  24772. }
  24773. },
  24774. "AnnotatedTag": {
  24775. "description": "AnnotatedTag",
  24776. "schema": {
  24777. "$ref": "#/definitions/AnnotatedTag"
  24778. }
  24779. },
  24780. "Attachment": {
  24781. "description": "Attachment",
  24782. "schema": {
  24783. "$ref": "#/definitions/Attachment"
  24784. }
  24785. },
  24786. "AttachmentList": {
  24787. "description": "AttachmentList",
  24788. "schema": {
  24789. "type": "array",
  24790. "items": {
  24791. "$ref": "#/definitions/Attachment"
  24792. }
  24793. }
  24794. },
  24795. "BadgeList": {
  24796. "description": "BadgeList",
  24797. "schema": {
  24798. "type": "array",
  24799. "items": {
  24800. "$ref": "#/definitions/Badge"
  24801. }
  24802. }
  24803. },
  24804. "Branch": {
  24805. "description": "Branch",
  24806. "schema": {
  24807. "$ref": "#/definitions/Branch"
  24808. }
  24809. },
  24810. "BranchList": {
  24811. "description": "BranchList",
  24812. "schema": {
  24813. "type": "array",
  24814. "items": {
  24815. "$ref": "#/definitions/Branch"
  24816. }
  24817. }
  24818. },
  24819. "BranchProtection": {
  24820. "description": "BranchProtection",
  24821. "schema": {
  24822. "$ref": "#/definitions/BranchProtection"
  24823. }
  24824. },
  24825. "BranchProtectionList": {
  24826. "description": "BranchProtectionList",
  24827. "schema": {
  24828. "type": "array",
  24829. "items": {
  24830. "$ref": "#/definitions/BranchProtection"
  24831. }
  24832. }
  24833. },
  24834. "ChangedFileList": {
  24835. "description": "ChangedFileList",
  24836. "schema": {
  24837. "type": "array",
  24838. "items": {
  24839. "$ref": "#/definitions/ChangedFile"
  24840. }
  24841. },
  24842. "headers": {
  24843. "X-HasMore": {
  24844. "type": "boolean",
  24845. "description": "True if there is another page"
  24846. },
  24847. "X-Page": {
  24848. "type": "integer",
  24849. "format": "int64",
  24850. "description": "The current page"
  24851. },
  24852. "X-PageCount": {
  24853. "type": "integer",
  24854. "format": "int64",
  24855. "description": "Total number of pages"
  24856. },
  24857. "X-PerPage": {
  24858. "type": "integer",
  24859. "format": "int64",
  24860. "description": "Commits per page"
  24861. },
  24862. "X-Total": {
  24863. "type": "integer",
  24864. "format": "int64",
  24865. "description": "Total commit count"
  24866. }
  24867. }
  24868. },
  24869. "CombinedStatus": {
  24870. "description": "CombinedStatus",
  24871. "schema": {
  24872. "$ref": "#/definitions/CombinedStatus"
  24873. }
  24874. },
  24875. "Comment": {
  24876. "description": "Comment",
  24877. "schema": {
  24878. "$ref": "#/definitions/Comment"
  24879. }
  24880. },
  24881. "CommentList": {
  24882. "description": "CommentList",
  24883. "schema": {
  24884. "type": "array",
  24885. "items": {
  24886. "$ref": "#/definitions/Comment"
  24887. }
  24888. }
  24889. },
  24890. "Commit": {
  24891. "description": "Commit",
  24892. "schema": {
  24893. "$ref": "#/definitions/Commit"
  24894. }
  24895. },
  24896. "CommitList": {
  24897. "description": "CommitList",
  24898. "schema": {
  24899. "type": "array",
  24900. "items": {
  24901. "$ref": "#/definitions/Commit"
  24902. }
  24903. },
  24904. "headers": {
  24905. "X-HasMore": {
  24906. "type": "boolean",
  24907. "description": "True if there is another page"
  24908. },
  24909. "X-Page": {
  24910. "type": "integer",
  24911. "format": "int64",
  24912. "description": "The current page"
  24913. },
  24914. "X-PageCount": {
  24915. "type": "integer",
  24916. "format": "int64",
  24917. "description": "Total number of pages"
  24918. },
  24919. "X-PerPage": {
  24920. "type": "integer",
  24921. "format": "int64",
  24922. "description": "Commits per page"
  24923. },
  24924. "X-Total": {
  24925. "type": "integer",
  24926. "format": "int64",
  24927. "description": "Total commit count"
  24928. }
  24929. }
  24930. },
  24931. "CommitStatus": {
  24932. "description": "CommitStatus",
  24933. "schema": {
  24934. "$ref": "#/definitions/CommitStatus"
  24935. }
  24936. },
  24937. "CommitStatusList": {
  24938. "description": "CommitStatusList",
  24939. "schema": {
  24940. "type": "array",
  24941. "items": {
  24942. "$ref": "#/definitions/CommitStatus"
  24943. }
  24944. }
  24945. },
  24946. "Compare": {
  24947. "description": "",
  24948. "schema": {
  24949. "$ref": "#/definitions/Compare"
  24950. }
  24951. },
  24952. "ContentsListResponse": {
  24953. "description": "ContentsListResponse",
  24954. "schema": {
  24955. "type": "array",
  24956. "items": {
  24957. "$ref": "#/definitions/ContentsResponse"
  24958. }
  24959. }
  24960. },
  24961. "ContentsResponse": {
  24962. "description": "ContentsResponse",
  24963. "schema": {
  24964. "$ref": "#/definitions/ContentsResponse"
  24965. }
  24966. },
  24967. "CronList": {
  24968. "description": "CronList",
  24969. "schema": {
  24970. "type": "array",
  24971. "items": {
  24972. "$ref": "#/definitions/Cron"
  24973. }
  24974. }
  24975. },
  24976. "DeployKey": {
  24977. "description": "DeployKey",
  24978. "schema": {
  24979. "$ref": "#/definitions/DeployKey"
  24980. }
  24981. },
  24982. "DeployKeyList": {
  24983. "description": "DeployKeyList",
  24984. "schema": {
  24985. "type": "array",
  24986. "items": {
  24987. "$ref": "#/definitions/DeployKey"
  24988. }
  24989. }
  24990. },
  24991. "EmailList": {
  24992. "description": "EmailList",
  24993. "schema": {
  24994. "type": "array",
  24995. "items": {
  24996. "$ref": "#/definitions/Email"
  24997. }
  24998. }
  24999. },
  25000. "EmptyRepository": {
  25001. "description": "EmptyRepository",
  25002. "schema": {
  25003. "$ref": "#/definitions/APIError"
  25004. }
  25005. },
  25006. "FileDeleteResponse": {
  25007. "description": "FileDeleteResponse",
  25008. "schema": {
  25009. "$ref": "#/definitions/FileDeleteResponse"
  25010. }
  25011. },
  25012. "FileResponse": {
  25013. "description": "FileResponse",
  25014. "schema": {
  25015. "$ref": "#/definitions/FileResponse"
  25016. }
  25017. },
  25018. "FilesResponse": {
  25019. "description": "FilesResponse",
  25020. "schema": {
  25021. "$ref": "#/definitions/FilesResponse"
  25022. }
  25023. },
  25024. "GPGKey": {
  25025. "description": "GPGKey",
  25026. "schema": {
  25027. "$ref": "#/definitions/GPGKey"
  25028. }
  25029. },
  25030. "GPGKeyList": {
  25031. "description": "GPGKeyList",
  25032. "schema": {
  25033. "type": "array",
  25034. "items": {
  25035. "$ref": "#/definitions/GPGKey"
  25036. }
  25037. }
  25038. },
  25039. "GeneralAPISettings": {
  25040. "description": "GeneralAPISettings",
  25041. "schema": {
  25042. "$ref": "#/definitions/GeneralAPISettings"
  25043. }
  25044. },
  25045. "GeneralAttachmentSettings": {
  25046. "description": "GeneralAttachmentSettings",
  25047. "schema": {
  25048. "$ref": "#/definitions/GeneralAttachmentSettings"
  25049. }
  25050. },
  25051. "GeneralRepoSettings": {
  25052. "description": "GeneralRepoSettings",
  25053. "schema": {
  25054. "$ref": "#/definitions/GeneralRepoSettings"
  25055. }
  25056. },
  25057. "GeneralUISettings": {
  25058. "description": "GeneralUISettings",
  25059. "schema": {
  25060. "$ref": "#/definitions/GeneralUISettings"
  25061. }
  25062. },
  25063. "GitBlobResponse": {
  25064. "description": "GitBlobResponse",
  25065. "schema": {
  25066. "$ref": "#/definitions/GitBlobResponse"
  25067. }
  25068. },
  25069. "GitHook": {
  25070. "description": "GitHook",
  25071. "schema": {
  25072. "$ref": "#/definitions/GitHook"
  25073. }
  25074. },
  25075. "GitHookList": {
  25076. "description": "GitHookList",
  25077. "schema": {
  25078. "type": "array",
  25079. "items": {
  25080. "$ref": "#/definitions/GitHook"
  25081. }
  25082. }
  25083. },
  25084. "GitTreeResponse": {
  25085. "description": "GitTreeResponse",
  25086. "schema": {
  25087. "$ref": "#/definitions/GitTreeResponse"
  25088. }
  25089. },
  25090. "GitignoreTemplateInfo": {
  25091. "description": "GitignoreTemplateInfo",
  25092. "schema": {
  25093. "$ref": "#/definitions/GitignoreTemplateInfo"
  25094. }
  25095. },
  25096. "GitignoreTemplateList": {
  25097. "description": "GitignoreTemplateList",
  25098. "schema": {
  25099. "type": "array",
  25100. "items": {
  25101. "type": "string"
  25102. }
  25103. }
  25104. },
  25105. "Hook": {
  25106. "description": "Hook",
  25107. "schema": {
  25108. "$ref": "#/definitions/Hook"
  25109. }
  25110. },
  25111. "HookList": {
  25112. "description": "HookList",
  25113. "schema": {
  25114. "type": "array",
  25115. "items": {
  25116. "$ref": "#/definitions/Hook"
  25117. }
  25118. }
  25119. },
  25120. "Issue": {
  25121. "description": "Issue",
  25122. "schema": {
  25123. "$ref": "#/definitions/Issue"
  25124. }
  25125. },
  25126. "IssueDeadline": {
  25127. "description": "IssueDeadline",
  25128. "schema": {
  25129. "$ref": "#/definitions/IssueDeadline"
  25130. }
  25131. },
  25132. "IssueList": {
  25133. "description": "IssueList",
  25134. "schema": {
  25135. "type": "array",
  25136. "items": {
  25137. "$ref": "#/definitions/Issue"
  25138. }
  25139. }
  25140. },
  25141. "IssueTemplates": {
  25142. "description": "IssueTemplates",
  25143. "schema": {
  25144. "type": "array",
  25145. "items": {
  25146. "$ref": "#/definitions/IssueTemplate"
  25147. }
  25148. }
  25149. },
  25150. "Label": {
  25151. "description": "Label",
  25152. "schema": {
  25153. "$ref": "#/definitions/Label"
  25154. }
  25155. },
  25156. "LabelList": {
  25157. "description": "LabelList",
  25158. "schema": {
  25159. "type": "array",
  25160. "items": {
  25161. "$ref": "#/definitions/Label"
  25162. }
  25163. }
  25164. },
  25165. "LabelTemplateInfo": {
  25166. "description": "LabelTemplateInfo",
  25167. "schema": {
  25168. "type": "array",
  25169. "items": {
  25170. "$ref": "#/definitions/LabelTemplate"
  25171. }
  25172. }
  25173. },
  25174. "LabelTemplateList": {
  25175. "description": "LabelTemplateList",
  25176. "schema": {
  25177. "type": "array",
  25178. "items": {
  25179. "type": "string"
  25180. }
  25181. }
  25182. },
  25183. "LanguageStatistics": {
  25184. "description": "LanguageStatistics",
  25185. "schema": {
  25186. "type": "object",
  25187. "additionalProperties": {
  25188. "type": "integer",
  25189. "format": "int64"
  25190. }
  25191. }
  25192. },
  25193. "LicenseTemplateInfo": {
  25194. "description": "LicenseTemplateInfo",
  25195. "schema": {
  25196. "$ref": "#/definitions/LicenseTemplateInfo"
  25197. }
  25198. },
  25199. "LicenseTemplateList": {
  25200. "description": "LicenseTemplateList",
  25201. "schema": {
  25202. "type": "array",
  25203. "items": {
  25204. "$ref": "#/definitions/LicensesTemplateListEntry"
  25205. }
  25206. }
  25207. },
  25208. "MarkdownRender": {
  25209. "description": "MarkdownRender is a rendered markdown document",
  25210. "schema": {
  25211. "type": "string"
  25212. }
  25213. },
  25214. "MarkupRender": {
  25215. "description": "MarkupRender is a rendered markup document",
  25216. "schema": {
  25217. "type": "string"
  25218. }
  25219. },
  25220. "Milestone": {
  25221. "description": "Milestone",
  25222. "schema": {
  25223. "$ref": "#/definitions/Milestone"
  25224. }
  25225. },
  25226. "MilestoneList": {
  25227. "description": "MilestoneList",
  25228. "schema": {
  25229. "type": "array",
  25230. "items": {
  25231. "$ref": "#/definitions/Milestone"
  25232. }
  25233. }
  25234. },
  25235. "NodeInfo": {
  25236. "description": "NodeInfo",
  25237. "schema": {
  25238. "$ref": "#/definitions/NodeInfo"
  25239. }
  25240. },
  25241. "Note": {
  25242. "description": "Note",
  25243. "schema": {
  25244. "$ref": "#/definitions/Note"
  25245. }
  25246. },
  25247. "NotificationCount": {
  25248. "description": "Number of unread notifications",
  25249. "schema": {
  25250. "$ref": "#/definitions/NotificationCount"
  25251. }
  25252. },
  25253. "NotificationThread": {
  25254. "description": "NotificationThread",
  25255. "schema": {
  25256. "$ref": "#/definitions/NotificationThread"
  25257. }
  25258. },
  25259. "NotificationThreadList": {
  25260. "description": "NotificationThreadList",
  25261. "schema": {
  25262. "type": "array",
  25263. "items": {
  25264. "$ref": "#/definitions/NotificationThread"
  25265. }
  25266. }
  25267. },
  25268. "OAuth2Application": {
  25269. "description": "OAuth2Application",
  25270. "schema": {
  25271. "$ref": "#/definitions/OAuth2Application"
  25272. }
  25273. },
  25274. "OAuth2ApplicationList": {
  25275. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  25276. "schema": {
  25277. "type": "array",
  25278. "items": {
  25279. "$ref": "#/definitions/OAuth2Application"
  25280. }
  25281. }
  25282. },
  25283. "Organization": {
  25284. "description": "Organization",
  25285. "schema": {
  25286. "$ref": "#/definitions/Organization"
  25287. }
  25288. },
  25289. "OrganizationList": {
  25290. "description": "OrganizationList",
  25291. "schema": {
  25292. "type": "array",
  25293. "items": {
  25294. "$ref": "#/definitions/Organization"
  25295. }
  25296. }
  25297. },
  25298. "OrganizationPermissions": {
  25299. "description": "OrganizationPermissions",
  25300. "schema": {
  25301. "$ref": "#/definitions/OrganizationPermissions"
  25302. }
  25303. },
  25304. "Package": {
  25305. "description": "Package",
  25306. "schema": {
  25307. "$ref": "#/definitions/Package"
  25308. }
  25309. },
  25310. "PackageFileList": {
  25311. "description": "PackageFileList",
  25312. "schema": {
  25313. "type": "array",
  25314. "items": {
  25315. "$ref": "#/definitions/PackageFile"
  25316. }
  25317. }
  25318. },
  25319. "PackageList": {
  25320. "description": "PackageList",
  25321. "schema": {
  25322. "type": "array",
  25323. "items": {
  25324. "$ref": "#/definitions/Package"
  25325. }
  25326. }
  25327. },
  25328. "PublicKey": {
  25329. "description": "PublicKey",
  25330. "schema": {
  25331. "$ref": "#/definitions/PublicKey"
  25332. }
  25333. },
  25334. "PublicKeyList": {
  25335. "description": "PublicKeyList",
  25336. "schema": {
  25337. "type": "array",
  25338. "items": {
  25339. "$ref": "#/definitions/PublicKey"
  25340. }
  25341. }
  25342. },
  25343. "PullRequest": {
  25344. "description": "PullRequest",
  25345. "schema": {
  25346. "$ref": "#/definitions/PullRequest"
  25347. }
  25348. },
  25349. "PullRequestList": {
  25350. "description": "PullRequestList",
  25351. "schema": {
  25352. "type": "array",
  25353. "items": {
  25354. "$ref": "#/definitions/PullRequest"
  25355. }
  25356. }
  25357. },
  25358. "PullReview": {
  25359. "description": "PullReview",
  25360. "schema": {
  25361. "$ref": "#/definitions/PullReview"
  25362. }
  25363. },
  25364. "PullReviewComment": {
  25365. "description": "PullComment",
  25366. "schema": {
  25367. "$ref": "#/definitions/PullReviewComment"
  25368. }
  25369. },
  25370. "PullReviewCommentList": {
  25371. "description": "PullCommentList",
  25372. "schema": {
  25373. "type": "array",
  25374. "items": {
  25375. "$ref": "#/definitions/PullReviewComment"
  25376. }
  25377. }
  25378. },
  25379. "PullReviewList": {
  25380. "description": "PullReviewList",
  25381. "schema": {
  25382. "type": "array",
  25383. "items": {
  25384. "$ref": "#/definitions/PullReview"
  25385. }
  25386. }
  25387. },
  25388. "PushMirror": {
  25389. "description": "PushMirror",
  25390. "schema": {
  25391. "$ref": "#/definitions/PushMirror"
  25392. }
  25393. },
  25394. "PushMirrorList": {
  25395. "description": "PushMirrorList",
  25396. "schema": {
  25397. "type": "array",
  25398. "items": {
  25399. "$ref": "#/definitions/PushMirror"
  25400. }
  25401. }
  25402. },
  25403. "Reaction": {
  25404. "description": "Reaction",
  25405. "schema": {
  25406. "$ref": "#/definitions/Reaction"
  25407. }
  25408. },
  25409. "ReactionList": {
  25410. "description": "ReactionList",
  25411. "schema": {
  25412. "type": "array",
  25413. "items": {
  25414. "$ref": "#/definitions/Reaction"
  25415. }
  25416. }
  25417. },
  25418. "Reference": {
  25419. "description": "Reference",
  25420. "schema": {
  25421. "$ref": "#/definitions/Reference"
  25422. }
  25423. },
  25424. "ReferenceList": {
  25425. "description": "ReferenceList",
  25426. "schema": {
  25427. "type": "array",
  25428. "items": {
  25429. "$ref": "#/definitions/Reference"
  25430. }
  25431. }
  25432. },
  25433. "RegistrationToken": {
  25434. "description": "RegistrationToken is response related to registration token",
  25435. "headers": {
  25436. "token": {
  25437. "type": "string"
  25438. }
  25439. }
  25440. },
  25441. "Release": {
  25442. "description": "Release",
  25443. "schema": {
  25444. "$ref": "#/definitions/Release"
  25445. }
  25446. },
  25447. "ReleaseList": {
  25448. "description": "ReleaseList",
  25449. "schema": {
  25450. "type": "array",
  25451. "items": {
  25452. "$ref": "#/definitions/Release"
  25453. }
  25454. }
  25455. },
  25456. "RepoCollaboratorPermission": {
  25457. "description": "RepoCollaboratorPermission",
  25458. "schema": {
  25459. "$ref": "#/definitions/RepoCollaboratorPermission"
  25460. }
  25461. },
  25462. "RepoIssueConfig": {
  25463. "description": "RepoIssueConfig",
  25464. "schema": {
  25465. "$ref": "#/definitions/IssueConfig"
  25466. }
  25467. },
  25468. "RepoIssueConfigValidation": {
  25469. "description": "RepoIssueConfigValidation",
  25470. "schema": {
  25471. "$ref": "#/definitions/IssueConfigValidation"
  25472. }
  25473. },
  25474. "RepoNewIssuePinsAllowed": {
  25475. "description": "RepoNewIssuePinsAllowed",
  25476. "schema": {
  25477. "$ref": "#/definitions/NewIssuePinsAllowed"
  25478. }
  25479. },
  25480. "Repository": {
  25481. "description": "Repository",
  25482. "schema": {
  25483. "$ref": "#/definitions/Repository"
  25484. }
  25485. },
  25486. "RepositoryList": {
  25487. "description": "RepositoryList",
  25488. "schema": {
  25489. "type": "array",
  25490. "items": {
  25491. "$ref": "#/definitions/Repository"
  25492. }
  25493. }
  25494. },
  25495. "SearchResults": {
  25496. "description": "SearchResults",
  25497. "schema": {
  25498. "$ref": "#/definitions/SearchResults"
  25499. }
  25500. },
  25501. "Secret": {
  25502. "description": "Secret",
  25503. "schema": {
  25504. "$ref": "#/definitions/Secret"
  25505. }
  25506. },
  25507. "SecretList": {
  25508. "description": "SecretList",
  25509. "schema": {
  25510. "type": "array",
  25511. "items": {
  25512. "$ref": "#/definitions/Secret"
  25513. }
  25514. }
  25515. },
  25516. "ServerVersion": {
  25517. "description": "ServerVersion",
  25518. "schema": {
  25519. "$ref": "#/definitions/ServerVersion"
  25520. }
  25521. },
  25522. "StopWatch": {
  25523. "description": "StopWatch",
  25524. "schema": {
  25525. "$ref": "#/definitions/StopWatch"
  25526. }
  25527. },
  25528. "StopWatchList": {
  25529. "description": "StopWatchList",
  25530. "schema": {
  25531. "type": "array",
  25532. "items": {
  25533. "$ref": "#/definitions/StopWatch"
  25534. }
  25535. }
  25536. },
  25537. "StringSlice": {
  25538. "description": "StringSlice",
  25539. "schema": {
  25540. "type": "array",
  25541. "items": {
  25542. "type": "string"
  25543. }
  25544. }
  25545. },
  25546. "Tag": {
  25547. "description": "Tag",
  25548. "schema": {
  25549. "$ref": "#/definitions/Tag"
  25550. }
  25551. },
  25552. "TagList": {
  25553. "description": "TagList",
  25554. "schema": {
  25555. "type": "array",
  25556. "items": {
  25557. "$ref": "#/definitions/Tag"
  25558. }
  25559. }
  25560. },
  25561. "TasksList": {
  25562. "description": "TasksList",
  25563. "schema": {
  25564. "$ref": "#/definitions/ActionTaskResponse"
  25565. }
  25566. },
  25567. "Team": {
  25568. "description": "Team",
  25569. "schema": {
  25570. "$ref": "#/definitions/Team"
  25571. }
  25572. },
  25573. "TeamList": {
  25574. "description": "TeamList",
  25575. "schema": {
  25576. "type": "array",
  25577. "items": {
  25578. "$ref": "#/definitions/Team"
  25579. }
  25580. }
  25581. },
  25582. "TimelineList": {
  25583. "description": "TimelineList",
  25584. "schema": {
  25585. "type": "array",
  25586. "items": {
  25587. "$ref": "#/definitions/TimelineComment"
  25588. }
  25589. }
  25590. },
  25591. "TopicListResponse": {
  25592. "description": "TopicListResponse",
  25593. "schema": {
  25594. "type": "array",
  25595. "items": {
  25596. "$ref": "#/definitions/TopicResponse"
  25597. }
  25598. }
  25599. },
  25600. "TopicNames": {
  25601. "description": "TopicNames",
  25602. "schema": {
  25603. "$ref": "#/definitions/TopicName"
  25604. }
  25605. },
  25606. "TrackedTime": {
  25607. "description": "TrackedTime",
  25608. "schema": {
  25609. "$ref": "#/definitions/TrackedTime"
  25610. }
  25611. },
  25612. "TrackedTimeList": {
  25613. "description": "TrackedTimeList",
  25614. "schema": {
  25615. "type": "array",
  25616. "items": {
  25617. "$ref": "#/definitions/TrackedTime"
  25618. }
  25619. }
  25620. },
  25621. "User": {
  25622. "description": "User",
  25623. "schema": {
  25624. "$ref": "#/definitions/User"
  25625. }
  25626. },
  25627. "UserHeatmapData": {
  25628. "description": "UserHeatmapData",
  25629. "schema": {
  25630. "type": "array",
  25631. "items": {
  25632. "$ref": "#/definitions/UserHeatmapData"
  25633. }
  25634. }
  25635. },
  25636. "UserList": {
  25637. "description": "UserList",
  25638. "schema": {
  25639. "type": "array",
  25640. "items": {
  25641. "$ref": "#/definitions/User"
  25642. }
  25643. }
  25644. },
  25645. "UserSettings": {
  25646. "description": "UserSettings",
  25647. "schema": {
  25648. "type": "array",
  25649. "items": {
  25650. "$ref": "#/definitions/UserSettings"
  25651. }
  25652. }
  25653. },
  25654. "VariableList": {
  25655. "description": "VariableList",
  25656. "schema": {
  25657. "type": "array",
  25658. "items": {
  25659. "$ref": "#/definitions/ActionVariable"
  25660. }
  25661. }
  25662. },
  25663. "WatchInfo": {
  25664. "description": "WatchInfo",
  25665. "schema": {
  25666. "$ref": "#/definitions/WatchInfo"
  25667. }
  25668. },
  25669. "WikiCommitList": {
  25670. "description": "WikiCommitList",
  25671. "schema": {
  25672. "$ref": "#/definitions/WikiCommitList"
  25673. }
  25674. },
  25675. "WikiPage": {
  25676. "description": "WikiPage",
  25677. "schema": {
  25678. "$ref": "#/definitions/WikiPage"
  25679. }
  25680. },
  25681. "WikiPageList": {
  25682. "description": "WikiPageList",
  25683. "schema": {
  25684. "type": "array",
  25685. "items": {
  25686. "$ref": "#/definitions/WikiPageMetaData"
  25687. }
  25688. }
  25689. },
  25690. "conflict": {
  25691. "description": "APIConflict is a conflict empty response"
  25692. },
  25693. "empty": {
  25694. "description": "APIEmpty is an empty response"
  25695. },
  25696. "error": {
  25697. "description": "APIError is error format response",
  25698. "headers": {
  25699. "message": {
  25700. "type": "string"
  25701. },
  25702. "url": {
  25703. "type": "string"
  25704. }
  25705. }
  25706. },
  25707. "forbidden": {
  25708. "description": "APIForbiddenError is a forbidden error response",
  25709. "headers": {
  25710. "message": {
  25711. "type": "string"
  25712. },
  25713. "url": {
  25714. "type": "string"
  25715. }
  25716. }
  25717. },
  25718. "invalidTopicsError": {
  25719. "description": "APIInvalidTopicsError is error format response to invalid topics",
  25720. "headers": {
  25721. "invalidTopics": {
  25722. "type": "array",
  25723. "items": {
  25724. "type": "string"
  25725. }
  25726. },
  25727. "message": {
  25728. "type": "string"
  25729. }
  25730. }
  25731. },
  25732. "notFound": {
  25733. "description": "APINotFound is a not found empty response"
  25734. },
  25735. "parameterBodies": {
  25736. "description": "parameterBodies",
  25737. "schema": {
  25738. "$ref": "#/definitions/UpdateVariableOption"
  25739. }
  25740. },
  25741. "redirect": {
  25742. "description": "APIRedirect is a redirect response"
  25743. },
  25744. "repoArchivedError": {
  25745. "description": "APIRepoArchivedError is an error that is raised when an archived repo should be modified",
  25746. "headers": {
  25747. "message": {
  25748. "type": "string"
  25749. },
  25750. "url": {
  25751. "type": "string"
  25752. }
  25753. }
  25754. },
  25755. "string": {
  25756. "description": "APIString is a string response",
  25757. "schema": {
  25758. "type": "string"
  25759. }
  25760. },
  25761. "validationError": {
  25762. "description": "APIValidationError is error format response related to input validation",
  25763. "headers": {
  25764. "message": {
  25765. "type": "string"
  25766. },
  25767. "url": {
  25768. "type": "string"
  25769. }
  25770. }
  25771. }
  25772. },
  25773. "securityDefinitions": {
  25774. "AccessToken": {
  25775. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  25776. "type": "apiKey",
  25777. "name": "access_token",
  25778. "in": "query"
  25779. },
  25780. "AuthorizationHeaderToken": {
  25781. "description": "API tokens must be prepended with \"token\" followed by a space.",
  25782. "type": "apiKey",
  25783. "name": "Authorization",
  25784. "in": "header"
  25785. },
  25786. "BasicAuth": {
  25787. "type": "basic"
  25788. },
  25789. "SudoHeader": {
  25790. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  25791. "type": "apiKey",
  25792. "name": "Sudo",
  25793. "in": "header"
  25794. },
  25795. "SudoParam": {
  25796. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  25797. "type": "apiKey",
  25798. "name": "sudo",
  25799. "in": "query"
  25800. },
  25801. "TOTPHeader": {
  25802. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  25803. "type": "apiKey",
  25804. "name": "X-GITEA-OTP",
  25805. "in": "header"
  25806. },
  25807. "Token": {
  25808. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  25809. "type": "apiKey",
  25810. "name": "token",
  25811. "in": "query"
  25812. }
  25813. },
  25814. "security": [
  25815. {
  25816. "BasicAuth": []
  25817. },
  25818. {
  25819. "Token": []
  25820. },
  25821. {
  25822. "AccessToken": []
  25823. },
  25824. {
  25825. "AuthorizationHeaderToken": []
  25826. },
  25827. {
  25828. "SudoParam": []
  25829. },
  25830. {
  25831. "SudoHeader": []
  25832. },
  25833. {
  25834. "TOTPHeader": []
  25835. }
  25836. ]
  25837. }