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

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812
  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}/activities/feeds": {
  1848. "get": {
  1849. "produces": [
  1850. "application/json"
  1851. ],
  1852. "tags": [
  1853. "organization"
  1854. ],
  1855. "summary": "List an organization's activity feeds",
  1856. "operationId": "orgListActivityFeeds",
  1857. "parameters": [
  1858. {
  1859. "type": "string",
  1860. "description": "name of the org",
  1861. "name": "org",
  1862. "in": "path",
  1863. "required": true
  1864. },
  1865. {
  1866. "type": "string",
  1867. "format": "date",
  1868. "description": "the date of the activities to be found",
  1869. "name": "date",
  1870. "in": "query"
  1871. },
  1872. {
  1873. "type": "integer",
  1874. "description": "page number of results to return (1-based)",
  1875. "name": "page",
  1876. "in": "query"
  1877. },
  1878. {
  1879. "type": "integer",
  1880. "description": "page size of results",
  1881. "name": "limit",
  1882. "in": "query"
  1883. }
  1884. ],
  1885. "responses": {
  1886. "200": {
  1887. "$ref": "#/responses/ActivityFeedsList"
  1888. },
  1889. "404": {
  1890. "$ref": "#/responses/notFound"
  1891. }
  1892. }
  1893. }
  1894. },
  1895. "/orgs/{org}/avatar": {
  1896. "post": {
  1897. "produces": [
  1898. "application/json"
  1899. ],
  1900. "tags": [
  1901. "organization"
  1902. ],
  1903. "summary": "Update Avatar",
  1904. "operationId": "orgUpdateAvatar",
  1905. "parameters": [
  1906. {
  1907. "type": "string",
  1908. "description": "name of the organization",
  1909. "name": "org",
  1910. "in": "path",
  1911. "required": true
  1912. },
  1913. {
  1914. "name": "body",
  1915. "in": "body",
  1916. "schema": {
  1917. "$ref": "#/definitions/UpdateUserAvatarOption"
  1918. }
  1919. }
  1920. ],
  1921. "responses": {
  1922. "204": {
  1923. "$ref": "#/responses/empty"
  1924. },
  1925. "404": {
  1926. "$ref": "#/responses/notFound"
  1927. }
  1928. }
  1929. },
  1930. "delete": {
  1931. "produces": [
  1932. "application/json"
  1933. ],
  1934. "tags": [
  1935. "organization"
  1936. ],
  1937. "summary": "Delete Avatar",
  1938. "operationId": "orgDeleteAvatar",
  1939. "parameters": [
  1940. {
  1941. "type": "string",
  1942. "description": "name of the organization",
  1943. "name": "org",
  1944. "in": "path",
  1945. "required": true
  1946. }
  1947. ],
  1948. "responses": {
  1949. "204": {
  1950. "$ref": "#/responses/empty"
  1951. },
  1952. "404": {
  1953. "$ref": "#/responses/notFound"
  1954. }
  1955. }
  1956. }
  1957. },
  1958. "/orgs/{org}/blocks": {
  1959. "get": {
  1960. "produces": [
  1961. "application/json"
  1962. ],
  1963. "tags": [
  1964. "organization"
  1965. ],
  1966. "summary": "List users blocked by the organization",
  1967. "operationId": "organizationListBlocks",
  1968. "parameters": [
  1969. {
  1970. "type": "string",
  1971. "description": "name of the organization",
  1972. "name": "org",
  1973. "in": "path",
  1974. "required": true
  1975. },
  1976. {
  1977. "type": "integer",
  1978. "description": "page number of results to return (1-based)",
  1979. "name": "page",
  1980. "in": "query"
  1981. },
  1982. {
  1983. "type": "integer",
  1984. "description": "page size of results",
  1985. "name": "limit",
  1986. "in": "query"
  1987. }
  1988. ],
  1989. "responses": {
  1990. "200": {
  1991. "$ref": "#/responses/UserList"
  1992. }
  1993. }
  1994. }
  1995. },
  1996. "/orgs/{org}/blocks/{username}": {
  1997. "get": {
  1998. "tags": [
  1999. "organization"
  2000. ],
  2001. "summary": "Check if a user is blocked by the organization",
  2002. "operationId": "organizationCheckUserBlock",
  2003. "parameters": [
  2004. {
  2005. "type": "string",
  2006. "description": "name of the organization",
  2007. "name": "org",
  2008. "in": "path",
  2009. "required": true
  2010. },
  2011. {
  2012. "type": "string",
  2013. "description": "user to check",
  2014. "name": "username",
  2015. "in": "path",
  2016. "required": true
  2017. }
  2018. ],
  2019. "responses": {
  2020. "204": {
  2021. "$ref": "#/responses/empty"
  2022. },
  2023. "404": {
  2024. "$ref": "#/responses/notFound"
  2025. }
  2026. }
  2027. },
  2028. "put": {
  2029. "tags": [
  2030. "organization"
  2031. ],
  2032. "summary": "Block a user",
  2033. "operationId": "organizationBlockUser",
  2034. "parameters": [
  2035. {
  2036. "type": "string",
  2037. "description": "name of the organization",
  2038. "name": "org",
  2039. "in": "path",
  2040. "required": true
  2041. },
  2042. {
  2043. "type": "string",
  2044. "description": "user to block",
  2045. "name": "username",
  2046. "in": "path",
  2047. "required": true
  2048. },
  2049. {
  2050. "type": "string",
  2051. "description": "optional note for the block",
  2052. "name": "note",
  2053. "in": "query"
  2054. }
  2055. ],
  2056. "responses": {
  2057. "204": {
  2058. "$ref": "#/responses/empty"
  2059. },
  2060. "404": {
  2061. "$ref": "#/responses/notFound"
  2062. },
  2063. "422": {
  2064. "$ref": "#/responses/validationError"
  2065. }
  2066. }
  2067. },
  2068. "delete": {
  2069. "tags": [
  2070. "organization"
  2071. ],
  2072. "summary": "Unblock a user",
  2073. "operationId": "organizationUnblockUser",
  2074. "parameters": [
  2075. {
  2076. "type": "string",
  2077. "description": "name of the organization",
  2078. "name": "org",
  2079. "in": "path",
  2080. "required": true
  2081. },
  2082. {
  2083. "type": "string",
  2084. "description": "user to unblock",
  2085. "name": "username",
  2086. "in": "path",
  2087. "required": true
  2088. }
  2089. ],
  2090. "responses": {
  2091. "204": {
  2092. "$ref": "#/responses/empty"
  2093. },
  2094. "404": {
  2095. "$ref": "#/responses/notFound"
  2096. },
  2097. "422": {
  2098. "$ref": "#/responses/validationError"
  2099. }
  2100. }
  2101. }
  2102. },
  2103. "/orgs/{org}/hooks": {
  2104. "get": {
  2105. "produces": [
  2106. "application/json"
  2107. ],
  2108. "tags": [
  2109. "organization"
  2110. ],
  2111. "summary": "List an organization's webhooks",
  2112. "operationId": "orgListHooks",
  2113. "parameters": [
  2114. {
  2115. "type": "string",
  2116. "description": "name of the organization",
  2117. "name": "org",
  2118. "in": "path",
  2119. "required": true
  2120. },
  2121. {
  2122. "type": "integer",
  2123. "description": "page number of results to return (1-based)",
  2124. "name": "page",
  2125. "in": "query"
  2126. },
  2127. {
  2128. "type": "integer",
  2129. "description": "page size of results",
  2130. "name": "limit",
  2131. "in": "query"
  2132. }
  2133. ],
  2134. "responses": {
  2135. "200": {
  2136. "$ref": "#/responses/HookList"
  2137. },
  2138. "404": {
  2139. "$ref": "#/responses/notFound"
  2140. }
  2141. }
  2142. },
  2143. "post": {
  2144. "consumes": [
  2145. "application/json"
  2146. ],
  2147. "produces": [
  2148. "application/json"
  2149. ],
  2150. "tags": [
  2151. "organization"
  2152. ],
  2153. "summary": "Create a hook",
  2154. "operationId": "orgCreateHook",
  2155. "parameters": [
  2156. {
  2157. "type": "string",
  2158. "description": "name of the organization",
  2159. "name": "org",
  2160. "in": "path",
  2161. "required": true
  2162. },
  2163. {
  2164. "name": "body",
  2165. "in": "body",
  2166. "required": true,
  2167. "schema": {
  2168. "$ref": "#/definitions/CreateHookOption"
  2169. }
  2170. }
  2171. ],
  2172. "responses": {
  2173. "201": {
  2174. "$ref": "#/responses/Hook"
  2175. },
  2176. "404": {
  2177. "$ref": "#/responses/notFound"
  2178. }
  2179. }
  2180. }
  2181. },
  2182. "/orgs/{org}/hooks/{id}": {
  2183. "get": {
  2184. "produces": [
  2185. "application/json"
  2186. ],
  2187. "tags": [
  2188. "organization"
  2189. ],
  2190. "summary": "Get a hook",
  2191. "operationId": "orgGetHook",
  2192. "parameters": [
  2193. {
  2194. "type": "string",
  2195. "description": "name of the organization",
  2196. "name": "org",
  2197. "in": "path",
  2198. "required": true
  2199. },
  2200. {
  2201. "type": "integer",
  2202. "format": "int64",
  2203. "description": "id of the hook to get",
  2204. "name": "id",
  2205. "in": "path",
  2206. "required": true
  2207. }
  2208. ],
  2209. "responses": {
  2210. "200": {
  2211. "$ref": "#/responses/Hook"
  2212. },
  2213. "404": {
  2214. "$ref": "#/responses/notFound"
  2215. }
  2216. }
  2217. },
  2218. "delete": {
  2219. "produces": [
  2220. "application/json"
  2221. ],
  2222. "tags": [
  2223. "organization"
  2224. ],
  2225. "summary": "Delete a hook",
  2226. "operationId": "orgDeleteHook",
  2227. "parameters": [
  2228. {
  2229. "type": "string",
  2230. "description": "name of the organization",
  2231. "name": "org",
  2232. "in": "path",
  2233. "required": true
  2234. },
  2235. {
  2236. "type": "integer",
  2237. "format": "int64",
  2238. "description": "id of the hook to delete",
  2239. "name": "id",
  2240. "in": "path",
  2241. "required": true
  2242. }
  2243. ],
  2244. "responses": {
  2245. "204": {
  2246. "$ref": "#/responses/empty"
  2247. },
  2248. "404": {
  2249. "$ref": "#/responses/notFound"
  2250. }
  2251. }
  2252. },
  2253. "patch": {
  2254. "consumes": [
  2255. "application/json"
  2256. ],
  2257. "produces": [
  2258. "application/json"
  2259. ],
  2260. "tags": [
  2261. "organization"
  2262. ],
  2263. "summary": "Update a hook",
  2264. "operationId": "orgEditHook",
  2265. "parameters": [
  2266. {
  2267. "type": "string",
  2268. "description": "name of the organization",
  2269. "name": "org",
  2270. "in": "path",
  2271. "required": true
  2272. },
  2273. {
  2274. "type": "integer",
  2275. "format": "int64",
  2276. "description": "id of the hook to update",
  2277. "name": "id",
  2278. "in": "path",
  2279. "required": true
  2280. },
  2281. {
  2282. "name": "body",
  2283. "in": "body",
  2284. "schema": {
  2285. "$ref": "#/definitions/EditHookOption"
  2286. }
  2287. }
  2288. ],
  2289. "responses": {
  2290. "200": {
  2291. "$ref": "#/responses/Hook"
  2292. },
  2293. "404": {
  2294. "$ref": "#/responses/notFound"
  2295. }
  2296. }
  2297. }
  2298. },
  2299. "/orgs/{org}/labels": {
  2300. "get": {
  2301. "produces": [
  2302. "application/json"
  2303. ],
  2304. "tags": [
  2305. "organization"
  2306. ],
  2307. "summary": "List an organization's labels",
  2308. "operationId": "orgListLabels",
  2309. "parameters": [
  2310. {
  2311. "type": "string",
  2312. "description": "name of the organization",
  2313. "name": "org",
  2314. "in": "path",
  2315. "required": true
  2316. },
  2317. {
  2318. "type": "integer",
  2319. "description": "page number of results to return (1-based)",
  2320. "name": "page",
  2321. "in": "query"
  2322. },
  2323. {
  2324. "type": "integer",
  2325. "description": "page size of results",
  2326. "name": "limit",
  2327. "in": "query"
  2328. }
  2329. ],
  2330. "responses": {
  2331. "200": {
  2332. "$ref": "#/responses/LabelList"
  2333. },
  2334. "404": {
  2335. "$ref": "#/responses/notFound"
  2336. }
  2337. }
  2338. },
  2339. "post": {
  2340. "consumes": [
  2341. "application/json"
  2342. ],
  2343. "produces": [
  2344. "application/json"
  2345. ],
  2346. "tags": [
  2347. "organization"
  2348. ],
  2349. "summary": "Create a label for an organization",
  2350. "operationId": "orgCreateLabel",
  2351. "parameters": [
  2352. {
  2353. "type": "string",
  2354. "description": "name of the organization",
  2355. "name": "org",
  2356. "in": "path",
  2357. "required": true
  2358. },
  2359. {
  2360. "name": "body",
  2361. "in": "body",
  2362. "schema": {
  2363. "$ref": "#/definitions/CreateLabelOption"
  2364. }
  2365. }
  2366. ],
  2367. "responses": {
  2368. "201": {
  2369. "$ref": "#/responses/Label"
  2370. },
  2371. "404": {
  2372. "$ref": "#/responses/notFound"
  2373. },
  2374. "422": {
  2375. "$ref": "#/responses/validationError"
  2376. }
  2377. }
  2378. }
  2379. },
  2380. "/orgs/{org}/labels/{id}": {
  2381. "get": {
  2382. "produces": [
  2383. "application/json"
  2384. ],
  2385. "tags": [
  2386. "organization"
  2387. ],
  2388. "summary": "Get a single label",
  2389. "operationId": "orgGetLabel",
  2390. "parameters": [
  2391. {
  2392. "type": "string",
  2393. "description": "name of the organization",
  2394. "name": "org",
  2395. "in": "path",
  2396. "required": true
  2397. },
  2398. {
  2399. "type": "integer",
  2400. "format": "int64",
  2401. "description": "id of the label to get",
  2402. "name": "id",
  2403. "in": "path",
  2404. "required": true
  2405. }
  2406. ],
  2407. "responses": {
  2408. "200": {
  2409. "$ref": "#/responses/Label"
  2410. },
  2411. "404": {
  2412. "$ref": "#/responses/notFound"
  2413. }
  2414. }
  2415. },
  2416. "delete": {
  2417. "tags": [
  2418. "organization"
  2419. ],
  2420. "summary": "Delete a label",
  2421. "operationId": "orgDeleteLabel",
  2422. "parameters": [
  2423. {
  2424. "type": "string",
  2425. "description": "name of the organization",
  2426. "name": "org",
  2427. "in": "path",
  2428. "required": true
  2429. },
  2430. {
  2431. "type": "integer",
  2432. "format": "int64",
  2433. "description": "id of the label to delete",
  2434. "name": "id",
  2435. "in": "path",
  2436. "required": true
  2437. }
  2438. ],
  2439. "responses": {
  2440. "204": {
  2441. "$ref": "#/responses/empty"
  2442. },
  2443. "404": {
  2444. "$ref": "#/responses/notFound"
  2445. }
  2446. }
  2447. },
  2448. "patch": {
  2449. "consumes": [
  2450. "application/json"
  2451. ],
  2452. "produces": [
  2453. "application/json"
  2454. ],
  2455. "tags": [
  2456. "organization"
  2457. ],
  2458. "summary": "Update a label",
  2459. "operationId": "orgEditLabel",
  2460. "parameters": [
  2461. {
  2462. "type": "string",
  2463. "description": "name of the organization",
  2464. "name": "org",
  2465. "in": "path",
  2466. "required": true
  2467. },
  2468. {
  2469. "type": "integer",
  2470. "format": "int64",
  2471. "description": "id of the label to edit",
  2472. "name": "id",
  2473. "in": "path",
  2474. "required": true
  2475. },
  2476. {
  2477. "name": "body",
  2478. "in": "body",
  2479. "schema": {
  2480. "$ref": "#/definitions/EditLabelOption"
  2481. }
  2482. }
  2483. ],
  2484. "responses": {
  2485. "200": {
  2486. "$ref": "#/responses/Label"
  2487. },
  2488. "404": {
  2489. "$ref": "#/responses/notFound"
  2490. },
  2491. "422": {
  2492. "$ref": "#/responses/validationError"
  2493. }
  2494. }
  2495. }
  2496. },
  2497. "/orgs/{org}/members": {
  2498. "get": {
  2499. "produces": [
  2500. "application/json"
  2501. ],
  2502. "tags": [
  2503. "organization"
  2504. ],
  2505. "summary": "List an organization's members",
  2506. "operationId": "orgListMembers",
  2507. "parameters": [
  2508. {
  2509. "type": "string",
  2510. "description": "name of the organization",
  2511. "name": "org",
  2512. "in": "path",
  2513. "required": true
  2514. },
  2515. {
  2516. "type": "integer",
  2517. "description": "page number of results to return (1-based)",
  2518. "name": "page",
  2519. "in": "query"
  2520. },
  2521. {
  2522. "type": "integer",
  2523. "description": "page size of results",
  2524. "name": "limit",
  2525. "in": "query"
  2526. }
  2527. ],
  2528. "responses": {
  2529. "200": {
  2530. "$ref": "#/responses/UserList"
  2531. },
  2532. "404": {
  2533. "$ref": "#/responses/notFound"
  2534. }
  2535. }
  2536. }
  2537. },
  2538. "/orgs/{org}/members/{username}": {
  2539. "get": {
  2540. "tags": [
  2541. "organization"
  2542. ],
  2543. "summary": "Check if a user is a member of an organization",
  2544. "operationId": "orgIsMember",
  2545. "parameters": [
  2546. {
  2547. "type": "string",
  2548. "description": "name of the organization",
  2549. "name": "org",
  2550. "in": "path",
  2551. "required": true
  2552. },
  2553. {
  2554. "type": "string",
  2555. "description": "username of the user",
  2556. "name": "username",
  2557. "in": "path",
  2558. "required": true
  2559. }
  2560. ],
  2561. "responses": {
  2562. "204": {
  2563. "description": "user is a member"
  2564. },
  2565. "303": {
  2566. "description": "redirection to /orgs/{org}/public_members/{username}"
  2567. },
  2568. "404": {
  2569. "description": "user is not a member"
  2570. }
  2571. }
  2572. },
  2573. "delete": {
  2574. "produces": [
  2575. "application/json"
  2576. ],
  2577. "tags": [
  2578. "organization"
  2579. ],
  2580. "summary": "Remove a member from an organization",
  2581. "operationId": "orgDeleteMember",
  2582. "parameters": [
  2583. {
  2584. "type": "string",
  2585. "description": "name of the organization",
  2586. "name": "org",
  2587. "in": "path",
  2588. "required": true
  2589. },
  2590. {
  2591. "type": "string",
  2592. "description": "username of the user",
  2593. "name": "username",
  2594. "in": "path",
  2595. "required": true
  2596. }
  2597. ],
  2598. "responses": {
  2599. "204": {
  2600. "description": "member removed"
  2601. },
  2602. "404": {
  2603. "$ref": "#/responses/notFound"
  2604. }
  2605. }
  2606. }
  2607. },
  2608. "/orgs/{org}/public_members": {
  2609. "get": {
  2610. "produces": [
  2611. "application/json"
  2612. ],
  2613. "tags": [
  2614. "organization"
  2615. ],
  2616. "summary": "List an organization's public members",
  2617. "operationId": "orgListPublicMembers",
  2618. "parameters": [
  2619. {
  2620. "type": "string",
  2621. "description": "name of the organization",
  2622. "name": "org",
  2623. "in": "path",
  2624. "required": true
  2625. },
  2626. {
  2627. "type": "integer",
  2628. "description": "page number of results to return (1-based)",
  2629. "name": "page",
  2630. "in": "query"
  2631. },
  2632. {
  2633. "type": "integer",
  2634. "description": "page size of results",
  2635. "name": "limit",
  2636. "in": "query"
  2637. }
  2638. ],
  2639. "responses": {
  2640. "200": {
  2641. "$ref": "#/responses/UserList"
  2642. },
  2643. "404": {
  2644. "$ref": "#/responses/notFound"
  2645. }
  2646. }
  2647. }
  2648. },
  2649. "/orgs/{org}/public_members/{username}": {
  2650. "get": {
  2651. "tags": [
  2652. "organization"
  2653. ],
  2654. "summary": "Check if a user is a public member of an organization",
  2655. "operationId": "orgIsPublicMember",
  2656. "parameters": [
  2657. {
  2658. "type": "string",
  2659. "description": "name of the organization",
  2660. "name": "org",
  2661. "in": "path",
  2662. "required": true
  2663. },
  2664. {
  2665. "type": "string",
  2666. "description": "username of the user",
  2667. "name": "username",
  2668. "in": "path",
  2669. "required": true
  2670. }
  2671. ],
  2672. "responses": {
  2673. "204": {
  2674. "description": "user is a public member"
  2675. },
  2676. "404": {
  2677. "description": "user is not a public member"
  2678. }
  2679. }
  2680. },
  2681. "put": {
  2682. "produces": [
  2683. "application/json"
  2684. ],
  2685. "tags": [
  2686. "organization"
  2687. ],
  2688. "summary": "Publicize a user's membership",
  2689. "operationId": "orgPublicizeMember",
  2690. "parameters": [
  2691. {
  2692. "type": "string",
  2693. "description": "name of the organization",
  2694. "name": "org",
  2695. "in": "path",
  2696. "required": true
  2697. },
  2698. {
  2699. "type": "string",
  2700. "description": "username of the user",
  2701. "name": "username",
  2702. "in": "path",
  2703. "required": true
  2704. }
  2705. ],
  2706. "responses": {
  2707. "204": {
  2708. "description": "membership publicized"
  2709. },
  2710. "403": {
  2711. "$ref": "#/responses/forbidden"
  2712. },
  2713. "404": {
  2714. "$ref": "#/responses/notFound"
  2715. }
  2716. }
  2717. },
  2718. "delete": {
  2719. "produces": [
  2720. "application/json"
  2721. ],
  2722. "tags": [
  2723. "organization"
  2724. ],
  2725. "summary": "Conceal a user's membership",
  2726. "operationId": "orgConcealMember",
  2727. "parameters": [
  2728. {
  2729. "type": "string",
  2730. "description": "name of the organization",
  2731. "name": "org",
  2732. "in": "path",
  2733. "required": true
  2734. },
  2735. {
  2736. "type": "string",
  2737. "description": "username of the user",
  2738. "name": "username",
  2739. "in": "path",
  2740. "required": true
  2741. }
  2742. ],
  2743. "responses": {
  2744. "204": {
  2745. "$ref": "#/responses/empty"
  2746. },
  2747. "403": {
  2748. "$ref": "#/responses/forbidden"
  2749. },
  2750. "404": {
  2751. "$ref": "#/responses/notFound"
  2752. }
  2753. }
  2754. }
  2755. },
  2756. "/orgs/{org}/repos": {
  2757. "get": {
  2758. "produces": [
  2759. "application/json"
  2760. ],
  2761. "tags": [
  2762. "organization"
  2763. ],
  2764. "summary": "List an organization's repos",
  2765. "operationId": "orgListRepos",
  2766. "parameters": [
  2767. {
  2768. "type": "string",
  2769. "description": "name of the organization",
  2770. "name": "org",
  2771. "in": "path",
  2772. "required": true
  2773. },
  2774. {
  2775. "type": "integer",
  2776. "description": "page number of results to return (1-based)",
  2777. "name": "page",
  2778. "in": "query"
  2779. },
  2780. {
  2781. "type": "integer",
  2782. "description": "page size of results",
  2783. "name": "limit",
  2784. "in": "query"
  2785. }
  2786. ],
  2787. "responses": {
  2788. "200": {
  2789. "$ref": "#/responses/RepositoryList"
  2790. },
  2791. "404": {
  2792. "$ref": "#/responses/notFound"
  2793. }
  2794. }
  2795. },
  2796. "post": {
  2797. "consumes": [
  2798. "application/json"
  2799. ],
  2800. "produces": [
  2801. "application/json"
  2802. ],
  2803. "tags": [
  2804. "organization"
  2805. ],
  2806. "summary": "Create a repository in an organization",
  2807. "operationId": "createOrgRepo",
  2808. "parameters": [
  2809. {
  2810. "type": "string",
  2811. "description": "name of organization",
  2812. "name": "org",
  2813. "in": "path",
  2814. "required": true
  2815. },
  2816. {
  2817. "name": "body",
  2818. "in": "body",
  2819. "schema": {
  2820. "$ref": "#/definitions/CreateRepoOption"
  2821. }
  2822. }
  2823. ],
  2824. "responses": {
  2825. "201": {
  2826. "$ref": "#/responses/Repository"
  2827. },
  2828. "400": {
  2829. "$ref": "#/responses/error"
  2830. },
  2831. "403": {
  2832. "$ref": "#/responses/forbidden"
  2833. },
  2834. "404": {
  2835. "$ref": "#/responses/notFound"
  2836. }
  2837. }
  2838. }
  2839. },
  2840. "/orgs/{org}/teams": {
  2841. "get": {
  2842. "produces": [
  2843. "application/json"
  2844. ],
  2845. "tags": [
  2846. "organization"
  2847. ],
  2848. "summary": "List an organization's teams",
  2849. "operationId": "orgListTeams",
  2850. "parameters": [
  2851. {
  2852. "type": "string",
  2853. "description": "name of the organization",
  2854. "name": "org",
  2855. "in": "path",
  2856. "required": true
  2857. },
  2858. {
  2859. "type": "integer",
  2860. "description": "page number of results to return (1-based)",
  2861. "name": "page",
  2862. "in": "query"
  2863. },
  2864. {
  2865. "type": "integer",
  2866. "description": "page size of results",
  2867. "name": "limit",
  2868. "in": "query"
  2869. }
  2870. ],
  2871. "responses": {
  2872. "200": {
  2873. "$ref": "#/responses/TeamList"
  2874. },
  2875. "404": {
  2876. "$ref": "#/responses/notFound"
  2877. }
  2878. }
  2879. },
  2880. "post": {
  2881. "consumes": [
  2882. "application/json"
  2883. ],
  2884. "produces": [
  2885. "application/json"
  2886. ],
  2887. "tags": [
  2888. "organization"
  2889. ],
  2890. "summary": "Create a team",
  2891. "operationId": "orgCreateTeam",
  2892. "parameters": [
  2893. {
  2894. "type": "string",
  2895. "description": "name of the organization",
  2896. "name": "org",
  2897. "in": "path",
  2898. "required": true
  2899. },
  2900. {
  2901. "name": "body",
  2902. "in": "body",
  2903. "schema": {
  2904. "$ref": "#/definitions/CreateTeamOption"
  2905. }
  2906. }
  2907. ],
  2908. "responses": {
  2909. "201": {
  2910. "$ref": "#/responses/Team"
  2911. },
  2912. "404": {
  2913. "$ref": "#/responses/notFound"
  2914. },
  2915. "422": {
  2916. "$ref": "#/responses/validationError"
  2917. }
  2918. }
  2919. }
  2920. },
  2921. "/orgs/{org}/teams/search": {
  2922. "get": {
  2923. "produces": [
  2924. "application/json"
  2925. ],
  2926. "tags": [
  2927. "organization"
  2928. ],
  2929. "summary": "Search for teams within an organization",
  2930. "operationId": "teamSearch",
  2931. "parameters": [
  2932. {
  2933. "type": "string",
  2934. "description": "name of the organization",
  2935. "name": "org",
  2936. "in": "path",
  2937. "required": true
  2938. },
  2939. {
  2940. "type": "string",
  2941. "description": "keywords to search",
  2942. "name": "q",
  2943. "in": "query"
  2944. },
  2945. {
  2946. "type": "boolean",
  2947. "description": "include search within team description (defaults to true)",
  2948. "name": "include_desc",
  2949. "in": "query"
  2950. },
  2951. {
  2952. "type": "integer",
  2953. "description": "page number of results to return (1-based)",
  2954. "name": "page",
  2955. "in": "query"
  2956. },
  2957. {
  2958. "type": "integer",
  2959. "description": "page size of results",
  2960. "name": "limit",
  2961. "in": "query"
  2962. }
  2963. ],
  2964. "responses": {
  2965. "200": {
  2966. "description": "SearchResults of a successful search",
  2967. "schema": {
  2968. "type": "object",
  2969. "properties": {
  2970. "data": {
  2971. "type": "array",
  2972. "items": {
  2973. "$ref": "#/definitions/Team"
  2974. }
  2975. },
  2976. "ok": {
  2977. "type": "boolean"
  2978. }
  2979. }
  2980. }
  2981. },
  2982. "404": {
  2983. "$ref": "#/responses/notFound"
  2984. }
  2985. }
  2986. }
  2987. },
  2988. "/packages/{owner}": {
  2989. "get": {
  2990. "produces": [
  2991. "application/json"
  2992. ],
  2993. "tags": [
  2994. "package"
  2995. ],
  2996. "summary": "Gets all packages of an owner",
  2997. "operationId": "listPackages",
  2998. "parameters": [
  2999. {
  3000. "type": "string",
  3001. "description": "owner of the packages",
  3002. "name": "owner",
  3003. "in": "path",
  3004. "required": true
  3005. },
  3006. {
  3007. "type": "integer",
  3008. "description": "page number of results to return (1-based)",
  3009. "name": "page",
  3010. "in": "query"
  3011. },
  3012. {
  3013. "type": "integer",
  3014. "description": "page size of results",
  3015. "name": "limit",
  3016. "in": "query"
  3017. },
  3018. {
  3019. "enum": [
  3020. "alpine",
  3021. "cargo",
  3022. "chef",
  3023. "composer",
  3024. "conan",
  3025. "conda",
  3026. "container",
  3027. "cran",
  3028. "debian",
  3029. "generic",
  3030. "go",
  3031. "helm",
  3032. "maven",
  3033. "npm",
  3034. "nuget",
  3035. "pub",
  3036. "pypi",
  3037. "rpm",
  3038. "rubygems",
  3039. "swift",
  3040. "vagrant"
  3041. ],
  3042. "type": "string",
  3043. "description": "package type filter",
  3044. "name": "type",
  3045. "in": "query"
  3046. },
  3047. {
  3048. "type": "string",
  3049. "description": "name filter",
  3050. "name": "q",
  3051. "in": "query"
  3052. }
  3053. ],
  3054. "responses": {
  3055. "200": {
  3056. "$ref": "#/responses/PackageList"
  3057. },
  3058. "404": {
  3059. "$ref": "#/responses/notFound"
  3060. }
  3061. }
  3062. }
  3063. },
  3064. "/packages/{owner}/{type}/{name}/{version}": {
  3065. "get": {
  3066. "produces": [
  3067. "application/json"
  3068. ],
  3069. "tags": [
  3070. "package"
  3071. ],
  3072. "summary": "Gets a package",
  3073. "operationId": "getPackage",
  3074. "parameters": [
  3075. {
  3076. "type": "string",
  3077. "description": "owner of the package",
  3078. "name": "owner",
  3079. "in": "path",
  3080. "required": true
  3081. },
  3082. {
  3083. "type": "string",
  3084. "description": "type of the package",
  3085. "name": "type",
  3086. "in": "path",
  3087. "required": true
  3088. },
  3089. {
  3090. "type": "string",
  3091. "description": "name of the package",
  3092. "name": "name",
  3093. "in": "path",
  3094. "required": true
  3095. },
  3096. {
  3097. "type": "string",
  3098. "description": "version of the package",
  3099. "name": "version",
  3100. "in": "path",
  3101. "required": true
  3102. }
  3103. ],
  3104. "responses": {
  3105. "200": {
  3106. "$ref": "#/responses/Package"
  3107. },
  3108. "404": {
  3109. "$ref": "#/responses/notFound"
  3110. }
  3111. }
  3112. },
  3113. "delete": {
  3114. "tags": [
  3115. "package"
  3116. ],
  3117. "summary": "Delete a package",
  3118. "operationId": "deletePackage",
  3119. "parameters": [
  3120. {
  3121. "type": "string",
  3122. "description": "owner of the package",
  3123. "name": "owner",
  3124. "in": "path",
  3125. "required": true
  3126. },
  3127. {
  3128. "type": "string",
  3129. "description": "type of the package",
  3130. "name": "type",
  3131. "in": "path",
  3132. "required": true
  3133. },
  3134. {
  3135. "type": "string",
  3136. "description": "name of the package",
  3137. "name": "name",
  3138. "in": "path",
  3139. "required": true
  3140. },
  3141. {
  3142. "type": "string",
  3143. "description": "version of the package",
  3144. "name": "version",
  3145. "in": "path",
  3146. "required": true
  3147. }
  3148. ],
  3149. "responses": {
  3150. "204": {
  3151. "$ref": "#/responses/empty"
  3152. },
  3153. "404": {
  3154. "$ref": "#/responses/notFound"
  3155. }
  3156. }
  3157. }
  3158. },
  3159. "/packages/{owner}/{type}/{name}/{version}/files": {
  3160. "get": {
  3161. "produces": [
  3162. "application/json"
  3163. ],
  3164. "tags": [
  3165. "package"
  3166. ],
  3167. "summary": "Gets all files of a package",
  3168. "operationId": "listPackageFiles",
  3169. "parameters": [
  3170. {
  3171. "type": "string",
  3172. "description": "owner of the package",
  3173. "name": "owner",
  3174. "in": "path",
  3175. "required": true
  3176. },
  3177. {
  3178. "type": "string",
  3179. "description": "type of the package",
  3180. "name": "type",
  3181. "in": "path",
  3182. "required": true
  3183. },
  3184. {
  3185. "type": "string",
  3186. "description": "name of the package",
  3187. "name": "name",
  3188. "in": "path",
  3189. "required": true
  3190. },
  3191. {
  3192. "type": "string",
  3193. "description": "version of the package",
  3194. "name": "version",
  3195. "in": "path",
  3196. "required": true
  3197. }
  3198. ],
  3199. "responses": {
  3200. "200": {
  3201. "$ref": "#/responses/PackageFileList"
  3202. },
  3203. "404": {
  3204. "$ref": "#/responses/notFound"
  3205. }
  3206. }
  3207. }
  3208. },
  3209. "/repos/issues/search": {
  3210. "get": {
  3211. "produces": [
  3212. "application/json"
  3213. ],
  3214. "tags": [
  3215. "issue"
  3216. ],
  3217. "summary": "Search for issues across the repositories that the user has access to",
  3218. "operationId": "issueSearchIssues",
  3219. "parameters": [
  3220. {
  3221. "type": "string",
  3222. "description": "whether issue is open or closed",
  3223. "name": "state",
  3224. "in": "query"
  3225. },
  3226. {
  3227. "type": "string",
  3228. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3229. "name": "labels",
  3230. "in": "query"
  3231. },
  3232. {
  3233. "type": "string",
  3234. "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
  3235. "name": "milestones",
  3236. "in": "query"
  3237. },
  3238. {
  3239. "type": "string",
  3240. "description": "search string",
  3241. "name": "q",
  3242. "in": "query"
  3243. },
  3244. {
  3245. "type": "integer",
  3246. "format": "int64",
  3247. "description": "repository to prioritize in the results",
  3248. "name": "priority_repo_id",
  3249. "in": "query"
  3250. },
  3251. {
  3252. "type": "string",
  3253. "description": "filter by type (issues / pulls) if set",
  3254. "name": "type",
  3255. "in": "query"
  3256. },
  3257. {
  3258. "type": "string",
  3259. "format": "date-time",
  3260. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  3261. "name": "since",
  3262. "in": "query"
  3263. },
  3264. {
  3265. "type": "string",
  3266. "format": "date-time",
  3267. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  3268. "name": "before",
  3269. "in": "query"
  3270. },
  3271. {
  3272. "type": "boolean",
  3273. "description": "filter (issues / pulls) assigned to you, default is false",
  3274. "name": "assigned",
  3275. "in": "query"
  3276. },
  3277. {
  3278. "type": "boolean",
  3279. "description": "filter (issues / pulls) created by you, default is false",
  3280. "name": "created",
  3281. "in": "query"
  3282. },
  3283. {
  3284. "type": "boolean",
  3285. "description": "filter (issues / pulls) mentioning you, default is false",
  3286. "name": "mentioned",
  3287. "in": "query"
  3288. },
  3289. {
  3290. "type": "boolean",
  3291. "description": "filter pulls requesting your review, default is false",
  3292. "name": "review_requested",
  3293. "in": "query"
  3294. },
  3295. {
  3296. "type": "boolean",
  3297. "description": "filter pulls reviewed by you, default is false",
  3298. "name": "reviewed",
  3299. "in": "query"
  3300. },
  3301. {
  3302. "type": "string",
  3303. "description": "filter by owner",
  3304. "name": "owner",
  3305. "in": "query"
  3306. },
  3307. {
  3308. "type": "string",
  3309. "description": "filter by team (requires organization owner parameter to be provided)",
  3310. "name": "team",
  3311. "in": "query"
  3312. },
  3313. {
  3314. "type": "integer",
  3315. "description": "page number of results to return (1-based)",
  3316. "name": "page",
  3317. "in": "query"
  3318. },
  3319. {
  3320. "type": "integer",
  3321. "description": "page size of results",
  3322. "name": "limit",
  3323. "in": "query"
  3324. }
  3325. ],
  3326. "responses": {
  3327. "200": {
  3328. "$ref": "#/responses/IssueList"
  3329. }
  3330. }
  3331. }
  3332. },
  3333. "/repos/migrate": {
  3334. "post": {
  3335. "consumes": [
  3336. "application/json"
  3337. ],
  3338. "produces": [
  3339. "application/json"
  3340. ],
  3341. "tags": [
  3342. "repository"
  3343. ],
  3344. "summary": "Migrate a remote git repository",
  3345. "operationId": "repoMigrate",
  3346. "parameters": [
  3347. {
  3348. "name": "body",
  3349. "in": "body",
  3350. "schema": {
  3351. "$ref": "#/definitions/MigrateRepoOptions"
  3352. }
  3353. }
  3354. ],
  3355. "responses": {
  3356. "201": {
  3357. "$ref": "#/responses/Repository"
  3358. },
  3359. "403": {
  3360. "$ref": "#/responses/forbidden"
  3361. },
  3362. "409": {
  3363. "description": "The repository with the same name already exists."
  3364. },
  3365. "422": {
  3366. "$ref": "#/responses/validationError"
  3367. }
  3368. }
  3369. }
  3370. },
  3371. "/repos/search": {
  3372. "get": {
  3373. "produces": [
  3374. "application/json"
  3375. ],
  3376. "tags": [
  3377. "repository"
  3378. ],
  3379. "summary": "Search for repositories",
  3380. "operationId": "repoSearch",
  3381. "parameters": [
  3382. {
  3383. "type": "string",
  3384. "description": "keyword",
  3385. "name": "q",
  3386. "in": "query"
  3387. },
  3388. {
  3389. "type": "boolean",
  3390. "description": "Limit search to repositories with keyword as topic",
  3391. "name": "topic",
  3392. "in": "query"
  3393. },
  3394. {
  3395. "type": "boolean",
  3396. "description": "include search of keyword within repository description",
  3397. "name": "includeDesc",
  3398. "in": "query"
  3399. },
  3400. {
  3401. "type": "integer",
  3402. "format": "int64",
  3403. "description": "search only for repos that the user with the given id owns or contributes to",
  3404. "name": "uid",
  3405. "in": "query"
  3406. },
  3407. {
  3408. "type": "integer",
  3409. "format": "int64",
  3410. "description": "repo owner to prioritize in the results",
  3411. "name": "priority_owner_id",
  3412. "in": "query"
  3413. },
  3414. {
  3415. "type": "integer",
  3416. "format": "int64",
  3417. "description": "search only for repos that belong to the given team id",
  3418. "name": "team_id",
  3419. "in": "query"
  3420. },
  3421. {
  3422. "type": "integer",
  3423. "format": "int64",
  3424. "description": "search only for repos that the user with the given id has starred",
  3425. "name": "starredBy",
  3426. "in": "query"
  3427. },
  3428. {
  3429. "type": "boolean",
  3430. "description": "include private repositories this user has access to (defaults to true)",
  3431. "name": "private",
  3432. "in": "query"
  3433. },
  3434. {
  3435. "type": "boolean",
  3436. "description": "show only pubic, private or all repositories (defaults to all)",
  3437. "name": "is_private",
  3438. "in": "query"
  3439. },
  3440. {
  3441. "type": "boolean",
  3442. "description": "include template repositories this user has access to (defaults to true)",
  3443. "name": "template",
  3444. "in": "query"
  3445. },
  3446. {
  3447. "type": "boolean",
  3448. "description": "show only archived, non-archived or all repositories (defaults to all)",
  3449. "name": "archived",
  3450. "in": "query"
  3451. },
  3452. {
  3453. "type": "string",
  3454. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  3455. "name": "mode",
  3456. "in": "query"
  3457. },
  3458. {
  3459. "type": "boolean",
  3460. "description": "if `uid` is given, search only for repos that the user owns",
  3461. "name": "exclusive",
  3462. "in": "query"
  3463. },
  3464. {
  3465. "type": "string",
  3466. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  3467. "name": "sort",
  3468. "in": "query"
  3469. },
  3470. {
  3471. "type": "string",
  3472. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  3473. "name": "order",
  3474. "in": "query"
  3475. },
  3476. {
  3477. "type": "integer",
  3478. "description": "page number of results to return (1-based)",
  3479. "name": "page",
  3480. "in": "query"
  3481. },
  3482. {
  3483. "type": "integer",
  3484. "description": "page size of results",
  3485. "name": "limit",
  3486. "in": "query"
  3487. }
  3488. ],
  3489. "responses": {
  3490. "200": {
  3491. "$ref": "#/responses/SearchResults"
  3492. },
  3493. "422": {
  3494. "$ref": "#/responses/validationError"
  3495. }
  3496. }
  3497. }
  3498. },
  3499. "/repos/{owner}/{repo}": {
  3500. "get": {
  3501. "produces": [
  3502. "application/json"
  3503. ],
  3504. "tags": [
  3505. "repository"
  3506. ],
  3507. "summary": "Get a repository",
  3508. "operationId": "repoGet",
  3509. "parameters": [
  3510. {
  3511. "type": "string",
  3512. "description": "owner of the repo",
  3513. "name": "owner",
  3514. "in": "path",
  3515. "required": true
  3516. },
  3517. {
  3518. "type": "string",
  3519. "description": "name of the repo",
  3520. "name": "repo",
  3521. "in": "path",
  3522. "required": true
  3523. }
  3524. ],
  3525. "responses": {
  3526. "200": {
  3527. "$ref": "#/responses/Repository"
  3528. },
  3529. "404": {
  3530. "$ref": "#/responses/notFound"
  3531. }
  3532. }
  3533. },
  3534. "delete": {
  3535. "produces": [
  3536. "application/json"
  3537. ],
  3538. "tags": [
  3539. "repository"
  3540. ],
  3541. "summary": "Delete a repository",
  3542. "operationId": "repoDelete",
  3543. "parameters": [
  3544. {
  3545. "type": "string",
  3546. "description": "owner of the repo to delete",
  3547. "name": "owner",
  3548. "in": "path",
  3549. "required": true
  3550. },
  3551. {
  3552. "type": "string",
  3553. "description": "name of the repo to delete",
  3554. "name": "repo",
  3555. "in": "path",
  3556. "required": true
  3557. }
  3558. ],
  3559. "responses": {
  3560. "204": {
  3561. "$ref": "#/responses/empty"
  3562. },
  3563. "403": {
  3564. "$ref": "#/responses/forbidden"
  3565. },
  3566. "404": {
  3567. "$ref": "#/responses/notFound"
  3568. }
  3569. }
  3570. },
  3571. "patch": {
  3572. "produces": [
  3573. "application/json"
  3574. ],
  3575. "tags": [
  3576. "repository"
  3577. ],
  3578. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  3579. "operationId": "repoEdit",
  3580. "parameters": [
  3581. {
  3582. "type": "string",
  3583. "description": "owner of the repo to edit",
  3584. "name": "owner",
  3585. "in": "path",
  3586. "required": true
  3587. },
  3588. {
  3589. "type": "string",
  3590. "description": "name of the repo to edit",
  3591. "name": "repo",
  3592. "in": "path",
  3593. "required": true
  3594. },
  3595. {
  3596. "description": "Properties of a repo that you can edit",
  3597. "name": "body",
  3598. "in": "body",
  3599. "schema": {
  3600. "$ref": "#/definitions/EditRepoOption"
  3601. }
  3602. }
  3603. ],
  3604. "responses": {
  3605. "200": {
  3606. "$ref": "#/responses/Repository"
  3607. },
  3608. "403": {
  3609. "$ref": "#/responses/forbidden"
  3610. },
  3611. "404": {
  3612. "$ref": "#/responses/notFound"
  3613. },
  3614. "422": {
  3615. "$ref": "#/responses/validationError"
  3616. }
  3617. }
  3618. }
  3619. },
  3620. "/repos/{owner}/{repo}/actions/secrets/{secretname}": {
  3621. "put": {
  3622. "consumes": [
  3623. "application/json"
  3624. ],
  3625. "produces": [
  3626. "application/json"
  3627. ],
  3628. "tags": [
  3629. "repository"
  3630. ],
  3631. "summary": "Create or Update a secret value in a repository",
  3632. "operationId": "updateRepoSecret",
  3633. "parameters": [
  3634. {
  3635. "type": "string",
  3636. "description": "owner of the repository",
  3637. "name": "owner",
  3638. "in": "path",
  3639. "required": true
  3640. },
  3641. {
  3642. "type": "string",
  3643. "description": "name of the repository",
  3644. "name": "repo",
  3645. "in": "path",
  3646. "required": true
  3647. },
  3648. {
  3649. "type": "string",
  3650. "description": "name of the secret",
  3651. "name": "secretname",
  3652. "in": "path",
  3653. "required": true
  3654. },
  3655. {
  3656. "name": "body",
  3657. "in": "body",
  3658. "schema": {
  3659. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  3660. }
  3661. }
  3662. ],
  3663. "responses": {
  3664. "201": {
  3665. "description": "response when creating a secret"
  3666. },
  3667. "204": {
  3668. "description": "response when updating a secret"
  3669. },
  3670. "400": {
  3671. "$ref": "#/responses/error"
  3672. },
  3673. "404": {
  3674. "$ref": "#/responses/notFound"
  3675. }
  3676. }
  3677. },
  3678. "delete": {
  3679. "consumes": [
  3680. "application/json"
  3681. ],
  3682. "produces": [
  3683. "application/json"
  3684. ],
  3685. "tags": [
  3686. "repository"
  3687. ],
  3688. "summary": "Delete a secret in a repository",
  3689. "operationId": "deleteRepoSecret",
  3690. "parameters": [
  3691. {
  3692. "type": "string",
  3693. "description": "owner of the repository",
  3694. "name": "owner",
  3695. "in": "path",
  3696. "required": true
  3697. },
  3698. {
  3699. "type": "string",
  3700. "description": "name of the repository",
  3701. "name": "repo",
  3702. "in": "path",
  3703. "required": true
  3704. },
  3705. {
  3706. "type": "string",
  3707. "description": "name of the secret",
  3708. "name": "secretname",
  3709. "in": "path",
  3710. "required": true
  3711. }
  3712. ],
  3713. "responses": {
  3714. "204": {
  3715. "description": "delete one secret of the organization"
  3716. },
  3717. "400": {
  3718. "$ref": "#/responses/error"
  3719. },
  3720. "404": {
  3721. "$ref": "#/responses/notFound"
  3722. }
  3723. }
  3724. }
  3725. },
  3726. "/repos/{owner}/{repo}/activities/feeds": {
  3727. "get": {
  3728. "produces": [
  3729. "application/json"
  3730. ],
  3731. "tags": [
  3732. "repository"
  3733. ],
  3734. "summary": "List a repository's activity feeds",
  3735. "operationId": "repoListActivityFeeds",
  3736. "parameters": [
  3737. {
  3738. "type": "string",
  3739. "description": "owner of the repo",
  3740. "name": "owner",
  3741. "in": "path",
  3742. "required": true
  3743. },
  3744. {
  3745. "type": "string",
  3746. "description": "name of the repo",
  3747. "name": "repo",
  3748. "in": "path",
  3749. "required": true
  3750. },
  3751. {
  3752. "type": "string",
  3753. "format": "date",
  3754. "description": "the date of the activities to be found",
  3755. "name": "date",
  3756. "in": "query"
  3757. },
  3758. {
  3759. "type": "integer",
  3760. "description": "page number of results to return (1-based)",
  3761. "name": "page",
  3762. "in": "query"
  3763. },
  3764. {
  3765. "type": "integer",
  3766. "description": "page size of results",
  3767. "name": "limit",
  3768. "in": "query"
  3769. }
  3770. ],
  3771. "responses": {
  3772. "200": {
  3773. "$ref": "#/responses/ActivityFeedsList"
  3774. },
  3775. "404": {
  3776. "$ref": "#/responses/notFound"
  3777. }
  3778. }
  3779. }
  3780. },
  3781. "/repos/{owner}/{repo}/archive/{archive}": {
  3782. "get": {
  3783. "produces": [
  3784. "application/json"
  3785. ],
  3786. "tags": [
  3787. "repository"
  3788. ],
  3789. "summary": "Get an archive of a repository",
  3790. "operationId": "repoGetArchive",
  3791. "parameters": [
  3792. {
  3793. "type": "string",
  3794. "description": "owner of the repo",
  3795. "name": "owner",
  3796. "in": "path",
  3797. "required": true
  3798. },
  3799. {
  3800. "type": "string",
  3801. "description": "name of the repo",
  3802. "name": "repo",
  3803. "in": "path",
  3804. "required": true
  3805. },
  3806. {
  3807. "type": "string",
  3808. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  3809. "name": "archive",
  3810. "in": "path",
  3811. "required": true
  3812. }
  3813. ],
  3814. "responses": {
  3815. "200": {
  3816. "description": "success"
  3817. },
  3818. "404": {
  3819. "$ref": "#/responses/notFound"
  3820. }
  3821. }
  3822. }
  3823. },
  3824. "/repos/{owner}/{repo}/assignees": {
  3825. "get": {
  3826. "produces": [
  3827. "application/json"
  3828. ],
  3829. "tags": [
  3830. "repository"
  3831. ],
  3832. "summary": "Return all users that have write access and can be assigned to issues",
  3833. "operationId": "repoGetAssignees",
  3834. "parameters": [
  3835. {
  3836. "type": "string",
  3837. "description": "owner of the repo",
  3838. "name": "owner",
  3839. "in": "path",
  3840. "required": true
  3841. },
  3842. {
  3843. "type": "string",
  3844. "description": "name of the repo",
  3845. "name": "repo",
  3846. "in": "path",
  3847. "required": true
  3848. }
  3849. ],
  3850. "responses": {
  3851. "200": {
  3852. "$ref": "#/responses/UserList"
  3853. },
  3854. "404": {
  3855. "$ref": "#/responses/notFound"
  3856. }
  3857. }
  3858. }
  3859. },
  3860. "/repos/{owner}/{repo}/avatar": {
  3861. "post": {
  3862. "produces": [
  3863. "application/json"
  3864. ],
  3865. "tags": [
  3866. "repository"
  3867. ],
  3868. "summary": "Update avatar",
  3869. "operationId": "repoUpdateAvatar",
  3870. "parameters": [
  3871. {
  3872. "type": "string",
  3873. "description": "owner of the repo",
  3874. "name": "owner",
  3875. "in": "path",
  3876. "required": true
  3877. },
  3878. {
  3879. "type": "string",
  3880. "description": "name of the repo",
  3881. "name": "repo",
  3882. "in": "path",
  3883. "required": true
  3884. },
  3885. {
  3886. "name": "body",
  3887. "in": "body",
  3888. "schema": {
  3889. "$ref": "#/definitions/UpdateRepoAvatarOption"
  3890. }
  3891. }
  3892. ],
  3893. "responses": {
  3894. "204": {
  3895. "$ref": "#/responses/empty"
  3896. },
  3897. "404": {
  3898. "$ref": "#/responses/notFound"
  3899. }
  3900. }
  3901. },
  3902. "delete": {
  3903. "produces": [
  3904. "application/json"
  3905. ],
  3906. "tags": [
  3907. "repository"
  3908. ],
  3909. "summary": "Delete avatar",
  3910. "operationId": "repoDeleteAvatar",
  3911. "parameters": [
  3912. {
  3913. "type": "string",
  3914. "description": "owner of the repo",
  3915. "name": "owner",
  3916. "in": "path",
  3917. "required": true
  3918. },
  3919. {
  3920. "type": "string",
  3921. "description": "name of the repo",
  3922. "name": "repo",
  3923. "in": "path",
  3924. "required": true
  3925. }
  3926. ],
  3927. "responses": {
  3928. "204": {
  3929. "$ref": "#/responses/empty"
  3930. },
  3931. "404": {
  3932. "$ref": "#/responses/notFound"
  3933. }
  3934. }
  3935. }
  3936. },
  3937. "/repos/{owner}/{repo}/branch_protections": {
  3938. "get": {
  3939. "produces": [
  3940. "application/json"
  3941. ],
  3942. "tags": [
  3943. "repository"
  3944. ],
  3945. "summary": "List branch protections for a repository",
  3946. "operationId": "repoListBranchProtection",
  3947. "parameters": [
  3948. {
  3949. "type": "string",
  3950. "description": "owner of the repo",
  3951. "name": "owner",
  3952. "in": "path",
  3953. "required": true
  3954. },
  3955. {
  3956. "type": "string",
  3957. "description": "name of the repo",
  3958. "name": "repo",
  3959. "in": "path",
  3960. "required": true
  3961. }
  3962. ],
  3963. "responses": {
  3964. "200": {
  3965. "$ref": "#/responses/BranchProtectionList"
  3966. }
  3967. }
  3968. },
  3969. "post": {
  3970. "consumes": [
  3971. "application/json"
  3972. ],
  3973. "produces": [
  3974. "application/json"
  3975. ],
  3976. "tags": [
  3977. "repository"
  3978. ],
  3979. "summary": "Create a branch protections for a repository",
  3980. "operationId": "repoCreateBranchProtection",
  3981. "parameters": [
  3982. {
  3983. "type": "string",
  3984. "description": "owner of the repo",
  3985. "name": "owner",
  3986. "in": "path",
  3987. "required": true
  3988. },
  3989. {
  3990. "type": "string",
  3991. "description": "name of the repo",
  3992. "name": "repo",
  3993. "in": "path",
  3994. "required": true
  3995. },
  3996. {
  3997. "name": "body",
  3998. "in": "body",
  3999. "schema": {
  4000. "$ref": "#/definitions/CreateBranchProtectionOption"
  4001. }
  4002. }
  4003. ],
  4004. "responses": {
  4005. "201": {
  4006. "$ref": "#/responses/BranchProtection"
  4007. },
  4008. "403": {
  4009. "$ref": "#/responses/forbidden"
  4010. },
  4011. "404": {
  4012. "$ref": "#/responses/notFound"
  4013. },
  4014. "422": {
  4015. "$ref": "#/responses/validationError"
  4016. },
  4017. "423": {
  4018. "$ref": "#/responses/repoArchivedError"
  4019. }
  4020. }
  4021. }
  4022. },
  4023. "/repos/{owner}/{repo}/branch_protections/{name}": {
  4024. "get": {
  4025. "produces": [
  4026. "application/json"
  4027. ],
  4028. "tags": [
  4029. "repository"
  4030. ],
  4031. "summary": "Get a specific branch protection for the repository",
  4032. "operationId": "repoGetBranchProtection",
  4033. "parameters": [
  4034. {
  4035. "type": "string",
  4036. "description": "owner of the repo",
  4037. "name": "owner",
  4038. "in": "path",
  4039. "required": true
  4040. },
  4041. {
  4042. "type": "string",
  4043. "description": "name of the repo",
  4044. "name": "repo",
  4045. "in": "path",
  4046. "required": true
  4047. },
  4048. {
  4049. "type": "string",
  4050. "description": "name of protected branch",
  4051. "name": "name",
  4052. "in": "path",
  4053. "required": true
  4054. }
  4055. ],
  4056. "responses": {
  4057. "200": {
  4058. "$ref": "#/responses/BranchProtection"
  4059. },
  4060. "404": {
  4061. "$ref": "#/responses/notFound"
  4062. }
  4063. }
  4064. },
  4065. "delete": {
  4066. "produces": [
  4067. "application/json"
  4068. ],
  4069. "tags": [
  4070. "repository"
  4071. ],
  4072. "summary": "Delete a specific branch protection for the repository",
  4073. "operationId": "repoDeleteBranchProtection",
  4074. "parameters": [
  4075. {
  4076. "type": "string",
  4077. "description": "owner of the repo",
  4078. "name": "owner",
  4079. "in": "path",
  4080. "required": true
  4081. },
  4082. {
  4083. "type": "string",
  4084. "description": "name of the repo",
  4085. "name": "repo",
  4086. "in": "path",
  4087. "required": true
  4088. },
  4089. {
  4090. "type": "string",
  4091. "description": "name of protected branch",
  4092. "name": "name",
  4093. "in": "path",
  4094. "required": true
  4095. }
  4096. ],
  4097. "responses": {
  4098. "204": {
  4099. "$ref": "#/responses/empty"
  4100. },
  4101. "404": {
  4102. "$ref": "#/responses/notFound"
  4103. }
  4104. }
  4105. },
  4106. "patch": {
  4107. "consumes": [
  4108. "application/json"
  4109. ],
  4110. "produces": [
  4111. "application/json"
  4112. ],
  4113. "tags": [
  4114. "repository"
  4115. ],
  4116. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  4117. "operationId": "repoEditBranchProtection",
  4118. "parameters": [
  4119. {
  4120. "type": "string",
  4121. "description": "owner of the repo",
  4122. "name": "owner",
  4123. "in": "path",
  4124. "required": true
  4125. },
  4126. {
  4127. "type": "string",
  4128. "description": "name of the repo",
  4129. "name": "repo",
  4130. "in": "path",
  4131. "required": true
  4132. },
  4133. {
  4134. "type": "string",
  4135. "description": "name of protected branch",
  4136. "name": "name",
  4137. "in": "path",
  4138. "required": true
  4139. },
  4140. {
  4141. "name": "body",
  4142. "in": "body",
  4143. "schema": {
  4144. "$ref": "#/definitions/EditBranchProtectionOption"
  4145. }
  4146. }
  4147. ],
  4148. "responses": {
  4149. "200": {
  4150. "$ref": "#/responses/BranchProtection"
  4151. },
  4152. "404": {
  4153. "$ref": "#/responses/notFound"
  4154. },
  4155. "422": {
  4156. "$ref": "#/responses/validationError"
  4157. },
  4158. "423": {
  4159. "$ref": "#/responses/repoArchivedError"
  4160. }
  4161. }
  4162. }
  4163. },
  4164. "/repos/{owner}/{repo}/branches": {
  4165. "get": {
  4166. "produces": [
  4167. "application/json"
  4168. ],
  4169. "tags": [
  4170. "repository"
  4171. ],
  4172. "summary": "List a repository's branches",
  4173. "operationId": "repoListBranches",
  4174. "parameters": [
  4175. {
  4176. "type": "string",
  4177. "description": "owner of the repo",
  4178. "name": "owner",
  4179. "in": "path",
  4180. "required": true
  4181. },
  4182. {
  4183. "type": "string",
  4184. "description": "name of the repo",
  4185. "name": "repo",
  4186. "in": "path",
  4187. "required": true
  4188. },
  4189. {
  4190. "type": "integer",
  4191. "description": "page number of results to return (1-based)",
  4192. "name": "page",
  4193. "in": "query"
  4194. },
  4195. {
  4196. "type": "integer",
  4197. "description": "page size of results",
  4198. "name": "limit",
  4199. "in": "query"
  4200. }
  4201. ],
  4202. "responses": {
  4203. "200": {
  4204. "$ref": "#/responses/BranchList"
  4205. }
  4206. }
  4207. },
  4208. "post": {
  4209. "consumes": [
  4210. "application/json"
  4211. ],
  4212. "produces": [
  4213. "application/json"
  4214. ],
  4215. "tags": [
  4216. "repository"
  4217. ],
  4218. "summary": "Create a branch",
  4219. "operationId": "repoCreateBranch",
  4220. "parameters": [
  4221. {
  4222. "type": "string",
  4223. "description": "owner of the repo",
  4224. "name": "owner",
  4225. "in": "path",
  4226. "required": true
  4227. },
  4228. {
  4229. "type": "string",
  4230. "description": "name of the repo",
  4231. "name": "repo",
  4232. "in": "path",
  4233. "required": true
  4234. },
  4235. {
  4236. "name": "body",
  4237. "in": "body",
  4238. "schema": {
  4239. "$ref": "#/definitions/CreateBranchRepoOption"
  4240. }
  4241. }
  4242. ],
  4243. "responses": {
  4244. "201": {
  4245. "$ref": "#/responses/Branch"
  4246. },
  4247. "403": {
  4248. "description": "The branch is archived or a mirror."
  4249. },
  4250. "404": {
  4251. "description": "The old branch does not exist."
  4252. },
  4253. "409": {
  4254. "description": "The branch with the same name already exists."
  4255. },
  4256. "423": {
  4257. "$ref": "#/responses/repoArchivedError"
  4258. }
  4259. }
  4260. }
  4261. },
  4262. "/repos/{owner}/{repo}/branches/{branch}": {
  4263. "get": {
  4264. "produces": [
  4265. "application/json"
  4266. ],
  4267. "tags": [
  4268. "repository"
  4269. ],
  4270. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  4271. "operationId": "repoGetBranch",
  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": "branch to get",
  4290. "name": "branch",
  4291. "in": "path",
  4292. "required": true
  4293. }
  4294. ],
  4295. "responses": {
  4296. "200": {
  4297. "$ref": "#/responses/Branch"
  4298. },
  4299. "404": {
  4300. "$ref": "#/responses/notFound"
  4301. }
  4302. }
  4303. },
  4304. "delete": {
  4305. "produces": [
  4306. "application/json"
  4307. ],
  4308. "tags": [
  4309. "repository"
  4310. ],
  4311. "summary": "Delete a specific branch from a repository",
  4312. "operationId": "repoDeleteBranch",
  4313. "parameters": [
  4314. {
  4315. "type": "string",
  4316. "description": "owner of the repo",
  4317. "name": "owner",
  4318. "in": "path",
  4319. "required": true
  4320. },
  4321. {
  4322. "type": "string",
  4323. "description": "name of the repo",
  4324. "name": "repo",
  4325. "in": "path",
  4326. "required": true
  4327. },
  4328. {
  4329. "type": "string",
  4330. "description": "branch to delete",
  4331. "name": "branch",
  4332. "in": "path",
  4333. "required": true
  4334. }
  4335. ],
  4336. "responses": {
  4337. "204": {
  4338. "$ref": "#/responses/empty"
  4339. },
  4340. "403": {
  4341. "$ref": "#/responses/error"
  4342. },
  4343. "404": {
  4344. "$ref": "#/responses/notFound"
  4345. },
  4346. "423": {
  4347. "$ref": "#/responses/repoArchivedError"
  4348. }
  4349. }
  4350. }
  4351. },
  4352. "/repos/{owner}/{repo}/collaborators": {
  4353. "get": {
  4354. "produces": [
  4355. "application/json"
  4356. ],
  4357. "tags": [
  4358. "repository"
  4359. ],
  4360. "summary": "List a repository's collaborators",
  4361. "operationId": "repoListCollaborators",
  4362. "parameters": [
  4363. {
  4364. "type": "string",
  4365. "description": "owner of the repo",
  4366. "name": "owner",
  4367. "in": "path",
  4368. "required": true
  4369. },
  4370. {
  4371. "type": "string",
  4372. "description": "name of the repo",
  4373. "name": "repo",
  4374. "in": "path",
  4375. "required": true
  4376. },
  4377. {
  4378. "type": "integer",
  4379. "description": "page number of results to return (1-based)",
  4380. "name": "page",
  4381. "in": "query"
  4382. },
  4383. {
  4384. "type": "integer",
  4385. "description": "page size of results",
  4386. "name": "limit",
  4387. "in": "query"
  4388. }
  4389. ],
  4390. "responses": {
  4391. "200": {
  4392. "$ref": "#/responses/UserList"
  4393. },
  4394. "404": {
  4395. "$ref": "#/responses/notFound"
  4396. }
  4397. }
  4398. }
  4399. },
  4400. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  4401. "get": {
  4402. "produces": [
  4403. "application/json"
  4404. ],
  4405. "tags": [
  4406. "repository"
  4407. ],
  4408. "summary": "Check if a user is a collaborator of a repository",
  4409. "operationId": "repoCheckCollaborator",
  4410. "parameters": [
  4411. {
  4412. "type": "string",
  4413. "description": "owner of the repo",
  4414. "name": "owner",
  4415. "in": "path",
  4416. "required": true
  4417. },
  4418. {
  4419. "type": "string",
  4420. "description": "name of the repo",
  4421. "name": "repo",
  4422. "in": "path",
  4423. "required": true
  4424. },
  4425. {
  4426. "type": "string",
  4427. "description": "username of the collaborator",
  4428. "name": "collaborator",
  4429. "in": "path",
  4430. "required": true
  4431. }
  4432. ],
  4433. "responses": {
  4434. "204": {
  4435. "$ref": "#/responses/empty"
  4436. },
  4437. "404": {
  4438. "$ref": "#/responses/notFound"
  4439. },
  4440. "422": {
  4441. "$ref": "#/responses/validationError"
  4442. }
  4443. }
  4444. },
  4445. "put": {
  4446. "produces": [
  4447. "application/json"
  4448. ],
  4449. "tags": [
  4450. "repository"
  4451. ],
  4452. "summary": "Add a collaborator to a repository",
  4453. "operationId": "repoAddCollaborator",
  4454. "parameters": [
  4455. {
  4456. "type": "string",
  4457. "description": "owner of the repo",
  4458. "name": "owner",
  4459. "in": "path",
  4460. "required": true
  4461. },
  4462. {
  4463. "type": "string",
  4464. "description": "name of the repo",
  4465. "name": "repo",
  4466. "in": "path",
  4467. "required": true
  4468. },
  4469. {
  4470. "type": "string",
  4471. "description": "username of the collaborator to add",
  4472. "name": "collaborator",
  4473. "in": "path",
  4474. "required": true
  4475. },
  4476. {
  4477. "name": "body",
  4478. "in": "body",
  4479. "schema": {
  4480. "$ref": "#/definitions/AddCollaboratorOption"
  4481. }
  4482. }
  4483. ],
  4484. "responses": {
  4485. "204": {
  4486. "$ref": "#/responses/empty"
  4487. },
  4488. "403": {
  4489. "$ref": "#/responses/forbidden"
  4490. },
  4491. "404": {
  4492. "$ref": "#/responses/notFound"
  4493. },
  4494. "422": {
  4495. "$ref": "#/responses/validationError"
  4496. }
  4497. }
  4498. },
  4499. "delete": {
  4500. "produces": [
  4501. "application/json"
  4502. ],
  4503. "tags": [
  4504. "repository"
  4505. ],
  4506. "summary": "Delete a collaborator from a repository",
  4507. "operationId": "repoDeleteCollaborator",
  4508. "parameters": [
  4509. {
  4510. "type": "string",
  4511. "description": "owner of the repo",
  4512. "name": "owner",
  4513. "in": "path",
  4514. "required": true
  4515. },
  4516. {
  4517. "type": "string",
  4518. "description": "name of the repo",
  4519. "name": "repo",
  4520. "in": "path",
  4521. "required": true
  4522. },
  4523. {
  4524. "type": "string",
  4525. "description": "username of the collaborator to delete",
  4526. "name": "collaborator",
  4527. "in": "path",
  4528. "required": true
  4529. }
  4530. ],
  4531. "responses": {
  4532. "204": {
  4533. "$ref": "#/responses/empty"
  4534. },
  4535. "404": {
  4536. "$ref": "#/responses/notFound"
  4537. },
  4538. "422": {
  4539. "$ref": "#/responses/validationError"
  4540. }
  4541. }
  4542. }
  4543. },
  4544. "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
  4545. "get": {
  4546. "produces": [
  4547. "application/json"
  4548. ],
  4549. "tags": [
  4550. "repository"
  4551. ],
  4552. "summary": "Get repository permissions for a user",
  4553. "operationId": "repoGetRepoPermissions",
  4554. "parameters": [
  4555. {
  4556. "type": "string",
  4557. "description": "owner of the repo",
  4558. "name": "owner",
  4559. "in": "path",
  4560. "required": true
  4561. },
  4562. {
  4563. "type": "string",
  4564. "description": "name of the repo",
  4565. "name": "repo",
  4566. "in": "path",
  4567. "required": true
  4568. },
  4569. {
  4570. "type": "string",
  4571. "description": "username of the collaborator",
  4572. "name": "collaborator",
  4573. "in": "path",
  4574. "required": true
  4575. }
  4576. ],
  4577. "responses": {
  4578. "200": {
  4579. "$ref": "#/responses/RepoCollaboratorPermission"
  4580. },
  4581. "403": {
  4582. "$ref": "#/responses/forbidden"
  4583. },
  4584. "404": {
  4585. "$ref": "#/responses/notFound"
  4586. }
  4587. }
  4588. }
  4589. },
  4590. "/repos/{owner}/{repo}/commits": {
  4591. "get": {
  4592. "produces": [
  4593. "application/json"
  4594. ],
  4595. "tags": [
  4596. "repository"
  4597. ],
  4598. "summary": "Get a list of all commits from a repository",
  4599. "operationId": "repoGetAllCommits",
  4600. "parameters": [
  4601. {
  4602. "type": "string",
  4603. "description": "owner of the repo",
  4604. "name": "owner",
  4605. "in": "path",
  4606. "required": true
  4607. },
  4608. {
  4609. "type": "string",
  4610. "description": "name of the repo",
  4611. "name": "repo",
  4612. "in": "path",
  4613. "required": true
  4614. },
  4615. {
  4616. "type": "string",
  4617. "description": "SHA or branch to start listing commits from (usually 'master')",
  4618. "name": "sha",
  4619. "in": "query"
  4620. },
  4621. {
  4622. "type": "string",
  4623. "description": "filepath of a file/dir",
  4624. "name": "path",
  4625. "in": "query"
  4626. },
  4627. {
  4628. "type": "boolean",
  4629. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  4630. "name": "stat",
  4631. "in": "query"
  4632. },
  4633. {
  4634. "type": "boolean",
  4635. "description": "include verification for every commit (disable for speedup, default 'true')",
  4636. "name": "verification",
  4637. "in": "query"
  4638. },
  4639. {
  4640. "type": "boolean",
  4641. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  4642. "name": "files",
  4643. "in": "query"
  4644. },
  4645. {
  4646. "type": "integer",
  4647. "description": "page number of results to return (1-based)",
  4648. "name": "page",
  4649. "in": "query"
  4650. },
  4651. {
  4652. "type": "integer",
  4653. "description": "page size of results (ignored if used with 'path')",
  4654. "name": "limit",
  4655. "in": "query"
  4656. },
  4657. {
  4658. "type": "string",
  4659. "description": "commits that match the given specifier will not be listed.",
  4660. "name": "not",
  4661. "in": "query"
  4662. }
  4663. ],
  4664. "responses": {
  4665. "200": {
  4666. "$ref": "#/responses/CommitList"
  4667. },
  4668. "404": {
  4669. "$ref": "#/responses/notFound"
  4670. },
  4671. "409": {
  4672. "$ref": "#/responses/EmptyRepository"
  4673. }
  4674. }
  4675. }
  4676. },
  4677. "/repos/{owner}/{repo}/commits/{ref}/status": {
  4678. "get": {
  4679. "produces": [
  4680. "application/json"
  4681. ],
  4682. "tags": [
  4683. "repository"
  4684. ],
  4685. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  4686. "operationId": "repoGetCombinedStatusByRef",
  4687. "parameters": [
  4688. {
  4689. "type": "string",
  4690. "description": "owner of the repo",
  4691. "name": "owner",
  4692. "in": "path",
  4693. "required": true
  4694. },
  4695. {
  4696. "type": "string",
  4697. "description": "name of the repo",
  4698. "name": "repo",
  4699. "in": "path",
  4700. "required": true
  4701. },
  4702. {
  4703. "type": "string",
  4704. "description": "name of branch/tag/commit",
  4705. "name": "ref",
  4706. "in": "path",
  4707. "required": true
  4708. },
  4709. {
  4710. "type": "integer",
  4711. "description": "page number of results to return (1-based)",
  4712. "name": "page",
  4713. "in": "query"
  4714. },
  4715. {
  4716. "type": "integer",
  4717. "description": "page size of results",
  4718. "name": "limit",
  4719. "in": "query"
  4720. }
  4721. ],
  4722. "responses": {
  4723. "200": {
  4724. "$ref": "#/responses/CombinedStatus"
  4725. },
  4726. "400": {
  4727. "$ref": "#/responses/error"
  4728. },
  4729. "404": {
  4730. "$ref": "#/responses/notFound"
  4731. }
  4732. }
  4733. }
  4734. },
  4735. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  4736. "get": {
  4737. "produces": [
  4738. "application/json"
  4739. ],
  4740. "tags": [
  4741. "repository"
  4742. ],
  4743. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  4744. "operationId": "repoListStatusesByRef",
  4745. "parameters": [
  4746. {
  4747. "type": "string",
  4748. "description": "owner of the repo",
  4749. "name": "owner",
  4750. "in": "path",
  4751. "required": true
  4752. },
  4753. {
  4754. "type": "string",
  4755. "description": "name of the repo",
  4756. "name": "repo",
  4757. "in": "path",
  4758. "required": true
  4759. },
  4760. {
  4761. "type": "string",
  4762. "description": "name of branch/tag/commit",
  4763. "name": "ref",
  4764. "in": "path",
  4765. "required": true
  4766. },
  4767. {
  4768. "enum": [
  4769. "oldest",
  4770. "recentupdate",
  4771. "leastupdate",
  4772. "leastindex",
  4773. "highestindex"
  4774. ],
  4775. "type": "string",
  4776. "description": "type of sort",
  4777. "name": "sort",
  4778. "in": "query"
  4779. },
  4780. {
  4781. "enum": [
  4782. "pending",
  4783. "success",
  4784. "error",
  4785. "failure",
  4786. "warning"
  4787. ],
  4788. "type": "string",
  4789. "description": "type of state",
  4790. "name": "state",
  4791. "in": "query"
  4792. },
  4793. {
  4794. "type": "integer",
  4795. "description": "page number of results to return (1-based)",
  4796. "name": "page",
  4797. "in": "query"
  4798. },
  4799. {
  4800. "type": "integer",
  4801. "description": "page size of results",
  4802. "name": "limit",
  4803. "in": "query"
  4804. }
  4805. ],
  4806. "responses": {
  4807. "200": {
  4808. "$ref": "#/responses/CommitStatusList"
  4809. },
  4810. "400": {
  4811. "$ref": "#/responses/error"
  4812. },
  4813. "404": {
  4814. "$ref": "#/responses/notFound"
  4815. }
  4816. }
  4817. }
  4818. },
  4819. "/repos/{owner}/{repo}/commits/{sha}/pull": {
  4820. "get": {
  4821. "produces": [
  4822. "application/json"
  4823. ],
  4824. "tags": [
  4825. "repository"
  4826. ],
  4827. "summary": "Get the pull request of the commit",
  4828. "operationId": "repoGetCommitPullRequest",
  4829. "parameters": [
  4830. {
  4831. "type": "string",
  4832. "description": "owner of the repo",
  4833. "name": "owner",
  4834. "in": "path",
  4835. "required": true
  4836. },
  4837. {
  4838. "type": "string",
  4839. "description": "name of the repo",
  4840. "name": "repo",
  4841. "in": "path",
  4842. "required": true
  4843. },
  4844. {
  4845. "type": "string",
  4846. "description": "SHA of the commit to get",
  4847. "name": "sha",
  4848. "in": "path",
  4849. "required": true
  4850. }
  4851. ],
  4852. "responses": {
  4853. "200": {
  4854. "$ref": "#/responses/PullRequest"
  4855. },
  4856. "404": {
  4857. "$ref": "#/responses/notFound"
  4858. }
  4859. }
  4860. }
  4861. },
  4862. "/repos/{owner}/{repo}/contents": {
  4863. "get": {
  4864. "produces": [
  4865. "application/json"
  4866. ],
  4867. "tags": [
  4868. "repository"
  4869. ],
  4870. "summary": "Gets the metadata of all the entries of the root dir",
  4871. "operationId": "repoGetContentsList",
  4872. "parameters": [
  4873. {
  4874. "type": "string",
  4875. "description": "owner of the repo",
  4876. "name": "owner",
  4877. "in": "path",
  4878. "required": true
  4879. },
  4880. {
  4881. "type": "string",
  4882. "description": "name of the repo",
  4883. "name": "repo",
  4884. "in": "path",
  4885. "required": true
  4886. },
  4887. {
  4888. "type": "string",
  4889. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4890. "name": "ref",
  4891. "in": "query"
  4892. }
  4893. ],
  4894. "responses": {
  4895. "200": {
  4896. "$ref": "#/responses/ContentsListResponse"
  4897. },
  4898. "404": {
  4899. "$ref": "#/responses/notFound"
  4900. }
  4901. }
  4902. },
  4903. "post": {
  4904. "consumes": [
  4905. "application/json"
  4906. ],
  4907. "produces": [
  4908. "application/json"
  4909. ],
  4910. "tags": [
  4911. "repository"
  4912. ],
  4913. "summary": "Modify multiple files in a repository",
  4914. "operationId": "repoChangeFiles",
  4915. "parameters": [
  4916. {
  4917. "type": "string",
  4918. "description": "owner of the repo",
  4919. "name": "owner",
  4920. "in": "path",
  4921. "required": true
  4922. },
  4923. {
  4924. "type": "string",
  4925. "description": "name of the repo",
  4926. "name": "repo",
  4927. "in": "path",
  4928. "required": true
  4929. },
  4930. {
  4931. "name": "body",
  4932. "in": "body",
  4933. "required": true,
  4934. "schema": {
  4935. "$ref": "#/definitions/ChangeFilesOptions"
  4936. }
  4937. }
  4938. ],
  4939. "responses": {
  4940. "201": {
  4941. "$ref": "#/responses/FilesResponse"
  4942. },
  4943. "403": {
  4944. "$ref": "#/responses/error"
  4945. },
  4946. "404": {
  4947. "$ref": "#/responses/notFound"
  4948. },
  4949. "422": {
  4950. "$ref": "#/responses/error"
  4951. },
  4952. "423": {
  4953. "$ref": "#/responses/repoArchivedError"
  4954. }
  4955. }
  4956. }
  4957. },
  4958. "/repos/{owner}/{repo}/contents/{filepath}": {
  4959. "get": {
  4960. "produces": [
  4961. "application/json"
  4962. ],
  4963. "tags": [
  4964. "repository"
  4965. ],
  4966. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  4967. "operationId": "repoGetContents",
  4968. "parameters": [
  4969. {
  4970. "type": "string",
  4971. "description": "owner of the repo",
  4972. "name": "owner",
  4973. "in": "path",
  4974. "required": true
  4975. },
  4976. {
  4977. "type": "string",
  4978. "description": "name of the repo",
  4979. "name": "repo",
  4980. "in": "path",
  4981. "required": true
  4982. },
  4983. {
  4984. "type": "string",
  4985. "description": "path of the dir, file, symlink or submodule in the repo",
  4986. "name": "filepath",
  4987. "in": "path",
  4988. "required": true
  4989. },
  4990. {
  4991. "type": "string",
  4992. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4993. "name": "ref",
  4994. "in": "query"
  4995. }
  4996. ],
  4997. "responses": {
  4998. "200": {
  4999. "$ref": "#/responses/ContentsResponse"
  5000. },
  5001. "404": {
  5002. "$ref": "#/responses/notFound"
  5003. }
  5004. }
  5005. },
  5006. "put": {
  5007. "consumes": [
  5008. "application/json"
  5009. ],
  5010. "produces": [
  5011. "application/json"
  5012. ],
  5013. "tags": [
  5014. "repository"
  5015. ],
  5016. "summary": "Update a file in a repository",
  5017. "operationId": "repoUpdateFile",
  5018. "parameters": [
  5019. {
  5020. "type": "string",
  5021. "description": "owner of the repo",
  5022. "name": "owner",
  5023. "in": "path",
  5024. "required": true
  5025. },
  5026. {
  5027. "type": "string",
  5028. "description": "name of the repo",
  5029. "name": "repo",
  5030. "in": "path",
  5031. "required": true
  5032. },
  5033. {
  5034. "type": "string",
  5035. "description": "path of the file to update",
  5036. "name": "filepath",
  5037. "in": "path",
  5038. "required": true
  5039. },
  5040. {
  5041. "name": "body",
  5042. "in": "body",
  5043. "required": true,
  5044. "schema": {
  5045. "$ref": "#/definitions/UpdateFileOptions"
  5046. }
  5047. }
  5048. ],
  5049. "responses": {
  5050. "200": {
  5051. "$ref": "#/responses/FileResponse"
  5052. },
  5053. "403": {
  5054. "$ref": "#/responses/error"
  5055. },
  5056. "404": {
  5057. "$ref": "#/responses/notFound"
  5058. },
  5059. "422": {
  5060. "$ref": "#/responses/error"
  5061. },
  5062. "423": {
  5063. "$ref": "#/responses/repoArchivedError"
  5064. }
  5065. }
  5066. },
  5067. "post": {
  5068. "consumes": [
  5069. "application/json"
  5070. ],
  5071. "produces": [
  5072. "application/json"
  5073. ],
  5074. "tags": [
  5075. "repository"
  5076. ],
  5077. "summary": "Create a file in a repository",
  5078. "operationId": "repoCreateFile",
  5079. "parameters": [
  5080. {
  5081. "type": "string",
  5082. "description": "owner of the repo",
  5083. "name": "owner",
  5084. "in": "path",
  5085. "required": true
  5086. },
  5087. {
  5088. "type": "string",
  5089. "description": "name of the repo",
  5090. "name": "repo",
  5091. "in": "path",
  5092. "required": true
  5093. },
  5094. {
  5095. "type": "string",
  5096. "description": "path of the file to create",
  5097. "name": "filepath",
  5098. "in": "path",
  5099. "required": true
  5100. },
  5101. {
  5102. "name": "body",
  5103. "in": "body",
  5104. "required": true,
  5105. "schema": {
  5106. "$ref": "#/definitions/CreateFileOptions"
  5107. }
  5108. }
  5109. ],
  5110. "responses": {
  5111. "201": {
  5112. "$ref": "#/responses/FileResponse"
  5113. },
  5114. "403": {
  5115. "$ref": "#/responses/error"
  5116. },
  5117. "404": {
  5118. "$ref": "#/responses/notFound"
  5119. },
  5120. "422": {
  5121. "$ref": "#/responses/error"
  5122. },
  5123. "423": {
  5124. "$ref": "#/responses/repoArchivedError"
  5125. }
  5126. }
  5127. },
  5128. "delete": {
  5129. "consumes": [
  5130. "application/json"
  5131. ],
  5132. "produces": [
  5133. "application/json"
  5134. ],
  5135. "tags": [
  5136. "repository"
  5137. ],
  5138. "summary": "Delete a file in a repository",
  5139. "operationId": "repoDeleteFile",
  5140. "parameters": [
  5141. {
  5142. "type": "string",
  5143. "description": "owner of the repo",
  5144. "name": "owner",
  5145. "in": "path",
  5146. "required": true
  5147. },
  5148. {
  5149. "type": "string",
  5150. "description": "name of the repo",
  5151. "name": "repo",
  5152. "in": "path",
  5153. "required": true
  5154. },
  5155. {
  5156. "type": "string",
  5157. "description": "path of the file to delete",
  5158. "name": "filepath",
  5159. "in": "path",
  5160. "required": true
  5161. },
  5162. {
  5163. "name": "body",
  5164. "in": "body",
  5165. "required": true,
  5166. "schema": {
  5167. "$ref": "#/definitions/DeleteFileOptions"
  5168. }
  5169. }
  5170. ],
  5171. "responses": {
  5172. "200": {
  5173. "$ref": "#/responses/FileDeleteResponse"
  5174. },
  5175. "400": {
  5176. "$ref": "#/responses/error"
  5177. },
  5178. "403": {
  5179. "$ref": "#/responses/error"
  5180. },
  5181. "404": {
  5182. "$ref": "#/responses/error"
  5183. },
  5184. "423": {
  5185. "$ref": "#/responses/repoArchivedError"
  5186. }
  5187. }
  5188. }
  5189. },
  5190. "/repos/{owner}/{repo}/diffpatch": {
  5191. "post": {
  5192. "consumes": [
  5193. "application/json"
  5194. ],
  5195. "produces": [
  5196. "application/json"
  5197. ],
  5198. "tags": [
  5199. "repository"
  5200. ],
  5201. "summary": "Apply diff patch to repository",
  5202. "operationId": "repoApplyDiffPatch",
  5203. "parameters": [
  5204. {
  5205. "type": "string",
  5206. "description": "owner of the repo",
  5207. "name": "owner",
  5208. "in": "path",
  5209. "required": true
  5210. },
  5211. {
  5212. "type": "string",
  5213. "description": "name of the repo",
  5214. "name": "repo",
  5215. "in": "path",
  5216. "required": true
  5217. },
  5218. {
  5219. "name": "body",
  5220. "in": "body",
  5221. "required": true,
  5222. "schema": {
  5223. "$ref": "#/definitions/UpdateFileOptions"
  5224. }
  5225. }
  5226. ],
  5227. "responses": {
  5228. "200": {
  5229. "$ref": "#/responses/FileResponse"
  5230. },
  5231. "404": {
  5232. "$ref": "#/responses/notFound"
  5233. },
  5234. "423": {
  5235. "$ref": "#/responses/repoArchivedError"
  5236. }
  5237. }
  5238. }
  5239. },
  5240. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  5241. "get": {
  5242. "produces": [
  5243. "application/json"
  5244. ],
  5245. "tags": [
  5246. "repository"
  5247. ],
  5248. "summary": "Get the EditorConfig definitions of a file in a repository",
  5249. "operationId": "repoGetEditorConfig",
  5250. "parameters": [
  5251. {
  5252. "type": "string",
  5253. "description": "owner of the repo",
  5254. "name": "owner",
  5255. "in": "path",
  5256. "required": true
  5257. },
  5258. {
  5259. "type": "string",
  5260. "description": "name of the repo",
  5261. "name": "repo",
  5262. "in": "path",
  5263. "required": true
  5264. },
  5265. {
  5266. "type": "string",
  5267. "description": "filepath of file to get",
  5268. "name": "filepath",
  5269. "in": "path",
  5270. "required": true
  5271. },
  5272. {
  5273. "type": "string",
  5274. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  5275. "name": "ref",
  5276. "in": "query"
  5277. }
  5278. ],
  5279. "responses": {
  5280. "200": {
  5281. "description": "success"
  5282. },
  5283. "404": {
  5284. "$ref": "#/responses/notFound"
  5285. }
  5286. }
  5287. }
  5288. },
  5289. "/repos/{owner}/{repo}/forks": {
  5290. "get": {
  5291. "produces": [
  5292. "application/json"
  5293. ],
  5294. "tags": [
  5295. "repository"
  5296. ],
  5297. "summary": "List a repository's forks",
  5298. "operationId": "listForks",
  5299. "parameters": [
  5300. {
  5301. "type": "string",
  5302. "description": "owner of the repo",
  5303. "name": "owner",
  5304. "in": "path",
  5305. "required": true
  5306. },
  5307. {
  5308. "type": "string",
  5309. "description": "name of the repo",
  5310. "name": "repo",
  5311. "in": "path",
  5312. "required": true
  5313. },
  5314. {
  5315. "type": "integer",
  5316. "description": "page number of results to return (1-based)",
  5317. "name": "page",
  5318. "in": "query"
  5319. },
  5320. {
  5321. "type": "integer",
  5322. "description": "page size of results",
  5323. "name": "limit",
  5324. "in": "query"
  5325. }
  5326. ],
  5327. "responses": {
  5328. "200": {
  5329. "$ref": "#/responses/RepositoryList"
  5330. },
  5331. "404": {
  5332. "$ref": "#/responses/notFound"
  5333. }
  5334. }
  5335. },
  5336. "post": {
  5337. "produces": [
  5338. "application/json"
  5339. ],
  5340. "tags": [
  5341. "repository"
  5342. ],
  5343. "summary": "Fork a repository",
  5344. "operationId": "createFork",
  5345. "parameters": [
  5346. {
  5347. "type": "string",
  5348. "description": "owner of the repo to fork",
  5349. "name": "owner",
  5350. "in": "path",
  5351. "required": true
  5352. },
  5353. {
  5354. "type": "string",
  5355. "description": "name of the repo to fork",
  5356. "name": "repo",
  5357. "in": "path",
  5358. "required": true
  5359. },
  5360. {
  5361. "name": "body",
  5362. "in": "body",
  5363. "schema": {
  5364. "$ref": "#/definitions/CreateForkOption"
  5365. }
  5366. }
  5367. ],
  5368. "responses": {
  5369. "202": {
  5370. "$ref": "#/responses/Repository"
  5371. },
  5372. "403": {
  5373. "$ref": "#/responses/forbidden"
  5374. },
  5375. "404": {
  5376. "$ref": "#/responses/notFound"
  5377. },
  5378. "409": {
  5379. "description": "The repository with the same name already exists."
  5380. },
  5381. "422": {
  5382. "$ref": "#/responses/validationError"
  5383. }
  5384. }
  5385. }
  5386. },
  5387. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  5388. "get": {
  5389. "produces": [
  5390. "application/json"
  5391. ],
  5392. "tags": [
  5393. "repository"
  5394. ],
  5395. "summary": "Gets the blob of a repository.",
  5396. "operationId": "GetBlob",
  5397. "parameters": [
  5398. {
  5399. "type": "string",
  5400. "description": "owner of the repo",
  5401. "name": "owner",
  5402. "in": "path",
  5403. "required": true
  5404. },
  5405. {
  5406. "type": "string",
  5407. "description": "name of the repo",
  5408. "name": "repo",
  5409. "in": "path",
  5410. "required": true
  5411. },
  5412. {
  5413. "type": "string",
  5414. "description": "sha of the commit",
  5415. "name": "sha",
  5416. "in": "path",
  5417. "required": true
  5418. }
  5419. ],
  5420. "responses": {
  5421. "200": {
  5422. "$ref": "#/responses/GitBlobResponse"
  5423. },
  5424. "400": {
  5425. "$ref": "#/responses/error"
  5426. },
  5427. "404": {
  5428. "$ref": "#/responses/notFound"
  5429. }
  5430. }
  5431. }
  5432. },
  5433. "/repos/{owner}/{repo}/git/commits/{sha}": {
  5434. "get": {
  5435. "produces": [
  5436. "application/json"
  5437. ],
  5438. "tags": [
  5439. "repository"
  5440. ],
  5441. "summary": "Get a single commit from a repository",
  5442. "operationId": "repoGetSingleCommit",
  5443. "parameters": [
  5444. {
  5445. "type": "string",
  5446. "description": "owner of the repo",
  5447. "name": "owner",
  5448. "in": "path",
  5449. "required": true
  5450. },
  5451. {
  5452. "type": "string",
  5453. "description": "name of the repo",
  5454. "name": "repo",
  5455. "in": "path",
  5456. "required": true
  5457. },
  5458. {
  5459. "type": "string",
  5460. "description": "a git ref or commit sha",
  5461. "name": "sha",
  5462. "in": "path",
  5463. "required": true
  5464. },
  5465. {
  5466. "type": "boolean",
  5467. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  5468. "name": "stat",
  5469. "in": "query"
  5470. },
  5471. {
  5472. "type": "boolean",
  5473. "description": "include verification for every commit (disable for speedup, default 'true')",
  5474. "name": "verification",
  5475. "in": "query"
  5476. },
  5477. {
  5478. "type": "boolean",
  5479. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5480. "name": "files",
  5481. "in": "query"
  5482. }
  5483. ],
  5484. "responses": {
  5485. "200": {
  5486. "$ref": "#/responses/Commit"
  5487. },
  5488. "404": {
  5489. "$ref": "#/responses/notFound"
  5490. },
  5491. "422": {
  5492. "$ref": "#/responses/validationError"
  5493. }
  5494. }
  5495. }
  5496. },
  5497. "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
  5498. "get": {
  5499. "produces": [
  5500. "text/plain"
  5501. ],
  5502. "tags": [
  5503. "repository"
  5504. ],
  5505. "summary": "Get a commit's diff or patch",
  5506. "operationId": "repoDownloadCommitDiffOrPatch",
  5507. "parameters": [
  5508. {
  5509. "type": "string",
  5510. "description": "owner of the repo",
  5511. "name": "owner",
  5512. "in": "path",
  5513. "required": true
  5514. },
  5515. {
  5516. "type": "string",
  5517. "description": "name of the repo",
  5518. "name": "repo",
  5519. "in": "path",
  5520. "required": true
  5521. },
  5522. {
  5523. "type": "string",
  5524. "description": "SHA of the commit to get",
  5525. "name": "sha",
  5526. "in": "path",
  5527. "required": true
  5528. },
  5529. {
  5530. "enum": [
  5531. "diff",
  5532. "patch"
  5533. ],
  5534. "type": "string",
  5535. "description": "whether the output is diff or patch",
  5536. "name": "diffType",
  5537. "in": "path",
  5538. "required": true
  5539. }
  5540. ],
  5541. "responses": {
  5542. "200": {
  5543. "$ref": "#/responses/string"
  5544. },
  5545. "404": {
  5546. "$ref": "#/responses/notFound"
  5547. }
  5548. }
  5549. }
  5550. },
  5551. "/repos/{owner}/{repo}/git/notes/{sha}": {
  5552. "get": {
  5553. "produces": [
  5554. "application/json"
  5555. ],
  5556. "tags": [
  5557. "repository"
  5558. ],
  5559. "summary": "Get a note corresponding to a single commit from a repository",
  5560. "operationId": "repoGetNote",
  5561. "parameters": [
  5562. {
  5563. "type": "string",
  5564. "description": "owner of the repo",
  5565. "name": "owner",
  5566. "in": "path",
  5567. "required": true
  5568. },
  5569. {
  5570. "type": "string",
  5571. "description": "name of the repo",
  5572. "name": "repo",
  5573. "in": "path",
  5574. "required": true
  5575. },
  5576. {
  5577. "type": "string",
  5578. "description": "a git ref or commit sha",
  5579. "name": "sha",
  5580. "in": "path",
  5581. "required": true
  5582. },
  5583. {
  5584. "type": "boolean",
  5585. "description": "include verification for every commit (disable for speedup, default 'true')",
  5586. "name": "verification",
  5587. "in": "query"
  5588. },
  5589. {
  5590. "type": "boolean",
  5591. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5592. "name": "files",
  5593. "in": "query"
  5594. }
  5595. ],
  5596. "responses": {
  5597. "200": {
  5598. "$ref": "#/responses/Note"
  5599. },
  5600. "404": {
  5601. "$ref": "#/responses/notFound"
  5602. },
  5603. "422": {
  5604. "$ref": "#/responses/validationError"
  5605. }
  5606. }
  5607. }
  5608. },
  5609. "/repos/{owner}/{repo}/git/refs": {
  5610. "get": {
  5611. "produces": [
  5612. "application/json"
  5613. ],
  5614. "tags": [
  5615. "repository"
  5616. ],
  5617. "summary": "Get specified ref or filtered repository's refs",
  5618. "operationId": "repoListAllGitRefs",
  5619. "parameters": [
  5620. {
  5621. "type": "string",
  5622. "description": "owner of the repo",
  5623. "name": "owner",
  5624. "in": "path",
  5625. "required": true
  5626. },
  5627. {
  5628. "type": "string",
  5629. "description": "name of the repo",
  5630. "name": "repo",
  5631. "in": "path",
  5632. "required": true
  5633. }
  5634. ],
  5635. "responses": {
  5636. "200": {
  5637. "$ref": "#/responses/ReferenceList"
  5638. },
  5639. "404": {
  5640. "$ref": "#/responses/notFound"
  5641. }
  5642. }
  5643. }
  5644. },
  5645. "/repos/{owner}/{repo}/git/refs/{ref}": {
  5646. "get": {
  5647. "produces": [
  5648. "application/json"
  5649. ],
  5650. "tags": [
  5651. "repository"
  5652. ],
  5653. "summary": "Get specified ref or filtered repository's refs",
  5654. "operationId": "repoListGitRefs",
  5655. "parameters": [
  5656. {
  5657. "type": "string",
  5658. "description": "owner of the repo",
  5659. "name": "owner",
  5660. "in": "path",
  5661. "required": true
  5662. },
  5663. {
  5664. "type": "string",
  5665. "description": "name of the repo",
  5666. "name": "repo",
  5667. "in": "path",
  5668. "required": true
  5669. },
  5670. {
  5671. "type": "string",
  5672. "description": "part or full name of the ref",
  5673. "name": "ref",
  5674. "in": "path",
  5675. "required": true
  5676. }
  5677. ],
  5678. "responses": {
  5679. "200": {
  5680. "$ref": "#/responses/ReferenceList"
  5681. },
  5682. "404": {
  5683. "$ref": "#/responses/notFound"
  5684. }
  5685. }
  5686. }
  5687. },
  5688. "/repos/{owner}/{repo}/git/tags/{sha}": {
  5689. "get": {
  5690. "produces": [
  5691. "application/json"
  5692. ],
  5693. "tags": [
  5694. "repository"
  5695. ],
  5696. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  5697. "operationId": "GetAnnotatedTag",
  5698. "parameters": [
  5699. {
  5700. "type": "string",
  5701. "description": "owner of the repo",
  5702. "name": "owner",
  5703. "in": "path",
  5704. "required": true
  5705. },
  5706. {
  5707. "type": "string",
  5708. "description": "name of the repo",
  5709. "name": "repo",
  5710. "in": "path",
  5711. "required": true
  5712. },
  5713. {
  5714. "type": "string",
  5715. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  5716. "name": "sha",
  5717. "in": "path",
  5718. "required": true
  5719. }
  5720. ],
  5721. "responses": {
  5722. "200": {
  5723. "$ref": "#/responses/AnnotatedTag"
  5724. },
  5725. "400": {
  5726. "$ref": "#/responses/error"
  5727. },
  5728. "404": {
  5729. "$ref": "#/responses/notFound"
  5730. }
  5731. }
  5732. }
  5733. },
  5734. "/repos/{owner}/{repo}/git/trees/{sha}": {
  5735. "get": {
  5736. "produces": [
  5737. "application/json"
  5738. ],
  5739. "tags": [
  5740. "repository"
  5741. ],
  5742. "summary": "Gets the tree of a repository.",
  5743. "operationId": "GetTree",
  5744. "parameters": [
  5745. {
  5746. "type": "string",
  5747. "description": "owner of the repo",
  5748. "name": "owner",
  5749. "in": "path",
  5750. "required": true
  5751. },
  5752. {
  5753. "type": "string",
  5754. "description": "name of the repo",
  5755. "name": "repo",
  5756. "in": "path",
  5757. "required": true
  5758. },
  5759. {
  5760. "type": "string",
  5761. "description": "sha of the commit",
  5762. "name": "sha",
  5763. "in": "path",
  5764. "required": true
  5765. },
  5766. {
  5767. "type": "boolean",
  5768. "description": "show all directories and files",
  5769. "name": "recursive",
  5770. "in": "query"
  5771. },
  5772. {
  5773. "type": "integer",
  5774. "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",
  5775. "name": "page",
  5776. "in": "query"
  5777. },
  5778. {
  5779. "type": "integer",
  5780. "description": "number of items per page",
  5781. "name": "per_page",
  5782. "in": "query"
  5783. }
  5784. ],
  5785. "responses": {
  5786. "200": {
  5787. "$ref": "#/responses/GitTreeResponse"
  5788. },
  5789. "400": {
  5790. "$ref": "#/responses/error"
  5791. },
  5792. "404": {
  5793. "$ref": "#/responses/notFound"
  5794. }
  5795. }
  5796. }
  5797. },
  5798. "/repos/{owner}/{repo}/hooks": {
  5799. "get": {
  5800. "produces": [
  5801. "application/json"
  5802. ],
  5803. "tags": [
  5804. "repository"
  5805. ],
  5806. "summary": "List the hooks in a repository",
  5807. "operationId": "repoListHooks",
  5808. "parameters": [
  5809. {
  5810. "type": "string",
  5811. "description": "owner of the repo",
  5812. "name": "owner",
  5813. "in": "path",
  5814. "required": true
  5815. },
  5816. {
  5817. "type": "string",
  5818. "description": "name of the repo",
  5819. "name": "repo",
  5820. "in": "path",
  5821. "required": true
  5822. },
  5823. {
  5824. "type": "integer",
  5825. "description": "page number of results to return (1-based)",
  5826. "name": "page",
  5827. "in": "query"
  5828. },
  5829. {
  5830. "type": "integer",
  5831. "description": "page size of results",
  5832. "name": "limit",
  5833. "in": "query"
  5834. }
  5835. ],
  5836. "responses": {
  5837. "200": {
  5838. "$ref": "#/responses/HookList"
  5839. },
  5840. "404": {
  5841. "$ref": "#/responses/notFound"
  5842. }
  5843. }
  5844. },
  5845. "post": {
  5846. "consumes": [
  5847. "application/json"
  5848. ],
  5849. "produces": [
  5850. "application/json"
  5851. ],
  5852. "tags": [
  5853. "repository"
  5854. ],
  5855. "summary": "Create a hook",
  5856. "operationId": "repoCreateHook",
  5857. "parameters": [
  5858. {
  5859. "type": "string",
  5860. "description": "owner of the repo",
  5861. "name": "owner",
  5862. "in": "path",
  5863. "required": true
  5864. },
  5865. {
  5866. "type": "string",
  5867. "description": "name of the repo",
  5868. "name": "repo",
  5869. "in": "path",
  5870. "required": true
  5871. },
  5872. {
  5873. "name": "body",
  5874. "in": "body",
  5875. "schema": {
  5876. "$ref": "#/definitions/CreateHookOption"
  5877. }
  5878. }
  5879. ],
  5880. "responses": {
  5881. "201": {
  5882. "$ref": "#/responses/Hook"
  5883. },
  5884. "404": {
  5885. "$ref": "#/responses/notFound"
  5886. }
  5887. }
  5888. }
  5889. },
  5890. "/repos/{owner}/{repo}/hooks/git": {
  5891. "get": {
  5892. "produces": [
  5893. "application/json"
  5894. ],
  5895. "tags": [
  5896. "repository"
  5897. ],
  5898. "summary": "List the Git hooks in a repository",
  5899. "operationId": "repoListGitHooks",
  5900. "parameters": [
  5901. {
  5902. "type": "string",
  5903. "description": "owner of the repo",
  5904. "name": "owner",
  5905. "in": "path",
  5906. "required": true
  5907. },
  5908. {
  5909. "type": "string",
  5910. "description": "name of the repo",
  5911. "name": "repo",
  5912. "in": "path",
  5913. "required": true
  5914. }
  5915. ],
  5916. "responses": {
  5917. "200": {
  5918. "$ref": "#/responses/GitHookList"
  5919. },
  5920. "404": {
  5921. "$ref": "#/responses/notFound"
  5922. }
  5923. }
  5924. }
  5925. },
  5926. "/repos/{owner}/{repo}/hooks/git/{id}": {
  5927. "get": {
  5928. "produces": [
  5929. "application/json"
  5930. ],
  5931. "tags": [
  5932. "repository"
  5933. ],
  5934. "summary": "Get a Git hook",
  5935. "operationId": "repoGetGitHook",
  5936. "parameters": [
  5937. {
  5938. "type": "string",
  5939. "description": "owner of the repo",
  5940. "name": "owner",
  5941. "in": "path",
  5942. "required": true
  5943. },
  5944. {
  5945. "type": "string",
  5946. "description": "name of the repo",
  5947. "name": "repo",
  5948. "in": "path",
  5949. "required": true
  5950. },
  5951. {
  5952. "type": "string",
  5953. "description": "id of the hook to get",
  5954. "name": "id",
  5955. "in": "path",
  5956. "required": true
  5957. }
  5958. ],
  5959. "responses": {
  5960. "200": {
  5961. "$ref": "#/responses/GitHook"
  5962. },
  5963. "404": {
  5964. "$ref": "#/responses/notFound"
  5965. }
  5966. }
  5967. },
  5968. "delete": {
  5969. "produces": [
  5970. "application/json"
  5971. ],
  5972. "tags": [
  5973. "repository"
  5974. ],
  5975. "summary": "Delete a Git hook in a repository",
  5976. "operationId": "repoDeleteGitHook",
  5977. "parameters": [
  5978. {
  5979. "type": "string",
  5980. "description": "owner of the repo",
  5981. "name": "owner",
  5982. "in": "path",
  5983. "required": true
  5984. },
  5985. {
  5986. "type": "string",
  5987. "description": "name of the repo",
  5988. "name": "repo",
  5989. "in": "path",
  5990. "required": true
  5991. },
  5992. {
  5993. "type": "string",
  5994. "description": "id of the hook to get",
  5995. "name": "id",
  5996. "in": "path",
  5997. "required": true
  5998. }
  5999. ],
  6000. "responses": {
  6001. "204": {
  6002. "$ref": "#/responses/empty"
  6003. },
  6004. "404": {
  6005. "$ref": "#/responses/notFound"
  6006. }
  6007. }
  6008. },
  6009. "patch": {
  6010. "produces": [
  6011. "application/json"
  6012. ],
  6013. "tags": [
  6014. "repository"
  6015. ],
  6016. "summary": "Edit a Git hook in a repository",
  6017. "operationId": "repoEditGitHook",
  6018. "parameters": [
  6019. {
  6020. "type": "string",
  6021. "description": "owner of the repo",
  6022. "name": "owner",
  6023. "in": "path",
  6024. "required": true
  6025. },
  6026. {
  6027. "type": "string",
  6028. "description": "name of the repo",
  6029. "name": "repo",
  6030. "in": "path",
  6031. "required": true
  6032. },
  6033. {
  6034. "type": "string",
  6035. "description": "id of the hook to get",
  6036. "name": "id",
  6037. "in": "path",
  6038. "required": true
  6039. },
  6040. {
  6041. "name": "body",
  6042. "in": "body",
  6043. "schema": {
  6044. "$ref": "#/definitions/EditGitHookOption"
  6045. }
  6046. }
  6047. ],
  6048. "responses": {
  6049. "200": {
  6050. "$ref": "#/responses/GitHook"
  6051. },
  6052. "404": {
  6053. "$ref": "#/responses/notFound"
  6054. }
  6055. }
  6056. }
  6057. },
  6058. "/repos/{owner}/{repo}/hooks/{id}": {
  6059. "get": {
  6060. "produces": [
  6061. "application/json"
  6062. ],
  6063. "tags": [
  6064. "repository"
  6065. ],
  6066. "summary": "Get a hook",
  6067. "operationId": "repoGetHook",
  6068. "parameters": [
  6069. {
  6070. "type": "string",
  6071. "description": "owner of the repo",
  6072. "name": "owner",
  6073. "in": "path",
  6074. "required": true
  6075. },
  6076. {
  6077. "type": "string",
  6078. "description": "name of the repo",
  6079. "name": "repo",
  6080. "in": "path",
  6081. "required": true
  6082. },
  6083. {
  6084. "type": "integer",
  6085. "format": "int64",
  6086. "description": "id of the hook to get",
  6087. "name": "id",
  6088. "in": "path",
  6089. "required": true
  6090. }
  6091. ],
  6092. "responses": {
  6093. "200": {
  6094. "$ref": "#/responses/Hook"
  6095. },
  6096. "404": {
  6097. "$ref": "#/responses/notFound"
  6098. }
  6099. }
  6100. },
  6101. "delete": {
  6102. "produces": [
  6103. "application/json"
  6104. ],
  6105. "tags": [
  6106. "repository"
  6107. ],
  6108. "summary": "Delete a hook in a repository",
  6109. "operationId": "repoDeleteHook",
  6110. "parameters": [
  6111. {
  6112. "type": "string",
  6113. "description": "owner of the repo",
  6114. "name": "owner",
  6115. "in": "path",
  6116. "required": true
  6117. },
  6118. {
  6119. "type": "string",
  6120. "description": "name of the repo",
  6121. "name": "repo",
  6122. "in": "path",
  6123. "required": true
  6124. },
  6125. {
  6126. "type": "integer",
  6127. "format": "int64",
  6128. "description": "id of the hook to delete",
  6129. "name": "id",
  6130. "in": "path",
  6131. "required": true
  6132. }
  6133. ],
  6134. "responses": {
  6135. "204": {
  6136. "$ref": "#/responses/empty"
  6137. },
  6138. "404": {
  6139. "$ref": "#/responses/notFound"
  6140. }
  6141. }
  6142. },
  6143. "patch": {
  6144. "produces": [
  6145. "application/json"
  6146. ],
  6147. "tags": [
  6148. "repository"
  6149. ],
  6150. "summary": "Edit a hook in a repository",
  6151. "operationId": "repoEditHook",
  6152. "parameters": [
  6153. {
  6154. "type": "string",
  6155. "description": "owner of the repo",
  6156. "name": "owner",
  6157. "in": "path",
  6158. "required": true
  6159. },
  6160. {
  6161. "type": "string",
  6162. "description": "name of the repo",
  6163. "name": "repo",
  6164. "in": "path",
  6165. "required": true
  6166. },
  6167. {
  6168. "type": "integer",
  6169. "format": "int64",
  6170. "description": "index of the hook",
  6171. "name": "id",
  6172. "in": "path",
  6173. "required": true
  6174. },
  6175. {
  6176. "name": "body",
  6177. "in": "body",
  6178. "schema": {
  6179. "$ref": "#/definitions/EditHookOption"
  6180. }
  6181. }
  6182. ],
  6183. "responses": {
  6184. "200": {
  6185. "$ref": "#/responses/Hook"
  6186. },
  6187. "404": {
  6188. "$ref": "#/responses/notFound"
  6189. }
  6190. }
  6191. }
  6192. },
  6193. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  6194. "post": {
  6195. "produces": [
  6196. "application/json"
  6197. ],
  6198. "tags": [
  6199. "repository"
  6200. ],
  6201. "summary": "Test a push webhook",
  6202. "operationId": "repoTestHook",
  6203. "parameters": [
  6204. {
  6205. "type": "string",
  6206. "description": "owner of the repo",
  6207. "name": "owner",
  6208. "in": "path",
  6209. "required": true
  6210. },
  6211. {
  6212. "type": "string",
  6213. "description": "name of the repo",
  6214. "name": "repo",
  6215. "in": "path",
  6216. "required": true
  6217. },
  6218. {
  6219. "type": "integer",
  6220. "format": "int64",
  6221. "description": "id of the hook to test",
  6222. "name": "id",
  6223. "in": "path",
  6224. "required": true
  6225. },
  6226. {
  6227. "type": "string",
  6228. "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
  6229. "name": "ref",
  6230. "in": "query"
  6231. }
  6232. ],
  6233. "responses": {
  6234. "204": {
  6235. "$ref": "#/responses/empty"
  6236. },
  6237. "404": {
  6238. "$ref": "#/responses/notFound"
  6239. }
  6240. }
  6241. }
  6242. },
  6243. "/repos/{owner}/{repo}/issue_config": {
  6244. "get": {
  6245. "produces": [
  6246. "application/json"
  6247. ],
  6248. "tags": [
  6249. "repository"
  6250. ],
  6251. "summary": "Returns the issue config for a repo",
  6252. "operationId": "repoGetIssueConfig",
  6253. "parameters": [
  6254. {
  6255. "type": "string",
  6256. "description": "owner of the repo",
  6257. "name": "owner",
  6258. "in": "path",
  6259. "required": true
  6260. },
  6261. {
  6262. "type": "string",
  6263. "description": "name of the repo",
  6264. "name": "repo",
  6265. "in": "path",
  6266. "required": true
  6267. }
  6268. ],
  6269. "responses": {
  6270. "200": {
  6271. "$ref": "#/responses/RepoIssueConfig"
  6272. },
  6273. "404": {
  6274. "$ref": "#/responses/notFound"
  6275. }
  6276. }
  6277. }
  6278. },
  6279. "/repos/{owner}/{repo}/issue_config/validate": {
  6280. "get": {
  6281. "produces": [
  6282. "application/json"
  6283. ],
  6284. "tags": [
  6285. "repository"
  6286. ],
  6287. "summary": "Returns the validation information for a issue config",
  6288. "operationId": "repoValidateIssueConfig",
  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. "responses": {
  6306. "200": {
  6307. "$ref": "#/responses/RepoIssueConfigValidation"
  6308. },
  6309. "404": {
  6310. "$ref": "#/responses/notFound"
  6311. }
  6312. }
  6313. }
  6314. },
  6315. "/repos/{owner}/{repo}/issue_templates": {
  6316. "get": {
  6317. "produces": [
  6318. "application/json"
  6319. ],
  6320. "tags": [
  6321. "repository"
  6322. ],
  6323. "summary": "Get available issue templates for a repository",
  6324. "operationId": "repoGetIssueTemplates",
  6325. "parameters": [
  6326. {
  6327. "type": "string",
  6328. "description": "owner of the repo",
  6329. "name": "owner",
  6330. "in": "path",
  6331. "required": true
  6332. },
  6333. {
  6334. "type": "string",
  6335. "description": "name of the repo",
  6336. "name": "repo",
  6337. "in": "path",
  6338. "required": true
  6339. }
  6340. ],
  6341. "responses": {
  6342. "200": {
  6343. "$ref": "#/responses/IssueTemplates"
  6344. },
  6345. "404": {
  6346. "$ref": "#/responses/notFound"
  6347. }
  6348. }
  6349. }
  6350. },
  6351. "/repos/{owner}/{repo}/issues": {
  6352. "get": {
  6353. "produces": [
  6354. "application/json"
  6355. ],
  6356. "tags": [
  6357. "issue"
  6358. ],
  6359. "summary": "List a repository's issues",
  6360. "operationId": "issueListIssues",
  6361. "parameters": [
  6362. {
  6363. "type": "string",
  6364. "description": "owner of the repo",
  6365. "name": "owner",
  6366. "in": "path",
  6367. "required": true
  6368. },
  6369. {
  6370. "type": "string",
  6371. "description": "name of the repo",
  6372. "name": "repo",
  6373. "in": "path",
  6374. "required": true
  6375. },
  6376. {
  6377. "enum": [
  6378. "closed",
  6379. "open",
  6380. "all"
  6381. ],
  6382. "type": "string",
  6383. "description": "whether issue is open or closed",
  6384. "name": "state",
  6385. "in": "query"
  6386. },
  6387. {
  6388. "type": "string",
  6389. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  6390. "name": "labels",
  6391. "in": "query"
  6392. },
  6393. {
  6394. "type": "string",
  6395. "description": "search string",
  6396. "name": "q",
  6397. "in": "query"
  6398. },
  6399. {
  6400. "enum": [
  6401. "issues",
  6402. "pulls"
  6403. ],
  6404. "type": "string",
  6405. "description": "filter by type (issues / pulls) if set",
  6406. "name": "type",
  6407. "in": "query"
  6408. },
  6409. {
  6410. "type": "string",
  6411. "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",
  6412. "name": "milestones",
  6413. "in": "query"
  6414. },
  6415. {
  6416. "type": "string",
  6417. "format": "date-time",
  6418. "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
  6419. "name": "since",
  6420. "in": "query"
  6421. },
  6422. {
  6423. "type": "string",
  6424. "format": "date-time",
  6425. "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
  6426. "name": "before",
  6427. "in": "query"
  6428. },
  6429. {
  6430. "type": "string",
  6431. "description": "Only show items which were created by the given user",
  6432. "name": "created_by",
  6433. "in": "query"
  6434. },
  6435. {
  6436. "type": "string",
  6437. "description": "Only show items for which the given user is assigned",
  6438. "name": "assigned_by",
  6439. "in": "query"
  6440. },
  6441. {
  6442. "type": "string",
  6443. "description": "Only show items in which the given user was mentioned",
  6444. "name": "mentioned_by",
  6445. "in": "query"
  6446. },
  6447. {
  6448. "type": "integer",
  6449. "description": "page number of results to return (1-based)",
  6450. "name": "page",
  6451. "in": "query"
  6452. },
  6453. {
  6454. "type": "integer",
  6455. "description": "page size of results",
  6456. "name": "limit",
  6457. "in": "query"
  6458. }
  6459. ],
  6460. "responses": {
  6461. "200": {
  6462. "$ref": "#/responses/IssueList"
  6463. },
  6464. "404": {
  6465. "$ref": "#/responses/notFound"
  6466. }
  6467. }
  6468. },
  6469. "post": {
  6470. "consumes": [
  6471. "application/json"
  6472. ],
  6473. "produces": [
  6474. "application/json"
  6475. ],
  6476. "tags": [
  6477. "issue"
  6478. ],
  6479. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6480. "operationId": "issueCreateIssue",
  6481. "parameters": [
  6482. {
  6483. "type": "string",
  6484. "description": "owner of the repo",
  6485. "name": "owner",
  6486. "in": "path",
  6487. "required": true
  6488. },
  6489. {
  6490. "type": "string",
  6491. "description": "name of the repo",
  6492. "name": "repo",
  6493. "in": "path",
  6494. "required": true
  6495. },
  6496. {
  6497. "name": "body",
  6498. "in": "body",
  6499. "schema": {
  6500. "$ref": "#/definitions/CreateIssueOption"
  6501. }
  6502. }
  6503. ],
  6504. "responses": {
  6505. "201": {
  6506. "$ref": "#/responses/Issue"
  6507. },
  6508. "403": {
  6509. "$ref": "#/responses/forbidden"
  6510. },
  6511. "404": {
  6512. "$ref": "#/responses/notFound"
  6513. },
  6514. "412": {
  6515. "$ref": "#/responses/error"
  6516. },
  6517. "422": {
  6518. "$ref": "#/responses/validationError"
  6519. },
  6520. "423": {
  6521. "$ref": "#/responses/repoArchivedError"
  6522. }
  6523. }
  6524. }
  6525. },
  6526. "/repos/{owner}/{repo}/issues/comments": {
  6527. "get": {
  6528. "produces": [
  6529. "application/json"
  6530. ],
  6531. "tags": [
  6532. "issue"
  6533. ],
  6534. "summary": "List all comments in a repository",
  6535. "operationId": "issueGetRepoComments",
  6536. "parameters": [
  6537. {
  6538. "type": "string",
  6539. "description": "owner of the repo",
  6540. "name": "owner",
  6541. "in": "path",
  6542. "required": true
  6543. },
  6544. {
  6545. "type": "string",
  6546. "description": "name of the repo",
  6547. "name": "repo",
  6548. "in": "path",
  6549. "required": true
  6550. },
  6551. {
  6552. "type": "string",
  6553. "format": "date-time",
  6554. "description": "if provided, only comments updated since the provided time are returned.",
  6555. "name": "since",
  6556. "in": "query"
  6557. },
  6558. {
  6559. "type": "string",
  6560. "format": "date-time",
  6561. "description": "if provided, only comments updated before the provided time are returned.",
  6562. "name": "before",
  6563. "in": "query"
  6564. },
  6565. {
  6566. "type": "integer",
  6567. "description": "page number of results to return (1-based)",
  6568. "name": "page",
  6569. "in": "query"
  6570. },
  6571. {
  6572. "type": "integer",
  6573. "description": "page size of results",
  6574. "name": "limit",
  6575. "in": "query"
  6576. }
  6577. ],
  6578. "responses": {
  6579. "200": {
  6580. "$ref": "#/responses/CommentList"
  6581. },
  6582. "404": {
  6583. "$ref": "#/responses/notFound"
  6584. }
  6585. }
  6586. }
  6587. },
  6588. "/repos/{owner}/{repo}/issues/comments/{id}": {
  6589. "get": {
  6590. "consumes": [
  6591. "application/json"
  6592. ],
  6593. "produces": [
  6594. "application/json"
  6595. ],
  6596. "tags": [
  6597. "issue"
  6598. ],
  6599. "summary": "Get a comment",
  6600. "operationId": "issueGetComment",
  6601. "parameters": [
  6602. {
  6603. "type": "string",
  6604. "description": "owner of the repo",
  6605. "name": "owner",
  6606. "in": "path",
  6607. "required": true
  6608. },
  6609. {
  6610. "type": "string",
  6611. "description": "name of the repo",
  6612. "name": "repo",
  6613. "in": "path",
  6614. "required": true
  6615. },
  6616. {
  6617. "type": "integer",
  6618. "format": "int64",
  6619. "description": "id of the comment",
  6620. "name": "id",
  6621. "in": "path",
  6622. "required": true
  6623. }
  6624. ],
  6625. "responses": {
  6626. "200": {
  6627. "$ref": "#/responses/Comment"
  6628. },
  6629. "204": {
  6630. "$ref": "#/responses/empty"
  6631. },
  6632. "403": {
  6633. "$ref": "#/responses/forbidden"
  6634. },
  6635. "404": {
  6636. "$ref": "#/responses/notFound"
  6637. }
  6638. }
  6639. },
  6640. "delete": {
  6641. "tags": [
  6642. "issue"
  6643. ],
  6644. "summary": "Delete a comment",
  6645. "operationId": "issueDeleteComment",
  6646. "parameters": [
  6647. {
  6648. "type": "string",
  6649. "description": "owner of the repo",
  6650. "name": "owner",
  6651. "in": "path",
  6652. "required": true
  6653. },
  6654. {
  6655. "type": "string",
  6656. "description": "name of the repo",
  6657. "name": "repo",
  6658. "in": "path",
  6659. "required": true
  6660. },
  6661. {
  6662. "type": "integer",
  6663. "format": "int64",
  6664. "description": "id of comment to delete",
  6665. "name": "id",
  6666. "in": "path",
  6667. "required": true
  6668. }
  6669. ],
  6670. "responses": {
  6671. "204": {
  6672. "$ref": "#/responses/empty"
  6673. },
  6674. "403": {
  6675. "$ref": "#/responses/forbidden"
  6676. },
  6677. "404": {
  6678. "$ref": "#/responses/notFound"
  6679. }
  6680. }
  6681. },
  6682. "patch": {
  6683. "consumes": [
  6684. "application/json"
  6685. ],
  6686. "produces": [
  6687. "application/json"
  6688. ],
  6689. "tags": [
  6690. "issue"
  6691. ],
  6692. "summary": "Edit a comment",
  6693. "operationId": "issueEditComment",
  6694. "parameters": [
  6695. {
  6696. "type": "string",
  6697. "description": "owner of the repo",
  6698. "name": "owner",
  6699. "in": "path",
  6700. "required": true
  6701. },
  6702. {
  6703. "type": "string",
  6704. "description": "name of the repo",
  6705. "name": "repo",
  6706. "in": "path",
  6707. "required": true
  6708. },
  6709. {
  6710. "type": "integer",
  6711. "format": "int64",
  6712. "description": "id of the comment to edit",
  6713. "name": "id",
  6714. "in": "path",
  6715. "required": true
  6716. },
  6717. {
  6718. "name": "body",
  6719. "in": "body",
  6720. "schema": {
  6721. "$ref": "#/definitions/EditIssueCommentOption"
  6722. }
  6723. }
  6724. ],
  6725. "responses": {
  6726. "200": {
  6727. "$ref": "#/responses/Comment"
  6728. },
  6729. "204": {
  6730. "$ref": "#/responses/empty"
  6731. },
  6732. "403": {
  6733. "$ref": "#/responses/forbidden"
  6734. },
  6735. "404": {
  6736. "$ref": "#/responses/notFound"
  6737. },
  6738. "423": {
  6739. "$ref": "#/responses/repoArchivedError"
  6740. }
  6741. }
  6742. }
  6743. },
  6744. "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
  6745. "get": {
  6746. "produces": [
  6747. "application/json"
  6748. ],
  6749. "tags": [
  6750. "issue"
  6751. ],
  6752. "summary": "List comment's attachments",
  6753. "operationId": "issueListIssueCommentAttachments",
  6754. "parameters": [
  6755. {
  6756. "type": "string",
  6757. "description": "owner of the repo",
  6758. "name": "owner",
  6759. "in": "path",
  6760. "required": true
  6761. },
  6762. {
  6763. "type": "string",
  6764. "description": "name of the repo",
  6765. "name": "repo",
  6766. "in": "path",
  6767. "required": true
  6768. },
  6769. {
  6770. "type": "integer",
  6771. "format": "int64",
  6772. "description": "id of the comment",
  6773. "name": "id",
  6774. "in": "path",
  6775. "required": true
  6776. }
  6777. ],
  6778. "responses": {
  6779. "200": {
  6780. "$ref": "#/responses/AttachmentList"
  6781. },
  6782. "404": {
  6783. "$ref": "#/responses/error"
  6784. }
  6785. }
  6786. },
  6787. "post": {
  6788. "consumes": [
  6789. "multipart/form-data"
  6790. ],
  6791. "produces": [
  6792. "application/json"
  6793. ],
  6794. "tags": [
  6795. "issue"
  6796. ],
  6797. "summary": "Create a comment attachment",
  6798. "operationId": "issueCreateIssueCommentAttachment",
  6799. "parameters": [
  6800. {
  6801. "type": "string",
  6802. "description": "owner of the repo",
  6803. "name": "owner",
  6804. "in": "path",
  6805. "required": true
  6806. },
  6807. {
  6808. "type": "string",
  6809. "description": "name of the repo",
  6810. "name": "repo",
  6811. "in": "path",
  6812. "required": true
  6813. },
  6814. {
  6815. "type": "integer",
  6816. "format": "int64",
  6817. "description": "id of the comment",
  6818. "name": "id",
  6819. "in": "path",
  6820. "required": true
  6821. },
  6822. {
  6823. "type": "string",
  6824. "description": "name of the attachment",
  6825. "name": "name",
  6826. "in": "query"
  6827. },
  6828. {
  6829. "type": "file",
  6830. "description": "attachment to upload",
  6831. "name": "attachment",
  6832. "in": "formData",
  6833. "required": true
  6834. }
  6835. ],
  6836. "responses": {
  6837. "201": {
  6838. "$ref": "#/responses/Attachment"
  6839. },
  6840. "400": {
  6841. "$ref": "#/responses/error"
  6842. },
  6843. "403": {
  6844. "$ref": "#/responses/forbidden"
  6845. },
  6846. "404": {
  6847. "$ref": "#/responses/error"
  6848. },
  6849. "423": {
  6850. "$ref": "#/responses/repoArchivedError"
  6851. }
  6852. }
  6853. }
  6854. },
  6855. "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
  6856. "get": {
  6857. "produces": [
  6858. "application/json"
  6859. ],
  6860. "tags": [
  6861. "issue"
  6862. ],
  6863. "summary": "Get a comment attachment",
  6864. "operationId": "issueGetIssueCommentAttachment",
  6865. "parameters": [
  6866. {
  6867. "type": "string",
  6868. "description": "owner of the repo",
  6869. "name": "owner",
  6870. "in": "path",
  6871. "required": true
  6872. },
  6873. {
  6874. "type": "string",
  6875. "description": "name of the repo",
  6876. "name": "repo",
  6877. "in": "path",
  6878. "required": true
  6879. },
  6880. {
  6881. "type": "integer",
  6882. "format": "int64",
  6883. "description": "id of the comment",
  6884. "name": "id",
  6885. "in": "path",
  6886. "required": true
  6887. },
  6888. {
  6889. "type": "integer",
  6890. "format": "int64",
  6891. "description": "id of the attachment to get",
  6892. "name": "attachment_id",
  6893. "in": "path",
  6894. "required": true
  6895. }
  6896. ],
  6897. "responses": {
  6898. "200": {
  6899. "$ref": "#/responses/Attachment"
  6900. },
  6901. "404": {
  6902. "$ref": "#/responses/error"
  6903. }
  6904. }
  6905. },
  6906. "delete": {
  6907. "produces": [
  6908. "application/json"
  6909. ],
  6910. "tags": [
  6911. "issue"
  6912. ],
  6913. "summary": "Delete a comment attachment",
  6914. "operationId": "issueDeleteIssueCommentAttachment",
  6915. "parameters": [
  6916. {
  6917. "type": "string",
  6918. "description": "owner of the repo",
  6919. "name": "owner",
  6920. "in": "path",
  6921. "required": true
  6922. },
  6923. {
  6924. "type": "string",
  6925. "description": "name of the repo",
  6926. "name": "repo",
  6927. "in": "path",
  6928. "required": true
  6929. },
  6930. {
  6931. "type": "integer",
  6932. "format": "int64",
  6933. "description": "id of the comment",
  6934. "name": "id",
  6935. "in": "path",
  6936. "required": true
  6937. },
  6938. {
  6939. "type": "integer",
  6940. "format": "int64",
  6941. "description": "id of the attachment to delete",
  6942. "name": "attachment_id",
  6943. "in": "path",
  6944. "required": true
  6945. }
  6946. ],
  6947. "responses": {
  6948. "204": {
  6949. "$ref": "#/responses/empty"
  6950. },
  6951. "404": {
  6952. "$ref": "#/responses/error"
  6953. },
  6954. "423": {
  6955. "$ref": "#/responses/repoArchivedError"
  6956. }
  6957. }
  6958. },
  6959. "patch": {
  6960. "consumes": [
  6961. "application/json"
  6962. ],
  6963. "produces": [
  6964. "application/json"
  6965. ],
  6966. "tags": [
  6967. "issue"
  6968. ],
  6969. "summary": "Edit a comment attachment",
  6970. "operationId": "issueEditIssueCommentAttachment",
  6971. "parameters": [
  6972. {
  6973. "type": "string",
  6974. "description": "owner of the repo",
  6975. "name": "owner",
  6976. "in": "path",
  6977. "required": true
  6978. },
  6979. {
  6980. "type": "string",
  6981. "description": "name of the repo",
  6982. "name": "repo",
  6983. "in": "path",
  6984. "required": true
  6985. },
  6986. {
  6987. "type": "integer",
  6988. "format": "int64",
  6989. "description": "id of the comment",
  6990. "name": "id",
  6991. "in": "path",
  6992. "required": true
  6993. },
  6994. {
  6995. "type": "integer",
  6996. "format": "int64",
  6997. "description": "id of the attachment to edit",
  6998. "name": "attachment_id",
  6999. "in": "path",
  7000. "required": true
  7001. },
  7002. {
  7003. "name": "body",
  7004. "in": "body",
  7005. "schema": {
  7006. "$ref": "#/definitions/EditAttachmentOptions"
  7007. }
  7008. }
  7009. ],
  7010. "responses": {
  7011. "201": {
  7012. "$ref": "#/responses/Attachment"
  7013. },
  7014. "404": {
  7015. "$ref": "#/responses/error"
  7016. },
  7017. "423": {
  7018. "$ref": "#/responses/repoArchivedError"
  7019. }
  7020. }
  7021. }
  7022. },
  7023. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  7024. "get": {
  7025. "consumes": [
  7026. "application/json"
  7027. ],
  7028. "produces": [
  7029. "application/json"
  7030. ],
  7031. "tags": [
  7032. "issue"
  7033. ],
  7034. "summary": "Get a list of reactions from a comment of an issue",
  7035. "operationId": "issueGetCommentReactions",
  7036. "parameters": [
  7037. {
  7038. "type": "string",
  7039. "description": "owner of the repo",
  7040. "name": "owner",
  7041. "in": "path",
  7042. "required": true
  7043. },
  7044. {
  7045. "type": "string",
  7046. "description": "name of the repo",
  7047. "name": "repo",
  7048. "in": "path",
  7049. "required": true
  7050. },
  7051. {
  7052. "type": "integer",
  7053. "format": "int64",
  7054. "description": "id of the comment to edit",
  7055. "name": "id",
  7056. "in": "path",
  7057. "required": true
  7058. }
  7059. ],
  7060. "responses": {
  7061. "200": {
  7062. "$ref": "#/responses/ReactionList"
  7063. },
  7064. "403": {
  7065. "$ref": "#/responses/forbidden"
  7066. },
  7067. "404": {
  7068. "$ref": "#/responses/notFound"
  7069. }
  7070. }
  7071. },
  7072. "post": {
  7073. "consumes": [
  7074. "application/json"
  7075. ],
  7076. "produces": [
  7077. "application/json"
  7078. ],
  7079. "tags": [
  7080. "issue"
  7081. ],
  7082. "summary": "Add a reaction to a comment of an issue",
  7083. "operationId": "issuePostCommentReaction",
  7084. "parameters": [
  7085. {
  7086. "type": "string",
  7087. "description": "owner of the repo",
  7088. "name": "owner",
  7089. "in": "path",
  7090. "required": true
  7091. },
  7092. {
  7093. "type": "string",
  7094. "description": "name of the repo",
  7095. "name": "repo",
  7096. "in": "path",
  7097. "required": true
  7098. },
  7099. {
  7100. "type": "integer",
  7101. "format": "int64",
  7102. "description": "id of the comment to edit",
  7103. "name": "id",
  7104. "in": "path",
  7105. "required": true
  7106. },
  7107. {
  7108. "name": "content",
  7109. "in": "body",
  7110. "schema": {
  7111. "$ref": "#/definitions/EditReactionOption"
  7112. }
  7113. }
  7114. ],
  7115. "responses": {
  7116. "200": {
  7117. "$ref": "#/responses/Reaction"
  7118. },
  7119. "201": {
  7120. "$ref": "#/responses/Reaction"
  7121. },
  7122. "403": {
  7123. "$ref": "#/responses/forbidden"
  7124. },
  7125. "404": {
  7126. "$ref": "#/responses/notFound"
  7127. }
  7128. }
  7129. },
  7130. "delete": {
  7131. "consumes": [
  7132. "application/json"
  7133. ],
  7134. "produces": [
  7135. "application/json"
  7136. ],
  7137. "tags": [
  7138. "issue"
  7139. ],
  7140. "summary": "Remove a reaction from a comment of an issue",
  7141. "operationId": "issueDeleteCommentReaction",
  7142. "parameters": [
  7143. {
  7144. "type": "string",
  7145. "description": "owner of the repo",
  7146. "name": "owner",
  7147. "in": "path",
  7148. "required": true
  7149. },
  7150. {
  7151. "type": "string",
  7152. "description": "name of the repo",
  7153. "name": "repo",
  7154. "in": "path",
  7155. "required": true
  7156. },
  7157. {
  7158. "type": "integer",
  7159. "format": "int64",
  7160. "description": "id of the comment to edit",
  7161. "name": "id",
  7162. "in": "path",
  7163. "required": true
  7164. },
  7165. {
  7166. "name": "content",
  7167. "in": "body",
  7168. "schema": {
  7169. "$ref": "#/definitions/EditReactionOption"
  7170. }
  7171. }
  7172. ],
  7173. "responses": {
  7174. "200": {
  7175. "$ref": "#/responses/empty"
  7176. },
  7177. "403": {
  7178. "$ref": "#/responses/forbidden"
  7179. },
  7180. "404": {
  7181. "$ref": "#/responses/notFound"
  7182. }
  7183. }
  7184. }
  7185. },
  7186. "/repos/{owner}/{repo}/issues/pinned": {
  7187. "get": {
  7188. "produces": [
  7189. "application/json"
  7190. ],
  7191. "tags": [
  7192. "repository"
  7193. ],
  7194. "summary": "List a repo's pinned issues",
  7195. "operationId": "repoListPinnedIssues",
  7196. "parameters": [
  7197. {
  7198. "type": "string",
  7199. "description": "owner of the repo",
  7200. "name": "owner",
  7201. "in": "path",
  7202. "required": true
  7203. },
  7204. {
  7205. "type": "string",
  7206. "description": "name of the repo",
  7207. "name": "repo",
  7208. "in": "path",
  7209. "required": true
  7210. }
  7211. ],
  7212. "responses": {
  7213. "200": {
  7214. "$ref": "#/responses/IssueList"
  7215. },
  7216. "404": {
  7217. "$ref": "#/responses/notFound"
  7218. }
  7219. }
  7220. }
  7221. },
  7222. "/repos/{owner}/{repo}/issues/{index}": {
  7223. "get": {
  7224. "produces": [
  7225. "application/json"
  7226. ],
  7227. "tags": [
  7228. "issue"
  7229. ],
  7230. "summary": "Get an issue",
  7231. "operationId": "issueGetIssue",
  7232. "parameters": [
  7233. {
  7234. "type": "string",
  7235. "description": "owner of the repo",
  7236. "name": "owner",
  7237. "in": "path",
  7238. "required": true
  7239. },
  7240. {
  7241. "type": "string",
  7242. "description": "name of the repo",
  7243. "name": "repo",
  7244. "in": "path",
  7245. "required": true
  7246. },
  7247. {
  7248. "type": "integer",
  7249. "format": "int64",
  7250. "description": "index of the issue to get",
  7251. "name": "index",
  7252. "in": "path",
  7253. "required": true
  7254. }
  7255. ],
  7256. "responses": {
  7257. "200": {
  7258. "$ref": "#/responses/Issue"
  7259. },
  7260. "404": {
  7261. "$ref": "#/responses/notFound"
  7262. }
  7263. }
  7264. },
  7265. "delete": {
  7266. "tags": [
  7267. "issue"
  7268. ],
  7269. "summary": "Delete an issue",
  7270. "operationId": "issueDelete",
  7271. "parameters": [
  7272. {
  7273. "type": "string",
  7274. "description": "owner of the repo",
  7275. "name": "owner",
  7276. "in": "path",
  7277. "required": true
  7278. },
  7279. {
  7280. "type": "string",
  7281. "description": "name of the repo",
  7282. "name": "repo",
  7283. "in": "path",
  7284. "required": true
  7285. },
  7286. {
  7287. "type": "integer",
  7288. "format": "int64",
  7289. "description": "index of issue to delete",
  7290. "name": "index",
  7291. "in": "path",
  7292. "required": true
  7293. }
  7294. ],
  7295. "responses": {
  7296. "204": {
  7297. "$ref": "#/responses/empty"
  7298. },
  7299. "403": {
  7300. "$ref": "#/responses/forbidden"
  7301. },
  7302. "404": {
  7303. "$ref": "#/responses/notFound"
  7304. }
  7305. }
  7306. },
  7307. "patch": {
  7308. "consumes": [
  7309. "application/json"
  7310. ],
  7311. "produces": [
  7312. "application/json"
  7313. ],
  7314. "tags": [
  7315. "issue"
  7316. ],
  7317. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  7318. "operationId": "issueEditIssue",
  7319. "parameters": [
  7320. {
  7321. "type": "string",
  7322. "description": "owner of the repo",
  7323. "name": "owner",
  7324. "in": "path",
  7325. "required": true
  7326. },
  7327. {
  7328. "type": "string",
  7329. "description": "name of the repo",
  7330. "name": "repo",
  7331. "in": "path",
  7332. "required": true
  7333. },
  7334. {
  7335. "type": "integer",
  7336. "format": "int64",
  7337. "description": "index of the issue to edit",
  7338. "name": "index",
  7339. "in": "path",
  7340. "required": true
  7341. },
  7342. {
  7343. "name": "body",
  7344. "in": "body",
  7345. "schema": {
  7346. "$ref": "#/definitions/EditIssueOption"
  7347. }
  7348. }
  7349. ],
  7350. "responses": {
  7351. "201": {
  7352. "$ref": "#/responses/Issue"
  7353. },
  7354. "403": {
  7355. "$ref": "#/responses/forbidden"
  7356. },
  7357. "404": {
  7358. "$ref": "#/responses/notFound"
  7359. },
  7360. "412": {
  7361. "$ref": "#/responses/error"
  7362. }
  7363. }
  7364. }
  7365. },
  7366. "/repos/{owner}/{repo}/issues/{index}/assets": {
  7367. "get": {
  7368. "produces": [
  7369. "application/json"
  7370. ],
  7371. "tags": [
  7372. "issue"
  7373. ],
  7374. "summary": "List issue's attachments",
  7375. "operationId": "issueListIssueAttachments",
  7376. "parameters": [
  7377. {
  7378. "type": "string",
  7379. "description": "owner of the repo",
  7380. "name": "owner",
  7381. "in": "path",
  7382. "required": true
  7383. },
  7384. {
  7385. "type": "string",
  7386. "description": "name of the repo",
  7387. "name": "repo",
  7388. "in": "path",
  7389. "required": true
  7390. },
  7391. {
  7392. "type": "integer",
  7393. "format": "int64",
  7394. "description": "index of the issue",
  7395. "name": "index",
  7396. "in": "path",
  7397. "required": true
  7398. }
  7399. ],
  7400. "responses": {
  7401. "200": {
  7402. "$ref": "#/responses/AttachmentList"
  7403. },
  7404. "404": {
  7405. "$ref": "#/responses/error"
  7406. }
  7407. }
  7408. },
  7409. "post": {
  7410. "consumes": [
  7411. "multipart/form-data"
  7412. ],
  7413. "produces": [
  7414. "application/json"
  7415. ],
  7416. "tags": [
  7417. "issue"
  7418. ],
  7419. "summary": "Create an issue attachment",
  7420. "operationId": "issueCreateIssueAttachment",
  7421. "parameters": [
  7422. {
  7423. "type": "string",
  7424. "description": "owner of the repo",
  7425. "name": "owner",
  7426. "in": "path",
  7427. "required": true
  7428. },
  7429. {
  7430. "type": "string",
  7431. "description": "name of the repo",
  7432. "name": "repo",
  7433. "in": "path",
  7434. "required": true
  7435. },
  7436. {
  7437. "type": "integer",
  7438. "format": "int64",
  7439. "description": "index of the issue",
  7440. "name": "index",
  7441. "in": "path",
  7442. "required": true
  7443. },
  7444. {
  7445. "type": "string",
  7446. "description": "name of the attachment",
  7447. "name": "name",
  7448. "in": "query"
  7449. },
  7450. {
  7451. "type": "file",
  7452. "description": "attachment to upload",
  7453. "name": "attachment",
  7454. "in": "formData",
  7455. "required": true
  7456. }
  7457. ],
  7458. "responses": {
  7459. "201": {
  7460. "$ref": "#/responses/Attachment"
  7461. },
  7462. "400": {
  7463. "$ref": "#/responses/error"
  7464. },
  7465. "404": {
  7466. "$ref": "#/responses/error"
  7467. },
  7468. "423": {
  7469. "$ref": "#/responses/repoArchivedError"
  7470. }
  7471. }
  7472. }
  7473. },
  7474. "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
  7475. "get": {
  7476. "produces": [
  7477. "application/json"
  7478. ],
  7479. "tags": [
  7480. "issue"
  7481. ],
  7482. "summary": "Get an issue attachment",
  7483. "operationId": "issueGetIssueAttachment",
  7484. "parameters": [
  7485. {
  7486. "type": "string",
  7487. "description": "owner of the repo",
  7488. "name": "owner",
  7489. "in": "path",
  7490. "required": true
  7491. },
  7492. {
  7493. "type": "string",
  7494. "description": "name of the repo",
  7495. "name": "repo",
  7496. "in": "path",
  7497. "required": true
  7498. },
  7499. {
  7500. "type": "integer",
  7501. "format": "int64",
  7502. "description": "index of the issue",
  7503. "name": "index",
  7504. "in": "path",
  7505. "required": true
  7506. },
  7507. {
  7508. "type": "integer",
  7509. "format": "int64",
  7510. "description": "id of the attachment to get",
  7511. "name": "attachment_id",
  7512. "in": "path",
  7513. "required": true
  7514. }
  7515. ],
  7516. "responses": {
  7517. "200": {
  7518. "$ref": "#/responses/Attachment"
  7519. },
  7520. "404": {
  7521. "$ref": "#/responses/error"
  7522. }
  7523. }
  7524. },
  7525. "delete": {
  7526. "produces": [
  7527. "application/json"
  7528. ],
  7529. "tags": [
  7530. "issue"
  7531. ],
  7532. "summary": "Delete an issue attachment",
  7533. "operationId": "issueDeleteIssueAttachment",
  7534. "parameters": [
  7535. {
  7536. "type": "string",
  7537. "description": "owner of the repo",
  7538. "name": "owner",
  7539. "in": "path",
  7540. "required": true
  7541. },
  7542. {
  7543. "type": "string",
  7544. "description": "name of the repo",
  7545. "name": "repo",
  7546. "in": "path",
  7547. "required": true
  7548. },
  7549. {
  7550. "type": "integer",
  7551. "format": "int64",
  7552. "description": "index of the issue",
  7553. "name": "index",
  7554. "in": "path",
  7555. "required": true
  7556. },
  7557. {
  7558. "type": "integer",
  7559. "format": "int64",
  7560. "description": "id of the attachment to delete",
  7561. "name": "attachment_id",
  7562. "in": "path",
  7563. "required": true
  7564. }
  7565. ],
  7566. "responses": {
  7567. "204": {
  7568. "$ref": "#/responses/empty"
  7569. },
  7570. "404": {
  7571. "$ref": "#/responses/error"
  7572. },
  7573. "423": {
  7574. "$ref": "#/responses/repoArchivedError"
  7575. }
  7576. }
  7577. },
  7578. "patch": {
  7579. "consumes": [
  7580. "application/json"
  7581. ],
  7582. "produces": [
  7583. "application/json"
  7584. ],
  7585. "tags": [
  7586. "issue"
  7587. ],
  7588. "summary": "Edit an issue attachment",
  7589. "operationId": "issueEditIssueAttachment",
  7590. "parameters": [
  7591. {
  7592. "type": "string",
  7593. "description": "owner of the repo",
  7594. "name": "owner",
  7595. "in": "path",
  7596. "required": true
  7597. },
  7598. {
  7599. "type": "string",
  7600. "description": "name of the repo",
  7601. "name": "repo",
  7602. "in": "path",
  7603. "required": true
  7604. },
  7605. {
  7606. "type": "integer",
  7607. "format": "int64",
  7608. "description": "index of the issue",
  7609. "name": "index",
  7610. "in": "path",
  7611. "required": true
  7612. },
  7613. {
  7614. "type": "integer",
  7615. "format": "int64",
  7616. "description": "id of the attachment to edit",
  7617. "name": "attachment_id",
  7618. "in": "path",
  7619. "required": true
  7620. },
  7621. {
  7622. "name": "body",
  7623. "in": "body",
  7624. "schema": {
  7625. "$ref": "#/definitions/EditAttachmentOptions"
  7626. }
  7627. }
  7628. ],
  7629. "responses": {
  7630. "201": {
  7631. "$ref": "#/responses/Attachment"
  7632. },
  7633. "404": {
  7634. "$ref": "#/responses/error"
  7635. },
  7636. "423": {
  7637. "$ref": "#/responses/repoArchivedError"
  7638. }
  7639. }
  7640. }
  7641. },
  7642. "/repos/{owner}/{repo}/issues/{index}/blocks": {
  7643. "get": {
  7644. "produces": [
  7645. "application/json"
  7646. ],
  7647. "tags": [
  7648. "issue"
  7649. ],
  7650. "summary": "List issues that are blocked by this issue",
  7651. "operationId": "issueListBlocks",
  7652. "parameters": [
  7653. {
  7654. "type": "string",
  7655. "description": "owner of the repo",
  7656. "name": "owner",
  7657. "in": "path",
  7658. "required": true
  7659. },
  7660. {
  7661. "type": "string",
  7662. "description": "name of the repo",
  7663. "name": "repo",
  7664. "in": "path",
  7665. "required": true
  7666. },
  7667. {
  7668. "type": "string",
  7669. "description": "index of the issue",
  7670. "name": "index",
  7671. "in": "path",
  7672. "required": true
  7673. },
  7674. {
  7675. "type": "integer",
  7676. "description": "page number of results to return (1-based)",
  7677. "name": "page",
  7678. "in": "query"
  7679. },
  7680. {
  7681. "type": "integer",
  7682. "description": "page size of results",
  7683. "name": "limit",
  7684. "in": "query"
  7685. }
  7686. ],
  7687. "responses": {
  7688. "200": {
  7689. "$ref": "#/responses/IssueList"
  7690. },
  7691. "404": {
  7692. "$ref": "#/responses/notFound"
  7693. }
  7694. }
  7695. },
  7696. "post": {
  7697. "produces": [
  7698. "application/json"
  7699. ],
  7700. "tags": [
  7701. "issue"
  7702. ],
  7703. "summary": "Block the issue given in the body by the issue in path",
  7704. "operationId": "issueCreateIssueBlocking",
  7705. "parameters": [
  7706. {
  7707. "type": "string",
  7708. "description": "owner of the repo",
  7709. "name": "owner",
  7710. "in": "path",
  7711. "required": true
  7712. },
  7713. {
  7714. "type": "string",
  7715. "description": "name of the repo",
  7716. "name": "repo",
  7717. "in": "path",
  7718. "required": true
  7719. },
  7720. {
  7721. "type": "string",
  7722. "description": "index of the issue",
  7723. "name": "index",
  7724. "in": "path",
  7725. "required": true
  7726. },
  7727. {
  7728. "name": "body",
  7729. "in": "body",
  7730. "schema": {
  7731. "$ref": "#/definitions/IssueMeta"
  7732. }
  7733. }
  7734. ],
  7735. "responses": {
  7736. "201": {
  7737. "$ref": "#/responses/Issue"
  7738. },
  7739. "404": {
  7740. "description": "the issue does not exist"
  7741. }
  7742. }
  7743. },
  7744. "delete": {
  7745. "produces": [
  7746. "application/json"
  7747. ],
  7748. "tags": [
  7749. "issue"
  7750. ],
  7751. "summary": "Unblock the issue given in the body by the issue in path",
  7752. "operationId": "issueRemoveIssueBlocking",
  7753. "parameters": [
  7754. {
  7755. "type": "string",
  7756. "description": "owner of the repo",
  7757. "name": "owner",
  7758. "in": "path",
  7759. "required": true
  7760. },
  7761. {
  7762. "type": "string",
  7763. "description": "name of the repo",
  7764. "name": "repo",
  7765. "in": "path",
  7766. "required": true
  7767. },
  7768. {
  7769. "type": "string",
  7770. "description": "index of the issue",
  7771. "name": "index",
  7772. "in": "path",
  7773. "required": true
  7774. },
  7775. {
  7776. "name": "body",
  7777. "in": "body",
  7778. "schema": {
  7779. "$ref": "#/definitions/IssueMeta"
  7780. }
  7781. }
  7782. ],
  7783. "responses": {
  7784. "200": {
  7785. "$ref": "#/responses/Issue"
  7786. },
  7787. "404": {
  7788. "$ref": "#/responses/notFound"
  7789. }
  7790. }
  7791. }
  7792. },
  7793. "/repos/{owner}/{repo}/issues/{index}/comments": {
  7794. "get": {
  7795. "produces": [
  7796. "application/json"
  7797. ],
  7798. "tags": [
  7799. "issue"
  7800. ],
  7801. "summary": "List all comments on an issue",
  7802. "operationId": "issueGetComments",
  7803. "parameters": [
  7804. {
  7805. "type": "string",
  7806. "description": "owner of the repo",
  7807. "name": "owner",
  7808. "in": "path",
  7809. "required": true
  7810. },
  7811. {
  7812. "type": "string",
  7813. "description": "name of the repo",
  7814. "name": "repo",
  7815. "in": "path",
  7816. "required": true
  7817. },
  7818. {
  7819. "type": "integer",
  7820. "format": "int64",
  7821. "description": "index of the issue",
  7822. "name": "index",
  7823. "in": "path",
  7824. "required": true
  7825. },
  7826. {
  7827. "type": "string",
  7828. "format": "date-time",
  7829. "description": "if provided, only comments updated since the specified time are returned.",
  7830. "name": "since",
  7831. "in": "query"
  7832. },
  7833. {
  7834. "type": "string",
  7835. "format": "date-time",
  7836. "description": "if provided, only comments updated before the provided time are returned.",
  7837. "name": "before",
  7838. "in": "query"
  7839. }
  7840. ],
  7841. "responses": {
  7842. "200": {
  7843. "$ref": "#/responses/CommentList"
  7844. },
  7845. "404": {
  7846. "$ref": "#/responses/notFound"
  7847. }
  7848. }
  7849. },
  7850. "post": {
  7851. "consumes": [
  7852. "application/json"
  7853. ],
  7854. "produces": [
  7855. "application/json"
  7856. ],
  7857. "tags": [
  7858. "issue"
  7859. ],
  7860. "summary": "Add a comment to an issue",
  7861. "operationId": "issueCreateComment",
  7862. "parameters": [
  7863. {
  7864. "type": "string",
  7865. "description": "owner of the repo",
  7866. "name": "owner",
  7867. "in": "path",
  7868. "required": true
  7869. },
  7870. {
  7871. "type": "string",
  7872. "description": "name of the repo",
  7873. "name": "repo",
  7874. "in": "path",
  7875. "required": true
  7876. },
  7877. {
  7878. "type": "integer",
  7879. "format": "int64",
  7880. "description": "index of the issue",
  7881. "name": "index",
  7882. "in": "path",
  7883. "required": true
  7884. },
  7885. {
  7886. "name": "body",
  7887. "in": "body",
  7888. "schema": {
  7889. "$ref": "#/definitions/CreateIssueCommentOption"
  7890. }
  7891. }
  7892. ],
  7893. "responses": {
  7894. "201": {
  7895. "$ref": "#/responses/Comment"
  7896. },
  7897. "403": {
  7898. "$ref": "#/responses/forbidden"
  7899. },
  7900. "404": {
  7901. "$ref": "#/responses/notFound"
  7902. },
  7903. "423": {
  7904. "$ref": "#/responses/repoArchivedError"
  7905. }
  7906. }
  7907. }
  7908. },
  7909. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  7910. "delete": {
  7911. "tags": [
  7912. "issue"
  7913. ],
  7914. "summary": "Delete a comment",
  7915. "operationId": "issueDeleteCommentDeprecated",
  7916. "deprecated": true,
  7917. "parameters": [
  7918. {
  7919. "type": "string",
  7920. "description": "owner of the repo",
  7921. "name": "owner",
  7922. "in": "path",
  7923. "required": true
  7924. },
  7925. {
  7926. "type": "string",
  7927. "description": "name of the repo",
  7928. "name": "repo",
  7929. "in": "path",
  7930. "required": true
  7931. },
  7932. {
  7933. "type": "integer",
  7934. "description": "this parameter is ignored",
  7935. "name": "index",
  7936. "in": "path",
  7937. "required": true
  7938. },
  7939. {
  7940. "type": "integer",
  7941. "format": "int64",
  7942. "description": "id of comment to delete",
  7943. "name": "id",
  7944. "in": "path",
  7945. "required": true
  7946. }
  7947. ],
  7948. "responses": {
  7949. "204": {
  7950. "$ref": "#/responses/empty"
  7951. },
  7952. "403": {
  7953. "$ref": "#/responses/forbidden"
  7954. },
  7955. "404": {
  7956. "$ref": "#/responses/notFound"
  7957. }
  7958. }
  7959. },
  7960. "patch": {
  7961. "consumes": [
  7962. "application/json"
  7963. ],
  7964. "produces": [
  7965. "application/json"
  7966. ],
  7967. "tags": [
  7968. "issue"
  7969. ],
  7970. "summary": "Edit a comment",
  7971. "operationId": "issueEditCommentDeprecated",
  7972. "deprecated": true,
  7973. "parameters": [
  7974. {
  7975. "type": "string",
  7976. "description": "owner of the repo",
  7977. "name": "owner",
  7978. "in": "path",
  7979. "required": true
  7980. },
  7981. {
  7982. "type": "string",
  7983. "description": "name of the repo",
  7984. "name": "repo",
  7985. "in": "path",
  7986. "required": true
  7987. },
  7988. {
  7989. "type": "integer",
  7990. "description": "this parameter is ignored",
  7991. "name": "index",
  7992. "in": "path",
  7993. "required": true
  7994. },
  7995. {
  7996. "type": "integer",
  7997. "format": "int64",
  7998. "description": "id of the comment to edit",
  7999. "name": "id",
  8000. "in": "path",
  8001. "required": true
  8002. },
  8003. {
  8004. "name": "body",
  8005. "in": "body",
  8006. "schema": {
  8007. "$ref": "#/definitions/EditIssueCommentOption"
  8008. }
  8009. }
  8010. ],
  8011. "responses": {
  8012. "200": {
  8013. "$ref": "#/responses/Comment"
  8014. },
  8015. "204": {
  8016. "$ref": "#/responses/empty"
  8017. },
  8018. "403": {
  8019. "$ref": "#/responses/forbidden"
  8020. },
  8021. "404": {
  8022. "$ref": "#/responses/notFound"
  8023. }
  8024. }
  8025. }
  8026. },
  8027. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  8028. "post": {
  8029. "consumes": [
  8030. "application/json"
  8031. ],
  8032. "produces": [
  8033. "application/json"
  8034. ],
  8035. "tags": [
  8036. "issue"
  8037. ],
  8038. "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.",
  8039. "operationId": "issueEditIssueDeadline",
  8040. "parameters": [
  8041. {
  8042. "type": "string",
  8043. "description": "owner of the repo",
  8044. "name": "owner",
  8045. "in": "path",
  8046. "required": true
  8047. },
  8048. {
  8049. "type": "string",
  8050. "description": "name of the repo",
  8051. "name": "repo",
  8052. "in": "path",
  8053. "required": true
  8054. },
  8055. {
  8056. "type": "integer",
  8057. "format": "int64",
  8058. "description": "index of the issue to create or update a deadline on",
  8059. "name": "index",
  8060. "in": "path",
  8061. "required": true
  8062. },
  8063. {
  8064. "name": "body",
  8065. "in": "body",
  8066. "schema": {
  8067. "$ref": "#/definitions/EditDeadlineOption"
  8068. }
  8069. }
  8070. ],
  8071. "responses": {
  8072. "201": {
  8073. "$ref": "#/responses/IssueDeadline"
  8074. },
  8075. "403": {
  8076. "$ref": "#/responses/forbidden"
  8077. },
  8078. "404": {
  8079. "$ref": "#/responses/notFound"
  8080. }
  8081. }
  8082. }
  8083. },
  8084. "/repos/{owner}/{repo}/issues/{index}/dependencies": {
  8085. "get": {
  8086. "produces": [
  8087. "application/json"
  8088. ],
  8089. "tags": [
  8090. "issue"
  8091. ],
  8092. "summary": "List an issue's dependencies, i.e all issues that block this issue.",
  8093. "operationId": "issueListIssueDependencies",
  8094. "parameters": [
  8095. {
  8096. "type": "string",
  8097. "description": "owner of the repo",
  8098. "name": "owner",
  8099. "in": "path",
  8100. "required": true
  8101. },
  8102. {
  8103. "type": "string",
  8104. "description": "name of the repo",
  8105. "name": "repo",
  8106. "in": "path",
  8107. "required": true
  8108. },
  8109. {
  8110. "type": "string",
  8111. "description": "index of the issue",
  8112. "name": "index",
  8113. "in": "path",
  8114. "required": true
  8115. },
  8116. {
  8117. "type": "integer",
  8118. "description": "page number of results to return (1-based)",
  8119. "name": "page",
  8120. "in": "query"
  8121. },
  8122. {
  8123. "type": "integer",
  8124. "description": "page size of results",
  8125. "name": "limit",
  8126. "in": "query"
  8127. }
  8128. ],
  8129. "responses": {
  8130. "200": {
  8131. "$ref": "#/responses/IssueList"
  8132. },
  8133. "404": {
  8134. "$ref": "#/responses/notFound"
  8135. }
  8136. }
  8137. },
  8138. "post": {
  8139. "produces": [
  8140. "application/json"
  8141. ],
  8142. "tags": [
  8143. "issue"
  8144. ],
  8145. "summary": "Make the issue in the url depend on the issue in the form.",
  8146. "operationId": "issueCreateIssueDependencies",
  8147. "parameters": [
  8148. {
  8149. "type": "string",
  8150. "description": "owner of the repo",
  8151. "name": "owner",
  8152. "in": "path",
  8153. "required": true
  8154. },
  8155. {
  8156. "type": "string",
  8157. "description": "name of the repo",
  8158. "name": "repo",
  8159. "in": "path",
  8160. "required": true
  8161. },
  8162. {
  8163. "type": "string",
  8164. "description": "index of the issue",
  8165. "name": "index",
  8166. "in": "path",
  8167. "required": true
  8168. },
  8169. {
  8170. "name": "body",
  8171. "in": "body",
  8172. "schema": {
  8173. "$ref": "#/definitions/IssueMeta"
  8174. }
  8175. }
  8176. ],
  8177. "responses": {
  8178. "201": {
  8179. "$ref": "#/responses/Issue"
  8180. },
  8181. "404": {
  8182. "description": "the issue does not exist"
  8183. },
  8184. "423": {
  8185. "$ref": "#/responses/repoArchivedError"
  8186. }
  8187. }
  8188. },
  8189. "delete": {
  8190. "produces": [
  8191. "application/json"
  8192. ],
  8193. "tags": [
  8194. "issue"
  8195. ],
  8196. "summary": "Remove an issue dependency",
  8197. "operationId": "issueRemoveIssueDependencies",
  8198. "parameters": [
  8199. {
  8200. "type": "string",
  8201. "description": "owner of the repo",
  8202. "name": "owner",
  8203. "in": "path",
  8204. "required": true
  8205. },
  8206. {
  8207. "type": "string",
  8208. "description": "name of the repo",
  8209. "name": "repo",
  8210. "in": "path",
  8211. "required": true
  8212. },
  8213. {
  8214. "type": "string",
  8215. "description": "index of the issue",
  8216. "name": "index",
  8217. "in": "path",
  8218. "required": true
  8219. },
  8220. {
  8221. "name": "body",
  8222. "in": "body",
  8223. "schema": {
  8224. "$ref": "#/definitions/IssueMeta"
  8225. }
  8226. }
  8227. ],
  8228. "responses": {
  8229. "200": {
  8230. "$ref": "#/responses/Issue"
  8231. },
  8232. "404": {
  8233. "$ref": "#/responses/notFound"
  8234. },
  8235. "423": {
  8236. "$ref": "#/responses/repoArchivedError"
  8237. }
  8238. }
  8239. }
  8240. },
  8241. "/repos/{owner}/{repo}/issues/{index}/labels": {
  8242. "get": {
  8243. "produces": [
  8244. "application/json"
  8245. ],
  8246. "tags": [
  8247. "issue"
  8248. ],
  8249. "summary": "Get an issue's labels",
  8250. "operationId": "issueGetLabels",
  8251. "parameters": [
  8252. {
  8253. "type": "string",
  8254. "description": "owner of the repo",
  8255. "name": "owner",
  8256. "in": "path",
  8257. "required": true
  8258. },
  8259. {
  8260. "type": "string",
  8261. "description": "name of the repo",
  8262. "name": "repo",
  8263. "in": "path",
  8264. "required": true
  8265. },
  8266. {
  8267. "type": "integer",
  8268. "format": "int64",
  8269. "description": "index of the issue",
  8270. "name": "index",
  8271. "in": "path",
  8272. "required": true
  8273. }
  8274. ],
  8275. "responses": {
  8276. "200": {
  8277. "$ref": "#/responses/LabelList"
  8278. },
  8279. "404": {
  8280. "$ref": "#/responses/notFound"
  8281. }
  8282. }
  8283. },
  8284. "put": {
  8285. "consumes": [
  8286. "application/json"
  8287. ],
  8288. "produces": [
  8289. "application/json"
  8290. ],
  8291. "tags": [
  8292. "issue"
  8293. ],
  8294. "summary": "Replace an issue's labels",
  8295. "operationId": "issueReplaceLabels",
  8296. "parameters": [
  8297. {
  8298. "type": "string",
  8299. "description": "owner of the repo",
  8300. "name": "owner",
  8301. "in": "path",
  8302. "required": true
  8303. },
  8304. {
  8305. "type": "string",
  8306. "description": "name of the repo",
  8307. "name": "repo",
  8308. "in": "path",
  8309. "required": true
  8310. },
  8311. {
  8312. "type": "integer",
  8313. "format": "int64",
  8314. "description": "index of the issue",
  8315. "name": "index",
  8316. "in": "path",
  8317. "required": true
  8318. },
  8319. {
  8320. "name": "body",
  8321. "in": "body",
  8322. "schema": {
  8323. "$ref": "#/definitions/IssueLabelsOption"
  8324. }
  8325. }
  8326. ],
  8327. "responses": {
  8328. "200": {
  8329. "$ref": "#/responses/LabelList"
  8330. },
  8331. "403": {
  8332. "$ref": "#/responses/forbidden"
  8333. },
  8334. "404": {
  8335. "$ref": "#/responses/notFound"
  8336. }
  8337. }
  8338. },
  8339. "post": {
  8340. "consumes": [
  8341. "application/json"
  8342. ],
  8343. "produces": [
  8344. "application/json"
  8345. ],
  8346. "tags": [
  8347. "issue"
  8348. ],
  8349. "summary": "Add a label to an issue",
  8350. "operationId": "issueAddLabel",
  8351. "parameters": [
  8352. {
  8353. "type": "string",
  8354. "description": "owner of the repo",
  8355. "name": "owner",
  8356. "in": "path",
  8357. "required": true
  8358. },
  8359. {
  8360. "type": "string",
  8361. "description": "name of the repo",
  8362. "name": "repo",
  8363. "in": "path",
  8364. "required": true
  8365. },
  8366. {
  8367. "type": "integer",
  8368. "format": "int64",
  8369. "description": "index of the issue",
  8370. "name": "index",
  8371. "in": "path",
  8372. "required": true
  8373. },
  8374. {
  8375. "name": "body",
  8376. "in": "body",
  8377. "schema": {
  8378. "$ref": "#/definitions/IssueLabelsOption"
  8379. }
  8380. }
  8381. ],
  8382. "responses": {
  8383. "200": {
  8384. "$ref": "#/responses/LabelList"
  8385. },
  8386. "403": {
  8387. "$ref": "#/responses/forbidden"
  8388. },
  8389. "404": {
  8390. "$ref": "#/responses/notFound"
  8391. }
  8392. }
  8393. },
  8394. "delete": {
  8395. "produces": [
  8396. "application/json"
  8397. ],
  8398. "tags": [
  8399. "issue"
  8400. ],
  8401. "summary": "Remove all labels from an issue",
  8402. "operationId": "issueClearLabels",
  8403. "parameters": [
  8404. {
  8405. "type": "string",
  8406. "description": "owner of the repo",
  8407. "name": "owner",
  8408. "in": "path",
  8409. "required": true
  8410. },
  8411. {
  8412. "type": "string",
  8413. "description": "name of the repo",
  8414. "name": "repo",
  8415. "in": "path",
  8416. "required": true
  8417. },
  8418. {
  8419. "type": "integer",
  8420. "format": "int64",
  8421. "description": "index of the issue",
  8422. "name": "index",
  8423. "in": "path",
  8424. "required": true
  8425. }
  8426. ],
  8427. "responses": {
  8428. "204": {
  8429. "$ref": "#/responses/empty"
  8430. },
  8431. "403": {
  8432. "$ref": "#/responses/forbidden"
  8433. },
  8434. "404": {
  8435. "$ref": "#/responses/notFound"
  8436. }
  8437. }
  8438. }
  8439. },
  8440. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  8441. "delete": {
  8442. "produces": [
  8443. "application/json"
  8444. ],
  8445. "tags": [
  8446. "issue"
  8447. ],
  8448. "summary": "Remove a label from an issue",
  8449. "operationId": "issueRemoveLabel",
  8450. "parameters": [
  8451. {
  8452. "type": "string",
  8453. "description": "owner of the repo",
  8454. "name": "owner",
  8455. "in": "path",
  8456. "required": true
  8457. },
  8458. {
  8459. "type": "string",
  8460. "description": "name of the repo",
  8461. "name": "repo",
  8462. "in": "path",
  8463. "required": true
  8464. },
  8465. {
  8466. "type": "integer",
  8467. "format": "int64",
  8468. "description": "index of the issue",
  8469. "name": "index",
  8470. "in": "path",
  8471. "required": true
  8472. },
  8473. {
  8474. "type": "integer",
  8475. "format": "int64",
  8476. "description": "id of the label to remove",
  8477. "name": "id",
  8478. "in": "path",
  8479. "required": true
  8480. }
  8481. ],
  8482. "responses": {
  8483. "204": {
  8484. "$ref": "#/responses/empty"
  8485. },
  8486. "403": {
  8487. "$ref": "#/responses/forbidden"
  8488. },
  8489. "404": {
  8490. "$ref": "#/responses/notFound"
  8491. },
  8492. "422": {
  8493. "$ref": "#/responses/validationError"
  8494. }
  8495. }
  8496. }
  8497. },
  8498. "/repos/{owner}/{repo}/issues/{index}/pin": {
  8499. "post": {
  8500. "tags": [
  8501. "issue"
  8502. ],
  8503. "summary": "Pin an Issue",
  8504. "operationId": "pinIssue",
  8505. "parameters": [
  8506. {
  8507. "type": "string",
  8508. "description": "owner of the repo",
  8509. "name": "owner",
  8510. "in": "path",
  8511. "required": true
  8512. },
  8513. {
  8514. "type": "string",
  8515. "description": "name of the repo",
  8516. "name": "repo",
  8517. "in": "path",
  8518. "required": true
  8519. },
  8520. {
  8521. "type": "integer",
  8522. "format": "int64",
  8523. "description": "index of issue to pin",
  8524. "name": "index",
  8525. "in": "path",
  8526. "required": true
  8527. }
  8528. ],
  8529. "responses": {
  8530. "204": {
  8531. "$ref": "#/responses/empty"
  8532. },
  8533. "403": {
  8534. "$ref": "#/responses/forbidden"
  8535. },
  8536. "404": {
  8537. "$ref": "#/responses/notFound"
  8538. }
  8539. }
  8540. },
  8541. "delete": {
  8542. "tags": [
  8543. "issue"
  8544. ],
  8545. "summary": "Unpin an Issue",
  8546. "operationId": "unpinIssue",
  8547. "parameters": [
  8548. {
  8549. "type": "string",
  8550. "description": "owner of the repo",
  8551. "name": "owner",
  8552. "in": "path",
  8553. "required": true
  8554. },
  8555. {
  8556. "type": "string",
  8557. "description": "name of the repo",
  8558. "name": "repo",
  8559. "in": "path",
  8560. "required": true
  8561. },
  8562. {
  8563. "type": "integer",
  8564. "format": "int64",
  8565. "description": "index of issue to unpin",
  8566. "name": "index",
  8567. "in": "path",
  8568. "required": true
  8569. }
  8570. ],
  8571. "responses": {
  8572. "204": {
  8573. "$ref": "#/responses/empty"
  8574. },
  8575. "403": {
  8576. "$ref": "#/responses/forbidden"
  8577. },
  8578. "404": {
  8579. "$ref": "#/responses/notFound"
  8580. }
  8581. }
  8582. }
  8583. },
  8584. "/repos/{owner}/{repo}/issues/{index}/pin/{position}": {
  8585. "patch": {
  8586. "tags": [
  8587. "issue"
  8588. ],
  8589. "summary": "Moves the Pin to the given Position",
  8590. "operationId": "moveIssuePin",
  8591. "parameters": [
  8592. {
  8593. "type": "string",
  8594. "description": "owner of the repo",
  8595. "name": "owner",
  8596. "in": "path",
  8597. "required": true
  8598. },
  8599. {
  8600. "type": "string",
  8601. "description": "name of the repo",
  8602. "name": "repo",
  8603. "in": "path",
  8604. "required": true
  8605. },
  8606. {
  8607. "type": "integer",
  8608. "format": "int64",
  8609. "description": "index of issue",
  8610. "name": "index",
  8611. "in": "path",
  8612. "required": true
  8613. },
  8614. {
  8615. "type": "integer",
  8616. "format": "int64",
  8617. "description": "the new position",
  8618. "name": "position",
  8619. "in": "path",
  8620. "required": true
  8621. }
  8622. ],
  8623. "responses": {
  8624. "204": {
  8625. "$ref": "#/responses/empty"
  8626. },
  8627. "403": {
  8628. "$ref": "#/responses/forbidden"
  8629. },
  8630. "404": {
  8631. "$ref": "#/responses/notFound"
  8632. }
  8633. }
  8634. }
  8635. },
  8636. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  8637. "get": {
  8638. "consumes": [
  8639. "application/json"
  8640. ],
  8641. "produces": [
  8642. "application/json"
  8643. ],
  8644. "tags": [
  8645. "issue"
  8646. ],
  8647. "summary": "Get a list reactions of an issue",
  8648. "operationId": "issueGetIssueReactions",
  8649. "parameters": [
  8650. {
  8651. "type": "string",
  8652. "description": "owner of the repo",
  8653. "name": "owner",
  8654. "in": "path",
  8655. "required": true
  8656. },
  8657. {
  8658. "type": "string",
  8659. "description": "name of the repo",
  8660. "name": "repo",
  8661. "in": "path",
  8662. "required": true
  8663. },
  8664. {
  8665. "type": "integer",
  8666. "format": "int64",
  8667. "description": "index of the issue",
  8668. "name": "index",
  8669. "in": "path",
  8670. "required": true
  8671. },
  8672. {
  8673. "type": "integer",
  8674. "description": "page number of results to return (1-based)",
  8675. "name": "page",
  8676. "in": "query"
  8677. },
  8678. {
  8679. "type": "integer",
  8680. "description": "page size of results",
  8681. "name": "limit",
  8682. "in": "query"
  8683. }
  8684. ],
  8685. "responses": {
  8686. "200": {
  8687. "$ref": "#/responses/ReactionList"
  8688. },
  8689. "403": {
  8690. "$ref": "#/responses/forbidden"
  8691. },
  8692. "404": {
  8693. "$ref": "#/responses/notFound"
  8694. }
  8695. }
  8696. },
  8697. "post": {
  8698. "consumes": [
  8699. "application/json"
  8700. ],
  8701. "produces": [
  8702. "application/json"
  8703. ],
  8704. "tags": [
  8705. "issue"
  8706. ],
  8707. "summary": "Add a reaction to an issue",
  8708. "operationId": "issuePostIssueReaction",
  8709. "parameters": [
  8710. {
  8711. "type": "string",
  8712. "description": "owner of the repo",
  8713. "name": "owner",
  8714. "in": "path",
  8715. "required": true
  8716. },
  8717. {
  8718. "type": "string",
  8719. "description": "name of the repo",
  8720. "name": "repo",
  8721. "in": "path",
  8722. "required": true
  8723. },
  8724. {
  8725. "type": "integer",
  8726. "format": "int64",
  8727. "description": "index of the issue",
  8728. "name": "index",
  8729. "in": "path",
  8730. "required": true
  8731. },
  8732. {
  8733. "name": "content",
  8734. "in": "body",
  8735. "schema": {
  8736. "$ref": "#/definitions/EditReactionOption"
  8737. }
  8738. }
  8739. ],
  8740. "responses": {
  8741. "200": {
  8742. "$ref": "#/responses/Reaction"
  8743. },
  8744. "201": {
  8745. "$ref": "#/responses/Reaction"
  8746. },
  8747. "403": {
  8748. "$ref": "#/responses/forbidden"
  8749. },
  8750. "404": {
  8751. "$ref": "#/responses/notFound"
  8752. }
  8753. }
  8754. },
  8755. "delete": {
  8756. "consumes": [
  8757. "application/json"
  8758. ],
  8759. "produces": [
  8760. "application/json"
  8761. ],
  8762. "tags": [
  8763. "issue"
  8764. ],
  8765. "summary": "Remove a reaction from an issue",
  8766. "operationId": "issueDeleteIssueReaction",
  8767. "parameters": [
  8768. {
  8769. "type": "string",
  8770. "description": "owner of the repo",
  8771. "name": "owner",
  8772. "in": "path",
  8773. "required": true
  8774. },
  8775. {
  8776. "type": "string",
  8777. "description": "name of the repo",
  8778. "name": "repo",
  8779. "in": "path",
  8780. "required": true
  8781. },
  8782. {
  8783. "type": "integer",
  8784. "format": "int64",
  8785. "description": "index of the issue",
  8786. "name": "index",
  8787. "in": "path",
  8788. "required": true
  8789. },
  8790. {
  8791. "name": "content",
  8792. "in": "body",
  8793. "schema": {
  8794. "$ref": "#/definitions/EditReactionOption"
  8795. }
  8796. }
  8797. ],
  8798. "responses": {
  8799. "200": {
  8800. "$ref": "#/responses/empty"
  8801. },
  8802. "403": {
  8803. "$ref": "#/responses/forbidden"
  8804. },
  8805. "404": {
  8806. "$ref": "#/responses/notFound"
  8807. }
  8808. }
  8809. }
  8810. },
  8811. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  8812. "delete": {
  8813. "consumes": [
  8814. "application/json"
  8815. ],
  8816. "produces": [
  8817. "application/json"
  8818. ],
  8819. "tags": [
  8820. "issue"
  8821. ],
  8822. "summary": "Delete an issue's existing stopwatch.",
  8823. "operationId": "issueDeleteStopWatch",
  8824. "parameters": [
  8825. {
  8826. "type": "string",
  8827. "description": "owner of the repo",
  8828. "name": "owner",
  8829. "in": "path",
  8830. "required": true
  8831. },
  8832. {
  8833. "type": "string",
  8834. "description": "name of the repo",
  8835. "name": "repo",
  8836. "in": "path",
  8837. "required": true
  8838. },
  8839. {
  8840. "type": "integer",
  8841. "format": "int64",
  8842. "description": "index of the issue to stop the stopwatch on",
  8843. "name": "index",
  8844. "in": "path",
  8845. "required": true
  8846. }
  8847. ],
  8848. "responses": {
  8849. "204": {
  8850. "$ref": "#/responses/empty"
  8851. },
  8852. "403": {
  8853. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8854. },
  8855. "404": {
  8856. "$ref": "#/responses/notFound"
  8857. },
  8858. "409": {
  8859. "description": "Cannot cancel a non existent stopwatch"
  8860. }
  8861. }
  8862. }
  8863. },
  8864. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  8865. "post": {
  8866. "consumes": [
  8867. "application/json"
  8868. ],
  8869. "produces": [
  8870. "application/json"
  8871. ],
  8872. "tags": [
  8873. "issue"
  8874. ],
  8875. "summary": "Start stopwatch on an issue.",
  8876. "operationId": "issueStartStopWatch",
  8877. "parameters": [
  8878. {
  8879. "type": "string",
  8880. "description": "owner of the repo",
  8881. "name": "owner",
  8882. "in": "path",
  8883. "required": true
  8884. },
  8885. {
  8886. "type": "string",
  8887. "description": "name of the repo",
  8888. "name": "repo",
  8889. "in": "path",
  8890. "required": true
  8891. },
  8892. {
  8893. "type": "integer",
  8894. "format": "int64",
  8895. "description": "index of the issue to create the stopwatch on",
  8896. "name": "index",
  8897. "in": "path",
  8898. "required": true
  8899. }
  8900. ],
  8901. "responses": {
  8902. "201": {
  8903. "$ref": "#/responses/empty"
  8904. },
  8905. "403": {
  8906. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8907. },
  8908. "404": {
  8909. "$ref": "#/responses/notFound"
  8910. },
  8911. "409": {
  8912. "description": "Cannot start a stopwatch again if it already exists"
  8913. }
  8914. }
  8915. }
  8916. },
  8917. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  8918. "post": {
  8919. "consumes": [
  8920. "application/json"
  8921. ],
  8922. "produces": [
  8923. "application/json"
  8924. ],
  8925. "tags": [
  8926. "issue"
  8927. ],
  8928. "summary": "Stop an issue's existing stopwatch.",
  8929. "operationId": "issueStopStopWatch",
  8930. "parameters": [
  8931. {
  8932. "type": "string",
  8933. "description": "owner of the repo",
  8934. "name": "owner",
  8935. "in": "path",
  8936. "required": true
  8937. },
  8938. {
  8939. "type": "string",
  8940. "description": "name of the repo",
  8941. "name": "repo",
  8942. "in": "path",
  8943. "required": true
  8944. },
  8945. {
  8946. "type": "integer",
  8947. "format": "int64",
  8948. "description": "index of the issue to stop the stopwatch on",
  8949. "name": "index",
  8950. "in": "path",
  8951. "required": true
  8952. }
  8953. ],
  8954. "responses": {
  8955. "201": {
  8956. "$ref": "#/responses/empty"
  8957. },
  8958. "403": {
  8959. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8960. },
  8961. "404": {
  8962. "$ref": "#/responses/notFound"
  8963. },
  8964. "409": {
  8965. "description": "Cannot stop a non existent stopwatch"
  8966. }
  8967. }
  8968. }
  8969. },
  8970. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  8971. "get": {
  8972. "consumes": [
  8973. "application/json"
  8974. ],
  8975. "produces": [
  8976. "application/json"
  8977. ],
  8978. "tags": [
  8979. "issue"
  8980. ],
  8981. "summary": "Get users who subscribed on an issue.",
  8982. "operationId": "issueSubscriptions",
  8983. "parameters": [
  8984. {
  8985. "type": "string",
  8986. "description": "owner of the repo",
  8987. "name": "owner",
  8988. "in": "path",
  8989. "required": true
  8990. },
  8991. {
  8992. "type": "string",
  8993. "description": "name of the repo",
  8994. "name": "repo",
  8995. "in": "path",
  8996. "required": true
  8997. },
  8998. {
  8999. "type": "integer",
  9000. "format": "int64",
  9001. "description": "index of the issue",
  9002. "name": "index",
  9003. "in": "path",
  9004. "required": true
  9005. },
  9006. {
  9007. "type": "integer",
  9008. "description": "page number of results to return (1-based)",
  9009. "name": "page",
  9010. "in": "query"
  9011. },
  9012. {
  9013. "type": "integer",
  9014. "description": "page size of results",
  9015. "name": "limit",
  9016. "in": "query"
  9017. }
  9018. ],
  9019. "responses": {
  9020. "200": {
  9021. "$ref": "#/responses/UserList"
  9022. },
  9023. "404": {
  9024. "$ref": "#/responses/notFound"
  9025. }
  9026. }
  9027. }
  9028. },
  9029. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  9030. "get": {
  9031. "consumes": [
  9032. "application/json"
  9033. ],
  9034. "produces": [
  9035. "application/json"
  9036. ],
  9037. "tags": [
  9038. "issue"
  9039. ],
  9040. "summary": "Check if user is subscribed to an issue",
  9041. "operationId": "issueCheckSubscription",
  9042. "parameters": [
  9043. {
  9044. "type": "string",
  9045. "description": "owner of the repo",
  9046. "name": "owner",
  9047. "in": "path",
  9048. "required": true
  9049. },
  9050. {
  9051. "type": "string",
  9052. "description": "name of the repo",
  9053. "name": "repo",
  9054. "in": "path",
  9055. "required": true
  9056. },
  9057. {
  9058. "type": "integer",
  9059. "format": "int64",
  9060. "description": "index of the issue",
  9061. "name": "index",
  9062. "in": "path",
  9063. "required": true
  9064. }
  9065. ],
  9066. "responses": {
  9067. "200": {
  9068. "$ref": "#/responses/WatchInfo"
  9069. },
  9070. "404": {
  9071. "$ref": "#/responses/notFound"
  9072. }
  9073. }
  9074. }
  9075. },
  9076. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  9077. "put": {
  9078. "consumes": [
  9079. "application/json"
  9080. ],
  9081. "produces": [
  9082. "application/json"
  9083. ],
  9084. "tags": [
  9085. "issue"
  9086. ],
  9087. "summary": "Subscribe user to issue",
  9088. "operationId": "issueAddSubscription",
  9089. "parameters": [
  9090. {
  9091. "type": "string",
  9092. "description": "owner of the repo",
  9093. "name": "owner",
  9094. "in": "path",
  9095. "required": true
  9096. },
  9097. {
  9098. "type": "string",
  9099. "description": "name of the repo",
  9100. "name": "repo",
  9101. "in": "path",
  9102. "required": true
  9103. },
  9104. {
  9105. "type": "integer",
  9106. "format": "int64",
  9107. "description": "index of the issue",
  9108. "name": "index",
  9109. "in": "path",
  9110. "required": true
  9111. },
  9112. {
  9113. "type": "string",
  9114. "description": "user to subscribe",
  9115. "name": "user",
  9116. "in": "path",
  9117. "required": true
  9118. }
  9119. ],
  9120. "responses": {
  9121. "200": {
  9122. "description": "Already subscribed"
  9123. },
  9124. "201": {
  9125. "description": "Successfully Subscribed"
  9126. },
  9127. "304": {
  9128. "description": "User can only subscribe itself if he is no admin"
  9129. },
  9130. "404": {
  9131. "$ref": "#/responses/notFound"
  9132. }
  9133. }
  9134. },
  9135. "delete": {
  9136. "consumes": [
  9137. "application/json"
  9138. ],
  9139. "produces": [
  9140. "application/json"
  9141. ],
  9142. "tags": [
  9143. "issue"
  9144. ],
  9145. "summary": "Unsubscribe user from issue",
  9146. "operationId": "issueDeleteSubscription",
  9147. "parameters": [
  9148. {
  9149. "type": "string",
  9150. "description": "owner of the repo",
  9151. "name": "owner",
  9152. "in": "path",
  9153. "required": true
  9154. },
  9155. {
  9156. "type": "string",
  9157. "description": "name of the repo",
  9158. "name": "repo",
  9159. "in": "path",
  9160. "required": true
  9161. },
  9162. {
  9163. "type": "integer",
  9164. "format": "int64",
  9165. "description": "index of the issue",
  9166. "name": "index",
  9167. "in": "path",
  9168. "required": true
  9169. },
  9170. {
  9171. "type": "string",
  9172. "description": "user witch unsubscribe",
  9173. "name": "user",
  9174. "in": "path",
  9175. "required": true
  9176. }
  9177. ],
  9178. "responses": {
  9179. "200": {
  9180. "description": "Already unsubscribed"
  9181. },
  9182. "201": {
  9183. "description": "Successfully Unsubscribed"
  9184. },
  9185. "304": {
  9186. "description": "User can only subscribe itself if he is no admin"
  9187. },
  9188. "404": {
  9189. "$ref": "#/responses/notFound"
  9190. }
  9191. }
  9192. }
  9193. },
  9194. "/repos/{owner}/{repo}/issues/{index}/timeline": {
  9195. "get": {
  9196. "produces": [
  9197. "application/json"
  9198. ],
  9199. "tags": [
  9200. "issue"
  9201. ],
  9202. "summary": "List all comments and events on an issue",
  9203. "operationId": "issueGetCommentsAndTimeline",
  9204. "parameters": [
  9205. {
  9206. "type": "string",
  9207. "description": "owner of the repo",
  9208. "name": "owner",
  9209. "in": "path",
  9210. "required": true
  9211. },
  9212. {
  9213. "type": "string",
  9214. "description": "name of the repo",
  9215. "name": "repo",
  9216. "in": "path",
  9217. "required": true
  9218. },
  9219. {
  9220. "type": "integer",
  9221. "format": "int64",
  9222. "description": "index of the issue",
  9223. "name": "index",
  9224. "in": "path",
  9225. "required": true
  9226. },
  9227. {
  9228. "type": "string",
  9229. "format": "date-time",
  9230. "description": "if provided, only comments updated since the specified time are returned.",
  9231. "name": "since",
  9232. "in": "query"
  9233. },
  9234. {
  9235. "type": "integer",
  9236. "description": "page number of results to return (1-based)",
  9237. "name": "page",
  9238. "in": "query"
  9239. },
  9240. {
  9241. "type": "integer",
  9242. "description": "page size of results",
  9243. "name": "limit",
  9244. "in": "query"
  9245. },
  9246. {
  9247. "type": "string",
  9248. "format": "date-time",
  9249. "description": "if provided, only comments updated before the provided time are returned.",
  9250. "name": "before",
  9251. "in": "query"
  9252. }
  9253. ],
  9254. "responses": {
  9255. "200": {
  9256. "$ref": "#/responses/TimelineList"
  9257. },
  9258. "404": {
  9259. "$ref": "#/responses/notFound"
  9260. }
  9261. }
  9262. }
  9263. },
  9264. "/repos/{owner}/{repo}/issues/{index}/times": {
  9265. "get": {
  9266. "produces": [
  9267. "application/json"
  9268. ],
  9269. "tags": [
  9270. "issue"
  9271. ],
  9272. "summary": "List an issue's tracked times",
  9273. "operationId": "issueTrackedTimes",
  9274. "parameters": [
  9275. {
  9276. "type": "string",
  9277. "description": "owner of the repo",
  9278. "name": "owner",
  9279. "in": "path",
  9280. "required": true
  9281. },
  9282. {
  9283. "type": "string",
  9284. "description": "name of the repo",
  9285. "name": "repo",
  9286. "in": "path",
  9287. "required": true
  9288. },
  9289. {
  9290. "type": "integer",
  9291. "format": "int64",
  9292. "description": "index of the issue",
  9293. "name": "index",
  9294. "in": "path",
  9295. "required": true
  9296. },
  9297. {
  9298. "type": "string",
  9299. "description": "optional filter by user (available for issue managers)",
  9300. "name": "user",
  9301. "in": "query"
  9302. },
  9303. {
  9304. "type": "string",
  9305. "format": "date-time",
  9306. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9307. "name": "since",
  9308. "in": "query"
  9309. },
  9310. {
  9311. "type": "string",
  9312. "format": "date-time",
  9313. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9314. "name": "before",
  9315. "in": "query"
  9316. },
  9317. {
  9318. "type": "integer",
  9319. "description": "page number of results to return (1-based)",
  9320. "name": "page",
  9321. "in": "query"
  9322. },
  9323. {
  9324. "type": "integer",
  9325. "description": "page size of results",
  9326. "name": "limit",
  9327. "in": "query"
  9328. }
  9329. ],
  9330. "responses": {
  9331. "200": {
  9332. "$ref": "#/responses/TrackedTimeList"
  9333. },
  9334. "404": {
  9335. "$ref": "#/responses/notFound"
  9336. }
  9337. }
  9338. },
  9339. "post": {
  9340. "consumes": [
  9341. "application/json"
  9342. ],
  9343. "produces": [
  9344. "application/json"
  9345. ],
  9346. "tags": [
  9347. "issue"
  9348. ],
  9349. "summary": "Add tracked time to a issue",
  9350. "operationId": "issueAddTime",
  9351. "parameters": [
  9352. {
  9353. "type": "string",
  9354. "description": "owner of the repo",
  9355. "name": "owner",
  9356. "in": "path",
  9357. "required": true
  9358. },
  9359. {
  9360. "type": "string",
  9361. "description": "name of the repo",
  9362. "name": "repo",
  9363. "in": "path",
  9364. "required": true
  9365. },
  9366. {
  9367. "type": "integer",
  9368. "format": "int64",
  9369. "description": "index of the issue",
  9370. "name": "index",
  9371. "in": "path",
  9372. "required": true
  9373. },
  9374. {
  9375. "name": "body",
  9376. "in": "body",
  9377. "schema": {
  9378. "$ref": "#/definitions/AddTimeOption"
  9379. }
  9380. }
  9381. ],
  9382. "responses": {
  9383. "200": {
  9384. "$ref": "#/responses/TrackedTime"
  9385. },
  9386. "400": {
  9387. "$ref": "#/responses/error"
  9388. },
  9389. "403": {
  9390. "$ref": "#/responses/forbidden"
  9391. },
  9392. "404": {
  9393. "$ref": "#/responses/notFound"
  9394. }
  9395. }
  9396. },
  9397. "delete": {
  9398. "consumes": [
  9399. "application/json"
  9400. ],
  9401. "produces": [
  9402. "application/json"
  9403. ],
  9404. "tags": [
  9405. "issue"
  9406. ],
  9407. "summary": "Reset a tracked time of an issue",
  9408. "operationId": "issueResetTime",
  9409. "parameters": [
  9410. {
  9411. "type": "string",
  9412. "description": "owner of the repo",
  9413. "name": "owner",
  9414. "in": "path",
  9415. "required": true
  9416. },
  9417. {
  9418. "type": "string",
  9419. "description": "name of the repo",
  9420. "name": "repo",
  9421. "in": "path",
  9422. "required": true
  9423. },
  9424. {
  9425. "type": "integer",
  9426. "format": "int64",
  9427. "description": "index of the issue to add tracked time to",
  9428. "name": "index",
  9429. "in": "path",
  9430. "required": true
  9431. }
  9432. ],
  9433. "responses": {
  9434. "204": {
  9435. "$ref": "#/responses/empty"
  9436. },
  9437. "400": {
  9438. "$ref": "#/responses/error"
  9439. },
  9440. "403": {
  9441. "$ref": "#/responses/forbidden"
  9442. },
  9443. "404": {
  9444. "$ref": "#/responses/notFound"
  9445. }
  9446. }
  9447. }
  9448. },
  9449. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  9450. "delete": {
  9451. "consumes": [
  9452. "application/json"
  9453. ],
  9454. "produces": [
  9455. "application/json"
  9456. ],
  9457. "tags": [
  9458. "issue"
  9459. ],
  9460. "summary": "Delete specific tracked time",
  9461. "operationId": "issueDeleteTime",
  9462. "parameters": [
  9463. {
  9464. "type": "string",
  9465. "description": "owner of the repo",
  9466. "name": "owner",
  9467. "in": "path",
  9468. "required": true
  9469. },
  9470. {
  9471. "type": "string",
  9472. "description": "name of the repo",
  9473. "name": "repo",
  9474. "in": "path",
  9475. "required": true
  9476. },
  9477. {
  9478. "type": "integer",
  9479. "format": "int64",
  9480. "description": "index of the issue",
  9481. "name": "index",
  9482. "in": "path",
  9483. "required": true
  9484. },
  9485. {
  9486. "type": "integer",
  9487. "format": "int64",
  9488. "description": "id of time to delete",
  9489. "name": "id",
  9490. "in": "path",
  9491. "required": true
  9492. }
  9493. ],
  9494. "responses": {
  9495. "204": {
  9496. "$ref": "#/responses/empty"
  9497. },
  9498. "400": {
  9499. "$ref": "#/responses/error"
  9500. },
  9501. "403": {
  9502. "$ref": "#/responses/forbidden"
  9503. },
  9504. "404": {
  9505. "$ref": "#/responses/notFound"
  9506. }
  9507. }
  9508. }
  9509. },
  9510. "/repos/{owner}/{repo}/keys": {
  9511. "get": {
  9512. "produces": [
  9513. "application/json"
  9514. ],
  9515. "tags": [
  9516. "repository"
  9517. ],
  9518. "summary": "List a repository's keys",
  9519. "operationId": "repoListKeys",
  9520. "parameters": [
  9521. {
  9522. "type": "string",
  9523. "description": "owner of the repo",
  9524. "name": "owner",
  9525. "in": "path",
  9526. "required": true
  9527. },
  9528. {
  9529. "type": "string",
  9530. "description": "name of the repo",
  9531. "name": "repo",
  9532. "in": "path",
  9533. "required": true
  9534. },
  9535. {
  9536. "type": "integer",
  9537. "description": "the key_id to search for",
  9538. "name": "key_id",
  9539. "in": "query"
  9540. },
  9541. {
  9542. "type": "string",
  9543. "description": "fingerprint of the key",
  9544. "name": "fingerprint",
  9545. "in": "query"
  9546. },
  9547. {
  9548. "type": "integer",
  9549. "description": "page number of results to return (1-based)",
  9550. "name": "page",
  9551. "in": "query"
  9552. },
  9553. {
  9554. "type": "integer",
  9555. "description": "page size of results",
  9556. "name": "limit",
  9557. "in": "query"
  9558. }
  9559. ],
  9560. "responses": {
  9561. "200": {
  9562. "$ref": "#/responses/DeployKeyList"
  9563. },
  9564. "404": {
  9565. "$ref": "#/responses/notFound"
  9566. }
  9567. }
  9568. },
  9569. "post": {
  9570. "consumes": [
  9571. "application/json"
  9572. ],
  9573. "produces": [
  9574. "application/json"
  9575. ],
  9576. "tags": [
  9577. "repository"
  9578. ],
  9579. "summary": "Add a key to a repository",
  9580. "operationId": "repoCreateKey",
  9581. "parameters": [
  9582. {
  9583. "type": "string",
  9584. "description": "owner of the repo",
  9585. "name": "owner",
  9586. "in": "path",
  9587. "required": true
  9588. },
  9589. {
  9590. "type": "string",
  9591. "description": "name of the repo",
  9592. "name": "repo",
  9593. "in": "path",
  9594. "required": true
  9595. },
  9596. {
  9597. "name": "body",
  9598. "in": "body",
  9599. "schema": {
  9600. "$ref": "#/definitions/CreateKeyOption"
  9601. }
  9602. }
  9603. ],
  9604. "responses": {
  9605. "201": {
  9606. "$ref": "#/responses/DeployKey"
  9607. },
  9608. "404": {
  9609. "$ref": "#/responses/notFound"
  9610. },
  9611. "422": {
  9612. "$ref": "#/responses/validationError"
  9613. }
  9614. }
  9615. }
  9616. },
  9617. "/repos/{owner}/{repo}/keys/{id}": {
  9618. "get": {
  9619. "produces": [
  9620. "application/json"
  9621. ],
  9622. "tags": [
  9623. "repository"
  9624. ],
  9625. "summary": "Get a repository's key by id",
  9626. "operationId": "repoGetKey",
  9627. "parameters": [
  9628. {
  9629. "type": "string",
  9630. "description": "owner of the repo",
  9631. "name": "owner",
  9632. "in": "path",
  9633. "required": true
  9634. },
  9635. {
  9636. "type": "string",
  9637. "description": "name of the repo",
  9638. "name": "repo",
  9639. "in": "path",
  9640. "required": true
  9641. },
  9642. {
  9643. "type": "integer",
  9644. "format": "int64",
  9645. "description": "id of the key to get",
  9646. "name": "id",
  9647. "in": "path",
  9648. "required": true
  9649. }
  9650. ],
  9651. "responses": {
  9652. "200": {
  9653. "$ref": "#/responses/DeployKey"
  9654. },
  9655. "404": {
  9656. "$ref": "#/responses/notFound"
  9657. }
  9658. }
  9659. },
  9660. "delete": {
  9661. "tags": [
  9662. "repository"
  9663. ],
  9664. "summary": "Delete a key from a repository",
  9665. "operationId": "repoDeleteKey",
  9666. "parameters": [
  9667. {
  9668. "type": "string",
  9669. "description": "owner of the repo",
  9670. "name": "owner",
  9671. "in": "path",
  9672. "required": true
  9673. },
  9674. {
  9675. "type": "string",
  9676. "description": "name of the repo",
  9677. "name": "repo",
  9678. "in": "path",
  9679. "required": true
  9680. },
  9681. {
  9682. "type": "integer",
  9683. "format": "int64",
  9684. "description": "id of the key to delete",
  9685. "name": "id",
  9686. "in": "path",
  9687. "required": true
  9688. }
  9689. ],
  9690. "responses": {
  9691. "204": {
  9692. "$ref": "#/responses/empty"
  9693. },
  9694. "403": {
  9695. "$ref": "#/responses/forbidden"
  9696. },
  9697. "404": {
  9698. "$ref": "#/responses/notFound"
  9699. }
  9700. }
  9701. }
  9702. },
  9703. "/repos/{owner}/{repo}/labels": {
  9704. "get": {
  9705. "produces": [
  9706. "application/json"
  9707. ],
  9708. "tags": [
  9709. "issue"
  9710. ],
  9711. "summary": "Get all of a repository's labels",
  9712. "operationId": "issueListLabels",
  9713. "parameters": [
  9714. {
  9715. "type": "string",
  9716. "description": "owner of the repo",
  9717. "name": "owner",
  9718. "in": "path",
  9719. "required": true
  9720. },
  9721. {
  9722. "type": "string",
  9723. "description": "name of the repo",
  9724. "name": "repo",
  9725. "in": "path",
  9726. "required": true
  9727. },
  9728. {
  9729. "type": "integer",
  9730. "description": "page number of results to return (1-based)",
  9731. "name": "page",
  9732. "in": "query"
  9733. },
  9734. {
  9735. "type": "integer",
  9736. "description": "page size of results",
  9737. "name": "limit",
  9738. "in": "query"
  9739. }
  9740. ],
  9741. "responses": {
  9742. "200": {
  9743. "$ref": "#/responses/LabelList"
  9744. },
  9745. "404": {
  9746. "$ref": "#/responses/notFound"
  9747. }
  9748. }
  9749. },
  9750. "post": {
  9751. "consumes": [
  9752. "application/json"
  9753. ],
  9754. "produces": [
  9755. "application/json"
  9756. ],
  9757. "tags": [
  9758. "issue"
  9759. ],
  9760. "summary": "Create a label",
  9761. "operationId": "issueCreateLabel",
  9762. "parameters": [
  9763. {
  9764. "type": "string",
  9765. "description": "owner of the repo",
  9766. "name": "owner",
  9767. "in": "path",
  9768. "required": true
  9769. },
  9770. {
  9771. "type": "string",
  9772. "description": "name of the repo",
  9773. "name": "repo",
  9774. "in": "path",
  9775. "required": true
  9776. },
  9777. {
  9778. "name": "body",
  9779. "in": "body",
  9780. "schema": {
  9781. "$ref": "#/definitions/CreateLabelOption"
  9782. }
  9783. }
  9784. ],
  9785. "responses": {
  9786. "201": {
  9787. "$ref": "#/responses/Label"
  9788. },
  9789. "404": {
  9790. "$ref": "#/responses/notFound"
  9791. },
  9792. "422": {
  9793. "$ref": "#/responses/validationError"
  9794. }
  9795. }
  9796. }
  9797. },
  9798. "/repos/{owner}/{repo}/labels/{id}": {
  9799. "get": {
  9800. "produces": [
  9801. "application/json"
  9802. ],
  9803. "tags": [
  9804. "issue"
  9805. ],
  9806. "summary": "Get a single label",
  9807. "operationId": "issueGetLabel",
  9808. "parameters": [
  9809. {
  9810. "type": "string",
  9811. "description": "owner of the repo",
  9812. "name": "owner",
  9813. "in": "path",
  9814. "required": true
  9815. },
  9816. {
  9817. "type": "string",
  9818. "description": "name of the repo",
  9819. "name": "repo",
  9820. "in": "path",
  9821. "required": true
  9822. },
  9823. {
  9824. "type": "integer",
  9825. "format": "int64",
  9826. "description": "id of the label to get",
  9827. "name": "id",
  9828. "in": "path",
  9829. "required": true
  9830. }
  9831. ],
  9832. "responses": {
  9833. "200": {
  9834. "$ref": "#/responses/Label"
  9835. },
  9836. "404": {
  9837. "$ref": "#/responses/notFound"
  9838. }
  9839. }
  9840. },
  9841. "delete": {
  9842. "tags": [
  9843. "issue"
  9844. ],
  9845. "summary": "Delete a label",
  9846. "operationId": "issueDeleteLabel",
  9847. "parameters": [
  9848. {
  9849. "type": "string",
  9850. "description": "owner of the repo",
  9851. "name": "owner",
  9852. "in": "path",
  9853. "required": true
  9854. },
  9855. {
  9856. "type": "string",
  9857. "description": "name of the repo",
  9858. "name": "repo",
  9859. "in": "path",
  9860. "required": true
  9861. },
  9862. {
  9863. "type": "integer",
  9864. "format": "int64",
  9865. "description": "id of the label to delete",
  9866. "name": "id",
  9867. "in": "path",
  9868. "required": true
  9869. }
  9870. ],
  9871. "responses": {
  9872. "204": {
  9873. "$ref": "#/responses/empty"
  9874. },
  9875. "404": {
  9876. "$ref": "#/responses/notFound"
  9877. }
  9878. }
  9879. },
  9880. "patch": {
  9881. "consumes": [
  9882. "application/json"
  9883. ],
  9884. "produces": [
  9885. "application/json"
  9886. ],
  9887. "tags": [
  9888. "issue"
  9889. ],
  9890. "summary": "Update a label",
  9891. "operationId": "issueEditLabel",
  9892. "parameters": [
  9893. {
  9894. "type": "string",
  9895. "description": "owner of the repo",
  9896. "name": "owner",
  9897. "in": "path",
  9898. "required": true
  9899. },
  9900. {
  9901. "type": "string",
  9902. "description": "name of the repo",
  9903. "name": "repo",
  9904. "in": "path",
  9905. "required": true
  9906. },
  9907. {
  9908. "type": "integer",
  9909. "format": "int64",
  9910. "description": "id of the label to edit",
  9911. "name": "id",
  9912. "in": "path",
  9913. "required": true
  9914. },
  9915. {
  9916. "name": "body",
  9917. "in": "body",
  9918. "schema": {
  9919. "$ref": "#/definitions/EditLabelOption"
  9920. }
  9921. }
  9922. ],
  9923. "responses": {
  9924. "200": {
  9925. "$ref": "#/responses/Label"
  9926. },
  9927. "404": {
  9928. "$ref": "#/responses/notFound"
  9929. },
  9930. "422": {
  9931. "$ref": "#/responses/validationError"
  9932. }
  9933. }
  9934. }
  9935. },
  9936. "/repos/{owner}/{repo}/languages": {
  9937. "get": {
  9938. "produces": [
  9939. "application/json"
  9940. ],
  9941. "tags": [
  9942. "repository"
  9943. ],
  9944. "summary": "Get languages and number of bytes of code written",
  9945. "operationId": "repoGetLanguages",
  9946. "parameters": [
  9947. {
  9948. "type": "string",
  9949. "description": "owner of the repo",
  9950. "name": "owner",
  9951. "in": "path",
  9952. "required": true
  9953. },
  9954. {
  9955. "type": "string",
  9956. "description": "name of the repo",
  9957. "name": "repo",
  9958. "in": "path",
  9959. "required": true
  9960. }
  9961. ],
  9962. "responses": {
  9963. "200": {
  9964. "$ref": "#/responses/LanguageStatistics"
  9965. },
  9966. "404": {
  9967. "$ref": "#/responses/notFound"
  9968. }
  9969. }
  9970. }
  9971. },
  9972. "/repos/{owner}/{repo}/media/{filepath}": {
  9973. "get": {
  9974. "tags": [
  9975. "repository"
  9976. ],
  9977. "summary": "Get a file or it's LFS object from a repository",
  9978. "operationId": "repoGetRawFileOrLFS",
  9979. "parameters": [
  9980. {
  9981. "type": "string",
  9982. "description": "owner of the repo",
  9983. "name": "owner",
  9984. "in": "path",
  9985. "required": true
  9986. },
  9987. {
  9988. "type": "string",
  9989. "description": "name of the repo",
  9990. "name": "repo",
  9991. "in": "path",
  9992. "required": true
  9993. },
  9994. {
  9995. "type": "string",
  9996. "description": "filepath of the file to get",
  9997. "name": "filepath",
  9998. "in": "path",
  9999. "required": true
  10000. },
  10001. {
  10002. "type": "string",
  10003. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  10004. "name": "ref",
  10005. "in": "query"
  10006. }
  10007. ],
  10008. "responses": {
  10009. "200": {
  10010. "description": "Returns raw file content."
  10011. },
  10012. "404": {
  10013. "$ref": "#/responses/notFound"
  10014. }
  10015. }
  10016. }
  10017. },
  10018. "/repos/{owner}/{repo}/milestones": {
  10019. "get": {
  10020. "produces": [
  10021. "application/json"
  10022. ],
  10023. "tags": [
  10024. "issue"
  10025. ],
  10026. "summary": "Get all of a repository's opened milestones",
  10027. "operationId": "issueGetMilestonesList",
  10028. "parameters": [
  10029. {
  10030. "type": "string",
  10031. "description": "owner of the repo",
  10032. "name": "owner",
  10033. "in": "path",
  10034. "required": true
  10035. },
  10036. {
  10037. "type": "string",
  10038. "description": "name of the repo",
  10039. "name": "repo",
  10040. "in": "path",
  10041. "required": true
  10042. },
  10043. {
  10044. "type": "string",
  10045. "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
  10046. "name": "state",
  10047. "in": "query"
  10048. },
  10049. {
  10050. "type": "string",
  10051. "description": "filter by milestone name",
  10052. "name": "name",
  10053. "in": "query"
  10054. },
  10055. {
  10056. "type": "integer",
  10057. "description": "page number of results to return (1-based)",
  10058. "name": "page",
  10059. "in": "query"
  10060. },
  10061. {
  10062. "type": "integer",
  10063. "description": "page size of results",
  10064. "name": "limit",
  10065. "in": "query"
  10066. }
  10067. ],
  10068. "responses": {
  10069. "200": {
  10070. "$ref": "#/responses/MilestoneList"
  10071. },
  10072. "404": {
  10073. "$ref": "#/responses/notFound"
  10074. }
  10075. }
  10076. },
  10077. "post": {
  10078. "consumes": [
  10079. "application/json"
  10080. ],
  10081. "produces": [
  10082. "application/json"
  10083. ],
  10084. "tags": [
  10085. "issue"
  10086. ],
  10087. "summary": "Create a milestone",
  10088. "operationId": "issueCreateMilestone",
  10089. "parameters": [
  10090. {
  10091. "type": "string",
  10092. "description": "owner of the repo",
  10093. "name": "owner",
  10094. "in": "path",
  10095. "required": true
  10096. },
  10097. {
  10098. "type": "string",
  10099. "description": "name of the repo",
  10100. "name": "repo",
  10101. "in": "path",
  10102. "required": true
  10103. },
  10104. {
  10105. "name": "body",
  10106. "in": "body",
  10107. "schema": {
  10108. "$ref": "#/definitions/CreateMilestoneOption"
  10109. }
  10110. }
  10111. ],
  10112. "responses": {
  10113. "201": {
  10114. "$ref": "#/responses/Milestone"
  10115. },
  10116. "404": {
  10117. "$ref": "#/responses/notFound"
  10118. }
  10119. }
  10120. }
  10121. },
  10122. "/repos/{owner}/{repo}/milestones/{id}": {
  10123. "get": {
  10124. "produces": [
  10125. "application/json"
  10126. ],
  10127. "tags": [
  10128. "issue"
  10129. ],
  10130. "summary": "Get a milestone",
  10131. "operationId": "issueGetMilestone",
  10132. "parameters": [
  10133. {
  10134. "type": "string",
  10135. "description": "owner of the repo",
  10136. "name": "owner",
  10137. "in": "path",
  10138. "required": true
  10139. },
  10140. {
  10141. "type": "string",
  10142. "description": "name of the repo",
  10143. "name": "repo",
  10144. "in": "path",
  10145. "required": true
  10146. },
  10147. {
  10148. "type": "string",
  10149. "description": "the milestone to get, identified by ID and if not available by name",
  10150. "name": "id",
  10151. "in": "path",
  10152. "required": true
  10153. }
  10154. ],
  10155. "responses": {
  10156. "200": {
  10157. "$ref": "#/responses/Milestone"
  10158. },
  10159. "404": {
  10160. "$ref": "#/responses/notFound"
  10161. }
  10162. }
  10163. },
  10164. "delete": {
  10165. "tags": [
  10166. "issue"
  10167. ],
  10168. "summary": "Delete a milestone",
  10169. "operationId": "issueDeleteMilestone",
  10170. "parameters": [
  10171. {
  10172. "type": "string",
  10173. "description": "owner of the repo",
  10174. "name": "owner",
  10175. "in": "path",
  10176. "required": true
  10177. },
  10178. {
  10179. "type": "string",
  10180. "description": "name of the repo",
  10181. "name": "repo",
  10182. "in": "path",
  10183. "required": true
  10184. },
  10185. {
  10186. "type": "string",
  10187. "description": "the milestone to delete, identified by ID and if not available by name",
  10188. "name": "id",
  10189. "in": "path",
  10190. "required": true
  10191. }
  10192. ],
  10193. "responses": {
  10194. "204": {
  10195. "$ref": "#/responses/empty"
  10196. },
  10197. "404": {
  10198. "$ref": "#/responses/notFound"
  10199. }
  10200. }
  10201. },
  10202. "patch": {
  10203. "consumes": [
  10204. "application/json"
  10205. ],
  10206. "produces": [
  10207. "application/json"
  10208. ],
  10209. "tags": [
  10210. "issue"
  10211. ],
  10212. "summary": "Update a milestone",
  10213. "operationId": "issueEditMilestone",
  10214. "parameters": [
  10215. {
  10216. "type": "string",
  10217. "description": "owner of the repo",
  10218. "name": "owner",
  10219. "in": "path",
  10220. "required": true
  10221. },
  10222. {
  10223. "type": "string",
  10224. "description": "name of the repo",
  10225. "name": "repo",
  10226. "in": "path",
  10227. "required": true
  10228. },
  10229. {
  10230. "type": "string",
  10231. "description": "the milestone to edit, identified by ID and if not available by name",
  10232. "name": "id",
  10233. "in": "path",
  10234. "required": true
  10235. },
  10236. {
  10237. "name": "body",
  10238. "in": "body",
  10239. "schema": {
  10240. "$ref": "#/definitions/EditMilestoneOption"
  10241. }
  10242. }
  10243. ],
  10244. "responses": {
  10245. "200": {
  10246. "$ref": "#/responses/Milestone"
  10247. },
  10248. "404": {
  10249. "$ref": "#/responses/notFound"
  10250. }
  10251. }
  10252. }
  10253. },
  10254. "/repos/{owner}/{repo}/mirror-sync": {
  10255. "post": {
  10256. "produces": [
  10257. "application/json"
  10258. ],
  10259. "tags": [
  10260. "repository"
  10261. ],
  10262. "summary": "Sync a mirrored repository",
  10263. "operationId": "repoMirrorSync",
  10264. "parameters": [
  10265. {
  10266. "type": "string",
  10267. "description": "owner of the repo to sync",
  10268. "name": "owner",
  10269. "in": "path",
  10270. "required": true
  10271. },
  10272. {
  10273. "type": "string",
  10274. "description": "name of the repo to sync",
  10275. "name": "repo",
  10276. "in": "path",
  10277. "required": true
  10278. }
  10279. ],
  10280. "responses": {
  10281. "200": {
  10282. "$ref": "#/responses/empty"
  10283. },
  10284. "403": {
  10285. "$ref": "#/responses/forbidden"
  10286. },
  10287. "404": {
  10288. "$ref": "#/responses/notFound"
  10289. }
  10290. }
  10291. }
  10292. },
  10293. "/repos/{owner}/{repo}/new_pin_allowed": {
  10294. "get": {
  10295. "produces": [
  10296. "application/json"
  10297. ],
  10298. "tags": [
  10299. "repository"
  10300. ],
  10301. "summary": "Returns if new Issue Pins are allowed",
  10302. "operationId": "repoNewPinAllowed",
  10303. "parameters": [
  10304. {
  10305. "type": "string",
  10306. "description": "owner of the repo",
  10307. "name": "owner",
  10308. "in": "path",
  10309. "required": true
  10310. },
  10311. {
  10312. "type": "string",
  10313. "description": "name of the repo",
  10314. "name": "repo",
  10315. "in": "path",
  10316. "required": true
  10317. }
  10318. ],
  10319. "responses": {
  10320. "200": {
  10321. "$ref": "#/responses/RepoNewIssuePinsAllowed"
  10322. },
  10323. "404": {
  10324. "$ref": "#/responses/notFound"
  10325. }
  10326. }
  10327. }
  10328. },
  10329. "/repos/{owner}/{repo}/notifications": {
  10330. "get": {
  10331. "consumes": [
  10332. "application/json"
  10333. ],
  10334. "produces": [
  10335. "application/json"
  10336. ],
  10337. "tags": [
  10338. "notification"
  10339. ],
  10340. "summary": "List users's notification threads on a specific repo",
  10341. "operationId": "notifyGetRepoList",
  10342. "parameters": [
  10343. {
  10344. "type": "string",
  10345. "description": "owner of the repo",
  10346. "name": "owner",
  10347. "in": "path",
  10348. "required": true
  10349. },
  10350. {
  10351. "type": "string",
  10352. "description": "name of the repo",
  10353. "name": "repo",
  10354. "in": "path",
  10355. "required": true
  10356. },
  10357. {
  10358. "type": "boolean",
  10359. "description": "If true, show notifications marked as read. Default value is false",
  10360. "name": "all",
  10361. "in": "query"
  10362. },
  10363. {
  10364. "type": "array",
  10365. "items": {
  10366. "type": "string"
  10367. },
  10368. "collectionFormat": "multi",
  10369. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  10370. "name": "status-types",
  10371. "in": "query"
  10372. },
  10373. {
  10374. "type": "array",
  10375. "items": {
  10376. "enum": [
  10377. "issue",
  10378. "pull",
  10379. "commit",
  10380. "repository"
  10381. ],
  10382. "type": "string"
  10383. },
  10384. "collectionFormat": "multi",
  10385. "description": "filter notifications by subject type",
  10386. "name": "subject-type",
  10387. "in": "query"
  10388. },
  10389. {
  10390. "type": "string",
  10391. "format": "date-time",
  10392. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  10393. "name": "since",
  10394. "in": "query"
  10395. },
  10396. {
  10397. "type": "string",
  10398. "format": "date-time",
  10399. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  10400. "name": "before",
  10401. "in": "query"
  10402. },
  10403. {
  10404. "type": "integer",
  10405. "description": "page number of results to return (1-based)",
  10406. "name": "page",
  10407. "in": "query"
  10408. },
  10409. {
  10410. "type": "integer",
  10411. "description": "page size of results",
  10412. "name": "limit",
  10413. "in": "query"
  10414. }
  10415. ],
  10416. "responses": {
  10417. "200": {
  10418. "$ref": "#/responses/NotificationThreadList"
  10419. }
  10420. }
  10421. },
  10422. "put": {
  10423. "consumes": [
  10424. "application/json"
  10425. ],
  10426. "produces": [
  10427. "application/json"
  10428. ],
  10429. "tags": [
  10430. "notification"
  10431. ],
  10432. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  10433. "operationId": "notifyReadRepoList",
  10434. "parameters": [
  10435. {
  10436. "type": "string",
  10437. "description": "owner of the repo",
  10438. "name": "owner",
  10439. "in": "path",
  10440. "required": true
  10441. },
  10442. {
  10443. "type": "string",
  10444. "description": "name of the repo",
  10445. "name": "repo",
  10446. "in": "path",
  10447. "required": true
  10448. },
  10449. {
  10450. "type": "string",
  10451. "description": "If true, mark all notifications on this repo. Default value is false",
  10452. "name": "all",
  10453. "in": "query"
  10454. },
  10455. {
  10456. "type": "array",
  10457. "items": {
  10458. "type": "string"
  10459. },
  10460. "collectionFormat": "multi",
  10461. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  10462. "name": "status-types",
  10463. "in": "query"
  10464. },
  10465. {
  10466. "type": "string",
  10467. "description": "Status to mark notifications as. Defaults to read.",
  10468. "name": "to-status",
  10469. "in": "query"
  10470. },
  10471. {
  10472. "type": "string",
  10473. "format": "date-time",
  10474. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  10475. "name": "last_read_at",
  10476. "in": "query"
  10477. }
  10478. ],
  10479. "responses": {
  10480. "205": {
  10481. "$ref": "#/responses/NotificationThreadList"
  10482. }
  10483. }
  10484. }
  10485. },
  10486. "/repos/{owner}/{repo}/pulls": {
  10487. "get": {
  10488. "produces": [
  10489. "application/json"
  10490. ],
  10491. "tags": [
  10492. "repository"
  10493. ],
  10494. "summary": "List a repo's pull requests",
  10495. "operationId": "repoListPullRequests",
  10496. "parameters": [
  10497. {
  10498. "type": "string",
  10499. "description": "owner of the repo",
  10500. "name": "owner",
  10501. "in": "path",
  10502. "required": true
  10503. },
  10504. {
  10505. "type": "string",
  10506. "description": "name of the repo",
  10507. "name": "repo",
  10508. "in": "path",
  10509. "required": true
  10510. },
  10511. {
  10512. "enum": [
  10513. "closed",
  10514. "open",
  10515. "all"
  10516. ],
  10517. "type": "string",
  10518. "description": "State of pull request: open or closed (optional)",
  10519. "name": "state",
  10520. "in": "query"
  10521. },
  10522. {
  10523. "enum": [
  10524. "oldest",
  10525. "recentupdate",
  10526. "leastupdate",
  10527. "mostcomment",
  10528. "leastcomment",
  10529. "priority"
  10530. ],
  10531. "type": "string",
  10532. "description": "Type of sort",
  10533. "name": "sort",
  10534. "in": "query"
  10535. },
  10536. {
  10537. "type": "integer",
  10538. "format": "int64",
  10539. "description": "ID of the milestone",
  10540. "name": "milestone",
  10541. "in": "query"
  10542. },
  10543. {
  10544. "type": "array",
  10545. "items": {
  10546. "type": "integer",
  10547. "format": "int64"
  10548. },
  10549. "collectionFormat": "multi",
  10550. "description": "Label IDs",
  10551. "name": "labels",
  10552. "in": "query"
  10553. },
  10554. {
  10555. "type": "integer",
  10556. "description": "page number of results to return (1-based)",
  10557. "name": "page",
  10558. "in": "query"
  10559. },
  10560. {
  10561. "type": "integer",
  10562. "description": "page size of results",
  10563. "name": "limit",
  10564. "in": "query"
  10565. }
  10566. ],
  10567. "responses": {
  10568. "200": {
  10569. "$ref": "#/responses/PullRequestList"
  10570. },
  10571. "404": {
  10572. "$ref": "#/responses/notFound"
  10573. }
  10574. }
  10575. },
  10576. "post": {
  10577. "consumes": [
  10578. "application/json"
  10579. ],
  10580. "produces": [
  10581. "application/json"
  10582. ],
  10583. "tags": [
  10584. "repository"
  10585. ],
  10586. "summary": "Create a pull request",
  10587. "operationId": "repoCreatePullRequest",
  10588. "parameters": [
  10589. {
  10590. "type": "string",
  10591. "description": "owner of the repo",
  10592. "name": "owner",
  10593. "in": "path",
  10594. "required": true
  10595. },
  10596. {
  10597. "type": "string",
  10598. "description": "name of the repo",
  10599. "name": "repo",
  10600. "in": "path",
  10601. "required": true
  10602. },
  10603. {
  10604. "name": "body",
  10605. "in": "body",
  10606. "schema": {
  10607. "$ref": "#/definitions/CreatePullRequestOption"
  10608. }
  10609. }
  10610. ],
  10611. "responses": {
  10612. "201": {
  10613. "$ref": "#/responses/PullRequest"
  10614. },
  10615. "403": {
  10616. "$ref": "#/responses/forbidden"
  10617. },
  10618. "404": {
  10619. "$ref": "#/responses/notFound"
  10620. },
  10621. "409": {
  10622. "$ref": "#/responses/error"
  10623. },
  10624. "422": {
  10625. "$ref": "#/responses/validationError"
  10626. },
  10627. "423": {
  10628. "$ref": "#/responses/repoArchivedError"
  10629. }
  10630. }
  10631. }
  10632. },
  10633. "/repos/{owner}/{repo}/pulls/pinned": {
  10634. "get": {
  10635. "produces": [
  10636. "application/json"
  10637. ],
  10638. "tags": [
  10639. "repository"
  10640. ],
  10641. "summary": "List a repo's pinned pull requests",
  10642. "operationId": "repoListPinnedPullRequests",
  10643. "parameters": [
  10644. {
  10645. "type": "string",
  10646. "description": "owner of the repo",
  10647. "name": "owner",
  10648. "in": "path",
  10649. "required": true
  10650. },
  10651. {
  10652. "type": "string",
  10653. "description": "name of the repo",
  10654. "name": "repo",
  10655. "in": "path",
  10656. "required": true
  10657. }
  10658. ],
  10659. "responses": {
  10660. "200": {
  10661. "$ref": "#/responses/PullRequestList"
  10662. },
  10663. "404": {
  10664. "$ref": "#/responses/notFound"
  10665. }
  10666. }
  10667. }
  10668. },
  10669. "/repos/{owner}/{repo}/pulls/{base}/{head}": {
  10670. "get": {
  10671. "produces": [
  10672. "application/json"
  10673. ],
  10674. "tags": [
  10675. "repository"
  10676. ],
  10677. "summary": "Get a pull request by base and head",
  10678. "operationId": "repoGetPullRequestByBaseHead",
  10679. "parameters": [
  10680. {
  10681. "type": "string",
  10682. "description": "owner of the repo",
  10683. "name": "owner",
  10684. "in": "path",
  10685. "required": true
  10686. },
  10687. {
  10688. "type": "string",
  10689. "description": "name of the repo",
  10690. "name": "repo",
  10691. "in": "path",
  10692. "required": true
  10693. },
  10694. {
  10695. "type": "string",
  10696. "description": "base of the pull request to get",
  10697. "name": "base",
  10698. "in": "path",
  10699. "required": true
  10700. },
  10701. {
  10702. "type": "string",
  10703. "description": "head of the pull request to get",
  10704. "name": "head",
  10705. "in": "path",
  10706. "required": true
  10707. }
  10708. ],
  10709. "responses": {
  10710. "200": {
  10711. "$ref": "#/responses/PullRequest"
  10712. },
  10713. "404": {
  10714. "$ref": "#/responses/notFound"
  10715. }
  10716. }
  10717. }
  10718. },
  10719. "/repos/{owner}/{repo}/pulls/{index}": {
  10720. "get": {
  10721. "produces": [
  10722. "application/json"
  10723. ],
  10724. "tags": [
  10725. "repository"
  10726. ],
  10727. "summary": "Get a pull request",
  10728. "operationId": "repoGetPullRequest",
  10729. "parameters": [
  10730. {
  10731. "type": "string",
  10732. "description": "owner of the repo",
  10733. "name": "owner",
  10734. "in": "path",
  10735. "required": true
  10736. },
  10737. {
  10738. "type": "string",
  10739. "description": "name of the repo",
  10740. "name": "repo",
  10741. "in": "path",
  10742. "required": true
  10743. },
  10744. {
  10745. "type": "integer",
  10746. "format": "int64",
  10747. "description": "index of the pull request to get",
  10748. "name": "index",
  10749. "in": "path",
  10750. "required": true
  10751. }
  10752. ],
  10753. "responses": {
  10754. "200": {
  10755. "$ref": "#/responses/PullRequest"
  10756. },
  10757. "404": {
  10758. "$ref": "#/responses/notFound"
  10759. }
  10760. }
  10761. },
  10762. "patch": {
  10763. "consumes": [
  10764. "application/json"
  10765. ],
  10766. "produces": [
  10767. "application/json"
  10768. ],
  10769. "tags": [
  10770. "repository"
  10771. ],
  10772. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  10773. "operationId": "repoEditPullRequest",
  10774. "parameters": [
  10775. {
  10776. "type": "string",
  10777. "description": "owner of the repo",
  10778. "name": "owner",
  10779. "in": "path",
  10780. "required": true
  10781. },
  10782. {
  10783. "type": "string",
  10784. "description": "name of the repo",
  10785. "name": "repo",
  10786. "in": "path",
  10787. "required": true
  10788. },
  10789. {
  10790. "type": "integer",
  10791. "format": "int64",
  10792. "description": "index of the pull request to edit",
  10793. "name": "index",
  10794. "in": "path",
  10795. "required": true
  10796. },
  10797. {
  10798. "name": "body",
  10799. "in": "body",
  10800. "schema": {
  10801. "$ref": "#/definitions/EditPullRequestOption"
  10802. }
  10803. }
  10804. ],
  10805. "responses": {
  10806. "201": {
  10807. "$ref": "#/responses/PullRequest"
  10808. },
  10809. "403": {
  10810. "$ref": "#/responses/forbidden"
  10811. },
  10812. "404": {
  10813. "$ref": "#/responses/notFound"
  10814. },
  10815. "409": {
  10816. "$ref": "#/responses/error"
  10817. },
  10818. "412": {
  10819. "$ref": "#/responses/error"
  10820. },
  10821. "422": {
  10822. "$ref": "#/responses/validationError"
  10823. }
  10824. }
  10825. }
  10826. },
  10827. "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
  10828. "get": {
  10829. "produces": [
  10830. "text/plain"
  10831. ],
  10832. "tags": [
  10833. "repository"
  10834. ],
  10835. "summary": "Get a pull request diff or patch",
  10836. "operationId": "repoDownloadPullDiffOrPatch",
  10837. "parameters": [
  10838. {
  10839. "type": "string",
  10840. "description": "owner of the repo",
  10841. "name": "owner",
  10842. "in": "path",
  10843. "required": true
  10844. },
  10845. {
  10846. "type": "string",
  10847. "description": "name of the repo",
  10848. "name": "repo",
  10849. "in": "path",
  10850. "required": true
  10851. },
  10852. {
  10853. "type": "integer",
  10854. "format": "int64",
  10855. "description": "index of the pull request to get",
  10856. "name": "index",
  10857. "in": "path",
  10858. "required": true
  10859. },
  10860. {
  10861. "enum": [
  10862. "diff",
  10863. "patch"
  10864. ],
  10865. "type": "string",
  10866. "description": "whether the output is diff or patch",
  10867. "name": "diffType",
  10868. "in": "path",
  10869. "required": true
  10870. },
  10871. {
  10872. "type": "boolean",
  10873. "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
  10874. "name": "binary",
  10875. "in": "query"
  10876. }
  10877. ],
  10878. "responses": {
  10879. "200": {
  10880. "$ref": "#/responses/string"
  10881. },
  10882. "404": {
  10883. "$ref": "#/responses/notFound"
  10884. }
  10885. }
  10886. }
  10887. },
  10888. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  10889. "get": {
  10890. "produces": [
  10891. "application/json"
  10892. ],
  10893. "tags": [
  10894. "repository"
  10895. ],
  10896. "summary": "Get commits for a pull request",
  10897. "operationId": "repoGetPullRequestCommits",
  10898. "parameters": [
  10899. {
  10900. "type": "string",
  10901. "description": "owner of the repo",
  10902. "name": "owner",
  10903. "in": "path",
  10904. "required": true
  10905. },
  10906. {
  10907. "type": "string",
  10908. "description": "name of the repo",
  10909. "name": "repo",
  10910. "in": "path",
  10911. "required": true
  10912. },
  10913. {
  10914. "type": "integer",
  10915. "format": "int64",
  10916. "description": "index of the pull request to get",
  10917. "name": "index",
  10918. "in": "path",
  10919. "required": true
  10920. },
  10921. {
  10922. "type": "integer",
  10923. "description": "page number of results to return (1-based)",
  10924. "name": "page",
  10925. "in": "query"
  10926. },
  10927. {
  10928. "type": "integer",
  10929. "description": "page size of results",
  10930. "name": "limit",
  10931. "in": "query"
  10932. },
  10933. {
  10934. "type": "boolean",
  10935. "description": "include verification for every commit (disable for speedup, default 'true')",
  10936. "name": "verification",
  10937. "in": "query"
  10938. },
  10939. {
  10940. "type": "boolean",
  10941. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  10942. "name": "files",
  10943. "in": "query"
  10944. }
  10945. ],
  10946. "responses": {
  10947. "200": {
  10948. "$ref": "#/responses/CommitList"
  10949. },
  10950. "404": {
  10951. "$ref": "#/responses/notFound"
  10952. }
  10953. }
  10954. }
  10955. },
  10956. "/repos/{owner}/{repo}/pulls/{index}/files": {
  10957. "get": {
  10958. "produces": [
  10959. "application/json"
  10960. ],
  10961. "tags": [
  10962. "repository"
  10963. ],
  10964. "summary": "Get changed files for a pull request",
  10965. "operationId": "repoGetPullRequestFiles",
  10966. "parameters": [
  10967. {
  10968. "type": "string",
  10969. "description": "owner of the repo",
  10970. "name": "owner",
  10971. "in": "path",
  10972. "required": true
  10973. },
  10974. {
  10975. "type": "string",
  10976. "description": "name of the repo",
  10977. "name": "repo",
  10978. "in": "path",
  10979. "required": true
  10980. },
  10981. {
  10982. "type": "integer",
  10983. "format": "int64",
  10984. "description": "index of the pull request to get",
  10985. "name": "index",
  10986. "in": "path",
  10987. "required": true
  10988. },
  10989. {
  10990. "type": "string",
  10991. "description": "skip to given file",
  10992. "name": "skip-to",
  10993. "in": "query"
  10994. },
  10995. {
  10996. "enum": [
  10997. "ignore-all",
  10998. "ignore-change",
  10999. "ignore-eol",
  11000. "show-all"
  11001. ],
  11002. "type": "string",
  11003. "description": "whitespace behavior",
  11004. "name": "whitespace",
  11005. "in": "query"
  11006. },
  11007. {
  11008. "type": "integer",
  11009. "description": "page number of results to return (1-based)",
  11010. "name": "page",
  11011. "in": "query"
  11012. },
  11013. {
  11014. "type": "integer",
  11015. "description": "page size of results",
  11016. "name": "limit",
  11017. "in": "query"
  11018. }
  11019. ],
  11020. "responses": {
  11021. "200": {
  11022. "$ref": "#/responses/ChangedFileList"
  11023. },
  11024. "404": {
  11025. "$ref": "#/responses/notFound"
  11026. }
  11027. }
  11028. }
  11029. },
  11030. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  11031. "get": {
  11032. "produces": [
  11033. "application/json"
  11034. ],
  11035. "tags": [
  11036. "repository"
  11037. ],
  11038. "summary": "Check if a pull request has been merged",
  11039. "operationId": "repoPullRequestIsMerged",
  11040. "parameters": [
  11041. {
  11042. "type": "string",
  11043. "description": "owner of the repo",
  11044. "name": "owner",
  11045. "in": "path",
  11046. "required": true
  11047. },
  11048. {
  11049. "type": "string",
  11050. "description": "name of the repo",
  11051. "name": "repo",
  11052. "in": "path",
  11053. "required": true
  11054. },
  11055. {
  11056. "type": "integer",
  11057. "format": "int64",
  11058. "description": "index of the pull request",
  11059. "name": "index",
  11060. "in": "path",
  11061. "required": true
  11062. }
  11063. ],
  11064. "responses": {
  11065. "204": {
  11066. "description": "pull request has been merged"
  11067. },
  11068. "404": {
  11069. "description": "pull request has not been merged"
  11070. }
  11071. }
  11072. },
  11073. "post": {
  11074. "produces": [
  11075. "application/json"
  11076. ],
  11077. "tags": [
  11078. "repository"
  11079. ],
  11080. "summary": "Merge a pull request",
  11081. "operationId": "repoMergePullRequest",
  11082. "parameters": [
  11083. {
  11084. "type": "string",
  11085. "description": "owner of the repo",
  11086. "name": "owner",
  11087. "in": "path",
  11088. "required": true
  11089. },
  11090. {
  11091. "type": "string",
  11092. "description": "name of the repo",
  11093. "name": "repo",
  11094. "in": "path",
  11095. "required": true
  11096. },
  11097. {
  11098. "type": "integer",
  11099. "format": "int64",
  11100. "description": "index of the pull request to merge",
  11101. "name": "index",
  11102. "in": "path",
  11103. "required": true
  11104. },
  11105. {
  11106. "name": "body",
  11107. "in": "body",
  11108. "schema": {
  11109. "$ref": "#/definitions/MergePullRequestOption"
  11110. }
  11111. }
  11112. ],
  11113. "responses": {
  11114. "200": {
  11115. "$ref": "#/responses/empty"
  11116. },
  11117. "404": {
  11118. "$ref": "#/responses/notFound"
  11119. },
  11120. "405": {
  11121. "$ref": "#/responses/empty"
  11122. },
  11123. "409": {
  11124. "$ref": "#/responses/error"
  11125. },
  11126. "423": {
  11127. "$ref": "#/responses/repoArchivedError"
  11128. }
  11129. }
  11130. },
  11131. "delete": {
  11132. "produces": [
  11133. "application/json"
  11134. ],
  11135. "tags": [
  11136. "repository"
  11137. ],
  11138. "summary": "Cancel the scheduled auto merge for the given pull request",
  11139. "operationId": "repoCancelScheduledAutoMerge",
  11140. "parameters": [
  11141. {
  11142. "type": "string",
  11143. "description": "owner of the repo",
  11144. "name": "owner",
  11145. "in": "path",
  11146. "required": true
  11147. },
  11148. {
  11149. "type": "string",
  11150. "description": "name of the repo",
  11151. "name": "repo",
  11152. "in": "path",
  11153. "required": true
  11154. },
  11155. {
  11156. "type": "integer",
  11157. "format": "int64",
  11158. "description": "index of the pull request to merge",
  11159. "name": "index",
  11160. "in": "path",
  11161. "required": true
  11162. }
  11163. ],
  11164. "responses": {
  11165. "204": {
  11166. "$ref": "#/responses/empty"
  11167. },
  11168. "403": {
  11169. "$ref": "#/responses/forbidden"
  11170. },
  11171. "404": {
  11172. "$ref": "#/responses/notFound"
  11173. },
  11174. "423": {
  11175. "$ref": "#/responses/repoArchivedError"
  11176. }
  11177. }
  11178. }
  11179. },
  11180. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  11181. "post": {
  11182. "produces": [
  11183. "application/json"
  11184. ],
  11185. "tags": [
  11186. "repository"
  11187. ],
  11188. "summary": "create review requests for a pull request",
  11189. "operationId": "repoCreatePullReviewRequests",
  11190. "parameters": [
  11191. {
  11192. "type": "string",
  11193. "description": "owner of the repo",
  11194. "name": "owner",
  11195. "in": "path",
  11196. "required": true
  11197. },
  11198. {
  11199. "type": "string",
  11200. "description": "name of the repo",
  11201. "name": "repo",
  11202. "in": "path",
  11203. "required": true
  11204. },
  11205. {
  11206. "type": "integer",
  11207. "format": "int64",
  11208. "description": "index of the pull request",
  11209. "name": "index",
  11210. "in": "path",
  11211. "required": true
  11212. },
  11213. {
  11214. "name": "body",
  11215. "in": "body",
  11216. "required": true,
  11217. "schema": {
  11218. "$ref": "#/definitions/PullReviewRequestOptions"
  11219. }
  11220. }
  11221. ],
  11222. "responses": {
  11223. "201": {
  11224. "$ref": "#/responses/PullReviewList"
  11225. },
  11226. "404": {
  11227. "$ref": "#/responses/notFound"
  11228. },
  11229. "422": {
  11230. "$ref": "#/responses/validationError"
  11231. }
  11232. }
  11233. },
  11234. "delete": {
  11235. "produces": [
  11236. "application/json"
  11237. ],
  11238. "tags": [
  11239. "repository"
  11240. ],
  11241. "summary": "cancel review requests for a pull request",
  11242. "operationId": "repoDeletePullReviewRequests",
  11243. "parameters": [
  11244. {
  11245. "type": "string",
  11246. "description": "owner of the repo",
  11247. "name": "owner",
  11248. "in": "path",
  11249. "required": true
  11250. },
  11251. {
  11252. "type": "string",
  11253. "description": "name of the repo",
  11254. "name": "repo",
  11255. "in": "path",
  11256. "required": true
  11257. },
  11258. {
  11259. "type": "integer",
  11260. "format": "int64",
  11261. "description": "index of the pull request",
  11262. "name": "index",
  11263. "in": "path",
  11264. "required": true
  11265. },
  11266. {
  11267. "name": "body",
  11268. "in": "body",
  11269. "required": true,
  11270. "schema": {
  11271. "$ref": "#/definitions/PullReviewRequestOptions"
  11272. }
  11273. }
  11274. ],
  11275. "responses": {
  11276. "204": {
  11277. "$ref": "#/responses/empty"
  11278. },
  11279. "403": {
  11280. "$ref": "#/responses/forbidden"
  11281. },
  11282. "404": {
  11283. "$ref": "#/responses/notFound"
  11284. },
  11285. "422": {
  11286. "$ref": "#/responses/validationError"
  11287. }
  11288. }
  11289. }
  11290. },
  11291. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  11292. "get": {
  11293. "produces": [
  11294. "application/json"
  11295. ],
  11296. "tags": [
  11297. "repository"
  11298. ],
  11299. "summary": "List all reviews for a pull request",
  11300. "operationId": "repoListPullReviews",
  11301. "parameters": [
  11302. {
  11303. "type": "string",
  11304. "description": "owner of the repo",
  11305. "name": "owner",
  11306. "in": "path",
  11307. "required": true
  11308. },
  11309. {
  11310. "type": "string",
  11311. "description": "name of the repo",
  11312. "name": "repo",
  11313. "in": "path",
  11314. "required": true
  11315. },
  11316. {
  11317. "type": "integer",
  11318. "format": "int64",
  11319. "description": "index of the pull request",
  11320. "name": "index",
  11321. "in": "path",
  11322. "required": true
  11323. },
  11324. {
  11325. "type": "integer",
  11326. "description": "page number of results to return (1-based)",
  11327. "name": "page",
  11328. "in": "query"
  11329. },
  11330. {
  11331. "type": "integer",
  11332. "description": "page size of results",
  11333. "name": "limit",
  11334. "in": "query"
  11335. }
  11336. ],
  11337. "responses": {
  11338. "200": {
  11339. "$ref": "#/responses/PullReviewList"
  11340. },
  11341. "404": {
  11342. "$ref": "#/responses/notFound"
  11343. }
  11344. }
  11345. },
  11346. "post": {
  11347. "produces": [
  11348. "application/json"
  11349. ],
  11350. "tags": [
  11351. "repository"
  11352. ],
  11353. "summary": "Create a review to an pull request",
  11354. "operationId": "repoCreatePullReview",
  11355. "parameters": [
  11356. {
  11357. "type": "string",
  11358. "description": "owner of the repo",
  11359. "name": "owner",
  11360. "in": "path",
  11361. "required": true
  11362. },
  11363. {
  11364. "type": "string",
  11365. "description": "name of the repo",
  11366. "name": "repo",
  11367. "in": "path",
  11368. "required": true
  11369. },
  11370. {
  11371. "type": "integer",
  11372. "format": "int64",
  11373. "description": "index of the pull request",
  11374. "name": "index",
  11375. "in": "path",
  11376. "required": true
  11377. },
  11378. {
  11379. "name": "body",
  11380. "in": "body",
  11381. "required": true,
  11382. "schema": {
  11383. "$ref": "#/definitions/CreatePullReviewOptions"
  11384. }
  11385. }
  11386. ],
  11387. "responses": {
  11388. "200": {
  11389. "$ref": "#/responses/PullReview"
  11390. },
  11391. "404": {
  11392. "$ref": "#/responses/notFound"
  11393. },
  11394. "422": {
  11395. "$ref": "#/responses/validationError"
  11396. }
  11397. }
  11398. }
  11399. },
  11400. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  11401. "get": {
  11402. "produces": [
  11403. "application/json"
  11404. ],
  11405. "tags": [
  11406. "repository"
  11407. ],
  11408. "summary": "Get a specific review for a pull request",
  11409. "operationId": "repoGetPullReview",
  11410. "parameters": [
  11411. {
  11412. "type": "string",
  11413. "description": "owner of the repo",
  11414. "name": "owner",
  11415. "in": "path",
  11416. "required": true
  11417. },
  11418. {
  11419. "type": "string",
  11420. "description": "name of the repo",
  11421. "name": "repo",
  11422. "in": "path",
  11423. "required": true
  11424. },
  11425. {
  11426. "type": "integer",
  11427. "format": "int64",
  11428. "description": "index of the pull request",
  11429. "name": "index",
  11430. "in": "path",
  11431. "required": true
  11432. },
  11433. {
  11434. "type": "integer",
  11435. "format": "int64",
  11436. "description": "id of the review",
  11437. "name": "id",
  11438. "in": "path",
  11439. "required": true
  11440. }
  11441. ],
  11442. "responses": {
  11443. "200": {
  11444. "$ref": "#/responses/PullReview"
  11445. },
  11446. "404": {
  11447. "$ref": "#/responses/notFound"
  11448. }
  11449. }
  11450. },
  11451. "post": {
  11452. "produces": [
  11453. "application/json"
  11454. ],
  11455. "tags": [
  11456. "repository"
  11457. ],
  11458. "summary": "Submit a pending review to an pull request",
  11459. "operationId": "repoSubmitPullReview",
  11460. "parameters": [
  11461. {
  11462. "type": "string",
  11463. "description": "owner of the repo",
  11464. "name": "owner",
  11465. "in": "path",
  11466. "required": true
  11467. },
  11468. {
  11469. "type": "string",
  11470. "description": "name of the repo",
  11471. "name": "repo",
  11472. "in": "path",
  11473. "required": true
  11474. },
  11475. {
  11476. "type": "integer",
  11477. "format": "int64",
  11478. "description": "index of the pull request",
  11479. "name": "index",
  11480. "in": "path",
  11481. "required": true
  11482. },
  11483. {
  11484. "type": "integer",
  11485. "format": "int64",
  11486. "description": "id of the review",
  11487. "name": "id",
  11488. "in": "path",
  11489. "required": true
  11490. },
  11491. {
  11492. "name": "body",
  11493. "in": "body",
  11494. "required": true,
  11495. "schema": {
  11496. "$ref": "#/definitions/SubmitPullReviewOptions"
  11497. }
  11498. }
  11499. ],
  11500. "responses": {
  11501. "200": {
  11502. "$ref": "#/responses/PullReview"
  11503. },
  11504. "404": {
  11505. "$ref": "#/responses/notFound"
  11506. },
  11507. "422": {
  11508. "$ref": "#/responses/validationError"
  11509. }
  11510. }
  11511. },
  11512. "delete": {
  11513. "produces": [
  11514. "application/json"
  11515. ],
  11516. "tags": [
  11517. "repository"
  11518. ],
  11519. "summary": "Delete a specific review from a pull request",
  11520. "operationId": "repoDeletePullReview",
  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. "type": "integer",
  11546. "format": "int64",
  11547. "description": "id of the review",
  11548. "name": "id",
  11549. "in": "path",
  11550. "required": true
  11551. }
  11552. ],
  11553. "responses": {
  11554. "204": {
  11555. "$ref": "#/responses/empty"
  11556. },
  11557. "403": {
  11558. "$ref": "#/responses/forbidden"
  11559. },
  11560. "404": {
  11561. "$ref": "#/responses/notFound"
  11562. }
  11563. }
  11564. }
  11565. },
  11566. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  11567. "get": {
  11568. "produces": [
  11569. "application/json"
  11570. ],
  11571. "tags": [
  11572. "repository"
  11573. ],
  11574. "summary": "Get a specific review for a pull request",
  11575. "operationId": "repoGetPullReviewComments",
  11576. "parameters": [
  11577. {
  11578. "type": "string",
  11579. "description": "owner of the repo",
  11580. "name": "owner",
  11581. "in": "path",
  11582. "required": true
  11583. },
  11584. {
  11585. "type": "string",
  11586. "description": "name of the repo",
  11587. "name": "repo",
  11588. "in": "path",
  11589. "required": true
  11590. },
  11591. {
  11592. "type": "integer",
  11593. "format": "int64",
  11594. "description": "index of the pull request",
  11595. "name": "index",
  11596. "in": "path",
  11597. "required": true
  11598. },
  11599. {
  11600. "type": "integer",
  11601. "format": "int64",
  11602. "description": "id of the review",
  11603. "name": "id",
  11604. "in": "path",
  11605. "required": true
  11606. }
  11607. ],
  11608. "responses": {
  11609. "200": {
  11610. "$ref": "#/responses/PullReviewCommentList"
  11611. },
  11612. "404": {
  11613. "$ref": "#/responses/notFound"
  11614. }
  11615. }
  11616. }
  11617. },
  11618. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  11619. "post": {
  11620. "produces": [
  11621. "application/json"
  11622. ],
  11623. "tags": [
  11624. "repository"
  11625. ],
  11626. "summary": "Dismiss a review for a pull request",
  11627. "operationId": "repoDismissPullReview",
  11628. "parameters": [
  11629. {
  11630. "type": "string",
  11631. "description": "owner of the repo",
  11632. "name": "owner",
  11633. "in": "path",
  11634. "required": true
  11635. },
  11636. {
  11637. "type": "string",
  11638. "description": "name of the repo",
  11639. "name": "repo",
  11640. "in": "path",
  11641. "required": true
  11642. },
  11643. {
  11644. "type": "integer",
  11645. "format": "int64",
  11646. "description": "index of the pull request",
  11647. "name": "index",
  11648. "in": "path",
  11649. "required": true
  11650. },
  11651. {
  11652. "type": "integer",
  11653. "format": "int64",
  11654. "description": "id of the review",
  11655. "name": "id",
  11656. "in": "path",
  11657. "required": true
  11658. },
  11659. {
  11660. "name": "body",
  11661. "in": "body",
  11662. "required": true,
  11663. "schema": {
  11664. "$ref": "#/definitions/DismissPullReviewOptions"
  11665. }
  11666. }
  11667. ],
  11668. "responses": {
  11669. "200": {
  11670. "$ref": "#/responses/PullReview"
  11671. },
  11672. "403": {
  11673. "$ref": "#/responses/forbidden"
  11674. },
  11675. "404": {
  11676. "$ref": "#/responses/notFound"
  11677. },
  11678. "422": {
  11679. "$ref": "#/responses/validationError"
  11680. }
  11681. }
  11682. }
  11683. },
  11684. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  11685. "post": {
  11686. "produces": [
  11687. "application/json"
  11688. ],
  11689. "tags": [
  11690. "repository"
  11691. ],
  11692. "summary": "Cancel to dismiss a review for a pull request",
  11693. "operationId": "repoUnDismissPullReview",
  11694. "parameters": [
  11695. {
  11696. "type": "string",
  11697. "description": "owner of the repo",
  11698. "name": "owner",
  11699. "in": "path",
  11700. "required": true
  11701. },
  11702. {
  11703. "type": "string",
  11704. "description": "name of the repo",
  11705. "name": "repo",
  11706. "in": "path",
  11707. "required": true
  11708. },
  11709. {
  11710. "type": "integer",
  11711. "format": "int64",
  11712. "description": "index of the pull request",
  11713. "name": "index",
  11714. "in": "path",
  11715. "required": true
  11716. },
  11717. {
  11718. "type": "integer",
  11719. "format": "int64",
  11720. "description": "id of the review",
  11721. "name": "id",
  11722. "in": "path",
  11723. "required": true
  11724. }
  11725. ],
  11726. "responses": {
  11727. "200": {
  11728. "$ref": "#/responses/PullReview"
  11729. },
  11730. "403": {
  11731. "$ref": "#/responses/forbidden"
  11732. },
  11733. "404": {
  11734. "$ref": "#/responses/notFound"
  11735. },
  11736. "422": {
  11737. "$ref": "#/responses/validationError"
  11738. }
  11739. }
  11740. }
  11741. },
  11742. "/repos/{owner}/{repo}/pulls/{index}/update": {
  11743. "post": {
  11744. "produces": [
  11745. "application/json"
  11746. ],
  11747. "tags": [
  11748. "repository"
  11749. ],
  11750. "summary": "Merge PR's baseBranch into headBranch",
  11751. "operationId": "repoUpdatePullRequest",
  11752. "parameters": [
  11753. {
  11754. "type": "string",
  11755. "description": "owner of the repo",
  11756. "name": "owner",
  11757. "in": "path",
  11758. "required": true
  11759. },
  11760. {
  11761. "type": "string",
  11762. "description": "name of the repo",
  11763. "name": "repo",
  11764. "in": "path",
  11765. "required": true
  11766. },
  11767. {
  11768. "type": "integer",
  11769. "format": "int64",
  11770. "description": "index of the pull request to get",
  11771. "name": "index",
  11772. "in": "path",
  11773. "required": true
  11774. },
  11775. {
  11776. "enum": [
  11777. "merge",
  11778. "rebase"
  11779. ],
  11780. "type": "string",
  11781. "description": "how to update pull request",
  11782. "name": "style",
  11783. "in": "query"
  11784. }
  11785. ],
  11786. "responses": {
  11787. "200": {
  11788. "$ref": "#/responses/empty"
  11789. },
  11790. "403": {
  11791. "$ref": "#/responses/forbidden"
  11792. },
  11793. "404": {
  11794. "$ref": "#/responses/notFound"
  11795. },
  11796. "409": {
  11797. "$ref": "#/responses/error"
  11798. },
  11799. "422": {
  11800. "$ref": "#/responses/validationError"
  11801. }
  11802. }
  11803. }
  11804. },
  11805. "/repos/{owner}/{repo}/push_mirrors": {
  11806. "get": {
  11807. "produces": [
  11808. "application/json"
  11809. ],
  11810. "tags": [
  11811. "repository"
  11812. ],
  11813. "summary": "Get all push mirrors of the repository",
  11814. "operationId": "repoListPushMirrors",
  11815. "parameters": [
  11816. {
  11817. "type": "string",
  11818. "description": "owner of the repo",
  11819. "name": "owner",
  11820. "in": "path",
  11821. "required": true
  11822. },
  11823. {
  11824. "type": "string",
  11825. "description": "name of the repo",
  11826. "name": "repo",
  11827. "in": "path",
  11828. "required": true
  11829. },
  11830. {
  11831. "type": "integer",
  11832. "description": "page number of results to return (1-based)",
  11833. "name": "page",
  11834. "in": "query"
  11835. },
  11836. {
  11837. "type": "integer",
  11838. "description": "page size of results",
  11839. "name": "limit",
  11840. "in": "query"
  11841. }
  11842. ],
  11843. "responses": {
  11844. "200": {
  11845. "$ref": "#/responses/PushMirrorList"
  11846. },
  11847. "400": {
  11848. "$ref": "#/responses/error"
  11849. },
  11850. "403": {
  11851. "$ref": "#/responses/forbidden"
  11852. },
  11853. "404": {
  11854. "$ref": "#/responses/notFound"
  11855. }
  11856. }
  11857. },
  11858. "post": {
  11859. "consumes": [
  11860. "application/json"
  11861. ],
  11862. "produces": [
  11863. "application/json"
  11864. ],
  11865. "tags": [
  11866. "repository"
  11867. ],
  11868. "summary": "add a push mirror to the repository",
  11869. "operationId": "repoAddPushMirror",
  11870. "parameters": [
  11871. {
  11872. "type": "string",
  11873. "description": "owner of the repo",
  11874. "name": "owner",
  11875. "in": "path",
  11876. "required": true
  11877. },
  11878. {
  11879. "type": "string",
  11880. "description": "name of the repo",
  11881. "name": "repo",
  11882. "in": "path",
  11883. "required": true
  11884. },
  11885. {
  11886. "name": "body",
  11887. "in": "body",
  11888. "schema": {
  11889. "$ref": "#/definitions/CreatePushMirrorOption"
  11890. }
  11891. }
  11892. ],
  11893. "responses": {
  11894. "200": {
  11895. "$ref": "#/responses/PushMirror"
  11896. },
  11897. "400": {
  11898. "$ref": "#/responses/error"
  11899. },
  11900. "403": {
  11901. "$ref": "#/responses/forbidden"
  11902. },
  11903. "404": {
  11904. "$ref": "#/responses/notFound"
  11905. }
  11906. }
  11907. }
  11908. },
  11909. "/repos/{owner}/{repo}/push_mirrors-sync": {
  11910. "post": {
  11911. "produces": [
  11912. "application/json"
  11913. ],
  11914. "tags": [
  11915. "repository"
  11916. ],
  11917. "summary": "Sync all push mirrored repository",
  11918. "operationId": "repoPushMirrorSync",
  11919. "parameters": [
  11920. {
  11921. "type": "string",
  11922. "description": "owner of the repo to sync",
  11923. "name": "owner",
  11924. "in": "path",
  11925. "required": true
  11926. },
  11927. {
  11928. "type": "string",
  11929. "description": "name of the repo to sync",
  11930. "name": "repo",
  11931. "in": "path",
  11932. "required": true
  11933. }
  11934. ],
  11935. "responses": {
  11936. "200": {
  11937. "$ref": "#/responses/empty"
  11938. },
  11939. "400": {
  11940. "$ref": "#/responses/error"
  11941. },
  11942. "403": {
  11943. "$ref": "#/responses/forbidden"
  11944. },
  11945. "404": {
  11946. "$ref": "#/responses/notFound"
  11947. }
  11948. }
  11949. }
  11950. },
  11951. "/repos/{owner}/{repo}/push_mirrors/{name}": {
  11952. "get": {
  11953. "produces": [
  11954. "application/json"
  11955. ],
  11956. "tags": [
  11957. "repository"
  11958. ],
  11959. "summary": "Get push mirror of the repository by remoteName",
  11960. "operationId": "repoGetPushMirrorByRemoteName",
  11961. "parameters": [
  11962. {
  11963. "type": "string",
  11964. "description": "owner of the repo",
  11965. "name": "owner",
  11966. "in": "path",
  11967. "required": true
  11968. },
  11969. {
  11970. "type": "string",
  11971. "description": "name of the repo",
  11972. "name": "repo",
  11973. "in": "path",
  11974. "required": true
  11975. },
  11976. {
  11977. "type": "string",
  11978. "description": "remote name of push mirror",
  11979. "name": "name",
  11980. "in": "path",
  11981. "required": true
  11982. }
  11983. ],
  11984. "responses": {
  11985. "200": {
  11986. "$ref": "#/responses/PushMirror"
  11987. },
  11988. "400": {
  11989. "$ref": "#/responses/error"
  11990. },
  11991. "403": {
  11992. "$ref": "#/responses/forbidden"
  11993. },
  11994. "404": {
  11995. "$ref": "#/responses/notFound"
  11996. }
  11997. }
  11998. },
  11999. "delete": {
  12000. "produces": [
  12001. "application/json"
  12002. ],
  12003. "tags": [
  12004. "repository"
  12005. ],
  12006. "summary": "deletes a push mirror from a repository by remoteName",
  12007. "operationId": "repoDeletePushMirror",
  12008. "parameters": [
  12009. {
  12010. "type": "string",
  12011. "description": "owner of the repo",
  12012. "name": "owner",
  12013. "in": "path",
  12014. "required": true
  12015. },
  12016. {
  12017. "type": "string",
  12018. "description": "name of the repo",
  12019. "name": "repo",
  12020. "in": "path",
  12021. "required": true
  12022. },
  12023. {
  12024. "type": "string",
  12025. "description": "remote name of the pushMirror",
  12026. "name": "name",
  12027. "in": "path",
  12028. "required": true
  12029. }
  12030. ],
  12031. "responses": {
  12032. "204": {
  12033. "$ref": "#/responses/empty"
  12034. },
  12035. "400": {
  12036. "$ref": "#/responses/error"
  12037. },
  12038. "404": {
  12039. "$ref": "#/responses/notFound"
  12040. }
  12041. }
  12042. }
  12043. },
  12044. "/repos/{owner}/{repo}/raw/{filepath}": {
  12045. "get": {
  12046. "produces": [
  12047. "application/json"
  12048. ],
  12049. "tags": [
  12050. "repository"
  12051. ],
  12052. "summary": "Get a file from a repository",
  12053. "operationId": "repoGetRawFile",
  12054. "parameters": [
  12055. {
  12056. "type": "string",
  12057. "description": "owner of the repo",
  12058. "name": "owner",
  12059. "in": "path",
  12060. "required": true
  12061. },
  12062. {
  12063. "type": "string",
  12064. "description": "name of the repo",
  12065. "name": "repo",
  12066. "in": "path",
  12067. "required": true
  12068. },
  12069. {
  12070. "type": "string",
  12071. "description": "filepath of the file to get",
  12072. "name": "filepath",
  12073. "in": "path",
  12074. "required": true
  12075. },
  12076. {
  12077. "type": "string",
  12078. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  12079. "name": "ref",
  12080. "in": "query"
  12081. }
  12082. ],
  12083. "responses": {
  12084. "200": {
  12085. "description": "Returns raw file content."
  12086. },
  12087. "404": {
  12088. "$ref": "#/responses/notFound"
  12089. }
  12090. }
  12091. }
  12092. },
  12093. "/repos/{owner}/{repo}/releases": {
  12094. "get": {
  12095. "produces": [
  12096. "application/json"
  12097. ],
  12098. "tags": [
  12099. "repository"
  12100. ],
  12101. "summary": "List a repo's releases",
  12102. "operationId": "repoListReleases",
  12103. "parameters": [
  12104. {
  12105. "type": "string",
  12106. "description": "owner of the repo",
  12107. "name": "owner",
  12108. "in": "path",
  12109. "required": true
  12110. },
  12111. {
  12112. "type": "string",
  12113. "description": "name of the repo",
  12114. "name": "repo",
  12115. "in": "path",
  12116. "required": true
  12117. },
  12118. {
  12119. "type": "boolean",
  12120. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  12121. "name": "draft",
  12122. "in": "query"
  12123. },
  12124. {
  12125. "type": "boolean",
  12126. "description": "filter (exclude / include) pre-releases",
  12127. "name": "pre-release",
  12128. "in": "query"
  12129. },
  12130. {
  12131. "type": "integer",
  12132. "description": "page number of results to return (1-based)",
  12133. "name": "page",
  12134. "in": "query"
  12135. },
  12136. {
  12137. "type": "integer",
  12138. "description": "page size of results",
  12139. "name": "limit",
  12140. "in": "query"
  12141. }
  12142. ],
  12143. "responses": {
  12144. "200": {
  12145. "$ref": "#/responses/ReleaseList"
  12146. },
  12147. "404": {
  12148. "$ref": "#/responses/notFound"
  12149. }
  12150. }
  12151. },
  12152. "post": {
  12153. "consumes": [
  12154. "application/json"
  12155. ],
  12156. "produces": [
  12157. "application/json"
  12158. ],
  12159. "tags": [
  12160. "repository"
  12161. ],
  12162. "summary": "Create a release",
  12163. "operationId": "repoCreateRelease",
  12164. "parameters": [
  12165. {
  12166. "type": "string",
  12167. "description": "owner of the repo",
  12168. "name": "owner",
  12169. "in": "path",
  12170. "required": true
  12171. },
  12172. {
  12173. "type": "string",
  12174. "description": "name of the repo",
  12175. "name": "repo",
  12176. "in": "path",
  12177. "required": true
  12178. },
  12179. {
  12180. "name": "body",
  12181. "in": "body",
  12182. "schema": {
  12183. "$ref": "#/definitions/CreateReleaseOption"
  12184. }
  12185. }
  12186. ],
  12187. "responses": {
  12188. "201": {
  12189. "$ref": "#/responses/Release"
  12190. },
  12191. "404": {
  12192. "$ref": "#/responses/notFound"
  12193. },
  12194. "409": {
  12195. "$ref": "#/responses/error"
  12196. }
  12197. }
  12198. }
  12199. },
  12200. "/repos/{owner}/{repo}/releases/latest": {
  12201. "get": {
  12202. "produces": [
  12203. "application/json"
  12204. ],
  12205. "tags": [
  12206. "repository"
  12207. ],
  12208. "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
  12209. "operationId": "repoGetLatestRelease",
  12210. "parameters": [
  12211. {
  12212. "type": "string",
  12213. "description": "owner of the repo",
  12214. "name": "owner",
  12215. "in": "path",
  12216. "required": true
  12217. },
  12218. {
  12219. "type": "string",
  12220. "description": "name of the repo",
  12221. "name": "repo",
  12222. "in": "path",
  12223. "required": true
  12224. }
  12225. ],
  12226. "responses": {
  12227. "200": {
  12228. "$ref": "#/responses/Release"
  12229. },
  12230. "404": {
  12231. "$ref": "#/responses/notFound"
  12232. }
  12233. }
  12234. }
  12235. },
  12236. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  12237. "get": {
  12238. "produces": [
  12239. "application/json"
  12240. ],
  12241. "tags": [
  12242. "repository"
  12243. ],
  12244. "summary": "Get a release by tag name",
  12245. "operationId": "repoGetReleaseByTag",
  12246. "parameters": [
  12247. {
  12248. "type": "string",
  12249. "description": "owner of the repo",
  12250. "name": "owner",
  12251. "in": "path",
  12252. "required": true
  12253. },
  12254. {
  12255. "type": "string",
  12256. "description": "name of the repo",
  12257. "name": "repo",
  12258. "in": "path",
  12259. "required": true
  12260. },
  12261. {
  12262. "type": "string",
  12263. "description": "tag name of the release to get",
  12264. "name": "tag",
  12265. "in": "path",
  12266. "required": true
  12267. }
  12268. ],
  12269. "responses": {
  12270. "200": {
  12271. "$ref": "#/responses/Release"
  12272. },
  12273. "404": {
  12274. "$ref": "#/responses/notFound"
  12275. }
  12276. }
  12277. },
  12278. "delete": {
  12279. "tags": [
  12280. "repository"
  12281. ],
  12282. "summary": "Delete a release by tag name",
  12283. "operationId": "repoDeleteReleaseByTag",
  12284. "parameters": [
  12285. {
  12286. "type": "string",
  12287. "description": "owner of the repo",
  12288. "name": "owner",
  12289. "in": "path",
  12290. "required": true
  12291. },
  12292. {
  12293. "type": "string",
  12294. "description": "name of the repo",
  12295. "name": "repo",
  12296. "in": "path",
  12297. "required": true
  12298. },
  12299. {
  12300. "type": "string",
  12301. "description": "tag name of the release to delete",
  12302. "name": "tag",
  12303. "in": "path",
  12304. "required": true
  12305. }
  12306. ],
  12307. "responses": {
  12308. "204": {
  12309. "$ref": "#/responses/empty"
  12310. },
  12311. "404": {
  12312. "$ref": "#/responses/notFound"
  12313. },
  12314. "405": {
  12315. "$ref": "#/responses/empty"
  12316. }
  12317. }
  12318. }
  12319. },
  12320. "/repos/{owner}/{repo}/releases/{id}": {
  12321. "get": {
  12322. "produces": [
  12323. "application/json"
  12324. ],
  12325. "tags": [
  12326. "repository"
  12327. ],
  12328. "summary": "Get a release",
  12329. "operationId": "repoGetRelease",
  12330. "parameters": [
  12331. {
  12332. "type": "string",
  12333. "description": "owner of the repo",
  12334. "name": "owner",
  12335. "in": "path",
  12336. "required": true
  12337. },
  12338. {
  12339. "type": "string",
  12340. "description": "name of the repo",
  12341. "name": "repo",
  12342. "in": "path",
  12343. "required": true
  12344. },
  12345. {
  12346. "type": "integer",
  12347. "format": "int64",
  12348. "description": "id of the release to get",
  12349. "name": "id",
  12350. "in": "path",
  12351. "required": true
  12352. }
  12353. ],
  12354. "responses": {
  12355. "200": {
  12356. "$ref": "#/responses/Release"
  12357. },
  12358. "404": {
  12359. "$ref": "#/responses/notFound"
  12360. }
  12361. }
  12362. },
  12363. "delete": {
  12364. "tags": [
  12365. "repository"
  12366. ],
  12367. "summary": "Delete a release",
  12368. "operationId": "repoDeleteRelease",
  12369. "parameters": [
  12370. {
  12371. "type": "string",
  12372. "description": "owner of the repo",
  12373. "name": "owner",
  12374. "in": "path",
  12375. "required": true
  12376. },
  12377. {
  12378. "type": "string",
  12379. "description": "name of the repo",
  12380. "name": "repo",
  12381. "in": "path",
  12382. "required": true
  12383. },
  12384. {
  12385. "type": "integer",
  12386. "format": "int64",
  12387. "description": "id of the release to delete",
  12388. "name": "id",
  12389. "in": "path",
  12390. "required": true
  12391. }
  12392. ],
  12393. "responses": {
  12394. "204": {
  12395. "$ref": "#/responses/empty"
  12396. },
  12397. "404": {
  12398. "$ref": "#/responses/notFound"
  12399. },
  12400. "405": {
  12401. "$ref": "#/responses/empty"
  12402. }
  12403. }
  12404. },
  12405. "patch": {
  12406. "consumes": [
  12407. "application/json"
  12408. ],
  12409. "produces": [
  12410. "application/json"
  12411. ],
  12412. "tags": [
  12413. "repository"
  12414. ],
  12415. "summary": "Update a release",
  12416. "operationId": "repoEditRelease",
  12417. "parameters": [
  12418. {
  12419. "type": "string",
  12420. "description": "owner of the repo",
  12421. "name": "owner",
  12422. "in": "path",
  12423. "required": true
  12424. },
  12425. {
  12426. "type": "string",
  12427. "description": "name of the repo",
  12428. "name": "repo",
  12429. "in": "path",
  12430. "required": true
  12431. },
  12432. {
  12433. "type": "integer",
  12434. "format": "int64",
  12435. "description": "id of the release to edit",
  12436. "name": "id",
  12437. "in": "path",
  12438. "required": true
  12439. },
  12440. {
  12441. "name": "body",
  12442. "in": "body",
  12443. "schema": {
  12444. "$ref": "#/definitions/EditReleaseOption"
  12445. }
  12446. }
  12447. ],
  12448. "responses": {
  12449. "200": {
  12450. "$ref": "#/responses/Release"
  12451. },
  12452. "404": {
  12453. "$ref": "#/responses/notFound"
  12454. }
  12455. }
  12456. }
  12457. },
  12458. "/repos/{owner}/{repo}/releases/{id}/assets": {
  12459. "get": {
  12460. "produces": [
  12461. "application/json"
  12462. ],
  12463. "tags": [
  12464. "repository"
  12465. ],
  12466. "summary": "List release's attachments",
  12467. "operationId": "repoListReleaseAttachments",
  12468. "parameters": [
  12469. {
  12470. "type": "string",
  12471. "description": "owner of the repo",
  12472. "name": "owner",
  12473. "in": "path",
  12474. "required": true
  12475. },
  12476. {
  12477. "type": "string",
  12478. "description": "name of the repo",
  12479. "name": "repo",
  12480. "in": "path",
  12481. "required": true
  12482. },
  12483. {
  12484. "type": "integer",
  12485. "format": "int64",
  12486. "description": "id of the release",
  12487. "name": "id",
  12488. "in": "path",
  12489. "required": true
  12490. }
  12491. ],
  12492. "responses": {
  12493. "200": {
  12494. "$ref": "#/responses/AttachmentList"
  12495. },
  12496. "404": {
  12497. "$ref": "#/responses/notFound"
  12498. }
  12499. }
  12500. },
  12501. "post": {
  12502. "consumes": [
  12503. "multipart/form-data",
  12504. "application/octet-stream"
  12505. ],
  12506. "produces": [
  12507. "application/json"
  12508. ],
  12509. "tags": [
  12510. "repository"
  12511. ],
  12512. "summary": "Create a release attachment",
  12513. "operationId": "repoCreateReleaseAttachment",
  12514. "parameters": [
  12515. {
  12516. "type": "string",
  12517. "description": "owner of the repo",
  12518. "name": "owner",
  12519. "in": "path",
  12520. "required": true
  12521. },
  12522. {
  12523. "type": "string",
  12524. "description": "name of the repo",
  12525. "name": "repo",
  12526. "in": "path",
  12527. "required": true
  12528. },
  12529. {
  12530. "type": "integer",
  12531. "format": "int64",
  12532. "description": "id of the release",
  12533. "name": "id",
  12534. "in": "path",
  12535. "required": true
  12536. },
  12537. {
  12538. "type": "string",
  12539. "description": "name of the attachment",
  12540. "name": "name",
  12541. "in": "query"
  12542. },
  12543. {
  12544. "type": "file",
  12545. "description": "attachment to upload",
  12546. "name": "attachment",
  12547. "in": "formData"
  12548. }
  12549. ],
  12550. "responses": {
  12551. "201": {
  12552. "$ref": "#/responses/Attachment"
  12553. },
  12554. "400": {
  12555. "$ref": "#/responses/error"
  12556. },
  12557. "404": {
  12558. "$ref": "#/responses/notFound"
  12559. }
  12560. }
  12561. }
  12562. },
  12563. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  12564. "get": {
  12565. "produces": [
  12566. "application/json"
  12567. ],
  12568. "tags": [
  12569. "repository"
  12570. ],
  12571. "summary": "Get a release attachment",
  12572. "operationId": "repoGetReleaseAttachment",
  12573. "parameters": [
  12574. {
  12575. "type": "string",
  12576. "description": "owner of the repo",
  12577. "name": "owner",
  12578. "in": "path",
  12579. "required": true
  12580. },
  12581. {
  12582. "type": "string",
  12583. "description": "name of the repo",
  12584. "name": "repo",
  12585. "in": "path",
  12586. "required": true
  12587. },
  12588. {
  12589. "type": "integer",
  12590. "format": "int64",
  12591. "description": "id of the release",
  12592. "name": "id",
  12593. "in": "path",
  12594. "required": true
  12595. },
  12596. {
  12597. "type": "integer",
  12598. "format": "int64",
  12599. "description": "id of the attachment to get",
  12600. "name": "attachment_id",
  12601. "in": "path",
  12602. "required": true
  12603. }
  12604. ],
  12605. "responses": {
  12606. "200": {
  12607. "$ref": "#/responses/Attachment"
  12608. },
  12609. "404": {
  12610. "$ref": "#/responses/notFound"
  12611. }
  12612. }
  12613. },
  12614. "delete": {
  12615. "produces": [
  12616. "application/json"
  12617. ],
  12618. "tags": [
  12619. "repository"
  12620. ],
  12621. "summary": "Delete a release attachment",
  12622. "operationId": "repoDeleteReleaseAttachment",
  12623. "parameters": [
  12624. {
  12625. "type": "string",
  12626. "description": "owner of the repo",
  12627. "name": "owner",
  12628. "in": "path",
  12629. "required": true
  12630. },
  12631. {
  12632. "type": "string",
  12633. "description": "name of the repo",
  12634. "name": "repo",
  12635. "in": "path",
  12636. "required": true
  12637. },
  12638. {
  12639. "type": "integer",
  12640. "format": "int64",
  12641. "description": "id of the release",
  12642. "name": "id",
  12643. "in": "path",
  12644. "required": true
  12645. },
  12646. {
  12647. "type": "integer",
  12648. "format": "int64",
  12649. "description": "id of the attachment to delete",
  12650. "name": "attachment_id",
  12651. "in": "path",
  12652. "required": true
  12653. }
  12654. ],
  12655. "responses": {
  12656. "204": {
  12657. "$ref": "#/responses/empty"
  12658. },
  12659. "404": {
  12660. "$ref": "#/responses/notFound"
  12661. }
  12662. }
  12663. },
  12664. "patch": {
  12665. "consumes": [
  12666. "application/json"
  12667. ],
  12668. "produces": [
  12669. "application/json"
  12670. ],
  12671. "tags": [
  12672. "repository"
  12673. ],
  12674. "summary": "Edit a release attachment",
  12675. "operationId": "repoEditReleaseAttachment",
  12676. "parameters": [
  12677. {
  12678. "type": "string",
  12679. "description": "owner of the repo",
  12680. "name": "owner",
  12681. "in": "path",
  12682. "required": true
  12683. },
  12684. {
  12685. "type": "string",
  12686. "description": "name of the repo",
  12687. "name": "repo",
  12688. "in": "path",
  12689. "required": true
  12690. },
  12691. {
  12692. "type": "integer",
  12693. "format": "int64",
  12694. "description": "id of the release",
  12695. "name": "id",
  12696. "in": "path",
  12697. "required": true
  12698. },
  12699. {
  12700. "type": "integer",
  12701. "format": "int64",
  12702. "description": "id of the attachment to edit",
  12703. "name": "attachment_id",
  12704. "in": "path",
  12705. "required": true
  12706. },
  12707. {
  12708. "name": "body",
  12709. "in": "body",
  12710. "schema": {
  12711. "$ref": "#/definitions/EditAttachmentOptions"
  12712. }
  12713. }
  12714. ],
  12715. "responses": {
  12716. "201": {
  12717. "$ref": "#/responses/Attachment"
  12718. },
  12719. "404": {
  12720. "$ref": "#/responses/notFound"
  12721. }
  12722. }
  12723. }
  12724. },
  12725. "/repos/{owner}/{repo}/reviewers": {
  12726. "get": {
  12727. "produces": [
  12728. "application/json"
  12729. ],
  12730. "tags": [
  12731. "repository"
  12732. ],
  12733. "summary": "Return all users that can be requested to review in this repo",
  12734. "operationId": "repoGetReviewers",
  12735. "parameters": [
  12736. {
  12737. "type": "string",
  12738. "description": "owner of the repo",
  12739. "name": "owner",
  12740. "in": "path",
  12741. "required": true
  12742. },
  12743. {
  12744. "type": "string",
  12745. "description": "name of the repo",
  12746. "name": "repo",
  12747. "in": "path",
  12748. "required": true
  12749. }
  12750. ],
  12751. "responses": {
  12752. "200": {
  12753. "$ref": "#/responses/UserList"
  12754. },
  12755. "404": {
  12756. "$ref": "#/responses/notFound"
  12757. }
  12758. }
  12759. }
  12760. },
  12761. "/repos/{owner}/{repo}/runners/registration-token": {
  12762. "get": {
  12763. "produces": [
  12764. "application/json"
  12765. ],
  12766. "tags": [
  12767. "repository"
  12768. ],
  12769. "summary": "Get a repository's actions runner registration token",
  12770. "operationId": "repoGetRunnerRegistrationToken",
  12771. "parameters": [
  12772. {
  12773. "type": "string",
  12774. "description": "owner of the repo",
  12775. "name": "owner",
  12776. "in": "path",
  12777. "required": true
  12778. },
  12779. {
  12780. "type": "string",
  12781. "description": "name of the repo",
  12782. "name": "repo",
  12783. "in": "path",
  12784. "required": true
  12785. }
  12786. ],
  12787. "responses": {
  12788. "200": {
  12789. "$ref": "#/responses/RegistrationToken"
  12790. }
  12791. }
  12792. }
  12793. },
  12794. "/repos/{owner}/{repo}/signing-key.gpg": {
  12795. "get": {
  12796. "produces": [
  12797. "text/plain"
  12798. ],
  12799. "tags": [
  12800. "repository"
  12801. ],
  12802. "summary": "Get signing-key.gpg for given repository",
  12803. "operationId": "repoSigningKey",
  12804. "parameters": [
  12805. {
  12806. "type": "string",
  12807. "description": "owner of the repo",
  12808. "name": "owner",
  12809. "in": "path",
  12810. "required": true
  12811. },
  12812. {
  12813. "type": "string",
  12814. "description": "name of the repo",
  12815. "name": "repo",
  12816. "in": "path",
  12817. "required": true
  12818. }
  12819. ],
  12820. "responses": {
  12821. "200": {
  12822. "description": "GPG armored public key",
  12823. "schema": {
  12824. "type": "string"
  12825. }
  12826. }
  12827. }
  12828. }
  12829. },
  12830. "/repos/{owner}/{repo}/stargazers": {
  12831. "get": {
  12832. "produces": [
  12833. "application/json"
  12834. ],
  12835. "tags": [
  12836. "repository"
  12837. ],
  12838. "summary": "List a repo's stargazers",
  12839. "operationId": "repoListStargazers",
  12840. "parameters": [
  12841. {
  12842. "type": "string",
  12843. "description": "owner of the repo",
  12844. "name": "owner",
  12845. "in": "path",
  12846. "required": true
  12847. },
  12848. {
  12849. "type": "string",
  12850. "description": "name of the repo",
  12851. "name": "repo",
  12852. "in": "path",
  12853. "required": true
  12854. },
  12855. {
  12856. "type": "integer",
  12857. "description": "page number of results to return (1-based)",
  12858. "name": "page",
  12859. "in": "query"
  12860. },
  12861. {
  12862. "type": "integer",
  12863. "description": "page size of results",
  12864. "name": "limit",
  12865. "in": "query"
  12866. }
  12867. ],
  12868. "responses": {
  12869. "200": {
  12870. "$ref": "#/responses/UserList"
  12871. },
  12872. "404": {
  12873. "$ref": "#/responses/notFound"
  12874. }
  12875. }
  12876. }
  12877. },
  12878. "/repos/{owner}/{repo}/statuses/{sha}": {
  12879. "get": {
  12880. "produces": [
  12881. "application/json"
  12882. ],
  12883. "tags": [
  12884. "repository"
  12885. ],
  12886. "summary": "Get a commit's statuses",
  12887. "operationId": "repoListStatuses",
  12888. "parameters": [
  12889. {
  12890. "type": "string",
  12891. "description": "owner of the repo",
  12892. "name": "owner",
  12893. "in": "path",
  12894. "required": true
  12895. },
  12896. {
  12897. "type": "string",
  12898. "description": "name of the repo",
  12899. "name": "repo",
  12900. "in": "path",
  12901. "required": true
  12902. },
  12903. {
  12904. "type": "string",
  12905. "description": "sha of the commit",
  12906. "name": "sha",
  12907. "in": "path",
  12908. "required": true
  12909. },
  12910. {
  12911. "enum": [
  12912. "oldest",
  12913. "recentupdate",
  12914. "leastupdate",
  12915. "leastindex",
  12916. "highestindex"
  12917. ],
  12918. "type": "string",
  12919. "description": "type of sort",
  12920. "name": "sort",
  12921. "in": "query"
  12922. },
  12923. {
  12924. "enum": [
  12925. "pending",
  12926. "success",
  12927. "error",
  12928. "failure",
  12929. "warning"
  12930. ],
  12931. "type": "string",
  12932. "description": "type of state",
  12933. "name": "state",
  12934. "in": "query"
  12935. },
  12936. {
  12937. "type": "integer",
  12938. "description": "page number of results to return (1-based)",
  12939. "name": "page",
  12940. "in": "query"
  12941. },
  12942. {
  12943. "type": "integer",
  12944. "description": "page size of results",
  12945. "name": "limit",
  12946. "in": "query"
  12947. }
  12948. ],
  12949. "responses": {
  12950. "200": {
  12951. "$ref": "#/responses/CommitStatusList"
  12952. },
  12953. "400": {
  12954. "$ref": "#/responses/error"
  12955. },
  12956. "404": {
  12957. "$ref": "#/responses/notFound"
  12958. }
  12959. }
  12960. },
  12961. "post": {
  12962. "produces": [
  12963. "application/json"
  12964. ],
  12965. "tags": [
  12966. "repository"
  12967. ],
  12968. "summary": "Create a commit status",
  12969. "operationId": "repoCreateStatus",
  12970. "parameters": [
  12971. {
  12972. "type": "string",
  12973. "description": "owner of the repo",
  12974. "name": "owner",
  12975. "in": "path",
  12976. "required": true
  12977. },
  12978. {
  12979. "type": "string",
  12980. "description": "name of the repo",
  12981. "name": "repo",
  12982. "in": "path",
  12983. "required": true
  12984. },
  12985. {
  12986. "type": "string",
  12987. "description": "sha of the commit",
  12988. "name": "sha",
  12989. "in": "path",
  12990. "required": true
  12991. },
  12992. {
  12993. "name": "body",
  12994. "in": "body",
  12995. "schema": {
  12996. "$ref": "#/definitions/CreateStatusOption"
  12997. }
  12998. }
  12999. ],
  13000. "responses": {
  13001. "201": {
  13002. "$ref": "#/responses/CommitStatus"
  13003. },
  13004. "400": {
  13005. "$ref": "#/responses/error"
  13006. },
  13007. "404": {
  13008. "$ref": "#/responses/notFound"
  13009. }
  13010. }
  13011. }
  13012. },
  13013. "/repos/{owner}/{repo}/subscribers": {
  13014. "get": {
  13015. "produces": [
  13016. "application/json"
  13017. ],
  13018. "tags": [
  13019. "repository"
  13020. ],
  13021. "summary": "List a repo's watchers",
  13022. "operationId": "repoListSubscribers",
  13023. "parameters": [
  13024. {
  13025. "type": "string",
  13026. "description": "owner of the repo",
  13027. "name": "owner",
  13028. "in": "path",
  13029. "required": true
  13030. },
  13031. {
  13032. "type": "string",
  13033. "description": "name of the repo",
  13034. "name": "repo",
  13035. "in": "path",
  13036. "required": true
  13037. },
  13038. {
  13039. "type": "integer",
  13040. "description": "page number of results to return (1-based)",
  13041. "name": "page",
  13042. "in": "query"
  13043. },
  13044. {
  13045. "type": "integer",
  13046. "description": "page size of results",
  13047. "name": "limit",
  13048. "in": "query"
  13049. }
  13050. ],
  13051. "responses": {
  13052. "200": {
  13053. "$ref": "#/responses/UserList"
  13054. },
  13055. "404": {
  13056. "$ref": "#/responses/notFound"
  13057. }
  13058. }
  13059. }
  13060. },
  13061. "/repos/{owner}/{repo}/subscription": {
  13062. "get": {
  13063. "tags": [
  13064. "repository"
  13065. ],
  13066. "summary": "Check if the current user is watching a repo",
  13067. "operationId": "userCurrentCheckSubscription",
  13068. "parameters": [
  13069. {
  13070. "type": "string",
  13071. "description": "owner of the repo",
  13072. "name": "owner",
  13073. "in": "path",
  13074. "required": true
  13075. },
  13076. {
  13077. "type": "string",
  13078. "description": "name of the repo",
  13079. "name": "repo",
  13080. "in": "path",
  13081. "required": true
  13082. }
  13083. ],
  13084. "responses": {
  13085. "200": {
  13086. "$ref": "#/responses/WatchInfo"
  13087. },
  13088. "404": {
  13089. "description": "User is not watching this repo or repo do not exist"
  13090. }
  13091. }
  13092. },
  13093. "put": {
  13094. "tags": [
  13095. "repository"
  13096. ],
  13097. "summary": "Watch a repo",
  13098. "operationId": "userCurrentPutSubscription",
  13099. "parameters": [
  13100. {
  13101. "type": "string",
  13102. "description": "owner of the repo",
  13103. "name": "owner",
  13104. "in": "path",
  13105. "required": true
  13106. },
  13107. {
  13108. "type": "string",
  13109. "description": "name of the repo",
  13110. "name": "repo",
  13111. "in": "path",
  13112. "required": true
  13113. }
  13114. ],
  13115. "responses": {
  13116. "200": {
  13117. "$ref": "#/responses/WatchInfo"
  13118. },
  13119. "403": {
  13120. "$ref": "#/responses/forbidden"
  13121. },
  13122. "404": {
  13123. "$ref": "#/responses/notFound"
  13124. }
  13125. }
  13126. },
  13127. "delete": {
  13128. "tags": [
  13129. "repository"
  13130. ],
  13131. "summary": "Unwatch a repo",
  13132. "operationId": "userCurrentDeleteSubscription",
  13133. "parameters": [
  13134. {
  13135. "type": "string",
  13136. "description": "owner of the repo",
  13137. "name": "owner",
  13138. "in": "path",
  13139. "required": true
  13140. },
  13141. {
  13142. "type": "string",
  13143. "description": "name of the repo",
  13144. "name": "repo",
  13145. "in": "path",
  13146. "required": true
  13147. }
  13148. ],
  13149. "responses": {
  13150. "204": {
  13151. "$ref": "#/responses/empty"
  13152. },
  13153. "404": {
  13154. "$ref": "#/responses/notFound"
  13155. }
  13156. }
  13157. }
  13158. },
  13159. "/repos/{owner}/{repo}/tags": {
  13160. "get": {
  13161. "produces": [
  13162. "application/json"
  13163. ],
  13164. "tags": [
  13165. "repository"
  13166. ],
  13167. "summary": "List a repository's tags",
  13168. "operationId": "repoListTags",
  13169. "parameters": [
  13170. {
  13171. "type": "string",
  13172. "description": "owner of the repo",
  13173. "name": "owner",
  13174. "in": "path",
  13175. "required": true
  13176. },
  13177. {
  13178. "type": "string",
  13179. "description": "name of the repo",
  13180. "name": "repo",
  13181. "in": "path",
  13182. "required": true
  13183. },
  13184. {
  13185. "type": "integer",
  13186. "description": "page number of results to return (1-based)",
  13187. "name": "page",
  13188. "in": "query"
  13189. },
  13190. {
  13191. "type": "integer",
  13192. "description": "page size of results, default maximum page size is 50",
  13193. "name": "limit",
  13194. "in": "query"
  13195. }
  13196. ],
  13197. "responses": {
  13198. "200": {
  13199. "$ref": "#/responses/TagList"
  13200. },
  13201. "404": {
  13202. "$ref": "#/responses/notFound"
  13203. }
  13204. }
  13205. },
  13206. "post": {
  13207. "produces": [
  13208. "application/json"
  13209. ],
  13210. "tags": [
  13211. "repository"
  13212. ],
  13213. "summary": "Create a new git tag in a repository",
  13214. "operationId": "repoCreateTag",
  13215. "parameters": [
  13216. {
  13217. "type": "string",
  13218. "description": "owner of the repo",
  13219. "name": "owner",
  13220. "in": "path",
  13221. "required": true
  13222. },
  13223. {
  13224. "type": "string",
  13225. "description": "name of the repo",
  13226. "name": "repo",
  13227. "in": "path",
  13228. "required": true
  13229. },
  13230. {
  13231. "name": "body",
  13232. "in": "body",
  13233. "schema": {
  13234. "$ref": "#/definitions/CreateTagOption"
  13235. }
  13236. }
  13237. ],
  13238. "responses": {
  13239. "200": {
  13240. "$ref": "#/responses/Tag"
  13241. },
  13242. "404": {
  13243. "$ref": "#/responses/notFound"
  13244. },
  13245. "405": {
  13246. "$ref": "#/responses/empty"
  13247. },
  13248. "409": {
  13249. "$ref": "#/responses/conflict"
  13250. },
  13251. "423": {
  13252. "$ref": "#/responses/repoArchivedError"
  13253. }
  13254. }
  13255. }
  13256. },
  13257. "/repos/{owner}/{repo}/tags/{tag}": {
  13258. "get": {
  13259. "produces": [
  13260. "application/json"
  13261. ],
  13262. "tags": [
  13263. "repository"
  13264. ],
  13265. "summary": "Get the tag of a repository by tag name",
  13266. "operationId": "repoGetTag",
  13267. "parameters": [
  13268. {
  13269. "type": "string",
  13270. "description": "owner of the repo",
  13271. "name": "owner",
  13272. "in": "path",
  13273. "required": true
  13274. },
  13275. {
  13276. "type": "string",
  13277. "description": "name of the repo",
  13278. "name": "repo",
  13279. "in": "path",
  13280. "required": true
  13281. },
  13282. {
  13283. "type": "string",
  13284. "description": "name of tag",
  13285. "name": "tag",
  13286. "in": "path",
  13287. "required": true
  13288. }
  13289. ],
  13290. "responses": {
  13291. "200": {
  13292. "$ref": "#/responses/Tag"
  13293. },
  13294. "404": {
  13295. "$ref": "#/responses/notFound"
  13296. }
  13297. }
  13298. },
  13299. "delete": {
  13300. "produces": [
  13301. "application/json"
  13302. ],
  13303. "tags": [
  13304. "repository"
  13305. ],
  13306. "summary": "Delete a repository's tag by name",
  13307. "operationId": "repoDeleteTag",
  13308. "parameters": [
  13309. {
  13310. "type": "string",
  13311. "description": "owner of the repo",
  13312. "name": "owner",
  13313. "in": "path",
  13314. "required": true
  13315. },
  13316. {
  13317. "type": "string",
  13318. "description": "name of the repo",
  13319. "name": "repo",
  13320. "in": "path",
  13321. "required": true
  13322. },
  13323. {
  13324. "type": "string",
  13325. "description": "name of tag to delete",
  13326. "name": "tag",
  13327. "in": "path",
  13328. "required": true
  13329. }
  13330. ],
  13331. "responses": {
  13332. "204": {
  13333. "$ref": "#/responses/empty"
  13334. },
  13335. "404": {
  13336. "$ref": "#/responses/notFound"
  13337. },
  13338. "405": {
  13339. "$ref": "#/responses/empty"
  13340. },
  13341. "409": {
  13342. "$ref": "#/responses/conflict"
  13343. },
  13344. "423": {
  13345. "$ref": "#/responses/repoArchivedError"
  13346. }
  13347. }
  13348. }
  13349. },
  13350. "/repos/{owner}/{repo}/teams": {
  13351. "get": {
  13352. "produces": [
  13353. "application/json"
  13354. ],
  13355. "tags": [
  13356. "repository"
  13357. ],
  13358. "summary": "List a repository's teams",
  13359. "operationId": "repoListTeams",
  13360. "parameters": [
  13361. {
  13362. "type": "string",
  13363. "description": "owner of the repo",
  13364. "name": "owner",
  13365. "in": "path",
  13366. "required": true
  13367. },
  13368. {
  13369. "type": "string",
  13370. "description": "name of the repo",
  13371. "name": "repo",
  13372. "in": "path",
  13373. "required": true
  13374. }
  13375. ],
  13376. "responses": {
  13377. "200": {
  13378. "$ref": "#/responses/TeamList"
  13379. },
  13380. "404": {
  13381. "$ref": "#/responses/notFound"
  13382. }
  13383. }
  13384. }
  13385. },
  13386. "/repos/{owner}/{repo}/teams/{team}": {
  13387. "get": {
  13388. "produces": [
  13389. "application/json"
  13390. ],
  13391. "tags": [
  13392. "repository"
  13393. ],
  13394. "summary": "Check if a team is assigned to a repository",
  13395. "operationId": "repoCheckTeam",
  13396. "parameters": [
  13397. {
  13398. "type": "string",
  13399. "description": "owner of the repo",
  13400. "name": "owner",
  13401. "in": "path",
  13402. "required": true
  13403. },
  13404. {
  13405. "type": "string",
  13406. "description": "name of the repo",
  13407. "name": "repo",
  13408. "in": "path",
  13409. "required": true
  13410. },
  13411. {
  13412. "type": "string",
  13413. "description": "team name",
  13414. "name": "team",
  13415. "in": "path",
  13416. "required": true
  13417. }
  13418. ],
  13419. "responses": {
  13420. "200": {
  13421. "$ref": "#/responses/Team"
  13422. },
  13423. "404": {
  13424. "$ref": "#/responses/notFound"
  13425. },
  13426. "405": {
  13427. "$ref": "#/responses/error"
  13428. }
  13429. }
  13430. },
  13431. "put": {
  13432. "produces": [
  13433. "application/json"
  13434. ],
  13435. "tags": [
  13436. "repository"
  13437. ],
  13438. "summary": "Add a team to a repository",
  13439. "operationId": "repoAddTeam",
  13440. "parameters": [
  13441. {
  13442. "type": "string",
  13443. "description": "owner of the repo",
  13444. "name": "owner",
  13445. "in": "path",
  13446. "required": true
  13447. },
  13448. {
  13449. "type": "string",
  13450. "description": "name of the repo",
  13451. "name": "repo",
  13452. "in": "path",
  13453. "required": true
  13454. },
  13455. {
  13456. "type": "string",
  13457. "description": "team name",
  13458. "name": "team",
  13459. "in": "path",
  13460. "required": true
  13461. }
  13462. ],
  13463. "responses": {
  13464. "204": {
  13465. "$ref": "#/responses/empty"
  13466. },
  13467. "404": {
  13468. "$ref": "#/responses/notFound"
  13469. },
  13470. "405": {
  13471. "$ref": "#/responses/error"
  13472. },
  13473. "422": {
  13474. "$ref": "#/responses/validationError"
  13475. }
  13476. }
  13477. },
  13478. "delete": {
  13479. "produces": [
  13480. "application/json"
  13481. ],
  13482. "tags": [
  13483. "repository"
  13484. ],
  13485. "summary": "Delete a team from a repository",
  13486. "operationId": "repoDeleteTeam",
  13487. "parameters": [
  13488. {
  13489. "type": "string",
  13490. "description": "owner of the repo",
  13491. "name": "owner",
  13492. "in": "path",
  13493. "required": true
  13494. },
  13495. {
  13496. "type": "string",
  13497. "description": "name of the repo",
  13498. "name": "repo",
  13499. "in": "path",
  13500. "required": true
  13501. },
  13502. {
  13503. "type": "string",
  13504. "description": "team name",
  13505. "name": "team",
  13506. "in": "path",
  13507. "required": true
  13508. }
  13509. ],
  13510. "responses": {
  13511. "204": {
  13512. "$ref": "#/responses/empty"
  13513. },
  13514. "404": {
  13515. "$ref": "#/responses/notFound"
  13516. },
  13517. "405": {
  13518. "$ref": "#/responses/error"
  13519. },
  13520. "422": {
  13521. "$ref": "#/responses/validationError"
  13522. }
  13523. }
  13524. }
  13525. },
  13526. "/repos/{owner}/{repo}/times": {
  13527. "get": {
  13528. "produces": [
  13529. "application/json"
  13530. ],
  13531. "tags": [
  13532. "repository"
  13533. ],
  13534. "summary": "List a repo's tracked times",
  13535. "operationId": "repoTrackedTimes",
  13536. "parameters": [
  13537. {
  13538. "type": "string",
  13539. "description": "owner of the repo",
  13540. "name": "owner",
  13541. "in": "path",
  13542. "required": true
  13543. },
  13544. {
  13545. "type": "string",
  13546. "description": "name of the repo",
  13547. "name": "repo",
  13548. "in": "path",
  13549. "required": true
  13550. },
  13551. {
  13552. "type": "string",
  13553. "description": "optional filter by user (available for issue managers)",
  13554. "name": "user",
  13555. "in": "query"
  13556. },
  13557. {
  13558. "type": "string",
  13559. "format": "date-time",
  13560. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  13561. "name": "since",
  13562. "in": "query"
  13563. },
  13564. {
  13565. "type": "string",
  13566. "format": "date-time",
  13567. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  13568. "name": "before",
  13569. "in": "query"
  13570. },
  13571. {
  13572. "type": "integer",
  13573. "description": "page number of results to return (1-based)",
  13574. "name": "page",
  13575. "in": "query"
  13576. },
  13577. {
  13578. "type": "integer",
  13579. "description": "page size of results",
  13580. "name": "limit",
  13581. "in": "query"
  13582. }
  13583. ],
  13584. "responses": {
  13585. "200": {
  13586. "$ref": "#/responses/TrackedTimeList"
  13587. },
  13588. "400": {
  13589. "$ref": "#/responses/error"
  13590. },
  13591. "403": {
  13592. "$ref": "#/responses/forbidden"
  13593. },
  13594. "404": {
  13595. "$ref": "#/responses/notFound"
  13596. }
  13597. }
  13598. }
  13599. },
  13600. "/repos/{owner}/{repo}/times/{user}": {
  13601. "get": {
  13602. "produces": [
  13603. "application/json"
  13604. ],
  13605. "tags": [
  13606. "repository"
  13607. ],
  13608. "summary": "List a user's tracked times in a repo",
  13609. "operationId": "userTrackedTimes",
  13610. "deprecated": true,
  13611. "parameters": [
  13612. {
  13613. "type": "string",
  13614. "description": "owner of the repo",
  13615. "name": "owner",
  13616. "in": "path",
  13617. "required": true
  13618. },
  13619. {
  13620. "type": "string",
  13621. "description": "name of the repo",
  13622. "name": "repo",
  13623. "in": "path",
  13624. "required": true
  13625. },
  13626. {
  13627. "type": "string",
  13628. "description": "username of user",
  13629. "name": "user",
  13630. "in": "path",
  13631. "required": true
  13632. }
  13633. ],
  13634. "responses": {
  13635. "200": {
  13636. "$ref": "#/responses/TrackedTimeList"
  13637. },
  13638. "400": {
  13639. "$ref": "#/responses/error"
  13640. },
  13641. "403": {
  13642. "$ref": "#/responses/forbidden"
  13643. },
  13644. "404": {
  13645. "$ref": "#/responses/notFound"
  13646. }
  13647. }
  13648. }
  13649. },
  13650. "/repos/{owner}/{repo}/topics": {
  13651. "get": {
  13652. "produces": [
  13653. "application/json"
  13654. ],
  13655. "tags": [
  13656. "repository"
  13657. ],
  13658. "summary": "Get list of topics that a repository has",
  13659. "operationId": "repoListTopics",
  13660. "parameters": [
  13661. {
  13662. "type": "string",
  13663. "description": "owner of the repo",
  13664. "name": "owner",
  13665. "in": "path",
  13666. "required": true
  13667. },
  13668. {
  13669. "type": "string",
  13670. "description": "name of the repo",
  13671. "name": "repo",
  13672. "in": "path",
  13673. "required": true
  13674. },
  13675. {
  13676. "type": "integer",
  13677. "description": "page number of results to return (1-based)",
  13678. "name": "page",
  13679. "in": "query"
  13680. },
  13681. {
  13682. "type": "integer",
  13683. "description": "page size of results",
  13684. "name": "limit",
  13685. "in": "query"
  13686. }
  13687. ],
  13688. "responses": {
  13689. "200": {
  13690. "$ref": "#/responses/TopicNames"
  13691. },
  13692. "404": {
  13693. "$ref": "#/responses/notFound"
  13694. }
  13695. }
  13696. },
  13697. "put": {
  13698. "produces": [
  13699. "application/json"
  13700. ],
  13701. "tags": [
  13702. "repository"
  13703. ],
  13704. "summary": "Replace list of topics for a repository",
  13705. "operationId": "repoUpdateTopics",
  13706. "parameters": [
  13707. {
  13708. "type": "string",
  13709. "description": "owner of the repo",
  13710. "name": "owner",
  13711. "in": "path",
  13712. "required": true
  13713. },
  13714. {
  13715. "type": "string",
  13716. "description": "name of the repo",
  13717. "name": "repo",
  13718. "in": "path",
  13719. "required": true
  13720. },
  13721. {
  13722. "name": "body",
  13723. "in": "body",
  13724. "schema": {
  13725. "$ref": "#/definitions/RepoTopicOptions"
  13726. }
  13727. }
  13728. ],
  13729. "responses": {
  13730. "204": {
  13731. "$ref": "#/responses/empty"
  13732. },
  13733. "404": {
  13734. "$ref": "#/responses/notFound"
  13735. },
  13736. "422": {
  13737. "$ref": "#/responses/invalidTopicsError"
  13738. }
  13739. }
  13740. }
  13741. },
  13742. "/repos/{owner}/{repo}/topics/{topic}": {
  13743. "put": {
  13744. "produces": [
  13745. "application/json"
  13746. ],
  13747. "tags": [
  13748. "repository"
  13749. ],
  13750. "summary": "Add a topic to a repository",
  13751. "operationId": "repoAddTopic",
  13752. "parameters": [
  13753. {
  13754. "type": "string",
  13755. "description": "owner of the repo",
  13756. "name": "owner",
  13757. "in": "path",
  13758. "required": true
  13759. },
  13760. {
  13761. "type": "string",
  13762. "description": "name of the repo",
  13763. "name": "repo",
  13764. "in": "path",
  13765. "required": true
  13766. },
  13767. {
  13768. "type": "string",
  13769. "description": "name of the topic to add",
  13770. "name": "topic",
  13771. "in": "path",
  13772. "required": true
  13773. }
  13774. ],
  13775. "responses": {
  13776. "204": {
  13777. "$ref": "#/responses/empty"
  13778. },
  13779. "404": {
  13780. "$ref": "#/responses/notFound"
  13781. },
  13782. "422": {
  13783. "$ref": "#/responses/invalidTopicsError"
  13784. }
  13785. }
  13786. },
  13787. "delete": {
  13788. "produces": [
  13789. "application/json"
  13790. ],
  13791. "tags": [
  13792. "repository"
  13793. ],
  13794. "summary": "Delete a topic from a repository",
  13795. "operationId": "repoDeleteTopic",
  13796. "parameters": [
  13797. {
  13798. "type": "string",
  13799. "description": "owner of the repo",
  13800. "name": "owner",
  13801. "in": "path",
  13802. "required": true
  13803. },
  13804. {
  13805. "type": "string",
  13806. "description": "name of the repo",
  13807. "name": "repo",
  13808. "in": "path",
  13809. "required": true
  13810. },
  13811. {
  13812. "type": "string",
  13813. "description": "name of the topic to delete",
  13814. "name": "topic",
  13815. "in": "path",
  13816. "required": true
  13817. }
  13818. ],
  13819. "responses": {
  13820. "204": {
  13821. "$ref": "#/responses/empty"
  13822. },
  13823. "404": {
  13824. "$ref": "#/responses/notFound"
  13825. },
  13826. "422": {
  13827. "$ref": "#/responses/invalidTopicsError"
  13828. }
  13829. }
  13830. }
  13831. },
  13832. "/repos/{owner}/{repo}/transfer": {
  13833. "post": {
  13834. "produces": [
  13835. "application/json"
  13836. ],
  13837. "tags": [
  13838. "repository"
  13839. ],
  13840. "summary": "Transfer a repo ownership",
  13841. "operationId": "repoTransfer",
  13842. "parameters": [
  13843. {
  13844. "type": "string",
  13845. "description": "owner of the repo to transfer",
  13846. "name": "owner",
  13847. "in": "path",
  13848. "required": true
  13849. },
  13850. {
  13851. "type": "string",
  13852. "description": "name of the repo to transfer",
  13853. "name": "repo",
  13854. "in": "path",
  13855. "required": true
  13856. },
  13857. {
  13858. "description": "Transfer Options",
  13859. "name": "body",
  13860. "in": "body",
  13861. "required": true,
  13862. "schema": {
  13863. "$ref": "#/definitions/TransferRepoOption"
  13864. }
  13865. }
  13866. ],
  13867. "responses": {
  13868. "202": {
  13869. "$ref": "#/responses/Repository"
  13870. },
  13871. "403": {
  13872. "$ref": "#/responses/forbidden"
  13873. },
  13874. "404": {
  13875. "$ref": "#/responses/notFound"
  13876. },
  13877. "422": {
  13878. "$ref": "#/responses/validationError"
  13879. }
  13880. }
  13881. }
  13882. },
  13883. "/repos/{owner}/{repo}/transfer/accept": {
  13884. "post": {
  13885. "produces": [
  13886. "application/json"
  13887. ],
  13888. "tags": [
  13889. "repository"
  13890. ],
  13891. "summary": "Accept a repo transfer",
  13892. "operationId": "acceptRepoTransfer",
  13893. "parameters": [
  13894. {
  13895. "type": "string",
  13896. "description": "owner of the repo to transfer",
  13897. "name": "owner",
  13898. "in": "path",
  13899. "required": true
  13900. },
  13901. {
  13902. "type": "string",
  13903. "description": "name of the repo to transfer",
  13904. "name": "repo",
  13905. "in": "path",
  13906. "required": true
  13907. }
  13908. ],
  13909. "responses": {
  13910. "202": {
  13911. "$ref": "#/responses/Repository"
  13912. },
  13913. "403": {
  13914. "$ref": "#/responses/forbidden"
  13915. },
  13916. "404": {
  13917. "$ref": "#/responses/notFound"
  13918. }
  13919. }
  13920. }
  13921. },
  13922. "/repos/{owner}/{repo}/transfer/reject": {
  13923. "post": {
  13924. "produces": [
  13925. "application/json"
  13926. ],
  13927. "tags": [
  13928. "repository"
  13929. ],
  13930. "summary": "Reject a repo transfer",
  13931. "operationId": "rejectRepoTransfer",
  13932. "parameters": [
  13933. {
  13934. "type": "string",
  13935. "description": "owner of the repo to transfer",
  13936. "name": "owner",
  13937. "in": "path",
  13938. "required": true
  13939. },
  13940. {
  13941. "type": "string",
  13942. "description": "name of the repo to transfer",
  13943. "name": "repo",
  13944. "in": "path",
  13945. "required": true
  13946. }
  13947. ],
  13948. "responses": {
  13949. "200": {
  13950. "$ref": "#/responses/Repository"
  13951. },
  13952. "403": {
  13953. "$ref": "#/responses/forbidden"
  13954. },
  13955. "404": {
  13956. "$ref": "#/responses/notFound"
  13957. }
  13958. }
  13959. }
  13960. },
  13961. "/repos/{owner}/{repo}/wiki/new": {
  13962. "post": {
  13963. "consumes": [
  13964. "application/json"
  13965. ],
  13966. "tags": [
  13967. "repository"
  13968. ],
  13969. "summary": "Create a wiki page",
  13970. "operationId": "repoCreateWikiPage",
  13971. "parameters": [
  13972. {
  13973. "type": "string",
  13974. "description": "owner of the repo",
  13975. "name": "owner",
  13976. "in": "path",
  13977. "required": true
  13978. },
  13979. {
  13980. "type": "string",
  13981. "description": "name of the repo",
  13982. "name": "repo",
  13983. "in": "path",
  13984. "required": true
  13985. },
  13986. {
  13987. "name": "body",
  13988. "in": "body",
  13989. "schema": {
  13990. "$ref": "#/definitions/CreateWikiPageOptions"
  13991. }
  13992. }
  13993. ],
  13994. "responses": {
  13995. "201": {
  13996. "$ref": "#/responses/WikiPage"
  13997. },
  13998. "400": {
  13999. "$ref": "#/responses/error"
  14000. },
  14001. "403": {
  14002. "$ref": "#/responses/forbidden"
  14003. },
  14004. "404": {
  14005. "$ref": "#/responses/notFound"
  14006. },
  14007. "423": {
  14008. "$ref": "#/responses/repoArchivedError"
  14009. }
  14010. }
  14011. }
  14012. },
  14013. "/repos/{owner}/{repo}/wiki/page/{pageName}": {
  14014. "get": {
  14015. "produces": [
  14016. "application/json"
  14017. ],
  14018. "tags": [
  14019. "repository"
  14020. ],
  14021. "summary": "Get a wiki page",
  14022. "operationId": "repoGetWikiPage",
  14023. "parameters": [
  14024. {
  14025. "type": "string",
  14026. "description": "owner of the repo",
  14027. "name": "owner",
  14028. "in": "path",
  14029. "required": true
  14030. },
  14031. {
  14032. "type": "string",
  14033. "description": "name of the repo",
  14034. "name": "repo",
  14035. "in": "path",
  14036. "required": true
  14037. },
  14038. {
  14039. "type": "string",
  14040. "description": "name of the page",
  14041. "name": "pageName",
  14042. "in": "path",
  14043. "required": true
  14044. }
  14045. ],
  14046. "responses": {
  14047. "200": {
  14048. "$ref": "#/responses/WikiPage"
  14049. },
  14050. "404": {
  14051. "$ref": "#/responses/notFound"
  14052. }
  14053. }
  14054. },
  14055. "delete": {
  14056. "tags": [
  14057. "repository"
  14058. ],
  14059. "summary": "Delete a wiki page",
  14060. "operationId": "repoDeleteWikiPage",
  14061. "parameters": [
  14062. {
  14063. "type": "string",
  14064. "description": "owner of the repo",
  14065. "name": "owner",
  14066. "in": "path",
  14067. "required": true
  14068. },
  14069. {
  14070. "type": "string",
  14071. "description": "name of the repo",
  14072. "name": "repo",
  14073. "in": "path",
  14074. "required": true
  14075. },
  14076. {
  14077. "type": "string",
  14078. "description": "name of the page",
  14079. "name": "pageName",
  14080. "in": "path",
  14081. "required": true
  14082. }
  14083. ],
  14084. "responses": {
  14085. "204": {
  14086. "$ref": "#/responses/empty"
  14087. },
  14088. "403": {
  14089. "$ref": "#/responses/forbidden"
  14090. },
  14091. "404": {
  14092. "$ref": "#/responses/notFound"
  14093. },
  14094. "423": {
  14095. "$ref": "#/responses/repoArchivedError"
  14096. }
  14097. }
  14098. },
  14099. "patch": {
  14100. "consumes": [
  14101. "application/json"
  14102. ],
  14103. "tags": [
  14104. "repository"
  14105. ],
  14106. "summary": "Edit a wiki page",
  14107. "operationId": "repoEditWikiPage",
  14108. "parameters": [
  14109. {
  14110. "type": "string",
  14111. "description": "owner of the repo",
  14112. "name": "owner",
  14113. "in": "path",
  14114. "required": true
  14115. },
  14116. {
  14117. "type": "string",
  14118. "description": "name of the repo",
  14119. "name": "repo",
  14120. "in": "path",
  14121. "required": true
  14122. },
  14123. {
  14124. "type": "string",
  14125. "description": "name of the page",
  14126. "name": "pageName",
  14127. "in": "path",
  14128. "required": true
  14129. },
  14130. {
  14131. "name": "body",
  14132. "in": "body",
  14133. "schema": {
  14134. "$ref": "#/definitions/CreateWikiPageOptions"
  14135. }
  14136. }
  14137. ],
  14138. "responses": {
  14139. "200": {
  14140. "$ref": "#/responses/WikiPage"
  14141. },
  14142. "400": {
  14143. "$ref": "#/responses/error"
  14144. },
  14145. "403": {
  14146. "$ref": "#/responses/forbidden"
  14147. },
  14148. "404": {
  14149. "$ref": "#/responses/notFound"
  14150. },
  14151. "423": {
  14152. "$ref": "#/responses/repoArchivedError"
  14153. }
  14154. }
  14155. }
  14156. },
  14157. "/repos/{owner}/{repo}/wiki/pages": {
  14158. "get": {
  14159. "produces": [
  14160. "application/json"
  14161. ],
  14162. "tags": [
  14163. "repository"
  14164. ],
  14165. "summary": "Get all wiki pages",
  14166. "operationId": "repoGetWikiPages",
  14167. "parameters": [
  14168. {
  14169. "type": "string",
  14170. "description": "owner of the repo",
  14171. "name": "owner",
  14172. "in": "path",
  14173. "required": true
  14174. },
  14175. {
  14176. "type": "string",
  14177. "description": "name of the repo",
  14178. "name": "repo",
  14179. "in": "path",
  14180. "required": true
  14181. },
  14182. {
  14183. "type": "integer",
  14184. "description": "page number of results to return (1-based)",
  14185. "name": "page",
  14186. "in": "query"
  14187. },
  14188. {
  14189. "type": "integer",
  14190. "description": "page size of results",
  14191. "name": "limit",
  14192. "in": "query"
  14193. }
  14194. ],
  14195. "responses": {
  14196. "200": {
  14197. "$ref": "#/responses/WikiPageList"
  14198. },
  14199. "404": {
  14200. "$ref": "#/responses/notFound"
  14201. }
  14202. }
  14203. }
  14204. },
  14205. "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
  14206. "get": {
  14207. "produces": [
  14208. "application/json"
  14209. ],
  14210. "tags": [
  14211. "repository"
  14212. ],
  14213. "summary": "Get revisions of a wiki page",
  14214. "operationId": "repoGetWikiPageRevisions",
  14215. "parameters": [
  14216. {
  14217. "type": "string",
  14218. "description": "owner of the repo",
  14219. "name": "owner",
  14220. "in": "path",
  14221. "required": true
  14222. },
  14223. {
  14224. "type": "string",
  14225. "description": "name of the repo",
  14226. "name": "repo",
  14227. "in": "path",
  14228. "required": true
  14229. },
  14230. {
  14231. "type": "string",
  14232. "description": "name of the page",
  14233. "name": "pageName",
  14234. "in": "path",
  14235. "required": true
  14236. },
  14237. {
  14238. "type": "integer",
  14239. "description": "page number of results to return (1-based)",
  14240. "name": "page",
  14241. "in": "query"
  14242. }
  14243. ],
  14244. "responses": {
  14245. "200": {
  14246. "$ref": "#/responses/WikiCommitList"
  14247. },
  14248. "404": {
  14249. "$ref": "#/responses/notFound"
  14250. }
  14251. }
  14252. }
  14253. },
  14254. "/repos/{template_owner}/{template_repo}/generate": {
  14255. "post": {
  14256. "consumes": [
  14257. "application/json"
  14258. ],
  14259. "produces": [
  14260. "application/json"
  14261. ],
  14262. "tags": [
  14263. "repository"
  14264. ],
  14265. "summary": "Create a repository using a template",
  14266. "operationId": "generateRepo",
  14267. "parameters": [
  14268. {
  14269. "type": "string",
  14270. "description": "name of the template repository owner",
  14271. "name": "template_owner",
  14272. "in": "path",
  14273. "required": true
  14274. },
  14275. {
  14276. "type": "string",
  14277. "description": "name of the template repository",
  14278. "name": "template_repo",
  14279. "in": "path",
  14280. "required": true
  14281. },
  14282. {
  14283. "name": "body",
  14284. "in": "body",
  14285. "schema": {
  14286. "$ref": "#/definitions/GenerateRepoOption"
  14287. }
  14288. }
  14289. ],
  14290. "responses": {
  14291. "201": {
  14292. "$ref": "#/responses/Repository"
  14293. },
  14294. "403": {
  14295. "$ref": "#/responses/forbidden"
  14296. },
  14297. "404": {
  14298. "$ref": "#/responses/notFound"
  14299. },
  14300. "409": {
  14301. "description": "The repository with the same name already exists."
  14302. },
  14303. "422": {
  14304. "$ref": "#/responses/validationError"
  14305. }
  14306. }
  14307. }
  14308. },
  14309. "/repositories/{id}": {
  14310. "get": {
  14311. "produces": [
  14312. "application/json"
  14313. ],
  14314. "tags": [
  14315. "repository"
  14316. ],
  14317. "summary": "Get a repository by id",
  14318. "operationId": "repoGetByID",
  14319. "parameters": [
  14320. {
  14321. "type": "integer",
  14322. "format": "int64",
  14323. "description": "id of the repo to get",
  14324. "name": "id",
  14325. "in": "path",
  14326. "required": true
  14327. }
  14328. ],
  14329. "responses": {
  14330. "200": {
  14331. "$ref": "#/responses/Repository"
  14332. },
  14333. "404": {
  14334. "$ref": "#/responses/notFound"
  14335. }
  14336. }
  14337. }
  14338. },
  14339. "/settings/api": {
  14340. "get": {
  14341. "produces": [
  14342. "application/json"
  14343. ],
  14344. "tags": [
  14345. "settings"
  14346. ],
  14347. "summary": "Get instance's global settings for api",
  14348. "operationId": "getGeneralAPISettings",
  14349. "responses": {
  14350. "200": {
  14351. "$ref": "#/responses/GeneralAPISettings"
  14352. }
  14353. }
  14354. }
  14355. },
  14356. "/settings/attachment": {
  14357. "get": {
  14358. "produces": [
  14359. "application/json"
  14360. ],
  14361. "tags": [
  14362. "settings"
  14363. ],
  14364. "summary": "Get instance's global settings for Attachment",
  14365. "operationId": "getGeneralAttachmentSettings",
  14366. "responses": {
  14367. "200": {
  14368. "$ref": "#/responses/GeneralAttachmentSettings"
  14369. }
  14370. }
  14371. }
  14372. },
  14373. "/settings/repository": {
  14374. "get": {
  14375. "produces": [
  14376. "application/json"
  14377. ],
  14378. "tags": [
  14379. "settings"
  14380. ],
  14381. "summary": "Get instance's global settings for repositories",
  14382. "operationId": "getGeneralRepositorySettings",
  14383. "responses": {
  14384. "200": {
  14385. "$ref": "#/responses/GeneralRepoSettings"
  14386. }
  14387. }
  14388. }
  14389. },
  14390. "/settings/ui": {
  14391. "get": {
  14392. "produces": [
  14393. "application/json"
  14394. ],
  14395. "tags": [
  14396. "settings"
  14397. ],
  14398. "summary": "Get instance's global settings for ui",
  14399. "operationId": "getGeneralUISettings",
  14400. "responses": {
  14401. "200": {
  14402. "$ref": "#/responses/GeneralUISettings"
  14403. }
  14404. }
  14405. }
  14406. },
  14407. "/signing-key.gpg": {
  14408. "get": {
  14409. "produces": [
  14410. "text/plain"
  14411. ],
  14412. "tags": [
  14413. "miscellaneous"
  14414. ],
  14415. "summary": "Get default signing-key.gpg",
  14416. "operationId": "getSigningKey",
  14417. "responses": {
  14418. "200": {
  14419. "description": "GPG armored public key",
  14420. "schema": {
  14421. "type": "string"
  14422. }
  14423. }
  14424. }
  14425. }
  14426. },
  14427. "/teams/{id}": {
  14428. "get": {
  14429. "produces": [
  14430. "application/json"
  14431. ],
  14432. "tags": [
  14433. "organization"
  14434. ],
  14435. "summary": "Get a team",
  14436. "operationId": "orgGetTeam",
  14437. "parameters": [
  14438. {
  14439. "type": "integer",
  14440. "format": "int64",
  14441. "description": "id of the team to get",
  14442. "name": "id",
  14443. "in": "path",
  14444. "required": true
  14445. }
  14446. ],
  14447. "responses": {
  14448. "200": {
  14449. "$ref": "#/responses/Team"
  14450. },
  14451. "404": {
  14452. "$ref": "#/responses/notFound"
  14453. }
  14454. }
  14455. },
  14456. "delete": {
  14457. "tags": [
  14458. "organization"
  14459. ],
  14460. "summary": "Delete a team",
  14461. "operationId": "orgDeleteTeam",
  14462. "parameters": [
  14463. {
  14464. "type": "integer",
  14465. "format": "int64",
  14466. "description": "id of the team to delete",
  14467. "name": "id",
  14468. "in": "path",
  14469. "required": true
  14470. }
  14471. ],
  14472. "responses": {
  14473. "204": {
  14474. "description": "team deleted"
  14475. },
  14476. "404": {
  14477. "$ref": "#/responses/notFound"
  14478. }
  14479. }
  14480. },
  14481. "patch": {
  14482. "consumes": [
  14483. "application/json"
  14484. ],
  14485. "produces": [
  14486. "application/json"
  14487. ],
  14488. "tags": [
  14489. "organization"
  14490. ],
  14491. "summary": "Edit a team",
  14492. "operationId": "orgEditTeam",
  14493. "parameters": [
  14494. {
  14495. "type": "integer",
  14496. "description": "id of the team to edit",
  14497. "name": "id",
  14498. "in": "path",
  14499. "required": true
  14500. },
  14501. {
  14502. "name": "body",
  14503. "in": "body",
  14504. "schema": {
  14505. "$ref": "#/definitions/EditTeamOption"
  14506. }
  14507. }
  14508. ],
  14509. "responses": {
  14510. "200": {
  14511. "$ref": "#/responses/Team"
  14512. },
  14513. "404": {
  14514. "$ref": "#/responses/notFound"
  14515. }
  14516. }
  14517. }
  14518. },
  14519. "/teams/{id}/activities/feeds": {
  14520. "get": {
  14521. "produces": [
  14522. "application/json"
  14523. ],
  14524. "tags": [
  14525. "organization"
  14526. ],
  14527. "summary": "List a team's activity feeds",
  14528. "operationId": "orgListTeamActivityFeeds",
  14529. "parameters": [
  14530. {
  14531. "type": "integer",
  14532. "format": "int64",
  14533. "description": "id of the team",
  14534. "name": "id",
  14535. "in": "path",
  14536. "required": true
  14537. },
  14538. {
  14539. "type": "string",
  14540. "format": "date",
  14541. "description": "the date of the activities to be found",
  14542. "name": "date",
  14543. "in": "query"
  14544. },
  14545. {
  14546. "type": "integer",
  14547. "description": "page number of results to return (1-based)",
  14548. "name": "page",
  14549. "in": "query"
  14550. },
  14551. {
  14552. "type": "integer",
  14553. "description": "page size of results",
  14554. "name": "limit",
  14555. "in": "query"
  14556. }
  14557. ],
  14558. "responses": {
  14559. "200": {
  14560. "$ref": "#/responses/ActivityFeedsList"
  14561. },
  14562. "404": {
  14563. "$ref": "#/responses/notFound"
  14564. }
  14565. }
  14566. }
  14567. },
  14568. "/teams/{id}/members": {
  14569. "get": {
  14570. "produces": [
  14571. "application/json"
  14572. ],
  14573. "tags": [
  14574. "organization"
  14575. ],
  14576. "summary": "List a team's members",
  14577. "operationId": "orgListTeamMembers",
  14578. "parameters": [
  14579. {
  14580. "type": "integer",
  14581. "format": "int64",
  14582. "description": "id of the team",
  14583. "name": "id",
  14584. "in": "path",
  14585. "required": true
  14586. },
  14587. {
  14588. "type": "integer",
  14589. "description": "page number of results to return (1-based)",
  14590. "name": "page",
  14591. "in": "query"
  14592. },
  14593. {
  14594. "type": "integer",
  14595. "description": "page size of results",
  14596. "name": "limit",
  14597. "in": "query"
  14598. }
  14599. ],
  14600. "responses": {
  14601. "200": {
  14602. "$ref": "#/responses/UserList"
  14603. },
  14604. "404": {
  14605. "$ref": "#/responses/notFound"
  14606. }
  14607. }
  14608. }
  14609. },
  14610. "/teams/{id}/members/{username}": {
  14611. "get": {
  14612. "produces": [
  14613. "application/json"
  14614. ],
  14615. "tags": [
  14616. "organization"
  14617. ],
  14618. "summary": "List a particular member of team",
  14619. "operationId": "orgListTeamMember",
  14620. "parameters": [
  14621. {
  14622. "type": "integer",
  14623. "format": "int64",
  14624. "description": "id of the team",
  14625. "name": "id",
  14626. "in": "path",
  14627. "required": true
  14628. },
  14629. {
  14630. "type": "string",
  14631. "description": "username of the member to list",
  14632. "name": "username",
  14633. "in": "path",
  14634. "required": true
  14635. }
  14636. ],
  14637. "responses": {
  14638. "200": {
  14639. "$ref": "#/responses/User"
  14640. },
  14641. "404": {
  14642. "$ref": "#/responses/notFound"
  14643. }
  14644. }
  14645. },
  14646. "put": {
  14647. "produces": [
  14648. "application/json"
  14649. ],
  14650. "tags": [
  14651. "organization"
  14652. ],
  14653. "summary": "Add a team member",
  14654. "operationId": "orgAddTeamMember",
  14655. "parameters": [
  14656. {
  14657. "type": "integer",
  14658. "format": "int64",
  14659. "description": "id of the team",
  14660. "name": "id",
  14661. "in": "path",
  14662. "required": true
  14663. },
  14664. {
  14665. "type": "string",
  14666. "description": "username of the user to add",
  14667. "name": "username",
  14668. "in": "path",
  14669. "required": true
  14670. }
  14671. ],
  14672. "responses": {
  14673. "204": {
  14674. "$ref": "#/responses/empty"
  14675. },
  14676. "403": {
  14677. "$ref": "#/responses/forbidden"
  14678. },
  14679. "404": {
  14680. "$ref": "#/responses/notFound"
  14681. }
  14682. }
  14683. },
  14684. "delete": {
  14685. "produces": [
  14686. "application/json"
  14687. ],
  14688. "tags": [
  14689. "organization"
  14690. ],
  14691. "summary": "Remove a team member",
  14692. "operationId": "orgRemoveTeamMember",
  14693. "parameters": [
  14694. {
  14695. "type": "integer",
  14696. "format": "int64",
  14697. "description": "id of the team",
  14698. "name": "id",
  14699. "in": "path",
  14700. "required": true
  14701. },
  14702. {
  14703. "type": "string",
  14704. "description": "username of the user to remove",
  14705. "name": "username",
  14706. "in": "path",
  14707. "required": true
  14708. }
  14709. ],
  14710. "responses": {
  14711. "204": {
  14712. "$ref": "#/responses/empty"
  14713. },
  14714. "404": {
  14715. "$ref": "#/responses/notFound"
  14716. }
  14717. }
  14718. }
  14719. },
  14720. "/teams/{id}/repos": {
  14721. "get": {
  14722. "produces": [
  14723. "application/json"
  14724. ],
  14725. "tags": [
  14726. "organization"
  14727. ],
  14728. "summary": "List a team's repos",
  14729. "operationId": "orgListTeamRepos",
  14730. "parameters": [
  14731. {
  14732. "type": "integer",
  14733. "format": "int64",
  14734. "description": "id of the team",
  14735. "name": "id",
  14736. "in": "path",
  14737. "required": true
  14738. },
  14739. {
  14740. "type": "integer",
  14741. "description": "page number of results to return (1-based)",
  14742. "name": "page",
  14743. "in": "query"
  14744. },
  14745. {
  14746. "type": "integer",
  14747. "description": "page size of results",
  14748. "name": "limit",
  14749. "in": "query"
  14750. }
  14751. ],
  14752. "responses": {
  14753. "200": {
  14754. "$ref": "#/responses/RepositoryList"
  14755. },
  14756. "404": {
  14757. "$ref": "#/responses/notFound"
  14758. }
  14759. }
  14760. }
  14761. },
  14762. "/teams/{id}/repos/{org}/{repo}": {
  14763. "get": {
  14764. "produces": [
  14765. "application/json"
  14766. ],
  14767. "tags": [
  14768. "organization"
  14769. ],
  14770. "summary": "List a particular repo of team",
  14771. "operationId": "orgListTeamRepo",
  14772. "parameters": [
  14773. {
  14774. "type": "integer",
  14775. "format": "int64",
  14776. "description": "id of the team",
  14777. "name": "id",
  14778. "in": "path",
  14779. "required": true
  14780. },
  14781. {
  14782. "type": "string",
  14783. "description": "organization that owns the repo to list",
  14784. "name": "org",
  14785. "in": "path",
  14786. "required": true
  14787. },
  14788. {
  14789. "type": "string",
  14790. "description": "name of the repo to list",
  14791. "name": "repo",
  14792. "in": "path",
  14793. "required": true
  14794. }
  14795. ],
  14796. "responses": {
  14797. "200": {
  14798. "$ref": "#/responses/Repository"
  14799. },
  14800. "404": {
  14801. "$ref": "#/responses/notFound"
  14802. }
  14803. }
  14804. },
  14805. "put": {
  14806. "produces": [
  14807. "application/json"
  14808. ],
  14809. "tags": [
  14810. "organization"
  14811. ],
  14812. "summary": "Add a repository to a team",
  14813. "operationId": "orgAddTeamRepository",
  14814. "parameters": [
  14815. {
  14816. "type": "integer",
  14817. "format": "int64",
  14818. "description": "id of the team",
  14819. "name": "id",
  14820. "in": "path",
  14821. "required": true
  14822. },
  14823. {
  14824. "type": "string",
  14825. "description": "organization that owns the repo to add",
  14826. "name": "org",
  14827. "in": "path",
  14828. "required": true
  14829. },
  14830. {
  14831. "type": "string",
  14832. "description": "name of the repo to add",
  14833. "name": "repo",
  14834. "in": "path",
  14835. "required": true
  14836. }
  14837. ],
  14838. "responses": {
  14839. "204": {
  14840. "$ref": "#/responses/empty"
  14841. },
  14842. "403": {
  14843. "$ref": "#/responses/forbidden"
  14844. },
  14845. "404": {
  14846. "$ref": "#/responses/notFound"
  14847. }
  14848. }
  14849. },
  14850. "delete": {
  14851. "description": "This does not delete the repository, it only removes the repository from the team.",
  14852. "produces": [
  14853. "application/json"
  14854. ],
  14855. "tags": [
  14856. "organization"
  14857. ],
  14858. "summary": "Remove a repository from a team",
  14859. "operationId": "orgRemoveTeamRepository",
  14860. "parameters": [
  14861. {
  14862. "type": "integer",
  14863. "format": "int64",
  14864. "description": "id of the team",
  14865. "name": "id",
  14866. "in": "path",
  14867. "required": true
  14868. },
  14869. {
  14870. "type": "string",
  14871. "description": "organization that owns the repo to remove",
  14872. "name": "org",
  14873. "in": "path",
  14874. "required": true
  14875. },
  14876. {
  14877. "type": "string",
  14878. "description": "name of the repo to remove",
  14879. "name": "repo",
  14880. "in": "path",
  14881. "required": true
  14882. }
  14883. ],
  14884. "responses": {
  14885. "204": {
  14886. "$ref": "#/responses/empty"
  14887. },
  14888. "403": {
  14889. "$ref": "#/responses/forbidden"
  14890. },
  14891. "404": {
  14892. "$ref": "#/responses/notFound"
  14893. }
  14894. }
  14895. }
  14896. },
  14897. "/topics/search": {
  14898. "get": {
  14899. "produces": [
  14900. "application/json"
  14901. ],
  14902. "tags": [
  14903. "repository"
  14904. ],
  14905. "summary": "search topics via keyword",
  14906. "operationId": "topicSearch",
  14907. "parameters": [
  14908. {
  14909. "type": "string",
  14910. "description": "keywords to search",
  14911. "name": "q",
  14912. "in": "query",
  14913. "required": true
  14914. },
  14915. {
  14916. "type": "integer",
  14917. "description": "page number of results to return (1-based)",
  14918. "name": "page",
  14919. "in": "query"
  14920. },
  14921. {
  14922. "type": "integer",
  14923. "description": "page size of results",
  14924. "name": "limit",
  14925. "in": "query"
  14926. }
  14927. ],
  14928. "responses": {
  14929. "200": {
  14930. "$ref": "#/responses/TopicListResponse"
  14931. },
  14932. "403": {
  14933. "$ref": "#/responses/forbidden"
  14934. },
  14935. "404": {
  14936. "$ref": "#/responses/notFound"
  14937. }
  14938. }
  14939. }
  14940. },
  14941. "/user": {
  14942. "get": {
  14943. "produces": [
  14944. "application/json"
  14945. ],
  14946. "tags": [
  14947. "user"
  14948. ],
  14949. "summary": "Get the authenticated user",
  14950. "operationId": "userGetCurrent",
  14951. "responses": {
  14952. "200": {
  14953. "$ref": "#/responses/User"
  14954. }
  14955. }
  14956. }
  14957. },
  14958. "/user/actions/runners/registration-token": {
  14959. "get": {
  14960. "produces": [
  14961. "application/json"
  14962. ],
  14963. "tags": [
  14964. "user"
  14965. ],
  14966. "summary": "Get an user's actions runner registration token",
  14967. "operationId": "userGetRunnerRegistrationToken",
  14968. "responses": {
  14969. "200": {
  14970. "$ref": "#/responses/RegistrationToken"
  14971. }
  14972. }
  14973. }
  14974. },
  14975. "/user/actions/secrets/{secretname}": {
  14976. "put": {
  14977. "consumes": [
  14978. "application/json"
  14979. ],
  14980. "produces": [
  14981. "application/json"
  14982. ],
  14983. "tags": [
  14984. "user"
  14985. ],
  14986. "summary": "Create or Update a secret value in a user scope",
  14987. "operationId": "updateUserSecret",
  14988. "parameters": [
  14989. {
  14990. "type": "string",
  14991. "description": "name of the secret",
  14992. "name": "secretname",
  14993. "in": "path",
  14994. "required": true
  14995. },
  14996. {
  14997. "name": "body",
  14998. "in": "body",
  14999. "schema": {
  15000. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  15001. }
  15002. }
  15003. ],
  15004. "responses": {
  15005. "201": {
  15006. "description": "response when creating a secret"
  15007. },
  15008. "204": {
  15009. "description": "response when updating a secret"
  15010. },
  15011. "400": {
  15012. "$ref": "#/responses/error"
  15013. },
  15014. "404": {
  15015. "$ref": "#/responses/notFound"
  15016. }
  15017. }
  15018. },
  15019. "delete": {
  15020. "consumes": [
  15021. "application/json"
  15022. ],
  15023. "produces": [
  15024. "application/json"
  15025. ],
  15026. "tags": [
  15027. "user"
  15028. ],
  15029. "summary": "Delete a secret in a user scope",
  15030. "operationId": "deleteUserSecret",
  15031. "parameters": [
  15032. {
  15033. "type": "string",
  15034. "description": "name of the secret",
  15035. "name": "secretname",
  15036. "in": "path",
  15037. "required": true
  15038. }
  15039. ],
  15040. "responses": {
  15041. "204": {
  15042. "description": "delete one secret of the user"
  15043. },
  15044. "400": {
  15045. "$ref": "#/responses/error"
  15046. },
  15047. "404": {
  15048. "$ref": "#/responses/notFound"
  15049. }
  15050. }
  15051. }
  15052. },
  15053. "/user/applications/oauth2": {
  15054. "get": {
  15055. "produces": [
  15056. "application/json"
  15057. ],
  15058. "tags": [
  15059. "user"
  15060. ],
  15061. "summary": "List the authenticated user's oauth2 applications",
  15062. "operationId": "userGetOauth2Application",
  15063. "parameters": [
  15064. {
  15065. "type": "integer",
  15066. "description": "page number of results to return (1-based)",
  15067. "name": "page",
  15068. "in": "query"
  15069. },
  15070. {
  15071. "type": "integer",
  15072. "description": "page size of results",
  15073. "name": "limit",
  15074. "in": "query"
  15075. }
  15076. ],
  15077. "responses": {
  15078. "200": {
  15079. "$ref": "#/responses/OAuth2ApplicationList"
  15080. }
  15081. }
  15082. },
  15083. "post": {
  15084. "produces": [
  15085. "application/json"
  15086. ],
  15087. "tags": [
  15088. "user"
  15089. ],
  15090. "summary": "creates a new OAuth2 application",
  15091. "operationId": "userCreateOAuth2Application",
  15092. "parameters": [
  15093. {
  15094. "name": "body",
  15095. "in": "body",
  15096. "required": true,
  15097. "schema": {
  15098. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  15099. }
  15100. }
  15101. ],
  15102. "responses": {
  15103. "201": {
  15104. "$ref": "#/responses/OAuth2Application"
  15105. },
  15106. "400": {
  15107. "$ref": "#/responses/error"
  15108. }
  15109. }
  15110. }
  15111. },
  15112. "/user/applications/oauth2/{id}": {
  15113. "get": {
  15114. "produces": [
  15115. "application/json"
  15116. ],
  15117. "tags": [
  15118. "user"
  15119. ],
  15120. "summary": "get an OAuth2 Application",
  15121. "operationId": "userGetOAuth2Application",
  15122. "parameters": [
  15123. {
  15124. "type": "integer",
  15125. "format": "int64",
  15126. "description": "Application ID to be found",
  15127. "name": "id",
  15128. "in": "path",
  15129. "required": true
  15130. }
  15131. ],
  15132. "responses": {
  15133. "200": {
  15134. "$ref": "#/responses/OAuth2Application"
  15135. },
  15136. "404": {
  15137. "$ref": "#/responses/notFound"
  15138. }
  15139. }
  15140. },
  15141. "delete": {
  15142. "produces": [
  15143. "application/json"
  15144. ],
  15145. "tags": [
  15146. "user"
  15147. ],
  15148. "summary": "delete an OAuth2 Application",
  15149. "operationId": "userDeleteOAuth2Application",
  15150. "parameters": [
  15151. {
  15152. "type": "integer",
  15153. "format": "int64",
  15154. "description": "token to be deleted",
  15155. "name": "id",
  15156. "in": "path",
  15157. "required": true
  15158. }
  15159. ],
  15160. "responses": {
  15161. "204": {
  15162. "$ref": "#/responses/empty"
  15163. },
  15164. "404": {
  15165. "$ref": "#/responses/notFound"
  15166. }
  15167. }
  15168. },
  15169. "patch": {
  15170. "produces": [
  15171. "application/json"
  15172. ],
  15173. "tags": [
  15174. "user"
  15175. ],
  15176. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  15177. "operationId": "userUpdateOAuth2Application",
  15178. "parameters": [
  15179. {
  15180. "type": "integer",
  15181. "format": "int64",
  15182. "description": "application to be updated",
  15183. "name": "id",
  15184. "in": "path",
  15185. "required": true
  15186. },
  15187. {
  15188. "name": "body",
  15189. "in": "body",
  15190. "required": true,
  15191. "schema": {
  15192. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  15193. }
  15194. }
  15195. ],
  15196. "responses": {
  15197. "200": {
  15198. "$ref": "#/responses/OAuth2Application"
  15199. },
  15200. "404": {
  15201. "$ref": "#/responses/notFound"
  15202. }
  15203. }
  15204. }
  15205. },
  15206. "/user/avatar": {
  15207. "post": {
  15208. "produces": [
  15209. "application/json"
  15210. ],
  15211. "tags": [
  15212. "user"
  15213. ],
  15214. "summary": "Update Avatar",
  15215. "operationId": "userUpdateAvatar",
  15216. "parameters": [
  15217. {
  15218. "name": "body",
  15219. "in": "body",
  15220. "schema": {
  15221. "$ref": "#/definitions/UpdateUserAvatarOption"
  15222. }
  15223. }
  15224. ],
  15225. "responses": {
  15226. "204": {
  15227. "$ref": "#/responses/empty"
  15228. }
  15229. }
  15230. },
  15231. "delete": {
  15232. "produces": [
  15233. "application/json"
  15234. ],
  15235. "tags": [
  15236. "user"
  15237. ],
  15238. "summary": "Delete Avatar",
  15239. "operationId": "userDeleteAvatar",
  15240. "responses": {
  15241. "204": {
  15242. "$ref": "#/responses/empty"
  15243. }
  15244. }
  15245. }
  15246. },
  15247. "/user/blocks": {
  15248. "get": {
  15249. "produces": [
  15250. "application/json"
  15251. ],
  15252. "tags": [
  15253. "user"
  15254. ],
  15255. "summary": "List users blocked by the authenticated user",
  15256. "operationId": "userListBlocks",
  15257. "parameters": [
  15258. {
  15259. "type": "integer",
  15260. "description": "page number of results to return (1-based)",
  15261. "name": "page",
  15262. "in": "query"
  15263. },
  15264. {
  15265. "type": "integer",
  15266. "description": "page size of results",
  15267. "name": "limit",
  15268. "in": "query"
  15269. }
  15270. ],
  15271. "responses": {
  15272. "200": {
  15273. "$ref": "#/responses/UserList"
  15274. }
  15275. }
  15276. }
  15277. },
  15278. "/user/blocks/{username}": {
  15279. "get": {
  15280. "tags": [
  15281. "user"
  15282. ],
  15283. "summary": "Check if a user is blocked by the authenticated user",
  15284. "operationId": "userCheckUserBlock",
  15285. "parameters": [
  15286. {
  15287. "type": "string",
  15288. "description": "user to check",
  15289. "name": "username",
  15290. "in": "path",
  15291. "required": true
  15292. }
  15293. ],
  15294. "responses": {
  15295. "204": {
  15296. "$ref": "#/responses/empty"
  15297. },
  15298. "404": {
  15299. "$ref": "#/responses/notFound"
  15300. }
  15301. }
  15302. },
  15303. "put": {
  15304. "tags": [
  15305. "user"
  15306. ],
  15307. "summary": "Block a user",
  15308. "operationId": "userBlockUser",
  15309. "parameters": [
  15310. {
  15311. "type": "string",
  15312. "description": "user to block",
  15313. "name": "username",
  15314. "in": "path",
  15315. "required": true
  15316. },
  15317. {
  15318. "type": "string",
  15319. "description": "optional note for the block",
  15320. "name": "note",
  15321. "in": "query"
  15322. }
  15323. ],
  15324. "responses": {
  15325. "204": {
  15326. "$ref": "#/responses/empty"
  15327. },
  15328. "404": {
  15329. "$ref": "#/responses/notFound"
  15330. },
  15331. "422": {
  15332. "$ref": "#/responses/validationError"
  15333. }
  15334. }
  15335. },
  15336. "delete": {
  15337. "tags": [
  15338. "user"
  15339. ],
  15340. "summary": "Unblock a user",
  15341. "operationId": "userUnblockUser",
  15342. "parameters": [
  15343. {
  15344. "type": "string",
  15345. "description": "user to unblock",
  15346. "name": "username",
  15347. "in": "path",
  15348. "required": true
  15349. }
  15350. ],
  15351. "responses": {
  15352. "204": {
  15353. "$ref": "#/responses/empty"
  15354. },
  15355. "404": {
  15356. "$ref": "#/responses/notFound"
  15357. },
  15358. "422": {
  15359. "$ref": "#/responses/validationError"
  15360. }
  15361. }
  15362. }
  15363. },
  15364. "/user/emails": {
  15365. "get": {
  15366. "produces": [
  15367. "application/json"
  15368. ],
  15369. "tags": [
  15370. "user"
  15371. ],
  15372. "summary": "List the authenticated user's email addresses",
  15373. "operationId": "userListEmails",
  15374. "responses": {
  15375. "200": {
  15376. "$ref": "#/responses/EmailList"
  15377. }
  15378. }
  15379. },
  15380. "post": {
  15381. "produces": [
  15382. "application/json"
  15383. ],
  15384. "tags": [
  15385. "user"
  15386. ],
  15387. "summary": "Add email addresses",
  15388. "operationId": "userAddEmail",
  15389. "parameters": [
  15390. {
  15391. "name": "body",
  15392. "in": "body",
  15393. "schema": {
  15394. "$ref": "#/definitions/CreateEmailOption"
  15395. }
  15396. }
  15397. ],
  15398. "responses": {
  15399. "201": {
  15400. "$ref": "#/responses/EmailList"
  15401. },
  15402. "422": {
  15403. "$ref": "#/responses/validationError"
  15404. }
  15405. }
  15406. },
  15407. "delete": {
  15408. "produces": [
  15409. "application/json"
  15410. ],
  15411. "tags": [
  15412. "user"
  15413. ],
  15414. "summary": "Delete email addresses",
  15415. "operationId": "userDeleteEmail",
  15416. "parameters": [
  15417. {
  15418. "name": "body",
  15419. "in": "body",
  15420. "schema": {
  15421. "$ref": "#/definitions/DeleteEmailOption"
  15422. }
  15423. }
  15424. ],
  15425. "responses": {
  15426. "204": {
  15427. "$ref": "#/responses/empty"
  15428. },
  15429. "404": {
  15430. "$ref": "#/responses/notFound"
  15431. }
  15432. }
  15433. }
  15434. },
  15435. "/user/followers": {
  15436. "get": {
  15437. "produces": [
  15438. "application/json"
  15439. ],
  15440. "tags": [
  15441. "user"
  15442. ],
  15443. "summary": "List the authenticated user's followers",
  15444. "operationId": "userCurrentListFollowers",
  15445. "parameters": [
  15446. {
  15447. "type": "integer",
  15448. "description": "page number of results to return (1-based)",
  15449. "name": "page",
  15450. "in": "query"
  15451. },
  15452. {
  15453. "type": "integer",
  15454. "description": "page size of results",
  15455. "name": "limit",
  15456. "in": "query"
  15457. }
  15458. ],
  15459. "responses": {
  15460. "200": {
  15461. "$ref": "#/responses/UserList"
  15462. }
  15463. }
  15464. }
  15465. },
  15466. "/user/following": {
  15467. "get": {
  15468. "produces": [
  15469. "application/json"
  15470. ],
  15471. "tags": [
  15472. "user"
  15473. ],
  15474. "summary": "List the users that the authenticated user is following",
  15475. "operationId": "userCurrentListFollowing",
  15476. "parameters": [
  15477. {
  15478. "type": "integer",
  15479. "description": "page number of results to return (1-based)",
  15480. "name": "page",
  15481. "in": "query"
  15482. },
  15483. {
  15484. "type": "integer",
  15485. "description": "page size of results",
  15486. "name": "limit",
  15487. "in": "query"
  15488. }
  15489. ],
  15490. "responses": {
  15491. "200": {
  15492. "$ref": "#/responses/UserList"
  15493. }
  15494. }
  15495. }
  15496. },
  15497. "/user/following/{username}": {
  15498. "get": {
  15499. "tags": [
  15500. "user"
  15501. ],
  15502. "summary": "Check whether a user is followed by the authenticated user",
  15503. "operationId": "userCurrentCheckFollowing",
  15504. "parameters": [
  15505. {
  15506. "type": "string",
  15507. "description": "username of followed user",
  15508. "name": "username",
  15509. "in": "path",
  15510. "required": true
  15511. }
  15512. ],
  15513. "responses": {
  15514. "204": {
  15515. "$ref": "#/responses/empty"
  15516. },
  15517. "404": {
  15518. "$ref": "#/responses/notFound"
  15519. }
  15520. }
  15521. },
  15522. "put": {
  15523. "tags": [
  15524. "user"
  15525. ],
  15526. "summary": "Follow a user",
  15527. "operationId": "userCurrentPutFollow",
  15528. "parameters": [
  15529. {
  15530. "type": "string",
  15531. "description": "username of user to follow",
  15532. "name": "username",
  15533. "in": "path",
  15534. "required": true
  15535. }
  15536. ],
  15537. "responses": {
  15538. "204": {
  15539. "$ref": "#/responses/empty"
  15540. },
  15541. "403": {
  15542. "$ref": "#/responses/forbidden"
  15543. },
  15544. "404": {
  15545. "$ref": "#/responses/notFound"
  15546. }
  15547. }
  15548. },
  15549. "delete": {
  15550. "tags": [
  15551. "user"
  15552. ],
  15553. "summary": "Unfollow a user",
  15554. "operationId": "userCurrentDeleteFollow",
  15555. "parameters": [
  15556. {
  15557. "type": "string",
  15558. "description": "username of user to unfollow",
  15559. "name": "username",
  15560. "in": "path",
  15561. "required": true
  15562. }
  15563. ],
  15564. "responses": {
  15565. "204": {
  15566. "$ref": "#/responses/empty"
  15567. },
  15568. "404": {
  15569. "$ref": "#/responses/notFound"
  15570. }
  15571. }
  15572. }
  15573. },
  15574. "/user/gpg_key_token": {
  15575. "get": {
  15576. "produces": [
  15577. "text/plain"
  15578. ],
  15579. "tags": [
  15580. "user"
  15581. ],
  15582. "summary": "Get a Token to verify",
  15583. "operationId": "getVerificationToken",
  15584. "responses": {
  15585. "200": {
  15586. "$ref": "#/responses/string"
  15587. },
  15588. "404": {
  15589. "$ref": "#/responses/notFound"
  15590. }
  15591. }
  15592. }
  15593. },
  15594. "/user/gpg_key_verify": {
  15595. "post": {
  15596. "consumes": [
  15597. "application/json"
  15598. ],
  15599. "produces": [
  15600. "application/json"
  15601. ],
  15602. "tags": [
  15603. "user"
  15604. ],
  15605. "summary": "Verify a GPG key",
  15606. "operationId": "userVerifyGPGKey",
  15607. "responses": {
  15608. "201": {
  15609. "$ref": "#/responses/GPGKey"
  15610. },
  15611. "404": {
  15612. "$ref": "#/responses/notFound"
  15613. },
  15614. "422": {
  15615. "$ref": "#/responses/validationError"
  15616. }
  15617. }
  15618. }
  15619. },
  15620. "/user/gpg_keys": {
  15621. "get": {
  15622. "produces": [
  15623. "application/json"
  15624. ],
  15625. "tags": [
  15626. "user"
  15627. ],
  15628. "summary": "List the authenticated user's GPG keys",
  15629. "operationId": "userCurrentListGPGKeys",
  15630. "parameters": [
  15631. {
  15632. "type": "integer",
  15633. "description": "page number of results to return (1-based)",
  15634. "name": "page",
  15635. "in": "query"
  15636. },
  15637. {
  15638. "type": "integer",
  15639. "description": "page size of results",
  15640. "name": "limit",
  15641. "in": "query"
  15642. }
  15643. ],
  15644. "responses": {
  15645. "200": {
  15646. "$ref": "#/responses/GPGKeyList"
  15647. }
  15648. }
  15649. },
  15650. "post": {
  15651. "consumes": [
  15652. "application/json"
  15653. ],
  15654. "produces": [
  15655. "application/json"
  15656. ],
  15657. "tags": [
  15658. "user"
  15659. ],
  15660. "summary": "Create a GPG key",
  15661. "operationId": "userCurrentPostGPGKey",
  15662. "parameters": [
  15663. {
  15664. "name": "Form",
  15665. "in": "body",
  15666. "schema": {
  15667. "$ref": "#/definitions/CreateGPGKeyOption"
  15668. }
  15669. }
  15670. ],
  15671. "responses": {
  15672. "201": {
  15673. "$ref": "#/responses/GPGKey"
  15674. },
  15675. "404": {
  15676. "$ref": "#/responses/notFound"
  15677. },
  15678. "422": {
  15679. "$ref": "#/responses/validationError"
  15680. }
  15681. }
  15682. }
  15683. },
  15684. "/user/gpg_keys/{id}": {
  15685. "get": {
  15686. "produces": [
  15687. "application/json"
  15688. ],
  15689. "tags": [
  15690. "user"
  15691. ],
  15692. "summary": "Get a GPG key",
  15693. "operationId": "userCurrentGetGPGKey",
  15694. "parameters": [
  15695. {
  15696. "type": "integer",
  15697. "format": "int64",
  15698. "description": "id of key to get",
  15699. "name": "id",
  15700. "in": "path",
  15701. "required": true
  15702. }
  15703. ],
  15704. "responses": {
  15705. "200": {
  15706. "$ref": "#/responses/GPGKey"
  15707. },
  15708. "404": {
  15709. "$ref": "#/responses/notFound"
  15710. }
  15711. }
  15712. },
  15713. "delete": {
  15714. "produces": [
  15715. "application/json"
  15716. ],
  15717. "tags": [
  15718. "user"
  15719. ],
  15720. "summary": "Remove a GPG key",
  15721. "operationId": "userCurrentDeleteGPGKey",
  15722. "parameters": [
  15723. {
  15724. "type": "integer",
  15725. "format": "int64",
  15726. "description": "id of key to delete",
  15727. "name": "id",
  15728. "in": "path",
  15729. "required": true
  15730. }
  15731. ],
  15732. "responses": {
  15733. "204": {
  15734. "$ref": "#/responses/empty"
  15735. },
  15736. "403": {
  15737. "$ref": "#/responses/forbidden"
  15738. },
  15739. "404": {
  15740. "$ref": "#/responses/notFound"
  15741. }
  15742. }
  15743. }
  15744. },
  15745. "/user/hooks": {
  15746. "get": {
  15747. "produces": [
  15748. "application/json"
  15749. ],
  15750. "tags": [
  15751. "user"
  15752. ],
  15753. "summary": "List the authenticated user's webhooks",
  15754. "operationId": "userListHooks",
  15755. "parameters": [
  15756. {
  15757. "type": "integer",
  15758. "description": "page number of results to return (1-based)",
  15759. "name": "page",
  15760. "in": "query"
  15761. },
  15762. {
  15763. "type": "integer",
  15764. "description": "page size of results",
  15765. "name": "limit",
  15766. "in": "query"
  15767. }
  15768. ],
  15769. "responses": {
  15770. "200": {
  15771. "$ref": "#/responses/HookList"
  15772. }
  15773. }
  15774. },
  15775. "post": {
  15776. "consumes": [
  15777. "application/json"
  15778. ],
  15779. "produces": [
  15780. "application/json"
  15781. ],
  15782. "tags": [
  15783. "user"
  15784. ],
  15785. "summary": "Create a hook",
  15786. "operationId": "userCreateHook",
  15787. "parameters": [
  15788. {
  15789. "name": "body",
  15790. "in": "body",
  15791. "required": true,
  15792. "schema": {
  15793. "$ref": "#/definitions/CreateHookOption"
  15794. }
  15795. }
  15796. ],
  15797. "responses": {
  15798. "201": {
  15799. "$ref": "#/responses/Hook"
  15800. }
  15801. }
  15802. }
  15803. },
  15804. "/user/hooks/{id}": {
  15805. "get": {
  15806. "produces": [
  15807. "application/json"
  15808. ],
  15809. "tags": [
  15810. "user"
  15811. ],
  15812. "summary": "Get a hook",
  15813. "operationId": "userGetHook",
  15814. "parameters": [
  15815. {
  15816. "type": "integer",
  15817. "format": "int64",
  15818. "description": "id of the hook to get",
  15819. "name": "id",
  15820. "in": "path",
  15821. "required": true
  15822. }
  15823. ],
  15824. "responses": {
  15825. "200": {
  15826. "$ref": "#/responses/Hook"
  15827. }
  15828. }
  15829. },
  15830. "delete": {
  15831. "produces": [
  15832. "application/json"
  15833. ],
  15834. "tags": [
  15835. "user"
  15836. ],
  15837. "summary": "Delete a hook",
  15838. "operationId": "userDeleteHook",
  15839. "parameters": [
  15840. {
  15841. "type": "integer",
  15842. "format": "int64",
  15843. "description": "id of the hook to delete",
  15844. "name": "id",
  15845. "in": "path",
  15846. "required": true
  15847. }
  15848. ],
  15849. "responses": {
  15850. "204": {
  15851. "$ref": "#/responses/empty"
  15852. }
  15853. }
  15854. },
  15855. "patch": {
  15856. "consumes": [
  15857. "application/json"
  15858. ],
  15859. "produces": [
  15860. "application/json"
  15861. ],
  15862. "tags": [
  15863. "user"
  15864. ],
  15865. "summary": "Update a hook",
  15866. "operationId": "userEditHook",
  15867. "parameters": [
  15868. {
  15869. "type": "integer",
  15870. "format": "int64",
  15871. "description": "id of the hook to update",
  15872. "name": "id",
  15873. "in": "path",
  15874. "required": true
  15875. },
  15876. {
  15877. "name": "body",
  15878. "in": "body",
  15879. "schema": {
  15880. "$ref": "#/definitions/EditHookOption"
  15881. }
  15882. }
  15883. ],
  15884. "responses": {
  15885. "200": {
  15886. "$ref": "#/responses/Hook"
  15887. }
  15888. }
  15889. }
  15890. },
  15891. "/user/keys": {
  15892. "get": {
  15893. "produces": [
  15894. "application/json"
  15895. ],
  15896. "tags": [
  15897. "user"
  15898. ],
  15899. "summary": "List the authenticated user's public keys",
  15900. "operationId": "userCurrentListKeys",
  15901. "parameters": [
  15902. {
  15903. "type": "string",
  15904. "description": "fingerprint of the key",
  15905. "name": "fingerprint",
  15906. "in": "query"
  15907. },
  15908. {
  15909. "type": "integer",
  15910. "description": "page number of results to return (1-based)",
  15911. "name": "page",
  15912. "in": "query"
  15913. },
  15914. {
  15915. "type": "integer",
  15916. "description": "page size of results",
  15917. "name": "limit",
  15918. "in": "query"
  15919. }
  15920. ],
  15921. "responses": {
  15922. "200": {
  15923. "$ref": "#/responses/PublicKeyList"
  15924. }
  15925. }
  15926. },
  15927. "post": {
  15928. "consumes": [
  15929. "application/json"
  15930. ],
  15931. "produces": [
  15932. "application/json"
  15933. ],
  15934. "tags": [
  15935. "user"
  15936. ],
  15937. "summary": "Create a public key",
  15938. "operationId": "userCurrentPostKey",
  15939. "parameters": [
  15940. {
  15941. "name": "body",
  15942. "in": "body",
  15943. "schema": {
  15944. "$ref": "#/definitions/CreateKeyOption"
  15945. }
  15946. }
  15947. ],
  15948. "responses": {
  15949. "201": {
  15950. "$ref": "#/responses/PublicKey"
  15951. },
  15952. "422": {
  15953. "$ref": "#/responses/validationError"
  15954. }
  15955. }
  15956. }
  15957. },
  15958. "/user/keys/{id}": {
  15959. "get": {
  15960. "produces": [
  15961. "application/json"
  15962. ],
  15963. "tags": [
  15964. "user"
  15965. ],
  15966. "summary": "Get a public key",
  15967. "operationId": "userCurrentGetKey",
  15968. "parameters": [
  15969. {
  15970. "type": "integer",
  15971. "format": "int64",
  15972. "description": "id of key to get",
  15973. "name": "id",
  15974. "in": "path",
  15975. "required": true
  15976. }
  15977. ],
  15978. "responses": {
  15979. "200": {
  15980. "$ref": "#/responses/PublicKey"
  15981. },
  15982. "404": {
  15983. "$ref": "#/responses/notFound"
  15984. }
  15985. }
  15986. },
  15987. "delete": {
  15988. "produces": [
  15989. "application/json"
  15990. ],
  15991. "tags": [
  15992. "user"
  15993. ],
  15994. "summary": "Delete a public key",
  15995. "operationId": "userCurrentDeleteKey",
  15996. "parameters": [
  15997. {
  15998. "type": "integer",
  15999. "format": "int64",
  16000. "description": "id of key to delete",
  16001. "name": "id",
  16002. "in": "path",
  16003. "required": true
  16004. }
  16005. ],
  16006. "responses": {
  16007. "204": {
  16008. "$ref": "#/responses/empty"
  16009. },
  16010. "403": {
  16011. "$ref": "#/responses/forbidden"
  16012. },
  16013. "404": {
  16014. "$ref": "#/responses/notFound"
  16015. }
  16016. }
  16017. }
  16018. },
  16019. "/user/orgs": {
  16020. "get": {
  16021. "produces": [
  16022. "application/json"
  16023. ],
  16024. "tags": [
  16025. "organization"
  16026. ],
  16027. "summary": "List the current user's organizations",
  16028. "operationId": "orgListCurrentUserOrgs",
  16029. "parameters": [
  16030. {
  16031. "type": "integer",
  16032. "description": "page number of results to return (1-based)",
  16033. "name": "page",
  16034. "in": "query"
  16035. },
  16036. {
  16037. "type": "integer",
  16038. "description": "page size of results",
  16039. "name": "limit",
  16040. "in": "query"
  16041. }
  16042. ],
  16043. "responses": {
  16044. "200": {
  16045. "$ref": "#/responses/OrganizationList"
  16046. },
  16047. "404": {
  16048. "$ref": "#/responses/notFound"
  16049. }
  16050. }
  16051. }
  16052. },
  16053. "/user/repos": {
  16054. "get": {
  16055. "produces": [
  16056. "application/json"
  16057. ],
  16058. "tags": [
  16059. "user"
  16060. ],
  16061. "summary": "List the repos that the authenticated user owns",
  16062. "operationId": "userCurrentListRepos",
  16063. "parameters": [
  16064. {
  16065. "type": "integer",
  16066. "description": "page number of results to return (1-based)",
  16067. "name": "page",
  16068. "in": "query"
  16069. },
  16070. {
  16071. "type": "integer",
  16072. "description": "page size of results",
  16073. "name": "limit",
  16074. "in": "query"
  16075. }
  16076. ],
  16077. "responses": {
  16078. "200": {
  16079. "$ref": "#/responses/RepositoryList"
  16080. }
  16081. }
  16082. },
  16083. "post": {
  16084. "consumes": [
  16085. "application/json"
  16086. ],
  16087. "produces": [
  16088. "application/json"
  16089. ],
  16090. "tags": [
  16091. "repository",
  16092. "user"
  16093. ],
  16094. "summary": "Create a repository",
  16095. "operationId": "createCurrentUserRepo",
  16096. "parameters": [
  16097. {
  16098. "name": "body",
  16099. "in": "body",
  16100. "schema": {
  16101. "$ref": "#/definitions/CreateRepoOption"
  16102. }
  16103. }
  16104. ],
  16105. "responses": {
  16106. "201": {
  16107. "$ref": "#/responses/Repository"
  16108. },
  16109. "400": {
  16110. "$ref": "#/responses/error"
  16111. },
  16112. "409": {
  16113. "description": "The repository with the same name already exists."
  16114. },
  16115. "422": {
  16116. "$ref": "#/responses/validationError"
  16117. }
  16118. }
  16119. }
  16120. },
  16121. "/user/settings": {
  16122. "get": {
  16123. "produces": [
  16124. "application/json"
  16125. ],
  16126. "tags": [
  16127. "user"
  16128. ],
  16129. "summary": "Get user settings",
  16130. "operationId": "getUserSettings",
  16131. "responses": {
  16132. "200": {
  16133. "$ref": "#/responses/UserSettings"
  16134. }
  16135. }
  16136. },
  16137. "patch": {
  16138. "produces": [
  16139. "application/json"
  16140. ],
  16141. "tags": [
  16142. "user"
  16143. ],
  16144. "summary": "Update user settings",
  16145. "operationId": "updateUserSettings",
  16146. "parameters": [
  16147. {
  16148. "name": "body",
  16149. "in": "body",
  16150. "schema": {
  16151. "$ref": "#/definitions/UserSettingsOptions"
  16152. }
  16153. }
  16154. ],
  16155. "responses": {
  16156. "200": {
  16157. "$ref": "#/responses/UserSettings"
  16158. }
  16159. }
  16160. }
  16161. },
  16162. "/user/starred": {
  16163. "get": {
  16164. "produces": [
  16165. "application/json"
  16166. ],
  16167. "tags": [
  16168. "user"
  16169. ],
  16170. "summary": "The repos that the authenticated user has starred",
  16171. "operationId": "userCurrentListStarred",
  16172. "parameters": [
  16173. {
  16174. "type": "integer",
  16175. "description": "page number of results to return (1-based)",
  16176. "name": "page",
  16177. "in": "query"
  16178. },
  16179. {
  16180. "type": "integer",
  16181. "description": "page size of results",
  16182. "name": "limit",
  16183. "in": "query"
  16184. }
  16185. ],
  16186. "responses": {
  16187. "200": {
  16188. "$ref": "#/responses/RepositoryList"
  16189. }
  16190. }
  16191. }
  16192. },
  16193. "/user/starred/{owner}/{repo}": {
  16194. "get": {
  16195. "tags": [
  16196. "user"
  16197. ],
  16198. "summary": "Whether the authenticated is starring the repo",
  16199. "operationId": "userCurrentCheckStarring",
  16200. "parameters": [
  16201. {
  16202. "type": "string",
  16203. "description": "owner of the repo",
  16204. "name": "owner",
  16205. "in": "path",
  16206. "required": true
  16207. },
  16208. {
  16209. "type": "string",
  16210. "description": "name of the repo",
  16211. "name": "repo",
  16212. "in": "path",
  16213. "required": true
  16214. }
  16215. ],
  16216. "responses": {
  16217. "204": {
  16218. "$ref": "#/responses/empty"
  16219. },
  16220. "404": {
  16221. "$ref": "#/responses/notFound"
  16222. }
  16223. }
  16224. },
  16225. "put": {
  16226. "tags": [
  16227. "user"
  16228. ],
  16229. "summary": "Star the given repo",
  16230. "operationId": "userCurrentPutStar",
  16231. "parameters": [
  16232. {
  16233. "type": "string",
  16234. "description": "owner of the repo to star",
  16235. "name": "owner",
  16236. "in": "path",
  16237. "required": true
  16238. },
  16239. {
  16240. "type": "string",
  16241. "description": "name of the repo to star",
  16242. "name": "repo",
  16243. "in": "path",
  16244. "required": true
  16245. }
  16246. ],
  16247. "responses": {
  16248. "204": {
  16249. "$ref": "#/responses/empty"
  16250. },
  16251. "403": {
  16252. "$ref": "#/responses/forbidden"
  16253. },
  16254. "404": {
  16255. "$ref": "#/responses/notFound"
  16256. }
  16257. }
  16258. },
  16259. "delete": {
  16260. "tags": [
  16261. "user"
  16262. ],
  16263. "summary": "Unstar the given repo",
  16264. "operationId": "userCurrentDeleteStar",
  16265. "parameters": [
  16266. {
  16267. "type": "string",
  16268. "description": "owner of the repo to unstar",
  16269. "name": "owner",
  16270. "in": "path",
  16271. "required": true
  16272. },
  16273. {
  16274. "type": "string",
  16275. "description": "name of the repo to unstar",
  16276. "name": "repo",
  16277. "in": "path",
  16278. "required": true
  16279. }
  16280. ],
  16281. "responses": {
  16282. "204": {
  16283. "$ref": "#/responses/empty"
  16284. },
  16285. "404": {
  16286. "$ref": "#/responses/notFound"
  16287. }
  16288. }
  16289. }
  16290. },
  16291. "/user/stopwatches": {
  16292. "get": {
  16293. "consumes": [
  16294. "application/json"
  16295. ],
  16296. "produces": [
  16297. "application/json"
  16298. ],
  16299. "tags": [
  16300. "user"
  16301. ],
  16302. "summary": "Get list of all existing stopwatches",
  16303. "operationId": "userGetStopWatches",
  16304. "parameters": [
  16305. {
  16306. "type": "integer",
  16307. "description": "page number of results to return (1-based)",
  16308. "name": "page",
  16309. "in": "query"
  16310. },
  16311. {
  16312. "type": "integer",
  16313. "description": "page size of results",
  16314. "name": "limit",
  16315. "in": "query"
  16316. }
  16317. ],
  16318. "responses": {
  16319. "200": {
  16320. "$ref": "#/responses/StopWatchList"
  16321. }
  16322. }
  16323. }
  16324. },
  16325. "/user/subscriptions": {
  16326. "get": {
  16327. "produces": [
  16328. "application/json"
  16329. ],
  16330. "tags": [
  16331. "user"
  16332. ],
  16333. "summary": "List repositories watched by the authenticated user",
  16334. "operationId": "userCurrentListSubscriptions",
  16335. "parameters": [
  16336. {
  16337. "type": "integer",
  16338. "description": "page number of results to return (1-based)",
  16339. "name": "page",
  16340. "in": "query"
  16341. },
  16342. {
  16343. "type": "integer",
  16344. "description": "page size of results",
  16345. "name": "limit",
  16346. "in": "query"
  16347. }
  16348. ],
  16349. "responses": {
  16350. "200": {
  16351. "$ref": "#/responses/RepositoryList"
  16352. }
  16353. }
  16354. }
  16355. },
  16356. "/user/teams": {
  16357. "get": {
  16358. "produces": [
  16359. "application/json"
  16360. ],
  16361. "tags": [
  16362. "user"
  16363. ],
  16364. "summary": "List all the teams a user belongs to",
  16365. "operationId": "userListTeams",
  16366. "parameters": [
  16367. {
  16368. "type": "integer",
  16369. "description": "page number of results to return (1-based)",
  16370. "name": "page",
  16371. "in": "query"
  16372. },
  16373. {
  16374. "type": "integer",
  16375. "description": "page size of results",
  16376. "name": "limit",
  16377. "in": "query"
  16378. }
  16379. ],
  16380. "responses": {
  16381. "200": {
  16382. "$ref": "#/responses/TeamList"
  16383. }
  16384. }
  16385. }
  16386. },
  16387. "/user/times": {
  16388. "get": {
  16389. "produces": [
  16390. "application/json"
  16391. ],
  16392. "tags": [
  16393. "user"
  16394. ],
  16395. "summary": "List the current user's tracked times",
  16396. "operationId": "userCurrentTrackedTimes",
  16397. "parameters": [
  16398. {
  16399. "type": "integer",
  16400. "description": "page number of results to return (1-based)",
  16401. "name": "page",
  16402. "in": "query"
  16403. },
  16404. {
  16405. "type": "integer",
  16406. "description": "page size of results",
  16407. "name": "limit",
  16408. "in": "query"
  16409. },
  16410. {
  16411. "type": "string",
  16412. "format": "date-time",
  16413. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  16414. "name": "since",
  16415. "in": "query"
  16416. },
  16417. {
  16418. "type": "string",
  16419. "format": "date-time",
  16420. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  16421. "name": "before",
  16422. "in": "query"
  16423. }
  16424. ],
  16425. "responses": {
  16426. "200": {
  16427. "$ref": "#/responses/TrackedTimeList"
  16428. }
  16429. }
  16430. }
  16431. },
  16432. "/users/search": {
  16433. "get": {
  16434. "produces": [
  16435. "application/json"
  16436. ],
  16437. "tags": [
  16438. "user"
  16439. ],
  16440. "summary": "Search for users",
  16441. "operationId": "userSearch",
  16442. "parameters": [
  16443. {
  16444. "type": "string",
  16445. "description": "keyword",
  16446. "name": "q",
  16447. "in": "query"
  16448. },
  16449. {
  16450. "type": "integer",
  16451. "format": "int64",
  16452. "description": "ID of the user to search for",
  16453. "name": "uid",
  16454. "in": "query"
  16455. },
  16456. {
  16457. "type": "integer",
  16458. "description": "page number of results to return (1-based)",
  16459. "name": "page",
  16460. "in": "query"
  16461. },
  16462. {
  16463. "type": "integer",
  16464. "description": "page size of results",
  16465. "name": "limit",
  16466. "in": "query"
  16467. }
  16468. ],
  16469. "responses": {
  16470. "200": {
  16471. "description": "SearchResults of a successful search",
  16472. "schema": {
  16473. "type": "object",
  16474. "properties": {
  16475. "data": {
  16476. "type": "array",
  16477. "items": {
  16478. "$ref": "#/definitions/User"
  16479. }
  16480. },
  16481. "ok": {
  16482. "type": "boolean"
  16483. }
  16484. }
  16485. }
  16486. }
  16487. }
  16488. }
  16489. },
  16490. "/users/{username}": {
  16491. "get": {
  16492. "produces": [
  16493. "application/json"
  16494. ],
  16495. "tags": [
  16496. "user"
  16497. ],
  16498. "summary": "Get a user",
  16499. "operationId": "userGet",
  16500. "parameters": [
  16501. {
  16502. "type": "string",
  16503. "description": "username of user to get",
  16504. "name": "username",
  16505. "in": "path",
  16506. "required": true
  16507. }
  16508. ],
  16509. "responses": {
  16510. "200": {
  16511. "$ref": "#/responses/User"
  16512. },
  16513. "404": {
  16514. "$ref": "#/responses/notFound"
  16515. }
  16516. }
  16517. }
  16518. },
  16519. "/users/{username}/activities/feeds": {
  16520. "get": {
  16521. "produces": [
  16522. "application/json"
  16523. ],
  16524. "tags": [
  16525. "user"
  16526. ],
  16527. "summary": "List a user's activity feeds",
  16528. "operationId": "userListActivityFeeds",
  16529. "parameters": [
  16530. {
  16531. "type": "string",
  16532. "description": "username of user",
  16533. "name": "username",
  16534. "in": "path",
  16535. "required": true
  16536. },
  16537. {
  16538. "type": "boolean",
  16539. "description": "if true, only show actions performed by the requested user",
  16540. "name": "only-performed-by",
  16541. "in": "query"
  16542. },
  16543. {
  16544. "type": "string",
  16545. "format": "date",
  16546. "description": "the date of the activities to be found",
  16547. "name": "date",
  16548. "in": "query"
  16549. },
  16550. {
  16551. "type": "integer",
  16552. "description": "page number of results to return (1-based)",
  16553. "name": "page",
  16554. "in": "query"
  16555. },
  16556. {
  16557. "type": "integer",
  16558. "description": "page size of results",
  16559. "name": "limit",
  16560. "in": "query"
  16561. }
  16562. ],
  16563. "responses": {
  16564. "200": {
  16565. "$ref": "#/responses/ActivityFeedsList"
  16566. },
  16567. "404": {
  16568. "$ref": "#/responses/notFound"
  16569. }
  16570. }
  16571. }
  16572. },
  16573. "/users/{username}/followers": {
  16574. "get": {
  16575. "produces": [
  16576. "application/json"
  16577. ],
  16578. "tags": [
  16579. "user"
  16580. ],
  16581. "summary": "List the given user's followers",
  16582. "operationId": "userListFollowers",
  16583. "parameters": [
  16584. {
  16585. "type": "string",
  16586. "description": "username of user",
  16587. "name": "username",
  16588. "in": "path",
  16589. "required": true
  16590. },
  16591. {
  16592. "type": "integer",
  16593. "description": "page number of results to return (1-based)",
  16594. "name": "page",
  16595. "in": "query"
  16596. },
  16597. {
  16598. "type": "integer",
  16599. "description": "page size of results",
  16600. "name": "limit",
  16601. "in": "query"
  16602. }
  16603. ],
  16604. "responses": {
  16605. "200": {
  16606. "$ref": "#/responses/UserList"
  16607. },
  16608. "404": {
  16609. "$ref": "#/responses/notFound"
  16610. }
  16611. }
  16612. }
  16613. },
  16614. "/users/{username}/following": {
  16615. "get": {
  16616. "produces": [
  16617. "application/json"
  16618. ],
  16619. "tags": [
  16620. "user"
  16621. ],
  16622. "summary": "List the users that the given user is following",
  16623. "operationId": "userListFollowing",
  16624. "parameters": [
  16625. {
  16626. "type": "string",
  16627. "description": "username of user",
  16628. "name": "username",
  16629. "in": "path",
  16630. "required": true
  16631. },
  16632. {
  16633. "type": "integer",
  16634. "description": "page number of results to return (1-based)",
  16635. "name": "page",
  16636. "in": "query"
  16637. },
  16638. {
  16639. "type": "integer",
  16640. "description": "page size of results",
  16641. "name": "limit",
  16642. "in": "query"
  16643. }
  16644. ],
  16645. "responses": {
  16646. "200": {
  16647. "$ref": "#/responses/UserList"
  16648. },
  16649. "404": {
  16650. "$ref": "#/responses/notFound"
  16651. }
  16652. }
  16653. }
  16654. },
  16655. "/users/{username}/following/{target}": {
  16656. "get": {
  16657. "tags": [
  16658. "user"
  16659. ],
  16660. "summary": "Check if one user is following another user",
  16661. "operationId": "userCheckFollowing",
  16662. "parameters": [
  16663. {
  16664. "type": "string",
  16665. "description": "username of following user",
  16666. "name": "username",
  16667. "in": "path",
  16668. "required": true
  16669. },
  16670. {
  16671. "type": "string",
  16672. "description": "username of followed user",
  16673. "name": "target",
  16674. "in": "path",
  16675. "required": true
  16676. }
  16677. ],
  16678. "responses": {
  16679. "204": {
  16680. "$ref": "#/responses/empty"
  16681. },
  16682. "404": {
  16683. "$ref": "#/responses/notFound"
  16684. }
  16685. }
  16686. }
  16687. },
  16688. "/users/{username}/gpg_keys": {
  16689. "get": {
  16690. "produces": [
  16691. "application/json"
  16692. ],
  16693. "tags": [
  16694. "user"
  16695. ],
  16696. "summary": "List the given user's GPG keys",
  16697. "operationId": "userListGPGKeys",
  16698. "parameters": [
  16699. {
  16700. "type": "string",
  16701. "description": "username of user",
  16702. "name": "username",
  16703. "in": "path",
  16704. "required": true
  16705. },
  16706. {
  16707. "type": "integer",
  16708. "description": "page number of results to return (1-based)",
  16709. "name": "page",
  16710. "in": "query"
  16711. },
  16712. {
  16713. "type": "integer",
  16714. "description": "page size of results",
  16715. "name": "limit",
  16716. "in": "query"
  16717. }
  16718. ],
  16719. "responses": {
  16720. "200": {
  16721. "$ref": "#/responses/GPGKeyList"
  16722. },
  16723. "404": {
  16724. "$ref": "#/responses/notFound"
  16725. }
  16726. }
  16727. }
  16728. },
  16729. "/users/{username}/heatmap": {
  16730. "get": {
  16731. "produces": [
  16732. "application/json"
  16733. ],
  16734. "tags": [
  16735. "user"
  16736. ],
  16737. "summary": "Get a user's heatmap",
  16738. "operationId": "userGetHeatmapData",
  16739. "parameters": [
  16740. {
  16741. "type": "string",
  16742. "description": "username of user to get",
  16743. "name": "username",
  16744. "in": "path",
  16745. "required": true
  16746. }
  16747. ],
  16748. "responses": {
  16749. "200": {
  16750. "$ref": "#/responses/UserHeatmapData"
  16751. },
  16752. "404": {
  16753. "$ref": "#/responses/notFound"
  16754. }
  16755. }
  16756. }
  16757. },
  16758. "/users/{username}/keys": {
  16759. "get": {
  16760. "produces": [
  16761. "application/json"
  16762. ],
  16763. "tags": [
  16764. "user"
  16765. ],
  16766. "summary": "List the given user's public keys",
  16767. "operationId": "userListKeys",
  16768. "parameters": [
  16769. {
  16770. "type": "string",
  16771. "description": "username of user",
  16772. "name": "username",
  16773. "in": "path",
  16774. "required": true
  16775. },
  16776. {
  16777. "type": "string",
  16778. "description": "fingerprint of the key",
  16779. "name": "fingerprint",
  16780. "in": "query"
  16781. },
  16782. {
  16783. "type": "integer",
  16784. "description": "page number of results to return (1-based)",
  16785. "name": "page",
  16786. "in": "query"
  16787. },
  16788. {
  16789. "type": "integer",
  16790. "description": "page size of results",
  16791. "name": "limit",
  16792. "in": "query"
  16793. }
  16794. ],
  16795. "responses": {
  16796. "200": {
  16797. "$ref": "#/responses/PublicKeyList"
  16798. },
  16799. "404": {
  16800. "$ref": "#/responses/notFound"
  16801. }
  16802. }
  16803. }
  16804. },
  16805. "/users/{username}/orgs": {
  16806. "get": {
  16807. "produces": [
  16808. "application/json"
  16809. ],
  16810. "tags": [
  16811. "organization"
  16812. ],
  16813. "summary": "List a user's organizations",
  16814. "operationId": "orgListUserOrgs",
  16815. "parameters": [
  16816. {
  16817. "type": "string",
  16818. "description": "username of user",
  16819. "name": "username",
  16820. "in": "path",
  16821. "required": true
  16822. },
  16823. {
  16824. "type": "integer",
  16825. "description": "page number of results to return (1-based)",
  16826. "name": "page",
  16827. "in": "query"
  16828. },
  16829. {
  16830. "type": "integer",
  16831. "description": "page size of results",
  16832. "name": "limit",
  16833. "in": "query"
  16834. }
  16835. ],
  16836. "responses": {
  16837. "200": {
  16838. "$ref": "#/responses/OrganizationList"
  16839. },
  16840. "404": {
  16841. "$ref": "#/responses/notFound"
  16842. }
  16843. }
  16844. }
  16845. },
  16846. "/users/{username}/orgs/{org}/permissions": {
  16847. "get": {
  16848. "produces": [
  16849. "application/json"
  16850. ],
  16851. "tags": [
  16852. "organization"
  16853. ],
  16854. "summary": "Get user permissions in organization",
  16855. "operationId": "orgGetUserPermissions",
  16856. "parameters": [
  16857. {
  16858. "type": "string",
  16859. "description": "username of user",
  16860. "name": "username",
  16861. "in": "path",
  16862. "required": true
  16863. },
  16864. {
  16865. "type": "string",
  16866. "description": "name of the organization",
  16867. "name": "org",
  16868. "in": "path",
  16869. "required": true
  16870. }
  16871. ],
  16872. "responses": {
  16873. "200": {
  16874. "$ref": "#/responses/OrganizationPermissions"
  16875. },
  16876. "403": {
  16877. "$ref": "#/responses/forbidden"
  16878. },
  16879. "404": {
  16880. "$ref": "#/responses/notFound"
  16881. }
  16882. }
  16883. }
  16884. },
  16885. "/users/{username}/repos": {
  16886. "get": {
  16887. "produces": [
  16888. "application/json"
  16889. ],
  16890. "tags": [
  16891. "user"
  16892. ],
  16893. "summary": "List the repos owned by the given user",
  16894. "operationId": "userListRepos",
  16895. "parameters": [
  16896. {
  16897. "type": "string",
  16898. "description": "username of user",
  16899. "name": "username",
  16900. "in": "path",
  16901. "required": true
  16902. },
  16903. {
  16904. "type": "integer",
  16905. "description": "page number of results to return (1-based)",
  16906. "name": "page",
  16907. "in": "query"
  16908. },
  16909. {
  16910. "type": "integer",
  16911. "description": "page size of results",
  16912. "name": "limit",
  16913. "in": "query"
  16914. }
  16915. ],
  16916. "responses": {
  16917. "200": {
  16918. "$ref": "#/responses/RepositoryList"
  16919. },
  16920. "404": {
  16921. "$ref": "#/responses/notFound"
  16922. }
  16923. }
  16924. }
  16925. },
  16926. "/users/{username}/starred": {
  16927. "get": {
  16928. "produces": [
  16929. "application/json"
  16930. ],
  16931. "tags": [
  16932. "user"
  16933. ],
  16934. "summary": "The repos that the given user has starred",
  16935. "operationId": "userListStarred",
  16936. "parameters": [
  16937. {
  16938. "type": "string",
  16939. "description": "username of user",
  16940. "name": "username",
  16941. "in": "path",
  16942. "required": true
  16943. },
  16944. {
  16945. "type": "integer",
  16946. "description": "page number of results to return (1-based)",
  16947. "name": "page",
  16948. "in": "query"
  16949. },
  16950. {
  16951. "type": "integer",
  16952. "description": "page size of results",
  16953. "name": "limit",
  16954. "in": "query"
  16955. }
  16956. ],
  16957. "responses": {
  16958. "200": {
  16959. "$ref": "#/responses/RepositoryList"
  16960. },
  16961. "404": {
  16962. "$ref": "#/responses/notFound"
  16963. }
  16964. }
  16965. }
  16966. },
  16967. "/users/{username}/subscriptions": {
  16968. "get": {
  16969. "produces": [
  16970. "application/json"
  16971. ],
  16972. "tags": [
  16973. "user"
  16974. ],
  16975. "summary": "List the repositories watched by a user",
  16976. "operationId": "userListSubscriptions",
  16977. "parameters": [
  16978. {
  16979. "type": "string",
  16980. "description": "username of the user",
  16981. "name": "username",
  16982. "in": "path",
  16983. "required": true
  16984. },
  16985. {
  16986. "type": "integer",
  16987. "description": "page number of results to return (1-based)",
  16988. "name": "page",
  16989. "in": "query"
  16990. },
  16991. {
  16992. "type": "integer",
  16993. "description": "page size of results",
  16994. "name": "limit",
  16995. "in": "query"
  16996. }
  16997. ],
  16998. "responses": {
  16999. "200": {
  17000. "$ref": "#/responses/RepositoryList"
  17001. },
  17002. "404": {
  17003. "$ref": "#/responses/notFound"
  17004. }
  17005. }
  17006. }
  17007. },
  17008. "/users/{username}/tokens": {
  17009. "get": {
  17010. "produces": [
  17011. "application/json"
  17012. ],
  17013. "tags": [
  17014. "user"
  17015. ],
  17016. "summary": "List the authenticated user's access tokens",
  17017. "operationId": "userGetTokens",
  17018. "parameters": [
  17019. {
  17020. "type": "string",
  17021. "description": "username of user",
  17022. "name": "username",
  17023. "in": "path",
  17024. "required": true
  17025. },
  17026. {
  17027. "type": "integer",
  17028. "description": "page number of results to return (1-based)",
  17029. "name": "page",
  17030. "in": "query"
  17031. },
  17032. {
  17033. "type": "integer",
  17034. "description": "page size of results",
  17035. "name": "limit",
  17036. "in": "query"
  17037. }
  17038. ],
  17039. "responses": {
  17040. "200": {
  17041. "$ref": "#/responses/AccessTokenList"
  17042. },
  17043. "403": {
  17044. "$ref": "#/responses/forbidden"
  17045. }
  17046. }
  17047. },
  17048. "post": {
  17049. "consumes": [
  17050. "application/json"
  17051. ],
  17052. "produces": [
  17053. "application/json"
  17054. ],
  17055. "tags": [
  17056. "user"
  17057. ],
  17058. "summary": "Create an access token",
  17059. "operationId": "userCreateToken",
  17060. "parameters": [
  17061. {
  17062. "type": "string",
  17063. "description": "username of user",
  17064. "name": "username",
  17065. "in": "path",
  17066. "required": true
  17067. },
  17068. {
  17069. "name": "body",
  17070. "in": "body",
  17071. "schema": {
  17072. "$ref": "#/definitions/CreateAccessTokenOption"
  17073. }
  17074. }
  17075. ],
  17076. "responses": {
  17077. "201": {
  17078. "$ref": "#/responses/AccessToken"
  17079. },
  17080. "400": {
  17081. "$ref": "#/responses/error"
  17082. },
  17083. "403": {
  17084. "$ref": "#/responses/forbidden"
  17085. }
  17086. }
  17087. }
  17088. },
  17089. "/users/{username}/tokens/{token}": {
  17090. "delete": {
  17091. "produces": [
  17092. "application/json"
  17093. ],
  17094. "tags": [
  17095. "user"
  17096. ],
  17097. "summary": "delete an access token",
  17098. "operationId": "userDeleteAccessToken",
  17099. "parameters": [
  17100. {
  17101. "type": "string",
  17102. "description": "username of user",
  17103. "name": "username",
  17104. "in": "path",
  17105. "required": true
  17106. },
  17107. {
  17108. "type": "string",
  17109. "description": "token to be deleted, identified by ID and if not available by name",
  17110. "name": "token",
  17111. "in": "path",
  17112. "required": true
  17113. }
  17114. ],
  17115. "responses": {
  17116. "204": {
  17117. "$ref": "#/responses/empty"
  17118. },
  17119. "403": {
  17120. "$ref": "#/responses/forbidden"
  17121. },
  17122. "404": {
  17123. "$ref": "#/responses/notFound"
  17124. },
  17125. "422": {
  17126. "$ref": "#/responses/error"
  17127. }
  17128. }
  17129. }
  17130. },
  17131. "/version": {
  17132. "get": {
  17133. "produces": [
  17134. "application/json"
  17135. ],
  17136. "tags": [
  17137. "miscellaneous"
  17138. ],
  17139. "summary": "Returns the version of the Gitea application",
  17140. "operationId": "getVersion",
  17141. "responses": {
  17142. "200": {
  17143. "$ref": "#/responses/ServerVersion"
  17144. }
  17145. }
  17146. }
  17147. }
  17148. },
  17149. "definitions": {
  17150. "APIError": {
  17151. "description": "APIError is an api error with a message",
  17152. "type": "object",
  17153. "properties": {
  17154. "message": {
  17155. "type": "string",
  17156. "x-go-name": "Message"
  17157. },
  17158. "url": {
  17159. "type": "string",
  17160. "x-go-name": "URL"
  17161. }
  17162. },
  17163. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17164. },
  17165. "AccessToken": {
  17166. "type": "object",
  17167. "title": "AccessToken represents an API access token.",
  17168. "properties": {
  17169. "id": {
  17170. "type": "integer",
  17171. "format": "int64",
  17172. "x-go-name": "ID"
  17173. },
  17174. "name": {
  17175. "type": "string",
  17176. "x-go-name": "Name"
  17177. },
  17178. "scopes": {
  17179. "type": "array",
  17180. "items": {
  17181. "type": "string"
  17182. },
  17183. "x-go-name": "Scopes"
  17184. },
  17185. "sha1": {
  17186. "type": "string",
  17187. "x-go-name": "Token"
  17188. },
  17189. "token_last_eight": {
  17190. "type": "string",
  17191. "x-go-name": "TokenLastEight"
  17192. }
  17193. },
  17194. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17195. },
  17196. "Activity": {
  17197. "type": "object",
  17198. "properties": {
  17199. "act_user": {
  17200. "$ref": "#/definitions/User"
  17201. },
  17202. "act_user_id": {
  17203. "type": "integer",
  17204. "format": "int64",
  17205. "x-go-name": "ActUserID"
  17206. },
  17207. "comment": {
  17208. "$ref": "#/definitions/Comment"
  17209. },
  17210. "comment_id": {
  17211. "type": "integer",
  17212. "format": "int64",
  17213. "x-go-name": "CommentID"
  17214. },
  17215. "content": {
  17216. "type": "string",
  17217. "x-go-name": "Content"
  17218. },
  17219. "created": {
  17220. "type": "string",
  17221. "format": "date-time",
  17222. "x-go-name": "Created"
  17223. },
  17224. "id": {
  17225. "type": "integer",
  17226. "format": "int64",
  17227. "x-go-name": "ID"
  17228. },
  17229. "is_private": {
  17230. "type": "boolean",
  17231. "x-go-name": "IsPrivate"
  17232. },
  17233. "op_type": {
  17234. "type": "string",
  17235. "x-go-name": "OpType"
  17236. },
  17237. "ref_name": {
  17238. "type": "string",
  17239. "x-go-name": "RefName"
  17240. },
  17241. "repo": {
  17242. "$ref": "#/definitions/Repository"
  17243. },
  17244. "repo_id": {
  17245. "type": "integer",
  17246. "format": "int64",
  17247. "x-go-name": "RepoID"
  17248. },
  17249. "user_id": {
  17250. "type": "integer",
  17251. "format": "int64",
  17252. "x-go-name": "UserID"
  17253. }
  17254. },
  17255. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17256. },
  17257. "ActivityPub": {
  17258. "description": "ActivityPub type",
  17259. "type": "object",
  17260. "properties": {
  17261. "@context": {
  17262. "type": "string",
  17263. "x-go-name": "Context"
  17264. }
  17265. },
  17266. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17267. },
  17268. "AddCollaboratorOption": {
  17269. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  17270. "type": "object",
  17271. "properties": {
  17272. "permission": {
  17273. "type": "string",
  17274. "x-go-name": "Permission"
  17275. }
  17276. },
  17277. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17278. },
  17279. "AddTimeOption": {
  17280. "description": "AddTimeOption options for adding time to an issue",
  17281. "type": "object",
  17282. "required": [
  17283. "time"
  17284. ],
  17285. "properties": {
  17286. "created": {
  17287. "type": "string",
  17288. "format": "date-time",
  17289. "x-go-name": "Created"
  17290. },
  17291. "time": {
  17292. "description": "time in seconds",
  17293. "type": "integer",
  17294. "format": "int64",
  17295. "x-go-name": "Time"
  17296. },
  17297. "user_name": {
  17298. "description": "User who spent the time (optional)",
  17299. "type": "string",
  17300. "x-go-name": "User"
  17301. }
  17302. },
  17303. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17304. },
  17305. "AnnotatedTag": {
  17306. "description": "AnnotatedTag represents an annotated tag",
  17307. "type": "object",
  17308. "properties": {
  17309. "message": {
  17310. "type": "string",
  17311. "x-go-name": "Message"
  17312. },
  17313. "object": {
  17314. "$ref": "#/definitions/AnnotatedTagObject"
  17315. },
  17316. "sha": {
  17317. "type": "string",
  17318. "x-go-name": "SHA"
  17319. },
  17320. "tag": {
  17321. "type": "string",
  17322. "x-go-name": "Tag"
  17323. },
  17324. "tagger": {
  17325. "$ref": "#/definitions/CommitUser"
  17326. },
  17327. "url": {
  17328. "type": "string",
  17329. "x-go-name": "URL"
  17330. },
  17331. "verification": {
  17332. "$ref": "#/definitions/PayloadCommitVerification"
  17333. }
  17334. },
  17335. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17336. },
  17337. "AnnotatedTagObject": {
  17338. "description": "AnnotatedTagObject contains meta information of the tag object",
  17339. "type": "object",
  17340. "properties": {
  17341. "sha": {
  17342. "type": "string",
  17343. "x-go-name": "SHA"
  17344. },
  17345. "type": {
  17346. "type": "string",
  17347. "x-go-name": "Type"
  17348. },
  17349. "url": {
  17350. "type": "string",
  17351. "x-go-name": "URL"
  17352. }
  17353. },
  17354. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17355. },
  17356. "Attachment": {
  17357. "description": "Attachment a generic attachment",
  17358. "type": "object",
  17359. "properties": {
  17360. "browser_download_url": {
  17361. "type": "string",
  17362. "x-go-name": "DownloadURL"
  17363. },
  17364. "created_at": {
  17365. "type": "string",
  17366. "format": "date-time",
  17367. "x-go-name": "Created"
  17368. },
  17369. "download_count": {
  17370. "type": "integer",
  17371. "format": "int64",
  17372. "x-go-name": "DownloadCount"
  17373. },
  17374. "id": {
  17375. "type": "integer",
  17376. "format": "int64",
  17377. "x-go-name": "ID"
  17378. },
  17379. "name": {
  17380. "type": "string",
  17381. "x-go-name": "Name"
  17382. },
  17383. "size": {
  17384. "type": "integer",
  17385. "format": "int64",
  17386. "x-go-name": "Size"
  17387. },
  17388. "uuid": {
  17389. "type": "string",
  17390. "x-go-name": "UUID"
  17391. }
  17392. },
  17393. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17394. },
  17395. "Badge": {
  17396. "description": "Badge represents a user badge",
  17397. "type": "object",
  17398. "properties": {
  17399. "description": {
  17400. "type": "string",
  17401. "x-go-name": "Description"
  17402. },
  17403. "id": {
  17404. "type": "integer",
  17405. "format": "int64",
  17406. "x-go-name": "ID"
  17407. },
  17408. "image_url": {
  17409. "type": "string",
  17410. "x-go-name": "ImageURL"
  17411. },
  17412. "slug": {
  17413. "type": "string",
  17414. "x-go-name": "Slug"
  17415. }
  17416. },
  17417. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17418. },
  17419. "Branch": {
  17420. "description": "Branch represents a repository branch",
  17421. "type": "object",
  17422. "properties": {
  17423. "commit": {
  17424. "$ref": "#/definitions/PayloadCommit"
  17425. },
  17426. "effective_branch_protection_name": {
  17427. "type": "string",
  17428. "x-go-name": "EffectiveBranchProtectionName"
  17429. },
  17430. "enable_status_check": {
  17431. "type": "boolean",
  17432. "x-go-name": "EnableStatusCheck"
  17433. },
  17434. "name": {
  17435. "type": "string",
  17436. "x-go-name": "Name"
  17437. },
  17438. "protected": {
  17439. "type": "boolean",
  17440. "x-go-name": "Protected"
  17441. },
  17442. "required_approvals": {
  17443. "type": "integer",
  17444. "format": "int64",
  17445. "x-go-name": "RequiredApprovals"
  17446. },
  17447. "status_check_contexts": {
  17448. "type": "array",
  17449. "items": {
  17450. "type": "string"
  17451. },
  17452. "x-go-name": "StatusCheckContexts"
  17453. },
  17454. "user_can_merge": {
  17455. "type": "boolean",
  17456. "x-go-name": "UserCanMerge"
  17457. },
  17458. "user_can_push": {
  17459. "type": "boolean",
  17460. "x-go-name": "UserCanPush"
  17461. }
  17462. },
  17463. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17464. },
  17465. "BranchProtection": {
  17466. "description": "BranchProtection represents a branch protection for a repository",
  17467. "type": "object",
  17468. "properties": {
  17469. "approvals_whitelist_teams": {
  17470. "type": "array",
  17471. "items": {
  17472. "type": "string"
  17473. },
  17474. "x-go-name": "ApprovalsWhitelistTeams"
  17475. },
  17476. "approvals_whitelist_username": {
  17477. "type": "array",
  17478. "items": {
  17479. "type": "string"
  17480. },
  17481. "x-go-name": "ApprovalsWhitelistUsernames"
  17482. },
  17483. "block_on_official_review_requests": {
  17484. "type": "boolean",
  17485. "x-go-name": "BlockOnOfficialReviewRequests"
  17486. },
  17487. "block_on_outdated_branch": {
  17488. "type": "boolean",
  17489. "x-go-name": "BlockOnOutdatedBranch"
  17490. },
  17491. "block_on_rejected_reviews": {
  17492. "type": "boolean",
  17493. "x-go-name": "BlockOnRejectedReviews"
  17494. },
  17495. "branch_name": {
  17496. "description": "Deprecated: true",
  17497. "type": "string",
  17498. "x-go-name": "BranchName"
  17499. },
  17500. "created_at": {
  17501. "type": "string",
  17502. "format": "date-time",
  17503. "x-go-name": "Created"
  17504. },
  17505. "dismiss_stale_approvals": {
  17506. "type": "boolean",
  17507. "x-go-name": "DismissStaleApprovals"
  17508. },
  17509. "enable_approvals_whitelist": {
  17510. "type": "boolean",
  17511. "x-go-name": "EnableApprovalsWhitelist"
  17512. },
  17513. "enable_merge_whitelist": {
  17514. "type": "boolean",
  17515. "x-go-name": "EnableMergeWhitelist"
  17516. },
  17517. "enable_push": {
  17518. "type": "boolean",
  17519. "x-go-name": "EnablePush"
  17520. },
  17521. "enable_push_whitelist": {
  17522. "type": "boolean",
  17523. "x-go-name": "EnablePushWhitelist"
  17524. },
  17525. "enable_status_check": {
  17526. "type": "boolean",
  17527. "x-go-name": "EnableStatusCheck"
  17528. },
  17529. "ignore_stale_approvals": {
  17530. "type": "boolean",
  17531. "x-go-name": "IgnoreStaleApprovals"
  17532. },
  17533. "merge_whitelist_teams": {
  17534. "type": "array",
  17535. "items": {
  17536. "type": "string"
  17537. },
  17538. "x-go-name": "MergeWhitelistTeams"
  17539. },
  17540. "merge_whitelist_usernames": {
  17541. "type": "array",
  17542. "items": {
  17543. "type": "string"
  17544. },
  17545. "x-go-name": "MergeWhitelistUsernames"
  17546. },
  17547. "protected_file_patterns": {
  17548. "type": "string",
  17549. "x-go-name": "ProtectedFilePatterns"
  17550. },
  17551. "push_whitelist_deploy_keys": {
  17552. "type": "boolean",
  17553. "x-go-name": "PushWhitelistDeployKeys"
  17554. },
  17555. "push_whitelist_teams": {
  17556. "type": "array",
  17557. "items": {
  17558. "type": "string"
  17559. },
  17560. "x-go-name": "PushWhitelistTeams"
  17561. },
  17562. "push_whitelist_usernames": {
  17563. "type": "array",
  17564. "items": {
  17565. "type": "string"
  17566. },
  17567. "x-go-name": "PushWhitelistUsernames"
  17568. },
  17569. "require_signed_commits": {
  17570. "type": "boolean",
  17571. "x-go-name": "RequireSignedCommits"
  17572. },
  17573. "required_approvals": {
  17574. "type": "integer",
  17575. "format": "int64",
  17576. "x-go-name": "RequiredApprovals"
  17577. },
  17578. "rule_name": {
  17579. "type": "string",
  17580. "x-go-name": "RuleName"
  17581. },
  17582. "status_check_contexts": {
  17583. "type": "array",
  17584. "items": {
  17585. "type": "string"
  17586. },
  17587. "x-go-name": "StatusCheckContexts"
  17588. },
  17589. "unprotected_file_patterns": {
  17590. "type": "string",
  17591. "x-go-name": "UnprotectedFilePatterns"
  17592. },
  17593. "updated_at": {
  17594. "type": "string",
  17595. "format": "date-time",
  17596. "x-go-name": "Updated"
  17597. }
  17598. },
  17599. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17600. },
  17601. "ChangeFileOperation": {
  17602. "description": "ChangeFileOperation for creating, updating or deleting a file",
  17603. "type": "object",
  17604. "required": [
  17605. "operation",
  17606. "path"
  17607. ],
  17608. "properties": {
  17609. "content": {
  17610. "description": "new or updated file content, must be base64 encoded",
  17611. "type": "string",
  17612. "x-go-name": "ContentBase64"
  17613. },
  17614. "from_path": {
  17615. "description": "old path of the file to move",
  17616. "type": "string",
  17617. "x-go-name": "FromPath"
  17618. },
  17619. "operation": {
  17620. "description": "indicates what to do with the file",
  17621. "type": "string",
  17622. "enum": [
  17623. "create",
  17624. "update",
  17625. "delete"
  17626. ],
  17627. "x-go-name": "Operation"
  17628. },
  17629. "path": {
  17630. "description": "path to the existing or new file",
  17631. "type": "string",
  17632. "x-go-name": "Path"
  17633. },
  17634. "sha": {
  17635. "description": "sha is the SHA for the file that already exists, required for update or delete",
  17636. "type": "string",
  17637. "x-go-name": "SHA"
  17638. }
  17639. },
  17640. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17641. },
  17642. "ChangeFilesOptions": {
  17643. "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)",
  17644. "type": "object",
  17645. "required": [
  17646. "files"
  17647. ],
  17648. "properties": {
  17649. "author": {
  17650. "$ref": "#/definitions/Identity"
  17651. },
  17652. "branch": {
  17653. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  17654. "type": "string",
  17655. "x-go-name": "BranchName"
  17656. },
  17657. "committer": {
  17658. "$ref": "#/definitions/Identity"
  17659. },
  17660. "dates": {
  17661. "$ref": "#/definitions/CommitDateOptions"
  17662. },
  17663. "files": {
  17664. "description": "list of file operations",
  17665. "type": "array",
  17666. "items": {
  17667. "$ref": "#/definitions/ChangeFileOperation"
  17668. },
  17669. "x-go-name": "Files"
  17670. },
  17671. "message": {
  17672. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  17673. "type": "string",
  17674. "x-go-name": "Message"
  17675. },
  17676. "new_branch": {
  17677. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  17678. "type": "string",
  17679. "x-go-name": "NewBranchName"
  17680. },
  17681. "signoff": {
  17682. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  17683. "type": "boolean",
  17684. "x-go-name": "Signoff"
  17685. }
  17686. },
  17687. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17688. },
  17689. "ChangedFile": {
  17690. "description": "ChangedFile store information about files affected by the pull request",
  17691. "type": "object",
  17692. "properties": {
  17693. "additions": {
  17694. "type": "integer",
  17695. "format": "int64",
  17696. "x-go-name": "Additions"
  17697. },
  17698. "changes": {
  17699. "type": "integer",
  17700. "format": "int64",
  17701. "x-go-name": "Changes"
  17702. },
  17703. "contents_url": {
  17704. "type": "string",
  17705. "x-go-name": "ContentsURL"
  17706. },
  17707. "deletions": {
  17708. "type": "integer",
  17709. "format": "int64",
  17710. "x-go-name": "Deletions"
  17711. },
  17712. "filename": {
  17713. "type": "string",
  17714. "x-go-name": "Filename"
  17715. },
  17716. "html_url": {
  17717. "type": "string",
  17718. "x-go-name": "HTMLURL"
  17719. },
  17720. "previous_filename": {
  17721. "type": "string",
  17722. "x-go-name": "PreviousFilename"
  17723. },
  17724. "raw_url": {
  17725. "type": "string",
  17726. "x-go-name": "RawURL"
  17727. },
  17728. "status": {
  17729. "type": "string",
  17730. "x-go-name": "Status"
  17731. }
  17732. },
  17733. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17734. },
  17735. "CombinedStatus": {
  17736. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  17737. "type": "object",
  17738. "properties": {
  17739. "commit_url": {
  17740. "type": "string",
  17741. "x-go-name": "CommitURL"
  17742. },
  17743. "repository": {
  17744. "$ref": "#/definitions/Repository"
  17745. },
  17746. "sha": {
  17747. "type": "string",
  17748. "x-go-name": "SHA"
  17749. },
  17750. "state": {
  17751. "$ref": "#/definitions/CommitStatusState"
  17752. },
  17753. "statuses": {
  17754. "type": "array",
  17755. "items": {
  17756. "$ref": "#/definitions/CommitStatus"
  17757. },
  17758. "x-go-name": "Statuses"
  17759. },
  17760. "total_count": {
  17761. "type": "integer",
  17762. "format": "int64",
  17763. "x-go-name": "TotalCount"
  17764. },
  17765. "url": {
  17766. "type": "string",
  17767. "x-go-name": "URL"
  17768. }
  17769. },
  17770. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17771. },
  17772. "Comment": {
  17773. "description": "Comment represents a comment on a commit or issue",
  17774. "type": "object",
  17775. "properties": {
  17776. "assets": {
  17777. "type": "array",
  17778. "items": {
  17779. "$ref": "#/definitions/Attachment"
  17780. },
  17781. "x-go-name": "Attachments"
  17782. },
  17783. "body": {
  17784. "type": "string",
  17785. "x-go-name": "Body"
  17786. },
  17787. "created_at": {
  17788. "type": "string",
  17789. "format": "date-time",
  17790. "x-go-name": "Created"
  17791. },
  17792. "html_url": {
  17793. "type": "string",
  17794. "x-go-name": "HTMLURL"
  17795. },
  17796. "id": {
  17797. "type": "integer",
  17798. "format": "int64",
  17799. "x-go-name": "ID"
  17800. },
  17801. "issue_url": {
  17802. "type": "string",
  17803. "x-go-name": "IssueURL"
  17804. },
  17805. "original_author": {
  17806. "type": "string",
  17807. "x-go-name": "OriginalAuthor"
  17808. },
  17809. "original_author_id": {
  17810. "type": "integer",
  17811. "format": "int64",
  17812. "x-go-name": "OriginalAuthorID"
  17813. },
  17814. "pull_request_url": {
  17815. "type": "string",
  17816. "x-go-name": "PRURL"
  17817. },
  17818. "updated_at": {
  17819. "type": "string",
  17820. "format": "date-time",
  17821. "x-go-name": "Updated"
  17822. },
  17823. "user": {
  17824. "$ref": "#/definitions/User"
  17825. }
  17826. },
  17827. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17828. },
  17829. "Commit": {
  17830. "type": "object",
  17831. "title": "Commit contains information generated from a Git commit.",
  17832. "properties": {
  17833. "author": {
  17834. "$ref": "#/definitions/User"
  17835. },
  17836. "commit": {
  17837. "$ref": "#/definitions/RepoCommit"
  17838. },
  17839. "committer": {
  17840. "$ref": "#/definitions/User"
  17841. },
  17842. "created": {
  17843. "type": "string",
  17844. "format": "date-time",
  17845. "x-go-name": "Created"
  17846. },
  17847. "files": {
  17848. "type": "array",
  17849. "items": {
  17850. "$ref": "#/definitions/CommitAffectedFiles"
  17851. },
  17852. "x-go-name": "Files"
  17853. },
  17854. "html_url": {
  17855. "type": "string",
  17856. "x-go-name": "HTMLURL"
  17857. },
  17858. "parents": {
  17859. "type": "array",
  17860. "items": {
  17861. "$ref": "#/definitions/CommitMeta"
  17862. },
  17863. "x-go-name": "Parents"
  17864. },
  17865. "sha": {
  17866. "type": "string",
  17867. "x-go-name": "SHA"
  17868. },
  17869. "stats": {
  17870. "$ref": "#/definitions/CommitStats"
  17871. },
  17872. "url": {
  17873. "type": "string",
  17874. "x-go-name": "URL"
  17875. }
  17876. },
  17877. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17878. },
  17879. "CommitAffectedFiles": {
  17880. "description": "CommitAffectedFiles store information about files affected by the commit",
  17881. "type": "object",
  17882. "properties": {
  17883. "filename": {
  17884. "type": "string",
  17885. "x-go-name": "Filename"
  17886. },
  17887. "status": {
  17888. "type": "string",
  17889. "x-go-name": "Status"
  17890. }
  17891. },
  17892. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17893. },
  17894. "CommitDateOptions": {
  17895. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  17896. "type": "object",
  17897. "properties": {
  17898. "author": {
  17899. "type": "string",
  17900. "format": "date-time",
  17901. "x-go-name": "Author"
  17902. },
  17903. "committer": {
  17904. "type": "string",
  17905. "format": "date-time",
  17906. "x-go-name": "Committer"
  17907. }
  17908. },
  17909. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17910. },
  17911. "CommitMeta": {
  17912. "type": "object",
  17913. "title": "CommitMeta contains meta information of a commit in terms of API.",
  17914. "properties": {
  17915. "created": {
  17916. "type": "string",
  17917. "format": "date-time",
  17918. "x-go-name": "Created"
  17919. },
  17920. "sha": {
  17921. "type": "string",
  17922. "x-go-name": "SHA"
  17923. },
  17924. "url": {
  17925. "type": "string",
  17926. "x-go-name": "URL"
  17927. }
  17928. },
  17929. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17930. },
  17931. "CommitStats": {
  17932. "description": "CommitStats is statistics for a RepoCommit",
  17933. "type": "object",
  17934. "properties": {
  17935. "additions": {
  17936. "type": "integer",
  17937. "format": "int64",
  17938. "x-go-name": "Additions"
  17939. },
  17940. "deletions": {
  17941. "type": "integer",
  17942. "format": "int64",
  17943. "x-go-name": "Deletions"
  17944. },
  17945. "total": {
  17946. "type": "integer",
  17947. "format": "int64",
  17948. "x-go-name": "Total"
  17949. }
  17950. },
  17951. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17952. },
  17953. "CommitStatus": {
  17954. "description": "CommitStatus holds a single status of a single Commit",
  17955. "type": "object",
  17956. "properties": {
  17957. "context": {
  17958. "type": "string",
  17959. "x-go-name": "Context"
  17960. },
  17961. "created_at": {
  17962. "type": "string",
  17963. "format": "date-time",
  17964. "x-go-name": "Created"
  17965. },
  17966. "creator": {
  17967. "$ref": "#/definitions/User"
  17968. },
  17969. "description": {
  17970. "type": "string",
  17971. "x-go-name": "Description"
  17972. },
  17973. "id": {
  17974. "type": "integer",
  17975. "format": "int64",
  17976. "x-go-name": "ID"
  17977. },
  17978. "status": {
  17979. "$ref": "#/definitions/CommitStatusState"
  17980. },
  17981. "target_url": {
  17982. "type": "string",
  17983. "x-go-name": "TargetURL"
  17984. },
  17985. "updated_at": {
  17986. "type": "string",
  17987. "format": "date-time",
  17988. "x-go-name": "Updated"
  17989. },
  17990. "url": {
  17991. "type": "string",
  17992. "x-go-name": "URL"
  17993. }
  17994. },
  17995. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17996. },
  17997. "CommitStatusState": {
  17998. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"",
  17999. "type": "string",
  18000. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18001. },
  18002. "CommitUser": {
  18003. "type": "object",
  18004. "title": "CommitUser contains information of a user in the context of a commit.",
  18005. "properties": {
  18006. "date": {
  18007. "type": "string",
  18008. "x-go-name": "Date"
  18009. },
  18010. "email": {
  18011. "type": "string",
  18012. "format": "email",
  18013. "x-go-name": "Email"
  18014. },
  18015. "name": {
  18016. "type": "string",
  18017. "x-go-name": "Name"
  18018. }
  18019. },
  18020. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18021. },
  18022. "ContentsResponse": {
  18023. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  18024. "type": "object",
  18025. "properties": {
  18026. "_links": {
  18027. "$ref": "#/definitions/FileLinksResponse"
  18028. },
  18029. "content": {
  18030. "description": "`content` is populated when `type` is `file`, otherwise null",
  18031. "type": "string",
  18032. "x-go-name": "Content"
  18033. },
  18034. "download_url": {
  18035. "type": "string",
  18036. "x-go-name": "DownloadURL"
  18037. },
  18038. "encoding": {
  18039. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  18040. "type": "string",
  18041. "x-go-name": "Encoding"
  18042. },
  18043. "git_url": {
  18044. "type": "string",
  18045. "x-go-name": "GitURL"
  18046. },
  18047. "html_url": {
  18048. "type": "string",
  18049. "x-go-name": "HTMLURL"
  18050. },
  18051. "last_commit_sha": {
  18052. "type": "string",
  18053. "x-go-name": "LastCommitSHA"
  18054. },
  18055. "name": {
  18056. "type": "string",
  18057. "x-go-name": "Name"
  18058. },
  18059. "path": {
  18060. "type": "string",
  18061. "x-go-name": "Path"
  18062. },
  18063. "sha": {
  18064. "type": "string",
  18065. "x-go-name": "SHA"
  18066. },
  18067. "size": {
  18068. "type": "integer",
  18069. "format": "int64",
  18070. "x-go-name": "Size"
  18071. },
  18072. "submodule_git_url": {
  18073. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  18074. "type": "string",
  18075. "x-go-name": "SubmoduleGitURL"
  18076. },
  18077. "target": {
  18078. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  18079. "type": "string",
  18080. "x-go-name": "Target"
  18081. },
  18082. "type": {
  18083. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  18084. "type": "string",
  18085. "x-go-name": "Type"
  18086. },
  18087. "url": {
  18088. "type": "string",
  18089. "x-go-name": "URL"
  18090. }
  18091. },
  18092. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18093. },
  18094. "CreateAccessTokenOption": {
  18095. "description": "CreateAccessTokenOption options when create access token",
  18096. "type": "object",
  18097. "required": [
  18098. "name"
  18099. ],
  18100. "properties": {
  18101. "name": {
  18102. "type": "string",
  18103. "x-go-name": "Name"
  18104. },
  18105. "scopes": {
  18106. "type": "array",
  18107. "items": {
  18108. "type": "string"
  18109. },
  18110. "x-go-name": "Scopes"
  18111. }
  18112. },
  18113. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18114. },
  18115. "CreateBranchProtectionOption": {
  18116. "description": "CreateBranchProtectionOption options for creating a branch protection",
  18117. "type": "object",
  18118. "properties": {
  18119. "approvals_whitelist_teams": {
  18120. "type": "array",
  18121. "items": {
  18122. "type": "string"
  18123. },
  18124. "x-go-name": "ApprovalsWhitelistTeams"
  18125. },
  18126. "approvals_whitelist_username": {
  18127. "type": "array",
  18128. "items": {
  18129. "type": "string"
  18130. },
  18131. "x-go-name": "ApprovalsWhitelistUsernames"
  18132. },
  18133. "block_on_official_review_requests": {
  18134. "type": "boolean",
  18135. "x-go-name": "BlockOnOfficialReviewRequests"
  18136. },
  18137. "block_on_outdated_branch": {
  18138. "type": "boolean",
  18139. "x-go-name": "BlockOnOutdatedBranch"
  18140. },
  18141. "block_on_rejected_reviews": {
  18142. "type": "boolean",
  18143. "x-go-name": "BlockOnRejectedReviews"
  18144. },
  18145. "branch_name": {
  18146. "description": "Deprecated: true",
  18147. "type": "string",
  18148. "x-go-name": "BranchName"
  18149. },
  18150. "dismiss_stale_approvals": {
  18151. "type": "boolean",
  18152. "x-go-name": "DismissStaleApprovals"
  18153. },
  18154. "enable_approvals_whitelist": {
  18155. "type": "boolean",
  18156. "x-go-name": "EnableApprovalsWhitelist"
  18157. },
  18158. "enable_merge_whitelist": {
  18159. "type": "boolean",
  18160. "x-go-name": "EnableMergeWhitelist"
  18161. },
  18162. "enable_push": {
  18163. "type": "boolean",
  18164. "x-go-name": "EnablePush"
  18165. },
  18166. "enable_push_whitelist": {
  18167. "type": "boolean",
  18168. "x-go-name": "EnablePushWhitelist"
  18169. },
  18170. "enable_status_check": {
  18171. "type": "boolean",
  18172. "x-go-name": "EnableStatusCheck"
  18173. },
  18174. "ignore_stale_approvals": {
  18175. "type": "boolean",
  18176. "x-go-name": "IgnoreStaleApprovals"
  18177. },
  18178. "merge_whitelist_teams": {
  18179. "type": "array",
  18180. "items": {
  18181. "type": "string"
  18182. },
  18183. "x-go-name": "MergeWhitelistTeams"
  18184. },
  18185. "merge_whitelist_usernames": {
  18186. "type": "array",
  18187. "items": {
  18188. "type": "string"
  18189. },
  18190. "x-go-name": "MergeWhitelistUsernames"
  18191. },
  18192. "protected_file_patterns": {
  18193. "type": "string",
  18194. "x-go-name": "ProtectedFilePatterns"
  18195. },
  18196. "push_whitelist_deploy_keys": {
  18197. "type": "boolean",
  18198. "x-go-name": "PushWhitelistDeployKeys"
  18199. },
  18200. "push_whitelist_teams": {
  18201. "type": "array",
  18202. "items": {
  18203. "type": "string"
  18204. },
  18205. "x-go-name": "PushWhitelistTeams"
  18206. },
  18207. "push_whitelist_usernames": {
  18208. "type": "array",
  18209. "items": {
  18210. "type": "string"
  18211. },
  18212. "x-go-name": "PushWhitelistUsernames"
  18213. },
  18214. "require_signed_commits": {
  18215. "type": "boolean",
  18216. "x-go-name": "RequireSignedCommits"
  18217. },
  18218. "required_approvals": {
  18219. "type": "integer",
  18220. "format": "int64",
  18221. "x-go-name": "RequiredApprovals"
  18222. },
  18223. "rule_name": {
  18224. "type": "string",
  18225. "x-go-name": "RuleName"
  18226. },
  18227. "status_check_contexts": {
  18228. "type": "array",
  18229. "items": {
  18230. "type": "string"
  18231. },
  18232. "x-go-name": "StatusCheckContexts"
  18233. },
  18234. "unprotected_file_patterns": {
  18235. "type": "string",
  18236. "x-go-name": "UnprotectedFilePatterns"
  18237. }
  18238. },
  18239. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18240. },
  18241. "CreateBranchRepoOption": {
  18242. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  18243. "type": "object",
  18244. "required": [
  18245. "new_branch_name"
  18246. ],
  18247. "properties": {
  18248. "new_branch_name": {
  18249. "description": "Name of the branch to create",
  18250. "type": "string",
  18251. "uniqueItems": true,
  18252. "x-go-name": "BranchName"
  18253. },
  18254. "old_branch_name": {
  18255. "description": "Deprecated: true\nName of the old branch to create from",
  18256. "type": "string",
  18257. "uniqueItems": true,
  18258. "x-go-name": "OldBranchName"
  18259. },
  18260. "old_ref_name": {
  18261. "description": "Name of the old branch/tag/commit to create from",
  18262. "type": "string",
  18263. "uniqueItems": true,
  18264. "x-go-name": "OldRefName"
  18265. }
  18266. },
  18267. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18268. },
  18269. "CreateEmailOption": {
  18270. "description": "CreateEmailOption options when creating email addresses",
  18271. "type": "object",
  18272. "properties": {
  18273. "emails": {
  18274. "description": "email addresses to add",
  18275. "type": "array",
  18276. "items": {
  18277. "type": "string"
  18278. },
  18279. "x-go-name": "Emails"
  18280. }
  18281. },
  18282. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18283. },
  18284. "CreateFileOptions": {
  18285. "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)",
  18286. "type": "object",
  18287. "required": [
  18288. "content"
  18289. ],
  18290. "properties": {
  18291. "author": {
  18292. "$ref": "#/definitions/Identity"
  18293. },
  18294. "branch": {
  18295. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  18296. "type": "string",
  18297. "x-go-name": "BranchName"
  18298. },
  18299. "committer": {
  18300. "$ref": "#/definitions/Identity"
  18301. },
  18302. "content": {
  18303. "description": "content must be base64 encoded",
  18304. "type": "string",
  18305. "x-go-name": "ContentBase64"
  18306. },
  18307. "dates": {
  18308. "$ref": "#/definitions/CommitDateOptions"
  18309. },
  18310. "message": {
  18311. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  18312. "type": "string",
  18313. "x-go-name": "Message"
  18314. },
  18315. "new_branch": {
  18316. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  18317. "type": "string",
  18318. "x-go-name": "NewBranchName"
  18319. },
  18320. "signoff": {
  18321. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  18322. "type": "boolean",
  18323. "x-go-name": "Signoff"
  18324. }
  18325. },
  18326. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18327. },
  18328. "CreateForkOption": {
  18329. "description": "CreateForkOption options for creating a fork",
  18330. "type": "object",
  18331. "properties": {
  18332. "name": {
  18333. "description": "name of the forked repository",
  18334. "type": "string",
  18335. "x-go-name": "Name"
  18336. },
  18337. "organization": {
  18338. "description": "organization name, if forking into an organization",
  18339. "type": "string",
  18340. "x-go-name": "Organization"
  18341. }
  18342. },
  18343. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18344. },
  18345. "CreateGPGKeyOption": {
  18346. "description": "CreateGPGKeyOption options create user GPG key",
  18347. "type": "object",
  18348. "required": [
  18349. "armored_public_key"
  18350. ],
  18351. "properties": {
  18352. "armored_public_key": {
  18353. "description": "An armored GPG key to add",
  18354. "type": "string",
  18355. "uniqueItems": true,
  18356. "x-go-name": "ArmoredKey"
  18357. },
  18358. "armored_signature": {
  18359. "type": "string",
  18360. "x-go-name": "Signature"
  18361. }
  18362. },
  18363. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18364. },
  18365. "CreateHookOption": {
  18366. "description": "CreateHookOption options when create a hook",
  18367. "type": "object",
  18368. "required": [
  18369. "type",
  18370. "config"
  18371. ],
  18372. "properties": {
  18373. "active": {
  18374. "type": "boolean",
  18375. "default": false,
  18376. "x-go-name": "Active"
  18377. },
  18378. "authorization_header": {
  18379. "type": "string",
  18380. "x-go-name": "AuthorizationHeader"
  18381. },
  18382. "branch_filter": {
  18383. "type": "string",
  18384. "x-go-name": "BranchFilter"
  18385. },
  18386. "config": {
  18387. "$ref": "#/definitions/CreateHookOptionConfig"
  18388. },
  18389. "events": {
  18390. "type": "array",
  18391. "items": {
  18392. "type": "string"
  18393. },
  18394. "x-go-name": "Events"
  18395. },
  18396. "type": {
  18397. "type": "string",
  18398. "enum": [
  18399. "dingtalk",
  18400. "discord",
  18401. "gitea",
  18402. "gogs",
  18403. "msteams",
  18404. "slack",
  18405. "telegram",
  18406. "feishu",
  18407. "wechatwork",
  18408. "packagist"
  18409. ],
  18410. "x-go-name": "Type"
  18411. }
  18412. },
  18413. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18414. },
  18415. "CreateHookOptionConfig": {
  18416. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  18417. "type": "object",
  18418. "additionalProperties": {
  18419. "type": "string"
  18420. },
  18421. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18422. },
  18423. "CreateIssueCommentOption": {
  18424. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  18425. "type": "object",
  18426. "required": [
  18427. "body"
  18428. ],
  18429. "properties": {
  18430. "body": {
  18431. "type": "string",
  18432. "x-go-name": "Body"
  18433. }
  18434. },
  18435. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18436. },
  18437. "CreateIssueOption": {
  18438. "description": "CreateIssueOption options to create one issue",
  18439. "type": "object",
  18440. "required": [
  18441. "title"
  18442. ],
  18443. "properties": {
  18444. "assignee": {
  18445. "description": "deprecated",
  18446. "type": "string",
  18447. "x-go-name": "Assignee"
  18448. },
  18449. "assignees": {
  18450. "type": "array",
  18451. "items": {
  18452. "type": "string"
  18453. },
  18454. "x-go-name": "Assignees"
  18455. },
  18456. "body": {
  18457. "type": "string",
  18458. "x-go-name": "Body"
  18459. },
  18460. "closed": {
  18461. "type": "boolean",
  18462. "x-go-name": "Closed"
  18463. },
  18464. "due_date": {
  18465. "type": "string",
  18466. "format": "date-time",
  18467. "x-go-name": "Deadline"
  18468. },
  18469. "labels": {
  18470. "description": "list of label ids",
  18471. "type": "array",
  18472. "items": {
  18473. "type": "integer",
  18474. "format": "int64"
  18475. },
  18476. "x-go-name": "Labels"
  18477. },
  18478. "milestone": {
  18479. "description": "milestone id",
  18480. "type": "integer",
  18481. "format": "int64",
  18482. "x-go-name": "Milestone"
  18483. },
  18484. "ref": {
  18485. "type": "string",
  18486. "x-go-name": "Ref"
  18487. },
  18488. "title": {
  18489. "type": "string",
  18490. "x-go-name": "Title"
  18491. }
  18492. },
  18493. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18494. },
  18495. "CreateKeyOption": {
  18496. "description": "CreateKeyOption options when creating a key",
  18497. "type": "object",
  18498. "required": [
  18499. "title",
  18500. "key"
  18501. ],
  18502. "properties": {
  18503. "key": {
  18504. "description": "An armored SSH key to add",
  18505. "type": "string",
  18506. "uniqueItems": true,
  18507. "x-go-name": "Key"
  18508. },
  18509. "read_only": {
  18510. "description": "Describe if the key has only read access or read/write",
  18511. "type": "boolean",
  18512. "x-go-name": "ReadOnly"
  18513. },
  18514. "title": {
  18515. "description": "Title of the key to add",
  18516. "type": "string",
  18517. "uniqueItems": true,
  18518. "x-go-name": "Title"
  18519. }
  18520. },
  18521. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18522. },
  18523. "CreateLabelOption": {
  18524. "description": "CreateLabelOption options for creating a label",
  18525. "type": "object",
  18526. "required": [
  18527. "name",
  18528. "color"
  18529. ],
  18530. "properties": {
  18531. "color": {
  18532. "type": "string",
  18533. "x-go-name": "Color",
  18534. "example": "#00aabb"
  18535. },
  18536. "description": {
  18537. "type": "string",
  18538. "x-go-name": "Description"
  18539. },
  18540. "exclusive": {
  18541. "type": "boolean",
  18542. "x-go-name": "Exclusive",
  18543. "example": false
  18544. },
  18545. "is_archived": {
  18546. "type": "boolean",
  18547. "x-go-name": "IsArchived",
  18548. "example": false
  18549. },
  18550. "name": {
  18551. "type": "string",
  18552. "x-go-name": "Name"
  18553. }
  18554. },
  18555. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18556. },
  18557. "CreateMilestoneOption": {
  18558. "description": "CreateMilestoneOption options for creating a milestone",
  18559. "type": "object",
  18560. "properties": {
  18561. "description": {
  18562. "type": "string",
  18563. "x-go-name": "Description"
  18564. },
  18565. "due_on": {
  18566. "type": "string",
  18567. "format": "date-time",
  18568. "x-go-name": "Deadline"
  18569. },
  18570. "state": {
  18571. "type": "string",
  18572. "enum": [
  18573. "open",
  18574. "closed"
  18575. ],
  18576. "x-go-name": "State"
  18577. },
  18578. "title": {
  18579. "type": "string",
  18580. "x-go-name": "Title"
  18581. }
  18582. },
  18583. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18584. },
  18585. "CreateOAuth2ApplicationOptions": {
  18586. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  18587. "type": "object",
  18588. "properties": {
  18589. "confidential_client": {
  18590. "type": "boolean",
  18591. "x-go-name": "ConfidentialClient"
  18592. },
  18593. "name": {
  18594. "type": "string",
  18595. "x-go-name": "Name"
  18596. },
  18597. "redirect_uris": {
  18598. "type": "array",
  18599. "items": {
  18600. "type": "string"
  18601. },
  18602. "x-go-name": "RedirectURIs"
  18603. }
  18604. },
  18605. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18606. },
  18607. "CreateOrUpdateSecretOption": {
  18608. "description": "CreateOrUpdateSecretOption options when creating or updating secret",
  18609. "type": "object",
  18610. "required": [
  18611. "data"
  18612. ],
  18613. "properties": {
  18614. "data": {
  18615. "description": "Data of the secret to update",
  18616. "type": "string",
  18617. "x-go-name": "Data"
  18618. }
  18619. },
  18620. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18621. },
  18622. "CreateOrgOption": {
  18623. "description": "CreateOrgOption options for creating an organization",
  18624. "type": "object",
  18625. "required": [
  18626. "username"
  18627. ],
  18628. "properties": {
  18629. "description": {
  18630. "type": "string",
  18631. "x-go-name": "Description"
  18632. },
  18633. "email": {
  18634. "type": "string",
  18635. "x-go-name": "Email"
  18636. },
  18637. "full_name": {
  18638. "type": "string",
  18639. "x-go-name": "FullName"
  18640. },
  18641. "location": {
  18642. "type": "string",
  18643. "x-go-name": "Location"
  18644. },
  18645. "repo_admin_change_team_access": {
  18646. "type": "boolean",
  18647. "x-go-name": "RepoAdminChangeTeamAccess"
  18648. },
  18649. "username": {
  18650. "type": "string",
  18651. "x-go-name": "UserName"
  18652. },
  18653. "visibility": {
  18654. "description": "possible values are `public` (default), `limited` or `private`",
  18655. "type": "string",
  18656. "enum": [
  18657. "public",
  18658. "limited",
  18659. "private"
  18660. ],
  18661. "x-go-name": "Visibility"
  18662. },
  18663. "website": {
  18664. "type": "string",
  18665. "x-go-name": "Website"
  18666. }
  18667. },
  18668. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18669. },
  18670. "CreatePullRequestOption": {
  18671. "description": "CreatePullRequestOption options when creating a pull request",
  18672. "type": "object",
  18673. "properties": {
  18674. "assignee": {
  18675. "type": "string",
  18676. "x-go-name": "Assignee"
  18677. },
  18678. "assignees": {
  18679. "type": "array",
  18680. "items": {
  18681. "type": "string"
  18682. },
  18683. "x-go-name": "Assignees"
  18684. },
  18685. "base": {
  18686. "type": "string",
  18687. "x-go-name": "Base"
  18688. },
  18689. "body": {
  18690. "type": "string",
  18691. "x-go-name": "Body"
  18692. },
  18693. "due_date": {
  18694. "type": "string",
  18695. "format": "date-time",
  18696. "x-go-name": "Deadline"
  18697. },
  18698. "head": {
  18699. "type": "string",
  18700. "x-go-name": "Head"
  18701. },
  18702. "labels": {
  18703. "type": "array",
  18704. "items": {
  18705. "type": "integer",
  18706. "format": "int64"
  18707. },
  18708. "x-go-name": "Labels"
  18709. },
  18710. "milestone": {
  18711. "type": "integer",
  18712. "format": "int64",
  18713. "x-go-name": "Milestone"
  18714. },
  18715. "title": {
  18716. "type": "string",
  18717. "x-go-name": "Title"
  18718. }
  18719. },
  18720. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18721. },
  18722. "CreatePullReviewComment": {
  18723. "description": "CreatePullReviewComment represent a review comment for creation api",
  18724. "type": "object",
  18725. "properties": {
  18726. "body": {
  18727. "type": "string",
  18728. "x-go-name": "Body"
  18729. },
  18730. "new_position": {
  18731. "description": "if comment to new file line or 0",
  18732. "type": "integer",
  18733. "format": "int64",
  18734. "x-go-name": "NewLineNum"
  18735. },
  18736. "old_position": {
  18737. "description": "if comment to old file line or 0",
  18738. "type": "integer",
  18739. "format": "int64",
  18740. "x-go-name": "OldLineNum"
  18741. },
  18742. "path": {
  18743. "description": "the tree path",
  18744. "type": "string",
  18745. "x-go-name": "Path"
  18746. }
  18747. },
  18748. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18749. },
  18750. "CreatePullReviewOptions": {
  18751. "description": "CreatePullReviewOptions are options to create a pull review",
  18752. "type": "object",
  18753. "properties": {
  18754. "body": {
  18755. "type": "string",
  18756. "x-go-name": "Body"
  18757. },
  18758. "comments": {
  18759. "type": "array",
  18760. "items": {
  18761. "$ref": "#/definitions/CreatePullReviewComment"
  18762. },
  18763. "x-go-name": "Comments"
  18764. },
  18765. "commit_id": {
  18766. "type": "string",
  18767. "x-go-name": "CommitID"
  18768. },
  18769. "event": {
  18770. "$ref": "#/definitions/ReviewStateType"
  18771. }
  18772. },
  18773. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18774. },
  18775. "CreatePushMirrorOption": {
  18776. "type": "object",
  18777. "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
  18778. "properties": {
  18779. "interval": {
  18780. "type": "string",
  18781. "x-go-name": "Interval"
  18782. },
  18783. "remote_address": {
  18784. "type": "string",
  18785. "x-go-name": "RemoteAddress"
  18786. },
  18787. "remote_password": {
  18788. "type": "string",
  18789. "x-go-name": "RemotePassword"
  18790. },
  18791. "remote_username": {
  18792. "type": "string",
  18793. "x-go-name": "RemoteUsername"
  18794. },
  18795. "sync_on_commit": {
  18796. "type": "boolean",
  18797. "x-go-name": "SyncOnCommit"
  18798. }
  18799. },
  18800. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18801. },
  18802. "CreateReleaseOption": {
  18803. "description": "CreateReleaseOption options when creating a release",
  18804. "type": "object",
  18805. "required": [
  18806. "tag_name"
  18807. ],
  18808. "properties": {
  18809. "body": {
  18810. "type": "string",
  18811. "x-go-name": "Note"
  18812. },
  18813. "draft": {
  18814. "type": "boolean",
  18815. "x-go-name": "IsDraft"
  18816. },
  18817. "name": {
  18818. "type": "string",
  18819. "x-go-name": "Title"
  18820. },
  18821. "prerelease": {
  18822. "type": "boolean",
  18823. "x-go-name": "IsPrerelease"
  18824. },
  18825. "tag_name": {
  18826. "type": "string",
  18827. "x-go-name": "TagName"
  18828. },
  18829. "target_commitish": {
  18830. "type": "string",
  18831. "x-go-name": "Target"
  18832. }
  18833. },
  18834. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18835. },
  18836. "CreateRepoOption": {
  18837. "description": "CreateRepoOption options when creating repository",
  18838. "type": "object",
  18839. "required": [
  18840. "name"
  18841. ],
  18842. "properties": {
  18843. "auto_init": {
  18844. "description": "Whether the repository should be auto-initialized?",
  18845. "type": "boolean",
  18846. "x-go-name": "AutoInit"
  18847. },
  18848. "default_branch": {
  18849. "description": "DefaultBranch of the repository (used when initializes and in template)",
  18850. "type": "string",
  18851. "x-go-name": "DefaultBranch"
  18852. },
  18853. "description": {
  18854. "description": "Description of the repository to create",
  18855. "type": "string",
  18856. "x-go-name": "Description"
  18857. },
  18858. "gitignores": {
  18859. "description": "Gitignores to use",
  18860. "type": "string",
  18861. "x-go-name": "Gitignores"
  18862. },
  18863. "issue_labels": {
  18864. "description": "Label-Set to use",
  18865. "type": "string",
  18866. "x-go-name": "IssueLabels"
  18867. },
  18868. "license": {
  18869. "description": "License to use",
  18870. "type": "string",
  18871. "x-go-name": "License"
  18872. },
  18873. "name": {
  18874. "description": "Name of the repository to create",
  18875. "type": "string",
  18876. "uniqueItems": true,
  18877. "x-go-name": "Name"
  18878. },
  18879. "object_format_name": {
  18880. "description": "ObjectFormatName of the underlying git repository",
  18881. "type": "string",
  18882. "enum": [
  18883. "sha1",
  18884. "sha256"
  18885. ],
  18886. "x-go-name": "ObjectFormatName"
  18887. },
  18888. "private": {
  18889. "description": "Whether the repository is private",
  18890. "type": "boolean",
  18891. "x-go-name": "Private"
  18892. },
  18893. "readme": {
  18894. "description": "Readme of the repository to create",
  18895. "type": "string",
  18896. "x-go-name": "Readme"
  18897. },
  18898. "template": {
  18899. "description": "Whether the repository is template",
  18900. "type": "boolean",
  18901. "x-go-name": "Template"
  18902. },
  18903. "trust_model": {
  18904. "description": "TrustModel of the repository",
  18905. "type": "string",
  18906. "enum": [
  18907. "default",
  18908. "collaborator",
  18909. "committer",
  18910. "collaboratorcommitter"
  18911. ],
  18912. "x-go-name": "TrustModel"
  18913. }
  18914. },
  18915. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18916. },
  18917. "CreateStatusOption": {
  18918. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  18919. "type": "object",
  18920. "properties": {
  18921. "context": {
  18922. "type": "string",
  18923. "x-go-name": "Context"
  18924. },
  18925. "description": {
  18926. "type": "string",
  18927. "x-go-name": "Description"
  18928. },
  18929. "state": {
  18930. "$ref": "#/definitions/CommitStatusState"
  18931. },
  18932. "target_url": {
  18933. "type": "string",
  18934. "x-go-name": "TargetURL"
  18935. }
  18936. },
  18937. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18938. },
  18939. "CreateTagOption": {
  18940. "description": "CreateTagOption options when creating a tag",
  18941. "type": "object",
  18942. "required": [
  18943. "tag_name"
  18944. ],
  18945. "properties": {
  18946. "message": {
  18947. "type": "string",
  18948. "x-go-name": "Message"
  18949. },
  18950. "tag_name": {
  18951. "type": "string",
  18952. "x-go-name": "TagName"
  18953. },
  18954. "target": {
  18955. "type": "string",
  18956. "x-go-name": "Target"
  18957. }
  18958. },
  18959. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18960. },
  18961. "CreateTeamOption": {
  18962. "description": "CreateTeamOption options for creating a team",
  18963. "type": "object",
  18964. "required": [
  18965. "name"
  18966. ],
  18967. "properties": {
  18968. "can_create_org_repo": {
  18969. "type": "boolean",
  18970. "x-go-name": "CanCreateOrgRepo"
  18971. },
  18972. "description": {
  18973. "type": "string",
  18974. "x-go-name": "Description"
  18975. },
  18976. "includes_all_repositories": {
  18977. "type": "boolean",
  18978. "x-go-name": "IncludesAllRepositories"
  18979. },
  18980. "name": {
  18981. "type": "string",
  18982. "x-go-name": "Name"
  18983. },
  18984. "permission": {
  18985. "type": "string",
  18986. "enum": [
  18987. "read",
  18988. "write",
  18989. "admin"
  18990. ],
  18991. "x-go-name": "Permission"
  18992. },
  18993. "units": {
  18994. "type": "array",
  18995. "items": {
  18996. "type": "string"
  18997. },
  18998. "x-go-name": "Units",
  18999. "example": [
  19000. "repo.actions",
  19001. "repo.code",
  19002. "repo.issues",
  19003. "repo.ext_issues",
  19004. "repo.wiki",
  19005. "repo.ext_wiki",
  19006. "repo.pulls",
  19007. "repo.releases",
  19008. "repo.projects",
  19009. "repo.ext_wiki"
  19010. ]
  19011. },
  19012. "units_map": {
  19013. "type": "object",
  19014. "additionalProperties": {
  19015. "type": "string"
  19016. },
  19017. "x-go-name": "UnitsMap",
  19018. "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\"}"
  19019. }
  19020. },
  19021. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19022. },
  19023. "CreateUserOption": {
  19024. "description": "CreateUserOption create user options",
  19025. "type": "object",
  19026. "required": [
  19027. "username",
  19028. "email"
  19029. ],
  19030. "properties": {
  19031. "created_at": {
  19032. "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\".",
  19033. "type": "string",
  19034. "format": "date-time",
  19035. "x-go-name": "Created"
  19036. },
  19037. "email": {
  19038. "type": "string",
  19039. "format": "email",
  19040. "x-go-name": "Email"
  19041. },
  19042. "full_name": {
  19043. "type": "string",
  19044. "x-go-name": "FullName"
  19045. },
  19046. "login_name": {
  19047. "type": "string",
  19048. "x-go-name": "LoginName"
  19049. },
  19050. "must_change_password": {
  19051. "type": "boolean",
  19052. "x-go-name": "MustChangePassword"
  19053. },
  19054. "password": {
  19055. "type": "string",
  19056. "x-go-name": "Password"
  19057. },
  19058. "restricted": {
  19059. "type": "boolean",
  19060. "x-go-name": "Restricted"
  19061. },
  19062. "send_notify": {
  19063. "type": "boolean",
  19064. "x-go-name": "SendNotify"
  19065. },
  19066. "source_id": {
  19067. "type": "integer",
  19068. "format": "int64",
  19069. "x-go-name": "SourceID"
  19070. },
  19071. "username": {
  19072. "type": "string",
  19073. "x-go-name": "Username"
  19074. },
  19075. "visibility": {
  19076. "type": "string",
  19077. "x-go-name": "Visibility"
  19078. }
  19079. },
  19080. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19081. },
  19082. "CreateWikiPageOptions": {
  19083. "description": "CreateWikiPageOptions form for creating wiki",
  19084. "type": "object",
  19085. "properties": {
  19086. "content_base64": {
  19087. "description": "content must be base64 encoded",
  19088. "type": "string",
  19089. "x-go-name": "ContentBase64"
  19090. },
  19091. "message": {
  19092. "description": "optional commit message summarizing the change",
  19093. "type": "string",
  19094. "x-go-name": "Message"
  19095. },
  19096. "title": {
  19097. "description": "page title. leave empty to keep unchanged",
  19098. "type": "string",
  19099. "x-go-name": "Title"
  19100. }
  19101. },
  19102. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19103. },
  19104. "Cron": {
  19105. "description": "Cron represents a Cron task",
  19106. "type": "object",
  19107. "properties": {
  19108. "exec_times": {
  19109. "type": "integer",
  19110. "format": "int64",
  19111. "x-go-name": "ExecTimes"
  19112. },
  19113. "name": {
  19114. "type": "string",
  19115. "x-go-name": "Name"
  19116. },
  19117. "next": {
  19118. "type": "string",
  19119. "format": "date-time",
  19120. "x-go-name": "Next"
  19121. },
  19122. "prev": {
  19123. "type": "string",
  19124. "format": "date-time",
  19125. "x-go-name": "Prev"
  19126. },
  19127. "schedule": {
  19128. "type": "string",
  19129. "x-go-name": "Schedule"
  19130. }
  19131. },
  19132. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19133. },
  19134. "DeleteEmailOption": {
  19135. "description": "DeleteEmailOption options when deleting email addresses",
  19136. "type": "object",
  19137. "properties": {
  19138. "emails": {
  19139. "description": "email addresses to delete",
  19140. "type": "array",
  19141. "items": {
  19142. "type": "string"
  19143. },
  19144. "x-go-name": "Emails"
  19145. }
  19146. },
  19147. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19148. },
  19149. "DeleteFileOptions": {
  19150. "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)",
  19151. "type": "object",
  19152. "required": [
  19153. "sha"
  19154. ],
  19155. "properties": {
  19156. "author": {
  19157. "$ref": "#/definitions/Identity"
  19158. },
  19159. "branch": {
  19160. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  19161. "type": "string",
  19162. "x-go-name": "BranchName"
  19163. },
  19164. "committer": {
  19165. "$ref": "#/definitions/Identity"
  19166. },
  19167. "dates": {
  19168. "$ref": "#/definitions/CommitDateOptions"
  19169. },
  19170. "message": {
  19171. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  19172. "type": "string",
  19173. "x-go-name": "Message"
  19174. },
  19175. "new_branch": {
  19176. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  19177. "type": "string",
  19178. "x-go-name": "NewBranchName"
  19179. },
  19180. "sha": {
  19181. "description": "sha is the SHA for the file that already exists",
  19182. "type": "string",
  19183. "x-go-name": "SHA"
  19184. },
  19185. "signoff": {
  19186. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  19187. "type": "boolean",
  19188. "x-go-name": "Signoff"
  19189. }
  19190. },
  19191. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19192. },
  19193. "DeployKey": {
  19194. "description": "DeployKey a deploy key",
  19195. "type": "object",
  19196. "properties": {
  19197. "created_at": {
  19198. "type": "string",
  19199. "format": "date-time",
  19200. "x-go-name": "Created"
  19201. },
  19202. "fingerprint": {
  19203. "type": "string",
  19204. "x-go-name": "Fingerprint"
  19205. },
  19206. "id": {
  19207. "type": "integer",
  19208. "format": "int64",
  19209. "x-go-name": "ID"
  19210. },
  19211. "key": {
  19212. "type": "string",
  19213. "x-go-name": "Key"
  19214. },
  19215. "key_id": {
  19216. "type": "integer",
  19217. "format": "int64",
  19218. "x-go-name": "KeyID"
  19219. },
  19220. "read_only": {
  19221. "type": "boolean",
  19222. "x-go-name": "ReadOnly"
  19223. },
  19224. "repository": {
  19225. "$ref": "#/definitions/Repository"
  19226. },
  19227. "title": {
  19228. "type": "string",
  19229. "x-go-name": "Title"
  19230. },
  19231. "url": {
  19232. "type": "string",
  19233. "x-go-name": "URL"
  19234. }
  19235. },
  19236. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19237. },
  19238. "DismissPullReviewOptions": {
  19239. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  19240. "type": "object",
  19241. "properties": {
  19242. "message": {
  19243. "type": "string",
  19244. "x-go-name": "Message"
  19245. },
  19246. "priors": {
  19247. "type": "boolean",
  19248. "x-go-name": "Priors"
  19249. }
  19250. },
  19251. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19252. },
  19253. "EditAttachmentOptions": {
  19254. "description": "EditAttachmentOptions options for editing attachments",
  19255. "type": "object",
  19256. "properties": {
  19257. "name": {
  19258. "type": "string",
  19259. "x-go-name": "Name"
  19260. }
  19261. },
  19262. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19263. },
  19264. "EditBranchProtectionOption": {
  19265. "description": "EditBranchProtectionOption options for editing a branch protection",
  19266. "type": "object",
  19267. "properties": {
  19268. "approvals_whitelist_teams": {
  19269. "type": "array",
  19270. "items": {
  19271. "type": "string"
  19272. },
  19273. "x-go-name": "ApprovalsWhitelistTeams"
  19274. },
  19275. "approvals_whitelist_username": {
  19276. "type": "array",
  19277. "items": {
  19278. "type": "string"
  19279. },
  19280. "x-go-name": "ApprovalsWhitelistUsernames"
  19281. },
  19282. "block_on_official_review_requests": {
  19283. "type": "boolean",
  19284. "x-go-name": "BlockOnOfficialReviewRequests"
  19285. },
  19286. "block_on_outdated_branch": {
  19287. "type": "boolean",
  19288. "x-go-name": "BlockOnOutdatedBranch"
  19289. },
  19290. "block_on_rejected_reviews": {
  19291. "type": "boolean",
  19292. "x-go-name": "BlockOnRejectedReviews"
  19293. },
  19294. "dismiss_stale_approvals": {
  19295. "type": "boolean",
  19296. "x-go-name": "DismissStaleApprovals"
  19297. },
  19298. "enable_approvals_whitelist": {
  19299. "type": "boolean",
  19300. "x-go-name": "EnableApprovalsWhitelist"
  19301. },
  19302. "enable_merge_whitelist": {
  19303. "type": "boolean",
  19304. "x-go-name": "EnableMergeWhitelist"
  19305. },
  19306. "enable_push": {
  19307. "type": "boolean",
  19308. "x-go-name": "EnablePush"
  19309. },
  19310. "enable_push_whitelist": {
  19311. "type": "boolean",
  19312. "x-go-name": "EnablePushWhitelist"
  19313. },
  19314. "enable_status_check": {
  19315. "type": "boolean",
  19316. "x-go-name": "EnableStatusCheck"
  19317. },
  19318. "ignore_stale_approvals": {
  19319. "type": "boolean",
  19320. "x-go-name": "IgnoreStaleApprovals"
  19321. },
  19322. "merge_whitelist_teams": {
  19323. "type": "array",
  19324. "items": {
  19325. "type": "string"
  19326. },
  19327. "x-go-name": "MergeWhitelistTeams"
  19328. },
  19329. "merge_whitelist_usernames": {
  19330. "type": "array",
  19331. "items": {
  19332. "type": "string"
  19333. },
  19334. "x-go-name": "MergeWhitelistUsernames"
  19335. },
  19336. "protected_file_patterns": {
  19337. "type": "string",
  19338. "x-go-name": "ProtectedFilePatterns"
  19339. },
  19340. "push_whitelist_deploy_keys": {
  19341. "type": "boolean",
  19342. "x-go-name": "PushWhitelistDeployKeys"
  19343. },
  19344. "push_whitelist_teams": {
  19345. "type": "array",
  19346. "items": {
  19347. "type": "string"
  19348. },
  19349. "x-go-name": "PushWhitelistTeams"
  19350. },
  19351. "push_whitelist_usernames": {
  19352. "type": "array",
  19353. "items": {
  19354. "type": "string"
  19355. },
  19356. "x-go-name": "PushWhitelistUsernames"
  19357. },
  19358. "require_signed_commits": {
  19359. "type": "boolean",
  19360. "x-go-name": "RequireSignedCommits"
  19361. },
  19362. "required_approvals": {
  19363. "type": "integer",
  19364. "format": "int64",
  19365. "x-go-name": "RequiredApprovals"
  19366. },
  19367. "status_check_contexts": {
  19368. "type": "array",
  19369. "items": {
  19370. "type": "string"
  19371. },
  19372. "x-go-name": "StatusCheckContexts"
  19373. },
  19374. "unprotected_file_patterns": {
  19375. "type": "string",
  19376. "x-go-name": "UnprotectedFilePatterns"
  19377. }
  19378. },
  19379. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19380. },
  19381. "EditDeadlineOption": {
  19382. "description": "EditDeadlineOption options for creating a deadline",
  19383. "type": "object",
  19384. "required": [
  19385. "due_date"
  19386. ],
  19387. "properties": {
  19388. "due_date": {
  19389. "type": "string",
  19390. "format": "date-time",
  19391. "x-go-name": "Deadline"
  19392. }
  19393. },
  19394. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19395. },
  19396. "EditGitHookOption": {
  19397. "description": "EditGitHookOption options when modifying one Git hook",
  19398. "type": "object",
  19399. "properties": {
  19400. "content": {
  19401. "type": "string",
  19402. "x-go-name": "Content"
  19403. }
  19404. },
  19405. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19406. },
  19407. "EditHookOption": {
  19408. "description": "EditHookOption options when modify one hook",
  19409. "type": "object",
  19410. "properties": {
  19411. "active": {
  19412. "type": "boolean",
  19413. "x-go-name": "Active"
  19414. },
  19415. "authorization_header": {
  19416. "type": "string",
  19417. "x-go-name": "AuthorizationHeader"
  19418. },
  19419. "branch_filter": {
  19420. "type": "string",
  19421. "x-go-name": "BranchFilter"
  19422. },
  19423. "config": {
  19424. "type": "object",
  19425. "additionalProperties": {
  19426. "type": "string"
  19427. },
  19428. "x-go-name": "Config"
  19429. },
  19430. "events": {
  19431. "type": "array",
  19432. "items": {
  19433. "type": "string"
  19434. },
  19435. "x-go-name": "Events"
  19436. }
  19437. },
  19438. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19439. },
  19440. "EditIssueCommentOption": {
  19441. "description": "EditIssueCommentOption options for editing a comment",
  19442. "type": "object",
  19443. "required": [
  19444. "body"
  19445. ],
  19446. "properties": {
  19447. "body": {
  19448. "type": "string",
  19449. "x-go-name": "Body"
  19450. }
  19451. },
  19452. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19453. },
  19454. "EditIssueOption": {
  19455. "description": "EditIssueOption options for editing an issue",
  19456. "type": "object",
  19457. "properties": {
  19458. "assignee": {
  19459. "description": "deprecated",
  19460. "type": "string",
  19461. "x-go-name": "Assignee"
  19462. },
  19463. "assignees": {
  19464. "type": "array",
  19465. "items": {
  19466. "type": "string"
  19467. },
  19468. "x-go-name": "Assignees"
  19469. },
  19470. "body": {
  19471. "type": "string",
  19472. "x-go-name": "Body"
  19473. },
  19474. "due_date": {
  19475. "type": "string",
  19476. "format": "date-time",
  19477. "x-go-name": "Deadline"
  19478. },
  19479. "milestone": {
  19480. "type": "integer",
  19481. "format": "int64",
  19482. "x-go-name": "Milestone"
  19483. },
  19484. "ref": {
  19485. "type": "string",
  19486. "x-go-name": "Ref"
  19487. },
  19488. "state": {
  19489. "type": "string",
  19490. "x-go-name": "State"
  19491. },
  19492. "title": {
  19493. "type": "string",
  19494. "x-go-name": "Title"
  19495. },
  19496. "unset_due_date": {
  19497. "type": "boolean",
  19498. "x-go-name": "RemoveDeadline"
  19499. }
  19500. },
  19501. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19502. },
  19503. "EditLabelOption": {
  19504. "description": "EditLabelOption options for editing a label",
  19505. "type": "object",
  19506. "properties": {
  19507. "color": {
  19508. "type": "string",
  19509. "x-go-name": "Color",
  19510. "example": "#00aabb"
  19511. },
  19512. "description": {
  19513. "type": "string",
  19514. "x-go-name": "Description"
  19515. },
  19516. "exclusive": {
  19517. "type": "boolean",
  19518. "x-go-name": "Exclusive",
  19519. "example": false
  19520. },
  19521. "is_archived": {
  19522. "type": "boolean",
  19523. "x-go-name": "IsArchived",
  19524. "example": false
  19525. },
  19526. "name": {
  19527. "type": "string",
  19528. "x-go-name": "Name"
  19529. }
  19530. },
  19531. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19532. },
  19533. "EditMilestoneOption": {
  19534. "description": "EditMilestoneOption options for editing a milestone",
  19535. "type": "object",
  19536. "properties": {
  19537. "description": {
  19538. "type": "string",
  19539. "x-go-name": "Description"
  19540. },
  19541. "due_on": {
  19542. "type": "string",
  19543. "format": "date-time",
  19544. "x-go-name": "Deadline"
  19545. },
  19546. "state": {
  19547. "type": "string",
  19548. "x-go-name": "State"
  19549. },
  19550. "title": {
  19551. "type": "string",
  19552. "x-go-name": "Title"
  19553. }
  19554. },
  19555. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19556. },
  19557. "EditOrgOption": {
  19558. "description": "EditOrgOption options for editing an organization",
  19559. "type": "object",
  19560. "properties": {
  19561. "description": {
  19562. "type": "string",
  19563. "x-go-name": "Description"
  19564. },
  19565. "email": {
  19566. "type": "string",
  19567. "x-go-name": "Email"
  19568. },
  19569. "full_name": {
  19570. "type": "string",
  19571. "x-go-name": "FullName"
  19572. },
  19573. "location": {
  19574. "type": "string",
  19575. "x-go-name": "Location"
  19576. },
  19577. "repo_admin_change_team_access": {
  19578. "type": "boolean",
  19579. "x-go-name": "RepoAdminChangeTeamAccess"
  19580. },
  19581. "visibility": {
  19582. "description": "possible values are `public`, `limited` or `private`",
  19583. "type": "string",
  19584. "enum": [
  19585. "public",
  19586. "limited",
  19587. "private"
  19588. ],
  19589. "x-go-name": "Visibility"
  19590. },
  19591. "website": {
  19592. "type": "string",
  19593. "x-go-name": "Website"
  19594. }
  19595. },
  19596. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19597. },
  19598. "EditPullRequestOption": {
  19599. "description": "EditPullRequestOption options when modify pull request",
  19600. "type": "object",
  19601. "properties": {
  19602. "allow_maintainer_edit": {
  19603. "type": "boolean",
  19604. "x-go-name": "AllowMaintainerEdit"
  19605. },
  19606. "assignee": {
  19607. "type": "string",
  19608. "x-go-name": "Assignee"
  19609. },
  19610. "assignees": {
  19611. "type": "array",
  19612. "items": {
  19613. "type": "string"
  19614. },
  19615. "x-go-name": "Assignees"
  19616. },
  19617. "base": {
  19618. "type": "string",
  19619. "x-go-name": "Base"
  19620. },
  19621. "body": {
  19622. "type": "string",
  19623. "x-go-name": "Body"
  19624. },
  19625. "due_date": {
  19626. "type": "string",
  19627. "format": "date-time",
  19628. "x-go-name": "Deadline"
  19629. },
  19630. "labels": {
  19631. "type": "array",
  19632. "items": {
  19633. "type": "integer",
  19634. "format": "int64"
  19635. },
  19636. "x-go-name": "Labels"
  19637. },
  19638. "milestone": {
  19639. "type": "integer",
  19640. "format": "int64",
  19641. "x-go-name": "Milestone"
  19642. },
  19643. "state": {
  19644. "type": "string",
  19645. "x-go-name": "State"
  19646. },
  19647. "title": {
  19648. "type": "string",
  19649. "x-go-name": "Title"
  19650. },
  19651. "unset_due_date": {
  19652. "type": "boolean",
  19653. "x-go-name": "RemoveDeadline"
  19654. }
  19655. },
  19656. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19657. },
  19658. "EditReactionOption": {
  19659. "description": "EditReactionOption contain the reaction type",
  19660. "type": "object",
  19661. "properties": {
  19662. "content": {
  19663. "type": "string",
  19664. "x-go-name": "Reaction"
  19665. }
  19666. },
  19667. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19668. },
  19669. "EditReleaseOption": {
  19670. "description": "EditReleaseOption options when editing a release",
  19671. "type": "object",
  19672. "properties": {
  19673. "body": {
  19674. "type": "string",
  19675. "x-go-name": "Note"
  19676. },
  19677. "draft": {
  19678. "type": "boolean",
  19679. "x-go-name": "IsDraft"
  19680. },
  19681. "name": {
  19682. "type": "string",
  19683. "x-go-name": "Title"
  19684. },
  19685. "prerelease": {
  19686. "type": "boolean",
  19687. "x-go-name": "IsPrerelease"
  19688. },
  19689. "tag_name": {
  19690. "type": "string",
  19691. "x-go-name": "TagName"
  19692. },
  19693. "target_commitish": {
  19694. "type": "string",
  19695. "x-go-name": "Target"
  19696. }
  19697. },
  19698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19699. },
  19700. "EditRepoOption": {
  19701. "description": "EditRepoOption options when editing a repository's properties",
  19702. "type": "object",
  19703. "properties": {
  19704. "allow_fast_forward_only_merge": {
  19705. "description": "either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging.",
  19706. "type": "boolean",
  19707. "x-go-name": "AllowFastForwardOnly"
  19708. },
  19709. "allow_manual_merge": {
  19710. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
  19711. "type": "boolean",
  19712. "x-go-name": "AllowManualMerge"
  19713. },
  19714. "allow_merge_commits": {
  19715. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  19716. "type": "boolean",
  19717. "x-go-name": "AllowMerge"
  19718. },
  19719. "allow_rebase": {
  19720. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  19721. "type": "boolean",
  19722. "x-go-name": "AllowRebase"
  19723. },
  19724. "allow_rebase_explicit": {
  19725. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
  19726. "type": "boolean",
  19727. "x-go-name": "AllowRebaseMerge"
  19728. },
  19729. "allow_rebase_update": {
  19730. "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
  19731. "type": "boolean",
  19732. "x-go-name": "AllowRebaseUpdate"
  19733. },
  19734. "allow_squash_merge": {
  19735. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  19736. "type": "boolean",
  19737. "x-go-name": "AllowSquash"
  19738. },
  19739. "archived": {
  19740. "description": "set to `true` to archive this repository.",
  19741. "type": "boolean",
  19742. "x-go-name": "Archived"
  19743. },
  19744. "autodetect_manual_merge": {
  19745. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
  19746. "type": "boolean",
  19747. "x-go-name": "AutodetectManualMerge"
  19748. },
  19749. "default_allow_maintainer_edit": {
  19750. "description": "set to `true` to allow edits from maintainers by default",
  19751. "type": "boolean",
  19752. "x-go-name": "DefaultAllowMaintainerEdit"
  19753. },
  19754. "default_branch": {
  19755. "description": "sets the default branch for this repository.",
  19756. "type": "string",
  19757. "x-go-name": "DefaultBranch"
  19758. },
  19759. "default_delete_branch_after_merge": {
  19760. "description": "set to `true` to delete pr branch after merge by default",
  19761. "type": "boolean",
  19762. "x-go-name": "DefaultDeleteBranchAfterMerge"
  19763. },
  19764. "default_merge_style": {
  19765. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", \"squash\", or \"fast-forward-only\".",
  19766. "type": "string",
  19767. "x-go-name": "DefaultMergeStyle"
  19768. },
  19769. "description": {
  19770. "description": "a short description of the repository.",
  19771. "type": "string",
  19772. "x-go-name": "Description"
  19773. },
  19774. "enable_prune": {
  19775. "description": "enable prune - remove obsolete remote-tracking references",
  19776. "type": "boolean",
  19777. "x-go-name": "EnablePrune"
  19778. },
  19779. "external_tracker": {
  19780. "$ref": "#/definitions/ExternalTracker"
  19781. },
  19782. "external_wiki": {
  19783. "$ref": "#/definitions/ExternalWiki"
  19784. },
  19785. "has_actions": {
  19786. "description": "either `true` to enable actions unit, or `false` to disable them.",
  19787. "type": "boolean",
  19788. "x-go-name": "HasActions"
  19789. },
  19790. "has_issues": {
  19791. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  19792. "type": "boolean",
  19793. "x-go-name": "HasIssues"
  19794. },
  19795. "has_packages": {
  19796. "description": "either `true` to enable packages unit, or `false` to disable them.",
  19797. "type": "boolean",
  19798. "x-go-name": "HasPackages"
  19799. },
  19800. "has_projects": {
  19801. "description": "either `true` to enable project unit, or `false` to disable them.",
  19802. "type": "boolean",
  19803. "x-go-name": "HasProjects"
  19804. },
  19805. "has_pull_requests": {
  19806. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  19807. "type": "boolean",
  19808. "x-go-name": "HasPullRequests"
  19809. },
  19810. "has_releases": {
  19811. "description": "either `true` to enable releases unit, or `false` to disable them.",
  19812. "type": "boolean",
  19813. "x-go-name": "HasReleases"
  19814. },
  19815. "has_wiki": {
  19816. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  19817. "type": "boolean",
  19818. "x-go-name": "HasWiki"
  19819. },
  19820. "ignore_whitespace_conflicts": {
  19821. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
  19822. "type": "boolean",
  19823. "x-go-name": "IgnoreWhitespaceConflicts"
  19824. },
  19825. "internal_tracker": {
  19826. "$ref": "#/definitions/InternalTracker"
  19827. },
  19828. "mirror_interval": {
  19829. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  19830. "type": "string",
  19831. "x-go-name": "MirrorInterval"
  19832. },
  19833. "name": {
  19834. "description": "name of the repository",
  19835. "type": "string",
  19836. "uniqueItems": true,
  19837. "x-go-name": "Name"
  19838. },
  19839. "private": {
  19840. "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.",
  19841. "type": "boolean",
  19842. "x-go-name": "Private"
  19843. },
  19844. "projects_mode": {
  19845. "description": "`repo` to only allow repo-level projects, `owner` to only allow owner projects, `all` to allow both.",
  19846. "type": "string",
  19847. "x-go-name": "ProjectsMode"
  19848. },
  19849. "template": {
  19850. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  19851. "type": "boolean",
  19852. "x-go-name": "Template"
  19853. },
  19854. "website": {
  19855. "description": "a URL with more information about the repository.",
  19856. "type": "string",
  19857. "x-go-name": "Website"
  19858. }
  19859. },
  19860. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19861. },
  19862. "EditTeamOption": {
  19863. "description": "EditTeamOption options for editing a team",
  19864. "type": "object",
  19865. "required": [
  19866. "name"
  19867. ],
  19868. "properties": {
  19869. "can_create_org_repo": {
  19870. "type": "boolean",
  19871. "x-go-name": "CanCreateOrgRepo"
  19872. },
  19873. "description": {
  19874. "type": "string",
  19875. "x-go-name": "Description"
  19876. },
  19877. "includes_all_repositories": {
  19878. "type": "boolean",
  19879. "x-go-name": "IncludesAllRepositories"
  19880. },
  19881. "name": {
  19882. "type": "string",
  19883. "x-go-name": "Name"
  19884. },
  19885. "permission": {
  19886. "type": "string",
  19887. "enum": [
  19888. "read",
  19889. "write",
  19890. "admin"
  19891. ],
  19892. "x-go-name": "Permission"
  19893. },
  19894. "units": {
  19895. "type": "array",
  19896. "items": {
  19897. "type": "string"
  19898. },
  19899. "x-go-name": "Units",
  19900. "example": [
  19901. "repo.code",
  19902. "repo.issues",
  19903. "repo.ext_issues",
  19904. "repo.wiki",
  19905. "repo.pulls",
  19906. "repo.releases",
  19907. "repo.projects",
  19908. "repo.ext_wiki"
  19909. ]
  19910. },
  19911. "units_map": {
  19912. "type": "object",
  19913. "additionalProperties": {
  19914. "type": "string"
  19915. },
  19916. "x-go-name": "UnitsMap",
  19917. "example": {
  19918. "repo.code": "read",
  19919. "repo.ext_issues": "none",
  19920. "repo.ext_wiki": "none",
  19921. "repo.issues": "write",
  19922. "repo.projects": "none",
  19923. "repo.pulls": "owner",
  19924. "repo.releases": "none",
  19925. "repo.wiki": "admin"
  19926. }
  19927. }
  19928. },
  19929. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19930. },
  19931. "EditUserOption": {
  19932. "description": "EditUserOption edit user options",
  19933. "type": "object",
  19934. "required": [
  19935. "source_id",
  19936. "login_name"
  19937. ],
  19938. "properties": {
  19939. "active": {
  19940. "type": "boolean",
  19941. "x-go-name": "Active"
  19942. },
  19943. "admin": {
  19944. "type": "boolean",
  19945. "x-go-name": "Admin"
  19946. },
  19947. "allow_create_organization": {
  19948. "type": "boolean",
  19949. "x-go-name": "AllowCreateOrganization"
  19950. },
  19951. "allow_git_hook": {
  19952. "type": "boolean",
  19953. "x-go-name": "AllowGitHook"
  19954. },
  19955. "allow_import_local": {
  19956. "type": "boolean",
  19957. "x-go-name": "AllowImportLocal"
  19958. },
  19959. "description": {
  19960. "type": "string",
  19961. "x-go-name": "Description"
  19962. },
  19963. "email": {
  19964. "type": "string",
  19965. "format": "email",
  19966. "x-go-name": "Email"
  19967. },
  19968. "full_name": {
  19969. "type": "string",
  19970. "x-go-name": "FullName"
  19971. },
  19972. "location": {
  19973. "type": "string",
  19974. "x-go-name": "Location"
  19975. },
  19976. "login_name": {
  19977. "type": "string",
  19978. "x-go-name": "LoginName"
  19979. },
  19980. "max_repo_creation": {
  19981. "type": "integer",
  19982. "format": "int64",
  19983. "x-go-name": "MaxRepoCreation"
  19984. },
  19985. "must_change_password": {
  19986. "type": "boolean",
  19987. "x-go-name": "MustChangePassword"
  19988. },
  19989. "password": {
  19990. "type": "string",
  19991. "x-go-name": "Password"
  19992. },
  19993. "prohibit_login": {
  19994. "type": "boolean",
  19995. "x-go-name": "ProhibitLogin"
  19996. },
  19997. "restricted": {
  19998. "type": "boolean",
  19999. "x-go-name": "Restricted"
  20000. },
  20001. "source_id": {
  20002. "type": "integer",
  20003. "format": "int64",
  20004. "x-go-name": "SourceID"
  20005. },
  20006. "visibility": {
  20007. "type": "string",
  20008. "x-go-name": "Visibility"
  20009. },
  20010. "website": {
  20011. "type": "string",
  20012. "x-go-name": "Website"
  20013. }
  20014. },
  20015. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20016. },
  20017. "Email": {
  20018. "description": "Email an email address belonging to a user",
  20019. "type": "object",
  20020. "properties": {
  20021. "email": {
  20022. "type": "string",
  20023. "format": "email",
  20024. "x-go-name": "Email"
  20025. },
  20026. "primary": {
  20027. "type": "boolean",
  20028. "x-go-name": "Primary"
  20029. },
  20030. "user_id": {
  20031. "type": "integer",
  20032. "format": "int64",
  20033. "x-go-name": "UserID"
  20034. },
  20035. "username": {
  20036. "type": "string",
  20037. "x-go-name": "UserName"
  20038. },
  20039. "verified": {
  20040. "type": "boolean",
  20041. "x-go-name": "Verified"
  20042. }
  20043. },
  20044. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20045. },
  20046. "ExternalTracker": {
  20047. "description": "ExternalTracker represents settings for external tracker",
  20048. "type": "object",
  20049. "properties": {
  20050. "external_tracker_format": {
  20051. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  20052. "type": "string",
  20053. "x-go-name": "ExternalTrackerFormat"
  20054. },
  20055. "external_tracker_regexp_pattern": {
  20056. "description": "External Issue Tracker issue regular expression",
  20057. "type": "string",
  20058. "x-go-name": "ExternalTrackerRegexpPattern"
  20059. },
  20060. "external_tracker_style": {
  20061. "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
  20062. "type": "string",
  20063. "x-go-name": "ExternalTrackerStyle"
  20064. },
  20065. "external_tracker_url": {
  20066. "description": "URL of external issue tracker.",
  20067. "type": "string",
  20068. "x-go-name": "ExternalTrackerURL"
  20069. }
  20070. },
  20071. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20072. },
  20073. "ExternalWiki": {
  20074. "description": "ExternalWiki represents setting for external wiki",
  20075. "type": "object",
  20076. "properties": {
  20077. "external_wiki_url": {
  20078. "description": "URL of external wiki.",
  20079. "type": "string",
  20080. "x-go-name": "ExternalWikiURL"
  20081. }
  20082. },
  20083. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20084. },
  20085. "FileCommitResponse": {
  20086. "type": "object",
  20087. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  20088. "properties": {
  20089. "author": {
  20090. "$ref": "#/definitions/CommitUser"
  20091. },
  20092. "committer": {
  20093. "$ref": "#/definitions/CommitUser"
  20094. },
  20095. "created": {
  20096. "type": "string",
  20097. "format": "date-time",
  20098. "x-go-name": "Created"
  20099. },
  20100. "html_url": {
  20101. "type": "string",
  20102. "x-go-name": "HTMLURL"
  20103. },
  20104. "message": {
  20105. "type": "string",
  20106. "x-go-name": "Message"
  20107. },
  20108. "parents": {
  20109. "type": "array",
  20110. "items": {
  20111. "$ref": "#/definitions/CommitMeta"
  20112. },
  20113. "x-go-name": "Parents"
  20114. },
  20115. "sha": {
  20116. "type": "string",
  20117. "x-go-name": "SHA"
  20118. },
  20119. "tree": {
  20120. "$ref": "#/definitions/CommitMeta"
  20121. },
  20122. "url": {
  20123. "type": "string",
  20124. "x-go-name": "URL"
  20125. }
  20126. },
  20127. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20128. },
  20129. "FileDeleteResponse": {
  20130. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  20131. "type": "object",
  20132. "properties": {
  20133. "commit": {
  20134. "$ref": "#/definitions/FileCommitResponse"
  20135. },
  20136. "content": {
  20137. "x-go-name": "Content"
  20138. },
  20139. "verification": {
  20140. "$ref": "#/definitions/PayloadCommitVerification"
  20141. }
  20142. },
  20143. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20144. },
  20145. "FileLinksResponse": {
  20146. "description": "FileLinksResponse contains the links for a repo's file",
  20147. "type": "object",
  20148. "properties": {
  20149. "git": {
  20150. "type": "string",
  20151. "x-go-name": "GitURL"
  20152. },
  20153. "html": {
  20154. "type": "string",
  20155. "x-go-name": "HTMLURL"
  20156. },
  20157. "self": {
  20158. "type": "string",
  20159. "x-go-name": "Self"
  20160. }
  20161. },
  20162. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20163. },
  20164. "FileResponse": {
  20165. "description": "FileResponse contains information about a repo's file",
  20166. "type": "object",
  20167. "properties": {
  20168. "commit": {
  20169. "$ref": "#/definitions/FileCommitResponse"
  20170. },
  20171. "content": {
  20172. "$ref": "#/definitions/ContentsResponse"
  20173. },
  20174. "verification": {
  20175. "$ref": "#/definitions/PayloadCommitVerification"
  20176. }
  20177. },
  20178. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20179. },
  20180. "FilesResponse": {
  20181. "description": "FilesResponse contains information about multiple files from a repo",
  20182. "type": "object",
  20183. "properties": {
  20184. "commit": {
  20185. "$ref": "#/definitions/FileCommitResponse"
  20186. },
  20187. "files": {
  20188. "type": "array",
  20189. "items": {
  20190. "$ref": "#/definitions/ContentsResponse"
  20191. },
  20192. "x-go-name": "Files"
  20193. },
  20194. "verification": {
  20195. "$ref": "#/definitions/PayloadCommitVerification"
  20196. }
  20197. },
  20198. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20199. },
  20200. "GPGKey": {
  20201. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  20202. "type": "object",
  20203. "properties": {
  20204. "can_certify": {
  20205. "type": "boolean",
  20206. "x-go-name": "CanCertify"
  20207. },
  20208. "can_encrypt_comms": {
  20209. "type": "boolean",
  20210. "x-go-name": "CanEncryptComms"
  20211. },
  20212. "can_encrypt_storage": {
  20213. "type": "boolean",
  20214. "x-go-name": "CanEncryptStorage"
  20215. },
  20216. "can_sign": {
  20217. "type": "boolean",
  20218. "x-go-name": "CanSign"
  20219. },
  20220. "created_at": {
  20221. "type": "string",
  20222. "format": "date-time",
  20223. "x-go-name": "Created"
  20224. },
  20225. "emails": {
  20226. "type": "array",
  20227. "items": {
  20228. "$ref": "#/definitions/GPGKeyEmail"
  20229. },
  20230. "x-go-name": "Emails"
  20231. },
  20232. "expires_at": {
  20233. "type": "string",
  20234. "format": "date-time",
  20235. "x-go-name": "Expires"
  20236. },
  20237. "id": {
  20238. "type": "integer",
  20239. "format": "int64",
  20240. "x-go-name": "ID"
  20241. },
  20242. "key_id": {
  20243. "type": "string",
  20244. "x-go-name": "KeyID"
  20245. },
  20246. "primary_key_id": {
  20247. "type": "string",
  20248. "x-go-name": "PrimaryKeyID"
  20249. },
  20250. "public_key": {
  20251. "type": "string",
  20252. "x-go-name": "PublicKey"
  20253. },
  20254. "subkeys": {
  20255. "type": "array",
  20256. "items": {
  20257. "$ref": "#/definitions/GPGKey"
  20258. },
  20259. "x-go-name": "SubsKey"
  20260. },
  20261. "verified": {
  20262. "type": "boolean",
  20263. "x-go-name": "Verified"
  20264. }
  20265. },
  20266. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20267. },
  20268. "GPGKeyEmail": {
  20269. "description": "GPGKeyEmail an email attached to a GPGKey",
  20270. "type": "object",
  20271. "properties": {
  20272. "email": {
  20273. "type": "string",
  20274. "x-go-name": "Email"
  20275. },
  20276. "verified": {
  20277. "type": "boolean",
  20278. "x-go-name": "Verified"
  20279. }
  20280. },
  20281. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20282. },
  20283. "GeneralAPISettings": {
  20284. "description": "GeneralAPISettings contains global api settings exposed by it",
  20285. "type": "object",
  20286. "properties": {
  20287. "default_git_trees_per_page": {
  20288. "type": "integer",
  20289. "format": "int64",
  20290. "x-go-name": "DefaultGitTreesPerPage"
  20291. },
  20292. "default_max_blob_size": {
  20293. "type": "integer",
  20294. "format": "int64",
  20295. "x-go-name": "DefaultMaxBlobSize"
  20296. },
  20297. "default_paging_num": {
  20298. "type": "integer",
  20299. "format": "int64",
  20300. "x-go-name": "DefaultPagingNum"
  20301. },
  20302. "max_response_items": {
  20303. "type": "integer",
  20304. "format": "int64",
  20305. "x-go-name": "MaxResponseItems"
  20306. }
  20307. },
  20308. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20309. },
  20310. "GeneralAttachmentSettings": {
  20311. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  20312. "type": "object",
  20313. "properties": {
  20314. "allowed_types": {
  20315. "type": "string",
  20316. "x-go-name": "AllowedTypes"
  20317. },
  20318. "enabled": {
  20319. "type": "boolean",
  20320. "x-go-name": "Enabled"
  20321. },
  20322. "max_files": {
  20323. "type": "integer",
  20324. "format": "int64",
  20325. "x-go-name": "MaxFiles"
  20326. },
  20327. "max_size": {
  20328. "type": "integer",
  20329. "format": "int64",
  20330. "x-go-name": "MaxSize"
  20331. }
  20332. },
  20333. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20334. },
  20335. "GeneralRepoSettings": {
  20336. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  20337. "type": "object",
  20338. "properties": {
  20339. "http_git_disabled": {
  20340. "type": "boolean",
  20341. "x-go-name": "HTTPGitDisabled"
  20342. },
  20343. "lfs_disabled": {
  20344. "type": "boolean",
  20345. "x-go-name": "LFSDisabled"
  20346. },
  20347. "migrations_disabled": {
  20348. "type": "boolean",
  20349. "x-go-name": "MigrationsDisabled"
  20350. },
  20351. "mirrors_disabled": {
  20352. "type": "boolean",
  20353. "x-go-name": "MirrorsDisabled"
  20354. },
  20355. "stars_disabled": {
  20356. "type": "boolean",
  20357. "x-go-name": "StarsDisabled"
  20358. },
  20359. "time_tracking_disabled": {
  20360. "type": "boolean",
  20361. "x-go-name": "TimeTrackingDisabled"
  20362. }
  20363. },
  20364. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20365. },
  20366. "GeneralUISettings": {
  20367. "description": "GeneralUISettings contains global ui settings exposed by API",
  20368. "type": "object",
  20369. "properties": {
  20370. "allowed_reactions": {
  20371. "type": "array",
  20372. "items": {
  20373. "type": "string"
  20374. },
  20375. "x-go-name": "AllowedReactions"
  20376. },
  20377. "custom_emojis": {
  20378. "type": "array",
  20379. "items": {
  20380. "type": "string"
  20381. },
  20382. "x-go-name": "CustomEmojis"
  20383. },
  20384. "default_theme": {
  20385. "type": "string",
  20386. "x-go-name": "DefaultTheme"
  20387. }
  20388. },
  20389. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20390. },
  20391. "GenerateRepoOption": {
  20392. "description": "GenerateRepoOption options when creating repository using a template",
  20393. "type": "object",
  20394. "required": [
  20395. "owner",
  20396. "name"
  20397. ],
  20398. "properties": {
  20399. "avatar": {
  20400. "description": "include avatar of the template repo",
  20401. "type": "boolean",
  20402. "x-go-name": "Avatar"
  20403. },
  20404. "default_branch": {
  20405. "description": "Default branch of the new repository",
  20406. "type": "string",
  20407. "x-go-name": "DefaultBranch"
  20408. },
  20409. "description": {
  20410. "description": "Description of the repository to create",
  20411. "type": "string",
  20412. "x-go-name": "Description"
  20413. },
  20414. "git_content": {
  20415. "description": "include git content of default branch in template repo",
  20416. "type": "boolean",
  20417. "x-go-name": "GitContent"
  20418. },
  20419. "git_hooks": {
  20420. "description": "include git hooks in template repo",
  20421. "type": "boolean",
  20422. "x-go-name": "GitHooks"
  20423. },
  20424. "labels": {
  20425. "description": "include labels in template repo",
  20426. "type": "boolean",
  20427. "x-go-name": "Labels"
  20428. },
  20429. "name": {
  20430. "description": "Name of the repository to create",
  20431. "type": "string",
  20432. "uniqueItems": true,
  20433. "x-go-name": "Name"
  20434. },
  20435. "owner": {
  20436. "description": "The organization or person who will own the new repository",
  20437. "type": "string",
  20438. "x-go-name": "Owner"
  20439. },
  20440. "private": {
  20441. "description": "Whether the repository is private",
  20442. "type": "boolean",
  20443. "x-go-name": "Private"
  20444. },
  20445. "protected_branch": {
  20446. "description": "include protected branches in template repo",
  20447. "type": "boolean",
  20448. "x-go-name": "ProtectedBranch"
  20449. },
  20450. "topics": {
  20451. "description": "include topics in template repo",
  20452. "type": "boolean",
  20453. "x-go-name": "Topics"
  20454. },
  20455. "webhooks": {
  20456. "description": "include webhooks in template repo",
  20457. "type": "boolean",
  20458. "x-go-name": "Webhooks"
  20459. }
  20460. },
  20461. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20462. },
  20463. "GitBlobResponse": {
  20464. "description": "GitBlobResponse represents a git blob",
  20465. "type": "object",
  20466. "properties": {
  20467. "content": {
  20468. "type": "string",
  20469. "x-go-name": "Content"
  20470. },
  20471. "encoding": {
  20472. "type": "string",
  20473. "x-go-name": "Encoding"
  20474. },
  20475. "sha": {
  20476. "type": "string",
  20477. "x-go-name": "SHA"
  20478. },
  20479. "size": {
  20480. "type": "integer",
  20481. "format": "int64",
  20482. "x-go-name": "Size"
  20483. },
  20484. "url": {
  20485. "type": "string",
  20486. "x-go-name": "URL"
  20487. }
  20488. },
  20489. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20490. },
  20491. "GitEntry": {
  20492. "description": "GitEntry represents a git tree",
  20493. "type": "object",
  20494. "properties": {
  20495. "mode": {
  20496. "type": "string",
  20497. "x-go-name": "Mode"
  20498. },
  20499. "path": {
  20500. "type": "string",
  20501. "x-go-name": "Path"
  20502. },
  20503. "sha": {
  20504. "type": "string",
  20505. "x-go-name": "SHA"
  20506. },
  20507. "size": {
  20508. "type": "integer",
  20509. "format": "int64",
  20510. "x-go-name": "Size"
  20511. },
  20512. "type": {
  20513. "type": "string",
  20514. "x-go-name": "Type"
  20515. },
  20516. "url": {
  20517. "type": "string",
  20518. "x-go-name": "URL"
  20519. }
  20520. },
  20521. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20522. },
  20523. "GitHook": {
  20524. "description": "GitHook represents a Git repository hook",
  20525. "type": "object",
  20526. "properties": {
  20527. "content": {
  20528. "type": "string",
  20529. "x-go-name": "Content"
  20530. },
  20531. "is_active": {
  20532. "type": "boolean",
  20533. "x-go-name": "IsActive"
  20534. },
  20535. "name": {
  20536. "type": "string",
  20537. "x-go-name": "Name"
  20538. }
  20539. },
  20540. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20541. },
  20542. "GitObject": {
  20543. "type": "object",
  20544. "title": "GitObject represents a Git object.",
  20545. "properties": {
  20546. "sha": {
  20547. "type": "string",
  20548. "x-go-name": "SHA"
  20549. },
  20550. "type": {
  20551. "type": "string",
  20552. "x-go-name": "Type"
  20553. },
  20554. "url": {
  20555. "type": "string",
  20556. "x-go-name": "URL"
  20557. }
  20558. },
  20559. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20560. },
  20561. "GitTreeResponse": {
  20562. "description": "GitTreeResponse returns a git tree",
  20563. "type": "object",
  20564. "properties": {
  20565. "page": {
  20566. "type": "integer",
  20567. "format": "int64",
  20568. "x-go-name": "Page"
  20569. },
  20570. "sha": {
  20571. "type": "string",
  20572. "x-go-name": "SHA"
  20573. },
  20574. "total_count": {
  20575. "type": "integer",
  20576. "format": "int64",
  20577. "x-go-name": "TotalCount"
  20578. },
  20579. "tree": {
  20580. "type": "array",
  20581. "items": {
  20582. "$ref": "#/definitions/GitEntry"
  20583. },
  20584. "x-go-name": "Entries"
  20585. },
  20586. "truncated": {
  20587. "type": "boolean",
  20588. "x-go-name": "Truncated"
  20589. },
  20590. "url": {
  20591. "type": "string",
  20592. "x-go-name": "URL"
  20593. }
  20594. },
  20595. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20596. },
  20597. "GitignoreTemplateInfo": {
  20598. "description": "GitignoreTemplateInfo name and text of a gitignore template",
  20599. "type": "object",
  20600. "properties": {
  20601. "name": {
  20602. "type": "string",
  20603. "x-go-name": "Name"
  20604. },
  20605. "source": {
  20606. "type": "string",
  20607. "x-go-name": "Source"
  20608. }
  20609. },
  20610. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20611. },
  20612. "Hook": {
  20613. "description": "Hook a hook is a web hook when one repository changed",
  20614. "type": "object",
  20615. "properties": {
  20616. "active": {
  20617. "type": "boolean",
  20618. "x-go-name": "Active"
  20619. },
  20620. "authorization_header": {
  20621. "type": "string",
  20622. "x-go-name": "AuthorizationHeader"
  20623. },
  20624. "branch_filter": {
  20625. "type": "string",
  20626. "x-go-name": "BranchFilter"
  20627. },
  20628. "config": {
  20629. "type": "object",
  20630. "additionalProperties": {
  20631. "type": "string"
  20632. },
  20633. "x-go-name": "Config"
  20634. },
  20635. "created_at": {
  20636. "type": "string",
  20637. "format": "date-time",
  20638. "x-go-name": "Created"
  20639. },
  20640. "events": {
  20641. "type": "array",
  20642. "items": {
  20643. "type": "string"
  20644. },
  20645. "x-go-name": "Events"
  20646. },
  20647. "id": {
  20648. "type": "integer",
  20649. "format": "int64",
  20650. "x-go-name": "ID"
  20651. },
  20652. "type": {
  20653. "type": "string",
  20654. "x-go-name": "Type"
  20655. },
  20656. "updated_at": {
  20657. "type": "string",
  20658. "format": "date-time",
  20659. "x-go-name": "Updated"
  20660. }
  20661. },
  20662. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20663. },
  20664. "Identity": {
  20665. "description": "Identity for a person's identity like an author or committer",
  20666. "type": "object",
  20667. "properties": {
  20668. "email": {
  20669. "type": "string",
  20670. "format": "email",
  20671. "x-go-name": "Email"
  20672. },
  20673. "name": {
  20674. "type": "string",
  20675. "x-go-name": "Name"
  20676. }
  20677. },
  20678. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20679. },
  20680. "InternalTracker": {
  20681. "description": "InternalTracker represents settings for internal tracker",
  20682. "type": "object",
  20683. "properties": {
  20684. "allow_only_contributors_to_track_time": {
  20685. "description": "Let only contributors track time (Built-in issue tracker)",
  20686. "type": "boolean",
  20687. "x-go-name": "AllowOnlyContributorsToTrackTime"
  20688. },
  20689. "enable_issue_dependencies": {
  20690. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  20691. "type": "boolean",
  20692. "x-go-name": "EnableIssueDependencies"
  20693. },
  20694. "enable_time_tracker": {
  20695. "description": "Enable time tracking (Built-in issue tracker)",
  20696. "type": "boolean",
  20697. "x-go-name": "EnableTimeTracker"
  20698. }
  20699. },
  20700. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20701. },
  20702. "Issue": {
  20703. "description": "Issue represents an issue in a repository",
  20704. "type": "object",
  20705. "properties": {
  20706. "assets": {
  20707. "type": "array",
  20708. "items": {
  20709. "$ref": "#/definitions/Attachment"
  20710. },
  20711. "x-go-name": "Attachments"
  20712. },
  20713. "assignee": {
  20714. "$ref": "#/definitions/User"
  20715. },
  20716. "assignees": {
  20717. "type": "array",
  20718. "items": {
  20719. "$ref": "#/definitions/User"
  20720. },
  20721. "x-go-name": "Assignees"
  20722. },
  20723. "body": {
  20724. "type": "string",
  20725. "x-go-name": "Body"
  20726. },
  20727. "closed_at": {
  20728. "type": "string",
  20729. "format": "date-time",
  20730. "x-go-name": "Closed"
  20731. },
  20732. "comments": {
  20733. "type": "integer",
  20734. "format": "int64",
  20735. "x-go-name": "Comments"
  20736. },
  20737. "created_at": {
  20738. "type": "string",
  20739. "format": "date-time",
  20740. "x-go-name": "Created"
  20741. },
  20742. "due_date": {
  20743. "type": "string",
  20744. "format": "date-time",
  20745. "x-go-name": "Deadline"
  20746. },
  20747. "html_url": {
  20748. "type": "string",
  20749. "x-go-name": "HTMLURL"
  20750. },
  20751. "id": {
  20752. "type": "integer",
  20753. "format": "int64",
  20754. "x-go-name": "ID"
  20755. },
  20756. "is_locked": {
  20757. "type": "boolean",
  20758. "x-go-name": "IsLocked"
  20759. },
  20760. "labels": {
  20761. "type": "array",
  20762. "items": {
  20763. "$ref": "#/definitions/Label"
  20764. },
  20765. "x-go-name": "Labels"
  20766. },
  20767. "milestone": {
  20768. "$ref": "#/definitions/Milestone"
  20769. },
  20770. "number": {
  20771. "type": "integer",
  20772. "format": "int64",
  20773. "x-go-name": "Index"
  20774. },
  20775. "original_author": {
  20776. "type": "string",
  20777. "x-go-name": "OriginalAuthor"
  20778. },
  20779. "original_author_id": {
  20780. "type": "integer",
  20781. "format": "int64",
  20782. "x-go-name": "OriginalAuthorID"
  20783. },
  20784. "pin_order": {
  20785. "type": "integer",
  20786. "format": "int64",
  20787. "x-go-name": "PinOrder"
  20788. },
  20789. "pull_request": {
  20790. "$ref": "#/definitions/PullRequestMeta"
  20791. },
  20792. "ref": {
  20793. "type": "string",
  20794. "x-go-name": "Ref"
  20795. },
  20796. "repository": {
  20797. "$ref": "#/definitions/RepositoryMeta"
  20798. },
  20799. "state": {
  20800. "$ref": "#/definitions/StateType"
  20801. },
  20802. "title": {
  20803. "type": "string",
  20804. "x-go-name": "Title"
  20805. },
  20806. "updated_at": {
  20807. "type": "string",
  20808. "format": "date-time",
  20809. "x-go-name": "Updated"
  20810. },
  20811. "url": {
  20812. "type": "string",
  20813. "x-go-name": "URL"
  20814. },
  20815. "user": {
  20816. "$ref": "#/definitions/User"
  20817. }
  20818. },
  20819. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20820. },
  20821. "IssueConfig": {
  20822. "type": "object",
  20823. "properties": {
  20824. "blank_issues_enabled": {
  20825. "type": "boolean",
  20826. "x-go-name": "BlankIssuesEnabled"
  20827. },
  20828. "contact_links": {
  20829. "type": "array",
  20830. "items": {
  20831. "$ref": "#/definitions/IssueConfigContactLink"
  20832. },
  20833. "x-go-name": "ContactLinks"
  20834. }
  20835. },
  20836. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20837. },
  20838. "IssueConfigContactLink": {
  20839. "type": "object",
  20840. "properties": {
  20841. "about": {
  20842. "type": "string",
  20843. "x-go-name": "About"
  20844. },
  20845. "name": {
  20846. "type": "string",
  20847. "x-go-name": "Name"
  20848. },
  20849. "url": {
  20850. "type": "string",
  20851. "x-go-name": "URL"
  20852. }
  20853. },
  20854. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20855. },
  20856. "IssueConfigValidation": {
  20857. "type": "object",
  20858. "properties": {
  20859. "message": {
  20860. "type": "string",
  20861. "x-go-name": "Message"
  20862. },
  20863. "valid": {
  20864. "type": "boolean",
  20865. "x-go-name": "Valid"
  20866. }
  20867. },
  20868. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20869. },
  20870. "IssueDeadline": {
  20871. "description": "IssueDeadline represents an issue deadline",
  20872. "type": "object",
  20873. "properties": {
  20874. "due_date": {
  20875. "type": "string",
  20876. "format": "date-time",
  20877. "x-go-name": "Deadline"
  20878. }
  20879. },
  20880. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20881. },
  20882. "IssueFormField": {
  20883. "description": "IssueFormField represents a form field",
  20884. "type": "object",
  20885. "properties": {
  20886. "attributes": {
  20887. "type": "object",
  20888. "additionalProperties": {},
  20889. "x-go-name": "Attributes"
  20890. },
  20891. "id": {
  20892. "type": "string",
  20893. "x-go-name": "ID"
  20894. },
  20895. "type": {
  20896. "$ref": "#/definitions/IssueFormFieldType"
  20897. },
  20898. "validations": {
  20899. "type": "object",
  20900. "additionalProperties": {},
  20901. "x-go-name": "Validations"
  20902. },
  20903. "visible": {
  20904. "type": "array",
  20905. "items": {
  20906. "$ref": "#/definitions/IssueFormFieldVisible"
  20907. },
  20908. "x-go-name": "Visible"
  20909. }
  20910. },
  20911. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20912. },
  20913. "IssueFormFieldType": {
  20914. "type": "string",
  20915. "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
  20916. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20917. },
  20918. "IssueFormFieldVisible": {
  20919. "description": "IssueFormFieldVisible defines issue form field visible",
  20920. "type": "string",
  20921. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20922. },
  20923. "IssueLabelsOption": {
  20924. "description": "IssueLabelsOption a collection of labels",
  20925. "type": "object",
  20926. "properties": {
  20927. "labels": {
  20928. "description": "list of label IDs",
  20929. "type": "array",
  20930. "items": {
  20931. "type": "integer",
  20932. "format": "int64"
  20933. },
  20934. "x-go-name": "Labels"
  20935. }
  20936. },
  20937. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20938. },
  20939. "IssueMeta": {
  20940. "description": "IssueMeta basic issue information",
  20941. "type": "object",
  20942. "properties": {
  20943. "index": {
  20944. "type": "integer",
  20945. "format": "int64",
  20946. "x-go-name": "Index"
  20947. },
  20948. "owner": {
  20949. "type": "string",
  20950. "x-go-name": "Owner"
  20951. },
  20952. "repo": {
  20953. "type": "string",
  20954. "x-go-name": "Name"
  20955. }
  20956. },
  20957. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20958. },
  20959. "IssueTemplate": {
  20960. "description": "IssueTemplate represents an issue template for a repository",
  20961. "type": "object",
  20962. "properties": {
  20963. "about": {
  20964. "type": "string",
  20965. "x-go-name": "About"
  20966. },
  20967. "body": {
  20968. "type": "array",
  20969. "items": {
  20970. "$ref": "#/definitions/IssueFormField"
  20971. },
  20972. "x-go-name": "Fields"
  20973. },
  20974. "content": {
  20975. "type": "string",
  20976. "x-go-name": "Content"
  20977. },
  20978. "file_name": {
  20979. "type": "string",
  20980. "x-go-name": "FileName"
  20981. },
  20982. "labels": {
  20983. "$ref": "#/definitions/IssueTemplateLabels"
  20984. },
  20985. "name": {
  20986. "type": "string",
  20987. "x-go-name": "Name"
  20988. },
  20989. "ref": {
  20990. "type": "string",
  20991. "x-go-name": "Ref"
  20992. },
  20993. "title": {
  20994. "type": "string",
  20995. "x-go-name": "Title"
  20996. }
  20997. },
  20998. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20999. },
  21000. "IssueTemplateLabels": {
  21001. "type": "array",
  21002. "items": {
  21003. "type": "string"
  21004. },
  21005. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21006. },
  21007. "Label": {
  21008. "description": "Label a label to an issue or a pr",
  21009. "type": "object",
  21010. "properties": {
  21011. "color": {
  21012. "type": "string",
  21013. "x-go-name": "Color",
  21014. "example": "00aabb"
  21015. },
  21016. "description": {
  21017. "type": "string",
  21018. "x-go-name": "Description"
  21019. },
  21020. "exclusive": {
  21021. "type": "boolean",
  21022. "x-go-name": "Exclusive",
  21023. "example": false
  21024. },
  21025. "id": {
  21026. "type": "integer",
  21027. "format": "int64",
  21028. "x-go-name": "ID"
  21029. },
  21030. "is_archived": {
  21031. "type": "boolean",
  21032. "x-go-name": "IsArchived",
  21033. "example": false
  21034. },
  21035. "name": {
  21036. "type": "string",
  21037. "x-go-name": "Name"
  21038. },
  21039. "url": {
  21040. "type": "string",
  21041. "x-go-name": "URL"
  21042. }
  21043. },
  21044. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21045. },
  21046. "LabelTemplate": {
  21047. "description": "LabelTemplate info of a Label template",
  21048. "type": "object",
  21049. "properties": {
  21050. "color": {
  21051. "type": "string",
  21052. "x-go-name": "Color",
  21053. "example": "00aabb"
  21054. },
  21055. "description": {
  21056. "type": "string",
  21057. "x-go-name": "Description"
  21058. },
  21059. "exclusive": {
  21060. "type": "boolean",
  21061. "x-go-name": "Exclusive",
  21062. "example": false
  21063. },
  21064. "name": {
  21065. "type": "string",
  21066. "x-go-name": "Name"
  21067. }
  21068. },
  21069. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21070. },
  21071. "LicenseTemplateInfo": {
  21072. "description": "LicensesInfo contains information about a License",
  21073. "type": "object",
  21074. "properties": {
  21075. "body": {
  21076. "type": "string",
  21077. "x-go-name": "Body"
  21078. },
  21079. "implementation": {
  21080. "type": "string",
  21081. "x-go-name": "Implementation"
  21082. },
  21083. "key": {
  21084. "type": "string",
  21085. "x-go-name": "Key"
  21086. },
  21087. "name": {
  21088. "type": "string",
  21089. "x-go-name": "Name"
  21090. },
  21091. "url": {
  21092. "type": "string",
  21093. "x-go-name": "URL"
  21094. }
  21095. },
  21096. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21097. },
  21098. "LicensesTemplateListEntry": {
  21099. "description": "LicensesListEntry is used for the API",
  21100. "type": "object",
  21101. "properties": {
  21102. "key": {
  21103. "type": "string",
  21104. "x-go-name": "Key"
  21105. },
  21106. "name": {
  21107. "type": "string",
  21108. "x-go-name": "Name"
  21109. },
  21110. "url": {
  21111. "type": "string",
  21112. "x-go-name": "URL"
  21113. }
  21114. },
  21115. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21116. },
  21117. "MarkdownOption": {
  21118. "description": "MarkdownOption markdown options",
  21119. "type": "object",
  21120. "properties": {
  21121. "Context": {
  21122. "description": "Context to render\n\nin: body",
  21123. "type": "string"
  21124. },
  21125. "Mode": {
  21126. "description": "Mode to render (comment, gfm, markdown)\n\nin: body",
  21127. "type": "string"
  21128. },
  21129. "Text": {
  21130. "description": "Text markdown to render\n\nin: body",
  21131. "type": "string"
  21132. },
  21133. "Wiki": {
  21134. "description": "Is it a wiki page ?\n\nin: body",
  21135. "type": "boolean"
  21136. }
  21137. },
  21138. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21139. },
  21140. "MarkupOption": {
  21141. "description": "MarkupOption markup options",
  21142. "type": "object",
  21143. "properties": {
  21144. "Context": {
  21145. "description": "Context to render\n\nin: body",
  21146. "type": "string"
  21147. },
  21148. "FilePath": {
  21149. "description": "File path for detecting extension in file mode\n\nin: body",
  21150. "type": "string"
  21151. },
  21152. "Mode": {
  21153. "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body",
  21154. "type": "string"
  21155. },
  21156. "Text": {
  21157. "description": "Text markup to render\n\nin: body",
  21158. "type": "string"
  21159. },
  21160. "Wiki": {
  21161. "description": "Is it a wiki page ?\n\nin: body",
  21162. "type": "boolean"
  21163. }
  21164. },
  21165. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21166. },
  21167. "MergePullRequestOption": {
  21168. "description": "MergePullRequestForm form for merging Pull Request",
  21169. "type": "object",
  21170. "required": [
  21171. "Do"
  21172. ],
  21173. "properties": {
  21174. "Do": {
  21175. "type": "string",
  21176. "enum": [
  21177. "merge",
  21178. "rebase",
  21179. "rebase-merge",
  21180. "squash",
  21181. "fast-forward-only",
  21182. "manually-merged"
  21183. ]
  21184. },
  21185. "MergeCommitID": {
  21186. "type": "string"
  21187. },
  21188. "MergeMessageField": {
  21189. "type": "string"
  21190. },
  21191. "MergeTitleField": {
  21192. "type": "string"
  21193. },
  21194. "delete_branch_after_merge": {
  21195. "type": "boolean",
  21196. "x-go-name": "DeleteBranchAfterMerge"
  21197. },
  21198. "force_merge": {
  21199. "type": "boolean",
  21200. "x-go-name": "ForceMerge"
  21201. },
  21202. "head_commit_id": {
  21203. "type": "string",
  21204. "x-go-name": "HeadCommitID"
  21205. },
  21206. "merge_when_checks_succeed": {
  21207. "type": "boolean",
  21208. "x-go-name": "MergeWhenChecksSucceed"
  21209. }
  21210. },
  21211. "x-go-name": "MergePullRequestForm",
  21212. "x-go-package": "code.gitea.io/gitea/services/forms"
  21213. },
  21214. "MigrateRepoOptions": {
  21215. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  21216. "type": "object",
  21217. "required": [
  21218. "clone_addr",
  21219. "repo_name"
  21220. ],
  21221. "properties": {
  21222. "auth_password": {
  21223. "type": "string",
  21224. "x-go-name": "AuthPassword"
  21225. },
  21226. "auth_token": {
  21227. "type": "string",
  21228. "x-go-name": "AuthToken"
  21229. },
  21230. "auth_username": {
  21231. "type": "string",
  21232. "x-go-name": "AuthUsername"
  21233. },
  21234. "clone_addr": {
  21235. "type": "string",
  21236. "x-go-name": "CloneAddr"
  21237. },
  21238. "description": {
  21239. "type": "string",
  21240. "x-go-name": "Description"
  21241. },
  21242. "issues": {
  21243. "type": "boolean",
  21244. "x-go-name": "Issues"
  21245. },
  21246. "labels": {
  21247. "type": "boolean",
  21248. "x-go-name": "Labels"
  21249. },
  21250. "lfs": {
  21251. "type": "boolean",
  21252. "x-go-name": "LFS"
  21253. },
  21254. "lfs_endpoint": {
  21255. "type": "string",
  21256. "x-go-name": "LFSEndpoint"
  21257. },
  21258. "milestones": {
  21259. "type": "boolean",
  21260. "x-go-name": "Milestones"
  21261. },
  21262. "mirror": {
  21263. "type": "boolean",
  21264. "x-go-name": "Mirror"
  21265. },
  21266. "mirror_interval": {
  21267. "type": "string",
  21268. "x-go-name": "MirrorInterval"
  21269. },
  21270. "private": {
  21271. "type": "boolean",
  21272. "x-go-name": "Private"
  21273. },
  21274. "pull_requests": {
  21275. "type": "boolean",
  21276. "x-go-name": "PullRequests"
  21277. },
  21278. "releases": {
  21279. "type": "boolean",
  21280. "x-go-name": "Releases"
  21281. },
  21282. "repo_name": {
  21283. "type": "string",
  21284. "x-go-name": "RepoName"
  21285. },
  21286. "repo_owner": {
  21287. "description": "Name of User or Organisation who will own Repo after migration",
  21288. "type": "string",
  21289. "x-go-name": "RepoOwner"
  21290. },
  21291. "service": {
  21292. "type": "string",
  21293. "enum": [
  21294. "git",
  21295. "github",
  21296. "gitea",
  21297. "gitlab",
  21298. "gogs",
  21299. "onedev",
  21300. "gitbucket",
  21301. "codebase"
  21302. ],
  21303. "x-go-name": "Service"
  21304. },
  21305. "uid": {
  21306. "description": "deprecated (only for backwards compatibility)",
  21307. "type": "integer",
  21308. "format": "int64",
  21309. "x-go-name": "RepoOwnerID"
  21310. },
  21311. "wiki": {
  21312. "type": "boolean",
  21313. "x-go-name": "Wiki"
  21314. }
  21315. },
  21316. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21317. },
  21318. "Milestone": {
  21319. "description": "Milestone milestone is a collection of issues on one repository",
  21320. "type": "object",
  21321. "properties": {
  21322. "closed_at": {
  21323. "type": "string",
  21324. "format": "date-time",
  21325. "x-go-name": "Closed"
  21326. },
  21327. "closed_issues": {
  21328. "type": "integer",
  21329. "format": "int64",
  21330. "x-go-name": "ClosedIssues"
  21331. },
  21332. "created_at": {
  21333. "type": "string",
  21334. "format": "date-time",
  21335. "x-go-name": "Created"
  21336. },
  21337. "description": {
  21338. "type": "string",
  21339. "x-go-name": "Description"
  21340. },
  21341. "due_on": {
  21342. "type": "string",
  21343. "format": "date-time",
  21344. "x-go-name": "Deadline"
  21345. },
  21346. "id": {
  21347. "type": "integer",
  21348. "format": "int64",
  21349. "x-go-name": "ID"
  21350. },
  21351. "open_issues": {
  21352. "type": "integer",
  21353. "format": "int64",
  21354. "x-go-name": "OpenIssues"
  21355. },
  21356. "state": {
  21357. "$ref": "#/definitions/StateType"
  21358. },
  21359. "title": {
  21360. "type": "string",
  21361. "x-go-name": "Title"
  21362. },
  21363. "updated_at": {
  21364. "type": "string",
  21365. "format": "date-time",
  21366. "x-go-name": "Updated"
  21367. }
  21368. },
  21369. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21370. },
  21371. "NewIssuePinsAllowed": {
  21372. "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed",
  21373. "type": "object",
  21374. "properties": {
  21375. "issues": {
  21376. "type": "boolean",
  21377. "x-go-name": "Issues"
  21378. },
  21379. "pull_requests": {
  21380. "type": "boolean",
  21381. "x-go-name": "PullRequests"
  21382. }
  21383. },
  21384. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21385. },
  21386. "NodeInfo": {
  21387. "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
  21388. "type": "object",
  21389. "properties": {
  21390. "metadata": {
  21391. "type": "object",
  21392. "x-go-name": "Metadata"
  21393. },
  21394. "openRegistrations": {
  21395. "type": "boolean",
  21396. "x-go-name": "OpenRegistrations"
  21397. },
  21398. "protocols": {
  21399. "type": "array",
  21400. "items": {
  21401. "type": "string"
  21402. },
  21403. "x-go-name": "Protocols"
  21404. },
  21405. "services": {
  21406. "$ref": "#/definitions/NodeInfoServices"
  21407. },
  21408. "software": {
  21409. "$ref": "#/definitions/NodeInfoSoftware"
  21410. },
  21411. "usage": {
  21412. "$ref": "#/definitions/NodeInfoUsage"
  21413. },
  21414. "version": {
  21415. "type": "string",
  21416. "x-go-name": "Version"
  21417. }
  21418. },
  21419. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21420. },
  21421. "NodeInfoServices": {
  21422. "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
  21423. "type": "object",
  21424. "properties": {
  21425. "inbound": {
  21426. "type": "array",
  21427. "items": {
  21428. "type": "string"
  21429. },
  21430. "x-go-name": "Inbound"
  21431. },
  21432. "outbound": {
  21433. "type": "array",
  21434. "items": {
  21435. "type": "string"
  21436. },
  21437. "x-go-name": "Outbound"
  21438. }
  21439. },
  21440. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21441. },
  21442. "NodeInfoSoftware": {
  21443. "description": "NodeInfoSoftware contains Metadata about server software in use",
  21444. "type": "object",
  21445. "properties": {
  21446. "homepage": {
  21447. "type": "string",
  21448. "x-go-name": "Homepage"
  21449. },
  21450. "name": {
  21451. "type": "string",
  21452. "x-go-name": "Name"
  21453. },
  21454. "repository": {
  21455. "type": "string",
  21456. "x-go-name": "Repository"
  21457. },
  21458. "version": {
  21459. "type": "string",
  21460. "x-go-name": "Version"
  21461. }
  21462. },
  21463. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21464. },
  21465. "NodeInfoUsage": {
  21466. "description": "NodeInfoUsage contains usage statistics for this server",
  21467. "type": "object",
  21468. "properties": {
  21469. "localComments": {
  21470. "type": "integer",
  21471. "format": "int64",
  21472. "x-go-name": "LocalComments"
  21473. },
  21474. "localPosts": {
  21475. "type": "integer",
  21476. "format": "int64",
  21477. "x-go-name": "LocalPosts"
  21478. },
  21479. "users": {
  21480. "$ref": "#/definitions/NodeInfoUsageUsers"
  21481. }
  21482. },
  21483. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21484. },
  21485. "NodeInfoUsageUsers": {
  21486. "description": "NodeInfoUsageUsers contains statistics about the users of this server",
  21487. "type": "object",
  21488. "properties": {
  21489. "activeHalfyear": {
  21490. "type": "integer",
  21491. "format": "int64",
  21492. "x-go-name": "ActiveHalfyear"
  21493. },
  21494. "activeMonth": {
  21495. "type": "integer",
  21496. "format": "int64",
  21497. "x-go-name": "ActiveMonth"
  21498. },
  21499. "total": {
  21500. "type": "integer",
  21501. "format": "int64",
  21502. "x-go-name": "Total"
  21503. }
  21504. },
  21505. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21506. },
  21507. "Note": {
  21508. "description": "Note contains information related to a git note",
  21509. "type": "object",
  21510. "properties": {
  21511. "commit": {
  21512. "$ref": "#/definitions/Commit"
  21513. },
  21514. "message": {
  21515. "type": "string",
  21516. "x-go-name": "Message"
  21517. }
  21518. },
  21519. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21520. },
  21521. "NotificationCount": {
  21522. "description": "NotificationCount number of unread notifications",
  21523. "type": "object",
  21524. "properties": {
  21525. "new": {
  21526. "type": "integer",
  21527. "format": "int64",
  21528. "x-go-name": "New"
  21529. }
  21530. },
  21531. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21532. },
  21533. "NotificationSubject": {
  21534. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  21535. "type": "object",
  21536. "properties": {
  21537. "html_url": {
  21538. "type": "string",
  21539. "x-go-name": "HTMLURL"
  21540. },
  21541. "latest_comment_html_url": {
  21542. "type": "string",
  21543. "x-go-name": "LatestCommentHTMLURL"
  21544. },
  21545. "latest_comment_url": {
  21546. "type": "string",
  21547. "x-go-name": "LatestCommentURL"
  21548. },
  21549. "state": {
  21550. "$ref": "#/definitions/StateType"
  21551. },
  21552. "title": {
  21553. "type": "string",
  21554. "x-go-name": "Title"
  21555. },
  21556. "type": {
  21557. "$ref": "#/definitions/NotifySubjectType"
  21558. },
  21559. "url": {
  21560. "type": "string",
  21561. "x-go-name": "URL"
  21562. }
  21563. },
  21564. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21565. },
  21566. "NotificationThread": {
  21567. "description": "NotificationThread expose Notification on API",
  21568. "type": "object",
  21569. "properties": {
  21570. "id": {
  21571. "type": "integer",
  21572. "format": "int64",
  21573. "x-go-name": "ID"
  21574. },
  21575. "pinned": {
  21576. "type": "boolean",
  21577. "x-go-name": "Pinned"
  21578. },
  21579. "repository": {
  21580. "$ref": "#/definitions/Repository"
  21581. },
  21582. "subject": {
  21583. "$ref": "#/definitions/NotificationSubject"
  21584. },
  21585. "unread": {
  21586. "type": "boolean",
  21587. "x-go-name": "Unread"
  21588. },
  21589. "updated_at": {
  21590. "type": "string",
  21591. "format": "date-time",
  21592. "x-go-name": "UpdatedAt"
  21593. },
  21594. "url": {
  21595. "type": "string",
  21596. "x-go-name": "URL"
  21597. }
  21598. },
  21599. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21600. },
  21601. "NotifySubjectType": {
  21602. "description": "NotifySubjectType represent type of notification subject",
  21603. "type": "string",
  21604. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21605. },
  21606. "OAuth2Application": {
  21607. "type": "object",
  21608. "title": "OAuth2Application represents an OAuth2 application.",
  21609. "properties": {
  21610. "client_id": {
  21611. "type": "string",
  21612. "x-go-name": "ClientID"
  21613. },
  21614. "client_secret": {
  21615. "type": "string",
  21616. "x-go-name": "ClientSecret"
  21617. },
  21618. "confidential_client": {
  21619. "type": "boolean",
  21620. "x-go-name": "ConfidentialClient"
  21621. },
  21622. "created": {
  21623. "type": "string",
  21624. "format": "date-time",
  21625. "x-go-name": "Created"
  21626. },
  21627. "id": {
  21628. "type": "integer",
  21629. "format": "int64",
  21630. "x-go-name": "ID"
  21631. },
  21632. "name": {
  21633. "type": "string",
  21634. "x-go-name": "Name"
  21635. },
  21636. "redirect_uris": {
  21637. "type": "array",
  21638. "items": {
  21639. "type": "string"
  21640. },
  21641. "x-go-name": "RedirectURIs"
  21642. }
  21643. },
  21644. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21645. },
  21646. "Organization": {
  21647. "description": "Organization represents an organization",
  21648. "type": "object",
  21649. "properties": {
  21650. "avatar_url": {
  21651. "type": "string",
  21652. "x-go-name": "AvatarURL"
  21653. },
  21654. "description": {
  21655. "type": "string",
  21656. "x-go-name": "Description"
  21657. },
  21658. "email": {
  21659. "type": "string",
  21660. "x-go-name": "Email"
  21661. },
  21662. "full_name": {
  21663. "type": "string",
  21664. "x-go-name": "FullName"
  21665. },
  21666. "id": {
  21667. "type": "integer",
  21668. "format": "int64",
  21669. "x-go-name": "ID"
  21670. },
  21671. "location": {
  21672. "type": "string",
  21673. "x-go-name": "Location"
  21674. },
  21675. "name": {
  21676. "type": "string",
  21677. "x-go-name": "Name"
  21678. },
  21679. "repo_admin_change_team_access": {
  21680. "type": "boolean",
  21681. "x-go-name": "RepoAdminChangeTeamAccess"
  21682. },
  21683. "username": {
  21684. "description": "deprecated",
  21685. "type": "string",
  21686. "x-go-name": "UserName"
  21687. },
  21688. "visibility": {
  21689. "type": "string",
  21690. "x-go-name": "Visibility"
  21691. },
  21692. "website": {
  21693. "type": "string",
  21694. "x-go-name": "Website"
  21695. }
  21696. },
  21697. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21698. },
  21699. "OrganizationPermissions": {
  21700. "description": "OrganizationPermissions list different users permissions on an organization",
  21701. "type": "object",
  21702. "properties": {
  21703. "can_create_repository": {
  21704. "type": "boolean",
  21705. "x-go-name": "CanCreateRepository"
  21706. },
  21707. "can_read": {
  21708. "type": "boolean",
  21709. "x-go-name": "CanRead"
  21710. },
  21711. "can_write": {
  21712. "type": "boolean",
  21713. "x-go-name": "CanWrite"
  21714. },
  21715. "is_admin": {
  21716. "type": "boolean",
  21717. "x-go-name": "IsAdmin"
  21718. },
  21719. "is_owner": {
  21720. "type": "boolean",
  21721. "x-go-name": "IsOwner"
  21722. }
  21723. },
  21724. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21725. },
  21726. "PRBranchInfo": {
  21727. "description": "PRBranchInfo information about a branch",
  21728. "type": "object",
  21729. "properties": {
  21730. "label": {
  21731. "type": "string",
  21732. "x-go-name": "Name"
  21733. },
  21734. "ref": {
  21735. "type": "string",
  21736. "x-go-name": "Ref"
  21737. },
  21738. "repo": {
  21739. "$ref": "#/definitions/Repository"
  21740. },
  21741. "repo_id": {
  21742. "type": "integer",
  21743. "format": "int64",
  21744. "x-go-name": "RepoID"
  21745. },
  21746. "sha": {
  21747. "type": "string",
  21748. "x-go-name": "Sha"
  21749. }
  21750. },
  21751. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21752. },
  21753. "Package": {
  21754. "description": "Package represents a package",
  21755. "type": "object",
  21756. "properties": {
  21757. "created_at": {
  21758. "type": "string",
  21759. "format": "date-time",
  21760. "x-go-name": "CreatedAt"
  21761. },
  21762. "creator": {
  21763. "$ref": "#/definitions/User"
  21764. },
  21765. "html_url": {
  21766. "type": "string",
  21767. "x-go-name": "HTMLURL"
  21768. },
  21769. "id": {
  21770. "type": "integer",
  21771. "format": "int64",
  21772. "x-go-name": "ID"
  21773. },
  21774. "name": {
  21775. "type": "string",
  21776. "x-go-name": "Name"
  21777. },
  21778. "owner": {
  21779. "$ref": "#/definitions/User"
  21780. },
  21781. "repository": {
  21782. "$ref": "#/definitions/Repository"
  21783. },
  21784. "type": {
  21785. "type": "string",
  21786. "x-go-name": "Type"
  21787. },
  21788. "version": {
  21789. "type": "string",
  21790. "x-go-name": "Version"
  21791. }
  21792. },
  21793. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21794. },
  21795. "PackageFile": {
  21796. "description": "PackageFile represents a package file",
  21797. "type": "object",
  21798. "properties": {
  21799. "Size": {
  21800. "type": "integer",
  21801. "format": "int64"
  21802. },
  21803. "id": {
  21804. "type": "integer",
  21805. "format": "int64",
  21806. "x-go-name": "ID"
  21807. },
  21808. "md5": {
  21809. "type": "string",
  21810. "x-go-name": "HashMD5"
  21811. },
  21812. "name": {
  21813. "type": "string",
  21814. "x-go-name": "Name"
  21815. },
  21816. "sha1": {
  21817. "type": "string",
  21818. "x-go-name": "HashSHA1"
  21819. },
  21820. "sha256": {
  21821. "type": "string",
  21822. "x-go-name": "HashSHA256"
  21823. },
  21824. "sha512": {
  21825. "type": "string",
  21826. "x-go-name": "HashSHA512"
  21827. }
  21828. },
  21829. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21830. },
  21831. "PayloadCommit": {
  21832. "description": "PayloadCommit represents a commit",
  21833. "type": "object",
  21834. "properties": {
  21835. "added": {
  21836. "type": "array",
  21837. "items": {
  21838. "type": "string"
  21839. },
  21840. "x-go-name": "Added"
  21841. },
  21842. "author": {
  21843. "$ref": "#/definitions/PayloadUser"
  21844. },
  21845. "committer": {
  21846. "$ref": "#/definitions/PayloadUser"
  21847. },
  21848. "id": {
  21849. "description": "sha1 hash of the commit",
  21850. "type": "string",
  21851. "x-go-name": "ID"
  21852. },
  21853. "message": {
  21854. "type": "string",
  21855. "x-go-name": "Message"
  21856. },
  21857. "modified": {
  21858. "type": "array",
  21859. "items": {
  21860. "type": "string"
  21861. },
  21862. "x-go-name": "Modified"
  21863. },
  21864. "removed": {
  21865. "type": "array",
  21866. "items": {
  21867. "type": "string"
  21868. },
  21869. "x-go-name": "Removed"
  21870. },
  21871. "timestamp": {
  21872. "type": "string",
  21873. "format": "date-time",
  21874. "x-go-name": "Timestamp"
  21875. },
  21876. "url": {
  21877. "type": "string",
  21878. "x-go-name": "URL"
  21879. },
  21880. "verification": {
  21881. "$ref": "#/definitions/PayloadCommitVerification"
  21882. }
  21883. },
  21884. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21885. },
  21886. "PayloadCommitVerification": {
  21887. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  21888. "type": "object",
  21889. "properties": {
  21890. "payload": {
  21891. "type": "string",
  21892. "x-go-name": "Payload"
  21893. },
  21894. "reason": {
  21895. "type": "string",
  21896. "x-go-name": "Reason"
  21897. },
  21898. "signature": {
  21899. "type": "string",
  21900. "x-go-name": "Signature"
  21901. },
  21902. "signer": {
  21903. "$ref": "#/definitions/PayloadUser"
  21904. },
  21905. "verified": {
  21906. "type": "boolean",
  21907. "x-go-name": "Verified"
  21908. }
  21909. },
  21910. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21911. },
  21912. "PayloadUser": {
  21913. "description": "PayloadUser represents the author or committer of a commit",
  21914. "type": "object",
  21915. "properties": {
  21916. "email": {
  21917. "type": "string",
  21918. "format": "email",
  21919. "x-go-name": "Email"
  21920. },
  21921. "name": {
  21922. "description": "Full name of the commit author",
  21923. "type": "string",
  21924. "x-go-name": "Name"
  21925. },
  21926. "username": {
  21927. "type": "string",
  21928. "x-go-name": "UserName"
  21929. }
  21930. },
  21931. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21932. },
  21933. "Permission": {
  21934. "description": "Permission represents a set of permissions",
  21935. "type": "object",
  21936. "properties": {
  21937. "admin": {
  21938. "type": "boolean",
  21939. "x-go-name": "Admin"
  21940. },
  21941. "pull": {
  21942. "type": "boolean",
  21943. "x-go-name": "Pull"
  21944. },
  21945. "push": {
  21946. "type": "boolean",
  21947. "x-go-name": "Push"
  21948. }
  21949. },
  21950. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21951. },
  21952. "PublicKey": {
  21953. "description": "PublicKey publickey is a user key to push code to repository",
  21954. "type": "object",
  21955. "properties": {
  21956. "created_at": {
  21957. "type": "string",
  21958. "format": "date-time",
  21959. "x-go-name": "Created"
  21960. },
  21961. "fingerprint": {
  21962. "type": "string",
  21963. "x-go-name": "Fingerprint"
  21964. },
  21965. "id": {
  21966. "type": "integer",
  21967. "format": "int64",
  21968. "x-go-name": "ID"
  21969. },
  21970. "key": {
  21971. "type": "string",
  21972. "x-go-name": "Key"
  21973. },
  21974. "key_type": {
  21975. "type": "string",
  21976. "x-go-name": "KeyType"
  21977. },
  21978. "read_only": {
  21979. "type": "boolean",
  21980. "x-go-name": "ReadOnly"
  21981. },
  21982. "title": {
  21983. "type": "string",
  21984. "x-go-name": "Title"
  21985. },
  21986. "url": {
  21987. "type": "string",
  21988. "x-go-name": "URL"
  21989. },
  21990. "user": {
  21991. "$ref": "#/definitions/User"
  21992. }
  21993. },
  21994. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21995. },
  21996. "PullRequest": {
  21997. "description": "PullRequest represents a pull request",
  21998. "type": "object",
  21999. "properties": {
  22000. "allow_maintainer_edit": {
  22001. "type": "boolean",
  22002. "x-go-name": "AllowMaintainerEdit"
  22003. },
  22004. "assignee": {
  22005. "$ref": "#/definitions/User"
  22006. },
  22007. "assignees": {
  22008. "type": "array",
  22009. "items": {
  22010. "$ref": "#/definitions/User"
  22011. },
  22012. "x-go-name": "Assignees"
  22013. },
  22014. "base": {
  22015. "$ref": "#/definitions/PRBranchInfo"
  22016. },
  22017. "body": {
  22018. "type": "string",
  22019. "x-go-name": "Body"
  22020. },
  22021. "closed_at": {
  22022. "type": "string",
  22023. "format": "date-time",
  22024. "x-go-name": "Closed"
  22025. },
  22026. "comments": {
  22027. "type": "integer",
  22028. "format": "int64",
  22029. "x-go-name": "Comments"
  22030. },
  22031. "created_at": {
  22032. "type": "string",
  22033. "format": "date-time",
  22034. "x-go-name": "Created"
  22035. },
  22036. "diff_url": {
  22037. "type": "string",
  22038. "x-go-name": "DiffURL"
  22039. },
  22040. "due_date": {
  22041. "type": "string",
  22042. "format": "date-time",
  22043. "x-go-name": "Deadline"
  22044. },
  22045. "head": {
  22046. "$ref": "#/definitions/PRBranchInfo"
  22047. },
  22048. "html_url": {
  22049. "type": "string",
  22050. "x-go-name": "HTMLURL"
  22051. },
  22052. "id": {
  22053. "type": "integer",
  22054. "format": "int64",
  22055. "x-go-name": "ID"
  22056. },
  22057. "is_locked": {
  22058. "type": "boolean",
  22059. "x-go-name": "IsLocked"
  22060. },
  22061. "labels": {
  22062. "type": "array",
  22063. "items": {
  22064. "$ref": "#/definitions/Label"
  22065. },
  22066. "x-go-name": "Labels"
  22067. },
  22068. "merge_base": {
  22069. "type": "string",
  22070. "x-go-name": "MergeBase"
  22071. },
  22072. "merge_commit_sha": {
  22073. "type": "string",
  22074. "x-go-name": "MergedCommitID"
  22075. },
  22076. "mergeable": {
  22077. "type": "boolean",
  22078. "x-go-name": "Mergeable"
  22079. },
  22080. "merged": {
  22081. "type": "boolean",
  22082. "x-go-name": "HasMerged"
  22083. },
  22084. "merged_at": {
  22085. "type": "string",
  22086. "format": "date-time",
  22087. "x-go-name": "Merged"
  22088. },
  22089. "merged_by": {
  22090. "$ref": "#/definitions/User"
  22091. },
  22092. "milestone": {
  22093. "$ref": "#/definitions/Milestone"
  22094. },
  22095. "number": {
  22096. "type": "integer",
  22097. "format": "int64",
  22098. "x-go-name": "Index"
  22099. },
  22100. "patch_url": {
  22101. "type": "string",
  22102. "x-go-name": "PatchURL"
  22103. },
  22104. "pin_order": {
  22105. "type": "integer",
  22106. "format": "int64",
  22107. "x-go-name": "PinOrder"
  22108. },
  22109. "requested_reviewers": {
  22110. "type": "array",
  22111. "items": {
  22112. "$ref": "#/definitions/User"
  22113. },
  22114. "x-go-name": "RequestedReviewers"
  22115. },
  22116. "state": {
  22117. "$ref": "#/definitions/StateType"
  22118. },
  22119. "title": {
  22120. "type": "string",
  22121. "x-go-name": "Title"
  22122. },
  22123. "updated_at": {
  22124. "type": "string",
  22125. "format": "date-time",
  22126. "x-go-name": "Updated"
  22127. },
  22128. "url": {
  22129. "type": "string",
  22130. "x-go-name": "URL"
  22131. },
  22132. "user": {
  22133. "$ref": "#/definitions/User"
  22134. }
  22135. },
  22136. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22137. },
  22138. "PullRequestMeta": {
  22139. "description": "PullRequestMeta PR info if an issue is a PR",
  22140. "type": "object",
  22141. "properties": {
  22142. "draft": {
  22143. "type": "boolean",
  22144. "x-go-name": "IsWorkInProgress"
  22145. },
  22146. "merged": {
  22147. "type": "boolean",
  22148. "x-go-name": "HasMerged"
  22149. },
  22150. "merged_at": {
  22151. "type": "string",
  22152. "format": "date-time",
  22153. "x-go-name": "Merged"
  22154. }
  22155. },
  22156. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22157. },
  22158. "PullReview": {
  22159. "description": "PullReview represents a pull request review",
  22160. "type": "object",
  22161. "properties": {
  22162. "body": {
  22163. "type": "string",
  22164. "x-go-name": "Body"
  22165. },
  22166. "comments_count": {
  22167. "type": "integer",
  22168. "format": "int64",
  22169. "x-go-name": "CodeCommentsCount"
  22170. },
  22171. "commit_id": {
  22172. "type": "string",
  22173. "x-go-name": "CommitID"
  22174. },
  22175. "dismissed": {
  22176. "type": "boolean",
  22177. "x-go-name": "Dismissed"
  22178. },
  22179. "html_url": {
  22180. "type": "string",
  22181. "x-go-name": "HTMLURL"
  22182. },
  22183. "id": {
  22184. "type": "integer",
  22185. "format": "int64",
  22186. "x-go-name": "ID"
  22187. },
  22188. "official": {
  22189. "type": "boolean",
  22190. "x-go-name": "Official"
  22191. },
  22192. "pull_request_url": {
  22193. "type": "string",
  22194. "x-go-name": "HTMLPullURL"
  22195. },
  22196. "stale": {
  22197. "type": "boolean",
  22198. "x-go-name": "Stale"
  22199. },
  22200. "state": {
  22201. "$ref": "#/definitions/ReviewStateType"
  22202. },
  22203. "submitted_at": {
  22204. "type": "string",
  22205. "format": "date-time",
  22206. "x-go-name": "Submitted"
  22207. },
  22208. "team": {
  22209. "$ref": "#/definitions/Team"
  22210. },
  22211. "updated_at": {
  22212. "type": "string",
  22213. "format": "date-time",
  22214. "x-go-name": "Updated"
  22215. },
  22216. "user": {
  22217. "$ref": "#/definitions/User"
  22218. }
  22219. },
  22220. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22221. },
  22222. "PullReviewComment": {
  22223. "description": "PullReviewComment represents a comment on a pull request review",
  22224. "type": "object",
  22225. "properties": {
  22226. "body": {
  22227. "type": "string",
  22228. "x-go-name": "Body"
  22229. },
  22230. "commit_id": {
  22231. "type": "string",
  22232. "x-go-name": "CommitID"
  22233. },
  22234. "created_at": {
  22235. "type": "string",
  22236. "format": "date-time",
  22237. "x-go-name": "Created"
  22238. },
  22239. "diff_hunk": {
  22240. "type": "string",
  22241. "x-go-name": "DiffHunk"
  22242. },
  22243. "html_url": {
  22244. "type": "string",
  22245. "x-go-name": "HTMLURL"
  22246. },
  22247. "id": {
  22248. "type": "integer",
  22249. "format": "int64",
  22250. "x-go-name": "ID"
  22251. },
  22252. "original_commit_id": {
  22253. "type": "string",
  22254. "x-go-name": "OrigCommitID"
  22255. },
  22256. "original_position": {
  22257. "type": "integer",
  22258. "format": "uint64",
  22259. "x-go-name": "OldLineNum"
  22260. },
  22261. "path": {
  22262. "type": "string",
  22263. "x-go-name": "Path"
  22264. },
  22265. "position": {
  22266. "type": "integer",
  22267. "format": "uint64",
  22268. "x-go-name": "LineNum"
  22269. },
  22270. "pull_request_review_id": {
  22271. "type": "integer",
  22272. "format": "int64",
  22273. "x-go-name": "ReviewID"
  22274. },
  22275. "pull_request_url": {
  22276. "type": "string",
  22277. "x-go-name": "HTMLPullURL"
  22278. },
  22279. "resolver": {
  22280. "$ref": "#/definitions/User"
  22281. },
  22282. "updated_at": {
  22283. "type": "string",
  22284. "format": "date-time",
  22285. "x-go-name": "Updated"
  22286. },
  22287. "user": {
  22288. "$ref": "#/definitions/User"
  22289. }
  22290. },
  22291. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22292. },
  22293. "PullReviewRequestOptions": {
  22294. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  22295. "type": "object",
  22296. "properties": {
  22297. "reviewers": {
  22298. "type": "array",
  22299. "items": {
  22300. "type": "string"
  22301. },
  22302. "x-go-name": "Reviewers"
  22303. },
  22304. "team_reviewers": {
  22305. "type": "array",
  22306. "items": {
  22307. "type": "string"
  22308. },
  22309. "x-go-name": "TeamReviewers"
  22310. }
  22311. },
  22312. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22313. },
  22314. "PushMirror": {
  22315. "description": "PushMirror represents information of a push mirror",
  22316. "type": "object",
  22317. "properties": {
  22318. "created": {
  22319. "type": "string",
  22320. "format": "date-time",
  22321. "x-go-name": "CreatedUnix"
  22322. },
  22323. "interval": {
  22324. "type": "string",
  22325. "x-go-name": "Interval"
  22326. },
  22327. "last_error": {
  22328. "type": "string",
  22329. "x-go-name": "LastError"
  22330. },
  22331. "last_update": {
  22332. "type": "string",
  22333. "format": "date-time",
  22334. "x-go-name": "LastUpdateUnix"
  22335. },
  22336. "remote_address": {
  22337. "type": "string",
  22338. "x-go-name": "RemoteAddress"
  22339. },
  22340. "remote_name": {
  22341. "type": "string",
  22342. "x-go-name": "RemoteName"
  22343. },
  22344. "repo_name": {
  22345. "type": "string",
  22346. "x-go-name": "RepoName"
  22347. },
  22348. "sync_on_commit": {
  22349. "type": "boolean",
  22350. "x-go-name": "SyncOnCommit"
  22351. }
  22352. },
  22353. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22354. },
  22355. "Reaction": {
  22356. "description": "Reaction contain one reaction",
  22357. "type": "object",
  22358. "properties": {
  22359. "content": {
  22360. "type": "string",
  22361. "x-go-name": "Reaction"
  22362. },
  22363. "created_at": {
  22364. "type": "string",
  22365. "format": "date-time",
  22366. "x-go-name": "Created"
  22367. },
  22368. "user": {
  22369. "$ref": "#/definitions/User"
  22370. }
  22371. },
  22372. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22373. },
  22374. "Reference": {
  22375. "type": "object",
  22376. "title": "Reference represents a Git reference.",
  22377. "properties": {
  22378. "object": {
  22379. "$ref": "#/definitions/GitObject"
  22380. },
  22381. "ref": {
  22382. "type": "string",
  22383. "x-go-name": "Ref"
  22384. },
  22385. "url": {
  22386. "type": "string",
  22387. "x-go-name": "URL"
  22388. }
  22389. },
  22390. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22391. },
  22392. "Release": {
  22393. "description": "Release represents a repository release",
  22394. "type": "object",
  22395. "properties": {
  22396. "assets": {
  22397. "type": "array",
  22398. "items": {
  22399. "$ref": "#/definitions/Attachment"
  22400. },
  22401. "x-go-name": "Attachments"
  22402. },
  22403. "author": {
  22404. "$ref": "#/definitions/User"
  22405. },
  22406. "body": {
  22407. "type": "string",
  22408. "x-go-name": "Note"
  22409. },
  22410. "created_at": {
  22411. "type": "string",
  22412. "format": "date-time",
  22413. "x-go-name": "CreatedAt"
  22414. },
  22415. "draft": {
  22416. "type": "boolean",
  22417. "x-go-name": "IsDraft"
  22418. },
  22419. "html_url": {
  22420. "type": "string",
  22421. "x-go-name": "HTMLURL"
  22422. },
  22423. "id": {
  22424. "type": "integer",
  22425. "format": "int64",
  22426. "x-go-name": "ID"
  22427. },
  22428. "name": {
  22429. "type": "string",
  22430. "x-go-name": "Title"
  22431. },
  22432. "prerelease": {
  22433. "type": "boolean",
  22434. "x-go-name": "IsPrerelease"
  22435. },
  22436. "published_at": {
  22437. "type": "string",
  22438. "format": "date-time",
  22439. "x-go-name": "PublishedAt"
  22440. },
  22441. "tag_name": {
  22442. "type": "string",
  22443. "x-go-name": "TagName"
  22444. },
  22445. "tarball_url": {
  22446. "type": "string",
  22447. "x-go-name": "TarURL"
  22448. },
  22449. "target_commitish": {
  22450. "type": "string",
  22451. "x-go-name": "Target"
  22452. },
  22453. "upload_url": {
  22454. "type": "string",
  22455. "x-go-name": "UploadURL"
  22456. },
  22457. "url": {
  22458. "type": "string",
  22459. "x-go-name": "URL"
  22460. },
  22461. "zipball_url": {
  22462. "type": "string",
  22463. "x-go-name": "ZipURL"
  22464. }
  22465. },
  22466. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22467. },
  22468. "RenameUserOption": {
  22469. "description": "RenameUserOption options when renaming a user",
  22470. "type": "object",
  22471. "required": [
  22472. "new_username"
  22473. ],
  22474. "properties": {
  22475. "new_username": {
  22476. "description": "New username for this user. This name cannot be in use yet by any other user.",
  22477. "type": "string",
  22478. "uniqueItems": true,
  22479. "x-go-name": "NewName"
  22480. }
  22481. },
  22482. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22483. },
  22484. "RepoCollaboratorPermission": {
  22485. "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
  22486. "type": "object",
  22487. "properties": {
  22488. "permission": {
  22489. "type": "string",
  22490. "x-go-name": "Permission"
  22491. },
  22492. "role_name": {
  22493. "type": "string",
  22494. "x-go-name": "RoleName"
  22495. },
  22496. "user": {
  22497. "$ref": "#/definitions/User"
  22498. }
  22499. },
  22500. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22501. },
  22502. "RepoCommit": {
  22503. "type": "object",
  22504. "title": "RepoCommit contains information of a commit in the context of a repository.",
  22505. "properties": {
  22506. "author": {
  22507. "$ref": "#/definitions/CommitUser"
  22508. },
  22509. "committer": {
  22510. "$ref": "#/definitions/CommitUser"
  22511. },
  22512. "message": {
  22513. "type": "string",
  22514. "x-go-name": "Message"
  22515. },
  22516. "tree": {
  22517. "$ref": "#/definitions/CommitMeta"
  22518. },
  22519. "url": {
  22520. "type": "string",
  22521. "x-go-name": "URL"
  22522. },
  22523. "verification": {
  22524. "$ref": "#/definitions/PayloadCommitVerification"
  22525. }
  22526. },
  22527. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22528. },
  22529. "RepoTopicOptions": {
  22530. "description": "RepoTopicOptions a collection of repo topic names",
  22531. "type": "object",
  22532. "properties": {
  22533. "topics": {
  22534. "description": "list of topic names",
  22535. "type": "array",
  22536. "items": {
  22537. "type": "string"
  22538. },
  22539. "x-go-name": "Topics"
  22540. }
  22541. },
  22542. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22543. },
  22544. "RepoTransfer": {
  22545. "description": "RepoTransfer represents a pending repo transfer",
  22546. "type": "object",
  22547. "properties": {
  22548. "doer": {
  22549. "$ref": "#/definitions/User"
  22550. },
  22551. "recipient": {
  22552. "$ref": "#/definitions/User"
  22553. },
  22554. "teams": {
  22555. "type": "array",
  22556. "items": {
  22557. "$ref": "#/definitions/Team"
  22558. },
  22559. "x-go-name": "Teams"
  22560. }
  22561. },
  22562. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22563. },
  22564. "Repository": {
  22565. "description": "Repository represents a repository",
  22566. "type": "object",
  22567. "properties": {
  22568. "allow_fast_forward_only_merge": {
  22569. "type": "boolean",
  22570. "x-go-name": "AllowFastForwardOnly"
  22571. },
  22572. "allow_merge_commits": {
  22573. "type": "boolean",
  22574. "x-go-name": "AllowMerge"
  22575. },
  22576. "allow_rebase": {
  22577. "type": "boolean",
  22578. "x-go-name": "AllowRebase"
  22579. },
  22580. "allow_rebase_explicit": {
  22581. "type": "boolean",
  22582. "x-go-name": "AllowRebaseMerge"
  22583. },
  22584. "allow_rebase_update": {
  22585. "type": "boolean",
  22586. "x-go-name": "AllowRebaseUpdate"
  22587. },
  22588. "allow_squash_merge": {
  22589. "type": "boolean",
  22590. "x-go-name": "AllowSquash"
  22591. },
  22592. "archived": {
  22593. "type": "boolean",
  22594. "x-go-name": "Archived"
  22595. },
  22596. "archived_at": {
  22597. "type": "string",
  22598. "format": "date-time",
  22599. "x-go-name": "ArchivedAt"
  22600. },
  22601. "avatar_url": {
  22602. "type": "string",
  22603. "x-go-name": "AvatarURL"
  22604. },
  22605. "clone_url": {
  22606. "type": "string",
  22607. "x-go-name": "CloneURL"
  22608. },
  22609. "created_at": {
  22610. "type": "string",
  22611. "format": "date-time",
  22612. "x-go-name": "Created"
  22613. },
  22614. "default_allow_maintainer_edit": {
  22615. "type": "boolean",
  22616. "x-go-name": "DefaultAllowMaintainerEdit"
  22617. },
  22618. "default_branch": {
  22619. "type": "string",
  22620. "x-go-name": "DefaultBranch"
  22621. },
  22622. "default_delete_branch_after_merge": {
  22623. "type": "boolean",
  22624. "x-go-name": "DefaultDeleteBranchAfterMerge"
  22625. },
  22626. "default_merge_style": {
  22627. "type": "string",
  22628. "x-go-name": "DefaultMergeStyle"
  22629. },
  22630. "description": {
  22631. "type": "string",
  22632. "x-go-name": "Description"
  22633. },
  22634. "empty": {
  22635. "type": "boolean",
  22636. "x-go-name": "Empty"
  22637. },
  22638. "external_tracker": {
  22639. "$ref": "#/definitions/ExternalTracker"
  22640. },
  22641. "external_wiki": {
  22642. "$ref": "#/definitions/ExternalWiki"
  22643. },
  22644. "fork": {
  22645. "type": "boolean",
  22646. "x-go-name": "Fork"
  22647. },
  22648. "forks_count": {
  22649. "type": "integer",
  22650. "format": "int64",
  22651. "x-go-name": "Forks"
  22652. },
  22653. "full_name": {
  22654. "type": "string",
  22655. "x-go-name": "FullName"
  22656. },
  22657. "has_actions": {
  22658. "type": "boolean",
  22659. "x-go-name": "HasActions"
  22660. },
  22661. "has_issues": {
  22662. "type": "boolean",
  22663. "x-go-name": "HasIssues"
  22664. },
  22665. "has_packages": {
  22666. "type": "boolean",
  22667. "x-go-name": "HasPackages"
  22668. },
  22669. "has_projects": {
  22670. "type": "boolean",
  22671. "x-go-name": "HasProjects"
  22672. },
  22673. "has_pull_requests": {
  22674. "type": "boolean",
  22675. "x-go-name": "HasPullRequests"
  22676. },
  22677. "has_releases": {
  22678. "type": "boolean",
  22679. "x-go-name": "HasReleases"
  22680. },
  22681. "has_wiki": {
  22682. "type": "boolean",
  22683. "x-go-name": "HasWiki"
  22684. },
  22685. "html_url": {
  22686. "type": "string",
  22687. "x-go-name": "HTMLURL"
  22688. },
  22689. "id": {
  22690. "type": "integer",
  22691. "format": "int64",
  22692. "x-go-name": "ID"
  22693. },
  22694. "ignore_whitespace_conflicts": {
  22695. "type": "boolean",
  22696. "x-go-name": "IgnoreWhitespaceConflicts"
  22697. },
  22698. "internal": {
  22699. "type": "boolean",
  22700. "x-go-name": "Internal"
  22701. },
  22702. "internal_tracker": {
  22703. "$ref": "#/definitions/InternalTracker"
  22704. },
  22705. "language": {
  22706. "type": "string",
  22707. "x-go-name": "Language"
  22708. },
  22709. "languages_url": {
  22710. "type": "string",
  22711. "x-go-name": "LanguagesURL"
  22712. },
  22713. "link": {
  22714. "type": "string",
  22715. "x-go-name": "Link"
  22716. },
  22717. "mirror": {
  22718. "type": "boolean",
  22719. "x-go-name": "Mirror"
  22720. },
  22721. "mirror_interval": {
  22722. "type": "string",
  22723. "x-go-name": "MirrorInterval"
  22724. },
  22725. "mirror_updated": {
  22726. "type": "string",
  22727. "format": "date-time",
  22728. "x-go-name": "MirrorUpdated"
  22729. },
  22730. "name": {
  22731. "type": "string",
  22732. "x-go-name": "Name"
  22733. },
  22734. "object_format_name": {
  22735. "description": "ObjectFormatName of the underlying git repository",
  22736. "type": "string",
  22737. "enum": [
  22738. "sha1",
  22739. "sha256"
  22740. ],
  22741. "x-go-name": "ObjectFormatName"
  22742. },
  22743. "open_issues_count": {
  22744. "type": "integer",
  22745. "format": "int64",
  22746. "x-go-name": "OpenIssues"
  22747. },
  22748. "open_pr_counter": {
  22749. "type": "integer",
  22750. "format": "int64",
  22751. "x-go-name": "OpenPulls"
  22752. },
  22753. "original_url": {
  22754. "type": "string",
  22755. "x-go-name": "OriginalURL"
  22756. },
  22757. "owner": {
  22758. "$ref": "#/definitions/User"
  22759. },
  22760. "parent": {
  22761. "$ref": "#/definitions/Repository"
  22762. },
  22763. "permissions": {
  22764. "$ref": "#/definitions/Permission"
  22765. },
  22766. "private": {
  22767. "type": "boolean",
  22768. "x-go-name": "Private"
  22769. },
  22770. "projects_mode": {
  22771. "type": "string",
  22772. "x-go-name": "ProjectsMode"
  22773. },
  22774. "release_counter": {
  22775. "type": "integer",
  22776. "format": "int64",
  22777. "x-go-name": "Releases"
  22778. },
  22779. "repo_transfer": {
  22780. "$ref": "#/definitions/RepoTransfer"
  22781. },
  22782. "size": {
  22783. "type": "integer",
  22784. "format": "int64",
  22785. "x-go-name": "Size"
  22786. },
  22787. "ssh_url": {
  22788. "type": "string",
  22789. "x-go-name": "SSHURL"
  22790. },
  22791. "stars_count": {
  22792. "type": "integer",
  22793. "format": "int64",
  22794. "x-go-name": "Stars"
  22795. },
  22796. "template": {
  22797. "type": "boolean",
  22798. "x-go-name": "Template"
  22799. },
  22800. "updated_at": {
  22801. "type": "string",
  22802. "format": "date-time",
  22803. "x-go-name": "Updated"
  22804. },
  22805. "url": {
  22806. "type": "string",
  22807. "x-go-name": "URL"
  22808. },
  22809. "watchers_count": {
  22810. "type": "integer",
  22811. "format": "int64",
  22812. "x-go-name": "Watchers"
  22813. },
  22814. "website": {
  22815. "type": "string",
  22816. "x-go-name": "Website"
  22817. }
  22818. },
  22819. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22820. },
  22821. "RepositoryMeta": {
  22822. "description": "RepositoryMeta basic repository information",
  22823. "type": "object",
  22824. "properties": {
  22825. "full_name": {
  22826. "type": "string",
  22827. "x-go-name": "FullName"
  22828. },
  22829. "id": {
  22830. "type": "integer",
  22831. "format": "int64",
  22832. "x-go-name": "ID"
  22833. },
  22834. "name": {
  22835. "type": "string",
  22836. "x-go-name": "Name"
  22837. },
  22838. "owner": {
  22839. "type": "string",
  22840. "x-go-name": "Owner"
  22841. }
  22842. },
  22843. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22844. },
  22845. "ReviewStateType": {
  22846. "description": "ReviewStateType review state type",
  22847. "type": "string",
  22848. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22849. },
  22850. "SearchResults": {
  22851. "description": "SearchResults results of a successful search",
  22852. "type": "object",
  22853. "properties": {
  22854. "data": {
  22855. "type": "array",
  22856. "items": {
  22857. "$ref": "#/definitions/Repository"
  22858. },
  22859. "x-go-name": "Data"
  22860. },
  22861. "ok": {
  22862. "type": "boolean",
  22863. "x-go-name": "OK"
  22864. }
  22865. },
  22866. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22867. },
  22868. "Secret": {
  22869. "description": "Secret represents a secret",
  22870. "type": "object",
  22871. "properties": {
  22872. "created_at": {
  22873. "type": "string",
  22874. "format": "date-time",
  22875. "x-go-name": "Created"
  22876. },
  22877. "name": {
  22878. "description": "the secret's name",
  22879. "type": "string",
  22880. "x-go-name": "Name"
  22881. }
  22882. },
  22883. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22884. },
  22885. "ServerVersion": {
  22886. "description": "ServerVersion wraps the version of the server",
  22887. "type": "object",
  22888. "properties": {
  22889. "version": {
  22890. "type": "string",
  22891. "x-go-name": "Version"
  22892. }
  22893. },
  22894. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22895. },
  22896. "StateType": {
  22897. "description": "StateType issue state type",
  22898. "type": "string",
  22899. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22900. },
  22901. "StopWatch": {
  22902. "description": "StopWatch represent a running stopwatch",
  22903. "type": "object",
  22904. "properties": {
  22905. "created": {
  22906. "type": "string",
  22907. "format": "date-time",
  22908. "x-go-name": "Created"
  22909. },
  22910. "duration": {
  22911. "type": "string",
  22912. "x-go-name": "Duration"
  22913. },
  22914. "issue_index": {
  22915. "type": "integer",
  22916. "format": "int64",
  22917. "x-go-name": "IssueIndex"
  22918. },
  22919. "issue_title": {
  22920. "type": "string",
  22921. "x-go-name": "IssueTitle"
  22922. },
  22923. "repo_name": {
  22924. "type": "string",
  22925. "x-go-name": "RepoName"
  22926. },
  22927. "repo_owner_name": {
  22928. "type": "string",
  22929. "x-go-name": "RepoOwnerName"
  22930. },
  22931. "seconds": {
  22932. "type": "integer",
  22933. "format": "int64",
  22934. "x-go-name": "Seconds"
  22935. }
  22936. },
  22937. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22938. },
  22939. "SubmitPullReviewOptions": {
  22940. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  22941. "type": "object",
  22942. "properties": {
  22943. "body": {
  22944. "type": "string",
  22945. "x-go-name": "Body"
  22946. },
  22947. "event": {
  22948. "$ref": "#/definitions/ReviewStateType"
  22949. }
  22950. },
  22951. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22952. },
  22953. "Tag": {
  22954. "description": "Tag represents a repository tag",
  22955. "type": "object",
  22956. "properties": {
  22957. "commit": {
  22958. "$ref": "#/definitions/CommitMeta"
  22959. },
  22960. "id": {
  22961. "type": "string",
  22962. "x-go-name": "ID"
  22963. },
  22964. "message": {
  22965. "type": "string",
  22966. "x-go-name": "Message"
  22967. },
  22968. "name": {
  22969. "type": "string",
  22970. "x-go-name": "Name"
  22971. },
  22972. "tarball_url": {
  22973. "type": "string",
  22974. "x-go-name": "TarballURL"
  22975. },
  22976. "zipball_url": {
  22977. "type": "string",
  22978. "x-go-name": "ZipballURL"
  22979. }
  22980. },
  22981. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22982. },
  22983. "Team": {
  22984. "description": "Team represents a team in an organization",
  22985. "type": "object",
  22986. "properties": {
  22987. "can_create_org_repo": {
  22988. "type": "boolean",
  22989. "x-go-name": "CanCreateOrgRepo"
  22990. },
  22991. "description": {
  22992. "type": "string",
  22993. "x-go-name": "Description"
  22994. },
  22995. "id": {
  22996. "type": "integer",
  22997. "format": "int64",
  22998. "x-go-name": "ID"
  22999. },
  23000. "includes_all_repositories": {
  23001. "type": "boolean",
  23002. "x-go-name": "IncludesAllRepositories"
  23003. },
  23004. "name": {
  23005. "type": "string",
  23006. "x-go-name": "Name"
  23007. },
  23008. "organization": {
  23009. "$ref": "#/definitions/Organization"
  23010. },
  23011. "permission": {
  23012. "type": "string",
  23013. "enum": [
  23014. "none",
  23015. "read",
  23016. "write",
  23017. "admin",
  23018. "owner"
  23019. ],
  23020. "x-go-name": "Permission"
  23021. },
  23022. "units": {
  23023. "type": "array",
  23024. "items": {
  23025. "type": "string"
  23026. },
  23027. "x-go-name": "Units",
  23028. "example": [
  23029. "repo.code",
  23030. "repo.issues",
  23031. "repo.ext_issues",
  23032. "repo.wiki",
  23033. "repo.pulls",
  23034. "repo.releases",
  23035. "repo.projects",
  23036. "repo.ext_wiki"
  23037. ]
  23038. },
  23039. "units_map": {
  23040. "type": "object",
  23041. "additionalProperties": {
  23042. "type": "string"
  23043. },
  23044. "x-go-name": "UnitsMap",
  23045. "example": {
  23046. "repo.code": "read",
  23047. "repo.ext_issues": "none",
  23048. "repo.ext_wiki": "none",
  23049. "repo.issues": "write",
  23050. "repo.projects": "none",
  23051. "repo.pulls": "owner",
  23052. "repo.releases": "none",
  23053. "repo.wiki": "admin"
  23054. }
  23055. }
  23056. },
  23057. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23058. },
  23059. "TimeStamp": {
  23060. "description": "TimeStamp defines a timestamp",
  23061. "type": "integer",
  23062. "format": "int64",
  23063. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  23064. },
  23065. "TimelineComment": {
  23066. "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
  23067. "type": "object",
  23068. "properties": {
  23069. "assignee": {
  23070. "$ref": "#/definitions/User"
  23071. },
  23072. "assignee_team": {
  23073. "$ref": "#/definitions/Team"
  23074. },
  23075. "body": {
  23076. "type": "string",
  23077. "x-go-name": "Body"
  23078. },
  23079. "created_at": {
  23080. "type": "string",
  23081. "format": "date-time",
  23082. "x-go-name": "Created"
  23083. },
  23084. "dependent_issue": {
  23085. "$ref": "#/definitions/Issue"
  23086. },
  23087. "html_url": {
  23088. "type": "string",
  23089. "x-go-name": "HTMLURL"
  23090. },
  23091. "id": {
  23092. "type": "integer",
  23093. "format": "int64",
  23094. "x-go-name": "ID"
  23095. },
  23096. "issue_url": {
  23097. "type": "string",
  23098. "x-go-name": "IssueURL"
  23099. },
  23100. "label": {
  23101. "$ref": "#/definitions/Label"
  23102. },
  23103. "milestone": {
  23104. "$ref": "#/definitions/Milestone"
  23105. },
  23106. "new_ref": {
  23107. "type": "string",
  23108. "x-go-name": "NewRef"
  23109. },
  23110. "new_title": {
  23111. "type": "string",
  23112. "x-go-name": "NewTitle"
  23113. },
  23114. "old_milestone": {
  23115. "$ref": "#/definitions/Milestone"
  23116. },
  23117. "old_project_id": {
  23118. "type": "integer",
  23119. "format": "int64",
  23120. "x-go-name": "OldProjectID"
  23121. },
  23122. "old_ref": {
  23123. "type": "string",
  23124. "x-go-name": "OldRef"
  23125. },
  23126. "old_title": {
  23127. "type": "string",
  23128. "x-go-name": "OldTitle"
  23129. },
  23130. "project_id": {
  23131. "type": "integer",
  23132. "format": "int64",
  23133. "x-go-name": "ProjectID"
  23134. },
  23135. "pull_request_url": {
  23136. "type": "string",
  23137. "x-go-name": "PRURL"
  23138. },
  23139. "ref_action": {
  23140. "type": "string",
  23141. "x-go-name": "RefAction"
  23142. },
  23143. "ref_comment": {
  23144. "$ref": "#/definitions/Comment"
  23145. },
  23146. "ref_commit_sha": {
  23147. "description": "commit SHA where issue/PR was referenced",
  23148. "type": "string",
  23149. "x-go-name": "RefCommitSHA"
  23150. },
  23151. "ref_issue": {
  23152. "$ref": "#/definitions/Issue"
  23153. },
  23154. "removed_assignee": {
  23155. "description": "whether the assignees were removed or added",
  23156. "type": "boolean",
  23157. "x-go-name": "RemovedAssignee"
  23158. },
  23159. "resolve_doer": {
  23160. "$ref": "#/definitions/User"
  23161. },
  23162. "review_id": {
  23163. "type": "integer",
  23164. "format": "int64",
  23165. "x-go-name": "ReviewID"
  23166. },
  23167. "tracked_time": {
  23168. "$ref": "#/definitions/TrackedTime"
  23169. },
  23170. "type": {
  23171. "type": "string",
  23172. "x-go-name": "Type"
  23173. },
  23174. "updated_at": {
  23175. "type": "string",
  23176. "format": "date-time",
  23177. "x-go-name": "Updated"
  23178. },
  23179. "user": {
  23180. "$ref": "#/definitions/User"
  23181. }
  23182. },
  23183. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23184. },
  23185. "TopicName": {
  23186. "description": "TopicName a list of repo topic names",
  23187. "type": "object",
  23188. "properties": {
  23189. "topics": {
  23190. "type": "array",
  23191. "items": {
  23192. "type": "string"
  23193. },
  23194. "x-go-name": "TopicNames"
  23195. }
  23196. },
  23197. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23198. },
  23199. "TopicResponse": {
  23200. "description": "TopicResponse for returning topics",
  23201. "type": "object",
  23202. "properties": {
  23203. "created": {
  23204. "type": "string",
  23205. "format": "date-time",
  23206. "x-go-name": "Created"
  23207. },
  23208. "id": {
  23209. "type": "integer",
  23210. "format": "int64",
  23211. "x-go-name": "ID"
  23212. },
  23213. "repo_count": {
  23214. "type": "integer",
  23215. "format": "int64",
  23216. "x-go-name": "RepoCount"
  23217. },
  23218. "topic_name": {
  23219. "type": "string",
  23220. "x-go-name": "Name"
  23221. },
  23222. "updated": {
  23223. "type": "string",
  23224. "format": "date-time",
  23225. "x-go-name": "Updated"
  23226. }
  23227. },
  23228. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23229. },
  23230. "TrackedTime": {
  23231. "description": "TrackedTime worked time for an issue / pr",
  23232. "type": "object",
  23233. "properties": {
  23234. "created": {
  23235. "type": "string",
  23236. "format": "date-time",
  23237. "x-go-name": "Created"
  23238. },
  23239. "id": {
  23240. "type": "integer",
  23241. "format": "int64",
  23242. "x-go-name": "ID"
  23243. },
  23244. "issue": {
  23245. "$ref": "#/definitions/Issue"
  23246. },
  23247. "issue_id": {
  23248. "description": "deprecated (only for backwards compatibility)",
  23249. "type": "integer",
  23250. "format": "int64",
  23251. "x-go-name": "IssueID"
  23252. },
  23253. "time": {
  23254. "description": "Time in seconds",
  23255. "type": "integer",
  23256. "format": "int64",
  23257. "x-go-name": "Time"
  23258. },
  23259. "user_id": {
  23260. "description": "deprecated (only for backwards compatibility)",
  23261. "type": "integer",
  23262. "format": "int64",
  23263. "x-go-name": "UserID"
  23264. },
  23265. "user_name": {
  23266. "type": "string",
  23267. "x-go-name": "UserName"
  23268. }
  23269. },
  23270. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23271. },
  23272. "TransferRepoOption": {
  23273. "description": "TransferRepoOption options when transfer a repository's ownership",
  23274. "type": "object",
  23275. "required": [
  23276. "new_owner"
  23277. ],
  23278. "properties": {
  23279. "new_owner": {
  23280. "type": "string",
  23281. "x-go-name": "NewOwner"
  23282. },
  23283. "team_ids": {
  23284. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  23285. "type": "array",
  23286. "items": {
  23287. "type": "integer",
  23288. "format": "int64"
  23289. },
  23290. "x-go-name": "TeamIDs"
  23291. }
  23292. },
  23293. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23294. },
  23295. "UpdateFileOptions": {
  23296. "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)",
  23297. "type": "object",
  23298. "required": [
  23299. "sha",
  23300. "content"
  23301. ],
  23302. "properties": {
  23303. "author": {
  23304. "$ref": "#/definitions/Identity"
  23305. },
  23306. "branch": {
  23307. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  23308. "type": "string",
  23309. "x-go-name": "BranchName"
  23310. },
  23311. "committer": {
  23312. "$ref": "#/definitions/Identity"
  23313. },
  23314. "content": {
  23315. "description": "content must be base64 encoded",
  23316. "type": "string",
  23317. "x-go-name": "ContentBase64"
  23318. },
  23319. "dates": {
  23320. "$ref": "#/definitions/CommitDateOptions"
  23321. },
  23322. "from_path": {
  23323. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  23324. "type": "string",
  23325. "x-go-name": "FromPath"
  23326. },
  23327. "message": {
  23328. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  23329. "type": "string",
  23330. "x-go-name": "Message"
  23331. },
  23332. "new_branch": {
  23333. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  23334. "type": "string",
  23335. "x-go-name": "NewBranchName"
  23336. },
  23337. "sha": {
  23338. "description": "sha is the SHA for the file that already exists",
  23339. "type": "string",
  23340. "x-go-name": "SHA"
  23341. },
  23342. "signoff": {
  23343. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  23344. "type": "boolean",
  23345. "x-go-name": "Signoff"
  23346. }
  23347. },
  23348. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23349. },
  23350. "UpdateRepoAvatarOption": {
  23351. "description": "UpdateRepoAvatarUserOption options when updating the repo avatar",
  23352. "type": "object",
  23353. "properties": {
  23354. "image": {
  23355. "description": "image must be base64 encoded",
  23356. "type": "string",
  23357. "x-go-name": "Image"
  23358. }
  23359. },
  23360. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23361. },
  23362. "UpdateUserAvatarOption": {
  23363. "description": "UpdateUserAvatarUserOption options when updating the user avatar",
  23364. "type": "object",
  23365. "properties": {
  23366. "image": {
  23367. "description": "image must be base64 encoded",
  23368. "type": "string",
  23369. "x-go-name": "Image"
  23370. }
  23371. },
  23372. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23373. },
  23374. "User": {
  23375. "description": "User represents a user",
  23376. "type": "object",
  23377. "properties": {
  23378. "active": {
  23379. "description": "Is user active",
  23380. "type": "boolean",
  23381. "x-go-name": "IsActive"
  23382. },
  23383. "avatar_url": {
  23384. "description": "URL to the user's avatar",
  23385. "type": "string",
  23386. "x-go-name": "AvatarURL"
  23387. },
  23388. "created": {
  23389. "type": "string",
  23390. "format": "date-time",
  23391. "x-go-name": "Created"
  23392. },
  23393. "description": {
  23394. "description": "the user's description",
  23395. "type": "string",
  23396. "x-go-name": "Description"
  23397. },
  23398. "email": {
  23399. "type": "string",
  23400. "format": "email",
  23401. "x-go-name": "Email"
  23402. },
  23403. "followers_count": {
  23404. "description": "user counts",
  23405. "type": "integer",
  23406. "format": "int64",
  23407. "x-go-name": "Followers"
  23408. },
  23409. "following_count": {
  23410. "type": "integer",
  23411. "format": "int64",
  23412. "x-go-name": "Following"
  23413. },
  23414. "full_name": {
  23415. "description": "the user's full name",
  23416. "type": "string",
  23417. "x-go-name": "FullName"
  23418. },
  23419. "id": {
  23420. "description": "the user's id",
  23421. "type": "integer",
  23422. "format": "int64",
  23423. "x-go-name": "ID"
  23424. },
  23425. "is_admin": {
  23426. "description": "Is the user an administrator",
  23427. "type": "boolean",
  23428. "x-go-name": "IsAdmin"
  23429. },
  23430. "language": {
  23431. "description": "User locale",
  23432. "type": "string",
  23433. "x-go-name": "Language"
  23434. },
  23435. "last_login": {
  23436. "type": "string",
  23437. "format": "date-time",
  23438. "x-go-name": "LastLogin"
  23439. },
  23440. "location": {
  23441. "description": "the user's location",
  23442. "type": "string",
  23443. "x-go-name": "Location"
  23444. },
  23445. "login": {
  23446. "description": "the user's username",
  23447. "type": "string",
  23448. "x-go-name": "UserName"
  23449. },
  23450. "login_name": {
  23451. "description": "the user's authentication sign-in name.",
  23452. "type": "string",
  23453. "default": "empty",
  23454. "x-go-name": "LoginName"
  23455. },
  23456. "prohibit_login": {
  23457. "description": "Is user login prohibited",
  23458. "type": "boolean",
  23459. "x-go-name": "ProhibitLogin"
  23460. },
  23461. "restricted": {
  23462. "description": "Is user restricted",
  23463. "type": "boolean",
  23464. "x-go-name": "Restricted"
  23465. },
  23466. "starred_repos_count": {
  23467. "type": "integer",
  23468. "format": "int64",
  23469. "x-go-name": "StarredRepos"
  23470. },
  23471. "visibility": {
  23472. "description": "User visibility level option: public, limited, private",
  23473. "type": "string",
  23474. "x-go-name": "Visibility"
  23475. },
  23476. "website": {
  23477. "description": "the user's website",
  23478. "type": "string",
  23479. "x-go-name": "Website"
  23480. }
  23481. },
  23482. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23483. },
  23484. "UserBadgeOption": {
  23485. "description": "UserBadgeOption options for link between users and badges",
  23486. "type": "object",
  23487. "properties": {
  23488. "badge_slugs": {
  23489. "type": "array",
  23490. "items": {
  23491. "type": "string"
  23492. },
  23493. "x-go-name": "BadgeSlugs",
  23494. "example": [
  23495. "badge1",
  23496. "badge2"
  23497. ]
  23498. }
  23499. },
  23500. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23501. },
  23502. "UserHeatmapData": {
  23503. "description": "UserHeatmapData represents the data needed to create a heatmap",
  23504. "type": "object",
  23505. "properties": {
  23506. "contributions": {
  23507. "type": "integer",
  23508. "format": "int64",
  23509. "x-go-name": "Contributions"
  23510. },
  23511. "timestamp": {
  23512. "$ref": "#/definitions/TimeStamp"
  23513. }
  23514. },
  23515. "x-go-package": "code.gitea.io/gitea/models/activities"
  23516. },
  23517. "UserSettings": {
  23518. "description": "UserSettings represents user settings",
  23519. "type": "object",
  23520. "properties": {
  23521. "description": {
  23522. "type": "string",
  23523. "x-go-name": "Description"
  23524. },
  23525. "diff_view_style": {
  23526. "type": "string",
  23527. "x-go-name": "DiffViewStyle"
  23528. },
  23529. "full_name": {
  23530. "type": "string",
  23531. "x-go-name": "FullName"
  23532. },
  23533. "hide_activity": {
  23534. "type": "boolean",
  23535. "x-go-name": "HideActivity"
  23536. },
  23537. "hide_email": {
  23538. "description": "Privacy",
  23539. "type": "boolean",
  23540. "x-go-name": "HideEmail"
  23541. },
  23542. "language": {
  23543. "type": "string",
  23544. "x-go-name": "Language"
  23545. },
  23546. "location": {
  23547. "type": "string",
  23548. "x-go-name": "Location"
  23549. },
  23550. "theme": {
  23551. "type": "string",
  23552. "x-go-name": "Theme"
  23553. },
  23554. "website": {
  23555. "type": "string",
  23556. "x-go-name": "Website"
  23557. }
  23558. },
  23559. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23560. },
  23561. "UserSettingsOptions": {
  23562. "description": "UserSettingsOptions represents options to change user settings",
  23563. "type": "object",
  23564. "properties": {
  23565. "description": {
  23566. "type": "string",
  23567. "x-go-name": "Description"
  23568. },
  23569. "diff_view_style": {
  23570. "type": "string",
  23571. "x-go-name": "DiffViewStyle"
  23572. },
  23573. "full_name": {
  23574. "type": "string",
  23575. "x-go-name": "FullName"
  23576. },
  23577. "hide_activity": {
  23578. "type": "boolean",
  23579. "x-go-name": "HideActivity"
  23580. },
  23581. "hide_email": {
  23582. "description": "Privacy",
  23583. "type": "boolean",
  23584. "x-go-name": "HideEmail"
  23585. },
  23586. "language": {
  23587. "type": "string",
  23588. "x-go-name": "Language"
  23589. },
  23590. "location": {
  23591. "type": "string",
  23592. "x-go-name": "Location"
  23593. },
  23594. "theme": {
  23595. "type": "string",
  23596. "x-go-name": "Theme"
  23597. },
  23598. "website": {
  23599. "type": "string",
  23600. "x-go-name": "Website"
  23601. }
  23602. },
  23603. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23604. },
  23605. "WatchInfo": {
  23606. "description": "WatchInfo represents an API watch status of one repository",
  23607. "type": "object",
  23608. "properties": {
  23609. "created_at": {
  23610. "type": "string",
  23611. "format": "date-time",
  23612. "x-go-name": "CreatedAt"
  23613. },
  23614. "ignored": {
  23615. "type": "boolean",
  23616. "x-go-name": "Ignored"
  23617. },
  23618. "reason": {
  23619. "x-go-name": "Reason"
  23620. },
  23621. "repository_url": {
  23622. "type": "string",
  23623. "x-go-name": "RepositoryURL"
  23624. },
  23625. "subscribed": {
  23626. "type": "boolean",
  23627. "x-go-name": "Subscribed"
  23628. },
  23629. "url": {
  23630. "type": "string",
  23631. "x-go-name": "URL"
  23632. }
  23633. },
  23634. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23635. },
  23636. "WikiCommit": {
  23637. "description": "WikiCommit page commit/revision",
  23638. "type": "object",
  23639. "properties": {
  23640. "author": {
  23641. "$ref": "#/definitions/CommitUser"
  23642. },
  23643. "commiter": {
  23644. "$ref": "#/definitions/CommitUser"
  23645. },
  23646. "message": {
  23647. "type": "string",
  23648. "x-go-name": "Message"
  23649. },
  23650. "sha": {
  23651. "type": "string",
  23652. "x-go-name": "ID"
  23653. }
  23654. },
  23655. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23656. },
  23657. "WikiCommitList": {
  23658. "description": "WikiCommitList commit/revision list",
  23659. "type": "object",
  23660. "properties": {
  23661. "commits": {
  23662. "type": "array",
  23663. "items": {
  23664. "$ref": "#/definitions/WikiCommit"
  23665. },
  23666. "x-go-name": "WikiCommits"
  23667. },
  23668. "count": {
  23669. "type": "integer",
  23670. "format": "int64",
  23671. "x-go-name": "Count"
  23672. }
  23673. },
  23674. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23675. },
  23676. "WikiPage": {
  23677. "description": "WikiPage a wiki page",
  23678. "type": "object",
  23679. "properties": {
  23680. "commit_count": {
  23681. "type": "integer",
  23682. "format": "int64",
  23683. "x-go-name": "CommitCount"
  23684. },
  23685. "content_base64": {
  23686. "description": "Page content, base64 encoded",
  23687. "type": "string",
  23688. "x-go-name": "ContentBase64"
  23689. },
  23690. "footer": {
  23691. "type": "string",
  23692. "x-go-name": "Footer"
  23693. },
  23694. "html_url": {
  23695. "type": "string",
  23696. "x-go-name": "HTMLURL"
  23697. },
  23698. "last_commit": {
  23699. "$ref": "#/definitions/WikiCommit"
  23700. },
  23701. "sidebar": {
  23702. "type": "string",
  23703. "x-go-name": "Sidebar"
  23704. },
  23705. "sub_url": {
  23706. "type": "string",
  23707. "x-go-name": "SubURL"
  23708. },
  23709. "title": {
  23710. "type": "string",
  23711. "x-go-name": "Title"
  23712. }
  23713. },
  23714. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23715. },
  23716. "WikiPageMetaData": {
  23717. "description": "WikiPageMetaData wiki page meta information",
  23718. "type": "object",
  23719. "properties": {
  23720. "html_url": {
  23721. "type": "string",
  23722. "x-go-name": "HTMLURL"
  23723. },
  23724. "last_commit": {
  23725. "$ref": "#/definitions/WikiCommit"
  23726. },
  23727. "sub_url": {
  23728. "type": "string",
  23729. "x-go-name": "SubURL"
  23730. },
  23731. "title": {
  23732. "type": "string",
  23733. "x-go-name": "Title"
  23734. }
  23735. },
  23736. "x-go-package": "code.gitea.io/gitea/modules/structs"
  23737. }
  23738. },
  23739. "responses": {
  23740. "AccessToken": {
  23741. "description": "AccessToken represents an API access token.",
  23742. "schema": {
  23743. "$ref": "#/definitions/AccessToken"
  23744. }
  23745. },
  23746. "AccessTokenList": {
  23747. "description": "AccessTokenList represents a list of API access token.",
  23748. "schema": {
  23749. "type": "array",
  23750. "items": {
  23751. "$ref": "#/definitions/AccessToken"
  23752. }
  23753. }
  23754. },
  23755. "ActivityFeedsList": {
  23756. "description": "ActivityFeedsList",
  23757. "schema": {
  23758. "type": "array",
  23759. "items": {
  23760. "$ref": "#/definitions/Activity"
  23761. }
  23762. }
  23763. },
  23764. "ActivityPub": {
  23765. "description": "ActivityPub",
  23766. "schema": {
  23767. "$ref": "#/definitions/ActivityPub"
  23768. }
  23769. },
  23770. "AnnotatedTag": {
  23771. "description": "AnnotatedTag",
  23772. "schema": {
  23773. "$ref": "#/definitions/AnnotatedTag"
  23774. }
  23775. },
  23776. "Attachment": {
  23777. "description": "Attachment",
  23778. "schema": {
  23779. "$ref": "#/definitions/Attachment"
  23780. }
  23781. },
  23782. "AttachmentList": {
  23783. "description": "AttachmentList",
  23784. "schema": {
  23785. "type": "array",
  23786. "items": {
  23787. "$ref": "#/definitions/Attachment"
  23788. }
  23789. }
  23790. },
  23791. "BadgeList": {
  23792. "description": "BadgeList",
  23793. "schema": {
  23794. "type": "array",
  23795. "items": {
  23796. "$ref": "#/definitions/Badge"
  23797. }
  23798. }
  23799. },
  23800. "Branch": {
  23801. "description": "Branch",
  23802. "schema": {
  23803. "$ref": "#/definitions/Branch"
  23804. }
  23805. },
  23806. "BranchList": {
  23807. "description": "BranchList",
  23808. "schema": {
  23809. "type": "array",
  23810. "items": {
  23811. "$ref": "#/definitions/Branch"
  23812. }
  23813. }
  23814. },
  23815. "BranchProtection": {
  23816. "description": "BranchProtection",
  23817. "schema": {
  23818. "$ref": "#/definitions/BranchProtection"
  23819. }
  23820. },
  23821. "BranchProtectionList": {
  23822. "description": "BranchProtectionList",
  23823. "schema": {
  23824. "type": "array",
  23825. "items": {
  23826. "$ref": "#/definitions/BranchProtection"
  23827. }
  23828. }
  23829. },
  23830. "ChangedFileList": {
  23831. "description": "ChangedFileList",
  23832. "schema": {
  23833. "type": "array",
  23834. "items": {
  23835. "$ref": "#/definitions/ChangedFile"
  23836. }
  23837. },
  23838. "headers": {
  23839. "X-HasMore": {
  23840. "type": "boolean",
  23841. "description": "True if there is another page"
  23842. },
  23843. "X-Page": {
  23844. "type": "integer",
  23845. "format": "int64",
  23846. "description": "The current page"
  23847. },
  23848. "X-PageCount": {
  23849. "type": "integer",
  23850. "format": "int64",
  23851. "description": "Total number of pages"
  23852. },
  23853. "X-PerPage": {
  23854. "type": "integer",
  23855. "format": "int64",
  23856. "description": "Commits per page"
  23857. },
  23858. "X-Total": {
  23859. "type": "integer",
  23860. "format": "int64",
  23861. "description": "Total commit count"
  23862. }
  23863. }
  23864. },
  23865. "CombinedStatus": {
  23866. "description": "CombinedStatus",
  23867. "schema": {
  23868. "$ref": "#/definitions/CombinedStatus"
  23869. }
  23870. },
  23871. "Comment": {
  23872. "description": "Comment",
  23873. "schema": {
  23874. "$ref": "#/definitions/Comment"
  23875. }
  23876. },
  23877. "CommentList": {
  23878. "description": "CommentList",
  23879. "schema": {
  23880. "type": "array",
  23881. "items": {
  23882. "$ref": "#/definitions/Comment"
  23883. }
  23884. }
  23885. },
  23886. "Commit": {
  23887. "description": "Commit",
  23888. "schema": {
  23889. "$ref": "#/definitions/Commit"
  23890. }
  23891. },
  23892. "CommitList": {
  23893. "description": "CommitList",
  23894. "schema": {
  23895. "type": "array",
  23896. "items": {
  23897. "$ref": "#/definitions/Commit"
  23898. }
  23899. },
  23900. "headers": {
  23901. "X-HasMore": {
  23902. "type": "boolean",
  23903. "description": "True if there is another page"
  23904. },
  23905. "X-Page": {
  23906. "type": "integer",
  23907. "format": "int64",
  23908. "description": "The current page"
  23909. },
  23910. "X-PageCount": {
  23911. "type": "integer",
  23912. "format": "int64",
  23913. "description": "Total number of pages"
  23914. },
  23915. "X-PerPage": {
  23916. "type": "integer",
  23917. "format": "int64",
  23918. "description": "Commits per page"
  23919. },
  23920. "X-Total": {
  23921. "type": "integer",
  23922. "format": "int64",
  23923. "description": "Total commit count"
  23924. }
  23925. }
  23926. },
  23927. "CommitStatus": {
  23928. "description": "CommitStatus",
  23929. "schema": {
  23930. "$ref": "#/definitions/CommitStatus"
  23931. }
  23932. },
  23933. "CommitStatusList": {
  23934. "description": "CommitStatusList",
  23935. "schema": {
  23936. "type": "array",
  23937. "items": {
  23938. "$ref": "#/definitions/CommitStatus"
  23939. }
  23940. }
  23941. },
  23942. "ContentsListResponse": {
  23943. "description": "ContentsListResponse",
  23944. "schema": {
  23945. "type": "array",
  23946. "items": {
  23947. "$ref": "#/definitions/ContentsResponse"
  23948. }
  23949. }
  23950. },
  23951. "ContentsResponse": {
  23952. "description": "ContentsResponse",
  23953. "schema": {
  23954. "$ref": "#/definitions/ContentsResponse"
  23955. }
  23956. },
  23957. "CronList": {
  23958. "description": "CronList",
  23959. "schema": {
  23960. "type": "array",
  23961. "items": {
  23962. "$ref": "#/definitions/Cron"
  23963. }
  23964. }
  23965. },
  23966. "DeployKey": {
  23967. "description": "DeployKey",
  23968. "schema": {
  23969. "$ref": "#/definitions/DeployKey"
  23970. }
  23971. },
  23972. "DeployKeyList": {
  23973. "description": "DeployKeyList",
  23974. "schema": {
  23975. "type": "array",
  23976. "items": {
  23977. "$ref": "#/definitions/DeployKey"
  23978. }
  23979. }
  23980. },
  23981. "EmailList": {
  23982. "description": "EmailList",
  23983. "schema": {
  23984. "type": "array",
  23985. "items": {
  23986. "$ref": "#/definitions/Email"
  23987. }
  23988. }
  23989. },
  23990. "EmptyRepository": {
  23991. "description": "EmptyRepository",
  23992. "schema": {
  23993. "$ref": "#/definitions/APIError"
  23994. }
  23995. },
  23996. "FileDeleteResponse": {
  23997. "description": "FileDeleteResponse",
  23998. "schema": {
  23999. "$ref": "#/definitions/FileDeleteResponse"
  24000. }
  24001. },
  24002. "FileResponse": {
  24003. "description": "FileResponse",
  24004. "schema": {
  24005. "$ref": "#/definitions/FileResponse"
  24006. }
  24007. },
  24008. "FilesResponse": {
  24009. "description": "FilesResponse",
  24010. "schema": {
  24011. "$ref": "#/definitions/FilesResponse"
  24012. }
  24013. },
  24014. "GPGKey": {
  24015. "description": "GPGKey",
  24016. "schema": {
  24017. "$ref": "#/definitions/GPGKey"
  24018. }
  24019. },
  24020. "GPGKeyList": {
  24021. "description": "GPGKeyList",
  24022. "schema": {
  24023. "type": "array",
  24024. "items": {
  24025. "$ref": "#/definitions/GPGKey"
  24026. }
  24027. }
  24028. },
  24029. "GeneralAPISettings": {
  24030. "description": "GeneralAPISettings",
  24031. "schema": {
  24032. "$ref": "#/definitions/GeneralAPISettings"
  24033. }
  24034. },
  24035. "GeneralAttachmentSettings": {
  24036. "description": "GeneralAttachmentSettings",
  24037. "schema": {
  24038. "$ref": "#/definitions/GeneralAttachmentSettings"
  24039. }
  24040. },
  24041. "GeneralRepoSettings": {
  24042. "description": "GeneralRepoSettings",
  24043. "schema": {
  24044. "$ref": "#/definitions/GeneralRepoSettings"
  24045. }
  24046. },
  24047. "GeneralUISettings": {
  24048. "description": "GeneralUISettings",
  24049. "schema": {
  24050. "$ref": "#/definitions/GeneralUISettings"
  24051. }
  24052. },
  24053. "GitBlobResponse": {
  24054. "description": "GitBlobResponse",
  24055. "schema": {
  24056. "$ref": "#/definitions/GitBlobResponse"
  24057. }
  24058. },
  24059. "GitHook": {
  24060. "description": "GitHook",
  24061. "schema": {
  24062. "$ref": "#/definitions/GitHook"
  24063. }
  24064. },
  24065. "GitHookList": {
  24066. "description": "GitHookList",
  24067. "schema": {
  24068. "type": "array",
  24069. "items": {
  24070. "$ref": "#/definitions/GitHook"
  24071. }
  24072. }
  24073. },
  24074. "GitTreeResponse": {
  24075. "description": "GitTreeResponse",
  24076. "schema": {
  24077. "$ref": "#/definitions/GitTreeResponse"
  24078. }
  24079. },
  24080. "GitignoreTemplateInfo": {
  24081. "description": "GitignoreTemplateInfo",
  24082. "schema": {
  24083. "$ref": "#/definitions/GitignoreTemplateInfo"
  24084. }
  24085. },
  24086. "GitignoreTemplateList": {
  24087. "description": "GitignoreTemplateList",
  24088. "schema": {
  24089. "type": "array",
  24090. "items": {
  24091. "type": "string"
  24092. }
  24093. }
  24094. },
  24095. "Hook": {
  24096. "description": "Hook",
  24097. "schema": {
  24098. "$ref": "#/definitions/Hook"
  24099. }
  24100. },
  24101. "HookList": {
  24102. "description": "HookList",
  24103. "schema": {
  24104. "type": "array",
  24105. "items": {
  24106. "$ref": "#/definitions/Hook"
  24107. }
  24108. }
  24109. },
  24110. "Issue": {
  24111. "description": "Issue",
  24112. "schema": {
  24113. "$ref": "#/definitions/Issue"
  24114. }
  24115. },
  24116. "IssueDeadline": {
  24117. "description": "IssueDeadline",
  24118. "schema": {
  24119. "$ref": "#/definitions/IssueDeadline"
  24120. }
  24121. },
  24122. "IssueList": {
  24123. "description": "IssueList",
  24124. "schema": {
  24125. "type": "array",
  24126. "items": {
  24127. "$ref": "#/definitions/Issue"
  24128. }
  24129. }
  24130. },
  24131. "IssueTemplates": {
  24132. "description": "IssueTemplates",
  24133. "schema": {
  24134. "type": "array",
  24135. "items": {
  24136. "$ref": "#/definitions/IssueTemplate"
  24137. }
  24138. }
  24139. },
  24140. "Label": {
  24141. "description": "Label",
  24142. "schema": {
  24143. "$ref": "#/definitions/Label"
  24144. }
  24145. },
  24146. "LabelList": {
  24147. "description": "LabelList",
  24148. "schema": {
  24149. "type": "array",
  24150. "items": {
  24151. "$ref": "#/definitions/Label"
  24152. }
  24153. }
  24154. },
  24155. "LabelTemplateInfo": {
  24156. "description": "LabelTemplateInfo",
  24157. "schema": {
  24158. "type": "array",
  24159. "items": {
  24160. "$ref": "#/definitions/LabelTemplate"
  24161. }
  24162. }
  24163. },
  24164. "LabelTemplateList": {
  24165. "description": "LabelTemplateList",
  24166. "schema": {
  24167. "type": "array",
  24168. "items": {
  24169. "type": "string"
  24170. }
  24171. }
  24172. },
  24173. "LanguageStatistics": {
  24174. "description": "LanguageStatistics",
  24175. "schema": {
  24176. "type": "object",
  24177. "additionalProperties": {
  24178. "type": "integer",
  24179. "format": "int64"
  24180. }
  24181. }
  24182. },
  24183. "LicenseTemplateInfo": {
  24184. "description": "LicenseTemplateInfo",
  24185. "schema": {
  24186. "$ref": "#/definitions/LicenseTemplateInfo"
  24187. }
  24188. },
  24189. "LicenseTemplateList": {
  24190. "description": "LicenseTemplateList",
  24191. "schema": {
  24192. "type": "array",
  24193. "items": {
  24194. "$ref": "#/definitions/LicensesTemplateListEntry"
  24195. }
  24196. }
  24197. },
  24198. "MarkdownRender": {
  24199. "description": "MarkdownRender is a rendered markdown document",
  24200. "schema": {
  24201. "type": "string"
  24202. }
  24203. },
  24204. "MarkupRender": {
  24205. "description": "MarkupRender is a rendered markup document",
  24206. "schema": {
  24207. "type": "string"
  24208. }
  24209. },
  24210. "Milestone": {
  24211. "description": "Milestone",
  24212. "schema": {
  24213. "$ref": "#/definitions/Milestone"
  24214. }
  24215. },
  24216. "MilestoneList": {
  24217. "description": "MilestoneList",
  24218. "schema": {
  24219. "type": "array",
  24220. "items": {
  24221. "$ref": "#/definitions/Milestone"
  24222. }
  24223. }
  24224. },
  24225. "NodeInfo": {
  24226. "description": "NodeInfo",
  24227. "schema": {
  24228. "$ref": "#/definitions/NodeInfo"
  24229. }
  24230. },
  24231. "Note": {
  24232. "description": "Note",
  24233. "schema": {
  24234. "$ref": "#/definitions/Note"
  24235. }
  24236. },
  24237. "NotificationCount": {
  24238. "description": "Number of unread notifications",
  24239. "schema": {
  24240. "$ref": "#/definitions/NotificationCount"
  24241. }
  24242. },
  24243. "NotificationThread": {
  24244. "description": "NotificationThread",
  24245. "schema": {
  24246. "$ref": "#/definitions/NotificationThread"
  24247. }
  24248. },
  24249. "NotificationThreadList": {
  24250. "description": "NotificationThreadList",
  24251. "schema": {
  24252. "type": "array",
  24253. "items": {
  24254. "$ref": "#/definitions/NotificationThread"
  24255. }
  24256. }
  24257. },
  24258. "OAuth2Application": {
  24259. "description": "OAuth2Application",
  24260. "schema": {
  24261. "$ref": "#/definitions/OAuth2Application"
  24262. }
  24263. },
  24264. "OAuth2ApplicationList": {
  24265. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  24266. "schema": {
  24267. "type": "array",
  24268. "items": {
  24269. "$ref": "#/definitions/OAuth2Application"
  24270. }
  24271. }
  24272. },
  24273. "Organization": {
  24274. "description": "Organization",
  24275. "schema": {
  24276. "$ref": "#/definitions/Organization"
  24277. }
  24278. },
  24279. "OrganizationList": {
  24280. "description": "OrganizationList",
  24281. "schema": {
  24282. "type": "array",
  24283. "items": {
  24284. "$ref": "#/definitions/Organization"
  24285. }
  24286. }
  24287. },
  24288. "OrganizationPermissions": {
  24289. "description": "OrganizationPermissions",
  24290. "schema": {
  24291. "$ref": "#/definitions/OrganizationPermissions"
  24292. }
  24293. },
  24294. "Package": {
  24295. "description": "Package",
  24296. "schema": {
  24297. "$ref": "#/definitions/Package"
  24298. }
  24299. },
  24300. "PackageFileList": {
  24301. "description": "PackageFileList",
  24302. "schema": {
  24303. "type": "array",
  24304. "items": {
  24305. "$ref": "#/definitions/PackageFile"
  24306. }
  24307. }
  24308. },
  24309. "PackageList": {
  24310. "description": "PackageList",
  24311. "schema": {
  24312. "type": "array",
  24313. "items": {
  24314. "$ref": "#/definitions/Package"
  24315. }
  24316. }
  24317. },
  24318. "PublicKey": {
  24319. "description": "PublicKey",
  24320. "schema": {
  24321. "$ref": "#/definitions/PublicKey"
  24322. }
  24323. },
  24324. "PublicKeyList": {
  24325. "description": "PublicKeyList",
  24326. "schema": {
  24327. "type": "array",
  24328. "items": {
  24329. "$ref": "#/definitions/PublicKey"
  24330. }
  24331. }
  24332. },
  24333. "PullRequest": {
  24334. "description": "PullRequest",
  24335. "schema": {
  24336. "$ref": "#/definitions/PullRequest"
  24337. }
  24338. },
  24339. "PullRequestList": {
  24340. "description": "PullRequestList",
  24341. "schema": {
  24342. "type": "array",
  24343. "items": {
  24344. "$ref": "#/definitions/PullRequest"
  24345. }
  24346. }
  24347. },
  24348. "PullReview": {
  24349. "description": "PullReview",
  24350. "schema": {
  24351. "$ref": "#/definitions/PullReview"
  24352. }
  24353. },
  24354. "PullReviewComment": {
  24355. "description": "PullComment",
  24356. "schema": {
  24357. "$ref": "#/definitions/PullReviewComment"
  24358. }
  24359. },
  24360. "PullReviewCommentList": {
  24361. "description": "PullCommentList",
  24362. "schema": {
  24363. "type": "array",
  24364. "items": {
  24365. "$ref": "#/definitions/PullReviewComment"
  24366. }
  24367. }
  24368. },
  24369. "PullReviewList": {
  24370. "description": "PullReviewList",
  24371. "schema": {
  24372. "type": "array",
  24373. "items": {
  24374. "$ref": "#/definitions/PullReview"
  24375. }
  24376. }
  24377. },
  24378. "PushMirror": {
  24379. "description": "PushMirror",
  24380. "schema": {
  24381. "$ref": "#/definitions/PushMirror"
  24382. }
  24383. },
  24384. "PushMirrorList": {
  24385. "description": "PushMirrorList",
  24386. "schema": {
  24387. "type": "array",
  24388. "items": {
  24389. "$ref": "#/definitions/PushMirror"
  24390. }
  24391. }
  24392. },
  24393. "Reaction": {
  24394. "description": "Reaction",
  24395. "schema": {
  24396. "$ref": "#/definitions/Reaction"
  24397. }
  24398. },
  24399. "ReactionList": {
  24400. "description": "ReactionList",
  24401. "schema": {
  24402. "type": "array",
  24403. "items": {
  24404. "$ref": "#/definitions/Reaction"
  24405. }
  24406. }
  24407. },
  24408. "Reference": {
  24409. "description": "Reference",
  24410. "schema": {
  24411. "$ref": "#/definitions/Reference"
  24412. }
  24413. },
  24414. "ReferenceList": {
  24415. "description": "ReferenceList",
  24416. "schema": {
  24417. "type": "array",
  24418. "items": {
  24419. "$ref": "#/definitions/Reference"
  24420. }
  24421. }
  24422. },
  24423. "RegistrationToken": {
  24424. "description": "RegistrationToken is response related to registeration token",
  24425. "headers": {
  24426. "token": {
  24427. "type": "string"
  24428. }
  24429. }
  24430. },
  24431. "Release": {
  24432. "description": "Release",
  24433. "schema": {
  24434. "$ref": "#/definitions/Release"
  24435. }
  24436. },
  24437. "ReleaseList": {
  24438. "description": "ReleaseList",
  24439. "schema": {
  24440. "type": "array",
  24441. "items": {
  24442. "$ref": "#/definitions/Release"
  24443. }
  24444. }
  24445. },
  24446. "RepoCollaboratorPermission": {
  24447. "description": "RepoCollaboratorPermission",
  24448. "schema": {
  24449. "$ref": "#/definitions/RepoCollaboratorPermission"
  24450. }
  24451. },
  24452. "RepoIssueConfig": {
  24453. "description": "RepoIssueConfig",
  24454. "schema": {
  24455. "$ref": "#/definitions/IssueConfig"
  24456. }
  24457. },
  24458. "RepoIssueConfigValidation": {
  24459. "description": "RepoIssueConfigValidation",
  24460. "schema": {
  24461. "$ref": "#/definitions/IssueConfigValidation"
  24462. }
  24463. },
  24464. "RepoNewIssuePinsAllowed": {
  24465. "description": "RepoNewIssuePinsAllowed",
  24466. "schema": {
  24467. "$ref": "#/definitions/NewIssuePinsAllowed"
  24468. }
  24469. },
  24470. "Repository": {
  24471. "description": "Repository",
  24472. "schema": {
  24473. "$ref": "#/definitions/Repository"
  24474. }
  24475. },
  24476. "RepositoryList": {
  24477. "description": "RepositoryList",
  24478. "schema": {
  24479. "type": "array",
  24480. "items": {
  24481. "$ref": "#/definitions/Repository"
  24482. }
  24483. }
  24484. },
  24485. "SearchResults": {
  24486. "description": "SearchResults",
  24487. "schema": {
  24488. "$ref": "#/definitions/SearchResults"
  24489. }
  24490. },
  24491. "Secret": {
  24492. "description": "Secret",
  24493. "schema": {
  24494. "$ref": "#/definitions/Secret"
  24495. }
  24496. },
  24497. "SecretList": {
  24498. "description": "SecretList",
  24499. "schema": {
  24500. "type": "array",
  24501. "items": {
  24502. "$ref": "#/definitions/Secret"
  24503. }
  24504. }
  24505. },
  24506. "ServerVersion": {
  24507. "description": "ServerVersion",
  24508. "schema": {
  24509. "$ref": "#/definitions/ServerVersion"
  24510. }
  24511. },
  24512. "StopWatch": {
  24513. "description": "StopWatch",
  24514. "schema": {
  24515. "$ref": "#/definitions/StopWatch"
  24516. }
  24517. },
  24518. "StopWatchList": {
  24519. "description": "StopWatchList",
  24520. "schema": {
  24521. "type": "array",
  24522. "items": {
  24523. "$ref": "#/definitions/StopWatch"
  24524. }
  24525. }
  24526. },
  24527. "StringSlice": {
  24528. "description": "StringSlice",
  24529. "schema": {
  24530. "type": "array",
  24531. "items": {
  24532. "type": "string"
  24533. }
  24534. }
  24535. },
  24536. "Tag": {
  24537. "description": "Tag",
  24538. "schema": {
  24539. "$ref": "#/definitions/Tag"
  24540. }
  24541. },
  24542. "TagList": {
  24543. "description": "TagList",
  24544. "schema": {
  24545. "type": "array",
  24546. "items": {
  24547. "$ref": "#/definitions/Tag"
  24548. }
  24549. }
  24550. },
  24551. "Team": {
  24552. "description": "Team",
  24553. "schema": {
  24554. "$ref": "#/definitions/Team"
  24555. }
  24556. },
  24557. "TeamList": {
  24558. "description": "TeamList",
  24559. "schema": {
  24560. "type": "array",
  24561. "items": {
  24562. "$ref": "#/definitions/Team"
  24563. }
  24564. }
  24565. },
  24566. "TimelineList": {
  24567. "description": "TimelineList",
  24568. "schema": {
  24569. "type": "array",
  24570. "items": {
  24571. "$ref": "#/definitions/TimelineComment"
  24572. }
  24573. }
  24574. },
  24575. "TopicListResponse": {
  24576. "description": "TopicListResponse",
  24577. "schema": {
  24578. "type": "array",
  24579. "items": {
  24580. "$ref": "#/definitions/TopicResponse"
  24581. }
  24582. }
  24583. },
  24584. "TopicNames": {
  24585. "description": "TopicNames",
  24586. "schema": {
  24587. "$ref": "#/definitions/TopicName"
  24588. }
  24589. },
  24590. "TrackedTime": {
  24591. "description": "TrackedTime",
  24592. "schema": {
  24593. "$ref": "#/definitions/TrackedTime"
  24594. }
  24595. },
  24596. "TrackedTimeList": {
  24597. "description": "TrackedTimeList",
  24598. "schema": {
  24599. "type": "array",
  24600. "items": {
  24601. "$ref": "#/definitions/TrackedTime"
  24602. }
  24603. }
  24604. },
  24605. "User": {
  24606. "description": "User",
  24607. "schema": {
  24608. "$ref": "#/definitions/User"
  24609. }
  24610. },
  24611. "UserHeatmapData": {
  24612. "description": "UserHeatmapData",
  24613. "schema": {
  24614. "type": "array",
  24615. "items": {
  24616. "$ref": "#/definitions/UserHeatmapData"
  24617. }
  24618. }
  24619. },
  24620. "UserList": {
  24621. "description": "UserList",
  24622. "schema": {
  24623. "type": "array",
  24624. "items": {
  24625. "$ref": "#/definitions/User"
  24626. }
  24627. }
  24628. },
  24629. "UserSettings": {
  24630. "description": "UserSettings",
  24631. "schema": {
  24632. "type": "array",
  24633. "items": {
  24634. "$ref": "#/definitions/UserSettings"
  24635. }
  24636. }
  24637. },
  24638. "WatchInfo": {
  24639. "description": "WatchInfo",
  24640. "schema": {
  24641. "$ref": "#/definitions/WatchInfo"
  24642. }
  24643. },
  24644. "WikiCommitList": {
  24645. "description": "WikiCommitList",
  24646. "schema": {
  24647. "$ref": "#/definitions/WikiCommitList"
  24648. }
  24649. },
  24650. "WikiPage": {
  24651. "description": "WikiPage",
  24652. "schema": {
  24653. "$ref": "#/definitions/WikiPage"
  24654. }
  24655. },
  24656. "WikiPageList": {
  24657. "description": "WikiPageList",
  24658. "schema": {
  24659. "type": "array",
  24660. "items": {
  24661. "$ref": "#/definitions/WikiPageMetaData"
  24662. }
  24663. }
  24664. },
  24665. "conflict": {
  24666. "description": "APIConflict is a conflict empty response"
  24667. },
  24668. "empty": {
  24669. "description": "APIEmpty is an empty response"
  24670. },
  24671. "error": {
  24672. "description": "APIError is error format response",
  24673. "headers": {
  24674. "message": {
  24675. "type": "string"
  24676. },
  24677. "url": {
  24678. "type": "string"
  24679. }
  24680. }
  24681. },
  24682. "forbidden": {
  24683. "description": "APIForbiddenError is a forbidden error response",
  24684. "headers": {
  24685. "message": {
  24686. "type": "string"
  24687. },
  24688. "url": {
  24689. "type": "string"
  24690. }
  24691. }
  24692. },
  24693. "invalidTopicsError": {
  24694. "description": "APIInvalidTopicsError is error format response to invalid topics",
  24695. "headers": {
  24696. "invalidTopics": {
  24697. "type": "array",
  24698. "items": {
  24699. "type": "string"
  24700. }
  24701. },
  24702. "message": {
  24703. "type": "string"
  24704. }
  24705. }
  24706. },
  24707. "notFound": {
  24708. "description": "APINotFound is a not found empty response"
  24709. },
  24710. "parameterBodies": {
  24711. "description": "parameterBodies",
  24712. "schema": {
  24713. "$ref": "#/definitions/UserBadgeOption"
  24714. }
  24715. },
  24716. "redirect": {
  24717. "description": "APIRedirect is a redirect response"
  24718. },
  24719. "repoArchivedError": {
  24720. "description": "APIRepoArchivedError is an error that is raised when an archived repo should be modified",
  24721. "headers": {
  24722. "message": {
  24723. "type": "string"
  24724. },
  24725. "url": {
  24726. "type": "string"
  24727. }
  24728. }
  24729. },
  24730. "string": {
  24731. "description": "APIString is a string response",
  24732. "schema": {
  24733. "type": "string"
  24734. }
  24735. },
  24736. "validationError": {
  24737. "description": "APIValidationError is error format response related to input validation",
  24738. "headers": {
  24739. "message": {
  24740. "type": "string"
  24741. },
  24742. "url": {
  24743. "type": "string"
  24744. }
  24745. }
  24746. }
  24747. },
  24748. "securityDefinitions": {
  24749. "AccessToken": {
  24750. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  24751. "type": "apiKey",
  24752. "name": "access_token",
  24753. "in": "query"
  24754. },
  24755. "AuthorizationHeaderToken": {
  24756. "description": "API tokens must be prepended with \"token\" followed by a space.",
  24757. "type": "apiKey",
  24758. "name": "Authorization",
  24759. "in": "header"
  24760. },
  24761. "BasicAuth": {
  24762. "type": "basic"
  24763. },
  24764. "SudoHeader": {
  24765. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  24766. "type": "apiKey",
  24767. "name": "Sudo",
  24768. "in": "header"
  24769. },
  24770. "SudoParam": {
  24771. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  24772. "type": "apiKey",
  24773. "name": "sudo",
  24774. "in": "query"
  24775. },
  24776. "TOTPHeader": {
  24777. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  24778. "type": "apiKey",
  24779. "name": "X-GITEA-OTP",
  24780. "in": "header"
  24781. },
  24782. "Token": {
  24783. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  24784. "type": "apiKey",
  24785. "name": "token",
  24786. "in": "query"
  24787. }
  24788. },
  24789. "security": [
  24790. {
  24791. "BasicAuth": []
  24792. },
  24793. {
  24794. "Token": []
  24795. },
  24796. {
  24797. "AccessToken": []
  24798. },
  24799. {
  24800. "AuthorizationHeaderToken": []
  24801. },
  24802. {
  24803. "SudoParam": []
  24804. },
  24805. {
  24806. "SudoHeader": []
  24807. },
  24808. {
  24809. "TOTPHeader": []
  24810. }
  24811. ]
  24812. }