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 644KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560
  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\", 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/{secretname}": {
  3847. "put": {
  3848. "consumes": [
  3849. "application/json"
  3850. ],
  3851. "produces": [
  3852. "application/json"
  3853. ],
  3854. "tags": [
  3855. "repository"
  3856. ],
  3857. "summary": "Create or Update a secret value in a repository",
  3858. "operationId": "updateRepoSecret",
  3859. "parameters": [
  3860. {
  3861. "type": "string",
  3862. "description": "owner of the repository",
  3863. "name": "owner",
  3864. "in": "path",
  3865. "required": true
  3866. },
  3867. {
  3868. "type": "string",
  3869. "description": "name of the repository",
  3870. "name": "repo",
  3871. "in": "path",
  3872. "required": true
  3873. },
  3874. {
  3875. "type": "string",
  3876. "description": "name of the secret",
  3877. "name": "secretname",
  3878. "in": "path",
  3879. "required": true
  3880. },
  3881. {
  3882. "name": "body",
  3883. "in": "body",
  3884. "schema": {
  3885. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  3886. }
  3887. }
  3888. ],
  3889. "responses": {
  3890. "201": {
  3891. "description": "response when creating a secret"
  3892. },
  3893. "204": {
  3894. "description": "response when updating a secret"
  3895. },
  3896. "400": {
  3897. "$ref": "#/responses/error"
  3898. },
  3899. "404": {
  3900. "$ref": "#/responses/notFound"
  3901. }
  3902. }
  3903. },
  3904. "delete": {
  3905. "consumes": [
  3906. "application/json"
  3907. ],
  3908. "produces": [
  3909. "application/json"
  3910. ],
  3911. "tags": [
  3912. "repository"
  3913. ],
  3914. "summary": "Delete a secret in a repository",
  3915. "operationId": "deleteRepoSecret",
  3916. "parameters": [
  3917. {
  3918. "type": "string",
  3919. "description": "owner of the repository",
  3920. "name": "owner",
  3921. "in": "path",
  3922. "required": true
  3923. },
  3924. {
  3925. "type": "string",
  3926. "description": "name of the repository",
  3927. "name": "repo",
  3928. "in": "path",
  3929. "required": true
  3930. },
  3931. {
  3932. "type": "string",
  3933. "description": "name of the secret",
  3934. "name": "secretname",
  3935. "in": "path",
  3936. "required": true
  3937. }
  3938. ],
  3939. "responses": {
  3940. "204": {
  3941. "description": "delete one secret of the organization"
  3942. },
  3943. "400": {
  3944. "$ref": "#/responses/error"
  3945. },
  3946. "404": {
  3947. "$ref": "#/responses/notFound"
  3948. }
  3949. }
  3950. }
  3951. },
  3952. "/repos/{owner}/{repo}/actions/variables": {
  3953. "get": {
  3954. "produces": [
  3955. "application/json"
  3956. ],
  3957. "tags": [
  3958. "repository"
  3959. ],
  3960. "summary": "Get repo-level variables list",
  3961. "operationId": "getRepoVariablesList",
  3962. "parameters": [
  3963. {
  3964. "type": "string",
  3965. "description": "name of the owner",
  3966. "name": "owner",
  3967. "in": "path",
  3968. "required": true
  3969. },
  3970. {
  3971. "type": "string",
  3972. "description": "name of the repository",
  3973. "name": "repo",
  3974. "in": "path",
  3975. "required": true
  3976. },
  3977. {
  3978. "type": "integer",
  3979. "description": "page number of results to return (1-based)",
  3980. "name": "page",
  3981. "in": "query"
  3982. },
  3983. {
  3984. "type": "integer",
  3985. "description": "page size of results",
  3986. "name": "limit",
  3987. "in": "query"
  3988. }
  3989. ],
  3990. "responses": {
  3991. "200": {
  3992. "$ref": "#/responses/VariableList"
  3993. },
  3994. "400": {
  3995. "$ref": "#/responses/error"
  3996. },
  3997. "404": {
  3998. "$ref": "#/responses/notFound"
  3999. }
  4000. }
  4001. }
  4002. },
  4003. "/repos/{owner}/{repo}/actions/variables/{variablename}": {
  4004. "get": {
  4005. "produces": [
  4006. "application/json"
  4007. ],
  4008. "tags": [
  4009. "repository"
  4010. ],
  4011. "summary": "Get a repo-level variable",
  4012. "operationId": "getRepoVariable",
  4013. "parameters": [
  4014. {
  4015. "type": "string",
  4016. "description": "name of the owner",
  4017. "name": "owner",
  4018. "in": "path",
  4019. "required": true
  4020. },
  4021. {
  4022. "type": "string",
  4023. "description": "name of the repository",
  4024. "name": "repo",
  4025. "in": "path",
  4026. "required": true
  4027. },
  4028. {
  4029. "type": "string",
  4030. "description": "name of the variable",
  4031. "name": "variablename",
  4032. "in": "path",
  4033. "required": true
  4034. }
  4035. ],
  4036. "responses": {
  4037. "200": {
  4038. "$ref": "#/responses/ActionVariable"
  4039. },
  4040. "400": {
  4041. "$ref": "#/responses/error"
  4042. },
  4043. "404": {
  4044. "$ref": "#/responses/notFound"
  4045. }
  4046. }
  4047. },
  4048. "put": {
  4049. "produces": [
  4050. "application/json"
  4051. ],
  4052. "tags": [
  4053. "repository"
  4054. ],
  4055. "summary": "Update a repo-level variable",
  4056. "operationId": "updateRepoVariable",
  4057. "parameters": [
  4058. {
  4059. "type": "string",
  4060. "description": "name of the owner",
  4061. "name": "owner",
  4062. "in": "path",
  4063. "required": true
  4064. },
  4065. {
  4066. "type": "string",
  4067. "description": "name of the repository",
  4068. "name": "repo",
  4069. "in": "path",
  4070. "required": true
  4071. },
  4072. {
  4073. "type": "string",
  4074. "description": "name of the variable",
  4075. "name": "variablename",
  4076. "in": "path",
  4077. "required": true
  4078. },
  4079. {
  4080. "name": "body",
  4081. "in": "body",
  4082. "schema": {
  4083. "$ref": "#/definitions/UpdateVariableOption"
  4084. }
  4085. }
  4086. ],
  4087. "responses": {
  4088. "201": {
  4089. "description": "response when updating a repo-level variable"
  4090. },
  4091. "204": {
  4092. "description": "response when updating a repo-level variable"
  4093. },
  4094. "400": {
  4095. "$ref": "#/responses/error"
  4096. },
  4097. "404": {
  4098. "$ref": "#/responses/notFound"
  4099. }
  4100. }
  4101. },
  4102. "post": {
  4103. "produces": [
  4104. "application/json"
  4105. ],
  4106. "tags": [
  4107. "repository"
  4108. ],
  4109. "summary": "Create a repo-level variable",
  4110. "operationId": "createRepoVariable",
  4111. "parameters": [
  4112. {
  4113. "type": "string",
  4114. "description": "name of the owner",
  4115. "name": "owner",
  4116. "in": "path",
  4117. "required": true
  4118. },
  4119. {
  4120. "type": "string",
  4121. "description": "name of the repository",
  4122. "name": "repo",
  4123. "in": "path",
  4124. "required": true
  4125. },
  4126. {
  4127. "type": "string",
  4128. "description": "name of the variable",
  4129. "name": "variablename",
  4130. "in": "path",
  4131. "required": true
  4132. },
  4133. {
  4134. "name": "body",
  4135. "in": "body",
  4136. "schema": {
  4137. "$ref": "#/definitions/CreateVariableOption"
  4138. }
  4139. }
  4140. ],
  4141. "responses": {
  4142. "201": {
  4143. "description": "response when creating a repo-level variable"
  4144. },
  4145. "204": {
  4146. "description": "response when creating a repo-level variable"
  4147. },
  4148. "400": {
  4149. "$ref": "#/responses/error"
  4150. },
  4151. "404": {
  4152. "$ref": "#/responses/notFound"
  4153. }
  4154. }
  4155. },
  4156. "delete": {
  4157. "produces": [
  4158. "application/json"
  4159. ],
  4160. "tags": [
  4161. "repository"
  4162. ],
  4163. "summary": "Delete a repo-level variable",
  4164. "operationId": "deleteRepoVariable",
  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. "responses": {
  4189. "200": {
  4190. "$ref": "#/responses/ActionVariable"
  4191. },
  4192. "201": {
  4193. "description": "response when deleting a variable"
  4194. },
  4195. "204": {
  4196. "description": "response when deleting a variable"
  4197. },
  4198. "400": {
  4199. "$ref": "#/responses/error"
  4200. },
  4201. "404": {
  4202. "$ref": "#/responses/notFound"
  4203. }
  4204. }
  4205. }
  4206. },
  4207. "/repos/{owner}/{repo}/activities/feeds": {
  4208. "get": {
  4209. "produces": [
  4210. "application/json"
  4211. ],
  4212. "tags": [
  4213. "repository"
  4214. ],
  4215. "summary": "List a repository's activity feeds",
  4216. "operationId": "repoListActivityFeeds",
  4217. "parameters": [
  4218. {
  4219. "type": "string",
  4220. "description": "owner of the repo",
  4221. "name": "owner",
  4222. "in": "path",
  4223. "required": true
  4224. },
  4225. {
  4226. "type": "string",
  4227. "description": "name of the repo",
  4228. "name": "repo",
  4229. "in": "path",
  4230. "required": true
  4231. },
  4232. {
  4233. "type": "string",
  4234. "format": "date",
  4235. "description": "the date of the activities to be found",
  4236. "name": "date",
  4237. "in": "query"
  4238. },
  4239. {
  4240. "type": "integer",
  4241. "description": "page number of results to return (1-based)",
  4242. "name": "page",
  4243. "in": "query"
  4244. },
  4245. {
  4246. "type": "integer",
  4247. "description": "page size of results",
  4248. "name": "limit",
  4249. "in": "query"
  4250. }
  4251. ],
  4252. "responses": {
  4253. "200": {
  4254. "$ref": "#/responses/ActivityFeedsList"
  4255. },
  4256. "404": {
  4257. "$ref": "#/responses/notFound"
  4258. }
  4259. }
  4260. }
  4261. },
  4262. "/repos/{owner}/{repo}/archive/{archive}": {
  4263. "get": {
  4264. "produces": [
  4265. "application/json"
  4266. ],
  4267. "tags": [
  4268. "repository"
  4269. ],
  4270. "summary": "Get an archive of a repository",
  4271. "operationId": "repoGetArchive",
  4272. "parameters": [
  4273. {
  4274. "type": "string",
  4275. "description": "owner of the repo",
  4276. "name": "owner",
  4277. "in": "path",
  4278. "required": true
  4279. },
  4280. {
  4281. "type": "string",
  4282. "description": "name of the repo",
  4283. "name": "repo",
  4284. "in": "path",
  4285. "required": true
  4286. },
  4287. {
  4288. "type": "string",
  4289. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  4290. "name": "archive",
  4291. "in": "path",
  4292. "required": true
  4293. }
  4294. ],
  4295. "responses": {
  4296. "200": {
  4297. "description": "success"
  4298. },
  4299. "404": {
  4300. "$ref": "#/responses/notFound"
  4301. }
  4302. }
  4303. }
  4304. },
  4305. "/repos/{owner}/{repo}/assignees": {
  4306. "get": {
  4307. "produces": [
  4308. "application/json"
  4309. ],
  4310. "tags": [
  4311. "repository"
  4312. ],
  4313. "summary": "Return all users that have write access and can be assigned to issues",
  4314. "operationId": "repoGetAssignees",
  4315. "parameters": [
  4316. {
  4317. "type": "string",
  4318. "description": "owner of the repo",
  4319. "name": "owner",
  4320. "in": "path",
  4321. "required": true
  4322. },
  4323. {
  4324. "type": "string",
  4325. "description": "name of the repo",
  4326. "name": "repo",
  4327. "in": "path",
  4328. "required": true
  4329. }
  4330. ],
  4331. "responses": {
  4332. "200": {
  4333. "$ref": "#/responses/UserList"
  4334. },
  4335. "404": {
  4336. "$ref": "#/responses/notFound"
  4337. }
  4338. }
  4339. }
  4340. },
  4341. "/repos/{owner}/{repo}/avatar": {
  4342. "post": {
  4343. "produces": [
  4344. "application/json"
  4345. ],
  4346. "tags": [
  4347. "repository"
  4348. ],
  4349. "summary": "Update avatar",
  4350. "operationId": "repoUpdateAvatar",
  4351. "parameters": [
  4352. {
  4353. "type": "string",
  4354. "description": "owner of the repo",
  4355. "name": "owner",
  4356. "in": "path",
  4357. "required": true
  4358. },
  4359. {
  4360. "type": "string",
  4361. "description": "name of the repo",
  4362. "name": "repo",
  4363. "in": "path",
  4364. "required": true
  4365. },
  4366. {
  4367. "name": "body",
  4368. "in": "body",
  4369. "schema": {
  4370. "$ref": "#/definitions/UpdateRepoAvatarOption"
  4371. }
  4372. }
  4373. ],
  4374. "responses": {
  4375. "204": {
  4376. "$ref": "#/responses/empty"
  4377. },
  4378. "404": {
  4379. "$ref": "#/responses/notFound"
  4380. }
  4381. }
  4382. },
  4383. "delete": {
  4384. "produces": [
  4385. "application/json"
  4386. ],
  4387. "tags": [
  4388. "repository"
  4389. ],
  4390. "summary": "Delete avatar",
  4391. "operationId": "repoDeleteAvatar",
  4392. "parameters": [
  4393. {
  4394. "type": "string",
  4395. "description": "owner of the repo",
  4396. "name": "owner",
  4397. "in": "path",
  4398. "required": true
  4399. },
  4400. {
  4401. "type": "string",
  4402. "description": "name of the repo",
  4403. "name": "repo",
  4404. "in": "path",
  4405. "required": true
  4406. }
  4407. ],
  4408. "responses": {
  4409. "204": {
  4410. "$ref": "#/responses/empty"
  4411. },
  4412. "404": {
  4413. "$ref": "#/responses/notFound"
  4414. }
  4415. }
  4416. }
  4417. },
  4418. "/repos/{owner}/{repo}/branch_protections": {
  4419. "get": {
  4420. "produces": [
  4421. "application/json"
  4422. ],
  4423. "tags": [
  4424. "repository"
  4425. ],
  4426. "summary": "List branch protections for a repository",
  4427. "operationId": "repoListBranchProtection",
  4428. "parameters": [
  4429. {
  4430. "type": "string",
  4431. "description": "owner of the repo",
  4432. "name": "owner",
  4433. "in": "path",
  4434. "required": true
  4435. },
  4436. {
  4437. "type": "string",
  4438. "description": "name of the repo",
  4439. "name": "repo",
  4440. "in": "path",
  4441. "required": true
  4442. }
  4443. ],
  4444. "responses": {
  4445. "200": {
  4446. "$ref": "#/responses/BranchProtectionList"
  4447. }
  4448. }
  4449. },
  4450. "post": {
  4451. "consumes": [
  4452. "application/json"
  4453. ],
  4454. "produces": [
  4455. "application/json"
  4456. ],
  4457. "tags": [
  4458. "repository"
  4459. ],
  4460. "summary": "Create a branch protections for a repository",
  4461. "operationId": "repoCreateBranchProtection",
  4462. "parameters": [
  4463. {
  4464. "type": "string",
  4465. "description": "owner of the repo",
  4466. "name": "owner",
  4467. "in": "path",
  4468. "required": true
  4469. },
  4470. {
  4471. "type": "string",
  4472. "description": "name of the repo",
  4473. "name": "repo",
  4474. "in": "path",
  4475. "required": true
  4476. },
  4477. {
  4478. "name": "body",
  4479. "in": "body",
  4480. "schema": {
  4481. "$ref": "#/definitions/CreateBranchProtectionOption"
  4482. }
  4483. }
  4484. ],
  4485. "responses": {
  4486. "201": {
  4487. "$ref": "#/responses/BranchProtection"
  4488. },
  4489. "403": {
  4490. "$ref": "#/responses/forbidden"
  4491. },
  4492. "404": {
  4493. "$ref": "#/responses/notFound"
  4494. },
  4495. "422": {
  4496. "$ref": "#/responses/validationError"
  4497. },
  4498. "423": {
  4499. "$ref": "#/responses/repoArchivedError"
  4500. }
  4501. }
  4502. }
  4503. },
  4504. "/repos/{owner}/{repo}/branch_protections/{name}": {
  4505. "get": {
  4506. "produces": [
  4507. "application/json"
  4508. ],
  4509. "tags": [
  4510. "repository"
  4511. ],
  4512. "summary": "Get a specific branch protection for the repository",
  4513. "operationId": "repoGetBranchProtection",
  4514. "parameters": [
  4515. {
  4516. "type": "string",
  4517. "description": "owner of the repo",
  4518. "name": "owner",
  4519. "in": "path",
  4520. "required": true
  4521. },
  4522. {
  4523. "type": "string",
  4524. "description": "name of the repo",
  4525. "name": "repo",
  4526. "in": "path",
  4527. "required": true
  4528. },
  4529. {
  4530. "type": "string",
  4531. "description": "name of protected branch",
  4532. "name": "name",
  4533. "in": "path",
  4534. "required": true
  4535. }
  4536. ],
  4537. "responses": {
  4538. "200": {
  4539. "$ref": "#/responses/BranchProtection"
  4540. },
  4541. "404": {
  4542. "$ref": "#/responses/notFound"
  4543. }
  4544. }
  4545. },
  4546. "delete": {
  4547. "produces": [
  4548. "application/json"
  4549. ],
  4550. "tags": [
  4551. "repository"
  4552. ],
  4553. "summary": "Delete a specific branch protection for the repository",
  4554. "operationId": "repoDeleteBranchProtection",
  4555. "parameters": [
  4556. {
  4557. "type": "string",
  4558. "description": "owner of the repo",
  4559. "name": "owner",
  4560. "in": "path",
  4561. "required": true
  4562. },
  4563. {
  4564. "type": "string",
  4565. "description": "name of the repo",
  4566. "name": "repo",
  4567. "in": "path",
  4568. "required": true
  4569. },
  4570. {
  4571. "type": "string",
  4572. "description": "name of protected branch",
  4573. "name": "name",
  4574. "in": "path",
  4575. "required": true
  4576. }
  4577. ],
  4578. "responses": {
  4579. "204": {
  4580. "$ref": "#/responses/empty"
  4581. },
  4582. "404": {
  4583. "$ref": "#/responses/notFound"
  4584. }
  4585. }
  4586. },
  4587. "patch": {
  4588. "consumes": [
  4589. "application/json"
  4590. ],
  4591. "produces": [
  4592. "application/json"
  4593. ],
  4594. "tags": [
  4595. "repository"
  4596. ],
  4597. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  4598. "operationId": "repoEditBranchProtection",
  4599. "parameters": [
  4600. {
  4601. "type": "string",
  4602. "description": "owner of the repo",
  4603. "name": "owner",
  4604. "in": "path",
  4605. "required": true
  4606. },
  4607. {
  4608. "type": "string",
  4609. "description": "name of the repo",
  4610. "name": "repo",
  4611. "in": "path",
  4612. "required": true
  4613. },
  4614. {
  4615. "type": "string",
  4616. "description": "name of protected branch",
  4617. "name": "name",
  4618. "in": "path",
  4619. "required": true
  4620. },
  4621. {
  4622. "name": "body",
  4623. "in": "body",
  4624. "schema": {
  4625. "$ref": "#/definitions/EditBranchProtectionOption"
  4626. }
  4627. }
  4628. ],
  4629. "responses": {
  4630. "200": {
  4631. "$ref": "#/responses/BranchProtection"
  4632. },
  4633. "404": {
  4634. "$ref": "#/responses/notFound"
  4635. },
  4636. "422": {
  4637. "$ref": "#/responses/validationError"
  4638. },
  4639. "423": {
  4640. "$ref": "#/responses/repoArchivedError"
  4641. }
  4642. }
  4643. }
  4644. },
  4645. "/repos/{owner}/{repo}/branches": {
  4646. "get": {
  4647. "produces": [
  4648. "application/json"
  4649. ],
  4650. "tags": [
  4651. "repository"
  4652. ],
  4653. "summary": "List a repository's branches",
  4654. "operationId": "repoListBranches",
  4655. "parameters": [
  4656. {
  4657. "type": "string",
  4658. "description": "owner of the repo",
  4659. "name": "owner",
  4660. "in": "path",
  4661. "required": true
  4662. },
  4663. {
  4664. "type": "string",
  4665. "description": "name of the repo",
  4666. "name": "repo",
  4667. "in": "path",
  4668. "required": true
  4669. },
  4670. {
  4671. "type": "integer",
  4672. "description": "page number of results to return (1-based)",
  4673. "name": "page",
  4674. "in": "query"
  4675. },
  4676. {
  4677. "type": "integer",
  4678. "description": "page size of results",
  4679. "name": "limit",
  4680. "in": "query"
  4681. }
  4682. ],
  4683. "responses": {
  4684. "200": {
  4685. "$ref": "#/responses/BranchList"
  4686. }
  4687. }
  4688. },
  4689. "post": {
  4690. "consumes": [
  4691. "application/json"
  4692. ],
  4693. "produces": [
  4694. "application/json"
  4695. ],
  4696. "tags": [
  4697. "repository"
  4698. ],
  4699. "summary": "Create a branch",
  4700. "operationId": "repoCreateBranch",
  4701. "parameters": [
  4702. {
  4703. "type": "string",
  4704. "description": "owner of the repo",
  4705. "name": "owner",
  4706. "in": "path",
  4707. "required": true
  4708. },
  4709. {
  4710. "type": "string",
  4711. "description": "name of the repo",
  4712. "name": "repo",
  4713. "in": "path",
  4714. "required": true
  4715. },
  4716. {
  4717. "name": "body",
  4718. "in": "body",
  4719. "schema": {
  4720. "$ref": "#/definitions/CreateBranchRepoOption"
  4721. }
  4722. }
  4723. ],
  4724. "responses": {
  4725. "201": {
  4726. "$ref": "#/responses/Branch"
  4727. },
  4728. "403": {
  4729. "description": "The branch is archived or a mirror."
  4730. },
  4731. "404": {
  4732. "description": "The old branch does not exist."
  4733. },
  4734. "409": {
  4735. "description": "The branch with the same name already exists."
  4736. },
  4737. "423": {
  4738. "$ref": "#/responses/repoArchivedError"
  4739. }
  4740. }
  4741. }
  4742. },
  4743. "/repos/{owner}/{repo}/branches/{branch}": {
  4744. "get": {
  4745. "produces": [
  4746. "application/json"
  4747. ],
  4748. "tags": [
  4749. "repository"
  4750. ],
  4751. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  4752. "operationId": "repoGetBranch",
  4753. "parameters": [
  4754. {
  4755. "type": "string",
  4756. "description": "owner of the repo",
  4757. "name": "owner",
  4758. "in": "path",
  4759. "required": true
  4760. },
  4761. {
  4762. "type": "string",
  4763. "description": "name of the repo",
  4764. "name": "repo",
  4765. "in": "path",
  4766. "required": true
  4767. },
  4768. {
  4769. "type": "string",
  4770. "description": "branch to get",
  4771. "name": "branch",
  4772. "in": "path",
  4773. "required": true
  4774. }
  4775. ],
  4776. "responses": {
  4777. "200": {
  4778. "$ref": "#/responses/Branch"
  4779. },
  4780. "404": {
  4781. "$ref": "#/responses/notFound"
  4782. }
  4783. }
  4784. },
  4785. "delete": {
  4786. "produces": [
  4787. "application/json"
  4788. ],
  4789. "tags": [
  4790. "repository"
  4791. ],
  4792. "summary": "Delete a specific branch from a repository",
  4793. "operationId": "repoDeleteBranch",
  4794. "parameters": [
  4795. {
  4796. "type": "string",
  4797. "description": "owner of the repo",
  4798. "name": "owner",
  4799. "in": "path",
  4800. "required": true
  4801. },
  4802. {
  4803. "type": "string",
  4804. "description": "name of the repo",
  4805. "name": "repo",
  4806. "in": "path",
  4807. "required": true
  4808. },
  4809. {
  4810. "type": "string",
  4811. "description": "branch to delete",
  4812. "name": "branch",
  4813. "in": "path",
  4814. "required": true
  4815. }
  4816. ],
  4817. "responses": {
  4818. "204": {
  4819. "$ref": "#/responses/empty"
  4820. },
  4821. "403": {
  4822. "$ref": "#/responses/error"
  4823. },
  4824. "404": {
  4825. "$ref": "#/responses/notFound"
  4826. },
  4827. "423": {
  4828. "$ref": "#/responses/repoArchivedError"
  4829. }
  4830. }
  4831. }
  4832. },
  4833. "/repos/{owner}/{repo}/collaborators": {
  4834. "get": {
  4835. "produces": [
  4836. "application/json"
  4837. ],
  4838. "tags": [
  4839. "repository"
  4840. ],
  4841. "summary": "List a repository's collaborators",
  4842. "operationId": "repoListCollaborators",
  4843. "parameters": [
  4844. {
  4845. "type": "string",
  4846. "description": "owner of the repo",
  4847. "name": "owner",
  4848. "in": "path",
  4849. "required": true
  4850. },
  4851. {
  4852. "type": "string",
  4853. "description": "name of the repo",
  4854. "name": "repo",
  4855. "in": "path",
  4856. "required": true
  4857. },
  4858. {
  4859. "type": "integer",
  4860. "description": "page number of results to return (1-based)",
  4861. "name": "page",
  4862. "in": "query"
  4863. },
  4864. {
  4865. "type": "integer",
  4866. "description": "page size of results",
  4867. "name": "limit",
  4868. "in": "query"
  4869. }
  4870. ],
  4871. "responses": {
  4872. "200": {
  4873. "$ref": "#/responses/UserList"
  4874. },
  4875. "404": {
  4876. "$ref": "#/responses/notFound"
  4877. }
  4878. }
  4879. }
  4880. },
  4881. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  4882. "get": {
  4883. "produces": [
  4884. "application/json"
  4885. ],
  4886. "tags": [
  4887. "repository"
  4888. ],
  4889. "summary": "Check if a user is a collaborator of a repository",
  4890. "operationId": "repoCheckCollaborator",
  4891. "parameters": [
  4892. {
  4893. "type": "string",
  4894. "description": "owner of the repo",
  4895. "name": "owner",
  4896. "in": "path",
  4897. "required": true
  4898. },
  4899. {
  4900. "type": "string",
  4901. "description": "name of the repo",
  4902. "name": "repo",
  4903. "in": "path",
  4904. "required": true
  4905. },
  4906. {
  4907. "type": "string",
  4908. "description": "username of the collaborator",
  4909. "name": "collaborator",
  4910. "in": "path",
  4911. "required": true
  4912. }
  4913. ],
  4914. "responses": {
  4915. "204": {
  4916. "$ref": "#/responses/empty"
  4917. },
  4918. "404": {
  4919. "$ref": "#/responses/notFound"
  4920. },
  4921. "422": {
  4922. "$ref": "#/responses/validationError"
  4923. }
  4924. }
  4925. },
  4926. "put": {
  4927. "produces": [
  4928. "application/json"
  4929. ],
  4930. "tags": [
  4931. "repository"
  4932. ],
  4933. "summary": "Add a collaborator to a repository",
  4934. "operationId": "repoAddCollaborator",
  4935. "parameters": [
  4936. {
  4937. "type": "string",
  4938. "description": "owner of the repo",
  4939. "name": "owner",
  4940. "in": "path",
  4941. "required": true
  4942. },
  4943. {
  4944. "type": "string",
  4945. "description": "name of the repo",
  4946. "name": "repo",
  4947. "in": "path",
  4948. "required": true
  4949. },
  4950. {
  4951. "type": "string",
  4952. "description": "username of the collaborator to add",
  4953. "name": "collaborator",
  4954. "in": "path",
  4955. "required": true
  4956. },
  4957. {
  4958. "name": "body",
  4959. "in": "body",
  4960. "schema": {
  4961. "$ref": "#/definitions/AddCollaboratorOption"
  4962. }
  4963. }
  4964. ],
  4965. "responses": {
  4966. "204": {
  4967. "$ref": "#/responses/empty"
  4968. },
  4969. "403": {
  4970. "$ref": "#/responses/forbidden"
  4971. },
  4972. "404": {
  4973. "$ref": "#/responses/notFound"
  4974. },
  4975. "422": {
  4976. "$ref": "#/responses/validationError"
  4977. }
  4978. }
  4979. },
  4980. "delete": {
  4981. "produces": [
  4982. "application/json"
  4983. ],
  4984. "tags": [
  4985. "repository"
  4986. ],
  4987. "summary": "Delete a collaborator from a repository",
  4988. "operationId": "repoDeleteCollaborator",
  4989. "parameters": [
  4990. {
  4991. "type": "string",
  4992. "description": "owner of the repo",
  4993. "name": "owner",
  4994. "in": "path",
  4995. "required": true
  4996. },
  4997. {
  4998. "type": "string",
  4999. "description": "name of the repo",
  5000. "name": "repo",
  5001. "in": "path",
  5002. "required": true
  5003. },
  5004. {
  5005. "type": "string",
  5006. "description": "username of the collaborator to delete",
  5007. "name": "collaborator",
  5008. "in": "path",
  5009. "required": true
  5010. }
  5011. ],
  5012. "responses": {
  5013. "204": {
  5014. "$ref": "#/responses/empty"
  5015. },
  5016. "404": {
  5017. "$ref": "#/responses/notFound"
  5018. },
  5019. "422": {
  5020. "$ref": "#/responses/validationError"
  5021. }
  5022. }
  5023. }
  5024. },
  5025. "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
  5026. "get": {
  5027. "produces": [
  5028. "application/json"
  5029. ],
  5030. "tags": [
  5031. "repository"
  5032. ],
  5033. "summary": "Get repository permissions for a user",
  5034. "operationId": "repoGetRepoPermissions",
  5035. "parameters": [
  5036. {
  5037. "type": "string",
  5038. "description": "owner of the repo",
  5039. "name": "owner",
  5040. "in": "path",
  5041. "required": true
  5042. },
  5043. {
  5044. "type": "string",
  5045. "description": "name of the repo",
  5046. "name": "repo",
  5047. "in": "path",
  5048. "required": true
  5049. },
  5050. {
  5051. "type": "string",
  5052. "description": "username of the collaborator",
  5053. "name": "collaborator",
  5054. "in": "path",
  5055. "required": true
  5056. }
  5057. ],
  5058. "responses": {
  5059. "200": {
  5060. "$ref": "#/responses/RepoCollaboratorPermission"
  5061. },
  5062. "403": {
  5063. "$ref": "#/responses/forbidden"
  5064. },
  5065. "404": {
  5066. "$ref": "#/responses/notFound"
  5067. }
  5068. }
  5069. }
  5070. },
  5071. "/repos/{owner}/{repo}/commits": {
  5072. "get": {
  5073. "produces": [
  5074. "application/json"
  5075. ],
  5076. "tags": [
  5077. "repository"
  5078. ],
  5079. "summary": "Get a list of all commits from a repository",
  5080. "operationId": "repoGetAllCommits",
  5081. "parameters": [
  5082. {
  5083. "type": "string",
  5084. "description": "owner of the repo",
  5085. "name": "owner",
  5086. "in": "path",
  5087. "required": true
  5088. },
  5089. {
  5090. "type": "string",
  5091. "description": "name of the repo",
  5092. "name": "repo",
  5093. "in": "path",
  5094. "required": true
  5095. },
  5096. {
  5097. "type": "string",
  5098. "description": "SHA or branch to start listing commits from (usually 'master')",
  5099. "name": "sha",
  5100. "in": "query"
  5101. },
  5102. {
  5103. "type": "string",
  5104. "description": "filepath of a file/dir",
  5105. "name": "path",
  5106. "in": "query"
  5107. },
  5108. {
  5109. "type": "boolean",
  5110. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  5111. "name": "stat",
  5112. "in": "query"
  5113. },
  5114. {
  5115. "type": "boolean",
  5116. "description": "include verification for every commit (disable for speedup, default 'true')",
  5117. "name": "verification",
  5118. "in": "query"
  5119. },
  5120. {
  5121. "type": "boolean",
  5122. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5123. "name": "files",
  5124. "in": "query"
  5125. },
  5126. {
  5127. "type": "integer",
  5128. "description": "page number of results to return (1-based)",
  5129. "name": "page",
  5130. "in": "query"
  5131. },
  5132. {
  5133. "type": "integer",
  5134. "description": "page size of results (ignored if used with 'path')",
  5135. "name": "limit",
  5136. "in": "query"
  5137. },
  5138. {
  5139. "type": "string",
  5140. "description": "commits that match the given specifier will not be listed.",
  5141. "name": "not",
  5142. "in": "query"
  5143. }
  5144. ],
  5145. "responses": {
  5146. "200": {
  5147. "$ref": "#/responses/CommitList"
  5148. },
  5149. "404": {
  5150. "$ref": "#/responses/notFound"
  5151. },
  5152. "409": {
  5153. "$ref": "#/responses/EmptyRepository"
  5154. }
  5155. }
  5156. }
  5157. },
  5158. "/repos/{owner}/{repo}/commits/{ref}/status": {
  5159. "get": {
  5160. "produces": [
  5161. "application/json"
  5162. ],
  5163. "tags": [
  5164. "repository"
  5165. ],
  5166. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  5167. "operationId": "repoGetCombinedStatusByRef",
  5168. "parameters": [
  5169. {
  5170. "type": "string",
  5171. "description": "owner of the repo",
  5172. "name": "owner",
  5173. "in": "path",
  5174. "required": true
  5175. },
  5176. {
  5177. "type": "string",
  5178. "description": "name of the repo",
  5179. "name": "repo",
  5180. "in": "path",
  5181. "required": true
  5182. },
  5183. {
  5184. "type": "string",
  5185. "description": "name of branch/tag/commit",
  5186. "name": "ref",
  5187. "in": "path",
  5188. "required": true
  5189. },
  5190. {
  5191. "type": "integer",
  5192. "description": "page number of results to return (1-based)",
  5193. "name": "page",
  5194. "in": "query"
  5195. },
  5196. {
  5197. "type": "integer",
  5198. "description": "page size of results",
  5199. "name": "limit",
  5200. "in": "query"
  5201. }
  5202. ],
  5203. "responses": {
  5204. "200": {
  5205. "$ref": "#/responses/CombinedStatus"
  5206. },
  5207. "400": {
  5208. "$ref": "#/responses/error"
  5209. },
  5210. "404": {
  5211. "$ref": "#/responses/notFound"
  5212. }
  5213. }
  5214. }
  5215. },
  5216. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  5217. "get": {
  5218. "produces": [
  5219. "application/json"
  5220. ],
  5221. "tags": [
  5222. "repository"
  5223. ],
  5224. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  5225. "operationId": "repoListStatusesByRef",
  5226. "parameters": [
  5227. {
  5228. "type": "string",
  5229. "description": "owner of the repo",
  5230. "name": "owner",
  5231. "in": "path",
  5232. "required": true
  5233. },
  5234. {
  5235. "type": "string",
  5236. "description": "name of the repo",
  5237. "name": "repo",
  5238. "in": "path",
  5239. "required": true
  5240. },
  5241. {
  5242. "type": "string",
  5243. "description": "name of branch/tag/commit",
  5244. "name": "ref",
  5245. "in": "path",
  5246. "required": true
  5247. },
  5248. {
  5249. "enum": [
  5250. "oldest",
  5251. "recentupdate",
  5252. "leastupdate",
  5253. "leastindex",
  5254. "highestindex"
  5255. ],
  5256. "type": "string",
  5257. "description": "type of sort",
  5258. "name": "sort",
  5259. "in": "query"
  5260. },
  5261. {
  5262. "enum": [
  5263. "pending",
  5264. "success",
  5265. "error",
  5266. "failure",
  5267. "warning"
  5268. ],
  5269. "type": "string",
  5270. "description": "type of state",
  5271. "name": "state",
  5272. "in": "query"
  5273. },
  5274. {
  5275. "type": "integer",
  5276. "description": "page number of results to return (1-based)",
  5277. "name": "page",
  5278. "in": "query"
  5279. },
  5280. {
  5281. "type": "integer",
  5282. "description": "page size of results",
  5283. "name": "limit",
  5284. "in": "query"
  5285. }
  5286. ],
  5287. "responses": {
  5288. "200": {
  5289. "$ref": "#/responses/CommitStatusList"
  5290. },
  5291. "400": {
  5292. "$ref": "#/responses/error"
  5293. },
  5294. "404": {
  5295. "$ref": "#/responses/notFound"
  5296. }
  5297. }
  5298. }
  5299. },
  5300. "/repos/{owner}/{repo}/commits/{sha}/pull": {
  5301. "get": {
  5302. "produces": [
  5303. "application/json"
  5304. ],
  5305. "tags": [
  5306. "repository"
  5307. ],
  5308. "summary": "Get the pull request of the commit",
  5309. "operationId": "repoGetCommitPullRequest",
  5310. "parameters": [
  5311. {
  5312. "type": "string",
  5313. "description": "owner of the repo",
  5314. "name": "owner",
  5315. "in": "path",
  5316. "required": true
  5317. },
  5318. {
  5319. "type": "string",
  5320. "description": "name of the repo",
  5321. "name": "repo",
  5322. "in": "path",
  5323. "required": true
  5324. },
  5325. {
  5326. "type": "string",
  5327. "description": "SHA of the commit to get",
  5328. "name": "sha",
  5329. "in": "path",
  5330. "required": true
  5331. }
  5332. ],
  5333. "responses": {
  5334. "200": {
  5335. "$ref": "#/responses/PullRequest"
  5336. },
  5337. "404": {
  5338. "$ref": "#/responses/notFound"
  5339. }
  5340. }
  5341. }
  5342. },
  5343. "/repos/{owner}/{repo}/contents": {
  5344. "get": {
  5345. "produces": [
  5346. "application/json"
  5347. ],
  5348. "tags": [
  5349. "repository"
  5350. ],
  5351. "summary": "Gets the metadata of all the entries of the root dir",
  5352. "operationId": "repoGetContentsList",
  5353. "parameters": [
  5354. {
  5355. "type": "string",
  5356. "description": "owner of the repo",
  5357. "name": "owner",
  5358. "in": "path",
  5359. "required": true
  5360. },
  5361. {
  5362. "type": "string",
  5363. "description": "name of the repo",
  5364. "name": "repo",
  5365. "in": "path",
  5366. "required": true
  5367. },
  5368. {
  5369. "type": "string",
  5370. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  5371. "name": "ref",
  5372. "in": "query"
  5373. }
  5374. ],
  5375. "responses": {
  5376. "200": {
  5377. "$ref": "#/responses/ContentsListResponse"
  5378. },
  5379. "404": {
  5380. "$ref": "#/responses/notFound"
  5381. }
  5382. }
  5383. },
  5384. "post": {
  5385. "consumes": [
  5386. "application/json"
  5387. ],
  5388. "produces": [
  5389. "application/json"
  5390. ],
  5391. "tags": [
  5392. "repository"
  5393. ],
  5394. "summary": "Modify multiple files in a repository",
  5395. "operationId": "repoChangeFiles",
  5396. "parameters": [
  5397. {
  5398. "type": "string",
  5399. "description": "owner of the repo",
  5400. "name": "owner",
  5401. "in": "path",
  5402. "required": true
  5403. },
  5404. {
  5405. "type": "string",
  5406. "description": "name of the repo",
  5407. "name": "repo",
  5408. "in": "path",
  5409. "required": true
  5410. },
  5411. {
  5412. "name": "body",
  5413. "in": "body",
  5414. "required": true,
  5415. "schema": {
  5416. "$ref": "#/definitions/ChangeFilesOptions"
  5417. }
  5418. }
  5419. ],
  5420. "responses": {
  5421. "201": {
  5422. "$ref": "#/responses/FilesResponse"
  5423. },
  5424. "403": {
  5425. "$ref": "#/responses/error"
  5426. },
  5427. "404": {
  5428. "$ref": "#/responses/notFound"
  5429. },
  5430. "422": {
  5431. "$ref": "#/responses/error"
  5432. },
  5433. "423": {
  5434. "$ref": "#/responses/repoArchivedError"
  5435. }
  5436. }
  5437. }
  5438. },
  5439. "/repos/{owner}/{repo}/contents/{filepath}": {
  5440. "get": {
  5441. "produces": [
  5442. "application/json"
  5443. ],
  5444. "tags": [
  5445. "repository"
  5446. ],
  5447. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  5448. "operationId": "repoGetContents",
  5449. "parameters": [
  5450. {
  5451. "type": "string",
  5452. "description": "owner of the repo",
  5453. "name": "owner",
  5454. "in": "path",
  5455. "required": true
  5456. },
  5457. {
  5458. "type": "string",
  5459. "description": "name of the repo",
  5460. "name": "repo",
  5461. "in": "path",
  5462. "required": true
  5463. },
  5464. {
  5465. "type": "string",
  5466. "description": "path of the dir, file, symlink or submodule in the repo",
  5467. "name": "filepath",
  5468. "in": "path",
  5469. "required": true
  5470. },
  5471. {
  5472. "type": "string",
  5473. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  5474. "name": "ref",
  5475. "in": "query"
  5476. }
  5477. ],
  5478. "responses": {
  5479. "200": {
  5480. "$ref": "#/responses/ContentsResponse"
  5481. },
  5482. "404": {
  5483. "$ref": "#/responses/notFound"
  5484. }
  5485. }
  5486. },
  5487. "put": {
  5488. "consumes": [
  5489. "application/json"
  5490. ],
  5491. "produces": [
  5492. "application/json"
  5493. ],
  5494. "tags": [
  5495. "repository"
  5496. ],
  5497. "summary": "Update a file in a repository",
  5498. "operationId": "repoUpdateFile",
  5499. "parameters": [
  5500. {
  5501. "type": "string",
  5502. "description": "owner of the repo",
  5503. "name": "owner",
  5504. "in": "path",
  5505. "required": true
  5506. },
  5507. {
  5508. "type": "string",
  5509. "description": "name of the repo",
  5510. "name": "repo",
  5511. "in": "path",
  5512. "required": true
  5513. },
  5514. {
  5515. "type": "string",
  5516. "description": "path of the file to update",
  5517. "name": "filepath",
  5518. "in": "path",
  5519. "required": true
  5520. },
  5521. {
  5522. "name": "body",
  5523. "in": "body",
  5524. "required": true,
  5525. "schema": {
  5526. "$ref": "#/definitions/UpdateFileOptions"
  5527. }
  5528. }
  5529. ],
  5530. "responses": {
  5531. "200": {
  5532. "$ref": "#/responses/FileResponse"
  5533. },
  5534. "403": {
  5535. "$ref": "#/responses/error"
  5536. },
  5537. "404": {
  5538. "$ref": "#/responses/notFound"
  5539. },
  5540. "422": {
  5541. "$ref": "#/responses/error"
  5542. },
  5543. "423": {
  5544. "$ref": "#/responses/repoArchivedError"
  5545. }
  5546. }
  5547. },
  5548. "post": {
  5549. "consumes": [
  5550. "application/json"
  5551. ],
  5552. "produces": [
  5553. "application/json"
  5554. ],
  5555. "tags": [
  5556. "repository"
  5557. ],
  5558. "summary": "Create a file in a repository",
  5559. "operationId": "repoCreateFile",
  5560. "parameters": [
  5561. {
  5562. "type": "string",
  5563. "description": "owner of the repo",
  5564. "name": "owner",
  5565. "in": "path",
  5566. "required": true
  5567. },
  5568. {
  5569. "type": "string",
  5570. "description": "name of the repo",
  5571. "name": "repo",
  5572. "in": "path",
  5573. "required": true
  5574. },
  5575. {
  5576. "type": "string",
  5577. "description": "path of the file to create",
  5578. "name": "filepath",
  5579. "in": "path",
  5580. "required": true
  5581. },
  5582. {
  5583. "name": "body",
  5584. "in": "body",
  5585. "required": true,
  5586. "schema": {
  5587. "$ref": "#/definitions/CreateFileOptions"
  5588. }
  5589. }
  5590. ],
  5591. "responses": {
  5592. "201": {
  5593. "$ref": "#/responses/FileResponse"
  5594. },
  5595. "403": {
  5596. "$ref": "#/responses/error"
  5597. },
  5598. "404": {
  5599. "$ref": "#/responses/notFound"
  5600. },
  5601. "422": {
  5602. "$ref": "#/responses/error"
  5603. },
  5604. "423": {
  5605. "$ref": "#/responses/repoArchivedError"
  5606. }
  5607. }
  5608. },
  5609. "delete": {
  5610. "consumes": [
  5611. "application/json"
  5612. ],
  5613. "produces": [
  5614. "application/json"
  5615. ],
  5616. "tags": [
  5617. "repository"
  5618. ],
  5619. "summary": "Delete a file in a repository",
  5620. "operationId": "repoDeleteFile",
  5621. "parameters": [
  5622. {
  5623. "type": "string",
  5624. "description": "owner of the repo",
  5625. "name": "owner",
  5626. "in": "path",
  5627. "required": true
  5628. },
  5629. {
  5630. "type": "string",
  5631. "description": "name of the repo",
  5632. "name": "repo",
  5633. "in": "path",
  5634. "required": true
  5635. },
  5636. {
  5637. "type": "string",
  5638. "description": "path of the file to delete",
  5639. "name": "filepath",
  5640. "in": "path",
  5641. "required": true
  5642. },
  5643. {
  5644. "name": "body",
  5645. "in": "body",
  5646. "required": true,
  5647. "schema": {
  5648. "$ref": "#/definitions/DeleteFileOptions"
  5649. }
  5650. }
  5651. ],
  5652. "responses": {
  5653. "200": {
  5654. "$ref": "#/responses/FileDeleteResponse"
  5655. },
  5656. "400": {
  5657. "$ref": "#/responses/error"
  5658. },
  5659. "403": {
  5660. "$ref": "#/responses/error"
  5661. },
  5662. "404": {
  5663. "$ref": "#/responses/error"
  5664. },
  5665. "423": {
  5666. "$ref": "#/responses/repoArchivedError"
  5667. }
  5668. }
  5669. }
  5670. },
  5671. "/repos/{owner}/{repo}/diffpatch": {
  5672. "post": {
  5673. "consumes": [
  5674. "application/json"
  5675. ],
  5676. "produces": [
  5677. "application/json"
  5678. ],
  5679. "tags": [
  5680. "repository"
  5681. ],
  5682. "summary": "Apply diff patch to repository",
  5683. "operationId": "repoApplyDiffPatch",
  5684. "parameters": [
  5685. {
  5686. "type": "string",
  5687. "description": "owner of the repo",
  5688. "name": "owner",
  5689. "in": "path",
  5690. "required": true
  5691. },
  5692. {
  5693. "type": "string",
  5694. "description": "name of the repo",
  5695. "name": "repo",
  5696. "in": "path",
  5697. "required": true
  5698. },
  5699. {
  5700. "name": "body",
  5701. "in": "body",
  5702. "required": true,
  5703. "schema": {
  5704. "$ref": "#/definitions/UpdateFileOptions"
  5705. }
  5706. }
  5707. ],
  5708. "responses": {
  5709. "200": {
  5710. "$ref": "#/responses/FileResponse"
  5711. },
  5712. "404": {
  5713. "$ref": "#/responses/notFound"
  5714. },
  5715. "423": {
  5716. "$ref": "#/responses/repoArchivedError"
  5717. }
  5718. }
  5719. }
  5720. },
  5721. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  5722. "get": {
  5723. "produces": [
  5724. "application/json"
  5725. ],
  5726. "tags": [
  5727. "repository"
  5728. ],
  5729. "summary": "Get the EditorConfig definitions of a file in a repository",
  5730. "operationId": "repoGetEditorConfig",
  5731. "parameters": [
  5732. {
  5733. "type": "string",
  5734. "description": "owner of the repo",
  5735. "name": "owner",
  5736. "in": "path",
  5737. "required": true
  5738. },
  5739. {
  5740. "type": "string",
  5741. "description": "name of the repo",
  5742. "name": "repo",
  5743. "in": "path",
  5744. "required": true
  5745. },
  5746. {
  5747. "type": "string",
  5748. "description": "filepath of file to get",
  5749. "name": "filepath",
  5750. "in": "path",
  5751. "required": true
  5752. },
  5753. {
  5754. "type": "string",
  5755. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  5756. "name": "ref",
  5757. "in": "query"
  5758. }
  5759. ],
  5760. "responses": {
  5761. "200": {
  5762. "description": "success"
  5763. },
  5764. "404": {
  5765. "$ref": "#/responses/notFound"
  5766. }
  5767. }
  5768. }
  5769. },
  5770. "/repos/{owner}/{repo}/forks": {
  5771. "get": {
  5772. "produces": [
  5773. "application/json"
  5774. ],
  5775. "tags": [
  5776. "repository"
  5777. ],
  5778. "summary": "List a repository's forks",
  5779. "operationId": "listForks",
  5780. "parameters": [
  5781. {
  5782. "type": "string",
  5783. "description": "owner of the repo",
  5784. "name": "owner",
  5785. "in": "path",
  5786. "required": true
  5787. },
  5788. {
  5789. "type": "string",
  5790. "description": "name of the repo",
  5791. "name": "repo",
  5792. "in": "path",
  5793. "required": true
  5794. },
  5795. {
  5796. "type": "integer",
  5797. "description": "page number of results to return (1-based)",
  5798. "name": "page",
  5799. "in": "query"
  5800. },
  5801. {
  5802. "type": "integer",
  5803. "description": "page size of results",
  5804. "name": "limit",
  5805. "in": "query"
  5806. }
  5807. ],
  5808. "responses": {
  5809. "200": {
  5810. "$ref": "#/responses/RepositoryList"
  5811. },
  5812. "404": {
  5813. "$ref": "#/responses/notFound"
  5814. }
  5815. }
  5816. },
  5817. "post": {
  5818. "produces": [
  5819. "application/json"
  5820. ],
  5821. "tags": [
  5822. "repository"
  5823. ],
  5824. "summary": "Fork a repository",
  5825. "operationId": "createFork",
  5826. "parameters": [
  5827. {
  5828. "type": "string",
  5829. "description": "owner of the repo to fork",
  5830. "name": "owner",
  5831. "in": "path",
  5832. "required": true
  5833. },
  5834. {
  5835. "type": "string",
  5836. "description": "name of the repo to fork",
  5837. "name": "repo",
  5838. "in": "path",
  5839. "required": true
  5840. },
  5841. {
  5842. "name": "body",
  5843. "in": "body",
  5844. "schema": {
  5845. "$ref": "#/definitions/CreateForkOption"
  5846. }
  5847. }
  5848. ],
  5849. "responses": {
  5850. "202": {
  5851. "$ref": "#/responses/Repository"
  5852. },
  5853. "403": {
  5854. "$ref": "#/responses/forbidden"
  5855. },
  5856. "404": {
  5857. "$ref": "#/responses/notFound"
  5858. },
  5859. "409": {
  5860. "description": "The repository with the same name already exists."
  5861. },
  5862. "422": {
  5863. "$ref": "#/responses/validationError"
  5864. }
  5865. }
  5866. }
  5867. },
  5868. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  5869. "get": {
  5870. "produces": [
  5871. "application/json"
  5872. ],
  5873. "tags": [
  5874. "repository"
  5875. ],
  5876. "summary": "Gets the blob of a repository.",
  5877. "operationId": "GetBlob",
  5878. "parameters": [
  5879. {
  5880. "type": "string",
  5881. "description": "owner of the repo",
  5882. "name": "owner",
  5883. "in": "path",
  5884. "required": true
  5885. },
  5886. {
  5887. "type": "string",
  5888. "description": "name of the repo",
  5889. "name": "repo",
  5890. "in": "path",
  5891. "required": true
  5892. },
  5893. {
  5894. "type": "string",
  5895. "description": "sha of the commit",
  5896. "name": "sha",
  5897. "in": "path",
  5898. "required": true
  5899. }
  5900. ],
  5901. "responses": {
  5902. "200": {
  5903. "$ref": "#/responses/GitBlobResponse"
  5904. },
  5905. "400": {
  5906. "$ref": "#/responses/error"
  5907. },
  5908. "404": {
  5909. "$ref": "#/responses/notFound"
  5910. }
  5911. }
  5912. }
  5913. },
  5914. "/repos/{owner}/{repo}/git/commits/{sha}": {
  5915. "get": {
  5916. "produces": [
  5917. "application/json"
  5918. ],
  5919. "tags": [
  5920. "repository"
  5921. ],
  5922. "summary": "Get a single commit from a repository",
  5923. "operationId": "repoGetSingleCommit",
  5924. "parameters": [
  5925. {
  5926. "type": "string",
  5927. "description": "owner of the repo",
  5928. "name": "owner",
  5929. "in": "path",
  5930. "required": true
  5931. },
  5932. {
  5933. "type": "string",
  5934. "description": "name of the repo",
  5935. "name": "repo",
  5936. "in": "path",
  5937. "required": true
  5938. },
  5939. {
  5940. "type": "string",
  5941. "description": "a git ref or commit sha",
  5942. "name": "sha",
  5943. "in": "path",
  5944. "required": true
  5945. },
  5946. {
  5947. "type": "boolean",
  5948. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  5949. "name": "stat",
  5950. "in": "query"
  5951. },
  5952. {
  5953. "type": "boolean",
  5954. "description": "include verification for every commit (disable for speedup, default 'true')",
  5955. "name": "verification",
  5956. "in": "query"
  5957. },
  5958. {
  5959. "type": "boolean",
  5960. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5961. "name": "files",
  5962. "in": "query"
  5963. }
  5964. ],
  5965. "responses": {
  5966. "200": {
  5967. "$ref": "#/responses/Commit"
  5968. },
  5969. "404": {
  5970. "$ref": "#/responses/notFound"
  5971. },
  5972. "422": {
  5973. "$ref": "#/responses/validationError"
  5974. }
  5975. }
  5976. }
  5977. },
  5978. "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
  5979. "get": {
  5980. "produces": [
  5981. "text/plain"
  5982. ],
  5983. "tags": [
  5984. "repository"
  5985. ],
  5986. "summary": "Get a commit's diff or patch",
  5987. "operationId": "repoDownloadCommitDiffOrPatch",
  5988. "parameters": [
  5989. {
  5990. "type": "string",
  5991. "description": "owner of the repo",
  5992. "name": "owner",
  5993. "in": "path",
  5994. "required": true
  5995. },
  5996. {
  5997. "type": "string",
  5998. "description": "name of the repo",
  5999. "name": "repo",
  6000. "in": "path",
  6001. "required": true
  6002. },
  6003. {
  6004. "type": "string",
  6005. "description": "SHA of the commit to get",
  6006. "name": "sha",
  6007. "in": "path",
  6008. "required": true
  6009. },
  6010. {
  6011. "enum": [
  6012. "diff",
  6013. "patch"
  6014. ],
  6015. "type": "string",
  6016. "description": "whether the output is diff or patch",
  6017. "name": "diffType",
  6018. "in": "path",
  6019. "required": true
  6020. }
  6021. ],
  6022. "responses": {
  6023. "200": {
  6024. "$ref": "#/responses/string"
  6025. },
  6026. "404": {
  6027. "$ref": "#/responses/notFound"
  6028. }
  6029. }
  6030. }
  6031. },
  6032. "/repos/{owner}/{repo}/git/notes/{sha}": {
  6033. "get": {
  6034. "produces": [
  6035. "application/json"
  6036. ],
  6037. "tags": [
  6038. "repository"
  6039. ],
  6040. "summary": "Get a note corresponding to a single commit from a repository",
  6041. "operationId": "repoGetNote",
  6042. "parameters": [
  6043. {
  6044. "type": "string",
  6045. "description": "owner of the repo",
  6046. "name": "owner",
  6047. "in": "path",
  6048. "required": true
  6049. },
  6050. {
  6051. "type": "string",
  6052. "description": "name of the repo",
  6053. "name": "repo",
  6054. "in": "path",
  6055. "required": true
  6056. },
  6057. {
  6058. "type": "string",
  6059. "description": "a git ref or commit sha",
  6060. "name": "sha",
  6061. "in": "path",
  6062. "required": true
  6063. },
  6064. {
  6065. "type": "boolean",
  6066. "description": "include verification for every commit (disable for speedup, default 'true')",
  6067. "name": "verification",
  6068. "in": "query"
  6069. },
  6070. {
  6071. "type": "boolean",
  6072. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  6073. "name": "files",
  6074. "in": "query"
  6075. }
  6076. ],
  6077. "responses": {
  6078. "200": {
  6079. "$ref": "#/responses/Note"
  6080. },
  6081. "404": {
  6082. "$ref": "#/responses/notFound"
  6083. },
  6084. "422": {
  6085. "$ref": "#/responses/validationError"
  6086. }
  6087. }
  6088. }
  6089. },
  6090. "/repos/{owner}/{repo}/git/refs": {
  6091. "get": {
  6092. "produces": [
  6093. "application/json"
  6094. ],
  6095. "tags": [
  6096. "repository"
  6097. ],
  6098. "summary": "Get specified ref or filtered repository's refs",
  6099. "operationId": "repoListAllGitRefs",
  6100. "parameters": [
  6101. {
  6102. "type": "string",
  6103. "description": "owner of the repo",
  6104. "name": "owner",
  6105. "in": "path",
  6106. "required": true
  6107. },
  6108. {
  6109. "type": "string",
  6110. "description": "name of the repo",
  6111. "name": "repo",
  6112. "in": "path",
  6113. "required": true
  6114. }
  6115. ],
  6116. "responses": {
  6117. "200": {
  6118. "$ref": "#/responses/ReferenceList"
  6119. },
  6120. "404": {
  6121. "$ref": "#/responses/notFound"
  6122. }
  6123. }
  6124. }
  6125. },
  6126. "/repos/{owner}/{repo}/git/refs/{ref}": {
  6127. "get": {
  6128. "produces": [
  6129. "application/json"
  6130. ],
  6131. "tags": [
  6132. "repository"
  6133. ],
  6134. "summary": "Get specified ref or filtered repository's refs",
  6135. "operationId": "repoListGitRefs",
  6136. "parameters": [
  6137. {
  6138. "type": "string",
  6139. "description": "owner of the repo",
  6140. "name": "owner",
  6141. "in": "path",
  6142. "required": true
  6143. },
  6144. {
  6145. "type": "string",
  6146. "description": "name of the repo",
  6147. "name": "repo",
  6148. "in": "path",
  6149. "required": true
  6150. },
  6151. {
  6152. "type": "string",
  6153. "description": "part or full name of the ref",
  6154. "name": "ref",
  6155. "in": "path",
  6156. "required": true
  6157. }
  6158. ],
  6159. "responses": {
  6160. "200": {
  6161. "$ref": "#/responses/ReferenceList"
  6162. },
  6163. "404": {
  6164. "$ref": "#/responses/notFound"
  6165. }
  6166. }
  6167. }
  6168. },
  6169. "/repos/{owner}/{repo}/git/tags/{sha}": {
  6170. "get": {
  6171. "produces": [
  6172. "application/json"
  6173. ],
  6174. "tags": [
  6175. "repository"
  6176. ],
  6177. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  6178. "operationId": "GetAnnotatedTag",
  6179. "parameters": [
  6180. {
  6181. "type": "string",
  6182. "description": "owner of the repo",
  6183. "name": "owner",
  6184. "in": "path",
  6185. "required": true
  6186. },
  6187. {
  6188. "type": "string",
  6189. "description": "name of the repo",
  6190. "name": "repo",
  6191. "in": "path",
  6192. "required": true
  6193. },
  6194. {
  6195. "type": "string",
  6196. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  6197. "name": "sha",
  6198. "in": "path",
  6199. "required": true
  6200. }
  6201. ],
  6202. "responses": {
  6203. "200": {
  6204. "$ref": "#/responses/AnnotatedTag"
  6205. },
  6206. "400": {
  6207. "$ref": "#/responses/error"
  6208. },
  6209. "404": {
  6210. "$ref": "#/responses/notFound"
  6211. }
  6212. }
  6213. }
  6214. },
  6215. "/repos/{owner}/{repo}/git/trees/{sha}": {
  6216. "get": {
  6217. "produces": [
  6218. "application/json"
  6219. ],
  6220. "tags": [
  6221. "repository"
  6222. ],
  6223. "summary": "Gets the tree of a repository.",
  6224. "operationId": "GetTree",
  6225. "parameters": [
  6226. {
  6227. "type": "string",
  6228. "description": "owner of the repo",
  6229. "name": "owner",
  6230. "in": "path",
  6231. "required": true
  6232. },
  6233. {
  6234. "type": "string",
  6235. "description": "name of the repo",
  6236. "name": "repo",
  6237. "in": "path",
  6238. "required": true
  6239. },
  6240. {
  6241. "type": "string",
  6242. "description": "sha of the commit",
  6243. "name": "sha",
  6244. "in": "path",
  6245. "required": true
  6246. },
  6247. {
  6248. "type": "boolean",
  6249. "description": "show all directories and files",
  6250. "name": "recursive",
  6251. "in": "query"
  6252. },
  6253. {
  6254. "type": "integer",
  6255. "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",
  6256. "name": "page",
  6257. "in": "query"
  6258. },
  6259. {
  6260. "type": "integer",
  6261. "description": "number of items per page",
  6262. "name": "per_page",
  6263. "in": "query"
  6264. }
  6265. ],
  6266. "responses": {
  6267. "200": {
  6268. "$ref": "#/responses/GitTreeResponse"
  6269. },
  6270. "400": {
  6271. "$ref": "#/responses/error"
  6272. },
  6273. "404": {
  6274. "$ref": "#/responses/notFound"
  6275. }
  6276. }
  6277. }
  6278. },
  6279. "/repos/{owner}/{repo}/hooks": {
  6280. "get": {
  6281. "produces": [
  6282. "application/json"
  6283. ],
  6284. "tags": [
  6285. "repository"
  6286. ],
  6287. "summary": "List the hooks in a repository",
  6288. "operationId": "repoListHooks",
  6289. "parameters": [
  6290. {
  6291. "type": "string",
  6292. "description": "owner of the repo",
  6293. "name": "owner",
  6294. "in": "path",
  6295. "required": true
  6296. },
  6297. {
  6298. "type": "string",
  6299. "description": "name of the repo",
  6300. "name": "repo",
  6301. "in": "path",
  6302. "required": true
  6303. },
  6304. {
  6305. "type": "integer",
  6306. "description": "page number of results to return (1-based)",
  6307. "name": "page",
  6308. "in": "query"
  6309. },
  6310. {
  6311. "type": "integer",
  6312. "description": "page size of results",
  6313. "name": "limit",
  6314. "in": "query"
  6315. }
  6316. ],
  6317. "responses": {
  6318. "200": {
  6319. "$ref": "#/responses/HookList"
  6320. },
  6321. "404": {
  6322. "$ref": "#/responses/notFound"
  6323. }
  6324. }
  6325. },
  6326. "post": {
  6327. "consumes": [
  6328. "application/json"
  6329. ],
  6330. "produces": [
  6331. "application/json"
  6332. ],
  6333. "tags": [
  6334. "repository"
  6335. ],
  6336. "summary": "Create a hook",
  6337. "operationId": "repoCreateHook",
  6338. "parameters": [
  6339. {
  6340. "type": "string",
  6341. "description": "owner of the repo",
  6342. "name": "owner",
  6343. "in": "path",
  6344. "required": true
  6345. },
  6346. {
  6347. "type": "string",
  6348. "description": "name of the repo",
  6349. "name": "repo",
  6350. "in": "path",
  6351. "required": true
  6352. },
  6353. {
  6354. "name": "body",
  6355. "in": "body",
  6356. "schema": {
  6357. "$ref": "#/definitions/CreateHookOption"
  6358. }
  6359. }
  6360. ],
  6361. "responses": {
  6362. "201": {
  6363. "$ref": "#/responses/Hook"
  6364. },
  6365. "404": {
  6366. "$ref": "#/responses/notFound"
  6367. }
  6368. }
  6369. }
  6370. },
  6371. "/repos/{owner}/{repo}/hooks/git": {
  6372. "get": {
  6373. "produces": [
  6374. "application/json"
  6375. ],
  6376. "tags": [
  6377. "repository"
  6378. ],
  6379. "summary": "List the Git hooks in a repository",
  6380. "operationId": "repoListGitHooks",
  6381. "parameters": [
  6382. {
  6383. "type": "string",
  6384. "description": "owner of the repo",
  6385. "name": "owner",
  6386. "in": "path",
  6387. "required": true
  6388. },
  6389. {
  6390. "type": "string",
  6391. "description": "name of the repo",
  6392. "name": "repo",
  6393. "in": "path",
  6394. "required": true
  6395. }
  6396. ],
  6397. "responses": {
  6398. "200": {
  6399. "$ref": "#/responses/GitHookList"
  6400. },
  6401. "404": {
  6402. "$ref": "#/responses/notFound"
  6403. }
  6404. }
  6405. }
  6406. },
  6407. "/repos/{owner}/{repo}/hooks/git/{id}": {
  6408. "get": {
  6409. "produces": [
  6410. "application/json"
  6411. ],
  6412. "tags": [
  6413. "repository"
  6414. ],
  6415. "summary": "Get a Git hook",
  6416. "operationId": "repoGetGitHook",
  6417. "parameters": [
  6418. {
  6419. "type": "string",
  6420. "description": "owner of the repo",
  6421. "name": "owner",
  6422. "in": "path",
  6423. "required": true
  6424. },
  6425. {
  6426. "type": "string",
  6427. "description": "name of the repo",
  6428. "name": "repo",
  6429. "in": "path",
  6430. "required": true
  6431. },
  6432. {
  6433. "type": "string",
  6434. "description": "id of the hook to get",
  6435. "name": "id",
  6436. "in": "path",
  6437. "required": true
  6438. }
  6439. ],
  6440. "responses": {
  6441. "200": {
  6442. "$ref": "#/responses/GitHook"
  6443. },
  6444. "404": {
  6445. "$ref": "#/responses/notFound"
  6446. }
  6447. }
  6448. },
  6449. "delete": {
  6450. "produces": [
  6451. "application/json"
  6452. ],
  6453. "tags": [
  6454. "repository"
  6455. ],
  6456. "summary": "Delete a Git hook in a repository",
  6457. "operationId": "repoDeleteGitHook",
  6458. "parameters": [
  6459. {
  6460. "type": "string",
  6461. "description": "owner of the repo",
  6462. "name": "owner",
  6463. "in": "path",
  6464. "required": true
  6465. },
  6466. {
  6467. "type": "string",
  6468. "description": "name of the repo",
  6469. "name": "repo",
  6470. "in": "path",
  6471. "required": true
  6472. },
  6473. {
  6474. "type": "string",
  6475. "description": "id of the hook to get",
  6476. "name": "id",
  6477. "in": "path",
  6478. "required": true
  6479. }
  6480. ],
  6481. "responses": {
  6482. "204": {
  6483. "$ref": "#/responses/empty"
  6484. },
  6485. "404": {
  6486. "$ref": "#/responses/notFound"
  6487. }
  6488. }
  6489. },
  6490. "patch": {
  6491. "produces": [
  6492. "application/json"
  6493. ],
  6494. "tags": [
  6495. "repository"
  6496. ],
  6497. "summary": "Edit a Git hook in a repository",
  6498. "operationId": "repoEditGitHook",
  6499. "parameters": [
  6500. {
  6501. "type": "string",
  6502. "description": "owner of the repo",
  6503. "name": "owner",
  6504. "in": "path",
  6505. "required": true
  6506. },
  6507. {
  6508. "type": "string",
  6509. "description": "name of the repo",
  6510. "name": "repo",
  6511. "in": "path",
  6512. "required": true
  6513. },
  6514. {
  6515. "type": "string",
  6516. "description": "id of the hook to get",
  6517. "name": "id",
  6518. "in": "path",
  6519. "required": true
  6520. },
  6521. {
  6522. "name": "body",
  6523. "in": "body",
  6524. "schema": {
  6525. "$ref": "#/definitions/EditGitHookOption"
  6526. }
  6527. }
  6528. ],
  6529. "responses": {
  6530. "200": {
  6531. "$ref": "#/responses/GitHook"
  6532. },
  6533. "404": {
  6534. "$ref": "#/responses/notFound"
  6535. }
  6536. }
  6537. }
  6538. },
  6539. "/repos/{owner}/{repo}/hooks/{id}": {
  6540. "get": {
  6541. "produces": [
  6542. "application/json"
  6543. ],
  6544. "tags": [
  6545. "repository"
  6546. ],
  6547. "summary": "Get a hook",
  6548. "operationId": "repoGetHook",
  6549. "parameters": [
  6550. {
  6551. "type": "string",
  6552. "description": "owner of the repo",
  6553. "name": "owner",
  6554. "in": "path",
  6555. "required": true
  6556. },
  6557. {
  6558. "type": "string",
  6559. "description": "name of the repo",
  6560. "name": "repo",
  6561. "in": "path",
  6562. "required": true
  6563. },
  6564. {
  6565. "type": "integer",
  6566. "format": "int64",
  6567. "description": "id of the hook to get",
  6568. "name": "id",
  6569. "in": "path",
  6570. "required": true
  6571. }
  6572. ],
  6573. "responses": {
  6574. "200": {
  6575. "$ref": "#/responses/Hook"
  6576. },
  6577. "404": {
  6578. "$ref": "#/responses/notFound"
  6579. }
  6580. }
  6581. },
  6582. "delete": {
  6583. "produces": [
  6584. "application/json"
  6585. ],
  6586. "tags": [
  6587. "repository"
  6588. ],
  6589. "summary": "Delete a hook in a repository",
  6590. "operationId": "repoDeleteHook",
  6591. "parameters": [
  6592. {
  6593. "type": "string",
  6594. "description": "owner of the repo",
  6595. "name": "owner",
  6596. "in": "path",
  6597. "required": true
  6598. },
  6599. {
  6600. "type": "string",
  6601. "description": "name of the repo",
  6602. "name": "repo",
  6603. "in": "path",
  6604. "required": true
  6605. },
  6606. {
  6607. "type": "integer",
  6608. "format": "int64",
  6609. "description": "id of the hook to delete",
  6610. "name": "id",
  6611. "in": "path",
  6612. "required": true
  6613. }
  6614. ],
  6615. "responses": {
  6616. "204": {
  6617. "$ref": "#/responses/empty"
  6618. },
  6619. "404": {
  6620. "$ref": "#/responses/notFound"
  6621. }
  6622. }
  6623. },
  6624. "patch": {
  6625. "produces": [
  6626. "application/json"
  6627. ],
  6628. "tags": [
  6629. "repository"
  6630. ],
  6631. "summary": "Edit a hook in a repository",
  6632. "operationId": "repoEditHook",
  6633. "parameters": [
  6634. {
  6635. "type": "string",
  6636. "description": "owner of the repo",
  6637. "name": "owner",
  6638. "in": "path",
  6639. "required": true
  6640. },
  6641. {
  6642. "type": "string",
  6643. "description": "name of the repo",
  6644. "name": "repo",
  6645. "in": "path",
  6646. "required": true
  6647. },
  6648. {
  6649. "type": "integer",
  6650. "format": "int64",
  6651. "description": "index of the hook",
  6652. "name": "id",
  6653. "in": "path",
  6654. "required": true
  6655. },
  6656. {
  6657. "name": "body",
  6658. "in": "body",
  6659. "schema": {
  6660. "$ref": "#/definitions/EditHookOption"
  6661. }
  6662. }
  6663. ],
  6664. "responses": {
  6665. "200": {
  6666. "$ref": "#/responses/Hook"
  6667. },
  6668. "404": {
  6669. "$ref": "#/responses/notFound"
  6670. }
  6671. }
  6672. }
  6673. },
  6674. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  6675. "post": {
  6676. "produces": [
  6677. "application/json"
  6678. ],
  6679. "tags": [
  6680. "repository"
  6681. ],
  6682. "summary": "Test a push webhook",
  6683. "operationId": "repoTestHook",
  6684. "parameters": [
  6685. {
  6686. "type": "string",
  6687. "description": "owner of the repo",
  6688. "name": "owner",
  6689. "in": "path",
  6690. "required": true
  6691. },
  6692. {
  6693. "type": "string",
  6694. "description": "name of the repo",
  6695. "name": "repo",
  6696. "in": "path",
  6697. "required": true
  6698. },
  6699. {
  6700. "type": "integer",
  6701. "format": "int64",
  6702. "description": "id of the hook to test",
  6703. "name": "id",
  6704. "in": "path",
  6705. "required": true
  6706. },
  6707. {
  6708. "type": "string",
  6709. "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
  6710. "name": "ref",
  6711. "in": "query"
  6712. }
  6713. ],
  6714. "responses": {
  6715. "204": {
  6716. "$ref": "#/responses/empty"
  6717. },
  6718. "404": {
  6719. "$ref": "#/responses/notFound"
  6720. }
  6721. }
  6722. }
  6723. },
  6724. "/repos/{owner}/{repo}/issue_config": {
  6725. "get": {
  6726. "produces": [
  6727. "application/json"
  6728. ],
  6729. "tags": [
  6730. "repository"
  6731. ],
  6732. "summary": "Returns the issue config for a repo",
  6733. "operationId": "repoGetIssueConfig",
  6734. "parameters": [
  6735. {
  6736. "type": "string",
  6737. "description": "owner of the repo",
  6738. "name": "owner",
  6739. "in": "path",
  6740. "required": true
  6741. },
  6742. {
  6743. "type": "string",
  6744. "description": "name of the repo",
  6745. "name": "repo",
  6746. "in": "path",
  6747. "required": true
  6748. }
  6749. ],
  6750. "responses": {
  6751. "200": {
  6752. "$ref": "#/responses/RepoIssueConfig"
  6753. },
  6754. "404": {
  6755. "$ref": "#/responses/notFound"
  6756. }
  6757. }
  6758. }
  6759. },
  6760. "/repos/{owner}/{repo}/issue_config/validate": {
  6761. "get": {
  6762. "produces": [
  6763. "application/json"
  6764. ],
  6765. "tags": [
  6766. "repository"
  6767. ],
  6768. "summary": "Returns the validation information for a issue config",
  6769. "operationId": "repoValidateIssueConfig",
  6770. "parameters": [
  6771. {
  6772. "type": "string",
  6773. "description": "owner of the repo",
  6774. "name": "owner",
  6775. "in": "path",
  6776. "required": true
  6777. },
  6778. {
  6779. "type": "string",
  6780. "description": "name of the repo",
  6781. "name": "repo",
  6782. "in": "path",
  6783. "required": true
  6784. }
  6785. ],
  6786. "responses": {
  6787. "200": {
  6788. "$ref": "#/responses/RepoIssueConfigValidation"
  6789. },
  6790. "404": {
  6791. "$ref": "#/responses/notFound"
  6792. }
  6793. }
  6794. }
  6795. },
  6796. "/repos/{owner}/{repo}/issue_templates": {
  6797. "get": {
  6798. "produces": [
  6799. "application/json"
  6800. ],
  6801. "tags": [
  6802. "repository"
  6803. ],
  6804. "summary": "Get available issue templates for a repository",
  6805. "operationId": "repoGetIssueTemplates",
  6806. "parameters": [
  6807. {
  6808. "type": "string",
  6809. "description": "owner of the repo",
  6810. "name": "owner",
  6811. "in": "path",
  6812. "required": true
  6813. },
  6814. {
  6815. "type": "string",
  6816. "description": "name of the repo",
  6817. "name": "repo",
  6818. "in": "path",
  6819. "required": true
  6820. }
  6821. ],
  6822. "responses": {
  6823. "200": {
  6824. "$ref": "#/responses/IssueTemplates"
  6825. },
  6826. "404": {
  6827. "$ref": "#/responses/notFound"
  6828. }
  6829. }
  6830. }
  6831. },
  6832. "/repos/{owner}/{repo}/issues": {
  6833. "get": {
  6834. "produces": [
  6835. "application/json"
  6836. ],
  6837. "tags": [
  6838. "issue"
  6839. ],
  6840. "summary": "List a repository's issues",
  6841. "operationId": "issueListIssues",
  6842. "parameters": [
  6843. {
  6844. "type": "string",
  6845. "description": "owner of the repo",
  6846. "name": "owner",
  6847. "in": "path",
  6848. "required": true
  6849. },
  6850. {
  6851. "type": "string",
  6852. "description": "name of the repo",
  6853. "name": "repo",
  6854. "in": "path",
  6855. "required": true
  6856. },
  6857. {
  6858. "enum": [
  6859. "closed",
  6860. "open",
  6861. "all"
  6862. ],
  6863. "type": "string",
  6864. "description": "whether issue is open or closed",
  6865. "name": "state",
  6866. "in": "query"
  6867. },
  6868. {
  6869. "type": "string",
  6870. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  6871. "name": "labels",
  6872. "in": "query"
  6873. },
  6874. {
  6875. "type": "string",
  6876. "description": "search string",
  6877. "name": "q",
  6878. "in": "query"
  6879. },
  6880. {
  6881. "enum": [
  6882. "issues",
  6883. "pulls"
  6884. ],
  6885. "type": "string",
  6886. "description": "filter by type (issues / pulls) if set",
  6887. "name": "type",
  6888. "in": "query"
  6889. },
  6890. {
  6891. "type": "string",
  6892. "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",
  6893. "name": "milestones",
  6894. "in": "query"
  6895. },
  6896. {
  6897. "type": "string",
  6898. "format": "date-time",
  6899. "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
  6900. "name": "since",
  6901. "in": "query"
  6902. },
  6903. {
  6904. "type": "string",
  6905. "format": "date-time",
  6906. "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
  6907. "name": "before",
  6908. "in": "query"
  6909. },
  6910. {
  6911. "type": "string",
  6912. "description": "Only show items which were created by the given user",
  6913. "name": "created_by",
  6914. "in": "query"
  6915. },
  6916. {
  6917. "type": "string",
  6918. "description": "Only show items for which the given user is assigned",
  6919. "name": "assigned_by",
  6920. "in": "query"
  6921. },
  6922. {
  6923. "type": "string",
  6924. "description": "Only show items in which the given user was mentioned",
  6925. "name": "mentioned_by",
  6926. "in": "query"
  6927. },
  6928. {
  6929. "type": "integer",
  6930. "description": "page number of results to return (1-based)",
  6931. "name": "page",
  6932. "in": "query"
  6933. },
  6934. {
  6935. "type": "integer",
  6936. "description": "page size of results",
  6937. "name": "limit",
  6938. "in": "query"
  6939. }
  6940. ],
  6941. "responses": {
  6942. "200": {
  6943. "$ref": "#/responses/IssueList"
  6944. },
  6945. "404": {
  6946. "$ref": "#/responses/notFound"
  6947. }
  6948. }
  6949. },
  6950. "post": {
  6951. "consumes": [
  6952. "application/json"
  6953. ],
  6954. "produces": [
  6955. "application/json"
  6956. ],
  6957. "tags": [
  6958. "issue"
  6959. ],
  6960. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6961. "operationId": "issueCreateIssue",
  6962. "parameters": [
  6963. {
  6964. "type": "string",
  6965. "description": "owner of the repo",
  6966. "name": "owner",
  6967. "in": "path",
  6968. "required": true
  6969. },
  6970. {
  6971. "type": "string",
  6972. "description": "name of the repo",
  6973. "name": "repo",
  6974. "in": "path",
  6975. "required": true
  6976. },
  6977. {
  6978. "name": "body",
  6979. "in": "body",
  6980. "schema": {
  6981. "$ref": "#/definitions/CreateIssueOption"
  6982. }
  6983. }
  6984. ],
  6985. "responses": {
  6986. "201": {
  6987. "$ref": "#/responses/Issue"
  6988. },
  6989. "403": {
  6990. "$ref": "#/responses/forbidden"
  6991. },
  6992. "404": {
  6993. "$ref": "#/responses/notFound"
  6994. },
  6995. "412": {
  6996. "$ref": "#/responses/error"
  6997. },
  6998. "422": {
  6999. "$ref": "#/responses/validationError"
  7000. },
  7001. "423": {
  7002. "$ref": "#/responses/repoArchivedError"
  7003. }
  7004. }
  7005. }
  7006. },
  7007. "/repos/{owner}/{repo}/issues/comments": {
  7008. "get": {
  7009. "produces": [
  7010. "application/json"
  7011. ],
  7012. "tags": [
  7013. "issue"
  7014. ],
  7015. "summary": "List all comments in a repository",
  7016. "operationId": "issueGetRepoComments",
  7017. "parameters": [
  7018. {
  7019. "type": "string",
  7020. "description": "owner of the repo",
  7021. "name": "owner",
  7022. "in": "path",
  7023. "required": true
  7024. },
  7025. {
  7026. "type": "string",
  7027. "description": "name of the repo",
  7028. "name": "repo",
  7029. "in": "path",
  7030. "required": true
  7031. },
  7032. {
  7033. "type": "string",
  7034. "format": "date-time",
  7035. "description": "if provided, only comments updated since the provided time are returned.",
  7036. "name": "since",
  7037. "in": "query"
  7038. },
  7039. {
  7040. "type": "string",
  7041. "format": "date-time",
  7042. "description": "if provided, only comments updated before the provided time are returned.",
  7043. "name": "before",
  7044. "in": "query"
  7045. },
  7046. {
  7047. "type": "integer",
  7048. "description": "page number of results to return (1-based)",
  7049. "name": "page",
  7050. "in": "query"
  7051. },
  7052. {
  7053. "type": "integer",
  7054. "description": "page size of results",
  7055. "name": "limit",
  7056. "in": "query"
  7057. }
  7058. ],
  7059. "responses": {
  7060. "200": {
  7061. "$ref": "#/responses/CommentList"
  7062. },
  7063. "404": {
  7064. "$ref": "#/responses/notFound"
  7065. }
  7066. }
  7067. }
  7068. },
  7069. "/repos/{owner}/{repo}/issues/comments/{id}": {
  7070. "get": {
  7071. "consumes": [
  7072. "application/json"
  7073. ],
  7074. "produces": [
  7075. "application/json"
  7076. ],
  7077. "tags": [
  7078. "issue"
  7079. ],
  7080. "summary": "Get a comment",
  7081. "operationId": "issueGetComment",
  7082. "parameters": [
  7083. {
  7084. "type": "string",
  7085. "description": "owner of the repo",
  7086. "name": "owner",
  7087. "in": "path",
  7088. "required": true
  7089. },
  7090. {
  7091. "type": "string",
  7092. "description": "name of the repo",
  7093. "name": "repo",
  7094. "in": "path",
  7095. "required": true
  7096. },
  7097. {
  7098. "type": "integer",
  7099. "format": "int64",
  7100. "description": "id of the comment",
  7101. "name": "id",
  7102. "in": "path",
  7103. "required": true
  7104. }
  7105. ],
  7106. "responses": {
  7107. "200": {
  7108. "$ref": "#/responses/Comment"
  7109. },
  7110. "204": {
  7111. "$ref": "#/responses/empty"
  7112. },
  7113. "403": {
  7114. "$ref": "#/responses/forbidden"
  7115. },
  7116. "404": {
  7117. "$ref": "#/responses/notFound"
  7118. }
  7119. }
  7120. },
  7121. "delete": {
  7122. "tags": [
  7123. "issue"
  7124. ],
  7125. "summary": "Delete a comment",
  7126. "operationId": "issueDeleteComment",
  7127. "parameters": [
  7128. {
  7129. "type": "string",
  7130. "description": "owner of the repo",
  7131. "name": "owner",
  7132. "in": "path",
  7133. "required": true
  7134. },
  7135. {
  7136. "type": "string",
  7137. "description": "name of the repo",
  7138. "name": "repo",
  7139. "in": "path",
  7140. "required": true
  7141. },
  7142. {
  7143. "type": "integer",
  7144. "format": "int64",
  7145. "description": "id of comment to delete",
  7146. "name": "id",
  7147. "in": "path",
  7148. "required": true
  7149. }
  7150. ],
  7151. "responses": {
  7152. "204": {
  7153. "$ref": "#/responses/empty"
  7154. },
  7155. "403": {
  7156. "$ref": "#/responses/forbidden"
  7157. },
  7158. "404": {
  7159. "$ref": "#/responses/notFound"
  7160. }
  7161. }
  7162. },
  7163. "patch": {
  7164. "consumes": [
  7165. "application/json"
  7166. ],
  7167. "produces": [
  7168. "application/json"
  7169. ],
  7170. "tags": [
  7171. "issue"
  7172. ],
  7173. "summary": "Edit a comment",
  7174. "operationId": "issueEditComment",
  7175. "parameters": [
  7176. {
  7177. "type": "string",
  7178. "description": "owner of the repo",
  7179. "name": "owner",
  7180. "in": "path",
  7181. "required": true
  7182. },
  7183. {
  7184. "type": "string",
  7185. "description": "name of the repo",
  7186. "name": "repo",
  7187. "in": "path",
  7188. "required": true
  7189. },
  7190. {
  7191. "type": "integer",
  7192. "format": "int64",
  7193. "description": "id of the comment to edit",
  7194. "name": "id",
  7195. "in": "path",
  7196. "required": true
  7197. },
  7198. {
  7199. "name": "body",
  7200. "in": "body",
  7201. "schema": {
  7202. "$ref": "#/definitions/EditIssueCommentOption"
  7203. }
  7204. }
  7205. ],
  7206. "responses": {
  7207. "200": {
  7208. "$ref": "#/responses/Comment"
  7209. },
  7210. "204": {
  7211. "$ref": "#/responses/empty"
  7212. },
  7213. "403": {
  7214. "$ref": "#/responses/forbidden"
  7215. },
  7216. "404": {
  7217. "$ref": "#/responses/notFound"
  7218. },
  7219. "423": {
  7220. "$ref": "#/responses/repoArchivedError"
  7221. }
  7222. }
  7223. }
  7224. },
  7225. "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
  7226. "get": {
  7227. "produces": [
  7228. "application/json"
  7229. ],
  7230. "tags": [
  7231. "issue"
  7232. ],
  7233. "summary": "List comment's attachments",
  7234. "operationId": "issueListIssueCommentAttachments",
  7235. "parameters": [
  7236. {
  7237. "type": "string",
  7238. "description": "owner of the repo",
  7239. "name": "owner",
  7240. "in": "path",
  7241. "required": true
  7242. },
  7243. {
  7244. "type": "string",
  7245. "description": "name of the repo",
  7246. "name": "repo",
  7247. "in": "path",
  7248. "required": true
  7249. },
  7250. {
  7251. "type": "integer",
  7252. "format": "int64",
  7253. "description": "id of the comment",
  7254. "name": "id",
  7255. "in": "path",
  7256. "required": true
  7257. }
  7258. ],
  7259. "responses": {
  7260. "200": {
  7261. "$ref": "#/responses/AttachmentList"
  7262. },
  7263. "404": {
  7264. "$ref": "#/responses/error"
  7265. }
  7266. }
  7267. },
  7268. "post": {
  7269. "consumes": [
  7270. "multipart/form-data"
  7271. ],
  7272. "produces": [
  7273. "application/json"
  7274. ],
  7275. "tags": [
  7276. "issue"
  7277. ],
  7278. "summary": "Create a comment attachment",
  7279. "operationId": "issueCreateIssueCommentAttachment",
  7280. "parameters": [
  7281. {
  7282. "type": "string",
  7283. "description": "owner of the repo",
  7284. "name": "owner",
  7285. "in": "path",
  7286. "required": true
  7287. },
  7288. {
  7289. "type": "string",
  7290. "description": "name of the repo",
  7291. "name": "repo",
  7292. "in": "path",
  7293. "required": true
  7294. },
  7295. {
  7296. "type": "integer",
  7297. "format": "int64",
  7298. "description": "id of the comment",
  7299. "name": "id",
  7300. "in": "path",
  7301. "required": true
  7302. },
  7303. {
  7304. "type": "string",
  7305. "description": "name of the attachment",
  7306. "name": "name",
  7307. "in": "query"
  7308. },
  7309. {
  7310. "type": "file",
  7311. "description": "attachment to upload",
  7312. "name": "attachment",
  7313. "in": "formData",
  7314. "required": true
  7315. }
  7316. ],
  7317. "responses": {
  7318. "201": {
  7319. "$ref": "#/responses/Attachment"
  7320. },
  7321. "400": {
  7322. "$ref": "#/responses/error"
  7323. },
  7324. "403": {
  7325. "$ref": "#/responses/forbidden"
  7326. },
  7327. "404": {
  7328. "$ref": "#/responses/error"
  7329. },
  7330. "423": {
  7331. "$ref": "#/responses/repoArchivedError"
  7332. }
  7333. }
  7334. }
  7335. },
  7336. "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
  7337. "get": {
  7338. "produces": [
  7339. "application/json"
  7340. ],
  7341. "tags": [
  7342. "issue"
  7343. ],
  7344. "summary": "Get a comment attachment",
  7345. "operationId": "issueGetIssueCommentAttachment",
  7346. "parameters": [
  7347. {
  7348. "type": "string",
  7349. "description": "owner of the repo",
  7350. "name": "owner",
  7351. "in": "path",
  7352. "required": true
  7353. },
  7354. {
  7355. "type": "string",
  7356. "description": "name of the repo",
  7357. "name": "repo",
  7358. "in": "path",
  7359. "required": true
  7360. },
  7361. {
  7362. "type": "integer",
  7363. "format": "int64",
  7364. "description": "id of the comment",
  7365. "name": "id",
  7366. "in": "path",
  7367. "required": true
  7368. },
  7369. {
  7370. "type": "integer",
  7371. "format": "int64",
  7372. "description": "id of the attachment to get",
  7373. "name": "attachment_id",
  7374. "in": "path",
  7375. "required": true
  7376. }
  7377. ],
  7378. "responses": {
  7379. "200": {
  7380. "$ref": "#/responses/Attachment"
  7381. },
  7382. "404": {
  7383. "$ref": "#/responses/error"
  7384. }
  7385. }
  7386. },
  7387. "delete": {
  7388. "produces": [
  7389. "application/json"
  7390. ],
  7391. "tags": [
  7392. "issue"
  7393. ],
  7394. "summary": "Delete a comment attachment",
  7395. "operationId": "issueDeleteIssueCommentAttachment",
  7396. "parameters": [
  7397. {
  7398. "type": "string",
  7399. "description": "owner of the repo",
  7400. "name": "owner",
  7401. "in": "path",
  7402. "required": true
  7403. },
  7404. {
  7405. "type": "string",
  7406. "description": "name of the repo",
  7407. "name": "repo",
  7408. "in": "path",
  7409. "required": true
  7410. },
  7411. {
  7412. "type": "integer",
  7413. "format": "int64",
  7414. "description": "id of the comment",
  7415. "name": "id",
  7416. "in": "path",
  7417. "required": true
  7418. },
  7419. {
  7420. "type": "integer",
  7421. "format": "int64",
  7422. "description": "id of the attachment to delete",
  7423. "name": "attachment_id",
  7424. "in": "path",
  7425. "required": true
  7426. }
  7427. ],
  7428. "responses": {
  7429. "204": {
  7430. "$ref": "#/responses/empty"
  7431. },
  7432. "404": {
  7433. "$ref": "#/responses/error"
  7434. },
  7435. "423": {
  7436. "$ref": "#/responses/repoArchivedError"
  7437. }
  7438. }
  7439. },
  7440. "patch": {
  7441. "consumes": [
  7442. "application/json"
  7443. ],
  7444. "produces": [
  7445. "application/json"
  7446. ],
  7447. "tags": [
  7448. "issue"
  7449. ],
  7450. "summary": "Edit a comment attachment",
  7451. "operationId": "issueEditIssueCommentAttachment",
  7452. "parameters": [
  7453. {
  7454. "type": "string",
  7455. "description": "owner of the repo",
  7456. "name": "owner",
  7457. "in": "path",
  7458. "required": true
  7459. },
  7460. {
  7461. "type": "string",
  7462. "description": "name of the repo",
  7463. "name": "repo",
  7464. "in": "path",
  7465. "required": true
  7466. },
  7467. {
  7468. "type": "integer",
  7469. "format": "int64",
  7470. "description": "id of the comment",
  7471. "name": "id",
  7472. "in": "path",
  7473. "required": true
  7474. },
  7475. {
  7476. "type": "integer",
  7477. "format": "int64",
  7478. "description": "id of the attachment to edit",
  7479. "name": "attachment_id",
  7480. "in": "path",
  7481. "required": true
  7482. },
  7483. {
  7484. "name": "body",
  7485. "in": "body",
  7486. "schema": {
  7487. "$ref": "#/definitions/EditAttachmentOptions"
  7488. }
  7489. }
  7490. ],
  7491. "responses": {
  7492. "201": {
  7493. "$ref": "#/responses/Attachment"
  7494. },
  7495. "404": {
  7496. "$ref": "#/responses/error"
  7497. },
  7498. "423": {
  7499. "$ref": "#/responses/repoArchivedError"
  7500. }
  7501. }
  7502. }
  7503. },
  7504. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  7505. "get": {
  7506. "consumes": [
  7507. "application/json"
  7508. ],
  7509. "produces": [
  7510. "application/json"
  7511. ],
  7512. "tags": [
  7513. "issue"
  7514. ],
  7515. "summary": "Get a list of reactions from a comment of an issue",
  7516. "operationId": "issueGetCommentReactions",
  7517. "parameters": [
  7518. {
  7519. "type": "string",
  7520. "description": "owner of the repo",
  7521. "name": "owner",
  7522. "in": "path",
  7523. "required": true
  7524. },
  7525. {
  7526. "type": "string",
  7527. "description": "name of the repo",
  7528. "name": "repo",
  7529. "in": "path",
  7530. "required": true
  7531. },
  7532. {
  7533. "type": "integer",
  7534. "format": "int64",
  7535. "description": "id of the comment to edit",
  7536. "name": "id",
  7537. "in": "path",
  7538. "required": true
  7539. }
  7540. ],
  7541. "responses": {
  7542. "200": {
  7543. "$ref": "#/responses/ReactionList"
  7544. },
  7545. "403": {
  7546. "$ref": "#/responses/forbidden"
  7547. },
  7548. "404": {
  7549. "$ref": "#/responses/notFound"
  7550. }
  7551. }
  7552. },
  7553. "post": {
  7554. "consumes": [
  7555. "application/json"
  7556. ],
  7557. "produces": [
  7558. "application/json"
  7559. ],
  7560. "tags": [
  7561. "issue"
  7562. ],
  7563. "summary": "Add a reaction to a comment of an issue",
  7564. "operationId": "issuePostCommentReaction",
  7565. "parameters": [
  7566. {
  7567. "type": "string",
  7568. "description": "owner of the repo",
  7569. "name": "owner",
  7570. "in": "path",
  7571. "required": true
  7572. },
  7573. {
  7574. "type": "string",
  7575. "description": "name of the repo",
  7576. "name": "repo",
  7577. "in": "path",
  7578. "required": true
  7579. },
  7580. {
  7581. "type": "integer",
  7582. "format": "int64",
  7583. "description": "id of the comment to edit",
  7584. "name": "id",
  7585. "in": "path",
  7586. "required": true
  7587. },
  7588. {
  7589. "name": "content",
  7590. "in": "body",
  7591. "schema": {
  7592. "$ref": "#/definitions/EditReactionOption"
  7593. }
  7594. }
  7595. ],
  7596. "responses": {
  7597. "200": {
  7598. "$ref": "#/responses/Reaction"
  7599. },
  7600. "201": {
  7601. "$ref": "#/responses/Reaction"
  7602. },
  7603. "403": {
  7604. "$ref": "#/responses/forbidden"
  7605. },
  7606. "404": {
  7607. "$ref": "#/responses/notFound"
  7608. }
  7609. }
  7610. },
  7611. "delete": {
  7612. "consumes": [
  7613. "application/json"
  7614. ],
  7615. "produces": [
  7616. "application/json"
  7617. ],
  7618. "tags": [
  7619. "issue"
  7620. ],
  7621. "summary": "Remove a reaction from a comment of an issue",
  7622. "operationId": "issueDeleteCommentReaction",
  7623. "parameters": [
  7624. {
  7625. "type": "string",
  7626. "description": "owner of the repo",
  7627. "name": "owner",
  7628. "in": "path",
  7629. "required": true
  7630. },
  7631. {
  7632. "type": "string",
  7633. "description": "name of the repo",
  7634. "name": "repo",
  7635. "in": "path",
  7636. "required": true
  7637. },
  7638. {
  7639. "type": "integer",
  7640. "format": "int64",
  7641. "description": "id of the comment to edit",
  7642. "name": "id",
  7643. "in": "path",
  7644. "required": true
  7645. },
  7646. {
  7647. "name": "content",
  7648. "in": "body",
  7649. "schema": {
  7650. "$ref": "#/definitions/EditReactionOption"
  7651. }
  7652. }
  7653. ],
  7654. "responses": {
  7655. "200": {
  7656. "$ref": "#/responses/empty"
  7657. },
  7658. "403": {
  7659. "$ref": "#/responses/forbidden"
  7660. },
  7661. "404": {
  7662. "$ref": "#/responses/notFound"
  7663. }
  7664. }
  7665. }
  7666. },
  7667. "/repos/{owner}/{repo}/issues/pinned": {
  7668. "get": {
  7669. "produces": [
  7670. "application/json"
  7671. ],
  7672. "tags": [
  7673. "repository"
  7674. ],
  7675. "summary": "List a repo's pinned issues",
  7676. "operationId": "repoListPinnedIssues",
  7677. "parameters": [
  7678. {
  7679. "type": "string",
  7680. "description": "owner of the repo",
  7681. "name": "owner",
  7682. "in": "path",
  7683. "required": true
  7684. },
  7685. {
  7686. "type": "string",
  7687. "description": "name of the repo",
  7688. "name": "repo",
  7689. "in": "path",
  7690. "required": true
  7691. }
  7692. ],
  7693. "responses": {
  7694. "200": {
  7695. "$ref": "#/responses/IssueList"
  7696. },
  7697. "404": {
  7698. "$ref": "#/responses/notFound"
  7699. }
  7700. }
  7701. }
  7702. },
  7703. "/repos/{owner}/{repo}/issues/{index}": {
  7704. "get": {
  7705. "produces": [
  7706. "application/json"
  7707. ],
  7708. "tags": [
  7709. "issue"
  7710. ],
  7711. "summary": "Get an issue",
  7712. "operationId": "issueGetIssue",
  7713. "parameters": [
  7714. {
  7715. "type": "string",
  7716. "description": "owner of the repo",
  7717. "name": "owner",
  7718. "in": "path",
  7719. "required": true
  7720. },
  7721. {
  7722. "type": "string",
  7723. "description": "name of the repo",
  7724. "name": "repo",
  7725. "in": "path",
  7726. "required": true
  7727. },
  7728. {
  7729. "type": "integer",
  7730. "format": "int64",
  7731. "description": "index of the issue to get",
  7732. "name": "index",
  7733. "in": "path",
  7734. "required": true
  7735. }
  7736. ],
  7737. "responses": {
  7738. "200": {
  7739. "$ref": "#/responses/Issue"
  7740. },
  7741. "404": {
  7742. "$ref": "#/responses/notFound"
  7743. }
  7744. }
  7745. },
  7746. "delete": {
  7747. "tags": [
  7748. "issue"
  7749. ],
  7750. "summary": "Delete an issue",
  7751. "operationId": "issueDelete",
  7752. "parameters": [
  7753. {
  7754. "type": "string",
  7755. "description": "owner of the repo",
  7756. "name": "owner",
  7757. "in": "path",
  7758. "required": true
  7759. },
  7760. {
  7761. "type": "string",
  7762. "description": "name of the repo",
  7763. "name": "repo",
  7764. "in": "path",
  7765. "required": true
  7766. },
  7767. {
  7768. "type": "integer",
  7769. "format": "int64",
  7770. "description": "index of issue to delete",
  7771. "name": "index",
  7772. "in": "path",
  7773. "required": true
  7774. }
  7775. ],
  7776. "responses": {
  7777. "204": {
  7778. "$ref": "#/responses/empty"
  7779. },
  7780. "403": {
  7781. "$ref": "#/responses/forbidden"
  7782. },
  7783. "404": {
  7784. "$ref": "#/responses/notFound"
  7785. }
  7786. }
  7787. },
  7788. "patch": {
  7789. "consumes": [
  7790. "application/json"
  7791. ],
  7792. "produces": [
  7793. "application/json"
  7794. ],
  7795. "tags": [
  7796. "issue"
  7797. ],
  7798. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  7799. "operationId": "issueEditIssue",
  7800. "parameters": [
  7801. {
  7802. "type": "string",
  7803. "description": "owner of the repo",
  7804. "name": "owner",
  7805. "in": "path",
  7806. "required": true
  7807. },
  7808. {
  7809. "type": "string",
  7810. "description": "name of the repo",
  7811. "name": "repo",
  7812. "in": "path",
  7813. "required": true
  7814. },
  7815. {
  7816. "type": "integer",
  7817. "format": "int64",
  7818. "description": "index of the issue to edit",
  7819. "name": "index",
  7820. "in": "path",
  7821. "required": true
  7822. },
  7823. {
  7824. "name": "body",
  7825. "in": "body",
  7826. "schema": {
  7827. "$ref": "#/definitions/EditIssueOption"
  7828. }
  7829. }
  7830. ],
  7831. "responses": {
  7832. "201": {
  7833. "$ref": "#/responses/Issue"
  7834. },
  7835. "403": {
  7836. "$ref": "#/responses/forbidden"
  7837. },
  7838. "404": {
  7839. "$ref": "#/responses/notFound"
  7840. },
  7841. "412": {
  7842. "$ref": "#/responses/error"
  7843. }
  7844. }
  7845. }
  7846. },
  7847. "/repos/{owner}/{repo}/issues/{index}/assets": {
  7848. "get": {
  7849. "produces": [
  7850. "application/json"
  7851. ],
  7852. "tags": [
  7853. "issue"
  7854. ],
  7855. "summary": "List issue's attachments",
  7856. "operationId": "issueListIssueAttachments",
  7857. "parameters": [
  7858. {
  7859. "type": "string",
  7860. "description": "owner of the repo",
  7861. "name": "owner",
  7862. "in": "path",
  7863. "required": true
  7864. },
  7865. {
  7866. "type": "string",
  7867. "description": "name of the repo",
  7868. "name": "repo",
  7869. "in": "path",
  7870. "required": true
  7871. },
  7872. {
  7873. "type": "integer",
  7874. "format": "int64",
  7875. "description": "index of the issue",
  7876. "name": "index",
  7877. "in": "path",
  7878. "required": true
  7879. }
  7880. ],
  7881. "responses": {
  7882. "200": {
  7883. "$ref": "#/responses/AttachmentList"
  7884. },
  7885. "404": {
  7886. "$ref": "#/responses/error"
  7887. }
  7888. }
  7889. },
  7890. "post": {
  7891. "consumes": [
  7892. "multipart/form-data"
  7893. ],
  7894. "produces": [
  7895. "application/json"
  7896. ],
  7897. "tags": [
  7898. "issue"
  7899. ],
  7900. "summary": "Create an issue attachment",
  7901. "operationId": "issueCreateIssueAttachment",
  7902. "parameters": [
  7903. {
  7904. "type": "string",
  7905. "description": "owner of the repo",
  7906. "name": "owner",
  7907. "in": "path",
  7908. "required": true
  7909. },
  7910. {
  7911. "type": "string",
  7912. "description": "name of the repo",
  7913. "name": "repo",
  7914. "in": "path",
  7915. "required": true
  7916. },
  7917. {
  7918. "type": "integer",
  7919. "format": "int64",
  7920. "description": "index of the issue",
  7921. "name": "index",
  7922. "in": "path",
  7923. "required": true
  7924. },
  7925. {
  7926. "type": "string",
  7927. "description": "name of the attachment",
  7928. "name": "name",
  7929. "in": "query"
  7930. },
  7931. {
  7932. "type": "file",
  7933. "description": "attachment to upload",
  7934. "name": "attachment",
  7935. "in": "formData",
  7936. "required": true
  7937. }
  7938. ],
  7939. "responses": {
  7940. "201": {
  7941. "$ref": "#/responses/Attachment"
  7942. },
  7943. "400": {
  7944. "$ref": "#/responses/error"
  7945. },
  7946. "404": {
  7947. "$ref": "#/responses/error"
  7948. },
  7949. "423": {
  7950. "$ref": "#/responses/repoArchivedError"
  7951. }
  7952. }
  7953. }
  7954. },
  7955. "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
  7956. "get": {
  7957. "produces": [
  7958. "application/json"
  7959. ],
  7960. "tags": [
  7961. "issue"
  7962. ],
  7963. "summary": "Get an issue attachment",
  7964. "operationId": "issueGetIssueAttachment",
  7965. "parameters": [
  7966. {
  7967. "type": "string",
  7968. "description": "owner of the repo",
  7969. "name": "owner",
  7970. "in": "path",
  7971. "required": true
  7972. },
  7973. {
  7974. "type": "string",
  7975. "description": "name of the repo",
  7976. "name": "repo",
  7977. "in": "path",
  7978. "required": true
  7979. },
  7980. {
  7981. "type": "integer",
  7982. "format": "int64",
  7983. "description": "index of the issue",
  7984. "name": "index",
  7985. "in": "path",
  7986. "required": true
  7987. },
  7988. {
  7989. "type": "integer",
  7990. "format": "int64",
  7991. "description": "id of the attachment to get",
  7992. "name": "attachment_id",
  7993. "in": "path",
  7994. "required": true
  7995. }
  7996. ],
  7997. "responses": {
  7998. "200": {
  7999. "$ref": "#/responses/Attachment"
  8000. },
  8001. "404": {
  8002. "$ref": "#/responses/error"
  8003. }
  8004. }
  8005. },
  8006. "delete": {
  8007. "produces": [
  8008. "application/json"
  8009. ],
  8010. "tags": [
  8011. "issue"
  8012. ],
  8013. "summary": "Delete an issue attachment",
  8014. "operationId": "issueDeleteIssueAttachment",
  8015. "parameters": [
  8016. {
  8017. "type": "string",
  8018. "description": "owner of the repo",
  8019. "name": "owner",
  8020. "in": "path",
  8021. "required": true
  8022. },
  8023. {
  8024. "type": "string",
  8025. "description": "name of the repo",
  8026. "name": "repo",
  8027. "in": "path",
  8028. "required": true
  8029. },
  8030. {
  8031. "type": "integer",
  8032. "format": "int64",
  8033. "description": "index of the issue",
  8034. "name": "index",
  8035. "in": "path",
  8036. "required": true
  8037. },
  8038. {
  8039. "type": "integer",
  8040. "format": "int64",
  8041. "description": "id of the attachment to delete",
  8042. "name": "attachment_id",
  8043. "in": "path",
  8044. "required": true
  8045. }
  8046. ],
  8047. "responses": {
  8048. "204": {
  8049. "$ref": "#/responses/empty"
  8050. },
  8051. "404": {
  8052. "$ref": "#/responses/error"
  8053. },
  8054. "423": {
  8055. "$ref": "#/responses/repoArchivedError"
  8056. }
  8057. }
  8058. },
  8059. "patch": {
  8060. "consumes": [
  8061. "application/json"
  8062. ],
  8063. "produces": [
  8064. "application/json"
  8065. ],
  8066. "tags": [
  8067. "issue"
  8068. ],
  8069. "summary": "Edit an issue attachment",
  8070. "operationId": "issueEditIssueAttachment",
  8071. "parameters": [
  8072. {
  8073. "type": "string",
  8074. "description": "owner of the repo",
  8075. "name": "owner",
  8076. "in": "path",
  8077. "required": true
  8078. },
  8079. {
  8080. "type": "string",
  8081. "description": "name of the repo",
  8082. "name": "repo",
  8083. "in": "path",
  8084. "required": true
  8085. },
  8086. {
  8087. "type": "integer",
  8088. "format": "int64",
  8089. "description": "index of the issue",
  8090. "name": "index",
  8091. "in": "path",
  8092. "required": true
  8093. },
  8094. {
  8095. "type": "integer",
  8096. "format": "int64",
  8097. "description": "id of the attachment to edit",
  8098. "name": "attachment_id",
  8099. "in": "path",
  8100. "required": true
  8101. },
  8102. {
  8103. "name": "body",
  8104. "in": "body",
  8105. "schema": {
  8106. "$ref": "#/definitions/EditAttachmentOptions"
  8107. }
  8108. }
  8109. ],
  8110. "responses": {
  8111. "201": {
  8112. "$ref": "#/responses/Attachment"
  8113. },
  8114. "404": {
  8115. "$ref": "#/responses/error"
  8116. },
  8117. "423": {
  8118. "$ref": "#/responses/repoArchivedError"
  8119. }
  8120. }
  8121. }
  8122. },
  8123. "/repos/{owner}/{repo}/issues/{index}/blocks": {
  8124. "get": {
  8125. "produces": [
  8126. "application/json"
  8127. ],
  8128. "tags": [
  8129. "issue"
  8130. ],
  8131. "summary": "List issues that are blocked by this issue",
  8132. "operationId": "issueListBlocks",
  8133. "parameters": [
  8134. {
  8135. "type": "string",
  8136. "description": "owner of the repo",
  8137. "name": "owner",
  8138. "in": "path",
  8139. "required": true
  8140. },
  8141. {
  8142. "type": "string",
  8143. "description": "name of the repo",
  8144. "name": "repo",
  8145. "in": "path",
  8146. "required": true
  8147. },
  8148. {
  8149. "type": "string",
  8150. "description": "index of the issue",
  8151. "name": "index",
  8152. "in": "path",
  8153. "required": true
  8154. },
  8155. {
  8156. "type": "integer",
  8157. "description": "page number of results to return (1-based)",
  8158. "name": "page",
  8159. "in": "query"
  8160. },
  8161. {
  8162. "type": "integer",
  8163. "description": "page size of results",
  8164. "name": "limit",
  8165. "in": "query"
  8166. }
  8167. ],
  8168. "responses": {
  8169. "200": {
  8170. "$ref": "#/responses/IssueList"
  8171. },
  8172. "404": {
  8173. "$ref": "#/responses/notFound"
  8174. }
  8175. }
  8176. },
  8177. "post": {
  8178. "produces": [
  8179. "application/json"
  8180. ],
  8181. "tags": [
  8182. "issue"
  8183. ],
  8184. "summary": "Block the issue given in the body by the issue in path",
  8185. "operationId": "issueCreateIssueBlocking",
  8186. "parameters": [
  8187. {
  8188. "type": "string",
  8189. "description": "owner of the repo",
  8190. "name": "owner",
  8191. "in": "path",
  8192. "required": true
  8193. },
  8194. {
  8195. "type": "string",
  8196. "description": "name of the repo",
  8197. "name": "repo",
  8198. "in": "path",
  8199. "required": true
  8200. },
  8201. {
  8202. "type": "string",
  8203. "description": "index of the issue",
  8204. "name": "index",
  8205. "in": "path",
  8206. "required": true
  8207. },
  8208. {
  8209. "name": "body",
  8210. "in": "body",
  8211. "schema": {
  8212. "$ref": "#/definitions/IssueMeta"
  8213. }
  8214. }
  8215. ],
  8216. "responses": {
  8217. "201": {
  8218. "$ref": "#/responses/Issue"
  8219. },
  8220. "404": {
  8221. "description": "the issue does not exist"
  8222. }
  8223. }
  8224. },
  8225. "delete": {
  8226. "produces": [
  8227. "application/json"
  8228. ],
  8229. "tags": [
  8230. "issue"
  8231. ],
  8232. "summary": "Unblock the issue given in the body by the issue in path",
  8233. "operationId": "issueRemoveIssueBlocking",
  8234. "parameters": [
  8235. {
  8236. "type": "string",
  8237. "description": "owner of the repo",
  8238. "name": "owner",
  8239. "in": "path",
  8240. "required": true
  8241. },
  8242. {
  8243. "type": "string",
  8244. "description": "name of the repo",
  8245. "name": "repo",
  8246. "in": "path",
  8247. "required": true
  8248. },
  8249. {
  8250. "type": "string",
  8251. "description": "index of the issue",
  8252. "name": "index",
  8253. "in": "path",
  8254. "required": true
  8255. },
  8256. {
  8257. "name": "body",
  8258. "in": "body",
  8259. "schema": {
  8260. "$ref": "#/definitions/IssueMeta"
  8261. }
  8262. }
  8263. ],
  8264. "responses": {
  8265. "200": {
  8266. "$ref": "#/responses/Issue"
  8267. },
  8268. "404": {
  8269. "$ref": "#/responses/notFound"
  8270. }
  8271. }
  8272. }
  8273. },
  8274. "/repos/{owner}/{repo}/issues/{index}/comments": {
  8275. "get": {
  8276. "produces": [
  8277. "application/json"
  8278. ],
  8279. "tags": [
  8280. "issue"
  8281. ],
  8282. "summary": "List all comments on an issue",
  8283. "operationId": "issueGetComments",
  8284. "parameters": [
  8285. {
  8286. "type": "string",
  8287. "description": "owner of the repo",
  8288. "name": "owner",
  8289. "in": "path",
  8290. "required": true
  8291. },
  8292. {
  8293. "type": "string",
  8294. "description": "name of the repo",
  8295. "name": "repo",
  8296. "in": "path",
  8297. "required": true
  8298. },
  8299. {
  8300. "type": "integer",
  8301. "format": "int64",
  8302. "description": "index of the issue",
  8303. "name": "index",
  8304. "in": "path",
  8305. "required": true
  8306. },
  8307. {
  8308. "type": "string",
  8309. "format": "date-time",
  8310. "description": "if provided, only comments updated since the specified time are returned.",
  8311. "name": "since",
  8312. "in": "query"
  8313. },
  8314. {
  8315. "type": "string",
  8316. "format": "date-time",
  8317. "description": "if provided, only comments updated before the provided time are returned.",
  8318. "name": "before",
  8319. "in": "query"
  8320. }
  8321. ],
  8322. "responses": {
  8323. "200": {
  8324. "$ref": "#/responses/CommentList"
  8325. },
  8326. "404": {
  8327. "$ref": "#/responses/notFound"
  8328. }
  8329. }
  8330. },
  8331. "post": {
  8332. "consumes": [
  8333. "application/json"
  8334. ],
  8335. "produces": [
  8336. "application/json"
  8337. ],
  8338. "tags": [
  8339. "issue"
  8340. ],
  8341. "summary": "Add a comment to an issue",
  8342. "operationId": "issueCreateComment",
  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": "integer",
  8360. "format": "int64",
  8361. "description": "index of the issue",
  8362. "name": "index",
  8363. "in": "path",
  8364. "required": true
  8365. },
  8366. {
  8367. "name": "body",
  8368. "in": "body",
  8369. "schema": {
  8370. "$ref": "#/definitions/CreateIssueCommentOption"
  8371. }
  8372. }
  8373. ],
  8374. "responses": {
  8375. "201": {
  8376. "$ref": "#/responses/Comment"
  8377. },
  8378. "403": {
  8379. "$ref": "#/responses/forbidden"
  8380. },
  8381. "404": {
  8382. "$ref": "#/responses/notFound"
  8383. },
  8384. "423": {
  8385. "$ref": "#/responses/repoArchivedError"
  8386. }
  8387. }
  8388. }
  8389. },
  8390. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  8391. "delete": {
  8392. "tags": [
  8393. "issue"
  8394. ],
  8395. "summary": "Delete a comment",
  8396. "operationId": "issueDeleteCommentDeprecated",
  8397. "deprecated": true,
  8398. "parameters": [
  8399. {
  8400. "type": "string",
  8401. "description": "owner of the repo",
  8402. "name": "owner",
  8403. "in": "path",
  8404. "required": true
  8405. },
  8406. {
  8407. "type": "string",
  8408. "description": "name of the repo",
  8409. "name": "repo",
  8410. "in": "path",
  8411. "required": true
  8412. },
  8413. {
  8414. "type": "integer",
  8415. "description": "this parameter is ignored",
  8416. "name": "index",
  8417. "in": "path",
  8418. "required": true
  8419. },
  8420. {
  8421. "type": "integer",
  8422. "format": "int64",
  8423. "description": "id of comment to delete",
  8424. "name": "id",
  8425. "in": "path",
  8426. "required": true
  8427. }
  8428. ],
  8429. "responses": {
  8430. "204": {
  8431. "$ref": "#/responses/empty"
  8432. },
  8433. "403": {
  8434. "$ref": "#/responses/forbidden"
  8435. },
  8436. "404": {
  8437. "$ref": "#/responses/notFound"
  8438. }
  8439. }
  8440. },
  8441. "patch": {
  8442. "consumes": [
  8443. "application/json"
  8444. ],
  8445. "produces": [
  8446. "application/json"
  8447. ],
  8448. "tags": [
  8449. "issue"
  8450. ],
  8451. "summary": "Edit a comment",
  8452. "operationId": "issueEditCommentDeprecated",
  8453. "deprecated": true,
  8454. "parameters": [
  8455. {
  8456. "type": "string",
  8457. "description": "owner of the repo",
  8458. "name": "owner",
  8459. "in": "path",
  8460. "required": true
  8461. },
  8462. {
  8463. "type": "string",
  8464. "description": "name of the repo",
  8465. "name": "repo",
  8466. "in": "path",
  8467. "required": true
  8468. },
  8469. {
  8470. "type": "integer",
  8471. "description": "this parameter is ignored",
  8472. "name": "index",
  8473. "in": "path",
  8474. "required": true
  8475. },
  8476. {
  8477. "type": "integer",
  8478. "format": "int64",
  8479. "description": "id of the comment to edit",
  8480. "name": "id",
  8481. "in": "path",
  8482. "required": true
  8483. },
  8484. {
  8485. "name": "body",
  8486. "in": "body",
  8487. "schema": {
  8488. "$ref": "#/definitions/EditIssueCommentOption"
  8489. }
  8490. }
  8491. ],
  8492. "responses": {
  8493. "200": {
  8494. "$ref": "#/responses/Comment"
  8495. },
  8496. "204": {
  8497. "$ref": "#/responses/empty"
  8498. },
  8499. "403": {
  8500. "$ref": "#/responses/forbidden"
  8501. },
  8502. "404": {
  8503. "$ref": "#/responses/notFound"
  8504. }
  8505. }
  8506. }
  8507. },
  8508. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  8509. "post": {
  8510. "consumes": [
  8511. "application/json"
  8512. ],
  8513. "produces": [
  8514. "application/json"
  8515. ],
  8516. "tags": [
  8517. "issue"
  8518. ],
  8519. "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.",
  8520. "operationId": "issueEditIssueDeadline",
  8521. "parameters": [
  8522. {
  8523. "type": "string",
  8524. "description": "owner of the repo",
  8525. "name": "owner",
  8526. "in": "path",
  8527. "required": true
  8528. },
  8529. {
  8530. "type": "string",
  8531. "description": "name of the repo",
  8532. "name": "repo",
  8533. "in": "path",
  8534. "required": true
  8535. },
  8536. {
  8537. "type": "integer",
  8538. "format": "int64",
  8539. "description": "index of the issue to create or update a deadline on",
  8540. "name": "index",
  8541. "in": "path",
  8542. "required": true
  8543. },
  8544. {
  8545. "name": "body",
  8546. "in": "body",
  8547. "schema": {
  8548. "$ref": "#/definitions/EditDeadlineOption"
  8549. }
  8550. }
  8551. ],
  8552. "responses": {
  8553. "201": {
  8554. "$ref": "#/responses/IssueDeadline"
  8555. },
  8556. "403": {
  8557. "$ref": "#/responses/forbidden"
  8558. },
  8559. "404": {
  8560. "$ref": "#/responses/notFound"
  8561. }
  8562. }
  8563. }
  8564. },
  8565. "/repos/{owner}/{repo}/issues/{index}/dependencies": {
  8566. "get": {
  8567. "produces": [
  8568. "application/json"
  8569. ],
  8570. "tags": [
  8571. "issue"
  8572. ],
  8573. "summary": "List an issue's dependencies, i.e all issues that block this issue.",
  8574. "operationId": "issueListIssueDependencies",
  8575. "parameters": [
  8576. {
  8577. "type": "string",
  8578. "description": "owner of the repo",
  8579. "name": "owner",
  8580. "in": "path",
  8581. "required": true
  8582. },
  8583. {
  8584. "type": "string",
  8585. "description": "name of the repo",
  8586. "name": "repo",
  8587. "in": "path",
  8588. "required": true
  8589. },
  8590. {
  8591. "type": "string",
  8592. "description": "index of the issue",
  8593. "name": "index",
  8594. "in": "path",
  8595. "required": true
  8596. },
  8597. {
  8598. "type": "integer",
  8599. "description": "page number of results to return (1-based)",
  8600. "name": "page",
  8601. "in": "query"
  8602. },
  8603. {
  8604. "type": "integer",
  8605. "description": "page size of results",
  8606. "name": "limit",
  8607. "in": "query"
  8608. }
  8609. ],
  8610. "responses": {
  8611. "200": {
  8612. "$ref": "#/responses/IssueList"
  8613. },
  8614. "404": {
  8615. "$ref": "#/responses/notFound"
  8616. }
  8617. }
  8618. },
  8619. "post": {
  8620. "produces": [
  8621. "application/json"
  8622. ],
  8623. "tags": [
  8624. "issue"
  8625. ],
  8626. "summary": "Make the issue in the url depend on the issue in the form.",
  8627. "operationId": "issueCreateIssueDependencies",
  8628. "parameters": [
  8629. {
  8630. "type": "string",
  8631. "description": "owner of the repo",
  8632. "name": "owner",
  8633. "in": "path",
  8634. "required": true
  8635. },
  8636. {
  8637. "type": "string",
  8638. "description": "name of the repo",
  8639. "name": "repo",
  8640. "in": "path",
  8641. "required": true
  8642. },
  8643. {
  8644. "type": "string",
  8645. "description": "index of the issue",
  8646. "name": "index",
  8647. "in": "path",
  8648. "required": true
  8649. },
  8650. {
  8651. "name": "body",
  8652. "in": "body",
  8653. "schema": {
  8654. "$ref": "#/definitions/IssueMeta"
  8655. }
  8656. }
  8657. ],
  8658. "responses": {
  8659. "201": {
  8660. "$ref": "#/responses/Issue"
  8661. },
  8662. "404": {
  8663. "description": "the issue does not exist"
  8664. },
  8665. "423": {
  8666. "$ref": "#/responses/repoArchivedError"
  8667. }
  8668. }
  8669. },
  8670. "delete": {
  8671. "produces": [
  8672. "application/json"
  8673. ],
  8674. "tags": [
  8675. "issue"
  8676. ],
  8677. "summary": "Remove an issue dependency",
  8678. "operationId": "issueRemoveIssueDependencies",
  8679. "parameters": [
  8680. {
  8681. "type": "string",
  8682. "description": "owner of the repo",
  8683. "name": "owner",
  8684. "in": "path",
  8685. "required": true
  8686. },
  8687. {
  8688. "type": "string",
  8689. "description": "name of the repo",
  8690. "name": "repo",
  8691. "in": "path",
  8692. "required": true
  8693. },
  8694. {
  8695. "type": "string",
  8696. "description": "index of the issue",
  8697. "name": "index",
  8698. "in": "path",
  8699. "required": true
  8700. },
  8701. {
  8702. "name": "body",
  8703. "in": "body",
  8704. "schema": {
  8705. "$ref": "#/definitions/IssueMeta"
  8706. }
  8707. }
  8708. ],
  8709. "responses": {
  8710. "200": {
  8711. "$ref": "#/responses/Issue"
  8712. },
  8713. "404": {
  8714. "$ref": "#/responses/notFound"
  8715. },
  8716. "423": {
  8717. "$ref": "#/responses/repoArchivedError"
  8718. }
  8719. }
  8720. }
  8721. },
  8722. "/repos/{owner}/{repo}/issues/{index}/labels": {
  8723. "get": {
  8724. "produces": [
  8725. "application/json"
  8726. ],
  8727. "tags": [
  8728. "issue"
  8729. ],
  8730. "summary": "Get an issue's labels",
  8731. "operationId": "issueGetLabels",
  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": "integer",
  8749. "format": "int64",
  8750. "description": "index of the issue",
  8751. "name": "index",
  8752. "in": "path",
  8753. "required": true
  8754. }
  8755. ],
  8756. "responses": {
  8757. "200": {
  8758. "$ref": "#/responses/LabelList"
  8759. },
  8760. "404": {
  8761. "$ref": "#/responses/notFound"
  8762. }
  8763. }
  8764. },
  8765. "put": {
  8766. "consumes": [
  8767. "application/json"
  8768. ],
  8769. "produces": [
  8770. "application/json"
  8771. ],
  8772. "tags": [
  8773. "issue"
  8774. ],
  8775. "summary": "Replace an issue's labels",
  8776. "operationId": "issueReplaceLabels",
  8777. "parameters": [
  8778. {
  8779. "type": "string",
  8780. "description": "owner of the repo",
  8781. "name": "owner",
  8782. "in": "path",
  8783. "required": true
  8784. },
  8785. {
  8786. "type": "string",
  8787. "description": "name of the repo",
  8788. "name": "repo",
  8789. "in": "path",
  8790. "required": true
  8791. },
  8792. {
  8793. "type": "integer",
  8794. "format": "int64",
  8795. "description": "index of the issue",
  8796. "name": "index",
  8797. "in": "path",
  8798. "required": true
  8799. },
  8800. {
  8801. "name": "body",
  8802. "in": "body",
  8803. "schema": {
  8804. "$ref": "#/definitions/IssueLabelsOption"
  8805. }
  8806. }
  8807. ],
  8808. "responses": {
  8809. "200": {
  8810. "$ref": "#/responses/LabelList"
  8811. },
  8812. "403": {
  8813. "$ref": "#/responses/forbidden"
  8814. },
  8815. "404": {
  8816. "$ref": "#/responses/notFound"
  8817. }
  8818. }
  8819. },
  8820. "post": {
  8821. "consumes": [
  8822. "application/json"
  8823. ],
  8824. "produces": [
  8825. "application/json"
  8826. ],
  8827. "tags": [
  8828. "issue"
  8829. ],
  8830. "summary": "Add a label to an issue",
  8831. "operationId": "issueAddLabel",
  8832. "parameters": [
  8833. {
  8834. "type": "string",
  8835. "description": "owner of the repo",
  8836. "name": "owner",
  8837. "in": "path",
  8838. "required": true
  8839. },
  8840. {
  8841. "type": "string",
  8842. "description": "name of the repo",
  8843. "name": "repo",
  8844. "in": "path",
  8845. "required": true
  8846. },
  8847. {
  8848. "type": "integer",
  8849. "format": "int64",
  8850. "description": "index of the issue",
  8851. "name": "index",
  8852. "in": "path",
  8853. "required": true
  8854. },
  8855. {
  8856. "name": "body",
  8857. "in": "body",
  8858. "schema": {
  8859. "$ref": "#/definitions/IssueLabelsOption"
  8860. }
  8861. }
  8862. ],
  8863. "responses": {
  8864. "200": {
  8865. "$ref": "#/responses/LabelList"
  8866. },
  8867. "403": {
  8868. "$ref": "#/responses/forbidden"
  8869. },
  8870. "404": {
  8871. "$ref": "#/responses/notFound"
  8872. }
  8873. }
  8874. },
  8875. "delete": {
  8876. "produces": [
  8877. "application/json"
  8878. ],
  8879. "tags": [
  8880. "issue"
  8881. ],
  8882. "summary": "Remove all labels from an issue",
  8883. "operationId": "issueClearLabels",
  8884. "parameters": [
  8885. {
  8886. "type": "string",
  8887. "description": "owner of the repo",
  8888. "name": "owner",
  8889. "in": "path",
  8890. "required": true
  8891. },
  8892. {
  8893. "type": "string",
  8894. "description": "name of the repo",
  8895. "name": "repo",
  8896. "in": "path",
  8897. "required": true
  8898. },
  8899. {
  8900. "type": "integer",
  8901. "format": "int64",
  8902. "description": "index of the issue",
  8903. "name": "index",
  8904. "in": "path",
  8905. "required": true
  8906. }
  8907. ],
  8908. "responses": {
  8909. "204": {
  8910. "$ref": "#/responses/empty"
  8911. },
  8912. "403": {
  8913. "$ref": "#/responses/forbidden"
  8914. },
  8915. "404": {
  8916. "$ref": "#/responses/notFound"
  8917. }
  8918. }
  8919. }
  8920. },
  8921. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  8922. "delete": {
  8923. "produces": [
  8924. "application/json"
  8925. ],
  8926. "tags": [
  8927. "issue"
  8928. ],
  8929. "summary": "Remove a label from an issue",
  8930. "operationId": "issueRemoveLabel",
  8931. "parameters": [
  8932. {
  8933. "type": "string",
  8934. "description": "owner of the repo",
  8935. "name": "owner",
  8936. "in": "path",
  8937. "required": true
  8938. },
  8939. {
  8940. "type": "string",
  8941. "description": "name of the repo",
  8942. "name": "repo",
  8943. "in": "path",
  8944. "required": true
  8945. },
  8946. {
  8947. "type": "integer",
  8948. "format": "int64",
  8949. "description": "index of the issue",
  8950. "name": "index",
  8951. "in": "path",
  8952. "required": true
  8953. },
  8954. {
  8955. "type": "integer",
  8956. "format": "int64",
  8957. "description": "id of the label to remove",
  8958. "name": "id",
  8959. "in": "path",
  8960. "required": true
  8961. }
  8962. ],
  8963. "responses": {
  8964. "204": {
  8965. "$ref": "#/responses/empty"
  8966. },
  8967. "403": {
  8968. "$ref": "#/responses/forbidden"
  8969. },
  8970. "404": {
  8971. "$ref": "#/responses/notFound"
  8972. },
  8973. "422": {
  8974. "$ref": "#/responses/validationError"
  8975. }
  8976. }
  8977. }
  8978. },
  8979. "/repos/{owner}/{repo}/issues/{index}/pin": {
  8980. "post": {
  8981. "tags": [
  8982. "issue"
  8983. ],
  8984. "summary": "Pin an Issue",
  8985. "operationId": "pinIssue",
  8986. "parameters": [
  8987. {
  8988. "type": "string",
  8989. "description": "owner of the repo",
  8990. "name": "owner",
  8991. "in": "path",
  8992. "required": true
  8993. },
  8994. {
  8995. "type": "string",
  8996. "description": "name of the repo",
  8997. "name": "repo",
  8998. "in": "path",
  8999. "required": true
  9000. },
  9001. {
  9002. "type": "integer",
  9003. "format": "int64",
  9004. "description": "index of issue to pin",
  9005. "name": "index",
  9006. "in": "path",
  9007. "required": true
  9008. }
  9009. ],
  9010. "responses": {
  9011. "204": {
  9012. "$ref": "#/responses/empty"
  9013. },
  9014. "403": {
  9015. "$ref": "#/responses/forbidden"
  9016. },
  9017. "404": {
  9018. "$ref": "#/responses/notFound"
  9019. }
  9020. }
  9021. },
  9022. "delete": {
  9023. "tags": [
  9024. "issue"
  9025. ],
  9026. "summary": "Unpin an Issue",
  9027. "operationId": "unpinIssue",
  9028. "parameters": [
  9029. {
  9030. "type": "string",
  9031. "description": "owner of the repo",
  9032. "name": "owner",
  9033. "in": "path",
  9034. "required": true
  9035. },
  9036. {
  9037. "type": "string",
  9038. "description": "name of the repo",
  9039. "name": "repo",
  9040. "in": "path",
  9041. "required": true
  9042. },
  9043. {
  9044. "type": "integer",
  9045. "format": "int64",
  9046. "description": "index of issue to unpin",
  9047. "name": "index",
  9048. "in": "path",
  9049. "required": true
  9050. }
  9051. ],
  9052. "responses": {
  9053. "204": {
  9054. "$ref": "#/responses/empty"
  9055. },
  9056. "403": {
  9057. "$ref": "#/responses/forbidden"
  9058. },
  9059. "404": {
  9060. "$ref": "#/responses/notFound"
  9061. }
  9062. }
  9063. }
  9064. },
  9065. "/repos/{owner}/{repo}/issues/{index}/pin/{position}": {
  9066. "patch": {
  9067. "tags": [
  9068. "issue"
  9069. ],
  9070. "summary": "Moves the Pin to the given Position",
  9071. "operationId": "moveIssuePin",
  9072. "parameters": [
  9073. {
  9074. "type": "string",
  9075. "description": "owner of the repo",
  9076. "name": "owner",
  9077. "in": "path",
  9078. "required": true
  9079. },
  9080. {
  9081. "type": "string",
  9082. "description": "name of the repo",
  9083. "name": "repo",
  9084. "in": "path",
  9085. "required": true
  9086. },
  9087. {
  9088. "type": "integer",
  9089. "format": "int64",
  9090. "description": "index of issue",
  9091. "name": "index",
  9092. "in": "path",
  9093. "required": true
  9094. },
  9095. {
  9096. "type": "integer",
  9097. "format": "int64",
  9098. "description": "the new position",
  9099. "name": "position",
  9100. "in": "path",
  9101. "required": true
  9102. }
  9103. ],
  9104. "responses": {
  9105. "204": {
  9106. "$ref": "#/responses/empty"
  9107. },
  9108. "403": {
  9109. "$ref": "#/responses/forbidden"
  9110. },
  9111. "404": {
  9112. "$ref": "#/responses/notFound"
  9113. }
  9114. }
  9115. }
  9116. },
  9117. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  9118. "get": {
  9119. "consumes": [
  9120. "application/json"
  9121. ],
  9122. "produces": [
  9123. "application/json"
  9124. ],
  9125. "tags": [
  9126. "issue"
  9127. ],
  9128. "summary": "Get a list reactions of an issue",
  9129. "operationId": "issueGetIssueReactions",
  9130. "parameters": [
  9131. {
  9132. "type": "string",
  9133. "description": "owner of the repo",
  9134. "name": "owner",
  9135. "in": "path",
  9136. "required": true
  9137. },
  9138. {
  9139. "type": "string",
  9140. "description": "name of the repo",
  9141. "name": "repo",
  9142. "in": "path",
  9143. "required": true
  9144. },
  9145. {
  9146. "type": "integer",
  9147. "format": "int64",
  9148. "description": "index of the issue",
  9149. "name": "index",
  9150. "in": "path",
  9151. "required": true
  9152. },
  9153. {
  9154. "type": "integer",
  9155. "description": "page number of results to return (1-based)",
  9156. "name": "page",
  9157. "in": "query"
  9158. },
  9159. {
  9160. "type": "integer",
  9161. "description": "page size of results",
  9162. "name": "limit",
  9163. "in": "query"
  9164. }
  9165. ],
  9166. "responses": {
  9167. "200": {
  9168. "$ref": "#/responses/ReactionList"
  9169. },
  9170. "403": {
  9171. "$ref": "#/responses/forbidden"
  9172. },
  9173. "404": {
  9174. "$ref": "#/responses/notFound"
  9175. }
  9176. }
  9177. },
  9178. "post": {
  9179. "consumes": [
  9180. "application/json"
  9181. ],
  9182. "produces": [
  9183. "application/json"
  9184. ],
  9185. "tags": [
  9186. "issue"
  9187. ],
  9188. "summary": "Add a reaction to an issue",
  9189. "operationId": "issuePostIssueReaction",
  9190. "parameters": [
  9191. {
  9192. "type": "string",
  9193. "description": "owner of the repo",
  9194. "name": "owner",
  9195. "in": "path",
  9196. "required": true
  9197. },
  9198. {
  9199. "type": "string",
  9200. "description": "name of the repo",
  9201. "name": "repo",
  9202. "in": "path",
  9203. "required": true
  9204. },
  9205. {
  9206. "type": "integer",
  9207. "format": "int64",
  9208. "description": "index of the issue",
  9209. "name": "index",
  9210. "in": "path",
  9211. "required": true
  9212. },
  9213. {
  9214. "name": "content",
  9215. "in": "body",
  9216. "schema": {
  9217. "$ref": "#/definitions/EditReactionOption"
  9218. }
  9219. }
  9220. ],
  9221. "responses": {
  9222. "200": {
  9223. "$ref": "#/responses/Reaction"
  9224. },
  9225. "201": {
  9226. "$ref": "#/responses/Reaction"
  9227. },
  9228. "403": {
  9229. "$ref": "#/responses/forbidden"
  9230. },
  9231. "404": {
  9232. "$ref": "#/responses/notFound"
  9233. }
  9234. }
  9235. },
  9236. "delete": {
  9237. "consumes": [
  9238. "application/json"
  9239. ],
  9240. "produces": [
  9241. "application/json"
  9242. ],
  9243. "tags": [
  9244. "issue"
  9245. ],
  9246. "summary": "Remove a reaction from an issue",
  9247. "operationId": "issueDeleteIssueReaction",
  9248. "parameters": [
  9249. {
  9250. "type": "string",
  9251. "description": "owner of the repo",
  9252. "name": "owner",
  9253. "in": "path",
  9254. "required": true
  9255. },
  9256. {
  9257. "type": "string",
  9258. "description": "name of the repo",
  9259. "name": "repo",
  9260. "in": "path",
  9261. "required": true
  9262. },
  9263. {
  9264. "type": "integer",
  9265. "format": "int64",
  9266. "description": "index of the issue",
  9267. "name": "index",
  9268. "in": "path",
  9269. "required": true
  9270. },
  9271. {
  9272. "name": "content",
  9273. "in": "body",
  9274. "schema": {
  9275. "$ref": "#/definitions/EditReactionOption"
  9276. }
  9277. }
  9278. ],
  9279. "responses": {
  9280. "200": {
  9281. "$ref": "#/responses/empty"
  9282. },
  9283. "403": {
  9284. "$ref": "#/responses/forbidden"
  9285. },
  9286. "404": {
  9287. "$ref": "#/responses/notFound"
  9288. }
  9289. }
  9290. }
  9291. },
  9292. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  9293. "delete": {
  9294. "consumes": [
  9295. "application/json"
  9296. ],
  9297. "produces": [
  9298. "application/json"
  9299. ],
  9300. "tags": [
  9301. "issue"
  9302. ],
  9303. "summary": "Delete an issue's existing stopwatch.",
  9304. "operationId": "issueDeleteStopWatch",
  9305. "parameters": [
  9306. {
  9307. "type": "string",
  9308. "description": "owner of the repo",
  9309. "name": "owner",
  9310. "in": "path",
  9311. "required": true
  9312. },
  9313. {
  9314. "type": "string",
  9315. "description": "name of the repo",
  9316. "name": "repo",
  9317. "in": "path",
  9318. "required": true
  9319. },
  9320. {
  9321. "type": "integer",
  9322. "format": "int64",
  9323. "description": "index of the issue to stop the stopwatch on",
  9324. "name": "index",
  9325. "in": "path",
  9326. "required": true
  9327. }
  9328. ],
  9329. "responses": {
  9330. "204": {
  9331. "$ref": "#/responses/empty"
  9332. },
  9333. "403": {
  9334. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  9335. },
  9336. "404": {
  9337. "$ref": "#/responses/notFound"
  9338. },
  9339. "409": {
  9340. "description": "Cannot cancel a non existent stopwatch"
  9341. }
  9342. }
  9343. }
  9344. },
  9345. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  9346. "post": {
  9347. "consumes": [
  9348. "application/json"
  9349. ],
  9350. "produces": [
  9351. "application/json"
  9352. ],
  9353. "tags": [
  9354. "issue"
  9355. ],
  9356. "summary": "Start stopwatch on an issue.",
  9357. "operationId": "issueStartStopWatch",
  9358. "parameters": [
  9359. {
  9360. "type": "string",
  9361. "description": "owner of the repo",
  9362. "name": "owner",
  9363. "in": "path",
  9364. "required": true
  9365. },
  9366. {
  9367. "type": "string",
  9368. "description": "name of the repo",
  9369. "name": "repo",
  9370. "in": "path",
  9371. "required": true
  9372. },
  9373. {
  9374. "type": "integer",
  9375. "format": "int64",
  9376. "description": "index of the issue to create the stopwatch on",
  9377. "name": "index",
  9378. "in": "path",
  9379. "required": true
  9380. }
  9381. ],
  9382. "responses": {
  9383. "201": {
  9384. "$ref": "#/responses/empty"
  9385. },
  9386. "403": {
  9387. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  9388. },
  9389. "404": {
  9390. "$ref": "#/responses/notFound"
  9391. },
  9392. "409": {
  9393. "description": "Cannot start a stopwatch again if it already exists"
  9394. }
  9395. }
  9396. }
  9397. },
  9398. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  9399. "post": {
  9400. "consumes": [
  9401. "application/json"
  9402. ],
  9403. "produces": [
  9404. "application/json"
  9405. ],
  9406. "tags": [
  9407. "issue"
  9408. ],
  9409. "summary": "Stop an issue's existing stopwatch.",
  9410. "operationId": "issueStopStopWatch",
  9411. "parameters": [
  9412. {
  9413. "type": "string",
  9414. "description": "owner of the repo",
  9415. "name": "owner",
  9416. "in": "path",
  9417. "required": true
  9418. },
  9419. {
  9420. "type": "string",
  9421. "description": "name of the repo",
  9422. "name": "repo",
  9423. "in": "path",
  9424. "required": true
  9425. },
  9426. {
  9427. "type": "integer",
  9428. "format": "int64",
  9429. "description": "index of the issue to stop the stopwatch on",
  9430. "name": "index",
  9431. "in": "path",
  9432. "required": true
  9433. }
  9434. ],
  9435. "responses": {
  9436. "201": {
  9437. "$ref": "#/responses/empty"
  9438. },
  9439. "403": {
  9440. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  9441. },
  9442. "404": {
  9443. "$ref": "#/responses/notFound"
  9444. },
  9445. "409": {
  9446. "description": "Cannot stop a non existent stopwatch"
  9447. }
  9448. }
  9449. }
  9450. },
  9451. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  9452. "get": {
  9453. "consumes": [
  9454. "application/json"
  9455. ],
  9456. "produces": [
  9457. "application/json"
  9458. ],
  9459. "tags": [
  9460. "issue"
  9461. ],
  9462. "summary": "Get users who subscribed on an issue.",
  9463. "operationId": "issueSubscriptions",
  9464. "parameters": [
  9465. {
  9466. "type": "string",
  9467. "description": "owner of the repo",
  9468. "name": "owner",
  9469. "in": "path",
  9470. "required": true
  9471. },
  9472. {
  9473. "type": "string",
  9474. "description": "name of the repo",
  9475. "name": "repo",
  9476. "in": "path",
  9477. "required": true
  9478. },
  9479. {
  9480. "type": "integer",
  9481. "format": "int64",
  9482. "description": "index of the issue",
  9483. "name": "index",
  9484. "in": "path",
  9485. "required": true
  9486. },
  9487. {
  9488. "type": "integer",
  9489. "description": "page number of results to return (1-based)",
  9490. "name": "page",
  9491. "in": "query"
  9492. },
  9493. {
  9494. "type": "integer",
  9495. "description": "page size of results",
  9496. "name": "limit",
  9497. "in": "query"
  9498. }
  9499. ],
  9500. "responses": {
  9501. "200": {
  9502. "$ref": "#/responses/UserList"
  9503. },
  9504. "404": {
  9505. "$ref": "#/responses/notFound"
  9506. }
  9507. }
  9508. }
  9509. },
  9510. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  9511. "get": {
  9512. "consumes": [
  9513. "application/json"
  9514. ],
  9515. "produces": [
  9516. "application/json"
  9517. ],
  9518. "tags": [
  9519. "issue"
  9520. ],
  9521. "summary": "Check if user is subscribed to an issue",
  9522. "operationId": "issueCheckSubscription",
  9523. "parameters": [
  9524. {
  9525. "type": "string",
  9526. "description": "owner of the repo",
  9527. "name": "owner",
  9528. "in": "path",
  9529. "required": true
  9530. },
  9531. {
  9532. "type": "string",
  9533. "description": "name of the repo",
  9534. "name": "repo",
  9535. "in": "path",
  9536. "required": true
  9537. },
  9538. {
  9539. "type": "integer",
  9540. "format": "int64",
  9541. "description": "index of the issue",
  9542. "name": "index",
  9543. "in": "path",
  9544. "required": true
  9545. }
  9546. ],
  9547. "responses": {
  9548. "200": {
  9549. "$ref": "#/responses/WatchInfo"
  9550. },
  9551. "404": {
  9552. "$ref": "#/responses/notFound"
  9553. }
  9554. }
  9555. }
  9556. },
  9557. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  9558. "put": {
  9559. "consumes": [
  9560. "application/json"
  9561. ],
  9562. "produces": [
  9563. "application/json"
  9564. ],
  9565. "tags": [
  9566. "issue"
  9567. ],
  9568. "summary": "Subscribe user to issue",
  9569. "operationId": "issueAddSubscription",
  9570. "parameters": [
  9571. {
  9572. "type": "string",
  9573. "description": "owner of the repo",
  9574. "name": "owner",
  9575. "in": "path",
  9576. "required": true
  9577. },
  9578. {
  9579. "type": "string",
  9580. "description": "name of the repo",
  9581. "name": "repo",
  9582. "in": "path",
  9583. "required": true
  9584. },
  9585. {
  9586. "type": "integer",
  9587. "format": "int64",
  9588. "description": "index of the issue",
  9589. "name": "index",
  9590. "in": "path",
  9591. "required": true
  9592. },
  9593. {
  9594. "type": "string",
  9595. "description": "user to subscribe",
  9596. "name": "user",
  9597. "in": "path",
  9598. "required": true
  9599. }
  9600. ],
  9601. "responses": {
  9602. "200": {
  9603. "description": "Already subscribed"
  9604. },
  9605. "201": {
  9606. "description": "Successfully Subscribed"
  9607. },
  9608. "304": {
  9609. "description": "User can only subscribe itself if he is no admin"
  9610. },
  9611. "404": {
  9612. "$ref": "#/responses/notFound"
  9613. }
  9614. }
  9615. },
  9616. "delete": {
  9617. "consumes": [
  9618. "application/json"
  9619. ],
  9620. "produces": [
  9621. "application/json"
  9622. ],
  9623. "tags": [
  9624. "issue"
  9625. ],
  9626. "summary": "Unsubscribe user from issue",
  9627. "operationId": "issueDeleteSubscription",
  9628. "parameters": [
  9629. {
  9630. "type": "string",
  9631. "description": "owner of the repo",
  9632. "name": "owner",
  9633. "in": "path",
  9634. "required": true
  9635. },
  9636. {
  9637. "type": "string",
  9638. "description": "name of the repo",
  9639. "name": "repo",
  9640. "in": "path",
  9641. "required": true
  9642. },
  9643. {
  9644. "type": "integer",
  9645. "format": "int64",
  9646. "description": "index of the issue",
  9647. "name": "index",
  9648. "in": "path",
  9649. "required": true
  9650. },
  9651. {
  9652. "type": "string",
  9653. "description": "user witch unsubscribe",
  9654. "name": "user",
  9655. "in": "path",
  9656. "required": true
  9657. }
  9658. ],
  9659. "responses": {
  9660. "200": {
  9661. "description": "Already unsubscribed"
  9662. },
  9663. "201": {
  9664. "description": "Successfully Unsubscribed"
  9665. },
  9666. "304": {
  9667. "description": "User can only subscribe itself if he is no admin"
  9668. },
  9669. "404": {
  9670. "$ref": "#/responses/notFound"
  9671. }
  9672. }
  9673. }
  9674. },
  9675. "/repos/{owner}/{repo}/issues/{index}/timeline": {
  9676. "get": {
  9677. "produces": [
  9678. "application/json"
  9679. ],
  9680. "tags": [
  9681. "issue"
  9682. ],
  9683. "summary": "List all comments and events on an issue",
  9684. "operationId": "issueGetCommentsAndTimeline",
  9685. "parameters": [
  9686. {
  9687. "type": "string",
  9688. "description": "owner of the repo",
  9689. "name": "owner",
  9690. "in": "path",
  9691. "required": true
  9692. },
  9693. {
  9694. "type": "string",
  9695. "description": "name of the repo",
  9696. "name": "repo",
  9697. "in": "path",
  9698. "required": true
  9699. },
  9700. {
  9701. "type": "integer",
  9702. "format": "int64",
  9703. "description": "index of the issue",
  9704. "name": "index",
  9705. "in": "path",
  9706. "required": true
  9707. },
  9708. {
  9709. "type": "string",
  9710. "format": "date-time",
  9711. "description": "if provided, only comments updated since the specified time are returned.",
  9712. "name": "since",
  9713. "in": "query"
  9714. },
  9715. {
  9716. "type": "integer",
  9717. "description": "page number of results to return (1-based)",
  9718. "name": "page",
  9719. "in": "query"
  9720. },
  9721. {
  9722. "type": "integer",
  9723. "description": "page size of results",
  9724. "name": "limit",
  9725. "in": "query"
  9726. },
  9727. {
  9728. "type": "string",
  9729. "format": "date-time",
  9730. "description": "if provided, only comments updated before the provided time are returned.",
  9731. "name": "before",
  9732. "in": "query"
  9733. }
  9734. ],
  9735. "responses": {
  9736. "200": {
  9737. "$ref": "#/responses/TimelineList"
  9738. },
  9739. "404": {
  9740. "$ref": "#/responses/notFound"
  9741. }
  9742. }
  9743. }
  9744. },
  9745. "/repos/{owner}/{repo}/issues/{index}/times": {
  9746. "get": {
  9747. "produces": [
  9748. "application/json"
  9749. ],
  9750. "tags": [
  9751. "issue"
  9752. ],
  9753. "summary": "List an issue's tracked times",
  9754. "operationId": "issueTrackedTimes",
  9755. "parameters": [
  9756. {
  9757. "type": "string",
  9758. "description": "owner of the repo",
  9759. "name": "owner",
  9760. "in": "path",
  9761. "required": true
  9762. },
  9763. {
  9764. "type": "string",
  9765. "description": "name of the repo",
  9766. "name": "repo",
  9767. "in": "path",
  9768. "required": true
  9769. },
  9770. {
  9771. "type": "integer",
  9772. "format": "int64",
  9773. "description": "index of the issue",
  9774. "name": "index",
  9775. "in": "path",
  9776. "required": true
  9777. },
  9778. {
  9779. "type": "string",
  9780. "description": "optional filter by user (available for issue managers)",
  9781. "name": "user",
  9782. "in": "query"
  9783. },
  9784. {
  9785. "type": "string",
  9786. "format": "date-time",
  9787. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9788. "name": "since",
  9789. "in": "query"
  9790. },
  9791. {
  9792. "type": "string",
  9793. "format": "date-time",
  9794. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9795. "name": "before",
  9796. "in": "query"
  9797. },
  9798. {
  9799. "type": "integer",
  9800. "description": "page number of results to return (1-based)",
  9801. "name": "page",
  9802. "in": "query"
  9803. },
  9804. {
  9805. "type": "integer",
  9806. "description": "page size of results",
  9807. "name": "limit",
  9808. "in": "query"
  9809. }
  9810. ],
  9811. "responses": {
  9812. "200": {
  9813. "$ref": "#/responses/TrackedTimeList"
  9814. },
  9815. "404": {
  9816. "$ref": "#/responses/notFound"
  9817. }
  9818. }
  9819. },
  9820. "post": {
  9821. "consumes": [
  9822. "application/json"
  9823. ],
  9824. "produces": [
  9825. "application/json"
  9826. ],
  9827. "tags": [
  9828. "issue"
  9829. ],
  9830. "summary": "Add tracked time to a issue",
  9831. "operationId": "issueAddTime",
  9832. "parameters": [
  9833. {
  9834. "type": "string",
  9835. "description": "owner of the repo",
  9836. "name": "owner",
  9837. "in": "path",
  9838. "required": true
  9839. },
  9840. {
  9841. "type": "string",
  9842. "description": "name of the repo",
  9843. "name": "repo",
  9844. "in": "path",
  9845. "required": true
  9846. },
  9847. {
  9848. "type": "integer",
  9849. "format": "int64",
  9850. "description": "index of the issue",
  9851. "name": "index",
  9852. "in": "path",
  9853. "required": true
  9854. },
  9855. {
  9856. "name": "body",
  9857. "in": "body",
  9858. "schema": {
  9859. "$ref": "#/definitions/AddTimeOption"
  9860. }
  9861. }
  9862. ],
  9863. "responses": {
  9864. "200": {
  9865. "$ref": "#/responses/TrackedTime"
  9866. },
  9867. "400": {
  9868. "$ref": "#/responses/error"
  9869. },
  9870. "403": {
  9871. "$ref": "#/responses/forbidden"
  9872. },
  9873. "404": {
  9874. "$ref": "#/responses/notFound"
  9875. }
  9876. }
  9877. },
  9878. "delete": {
  9879. "consumes": [
  9880. "application/json"
  9881. ],
  9882. "produces": [
  9883. "application/json"
  9884. ],
  9885. "tags": [
  9886. "issue"
  9887. ],
  9888. "summary": "Reset a tracked time of an issue",
  9889. "operationId": "issueResetTime",
  9890. "parameters": [
  9891. {
  9892. "type": "string",
  9893. "description": "owner of the repo",
  9894. "name": "owner",
  9895. "in": "path",
  9896. "required": true
  9897. },
  9898. {
  9899. "type": "string",
  9900. "description": "name of the repo",
  9901. "name": "repo",
  9902. "in": "path",
  9903. "required": true
  9904. },
  9905. {
  9906. "type": "integer",
  9907. "format": "int64",
  9908. "description": "index of the issue to add tracked time to",
  9909. "name": "index",
  9910. "in": "path",
  9911. "required": true
  9912. }
  9913. ],
  9914. "responses": {
  9915. "204": {
  9916. "$ref": "#/responses/empty"
  9917. },
  9918. "400": {
  9919. "$ref": "#/responses/error"
  9920. },
  9921. "403": {
  9922. "$ref": "#/responses/forbidden"
  9923. },
  9924. "404": {
  9925. "$ref": "#/responses/notFound"
  9926. }
  9927. }
  9928. }
  9929. },
  9930. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  9931. "delete": {
  9932. "consumes": [
  9933. "application/json"
  9934. ],
  9935. "produces": [
  9936. "application/json"
  9937. ],
  9938. "tags": [
  9939. "issue"
  9940. ],
  9941. "summary": "Delete specific tracked time",
  9942. "operationId": "issueDeleteTime",
  9943. "parameters": [
  9944. {
  9945. "type": "string",
  9946. "description": "owner of the repo",
  9947. "name": "owner",
  9948. "in": "path",
  9949. "required": true
  9950. },
  9951. {
  9952. "type": "string",
  9953. "description": "name of the repo",
  9954. "name": "repo",
  9955. "in": "path",
  9956. "required": true
  9957. },
  9958. {
  9959. "type": "integer",
  9960. "format": "int64",
  9961. "description": "index of the issue",
  9962. "name": "index",
  9963. "in": "path",
  9964. "required": true
  9965. },
  9966. {
  9967. "type": "integer",
  9968. "format": "int64",
  9969. "description": "id of time to delete",
  9970. "name": "id",
  9971. "in": "path",
  9972. "required": true
  9973. }
  9974. ],
  9975. "responses": {
  9976. "204": {
  9977. "$ref": "#/responses/empty"
  9978. },
  9979. "400": {
  9980. "$ref": "#/responses/error"
  9981. },
  9982. "403": {
  9983. "$ref": "#/responses/forbidden"
  9984. },
  9985. "404": {
  9986. "$ref": "#/responses/notFound"
  9987. }
  9988. }
  9989. }
  9990. },
  9991. "/repos/{owner}/{repo}/keys": {
  9992. "get": {
  9993. "produces": [
  9994. "application/json"
  9995. ],
  9996. "tags": [
  9997. "repository"
  9998. ],
  9999. "summary": "List a repository's keys",
  10000. "operationId": "repoListKeys",
  10001. "parameters": [
  10002. {
  10003. "type": "string",
  10004. "description": "owner of the repo",
  10005. "name": "owner",
  10006. "in": "path",
  10007. "required": true
  10008. },
  10009. {
  10010. "type": "string",
  10011. "description": "name of the repo",
  10012. "name": "repo",
  10013. "in": "path",
  10014. "required": true
  10015. },
  10016. {
  10017. "type": "integer",
  10018. "description": "the key_id to search for",
  10019. "name": "key_id",
  10020. "in": "query"
  10021. },
  10022. {
  10023. "type": "string",
  10024. "description": "fingerprint of the key",
  10025. "name": "fingerprint",
  10026. "in": "query"
  10027. },
  10028. {
  10029. "type": "integer",
  10030. "description": "page number of results to return (1-based)",
  10031. "name": "page",
  10032. "in": "query"
  10033. },
  10034. {
  10035. "type": "integer",
  10036. "description": "page size of results",
  10037. "name": "limit",
  10038. "in": "query"
  10039. }
  10040. ],
  10041. "responses": {
  10042. "200": {
  10043. "$ref": "#/responses/DeployKeyList"
  10044. },
  10045. "404": {
  10046. "$ref": "#/responses/notFound"
  10047. }
  10048. }
  10049. },
  10050. "post": {
  10051. "consumes": [
  10052. "application/json"
  10053. ],
  10054. "produces": [
  10055. "application/json"
  10056. ],
  10057. "tags": [
  10058. "repository"
  10059. ],
  10060. "summary": "Add a key to a repository",
  10061. "operationId": "repoCreateKey",
  10062. "parameters": [
  10063. {
  10064. "type": "string",
  10065. "description": "owner of the repo",
  10066. "name": "owner",
  10067. "in": "path",
  10068. "required": true
  10069. },
  10070. {
  10071. "type": "string",
  10072. "description": "name of the repo",
  10073. "name": "repo",
  10074. "in": "path",
  10075. "required": true
  10076. },
  10077. {
  10078. "name": "body",
  10079. "in": "body",
  10080. "schema": {
  10081. "$ref": "#/definitions/CreateKeyOption"
  10082. }
  10083. }
  10084. ],
  10085. "responses": {
  10086. "201": {
  10087. "$ref": "#/responses/DeployKey"
  10088. },
  10089. "404": {
  10090. "$ref": "#/responses/notFound"
  10091. },
  10092. "422": {
  10093. "$ref": "#/responses/validationError"
  10094. }
  10095. }
  10096. }
  10097. },
  10098. "/repos/{owner}/{repo}/keys/{id}": {
  10099. "get": {
  10100. "produces": [
  10101. "application/json"
  10102. ],
  10103. "tags": [
  10104. "repository"
  10105. ],
  10106. "summary": "Get a repository's key by id",
  10107. "operationId": "repoGetKey",
  10108. "parameters": [
  10109. {
  10110. "type": "string",
  10111. "description": "owner of the repo",
  10112. "name": "owner",
  10113. "in": "path",
  10114. "required": true
  10115. },
  10116. {
  10117. "type": "string",
  10118. "description": "name of the repo",
  10119. "name": "repo",
  10120. "in": "path",
  10121. "required": true
  10122. },
  10123. {
  10124. "type": "integer",
  10125. "format": "int64",
  10126. "description": "id of the key to get",
  10127. "name": "id",
  10128. "in": "path",
  10129. "required": true
  10130. }
  10131. ],
  10132. "responses": {
  10133. "200": {
  10134. "$ref": "#/responses/DeployKey"
  10135. },
  10136. "404": {
  10137. "$ref": "#/responses/notFound"
  10138. }
  10139. }
  10140. },
  10141. "delete": {
  10142. "tags": [
  10143. "repository"
  10144. ],
  10145. "summary": "Delete a key from a repository",
  10146. "operationId": "repoDeleteKey",
  10147. "parameters": [
  10148. {
  10149. "type": "string",
  10150. "description": "owner of the repo",
  10151. "name": "owner",
  10152. "in": "path",
  10153. "required": true
  10154. },
  10155. {
  10156. "type": "string",
  10157. "description": "name of the repo",
  10158. "name": "repo",
  10159. "in": "path",
  10160. "required": true
  10161. },
  10162. {
  10163. "type": "integer",
  10164. "format": "int64",
  10165. "description": "id of the key to delete",
  10166. "name": "id",
  10167. "in": "path",
  10168. "required": true
  10169. }
  10170. ],
  10171. "responses": {
  10172. "204": {
  10173. "$ref": "#/responses/empty"
  10174. },
  10175. "403": {
  10176. "$ref": "#/responses/forbidden"
  10177. },
  10178. "404": {
  10179. "$ref": "#/responses/notFound"
  10180. }
  10181. }
  10182. }
  10183. },
  10184. "/repos/{owner}/{repo}/labels": {
  10185. "get": {
  10186. "produces": [
  10187. "application/json"
  10188. ],
  10189. "tags": [
  10190. "issue"
  10191. ],
  10192. "summary": "Get all of a repository's labels",
  10193. "operationId": "issueListLabels",
  10194. "parameters": [
  10195. {
  10196. "type": "string",
  10197. "description": "owner of the repo",
  10198. "name": "owner",
  10199. "in": "path",
  10200. "required": true
  10201. },
  10202. {
  10203. "type": "string",
  10204. "description": "name of the repo",
  10205. "name": "repo",
  10206. "in": "path",
  10207. "required": true
  10208. },
  10209. {
  10210. "type": "integer",
  10211. "description": "page number of results to return (1-based)",
  10212. "name": "page",
  10213. "in": "query"
  10214. },
  10215. {
  10216. "type": "integer",
  10217. "description": "page size of results",
  10218. "name": "limit",
  10219. "in": "query"
  10220. }
  10221. ],
  10222. "responses": {
  10223. "200": {
  10224. "$ref": "#/responses/LabelList"
  10225. },
  10226. "404": {
  10227. "$ref": "#/responses/notFound"
  10228. }
  10229. }
  10230. },
  10231. "post": {
  10232. "consumes": [
  10233. "application/json"
  10234. ],
  10235. "produces": [
  10236. "application/json"
  10237. ],
  10238. "tags": [
  10239. "issue"
  10240. ],
  10241. "summary": "Create a label",
  10242. "operationId": "issueCreateLabel",
  10243. "parameters": [
  10244. {
  10245. "type": "string",
  10246. "description": "owner of the repo",
  10247. "name": "owner",
  10248. "in": "path",
  10249. "required": true
  10250. },
  10251. {
  10252. "type": "string",
  10253. "description": "name of the repo",
  10254. "name": "repo",
  10255. "in": "path",
  10256. "required": true
  10257. },
  10258. {
  10259. "name": "body",
  10260. "in": "body",
  10261. "schema": {
  10262. "$ref": "#/definitions/CreateLabelOption"
  10263. }
  10264. }
  10265. ],
  10266. "responses": {
  10267. "201": {
  10268. "$ref": "#/responses/Label"
  10269. },
  10270. "404": {
  10271. "$ref": "#/responses/notFound"
  10272. },
  10273. "422": {
  10274. "$ref": "#/responses/validationError"
  10275. }
  10276. }
  10277. }
  10278. },
  10279. "/repos/{owner}/{repo}/labels/{id}": {
  10280. "get": {
  10281. "produces": [
  10282. "application/json"
  10283. ],
  10284. "tags": [
  10285. "issue"
  10286. ],
  10287. "summary": "Get a single label",
  10288. "operationId": "issueGetLabel",
  10289. "parameters": [
  10290. {
  10291. "type": "string",
  10292. "description": "owner of the repo",
  10293. "name": "owner",
  10294. "in": "path",
  10295. "required": true
  10296. },
  10297. {
  10298. "type": "string",
  10299. "description": "name of the repo",
  10300. "name": "repo",
  10301. "in": "path",
  10302. "required": true
  10303. },
  10304. {
  10305. "type": "integer",
  10306. "format": "int64",
  10307. "description": "id of the label to get",
  10308. "name": "id",
  10309. "in": "path",
  10310. "required": true
  10311. }
  10312. ],
  10313. "responses": {
  10314. "200": {
  10315. "$ref": "#/responses/Label"
  10316. },
  10317. "404": {
  10318. "$ref": "#/responses/notFound"
  10319. }
  10320. }
  10321. },
  10322. "delete": {
  10323. "tags": [
  10324. "issue"
  10325. ],
  10326. "summary": "Delete a label",
  10327. "operationId": "issueDeleteLabel",
  10328. "parameters": [
  10329. {
  10330. "type": "string",
  10331. "description": "owner of the repo",
  10332. "name": "owner",
  10333. "in": "path",
  10334. "required": true
  10335. },
  10336. {
  10337. "type": "string",
  10338. "description": "name of the repo",
  10339. "name": "repo",
  10340. "in": "path",
  10341. "required": true
  10342. },
  10343. {
  10344. "type": "integer",
  10345. "format": "int64",
  10346. "description": "id of the label to delete",
  10347. "name": "id",
  10348. "in": "path",
  10349. "required": true
  10350. }
  10351. ],
  10352. "responses": {
  10353. "204": {
  10354. "$ref": "#/responses/empty"
  10355. },
  10356. "404": {
  10357. "$ref": "#/responses/notFound"
  10358. }
  10359. }
  10360. },
  10361. "patch": {
  10362. "consumes": [
  10363. "application/json"
  10364. ],
  10365. "produces": [
  10366. "application/json"
  10367. ],
  10368. "tags": [
  10369. "issue"
  10370. ],
  10371. "summary": "Update a label",
  10372. "operationId": "issueEditLabel",
  10373. "parameters": [
  10374. {
  10375. "type": "string",
  10376. "description": "owner of the repo",
  10377. "name": "owner",
  10378. "in": "path",
  10379. "required": true
  10380. },
  10381. {
  10382. "type": "string",
  10383. "description": "name of the repo",
  10384. "name": "repo",
  10385. "in": "path",
  10386. "required": true
  10387. },
  10388. {
  10389. "type": "integer",
  10390. "format": "int64",
  10391. "description": "id of the label to edit",
  10392. "name": "id",
  10393. "in": "path",
  10394. "required": true
  10395. },
  10396. {
  10397. "name": "body",
  10398. "in": "body",
  10399. "schema": {
  10400. "$ref": "#/definitions/EditLabelOption"
  10401. }
  10402. }
  10403. ],
  10404. "responses": {
  10405. "200": {
  10406. "$ref": "#/responses/Label"
  10407. },
  10408. "404": {
  10409. "$ref": "#/responses/notFound"
  10410. },
  10411. "422": {
  10412. "$ref": "#/responses/validationError"
  10413. }
  10414. }
  10415. }
  10416. },
  10417. "/repos/{owner}/{repo}/languages": {
  10418. "get": {
  10419. "produces": [
  10420. "application/json"
  10421. ],
  10422. "tags": [
  10423. "repository"
  10424. ],
  10425. "summary": "Get languages and number of bytes of code written",
  10426. "operationId": "repoGetLanguages",
  10427. "parameters": [
  10428. {
  10429. "type": "string",
  10430. "description": "owner of the repo",
  10431. "name": "owner",
  10432. "in": "path",
  10433. "required": true
  10434. },
  10435. {
  10436. "type": "string",
  10437. "description": "name of the repo",
  10438. "name": "repo",
  10439. "in": "path",
  10440. "required": true
  10441. }
  10442. ],
  10443. "responses": {
  10444. "200": {
  10445. "$ref": "#/responses/LanguageStatistics"
  10446. },
  10447. "404": {
  10448. "$ref": "#/responses/notFound"
  10449. }
  10450. }
  10451. }
  10452. },
  10453. "/repos/{owner}/{repo}/media/{filepath}": {
  10454. "get": {
  10455. "tags": [
  10456. "repository"
  10457. ],
  10458. "summary": "Get a file or it's LFS object from a repository",
  10459. "operationId": "repoGetRawFileOrLFS",
  10460. "parameters": [
  10461. {
  10462. "type": "string",
  10463. "description": "owner of the repo",
  10464. "name": "owner",
  10465. "in": "path",
  10466. "required": true
  10467. },
  10468. {
  10469. "type": "string",
  10470. "description": "name of the repo",
  10471. "name": "repo",
  10472. "in": "path",
  10473. "required": true
  10474. },
  10475. {
  10476. "type": "string",
  10477. "description": "filepath of the file to get",
  10478. "name": "filepath",
  10479. "in": "path",
  10480. "required": true
  10481. },
  10482. {
  10483. "type": "string",
  10484. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  10485. "name": "ref",
  10486. "in": "query"
  10487. }
  10488. ],
  10489. "responses": {
  10490. "200": {
  10491. "description": "Returns raw file content."
  10492. },
  10493. "404": {
  10494. "$ref": "#/responses/notFound"
  10495. }
  10496. }
  10497. }
  10498. },
  10499. "/repos/{owner}/{repo}/milestones": {
  10500. "get": {
  10501. "produces": [
  10502. "application/json"
  10503. ],
  10504. "tags": [
  10505. "issue"
  10506. ],
  10507. "summary": "Get all of a repository's opened milestones",
  10508. "operationId": "issueGetMilestonesList",
  10509. "parameters": [
  10510. {
  10511. "type": "string",
  10512. "description": "owner of the repo",
  10513. "name": "owner",
  10514. "in": "path",
  10515. "required": true
  10516. },
  10517. {
  10518. "type": "string",
  10519. "description": "name of the repo",
  10520. "name": "repo",
  10521. "in": "path",
  10522. "required": true
  10523. },
  10524. {
  10525. "type": "string",
  10526. "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
  10527. "name": "state",
  10528. "in": "query"
  10529. },
  10530. {
  10531. "type": "string",
  10532. "description": "filter by milestone name",
  10533. "name": "name",
  10534. "in": "query"
  10535. },
  10536. {
  10537. "type": "integer",
  10538. "description": "page number of results to return (1-based)",
  10539. "name": "page",
  10540. "in": "query"
  10541. },
  10542. {
  10543. "type": "integer",
  10544. "description": "page size of results",
  10545. "name": "limit",
  10546. "in": "query"
  10547. }
  10548. ],
  10549. "responses": {
  10550. "200": {
  10551. "$ref": "#/responses/MilestoneList"
  10552. },
  10553. "404": {
  10554. "$ref": "#/responses/notFound"
  10555. }
  10556. }
  10557. },
  10558. "post": {
  10559. "consumes": [
  10560. "application/json"
  10561. ],
  10562. "produces": [
  10563. "application/json"
  10564. ],
  10565. "tags": [
  10566. "issue"
  10567. ],
  10568. "summary": "Create a milestone",
  10569. "operationId": "issueCreateMilestone",
  10570. "parameters": [
  10571. {
  10572. "type": "string",
  10573. "description": "owner of the repo",
  10574. "name": "owner",
  10575. "in": "path",
  10576. "required": true
  10577. },
  10578. {
  10579. "type": "string",
  10580. "description": "name of the repo",
  10581. "name": "repo",
  10582. "in": "path",
  10583. "required": true
  10584. },
  10585. {
  10586. "name": "body",
  10587. "in": "body",
  10588. "schema": {
  10589. "$ref": "#/definitions/CreateMilestoneOption"
  10590. }
  10591. }
  10592. ],
  10593. "responses": {
  10594. "201": {
  10595. "$ref": "#/responses/Milestone"
  10596. },
  10597. "404": {
  10598. "$ref": "#/responses/notFound"
  10599. }
  10600. }
  10601. }
  10602. },
  10603. "/repos/{owner}/{repo}/milestones/{id}": {
  10604. "get": {
  10605. "produces": [
  10606. "application/json"
  10607. ],
  10608. "tags": [
  10609. "issue"
  10610. ],
  10611. "summary": "Get a milestone",
  10612. "operationId": "issueGetMilestone",
  10613. "parameters": [
  10614. {
  10615. "type": "string",
  10616. "description": "owner of the repo",
  10617. "name": "owner",
  10618. "in": "path",
  10619. "required": true
  10620. },
  10621. {
  10622. "type": "string",
  10623. "description": "name of the repo",
  10624. "name": "repo",
  10625. "in": "path",
  10626. "required": true
  10627. },
  10628. {
  10629. "type": "string",
  10630. "description": "the milestone to get, identified by ID and if not available by name",
  10631. "name": "id",
  10632. "in": "path",
  10633. "required": true
  10634. }
  10635. ],
  10636. "responses": {
  10637. "200": {
  10638. "$ref": "#/responses/Milestone"
  10639. },
  10640. "404": {
  10641. "$ref": "#/responses/notFound"
  10642. }
  10643. }
  10644. },
  10645. "delete": {
  10646. "tags": [
  10647. "issue"
  10648. ],
  10649. "summary": "Delete a milestone",
  10650. "operationId": "issueDeleteMilestone",
  10651. "parameters": [
  10652. {
  10653. "type": "string",
  10654. "description": "owner of the repo",
  10655. "name": "owner",
  10656. "in": "path",
  10657. "required": true
  10658. },
  10659. {
  10660. "type": "string",
  10661. "description": "name of the repo",
  10662. "name": "repo",
  10663. "in": "path",
  10664. "required": true
  10665. },
  10666. {
  10667. "type": "string",
  10668. "description": "the milestone to delete, identified by ID and if not available by name",
  10669. "name": "id",
  10670. "in": "path",
  10671. "required": true
  10672. }
  10673. ],
  10674. "responses": {
  10675. "204": {
  10676. "$ref": "#/responses/empty"
  10677. },
  10678. "404": {
  10679. "$ref": "#/responses/notFound"
  10680. }
  10681. }
  10682. },
  10683. "patch": {
  10684. "consumes": [
  10685. "application/json"
  10686. ],
  10687. "produces": [
  10688. "application/json"
  10689. ],
  10690. "tags": [
  10691. "issue"
  10692. ],
  10693. "summary": "Update a milestone",
  10694. "operationId": "issueEditMilestone",
  10695. "parameters": [
  10696. {
  10697. "type": "string",
  10698. "description": "owner of the repo",
  10699. "name": "owner",
  10700. "in": "path",
  10701. "required": true
  10702. },
  10703. {
  10704. "type": "string",
  10705. "description": "name of the repo",
  10706. "name": "repo",
  10707. "in": "path",
  10708. "required": true
  10709. },
  10710. {
  10711. "type": "string",
  10712. "description": "the milestone to edit, identified by ID and if not available by name",
  10713. "name": "id",
  10714. "in": "path",
  10715. "required": true
  10716. },
  10717. {
  10718. "name": "body",
  10719. "in": "body",
  10720. "schema": {
  10721. "$ref": "#/definitions/EditMilestoneOption"
  10722. }
  10723. }
  10724. ],
  10725. "responses": {
  10726. "200": {
  10727. "$ref": "#/responses/Milestone"
  10728. },
  10729. "404": {
  10730. "$ref": "#/responses/notFound"
  10731. }
  10732. }
  10733. }
  10734. },
  10735. "/repos/{owner}/{repo}/mirror-sync": {
  10736. "post": {
  10737. "produces": [
  10738. "application/json"
  10739. ],
  10740. "tags": [
  10741. "repository"
  10742. ],
  10743. "summary": "Sync a mirrored repository",
  10744. "operationId": "repoMirrorSync",
  10745. "parameters": [
  10746. {
  10747. "type": "string",
  10748. "description": "owner of the repo to sync",
  10749. "name": "owner",
  10750. "in": "path",
  10751. "required": true
  10752. },
  10753. {
  10754. "type": "string",
  10755. "description": "name of the repo to sync",
  10756. "name": "repo",
  10757. "in": "path",
  10758. "required": true
  10759. }
  10760. ],
  10761. "responses": {
  10762. "200": {
  10763. "$ref": "#/responses/empty"
  10764. },
  10765. "403": {
  10766. "$ref": "#/responses/forbidden"
  10767. },
  10768. "404": {
  10769. "$ref": "#/responses/notFound"
  10770. }
  10771. }
  10772. }
  10773. },
  10774. "/repos/{owner}/{repo}/new_pin_allowed": {
  10775. "get": {
  10776. "produces": [
  10777. "application/json"
  10778. ],
  10779. "tags": [
  10780. "repository"
  10781. ],
  10782. "summary": "Returns if new Issue Pins are allowed",
  10783. "operationId": "repoNewPinAllowed",
  10784. "parameters": [
  10785. {
  10786. "type": "string",
  10787. "description": "owner of the repo",
  10788. "name": "owner",
  10789. "in": "path",
  10790. "required": true
  10791. },
  10792. {
  10793. "type": "string",
  10794. "description": "name of the repo",
  10795. "name": "repo",
  10796. "in": "path",
  10797. "required": true
  10798. }
  10799. ],
  10800. "responses": {
  10801. "200": {
  10802. "$ref": "#/responses/RepoNewIssuePinsAllowed"
  10803. },
  10804. "404": {
  10805. "$ref": "#/responses/notFound"
  10806. }
  10807. }
  10808. }
  10809. },
  10810. "/repos/{owner}/{repo}/notifications": {
  10811. "get": {
  10812. "consumes": [
  10813. "application/json"
  10814. ],
  10815. "produces": [
  10816. "application/json"
  10817. ],
  10818. "tags": [
  10819. "notification"
  10820. ],
  10821. "summary": "List users's notification threads on a specific repo",
  10822. "operationId": "notifyGetRepoList",
  10823. "parameters": [
  10824. {
  10825. "type": "string",
  10826. "description": "owner of the repo",
  10827. "name": "owner",
  10828. "in": "path",
  10829. "required": true
  10830. },
  10831. {
  10832. "type": "string",
  10833. "description": "name of the repo",
  10834. "name": "repo",
  10835. "in": "path",
  10836. "required": true
  10837. },
  10838. {
  10839. "type": "boolean",
  10840. "description": "If true, show notifications marked as read. Default value is false",
  10841. "name": "all",
  10842. "in": "query"
  10843. },
  10844. {
  10845. "type": "array",
  10846. "items": {
  10847. "type": "string"
  10848. },
  10849. "collectionFormat": "multi",
  10850. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  10851. "name": "status-types",
  10852. "in": "query"
  10853. },
  10854. {
  10855. "type": "array",
  10856. "items": {
  10857. "enum": [
  10858. "issue",
  10859. "pull",
  10860. "commit",
  10861. "repository"
  10862. ],
  10863. "type": "string"
  10864. },
  10865. "collectionFormat": "multi",
  10866. "description": "filter notifications by subject type",
  10867. "name": "subject-type",
  10868. "in": "query"
  10869. },
  10870. {
  10871. "type": "string",
  10872. "format": "date-time",
  10873. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  10874. "name": "since",
  10875. "in": "query"
  10876. },
  10877. {
  10878. "type": "string",
  10879. "format": "date-time",
  10880. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  10881. "name": "before",
  10882. "in": "query"
  10883. },
  10884. {
  10885. "type": "integer",
  10886. "description": "page number of results to return (1-based)",
  10887. "name": "page",
  10888. "in": "query"
  10889. },
  10890. {
  10891. "type": "integer",
  10892. "description": "page size of results",
  10893. "name": "limit",
  10894. "in": "query"
  10895. }
  10896. ],
  10897. "responses": {
  10898. "200": {
  10899. "$ref": "#/responses/NotificationThreadList"
  10900. }
  10901. }
  10902. },
  10903. "put": {
  10904. "consumes": [
  10905. "application/json"
  10906. ],
  10907. "produces": [
  10908. "application/json"
  10909. ],
  10910. "tags": [
  10911. "notification"
  10912. ],
  10913. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  10914. "operationId": "notifyReadRepoList",
  10915. "parameters": [
  10916. {
  10917. "type": "string",
  10918. "description": "owner of the repo",
  10919. "name": "owner",
  10920. "in": "path",
  10921. "required": true
  10922. },
  10923. {
  10924. "type": "string",
  10925. "description": "name of the repo",
  10926. "name": "repo",
  10927. "in": "path",
  10928. "required": true
  10929. },
  10930. {
  10931. "type": "string",
  10932. "description": "If true, mark all notifications on this repo. Default value is false",
  10933. "name": "all",
  10934. "in": "query"
  10935. },
  10936. {
  10937. "type": "array",
  10938. "items": {
  10939. "type": "string"
  10940. },
  10941. "collectionFormat": "multi",
  10942. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  10943. "name": "status-types",
  10944. "in": "query"
  10945. },
  10946. {
  10947. "type": "string",
  10948. "description": "Status to mark notifications as. Defaults to read.",
  10949. "name": "to-status",
  10950. "in": "query"
  10951. },
  10952. {
  10953. "type": "string",
  10954. "format": "date-time",
  10955. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  10956. "name": "last_read_at",
  10957. "in": "query"
  10958. }
  10959. ],
  10960. "responses": {
  10961. "205": {
  10962. "$ref": "#/responses/NotificationThreadList"
  10963. }
  10964. }
  10965. }
  10966. },
  10967. "/repos/{owner}/{repo}/pulls": {
  10968. "get": {
  10969. "produces": [
  10970. "application/json"
  10971. ],
  10972. "tags": [
  10973. "repository"
  10974. ],
  10975. "summary": "List a repo's pull requests",
  10976. "operationId": "repoListPullRequests",
  10977. "parameters": [
  10978. {
  10979. "type": "string",
  10980. "description": "owner of the repo",
  10981. "name": "owner",
  10982. "in": "path",
  10983. "required": true
  10984. },
  10985. {
  10986. "type": "string",
  10987. "description": "name of the repo",
  10988. "name": "repo",
  10989. "in": "path",
  10990. "required": true
  10991. },
  10992. {
  10993. "enum": [
  10994. "closed",
  10995. "open",
  10996. "all"
  10997. ],
  10998. "type": "string",
  10999. "description": "State of pull request: open or closed (optional)",
  11000. "name": "state",
  11001. "in": "query"
  11002. },
  11003. {
  11004. "enum": [
  11005. "oldest",
  11006. "recentupdate",
  11007. "leastupdate",
  11008. "mostcomment",
  11009. "leastcomment",
  11010. "priority"
  11011. ],
  11012. "type": "string",
  11013. "description": "Type of sort",
  11014. "name": "sort",
  11015. "in": "query"
  11016. },
  11017. {
  11018. "type": "integer",
  11019. "format": "int64",
  11020. "description": "ID of the milestone",
  11021. "name": "milestone",
  11022. "in": "query"
  11023. },
  11024. {
  11025. "type": "array",
  11026. "items": {
  11027. "type": "integer",
  11028. "format": "int64"
  11029. },
  11030. "collectionFormat": "multi",
  11031. "description": "Label IDs",
  11032. "name": "labels",
  11033. "in": "query"
  11034. },
  11035. {
  11036. "type": "integer",
  11037. "description": "page number of results to return (1-based)",
  11038. "name": "page",
  11039. "in": "query"
  11040. },
  11041. {
  11042. "type": "integer",
  11043. "description": "page size of results",
  11044. "name": "limit",
  11045. "in": "query"
  11046. }
  11047. ],
  11048. "responses": {
  11049. "200": {
  11050. "$ref": "#/responses/PullRequestList"
  11051. },
  11052. "404": {
  11053. "$ref": "#/responses/notFound"
  11054. }
  11055. }
  11056. },
  11057. "post": {
  11058. "consumes": [
  11059. "application/json"
  11060. ],
  11061. "produces": [
  11062. "application/json"
  11063. ],
  11064. "tags": [
  11065. "repository"
  11066. ],
  11067. "summary": "Create a pull request",
  11068. "operationId": "repoCreatePullRequest",
  11069. "parameters": [
  11070. {
  11071. "type": "string",
  11072. "description": "owner of the repo",
  11073. "name": "owner",
  11074. "in": "path",
  11075. "required": true
  11076. },
  11077. {
  11078. "type": "string",
  11079. "description": "name of the repo",
  11080. "name": "repo",
  11081. "in": "path",
  11082. "required": true
  11083. },
  11084. {
  11085. "name": "body",
  11086. "in": "body",
  11087. "schema": {
  11088. "$ref": "#/definitions/CreatePullRequestOption"
  11089. }
  11090. }
  11091. ],
  11092. "responses": {
  11093. "201": {
  11094. "$ref": "#/responses/PullRequest"
  11095. },
  11096. "403": {
  11097. "$ref": "#/responses/forbidden"
  11098. },
  11099. "404": {
  11100. "$ref": "#/responses/notFound"
  11101. },
  11102. "409": {
  11103. "$ref": "#/responses/error"
  11104. },
  11105. "422": {
  11106. "$ref": "#/responses/validationError"
  11107. },
  11108. "423": {
  11109. "$ref": "#/responses/repoArchivedError"
  11110. }
  11111. }
  11112. }
  11113. },
  11114. "/repos/{owner}/{repo}/pulls/pinned": {
  11115. "get": {
  11116. "produces": [
  11117. "application/json"
  11118. ],
  11119. "tags": [
  11120. "repository"
  11121. ],
  11122. "summary": "List a repo's pinned pull requests",
  11123. "operationId": "repoListPinnedPullRequests",
  11124. "parameters": [
  11125. {
  11126. "type": "string",
  11127. "description": "owner of the repo",
  11128. "name": "owner",
  11129. "in": "path",
  11130. "required": true
  11131. },
  11132. {
  11133. "type": "string",
  11134. "description": "name of the repo",
  11135. "name": "repo",
  11136. "in": "path",
  11137. "required": true
  11138. }
  11139. ],
  11140. "responses": {
  11141. "200": {
  11142. "$ref": "#/responses/PullRequestList"
  11143. },
  11144. "404": {
  11145. "$ref": "#/responses/notFound"
  11146. }
  11147. }
  11148. }
  11149. },
  11150. "/repos/{owner}/{repo}/pulls/{base}/{head}": {
  11151. "get": {
  11152. "produces": [
  11153. "application/json"
  11154. ],
  11155. "tags": [
  11156. "repository"
  11157. ],
  11158. "summary": "Get a pull request by base and head",
  11159. "operationId": "repoGetPullRequestByBaseHead",
  11160. "parameters": [
  11161. {
  11162. "type": "string",
  11163. "description": "owner of the repo",
  11164. "name": "owner",
  11165. "in": "path",
  11166. "required": true
  11167. },
  11168. {
  11169. "type": "string",
  11170. "description": "name of the repo",
  11171. "name": "repo",
  11172. "in": "path",
  11173. "required": true
  11174. },
  11175. {
  11176. "type": "string",
  11177. "description": "base of the pull request to get",
  11178. "name": "base",
  11179. "in": "path",
  11180. "required": true
  11181. },
  11182. {
  11183. "type": "string",
  11184. "description": "head of the pull request to get",
  11185. "name": "head",
  11186. "in": "path",
  11187. "required": true
  11188. }
  11189. ],
  11190. "responses": {
  11191. "200": {
  11192. "$ref": "#/responses/PullRequest"
  11193. },
  11194. "404": {
  11195. "$ref": "#/responses/notFound"
  11196. }
  11197. }
  11198. }
  11199. },
  11200. "/repos/{owner}/{repo}/pulls/{index}": {
  11201. "get": {
  11202. "produces": [
  11203. "application/json"
  11204. ],
  11205. "tags": [
  11206. "repository"
  11207. ],
  11208. "summary": "Get a pull request",
  11209. "operationId": "repoGetPullRequest",
  11210. "parameters": [
  11211. {
  11212. "type": "string",
  11213. "description": "owner of the repo",
  11214. "name": "owner",
  11215. "in": "path",
  11216. "required": true
  11217. },
  11218. {
  11219. "type": "string",
  11220. "description": "name of the repo",
  11221. "name": "repo",
  11222. "in": "path",
  11223. "required": true
  11224. },
  11225. {
  11226. "type": "integer",
  11227. "format": "int64",
  11228. "description": "index of the pull request to get",
  11229. "name": "index",
  11230. "in": "path",
  11231. "required": true
  11232. }
  11233. ],
  11234. "responses": {
  11235. "200": {
  11236. "$ref": "#/responses/PullRequest"
  11237. },
  11238. "404": {
  11239. "$ref": "#/responses/notFound"
  11240. }
  11241. }
  11242. },
  11243. "patch": {
  11244. "consumes": [
  11245. "application/json"
  11246. ],
  11247. "produces": [
  11248. "application/json"
  11249. ],
  11250. "tags": [
  11251. "repository"
  11252. ],
  11253. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  11254. "operationId": "repoEditPullRequest",
  11255. "parameters": [
  11256. {
  11257. "type": "string",
  11258. "description": "owner of the repo",
  11259. "name": "owner",
  11260. "in": "path",
  11261. "required": true
  11262. },
  11263. {
  11264. "type": "string",
  11265. "description": "name of the repo",
  11266. "name": "repo",
  11267. "in": "path",
  11268. "required": true
  11269. },
  11270. {
  11271. "type": "integer",
  11272. "format": "int64",
  11273. "description": "index of the pull request to edit",
  11274. "name": "index",
  11275. "in": "path",
  11276. "required": true
  11277. },
  11278. {
  11279. "name": "body",
  11280. "in": "body",
  11281. "schema": {
  11282. "$ref": "#/definitions/EditPullRequestOption"
  11283. }
  11284. }
  11285. ],
  11286. "responses": {
  11287. "201": {
  11288. "$ref": "#/responses/PullRequest"
  11289. },
  11290. "403": {
  11291. "$ref": "#/responses/forbidden"
  11292. },
  11293. "404": {
  11294. "$ref": "#/responses/notFound"
  11295. },
  11296. "409": {
  11297. "$ref": "#/responses/error"
  11298. },
  11299. "412": {
  11300. "$ref": "#/responses/error"
  11301. },
  11302. "422": {
  11303. "$ref": "#/responses/validationError"
  11304. }
  11305. }
  11306. }
  11307. },
  11308. "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
  11309. "get": {
  11310. "produces": [
  11311. "text/plain"
  11312. ],
  11313. "tags": [
  11314. "repository"
  11315. ],
  11316. "summary": "Get a pull request diff or patch",
  11317. "operationId": "repoDownloadPullDiffOrPatch",
  11318. "parameters": [
  11319. {
  11320. "type": "string",
  11321. "description": "owner of the repo",
  11322. "name": "owner",
  11323. "in": "path",
  11324. "required": true
  11325. },
  11326. {
  11327. "type": "string",
  11328. "description": "name of the repo",
  11329. "name": "repo",
  11330. "in": "path",
  11331. "required": true
  11332. },
  11333. {
  11334. "type": "integer",
  11335. "format": "int64",
  11336. "description": "index of the pull request to get",
  11337. "name": "index",
  11338. "in": "path",
  11339. "required": true
  11340. },
  11341. {
  11342. "enum": [
  11343. "diff",
  11344. "patch"
  11345. ],
  11346. "type": "string",
  11347. "description": "whether the output is diff or patch",
  11348. "name": "diffType",
  11349. "in": "path",
  11350. "required": true
  11351. },
  11352. {
  11353. "type": "boolean",
  11354. "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
  11355. "name": "binary",
  11356. "in": "query"
  11357. }
  11358. ],
  11359. "responses": {
  11360. "200": {
  11361. "$ref": "#/responses/string"
  11362. },
  11363. "404": {
  11364. "$ref": "#/responses/notFound"
  11365. }
  11366. }
  11367. }
  11368. },
  11369. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  11370. "get": {
  11371. "produces": [
  11372. "application/json"
  11373. ],
  11374. "tags": [
  11375. "repository"
  11376. ],
  11377. "summary": "Get commits for a pull request",
  11378. "operationId": "repoGetPullRequestCommits",
  11379. "parameters": [
  11380. {
  11381. "type": "string",
  11382. "description": "owner of the repo",
  11383. "name": "owner",
  11384. "in": "path",
  11385. "required": true
  11386. },
  11387. {
  11388. "type": "string",
  11389. "description": "name of the repo",
  11390. "name": "repo",
  11391. "in": "path",
  11392. "required": true
  11393. },
  11394. {
  11395. "type": "integer",
  11396. "format": "int64",
  11397. "description": "index of the pull request to get",
  11398. "name": "index",
  11399. "in": "path",
  11400. "required": true
  11401. },
  11402. {
  11403. "type": "integer",
  11404. "description": "page number of results to return (1-based)",
  11405. "name": "page",
  11406. "in": "query"
  11407. },
  11408. {
  11409. "type": "integer",
  11410. "description": "page size of results",
  11411. "name": "limit",
  11412. "in": "query"
  11413. },
  11414. {
  11415. "type": "boolean",
  11416. "description": "include verification for every commit (disable for speedup, default 'true')",
  11417. "name": "verification",
  11418. "in": "query"
  11419. },
  11420. {
  11421. "type": "boolean",
  11422. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  11423. "name": "files",
  11424. "in": "query"
  11425. }
  11426. ],
  11427. "responses": {
  11428. "200": {
  11429. "$ref": "#/responses/CommitList"
  11430. },
  11431. "404": {
  11432. "$ref": "#/responses/notFound"
  11433. }
  11434. }
  11435. }
  11436. },
  11437. "/repos/{owner}/{repo}/pulls/{index}/files": {
  11438. "get": {
  11439. "produces": [
  11440. "application/json"
  11441. ],
  11442. "tags": [
  11443. "repository"
  11444. ],
  11445. "summary": "Get changed files for a pull request",
  11446. "operationId": "repoGetPullRequestFiles",
  11447. "parameters": [
  11448. {
  11449. "type": "string",
  11450. "description": "owner of the repo",
  11451. "name": "owner",
  11452. "in": "path",
  11453. "required": true
  11454. },
  11455. {
  11456. "type": "string",
  11457. "description": "name of the repo",
  11458. "name": "repo",
  11459. "in": "path",
  11460. "required": true
  11461. },
  11462. {
  11463. "type": "integer",
  11464. "format": "int64",
  11465. "description": "index of the pull request to get",
  11466. "name": "index",
  11467. "in": "path",
  11468. "required": true
  11469. },
  11470. {
  11471. "type": "string",
  11472. "description": "skip to given file",
  11473. "name": "skip-to",
  11474. "in": "query"
  11475. },
  11476. {
  11477. "enum": [
  11478. "ignore-all",
  11479. "ignore-change",
  11480. "ignore-eol",
  11481. "show-all"
  11482. ],
  11483. "type": "string",
  11484. "description": "whitespace behavior",
  11485. "name": "whitespace",
  11486. "in": "query"
  11487. },
  11488. {
  11489. "type": "integer",
  11490. "description": "page number of results to return (1-based)",
  11491. "name": "page",
  11492. "in": "query"
  11493. },
  11494. {
  11495. "type": "integer",
  11496. "description": "page size of results",
  11497. "name": "limit",
  11498. "in": "query"
  11499. }
  11500. ],
  11501. "responses": {
  11502. "200": {
  11503. "$ref": "#/responses/ChangedFileList"
  11504. },
  11505. "404": {
  11506. "$ref": "#/responses/notFound"
  11507. }
  11508. }
  11509. }
  11510. },
  11511. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  11512. "get": {
  11513. "produces": [
  11514. "application/json"
  11515. ],
  11516. "tags": [
  11517. "repository"
  11518. ],
  11519. "summary": "Check if a pull request has been merged",
  11520. "operationId": "repoPullRequestIsMerged",
  11521. "parameters": [
  11522. {
  11523. "type": "string",
  11524. "description": "owner of the repo",
  11525. "name": "owner",
  11526. "in": "path",
  11527. "required": true
  11528. },
  11529. {
  11530. "type": "string",
  11531. "description": "name of the repo",
  11532. "name": "repo",
  11533. "in": "path",
  11534. "required": true
  11535. },
  11536. {
  11537. "type": "integer",
  11538. "format": "int64",
  11539. "description": "index of the pull request",
  11540. "name": "index",
  11541. "in": "path",
  11542. "required": true
  11543. }
  11544. ],
  11545. "responses": {
  11546. "204": {
  11547. "description": "pull request has been merged"
  11548. },
  11549. "404": {
  11550. "description": "pull request has not been merged"
  11551. }
  11552. }
  11553. },
  11554. "post": {
  11555. "produces": [
  11556. "application/json"
  11557. ],
  11558. "tags": [
  11559. "repository"
  11560. ],
  11561. "summary": "Merge a pull request",
  11562. "operationId": "repoMergePullRequest",
  11563. "parameters": [
  11564. {
  11565. "type": "string",
  11566. "description": "owner of the repo",
  11567. "name": "owner",
  11568. "in": "path",
  11569. "required": true
  11570. },
  11571. {
  11572. "type": "string",
  11573. "description": "name of the repo",
  11574. "name": "repo",
  11575. "in": "path",
  11576. "required": true
  11577. },
  11578. {
  11579. "type": "integer",
  11580. "format": "int64",
  11581. "description": "index of the pull request to merge",
  11582. "name": "index",
  11583. "in": "path",
  11584. "required": true
  11585. },
  11586. {
  11587. "name": "body",
  11588. "in": "body",
  11589. "schema": {
  11590. "$ref": "#/definitions/MergePullRequestOption"
  11591. }
  11592. }
  11593. ],
  11594. "responses": {
  11595. "200": {
  11596. "$ref": "#/responses/empty"
  11597. },
  11598. "404": {
  11599. "$ref": "#/responses/notFound"
  11600. },
  11601. "405": {
  11602. "$ref": "#/responses/empty"
  11603. },
  11604. "409": {
  11605. "$ref": "#/responses/error"
  11606. },
  11607. "423": {
  11608. "$ref": "#/responses/repoArchivedError"
  11609. }
  11610. }
  11611. },
  11612. "delete": {
  11613. "produces": [
  11614. "application/json"
  11615. ],
  11616. "tags": [
  11617. "repository"
  11618. ],
  11619. "summary": "Cancel the scheduled auto merge for the given pull request",
  11620. "operationId": "repoCancelScheduledAutoMerge",
  11621. "parameters": [
  11622. {
  11623. "type": "string",
  11624. "description": "owner of the repo",
  11625. "name": "owner",
  11626. "in": "path",
  11627. "required": true
  11628. },
  11629. {
  11630. "type": "string",
  11631. "description": "name of the repo",
  11632. "name": "repo",
  11633. "in": "path",
  11634. "required": true
  11635. },
  11636. {
  11637. "type": "integer",
  11638. "format": "int64",
  11639. "description": "index of the pull request to merge",
  11640. "name": "index",
  11641. "in": "path",
  11642. "required": true
  11643. }
  11644. ],
  11645. "responses": {
  11646. "204": {
  11647. "$ref": "#/responses/empty"
  11648. },
  11649. "403": {
  11650. "$ref": "#/responses/forbidden"
  11651. },
  11652. "404": {
  11653. "$ref": "#/responses/notFound"
  11654. },
  11655. "423": {
  11656. "$ref": "#/responses/repoArchivedError"
  11657. }
  11658. }
  11659. }
  11660. },
  11661. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  11662. "post": {
  11663. "produces": [
  11664. "application/json"
  11665. ],
  11666. "tags": [
  11667. "repository"
  11668. ],
  11669. "summary": "create review requests for a pull request",
  11670. "operationId": "repoCreatePullReviewRequests",
  11671. "parameters": [
  11672. {
  11673. "type": "string",
  11674. "description": "owner of the repo",
  11675. "name": "owner",
  11676. "in": "path",
  11677. "required": true
  11678. },
  11679. {
  11680. "type": "string",
  11681. "description": "name of the repo",
  11682. "name": "repo",
  11683. "in": "path",
  11684. "required": true
  11685. },
  11686. {
  11687. "type": "integer",
  11688. "format": "int64",
  11689. "description": "index of the pull request",
  11690. "name": "index",
  11691. "in": "path",
  11692. "required": true
  11693. },
  11694. {
  11695. "name": "body",
  11696. "in": "body",
  11697. "required": true,
  11698. "schema": {
  11699. "$ref": "#/definitions/PullReviewRequestOptions"
  11700. }
  11701. }
  11702. ],
  11703. "responses": {
  11704. "201": {
  11705. "$ref": "#/responses/PullReviewList"
  11706. },
  11707. "404": {
  11708. "$ref": "#/responses/notFound"
  11709. },
  11710. "422": {
  11711. "$ref": "#/responses/validationError"
  11712. }
  11713. }
  11714. },
  11715. "delete": {
  11716. "produces": [
  11717. "application/json"
  11718. ],
  11719. "tags": [
  11720. "repository"
  11721. ],
  11722. "summary": "cancel review requests for a pull request",
  11723. "operationId": "repoDeletePullReviewRequests",
  11724. "parameters": [
  11725. {
  11726. "type": "string",
  11727. "description": "owner of the repo",
  11728. "name": "owner",
  11729. "in": "path",
  11730. "required": true
  11731. },
  11732. {
  11733. "type": "string",
  11734. "description": "name of the repo",
  11735. "name": "repo",
  11736. "in": "path",
  11737. "required": true
  11738. },
  11739. {
  11740. "type": "integer",
  11741. "format": "int64",
  11742. "description": "index of the pull request",
  11743. "name": "index",
  11744. "in": "path",
  11745. "required": true
  11746. },
  11747. {
  11748. "name": "body",
  11749. "in": "body",
  11750. "required": true,
  11751. "schema": {
  11752. "$ref": "#/definitions/PullReviewRequestOptions"
  11753. }
  11754. }
  11755. ],
  11756. "responses": {
  11757. "204": {
  11758. "$ref": "#/responses/empty"
  11759. },
  11760. "403": {
  11761. "$ref": "#/responses/forbidden"
  11762. },
  11763. "404": {
  11764. "$ref": "#/responses/notFound"
  11765. },
  11766. "422": {
  11767. "$ref": "#/responses/validationError"
  11768. }
  11769. }
  11770. }
  11771. },
  11772. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  11773. "get": {
  11774. "produces": [
  11775. "application/json"
  11776. ],
  11777. "tags": [
  11778. "repository"
  11779. ],
  11780. "summary": "List all reviews for a pull request",
  11781. "operationId": "repoListPullReviews",
  11782. "parameters": [
  11783. {
  11784. "type": "string",
  11785. "description": "owner of the repo",
  11786. "name": "owner",
  11787. "in": "path",
  11788. "required": true
  11789. },
  11790. {
  11791. "type": "string",
  11792. "description": "name of the repo",
  11793. "name": "repo",
  11794. "in": "path",
  11795. "required": true
  11796. },
  11797. {
  11798. "type": "integer",
  11799. "format": "int64",
  11800. "description": "index of the pull request",
  11801. "name": "index",
  11802. "in": "path",
  11803. "required": true
  11804. },
  11805. {
  11806. "type": "integer",
  11807. "description": "page number of results to return (1-based)",
  11808. "name": "page",
  11809. "in": "query"
  11810. },
  11811. {
  11812. "type": "integer",
  11813. "description": "page size of results",
  11814. "name": "limit",
  11815. "in": "query"
  11816. }
  11817. ],
  11818. "responses": {
  11819. "200": {
  11820. "$ref": "#/responses/PullReviewList"
  11821. },
  11822. "404": {
  11823. "$ref": "#/responses/notFound"
  11824. }
  11825. }
  11826. },
  11827. "post": {
  11828. "produces": [
  11829. "application/json"
  11830. ],
  11831. "tags": [
  11832. "repository"
  11833. ],
  11834. "summary": "Create a review to an pull request",
  11835. "operationId": "repoCreatePullReview",
  11836. "parameters": [
  11837. {
  11838. "type": "string",
  11839. "description": "owner of the repo",
  11840. "name": "owner",
  11841. "in": "path",
  11842. "required": true
  11843. },
  11844. {
  11845. "type": "string",
  11846. "description": "name of the repo",
  11847. "name": "repo",
  11848. "in": "path",
  11849. "required": true
  11850. },
  11851. {
  11852. "type": "integer",
  11853. "format": "int64",
  11854. "description": "index of the pull request",
  11855. "name": "index",
  11856. "in": "path",
  11857. "required": true
  11858. },
  11859. {
  11860. "name": "body",
  11861. "in": "body",
  11862. "required": true,
  11863. "schema": {
  11864. "$ref": "#/definitions/CreatePullReviewOptions"
  11865. }
  11866. }
  11867. ],
  11868. "responses": {
  11869. "200": {
  11870. "$ref": "#/responses/PullReview"
  11871. },
  11872. "404": {
  11873. "$ref": "#/responses/notFound"
  11874. },
  11875. "422": {
  11876. "$ref": "#/responses/validationError"
  11877. }
  11878. }
  11879. }
  11880. },
  11881. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  11882. "get": {
  11883. "produces": [
  11884. "application/json"
  11885. ],
  11886. "tags": [
  11887. "repository"
  11888. ],
  11889. "summary": "Get a specific review for a pull request",
  11890. "operationId": "repoGetPullReview",
  11891. "parameters": [
  11892. {
  11893. "type": "string",
  11894. "description": "owner of the repo",
  11895. "name": "owner",
  11896. "in": "path",
  11897. "required": true
  11898. },
  11899. {
  11900. "type": "string",
  11901. "description": "name of the repo",
  11902. "name": "repo",
  11903. "in": "path",
  11904. "required": true
  11905. },
  11906. {
  11907. "type": "integer",
  11908. "format": "int64",
  11909. "description": "index of the pull request",
  11910. "name": "index",
  11911. "in": "path",
  11912. "required": true
  11913. },
  11914. {
  11915. "type": "integer",
  11916. "format": "int64",
  11917. "description": "id of the review",
  11918. "name": "id",
  11919. "in": "path",
  11920. "required": true
  11921. }
  11922. ],
  11923. "responses": {
  11924. "200": {
  11925. "$ref": "#/responses/PullReview"
  11926. },
  11927. "404": {
  11928. "$ref": "#/responses/notFound"
  11929. }
  11930. }
  11931. },
  11932. "post": {
  11933. "produces": [
  11934. "application/json"
  11935. ],
  11936. "tags": [
  11937. "repository"
  11938. ],
  11939. "summary": "Submit a pending review to an pull request",
  11940. "operationId": "repoSubmitPullReview",
  11941. "parameters": [
  11942. {
  11943. "type": "string",
  11944. "description": "owner of the repo",
  11945. "name": "owner",
  11946. "in": "path",
  11947. "required": true
  11948. },
  11949. {
  11950. "type": "string",
  11951. "description": "name of the repo",
  11952. "name": "repo",
  11953. "in": "path",
  11954. "required": true
  11955. },
  11956. {
  11957. "type": "integer",
  11958. "format": "int64",
  11959. "description": "index of the pull request",
  11960. "name": "index",
  11961. "in": "path",
  11962. "required": true
  11963. },
  11964. {
  11965. "type": "integer",
  11966. "format": "int64",
  11967. "description": "id of the review",
  11968. "name": "id",
  11969. "in": "path",
  11970. "required": true
  11971. },
  11972. {
  11973. "name": "body",
  11974. "in": "body",
  11975. "required": true,
  11976. "schema": {
  11977. "$ref": "#/definitions/SubmitPullReviewOptions"
  11978. }
  11979. }
  11980. ],
  11981. "responses": {
  11982. "200": {
  11983. "$ref": "#/responses/PullReview"
  11984. },
  11985. "404": {
  11986. "$ref": "#/responses/notFound"
  11987. },
  11988. "422": {
  11989. "$ref": "#/responses/validationError"
  11990. }
  11991. }
  11992. },
  11993. "delete": {
  11994. "produces": [
  11995. "application/json"
  11996. ],
  11997. "tags": [
  11998. "repository"
  11999. ],
  12000. "summary": "Delete a specific review from a pull request",
  12001. "operationId": "repoDeletePullReview",
  12002. "parameters": [
  12003. {
  12004. "type": "string",
  12005. "description": "owner of the repo",
  12006. "name": "owner",
  12007. "in": "path",
  12008. "required": true
  12009. },
  12010. {
  12011. "type": "string",
  12012. "description": "name of the repo",
  12013. "name": "repo",
  12014. "in": "path",
  12015. "required": true
  12016. },
  12017. {
  12018. "type": "integer",
  12019. "format": "int64",
  12020. "description": "index of the pull request",
  12021. "name": "index",
  12022. "in": "path",
  12023. "required": true
  12024. },
  12025. {
  12026. "type": "integer",
  12027. "format": "int64",
  12028. "description": "id of the review",
  12029. "name": "id",
  12030. "in": "path",
  12031. "required": true
  12032. }
  12033. ],
  12034. "responses": {
  12035. "204": {
  12036. "$ref": "#/responses/empty"
  12037. },
  12038. "403": {
  12039. "$ref": "#/responses/forbidden"
  12040. },
  12041. "404": {
  12042. "$ref": "#/responses/notFound"
  12043. }
  12044. }
  12045. }
  12046. },
  12047. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  12048. "get": {
  12049. "produces": [
  12050. "application/json"
  12051. ],
  12052. "tags": [
  12053. "repository"
  12054. ],
  12055. "summary": "Get a specific review for a pull request",
  12056. "operationId": "repoGetPullReviewComments",
  12057. "parameters": [
  12058. {
  12059. "type": "string",
  12060. "description": "owner of the repo",
  12061. "name": "owner",
  12062. "in": "path",
  12063. "required": true
  12064. },
  12065. {
  12066. "type": "string",
  12067. "description": "name of the repo",
  12068. "name": "repo",
  12069. "in": "path",
  12070. "required": true
  12071. },
  12072. {
  12073. "type": "integer",
  12074. "format": "int64",
  12075. "description": "index of the pull request",
  12076. "name": "index",
  12077. "in": "path",
  12078. "required": true
  12079. },
  12080. {
  12081. "type": "integer",
  12082. "format": "int64",
  12083. "description": "id of the review",
  12084. "name": "id",
  12085. "in": "path",
  12086. "required": true
  12087. }
  12088. ],
  12089. "responses": {
  12090. "200": {
  12091. "$ref": "#/responses/PullReviewCommentList"
  12092. },
  12093. "404": {
  12094. "$ref": "#/responses/notFound"
  12095. }
  12096. }
  12097. }
  12098. },
  12099. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  12100. "post": {
  12101. "produces": [
  12102. "application/json"
  12103. ],
  12104. "tags": [
  12105. "repository"
  12106. ],
  12107. "summary": "Dismiss a review for a pull request",
  12108. "operationId": "repoDismissPullReview",
  12109. "parameters": [
  12110. {
  12111. "type": "string",
  12112. "description": "owner of the repo",
  12113. "name": "owner",
  12114. "in": "path",
  12115. "required": true
  12116. },
  12117. {
  12118. "type": "string",
  12119. "description": "name of the repo",
  12120. "name": "repo",
  12121. "in": "path",
  12122. "required": true
  12123. },
  12124. {
  12125. "type": "integer",
  12126. "format": "int64",
  12127. "description": "index of the pull request",
  12128. "name": "index",
  12129. "in": "path",
  12130. "required": true
  12131. },
  12132. {
  12133. "type": "integer",
  12134. "format": "int64",
  12135. "description": "id of the review",
  12136. "name": "id",
  12137. "in": "path",
  12138. "required": true
  12139. },
  12140. {
  12141. "name": "body",
  12142. "in": "body",
  12143. "required": true,
  12144. "schema": {
  12145. "$ref": "#/definitions/DismissPullReviewOptions"
  12146. }
  12147. }
  12148. ],
  12149. "responses": {
  12150. "200": {
  12151. "$ref": "#/responses/PullReview"
  12152. },
  12153. "403": {
  12154. "$ref": "#/responses/forbidden"
  12155. },
  12156. "404": {
  12157. "$ref": "#/responses/notFound"
  12158. },
  12159. "422": {
  12160. "$ref": "#/responses/validationError"
  12161. }
  12162. }
  12163. }
  12164. },
  12165. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  12166. "post": {
  12167. "produces": [
  12168. "application/json"
  12169. ],
  12170. "tags": [
  12171. "repository"
  12172. ],
  12173. "summary": "Cancel to dismiss a review for a pull request",
  12174. "operationId": "repoUnDismissPullReview",
  12175. "parameters": [
  12176. {
  12177. "type": "string",
  12178. "description": "owner of the repo",
  12179. "name": "owner",
  12180. "in": "path",
  12181. "required": true
  12182. },
  12183. {
  12184. "type": "string",
  12185. "description": "name of the repo",
  12186. "name": "repo",
  12187. "in": "path",
  12188. "required": true
  12189. },
  12190. {
  12191. "type": "integer",
  12192. "format": "int64",
  12193. "description": "index of the pull request",
  12194. "name": "index",
  12195. "in": "path",
  12196. "required": true
  12197. },
  12198. {
  12199. "type": "integer",
  12200. "format": "int64",
  12201. "description": "id of the review",
  12202. "name": "id",
  12203. "in": "path",
  12204. "required": true
  12205. }
  12206. ],
  12207. "responses": {
  12208. "200": {
  12209. "$ref": "#/responses/PullReview"
  12210. },
  12211. "403": {
  12212. "$ref": "#/responses/forbidden"
  12213. },
  12214. "404": {
  12215. "$ref": "#/responses/notFound"
  12216. },
  12217. "422": {
  12218. "$ref": "#/responses/validationError"
  12219. }
  12220. }
  12221. }
  12222. },
  12223. "/repos/{owner}/{repo}/pulls/{index}/update": {
  12224. "post": {
  12225. "produces": [
  12226. "application/json"
  12227. ],
  12228. "tags": [
  12229. "repository"
  12230. ],
  12231. "summary": "Merge PR's baseBranch into headBranch",
  12232. "operationId": "repoUpdatePullRequest",
  12233. "parameters": [
  12234. {
  12235. "type": "string",
  12236. "description": "owner of the repo",
  12237. "name": "owner",
  12238. "in": "path",
  12239. "required": true
  12240. },
  12241. {
  12242. "type": "string",
  12243. "description": "name of the repo",
  12244. "name": "repo",
  12245. "in": "path",
  12246. "required": true
  12247. },
  12248. {
  12249. "type": "integer",
  12250. "format": "int64",
  12251. "description": "index of the pull request to get",
  12252. "name": "index",
  12253. "in": "path",
  12254. "required": true
  12255. },
  12256. {
  12257. "enum": [
  12258. "merge",
  12259. "rebase"
  12260. ],
  12261. "type": "string",
  12262. "description": "how to update pull request",
  12263. "name": "style",
  12264. "in": "query"
  12265. }
  12266. ],
  12267. "responses": {
  12268. "200": {
  12269. "$ref": "#/responses/empty"
  12270. },
  12271. "403": {
  12272. "$ref": "#/responses/forbidden"
  12273. },
  12274. "404": {
  12275. "$ref": "#/responses/notFound"
  12276. },
  12277. "409": {
  12278. "$ref": "#/responses/error"
  12279. },
  12280. "422": {
  12281. "$ref": "#/responses/validationError"
  12282. }
  12283. }
  12284. }
  12285. },
  12286. "/repos/{owner}/{repo}/push_mirrors": {
  12287. "get": {
  12288. "produces": [
  12289. "application/json"
  12290. ],
  12291. "tags": [
  12292. "repository"
  12293. ],
  12294. "summary": "Get all push mirrors of the repository",
  12295. "operationId": "repoListPushMirrors",
  12296. "parameters": [
  12297. {
  12298. "type": "string",
  12299. "description": "owner of the repo",
  12300. "name": "owner",
  12301. "in": "path",
  12302. "required": true
  12303. },
  12304. {
  12305. "type": "string",
  12306. "description": "name of the repo",
  12307. "name": "repo",
  12308. "in": "path",
  12309. "required": true
  12310. },
  12311. {
  12312. "type": "integer",
  12313. "description": "page number of results to return (1-based)",
  12314. "name": "page",
  12315. "in": "query"
  12316. },
  12317. {
  12318. "type": "integer",
  12319. "description": "page size of results",
  12320. "name": "limit",
  12321. "in": "query"
  12322. }
  12323. ],
  12324. "responses": {
  12325. "200": {
  12326. "$ref": "#/responses/PushMirrorList"
  12327. },
  12328. "400": {
  12329. "$ref": "#/responses/error"
  12330. },
  12331. "403": {
  12332. "$ref": "#/responses/forbidden"
  12333. },
  12334. "404": {
  12335. "$ref": "#/responses/notFound"
  12336. }
  12337. }
  12338. },
  12339. "post": {
  12340. "consumes": [
  12341. "application/json"
  12342. ],
  12343. "produces": [
  12344. "application/json"
  12345. ],
  12346. "tags": [
  12347. "repository"
  12348. ],
  12349. "summary": "add a push mirror to the repository",
  12350. "operationId": "repoAddPushMirror",
  12351. "parameters": [
  12352. {
  12353. "type": "string",
  12354. "description": "owner of the repo",
  12355. "name": "owner",
  12356. "in": "path",
  12357. "required": true
  12358. },
  12359. {
  12360. "type": "string",
  12361. "description": "name of the repo",
  12362. "name": "repo",
  12363. "in": "path",
  12364. "required": true
  12365. },
  12366. {
  12367. "name": "body",
  12368. "in": "body",
  12369. "schema": {
  12370. "$ref": "#/definitions/CreatePushMirrorOption"
  12371. }
  12372. }
  12373. ],
  12374. "responses": {
  12375. "200": {
  12376. "$ref": "#/responses/PushMirror"
  12377. },
  12378. "400": {
  12379. "$ref": "#/responses/error"
  12380. },
  12381. "403": {
  12382. "$ref": "#/responses/forbidden"
  12383. },
  12384. "404": {
  12385. "$ref": "#/responses/notFound"
  12386. }
  12387. }
  12388. }
  12389. },
  12390. "/repos/{owner}/{repo}/push_mirrors-sync": {
  12391. "post": {
  12392. "produces": [
  12393. "application/json"
  12394. ],
  12395. "tags": [
  12396. "repository"
  12397. ],
  12398. "summary": "Sync all push mirrored repository",
  12399. "operationId": "repoPushMirrorSync",
  12400. "parameters": [
  12401. {
  12402. "type": "string",
  12403. "description": "owner of the repo to sync",
  12404. "name": "owner",
  12405. "in": "path",
  12406. "required": true
  12407. },
  12408. {
  12409. "type": "string",
  12410. "description": "name of the repo to sync",
  12411. "name": "repo",
  12412. "in": "path",
  12413. "required": true
  12414. }
  12415. ],
  12416. "responses": {
  12417. "200": {
  12418. "$ref": "#/responses/empty"
  12419. },
  12420. "400": {
  12421. "$ref": "#/responses/error"
  12422. },
  12423. "403": {
  12424. "$ref": "#/responses/forbidden"
  12425. },
  12426. "404": {
  12427. "$ref": "#/responses/notFound"
  12428. }
  12429. }
  12430. }
  12431. },
  12432. "/repos/{owner}/{repo}/push_mirrors/{name}": {
  12433. "get": {
  12434. "produces": [
  12435. "application/json"
  12436. ],
  12437. "tags": [
  12438. "repository"
  12439. ],
  12440. "summary": "Get push mirror of the repository by remoteName",
  12441. "operationId": "repoGetPushMirrorByRemoteName",
  12442. "parameters": [
  12443. {
  12444. "type": "string",
  12445. "description": "owner of the repo",
  12446. "name": "owner",
  12447. "in": "path",
  12448. "required": true
  12449. },
  12450. {
  12451. "type": "string",
  12452. "description": "name of the repo",
  12453. "name": "repo",
  12454. "in": "path",
  12455. "required": true
  12456. },
  12457. {
  12458. "type": "string",
  12459. "description": "remote name of push mirror",
  12460. "name": "name",
  12461. "in": "path",
  12462. "required": true
  12463. }
  12464. ],
  12465. "responses": {
  12466. "200": {
  12467. "$ref": "#/responses/PushMirror"
  12468. },
  12469. "400": {
  12470. "$ref": "#/responses/error"
  12471. },
  12472. "403": {
  12473. "$ref": "#/responses/forbidden"
  12474. },
  12475. "404": {
  12476. "$ref": "#/responses/notFound"
  12477. }
  12478. }
  12479. },
  12480. "delete": {
  12481. "produces": [
  12482. "application/json"
  12483. ],
  12484. "tags": [
  12485. "repository"
  12486. ],
  12487. "summary": "deletes a push mirror from a repository by remoteName",
  12488. "operationId": "repoDeletePushMirror",
  12489. "parameters": [
  12490. {
  12491. "type": "string",
  12492. "description": "owner of the repo",
  12493. "name": "owner",
  12494. "in": "path",
  12495. "required": true
  12496. },
  12497. {
  12498. "type": "string",
  12499. "description": "name of the repo",
  12500. "name": "repo",
  12501. "in": "path",
  12502. "required": true
  12503. },
  12504. {
  12505. "type": "string",
  12506. "description": "remote name of the pushMirror",
  12507. "name": "name",
  12508. "in": "path",
  12509. "required": true
  12510. }
  12511. ],
  12512. "responses": {
  12513. "204": {
  12514. "$ref": "#/responses/empty"
  12515. },
  12516. "400": {
  12517. "$ref": "#/responses/error"
  12518. },
  12519. "404": {
  12520. "$ref": "#/responses/notFound"
  12521. }
  12522. }
  12523. }
  12524. },
  12525. "/repos/{owner}/{repo}/raw/{filepath}": {
  12526. "get": {
  12527. "produces": [
  12528. "application/json"
  12529. ],
  12530. "tags": [
  12531. "repository"
  12532. ],
  12533. "summary": "Get a file from a repository",
  12534. "operationId": "repoGetRawFile",
  12535. "parameters": [
  12536. {
  12537. "type": "string",
  12538. "description": "owner of the repo",
  12539. "name": "owner",
  12540. "in": "path",
  12541. "required": true
  12542. },
  12543. {
  12544. "type": "string",
  12545. "description": "name of the repo",
  12546. "name": "repo",
  12547. "in": "path",
  12548. "required": true
  12549. },
  12550. {
  12551. "type": "string",
  12552. "description": "filepath of the file to get",
  12553. "name": "filepath",
  12554. "in": "path",
  12555. "required": true
  12556. },
  12557. {
  12558. "type": "string",
  12559. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  12560. "name": "ref",
  12561. "in": "query"
  12562. }
  12563. ],
  12564. "responses": {
  12565. "200": {
  12566. "description": "Returns raw file content."
  12567. },
  12568. "404": {
  12569. "$ref": "#/responses/notFound"
  12570. }
  12571. }
  12572. }
  12573. },
  12574. "/repos/{owner}/{repo}/releases": {
  12575. "get": {
  12576. "produces": [
  12577. "application/json"
  12578. ],
  12579. "tags": [
  12580. "repository"
  12581. ],
  12582. "summary": "List a repo's releases",
  12583. "operationId": "repoListReleases",
  12584. "parameters": [
  12585. {
  12586. "type": "string",
  12587. "description": "owner of the repo",
  12588. "name": "owner",
  12589. "in": "path",
  12590. "required": true
  12591. },
  12592. {
  12593. "type": "string",
  12594. "description": "name of the repo",
  12595. "name": "repo",
  12596. "in": "path",
  12597. "required": true
  12598. },
  12599. {
  12600. "type": "boolean",
  12601. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  12602. "name": "draft",
  12603. "in": "query"
  12604. },
  12605. {
  12606. "type": "boolean",
  12607. "description": "filter (exclude / include) pre-releases",
  12608. "name": "pre-release",
  12609. "in": "query"
  12610. },
  12611. {
  12612. "type": "integer",
  12613. "description": "page number of results to return (1-based)",
  12614. "name": "page",
  12615. "in": "query"
  12616. },
  12617. {
  12618. "type": "integer",
  12619. "description": "page size of results",
  12620. "name": "limit",
  12621. "in": "query"
  12622. }
  12623. ],
  12624. "responses": {
  12625. "200": {
  12626. "$ref": "#/responses/ReleaseList"
  12627. },
  12628. "404": {
  12629. "$ref": "#/responses/notFound"
  12630. }
  12631. }
  12632. },
  12633. "post": {
  12634. "consumes": [
  12635. "application/json"
  12636. ],
  12637. "produces": [
  12638. "application/json"
  12639. ],
  12640. "tags": [
  12641. "repository"
  12642. ],
  12643. "summary": "Create a release",
  12644. "operationId": "repoCreateRelease",
  12645. "parameters": [
  12646. {
  12647. "type": "string",
  12648. "description": "owner of the repo",
  12649. "name": "owner",
  12650. "in": "path",
  12651. "required": true
  12652. },
  12653. {
  12654. "type": "string",
  12655. "description": "name of the repo",
  12656. "name": "repo",
  12657. "in": "path",
  12658. "required": true
  12659. },
  12660. {
  12661. "name": "body",
  12662. "in": "body",
  12663. "schema": {
  12664. "$ref": "#/definitions/CreateReleaseOption"
  12665. }
  12666. }
  12667. ],
  12668. "responses": {
  12669. "201": {
  12670. "$ref": "#/responses/Release"
  12671. },
  12672. "404": {
  12673. "$ref": "#/responses/notFound"
  12674. },
  12675. "409": {
  12676. "$ref": "#/responses/error"
  12677. }
  12678. }
  12679. }
  12680. },
  12681. "/repos/{owner}/{repo}/releases/latest": {
  12682. "get": {
  12683. "produces": [
  12684. "application/json"
  12685. ],
  12686. "tags": [
  12687. "repository"
  12688. ],
  12689. "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
  12690. "operationId": "repoGetLatestRelease",
  12691. "parameters": [
  12692. {
  12693. "type": "string",
  12694. "description": "owner of the repo",
  12695. "name": "owner",
  12696. "in": "path",
  12697. "required": true
  12698. },
  12699. {
  12700. "type": "string",
  12701. "description": "name of the repo",
  12702. "name": "repo",
  12703. "in": "path",
  12704. "required": true
  12705. }
  12706. ],
  12707. "responses": {
  12708. "200": {
  12709. "$ref": "#/responses/Release"
  12710. },
  12711. "404": {
  12712. "$ref": "#/responses/notFound"
  12713. }
  12714. }
  12715. }
  12716. },
  12717. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  12718. "get": {
  12719. "produces": [
  12720. "application/json"
  12721. ],
  12722. "tags": [
  12723. "repository"
  12724. ],
  12725. "summary": "Get a release by tag name",
  12726. "operationId": "repoGetReleaseByTag",
  12727. "parameters": [
  12728. {
  12729. "type": "string",
  12730. "description": "owner of the repo",
  12731. "name": "owner",
  12732. "in": "path",
  12733. "required": true
  12734. },
  12735. {
  12736. "type": "string",
  12737. "description": "name of the repo",
  12738. "name": "repo",
  12739. "in": "path",
  12740. "required": true
  12741. },
  12742. {
  12743. "type": "string",
  12744. "description": "tag name of the release to get",
  12745. "name": "tag",
  12746. "in": "path",
  12747. "required": true
  12748. }
  12749. ],
  12750. "responses": {
  12751. "200": {
  12752. "$ref": "#/responses/Release"
  12753. },
  12754. "404": {
  12755. "$ref": "#/responses/notFound"
  12756. }
  12757. }
  12758. },
  12759. "delete": {
  12760. "tags": [
  12761. "repository"
  12762. ],
  12763. "summary": "Delete a release by tag name",
  12764. "operationId": "repoDeleteReleaseByTag",
  12765. "parameters": [
  12766. {
  12767. "type": "string",
  12768. "description": "owner of the repo",
  12769. "name": "owner",
  12770. "in": "path",
  12771. "required": true
  12772. },
  12773. {
  12774. "type": "string",
  12775. "description": "name of the repo",
  12776. "name": "repo",
  12777. "in": "path",
  12778. "required": true
  12779. },
  12780. {
  12781. "type": "string",
  12782. "description": "tag name of the release to delete",
  12783. "name": "tag",
  12784. "in": "path",
  12785. "required": true
  12786. }
  12787. ],
  12788. "responses": {
  12789. "204": {
  12790. "$ref": "#/responses/empty"
  12791. },
  12792. "404": {
  12793. "$ref": "#/responses/notFound"
  12794. },
  12795. "405": {
  12796. "$ref": "#/responses/empty"
  12797. }
  12798. }
  12799. }
  12800. },
  12801. "/repos/{owner}/{repo}/releases/{id}": {
  12802. "get": {
  12803. "produces": [
  12804. "application/json"
  12805. ],
  12806. "tags": [
  12807. "repository"
  12808. ],
  12809. "summary": "Get a release",
  12810. "operationId": "repoGetRelease",
  12811. "parameters": [
  12812. {
  12813. "type": "string",
  12814. "description": "owner of the repo",
  12815. "name": "owner",
  12816. "in": "path",
  12817. "required": true
  12818. },
  12819. {
  12820. "type": "string",
  12821. "description": "name of the repo",
  12822. "name": "repo",
  12823. "in": "path",
  12824. "required": true
  12825. },
  12826. {
  12827. "type": "integer",
  12828. "format": "int64",
  12829. "description": "id of the release to get",
  12830. "name": "id",
  12831. "in": "path",
  12832. "required": true
  12833. }
  12834. ],
  12835. "responses": {
  12836. "200": {
  12837. "$ref": "#/responses/Release"
  12838. },
  12839. "404": {
  12840. "$ref": "#/responses/notFound"
  12841. }
  12842. }
  12843. },
  12844. "delete": {
  12845. "tags": [
  12846. "repository"
  12847. ],
  12848. "summary": "Delete a release",
  12849. "operationId": "repoDeleteRelease",
  12850. "parameters": [
  12851. {
  12852. "type": "string",
  12853. "description": "owner of the repo",
  12854. "name": "owner",
  12855. "in": "path",
  12856. "required": true
  12857. },
  12858. {
  12859. "type": "string",
  12860. "description": "name of the repo",
  12861. "name": "repo",
  12862. "in": "path",
  12863. "required": true
  12864. },
  12865. {
  12866. "type": "integer",
  12867. "format": "int64",
  12868. "description": "id of the release to delete",
  12869. "name": "id",
  12870. "in": "path",
  12871. "required": true
  12872. }
  12873. ],
  12874. "responses": {
  12875. "204": {
  12876. "$ref": "#/responses/empty"
  12877. },
  12878. "404": {
  12879. "$ref": "#/responses/notFound"
  12880. },
  12881. "405": {
  12882. "$ref": "#/responses/empty"
  12883. }
  12884. }
  12885. },
  12886. "patch": {
  12887. "consumes": [
  12888. "application/json"
  12889. ],
  12890. "produces": [
  12891. "application/json"
  12892. ],
  12893. "tags": [
  12894. "repository"
  12895. ],
  12896. "summary": "Update a release",
  12897. "operationId": "repoEditRelease",
  12898. "parameters": [
  12899. {
  12900. "type": "string",
  12901. "description": "owner of the repo",
  12902. "name": "owner",
  12903. "in": "path",
  12904. "required": true
  12905. },
  12906. {
  12907. "type": "string",
  12908. "description": "name of the repo",
  12909. "name": "repo",
  12910. "in": "path",
  12911. "required": true
  12912. },
  12913. {
  12914. "type": "integer",
  12915. "format": "int64",
  12916. "description": "id of the release to edit",
  12917. "name": "id",
  12918. "in": "path",
  12919. "required": true
  12920. },
  12921. {
  12922. "name": "body",
  12923. "in": "body",
  12924. "schema": {
  12925. "$ref": "#/definitions/EditReleaseOption"
  12926. }
  12927. }
  12928. ],
  12929. "responses": {
  12930. "200": {
  12931. "$ref": "#/responses/Release"
  12932. },
  12933. "404": {
  12934. "$ref": "#/responses/notFound"
  12935. }
  12936. }
  12937. }
  12938. },
  12939. "/repos/{owner}/{repo}/releases/{id}/assets": {
  12940. "get": {
  12941. "produces": [
  12942. "application/json"
  12943. ],
  12944. "tags": [
  12945. "repository"
  12946. ],
  12947. "summary": "List release's attachments",
  12948. "operationId": "repoListReleaseAttachments",
  12949. "parameters": [
  12950. {
  12951. "type": "string",
  12952. "description": "owner of the repo",
  12953. "name": "owner",
  12954. "in": "path",
  12955. "required": true
  12956. },
  12957. {
  12958. "type": "string",
  12959. "description": "name of the repo",
  12960. "name": "repo",
  12961. "in": "path",
  12962. "required": true
  12963. },
  12964. {
  12965. "type": "integer",
  12966. "format": "int64",
  12967. "description": "id of the release",
  12968. "name": "id",
  12969. "in": "path",
  12970. "required": true
  12971. }
  12972. ],
  12973. "responses": {
  12974. "200": {
  12975. "$ref": "#/responses/AttachmentList"
  12976. },
  12977. "404": {
  12978. "$ref": "#/responses/notFound"
  12979. }
  12980. }
  12981. },
  12982. "post": {
  12983. "consumes": [
  12984. "multipart/form-data",
  12985. "application/octet-stream"
  12986. ],
  12987. "produces": [
  12988. "application/json"
  12989. ],
  12990. "tags": [
  12991. "repository"
  12992. ],
  12993. "summary": "Create a release attachment",
  12994. "operationId": "repoCreateReleaseAttachment",
  12995. "parameters": [
  12996. {
  12997. "type": "string",
  12998. "description": "owner of the repo",
  12999. "name": "owner",
  13000. "in": "path",
  13001. "required": true
  13002. },
  13003. {
  13004. "type": "string",
  13005. "description": "name of the repo",
  13006. "name": "repo",
  13007. "in": "path",
  13008. "required": true
  13009. },
  13010. {
  13011. "type": "integer",
  13012. "format": "int64",
  13013. "description": "id of the release",
  13014. "name": "id",
  13015. "in": "path",
  13016. "required": true
  13017. },
  13018. {
  13019. "type": "string",
  13020. "description": "name of the attachment",
  13021. "name": "name",
  13022. "in": "query"
  13023. },
  13024. {
  13025. "type": "file",
  13026. "description": "attachment to upload",
  13027. "name": "attachment",
  13028. "in": "formData"
  13029. }
  13030. ],
  13031. "responses": {
  13032. "201": {
  13033. "$ref": "#/responses/Attachment"
  13034. },
  13035. "400": {
  13036. "$ref": "#/responses/error"
  13037. },
  13038. "404": {
  13039. "$ref": "#/responses/notFound"
  13040. }
  13041. }
  13042. }
  13043. },
  13044. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  13045. "get": {
  13046. "produces": [
  13047. "application/json"
  13048. ],
  13049. "tags": [
  13050. "repository"
  13051. ],
  13052. "summary": "Get a release attachment",
  13053. "operationId": "repoGetReleaseAttachment",
  13054. "parameters": [
  13055. {
  13056. "type": "string",
  13057. "description": "owner of the repo",
  13058. "name": "owner",
  13059. "in": "path",
  13060. "required": true
  13061. },
  13062. {
  13063. "type": "string",
  13064. "description": "name of the repo",
  13065. "name": "repo",
  13066. "in": "path",
  13067. "required": true
  13068. },
  13069. {
  13070. "type": "integer",
  13071. "format": "int64",
  13072. "description": "id of the release",
  13073. "name": "id",
  13074. "in": "path",
  13075. "required": true
  13076. },
  13077. {
  13078. "type": "integer",
  13079. "format": "int64",
  13080. "description": "id of the attachment to get",
  13081. "name": "attachment_id",
  13082. "in": "path",
  13083. "required": true
  13084. }
  13085. ],
  13086. "responses": {
  13087. "200": {
  13088. "$ref": "#/responses/Attachment"
  13089. },
  13090. "404": {
  13091. "$ref": "#/responses/notFound"
  13092. }
  13093. }
  13094. },
  13095. "delete": {
  13096. "produces": [
  13097. "application/json"
  13098. ],
  13099. "tags": [
  13100. "repository"
  13101. ],
  13102. "summary": "Delete a release attachment",
  13103. "operationId": "repoDeleteReleaseAttachment",
  13104. "parameters": [
  13105. {
  13106. "type": "string",
  13107. "description": "owner of the repo",
  13108. "name": "owner",
  13109. "in": "path",
  13110. "required": true
  13111. },
  13112. {
  13113. "type": "string",
  13114. "description": "name of the repo",
  13115. "name": "repo",
  13116. "in": "path",
  13117. "required": true
  13118. },
  13119. {
  13120. "type": "integer",
  13121. "format": "int64",
  13122. "description": "id of the release",
  13123. "name": "id",
  13124. "in": "path",
  13125. "required": true
  13126. },
  13127. {
  13128. "type": "integer",
  13129. "format": "int64",
  13130. "description": "id of the attachment to delete",
  13131. "name": "attachment_id",
  13132. "in": "path",
  13133. "required": true
  13134. }
  13135. ],
  13136. "responses": {
  13137. "204": {
  13138. "$ref": "#/responses/empty"
  13139. },
  13140. "404": {
  13141. "$ref": "#/responses/notFound"
  13142. }
  13143. }
  13144. },
  13145. "patch": {
  13146. "consumes": [
  13147. "application/json"
  13148. ],
  13149. "produces": [
  13150. "application/json"
  13151. ],
  13152. "tags": [
  13153. "repository"
  13154. ],
  13155. "summary": "Edit a release attachment",
  13156. "operationId": "repoEditReleaseAttachment",
  13157. "parameters": [
  13158. {
  13159. "type": "string",
  13160. "description": "owner of the repo",
  13161. "name": "owner",
  13162. "in": "path",
  13163. "required": true
  13164. },
  13165. {
  13166. "type": "string",
  13167. "description": "name of the repo",
  13168. "name": "repo",
  13169. "in": "path",
  13170. "required": true
  13171. },
  13172. {
  13173. "type": "integer",
  13174. "format": "int64",
  13175. "description": "id of the release",
  13176. "name": "id",
  13177. "in": "path",
  13178. "required": true
  13179. },
  13180. {
  13181. "type": "integer",
  13182. "format": "int64",
  13183. "description": "id of the attachment to edit",
  13184. "name": "attachment_id",
  13185. "in": "path",
  13186. "required": true
  13187. },
  13188. {
  13189. "name": "body",
  13190. "in": "body",
  13191. "schema": {
  13192. "$ref": "#/definitions/EditAttachmentOptions"
  13193. }
  13194. }
  13195. ],
  13196. "responses": {
  13197. "201": {
  13198. "$ref": "#/responses/Attachment"
  13199. },
  13200. "404": {
  13201. "$ref": "#/responses/notFound"
  13202. }
  13203. }
  13204. }
  13205. },
  13206. "/repos/{owner}/{repo}/reviewers": {
  13207. "get": {
  13208. "produces": [
  13209. "application/json"
  13210. ],
  13211. "tags": [
  13212. "repository"
  13213. ],
  13214. "summary": "Return all users that can be requested to review in this repo",
  13215. "operationId": "repoGetReviewers",
  13216. "parameters": [
  13217. {
  13218. "type": "string",
  13219. "description": "owner of the repo",
  13220. "name": "owner",
  13221. "in": "path",
  13222. "required": true
  13223. },
  13224. {
  13225. "type": "string",
  13226. "description": "name of the repo",
  13227. "name": "repo",
  13228. "in": "path",
  13229. "required": true
  13230. }
  13231. ],
  13232. "responses": {
  13233. "200": {
  13234. "$ref": "#/responses/UserList"
  13235. },
  13236. "404": {
  13237. "$ref": "#/responses/notFound"
  13238. }
  13239. }
  13240. }
  13241. },
  13242. "/repos/{owner}/{repo}/runners/registration-token": {
  13243. "get": {
  13244. "produces": [
  13245. "application/json"
  13246. ],
  13247. "tags": [
  13248. "repository"
  13249. ],
  13250. "summary": "Get a repository's actions runner registration token",
  13251. "operationId": "repoGetRunnerRegistrationToken",
  13252. "parameters": [
  13253. {
  13254. "type": "string",
  13255. "description": "owner of the repo",
  13256. "name": "owner",
  13257. "in": "path",
  13258. "required": true
  13259. },
  13260. {
  13261. "type": "string",
  13262. "description": "name of the repo",
  13263. "name": "repo",
  13264. "in": "path",
  13265. "required": true
  13266. }
  13267. ],
  13268. "responses": {
  13269. "200": {
  13270. "$ref": "#/responses/RegistrationToken"
  13271. }
  13272. }
  13273. }
  13274. },
  13275. "/repos/{owner}/{repo}/signing-key.gpg": {
  13276. "get": {
  13277. "produces": [
  13278. "text/plain"
  13279. ],
  13280. "tags": [
  13281. "repository"
  13282. ],
  13283. "summary": "Get signing-key.gpg for given repository",
  13284. "operationId": "repoSigningKey",
  13285. "parameters": [
  13286. {
  13287. "type": "string",
  13288. "description": "owner of the repo",
  13289. "name": "owner",
  13290. "in": "path",
  13291. "required": true
  13292. },
  13293. {
  13294. "type": "string",
  13295. "description": "name of the repo",
  13296. "name": "repo",
  13297. "in": "path",
  13298. "required": true
  13299. }
  13300. ],
  13301. "responses": {
  13302. "200": {
  13303. "description": "GPG armored public key",
  13304. "schema": {
  13305. "type": "string"
  13306. }
  13307. }
  13308. }
  13309. }
  13310. },
  13311. "/repos/{owner}/{repo}/stargazers": {
  13312. "get": {
  13313. "produces": [
  13314. "application/json"
  13315. ],
  13316. "tags": [
  13317. "repository"
  13318. ],
  13319. "summary": "List a repo's stargazers",
  13320. "operationId": "repoListStargazers",
  13321. "parameters": [
  13322. {
  13323. "type": "string",
  13324. "description": "owner of the repo",
  13325. "name": "owner",
  13326. "in": "path",
  13327. "required": true
  13328. },
  13329. {
  13330. "type": "string",
  13331. "description": "name of the repo",
  13332. "name": "repo",
  13333. "in": "path",
  13334. "required": true
  13335. },
  13336. {
  13337. "type": "integer",
  13338. "description": "page number of results to return (1-based)",
  13339. "name": "page",
  13340. "in": "query"
  13341. },
  13342. {
  13343. "type": "integer",
  13344. "description": "page size of results",
  13345. "name": "limit",
  13346. "in": "query"
  13347. }
  13348. ],
  13349. "responses": {
  13350. "200": {
  13351. "$ref": "#/responses/UserList"
  13352. },
  13353. "404": {
  13354. "$ref": "#/responses/notFound"
  13355. }
  13356. }
  13357. }
  13358. },
  13359. "/repos/{owner}/{repo}/statuses/{sha}": {
  13360. "get": {
  13361. "produces": [
  13362. "application/json"
  13363. ],
  13364. "tags": [
  13365. "repository"
  13366. ],
  13367. "summary": "Get a commit's statuses",
  13368. "operationId": "repoListStatuses",
  13369. "parameters": [
  13370. {
  13371. "type": "string",
  13372. "description": "owner of the repo",
  13373. "name": "owner",
  13374. "in": "path",
  13375. "required": true
  13376. },
  13377. {
  13378. "type": "string",
  13379. "description": "name of the repo",
  13380. "name": "repo",
  13381. "in": "path",
  13382. "required": true
  13383. },
  13384. {
  13385. "type": "string",
  13386. "description": "sha of the commit",
  13387. "name": "sha",
  13388. "in": "path",
  13389. "required": true
  13390. },
  13391. {
  13392. "enum": [
  13393. "oldest",
  13394. "recentupdate",
  13395. "leastupdate",
  13396. "leastindex",
  13397. "highestindex"
  13398. ],
  13399. "type": "string",
  13400. "description": "type of sort",
  13401. "name": "sort",
  13402. "in": "query"
  13403. },
  13404. {
  13405. "enum": [
  13406. "pending",
  13407. "success",
  13408. "error",
  13409. "failure",
  13410. "warning"
  13411. ],
  13412. "type": "string",
  13413. "description": "type of state",
  13414. "name": "state",
  13415. "in": "query"
  13416. },
  13417. {
  13418. "type": "integer",
  13419. "description": "page number of results to return (1-based)",
  13420. "name": "page",
  13421. "in": "query"
  13422. },
  13423. {
  13424. "type": "integer",
  13425. "description": "page size of results",
  13426. "name": "limit",
  13427. "in": "query"
  13428. }
  13429. ],
  13430. "responses": {
  13431. "200": {
  13432. "$ref": "#/responses/CommitStatusList"
  13433. },
  13434. "400": {
  13435. "$ref": "#/responses/error"
  13436. },
  13437. "404": {
  13438. "$ref": "#/responses/notFound"
  13439. }
  13440. }
  13441. },
  13442. "post": {
  13443. "produces": [
  13444. "application/json"
  13445. ],
  13446. "tags": [
  13447. "repository"
  13448. ],
  13449. "summary": "Create a commit status",
  13450. "operationId": "repoCreateStatus",
  13451. "parameters": [
  13452. {
  13453. "type": "string",
  13454. "description": "owner of the repo",
  13455. "name": "owner",
  13456. "in": "path",
  13457. "required": true
  13458. },
  13459. {
  13460. "type": "string",
  13461. "description": "name of the repo",
  13462. "name": "repo",
  13463. "in": "path",
  13464. "required": true
  13465. },
  13466. {
  13467. "type": "string",
  13468. "description": "sha of the commit",
  13469. "name": "sha",
  13470. "in": "path",
  13471. "required": true
  13472. },
  13473. {
  13474. "name": "body",
  13475. "in": "body",
  13476. "schema": {
  13477. "$ref": "#/definitions/CreateStatusOption"
  13478. }
  13479. }
  13480. ],
  13481. "responses": {
  13482. "201": {
  13483. "$ref": "#/responses/CommitStatus"
  13484. },
  13485. "400": {
  13486. "$ref": "#/responses/error"
  13487. },
  13488. "404": {
  13489. "$ref": "#/responses/notFound"
  13490. }
  13491. }
  13492. }
  13493. },
  13494. "/repos/{owner}/{repo}/subscribers": {
  13495. "get": {
  13496. "produces": [
  13497. "application/json"
  13498. ],
  13499. "tags": [
  13500. "repository"
  13501. ],
  13502. "summary": "List a repo's watchers",
  13503. "operationId": "repoListSubscribers",
  13504. "parameters": [
  13505. {
  13506. "type": "string",
  13507. "description": "owner of the repo",
  13508. "name": "owner",
  13509. "in": "path",
  13510. "required": true
  13511. },
  13512. {
  13513. "type": "string",
  13514. "description": "name of the repo",
  13515. "name": "repo",
  13516. "in": "path",
  13517. "required": true
  13518. },
  13519. {
  13520. "type": "integer",
  13521. "description": "page number of results to return (1-based)",
  13522. "name": "page",
  13523. "in": "query"
  13524. },
  13525. {
  13526. "type": "integer",
  13527. "description": "page size of results",
  13528. "name": "limit",
  13529. "in": "query"
  13530. }
  13531. ],
  13532. "responses": {
  13533. "200": {
  13534. "$ref": "#/responses/UserList"
  13535. },
  13536. "404": {
  13537. "$ref": "#/responses/notFound"
  13538. }
  13539. }
  13540. }
  13541. },
  13542. "/repos/{owner}/{repo}/subscription": {
  13543. "get": {
  13544. "tags": [
  13545. "repository"
  13546. ],
  13547. "summary": "Check if the current user is watching a repo",
  13548. "operationId": "userCurrentCheckSubscription",
  13549. "parameters": [
  13550. {
  13551. "type": "string",
  13552. "description": "owner of the repo",
  13553. "name": "owner",
  13554. "in": "path",
  13555. "required": true
  13556. },
  13557. {
  13558. "type": "string",
  13559. "description": "name of the repo",
  13560. "name": "repo",
  13561. "in": "path",
  13562. "required": true
  13563. }
  13564. ],
  13565. "responses": {
  13566. "200": {
  13567. "$ref": "#/responses/WatchInfo"
  13568. },
  13569. "404": {
  13570. "description": "User is not watching this repo or repo do not exist"
  13571. }
  13572. }
  13573. },
  13574. "put": {
  13575. "tags": [
  13576. "repository"
  13577. ],
  13578. "summary": "Watch a repo",
  13579. "operationId": "userCurrentPutSubscription",
  13580. "parameters": [
  13581. {
  13582. "type": "string",
  13583. "description": "owner of the repo",
  13584. "name": "owner",
  13585. "in": "path",
  13586. "required": true
  13587. },
  13588. {
  13589. "type": "string",
  13590. "description": "name of the repo",
  13591. "name": "repo",
  13592. "in": "path",
  13593. "required": true
  13594. }
  13595. ],
  13596. "responses": {
  13597. "200": {
  13598. "$ref": "#/responses/WatchInfo"
  13599. },
  13600. "403": {
  13601. "$ref": "#/responses/forbidden"
  13602. },
  13603. "404": {
  13604. "$ref": "#/responses/notFound"
  13605. }
  13606. }
  13607. },
  13608. "delete": {
  13609. "tags": [
  13610. "repository"
  13611. ],
  13612. "summary": "Unwatch a repo",
  13613. "operationId": "userCurrentDeleteSubscription",
  13614. "parameters": [
  13615. {
  13616. "type": "string",
  13617. "description": "owner of the repo",
  13618. "name": "owner",
  13619. "in": "path",
  13620. "required": true
  13621. },
  13622. {
  13623. "type": "string",
  13624. "description": "name of the repo",
  13625. "name": "repo",
  13626. "in": "path",
  13627. "required": true
  13628. }
  13629. ],
  13630. "responses": {
  13631. "204": {
  13632. "$ref": "#/responses/empty"
  13633. },
  13634. "404": {
  13635. "$ref": "#/responses/notFound"
  13636. }
  13637. }
  13638. }
  13639. },
  13640. "/repos/{owner}/{repo}/tags": {
  13641. "get": {
  13642. "produces": [
  13643. "application/json"
  13644. ],
  13645. "tags": [
  13646. "repository"
  13647. ],
  13648. "summary": "List a repository's tags",
  13649. "operationId": "repoListTags",
  13650. "parameters": [
  13651. {
  13652. "type": "string",
  13653. "description": "owner of the repo",
  13654. "name": "owner",
  13655. "in": "path",
  13656. "required": true
  13657. },
  13658. {
  13659. "type": "string",
  13660. "description": "name of the repo",
  13661. "name": "repo",
  13662. "in": "path",
  13663. "required": true
  13664. },
  13665. {
  13666. "type": "integer",
  13667. "description": "page number of results to return (1-based)",
  13668. "name": "page",
  13669. "in": "query"
  13670. },
  13671. {
  13672. "type": "integer",
  13673. "description": "page size of results, default maximum page size is 50",
  13674. "name": "limit",
  13675. "in": "query"
  13676. }
  13677. ],
  13678. "responses": {
  13679. "200": {
  13680. "$ref": "#/responses/TagList"
  13681. },
  13682. "404": {
  13683. "$ref": "#/responses/notFound"
  13684. }
  13685. }
  13686. },
  13687. "post": {
  13688. "produces": [
  13689. "application/json"
  13690. ],
  13691. "tags": [
  13692. "repository"
  13693. ],
  13694. "summary": "Create a new git tag in a repository",
  13695. "operationId": "repoCreateTag",
  13696. "parameters": [
  13697. {
  13698. "type": "string",
  13699. "description": "owner of the repo",
  13700. "name": "owner",
  13701. "in": "path",
  13702. "required": true
  13703. },
  13704. {
  13705. "type": "string",
  13706. "description": "name of the repo",
  13707. "name": "repo",
  13708. "in": "path",
  13709. "required": true
  13710. },
  13711. {
  13712. "name": "body",
  13713. "in": "body",
  13714. "schema": {
  13715. "$ref": "#/definitions/CreateTagOption"
  13716. }
  13717. }
  13718. ],
  13719. "responses": {
  13720. "200": {
  13721. "$ref": "#/responses/Tag"
  13722. },
  13723. "404": {
  13724. "$ref": "#/responses/notFound"
  13725. },
  13726. "405": {
  13727. "$ref": "#/responses/empty"
  13728. },
  13729. "409": {
  13730. "$ref": "#/responses/conflict"
  13731. },
  13732. "423": {
  13733. "$ref": "#/responses/repoArchivedError"
  13734. }
  13735. }
  13736. }
  13737. },
  13738. "/repos/{owner}/{repo}/tags/{tag}": {
  13739. "get": {
  13740. "produces": [
  13741. "application/json"
  13742. ],
  13743. "tags": [
  13744. "repository"
  13745. ],
  13746. "summary": "Get the tag of a repository by tag name",
  13747. "operationId": "repoGetTag",
  13748. "parameters": [
  13749. {
  13750. "type": "string",
  13751. "description": "owner of the repo",
  13752. "name": "owner",
  13753. "in": "path",
  13754. "required": true
  13755. },
  13756. {
  13757. "type": "string",
  13758. "description": "name of the repo",
  13759. "name": "repo",
  13760. "in": "path",
  13761. "required": true
  13762. },
  13763. {
  13764. "type": "string",
  13765. "description": "name of tag",
  13766. "name": "tag",
  13767. "in": "path",
  13768. "required": true
  13769. }
  13770. ],
  13771. "responses": {
  13772. "200": {
  13773. "$ref": "#/responses/Tag"
  13774. },
  13775. "404": {
  13776. "$ref": "#/responses/notFound"
  13777. }
  13778. }
  13779. },
  13780. "delete": {
  13781. "produces": [
  13782. "application/json"
  13783. ],
  13784. "tags": [
  13785. "repository"
  13786. ],
  13787. "summary": "Delete a repository's tag by name",
  13788. "operationId": "repoDeleteTag",
  13789. "parameters": [
  13790. {
  13791. "type": "string",
  13792. "description": "owner of the repo",
  13793. "name": "owner",
  13794. "in": "path",
  13795. "required": true
  13796. },
  13797. {
  13798. "type": "string",
  13799. "description": "name of the repo",
  13800. "name": "repo",
  13801. "in": "path",
  13802. "required": true
  13803. },
  13804. {
  13805. "type": "string",
  13806. "description": "name of tag to delete",
  13807. "name": "tag",
  13808. "in": "path",
  13809. "required": true
  13810. }
  13811. ],
  13812. "responses": {
  13813. "204": {
  13814. "$ref": "#/responses/empty"
  13815. },
  13816. "404": {
  13817. "$ref": "#/responses/notFound"
  13818. },
  13819. "405": {
  13820. "$ref": "#/responses/empty"
  13821. },
  13822. "409": {
  13823. "$ref": "#/responses/conflict"
  13824. },
  13825. "423": {
  13826. "$ref": "#/responses/repoArchivedError"
  13827. }
  13828. }
  13829. }
  13830. },
  13831. "/repos/{owner}/{repo}/teams": {
  13832. "get": {
  13833. "produces": [
  13834. "application/json"
  13835. ],
  13836. "tags": [
  13837. "repository"
  13838. ],
  13839. "summary": "List a repository's teams",
  13840. "operationId": "repoListTeams",
  13841. "parameters": [
  13842. {
  13843. "type": "string",
  13844. "description": "owner of the repo",
  13845. "name": "owner",
  13846. "in": "path",
  13847. "required": true
  13848. },
  13849. {
  13850. "type": "string",
  13851. "description": "name of the repo",
  13852. "name": "repo",
  13853. "in": "path",
  13854. "required": true
  13855. }
  13856. ],
  13857. "responses": {
  13858. "200": {
  13859. "$ref": "#/responses/TeamList"
  13860. },
  13861. "404": {
  13862. "$ref": "#/responses/notFound"
  13863. }
  13864. }
  13865. }
  13866. },
  13867. "/repos/{owner}/{repo}/teams/{team}": {
  13868. "get": {
  13869. "produces": [
  13870. "application/json"
  13871. ],
  13872. "tags": [
  13873. "repository"
  13874. ],
  13875. "summary": "Check if a team is assigned to a repository",
  13876. "operationId": "repoCheckTeam",
  13877. "parameters": [
  13878. {
  13879. "type": "string",
  13880. "description": "owner of the repo",
  13881. "name": "owner",
  13882. "in": "path",
  13883. "required": true
  13884. },
  13885. {
  13886. "type": "string",
  13887. "description": "name of the repo",
  13888. "name": "repo",
  13889. "in": "path",
  13890. "required": true
  13891. },
  13892. {
  13893. "type": "string",
  13894. "description": "team name",
  13895. "name": "team",
  13896. "in": "path",
  13897. "required": true
  13898. }
  13899. ],
  13900. "responses": {
  13901. "200": {
  13902. "$ref": "#/responses/Team"
  13903. },
  13904. "404": {
  13905. "$ref": "#/responses/notFound"
  13906. },
  13907. "405": {
  13908. "$ref": "#/responses/error"
  13909. }
  13910. }
  13911. },
  13912. "put": {
  13913. "produces": [
  13914. "application/json"
  13915. ],
  13916. "tags": [
  13917. "repository"
  13918. ],
  13919. "summary": "Add a team to a repository",
  13920. "operationId": "repoAddTeam",
  13921. "parameters": [
  13922. {
  13923. "type": "string",
  13924. "description": "owner of the repo",
  13925. "name": "owner",
  13926. "in": "path",
  13927. "required": true
  13928. },
  13929. {
  13930. "type": "string",
  13931. "description": "name of the repo",
  13932. "name": "repo",
  13933. "in": "path",
  13934. "required": true
  13935. },
  13936. {
  13937. "type": "string",
  13938. "description": "team name",
  13939. "name": "team",
  13940. "in": "path",
  13941. "required": true
  13942. }
  13943. ],
  13944. "responses": {
  13945. "204": {
  13946. "$ref": "#/responses/empty"
  13947. },
  13948. "404": {
  13949. "$ref": "#/responses/notFound"
  13950. },
  13951. "405": {
  13952. "$ref": "#/responses/error"
  13953. },
  13954. "422": {
  13955. "$ref": "#/responses/validationError"
  13956. }
  13957. }
  13958. },
  13959. "delete": {
  13960. "produces": [
  13961. "application/json"
  13962. ],
  13963. "tags": [
  13964. "repository"
  13965. ],
  13966. "summary": "Delete a team from a repository",
  13967. "operationId": "repoDeleteTeam",
  13968. "parameters": [
  13969. {
  13970. "type": "string",
  13971. "description": "owner of the repo",
  13972. "name": "owner",
  13973. "in": "path",
  13974. "required": true
  13975. },
  13976. {
  13977. "type": "string",
  13978. "description": "name of the repo",
  13979. "name": "repo",
  13980. "in": "path",
  13981. "required": true
  13982. },
  13983. {
  13984. "type": "string",
  13985. "description": "team name",
  13986. "name": "team",
  13987. "in": "path",
  13988. "required": true
  13989. }
  13990. ],
  13991. "responses": {
  13992. "204": {
  13993. "$ref": "#/responses/empty"
  13994. },
  13995. "404": {
  13996. "$ref": "#/responses/notFound"
  13997. },
  13998. "405": {
  13999. "$ref": "#/responses/error"
  14000. },
  14001. "422": {
  14002. "$ref": "#/responses/validationError"
  14003. }
  14004. }
  14005. }
  14006. },
  14007. "/repos/{owner}/{repo}/times": {
  14008. "get": {
  14009. "produces": [
  14010. "application/json"
  14011. ],
  14012. "tags": [
  14013. "repository"
  14014. ],
  14015. "summary": "List a repo's tracked times",
  14016. "operationId": "repoTrackedTimes",
  14017. "parameters": [
  14018. {
  14019. "type": "string",
  14020. "description": "owner of the repo",
  14021. "name": "owner",
  14022. "in": "path",
  14023. "required": true
  14024. },
  14025. {
  14026. "type": "string",
  14027. "description": "name of the repo",
  14028. "name": "repo",
  14029. "in": "path",
  14030. "required": true
  14031. },
  14032. {
  14033. "type": "string",
  14034. "description": "optional filter by user (available for issue managers)",
  14035. "name": "user",
  14036. "in": "query"
  14037. },
  14038. {
  14039. "type": "string",
  14040. "format": "date-time",
  14041. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  14042. "name": "since",
  14043. "in": "query"
  14044. },
  14045. {
  14046. "type": "string",
  14047. "format": "date-time",
  14048. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  14049. "name": "before",
  14050. "in": "query"
  14051. },
  14052. {
  14053. "type": "integer",
  14054. "description": "page number of results to return (1-based)",
  14055. "name": "page",
  14056. "in": "query"
  14057. },
  14058. {
  14059. "type": "integer",
  14060. "description": "page size of results",
  14061. "name": "limit",
  14062. "in": "query"
  14063. }
  14064. ],
  14065. "responses": {
  14066. "200": {
  14067. "$ref": "#/responses/TrackedTimeList"
  14068. },
  14069. "400": {
  14070. "$ref": "#/responses/error"
  14071. },
  14072. "403": {
  14073. "$ref": "#/responses/forbidden"
  14074. },
  14075. "404": {
  14076. "$ref": "#/responses/notFound"
  14077. }
  14078. }
  14079. }
  14080. },
  14081. "/repos/{owner}/{repo}/times/{user}": {
  14082. "get": {
  14083. "produces": [
  14084. "application/json"
  14085. ],
  14086. "tags": [
  14087. "repository"
  14088. ],
  14089. "summary": "List a user's tracked times in a repo",
  14090. "operationId": "userTrackedTimes",
  14091. "deprecated": true,
  14092. "parameters": [
  14093. {
  14094. "type": "string",
  14095. "description": "owner of the repo",
  14096. "name": "owner",
  14097. "in": "path",
  14098. "required": true
  14099. },
  14100. {
  14101. "type": "string",
  14102. "description": "name of the repo",
  14103. "name": "repo",
  14104. "in": "path",
  14105. "required": true
  14106. },
  14107. {
  14108. "type": "string",
  14109. "description": "username of user",
  14110. "name": "user",
  14111. "in": "path",
  14112. "required": true
  14113. }
  14114. ],
  14115. "responses": {
  14116. "200": {
  14117. "$ref": "#/responses/TrackedTimeList"
  14118. },
  14119. "400": {
  14120. "$ref": "#/responses/error"
  14121. },
  14122. "403": {
  14123. "$ref": "#/responses/forbidden"
  14124. },
  14125. "404": {
  14126. "$ref": "#/responses/notFound"
  14127. }
  14128. }
  14129. }
  14130. },
  14131. "/repos/{owner}/{repo}/topics": {
  14132. "get": {
  14133. "produces": [
  14134. "application/json"
  14135. ],
  14136. "tags": [
  14137. "repository"
  14138. ],
  14139. "summary": "Get list of topics that a repository has",
  14140. "operationId": "repoListTopics",
  14141. "parameters": [
  14142. {
  14143. "type": "string",
  14144. "description": "owner of the repo",
  14145. "name": "owner",
  14146. "in": "path",
  14147. "required": true
  14148. },
  14149. {
  14150. "type": "string",
  14151. "description": "name of the repo",
  14152. "name": "repo",
  14153. "in": "path",
  14154. "required": true
  14155. },
  14156. {
  14157. "type": "integer",
  14158. "description": "page number of results to return (1-based)",
  14159. "name": "page",
  14160. "in": "query"
  14161. },
  14162. {
  14163. "type": "integer",
  14164. "description": "page size of results",
  14165. "name": "limit",
  14166. "in": "query"
  14167. }
  14168. ],
  14169. "responses": {
  14170. "200": {
  14171. "$ref": "#/responses/TopicNames"
  14172. },
  14173. "404": {
  14174. "$ref": "#/responses/notFound"
  14175. }
  14176. }
  14177. },
  14178. "put": {
  14179. "produces": [
  14180. "application/json"
  14181. ],
  14182. "tags": [
  14183. "repository"
  14184. ],
  14185. "summary": "Replace list of topics for a repository",
  14186. "operationId": "repoUpdateTopics",
  14187. "parameters": [
  14188. {
  14189. "type": "string",
  14190. "description": "owner of the repo",
  14191. "name": "owner",
  14192. "in": "path",
  14193. "required": true
  14194. },
  14195. {
  14196. "type": "string",
  14197. "description": "name of the repo",
  14198. "name": "repo",
  14199. "in": "path",
  14200. "required": true
  14201. },
  14202. {
  14203. "name": "body",
  14204. "in": "body",
  14205. "schema": {
  14206. "$ref": "#/definitions/RepoTopicOptions"
  14207. }
  14208. }
  14209. ],
  14210. "responses": {
  14211. "204": {
  14212. "$ref": "#/responses/empty"
  14213. },
  14214. "404": {
  14215. "$ref": "#/responses/notFound"
  14216. },
  14217. "422": {
  14218. "$ref": "#/responses/invalidTopicsError"
  14219. }
  14220. }
  14221. }
  14222. },
  14223. "/repos/{owner}/{repo}/topics/{topic}": {
  14224. "put": {
  14225. "produces": [
  14226. "application/json"
  14227. ],
  14228. "tags": [
  14229. "repository"
  14230. ],
  14231. "summary": "Add a topic to a repository",
  14232. "operationId": "repoAddTopic",
  14233. "parameters": [
  14234. {
  14235. "type": "string",
  14236. "description": "owner of the repo",
  14237. "name": "owner",
  14238. "in": "path",
  14239. "required": true
  14240. },
  14241. {
  14242. "type": "string",
  14243. "description": "name of the repo",
  14244. "name": "repo",
  14245. "in": "path",
  14246. "required": true
  14247. },
  14248. {
  14249. "type": "string",
  14250. "description": "name of the topic to add",
  14251. "name": "topic",
  14252. "in": "path",
  14253. "required": true
  14254. }
  14255. ],
  14256. "responses": {
  14257. "204": {
  14258. "$ref": "#/responses/empty"
  14259. },
  14260. "404": {
  14261. "$ref": "#/responses/notFound"
  14262. },
  14263. "422": {
  14264. "$ref": "#/responses/invalidTopicsError"
  14265. }
  14266. }
  14267. },
  14268. "delete": {
  14269. "produces": [
  14270. "application/json"
  14271. ],
  14272. "tags": [
  14273. "repository"
  14274. ],
  14275. "summary": "Delete a topic from a repository",
  14276. "operationId": "repoDeleteTopic",
  14277. "parameters": [
  14278. {
  14279. "type": "string",
  14280. "description": "owner of the repo",
  14281. "name": "owner",
  14282. "in": "path",
  14283. "required": true
  14284. },
  14285. {
  14286. "type": "string",
  14287. "description": "name of the repo",
  14288. "name": "repo",
  14289. "in": "path",
  14290. "required": true
  14291. },
  14292. {
  14293. "type": "string",
  14294. "description": "name of the topic to delete",
  14295. "name": "topic",
  14296. "in": "path",
  14297. "required": true
  14298. }
  14299. ],
  14300. "responses": {
  14301. "204": {
  14302. "$ref": "#/responses/empty"
  14303. },
  14304. "404": {
  14305. "$ref": "#/responses/notFound"
  14306. },
  14307. "422": {
  14308. "$ref": "#/responses/invalidTopicsError"
  14309. }
  14310. }
  14311. }
  14312. },
  14313. "/repos/{owner}/{repo}/transfer": {
  14314. "post": {
  14315. "produces": [
  14316. "application/json"
  14317. ],
  14318. "tags": [
  14319. "repository"
  14320. ],
  14321. "summary": "Transfer a repo ownership",
  14322. "operationId": "repoTransfer",
  14323. "parameters": [
  14324. {
  14325. "type": "string",
  14326. "description": "owner of the repo to transfer",
  14327. "name": "owner",
  14328. "in": "path",
  14329. "required": true
  14330. },
  14331. {
  14332. "type": "string",
  14333. "description": "name of the repo to transfer",
  14334. "name": "repo",
  14335. "in": "path",
  14336. "required": true
  14337. },
  14338. {
  14339. "description": "Transfer Options",
  14340. "name": "body",
  14341. "in": "body",
  14342. "required": true,
  14343. "schema": {
  14344. "$ref": "#/definitions/TransferRepoOption"
  14345. }
  14346. }
  14347. ],
  14348. "responses": {
  14349. "202": {
  14350. "$ref": "#/responses/Repository"
  14351. },
  14352. "403": {
  14353. "$ref": "#/responses/forbidden"
  14354. },
  14355. "404": {
  14356. "$ref": "#/responses/notFound"
  14357. },
  14358. "422": {
  14359. "$ref": "#/responses/validationError"
  14360. }
  14361. }
  14362. }
  14363. },
  14364. "/repos/{owner}/{repo}/transfer/accept": {
  14365. "post": {
  14366. "produces": [
  14367. "application/json"
  14368. ],
  14369. "tags": [
  14370. "repository"
  14371. ],
  14372. "summary": "Accept a repo transfer",
  14373. "operationId": "acceptRepoTransfer",
  14374. "parameters": [
  14375. {
  14376. "type": "string",
  14377. "description": "owner of the repo to transfer",
  14378. "name": "owner",
  14379. "in": "path",
  14380. "required": true
  14381. },
  14382. {
  14383. "type": "string",
  14384. "description": "name of the repo to transfer",
  14385. "name": "repo",
  14386. "in": "path",
  14387. "required": true
  14388. }
  14389. ],
  14390. "responses": {
  14391. "202": {
  14392. "$ref": "#/responses/Repository"
  14393. },
  14394. "403": {
  14395. "$ref": "#/responses/forbidden"
  14396. },
  14397. "404": {
  14398. "$ref": "#/responses/notFound"
  14399. }
  14400. }
  14401. }
  14402. },
  14403. "/repos/{owner}/{repo}/transfer/reject": {
  14404. "post": {
  14405. "produces": [
  14406. "application/json"
  14407. ],
  14408. "tags": [
  14409. "repository"
  14410. ],
  14411. "summary": "Reject a repo transfer",
  14412. "operationId": "rejectRepoTransfer",
  14413. "parameters": [
  14414. {
  14415. "type": "string",
  14416. "description": "owner of the repo to transfer",
  14417. "name": "owner",
  14418. "in": "path",
  14419. "required": true
  14420. },
  14421. {
  14422. "type": "string",
  14423. "description": "name of the repo to transfer",
  14424. "name": "repo",
  14425. "in": "path",
  14426. "required": true
  14427. }
  14428. ],
  14429. "responses": {
  14430. "200": {
  14431. "$ref": "#/responses/Repository"
  14432. },
  14433. "403": {
  14434. "$ref": "#/responses/forbidden"
  14435. },
  14436. "404": {
  14437. "$ref": "#/responses/notFound"
  14438. }
  14439. }
  14440. }
  14441. },
  14442. "/repos/{owner}/{repo}/wiki/new": {
  14443. "post": {
  14444. "consumes": [
  14445. "application/json"
  14446. ],
  14447. "tags": [
  14448. "repository"
  14449. ],
  14450. "summary": "Create a wiki page",
  14451. "operationId": "repoCreateWikiPage",
  14452. "parameters": [
  14453. {
  14454. "type": "string",
  14455. "description": "owner of the repo",
  14456. "name": "owner",
  14457. "in": "path",
  14458. "required": true
  14459. },
  14460. {
  14461. "type": "string",
  14462. "description": "name of the repo",
  14463. "name": "repo",
  14464. "in": "path",
  14465. "required": true
  14466. },
  14467. {
  14468. "name": "body",
  14469. "in": "body",
  14470. "schema": {
  14471. "$ref": "#/definitions/CreateWikiPageOptions"
  14472. }
  14473. }
  14474. ],
  14475. "responses": {
  14476. "201": {
  14477. "$ref": "#/responses/WikiPage"
  14478. },
  14479. "400": {
  14480. "$ref": "#/responses/error"
  14481. },
  14482. "403": {
  14483. "$ref": "#/responses/forbidden"
  14484. },
  14485. "404": {
  14486. "$ref": "#/responses/notFound"
  14487. },
  14488. "423": {
  14489. "$ref": "#/responses/repoArchivedError"
  14490. }
  14491. }
  14492. }
  14493. },
  14494. "/repos/{owner}/{repo}/wiki/page/{pageName}": {
  14495. "get": {
  14496. "produces": [
  14497. "application/json"
  14498. ],
  14499. "tags": [
  14500. "repository"
  14501. ],
  14502. "summary": "Get a wiki page",
  14503. "operationId": "repoGetWikiPage",
  14504. "parameters": [
  14505. {
  14506. "type": "string",
  14507. "description": "owner of the repo",
  14508. "name": "owner",
  14509. "in": "path",
  14510. "required": true
  14511. },
  14512. {
  14513. "type": "string",
  14514. "description": "name of the repo",
  14515. "name": "repo",
  14516. "in": "path",
  14517. "required": true
  14518. },
  14519. {
  14520. "type": "string",
  14521. "description": "name of the page",
  14522. "name": "pageName",
  14523. "in": "path",
  14524. "required": true
  14525. }
  14526. ],
  14527. "responses": {
  14528. "200": {
  14529. "$ref": "#/responses/WikiPage"
  14530. },
  14531. "404": {
  14532. "$ref": "#/responses/notFound"
  14533. }
  14534. }
  14535. },
  14536. "delete": {
  14537. "tags": [
  14538. "repository"
  14539. ],
  14540. "summary": "Delete a wiki page",
  14541. "operationId": "repoDeleteWikiPage",
  14542. "parameters": [
  14543. {
  14544. "type": "string",
  14545. "description": "owner of the repo",
  14546. "name": "owner",
  14547. "in": "path",
  14548. "required": true
  14549. },
  14550. {
  14551. "type": "string",
  14552. "description": "name of the repo",
  14553. "name": "repo",
  14554. "in": "path",
  14555. "required": true
  14556. },
  14557. {
  14558. "type": "string",
  14559. "description": "name of the page",
  14560. "name": "pageName",
  14561. "in": "path",
  14562. "required": true
  14563. }
  14564. ],
  14565. "responses": {
  14566. "204": {
  14567. "$ref": "#/responses/empty"
  14568. },
  14569. "403": {
  14570. "$ref": "#/responses/forbidden"
  14571. },
  14572. "404": {
  14573. "$ref": "#/responses/notFound"
  14574. },
  14575. "423": {
  14576. "$ref": "#/responses/repoArchivedError"
  14577. }
  14578. }
  14579. },
  14580. "patch": {
  14581. "consumes": [
  14582. "application/json"
  14583. ],
  14584. "tags": [
  14585. "repository"
  14586. ],
  14587. "summary": "Edit a wiki page",
  14588. "operationId": "repoEditWikiPage",
  14589. "parameters": [
  14590. {
  14591. "type": "string",
  14592. "description": "owner of the repo",
  14593. "name": "owner",
  14594. "in": "path",
  14595. "required": true
  14596. },
  14597. {
  14598. "type": "string",
  14599. "description": "name of the repo",
  14600. "name": "repo",
  14601. "in": "path",
  14602. "required": true
  14603. },
  14604. {
  14605. "type": "string",
  14606. "description": "name of the page",
  14607. "name": "pageName",
  14608. "in": "path",
  14609. "required": true
  14610. },
  14611. {
  14612. "name": "body",
  14613. "in": "body",
  14614. "schema": {
  14615. "$ref": "#/definitions/CreateWikiPageOptions"
  14616. }
  14617. }
  14618. ],
  14619. "responses": {
  14620. "200": {
  14621. "$ref": "#/responses/WikiPage"
  14622. },
  14623. "400": {
  14624. "$ref": "#/responses/error"
  14625. },
  14626. "403": {
  14627. "$ref": "#/responses/forbidden"
  14628. },
  14629. "404": {
  14630. "$ref": "#/responses/notFound"
  14631. },
  14632. "423": {
  14633. "$ref": "#/responses/repoArchivedError"
  14634. }
  14635. }
  14636. }
  14637. },
  14638. "/repos/{owner}/{repo}/wiki/pages": {
  14639. "get": {
  14640. "produces": [
  14641. "application/json"
  14642. ],
  14643. "tags": [
  14644. "repository"
  14645. ],
  14646. "summary": "Get all wiki pages",
  14647. "operationId": "repoGetWikiPages",
  14648. "parameters": [
  14649. {
  14650. "type": "string",
  14651. "description": "owner of the repo",
  14652. "name": "owner",
  14653. "in": "path",
  14654. "required": true
  14655. },
  14656. {
  14657. "type": "string",
  14658. "description": "name of the repo",
  14659. "name": "repo",
  14660. "in": "path",
  14661. "required": true
  14662. },
  14663. {
  14664. "type": "integer",
  14665. "description": "page number of results to return (1-based)",
  14666. "name": "page",
  14667. "in": "query"
  14668. },
  14669. {
  14670. "type": "integer",
  14671. "description": "page size of results",
  14672. "name": "limit",
  14673. "in": "query"
  14674. }
  14675. ],
  14676. "responses": {
  14677. "200": {
  14678. "$ref": "#/responses/WikiPageList"
  14679. },
  14680. "404": {
  14681. "$ref": "#/responses/notFound"
  14682. }
  14683. }
  14684. }
  14685. },
  14686. "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
  14687. "get": {
  14688. "produces": [
  14689. "application/json"
  14690. ],
  14691. "tags": [
  14692. "repository"
  14693. ],
  14694. "summary": "Get revisions of a wiki page",
  14695. "operationId": "repoGetWikiPageRevisions",
  14696. "parameters": [
  14697. {
  14698. "type": "string",
  14699. "description": "owner of the repo",
  14700. "name": "owner",
  14701. "in": "path",
  14702. "required": true
  14703. },
  14704. {
  14705. "type": "string",
  14706. "description": "name of the repo",
  14707. "name": "repo",
  14708. "in": "path",
  14709. "required": true
  14710. },
  14711. {
  14712. "type": "string",
  14713. "description": "name of the page",
  14714. "name": "pageName",
  14715. "in": "path",
  14716. "required": true
  14717. },
  14718. {
  14719. "type": "integer",
  14720. "description": "page number of results to return (1-based)",
  14721. "name": "page",
  14722. "in": "query"
  14723. }
  14724. ],
  14725. "responses": {
  14726. "200": {
  14727. "$ref": "#/responses/WikiCommitList"
  14728. },
  14729. "404": {
  14730. "$ref": "#/responses/notFound"
  14731. }
  14732. }
  14733. }
  14734. },
  14735. "/repos/{template_owner}/{template_repo}/generate": {
  14736. "post": {
  14737. "consumes": [
  14738. "application/json"
  14739. ],
  14740. "produces": [
  14741. "application/json"
  14742. ],
  14743. "tags": [
  14744. "repository"
  14745. ],
  14746. "summary": "Create a repository using a template",
  14747. "operationId": "generateRepo",
  14748. "parameters": [
  14749. {
  14750. "type": "string",
  14751. "description": "name of the template repository owner",
  14752. "name": "template_owner",
  14753. "in": "path",
  14754. "required": true
  14755. },
  14756. {
  14757. "type": "string",
  14758. "description": "name of the template repository",
  14759. "name": "template_repo",
  14760. "in": "path",
  14761. "required": true
  14762. },
  14763. {
  14764. "name": "body",
  14765. "in": "body",
  14766. "schema": {
  14767. "$ref": "#/definitions/GenerateRepoOption"
  14768. }
  14769. }
  14770. ],
  14771. "responses": {
  14772. "201": {
  14773. "$ref": "#/responses/Repository"
  14774. },
  14775. "403": {
  14776. "$ref": "#/responses/forbidden"
  14777. },
  14778. "404": {
  14779. "$ref": "#/responses/notFound"
  14780. },
  14781. "409": {
  14782. "description": "The repository with the same name already exists."
  14783. },
  14784. "422": {
  14785. "$ref": "#/responses/validationError"
  14786. }
  14787. }
  14788. }
  14789. },
  14790. "/repositories/{id}": {
  14791. "get": {
  14792. "produces": [
  14793. "application/json"
  14794. ],
  14795. "tags": [
  14796. "repository"
  14797. ],
  14798. "summary": "Get a repository by id",
  14799. "operationId": "repoGetByID",
  14800. "parameters": [
  14801. {
  14802. "type": "integer",
  14803. "format": "int64",
  14804. "description": "id of the repo to get",
  14805. "name": "id",
  14806. "in": "path",
  14807. "required": true
  14808. }
  14809. ],
  14810. "responses": {
  14811. "200": {
  14812. "$ref": "#/responses/Repository"
  14813. },
  14814. "404": {
  14815. "$ref": "#/responses/notFound"
  14816. }
  14817. }
  14818. }
  14819. },
  14820. "/settings/api": {
  14821. "get": {
  14822. "produces": [
  14823. "application/json"
  14824. ],
  14825. "tags": [
  14826. "settings"
  14827. ],
  14828. "summary": "Get instance's global settings for api",
  14829. "operationId": "getGeneralAPISettings",
  14830. "responses": {
  14831. "200": {
  14832. "$ref": "#/responses/GeneralAPISettings"
  14833. }
  14834. }
  14835. }
  14836. },
  14837. "/settings/attachment": {
  14838. "get": {
  14839. "produces": [
  14840. "application/json"
  14841. ],
  14842. "tags": [
  14843. "settings"
  14844. ],
  14845. "summary": "Get instance's global settings for Attachment",
  14846. "operationId": "getGeneralAttachmentSettings",
  14847. "responses": {
  14848. "200": {
  14849. "$ref": "#/responses/GeneralAttachmentSettings"
  14850. }
  14851. }
  14852. }
  14853. },
  14854. "/settings/repository": {
  14855. "get": {
  14856. "produces": [
  14857. "application/json"
  14858. ],
  14859. "tags": [
  14860. "settings"
  14861. ],
  14862. "summary": "Get instance's global settings for repositories",
  14863. "operationId": "getGeneralRepositorySettings",
  14864. "responses": {
  14865. "200": {
  14866. "$ref": "#/responses/GeneralRepoSettings"
  14867. }
  14868. }
  14869. }
  14870. },
  14871. "/settings/ui": {
  14872. "get": {
  14873. "produces": [
  14874. "application/json"
  14875. ],
  14876. "tags": [
  14877. "settings"
  14878. ],
  14879. "summary": "Get instance's global settings for ui",
  14880. "operationId": "getGeneralUISettings",
  14881. "responses": {
  14882. "200": {
  14883. "$ref": "#/responses/GeneralUISettings"
  14884. }
  14885. }
  14886. }
  14887. },
  14888. "/signing-key.gpg": {
  14889. "get": {
  14890. "produces": [
  14891. "text/plain"
  14892. ],
  14893. "tags": [
  14894. "miscellaneous"
  14895. ],
  14896. "summary": "Get default signing-key.gpg",
  14897. "operationId": "getSigningKey",
  14898. "responses": {
  14899. "200": {
  14900. "description": "GPG armored public key",
  14901. "schema": {
  14902. "type": "string"
  14903. }
  14904. }
  14905. }
  14906. }
  14907. },
  14908. "/teams/{id}": {
  14909. "get": {
  14910. "produces": [
  14911. "application/json"
  14912. ],
  14913. "tags": [
  14914. "organization"
  14915. ],
  14916. "summary": "Get a team",
  14917. "operationId": "orgGetTeam",
  14918. "parameters": [
  14919. {
  14920. "type": "integer",
  14921. "format": "int64",
  14922. "description": "id of the team to get",
  14923. "name": "id",
  14924. "in": "path",
  14925. "required": true
  14926. }
  14927. ],
  14928. "responses": {
  14929. "200": {
  14930. "$ref": "#/responses/Team"
  14931. },
  14932. "404": {
  14933. "$ref": "#/responses/notFound"
  14934. }
  14935. }
  14936. },
  14937. "delete": {
  14938. "tags": [
  14939. "organization"
  14940. ],
  14941. "summary": "Delete a team",
  14942. "operationId": "orgDeleteTeam",
  14943. "parameters": [
  14944. {
  14945. "type": "integer",
  14946. "format": "int64",
  14947. "description": "id of the team to delete",
  14948. "name": "id",
  14949. "in": "path",
  14950. "required": true
  14951. }
  14952. ],
  14953. "responses": {
  14954. "204": {
  14955. "description": "team deleted"
  14956. },
  14957. "404": {
  14958. "$ref": "#/responses/notFound"
  14959. }
  14960. }
  14961. },
  14962. "patch": {
  14963. "consumes": [
  14964. "application/json"
  14965. ],
  14966. "produces": [
  14967. "application/json"
  14968. ],
  14969. "tags": [
  14970. "organization"
  14971. ],
  14972. "summary": "Edit a team",
  14973. "operationId": "orgEditTeam",
  14974. "parameters": [
  14975. {
  14976. "type": "integer",
  14977. "description": "id of the team to edit",
  14978. "name": "id",
  14979. "in": "path",
  14980. "required": true
  14981. },
  14982. {
  14983. "name": "body",
  14984. "in": "body",
  14985. "schema": {
  14986. "$ref": "#/definitions/EditTeamOption"
  14987. }
  14988. }
  14989. ],
  14990. "responses": {
  14991. "200": {
  14992. "$ref": "#/responses/Team"
  14993. },
  14994. "404": {
  14995. "$ref": "#/responses/notFound"
  14996. }
  14997. }
  14998. }
  14999. },
  15000. "/teams/{id}/activities/feeds": {
  15001. "get": {
  15002. "produces": [
  15003. "application/json"
  15004. ],
  15005. "tags": [
  15006. "organization"
  15007. ],
  15008. "summary": "List a team's activity feeds",
  15009. "operationId": "orgListTeamActivityFeeds",
  15010. "parameters": [
  15011. {
  15012. "type": "integer",
  15013. "format": "int64",
  15014. "description": "id of the team",
  15015. "name": "id",
  15016. "in": "path",
  15017. "required": true
  15018. },
  15019. {
  15020. "type": "string",
  15021. "format": "date",
  15022. "description": "the date of the activities to be found",
  15023. "name": "date",
  15024. "in": "query"
  15025. },
  15026. {
  15027. "type": "integer",
  15028. "description": "page number of results to return (1-based)",
  15029. "name": "page",
  15030. "in": "query"
  15031. },
  15032. {
  15033. "type": "integer",
  15034. "description": "page size of results",
  15035. "name": "limit",
  15036. "in": "query"
  15037. }
  15038. ],
  15039. "responses": {
  15040. "200": {
  15041. "$ref": "#/responses/ActivityFeedsList"
  15042. },
  15043. "404": {
  15044. "$ref": "#/responses/notFound"
  15045. }
  15046. }
  15047. }
  15048. },
  15049. "/teams/{id}/members": {
  15050. "get": {
  15051. "produces": [
  15052. "application/json"
  15053. ],
  15054. "tags": [
  15055. "organization"
  15056. ],
  15057. "summary": "List a team's members",
  15058. "operationId": "orgListTeamMembers",
  15059. "parameters": [
  15060. {
  15061. "type": "integer",
  15062. "format": "int64",
  15063. "description": "id of the team",
  15064. "name": "id",
  15065. "in": "path",
  15066. "required": true
  15067. },
  15068. {
  15069. "type": "integer",
  15070. "description": "page number of results to return (1-based)",
  15071. "name": "page",
  15072. "in": "query"
  15073. },
  15074. {
  15075. "type": "integer",
  15076. "description": "page size of results",
  15077. "name": "limit",
  15078. "in": "query"
  15079. }
  15080. ],
  15081. "responses": {
  15082. "200": {
  15083. "$ref": "#/responses/UserList"
  15084. },
  15085. "404": {
  15086. "$ref": "#/responses/notFound"
  15087. }
  15088. }
  15089. }
  15090. },
  15091. "/teams/{id}/members/{username}": {
  15092. "get": {
  15093. "produces": [
  15094. "application/json"
  15095. ],
  15096. "tags": [
  15097. "organization"
  15098. ],
  15099. "summary": "List a particular member of team",
  15100. "operationId": "orgListTeamMember",
  15101. "parameters": [
  15102. {
  15103. "type": "integer",
  15104. "format": "int64",
  15105. "description": "id of the team",
  15106. "name": "id",
  15107. "in": "path",
  15108. "required": true
  15109. },
  15110. {
  15111. "type": "string",
  15112. "description": "username of the member to list",
  15113. "name": "username",
  15114. "in": "path",
  15115. "required": true
  15116. }
  15117. ],
  15118. "responses": {
  15119. "200": {
  15120. "$ref": "#/responses/User"
  15121. },
  15122. "404": {
  15123. "$ref": "#/responses/notFound"
  15124. }
  15125. }
  15126. },
  15127. "put": {
  15128. "produces": [
  15129. "application/json"
  15130. ],
  15131. "tags": [
  15132. "organization"
  15133. ],
  15134. "summary": "Add a team member",
  15135. "operationId": "orgAddTeamMember",
  15136. "parameters": [
  15137. {
  15138. "type": "integer",
  15139. "format": "int64",
  15140. "description": "id of the team",
  15141. "name": "id",
  15142. "in": "path",
  15143. "required": true
  15144. },
  15145. {
  15146. "type": "string",
  15147. "description": "username of the user to add",
  15148. "name": "username",
  15149. "in": "path",
  15150. "required": true
  15151. }
  15152. ],
  15153. "responses": {
  15154. "204": {
  15155. "$ref": "#/responses/empty"
  15156. },
  15157. "403": {
  15158. "$ref": "#/responses/forbidden"
  15159. },
  15160. "404": {
  15161. "$ref": "#/responses/notFound"
  15162. }
  15163. }
  15164. },
  15165. "delete": {
  15166. "produces": [
  15167. "application/json"
  15168. ],
  15169. "tags": [
  15170. "organization"
  15171. ],
  15172. "summary": "Remove a team member",
  15173. "operationId": "orgRemoveTeamMember",
  15174. "parameters": [
  15175. {
  15176. "type": "integer",
  15177. "format": "int64",
  15178. "description": "id of the team",
  15179. "name": "id",
  15180. "in": "path",
  15181. "required": true
  15182. },
  15183. {
  15184. "type": "string",
  15185. "description": "username of the user to remove",
  15186. "name": "username",
  15187. "in": "path",
  15188. "required": true
  15189. }
  15190. ],
  15191. "responses": {
  15192. "204": {
  15193. "$ref": "#/responses/empty"
  15194. },
  15195. "404": {
  15196. "$ref": "#/responses/notFound"
  15197. }
  15198. }
  15199. }
  15200. },
  15201. "/teams/{id}/repos": {
  15202. "get": {
  15203. "produces": [
  15204. "application/json"
  15205. ],
  15206. "tags": [
  15207. "organization"
  15208. ],
  15209. "summary": "List a team's repos",
  15210. "operationId": "orgListTeamRepos",
  15211. "parameters": [
  15212. {
  15213. "type": "integer",
  15214. "format": "int64",
  15215. "description": "id of the team",
  15216. "name": "id",
  15217. "in": "path",
  15218. "required": true
  15219. },
  15220. {
  15221. "type": "integer",
  15222. "description": "page number of results to return (1-based)",
  15223. "name": "page",
  15224. "in": "query"
  15225. },
  15226. {
  15227. "type": "integer",
  15228. "description": "page size of results",
  15229. "name": "limit",
  15230. "in": "query"
  15231. }
  15232. ],
  15233. "responses": {
  15234. "200": {
  15235. "$ref": "#/responses/RepositoryList"
  15236. },
  15237. "404": {
  15238. "$ref": "#/responses/notFound"
  15239. }
  15240. }
  15241. }
  15242. },
  15243. "/teams/{id}/repos/{org}/{repo}": {
  15244. "get": {
  15245. "produces": [
  15246. "application/json"
  15247. ],
  15248. "tags": [
  15249. "organization"
  15250. ],
  15251. "summary": "List a particular repo of team",
  15252. "operationId": "orgListTeamRepo",
  15253. "parameters": [
  15254. {
  15255. "type": "integer",
  15256. "format": "int64",
  15257. "description": "id of the team",
  15258. "name": "id",
  15259. "in": "path",
  15260. "required": true
  15261. },
  15262. {
  15263. "type": "string",
  15264. "description": "organization that owns the repo to list",
  15265. "name": "org",
  15266. "in": "path",
  15267. "required": true
  15268. },
  15269. {
  15270. "type": "string",
  15271. "description": "name of the repo to list",
  15272. "name": "repo",
  15273. "in": "path",
  15274. "required": true
  15275. }
  15276. ],
  15277. "responses": {
  15278. "200": {
  15279. "$ref": "#/responses/Repository"
  15280. },
  15281. "404": {
  15282. "$ref": "#/responses/notFound"
  15283. }
  15284. }
  15285. },
  15286. "put": {
  15287. "produces": [
  15288. "application/json"
  15289. ],
  15290. "tags": [
  15291. "organization"
  15292. ],
  15293. "summary": "Add a repository to a team",
  15294. "operationId": "orgAddTeamRepository",
  15295. "parameters": [
  15296. {
  15297. "type": "integer",
  15298. "format": "int64",
  15299. "description": "id of the team",
  15300. "name": "id",
  15301. "in": "path",
  15302. "required": true
  15303. },
  15304. {
  15305. "type": "string",
  15306. "description": "organization that owns the repo to add",
  15307. "name": "org",
  15308. "in": "path",
  15309. "required": true
  15310. },
  15311. {
  15312. "type": "string",
  15313. "description": "name of the repo to add",
  15314. "name": "repo",
  15315. "in": "path",
  15316. "required": true
  15317. }
  15318. ],
  15319. "responses": {
  15320. "204": {
  15321. "$ref": "#/responses/empty"
  15322. },
  15323. "403": {
  15324. "$ref": "#/responses/forbidden"
  15325. },
  15326. "404": {
  15327. "$ref": "#/responses/notFound"
  15328. }
  15329. }
  15330. },
  15331. "delete": {
  15332. "description": "This does not delete the repository, it only removes the repository from the team.",
  15333. "produces": [
  15334. "application/json"
  15335. ],
  15336. "tags": [
  15337. "organization"
  15338. ],
  15339. "summary": "Remove a repository from a team",
  15340. "operationId": "orgRemoveTeamRepository",
  15341. "parameters": [
  15342. {
  15343. "type": "integer",
  15344. "format": "int64",
  15345. "description": "id of the team",
  15346. "name": "id",
  15347. "in": "path",
  15348. "required": true
  15349. },
  15350. {
  15351. "type": "string",
  15352. "description": "organization that owns the repo to remove",
  15353. "name": "org",
  15354. "in": "path",
  15355. "required": true
  15356. },
  15357. {
  15358. "type": "string",
  15359. "description": "name of the repo to remove",
  15360. "name": "repo",
  15361. "in": "path",
  15362. "required": true
  15363. }
  15364. ],
  15365. "responses": {
  15366. "204": {
  15367. "$ref": "#/responses/empty"
  15368. },
  15369. "403": {
  15370. "$ref": "#/responses/forbidden"
  15371. },
  15372. "404": {
  15373. "$ref": "#/responses/notFound"
  15374. }
  15375. }
  15376. }
  15377. },
  15378. "/topics/search": {
  15379. "get": {
  15380. "produces": [
  15381. "application/json"
  15382. ],
  15383. "tags": [
  15384. "repository"
  15385. ],
  15386. "summary": "search topics via keyword",
  15387. "operationId": "topicSearch",
  15388. "parameters": [
  15389. {
  15390. "type": "string",
  15391. "description": "keywords to search",
  15392. "name": "q",
  15393. "in": "query",
  15394. "required": true
  15395. },
  15396. {
  15397. "type": "integer",
  15398. "description": "page number of results to return (1-based)",
  15399. "name": "page",
  15400. "in": "query"
  15401. },
  15402. {
  15403. "type": "integer",
  15404. "description": "page size of results",
  15405. "name": "limit",
  15406. "in": "query"
  15407. }
  15408. ],
  15409. "responses": {
  15410. "200": {
  15411. "$ref": "#/responses/TopicListResponse"
  15412. },
  15413. "403": {
  15414. "$ref": "#/responses/forbidden"
  15415. },
  15416. "404": {
  15417. "$ref": "#/responses/notFound"
  15418. }
  15419. }
  15420. }
  15421. },
  15422. "/user": {
  15423. "get": {
  15424. "produces": [
  15425. "application/json"
  15426. ],
  15427. "tags": [
  15428. "user"
  15429. ],
  15430. "summary": "Get the authenticated user",
  15431. "operationId": "userGetCurrent",
  15432. "responses": {
  15433. "200": {
  15434. "$ref": "#/responses/User"
  15435. }
  15436. }
  15437. }
  15438. },
  15439. "/user/actions/runners/registration-token": {
  15440. "get": {
  15441. "produces": [
  15442. "application/json"
  15443. ],
  15444. "tags": [
  15445. "user"
  15446. ],
  15447. "summary": "Get an user's actions runner registration token",
  15448. "operationId": "userGetRunnerRegistrationToken",
  15449. "responses": {
  15450. "200": {
  15451. "$ref": "#/responses/RegistrationToken"
  15452. }
  15453. }
  15454. }
  15455. },
  15456. "/user/actions/secrets/{secretname}": {
  15457. "put": {
  15458. "consumes": [
  15459. "application/json"
  15460. ],
  15461. "produces": [
  15462. "application/json"
  15463. ],
  15464. "tags": [
  15465. "user"
  15466. ],
  15467. "summary": "Create or Update a secret value in a user scope",
  15468. "operationId": "updateUserSecret",
  15469. "parameters": [
  15470. {
  15471. "type": "string",
  15472. "description": "name of the secret",
  15473. "name": "secretname",
  15474. "in": "path",
  15475. "required": true
  15476. },
  15477. {
  15478. "name": "body",
  15479. "in": "body",
  15480. "schema": {
  15481. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  15482. }
  15483. }
  15484. ],
  15485. "responses": {
  15486. "201": {
  15487. "description": "response when creating a secret"
  15488. },
  15489. "204": {
  15490. "description": "response when updating a secret"
  15491. },
  15492. "400": {
  15493. "$ref": "#/responses/error"
  15494. },
  15495. "404": {
  15496. "$ref": "#/responses/notFound"
  15497. }
  15498. }
  15499. },
  15500. "delete": {
  15501. "consumes": [
  15502. "application/json"
  15503. ],
  15504. "produces": [
  15505. "application/json"
  15506. ],
  15507. "tags": [
  15508. "user"
  15509. ],
  15510. "summary": "Delete a secret in a user scope",
  15511. "operationId": "deleteUserSecret",
  15512. "parameters": [
  15513. {
  15514. "type": "string",
  15515. "description": "name of the secret",
  15516. "name": "secretname",
  15517. "in": "path",
  15518. "required": true
  15519. }
  15520. ],
  15521. "responses": {
  15522. "204": {
  15523. "description": "delete one secret of the user"
  15524. },
  15525. "400": {
  15526. "$ref": "#/responses/error"
  15527. },
  15528. "404": {
  15529. "$ref": "#/responses/notFound"
  15530. }
  15531. }
  15532. }
  15533. },
  15534. "/user/actions/variables": {
  15535. "get": {
  15536. "produces": [
  15537. "application/json"
  15538. ],
  15539. "tags": [
  15540. "user"
  15541. ],
  15542. "summary": "Get the user-level list of variables which is created by current doer",
  15543. "operationId": "getUserVariablesList",
  15544. "parameters": [
  15545. {
  15546. "type": "integer",
  15547. "description": "page number of results to return (1-based)",
  15548. "name": "page",
  15549. "in": "query"
  15550. },
  15551. {
  15552. "type": "integer",
  15553. "description": "page size of results",
  15554. "name": "limit",
  15555. "in": "query"
  15556. }
  15557. ],
  15558. "responses": {
  15559. "200": {
  15560. "$ref": "#/responses/VariableList"
  15561. },
  15562. "400": {
  15563. "$ref": "#/responses/error"
  15564. },
  15565. "404": {
  15566. "$ref": "#/responses/notFound"
  15567. }
  15568. }
  15569. }
  15570. },
  15571. "/user/actions/variables/{variablename}": {
  15572. "get": {
  15573. "produces": [
  15574. "application/json"
  15575. ],
  15576. "tags": [
  15577. "user"
  15578. ],
  15579. "summary": "Get a user-level variable which is created by current doer",
  15580. "operationId": "getUserVariable",
  15581. "parameters": [
  15582. {
  15583. "type": "string",
  15584. "description": "name of the variable",
  15585. "name": "variablename",
  15586. "in": "path",
  15587. "required": true
  15588. }
  15589. ],
  15590. "responses": {
  15591. "200": {
  15592. "$ref": "#/responses/ActionVariable"
  15593. },
  15594. "400": {
  15595. "$ref": "#/responses/error"
  15596. },
  15597. "404": {
  15598. "$ref": "#/responses/notFound"
  15599. }
  15600. }
  15601. },
  15602. "put": {
  15603. "consumes": [
  15604. "application/json"
  15605. ],
  15606. "produces": [
  15607. "application/json"
  15608. ],
  15609. "tags": [
  15610. "user"
  15611. ],
  15612. "summary": "Update a user-level variable which is created by current doer",
  15613. "operationId": "updateUserVariable",
  15614. "parameters": [
  15615. {
  15616. "type": "string",
  15617. "description": "name of the variable",
  15618. "name": "variablename",
  15619. "in": "path",
  15620. "required": true
  15621. },
  15622. {
  15623. "name": "body",
  15624. "in": "body",
  15625. "schema": {
  15626. "$ref": "#/definitions/UpdateVariableOption"
  15627. }
  15628. }
  15629. ],
  15630. "responses": {
  15631. "201": {
  15632. "description": "response when updating a variable"
  15633. },
  15634. "204": {
  15635. "description": "response when updating a variable"
  15636. },
  15637. "400": {
  15638. "$ref": "#/responses/error"
  15639. },
  15640. "404": {
  15641. "$ref": "#/responses/notFound"
  15642. }
  15643. }
  15644. },
  15645. "post": {
  15646. "consumes": [
  15647. "application/json"
  15648. ],
  15649. "produces": [
  15650. "application/json"
  15651. ],
  15652. "tags": [
  15653. "user"
  15654. ],
  15655. "summary": "Create a user-level variable",
  15656. "operationId": "createUserVariable",
  15657. "parameters": [
  15658. {
  15659. "type": "string",
  15660. "description": "name of the variable",
  15661. "name": "variablename",
  15662. "in": "path",
  15663. "required": true
  15664. },
  15665. {
  15666. "name": "body",
  15667. "in": "body",
  15668. "schema": {
  15669. "$ref": "#/definitions/CreateVariableOption"
  15670. }
  15671. }
  15672. ],
  15673. "responses": {
  15674. "201": {
  15675. "description": "response when creating a variable"
  15676. },
  15677. "204": {
  15678. "description": "response when creating a variable"
  15679. },
  15680. "400": {
  15681. "$ref": "#/responses/error"
  15682. },
  15683. "404": {
  15684. "$ref": "#/responses/notFound"
  15685. }
  15686. }
  15687. },
  15688. "delete": {
  15689. "produces": [
  15690. "application/json"
  15691. ],
  15692. "tags": [
  15693. "user"
  15694. ],
  15695. "summary": "Delete a user-level variable which is created by current doer",
  15696. "operationId": "deleteUserVariable",
  15697. "parameters": [
  15698. {
  15699. "type": "string",
  15700. "description": "name of the variable",
  15701. "name": "variablename",
  15702. "in": "path",
  15703. "required": true
  15704. }
  15705. ],
  15706. "responses": {
  15707. "201": {
  15708. "description": "response when deleting a variable"
  15709. },
  15710. "204": {
  15711. "description": "response when deleting a variable"
  15712. },
  15713. "400": {
  15714. "$ref": "#/responses/error"
  15715. },
  15716. "404": {
  15717. "$ref": "#/responses/notFound"
  15718. }
  15719. }
  15720. }
  15721. },
  15722. "/user/applications/oauth2": {
  15723. "get": {
  15724. "produces": [
  15725. "application/json"
  15726. ],
  15727. "tags": [
  15728. "user"
  15729. ],
  15730. "summary": "List the authenticated user's oauth2 applications",
  15731. "operationId": "userGetOauth2Application",
  15732. "parameters": [
  15733. {
  15734. "type": "integer",
  15735. "description": "page number of results to return (1-based)",
  15736. "name": "page",
  15737. "in": "query"
  15738. },
  15739. {
  15740. "type": "integer",
  15741. "description": "page size of results",
  15742. "name": "limit",
  15743. "in": "query"
  15744. }
  15745. ],
  15746. "responses": {
  15747. "200": {
  15748. "$ref": "#/responses/OAuth2ApplicationList"
  15749. }
  15750. }
  15751. },
  15752. "post": {
  15753. "produces": [
  15754. "application/json"
  15755. ],
  15756. "tags": [
  15757. "user"
  15758. ],
  15759. "summary": "creates a new OAuth2 application",
  15760. "operationId": "userCreateOAuth2Application",
  15761. "parameters": [
  15762. {
  15763. "name": "body",
  15764. "in": "body",
  15765. "required": true,
  15766. "schema": {
  15767. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  15768. }
  15769. }
  15770. ],
  15771. "responses": {
  15772. "201": {
  15773. "$ref": "#/responses/OAuth2Application"
  15774. },
  15775. "400": {
  15776. "$ref": "#/responses/error"
  15777. }
  15778. }
  15779. }
  15780. },
  15781. "/user/applications/oauth2/{id}": {
  15782. "get": {
  15783. "produces": [
  15784. "application/json"
  15785. ],
  15786. "tags": [
  15787. "user"
  15788. ],
  15789. "summary": "get an OAuth2 Application",
  15790. "operationId": "userGetOAuth2Application",
  15791. "parameters": [
  15792. {
  15793. "type": "integer",
  15794. "format": "int64",
  15795. "description": "Application ID to be found",
  15796. "name": "id",
  15797. "in": "path",
  15798. "required": true
  15799. }
  15800. ],
  15801. "responses": {
  15802. "200": {
  15803. "$ref": "#/responses/OAuth2Application"
  15804. },
  15805. "404": {
  15806. "$ref": "#/responses/notFound"
  15807. }
  15808. }
  15809. },
  15810. "delete": {
  15811. "produces": [
  15812. "application/json"
  15813. ],
  15814. "tags": [
  15815. "user"
  15816. ],
  15817. "summary": "delete an OAuth2 Application",
  15818. "operationId": "userDeleteOAuth2Application",
  15819. "parameters": [
  15820. {
  15821. "type": "integer",
  15822. "format": "int64",
  15823. "description": "token to be deleted",
  15824. "name": "id",
  15825. "in": "path",
  15826. "required": true
  15827. }
  15828. ],
  15829. "responses": {
  15830. "204": {
  15831. "$ref": "#/responses/empty"
  15832. },
  15833. "404": {
  15834. "$ref": "#/responses/notFound"
  15835. }
  15836. }
  15837. },
  15838. "patch": {
  15839. "produces": [
  15840. "application/json"
  15841. ],
  15842. "tags": [
  15843. "user"
  15844. ],
  15845. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  15846. "operationId": "userUpdateOAuth2Application",
  15847. "parameters": [
  15848. {
  15849. "type": "integer",
  15850. "format": "int64",
  15851. "description": "application to be updated",
  15852. "name": "id",
  15853. "in": "path",
  15854. "required": true
  15855. },
  15856. {
  15857. "name": "body",
  15858. "in": "body",
  15859. "required": true,
  15860. "schema": {
  15861. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  15862. }
  15863. }
  15864. ],
  15865. "responses": {
  15866. "200": {
  15867. "$ref": "#/responses/OAuth2Application"
  15868. },
  15869. "404": {
  15870. "$ref": "#/responses/notFound"
  15871. }
  15872. }
  15873. }
  15874. },
  15875. "/user/avatar": {
  15876. "post": {
  15877. "produces": [
  15878. "application/json"
  15879. ],
  15880. "tags": [
  15881. "user"
  15882. ],
  15883. "summary": "Update Avatar",
  15884. "operationId": "userUpdateAvatar",
  15885. "parameters": [
  15886. {
  15887. "name": "body",
  15888. "in": "body",
  15889. "schema": {
  15890. "$ref": "#/definitions/UpdateUserAvatarOption"
  15891. }
  15892. }
  15893. ],
  15894. "responses": {
  15895. "204": {
  15896. "$ref": "#/responses/empty"
  15897. }
  15898. }
  15899. },
  15900. "delete": {
  15901. "produces": [
  15902. "application/json"
  15903. ],
  15904. "tags": [
  15905. "user"
  15906. ],
  15907. "summary": "Delete Avatar",
  15908. "operationId": "userDeleteAvatar",
  15909. "responses": {
  15910. "204": {
  15911. "$ref": "#/responses/empty"
  15912. }
  15913. }
  15914. }
  15915. },
  15916. "/user/blocks": {
  15917. "get": {
  15918. "produces": [
  15919. "application/json"
  15920. ],
  15921. "tags": [
  15922. "user"
  15923. ],
  15924. "summary": "List users blocked by the authenticated user",
  15925. "operationId": "userListBlocks",
  15926. "parameters": [
  15927. {
  15928. "type": "integer",
  15929. "description": "page number of results to return (1-based)",
  15930. "name": "page",
  15931. "in": "query"
  15932. },
  15933. {
  15934. "type": "integer",
  15935. "description": "page size of results",
  15936. "name": "limit",
  15937. "in": "query"
  15938. }
  15939. ],
  15940. "responses": {
  15941. "200": {
  15942. "$ref": "#/responses/UserList"
  15943. }
  15944. }
  15945. }
  15946. },
  15947. "/user/blocks/{username}": {
  15948. "get": {
  15949. "tags": [
  15950. "user"
  15951. ],
  15952. "summary": "Check if a user is blocked by the authenticated user",
  15953. "operationId": "userCheckUserBlock",
  15954. "parameters": [
  15955. {
  15956. "type": "string",
  15957. "description": "user to check",
  15958. "name": "username",
  15959. "in": "path",
  15960. "required": true
  15961. }
  15962. ],
  15963. "responses": {
  15964. "204": {
  15965. "$ref": "#/responses/empty"
  15966. },
  15967. "404": {
  15968. "$ref": "#/responses/notFound"
  15969. }
  15970. }
  15971. },
  15972. "put": {
  15973. "tags": [
  15974. "user"
  15975. ],
  15976. "summary": "Block a user",
  15977. "operationId": "userBlockUser",
  15978. "parameters": [
  15979. {
  15980. "type": "string",
  15981. "description": "user to block",
  15982. "name": "username",
  15983. "in": "path",
  15984. "required": true
  15985. },
  15986. {
  15987. "type": "string",
  15988. "description": "optional note for the block",
  15989. "name": "note",
  15990. "in": "query"
  15991. }
  15992. ],
  15993. "responses": {
  15994. "204": {
  15995. "$ref": "#/responses/empty"
  15996. },
  15997. "404": {
  15998. "$ref": "#/responses/notFound"
  15999. },
  16000. "422": {
  16001. "$ref": "#/responses/validationError"
  16002. }
  16003. }
  16004. },
  16005. "delete": {
  16006. "tags": [
  16007. "user"
  16008. ],
  16009. "summary": "Unblock a user",
  16010. "operationId": "userUnblockUser",
  16011. "parameters": [
  16012. {
  16013. "type": "string",
  16014. "description": "user to unblock",
  16015. "name": "username",
  16016. "in": "path",
  16017. "required": true
  16018. }
  16019. ],
  16020. "responses": {
  16021. "204": {
  16022. "$ref": "#/responses/empty"
  16023. },
  16024. "404": {
  16025. "$ref": "#/responses/notFound"
  16026. },
  16027. "422": {
  16028. "$ref": "#/responses/validationError"
  16029. }
  16030. }
  16031. }
  16032. },
  16033. "/user/emails": {
  16034. "get": {
  16035. "produces": [
  16036. "application/json"
  16037. ],
  16038. "tags": [
  16039. "user"
  16040. ],
  16041. "summary": "List the authenticated user's email addresses",
  16042. "operationId": "userListEmails",
  16043. "responses": {
  16044. "200": {
  16045. "$ref": "#/responses/EmailList"
  16046. }
  16047. }
  16048. },
  16049. "post": {
  16050. "produces": [
  16051. "application/json"
  16052. ],
  16053. "tags": [
  16054. "user"
  16055. ],
  16056. "summary": "Add email addresses",
  16057. "operationId": "userAddEmail",
  16058. "parameters": [
  16059. {
  16060. "name": "body",
  16061. "in": "body",
  16062. "schema": {
  16063. "$ref": "#/definitions/CreateEmailOption"
  16064. }
  16065. }
  16066. ],
  16067. "responses": {
  16068. "201": {
  16069. "$ref": "#/responses/EmailList"
  16070. },
  16071. "422": {
  16072. "$ref": "#/responses/validationError"
  16073. }
  16074. }
  16075. },
  16076. "delete": {
  16077. "produces": [
  16078. "application/json"
  16079. ],
  16080. "tags": [
  16081. "user"
  16082. ],
  16083. "summary": "Delete email addresses",
  16084. "operationId": "userDeleteEmail",
  16085. "parameters": [
  16086. {
  16087. "name": "body",
  16088. "in": "body",
  16089. "schema": {
  16090. "$ref": "#/definitions/DeleteEmailOption"
  16091. }
  16092. }
  16093. ],
  16094. "responses": {
  16095. "204": {
  16096. "$ref": "#/responses/empty"
  16097. },
  16098. "404": {
  16099. "$ref": "#/responses/notFound"
  16100. }
  16101. }
  16102. }
  16103. },
  16104. "/user/followers": {
  16105. "get": {
  16106. "produces": [
  16107. "application/json"
  16108. ],
  16109. "tags": [
  16110. "user"
  16111. ],
  16112. "summary": "List the authenticated user's followers",
  16113. "operationId": "userCurrentListFollowers",
  16114. "parameters": [
  16115. {
  16116. "type": "integer",
  16117. "description": "page number of results to return (1-based)",
  16118. "name": "page",
  16119. "in": "query"
  16120. },
  16121. {
  16122. "type": "integer",
  16123. "description": "page size of results",
  16124. "name": "limit",
  16125. "in": "query"
  16126. }
  16127. ],
  16128. "responses": {
  16129. "200": {
  16130. "$ref": "#/responses/UserList"
  16131. }
  16132. }
  16133. }
  16134. },
  16135. "/user/following": {
  16136. "get": {
  16137. "produces": [
  16138. "application/json"
  16139. ],
  16140. "tags": [
  16141. "user"
  16142. ],
  16143. "summary": "List the users that the authenticated user is following",
  16144. "operationId": "userCurrentListFollowing",
  16145. "parameters": [
  16146. {
  16147. "type": "integer",
  16148. "description": "page number of results to return (1-based)",
  16149. "name": "page",
  16150. "in": "query"
  16151. },
  16152. {
  16153. "type": "integer",
  16154. "description": "page size of results",
  16155. "name": "limit",
  16156. "in": "query"
  16157. }
  16158. ],
  16159. "responses": {
  16160. "200": {
  16161. "$ref": "#/responses/UserList"
  16162. }
  16163. }
  16164. }
  16165. },
  16166. "/user/following/{username}": {
  16167. "get": {
  16168. "tags": [
  16169. "user"
  16170. ],
  16171. "summary": "Check whether a user is followed by the authenticated user",
  16172. "operationId": "userCurrentCheckFollowing",
  16173. "parameters": [
  16174. {
  16175. "type": "string",
  16176. "description": "username of followed user",
  16177. "name": "username",
  16178. "in": "path",
  16179. "required": true
  16180. }
  16181. ],
  16182. "responses": {
  16183. "204": {
  16184. "$ref": "#/responses/empty"
  16185. },
  16186. "404": {
  16187. "$ref": "#/responses/notFound"
  16188. }
  16189. }
  16190. },
  16191. "put": {
  16192. "tags": [
  16193. "user"
  16194. ],
  16195. "summary": "Follow a user",
  16196. "operationId": "userCurrentPutFollow",
  16197. "parameters": [
  16198. {
  16199. "type": "string",
  16200. "description": "username of user to follow",
  16201. "name": "username",
  16202. "in": "path",
  16203. "required": true
  16204. }
  16205. ],
  16206. "responses": {
  16207. "204": {
  16208. "$ref": "#/responses/empty"
  16209. },
  16210. "403": {
  16211. "$ref": "#/responses/forbidden"
  16212. },
  16213. "404": {
  16214. "$ref": "#/responses/notFound"
  16215. }
  16216. }
  16217. },
  16218. "delete": {
  16219. "tags": [
  16220. "user"
  16221. ],
  16222. "summary": "Unfollow a user",
  16223. "operationId": "userCurrentDeleteFollow",
  16224. "parameters": [
  16225. {
  16226. "type": "string",
  16227. "description": "username of user to unfollow",
  16228. "name": "username",
  16229. "in": "path",
  16230. "required": true
  16231. }
  16232. ],
  16233. "responses": {
  16234. "204": {
  16235. "$ref": "#/responses/empty"
  16236. },
  16237. "404": {
  16238. "$ref": "#/responses/notFound"
  16239. }
  16240. }
  16241. }
  16242. },
  16243. "/user/gpg_key_token": {
  16244. "get": {
  16245. "produces": [
  16246. "text/plain"
  16247. ],
  16248. "tags": [
  16249. "user"
  16250. ],
  16251. "summary": "Get a Token to verify",
  16252. "operationId": "getVerificationToken",
  16253. "responses": {
  16254. "200": {
  16255. "$ref": "#/responses/string"
  16256. },
  16257. "404": {
  16258. "$ref": "#/responses/notFound"
  16259. }
  16260. }
  16261. }
  16262. },
  16263. "/user/gpg_key_verify": {
  16264. "post": {
  16265. "consumes": [
  16266. "application/json"
  16267. ],
  16268. "produces": [
  16269. "application/json"
  16270. ],
  16271. "tags": [
  16272. "user"
  16273. ],
  16274. "summary": "Verify a GPG key",
  16275. "operationId": "userVerifyGPGKey",
  16276. "responses": {
  16277. "201": {
  16278. "$ref": "#/responses/GPGKey"
  16279. },
  16280. "404": {
  16281. "$ref": "#/responses/notFound"
  16282. },
  16283. "422": {
  16284. "$ref": "#/responses/validationError"
  16285. }
  16286. }
  16287. }
  16288. },
  16289. "/user/gpg_keys": {
  16290. "get": {
  16291. "produces": [
  16292. "application/json"
  16293. ],
  16294. "tags": [
  16295. "user"
  16296. ],
  16297. "summary": "List the authenticated user's GPG keys",
  16298. "operationId": "userCurrentListGPGKeys",
  16299. "parameters": [
  16300. {
  16301. "type": "integer",
  16302. "description": "page number of results to return (1-based)",
  16303. "name": "page",
  16304. "in": "query"
  16305. },
  16306. {
  16307. "type": "integer",
  16308. "description": "page size of results",
  16309. "name": "limit",
  16310. "in": "query"
  16311. }
  16312. ],
  16313. "responses": {
  16314. "200": {
  16315. "$ref": "#/responses/GPGKeyList"
  16316. }
  16317. }
  16318. },
  16319. "post": {
  16320. "consumes": [
  16321. "application/json"
  16322. ],
  16323. "produces": [
  16324. "application/json"
  16325. ],
  16326. "tags": [
  16327. "user"
  16328. ],
  16329. "summary": "Create a GPG key",
  16330. "operationId": "userCurrentPostGPGKey",
  16331. "parameters": [
  16332. {
  16333. "name": "Form",
  16334. "in": "body",
  16335. "schema": {
  16336. "$ref": "#/definitions/CreateGPGKeyOption"
  16337. }
  16338. }
  16339. ],
  16340. "responses": {
  16341. "201": {
  16342. "$ref": "#/responses/GPGKey"
  16343. },
  16344. "404": {
  16345. "$ref": "#/responses/notFound"
  16346. },
  16347. "422": {
  16348. "$ref": "#/responses/validationError"
  16349. }
  16350. }
  16351. }
  16352. },
  16353. "/user/gpg_keys/{id}": {
  16354. "get": {
  16355. "produces": [
  16356. "application/json"
  16357. ],
  16358. "tags": [
  16359. "user"
  16360. ],
  16361. "summary": "Get a GPG key",
  16362. "operationId": "userCurrentGetGPGKey",
  16363. "parameters": [
  16364. {
  16365. "type": "integer",
  16366. "format": "int64",
  16367. "description": "id of key to get",
  16368. "name": "id",
  16369. "in": "path",
  16370. "required": true
  16371. }
  16372. ],
  16373. "responses": {
  16374. "200": {
  16375. "$ref": "#/responses/GPGKey"
  16376. },
  16377. "404": {
  16378. "$ref": "#/responses/notFound"
  16379. }
  16380. }
  16381. },
  16382. "delete": {
  16383. "produces": [
  16384. "application/json"
  16385. ],
  16386. "tags": [
  16387. "user"
  16388. ],
  16389. "summary": "Remove a GPG key",
  16390. "operationId": "userCurrentDeleteGPGKey",
  16391. "parameters": [
  16392. {
  16393. "type": "integer",
  16394. "format": "int64",
  16395. "description": "id of key to delete",
  16396. "name": "id",
  16397. "in": "path",
  16398. "required": true
  16399. }
  16400. ],
  16401. "responses": {
  16402. "204": {
  16403. "$ref": "#/responses/empty"
  16404. },
  16405. "403": {
  16406. "$ref": "#/responses/forbidden"
  16407. },
  16408. "404": {
  16409. "$ref": "#/responses/notFound"
  16410. }
  16411. }
  16412. }
  16413. },
  16414. "/user/hooks": {
  16415. "get": {
  16416. "produces": [
  16417. "application/json"
  16418. ],
  16419. "tags": [
  16420. "user"
  16421. ],
  16422. "summary": "List the authenticated user's webhooks",
  16423. "operationId": "userListHooks",
  16424. "parameters": [
  16425. {
  16426. "type": "integer",
  16427. "description": "page number of results to return (1-based)",
  16428. "name": "page",
  16429. "in": "query"
  16430. },
  16431. {
  16432. "type": "integer",
  16433. "description": "page size of results",
  16434. "name": "limit",
  16435. "in": "query"
  16436. }
  16437. ],
  16438. "responses": {
  16439. "200": {
  16440. "$ref": "#/responses/HookList"
  16441. }
  16442. }
  16443. },
  16444. "post": {
  16445. "consumes": [
  16446. "application/json"
  16447. ],
  16448. "produces": [
  16449. "application/json"
  16450. ],
  16451. "tags": [
  16452. "user"
  16453. ],
  16454. "summary": "Create a hook",
  16455. "operationId": "userCreateHook",
  16456. "parameters": [
  16457. {
  16458. "name": "body",
  16459. "in": "body",
  16460. "required": true,
  16461. "schema": {
  16462. "$ref": "#/definitions/CreateHookOption"
  16463. }
  16464. }
  16465. ],
  16466. "responses": {
  16467. "201": {
  16468. "$ref": "#/responses/Hook"
  16469. }
  16470. }
  16471. }
  16472. },
  16473. "/user/hooks/{id}": {
  16474. "get": {
  16475. "produces": [
  16476. "application/json"
  16477. ],
  16478. "tags": [
  16479. "user"
  16480. ],
  16481. "summary": "Get a hook",
  16482. "operationId": "userGetHook",
  16483. "parameters": [
  16484. {
  16485. "type": "integer",
  16486. "format": "int64",
  16487. "description": "id of the hook to get",
  16488. "name": "id",
  16489. "in": "path",
  16490. "required": true
  16491. }
  16492. ],
  16493. "responses": {
  16494. "200": {
  16495. "$ref": "#/responses/Hook"
  16496. }
  16497. }
  16498. },
  16499. "delete": {
  16500. "produces": [
  16501. "application/json"
  16502. ],
  16503. "tags": [
  16504. "user"
  16505. ],
  16506. "summary": "Delete a hook",
  16507. "operationId": "userDeleteHook",
  16508. "parameters": [
  16509. {
  16510. "type": "integer",
  16511. "format": "int64",
  16512. "description": "id of the hook to delete",
  16513. "name": "id",
  16514. "in": "path",
  16515. "required": true
  16516. }
  16517. ],
  16518. "responses": {
  16519. "204": {
  16520. "$ref": "#/responses/empty"
  16521. }
  16522. }
  16523. },
  16524. "patch": {
  16525. "consumes": [
  16526. "application/json"
  16527. ],
  16528. "produces": [
  16529. "application/json"
  16530. ],
  16531. "tags": [
  16532. "user"
  16533. ],
  16534. "summary": "Update a hook",
  16535. "operationId": "userEditHook",
  16536. "parameters": [
  16537. {
  16538. "type": "integer",
  16539. "format": "int64",
  16540. "description": "id of the hook to update",
  16541. "name": "id",
  16542. "in": "path",
  16543. "required": true
  16544. },
  16545. {
  16546. "name": "body",
  16547. "in": "body",
  16548. "schema": {
  16549. "$ref": "#/definitions/EditHookOption"
  16550. }
  16551. }
  16552. ],
  16553. "responses": {
  16554. "200": {
  16555. "$ref": "#/responses/Hook"
  16556. }
  16557. }
  16558. }
  16559. },
  16560. "/user/keys": {
  16561. "get": {
  16562. "produces": [
  16563. "application/json"
  16564. ],
  16565. "tags": [
  16566. "user"
  16567. ],
  16568. "summary": "List the authenticated user's public keys",
  16569. "operationId": "userCurrentListKeys",
  16570. "parameters": [
  16571. {
  16572. "type": "string",
  16573. "description": "fingerprint of the key",
  16574. "name": "fingerprint",
  16575. "in": "query"
  16576. },
  16577. {
  16578. "type": "integer",
  16579. "description": "page number of results to return (1-based)",
  16580. "name": "page",
  16581. "in": "query"
  16582. },
  16583. {
  16584. "type": "integer",
  16585. "description": "page size of results",
  16586. "name": "limit",
  16587. "in": "query"
  16588. }
  16589. ],
  16590. "responses": {
  16591. "200": {
  16592. "$ref": "#/responses/PublicKeyList"
  16593. }
  16594. }
  16595. },
  16596. "post": {
  16597. "consumes": [
  16598. "application/json"
  16599. ],
  16600. "produces": [
  16601. "application/json"
  16602. ],
  16603. "tags": [
  16604. "user"
  16605. ],
  16606. "summary": "Create a public key",
  16607. "operationId": "userCurrentPostKey",
  16608. "parameters": [
  16609. {
  16610. "name": "body",
  16611. "in": "body",
  16612. "schema": {
  16613. "$ref": "#/definitions/CreateKeyOption"
  16614. }
  16615. }
  16616. ],
  16617. "responses": {
  16618. "201": {
  16619. "$ref": "#/responses/PublicKey"
  16620. },
  16621. "422": {
  16622. "$ref": "#/responses/validationError"
  16623. }
  16624. }
  16625. }
  16626. },
  16627. "/user/keys/{id}": {
  16628. "get": {
  16629. "produces": [
  16630. "application/json"
  16631. ],
  16632. "tags": [
  16633. "user"
  16634. ],
  16635. "summary": "Get a public key",
  16636. "operationId": "userCurrentGetKey",
  16637. "parameters": [
  16638. {
  16639. "type": "integer",
  16640. "format": "int64",
  16641. "description": "id of key to get",
  16642. "name": "id",
  16643. "in": "path",
  16644. "required": true
  16645. }
  16646. ],
  16647. "responses": {
  16648. "200": {
  16649. "$ref": "#/responses/PublicKey"
  16650. },
  16651. "404": {
  16652. "$ref": "#/responses/notFound"
  16653. }
  16654. }
  16655. },
  16656. "delete": {
  16657. "produces": [
  16658. "application/json"
  16659. ],
  16660. "tags": [
  16661. "user"
  16662. ],
  16663. "summary": "Delete a public key",
  16664. "operationId": "userCurrentDeleteKey",
  16665. "parameters": [
  16666. {
  16667. "type": "integer",
  16668. "format": "int64",
  16669. "description": "id of key to delete",
  16670. "name": "id",
  16671. "in": "path",
  16672. "required": true
  16673. }
  16674. ],
  16675. "responses": {
  16676. "204": {
  16677. "$ref": "#/responses/empty"
  16678. },
  16679. "403": {
  16680. "$ref": "#/responses/forbidden"
  16681. },
  16682. "404": {
  16683. "$ref": "#/responses/notFound"
  16684. }
  16685. }
  16686. }
  16687. },
  16688. "/user/orgs": {
  16689. "get": {
  16690. "produces": [
  16691. "application/json"
  16692. ],
  16693. "tags": [
  16694. "organization"
  16695. ],
  16696. "summary": "List the current user's organizations",
  16697. "operationId": "orgListCurrentUserOrgs",
  16698. "parameters": [
  16699. {
  16700. "type": "integer",
  16701. "description": "page number of results to return (1-based)",
  16702. "name": "page",
  16703. "in": "query"
  16704. },
  16705. {
  16706. "type": "integer",
  16707. "description": "page size of results",
  16708. "name": "limit",
  16709. "in": "query"
  16710. }
  16711. ],
  16712. "responses": {
  16713. "200": {
  16714. "$ref": "#/responses/OrganizationList"
  16715. },
  16716. "404": {
  16717. "$ref": "#/responses/notFound"
  16718. }
  16719. }
  16720. }
  16721. },
  16722. "/user/repos": {
  16723. "get": {
  16724. "produces": [
  16725. "application/json"
  16726. ],
  16727. "tags": [
  16728. "user"
  16729. ],
  16730. "summary": "List the repos that the authenticated user owns",
  16731. "operationId": "userCurrentListRepos",
  16732. "parameters": [
  16733. {
  16734. "type": "integer",
  16735. "description": "page number of results to return (1-based)",
  16736. "name": "page",
  16737. "in": "query"
  16738. },
  16739. {
  16740. "type": "integer",
  16741. "description": "page size of results",
  16742. "name": "limit",
  16743. "in": "query"
  16744. }
  16745. ],
  16746. "responses": {
  16747. "200": {
  16748. "$ref": "#/responses/RepositoryList"
  16749. }
  16750. }
  16751. },
  16752. "post": {
  16753. "consumes": [
  16754. "application/json"
  16755. ],
  16756. "produces": [
  16757. "application/json"
  16758. ],
  16759. "tags": [
  16760. "repository",
  16761. "user"
  16762. ],
  16763. "summary": "Create a repository",
  16764. "operationId": "createCurrentUserRepo",
  16765. "parameters": [
  16766. {
  16767. "name": "body",
  16768. "in": "body",
  16769. "schema": {
  16770. "$ref": "#/definitions/CreateRepoOption"
  16771. }
  16772. }
  16773. ],
  16774. "responses": {
  16775. "201": {
  16776. "$ref": "#/responses/Repository"
  16777. },
  16778. "400": {
  16779. "$ref": "#/responses/error"
  16780. },
  16781. "409": {
  16782. "description": "The repository with the same name already exists."
  16783. },
  16784. "422": {
  16785. "$ref": "#/responses/validationError"
  16786. }
  16787. }
  16788. }
  16789. },
  16790. "/user/settings": {
  16791. "get": {
  16792. "produces": [
  16793. "application/json"
  16794. ],
  16795. "tags": [
  16796. "user"
  16797. ],
  16798. "summary": "Get user settings",
  16799. "operationId": "getUserSettings",
  16800. "responses": {
  16801. "200": {
  16802. "$ref": "#/responses/UserSettings"
  16803. }
  16804. }
  16805. },
  16806. "patch": {
  16807. "produces": [
  16808. "application/json"
  16809. ],
  16810. "tags": [
  16811. "user"
  16812. ],
  16813. "summary": "Update user settings",
  16814. "operationId": "updateUserSettings",
  16815. "parameters": [
  16816. {
  16817. "name": "body",
  16818. "in": "body",
  16819. "schema": {
  16820. "$ref": "#/definitions/UserSettingsOptions"
  16821. }
  16822. }
  16823. ],
  16824. "responses": {
  16825. "200": {
  16826. "$ref": "#/responses/UserSettings"
  16827. }
  16828. }
  16829. }
  16830. },
  16831. "/user/starred": {
  16832. "get": {
  16833. "produces": [
  16834. "application/json"
  16835. ],
  16836. "tags": [
  16837. "user"
  16838. ],
  16839. "summary": "The repos that the authenticated user has starred",
  16840. "operationId": "userCurrentListStarred",
  16841. "parameters": [
  16842. {
  16843. "type": "integer",
  16844. "description": "page number of results to return (1-based)",
  16845. "name": "page",
  16846. "in": "query"
  16847. },
  16848. {
  16849. "type": "integer",
  16850. "description": "page size of results",
  16851. "name": "limit",
  16852. "in": "query"
  16853. }
  16854. ],
  16855. "responses": {
  16856. "200": {
  16857. "$ref": "#/responses/RepositoryList"
  16858. }
  16859. }
  16860. }
  16861. },
  16862. "/user/starred/{owner}/{repo}": {
  16863. "get": {
  16864. "tags": [
  16865. "user"
  16866. ],
  16867. "summary": "Whether the authenticated is starring the repo",
  16868. "operationId": "userCurrentCheckStarring",
  16869. "parameters": [
  16870. {
  16871. "type": "string",
  16872. "description": "owner of the repo",
  16873. "name": "owner",
  16874. "in": "path",
  16875. "required": true
  16876. },
  16877. {
  16878. "type": "string",
  16879. "description": "name of the repo",
  16880. "name": "repo",
  16881. "in": "path",
  16882. "required": true
  16883. }
  16884. ],
  16885. "responses": {
  16886. "204": {
  16887. "$ref": "#/responses/empty"
  16888. },
  16889. "404": {
  16890. "$ref": "#/responses/notFound"
  16891. }
  16892. }
  16893. },
  16894. "put": {
  16895. "tags": [
  16896. "user"
  16897. ],
  16898. "summary": "Star the given repo",
  16899. "operationId": "userCurrentPutStar",
  16900. "parameters": [
  16901. {
  16902. "type": "string",
  16903. "description": "owner of the repo to star",
  16904. "name": "owner",
  16905. "in": "path",
  16906. "required": true
  16907. },
  16908. {
  16909. "type": "string",
  16910. "description": "name of the repo to star",
  16911. "name": "repo",
  16912. "in": "path",
  16913. "required": true
  16914. }
  16915. ],
  16916. "responses": {
  16917. "204": {
  16918. "$ref": "#/responses/empty"
  16919. },
  16920. "403": {
  16921. "$ref": "#/responses/forbidden"
  16922. },
  16923. "404": {
  16924. "$ref": "#/responses/notFound"
  16925. }
  16926. }
  16927. },
  16928. "delete": {
  16929. "tags": [
  16930. "user"
  16931. ],
  16932. "summary": "Unstar the given repo",
  16933. "operationId": "userCurrentDeleteStar",
  16934. "parameters": [
  16935. {
  16936. "type": "string",
  16937. "description": "owner of the repo to unstar",
  16938. "name": "owner",
  16939. "in": "path",
  16940. "required": true
  16941. },
  16942. {
  16943. "type": "string",
  16944. "description": "name of the repo to unstar",
  16945. "name": "repo",
  16946. "in": "path",
  16947. "required": true
  16948. }
  16949. ],
  16950. "responses": {
  16951. "204": {
  16952. "$ref": "#/responses/empty"
  16953. },
  16954. "404": {
  16955. "$ref": "#/responses/notFound"
  16956. }
  16957. }
  16958. }
  16959. },
  16960. "/user/stopwatches": {
  16961. "get": {
  16962. "consumes": [
  16963. "application/json"
  16964. ],
  16965. "produces": [
  16966. "application/json"
  16967. ],
  16968. "tags": [
  16969. "user"
  16970. ],
  16971. "summary": "Get list of all existing stopwatches",
  16972. "operationId": "userGetStopWatches",
  16973. "parameters": [
  16974. {
  16975. "type": "integer",
  16976. "description": "page number of results to return (1-based)",
  16977. "name": "page",
  16978. "in": "query"
  16979. },
  16980. {
  16981. "type": "integer",
  16982. "description": "page size of results",
  16983. "name": "limit",
  16984. "in": "query"
  16985. }
  16986. ],
  16987. "responses": {
  16988. "200": {
  16989. "$ref": "#/responses/StopWatchList"
  16990. }
  16991. }
  16992. }
  16993. },
  16994. "/user/subscriptions": {
  16995. "get": {
  16996. "produces": [
  16997. "application/json"
  16998. ],
  16999. "tags": [
  17000. "user"
  17001. ],
  17002. "summary": "List repositories watched by the authenticated user",
  17003. "operationId": "userCurrentListSubscriptions",
  17004. "parameters": [
  17005. {
  17006. "type": "integer",
  17007. "description": "page number of results to return (1-based)",
  17008. "name": "page",
  17009. "in": "query"
  17010. },
  17011. {
  17012. "type": "integer",
  17013. "description": "page size of results",
  17014. "name": "limit",
  17015. "in": "query"
  17016. }
  17017. ],
  17018. "responses": {
  17019. "200": {
  17020. "$ref": "#/responses/RepositoryList"
  17021. }
  17022. }
  17023. }
  17024. },
  17025. "/user/teams": {
  17026. "get": {
  17027. "produces": [
  17028. "application/json"
  17029. ],
  17030. "tags": [
  17031. "user"
  17032. ],
  17033. "summary": "List all the teams a user belongs to",
  17034. "operationId": "userListTeams",
  17035. "parameters": [
  17036. {
  17037. "type": "integer",
  17038. "description": "page number of results to return (1-based)",
  17039. "name": "page",
  17040. "in": "query"
  17041. },
  17042. {
  17043. "type": "integer",
  17044. "description": "page size of results",
  17045. "name": "limit",
  17046. "in": "query"
  17047. }
  17048. ],
  17049. "responses": {
  17050. "200": {
  17051. "$ref": "#/responses/TeamList"
  17052. }
  17053. }
  17054. }
  17055. },
  17056. "/user/times": {
  17057. "get": {
  17058. "produces": [
  17059. "application/json"
  17060. ],
  17061. "tags": [
  17062. "user"
  17063. ],
  17064. "summary": "List the current user's tracked times",
  17065. "operationId": "userCurrentTrackedTimes",
  17066. "parameters": [
  17067. {
  17068. "type": "integer",
  17069. "description": "page number of results to return (1-based)",
  17070. "name": "page",
  17071. "in": "query"
  17072. },
  17073. {
  17074. "type": "integer",
  17075. "description": "page size of results",
  17076. "name": "limit",
  17077. "in": "query"
  17078. },
  17079. {
  17080. "type": "string",
  17081. "format": "date-time",
  17082. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  17083. "name": "since",
  17084. "in": "query"
  17085. },
  17086. {
  17087. "type": "string",
  17088. "format": "date-time",
  17089. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  17090. "name": "before",
  17091. "in": "query"
  17092. }
  17093. ],
  17094. "responses": {
  17095. "200": {
  17096. "$ref": "#/responses/TrackedTimeList"
  17097. }
  17098. }
  17099. }
  17100. },
  17101. "/users/search": {
  17102. "get": {
  17103. "produces": [
  17104. "application/json"
  17105. ],
  17106. "tags": [
  17107. "user"
  17108. ],
  17109. "summary": "Search for users",
  17110. "operationId": "userSearch",
  17111. "parameters": [
  17112. {
  17113. "type": "string",
  17114. "description": "keyword",
  17115. "name": "q",
  17116. "in": "query"
  17117. },
  17118. {
  17119. "type": "integer",
  17120. "format": "int64",
  17121. "description": "ID of the user to search for",
  17122. "name": "uid",
  17123. "in": "query"
  17124. },
  17125. {
  17126. "type": "integer",
  17127. "description": "page number of results to return (1-based)",
  17128. "name": "page",
  17129. "in": "query"
  17130. },
  17131. {
  17132. "type": "integer",
  17133. "description": "page size of results",
  17134. "name": "limit",
  17135. "in": "query"
  17136. }
  17137. ],
  17138. "responses": {
  17139. "200": {
  17140. "description": "SearchResults of a successful search",
  17141. "schema": {
  17142. "type": "object",
  17143. "properties": {
  17144. "data": {
  17145. "type": "array",
  17146. "items": {
  17147. "$ref": "#/definitions/User"
  17148. }
  17149. },
  17150. "ok": {
  17151. "type": "boolean"
  17152. }
  17153. }
  17154. }
  17155. }
  17156. }
  17157. }
  17158. },
  17159. "/users/{username}": {
  17160. "get": {
  17161. "produces": [
  17162. "application/json"
  17163. ],
  17164. "tags": [
  17165. "user"
  17166. ],
  17167. "summary": "Get a user",
  17168. "operationId": "userGet",
  17169. "parameters": [
  17170. {
  17171. "type": "string",
  17172. "description": "username of user to get",
  17173. "name": "username",
  17174. "in": "path",
  17175. "required": true
  17176. }
  17177. ],
  17178. "responses": {
  17179. "200": {
  17180. "$ref": "#/responses/User"
  17181. },
  17182. "404": {
  17183. "$ref": "#/responses/notFound"
  17184. }
  17185. }
  17186. }
  17187. },
  17188. "/users/{username}/activities/feeds": {
  17189. "get": {
  17190. "produces": [
  17191. "application/json"
  17192. ],
  17193. "tags": [
  17194. "user"
  17195. ],
  17196. "summary": "List a user's activity feeds",
  17197. "operationId": "userListActivityFeeds",
  17198. "parameters": [
  17199. {
  17200. "type": "string",
  17201. "description": "username of user",
  17202. "name": "username",
  17203. "in": "path",
  17204. "required": true
  17205. },
  17206. {
  17207. "type": "boolean",
  17208. "description": "if true, only show actions performed by the requested user",
  17209. "name": "only-performed-by",
  17210. "in": "query"
  17211. },
  17212. {
  17213. "type": "string",
  17214. "format": "date",
  17215. "description": "the date of the activities to be found",
  17216. "name": "date",
  17217. "in": "query"
  17218. },
  17219. {
  17220. "type": "integer",
  17221. "description": "page number of results to return (1-based)",
  17222. "name": "page",
  17223. "in": "query"
  17224. },
  17225. {
  17226. "type": "integer",
  17227. "description": "page size of results",
  17228. "name": "limit",
  17229. "in": "query"
  17230. }
  17231. ],
  17232. "responses": {
  17233. "200": {
  17234. "$ref": "#/responses/ActivityFeedsList"
  17235. },
  17236. "404": {
  17237. "$ref": "#/responses/notFound"
  17238. }
  17239. }
  17240. }
  17241. },
  17242. "/users/{username}/followers": {
  17243. "get": {
  17244. "produces": [
  17245. "application/json"
  17246. ],
  17247. "tags": [
  17248. "user"
  17249. ],
  17250. "summary": "List the given user's followers",
  17251. "operationId": "userListFollowers",
  17252. "parameters": [
  17253. {
  17254. "type": "string",
  17255. "description": "username of user",
  17256. "name": "username",
  17257. "in": "path",
  17258. "required": true
  17259. },
  17260. {
  17261. "type": "integer",
  17262. "description": "page number of results to return (1-based)",
  17263. "name": "page",
  17264. "in": "query"
  17265. },
  17266. {
  17267. "type": "integer",
  17268. "description": "page size of results",
  17269. "name": "limit",
  17270. "in": "query"
  17271. }
  17272. ],
  17273. "responses": {
  17274. "200": {
  17275. "$ref": "#/responses/UserList"
  17276. },
  17277. "404": {
  17278. "$ref": "#/responses/notFound"
  17279. }
  17280. }
  17281. }
  17282. },
  17283. "/users/{username}/following": {
  17284. "get": {
  17285. "produces": [
  17286. "application/json"
  17287. ],
  17288. "tags": [
  17289. "user"
  17290. ],
  17291. "summary": "List the users that the given user is following",
  17292. "operationId": "userListFollowing",
  17293. "parameters": [
  17294. {
  17295. "type": "string",
  17296. "description": "username of user",
  17297. "name": "username",
  17298. "in": "path",
  17299. "required": true
  17300. },
  17301. {
  17302. "type": "integer",
  17303. "description": "page number of results to return (1-based)",
  17304. "name": "page",
  17305. "in": "query"
  17306. },
  17307. {
  17308. "type": "integer",
  17309. "description": "page size of results",
  17310. "name": "limit",
  17311. "in": "query"
  17312. }
  17313. ],
  17314. "responses": {
  17315. "200": {
  17316. "$ref": "#/responses/UserList"
  17317. },
  17318. "404": {
  17319. "$ref": "#/responses/notFound"
  17320. }
  17321. }
  17322. }
  17323. },
  17324. "/users/{username}/following/{target}": {
  17325. "get": {
  17326. "tags": [
  17327. "user"
  17328. ],
  17329. "summary": "Check if one user is following another user",
  17330. "operationId": "userCheckFollowing",
  17331. "parameters": [
  17332. {
  17333. "type": "string",
  17334. "description": "username of following user",
  17335. "name": "username",
  17336. "in": "path",
  17337. "required": true
  17338. },
  17339. {
  17340. "type": "string",
  17341. "description": "username of followed user",
  17342. "name": "target",
  17343. "in": "path",
  17344. "required": true
  17345. }
  17346. ],
  17347. "responses": {
  17348. "204": {
  17349. "$ref": "#/responses/empty"
  17350. },
  17351. "404": {
  17352. "$ref": "#/responses/notFound"
  17353. }
  17354. }
  17355. }
  17356. },
  17357. "/users/{username}/gpg_keys": {
  17358. "get": {
  17359. "produces": [
  17360. "application/json"
  17361. ],
  17362. "tags": [
  17363. "user"
  17364. ],
  17365. "summary": "List the given user's GPG keys",
  17366. "operationId": "userListGPGKeys",
  17367. "parameters": [
  17368. {
  17369. "type": "string",
  17370. "description": "username of user",
  17371. "name": "username",
  17372. "in": "path",
  17373. "required": true
  17374. },
  17375. {
  17376. "type": "integer",
  17377. "description": "page number of results to return (1-based)",
  17378. "name": "page",
  17379. "in": "query"
  17380. },
  17381. {
  17382. "type": "integer",
  17383. "description": "page size of results",
  17384. "name": "limit",
  17385. "in": "query"
  17386. }
  17387. ],
  17388. "responses": {
  17389. "200": {
  17390. "$ref": "#/responses/GPGKeyList"
  17391. },
  17392. "404": {
  17393. "$ref": "#/responses/notFound"
  17394. }
  17395. }
  17396. }
  17397. },
  17398. "/users/{username}/heatmap": {
  17399. "get": {
  17400. "produces": [
  17401. "application/json"
  17402. ],
  17403. "tags": [
  17404. "user"
  17405. ],
  17406. "summary": "Get a user's heatmap",
  17407. "operationId": "userGetHeatmapData",
  17408. "parameters": [
  17409. {
  17410. "type": "string",
  17411. "description": "username of user to get",
  17412. "name": "username",
  17413. "in": "path",
  17414. "required": true
  17415. }
  17416. ],
  17417. "responses": {
  17418. "200": {
  17419. "$ref": "#/responses/UserHeatmapData"
  17420. },
  17421. "404": {
  17422. "$ref": "#/responses/notFound"
  17423. }
  17424. }
  17425. }
  17426. },
  17427. "/users/{username}/keys": {
  17428. "get": {
  17429. "produces": [
  17430. "application/json"
  17431. ],
  17432. "tags": [
  17433. "user"
  17434. ],
  17435. "summary": "List the given user's public keys",
  17436. "operationId": "userListKeys",
  17437. "parameters": [
  17438. {
  17439. "type": "string",
  17440. "description": "username of user",
  17441. "name": "username",
  17442. "in": "path",
  17443. "required": true
  17444. },
  17445. {
  17446. "type": "string",
  17447. "description": "fingerprint of the key",
  17448. "name": "fingerprint",
  17449. "in": "query"
  17450. },
  17451. {
  17452. "type": "integer",
  17453. "description": "page number of results to return (1-based)",
  17454. "name": "page",
  17455. "in": "query"
  17456. },
  17457. {
  17458. "type": "integer",
  17459. "description": "page size of results",
  17460. "name": "limit",
  17461. "in": "query"
  17462. }
  17463. ],
  17464. "responses": {
  17465. "200": {
  17466. "$ref": "#/responses/PublicKeyList"
  17467. },
  17468. "404": {
  17469. "$ref": "#/responses/notFound"
  17470. }
  17471. }
  17472. }
  17473. },
  17474. "/users/{username}/orgs": {
  17475. "get": {
  17476. "produces": [
  17477. "application/json"
  17478. ],
  17479. "tags": [
  17480. "organization"
  17481. ],
  17482. "summary": "List a user's organizations",
  17483. "operationId": "orgListUserOrgs",
  17484. "parameters": [
  17485. {
  17486. "type": "string",
  17487. "description": "username of user",
  17488. "name": "username",
  17489. "in": "path",
  17490. "required": true
  17491. },
  17492. {
  17493. "type": "integer",
  17494. "description": "page number of results to return (1-based)",
  17495. "name": "page",
  17496. "in": "query"
  17497. },
  17498. {
  17499. "type": "integer",
  17500. "description": "page size of results",
  17501. "name": "limit",
  17502. "in": "query"
  17503. }
  17504. ],
  17505. "responses": {
  17506. "200": {
  17507. "$ref": "#/responses/OrganizationList"
  17508. },
  17509. "404": {
  17510. "$ref": "#/responses/notFound"
  17511. }
  17512. }
  17513. }
  17514. },
  17515. "/users/{username}/orgs/{org}/permissions": {
  17516. "get": {
  17517. "produces": [
  17518. "application/json"
  17519. ],
  17520. "tags": [
  17521. "organization"
  17522. ],
  17523. "summary": "Get user permissions in organization",
  17524. "operationId": "orgGetUserPermissions",
  17525. "parameters": [
  17526. {
  17527. "type": "string",
  17528. "description": "username of user",
  17529. "name": "username",
  17530. "in": "path",
  17531. "required": true
  17532. },
  17533. {
  17534. "type": "string",
  17535. "description": "name of the organization",
  17536. "name": "org",
  17537. "in": "path",
  17538. "required": true
  17539. }
  17540. ],
  17541. "responses": {
  17542. "200": {
  17543. "$ref": "#/responses/OrganizationPermissions"
  17544. },
  17545. "403": {
  17546. "$ref": "#/responses/forbidden"
  17547. },
  17548. "404": {
  17549. "$ref": "#/responses/notFound"
  17550. }
  17551. }
  17552. }
  17553. },
  17554. "/users/{username}/repos": {
  17555. "get": {
  17556. "produces": [
  17557. "application/json"
  17558. ],
  17559. "tags": [
  17560. "user"
  17561. ],
  17562. "summary": "List the repos owned by the given user",
  17563. "operationId": "userListRepos",
  17564. "parameters": [
  17565. {
  17566. "type": "string",
  17567. "description": "username of user",
  17568. "name": "username",
  17569. "in": "path",
  17570. "required": true
  17571. },
  17572. {
  17573. "type": "integer",
  17574. "description": "page number of results to return (1-based)",
  17575. "name": "page",
  17576. "in": "query"
  17577. },
  17578. {
  17579. "type": "integer",
  17580. "description": "page size of results",
  17581. "name": "limit",
  17582. "in": "query"
  17583. }
  17584. ],
  17585. "responses": {
  17586. "200": {
  17587. "$ref": "#/responses/RepositoryList"
  17588. },
  17589. "404": {
  17590. "$ref": "#/responses/notFound"
  17591. }
  17592. }
  17593. }
  17594. },
  17595. "/users/{username}/starred": {
  17596. "get": {
  17597. "produces": [
  17598. "application/json"
  17599. ],
  17600. "tags": [
  17601. "user"
  17602. ],
  17603. "summary": "The repos that the given user has starred",
  17604. "operationId": "userListStarred",
  17605. "parameters": [
  17606. {
  17607. "type": "string",
  17608. "description": "username of user",
  17609. "name": "username",
  17610. "in": "path",
  17611. "required": true
  17612. },
  17613. {
  17614. "type": "integer",
  17615. "description": "page number of results to return (1-based)",
  17616. "name": "page",
  17617. "in": "query"
  17618. },
  17619. {
  17620. "type": "integer",
  17621. "description": "page size of results",
  17622. "name": "limit",
  17623. "in": "query"
  17624. }
  17625. ],
  17626. "responses": {
  17627. "200": {
  17628. "$ref": "#/responses/RepositoryList"
  17629. },
  17630. "404": {
  17631. "$ref": "#/responses/notFound"
  17632. }
  17633. }
  17634. }
  17635. },
  17636. "/users/{username}/subscriptions": {
  17637. "get": {
  17638. "produces": [
  17639. "application/json"
  17640. ],
  17641. "tags": [
  17642. "user"
  17643. ],
  17644. "summary": "List the repositories watched by a user",
  17645. "operationId": "userListSubscriptions",
  17646. "parameters": [
  17647. {
  17648. "type": "string",
  17649. "description": "username of the user",
  17650. "name": "username",
  17651. "in": "path",
  17652. "required": true
  17653. },
  17654. {
  17655. "type": "integer",
  17656. "description": "page number of results to return (1-based)",
  17657. "name": "page",
  17658. "in": "query"
  17659. },
  17660. {
  17661. "type": "integer",
  17662. "description": "page size of results",
  17663. "name": "limit",
  17664. "in": "query"
  17665. }
  17666. ],
  17667. "responses": {
  17668. "200": {
  17669. "$ref": "#/responses/RepositoryList"
  17670. },
  17671. "404": {
  17672. "$ref": "#/responses/notFound"
  17673. }
  17674. }
  17675. }
  17676. },
  17677. "/users/{username}/tokens": {
  17678. "get": {
  17679. "produces": [
  17680. "application/json"
  17681. ],
  17682. "tags": [
  17683. "user"
  17684. ],
  17685. "summary": "List the authenticated user's access tokens",
  17686. "operationId": "userGetTokens",
  17687. "parameters": [
  17688. {
  17689. "type": "string",
  17690. "description": "username of user",
  17691. "name": "username",
  17692. "in": "path",
  17693. "required": true
  17694. },
  17695. {
  17696. "type": "integer",
  17697. "description": "page number of results to return (1-based)",
  17698. "name": "page",
  17699. "in": "query"
  17700. },
  17701. {
  17702. "type": "integer",
  17703. "description": "page size of results",
  17704. "name": "limit",
  17705. "in": "query"
  17706. }
  17707. ],
  17708. "responses": {
  17709. "200": {
  17710. "$ref": "#/responses/AccessTokenList"
  17711. },
  17712. "403": {
  17713. "$ref": "#/responses/forbidden"
  17714. }
  17715. }
  17716. },
  17717. "post": {
  17718. "consumes": [
  17719. "application/json"
  17720. ],
  17721. "produces": [
  17722. "application/json"
  17723. ],
  17724. "tags": [
  17725. "user"
  17726. ],
  17727. "summary": "Create an access token",
  17728. "operationId": "userCreateToken",
  17729. "parameters": [
  17730. {
  17731. "type": "string",
  17732. "description": "username of user",
  17733. "name": "username",
  17734. "in": "path",
  17735. "required": true
  17736. },
  17737. {
  17738. "name": "body",
  17739. "in": "body",
  17740. "schema": {
  17741. "$ref": "#/definitions/CreateAccessTokenOption"
  17742. }
  17743. }
  17744. ],
  17745. "responses": {
  17746. "201": {
  17747. "$ref": "#/responses/AccessToken"
  17748. },
  17749. "400": {
  17750. "$ref": "#/responses/error"
  17751. },
  17752. "403": {
  17753. "$ref": "#/responses/forbidden"
  17754. }
  17755. }
  17756. }
  17757. },
  17758. "/users/{username}/tokens/{token}": {
  17759. "delete": {
  17760. "produces": [
  17761. "application/json"
  17762. ],
  17763. "tags": [
  17764. "user"
  17765. ],
  17766. "summary": "delete an access token",
  17767. "operationId": "userDeleteAccessToken",
  17768. "parameters": [
  17769. {
  17770. "type": "string",
  17771. "description": "username of user",
  17772. "name": "username",
  17773. "in": "path",
  17774. "required": true
  17775. },
  17776. {
  17777. "type": "string",
  17778. "description": "token to be deleted, identified by ID and if not available by name",
  17779. "name": "token",
  17780. "in": "path",
  17781. "required": true
  17782. }
  17783. ],
  17784. "responses": {
  17785. "204": {
  17786. "$ref": "#/responses/empty"
  17787. },
  17788. "403": {
  17789. "$ref": "#/responses/forbidden"
  17790. },
  17791. "404": {
  17792. "$ref": "#/responses/notFound"
  17793. },
  17794. "422": {
  17795. "$ref": "#/responses/error"
  17796. }
  17797. }
  17798. }
  17799. },
  17800. "/version": {
  17801. "get": {
  17802. "produces": [
  17803. "application/json"
  17804. ],
  17805. "tags": [
  17806. "miscellaneous"
  17807. ],
  17808. "summary": "Returns the version of the Gitea application",
  17809. "operationId": "getVersion",
  17810. "responses": {
  17811. "200": {
  17812. "$ref": "#/responses/ServerVersion"
  17813. }
  17814. }
  17815. }
  17816. }
  17817. },
  17818. "definitions": {
  17819. "APIError": {
  17820. "description": "APIError is an api error with a message",
  17821. "type": "object",
  17822. "properties": {
  17823. "message": {
  17824. "type": "string",
  17825. "x-go-name": "Message"
  17826. },
  17827. "url": {
  17828. "type": "string",
  17829. "x-go-name": "URL"
  17830. }
  17831. },
  17832. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17833. },
  17834. "AccessToken": {
  17835. "type": "object",
  17836. "title": "AccessToken represents an API access token.",
  17837. "properties": {
  17838. "id": {
  17839. "type": "integer",
  17840. "format": "int64",
  17841. "x-go-name": "ID"
  17842. },
  17843. "name": {
  17844. "type": "string",
  17845. "x-go-name": "Name"
  17846. },
  17847. "scopes": {
  17848. "type": "array",
  17849. "items": {
  17850. "type": "string"
  17851. },
  17852. "x-go-name": "Scopes"
  17853. },
  17854. "sha1": {
  17855. "type": "string",
  17856. "x-go-name": "Token"
  17857. },
  17858. "token_last_eight": {
  17859. "type": "string",
  17860. "x-go-name": "TokenLastEight"
  17861. }
  17862. },
  17863. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17864. },
  17865. "ActionVariable": {
  17866. "description": "ActionVariable return value of the query API",
  17867. "type": "object",
  17868. "properties": {
  17869. "data": {
  17870. "description": "the value of the variable",
  17871. "type": "string",
  17872. "x-go-name": "Data"
  17873. },
  17874. "name": {
  17875. "description": "the name of the variable",
  17876. "type": "string",
  17877. "x-go-name": "Name"
  17878. },
  17879. "owner_id": {
  17880. "description": "the owner to which the variable belongs",
  17881. "type": "integer",
  17882. "format": "int64",
  17883. "x-go-name": "OwnerID"
  17884. },
  17885. "repo_id": {
  17886. "description": "the repository to which the variable belongs",
  17887. "type": "integer",
  17888. "format": "int64",
  17889. "x-go-name": "RepoID"
  17890. }
  17891. },
  17892. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17893. },
  17894. "Activity": {
  17895. "type": "object",
  17896. "properties": {
  17897. "act_user": {
  17898. "$ref": "#/definitions/User"
  17899. },
  17900. "act_user_id": {
  17901. "type": "integer",
  17902. "format": "int64",
  17903. "x-go-name": "ActUserID"
  17904. },
  17905. "comment": {
  17906. "$ref": "#/definitions/Comment"
  17907. },
  17908. "comment_id": {
  17909. "type": "integer",
  17910. "format": "int64",
  17911. "x-go-name": "CommentID"
  17912. },
  17913. "content": {
  17914. "type": "string",
  17915. "x-go-name": "Content"
  17916. },
  17917. "created": {
  17918. "type": "string",
  17919. "format": "date-time",
  17920. "x-go-name": "Created"
  17921. },
  17922. "id": {
  17923. "type": "integer",
  17924. "format": "int64",
  17925. "x-go-name": "ID"
  17926. },
  17927. "is_private": {
  17928. "type": "boolean",
  17929. "x-go-name": "IsPrivate"
  17930. },
  17931. "op_type": {
  17932. "type": "string",
  17933. "x-go-name": "OpType"
  17934. },
  17935. "ref_name": {
  17936. "type": "string",
  17937. "x-go-name": "RefName"
  17938. },
  17939. "repo": {
  17940. "$ref": "#/definitions/Repository"
  17941. },
  17942. "repo_id": {
  17943. "type": "integer",
  17944. "format": "int64",
  17945. "x-go-name": "RepoID"
  17946. },
  17947. "user_id": {
  17948. "type": "integer",
  17949. "format": "int64",
  17950. "x-go-name": "UserID"
  17951. }
  17952. },
  17953. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17954. },
  17955. "ActivityPub": {
  17956. "description": "ActivityPub type",
  17957. "type": "object",
  17958. "properties": {
  17959. "@context": {
  17960. "type": "string",
  17961. "x-go-name": "Context"
  17962. }
  17963. },
  17964. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17965. },
  17966. "AddCollaboratorOption": {
  17967. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  17968. "type": "object",
  17969. "properties": {
  17970. "permission": {
  17971. "type": "string",
  17972. "x-go-name": "Permission"
  17973. }
  17974. },
  17975. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17976. },
  17977. "AddTimeOption": {
  17978. "description": "AddTimeOption options for adding time to an issue",
  17979. "type": "object",
  17980. "required": [
  17981. "time"
  17982. ],
  17983. "properties": {
  17984. "created": {
  17985. "type": "string",
  17986. "format": "date-time",
  17987. "x-go-name": "Created"
  17988. },
  17989. "time": {
  17990. "description": "time in seconds",
  17991. "type": "integer",
  17992. "format": "int64",
  17993. "x-go-name": "Time"
  17994. },
  17995. "user_name": {
  17996. "description": "User who spent the time (optional)",
  17997. "type": "string",
  17998. "x-go-name": "User"
  17999. }
  18000. },
  18001. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18002. },
  18003. "AnnotatedTag": {
  18004. "description": "AnnotatedTag represents an annotated tag",
  18005. "type": "object",
  18006. "properties": {
  18007. "message": {
  18008. "type": "string",
  18009. "x-go-name": "Message"
  18010. },
  18011. "object": {
  18012. "$ref": "#/definitions/AnnotatedTagObject"
  18013. },
  18014. "sha": {
  18015. "type": "string",
  18016. "x-go-name": "SHA"
  18017. },
  18018. "tag": {
  18019. "type": "string",
  18020. "x-go-name": "Tag"
  18021. },
  18022. "tagger": {
  18023. "$ref": "#/definitions/CommitUser"
  18024. },
  18025. "url": {
  18026. "type": "string",
  18027. "x-go-name": "URL"
  18028. },
  18029. "verification": {
  18030. "$ref": "#/definitions/PayloadCommitVerification"
  18031. }
  18032. },
  18033. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18034. },
  18035. "AnnotatedTagObject": {
  18036. "description": "AnnotatedTagObject contains meta information of the tag object",
  18037. "type": "object",
  18038. "properties": {
  18039. "sha": {
  18040. "type": "string",
  18041. "x-go-name": "SHA"
  18042. },
  18043. "type": {
  18044. "type": "string",
  18045. "x-go-name": "Type"
  18046. },
  18047. "url": {
  18048. "type": "string",
  18049. "x-go-name": "URL"
  18050. }
  18051. },
  18052. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18053. },
  18054. "Attachment": {
  18055. "description": "Attachment a generic attachment",
  18056. "type": "object",
  18057. "properties": {
  18058. "browser_download_url": {
  18059. "type": "string",
  18060. "x-go-name": "DownloadURL"
  18061. },
  18062. "created_at": {
  18063. "type": "string",
  18064. "format": "date-time",
  18065. "x-go-name": "Created"
  18066. },
  18067. "download_count": {
  18068. "type": "integer",
  18069. "format": "int64",
  18070. "x-go-name": "DownloadCount"
  18071. },
  18072. "id": {
  18073. "type": "integer",
  18074. "format": "int64",
  18075. "x-go-name": "ID"
  18076. },
  18077. "name": {
  18078. "type": "string",
  18079. "x-go-name": "Name"
  18080. },
  18081. "size": {
  18082. "type": "integer",
  18083. "format": "int64",
  18084. "x-go-name": "Size"
  18085. },
  18086. "uuid": {
  18087. "type": "string",
  18088. "x-go-name": "UUID"
  18089. }
  18090. },
  18091. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18092. },
  18093. "Badge": {
  18094. "description": "Badge represents a user badge",
  18095. "type": "object",
  18096. "properties": {
  18097. "description": {
  18098. "type": "string",
  18099. "x-go-name": "Description"
  18100. },
  18101. "id": {
  18102. "type": "integer",
  18103. "format": "int64",
  18104. "x-go-name": "ID"
  18105. },
  18106. "image_url": {
  18107. "type": "string",
  18108. "x-go-name": "ImageURL"
  18109. },
  18110. "slug": {
  18111. "type": "string",
  18112. "x-go-name": "Slug"
  18113. }
  18114. },
  18115. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18116. },
  18117. "Branch": {
  18118. "description": "Branch represents a repository branch",
  18119. "type": "object",
  18120. "properties": {
  18121. "commit": {
  18122. "$ref": "#/definitions/PayloadCommit"
  18123. },
  18124. "effective_branch_protection_name": {
  18125. "type": "string",
  18126. "x-go-name": "EffectiveBranchProtectionName"
  18127. },
  18128. "enable_status_check": {
  18129. "type": "boolean",
  18130. "x-go-name": "EnableStatusCheck"
  18131. },
  18132. "name": {
  18133. "type": "string",
  18134. "x-go-name": "Name"
  18135. },
  18136. "protected": {
  18137. "type": "boolean",
  18138. "x-go-name": "Protected"
  18139. },
  18140. "required_approvals": {
  18141. "type": "integer",
  18142. "format": "int64",
  18143. "x-go-name": "RequiredApprovals"
  18144. },
  18145. "status_check_contexts": {
  18146. "type": "array",
  18147. "items": {
  18148. "type": "string"
  18149. },
  18150. "x-go-name": "StatusCheckContexts"
  18151. },
  18152. "user_can_merge": {
  18153. "type": "boolean",
  18154. "x-go-name": "UserCanMerge"
  18155. },
  18156. "user_can_push": {
  18157. "type": "boolean",
  18158. "x-go-name": "UserCanPush"
  18159. }
  18160. },
  18161. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18162. },
  18163. "BranchProtection": {
  18164. "description": "BranchProtection represents a branch protection for a repository",
  18165. "type": "object",
  18166. "properties": {
  18167. "approvals_whitelist_teams": {
  18168. "type": "array",
  18169. "items": {
  18170. "type": "string"
  18171. },
  18172. "x-go-name": "ApprovalsWhitelistTeams"
  18173. },
  18174. "approvals_whitelist_username": {
  18175. "type": "array",
  18176. "items": {
  18177. "type": "string"
  18178. },
  18179. "x-go-name": "ApprovalsWhitelistUsernames"
  18180. },
  18181. "block_on_official_review_requests": {
  18182. "type": "boolean",
  18183. "x-go-name": "BlockOnOfficialReviewRequests"
  18184. },
  18185. "block_on_outdated_branch": {
  18186. "type": "boolean",
  18187. "x-go-name": "BlockOnOutdatedBranch"
  18188. },
  18189. "block_on_rejected_reviews": {
  18190. "type": "boolean",
  18191. "x-go-name": "BlockOnRejectedReviews"
  18192. },
  18193. "branch_name": {
  18194. "description": "Deprecated: true",
  18195. "type": "string",
  18196. "x-go-name": "BranchName"
  18197. },
  18198. "created_at": {
  18199. "type": "string",
  18200. "format": "date-time",
  18201. "x-go-name": "Created"
  18202. },
  18203. "dismiss_stale_approvals": {
  18204. "type": "boolean",
  18205. "x-go-name": "DismissStaleApprovals"
  18206. },
  18207. "enable_approvals_whitelist": {
  18208. "type": "boolean",
  18209. "x-go-name": "EnableApprovalsWhitelist"
  18210. },
  18211. "enable_merge_whitelist": {
  18212. "type": "boolean",
  18213. "x-go-name": "EnableMergeWhitelist"
  18214. },
  18215. "enable_push": {
  18216. "type": "boolean",
  18217. "x-go-name": "EnablePush"
  18218. },
  18219. "enable_push_whitelist": {
  18220. "type": "boolean",
  18221. "x-go-name": "EnablePushWhitelist"
  18222. },
  18223. "enable_status_check": {
  18224. "type": "boolean",
  18225. "x-go-name": "EnableStatusCheck"
  18226. },
  18227. "ignore_stale_approvals": {
  18228. "type": "boolean",
  18229. "x-go-name": "IgnoreStaleApprovals"
  18230. },
  18231. "merge_whitelist_teams": {
  18232. "type": "array",
  18233. "items": {
  18234. "type": "string"
  18235. },
  18236. "x-go-name": "MergeWhitelistTeams"
  18237. },
  18238. "merge_whitelist_usernames": {
  18239. "type": "array",
  18240. "items": {
  18241. "type": "string"
  18242. },
  18243. "x-go-name": "MergeWhitelistUsernames"
  18244. },
  18245. "protected_file_patterns": {
  18246. "type": "string",
  18247. "x-go-name": "ProtectedFilePatterns"
  18248. },
  18249. "push_whitelist_deploy_keys": {
  18250. "type": "boolean",
  18251. "x-go-name": "PushWhitelistDeployKeys"
  18252. },
  18253. "push_whitelist_teams": {
  18254. "type": "array",
  18255. "items": {
  18256. "type": "string"
  18257. },
  18258. "x-go-name": "PushWhitelistTeams"
  18259. },
  18260. "push_whitelist_usernames": {
  18261. "type": "array",
  18262. "items": {
  18263. "type": "string"
  18264. },
  18265. "x-go-name": "PushWhitelistUsernames"
  18266. },
  18267. "require_signed_commits": {
  18268. "type": "boolean",
  18269. "x-go-name": "RequireSignedCommits"
  18270. },
  18271. "required_approvals": {
  18272. "type": "integer",
  18273. "format": "int64",
  18274. "x-go-name": "RequiredApprovals"
  18275. },
  18276. "rule_name": {
  18277. "type": "string",
  18278. "x-go-name": "RuleName"
  18279. },
  18280. "status_check_contexts": {
  18281. "type": "array",
  18282. "items": {
  18283. "type": "string"
  18284. },
  18285. "x-go-name": "StatusCheckContexts"
  18286. },
  18287. "unprotected_file_patterns": {
  18288. "type": "string",
  18289. "x-go-name": "UnprotectedFilePatterns"
  18290. },
  18291. "updated_at": {
  18292. "type": "string",
  18293. "format": "date-time",
  18294. "x-go-name": "Updated"
  18295. }
  18296. },
  18297. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18298. },
  18299. "ChangeFileOperation": {
  18300. "description": "ChangeFileOperation for creating, updating or deleting a file",
  18301. "type": "object",
  18302. "required": [
  18303. "operation",
  18304. "path"
  18305. ],
  18306. "properties": {
  18307. "content": {
  18308. "description": "new or updated file content, must be base64 encoded",
  18309. "type": "string",
  18310. "x-go-name": "ContentBase64"
  18311. },
  18312. "from_path": {
  18313. "description": "old path of the file to move",
  18314. "type": "string",
  18315. "x-go-name": "FromPath"
  18316. },
  18317. "operation": {
  18318. "description": "indicates what to do with the file",
  18319. "type": "string",
  18320. "enum": [
  18321. "create",
  18322. "update",
  18323. "delete"
  18324. ],
  18325. "x-go-name": "Operation"
  18326. },
  18327. "path": {
  18328. "description": "path to the existing or new file",
  18329. "type": "string",
  18330. "x-go-name": "Path"
  18331. },
  18332. "sha": {
  18333. "description": "sha is the SHA for the file that already exists, required for update or delete",
  18334. "type": "string",
  18335. "x-go-name": "SHA"
  18336. }
  18337. },
  18338. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18339. },
  18340. "ChangeFilesOptions": {
  18341. "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)",
  18342. "type": "object",
  18343. "required": [
  18344. "files"
  18345. ],
  18346. "properties": {
  18347. "author": {
  18348. "$ref": "#/definitions/Identity"
  18349. },
  18350. "branch": {
  18351. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  18352. "type": "string",
  18353. "x-go-name": "BranchName"
  18354. },
  18355. "committer": {
  18356. "$ref": "#/definitions/Identity"
  18357. },
  18358. "dates": {
  18359. "$ref": "#/definitions/CommitDateOptions"
  18360. },
  18361. "files": {
  18362. "description": "list of file operations",
  18363. "type": "array",
  18364. "items": {
  18365. "$ref": "#/definitions/ChangeFileOperation"
  18366. },
  18367. "x-go-name": "Files"
  18368. },
  18369. "message": {
  18370. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  18371. "type": "string",
  18372. "x-go-name": "Message"
  18373. },
  18374. "new_branch": {
  18375. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  18376. "type": "string",
  18377. "x-go-name": "NewBranchName"
  18378. },
  18379. "signoff": {
  18380. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  18381. "type": "boolean",
  18382. "x-go-name": "Signoff"
  18383. }
  18384. },
  18385. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18386. },
  18387. "ChangedFile": {
  18388. "description": "ChangedFile store information about files affected by the pull request",
  18389. "type": "object",
  18390. "properties": {
  18391. "additions": {
  18392. "type": "integer",
  18393. "format": "int64",
  18394. "x-go-name": "Additions"
  18395. },
  18396. "changes": {
  18397. "type": "integer",
  18398. "format": "int64",
  18399. "x-go-name": "Changes"
  18400. },
  18401. "contents_url": {
  18402. "type": "string",
  18403. "x-go-name": "ContentsURL"
  18404. },
  18405. "deletions": {
  18406. "type": "integer",
  18407. "format": "int64",
  18408. "x-go-name": "Deletions"
  18409. },
  18410. "filename": {
  18411. "type": "string",
  18412. "x-go-name": "Filename"
  18413. },
  18414. "html_url": {
  18415. "type": "string",
  18416. "x-go-name": "HTMLURL"
  18417. },
  18418. "previous_filename": {
  18419. "type": "string",
  18420. "x-go-name": "PreviousFilename"
  18421. },
  18422. "raw_url": {
  18423. "type": "string",
  18424. "x-go-name": "RawURL"
  18425. },
  18426. "status": {
  18427. "type": "string",
  18428. "x-go-name": "Status"
  18429. }
  18430. },
  18431. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18432. },
  18433. "CombinedStatus": {
  18434. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  18435. "type": "object",
  18436. "properties": {
  18437. "commit_url": {
  18438. "type": "string",
  18439. "x-go-name": "CommitURL"
  18440. },
  18441. "repository": {
  18442. "$ref": "#/definitions/Repository"
  18443. },
  18444. "sha": {
  18445. "type": "string",
  18446. "x-go-name": "SHA"
  18447. },
  18448. "state": {
  18449. "$ref": "#/definitions/CommitStatusState"
  18450. },
  18451. "statuses": {
  18452. "type": "array",
  18453. "items": {
  18454. "$ref": "#/definitions/CommitStatus"
  18455. },
  18456. "x-go-name": "Statuses"
  18457. },
  18458. "total_count": {
  18459. "type": "integer",
  18460. "format": "int64",
  18461. "x-go-name": "TotalCount"
  18462. },
  18463. "url": {
  18464. "type": "string",
  18465. "x-go-name": "URL"
  18466. }
  18467. },
  18468. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18469. },
  18470. "Comment": {
  18471. "description": "Comment represents a comment on a commit or issue",
  18472. "type": "object",
  18473. "properties": {
  18474. "assets": {
  18475. "type": "array",
  18476. "items": {
  18477. "$ref": "#/definitions/Attachment"
  18478. },
  18479. "x-go-name": "Attachments"
  18480. },
  18481. "body": {
  18482. "type": "string",
  18483. "x-go-name": "Body"
  18484. },
  18485. "created_at": {
  18486. "type": "string",
  18487. "format": "date-time",
  18488. "x-go-name": "Created"
  18489. },
  18490. "html_url": {
  18491. "type": "string",
  18492. "x-go-name": "HTMLURL"
  18493. },
  18494. "id": {
  18495. "type": "integer",
  18496. "format": "int64",
  18497. "x-go-name": "ID"
  18498. },
  18499. "issue_url": {
  18500. "type": "string",
  18501. "x-go-name": "IssueURL"
  18502. },
  18503. "original_author": {
  18504. "type": "string",
  18505. "x-go-name": "OriginalAuthor"
  18506. },
  18507. "original_author_id": {
  18508. "type": "integer",
  18509. "format": "int64",
  18510. "x-go-name": "OriginalAuthorID"
  18511. },
  18512. "pull_request_url": {
  18513. "type": "string",
  18514. "x-go-name": "PRURL"
  18515. },
  18516. "updated_at": {
  18517. "type": "string",
  18518. "format": "date-time",
  18519. "x-go-name": "Updated"
  18520. },
  18521. "user": {
  18522. "$ref": "#/definitions/User"
  18523. }
  18524. },
  18525. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18526. },
  18527. "Commit": {
  18528. "type": "object",
  18529. "title": "Commit contains information generated from a Git commit.",
  18530. "properties": {
  18531. "author": {
  18532. "$ref": "#/definitions/User"
  18533. },
  18534. "commit": {
  18535. "$ref": "#/definitions/RepoCommit"
  18536. },
  18537. "committer": {
  18538. "$ref": "#/definitions/User"
  18539. },
  18540. "created": {
  18541. "type": "string",
  18542. "format": "date-time",
  18543. "x-go-name": "Created"
  18544. },
  18545. "files": {
  18546. "type": "array",
  18547. "items": {
  18548. "$ref": "#/definitions/CommitAffectedFiles"
  18549. },
  18550. "x-go-name": "Files"
  18551. },
  18552. "html_url": {
  18553. "type": "string",
  18554. "x-go-name": "HTMLURL"
  18555. },
  18556. "parents": {
  18557. "type": "array",
  18558. "items": {
  18559. "$ref": "#/definitions/CommitMeta"
  18560. },
  18561. "x-go-name": "Parents"
  18562. },
  18563. "sha": {
  18564. "type": "string",
  18565. "x-go-name": "SHA"
  18566. },
  18567. "stats": {
  18568. "$ref": "#/definitions/CommitStats"
  18569. },
  18570. "url": {
  18571. "type": "string",
  18572. "x-go-name": "URL"
  18573. }
  18574. },
  18575. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18576. },
  18577. "CommitAffectedFiles": {
  18578. "description": "CommitAffectedFiles store information about files affected by the commit",
  18579. "type": "object",
  18580. "properties": {
  18581. "filename": {
  18582. "type": "string",
  18583. "x-go-name": "Filename"
  18584. },
  18585. "status": {
  18586. "type": "string",
  18587. "x-go-name": "Status"
  18588. }
  18589. },
  18590. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18591. },
  18592. "CommitDateOptions": {
  18593. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  18594. "type": "object",
  18595. "properties": {
  18596. "author": {
  18597. "type": "string",
  18598. "format": "date-time",
  18599. "x-go-name": "Author"
  18600. },
  18601. "committer": {
  18602. "type": "string",
  18603. "format": "date-time",
  18604. "x-go-name": "Committer"
  18605. }
  18606. },
  18607. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18608. },
  18609. "CommitMeta": {
  18610. "type": "object",
  18611. "title": "CommitMeta contains meta information of a commit in terms of API.",
  18612. "properties": {
  18613. "created": {
  18614. "type": "string",
  18615. "format": "date-time",
  18616. "x-go-name": "Created"
  18617. },
  18618. "sha": {
  18619. "type": "string",
  18620. "x-go-name": "SHA"
  18621. },
  18622. "url": {
  18623. "type": "string",
  18624. "x-go-name": "URL"
  18625. }
  18626. },
  18627. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18628. },
  18629. "CommitStats": {
  18630. "description": "CommitStats is statistics for a RepoCommit",
  18631. "type": "object",
  18632. "properties": {
  18633. "additions": {
  18634. "type": "integer",
  18635. "format": "int64",
  18636. "x-go-name": "Additions"
  18637. },
  18638. "deletions": {
  18639. "type": "integer",
  18640. "format": "int64",
  18641. "x-go-name": "Deletions"
  18642. },
  18643. "total": {
  18644. "type": "integer",
  18645. "format": "int64",
  18646. "x-go-name": "Total"
  18647. }
  18648. },
  18649. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18650. },
  18651. "CommitStatus": {
  18652. "description": "CommitStatus holds a single status of a single Commit",
  18653. "type": "object",
  18654. "properties": {
  18655. "context": {
  18656. "type": "string",
  18657. "x-go-name": "Context"
  18658. },
  18659. "created_at": {
  18660. "type": "string",
  18661. "format": "date-time",
  18662. "x-go-name": "Created"
  18663. },
  18664. "creator": {
  18665. "$ref": "#/definitions/User"
  18666. },
  18667. "description": {
  18668. "type": "string",
  18669. "x-go-name": "Description"
  18670. },
  18671. "id": {
  18672. "type": "integer",
  18673. "format": "int64",
  18674. "x-go-name": "ID"
  18675. },
  18676. "status": {
  18677. "$ref": "#/definitions/CommitStatusState"
  18678. },
  18679. "target_url": {
  18680. "type": "string",
  18681. "x-go-name": "TargetURL"
  18682. },
  18683. "updated_at": {
  18684. "type": "string",
  18685. "format": "date-time",
  18686. "x-go-name": "Updated"
  18687. },
  18688. "url": {
  18689. "type": "string",
  18690. "x-go-name": "URL"
  18691. }
  18692. },
  18693. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18694. },
  18695. "CommitStatusState": {
  18696. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"",
  18697. "type": "string",
  18698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18699. },
  18700. "CommitUser": {
  18701. "type": "object",
  18702. "title": "CommitUser contains information of a user in the context of a commit.",
  18703. "properties": {
  18704. "date": {
  18705. "type": "string",
  18706. "x-go-name": "Date"
  18707. },
  18708. "email": {
  18709. "type": "string",
  18710. "format": "email",
  18711. "x-go-name": "Email"
  18712. },
  18713. "name": {
  18714. "type": "string",
  18715. "x-go-name": "Name"
  18716. }
  18717. },
  18718. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18719. },
  18720. "ContentsResponse": {
  18721. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  18722. "type": "object",
  18723. "properties": {
  18724. "_links": {
  18725. "$ref": "#/definitions/FileLinksResponse"
  18726. },
  18727. "content": {
  18728. "description": "`content` is populated when `type` is `file`, otherwise null",
  18729. "type": "string",
  18730. "x-go-name": "Content"
  18731. },
  18732. "download_url": {
  18733. "type": "string",
  18734. "x-go-name": "DownloadURL"
  18735. },
  18736. "encoding": {
  18737. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  18738. "type": "string",
  18739. "x-go-name": "Encoding"
  18740. },
  18741. "git_url": {
  18742. "type": "string",
  18743. "x-go-name": "GitURL"
  18744. },
  18745. "html_url": {
  18746. "type": "string",
  18747. "x-go-name": "HTMLURL"
  18748. },
  18749. "last_commit_sha": {
  18750. "type": "string",
  18751. "x-go-name": "LastCommitSHA"
  18752. },
  18753. "name": {
  18754. "type": "string",
  18755. "x-go-name": "Name"
  18756. },
  18757. "path": {
  18758. "type": "string",
  18759. "x-go-name": "Path"
  18760. },
  18761. "sha": {
  18762. "type": "string",
  18763. "x-go-name": "SHA"
  18764. },
  18765. "size": {
  18766. "type": "integer",
  18767. "format": "int64",
  18768. "x-go-name": "Size"
  18769. },
  18770. "submodule_git_url": {
  18771. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  18772. "type": "string",
  18773. "x-go-name": "SubmoduleGitURL"
  18774. },
  18775. "target": {
  18776. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  18777. "type": "string",
  18778. "x-go-name": "Target"
  18779. },
  18780. "type": {
  18781. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  18782. "type": "string",
  18783. "x-go-name": "Type"
  18784. },
  18785. "url": {
  18786. "type": "string",
  18787. "x-go-name": "URL"
  18788. }
  18789. },
  18790. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18791. },
  18792. "CreateAccessTokenOption": {
  18793. "description": "CreateAccessTokenOption options when create access token",
  18794. "type": "object",
  18795. "required": [
  18796. "name"
  18797. ],
  18798. "properties": {
  18799. "name": {
  18800. "type": "string",
  18801. "x-go-name": "Name"
  18802. },
  18803. "scopes": {
  18804. "type": "array",
  18805. "items": {
  18806. "type": "string"
  18807. },
  18808. "x-go-name": "Scopes"
  18809. }
  18810. },
  18811. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18812. },
  18813. "CreateBranchProtectionOption": {
  18814. "description": "CreateBranchProtectionOption options for creating a branch protection",
  18815. "type": "object",
  18816. "properties": {
  18817. "approvals_whitelist_teams": {
  18818. "type": "array",
  18819. "items": {
  18820. "type": "string"
  18821. },
  18822. "x-go-name": "ApprovalsWhitelistTeams"
  18823. },
  18824. "approvals_whitelist_username": {
  18825. "type": "array",
  18826. "items": {
  18827. "type": "string"
  18828. },
  18829. "x-go-name": "ApprovalsWhitelistUsernames"
  18830. },
  18831. "block_on_official_review_requests": {
  18832. "type": "boolean",
  18833. "x-go-name": "BlockOnOfficialReviewRequests"
  18834. },
  18835. "block_on_outdated_branch": {
  18836. "type": "boolean",
  18837. "x-go-name": "BlockOnOutdatedBranch"
  18838. },
  18839. "block_on_rejected_reviews": {
  18840. "type": "boolean",
  18841. "x-go-name": "BlockOnRejectedReviews"
  18842. },
  18843. "branch_name": {
  18844. "description": "Deprecated: true",
  18845. "type": "string",
  18846. "x-go-name": "BranchName"
  18847. },
  18848. "dismiss_stale_approvals": {
  18849. "type": "boolean",
  18850. "x-go-name": "DismissStaleApprovals"
  18851. },
  18852. "enable_approvals_whitelist": {
  18853. "type": "boolean",
  18854. "x-go-name": "EnableApprovalsWhitelist"
  18855. },
  18856. "enable_merge_whitelist": {
  18857. "type": "boolean",
  18858. "x-go-name": "EnableMergeWhitelist"
  18859. },
  18860. "enable_push": {
  18861. "type": "boolean",
  18862. "x-go-name": "EnablePush"
  18863. },
  18864. "enable_push_whitelist": {
  18865. "type": "boolean",
  18866. "x-go-name": "EnablePushWhitelist"
  18867. },
  18868. "enable_status_check": {
  18869. "type": "boolean",
  18870. "x-go-name": "EnableStatusCheck"
  18871. },
  18872. "ignore_stale_approvals": {
  18873. "type": "boolean",
  18874. "x-go-name": "IgnoreStaleApprovals"
  18875. },
  18876. "merge_whitelist_teams": {
  18877. "type": "array",
  18878. "items": {
  18879. "type": "string"
  18880. },
  18881. "x-go-name": "MergeWhitelistTeams"
  18882. },
  18883. "merge_whitelist_usernames": {
  18884. "type": "array",
  18885. "items": {
  18886. "type": "string"
  18887. },
  18888. "x-go-name": "MergeWhitelistUsernames"
  18889. },
  18890. "protected_file_patterns": {
  18891. "type": "string",
  18892. "x-go-name": "ProtectedFilePatterns"
  18893. },
  18894. "push_whitelist_deploy_keys": {
  18895. "type": "boolean",
  18896. "x-go-name": "PushWhitelistDeployKeys"
  18897. },
  18898. "push_whitelist_teams": {
  18899. "type": "array",
  18900. "items": {
  18901. "type": "string"
  18902. },
  18903. "x-go-name": "PushWhitelistTeams"
  18904. },
  18905. "push_whitelist_usernames": {
  18906. "type": "array",
  18907. "items": {
  18908. "type": "string"
  18909. },
  18910. "x-go-name": "PushWhitelistUsernames"
  18911. },
  18912. "require_signed_commits": {
  18913. "type": "boolean",
  18914. "x-go-name": "RequireSignedCommits"
  18915. },
  18916. "required_approvals": {
  18917. "type": "integer",
  18918. "format": "int64",
  18919. "x-go-name": "RequiredApprovals"
  18920. },
  18921. "rule_name": {
  18922. "type": "string",
  18923. "x-go-name": "RuleName"
  18924. },
  18925. "status_check_contexts": {
  18926. "type": "array",
  18927. "items": {
  18928. "type": "string"
  18929. },
  18930. "x-go-name": "StatusCheckContexts"
  18931. },
  18932. "unprotected_file_patterns": {
  18933. "type": "string",
  18934. "x-go-name": "UnprotectedFilePatterns"
  18935. }
  18936. },
  18937. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18938. },
  18939. "CreateBranchRepoOption": {
  18940. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  18941. "type": "object",
  18942. "required": [
  18943. "new_branch_name"
  18944. ],
  18945. "properties": {
  18946. "new_branch_name": {
  18947. "description": "Name of the branch to create",
  18948. "type": "string",
  18949. "uniqueItems": true,
  18950. "x-go-name": "BranchName"
  18951. },
  18952. "old_branch_name": {
  18953. "description": "Deprecated: true\nName of the old branch to create from",
  18954. "type": "string",
  18955. "uniqueItems": true,
  18956. "x-go-name": "OldBranchName"
  18957. },
  18958. "old_ref_name": {
  18959. "description": "Name of the old branch/tag/commit to create from",
  18960. "type": "string",
  18961. "uniqueItems": true,
  18962. "x-go-name": "OldRefName"
  18963. }
  18964. },
  18965. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18966. },
  18967. "CreateEmailOption": {
  18968. "description": "CreateEmailOption options when creating email addresses",
  18969. "type": "object",
  18970. "properties": {
  18971. "emails": {
  18972. "description": "email addresses to add",
  18973. "type": "array",
  18974. "items": {
  18975. "type": "string"
  18976. },
  18977. "x-go-name": "Emails"
  18978. }
  18979. },
  18980. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18981. },
  18982. "CreateFileOptions": {
  18983. "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)",
  18984. "type": "object",
  18985. "required": [
  18986. "content"
  18987. ],
  18988. "properties": {
  18989. "author": {
  18990. "$ref": "#/definitions/Identity"
  18991. },
  18992. "branch": {
  18993. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  18994. "type": "string",
  18995. "x-go-name": "BranchName"
  18996. },
  18997. "committer": {
  18998. "$ref": "#/definitions/Identity"
  18999. },
  19000. "content": {
  19001. "description": "content must be base64 encoded",
  19002. "type": "string",
  19003. "x-go-name": "ContentBase64"
  19004. },
  19005. "dates": {
  19006. "$ref": "#/definitions/CommitDateOptions"
  19007. },
  19008. "message": {
  19009. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  19010. "type": "string",
  19011. "x-go-name": "Message"
  19012. },
  19013. "new_branch": {
  19014. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  19015. "type": "string",
  19016. "x-go-name": "NewBranchName"
  19017. },
  19018. "signoff": {
  19019. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  19020. "type": "boolean",
  19021. "x-go-name": "Signoff"
  19022. }
  19023. },
  19024. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19025. },
  19026. "CreateForkOption": {
  19027. "description": "CreateForkOption options for creating a fork",
  19028. "type": "object",
  19029. "properties": {
  19030. "name": {
  19031. "description": "name of the forked repository",
  19032. "type": "string",
  19033. "x-go-name": "Name"
  19034. },
  19035. "organization": {
  19036. "description": "organization name, if forking into an organization",
  19037. "type": "string",
  19038. "x-go-name": "Organization"
  19039. }
  19040. },
  19041. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19042. },
  19043. "CreateGPGKeyOption": {
  19044. "description": "CreateGPGKeyOption options create user GPG key",
  19045. "type": "object",
  19046. "required": [
  19047. "armored_public_key"
  19048. ],
  19049. "properties": {
  19050. "armored_public_key": {
  19051. "description": "An armored GPG key to add",
  19052. "type": "string",
  19053. "uniqueItems": true,
  19054. "x-go-name": "ArmoredKey"
  19055. },
  19056. "armored_signature": {
  19057. "type": "string",
  19058. "x-go-name": "Signature"
  19059. }
  19060. },
  19061. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19062. },
  19063. "CreateHookOption": {
  19064. "description": "CreateHookOption options when create a hook",
  19065. "type": "object",
  19066. "required": [
  19067. "type",
  19068. "config"
  19069. ],
  19070. "properties": {
  19071. "active": {
  19072. "type": "boolean",
  19073. "default": false,
  19074. "x-go-name": "Active"
  19075. },
  19076. "authorization_header": {
  19077. "type": "string",
  19078. "x-go-name": "AuthorizationHeader"
  19079. },
  19080. "branch_filter": {
  19081. "type": "string",
  19082. "x-go-name": "BranchFilter"
  19083. },
  19084. "config": {
  19085. "$ref": "#/definitions/CreateHookOptionConfig"
  19086. },
  19087. "events": {
  19088. "type": "array",
  19089. "items": {
  19090. "type": "string"
  19091. },
  19092. "x-go-name": "Events"
  19093. },
  19094. "type": {
  19095. "type": "string",
  19096. "enum": [
  19097. "dingtalk",
  19098. "discord",
  19099. "gitea",
  19100. "gogs",
  19101. "msteams",
  19102. "slack",
  19103. "telegram",
  19104. "feishu",
  19105. "wechatwork",
  19106. "packagist"
  19107. ],
  19108. "x-go-name": "Type"
  19109. }
  19110. },
  19111. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19112. },
  19113. "CreateHookOptionConfig": {
  19114. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  19115. "type": "object",
  19116. "additionalProperties": {
  19117. "type": "string"
  19118. },
  19119. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19120. },
  19121. "CreateIssueCommentOption": {
  19122. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  19123. "type": "object",
  19124. "required": [
  19125. "body"
  19126. ],
  19127. "properties": {
  19128. "body": {
  19129. "type": "string",
  19130. "x-go-name": "Body"
  19131. }
  19132. },
  19133. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19134. },
  19135. "CreateIssueOption": {
  19136. "description": "CreateIssueOption options to create one issue",
  19137. "type": "object",
  19138. "required": [
  19139. "title"
  19140. ],
  19141. "properties": {
  19142. "assignee": {
  19143. "description": "deprecated",
  19144. "type": "string",
  19145. "x-go-name": "Assignee"
  19146. },
  19147. "assignees": {
  19148. "type": "array",
  19149. "items": {
  19150. "type": "string"
  19151. },
  19152. "x-go-name": "Assignees"
  19153. },
  19154. "body": {
  19155. "type": "string",
  19156. "x-go-name": "Body"
  19157. },
  19158. "closed": {
  19159. "type": "boolean",
  19160. "x-go-name": "Closed"
  19161. },
  19162. "due_date": {
  19163. "type": "string",
  19164. "format": "date-time",
  19165. "x-go-name": "Deadline"
  19166. },
  19167. "labels": {
  19168. "description": "list of label ids",
  19169. "type": "array",
  19170. "items": {
  19171. "type": "integer",
  19172. "format": "int64"
  19173. },
  19174. "x-go-name": "Labels"
  19175. },
  19176. "milestone": {
  19177. "description": "milestone id",
  19178. "type": "integer",
  19179. "format": "int64",
  19180. "x-go-name": "Milestone"
  19181. },
  19182. "ref": {
  19183. "type": "string",
  19184. "x-go-name": "Ref"
  19185. },
  19186. "title": {
  19187. "type": "string",
  19188. "x-go-name": "Title"
  19189. }
  19190. },
  19191. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19192. },
  19193. "CreateKeyOption": {
  19194. "description": "CreateKeyOption options when creating a key",
  19195. "type": "object",
  19196. "required": [
  19197. "title",
  19198. "key"
  19199. ],
  19200. "properties": {
  19201. "key": {
  19202. "description": "An armored SSH key to add",
  19203. "type": "string",
  19204. "uniqueItems": true,
  19205. "x-go-name": "Key"
  19206. },
  19207. "read_only": {
  19208. "description": "Describe if the key has only read access or read/write",
  19209. "type": "boolean",
  19210. "x-go-name": "ReadOnly"
  19211. },
  19212. "title": {
  19213. "description": "Title of the key to add",
  19214. "type": "string",
  19215. "uniqueItems": true,
  19216. "x-go-name": "Title"
  19217. }
  19218. },
  19219. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19220. },
  19221. "CreateLabelOption": {
  19222. "description": "CreateLabelOption options for creating a label",
  19223. "type": "object",
  19224. "required": [
  19225. "name",
  19226. "color"
  19227. ],
  19228. "properties": {
  19229. "color": {
  19230. "type": "string",
  19231. "x-go-name": "Color",
  19232. "example": "#00aabb"
  19233. },
  19234. "description": {
  19235. "type": "string",
  19236. "x-go-name": "Description"
  19237. },
  19238. "exclusive": {
  19239. "type": "boolean",
  19240. "x-go-name": "Exclusive",
  19241. "example": false
  19242. },
  19243. "is_archived": {
  19244. "type": "boolean",
  19245. "x-go-name": "IsArchived",
  19246. "example": false
  19247. },
  19248. "name": {
  19249. "type": "string",
  19250. "x-go-name": "Name"
  19251. }
  19252. },
  19253. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19254. },
  19255. "CreateMilestoneOption": {
  19256. "description": "CreateMilestoneOption options for creating a milestone",
  19257. "type": "object",
  19258. "properties": {
  19259. "description": {
  19260. "type": "string",
  19261. "x-go-name": "Description"
  19262. },
  19263. "due_on": {
  19264. "type": "string",
  19265. "format": "date-time",
  19266. "x-go-name": "Deadline"
  19267. },
  19268. "state": {
  19269. "type": "string",
  19270. "enum": [
  19271. "open",
  19272. "closed"
  19273. ],
  19274. "x-go-name": "State"
  19275. },
  19276. "title": {
  19277. "type": "string",
  19278. "x-go-name": "Title"
  19279. }
  19280. },
  19281. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19282. },
  19283. "CreateOAuth2ApplicationOptions": {
  19284. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  19285. "type": "object",
  19286. "properties": {
  19287. "confidential_client": {
  19288. "type": "boolean",
  19289. "x-go-name": "ConfidentialClient"
  19290. },
  19291. "name": {
  19292. "type": "string",
  19293. "x-go-name": "Name"
  19294. },
  19295. "redirect_uris": {
  19296. "type": "array",
  19297. "items": {
  19298. "type": "string"
  19299. },
  19300. "x-go-name": "RedirectURIs"
  19301. }
  19302. },
  19303. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19304. },
  19305. "CreateOrUpdateSecretOption": {
  19306. "description": "CreateOrUpdateSecretOption options when creating or updating secret",
  19307. "type": "object",
  19308. "required": [
  19309. "data"
  19310. ],
  19311. "properties": {
  19312. "data": {
  19313. "description": "Data of the secret to update",
  19314. "type": "string",
  19315. "x-go-name": "Data"
  19316. }
  19317. },
  19318. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19319. },
  19320. "CreateOrgOption": {
  19321. "description": "CreateOrgOption options for creating an organization",
  19322. "type": "object",
  19323. "required": [
  19324. "username"
  19325. ],
  19326. "properties": {
  19327. "description": {
  19328. "type": "string",
  19329. "x-go-name": "Description"
  19330. },
  19331. "email": {
  19332. "type": "string",
  19333. "x-go-name": "Email"
  19334. },
  19335. "full_name": {
  19336. "type": "string",
  19337. "x-go-name": "FullName"
  19338. },
  19339. "location": {
  19340. "type": "string",
  19341. "x-go-name": "Location"
  19342. },
  19343. "repo_admin_change_team_access": {
  19344. "type": "boolean",
  19345. "x-go-name": "RepoAdminChangeTeamAccess"
  19346. },
  19347. "username": {
  19348. "type": "string",
  19349. "x-go-name": "UserName"
  19350. },
  19351. "visibility": {
  19352. "description": "possible values are `public` (default), `limited` or `private`",
  19353. "type": "string",
  19354. "enum": [
  19355. "public",
  19356. "limited",
  19357. "private"
  19358. ],
  19359. "x-go-name": "Visibility"
  19360. },
  19361. "website": {
  19362. "type": "string",
  19363. "x-go-name": "Website"
  19364. }
  19365. },
  19366. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19367. },
  19368. "CreatePullRequestOption": {
  19369. "description": "CreatePullRequestOption options when creating a pull request",
  19370. "type": "object",
  19371. "properties": {
  19372. "assignee": {
  19373. "type": "string",
  19374. "x-go-name": "Assignee"
  19375. },
  19376. "assignees": {
  19377. "type": "array",
  19378. "items": {
  19379. "type": "string"
  19380. },
  19381. "x-go-name": "Assignees"
  19382. },
  19383. "base": {
  19384. "type": "string",
  19385. "x-go-name": "Base"
  19386. },
  19387. "body": {
  19388. "type": "string",
  19389. "x-go-name": "Body"
  19390. },
  19391. "due_date": {
  19392. "type": "string",
  19393. "format": "date-time",
  19394. "x-go-name": "Deadline"
  19395. },
  19396. "head": {
  19397. "type": "string",
  19398. "x-go-name": "Head"
  19399. },
  19400. "labels": {
  19401. "type": "array",
  19402. "items": {
  19403. "type": "integer",
  19404. "format": "int64"
  19405. },
  19406. "x-go-name": "Labels"
  19407. },
  19408. "milestone": {
  19409. "type": "integer",
  19410. "format": "int64",
  19411. "x-go-name": "Milestone"
  19412. },
  19413. "title": {
  19414. "type": "string",
  19415. "x-go-name": "Title"
  19416. }
  19417. },
  19418. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19419. },
  19420. "CreatePullReviewComment": {
  19421. "description": "CreatePullReviewComment represent a review comment for creation api",
  19422. "type": "object",
  19423. "properties": {
  19424. "body": {
  19425. "type": "string",
  19426. "x-go-name": "Body"
  19427. },
  19428. "new_position": {
  19429. "description": "if comment to new file line or 0",
  19430. "type": "integer",
  19431. "format": "int64",
  19432. "x-go-name": "NewLineNum"
  19433. },
  19434. "old_position": {
  19435. "description": "if comment to old file line or 0",
  19436. "type": "integer",
  19437. "format": "int64",
  19438. "x-go-name": "OldLineNum"
  19439. },
  19440. "path": {
  19441. "description": "the tree path",
  19442. "type": "string",
  19443. "x-go-name": "Path"
  19444. }
  19445. },
  19446. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19447. },
  19448. "CreatePullReviewOptions": {
  19449. "description": "CreatePullReviewOptions are options to create a pull review",
  19450. "type": "object",
  19451. "properties": {
  19452. "body": {
  19453. "type": "string",
  19454. "x-go-name": "Body"
  19455. },
  19456. "comments": {
  19457. "type": "array",
  19458. "items": {
  19459. "$ref": "#/definitions/CreatePullReviewComment"
  19460. },
  19461. "x-go-name": "Comments"
  19462. },
  19463. "commit_id": {
  19464. "type": "string",
  19465. "x-go-name": "CommitID"
  19466. },
  19467. "event": {
  19468. "$ref": "#/definitions/ReviewStateType"
  19469. }
  19470. },
  19471. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19472. },
  19473. "CreatePushMirrorOption": {
  19474. "type": "object",
  19475. "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
  19476. "properties": {
  19477. "interval": {
  19478. "type": "string",
  19479. "x-go-name": "Interval"
  19480. },
  19481. "remote_address": {
  19482. "type": "string",
  19483. "x-go-name": "RemoteAddress"
  19484. },
  19485. "remote_password": {
  19486. "type": "string",
  19487. "x-go-name": "RemotePassword"
  19488. },
  19489. "remote_username": {
  19490. "type": "string",
  19491. "x-go-name": "RemoteUsername"
  19492. },
  19493. "sync_on_commit": {
  19494. "type": "boolean",
  19495. "x-go-name": "SyncOnCommit"
  19496. }
  19497. },
  19498. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19499. },
  19500. "CreateReleaseOption": {
  19501. "description": "CreateReleaseOption options when creating a release",
  19502. "type": "object",
  19503. "required": [
  19504. "tag_name"
  19505. ],
  19506. "properties": {
  19507. "body": {
  19508. "type": "string",
  19509. "x-go-name": "Note"
  19510. },
  19511. "draft": {
  19512. "type": "boolean",
  19513. "x-go-name": "IsDraft"
  19514. },
  19515. "name": {
  19516. "type": "string",
  19517. "x-go-name": "Title"
  19518. },
  19519. "prerelease": {
  19520. "type": "boolean",
  19521. "x-go-name": "IsPrerelease"
  19522. },
  19523. "tag_name": {
  19524. "type": "string",
  19525. "x-go-name": "TagName"
  19526. },
  19527. "target_commitish": {
  19528. "type": "string",
  19529. "x-go-name": "Target"
  19530. }
  19531. },
  19532. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19533. },
  19534. "CreateRepoOption": {
  19535. "description": "CreateRepoOption options when creating repository",
  19536. "type": "object",
  19537. "required": [
  19538. "name"
  19539. ],
  19540. "properties": {
  19541. "auto_init": {
  19542. "description": "Whether the repository should be auto-initialized?",
  19543. "type": "boolean",
  19544. "x-go-name": "AutoInit"
  19545. },
  19546. "default_branch": {
  19547. "description": "DefaultBranch of the repository (used when initializes and in template)",
  19548. "type": "string",
  19549. "x-go-name": "DefaultBranch"
  19550. },
  19551. "description": {
  19552. "description": "Description of the repository to create",
  19553. "type": "string",
  19554. "x-go-name": "Description"
  19555. },
  19556. "gitignores": {
  19557. "description": "Gitignores to use",
  19558. "type": "string",
  19559. "x-go-name": "Gitignores"
  19560. },
  19561. "issue_labels": {
  19562. "description": "Label-Set to use",
  19563. "type": "string",
  19564. "x-go-name": "IssueLabels"
  19565. },
  19566. "license": {
  19567. "description": "License to use",
  19568. "type": "string",
  19569. "x-go-name": "License"
  19570. },
  19571. "name": {
  19572. "description": "Name of the repository to create",
  19573. "type": "string",
  19574. "uniqueItems": true,
  19575. "x-go-name": "Name"
  19576. },
  19577. "object_format_name": {
  19578. "description": "ObjectFormatName of the underlying git repository",
  19579. "type": "string",
  19580. "enum": [
  19581. "sha1",
  19582. "sha256"
  19583. ],
  19584. "x-go-name": "ObjectFormatName"
  19585. },
  19586. "private": {
  19587. "description": "Whether the repository is private",
  19588. "type": "boolean",
  19589. "x-go-name": "Private"
  19590. },
  19591. "readme": {
  19592. "description": "Readme of the repository to create",
  19593. "type": "string",
  19594. "x-go-name": "Readme"
  19595. },
  19596. "template": {
  19597. "description": "Whether the repository is template",
  19598. "type": "boolean",
  19599. "x-go-name": "Template"
  19600. },
  19601. "trust_model": {
  19602. "description": "TrustModel of the repository",
  19603. "type": "string",
  19604. "enum": [
  19605. "default",
  19606. "collaborator",
  19607. "committer",
  19608. "collaboratorcommitter"
  19609. ],
  19610. "x-go-name": "TrustModel"
  19611. }
  19612. },
  19613. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19614. },
  19615. "CreateStatusOption": {
  19616. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  19617. "type": "object",
  19618. "properties": {
  19619. "context": {
  19620. "type": "string",
  19621. "x-go-name": "Context"
  19622. },
  19623. "description": {
  19624. "type": "string",
  19625. "x-go-name": "Description"
  19626. },
  19627. "state": {
  19628. "$ref": "#/definitions/CommitStatusState"
  19629. },
  19630. "target_url": {
  19631. "type": "string",
  19632. "x-go-name": "TargetURL"
  19633. }
  19634. },
  19635. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19636. },
  19637. "CreateTagOption": {
  19638. "description": "CreateTagOption options when creating a tag",
  19639. "type": "object",
  19640. "required": [
  19641. "tag_name"
  19642. ],
  19643. "properties": {
  19644. "message": {
  19645. "type": "string",
  19646. "x-go-name": "Message"
  19647. },
  19648. "tag_name": {
  19649. "type": "string",
  19650. "x-go-name": "TagName"
  19651. },
  19652. "target": {
  19653. "type": "string",
  19654. "x-go-name": "Target"
  19655. }
  19656. },
  19657. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19658. },
  19659. "CreateTeamOption": {
  19660. "description": "CreateTeamOption options for creating a team",
  19661. "type": "object",
  19662. "required": [
  19663. "name"
  19664. ],
  19665. "properties": {
  19666. "can_create_org_repo": {
  19667. "type": "boolean",
  19668. "x-go-name": "CanCreateOrgRepo"
  19669. },
  19670. "description": {
  19671. "type": "string",
  19672. "x-go-name": "Description"
  19673. },
  19674. "includes_all_repositories": {
  19675. "type": "boolean",
  19676. "x-go-name": "IncludesAllRepositories"
  19677. },
  19678. "name": {
  19679. "type": "string",
  19680. "x-go-name": "Name"
  19681. },
  19682. "permission": {
  19683. "type": "string",
  19684. "enum": [
  19685. "read",
  19686. "write",
  19687. "admin"
  19688. ],
  19689. "x-go-name": "Permission"
  19690. },
  19691. "units": {
  19692. "type": "array",
  19693. "items": {
  19694. "type": "string"
  19695. },
  19696. "x-go-name": "Units",
  19697. "example": [
  19698. "repo.actions",
  19699. "repo.code",
  19700. "repo.issues",
  19701. "repo.ext_issues",
  19702. "repo.wiki",
  19703. "repo.ext_wiki",
  19704. "repo.pulls",
  19705. "repo.releases",
  19706. "repo.projects",
  19707. "repo.ext_wiki"
  19708. ]
  19709. },
  19710. "units_map": {
  19711. "type": "object",
  19712. "additionalProperties": {
  19713. "type": "string"
  19714. },
  19715. "x-go-name": "UnitsMap",
  19716. "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\"}"
  19717. }
  19718. },
  19719. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19720. },
  19721. "CreateUserOption": {
  19722. "description": "CreateUserOption create user options",
  19723. "type": "object",
  19724. "required": [
  19725. "username",
  19726. "email"
  19727. ],
  19728. "properties": {
  19729. "created_at": {
  19730. "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\".",
  19731. "type": "string",
  19732. "format": "date-time",
  19733. "x-go-name": "Created"
  19734. },
  19735. "email": {
  19736. "type": "string",
  19737. "format": "email",
  19738. "x-go-name": "Email"
  19739. },
  19740. "full_name": {
  19741. "type": "string",
  19742. "x-go-name": "FullName"
  19743. },
  19744. "login_name": {
  19745. "type": "string",
  19746. "x-go-name": "LoginName"
  19747. },
  19748. "must_change_password": {
  19749. "type": "boolean",
  19750. "x-go-name": "MustChangePassword"
  19751. },
  19752. "password": {
  19753. "type": "string",
  19754. "x-go-name": "Password"
  19755. },
  19756. "restricted": {
  19757. "type": "boolean",
  19758. "x-go-name": "Restricted"
  19759. },
  19760. "send_notify": {
  19761. "type": "boolean",
  19762. "x-go-name": "SendNotify"
  19763. },
  19764. "source_id": {
  19765. "type": "integer",
  19766. "format": "int64",
  19767. "x-go-name": "SourceID"
  19768. },
  19769. "username": {
  19770. "type": "string",
  19771. "x-go-name": "Username"
  19772. },
  19773. "visibility": {
  19774. "type": "string",
  19775. "x-go-name": "Visibility"
  19776. }
  19777. },
  19778. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19779. },
  19780. "CreateVariableOption": {
  19781. "description": "CreateVariableOption the option when creating variable",
  19782. "type": "object",
  19783. "required": [
  19784. "value"
  19785. ],
  19786. "properties": {
  19787. "value": {
  19788. "description": "Value of the variable to create",
  19789. "type": "string",
  19790. "x-go-name": "Value"
  19791. }
  19792. },
  19793. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19794. },
  19795. "CreateWikiPageOptions": {
  19796. "description": "CreateWikiPageOptions form for creating wiki",
  19797. "type": "object",
  19798. "properties": {
  19799. "content_base64": {
  19800. "description": "content must be base64 encoded",
  19801. "type": "string",
  19802. "x-go-name": "ContentBase64"
  19803. },
  19804. "message": {
  19805. "description": "optional commit message summarizing the change",
  19806. "type": "string",
  19807. "x-go-name": "Message"
  19808. },
  19809. "title": {
  19810. "description": "page title. leave empty to keep unchanged",
  19811. "type": "string",
  19812. "x-go-name": "Title"
  19813. }
  19814. },
  19815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19816. },
  19817. "Cron": {
  19818. "description": "Cron represents a Cron task",
  19819. "type": "object",
  19820. "properties": {
  19821. "exec_times": {
  19822. "type": "integer",
  19823. "format": "int64",
  19824. "x-go-name": "ExecTimes"
  19825. },
  19826. "name": {
  19827. "type": "string",
  19828. "x-go-name": "Name"
  19829. },
  19830. "next": {
  19831. "type": "string",
  19832. "format": "date-time",
  19833. "x-go-name": "Next"
  19834. },
  19835. "prev": {
  19836. "type": "string",
  19837. "format": "date-time",
  19838. "x-go-name": "Prev"
  19839. },
  19840. "schedule": {
  19841. "type": "string",
  19842. "x-go-name": "Schedule"
  19843. }
  19844. },
  19845. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19846. },
  19847. "DeleteEmailOption": {
  19848. "description": "DeleteEmailOption options when deleting email addresses",
  19849. "type": "object",
  19850. "properties": {
  19851. "emails": {
  19852. "description": "email addresses to delete",
  19853. "type": "array",
  19854. "items": {
  19855. "type": "string"
  19856. },
  19857. "x-go-name": "Emails"
  19858. }
  19859. },
  19860. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19861. },
  19862. "DeleteFileOptions": {
  19863. "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)",
  19864. "type": "object",
  19865. "required": [
  19866. "sha"
  19867. ],
  19868. "properties": {
  19869. "author": {
  19870. "$ref": "#/definitions/Identity"
  19871. },
  19872. "branch": {
  19873. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  19874. "type": "string",
  19875. "x-go-name": "BranchName"
  19876. },
  19877. "committer": {
  19878. "$ref": "#/definitions/Identity"
  19879. },
  19880. "dates": {
  19881. "$ref": "#/definitions/CommitDateOptions"
  19882. },
  19883. "message": {
  19884. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  19885. "type": "string",
  19886. "x-go-name": "Message"
  19887. },
  19888. "new_branch": {
  19889. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  19890. "type": "string",
  19891. "x-go-name": "NewBranchName"
  19892. },
  19893. "sha": {
  19894. "description": "sha is the SHA for the file that already exists",
  19895. "type": "string",
  19896. "x-go-name": "SHA"
  19897. },
  19898. "signoff": {
  19899. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  19900. "type": "boolean",
  19901. "x-go-name": "Signoff"
  19902. }
  19903. },
  19904. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19905. },
  19906. "DeployKey": {
  19907. "description": "DeployKey a deploy key",
  19908. "type": "object",
  19909. "properties": {
  19910. "created_at": {
  19911. "type": "string",
  19912. "format": "date-time",
  19913. "x-go-name": "Created"
  19914. },
  19915. "fingerprint": {
  19916. "type": "string",
  19917. "x-go-name": "Fingerprint"
  19918. },
  19919. "id": {
  19920. "type": "integer",
  19921. "format": "int64",
  19922. "x-go-name": "ID"
  19923. },
  19924. "key": {
  19925. "type": "string",
  19926. "x-go-name": "Key"
  19927. },
  19928. "key_id": {
  19929. "type": "integer",
  19930. "format": "int64",
  19931. "x-go-name": "KeyID"
  19932. },
  19933. "read_only": {
  19934. "type": "boolean",
  19935. "x-go-name": "ReadOnly"
  19936. },
  19937. "repository": {
  19938. "$ref": "#/definitions/Repository"
  19939. },
  19940. "title": {
  19941. "type": "string",
  19942. "x-go-name": "Title"
  19943. },
  19944. "url": {
  19945. "type": "string",
  19946. "x-go-name": "URL"
  19947. }
  19948. },
  19949. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19950. },
  19951. "DismissPullReviewOptions": {
  19952. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  19953. "type": "object",
  19954. "properties": {
  19955. "message": {
  19956. "type": "string",
  19957. "x-go-name": "Message"
  19958. },
  19959. "priors": {
  19960. "type": "boolean",
  19961. "x-go-name": "Priors"
  19962. }
  19963. },
  19964. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19965. },
  19966. "EditAttachmentOptions": {
  19967. "description": "EditAttachmentOptions options for editing attachments",
  19968. "type": "object",
  19969. "properties": {
  19970. "name": {
  19971. "type": "string",
  19972. "x-go-name": "Name"
  19973. }
  19974. },
  19975. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19976. },
  19977. "EditBranchProtectionOption": {
  19978. "description": "EditBranchProtectionOption options for editing a branch protection",
  19979. "type": "object",
  19980. "properties": {
  19981. "approvals_whitelist_teams": {
  19982. "type": "array",
  19983. "items": {
  19984. "type": "string"
  19985. },
  19986. "x-go-name": "ApprovalsWhitelistTeams"
  19987. },
  19988. "approvals_whitelist_username": {
  19989. "type": "array",
  19990. "items": {
  19991. "type": "string"
  19992. },
  19993. "x-go-name": "ApprovalsWhitelistUsernames"
  19994. },
  19995. "block_on_official_review_requests": {
  19996. "type": "boolean",
  19997. "x-go-name": "BlockOnOfficialReviewRequests"
  19998. },
  19999. "block_on_outdated_branch": {
  20000. "type": "boolean",
  20001. "x-go-name": "BlockOnOutdatedBranch"
  20002. },
  20003. "block_on_rejected_reviews": {
  20004. "type": "boolean",
  20005. "x-go-name": "BlockOnRejectedReviews"
  20006. },
  20007. "dismiss_stale_approvals": {
  20008. "type": "boolean",
  20009. "x-go-name": "DismissStaleApprovals"
  20010. },
  20011. "enable_approvals_whitelist": {
  20012. "type": "boolean",
  20013. "x-go-name": "EnableApprovalsWhitelist"
  20014. },
  20015. "enable_merge_whitelist": {
  20016. "type": "boolean",
  20017. "x-go-name": "EnableMergeWhitelist"
  20018. },
  20019. "enable_push": {
  20020. "type": "boolean",
  20021. "x-go-name": "EnablePush"
  20022. },
  20023. "enable_push_whitelist": {
  20024. "type": "boolean",
  20025. "x-go-name": "EnablePushWhitelist"
  20026. },
  20027. "enable_status_check": {
  20028. "type": "boolean",
  20029. "x-go-name": "EnableStatusCheck"
  20030. },
  20031. "ignore_stale_approvals": {
  20032. "type": "boolean",
  20033. "x-go-name": "IgnoreStaleApprovals"
  20034. },
  20035. "merge_whitelist_teams": {
  20036. "type": "array",
  20037. "items": {
  20038. "type": "string"
  20039. },
  20040. "x-go-name": "MergeWhitelistTeams"
  20041. },
  20042. "merge_whitelist_usernames": {
  20043. "type": "array",
  20044. "items": {
  20045. "type": "string"
  20046. },
  20047. "x-go-name": "MergeWhitelistUsernames"
  20048. },
  20049. "protected_file_patterns": {
  20050. "type": "string",
  20051. "x-go-name": "ProtectedFilePatterns"
  20052. },
  20053. "push_whitelist_deploy_keys": {
  20054. "type": "boolean",
  20055. "x-go-name": "PushWhitelistDeployKeys"
  20056. },
  20057. "push_whitelist_teams": {
  20058. "type": "array",
  20059. "items": {
  20060. "type": "string"
  20061. },
  20062. "x-go-name": "PushWhitelistTeams"
  20063. },
  20064. "push_whitelist_usernames": {
  20065. "type": "array",
  20066. "items": {
  20067. "type": "string"
  20068. },
  20069. "x-go-name": "PushWhitelistUsernames"
  20070. },
  20071. "require_signed_commits": {
  20072. "type": "boolean",
  20073. "x-go-name": "RequireSignedCommits"
  20074. },
  20075. "required_approvals": {
  20076. "type": "integer",
  20077. "format": "int64",
  20078. "x-go-name": "RequiredApprovals"
  20079. },
  20080. "status_check_contexts": {
  20081. "type": "array",
  20082. "items": {
  20083. "type": "string"
  20084. },
  20085. "x-go-name": "StatusCheckContexts"
  20086. },
  20087. "unprotected_file_patterns": {
  20088. "type": "string",
  20089. "x-go-name": "UnprotectedFilePatterns"
  20090. }
  20091. },
  20092. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20093. },
  20094. "EditDeadlineOption": {
  20095. "description": "EditDeadlineOption options for creating a deadline",
  20096. "type": "object",
  20097. "required": [
  20098. "due_date"
  20099. ],
  20100. "properties": {
  20101. "due_date": {
  20102. "type": "string",
  20103. "format": "date-time",
  20104. "x-go-name": "Deadline"
  20105. }
  20106. },
  20107. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20108. },
  20109. "EditGitHookOption": {
  20110. "description": "EditGitHookOption options when modifying one Git hook",
  20111. "type": "object",
  20112. "properties": {
  20113. "content": {
  20114. "type": "string",
  20115. "x-go-name": "Content"
  20116. }
  20117. },
  20118. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20119. },
  20120. "EditHookOption": {
  20121. "description": "EditHookOption options when modify one hook",
  20122. "type": "object",
  20123. "properties": {
  20124. "active": {
  20125. "type": "boolean",
  20126. "x-go-name": "Active"
  20127. },
  20128. "authorization_header": {
  20129. "type": "string",
  20130. "x-go-name": "AuthorizationHeader"
  20131. },
  20132. "branch_filter": {
  20133. "type": "string",
  20134. "x-go-name": "BranchFilter"
  20135. },
  20136. "config": {
  20137. "type": "object",
  20138. "additionalProperties": {
  20139. "type": "string"
  20140. },
  20141. "x-go-name": "Config"
  20142. },
  20143. "events": {
  20144. "type": "array",
  20145. "items": {
  20146. "type": "string"
  20147. },
  20148. "x-go-name": "Events"
  20149. }
  20150. },
  20151. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20152. },
  20153. "EditIssueCommentOption": {
  20154. "description": "EditIssueCommentOption options for editing a comment",
  20155. "type": "object",
  20156. "required": [
  20157. "body"
  20158. ],
  20159. "properties": {
  20160. "body": {
  20161. "type": "string",
  20162. "x-go-name": "Body"
  20163. }
  20164. },
  20165. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20166. },
  20167. "EditIssueOption": {
  20168. "description": "EditIssueOption options for editing an issue",
  20169. "type": "object",
  20170. "properties": {
  20171. "assignee": {
  20172. "description": "deprecated",
  20173. "type": "string",
  20174. "x-go-name": "Assignee"
  20175. },
  20176. "assignees": {
  20177. "type": "array",
  20178. "items": {
  20179. "type": "string"
  20180. },
  20181. "x-go-name": "Assignees"
  20182. },
  20183. "body": {
  20184. "type": "string",
  20185. "x-go-name": "Body"
  20186. },
  20187. "due_date": {
  20188. "type": "string",
  20189. "format": "date-time",
  20190. "x-go-name": "Deadline"
  20191. },
  20192. "milestone": {
  20193. "type": "integer",
  20194. "format": "int64",
  20195. "x-go-name": "Milestone"
  20196. },
  20197. "ref": {
  20198. "type": "string",
  20199. "x-go-name": "Ref"
  20200. },
  20201. "state": {
  20202. "type": "string",
  20203. "x-go-name": "State"
  20204. },
  20205. "title": {
  20206. "type": "string",
  20207. "x-go-name": "Title"
  20208. },
  20209. "unset_due_date": {
  20210. "type": "boolean",
  20211. "x-go-name": "RemoveDeadline"
  20212. }
  20213. },
  20214. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20215. },
  20216. "EditLabelOption": {
  20217. "description": "EditLabelOption options for editing a label",
  20218. "type": "object",
  20219. "properties": {
  20220. "color": {
  20221. "type": "string",
  20222. "x-go-name": "Color",
  20223. "example": "#00aabb"
  20224. },
  20225. "description": {
  20226. "type": "string",
  20227. "x-go-name": "Description"
  20228. },
  20229. "exclusive": {
  20230. "type": "boolean",
  20231. "x-go-name": "Exclusive",
  20232. "example": false
  20233. },
  20234. "is_archived": {
  20235. "type": "boolean",
  20236. "x-go-name": "IsArchived",
  20237. "example": false
  20238. },
  20239. "name": {
  20240. "type": "string",
  20241. "x-go-name": "Name"
  20242. }
  20243. },
  20244. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20245. },
  20246. "EditMilestoneOption": {
  20247. "description": "EditMilestoneOption options for editing a milestone",
  20248. "type": "object",
  20249. "properties": {
  20250. "description": {
  20251. "type": "string",
  20252. "x-go-name": "Description"
  20253. },
  20254. "due_on": {
  20255. "type": "string",
  20256. "format": "date-time",
  20257. "x-go-name": "Deadline"
  20258. },
  20259. "state": {
  20260. "type": "string",
  20261. "x-go-name": "State"
  20262. },
  20263. "title": {
  20264. "type": "string",
  20265. "x-go-name": "Title"
  20266. }
  20267. },
  20268. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20269. },
  20270. "EditOrgOption": {
  20271. "description": "EditOrgOption options for editing an organization",
  20272. "type": "object",
  20273. "properties": {
  20274. "description": {
  20275. "type": "string",
  20276. "x-go-name": "Description"
  20277. },
  20278. "email": {
  20279. "type": "string",
  20280. "x-go-name": "Email"
  20281. },
  20282. "full_name": {
  20283. "type": "string",
  20284. "x-go-name": "FullName"
  20285. },
  20286. "location": {
  20287. "type": "string",
  20288. "x-go-name": "Location"
  20289. },
  20290. "repo_admin_change_team_access": {
  20291. "type": "boolean",
  20292. "x-go-name": "RepoAdminChangeTeamAccess"
  20293. },
  20294. "visibility": {
  20295. "description": "possible values are `public`, `limited` or `private`",
  20296. "type": "string",
  20297. "enum": [
  20298. "public",
  20299. "limited",
  20300. "private"
  20301. ],
  20302. "x-go-name": "Visibility"
  20303. },
  20304. "website": {
  20305. "type": "string",
  20306. "x-go-name": "Website"
  20307. }
  20308. },
  20309. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20310. },
  20311. "EditPullRequestOption": {
  20312. "description": "EditPullRequestOption options when modify pull request",
  20313. "type": "object",
  20314. "properties": {
  20315. "allow_maintainer_edit": {
  20316. "type": "boolean",
  20317. "x-go-name": "AllowMaintainerEdit"
  20318. },
  20319. "assignee": {
  20320. "type": "string",
  20321. "x-go-name": "Assignee"
  20322. },
  20323. "assignees": {
  20324. "type": "array",
  20325. "items": {
  20326. "type": "string"
  20327. },
  20328. "x-go-name": "Assignees"
  20329. },
  20330. "base": {
  20331. "type": "string",
  20332. "x-go-name": "Base"
  20333. },
  20334. "body": {
  20335. "type": "string",
  20336. "x-go-name": "Body"
  20337. },
  20338. "due_date": {
  20339. "type": "string",
  20340. "format": "date-time",
  20341. "x-go-name": "Deadline"
  20342. },
  20343. "labels": {
  20344. "type": "array",
  20345. "items": {
  20346. "type": "integer",
  20347. "format": "int64"
  20348. },
  20349. "x-go-name": "Labels"
  20350. },
  20351. "milestone": {
  20352. "type": "integer",
  20353. "format": "int64",
  20354. "x-go-name": "Milestone"
  20355. },
  20356. "state": {
  20357. "type": "string",
  20358. "x-go-name": "State"
  20359. },
  20360. "title": {
  20361. "type": "string",
  20362. "x-go-name": "Title"
  20363. },
  20364. "unset_due_date": {
  20365. "type": "boolean",
  20366. "x-go-name": "RemoveDeadline"
  20367. }
  20368. },
  20369. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20370. },
  20371. "EditReactionOption": {
  20372. "description": "EditReactionOption contain the reaction type",
  20373. "type": "object",
  20374. "properties": {
  20375. "content": {
  20376. "type": "string",
  20377. "x-go-name": "Reaction"
  20378. }
  20379. },
  20380. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20381. },
  20382. "EditReleaseOption": {
  20383. "description": "EditReleaseOption options when editing a release",
  20384. "type": "object",
  20385. "properties": {
  20386. "body": {
  20387. "type": "string",
  20388. "x-go-name": "Note"
  20389. },
  20390. "draft": {
  20391. "type": "boolean",
  20392. "x-go-name": "IsDraft"
  20393. },
  20394. "name": {
  20395. "type": "string",
  20396. "x-go-name": "Title"
  20397. },
  20398. "prerelease": {
  20399. "type": "boolean",
  20400. "x-go-name": "IsPrerelease"
  20401. },
  20402. "tag_name": {
  20403. "type": "string",
  20404. "x-go-name": "TagName"
  20405. },
  20406. "target_commitish": {
  20407. "type": "string",
  20408. "x-go-name": "Target"
  20409. }
  20410. },
  20411. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20412. },
  20413. "EditRepoOption": {
  20414. "description": "EditRepoOption options when editing a repository's properties",
  20415. "type": "object",
  20416. "properties": {
  20417. "allow_fast_forward_only_merge": {
  20418. "description": "either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging.",
  20419. "type": "boolean",
  20420. "x-go-name": "AllowFastForwardOnly"
  20421. },
  20422. "allow_manual_merge": {
  20423. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
  20424. "type": "boolean",
  20425. "x-go-name": "AllowManualMerge"
  20426. },
  20427. "allow_merge_commits": {
  20428. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  20429. "type": "boolean",
  20430. "x-go-name": "AllowMerge"
  20431. },
  20432. "allow_rebase": {
  20433. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  20434. "type": "boolean",
  20435. "x-go-name": "AllowRebase"
  20436. },
  20437. "allow_rebase_explicit": {
  20438. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
  20439. "type": "boolean",
  20440. "x-go-name": "AllowRebaseMerge"
  20441. },
  20442. "allow_rebase_update": {
  20443. "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
  20444. "type": "boolean",
  20445. "x-go-name": "AllowRebaseUpdate"
  20446. },
  20447. "allow_squash_merge": {
  20448. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  20449. "type": "boolean",
  20450. "x-go-name": "AllowSquash"
  20451. },
  20452. "archived": {
  20453. "description": "set to `true` to archive this repository.",
  20454. "type": "boolean",
  20455. "x-go-name": "Archived"
  20456. },
  20457. "autodetect_manual_merge": {
  20458. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
  20459. "type": "boolean",
  20460. "x-go-name": "AutodetectManualMerge"
  20461. },
  20462. "default_allow_maintainer_edit": {
  20463. "description": "set to `true` to allow edits from maintainers by default",
  20464. "type": "boolean",
  20465. "x-go-name": "DefaultAllowMaintainerEdit"
  20466. },
  20467. "default_branch": {
  20468. "description": "sets the default branch for this repository.",
  20469. "type": "string",
  20470. "x-go-name": "DefaultBranch"
  20471. },
  20472. "default_delete_branch_after_merge": {
  20473. "description": "set to `true` to delete pr branch after merge by default",
  20474. "type": "boolean",
  20475. "x-go-name": "DefaultDeleteBranchAfterMerge"
  20476. },
  20477. "default_merge_style": {
  20478. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", \"squash\", or \"fast-forward-only\".",
  20479. "type": "string",
  20480. "x-go-name": "DefaultMergeStyle"
  20481. },
  20482. "description": {
  20483. "description": "a short description of the repository.",
  20484. "type": "string",
  20485. "x-go-name": "Description"
  20486. },
  20487. "enable_prune": {
  20488. "description": "enable prune - remove obsolete remote-tracking references",
  20489. "type": "boolean",
  20490. "x-go-name": "EnablePrune"
  20491. },
  20492. "external_tracker": {
  20493. "$ref": "#/definitions/ExternalTracker"
  20494. },
  20495. "external_wiki": {
  20496. "$ref": "#/definitions/ExternalWiki"
  20497. },
  20498. "has_actions": {
  20499. "description": "either `true` to enable actions unit, or `false` to disable them.",
  20500. "type": "boolean",
  20501. "x-go-name": "HasActions"
  20502. },
  20503. "has_issues": {
  20504. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  20505. "type": "boolean",
  20506. "x-go-name": "HasIssues"
  20507. },
  20508. "has_packages": {
  20509. "description": "either `true` to enable packages unit, or `false` to disable them.",
  20510. "type": "boolean",
  20511. "x-go-name": "HasPackages"
  20512. },
  20513. "has_projects": {
  20514. "description": "either `true` to enable project unit, or `false` to disable them.",
  20515. "type": "boolean",
  20516. "x-go-name": "HasProjects"
  20517. },
  20518. "has_pull_requests": {
  20519. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  20520. "type": "boolean",
  20521. "x-go-name": "HasPullRequests"
  20522. },
  20523. "has_releases": {
  20524. "description": "either `true` to enable releases unit, or `false` to disable them.",
  20525. "type": "boolean",
  20526. "x-go-name": "HasReleases"
  20527. },
  20528. "has_wiki": {
  20529. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  20530. "type": "boolean",
  20531. "x-go-name": "HasWiki"
  20532. },
  20533. "ignore_whitespace_conflicts": {
  20534. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
  20535. "type": "boolean",
  20536. "x-go-name": "IgnoreWhitespaceConflicts"
  20537. },
  20538. "internal_tracker": {
  20539. "$ref": "#/definitions/InternalTracker"
  20540. },
  20541. "mirror_interval": {
  20542. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  20543. "type": "string",
  20544. "x-go-name": "MirrorInterval"
  20545. },
  20546. "name": {
  20547. "description": "name of the repository",
  20548. "type": "string",
  20549. "uniqueItems": true,
  20550. "x-go-name": "Name"
  20551. },
  20552. "private": {
  20553. "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.",
  20554. "type": "boolean",
  20555. "x-go-name": "Private"
  20556. },
  20557. "projects_mode": {
  20558. "description": "`repo` to only allow repo-level projects, `owner` to only allow owner projects, `all` to allow both.",
  20559. "type": "string",
  20560. "x-go-name": "ProjectsMode"
  20561. },
  20562. "template": {
  20563. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  20564. "type": "boolean",
  20565. "x-go-name": "Template"
  20566. },
  20567. "website": {
  20568. "description": "a URL with more information about the repository.",
  20569. "type": "string",
  20570. "x-go-name": "Website"
  20571. }
  20572. },
  20573. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20574. },
  20575. "EditTeamOption": {
  20576. "description": "EditTeamOption options for editing a team",
  20577. "type": "object",
  20578. "required": [
  20579. "name"
  20580. ],
  20581. "properties": {
  20582. "can_create_org_repo": {
  20583. "type": "boolean",
  20584. "x-go-name": "CanCreateOrgRepo"
  20585. },
  20586. "description": {
  20587. "type": "string",
  20588. "x-go-name": "Description"
  20589. },
  20590. "includes_all_repositories": {
  20591. "type": "boolean",
  20592. "x-go-name": "IncludesAllRepositories"
  20593. },
  20594. "name": {
  20595. "type": "string",
  20596. "x-go-name": "Name"
  20597. },
  20598. "permission": {
  20599. "type": "string",
  20600. "enum": [
  20601. "read",
  20602. "write",
  20603. "admin"
  20604. ],
  20605. "x-go-name": "Permission"
  20606. },
  20607. "units": {
  20608. "type": "array",
  20609. "items": {
  20610. "type": "string"
  20611. },
  20612. "x-go-name": "Units",
  20613. "example": [
  20614. "repo.code",
  20615. "repo.issues",
  20616. "repo.ext_issues",
  20617. "repo.wiki",
  20618. "repo.pulls",
  20619. "repo.releases",
  20620. "repo.projects",
  20621. "repo.ext_wiki"
  20622. ]
  20623. },
  20624. "units_map": {
  20625. "type": "object",
  20626. "additionalProperties": {
  20627. "type": "string"
  20628. },
  20629. "x-go-name": "UnitsMap",
  20630. "example": {
  20631. "repo.code": "read",
  20632. "repo.ext_issues": "none",
  20633. "repo.ext_wiki": "none",
  20634. "repo.issues": "write",
  20635. "repo.projects": "none",
  20636. "repo.pulls": "owner",
  20637. "repo.releases": "none",
  20638. "repo.wiki": "admin"
  20639. }
  20640. }
  20641. },
  20642. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20643. },
  20644. "EditUserOption": {
  20645. "description": "EditUserOption edit user options",
  20646. "type": "object",
  20647. "required": [
  20648. "source_id",
  20649. "login_name"
  20650. ],
  20651. "properties": {
  20652. "active": {
  20653. "type": "boolean",
  20654. "x-go-name": "Active"
  20655. },
  20656. "admin": {
  20657. "type": "boolean",
  20658. "x-go-name": "Admin"
  20659. },
  20660. "allow_create_organization": {
  20661. "type": "boolean",
  20662. "x-go-name": "AllowCreateOrganization"
  20663. },
  20664. "allow_git_hook": {
  20665. "type": "boolean",
  20666. "x-go-name": "AllowGitHook"
  20667. },
  20668. "allow_import_local": {
  20669. "type": "boolean",
  20670. "x-go-name": "AllowImportLocal"
  20671. },
  20672. "description": {
  20673. "type": "string",
  20674. "x-go-name": "Description"
  20675. },
  20676. "email": {
  20677. "type": "string",
  20678. "format": "email",
  20679. "x-go-name": "Email"
  20680. },
  20681. "full_name": {
  20682. "type": "string",
  20683. "x-go-name": "FullName"
  20684. },
  20685. "location": {
  20686. "type": "string",
  20687. "x-go-name": "Location"
  20688. },
  20689. "login_name": {
  20690. "type": "string",
  20691. "x-go-name": "LoginName"
  20692. },
  20693. "max_repo_creation": {
  20694. "type": "integer",
  20695. "format": "int64",
  20696. "x-go-name": "MaxRepoCreation"
  20697. },
  20698. "must_change_password": {
  20699. "type": "boolean",
  20700. "x-go-name": "MustChangePassword"
  20701. },
  20702. "password": {
  20703. "type": "string",
  20704. "x-go-name": "Password"
  20705. },
  20706. "prohibit_login": {
  20707. "type": "boolean",
  20708. "x-go-name": "ProhibitLogin"
  20709. },
  20710. "restricted": {
  20711. "type": "boolean",
  20712. "x-go-name": "Restricted"
  20713. },
  20714. "source_id": {
  20715. "type": "integer",
  20716. "format": "int64",
  20717. "x-go-name": "SourceID"
  20718. },
  20719. "visibility": {
  20720. "type": "string",
  20721. "x-go-name": "Visibility"
  20722. },
  20723. "website": {
  20724. "type": "string",
  20725. "x-go-name": "Website"
  20726. }
  20727. },
  20728. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20729. },
  20730. "Email": {
  20731. "description": "Email an email address belonging to a user",
  20732. "type": "object",
  20733. "properties": {
  20734. "email": {
  20735. "type": "string",
  20736. "format": "email",
  20737. "x-go-name": "Email"
  20738. },
  20739. "primary": {
  20740. "type": "boolean",
  20741. "x-go-name": "Primary"
  20742. },
  20743. "user_id": {
  20744. "type": "integer",
  20745. "format": "int64",
  20746. "x-go-name": "UserID"
  20747. },
  20748. "username": {
  20749. "type": "string",
  20750. "x-go-name": "UserName"
  20751. },
  20752. "verified": {
  20753. "type": "boolean",
  20754. "x-go-name": "Verified"
  20755. }
  20756. },
  20757. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20758. },
  20759. "ExternalTracker": {
  20760. "description": "ExternalTracker represents settings for external tracker",
  20761. "type": "object",
  20762. "properties": {
  20763. "external_tracker_format": {
  20764. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  20765. "type": "string",
  20766. "x-go-name": "ExternalTrackerFormat"
  20767. },
  20768. "external_tracker_regexp_pattern": {
  20769. "description": "External Issue Tracker issue regular expression",
  20770. "type": "string",
  20771. "x-go-name": "ExternalTrackerRegexpPattern"
  20772. },
  20773. "external_tracker_style": {
  20774. "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
  20775. "type": "string",
  20776. "x-go-name": "ExternalTrackerStyle"
  20777. },
  20778. "external_tracker_url": {
  20779. "description": "URL of external issue tracker.",
  20780. "type": "string",
  20781. "x-go-name": "ExternalTrackerURL"
  20782. }
  20783. },
  20784. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20785. },
  20786. "ExternalWiki": {
  20787. "description": "ExternalWiki represents setting for external wiki",
  20788. "type": "object",
  20789. "properties": {
  20790. "external_wiki_url": {
  20791. "description": "URL of external wiki.",
  20792. "type": "string",
  20793. "x-go-name": "ExternalWikiURL"
  20794. }
  20795. },
  20796. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20797. },
  20798. "FileCommitResponse": {
  20799. "type": "object",
  20800. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  20801. "properties": {
  20802. "author": {
  20803. "$ref": "#/definitions/CommitUser"
  20804. },
  20805. "committer": {
  20806. "$ref": "#/definitions/CommitUser"
  20807. },
  20808. "created": {
  20809. "type": "string",
  20810. "format": "date-time",
  20811. "x-go-name": "Created"
  20812. },
  20813. "html_url": {
  20814. "type": "string",
  20815. "x-go-name": "HTMLURL"
  20816. },
  20817. "message": {
  20818. "type": "string",
  20819. "x-go-name": "Message"
  20820. },
  20821. "parents": {
  20822. "type": "array",
  20823. "items": {
  20824. "$ref": "#/definitions/CommitMeta"
  20825. },
  20826. "x-go-name": "Parents"
  20827. },
  20828. "sha": {
  20829. "type": "string",
  20830. "x-go-name": "SHA"
  20831. },
  20832. "tree": {
  20833. "$ref": "#/definitions/CommitMeta"
  20834. },
  20835. "url": {
  20836. "type": "string",
  20837. "x-go-name": "URL"
  20838. }
  20839. },
  20840. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20841. },
  20842. "FileDeleteResponse": {
  20843. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  20844. "type": "object",
  20845. "properties": {
  20846. "commit": {
  20847. "$ref": "#/definitions/FileCommitResponse"
  20848. },
  20849. "content": {
  20850. "x-go-name": "Content"
  20851. },
  20852. "verification": {
  20853. "$ref": "#/definitions/PayloadCommitVerification"
  20854. }
  20855. },
  20856. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20857. },
  20858. "FileLinksResponse": {
  20859. "description": "FileLinksResponse contains the links for a repo's file",
  20860. "type": "object",
  20861. "properties": {
  20862. "git": {
  20863. "type": "string",
  20864. "x-go-name": "GitURL"
  20865. },
  20866. "html": {
  20867. "type": "string",
  20868. "x-go-name": "HTMLURL"
  20869. },
  20870. "self": {
  20871. "type": "string",
  20872. "x-go-name": "Self"
  20873. }
  20874. },
  20875. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20876. },
  20877. "FileResponse": {
  20878. "description": "FileResponse contains information about a repo's file",
  20879. "type": "object",
  20880. "properties": {
  20881. "commit": {
  20882. "$ref": "#/definitions/FileCommitResponse"
  20883. },
  20884. "content": {
  20885. "$ref": "#/definitions/ContentsResponse"
  20886. },
  20887. "verification": {
  20888. "$ref": "#/definitions/PayloadCommitVerification"
  20889. }
  20890. },
  20891. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20892. },
  20893. "FilesResponse": {
  20894. "description": "FilesResponse contains information about multiple files from a repo",
  20895. "type": "object",
  20896. "properties": {
  20897. "commit": {
  20898. "$ref": "#/definitions/FileCommitResponse"
  20899. },
  20900. "files": {
  20901. "type": "array",
  20902. "items": {
  20903. "$ref": "#/definitions/ContentsResponse"
  20904. },
  20905. "x-go-name": "Files"
  20906. },
  20907. "verification": {
  20908. "$ref": "#/definitions/PayloadCommitVerification"
  20909. }
  20910. },
  20911. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20912. },
  20913. "GPGKey": {
  20914. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  20915. "type": "object",
  20916. "properties": {
  20917. "can_certify": {
  20918. "type": "boolean",
  20919. "x-go-name": "CanCertify"
  20920. },
  20921. "can_encrypt_comms": {
  20922. "type": "boolean",
  20923. "x-go-name": "CanEncryptComms"
  20924. },
  20925. "can_encrypt_storage": {
  20926. "type": "boolean",
  20927. "x-go-name": "CanEncryptStorage"
  20928. },
  20929. "can_sign": {
  20930. "type": "boolean",
  20931. "x-go-name": "CanSign"
  20932. },
  20933. "created_at": {
  20934. "type": "string",
  20935. "format": "date-time",
  20936. "x-go-name": "Created"
  20937. },
  20938. "emails": {
  20939. "type": "array",
  20940. "items": {
  20941. "$ref": "#/definitions/GPGKeyEmail"
  20942. },
  20943. "x-go-name": "Emails"
  20944. },
  20945. "expires_at": {
  20946. "type": "string",
  20947. "format": "date-time",
  20948. "x-go-name": "Expires"
  20949. },
  20950. "id": {
  20951. "type": "integer",
  20952. "format": "int64",
  20953. "x-go-name": "ID"
  20954. },
  20955. "key_id": {
  20956. "type": "string",
  20957. "x-go-name": "KeyID"
  20958. },
  20959. "primary_key_id": {
  20960. "type": "string",
  20961. "x-go-name": "PrimaryKeyID"
  20962. },
  20963. "public_key": {
  20964. "type": "string",
  20965. "x-go-name": "PublicKey"
  20966. },
  20967. "subkeys": {
  20968. "type": "array",
  20969. "items": {
  20970. "$ref": "#/definitions/GPGKey"
  20971. },
  20972. "x-go-name": "SubsKey"
  20973. },
  20974. "verified": {
  20975. "type": "boolean",
  20976. "x-go-name": "Verified"
  20977. }
  20978. },
  20979. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20980. },
  20981. "GPGKeyEmail": {
  20982. "description": "GPGKeyEmail an email attached to a GPGKey",
  20983. "type": "object",
  20984. "properties": {
  20985. "email": {
  20986. "type": "string",
  20987. "x-go-name": "Email"
  20988. },
  20989. "verified": {
  20990. "type": "boolean",
  20991. "x-go-name": "Verified"
  20992. }
  20993. },
  20994. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20995. },
  20996. "GeneralAPISettings": {
  20997. "description": "GeneralAPISettings contains global api settings exposed by it",
  20998. "type": "object",
  20999. "properties": {
  21000. "default_git_trees_per_page": {
  21001. "type": "integer",
  21002. "format": "int64",
  21003. "x-go-name": "DefaultGitTreesPerPage"
  21004. },
  21005. "default_max_blob_size": {
  21006. "type": "integer",
  21007. "format": "int64",
  21008. "x-go-name": "DefaultMaxBlobSize"
  21009. },
  21010. "default_paging_num": {
  21011. "type": "integer",
  21012. "format": "int64",
  21013. "x-go-name": "DefaultPagingNum"
  21014. },
  21015. "max_response_items": {
  21016. "type": "integer",
  21017. "format": "int64",
  21018. "x-go-name": "MaxResponseItems"
  21019. }
  21020. },
  21021. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21022. },
  21023. "GeneralAttachmentSettings": {
  21024. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  21025. "type": "object",
  21026. "properties": {
  21027. "allowed_types": {
  21028. "type": "string",
  21029. "x-go-name": "AllowedTypes"
  21030. },
  21031. "enabled": {
  21032. "type": "boolean",
  21033. "x-go-name": "Enabled"
  21034. },
  21035. "max_files": {
  21036. "type": "integer",
  21037. "format": "int64",
  21038. "x-go-name": "MaxFiles"
  21039. },
  21040. "max_size": {
  21041. "type": "integer",
  21042. "format": "int64",
  21043. "x-go-name": "MaxSize"
  21044. }
  21045. },
  21046. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21047. },
  21048. "GeneralRepoSettings": {
  21049. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  21050. "type": "object",
  21051. "properties": {
  21052. "http_git_disabled": {
  21053. "type": "boolean",
  21054. "x-go-name": "HTTPGitDisabled"
  21055. },
  21056. "lfs_disabled": {
  21057. "type": "boolean",
  21058. "x-go-name": "LFSDisabled"
  21059. },
  21060. "migrations_disabled": {
  21061. "type": "boolean",
  21062. "x-go-name": "MigrationsDisabled"
  21063. },
  21064. "mirrors_disabled": {
  21065. "type": "boolean",
  21066. "x-go-name": "MirrorsDisabled"
  21067. },
  21068. "stars_disabled": {
  21069. "type": "boolean",
  21070. "x-go-name": "StarsDisabled"
  21071. },
  21072. "time_tracking_disabled": {
  21073. "type": "boolean",
  21074. "x-go-name": "TimeTrackingDisabled"
  21075. }
  21076. },
  21077. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21078. },
  21079. "GeneralUISettings": {
  21080. "description": "GeneralUISettings contains global ui settings exposed by API",
  21081. "type": "object",
  21082. "properties": {
  21083. "allowed_reactions": {
  21084. "type": "array",
  21085. "items": {
  21086. "type": "string"
  21087. },
  21088. "x-go-name": "AllowedReactions"
  21089. },
  21090. "custom_emojis": {
  21091. "type": "array",
  21092. "items": {
  21093. "type": "string"
  21094. },
  21095. "x-go-name": "CustomEmojis"
  21096. },
  21097. "default_theme": {
  21098. "type": "string",
  21099. "x-go-name": "DefaultTheme"
  21100. }
  21101. },
  21102. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21103. },
  21104. "GenerateRepoOption": {
  21105. "description": "GenerateRepoOption options when creating repository using a template",
  21106. "type": "object",
  21107. "required": [
  21108. "owner",
  21109. "name"
  21110. ],
  21111. "properties": {
  21112. "avatar": {
  21113. "description": "include avatar of the template repo",
  21114. "type": "boolean",
  21115. "x-go-name": "Avatar"
  21116. },
  21117. "default_branch": {
  21118. "description": "Default branch of the new repository",
  21119. "type": "string",
  21120. "x-go-name": "DefaultBranch"
  21121. },
  21122. "description": {
  21123. "description": "Description of the repository to create",
  21124. "type": "string",
  21125. "x-go-name": "Description"
  21126. },
  21127. "git_content": {
  21128. "description": "include git content of default branch in template repo",
  21129. "type": "boolean",
  21130. "x-go-name": "GitContent"
  21131. },
  21132. "git_hooks": {
  21133. "description": "include git hooks in template repo",
  21134. "type": "boolean",
  21135. "x-go-name": "GitHooks"
  21136. },
  21137. "labels": {
  21138. "description": "include labels in template repo",
  21139. "type": "boolean",
  21140. "x-go-name": "Labels"
  21141. },
  21142. "name": {
  21143. "description": "Name of the repository to create",
  21144. "type": "string",
  21145. "uniqueItems": true,
  21146. "x-go-name": "Name"
  21147. },
  21148. "owner": {
  21149. "description": "The organization or person who will own the new repository",
  21150. "type": "string",
  21151. "x-go-name": "Owner"
  21152. },
  21153. "private": {
  21154. "description": "Whether the repository is private",
  21155. "type": "boolean",
  21156. "x-go-name": "Private"
  21157. },
  21158. "protected_branch": {
  21159. "description": "include protected branches in template repo",
  21160. "type": "boolean",
  21161. "x-go-name": "ProtectedBranch"
  21162. },
  21163. "topics": {
  21164. "description": "include topics in template repo",
  21165. "type": "boolean",
  21166. "x-go-name": "Topics"
  21167. },
  21168. "webhooks": {
  21169. "description": "include webhooks in template repo",
  21170. "type": "boolean",
  21171. "x-go-name": "Webhooks"
  21172. }
  21173. },
  21174. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21175. },
  21176. "GitBlobResponse": {
  21177. "description": "GitBlobResponse represents a git blob",
  21178. "type": "object",
  21179. "properties": {
  21180. "content": {
  21181. "type": "string",
  21182. "x-go-name": "Content"
  21183. },
  21184. "encoding": {
  21185. "type": "string",
  21186. "x-go-name": "Encoding"
  21187. },
  21188. "sha": {
  21189. "type": "string",
  21190. "x-go-name": "SHA"
  21191. },
  21192. "size": {
  21193. "type": "integer",
  21194. "format": "int64",
  21195. "x-go-name": "Size"
  21196. },
  21197. "url": {
  21198. "type": "string",
  21199. "x-go-name": "URL"
  21200. }
  21201. },
  21202. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21203. },
  21204. "GitEntry": {
  21205. "description": "GitEntry represents a git tree",
  21206. "type": "object",
  21207. "properties": {
  21208. "mode": {
  21209. "type": "string",
  21210. "x-go-name": "Mode"
  21211. },
  21212. "path": {
  21213. "type": "string",
  21214. "x-go-name": "Path"
  21215. },
  21216. "sha": {
  21217. "type": "string",
  21218. "x-go-name": "SHA"
  21219. },
  21220. "size": {
  21221. "type": "integer",
  21222. "format": "int64",
  21223. "x-go-name": "Size"
  21224. },
  21225. "type": {
  21226. "type": "string",
  21227. "x-go-name": "Type"
  21228. },
  21229. "url": {
  21230. "type": "string",
  21231. "x-go-name": "URL"
  21232. }
  21233. },
  21234. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21235. },
  21236. "GitHook": {
  21237. "description": "GitHook represents a Git repository hook",
  21238. "type": "object",
  21239. "properties": {
  21240. "content": {
  21241. "type": "string",
  21242. "x-go-name": "Content"
  21243. },
  21244. "is_active": {
  21245. "type": "boolean",
  21246. "x-go-name": "IsActive"
  21247. },
  21248. "name": {
  21249. "type": "string",
  21250. "x-go-name": "Name"
  21251. }
  21252. },
  21253. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21254. },
  21255. "GitObject": {
  21256. "type": "object",
  21257. "title": "GitObject represents a Git object.",
  21258. "properties": {
  21259. "sha": {
  21260. "type": "string",
  21261. "x-go-name": "SHA"
  21262. },
  21263. "type": {
  21264. "type": "string",
  21265. "x-go-name": "Type"
  21266. },
  21267. "url": {
  21268. "type": "string",
  21269. "x-go-name": "URL"
  21270. }
  21271. },
  21272. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21273. },
  21274. "GitTreeResponse": {
  21275. "description": "GitTreeResponse returns a git tree",
  21276. "type": "object",
  21277. "properties": {
  21278. "page": {
  21279. "type": "integer",
  21280. "format": "int64",
  21281. "x-go-name": "Page"
  21282. },
  21283. "sha": {
  21284. "type": "string",
  21285. "x-go-name": "SHA"
  21286. },
  21287. "total_count": {
  21288. "type": "integer",
  21289. "format": "int64",
  21290. "x-go-name": "TotalCount"
  21291. },
  21292. "tree": {
  21293. "type": "array",
  21294. "items": {
  21295. "$ref": "#/definitions/GitEntry"
  21296. },
  21297. "x-go-name": "Entries"
  21298. },
  21299. "truncated": {
  21300. "type": "boolean",
  21301. "x-go-name": "Truncated"
  21302. },
  21303. "url": {
  21304. "type": "string",
  21305. "x-go-name": "URL"
  21306. }
  21307. },
  21308. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21309. },
  21310. "GitignoreTemplateInfo": {
  21311. "description": "GitignoreTemplateInfo name and text of a gitignore template",
  21312. "type": "object",
  21313. "properties": {
  21314. "name": {
  21315. "type": "string",
  21316. "x-go-name": "Name"
  21317. },
  21318. "source": {
  21319. "type": "string",
  21320. "x-go-name": "Source"
  21321. }
  21322. },
  21323. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21324. },
  21325. "Hook": {
  21326. "description": "Hook a hook is a web hook when one repository changed",
  21327. "type": "object",
  21328. "properties": {
  21329. "active": {
  21330. "type": "boolean",
  21331. "x-go-name": "Active"
  21332. },
  21333. "authorization_header": {
  21334. "type": "string",
  21335. "x-go-name": "AuthorizationHeader"
  21336. },
  21337. "branch_filter": {
  21338. "type": "string",
  21339. "x-go-name": "BranchFilter"
  21340. },
  21341. "config": {
  21342. "type": "object",
  21343. "additionalProperties": {
  21344. "type": "string"
  21345. },
  21346. "x-go-name": "Config"
  21347. },
  21348. "created_at": {
  21349. "type": "string",
  21350. "format": "date-time",
  21351. "x-go-name": "Created"
  21352. },
  21353. "events": {
  21354. "type": "array",
  21355. "items": {
  21356. "type": "string"
  21357. },
  21358. "x-go-name": "Events"
  21359. },
  21360. "id": {
  21361. "type": "integer",
  21362. "format": "int64",
  21363. "x-go-name": "ID"
  21364. },
  21365. "type": {
  21366. "type": "string",
  21367. "x-go-name": "Type"
  21368. },
  21369. "updated_at": {
  21370. "type": "string",
  21371. "format": "date-time",
  21372. "x-go-name": "Updated"
  21373. }
  21374. },
  21375. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21376. },
  21377. "Identity": {
  21378. "description": "Identity for a person's identity like an author or committer",
  21379. "type": "object",
  21380. "properties": {
  21381. "email": {
  21382. "type": "string",
  21383. "format": "email",
  21384. "x-go-name": "Email"
  21385. },
  21386. "name": {
  21387. "type": "string",
  21388. "x-go-name": "Name"
  21389. }
  21390. },
  21391. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21392. },
  21393. "InternalTracker": {
  21394. "description": "InternalTracker represents settings for internal tracker",
  21395. "type": "object",
  21396. "properties": {
  21397. "allow_only_contributors_to_track_time": {
  21398. "description": "Let only contributors track time (Built-in issue tracker)",
  21399. "type": "boolean",
  21400. "x-go-name": "AllowOnlyContributorsToTrackTime"
  21401. },
  21402. "enable_issue_dependencies": {
  21403. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  21404. "type": "boolean",
  21405. "x-go-name": "EnableIssueDependencies"
  21406. },
  21407. "enable_time_tracker": {
  21408. "description": "Enable time tracking (Built-in issue tracker)",
  21409. "type": "boolean",
  21410. "x-go-name": "EnableTimeTracker"
  21411. }
  21412. },
  21413. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21414. },
  21415. "Issue": {
  21416. "description": "Issue represents an issue in a repository",
  21417. "type": "object",
  21418. "properties": {
  21419. "assets": {
  21420. "type": "array",
  21421. "items": {
  21422. "$ref": "#/definitions/Attachment"
  21423. },
  21424. "x-go-name": "Attachments"
  21425. },
  21426. "assignee": {
  21427. "$ref": "#/definitions/User"
  21428. },
  21429. "assignees": {
  21430. "type": "array",
  21431. "items": {
  21432. "$ref": "#/definitions/User"
  21433. },
  21434. "x-go-name": "Assignees"
  21435. },
  21436. "body": {
  21437. "type": "string",
  21438. "x-go-name": "Body"
  21439. },
  21440. "closed_at": {
  21441. "type": "string",
  21442. "format": "date-time",
  21443. "x-go-name": "Closed"
  21444. },
  21445. "comments": {
  21446. "type": "integer",
  21447. "format": "int64",
  21448. "x-go-name": "Comments"
  21449. },
  21450. "created_at": {
  21451. "type": "string",
  21452. "format": "date-time",
  21453. "x-go-name": "Created"
  21454. },
  21455. "due_date": {
  21456. "type": "string",
  21457. "format": "date-time",
  21458. "x-go-name": "Deadline"
  21459. },
  21460. "html_url": {
  21461. "type": "string",
  21462. "x-go-name": "HTMLURL"
  21463. },
  21464. "id": {
  21465. "type": "integer",
  21466. "format": "int64",
  21467. "x-go-name": "ID"
  21468. },
  21469. "is_locked": {
  21470. "type": "boolean",
  21471. "x-go-name": "IsLocked"
  21472. },
  21473. "labels": {
  21474. "type": "array",
  21475. "items": {
  21476. "$ref": "#/definitions/Label"
  21477. },
  21478. "x-go-name": "Labels"
  21479. },
  21480. "milestone": {
  21481. "$ref": "#/definitions/Milestone"
  21482. },
  21483. "number": {
  21484. "type": "integer",
  21485. "format": "int64",
  21486. "x-go-name": "Index"
  21487. },
  21488. "original_author": {
  21489. "type": "string",
  21490. "x-go-name": "OriginalAuthor"
  21491. },
  21492. "original_author_id": {
  21493. "type": "integer",
  21494. "format": "int64",
  21495. "x-go-name": "OriginalAuthorID"
  21496. },
  21497. "pin_order": {
  21498. "type": "integer",
  21499. "format": "int64",
  21500. "x-go-name": "PinOrder"
  21501. },
  21502. "pull_request": {
  21503. "$ref": "#/definitions/PullRequestMeta"
  21504. },
  21505. "ref": {
  21506. "type": "string",
  21507. "x-go-name": "Ref"
  21508. },
  21509. "repository": {
  21510. "$ref": "#/definitions/RepositoryMeta"
  21511. },
  21512. "state": {
  21513. "$ref": "#/definitions/StateType"
  21514. },
  21515. "title": {
  21516. "type": "string",
  21517. "x-go-name": "Title"
  21518. },
  21519. "updated_at": {
  21520. "type": "string",
  21521. "format": "date-time",
  21522. "x-go-name": "Updated"
  21523. },
  21524. "url": {
  21525. "type": "string",
  21526. "x-go-name": "URL"
  21527. },
  21528. "user": {
  21529. "$ref": "#/definitions/User"
  21530. }
  21531. },
  21532. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21533. },
  21534. "IssueConfig": {
  21535. "type": "object",
  21536. "properties": {
  21537. "blank_issues_enabled": {
  21538. "type": "boolean",
  21539. "x-go-name": "BlankIssuesEnabled"
  21540. },
  21541. "contact_links": {
  21542. "type": "array",
  21543. "items": {
  21544. "$ref": "#/definitions/IssueConfigContactLink"
  21545. },
  21546. "x-go-name": "ContactLinks"
  21547. }
  21548. },
  21549. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21550. },
  21551. "IssueConfigContactLink": {
  21552. "type": "object",
  21553. "properties": {
  21554. "about": {
  21555. "type": "string",
  21556. "x-go-name": "About"
  21557. },
  21558. "name": {
  21559. "type": "string",
  21560. "x-go-name": "Name"
  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. "IssueConfigValidation": {
  21570. "type": "object",
  21571. "properties": {
  21572. "message": {
  21573. "type": "string",
  21574. "x-go-name": "Message"
  21575. },
  21576. "valid": {
  21577. "type": "boolean",
  21578. "x-go-name": "Valid"
  21579. }
  21580. },
  21581. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21582. },
  21583. "IssueDeadline": {
  21584. "description": "IssueDeadline represents an issue deadline",
  21585. "type": "object",
  21586. "properties": {
  21587. "due_date": {
  21588. "type": "string",
  21589. "format": "date-time",
  21590. "x-go-name": "Deadline"
  21591. }
  21592. },
  21593. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21594. },
  21595. "IssueFormField": {
  21596. "description": "IssueFormField represents a form field",
  21597. "type": "object",
  21598. "properties": {
  21599. "attributes": {
  21600. "type": "object",
  21601. "additionalProperties": {},
  21602. "x-go-name": "Attributes"
  21603. },
  21604. "id": {
  21605. "type": "string",
  21606. "x-go-name": "ID"
  21607. },
  21608. "type": {
  21609. "$ref": "#/definitions/IssueFormFieldType"
  21610. },
  21611. "validations": {
  21612. "type": "object",
  21613. "additionalProperties": {},
  21614. "x-go-name": "Validations"
  21615. },
  21616. "visible": {
  21617. "type": "array",
  21618. "items": {
  21619. "$ref": "#/definitions/IssueFormFieldVisible"
  21620. },
  21621. "x-go-name": "Visible"
  21622. }
  21623. },
  21624. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21625. },
  21626. "IssueFormFieldType": {
  21627. "type": "string",
  21628. "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
  21629. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21630. },
  21631. "IssueFormFieldVisible": {
  21632. "description": "IssueFormFieldVisible defines issue form field visible",
  21633. "type": "string",
  21634. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21635. },
  21636. "IssueLabelsOption": {
  21637. "description": "IssueLabelsOption a collection of labels",
  21638. "type": "object",
  21639. "properties": {
  21640. "labels": {
  21641. "description": "list of label IDs",
  21642. "type": "array",
  21643. "items": {
  21644. "type": "integer",
  21645. "format": "int64"
  21646. },
  21647. "x-go-name": "Labels"
  21648. }
  21649. },
  21650. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21651. },
  21652. "IssueMeta": {
  21653. "description": "IssueMeta basic issue information",
  21654. "type": "object",
  21655. "properties": {
  21656. "index": {
  21657. "type": "integer",
  21658. "format": "int64",
  21659. "x-go-name": "Index"
  21660. },
  21661. "owner": {
  21662. "type": "string",
  21663. "x-go-name": "Owner"
  21664. },
  21665. "repo": {
  21666. "type": "string",
  21667. "x-go-name": "Name"
  21668. }
  21669. },
  21670. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21671. },
  21672. "IssueTemplate": {
  21673. "description": "IssueTemplate represents an issue template for a repository",
  21674. "type": "object",
  21675. "properties": {
  21676. "about": {
  21677. "type": "string",
  21678. "x-go-name": "About"
  21679. },
  21680. "body": {
  21681. "type": "array",
  21682. "items": {
  21683. "$ref": "#/definitions/IssueFormField"
  21684. },
  21685. "x-go-name": "Fields"
  21686. },
  21687. "content": {
  21688. "type": "string",
  21689. "x-go-name": "Content"
  21690. },
  21691. "file_name": {
  21692. "type": "string",
  21693. "x-go-name": "FileName"
  21694. },
  21695. "labels": {
  21696. "$ref": "#/definitions/IssueTemplateLabels"
  21697. },
  21698. "name": {
  21699. "type": "string",
  21700. "x-go-name": "Name"
  21701. },
  21702. "ref": {
  21703. "type": "string",
  21704. "x-go-name": "Ref"
  21705. },
  21706. "title": {
  21707. "type": "string",
  21708. "x-go-name": "Title"
  21709. }
  21710. },
  21711. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21712. },
  21713. "IssueTemplateLabels": {
  21714. "type": "array",
  21715. "items": {
  21716. "type": "string"
  21717. },
  21718. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21719. },
  21720. "Label": {
  21721. "description": "Label a label to an issue or a pr",
  21722. "type": "object",
  21723. "properties": {
  21724. "color": {
  21725. "type": "string",
  21726. "x-go-name": "Color",
  21727. "example": "00aabb"
  21728. },
  21729. "description": {
  21730. "type": "string",
  21731. "x-go-name": "Description"
  21732. },
  21733. "exclusive": {
  21734. "type": "boolean",
  21735. "x-go-name": "Exclusive",
  21736. "example": false
  21737. },
  21738. "id": {
  21739. "type": "integer",
  21740. "format": "int64",
  21741. "x-go-name": "ID"
  21742. },
  21743. "is_archived": {
  21744. "type": "boolean",
  21745. "x-go-name": "IsArchived",
  21746. "example": false
  21747. },
  21748. "name": {
  21749. "type": "string",
  21750. "x-go-name": "Name"
  21751. },
  21752. "url": {
  21753. "type": "string",
  21754. "x-go-name": "URL"
  21755. }
  21756. },
  21757. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21758. },
  21759. "LabelTemplate": {
  21760. "description": "LabelTemplate info of a Label template",
  21761. "type": "object",
  21762. "properties": {
  21763. "color": {
  21764. "type": "string",
  21765. "x-go-name": "Color",
  21766. "example": "00aabb"
  21767. },
  21768. "description": {
  21769. "type": "string",
  21770. "x-go-name": "Description"
  21771. },
  21772. "exclusive": {
  21773. "type": "boolean",
  21774. "x-go-name": "Exclusive",
  21775. "example": false
  21776. },
  21777. "name": {
  21778. "type": "string",
  21779. "x-go-name": "Name"
  21780. }
  21781. },
  21782. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21783. },
  21784. "LicenseTemplateInfo": {
  21785. "description": "LicensesInfo contains information about a License",
  21786. "type": "object",
  21787. "properties": {
  21788. "body": {
  21789. "type": "string",
  21790. "x-go-name": "Body"
  21791. },
  21792. "implementation": {
  21793. "type": "string",
  21794. "x-go-name": "Implementation"
  21795. },
  21796. "key": {
  21797. "type": "string",
  21798. "x-go-name": "Key"
  21799. },
  21800. "name": {
  21801. "type": "string",
  21802. "x-go-name": "Name"
  21803. },
  21804. "url": {
  21805. "type": "string",
  21806. "x-go-name": "URL"
  21807. }
  21808. },
  21809. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21810. },
  21811. "LicensesTemplateListEntry": {
  21812. "description": "LicensesListEntry is used for the API",
  21813. "type": "object",
  21814. "properties": {
  21815. "key": {
  21816. "type": "string",
  21817. "x-go-name": "Key"
  21818. },
  21819. "name": {
  21820. "type": "string",
  21821. "x-go-name": "Name"
  21822. },
  21823. "url": {
  21824. "type": "string",
  21825. "x-go-name": "URL"
  21826. }
  21827. },
  21828. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21829. },
  21830. "MarkdownOption": {
  21831. "description": "MarkdownOption markdown options",
  21832. "type": "object",
  21833. "properties": {
  21834. "Context": {
  21835. "description": "Context to render\n\nin: body",
  21836. "type": "string"
  21837. },
  21838. "Mode": {
  21839. "description": "Mode to render (comment, gfm, markdown)\n\nin: body",
  21840. "type": "string"
  21841. },
  21842. "Text": {
  21843. "description": "Text markdown to render\n\nin: body",
  21844. "type": "string"
  21845. },
  21846. "Wiki": {
  21847. "description": "Is it a wiki page ?\n\nin: body",
  21848. "type": "boolean"
  21849. }
  21850. },
  21851. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21852. },
  21853. "MarkupOption": {
  21854. "description": "MarkupOption markup options",
  21855. "type": "object",
  21856. "properties": {
  21857. "Context": {
  21858. "description": "Context to render\n\nin: body",
  21859. "type": "string"
  21860. },
  21861. "FilePath": {
  21862. "description": "File path for detecting extension in file mode\n\nin: body",
  21863. "type": "string"
  21864. },
  21865. "Mode": {
  21866. "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body",
  21867. "type": "string"
  21868. },
  21869. "Text": {
  21870. "description": "Text markup to render\n\nin: body",
  21871. "type": "string"
  21872. },
  21873. "Wiki": {
  21874. "description": "Is it a wiki page ?\n\nin: body",
  21875. "type": "boolean"
  21876. }
  21877. },
  21878. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21879. },
  21880. "MergePullRequestOption": {
  21881. "description": "MergePullRequestForm form for merging Pull Request",
  21882. "type": "object",
  21883. "required": [
  21884. "Do"
  21885. ],
  21886. "properties": {
  21887. "Do": {
  21888. "type": "string",
  21889. "enum": [
  21890. "merge",
  21891. "rebase",
  21892. "rebase-merge",
  21893. "squash",
  21894. "fast-forward-only",
  21895. "manually-merged"
  21896. ]
  21897. },
  21898. "MergeCommitID": {
  21899. "type": "string"
  21900. },
  21901. "MergeMessageField": {
  21902. "type": "string"
  21903. },
  21904. "MergeTitleField": {
  21905. "type": "string"
  21906. },
  21907. "delete_branch_after_merge": {
  21908. "type": "boolean",
  21909. "x-go-name": "DeleteBranchAfterMerge"
  21910. },
  21911. "force_merge": {
  21912. "type": "boolean",
  21913. "x-go-name": "ForceMerge"
  21914. },
  21915. "head_commit_id": {
  21916. "type": "string",
  21917. "x-go-name": "HeadCommitID"
  21918. },
  21919. "merge_when_checks_succeed": {
  21920. "type": "boolean",
  21921. "x-go-name": "MergeWhenChecksSucceed"
  21922. }
  21923. },
  21924. "x-go-name": "MergePullRequestForm",
  21925. "x-go-package": "code.gitea.io/gitea/services/forms"
  21926. },
  21927. "MigrateRepoOptions": {
  21928. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  21929. "type": "object",
  21930. "required": [
  21931. "clone_addr",
  21932. "repo_name"
  21933. ],
  21934. "properties": {
  21935. "auth_password": {
  21936. "type": "string",
  21937. "x-go-name": "AuthPassword"
  21938. },
  21939. "auth_token": {
  21940. "type": "string",
  21941. "x-go-name": "AuthToken"
  21942. },
  21943. "auth_username": {
  21944. "type": "string",
  21945. "x-go-name": "AuthUsername"
  21946. },
  21947. "clone_addr": {
  21948. "type": "string",
  21949. "x-go-name": "CloneAddr"
  21950. },
  21951. "description": {
  21952. "type": "string",
  21953. "x-go-name": "Description"
  21954. },
  21955. "issues": {
  21956. "type": "boolean",
  21957. "x-go-name": "Issues"
  21958. },
  21959. "labels": {
  21960. "type": "boolean",
  21961. "x-go-name": "Labels"
  21962. },
  21963. "lfs": {
  21964. "type": "boolean",
  21965. "x-go-name": "LFS"
  21966. },
  21967. "lfs_endpoint": {
  21968. "type": "string",
  21969. "x-go-name": "LFSEndpoint"
  21970. },
  21971. "milestones": {
  21972. "type": "boolean",
  21973. "x-go-name": "Milestones"
  21974. },
  21975. "mirror": {
  21976. "type": "boolean",
  21977. "x-go-name": "Mirror"
  21978. },
  21979. "mirror_interval": {
  21980. "type": "string",
  21981. "x-go-name": "MirrorInterval"
  21982. },
  21983. "private": {
  21984. "type": "boolean",
  21985. "x-go-name": "Private"
  21986. },
  21987. "pull_requests": {
  21988. "type": "boolean",
  21989. "x-go-name": "PullRequests"
  21990. },
  21991. "releases": {
  21992. "type": "boolean",
  21993. "x-go-name": "Releases"
  21994. },
  21995. "repo_name": {
  21996. "type": "string",
  21997. "x-go-name": "RepoName"
  21998. },
  21999. "repo_owner": {
  22000. "description": "Name of User or Organisation who will own Repo after migration",
  22001. "type": "string",
  22002. "x-go-name": "RepoOwner"
  22003. },
  22004. "service": {
  22005. "type": "string",
  22006. "enum": [
  22007. "git",
  22008. "github",
  22009. "gitea",
  22010. "gitlab",
  22011. "gogs",
  22012. "onedev",
  22013. "gitbucket",
  22014. "codebase"
  22015. ],
  22016. "x-go-name": "Service"
  22017. },
  22018. "uid": {
  22019. "description": "deprecated (only for backwards compatibility)",
  22020. "type": "integer",
  22021. "format": "int64",
  22022. "x-go-name": "RepoOwnerID"
  22023. },
  22024. "wiki": {
  22025. "type": "boolean",
  22026. "x-go-name": "Wiki"
  22027. }
  22028. },
  22029. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22030. },
  22031. "Milestone": {
  22032. "description": "Milestone milestone is a collection of issues on one repository",
  22033. "type": "object",
  22034. "properties": {
  22035. "closed_at": {
  22036. "type": "string",
  22037. "format": "date-time",
  22038. "x-go-name": "Closed"
  22039. },
  22040. "closed_issues": {
  22041. "type": "integer",
  22042. "format": "int64",
  22043. "x-go-name": "ClosedIssues"
  22044. },
  22045. "created_at": {
  22046. "type": "string",
  22047. "format": "date-time",
  22048. "x-go-name": "Created"
  22049. },
  22050. "description": {
  22051. "type": "string",
  22052. "x-go-name": "Description"
  22053. },
  22054. "due_on": {
  22055. "type": "string",
  22056. "format": "date-time",
  22057. "x-go-name": "Deadline"
  22058. },
  22059. "id": {
  22060. "type": "integer",
  22061. "format": "int64",
  22062. "x-go-name": "ID"
  22063. },
  22064. "open_issues": {
  22065. "type": "integer",
  22066. "format": "int64",
  22067. "x-go-name": "OpenIssues"
  22068. },
  22069. "state": {
  22070. "$ref": "#/definitions/StateType"
  22071. },
  22072. "title": {
  22073. "type": "string",
  22074. "x-go-name": "Title"
  22075. },
  22076. "updated_at": {
  22077. "type": "string",
  22078. "format": "date-time",
  22079. "x-go-name": "Updated"
  22080. }
  22081. },
  22082. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22083. },
  22084. "NewIssuePinsAllowed": {
  22085. "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed",
  22086. "type": "object",
  22087. "properties": {
  22088. "issues": {
  22089. "type": "boolean",
  22090. "x-go-name": "Issues"
  22091. },
  22092. "pull_requests": {
  22093. "type": "boolean",
  22094. "x-go-name": "PullRequests"
  22095. }
  22096. },
  22097. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22098. },
  22099. "NodeInfo": {
  22100. "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
  22101. "type": "object",
  22102. "properties": {
  22103. "metadata": {
  22104. "type": "object",
  22105. "x-go-name": "Metadata"
  22106. },
  22107. "openRegistrations": {
  22108. "type": "boolean",
  22109. "x-go-name": "OpenRegistrations"
  22110. },
  22111. "protocols": {
  22112. "type": "array",
  22113. "items": {
  22114. "type": "string"
  22115. },
  22116. "x-go-name": "Protocols"
  22117. },
  22118. "services": {
  22119. "$ref": "#/definitions/NodeInfoServices"
  22120. },
  22121. "software": {
  22122. "$ref": "#/definitions/NodeInfoSoftware"
  22123. },
  22124. "usage": {
  22125. "$ref": "#/definitions/NodeInfoUsage"
  22126. },
  22127. "version": {
  22128. "type": "string",
  22129. "x-go-name": "Version"
  22130. }
  22131. },
  22132. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22133. },
  22134. "NodeInfoServices": {
  22135. "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
  22136. "type": "object",
  22137. "properties": {
  22138. "inbound": {
  22139. "type": "array",
  22140. "items": {
  22141. "type": "string"
  22142. },
  22143. "x-go-name": "Inbound"
  22144. },
  22145. "outbound": {
  22146. "type": "array",
  22147. "items": {
  22148. "type": "string"
  22149. },
  22150. "x-go-name": "Outbound"
  22151. }
  22152. },
  22153. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22154. },
  22155. "NodeInfoSoftware": {
  22156. "description": "NodeInfoSoftware contains Metadata about server software in use",
  22157. "type": "object",
  22158. "properties": {
  22159. "homepage": {
  22160. "type": "string",
  22161. "x-go-name": "Homepage"
  22162. },
  22163. "name": {
  22164. "type": "string",
  22165. "x-go-name": "Name"
  22166. },
  22167. "repository": {
  22168. "type": "string",
  22169. "x-go-name": "Repository"
  22170. },
  22171. "version": {
  22172. "type": "string",
  22173. "x-go-name": "Version"
  22174. }
  22175. },
  22176. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22177. },
  22178. "NodeInfoUsage": {
  22179. "description": "NodeInfoUsage contains usage statistics for this server",
  22180. "type": "object",
  22181. "properties": {
  22182. "localComments": {
  22183. "type": "integer",
  22184. "format": "int64",
  22185. "x-go-name": "LocalComments"
  22186. },
  22187. "localPosts": {
  22188. "type": "integer",
  22189. "format": "int64",
  22190. "x-go-name": "LocalPosts"
  22191. },
  22192. "users": {
  22193. "$ref": "#/definitions/NodeInfoUsageUsers"
  22194. }
  22195. },
  22196. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22197. },
  22198. "NodeInfoUsageUsers": {
  22199. "description": "NodeInfoUsageUsers contains statistics about the users of this server",
  22200. "type": "object",
  22201. "properties": {
  22202. "activeHalfyear": {
  22203. "type": "integer",
  22204. "format": "int64",
  22205. "x-go-name": "ActiveHalfyear"
  22206. },
  22207. "activeMonth": {
  22208. "type": "integer",
  22209. "format": "int64",
  22210. "x-go-name": "ActiveMonth"
  22211. },
  22212. "total": {
  22213. "type": "integer",
  22214. "format": "int64",
  22215. "x-go-name": "Total"
  22216. }
  22217. },
  22218. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22219. },
  22220. "Note": {
  22221. "description": "Note contains information related to a git note",
  22222. "type": "object",
  22223. "properties": {
  22224. "commit": {
  22225. "$ref": "#/definitions/Commit"
  22226. },
  22227. "message": {
  22228. "type": "string",
  22229. "x-go-name": "Message"
  22230. }
  22231. },
  22232. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22233. },
  22234. "NotificationCount": {
  22235. "description": "NotificationCount number of unread notifications",
  22236. "type": "object",
  22237. "properties": {
  22238. "new": {
  22239. "type": "integer",
  22240. "format": "int64",
  22241. "x-go-name": "New"
  22242. }
  22243. },
  22244. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22245. },
  22246. "NotificationSubject": {
  22247. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  22248. "type": "object",
  22249. "properties": {
  22250. "html_url": {
  22251. "type": "string",
  22252. "x-go-name": "HTMLURL"
  22253. },
  22254. "latest_comment_html_url": {
  22255. "type": "string",
  22256. "x-go-name": "LatestCommentHTMLURL"
  22257. },
  22258. "latest_comment_url": {
  22259. "type": "string",
  22260. "x-go-name": "LatestCommentURL"
  22261. },
  22262. "state": {
  22263. "$ref": "#/definitions/StateType"
  22264. },
  22265. "title": {
  22266. "type": "string",
  22267. "x-go-name": "Title"
  22268. },
  22269. "type": {
  22270. "$ref": "#/definitions/NotifySubjectType"
  22271. },
  22272. "url": {
  22273. "type": "string",
  22274. "x-go-name": "URL"
  22275. }
  22276. },
  22277. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22278. },
  22279. "NotificationThread": {
  22280. "description": "NotificationThread expose Notification on API",
  22281. "type": "object",
  22282. "properties": {
  22283. "id": {
  22284. "type": "integer",
  22285. "format": "int64",
  22286. "x-go-name": "ID"
  22287. },
  22288. "pinned": {
  22289. "type": "boolean",
  22290. "x-go-name": "Pinned"
  22291. },
  22292. "repository": {
  22293. "$ref": "#/definitions/Repository"
  22294. },
  22295. "subject": {
  22296. "$ref": "#/definitions/NotificationSubject"
  22297. },
  22298. "unread": {
  22299. "type": "boolean",
  22300. "x-go-name": "Unread"
  22301. },
  22302. "updated_at": {
  22303. "type": "string",
  22304. "format": "date-time",
  22305. "x-go-name": "UpdatedAt"
  22306. },
  22307. "url": {
  22308. "type": "string",
  22309. "x-go-name": "URL"
  22310. }
  22311. },
  22312. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22313. },
  22314. "NotifySubjectType": {
  22315. "description": "NotifySubjectType represent type of notification subject",
  22316. "type": "string",
  22317. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22318. },
  22319. "OAuth2Application": {
  22320. "type": "object",
  22321. "title": "OAuth2Application represents an OAuth2 application.",
  22322. "properties": {
  22323. "client_id": {
  22324. "type": "string",
  22325. "x-go-name": "ClientID"
  22326. },
  22327. "client_secret": {
  22328. "type": "string",
  22329. "x-go-name": "ClientSecret"
  22330. },
  22331. "confidential_client": {
  22332. "type": "boolean",
  22333. "x-go-name": "ConfidentialClient"
  22334. },
  22335. "created": {
  22336. "type": "string",
  22337. "format": "date-time",
  22338. "x-go-name": "Created"
  22339. },
  22340. "id": {
  22341. "type": "integer",
  22342. "format": "int64",
  22343. "x-go-name": "ID"
  22344. },
  22345. "name": {
  22346. "type": "string",
  22347. "x-go-name": "Name"
  22348. },
  22349. "redirect_uris": {
  22350. "type": "array",
  22351. "items": {
  22352. "type": "string"
  22353. },
  22354. "x-go-name": "RedirectURIs"
  22355. }
  22356. },
  22357. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22358. },
  22359. "Organization": {
  22360. "description": "Organization represents an organization",
  22361. "type": "object",
  22362. "properties": {
  22363. "avatar_url": {
  22364. "type": "string",
  22365. "x-go-name": "AvatarURL"
  22366. },
  22367. "description": {
  22368. "type": "string",
  22369. "x-go-name": "Description"
  22370. },
  22371. "email": {
  22372. "type": "string",
  22373. "x-go-name": "Email"
  22374. },
  22375. "full_name": {
  22376. "type": "string",
  22377. "x-go-name": "FullName"
  22378. },
  22379. "id": {
  22380. "type": "integer",
  22381. "format": "int64",
  22382. "x-go-name": "ID"
  22383. },
  22384. "location": {
  22385. "type": "string",
  22386. "x-go-name": "Location"
  22387. },
  22388. "name": {
  22389. "type": "string",
  22390. "x-go-name": "Name"
  22391. },
  22392. "repo_admin_change_team_access": {
  22393. "type": "boolean",
  22394. "x-go-name": "RepoAdminChangeTeamAccess"
  22395. },
  22396. "username": {
  22397. "description": "deprecated",
  22398. "type": "string",
  22399. "x-go-name": "UserName"
  22400. },
  22401. "visibility": {
  22402. "type": "string",
  22403. "x-go-name": "Visibility"
  22404. },
  22405. "website": {
  22406. "type": "string",
  22407. "x-go-name": "Website"
  22408. }
  22409. },
  22410. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22411. },
  22412. "OrganizationPermissions": {
  22413. "description": "OrganizationPermissions list different users permissions on an organization",
  22414. "type": "object",
  22415. "properties": {
  22416. "can_create_repository": {
  22417. "type": "boolean",
  22418. "x-go-name": "CanCreateRepository"
  22419. },
  22420. "can_read": {
  22421. "type": "boolean",
  22422. "x-go-name": "CanRead"
  22423. },
  22424. "can_write": {
  22425. "type": "boolean",
  22426. "x-go-name": "CanWrite"
  22427. },
  22428. "is_admin": {
  22429. "type": "boolean",
  22430. "x-go-name": "IsAdmin"
  22431. },
  22432. "is_owner": {
  22433. "type": "boolean",
  22434. "x-go-name": "IsOwner"
  22435. }
  22436. },
  22437. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22438. },
  22439. "PRBranchInfo": {
  22440. "description": "PRBranchInfo information about a branch",
  22441. "type": "object",
  22442. "properties": {
  22443. "label": {
  22444. "type": "string",
  22445. "x-go-name": "Name"
  22446. },
  22447. "ref": {
  22448. "type": "string",
  22449. "x-go-name": "Ref"
  22450. },
  22451. "repo": {
  22452. "$ref": "#/definitions/Repository"
  22453. },
  22454. "repo_id": {
  22455. "type": "integer",
  22456. "format": "int64",
  22457. "x-go-name": "RepoID"
  22458. },
  22459. "sha": {
  22460. "type": "string",
  22461. "x-go-name": "Sha"
  22462. }
  22463. },
  22464. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22465. },
  22466. "Package": {
  22467. "description": "Package represents a package",
  22468. "type": "object",
  22469. "properties": {
  22470. "created_at": {
  22471. "type": "string",
  22472. "format": "date-time",
  22473. "x-go-name": "CreatedAt"
  22474. },
  22475. "creator": {
  22476. "$ref": "#/definitions/User"
  22477. },
  22478. "html_url": {
  22479. "type": "string",
  22480. "x-go-name": "HTMLURL"
  22481. },
  22482. "id": {
  22483. "type": "integer",
  22484. "format": "int64",
  22485. "x-go-name": "ID"
  22486. },
  22487. "name": {
  22488. "type": "string",
  22489. "x-go-name": "Name"
  22490. },
  22491. "owner": {
  22492. "$ref": "#/definitions/User"
  22493. },
  22494. "repository": {
  22495. "$ref": "#/definitions/Repository"
  22496. },
  22497. "type": {
  22498. "type": "string",
  22499. "x-go-name": "Type"
  22500. },
  22501. "version": {
  22502. "type": "string",
  22503. "x-go-name": "Version"
  22504. }
  22505. },
  22506. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22507. },
  22508. "PackageFile": {
  22509. "description": "PackageFile represents a package file",
  22510. "type": "object",
  22511. "properties": {
  22512. "Size": {
  22513. "type": "integer",
  22514. "format": "int64"
  22515. },
  22516. "id": {
  22517. "type": "integer",
  22518. "format": "int64",
  22519. "x-go-name": "ID"
  22520. },
  22521. "md5": {
  22522. "type": "string",
  22523. "x-go-name": "HashMD5"
  22524. },
  22525. "name": {
  22526. "type": "string",
  22527. "x-go-name": "Name"
  22528. },
  22529. "sha1": {
  22530. "type": "string",
  22531. "x-go-name": "HashSHA1"
  22532. },
  22533. "sha256": {
  22534. "type": "string",
  22535. "x-go-name": "HashSHA256"
  22536. },
  22537. "sha512": {
  22538. "type": "string",
  22539. "x-go-name": "HashSHA512"
  22540. }
  22541. },
  22542. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22543. },
  22544. "PayloadCommit": {
  22545. "description": "PayloadCommit represents a commit",
  22546. "type": "object",
  22547. "properties": {
  22548. "added": {
  22549. "type": "array",
  22550. "items": {
  22551. "type": "string"
  22552. },
  22553. "x-go-name": "Added"
  22554. },
  22555. "author": {
  22556. "$ref": "#/definitions/PayloadUser"
  22557. },
  22558. "committer": {
  22559. "$ref": "#/definitions/PayloadUser"
  22560. },
  22561. "id": {
  22562. "description": "sha1 hash of the commit",
  22563. "type": "string",
  22564. "x-go-name": "ID"
  22565. },
  22566. "message": {
  22567. "type": "string",
  22568. "x-go-name": "Message"
  22569. },
  22570. "modified": {
  22571. "type": "array",
  22572. "items": {
  22573. "type": "string"
  22574. },
  22575. "x-go-name": "Modified"
  22576. },
  22577. "removed": {
  22578. "type": "array",
  22579. "items": {
  22580. "type": "string"
  22581. },
  22582. "x-go-name": "Removed"
  22583. },
  22584. "timestamp": {
  22585. "type": "string",
  22586. "format": "date-time",
  22587. "x-go-name": "Timestamp"
  22588. },
  22589. "url": {
  22590. "type": "string",
  22591. "x-go-name": "URL"
  22592. },
  22593. "verification": {
  22594. "$ref": "#/definitions/PayloadCommitVerification"
  22595. }
  22596. },
  22597. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22598. },
  22599. "PayloadCommitVerification": {
  22600. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  22601. "type": "object",
  22602. "properties": {
  22603. "payload": {
  22604. "type": "string",
  22605. "x-go-name": "Payload"
  22606. },
  22607. "reason": {
  22608. "type": "string",
  22609. "x-go-name": "Reason"
  22610. },
  22611. "signature": {
  22612. "type": "string",
  22613. "x-go-name": "Signature"
  22614. },
  22615. "signer": {
  22616. "$ref": "#/definitions/PayloadUser"
  22617. },
  22618. "verified": {
  22619. "type": "boolean",
  22620. "x-go-name": "Verified"
  22621. }
  22622. },
  22623. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22624. },
  22625. "PayloadUser": {
  22626. "description": "PayloadUser represents the author or committer of a commit",
  22627. "type": "object",
  22628. "properties": {
  22629. "email": {
  22630. "type": "string",
  22631. "format": "email",
  22632. "x-go-name": "Email"
  22633. },
  22634. "name": {
  22635. "description": "Full name of the commit author",
  22636. "type": "string",
  22637. "x-go-name": "Name"
  22638. },
  22639. "username": {
  22640. "type": "string",
  22641. "x-go-name": "UserName"
  22642. }
  22643. },
  22644. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22645. },
  22646. "Permission": {
  22647. "description": "Permission represents a set of permissions",
  22648. "type": "object",
  22649. "properties": {
  22650. "admin": {
  22651. "type": "boolean",
  22652. "x-go-name": "Admin"
  22653. },
  22654. "pull": {
  22655. "type": "boolean",
  22656. "x-go-name": "Pull"
  22657. },
  22658. "push": {
  22659. "type": "boolean",
  22660. "x-go-name": "Push"
  22661. }
  22662. },
  22663. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22664. },
  22665. "PublicKey": {
  22666. "description": "PublicKey publickey is a user key to push code to repository",
  22667. "type": "object",
  22668. "properties": {
  22669. "created_at": {
  22670. "type": "string",
  22671. "format": "date-time",
  22672. "x-go-name": "Created"
  22673. },
  22674. "fingerprint": {
  22675. "type": "string",
  22676. "x-go-name": "Fingerprint"
  22677. },
  22678. "id": {
  22679. "type": "integer",
  22680. "format": "int64",
  22681. "x-go-name": "ID"
  22682. },
  22683. "key": {
  22684. "type": "string",
  22685. "x-go-name": "Key"
  22686. },
  22687. "key_type": {
  22688. "type": "string",
  22689. "x-go-name": "KeyType"
  22690. },
  22691. "read_only": {
  22692. "type": "boolean",
  22693. "x-go-name": "ReadOnly"
  22694. },
  22695. "title": {
  22696. "type": "string",
  22697. "x-go-name": "Title"
  22698. },
  22699. "url": {
  22700. "type": "string",
  22701. "x-go-name": "URL"
  22702. },
  22703. "user": {
  22704. "$ref": "#/definitions/User"
  22705. }
  22706. },
  22707. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22708. },
  22709. "PullRequest": {
  22710. "description": "PullRequest represents a pull request",
  22711. "type": "object",
  22712. "properties": {
  22713. "allow_maintainer_edit": {
  22714. "type": "boolean",
  22715. "x-go-name": "AllowMaintainerEdit"
  22716. },
  22717. "assignee": {
  22718. "$ref": "#/definitions/User"
  22719. },
  22720. "assignees": {
  22721. "type": "array",
  22722. "items": {
  22723. "$ref": "#/definitions/User"
  22724. },
  22725. "x-go-name": "Assignees"
  22726. },
  22727. "base": {
  22728. "$ref": "#/definitions/PRBranchInfo"
  22729. },
  22730. "body": {
  22731. "type": "string",
  22732. "x-go-name": "Body"
  22733. },
  22734. "closed_at": {
  22735. "type": "string",
  22736. "format": "date-time",
  22737. "x-go-name": "Closed"
  22738. },
  22739. "comments": {
  22740. "type": "integer",
  22741. "format": "int64",
  22742. "x-go-name": "Comments"
  22743. },
  22744. "created_at": {
  22745. "type": "string",
  22746. "format": "date-time",
  22747. "x-go-name": "Created"
  22748. },
  22749. "diff_url": {
  22750. "type": "string",
  22751. "x-go-name": "DiffURL"
  22752. },
  22753. "due_date": {
  22754. "type": "string",
  22755. "format": "date-time",
  22756. "x-go-name": "Deadline"
  22757. },
  22758. "head": {
  22759. "$ref": "#/definitions/PRBranchInfo"
  22760. },
  22761. "html_url": {
  22762. "type": "string",
  22763. "x-go-name": "HTMLURL"
  22764. },
  22765. "id": {
  22766. "type": "integer",
  22767. "format": "int64",
  22768. "x-go-name": "ID"
  22769. },
  22770. "is_locked": {
  22771. "type": "boolean",
  22772. "x-go-name": "IsLocked"
  22773. },
  22774. "labels": {
  22775. "type": "array",
  22776. "items": {
  22777. "$ref": "#/definitions/Label"
  22778. },
  22779. "x-go-name": "Labels"
  22780. },
  22781. "merge_base": {
  22782. "type": "string",
  22783. "x-go-name": "MergeBase"
  22784. },
  22785. "merge_commit_sha": {
  22786. "type": "string",
  22787. "x-go-name": "MergedCommitID"
  22788. },
  22789. "mergeable": {
  22790. "type": "boolean",
  22791. "x-go-name": "Mergeable"
  22792. },
  22793. "merged": {
  22794. "type": "boolean",
  22795. "x-go-name": "HasMerged"
  22796. },
  22797. "merged_at": {
  22798. "type": "string",
  22799. "format": "date-time",
  22800. "x-go-name": "Merged"
  22801. },
  22802. "merged_by": {
  22803. "$ref": "#/definitions/User"
  22804. },
  22805. "milestone": {
  22806. "$ref": "#/definitions/Milestone"
  22807. },
  22808. "number": {
  22809. "type": "integer",
  22810. "format": "int64",
  22811. "x-go-name": "Index"
  22812. },
  22813. "patch_url": {
  22814. "type": "string",
  22815. "x-go-name": "PatchURL"
  22816. },
  22817. "pin_order": {
  22818. "type": "integer",
  22819. "format": "int64",
  22820. "x-go-name": "PinOrder"
  22821. },
  22822. "requested_reviewers": {
  22823. "type": "array",
  22824. "items": {
  22825. "$ref": "#/definitions/User"
  22826. },
  22827. "x-go-name": "RequestedReviewers"
  22828. },
  22829. "state": {
  22830. "$ref": "#/definitions/StateType"
  22831. },
  22832. "title": {
  22833. "type": "string",
  22834. "x-go-name": "Title"
  22835. },
  22836. "updated_at": {
  22837. "type": "string",
  22838. "format": "date-time",
  22839. "x-go-name": "Updated"
  22840. },
  22841. "url": {
  22842. "type": "string",
  22843. "x-go-name": "URL"
  22844. },
  22845. "user": {
  22846. "$ref": "#/definitions/User"
  22847. }
  22848. },
  22849. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22850. },
  22851. "PullRequestMeta": {
  22852. "description": "PullRequestMeta PR info if an issue is a PR",
  22853. "type": "object",
  22854. "properties": {
  22855. "draft": {
  22856. "type": "boolean",
  22857. "x-go-name": "IsWorkInProgress"
  22858. },
  22859. "merged": {
  22860. "type": "boolean",
  22861. "x-go-name": "HasMerged"
  22862. },
  22863. "merged_at": {
  22864. "type": "string",
  22865. "format": "date-time",
  22866. "x-go-name": "Merged"
  22867. }
  22868. },
  22869. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22870. },
  22871. "PullReview": {
  22872. "description": "PullReview represents a pull request review",
  22873. "type": "object",
  22874. "properties": {
  22875. "body": {
  22876. "type": "string",
  22877. "x-go-name": "Body"
  22878. },
  22879. "comments_count": {
  22880. "type": "integer",
  22881. "format": "int64",
  22882. "x-go-name": "CodeCommentsCount"
  22883. },
  22884. "commit_id": {
  22885. "type": "string",
  22886. "x-go-name": "CommitID"
  22887. },
  22888. "dismissed": {
  22889. "type": "boolean",
  22890. "x-go-name": "Dismissed"
  22891. },
  22892. "html_url": {
  22893. "type": "string",
  22894. "x-go-name": "HTMLURL"
  22895. },
  22896. "id": {
  22897. "type": "integer",
  22898. "format": "int64",
  22899. "x-go-name": "ID"
  22900. },
  22901. "official": {
  22902. "type": "boolean",
  22903. "x-go-name": "Official"
  22904. },
  22905. "pull_request_url": {
  22906. "type": "string",
  22907. "x-go-name": "HTMLPullURL"
  22908. },
  22909. "stale": {
  22910. "type": "boolean",
  22911. "x-go-name": "Stale"
  22912. },
  22913. "state": {
  22914. "$ref": "#/definitions/ReviewStateType"
  22915. },
  22916. "submitted_at": {
  22917. "type": "string",
  22918. "format": "date-time",
  22919. "x-go-name": "Submitted"
  22920. },
  22921. "team": {
  22922. "$ref": "#/definitions/Team"
  22923. },
  22924. "updated_at": {
  22925. "type": "string",
  22926. "format": "date-time",
  22927. "x-go-name": "Updated"
  22928. },
  22929. "user": {
  22930. "$ref": "#/definitions/User"
  22931. }
  22932. },
  22933. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22934. },
  22935. "PullReviewComment": {
  22936. "description": "PullReviewComment represents a comment on a pull request review",
  22937. "type": "object",
  22938. "properties": {
  22939. "body": {
  22940. "type": "string",
  22941. "x-go-name": "Body"
  22942. },
  22943. "commit_id": {
  22944. "type": "string",
  22945. "x-go-name": "CommitID"
  22946. },
  22947. "created_at": {
  22948. "type": "string",
  22949. "format": "date-time",
  22950. "x-go-name": "Created"
  22951. },
  22952. "diff_hunk": {
  22953. "type": "string",
  22954. "x-go-name": "DiffHunk"
  22955. },
  22956. "html_url": {
  22957. "type": "string",
  22958. "x-go-name": "HTMLURL"
  22959. },
  22960. "id": {
  22961. "type": "integer",
  22962. "format": "int64",
  22963. "x-go-name": "ID"
  22964. },
  22965. "original_commit_id": {
  22966. "type": "string",
  22967. "x-go-name": "OrigCommitID"
  22968. },
  22969. "original_position": {
  22970. "type": "integer",
  22971. "format": "uint64",
  22972. "x-go-name": "OldLineNum"
  22973. },
  22974. "path": {
  22975. "type": "string",
  22976. "x-go-name": "Path"
  22977. },
  22978. "position": {
  22979. "type": "integer",
  22980. "format": "uint64",
  22981. "x-go-name": "LineNum"
  22982. },
  22983. "pull_request_review_id": {
  22984. "type": "integer",
  22985. "format": "int64",
  22986. "x-go-name": "ReviewID"
  22987. },
  22988. "pull_request_url": {
  22989. "type": "string",
  22990. "x-go-name": "HTMLPullURL"
  22991. },
  22992. "resolver": {
  22993. "$ref": "#/definitions/User"
  22994. },
  22995. "updated_at": {
  22996. "type": "string",
  22997. "format": "date-time",
  22998. "x-go-name": "Updated"
  22999. },
  23000. "user": {
  23001. "$ref": "#/definitions/User"
  23002. }
  23003. },
  23004. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23005. },
  23006. "PullReviewRequestOptions": {
  23007. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  23008. "type": "object",
  23009. "properties": {
  23010. "reviewers": {
  23011. "type": "array",
  23012. "items": {
  23013. "type": "string"
  23014. },
  23015. "x-go-name": "Reviewers"
  23016. },
  23017. "team_reviewers": {
  23018. "type": "array",
  23019. "items": {
  23020. "type": "string"
  23021. },
  23022. "x-go-name": "TeamReviewers"
  23023. }
  23024. },
  23025. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23026. },
  23027. "PushMirror": {
  23028. "description": "PushMirror represents information of a push mirror",
  23029. "type": "object",
  23030. "properties": {
  23031. "created": {
  23032. "type": "string",
  23033. "format": "date-time",
  23034. "x-go-name": "CreatedUnix"
  23035. },
  23036. "interval": {
  23037. "type": "string",
  23038. "x-go-name": "Interval"
  23039. },
  23040. "last_error": {
  23041. "type": "string",
  23042. "x-go-name": "LastError"
  23043. },
  23044. "last_update": {
  23045. "type": "string",
  23046. "format": "date-time",
  23047. "x-go-name": "LastUpdateUnix"
  23048. },
  23049. "remote_address": {
  23050. "type": "string",
  23051. "x-go-name": "RemoteAddress"
  23052. },
  23053. "remote_name": {
  23054. "type": "string",
  23055. "x-go-name": "RemoteName"
  23056. },
  23057. "repo_name": {
  23058. "type": "string",
  23059. "x-go-name": "RepoName"
  23060. },
  23061. "sync_on_commit": {
  23062. "type": "boolean",
  23063. "x-go-name": "SyncOnCommit"
  23064. }
  23065. },
  23066. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23067. },
  23068. "Reaction": {
  23069. "description": "Reaction contain one reaction",
  23070. "type": "object",
  23071. "properties": {
  23072. "content": {
  23073. "type": "string",
  23074. "x-go-name": "Reaction"
  23075. },
  23076. "created_at": {
  23077. "type": "string",
  23078. "format": "date-time",
  23079. "x-go-name": "Created"
  23080. },
  23081. "user": {
  23082. "$ref": "#/definitions/User"
  23083. }
  23084. },
  23085. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23086. },
  23087. "Reference": {
  23088. "type": "object",
  23089. "title": "Reference represents a Git reference.",
  23090. "properties": {
  23091. "object": {
  23092. "$ref": "#/definitions/GitObject"
  23093. },
  23094. "ref": {
  23095. "type": "string",
  23096. "x-go-name": "Ref"
  23097. },
  23098. "url": {
  23099. "type": "string",
  23100. "x-go-name": "URL"
  23101. }
  23102. },
  23103. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23104. },
  23105. "Release": {
  23106. "description": "Release represents a repository release",
  23107. "type": "object",
  23108. "properties": {
  23109. "assets": {
  23110. "type": "array",
  23111. "items": {
  23112. "$ref": "#/definitions/Attachment"
  23113. },
  23114. "x-go-name": "Attachments"
  23115. },
  23116. "author": {
  23117. "$ref": "#/definitions/User"
  23118. },
  23119. "body": {
  23120. "type": "string",
  23121. "x-go-name": "Note"
  23122. },
  23123. "created_at": {
  23124. "type": "string",
  23125. "format": "date-time",
  23126. "x-go-name": "CreatedAt"
  23127. },
  23128. "draft": {
  23129. "type": "boolean",
  23130. "x-go-name": "IsDraft"
  23131. },
  23132. "html_url": {
  23133. "type": "string",
  23134. "x-go-name": "HTMLURL"
  23135. },
  23136. "id": {
  23137. "type": "integer",
  23138. "format": "int64",
  23139. "x-go-name": "ID"
  23140. },
  23141. "name": {
  23142. "type": "string",
  23143. "x-go-name": "Title"
  23144. },
  23145. "prerelease": {
  23146. "type": "boolean",
  23147. "x-go-name": "IsPrerelease"
  23148. },
  23149. "published_at": {
  23150. "type": "string",
  23151. "format": "date-time",
  23152. "x-go-name": "PublishedAt"
  23153. },
  23154. "tag_name": {
  23155. "type": "string",
  23156. "x-go-name": "TagName"
  23157. },
  23158. "tarball_url": {
  23159. "type": "string",
  23160. "x-go-name": "TarURL"
  23161. },
  23162. "target_commitish": {
  23163. "type": "string",
  23164. "x-go-name": "Target"
  23165. },
  23166. "upload_url": {
  23167. "type": "string",
  23168. "x-go-name": "UploadURL"
  23169. },
  23170. "url": {
  23171. "type": "string",
  23172. "x-go-name": "URL"
  23173. },
  23174. "zipball_url": {
  23175. "type": "string",
  23176. "x-go-name": "ZipURL"
  23177. }
  23178. },
  23179. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23180. },
  23181. "RenameUserOption": {
  23182. "description": "RenameUserOption options when renaming a user",
  23183. "type": "object",
  23184. "required": [
  23185. "new_username"
  23186. ],
  23187. "properties": {
  23188. "new_username": {
  23189. "description": "New username for this user. This name cannot be in use yet by any other user.",
  23190. "type": "string",
  23191. "uniqueItems": true,
  23192. "x-go-name": "NewName"
  23193. }
  23194. },
  23195. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23196. },
  23197. "RepoCollaboratorPermission": {
  23198. "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
  23199. "type": "object",
  23200. "properties": {
  23201. "permission": {
  23202. "type": "string",
  23203. "x-go-name": "Permission"
  23204. },
  23205. "role_name": {
  23206. "type": "string",
  23207. "x-go-name": "RoleName"
  23208. },
  23209. "user": {
  23210. "$ref": "#/definitions/User"
  23211. }
  23212. },
  23213. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23214. },
  23215. "RepoCommit": {
  23216. "type": "object",
  23217. "title": "RepoCommit contains information of a commit in the context of a repository.",
  23218. "properties": {
  23219. "author": {
  23220. "$ref": "#/definitions/CommitUser"
  23221. },
  23222. "committer": {
  23223. "$ref": "#/definitions/CommitUser"
  23224. },
  23225. "message": {
  23226. "type": "string",
  23227. "x-go-name": "Message"
  23228. },
  23229. "tree": {
  23230. "$ref": "#/definitions/CommitMeta"
  23231. },
  23232. "url": {
  23233. "type": "string",
  23234. "x-go-name": "URL"
  23235. },
  23236. "verification": {
  23237. "$ref": "#/definitions/PayloadCommitVerification"
  23238. }
  23239. },
  23240. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23241. },
  23242. "RepoTopicOptions": {
  23243. "description": "RepoTopicOptions a collection of repo topic names",
  23244. "type": "object",
  23245. "properties": {
  23246. "topics": {
  23247. "description": "list of topic names",
  23248. "type": "array",
  23249. "items": {
  23250. "type": "string"
  23251. },
  23252. "x-go-name": "Topics"
  23253. }
  23254. },
  23255. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23256. },
  23257. "RepoTransfer": {
  23258. "description": "RepoTransfer represents a pending repo transfer",
  23259. "type": "object",
  23260. "properties": {
  23261. "doer": {
  23262. "$ref": "#/definitions/User"
  23263. },
  23264. "recipient": {
  23265. "$ref": "#/definitions/User"
  23266. },
  23267. "teams": {
  23268. "type": "array",
  23269. "items": {
  23270. "$ref": "#/definitions/Team"
  23271. },
  23272. "x-go-name": "Teams"
  23273. }
  23274. },
  23275. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23276. },
  23277. "Repository": {
  23278. "description": "Repository represents a repository",
  23279. "type": "object",
  23280. "properties": {
  23281. "allow_fast_forward_only_merge": {
  23282. "type": "boolean",
  23283. "x-go-name": "AllowFastForwardOnly"
  23284. },
  23285. "allow_merge_commits": {
  23286. "type": "boolean",
  23287. "x-go-name": "AllowMerge"
  23288. },
  23289. "allow_rebase": {
  23290. "type": "boolean",
  23291. "x-go-name": "AllowRebase"
  23292. },
  23293. "allow_rebase_explicit": {
  23294. "type": "boolean",
  23295. "x-go-name": "AllowRebaseMerge"
  23296. },
  23297. "allow_rebase_update": {
  23298. "type": "boolean",
  23299. "x-go-name": "AllowRebaseUpdate"
  23300. },
  23301. "allow_squash_merge": {
  23302. "type": "boolean",
  23303. "x-go-name": "AllowSquash"
  23304. },
  23305. "archived": {
  23306. "type": "boolean",
  23307. "x-go-name": "Archived"
  23308. },
  23309. "archived_at": {
  23310. "type": "string",
  23311. "format": "date-time",
  23312. "x-go-name": "ArchivedAt"
  23313. },
  23314. "avatar_url": {
  23315. "type": "string",
  23316. "x-go-name": "AvatarURL"
  23317. },
  23318. "clone_url": {
  23319. "type": "string",
  23320. "x-go-name": "CloneURL"
  23321. },
  23322. "created_at": {
  23323. "type": "string",
  23324. "format": "date-time",
  23325. "x-go-name": "Created"
  23326. },
  23327. "default_allow_maintainer_edit": {
  23328. "type": "boolean",
  23329. "x-go-name": "DefaultAllowMaintainerEdit"
  23330. },
  23331. "default_branch": {
  23332. "type": "string",
  23333. "x-go-name": "DefaultBranch"
  23334. },
  23335. "default_delete_branch_after_merge": {
  23336. "type": "boolean",
  23337. "x-go-name": "DefaultDeleteBranchAfterMerge"
  23338. },
  23339. "default_merge_style": {
  23340. "type": "string",
  23341. "x-go-name": "DefaultMergeStyle"
  23342. },
  23343. "description": {
  23344. "type": "string",
  23345. "x-go-name": "Description"
  23346. },
  23347. "empty": {
  23348. "type": "boolean",
  23349. "x-go-name": "Empty"
  23350. },
  23351. "external_tracker": {
  23352. "$ref": "#/definitions/ExternalTracker"
  23353. },
  23354. "external_wiki": {
  23355. "$ref": "#/definitions/ExternalWiki"
  23356. },
  23357. "fork": {
  23358. "type": "boolean",
  23359. "x-go-name": "Fork"
  23360. },
  23361. "forks_count": {
  23362. "type": "integer",
  23363. "format": "int64",
  23364. "x-go-name": "Forks"
  23365. },
  23366. "full_name": {
  23367. "type": "string",
  23368. "x-go-name": "FullName"
  23369. },
  23370. "has_actions": {
  23371. "type": "boolean",
  23372. "x-go-name": "HasActions"
  23373. },
  23374. "has_issues": {
  23375. "type": "boolean",
  23376. "x-go-name": "HasIssues"
  23377. },
  23378. "has_packages": {
  23379. "type": "boolean",
  23380. "x-go-name": "HasPackages"
  23381. },
  23382. "has_projects": {
  23383. "type": "boolean",
  23384. "x-go-name": "HasProjects"
  23385. },
  23386. "has_pull_requests": {
  23387. "type": "boolean",
  23388. "x-go-name": "HasPullRequests"
  23389. },
  23390. "has_releases": {
  23391. "type": "boolean",
  23392. "x-go-name": "HasReleases"
  23393. },
  23394. "has_wiki": {
  23395. "type": "boolean",
  23396. "x-go-name": "HasWiki"
  23397. },
  23398. "html_url": {
  23399. "type": "string",
  23400. "x-go-name": "HTMLURL"
  23401. },
  23402. "id": {
  23403. "type": "integer",
  23404. "format": "int64",
  23405. "x-go-name": "ID"
  23406. },
  23407. "ignore_whitespace_conflicts": {
  23408. "type": "boolean",
  23409. "x-go-name": "IgnoreWhitespaceConflicts"
  23410. },
  23411. "internal": {
  23412. "type": "boolean",
  23413. "x-go-name": "Internal"
  23414. },
  23415. "internal_tracker": {
  23416. "$ref": "#/definitions/InternalTracker"
  23417. },
  23418. "language": {
  23419. "type": "string",
  23420. "x-go-name": "Language"
  23421. },
  23422. "languages_url": {
  23423. "type": "string",
  23424. "x-go-name": "LanguagesURL"
  23425. },
  23426. "link": {
  23427. "type": "string",
  23428. "x-go-name": "Link"
  23429. },
  23430. "mirror": {
  23431. "type": "boolean",
  23432. "x-go-name": "Mirror"
  23433. },
  23434. "mirror_interval": {
  23435. "type": "string",
  23436. "x-go-name": "MirrorInterval"
  23437. },
  23438. "mirror_updated": {
  23439. "type": "string",
  23440. "format": "date-time",
  23441. "x-go-name": "MirrorUpdated"
  23442. },
  23443. "name": {
  23444. "type": "string",
  23445. "x-go-name": "Name"
  23446. },
  23447. "object_format_name": {
  23448. "description": "ObjectFormatName of the underlying git repository",
  23449. "type": "string",
  23450. "enum": [
  23451. "sha1",
  23452. "sha256"
  23453. ],
  23454. "x-go-name": "ObjectFormatName"
  23455. },
  23456. "open_issues_count": {
  23457. "type": "integer",
  23458. "format": "int64",
  23459. "x-go-name": "OpenIssues"
  23460. },
  23461. "open_pr_counter": {
  23462. "type": "integer",
  23463. "format": "int64",
  23464. "x-go-name": "OpenPulls"
  23465. },
  23466. "original_url": {
  23467. "type": "string",
  23468. "x-go-name": "OriginalURL"
  23469. },
  23470. "owner": {
  23471. "$ref": "#/definitions/User"
  23472. },
  23473. "parent": {
  23474. "$ref": "#/definitions/Repository"
  23475. },
  23476. "permissions": {
  23477. "$ref": "#/definitions/Permission"
  23478. },
  23479. "private": {
  23480. "type": "boolean",
  23481. "x-go-name": "Private"
  23482. },
  23483. "projects_mode": {
  23484. "type": "string",
  23485. "x-go-name": "ProjectsMode"
  23486. },
  23487. "release_counter": {
  23488. "type": "integer",
  23489. "format": "int64",
  23490. "x-go-name": "Releases"
  23491. },
  23492. "repo_transfer": {
  23493. "$ref": "#/definitions/RepoTransfer"
  23494. },
  23495. "size": {
  23496. "type": "integer",
  23497. "format": "int64",
  23498. "x-go-name": "Size"
  23499. },
  23500. "ssh_url": {
  23501. "type": "string",
  23502. "x-go-name": "SSHURL"
  23503. },
  23504. "stars_count": {
  23505. "type": "integer",
  23506. "format": "int64",
  23507. "x-go-name": "Stars"
  23508. },
  23509. "template": {
  23510. "type": "boolean",
  23511. "x-go-name": "Template"
  23512. },
  23513. "updated_at": {
  23514. "type": "string",
  23515. "format": "date-time",
  23516. "x-go-name": "Updated"
  23517. },
  23518. "url": {
  23519. "type": "string",
  23520. "x-go-name": "URL"
  23521. },
  23522. "watchers_count": {
  23523. "type": "integer",
  23524. "format": "int64",
  23525. "x-go-name": "Watchers"
  23526. },
  23527. "website": {
  23528. "type": "string",
  23529. "x-go-name": "Website"
  23530. }
  23531. },
  23532. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23533. },
  23534. "RepositoryMeta": {
  23535. "description": "RepositoryMeta basic repository information",
  23536. "type": "object",
  23537. "properties": {
  23538. "full_name": {
  23539. "type": "string",
  23540. "x-go-name": "FullName"
  23541. },
  23542. "id": {
  23543. "type": "integer",
  23544. "format": "int64",
  23545. "x-go-name": "ID"
  23546. },
  23547. "name": {
  23548. "type": "string",
  23549. "x-go-name": "Name"
  23550. },
  23551. "owner": {
  23552. "type": "string",
  23553. "x-go-name": "Owner"
  23554. }
  23555. },
  23556. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23557. },
  23558. "ReviewStateType": {
  23559. "description": "ReviewStateType review state type",
  23560. "type": "string",
  23561. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23562. },
  23563. "SearchResults": {
  23564. "description": "SearchResults results of a successful search",
  23565. "type": "object",
  23566. "properties": {
  23567. "data": {
  23568. "type": "array",
  23569. "items": {
  23570. "$ref": "#/definitions/Repository"
  23571. },
  23572. "x-go-name": "Data"
  23573. },
  23574. "ok": {
  23575. "type": "boolean",
  23576. "x-go-name": "OK"
  23577. }
  23578. },
  23579. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23580. },
  23581. "Secret": {
  23582. "description": "Secret represents a secret",
  23583. "type": "object",
  23584. "properties": {
  23585. "created_at": {
  23586. "type": "string",
  23587. "format": "date-time",
  23588. "x-go-name": "Created"
  23589. },
  23590. "name": {
  23591. "description": "the secret's name",
  23592. "type": "string",
  23593. "x-go-name": "Name"
  23594. }
  23595. },
  23596. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23597. },
  23598. "ServerVersion": {
  23599. "description": "ServerVersion wraps the version of the server",
  23600. "type": "object",
  23601. "properties": {
  23602. "version": {
  23603. "type": "string",
  23604. "x-go-name": "Version"
  23605. }
  23606. },
  23607. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23608. },
  23609. "StateType": {
  23610. "description": "StateType issue state type",
  23611. "type": "string",
  23612. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23613. },
  23614. "StopWatch": {
  23615. "description": "StopWatch represent a running stopwatch",
  23616. "type": "object",
  23617. "properties": {
  23618. "created": {
  23619. "type": "string",
  23620. "format": "date-time",
  23621. "x-go-name": "Created"
  23622. },
  23623. "duration": {
  23624. "type": "string",
  23625. "x-go-name": "Duration"
  23626. },
  23627. "issue_index": {
  23628. "type": "integer",
  23629. "format": "int64",
  23630. "x-go-name": "IssueIndex"
  23631. },
  23632. "issue_title": {
  23633. "type": "string",
  23634. "x-go-name": "IssueTitle"
  23635. },
  23636. "repo_name": {
  23637. "type": "string",
  23638. "x-go-name": "RepoName"
  23639. },
  23640. "repo_owner_name": {
  23641. "type": "string",
  23642. "x-go-name": "RepoOwnerName"
  23643. },
  23644. "seconds": {
  23645. "type": "integer",
  23646. "format": "int64",
  23647. "x-go-name": "Seconds"
  23648. }
  23649. },
  23650. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23651. },
  23652. "SubmitPullReviewOptions": {
  23653. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  23654. "type": "object",
  23655. "properties": {
  23656. "body": {
  23657. "type": "string",
  23658. "x-go-name": "Body"
  23659. },
  23660. "event": {
  23661. "$ref": "#/definitions/ReviewStateType"
  23662. }
  23663. },
  23664. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23665. },
  23666. "Tag": {
  23667. "description": "Tag represents a repository tag",
  23668. "type": "object",
  23669. "properties": {
  23670. "commit": {
  23671. "$ref": "#/definitions/CommitMeta"
  23672. },
  23673. "id": {
  23674. "type": "string",
  23675. "x-go-name": "ID"
  23676. },
  23677. "message": {
  23678. "type": "string",
  23679. "x-go-name": "Message"
  23680. },
  23681. "name": {
  23682. "type": "string",
  23683. "x-go-name": "Name"
  23684. },
  23685. "tarball_url": {
  23686. "type": "string",
  23687. "x-go-name": "TarballURL"
  23688. },
  23689. "zipball_url": {
  23690. "type": "string",
  23691. "x-go-name": "ZipballURL"
  23692. }
  23693. },
  23694. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23695. },
  23696. "Team": {
  23697. "description": "Team represents a team in an organization",
  23698. "type": "object",
  23699. "properties": {
  23700. "can_create_org_repo": {
  23701. "type": "boolean",
  23702. "x-go-name": "CanCreateOrgRepo"
  23703. },
  23704. "description": {
  23705. "type": "string",
  23706. "x-go-name": "Description"
  23707. },
  23708. "id": {
  23709. "type": "integer",
  23710. "format": "int64",
  23711. "x-go-name": "ID"
  23712. },
  23713. "includes_all_repositories": {
  23714. "type": "boolean",
  23715. "x-go-name": "IncludesAllRepositories"
  23716. },
  23717. "name": {
  23718. "type": "string",
  23719. "x-go-name": "Name"
  23720. },
  23721. "organization": {
  23722. "$ref": "#/definitions/Organization"
  23723. },
  23724. "permission": {
  23725. "type": "string",
  23726. "enum": [
  23727. "none",
  23728. "read",
  23729. "write",
  23730. "admin",
  23731. "owner"
  23732. ],
  23733. "x-go-name": "Permission"
  23734. },
  23735. "units": {
  23736. "type": "array",
  23737. "items": {
  23738. "type": "string"
  23739. },
  23740. "x-go-name": "Units",
  23741. "example": [
  23742. "repo.code",
  23743. "repo.issues",
  23744. "repo.ext_issues",
  23745. "repo.wiki",
  23746. "repo.pulls",
  23747. "repo.releases",
  23748. "repo.projects",
  23749. "repo.ext_wiki"
  23750. ]
  23751. },
  23752. "units_map": {
  23753. "type": "object",
  23754. "additionalProperties": {
  23755. "type": "string"
  23756. },
  23757. "x-go-name": "UnitsMap",
  23758. "example": {
  23759. "repo.code": "read",
  23760. "repo.ext_issues": "none",
  23761. "repo.ext_wiki": "none",
  23762. "repo.issues": "write",
  23763. "repo.projects": "none",
  23764. "repo.pulls": "owner",
  23765. "repo.releases": "none",
  23766. "repo.wiki": "admin"
  23767. }
  23768. }
  23769. },
  23770. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23771. },
  23772. "TimeStamp": {
  23773. "description": "TimeStamp defines a timestamp",
  23774. "type": "integer",
  23775. "format": "int64",
  23776. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  23777. },
  23778. "TimelineComment": {
  23779. "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
  23780. "type": "object",
  23781. "properties": {
  23782. "assignee": {
  23783. "$ref": "#/definitions/User"
  23784. },
  23785. "assignee_team": {
  23786. "$ref": "#/definitions/Team"
  23787. },
  23788. "body": {
  23789. "type": "string",
  23790. "x-go-name": "Body"
  23791. },
  23792. "created_at": {
  23793. "type": "string",
  23794. "format": "date-time",
  23795. "x-go-name": "Created"
  23796. },
  23797. "dependent_issue": {
  23798. "$ref": "#/definitions/Issue"
  23799. },
  23800. "html_url": {
  23801. "type": "string",
  23802. "x-go-name": "HTMLURL"
  23803. },
  23804. "id": {
  23805. "type": "integer",
  23806. "format": "int64",
  23807. "x-go-name": "ID"
  23808. },
  23809. "issue_url": {
  23810. "type": "string",
  23811. "x-go-name": "IssueURL"
  23812. },
  23813. "label": {
  23814. "$ref": "#/definitions/Label"
  23815. },
  23816. "milestone": {
  23817. "$ref": "#/definitions/Milestone"
  23818. },
  23819. "new_ref": {
  23820. "type": "string",
  23821. "x-go-name": "NewRef"
  23822. },
  23823. "new_title": {
  23824. "type": "string",
  23825. "x-go-name": "NewTitle"
  23826. },
  23827. "old_milestone": {
  23828. "$ref": "#/definitions/Milestone"
  23829. },
  23830. "old_project_id": {
  23831. "type": "integer",
  23832. "format": "int64",
  23833. "x-go-name": "OldProjectID"
  23834. },
  23835. "old_ref": {
  23836. "type": "string",
  23837. "x-go-name": "OldRef"
  23838. },
  23839. "old_title": {
  23840. "type": "string",
  23841. "x-go-name": "OldTitle"
  23842. },
  23843. "project_id": {
  23844. "type": "integer",
  23845. "format": "int64",
  23846. "x-go-name": "ProjectID"
  23847. },
  23848. "pull_request_url": {
  23849. "type": "string",
  23850. "x-go-name": "PRURL"
  23851. },
  23852. "ref_action": {
  23853. "type": "string",
  23854. "x-go-name": "RefAction"
  23855. },
  23856. "ref_comment": {
  23857. "$ref": "#/definitions/Comment"
  23858. },
  23859. "ref_commit_sha": {
  23860. "description": "commit SHA where issue/PR was referenced",
  23861. "type": "string",
  23862. "x-go-name": "RefCommitSHA"
  23863. },
  23864. "ref_issue": {
  23865. "$ref": "#/definitions/Issue"
  23866. },
  23867. "removed_assignee": {
  23868. "description": "whether the assignees were removed or added",
  23869. "type": "boolean",
  23870. "x-go-name": "RemovedAssignee"
  23871. },
  23872. "resolve_doer": {
  23873. "$ref": "#/definitions/User"
  23874. },
  23875. "review_id": {
  23876. "type": "integer",
  23877. "format": "int64",
  23878. "x-go-name": "ReviewID"
  23879. },
  23880. "tracked_time": {
  23881. "$ref": "#/definitions/TrackedTime"
  23882. },
  23883. "type": {
  23884. "type": "string",
  23885. "x-go-name": "Type"
  23886. },
  23887. "updated_at": {
  23888. "type": "string",
  23889. "format": "date-time",
  23890. "x-go-name": "Updated"
  23891. },
  23892. "user": {
  23893. "$ref": "#/definitions/User"
  23894. }
  23895. },
  23896. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23897. },
  23898. "TopicName": {
  23899. "description": "TopicName a list of repo topic names",
  23900. "type": "object",
  23901. "properties": {
  23902. "topics": {
  23903. "type": "array",
  23904. "items": {
  23905. "type": "string"
  23906. },
  23907. "x-go-name": "TopicNames"
  23908. }
  23909. },
  23910. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23911. },
  23912. "TopicResponse": {
  23913. "description": "TopicResponse for returning topics",
  23914. "type": "object",
  23915. "properties": {
  23916. "created": {
  23917. "type": "string",
  23918. "format": "date-time",
  23919. "x-go-name": "Created"
  23920. },
  23921. "id": {
  23922. "type": "integer",
  23923. "format": "int64",
  23924. "x-go-name": "ID"
  23925. },
  23926. "repo_count": {
  23927. "type": "integer",
  23928. "format": "int64",
  23929. "x-go-name": "RepoCount"
  23930. },
  23931. "topic_name": {
  23932. "type": "string",
  23933. "x-go-name": "Name"
  23934. },
  23935. "updated": {
  23936. "type": "string",
  23937. "format": "date-time",
  23938. "x-go-name": "Updated"
  23939. }
  23940. },
  23941. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23942. },
  23943. "TrackedTime": {
  23944. "description": "TrackedTime worked time for an issue / pr",
  23945. "type": "object",
  23946. "properties": {
  23947. "created": {
  23948. "type": "string",
  23949. "format": "date-time",
  23950. "x-go-name": "Created"
  23951. },
  23952. "id": {
  23953. "type": "integer",
  23954. "format": "int64",
  23955. "x-go-name": "ID"
  23956. },
  23957. "issue": {
  23958. "$ref": "#/definitions/Issue"
  23959. },
  23960. "issue_id": {
  23961. "description": "deprecated (only for backwards compatibility)",
  23962. "type": "integer",
  23963. "format": "int64",
  23964. "x-go-name": "IssueID"
  23965. },
  23966. "time": {
  23967. "description": "Time in seconds",
  23968. "type": "integer",
  23969. "format": "int64",
  23970. "x-go-name": "Time"
  23971. },
  23972. "user_id": {
  23973. "description": "deprecated (only for backwards compatibility)",
  23974. "type": "integer",
  23975. "format": "int64",
  23976. "x-go-name": "UserID"
  23977. },
  23978. "user_name": {
  23979. "type": "string",
  23980. "x-go-name": "UserName"
  23981. }
  23982. },
  23983. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23984. },
  23985. "TransferRepoOption": {
  23986. "description": "TransferRepoOption options when transfer a repository's ownership",
  23987. "type": "object",
  23988. "required": [
  23989. "new_owner"
  23990. ],
  23991. "properties": {
  23992. "new_owner": {
  23993. "type": "string",
  23994. "x-go-name": "NewOwner"
  23995. },
  23996. "team_ids": {
  23997. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  23998. "type": "array",
  23999. "items": {
  24000. "type": "integer",
  24001. "format": "int64"
  24002. },
  24003. "x-go-name": "TeamIDs"
  24004. }
  24005. },
  24006. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24007. },
  24008. "UpdateFileOptions": {
  24009. "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)",
  24010. "type": "object",
  24011. "required": [
  24012. "sha",
  24013. "content"
  24014. ],
  24015. "properties": {
  24016. "author": {
  24017. "$ref": "#/definitions/Identity"
  24018. },
  24019. "branch": {
  24020. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  24021. "type": "string",
  24022. "x-go-name": "BranchName"
  24023. },
  24024. "committer": {
  24025. "$ref": "#/definitions/Identity"
  24026. },
  24027. "content": {
  24028. "description": "content must be base64 encoded",
  24029. "type": "string",
  24030. "x-go-name": "ContentBase64"
  24031. },
  24032. "dates": {
  24033. "$ref": "#/definitions/CommitDateOptions"
  24034. },
  24035. "from_path": {
  24036. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  24037. "type": "string",
  24038. "x-go-name": "FromPath"
  24039. },
  24040. "message": {
  24041. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  24042. "type": "string",
  24043. "x-go-name": "Message"
  24044. },
  24045. "new_branch": {
  24046. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  24047. "type": "string",
  24048. "x-go-name": "NewBranchName"
  24049. },
  24050. "sha": {
  24051. "description": "sha is the SHA for the file that already exists",
  24052. "type": "string",
  24053. "x-go-name": "SHA"
  24054. },
  24055. "signoff": {
  24056. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  24057. "type": "boolean",
  24058. "x-go-name": "Signoff"
  24059. }
  24060. },
  24061. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24062. },
  24063. "UpdateRepoAvatarOption": {
  24064. "description": "UpdateRepoAvatarUserOption options when updating the repo avatar",
  24065. "type": "object",
  24066. "properties": {
  24067. "image": {
  24068. "description": "image must be base64 encoded",
  24069. "type": "string",
  24070. "x-go-name": "Image"
  24071. }
  24072. },
  24073. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24074. },
  24075. "UpdateUserAvatarOption": {
  24076. "description": "UpdateUserAvatarUserOption options when updating the user avatar",
  24077. "type": "object",
  24078. "properties": {
  24079. "image": {
  24080. "description": "image must be base64 encoded",
  24081. "type": "string",
  24082. "x-go-name": "Image"
  24083. }
  24084. },
  24085. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24086. },
  24087. "UpdateVariableOption": {
  24088. "description": "UpdateVariableOption the option when updating variable",
  24089. "type": "object",
  24090. "required": [
  24091. "value"
  24092. ],
  24093. "properties": {
  24094. "name": {
  24095. "description": "New name for the variable. If the field is empty, the variable name won't be updated.",
  24096. "type": "string",
  24097. "x-go-name": "Name"
  24098. },
  24099. "value": {
  24100. "description": "Value of the variable to update",
  24101. "type": "string",
  24102. "x-go-name": "Value"
  24103. }
  24104. },
  24105. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24106. },
  24107. "User": {
  24108. "description": "User represents a user",
  24109. "type": "object",
  24110. "properties": {
  24111. "active": {
  24112. "description": "Is user active",
  24113. "type": "boolean",
  24114. "x-go-name": "IsActive"
  24115. },
  24116. "avatar_url": {
  24117. "description": "URL to the user's avatar",
  24118. "type": "string",
  24119. "x-go-name": "AvatarURL"
  24120. },
  24121. "created": {
  24122. "type": "string",
  24123. "format": "date-time",
  24124. "x-go-name": "Created"
  24125. },
  24126. "description": {
  24127. "description": "the user's description",
  24128. "type": "string",
  24129. "x-go-name": "Description"
  24130. },
  24131. "email": {
  24132. "type": "string",
  24133. "format": "email",
  24134. "x-go-name": "Email"
  24135. },
  24136. "followers_count": {
  24137. "description": "user counts",
  24138. "type": "integer",
  24139. "format": "int64",
  24140. "x-go-name": "Followers"
  24141. },
  24142. "following_count": {
  24143. "type": "integer",
  24144. "format": "int64",
  24145. "x-go-name": "Following"
  24146. },
  24147. "full_name": {
  24148. "description": "the user's full name",
  24149. "type": "string",
  24150. "x-go-name": "FullName"
  24151. },
  24152. "id": {
  24153. "description": "the user's id",
  24154. "type": "integer",
  24155. "format": "int64",
  24156. "x-go-name": "ID"
  24157. },
  24158. "is_admin": {
  24159. "description": "Is the user an administrator",
  24160. "type": "boolean",
  24161. "x-go-name": "IsAdmin"
  24162. },
  24163. "language": {
  24164. "description": "User locale",
  24165. "type": "string",
  24166. "x-go-name": "Language"
  24167. },
  24168. "last_login": {
  24169. "type": "string",
  24170. "format": "date-time",
  24171. "x-go-name": "LastLogin"
  24172. },
  24173. "location": {
  24174. "description": "the user's location",
  24175. "type": "string",
  24176. "x-go-name": "Location"
  24177. },
  24178. "login": {
  24179. "description": "the user's username",
  24180. "type": "string",
  24181. "x-go-name": "UserName"
  24182. },
  24183. "login_name": {
  24184. "description": "the user's authentication sign-in name.",
  24185. "type": "string",
  24186. "default": "empty",
  24187. "x-go-name": "LoginName"
  24188. },
  24189. "prohibit_login": {
  24190. "description": "Is user login prohibited",
  24191. "type": "boolean",
  24192. "x-go-name": "ProhibitLogin"
  24193. },
  24194. "restricted": {
  24195. "description": "Is user restricted",
  24196. "type": "boolean",
  24197. "x-go-name": "Restricted"
  24198. },
  24199. "starred_repos_count": {
  24200. "type": "integer",
  24201. "format": "int64",
  24202. "x-go-name": "StarredRepos"
  24203. },
  24204. "visibility": {
  24205. "description": "User visibility level option: public, limited, private",
  24206. "type": "string",
  24207. "x-go-name": "Visibility"
  24208. },
  24209. "website": {
  24210. "description": "the user's website",
  24211. "type": "string",
  24212. "x-go-name": "Website"
  24213. }
  24214. },
  24215. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24216. },
  24217. "UserBadgeOption": {
  24218. "description": "UserBadgeOption options for link between users and badges",
  24219. "type": "object",
  24220. "properties": {
  24221. "badge_slugs": {
  24222. "type": "array",
  24223. "items": {
  24224. "type": "string"
  24225. },
  24226. "x-go-name": "BadgeSlugs",
  24227. "example": [
  24228. "badge1",
  24229. "badge2"
  24230. ]
  24231. }
  24232. },
  24233. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24234. },
  24235. "UserHeatmapData": {
  24236. "description": "UserHeatmapData represents the data needed to create a heatmap",
  24237. "type": "object",
  24238. "properties": {
  24239. "contributions": {
  24240. "type": "integer",
  24241. "format": "int64",
  24242. "x-go-name": "Contributions"
  24243. },
  24244. "timestamp": {
  24245. "$ref": "#/definitions/TimeStamp"
  24246. }
  24247. },
  24248. "x-go-package": "code.gitea.io/gitea/models/activities"
  24249. },
  24250. "UserSettings": {
  24251. "description": "UserSettings represents user settings",
  24252. "type": "object",
  24253. "properties": {
  24254. "description": {
  24255. "type": "string",
  24256. "x-go-name": "Description"
  24257. },
  24258. "diff_view_style": {
  24259. "type": "string",
  24260. "x-go-name": "DiffViewStyle"
  24261. },
  24262. "full_name": {
  24263. "type": "string",
  24264. "x-go-name": "FullName"
  24265. },
  24266. "hide_activity": {
  24267. "type": "boolean",
  24268. "x-go-name": "HideActivity"
  24269. },
  24270. "hide_email": {
  24271. "description": "Privacy",
  24272. "type": "boolean",
  24273. "x-go-name": "HideEmail"
  24274. },
  24275. "language": {
  24276. "type": "string",
  24277. "x-go-name": "Language"
  24278. },
  24279. "location": {
  24280. "type": "string",
  24281. "x-go-name": "Location"
  24282. },
  24283. "theme": {
  24284. "type": "string",
  24285. "x-go-name": "Theme"
  24286. },
  24287. "website": {
  24288. "type": "string",
  24289. "x-go-name": "Website"
  24290. }
  24291. },
  24292. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24293. },
  24294. "UserSettingsOptions": {
  24295. "description": "UserSettingsOptions represents options to change user settings",
  24296. "type": "object",
  24297. "properties": {
  24298. "description": {
  24299. "type": "string",
  24300. "x-go-name": "Description"
  24301. },
  24302. "diff_view_style": {
  24303. "type": "string",
  24304. "x-go-name": "DiffViewStyle"
  24305. },
  24306. "full_name": {
  24307. "type": "string",
  24308. "x-go-name": "FullName"
  24309. },
  24310. "hide_activity": {
  24311. "type": "boolean",
  24312. "x-go-name": "HideActivity"
  24313. },
  24314. "hide_email": {
  24315. "description": "Privacy",
  24316. "type": "boolean",
  24317. "x-go-name": "HideEmail"
  24318. },
  24319. "language": {
  24320. "type": "string",
  24321. "x-go-name": "Language"
  24322. },
  24323. "location": {
  24324. "type": "string",
  24325. "x-go-name": "Location"
  24326. },
  24327. "theme": {
  24328. "type": "string",
  24329. "x-go-name": "Theme"
  24330. },
  24331. "website": {
  24332. "type": "string",
  24333. "x-go-name": "Website"
  24334. }
  24335. },
  24336. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24337. },
  24338. "WatchInfo": {
  24339. "description": "WatchInfo represents an API watch status of one repository",
  24340. "type": "object",
  24341. "properties": {
  24342. "created_at": {
  24343. "type": "string",
  24344. "format": "date-time",
  24345. "x-go-name": "CreatedAt"
  24346. },
  24347. "ignored": {
  24348. "type": "boolean",
  24349. "x-go-name": "Ignored"
  24350. },
  24351. "reason": {
  24352. "x-go-name": "Reason"
  24353. },
  24354. "repository_url": {
  24355. "type": "string",
  24356. "x-go-name": "RepositoryURL"
  24357. },
  24358. "subscribed": {
  24359. "type": "boolean",
  24360. "x-go-name": "Subscribed"
  24361. },
  24362. "url": {
  24363. "type": "string",
  24364. "x-go-name": "URL"
  24365. }
  24366. },
  24367. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24368. },
  24369. "WikiCommit": {
  24370. "description": "WikiCommit page commit/revision",
  24371. "type": "object",
  24372. "properties": {
  24373. "author": {
  24374. "$ref": "#/definitions/CommitUser"
  24375. },
  24376. "commiter": {
  24377. "$ref": "#/definitions/CommitUser"
  24378. },
  24379. "message": {
  24380. "type": "string",
  24381. "x-go-name": "Message"
  24382. },
  24383. "sha": {
  24384. "type": "string",
  24385. "x-go-name": "ID"
  24386. }
  24387. },
  24388. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24389. },
  24390. "WikiCommitList": {
  24391. "description": "WikiCommitList commit/revision list",
  24392. "type": "object",
  24393. "properties": {
  24394. "commits": {
  24395. "type": "array",
  24396. "items": {
  24397. "$ref": "#/definitions/WikiCommit"
  24398. },
  24399. "x-go-name": "WikiCommits"
  24400. },
  24401. "count": {
  24402. "type": "integer",
  24403. "format": "int64",
  24404. "x-go-name": "Count"
  24405. }
  24406. },
  24407. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24408. },
  24409. "WikiPage": {
  24410. "description": "WikiPage a wiki page",
  24411. "type": "object",
  24412. "properties": {
  24413. "commit_count": {
  24414. "type": "integer",
  24415. "format": "int64",
  24416. "x-go-name": "CommitCount"
  24417. },
  24418. "content_base64": {
  24419. "description": "Page content, base64 encoded",
  24420. "type": "string",
  24421. "x-go-name": "ContentBase64"
  24422. },
  24423. "footer": {
  24424. "type": "string",
  24425. "x-go-name": "Footer"
  24426. },
  24427. "html_url": {
  24428. "type": "string",
  24429. "x-go-name": "HTMLURL"
  24430. },
  24431. "last_commit": {
  24432. "$ref": "#/definitions/WikiCommit"
  24433. },
  24434. "sidebar": {
  24435. "type": "string",
  24436. "x-go-name": "Sidebar"
  24437. },
  24438. "sub_url": {
  24439. "type": "string",
  24440. "x-go-name": "SubURL"
  24441. },
  24442. "title": {
  24443. "type": "string",
  24444. "x-go-name": "Title"
  24445. }
  24446. },
  24447. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24448. },
  24449. "WikiPageMetaData": {
  24450. "description": "WikiPageMetaData wiki page meta information",
  24451. "type": "object",
  24452. "properties": {
  24453. "html_url": {
  24454. "type": "string",
  24455. "x-go-name": "HTMLURL"
  24456. },
  24457. "last_commit": {
  24458. "$ref": "#/definitions/WikiCommit"
  24459. },
  24460. "sub_url": {
  24461. "type": "string",
  24462. "x-go-name": "SubURL"
  24463. },
  24464. "title": {
  24465. "type": "string",
  24466. "x-go-name": "Title"
  24467. }
  24468. },
  24469. "x-go-package": "code.gitea.io/gitea/modules/structs"
  24470. }
  24471. },
  24472. "responses": {
  24473. "AccessToken": {
  24474. "description": "AccessToken represents an API access token.",
  24475. "schema": {
  24476. "$ref": "#/definitions/AccessToken"
  24477. }
  24478. },
  24479. "AccessTokenList": {
  24480. "description": "AccessTokenList represents a list of API access token.",
  24481. "schema": {
  24482. "type": "array",
  24483. "items": {
  24484. "$ref": "#/definitions/AccessToken"
  24485. }
  24486. }
  24487. },
  24488. "ActionVariable": {
  24489. "description": "ActionVariable",
  24490. "schema": {
  24491. "$ref": "#/definitions/ActionVariable"
  24492. }
  24493. },
  24494. "ActivityFeedsList": {
  24495. "description": "ActivityFeedsList",
  24496. "schema": {
  24497. "type": "array",
  24498. "items": {
  24499. "$ref": "#/definitions/Activity"
  24500. }
  24501. }
  24502. },
  24503. "ActivityPub": {
  24504. "description": "ActivityPub",
  24505. "schema": {
  24506. "$ref": "#/definitions/ActivityPub"
  24507. }
  24508. },
  24509. "AnnotatedTag": {
  24510. "description": "AnnotatedTag",
  24511. "schema": {
  24512. "$ref": "#/definitions/AnnotatedTag"
  24513. }
  24514. },
  24515. "Attachment": {
  24516. "description": "Attachment",
  24517. "schema": {
  24518. "$ref": "#/definitions/Attachment"
  24519. }
  24520. },
  24521. "AttachmentList": {
  24522. "description": "AttachmentList",
  24523. "schema": {
  24524. "type": "array",
  24525. "items": {
  24526. "$ref": "#/definitions/Attachment"
  24527. }
  24528. }
  24529. },
  24530. "BadgeList": {
  24531. "description": "BadgeList",
  24532. "schema": {
  24533. "type": "array",
  24534. "items": {
  24535. "$ref": "#/definitions/Badge"
  24536. }
  24537. }
  24538. },
  24539. "Branch": {
  24540. "description": "Branch",
  24541. "schema": {
  24542. "$ref": "#/definitions/Branch"
  24543. }
  24544. },
  24545. "BranchList": {
  24546. "description": "BranchList",
  24547. "schema": {
  24548. "type": "array",
  24549. "items": {
  24550. "$ref": "#/definitions/Branch"
  24551. }
  24552. }
  24553. },
  24554. "BranchProtection": {
  24555. "description": "BranchProtection",
  24556. "schema": {
  24557. "$ref": "#/definitions/BranchProtection"
  24558. }
  24559. },
  24560. "BranchProtectionList": {
  24561. "description": "BranchProtectionList",
  24562. "schema": {
  24563. "type": "array",
  24564. "items": {
  24565. "$ref": "#/definitions/BranchProtection"
  24566. }
  24567. }
  24568. },
  24569. "ChangedFileList": {
  24570. "description": "ChangedFileList",
  24571. "schema": {
  24572. "type": "array",
  24573. "items": {
  24574. "$ref": "#/definitions/ChangedFile"
  24575. }
  24576. },
  24577. "headers": {
  24578. "X-HasMore": {
  24579. "type": "boolean",
  24580. "description": "True if there is another page"
  24581. },
  24582. "X-Page": {
  24583. "type": "integer",
  24584. "format": "int64",
  24585. "description": "The current page"
  24586. },
  24587. "X-PageCount": {
  24588. "type": "integer",
  24589. "format": "int64",
  24590. "description": "Total number of pages"
  24591. },
  24592. "X-PerPage": {
  24593. "type": "integer",
  24594. "format": "int64",
  24595. "description": "Commits per page"
  24596. },
  24597. "X-Total": {
  24598. "type": "integer",
  24599. "format": "int64",
  24600. "description": "Total commit count"
  24601. }
  24602. }
  24603. },
  24604. "CombinedStatus": {
  24605. "description": "CombinedStatus",
  24606. "schema": {
  24607. "$ref": "#/definitions/CombinedStatus"
  24608. }
  24609. },
  24610. "Comment": {
  24611. "description": "Comment",
  24612. "schema": {
  24613. "$ref": "#/definitions/Comment"
  24614. }
  24615. },
  24616. "CommentList": {
  24617. "description": "CommentList",
  24618. "schema": {
  24619. "type": "array",
  24620. "items": {
  24621. "$ref": "#/definitions/Comment"
  24622. }
  24623. }
  24624. },
  24625. "Commit": {
  24626. "description": "Commit",
  24627. "schema": {
  24628. "$ref": "#/definitions/Commit"
  24629. }
  24630. },
  24631. "CommitList": {
  24632. "description": "CommitList",
  24633. "schema": {
  24634. "type": "array",
  24635. "items": {
  24636. "$ref": "#/definitions/Commit"
  24637. }
  24638. },
  24639. "headers": {
  24640. "X-HasMore": {
  24641. "type": "boolean",
  24642. "description": "True if there is another page"
  24643. },
  24644. "X-Page": {
  24645. "type": "integer",
  24646. "format": "int64",
  24647. "description": "The current page"
  24648. },
  24649. "X-PageCount": {
  24650. "type": "integer",
  24651. "format": "int64",
  24652. "description": "Total number of pages"
  24653. },
  24654. "X-PerPage": {
  24655. "type": "integer",
  24656. "format": "int64",
  24657. "description": "Commits per page"
  24658. },
  24659. "X-Total": {
  24660. "type": "integer",
  24661. "format": "int64",
  24662. "description": "Total commit count"
  24663. }
  24664. }
  24665. },
  24666. "CommitStatus": {
  24667. "description": "CommitStatus",
  24668. "schema": {
  24669. "$ref": "#/definitions/CommitStatus"
  24670. }
  24671. },
  24672. "CommitStatusList": {
  24673. "description": "CommitStatusList",
  24674. "schema": {
  24675. "type": "array",
  24676. "items": {
  24677. "$ref": "#/definitions/CommitStatus"
  24678. }
  24679. }
  24680. },
  24681. "ContentsListResponse": {
  24682. "description": "ContentsListResponse",
  24683. "schema": {
  24684. "type": "array",
  24685. "items": {
  24686. "$ref": "#/definitions/ContentsResponse"
  24687. }
  24688. }
  24689. },
  24690. "ContentsResponse": {
  24691. "description": "ContentsResponse",
  24692. "schema": {
  24693. "$ref": "#/definitions/ContentsResponse"
  24694. }
  24695. },
  24696. "CronList": {
  24697. "description": "CronList",
  24698. "schema": {
  24699. "type": "array",
  24700. "items": {
  24701. "$ref": "#/definitions/Cron"
  24702. }
  24703. }
  24704. },
  24705. "DeployKey": {
  24706. "description": "DeployKey",
  24707. "schema": {
  24708. "$ref": "#/definitions/DeployKey"
  24709. }
  24710. },
  24711. "DeployKeyList": {
  24712. "description": "DeployKeyList",
  24713. "schema": {
  24714. "type": "array",
  24715. "items": {
  24716. "$ref": "#/definitions/DeployKey"
  24717. }
  24718. }
  24719. },
  24720. "EmailList": {
  24721. "description": "EmailList",
  24722. "schema": {
  24723. "type": "array",
  24724. "items": {
  24725. "$ref": "#/definitions/Email"
  24726. }
  24727. }
  24728. },
  24729. "EmptyRepository": {
  24730. "description": "EmptyRepository",
  24731. "schema": {
  24732. "$ref": "#/definitions/APIError"
  24733. }
  24734. },
  24735. "FileDeleteResponse": {
  24736. "description": "FileDeleteResponse",
  24737. "schema": {
  24738. "$ref": "#/definitions/FileDeleteResponse"
  24739. }
  24740. },
  24741. "FileResponse": {
  24742. "description": "FileResponse",
  24743. "schema": {
  24744. "$ref": "#/definitions/FileResponse"
  24745. }
  24746. },
  24747. "FilesResponse": {
  24748. "description": "FilesResponse",
  24749. "schema": {
  24750. "$ref": "#/definitions/FilesResponse"
  24751. }
  24752. },
  24753. "GPGKey": {
  24754. "description": "GPGKey",
  24755. "schema": {
  24756. "$ref": "#/definitions/GPGKey"
  24757. }
  24758. },
  24759. "GPGKeyList": {
  24760. "description": "GPGKeyList",
  24761. "schema": {
  24762. "type": "array",
  24763. "items": {
  24764. "$ref": "#/definitions/GPGKey"
  24765. }
  24766. }
  24767. },
  24768. "GeneralAPISettings": {
  24769. "description": "GeneralAPISettings",
  24770. "schema": {
  24771. "$ref": "#/definitions/GeneralAPISettings"
  24772. }
  24773. },
  24774. "GeneralAttachmentSettings": {
  24775. "description": "GeneralAttachmentSettings",
  24776. "schema": {
  24777. "$ref": "#/definitions/GeneralAttachmentSettings"
  24778. }
  24779. },
  24780. "GeneralRepoSettings": {
  24781. "description": "GeneralRepoSettings",
  24782. "schema": {
  24783. "$ref": "#/definitions/GeneralRepoSettings"
  24784. }
  24785. },
  24786. "GeneralUISettings": {
  24787. "description": "GeneralUISettings",
  24788. "schema": {
  24789. "$ref": "#/definitions/GeneralUISettings"
  24790. }
  24791. },
  24792. "GitBlobResponse": {
  24793. "description": "GitBlobResponse",
  24794. "schema": {
  24795. "$ref": "#/definitions/GitBlobResponse"
  24796. }
  24797. },
  24798. "GitHook": {
  24799. "description": "GitHook",
  24800. "schema": {
  24801. "$ref": "#/definitions/GitHook"
  24802. }
  24803. },
  24804. "GitHookList": {
  24805. "description": "GitHookList",
  24806. "schema": {
  24807. "type": "array",
  24808. "items": {
  24809. "$ref": "#/definitions/GitHook"
  24810. }
  24811. }
  24812. },
  24813. "GitTreeResponse": {
  24814. "description": "GitTreeResponse",
  24815. "schema": {
  24816. "$ref": "#/definitions/GitTreeResponse"
  24817. }
  24818. },
  24819. "GitignoreTemplateInfo": {
  24820. "description": "GitignoreTemplateInfo",
  24821. "schema": {
  24822. "$ref": "#/definitions/GitignoreTemplateInfo"
  24823. }
  24824. },
  24825. "GitignoreTemplateList": {
  24826. "description": "GitignoreTemplateList",
  24827. "schema": {
  24828. "type": "array",
  24829. "items": {
  24830. "type": "string"
  24831. }
  24832. }
  24833. },
  24834. "Hook": {
  24835. "description": "Hook",
  24836. "schema": {
  24837. "$ref": "#/definitions/Hook"
  24838. }
  24839. },
  24840. "HookList": {
  24841. "description": "HookList",
  24842. "schema": {
  24843. "type": "array",
  24844. "items": {
  24845. "$ref": "#/definitions/Hook"
  24846. }
  24847. }
  24848. },
  24849. "Issue": {
  24850. "description": "Issue",
  24851. "schema": {
  24852. "$ref": "#/definitions/Issue"
  24853. }
  24854. },
  24855. "IssueDeadline": {
  24856. "description": "IssueDeadline",
  24857. "schema": {
  24858. "$ref": "#/definitions/IssueDeadline"
  24859. }
  24860. },
  24861. "IssueList": {
  24862. "description": "IssueList",
  24863. "schema": {
  24864. "type": "array",
  24865. "items": {
  24866. "$ref": "#/definitions/Issue"
  24867. }
  24868. }
  24869. },
  24870. "IssueTemplates": {
  24871. "description": "IssueTemplates",
  24872. "schema": {
  24873. "type": "array",
  24874. "items": {
  24875. "$ref": "#/definitions/IssueTemplate"
  24876. }
  24877. }
  24878. },
  24879. "Label": {
  24880. "description": "Label",
  24881. "schema": {
  24882. "$ref": "#/definitions/Label"
  24883. }
  24884. },
  24885. "LabelList": {
  24886. "description": "LabelList",
  24887. "schema": {
  24888. "type": "array",
  24889. "items": {
  24890. "$ref": "#/definitions/Label"
  24891. }
  24892. }
  24893. },
  24894. "LabelTemplateInfo": {
  24895. "description": "LabelTemplateInfo",
  24896. "schema": {
  24897. "type": "array",
  24898. "items": {
  24899. "$ref": "#/definitions/LabelTemplate"
  24900. }
  24901. }
  24902. },
  24903. "LabelTemplateList": {
  24904. "description": "LabelTemplateList",
  24905. "schema": {
  24906. "type": "array",
  24907. "items": {
  24908. "type": "string"
  24909. }
  24910. }
  24911. },
  24912. "LanguageStatistics": {
  24913. "description": "LanguageStatistics",
  24914. "schema": {
  24915. "type": "object",
  24916. "additionalProperties": {
  24917. "type": "integer",
  24918. "format": "int64"
  24919. }
  24920. }
  24921. },
  24922. "LicenseTemplateInfo": {
  24923. "description": "LicenseTemplateInfo",
  24924. "schema": {
  24925. "$ref": "#/definitions/LicenseTemplateInfo"
  24926. }
  24927. },
  24928. "LicenseTemplateList": {
  24929. "description": "LicenseTemplateList",
  24930. "schema": {
  24931. "type": "array",
  24932. "items": {
  24933. "$ref": "#/definitions/LicensesTemplateListEntry"
  24934. }
  24935. }
  24936. },
  24937. "MarkdownRender": {
  24938. "description": "MarkdownRender is a rendered markdown document",
  24939. "schema": {
  24940. "type": "string"
  24941. }
  24942. },
  24943. "MarkupRender": {
  24944. "description": "MarkupRender is a rendered markup document",
  24945. "schema": {
  24946. "type": "string"
  24947. }
  24948. },
  24949. "Milestone": {
  24950. "description": "Milestone",
  24951. "schema": {
  24952. "$ref": "#/definitions/Milestone"
  24953. }
  24954. },
  24955. "MilestoneList": {
  24956. "description": "MilestoneList",
  24957. "schema": {
  24958. "type": "array",
  24959. "items": {
  24960. "$ref": "#/definitions/Milestone"
  24961. }
  24962. }
  24963. },
  24964. "NodeInfo": {
  24965. "description": "NodeInfo",
  24966. "schema": {
  24967. "$ref": "#/definitions/NodeInfo"
  24968. }
  24969. },
  24970. "Note": {
  24971. "description": "Note",
  24972. "schema": {
  24973. "$ref": "#/definitions/Note"
  24974. }
  24975. },
  24976. "NotificationCount": {
  24977. "description": "Number of unread notifications",
  24978. "schema": {
  24979. "$ref": "#/definitions/NotificationCount"
  24980. }
  24981. },
  24982. "NotificationThread": {
  24983. "description": "NotificationThread",
  24984. "schema": {
  24985. "$ref": "#/definitions/NotificationThread"
  24986. }
  24987. },
  24988. "NotificationThreadList": {
  24989. "description": "NotificationThreadList",
  24990. "schema": {
  24991. "type": "array",
  24992. "items": {
  24993. "$ref": "#/definitions/NotificationThread"
  24994. }
  24995. }
  24996. },
  24997. "OAuth2Application": {
  24998. "description": "OAuth2Application",
  24999. "schema": {
  25000. "$ref": "#/definitions/OAuth2Application"
  25001. }
  25002. },
  25003. "OAuth2ApplicationList": {
  25004. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  25005. "schema": {
  25006. "type": "array",
  25007. "items": {
  25008. "$ref": "#/definitions/OAuth2Application"
  25009. }
  25010. }
  25011. },
  25012. "Organization": {
  25013. "description": "Organization",
  25014. "schema": {
  25015. "$ref": "#/definitions/Organization"
  25016. }
  25017. },
  25018. "OrganizationList": {
  25019. "description": "OrganizationList",
  25020. "schema": {
  25021. "type": "array",
  25022. "items": {
  25023. "$ref": "#/definitions/Organization"
  25024. }
  25025. }
  25026. },
  25027. "OrganizationPermissions": {
  25028. "description": "OrganizationPermissions",
  25029. "schema": {
  25030. "$ref": "#/definitions/OrganizationPermissions"
  25031. }
  25032. },
  25033. "Package": {
  25034. "description": "Package",
  25035. "schema": {
  25036. "$ref": "#/definitions/Package"
  25037. }
  25038. },
  25039. "PackageFileList": {
  25040. "description": "PackageFileList",
  25041. "schema": {
  25042. "type": "array",
  25043. "items": {
  25044. "$ref": "#/definitions/PackageFile"
  25045. }
  25046. }
  25047. },
  25048. "PackageList": {
  25049. "description": "PackageList",
  25050. "schema": {
  25051. "type": "array",
  25052. "items": {
  25053. "$ref": "#/definitions/Package"
  25054. }
  25055. }
  25056. },
  25057. "PublicKey": {
  25058. "description": "PublicKey",
  25059. "schema": {
  25060. "$ref": "#/definitions/PublicKey"
  25061. }
  25062. },
  25063. "PublicKeyList": {
  25064. "description": "PublicKeyList",
  25065. "schema": {
  25066. "type": "array",
  25067. "items": {
  25068. "$ref": "#/definitions/PublicKey"
  25069. }
  25070. }
  25071. },
  25072. "PullRequest": {
  25073. "description": "PullRequest",
  25074. "schema": {
  25075. "$ref": "#/definitions/PullRequest"
  25076. }
  25077. },
  25078. "PullRequestList": {
  25079. "description": "PullRequestList",
  25080. "schema": {
  25081. "type": "array",
  25082. "items": {
  25083. "$ref": "#/definitions/PullRequest"
  25084. }
  25085. }
  25086. },
  25087. "PullReview": {
  25088. "description": "PullReview",
  25089. "schema": {
  25090. "$ref": "#/definitions/PullReview"
  25091. }
  25092. },
  25093. "PullReviewComment": {
  25094. "description": "PullComment",
  25095. "schema": {
  25096. "$ref": "#/definitions/PullReviewComment"
  25097. }
  25098. },
  25099. "PullReviewCommentList": {
  25100. "description": "PullCommentList",
  25101. "schema": {
  25102. "type": "array",
  25103. "items": {
  25104. "$ref": "#/definitions/PullReviewComment"
  25105. }
  25106. }
  25107. },
  25108. "PullReviewList": {
  25109. "description": "PullReviewList",
  25110. "schema": {
  25111. "type": "array",
  25112. "items": {
  25113. "$ref": "#/definitions/PullReview"
  25114. }
  25115. }
  25116. },
  25117. "PushMirror": {
  25118. "description": "PushMirror",
  25119. "schema": {
  25120. "$ref": "#/definitions/PushMirror"
  25121. }
  25122. },
  25123. "PushMirrorList": {
  25124. "description": "PushMirrorList",
  25125. "schema": {
  25126. "type": "array",
  25127. "items": {
  25128. "$ref": "#/definitions/PushMirror"
  25129. }
  25130. }
  25131. },
  25132. "Reaction": {
  25133. "description": "Reaction",
  25134. "schema": {
  25135. "$ref": "#/definitions/Reaction"
  25136. }
  25137. },
  25138. "ReactionList": {
  25139. "description": "ReactionList",
  25140. "schema": {
  25141. "type": "array",
  25142. "items": {
  25143. "$ref": "#/definitions/Reaction"
  25144. }
  25145. }
  25146. },
  25147. "Reference": {
  25148. "description": "Reference",
  25149. "schema": {
  25150. "$ref": "#/definitions/Reference"
  25151. }
  25152. },
  25153. "ReferenceList": {
  25154. "description": "ReferenceList",
  25155. "schema": {
  25156. "type": "array",
  25157. "items": {
  25158. "$ref": "#/definitions/Reference"
  25159. }
  25160. }
  25161. },
  25162. "RegistrationToken": {
  25163. "description": "RegistrationToken is response related to registeration token",
  25164. "headers": {
  25165. "token": {
  25166. "type": "string"
  25167. }
  25168. }
  25169. },
  25170. "Release": {
  25171. "description": "Release",
  25172. "schema": {
  25173. "$ref": "#/definitions/Release"
  25174. }
  25175. },
  25176. "ReleaseList": {
  25177. "description": "ReleaseList",
  25178. "schema": {
  25179. "type": "array",
  25180. "items": {
  25181. "$ref": "#/definitions/Release"
  25182. }
  25183. }
  25184. },
  25185. "RepoCollaboratorPermission": {
  25186. "description": "RepoCollaboratorPermission",
  25187. "schema": {
  25188. "$ref": "#/definitions/RepoCollaboratorPermission"
  25189. }
  25190. },
  25191. "RepoIssueConfig": {
  25192. "description": "RepoIssueConfig",
  25193. "schema": {
  25194. "$ref": "#/definitions/IssueConfig"
  25195. }
  25196. },
  25197. "RepoIssueConfigValidation": {
  25198. "description": "RepoIssueConfigValidation",
  25199. "schema": {
  25200. "$ref": "#/definitions/IssueConfigValidation"
  25201. }
  25202. },
  25203. "RepoNewIssuePinsAllowed": {
  25204. "description": "RepoNewIssuePinsAllowed",
  25205. "schema": {
  25206. "$ref": "#/definitions/NewIssuePinsAllowed"
  25207. }
  25208. },
  25209. "Repository": {
  25210. "description": "Repository",
  25211. "schema": {
  25212. "$ref": "#/definitions/Repository"
  25213. }
  25214. },
  25215. "RepositoryList": {
  25216. "description": "RepositoryList",
  25217. "schema": {
  25218. "type": "array",
  25219. "items": {
  25220. "$ref": "#/definitions/Repository"
  25221. }
  25222. }
  25223. },
  25224. "SearchResults": {
  25225. "description": "SearchResults",
  25226. "schema": {
  25227. "$ref": "#/definitions/SearchResults"
  25228. }
  25229. },
  25230. "Secret": {
  25231. "description": "Secret",
  25232. "schema": {
  25233. "$ref": "#/definitions/Secret"
  25234. }
  25235. },
  25236. "SecretList": {
  25237. "description": "SecretList",
  25238. "schema": {
  25239. "type": "array",
  25240. "items": {
  25241. "$ref": "#/definitions/Secret"
  25242. }
  25243. }
  25244. },
  25245. "ServerVersion": {
  25246. "description": "ServerVersion",
  25247. "schema": {
  25248. "$ref": "#/definitions/ServerVersion"
  25249. }
  25250. },
  25251. "StopWatch": {
  25252. "description": "StopWatch",
  25253. "schema": {
  25254. "$ref": "#/definitions/StopWatch"
  25255. }
  25256. },
  25257. "StopWatchList": {
  25258. "description": "StopWatchList",
  25259. "schema": {
  25260. "type": "array",
  25261. "items": {
  25262. "$ref": "#/definitions/StopWatch"
  25263. }
  25264. }
  25265. },
  25266. "StringSlice": {
  25267. "description": "StringSlice",
  25268. "schema": {
  25269. "type": "array",
  25270. "items": {
  25271. "type": "string"
  25272. }
  25273. }
  25274. },
  25275. "Tag": {
  25276. "description": "Tag",
  25277. "schema": {
  25278. "$ref": "#/definitions/Tag"
  25279. }
  25280. },
  25281. "TagList": {
  25282. "description": "TagList",
  25283. "schema": {
  25284. "type": "array",
  25285. "items": {
  25286. "$ref": "#/definitions/Tag"
  25287. }
  25288. }
  25289. },
  25290. "Team": {
  25291. "description": "Team",
  25292. "schema": {
  25293. "$ref": "#/definitions/Team"
  25294. }
  25295. },
  25296. "TeamList": {
  25297. "description": "TeamList",
  25298. "schema": {
  25299. "type": "array",
  25300. "items": {
  25301. "$ref": "#/definitions/Team"
  25302. }
  25303. }
  25304. },
  25305. "TimelineList": {
  25306. "description": "TimelineList",
  25307. "schema": {
  25308. "type": "array",
  25309. "items": {
  25310. "$ref": "#/definitions/TimelineComment"
  25311. }
  25312. }
  25313. },
  25314. "TopicListResponse": {
  25315. "description": "TopicListResponse",
  25316. "schema": {
  25317. "type": "array",
  25318. "items": {
  25319. "$ref": "#/definitions/TopicResponse"
  25320. }
  25321. }
  25322. },
  25323. "TopicNames": {
  25324. "description": "TopicNames",
  25325. "schema": {
  25326. "$ref": "#/definitions/TopicName"
  25327. }
  25328. },
  25329. "TrackedTime": {
  25330. "description": "TrackedTime",
  25331. "schema": {
  25332. "$ref": "#/definitions/TrackedTime"
  25333. }
  25334. },
  25335. "TrackedTimeList": {
  25336. "description": "TrackedTimeList",
  25337. "schema": {
  25338. "type": "array",
  25339. "items": {
  25340. "$ref": "#/definitions/TrackedTime"
  25341. }
  25342. }
  25343. },
  25344. "User": {
  25345. "description": "User",
  25346. "schema": {
  25347. "$ref": "#/definitions/User"
  25348. }
  25349. },
  25350. "UserHeatmapData": {
  25351. "description": "UserHeatmapData",
  25352. "schema": {
  25353. "type": "array",
  25354. "items": {
  25355. "$ref": "#/definitions/UserHeatmapData"
  25356. }
  25357. }
  25358. },
  25359. "UserList": {
  25360. "description": "UserList",
  25361. "schema": {
  25362. "type": "array",
  25363. "items": {
  25364. "$ref": "#/definitions/User"
  25365. }
  25366. }
  25367. },
  25368. "UserSettings": {
  25369. "description": "UserSettings",
  25370. "schema": {
  25371. "type": "array",
  25372. "items": {
  25373. "$ref": "#/definitions/UserSettings"
  25374. }
  25375. }
  25376. },
  25377. "VariableList": {
  25378. "description": "VariableList",
  25379. "schema": {
  25380. "type": "array",
  25381. "items": {
  25382. "$ref": "#/definitions/ActionVariable"
  25383. }
  25384. }
  25385. },
  25386. "WatchInfo": {
  25387. "description": "WatchInfo",
  25388. "schema": {
  25389. "$ref": "#/definitions/WatchInfo"
  25390. }
  25391. },
  25392. "WikiCommitList": {
  25393. "description": "WikiCommitList",
  25394. "schema": {
  25395. "$ref": "#/definitions/WikiCommitList"
  25396. }
  25397. },
  25398. "WikiPage": {
  25399. "description": "WikiPage",
  25400. "schema": {
  25401. "$ref": "#/definitions/WikiPage"
  25402. }
  25403. },
  25404. "WikiPageList": {
  25405. "description": "WikiPageList",
  25406. "schema": {
  25407. "type": "array",
  25408. "items": {
  25409. "$ref": "#/definitions/WikiPageMetaData"
  25410. }
  25411. }
  25412. },
  25413. "conflict": {
  25414. "description": "APIConflict is a conflict empty response"
  25415. },
  25416. "empty": {
  25417. "description": "APIEmpty is an empty response"
  25418. },
  25419. "error": {
  25420. "description": "APIError is error format response",
  25421. "headers": {
  25422. "message": {
  25423. "type": "string"
  25424. },
  25425. "url": {
  25426. "type": "string"
  25427. }
  25428. }
  25429. },
  25430. "forbidden": {
  25431. "description": "APIForbiddenError is a forbidden error response",
  25432. "headers": {
  25433. "message": {
  25434. "type": "string"
  25435. },
  25436. "url": {
  25437. "type": "string"
  25438. }
  25439. }
  25440. },
  25441. "invalidTopicsError": {
  25442. "description": "APIInvalidTopicsError is error format response to invalid topics",
  25443. "headers": {
  25444. "invalidTopics": {
  25445. "type": "array",
  25446. "items": {
  25447. "type": "string"
  25448. }
  25449. },
  25450. "message": {
  25451. "type": "string"
  25452. }
  25453. }
  25454. },
  25455. "notFound": {
  25456. "description": "APINotFound is a not found empty response"
  25457. },
  25458. "parameterBodies": {
  25459. "description": "parameterBodies",
  25460. "schema": {
  25461. "$ref": "#/definitions/UpdateVariableOption"
  25462. }
  25463. },
  25464. "redirect": {
  25465. "description": "APIRedirect is a redirect response"
  25466. },
  25467. "repoArchivedError": {
  25468. "description": "APIRepoArchivedError is an error that is raised when an archived repo should be modified",
  25469. "headers": {
  25470. "message": {
  25471. "type": "string"
  25472. },
  25473. "url": {
  25474. "type": "string"
  25475. }
  25476. }
  25477. },
  25478. "string": {
  25479. "description": "APIString is a string response",
  25480. "schema": {
  25481. "type": "string"
  25482. }
  25483. },
  25484. "validationError": {
  25485. "description": "APIValidationError is error format response related to input validation",
  25486. "headers": {
  25487. "message": {
  25488. "type": "string"
  25489. },
  25490. "url": {
  25491. "type": "string"
  25492. }
  25493. }
  25494. }
  25495. },
  25496. "securityDefinitions": {
  25497. "AccessToken": {
  25498. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  25499. "type": "apiKey",
  25500. "name": "access_token",
  25501. "in": "query"
  25502. },
  25503. "AuthorizationHeaderToken": {
  25504. "description": "API tokens must be prepended with \"token\" followed by a space.",
  25505. "type": "apiKey",
  25506. "name": "Authorization",
  25507. "in": "header"
  25508. },
  25509. "BasicAuth": {
  25510. "type": "basic"
  25511. },
  25512. "SudoHeader": {
  25513. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  25514. "type": "apiKey",
  25515. "name": "Sudo",
  25516. "in": "header"
  25517. },
  25518. "SudoParam": {
  25519. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  25520. "type": "apiKey",
  25521. "name": "sudo",
  25522. "in": "query"
  25523. },
  25524. "TOTPHeader": {
  25525. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  25526. "type": "apiKey",
  25527. "name": "X-GITEA-OTP",
  25528. "in": "header"
  25529. },
  25530. "Token": {
  25531. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  25532. "type": "apiKey",
  25533. "name": "token",
  25534. "in": "query"
  25535. }
  25536. },
  25537. "security": [
  25538. {
  25539. "BasicAuth": []
  25540. },
  25541. {
  25542. "Token": []
  25543. },
  25544. {
  25545. "AccessToken": []
  25546. },
  25547. {
  25548. "AuthorizationHeaderToken": []
  25549. },
  25550. {
  25551. "SudoParam": []
  25552. },
  25553. {
  25554. "SudoHeader": []
  25555. },
  25556. {
  25557. "TOTPHeader": []
  25558. }
  25559. ]
  25560. }