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

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "{{AppVer | JSEscape | Safe}}"
  23. },
  24. "basePath": "{{AppSubUrl | JSEscape | Safe}}/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/unadopted": {
  396. "get": {
  397. "produces": [
  398. "application/json"
  399. ],
  400. "tags": [
  401. "admin"
  402. ],
  403. "summary": "List unadopted repositories",
  404. "operationId": "adminUnadoptedList",
  405. "parameters": [
  406. {
  407. "type": "integer",
  408. "description": "page number of results to return (1-based)",
  409. "name": "page",
  410. "in": "query"
  411. },
  412. {
  413. "type": "integer",
  414. "description": "page size of results",
  415. "name": "limit",
  416. "in": "query"
  417. },
  418. {
  419. "type": "string",
  420. "description": "pattern of repositories to search for",
  421. "name": "pattern",
  422. "in": "query"
  423. }
  424. ],
  425. "responses": {
  426. "200": {
  427. "$ref": "#/responses/StringSlice"
  428. },
  429. "403": {
  430. "$ref": "#/responses/forbidden"
  431. }
  432. }
  433. }
  434. },
  435. "/admin/unadopted/{owner}/{repo}": {
  436. "post": {
  437. "produces": [
  438. "application/json"
  439. ],
  440. "tags": [
  441. "admin"
  442. ],
  443. "summary": "Adopt unadopted files as a repository",
  444. "operationId": "adminAdoptRepository",
  445. "parameters": [
  446. {
  447. "type": "string",
  448. "description": "owner of the repo",
  449. "name": "owner",
  450. "in": "path",
  451. "required": true
  452. },
  453. {
  454. "type": "string",
  455. "description": "name of the repo",
  456. "name": "repo",
  457. "in": "path",
  458. "required": true
  459. }
  460. ],
  461. "responses": {
  462. "204": {
  463. "$ref": "#/responses/empty"
  464. },
  465. "403": {
  466. "$ref": "#/responses/forbidden"
  467. },
  468. "404": {
  469. "$ref": "#/responses/notFound"
  470. }
  471. }
  472. },
  473. "delete": {
  474. "produces": [
  475. "application/json"
  476. ],
  477. "tags": [
  478. "admin"
  479. ],
  480. "summary": "Delete unadopted files",
  481. "operationId": "adminDeleteUnadoptedRepository",
  482. "parameters": [
  483. {
  484. "type": "string",
  485. "description": "owner of the repo",
  486. "name": "owner",
  487. "in": "path",
  488. "required": true
  489. },
  490. {
  491. "type": "string",
  492. "description": "name of the repo",
  493. "name": "repo",
  494. "in": "path",
  495. "required": true
  496. }
  497. ],
  498. "responses": {
  499. "204": {
  500. "$ref": "#/responses/empty"
  501. },
  502. "403": {
  503. "$ref": "#/responses/forbidden"
  504. }
  505. }
  506. }
  507. },
  508. "/admin/users": {
  509. "get": {
  510. "produces": [
  511. "application/json"
  512. ],
  513. "tags": [
  514. "admin"
  515. ],
  516. "summary": "Search users according filter conditions",
  517. "operationId": "adminSearchUsers",
  518. "parameters": [
  519. {
  520. "type": "integer",
  521. "format": "int64",
  522. "description": "ID of the user's login source to search for",
  523. "name": "source_id",
  524. "in": "query"
  525. },
  526. {
  527. "type": "string",
  528. "description": "user's login name to search for",
  529. "name": "login_name",
  530. "in": "query"
  531. },
  532. {
  533. "type": "integer",
  534. "description": "page number of results to return (1-based)",
  535. "name": "page",
  536. "in": "query"
  537. },
  538. {
  539. "type": "integer",
  540. "description": "page size of results",
  541. "name": "limit",
  542. "in": "query"
  543. }
  544. ],
  545. "responses": {
  546. "200": {
  547. "$ref": "#/responses/UserList"
  548. },
  549. "403": {
  550. "$ref": "#/responses/forbidden"
  551. }
  552. }
  553. },
  554. "post": {
  555. "consumes": [
  556. "application/json"
  557. ],
  558. "produces": [
  559. "application/json"
  560. ],
  561. "tags": [
  562. "admin"
  563. ],
  564. "summary": "Create a user",
  565. "operationId": "adminCreateUser",
  566. "parameters": [
  567. {
  568. "name": "body",
  569. "in": "body",
  570. "schema": {
  571. "$ref": "#/definitions/CreateUserOption"
  572. }
  573. }
  574. ],
  575. "responses": {
  576. "201": {
  577. "$ref": "#/responses/User"
  578. },
  579. "400": {
  580. "$ref": "#/responses/error"
  581. },
  582. "403": {
  583. "$ref": "#/responses/forbidden"
  584. },
  585. "422": {
  586. "$ref": "#/responses/validationError"
  587. }
  588. }
  589. }
  590. },
  591. "/admin/users/{username}": {
  592. "delete": {
  593. "produces": [
  594. "application/json"
  595. ],
  596. "tags": [
  597. "admin"
  598. ],
  599. "summary": "Delete a user",
  600. "operationId": "adminDeleteUser",
  601. "parameters": [
  602. {
  603. "type": "string",
  604. "description": "username of user to delete",
  605. "name": "username",
  606. "in": "path",
  607. "required": true
  608. },
  609. {
  610. "type": "boolean",
  611. "description": "purge the user from the system completely",
  612. "name": "purge",
  613. "in": "query"
  614. }
  615. ],
  616. "responses": {
  617. "204": {
  618. "$ref": "#/responses/empty"
  619. },
  620. "403": {
  621. "$ref": "#/responses/forbidden"
  622. },
  623. "404": {
  624. "$ref": "#/responses/notFound"
  625. },
  626. "422": {
  627. "$ref": "#/responses/validationError"
  628. }
  629. }
  630. },
  631. "patch": {
  632. "consumes": [
  633. "application/json"
  634. ],
  635. "produces": [
  636. "application/json"
  637. ],
  638. "tags": [
  639. "admin"
  640. ],
  641. "summary": "Edit an existing user",
  642. "operationId": "adminEditUser",
  643. "parameters": [
  644. {
  645. "type": "string",
  646. "description": "username of user to edit",
  647. "name": "username",
  648. "in": "path",
  649. "required": true
  650. },
  651. {
  652. "name": "body",
  653. "in": "body",
  654. "schema": {
  655. "$ref": "#/definitions/EditUserOption"
  656. }
  657. }
  658. ],
  659. "responses": {
  660. "200": {
  661. "$ref": "#/responses/User"
  662. },
  663. "403": {
  664. "$ref": "#/responses/forbidden"
  665. },
  666. "422": {
  667. "$ref": "#/responses/validationError"
  668. }
  669. }
  670. }
  671. },
  672. "/admin/users/{username}/keys": {
  673. "post": {
  674. "consumes": [
  675. "application/json"
  676. ],
  677. "produces": [
  678. "application/json"
  679. ],
  680. "tags": [
  681. "admin"
  682. ],
  683. "summary": "Add a public key on behalf of a user",
  684. "operationId": "adminCreatePublicKey",
  685. "parameters": [
  686. {
  687. "type": "string",
  688. "description": "username of the user",
  689. "name": "username",
  690. "in": "path",
  691. "required": true
  692. },
  693. {
  694. "name": "key",
  695. "in": "body",
  696. "schema": {
  697. "$ref": "#/definitions/CreateKeyOption"
  698. }
  699. }
  700. ],
  701. "responses": {
  702. "201": {
  703. "$ref": "#/responses/PublicKey"
  704. },
  705. "403": {
  706. "$ref": "#/responses/forbidden"
  707. },
  708. "422": {
  709. "$ref": "#/responses/validationError"
  710. }
  711. }
  712. }
  713. },
  714. "/admin/users/{username}/keys/{id}": {
  715. "delete": {
  716. "produces": [
  717. "application/json"
  718. ],
  719. "tags": [
  720. "admin"
  721. ],
  722. "summary": "Delete a user's public key",
  723. "operationId": "adminDeleteUserPublicKey",
  724. "parameters": [
  725. {
  726. "type": "string",
  727. "description": "username of user",
  728. "name": "username",
  729. "in": "path",
  730. "required": true
  731. },
  732. {
  733. "type": "integer",
  734. "format": "int64",
  735. "description": "id of the key to delete",
  736. "name": "id",
  737. "in": "path",
  738. "required": true
  739. }
  740. ],
  741. "responses": {
  742. "204": {
  743. "$ref": "#/responses/empty"
  744. },
  745. "403": {
  746. "$ref": "#/responses/forbidden"
  747. },
  748. "404": {
  749. "$ref": "#/responses/notFound"
  750. }
  751. }
  752. }
  753. },
  754. "/admin/users/{username}/orgs": {
  755. "post": {
  756. "consumes": [
  757. "application/json"
  758. ],
  759. "produces": [
  760. "application/json"
  761. ],
  762. "tags": [
  763. "admin"
  764. ],
  765. "summary": "Create an organization",
  766. "operationId": "adminCreateOrg",
  767. "parameters": [
  768. {
  769. "type": "string",
  770. "description": "username of the user that will own the created organization",
  771. "name": "username",
  772. "in": "path",
  773. "required": true
  774. },
  775. {
  776. "name": "organization",
  777. "in": "body",
  778. "required": true,
  779. "schema": {
  780. "$ref": "#/definitions/CreateOrgOption"
  781. }
  782. }
  783. ],
  784. "responses": {
  785. "201": {
  786. "$ref": "#/responses/Organization"
  787. },
  788. "403": {
  789. "$ref": "#/responses/forbidden"
  790. },
  791. "422": {
  792. "$ref": "#/responses/validationError"
  793. }
  794. }
  795. }
  796. },
  797. "/admin/users/{username}/rename": {
  798. "post": {
  799. "produces": [
  800. "application/json"
  801. ],
  802. "tags": [
  803. "admin"
  804. ],
  805. "summary": "Rename a user",
  806. "operationId": "adminRenameUser",
  807. "parameters": [
  808. {
  809. "type": "string",
  810. "description": "existing username of user",
  811. "name": "username",
  812. "in": "path",
  813. "required": true
  814. },
  815. {
  816. "name": "body",
  817. "in": "body",
  818. "required": true,
  819. "schema": {
  820. "$ref": "#/definitions/RenameUserOption"
  821. }
  822. }
  823. ],
  824. "responses": {
  825. "204": {
  826. "$ref": "#/responses/empty"
  827. },
  828. "403": {
  829. "$ref": "#/responses/forbidden"
  830. },
  831. "422": {
  832. "$ref": "#/responses/validationError"
  833. }
  834. }
  835. }
  836. },
  837. "/admin/users/{username}/repos": {
  838. "post": {
  839. "consumes": [
  840. "application/json"
  841. ],
  842. "produces": [
  843. "application/json"
  844. ],
  845. "tags": [
  846. "admin"
  847. ],
  848. "summary": "Create a repository on behalf of a user",
  849. "operationId": "adminCreateRepo",
  850. "parameters": [
  851. {
  852. "type": "string",
  853. "description": "username of the user. This user will own the created repository",
  854. "name": "username",
  855. "in": "path",
  856. "required": true
  857. },
  858. {
  859. "name": "repository",
  860. "in": "body",
  861. "required": true,
  862. "schema": {
  863. "$ref": "#/definitions/CreateRepoOption"
  864. }
  865. }
  866. ],
  867. "responses": {
  868. "201": {
  869. "$ref": "#/responses/Repository"
  870. },
  871. "400": {
  872. "$ref": "#/responses/error"
  873. },
  874. "403": {
  875. "$ref": "#/responses/forbidden"
  876. },
  877. "404": {
  878. "$ref": "#/responses/notFound"
  879. },
  880. "409": {
  881. "$ref": "#/responses/error"
  882. },
  883. "422": {
  884. "$ref": "#/responses/validationError"
  885. }
  886. }
  887. }
  888. },
  889. "/gitignore/templates": {
  890. "get": {
  891. "produces": [
  892. "application/json"
  893. ],
  894. "tags": [
  895. "miscellaneous"
  896. ],
  897. "summary": "Returns a list of all gitignore templates",
  898. "operationId": "listGitignoresTemplates",
  899. "responses": {
  900. "200": {
  901. "$ref": "#/responses/GitignoreTemplateList"
  902. }
  903. }
  904. }
  905. },
  906. "/gitignore/templates/{name}": {
  907. "get": {
  908. "produces": [
  909. "application/json"
  910. ],
  911. "tags": [
  912. "miscellaneous"
  913. ],
  914. "summary": "Returns information about a gitignore template",
  915. "operationId": "getGitignoreTemplateInfo",
  916. "parameters": [
  917. {
  918. "type": "string",
  919. "description": "name of the template",
  920. "name": "name",
  921. "in": "path",
  922. "required": true
  923. }
  924. ],
  925. "responses": {
  926. "200": {
  927. "$ref": "#/responses/GitignoreTemplateInfo"
  928. },
  929. "404": {
  930. "$ref": "#/responses/notFound"
  931. }
  932. }
  933. }
  934. },
  935. "/label/templates": {
  936. "get": {
  937. "produces": [
  938. "application/json"
  939. ],
  940. "tags": [
  941. "miscellaneous"
  942. ],
  943. "summary": "Returns a list of all label templates",
  944. "operationId": "listLabelTemplates",
  945. "responses": {
  946. "200": {
  947. "$ref": "#/responses/LabelTemplateList"
  948. }
  949. }
  950. }
  951. },
  952. "/label/templates/{name}": {
  953. "get": {
  954. "produces": [
  955. "application/json"
  956. ],
  957. "tags": [
  958. "miscellaneous"
  959. ],
  960. "summary": "Returns all labels in a template",
  961. "operationId": "getLabelTemplateInfo",
  962. "parameters": [
  963. {
  964. "type": "string",
  965. "description": "name of the template",
  966. "name": "name",
  967. "in": "path",
  968. "required": true
  969. }
  970. ],
  971. "responses": {
  972. "200": {
  973. "$ref": "#/responses/LabelTemplateInfo"
  974. },
  975. "404": {
  976. "$ref": "#/responses/notFound"
  977. }
  978. }
  979. }
  980. },
  981. "/licenses": {
  982. "get": {
  983. "produces": [
  984. "application/json"
  985. ],
  986. "tags": [
  987. "miscellaneous"
  988. ],
  989. "summary": "Returns a list of all license templates",
  990. "operationId": "listLicenseTemplates",
  991. "responses": {
  992. "200": {
  993. "$ref": "#/responses/LicenseTemplateList"
  994. }
  995. }
  996. }
  997. },
  998. "/licenses/{name}": {
  999. "get": {
  1000. "produces": [
  1001. "application/json"
  1002. ],
  1003. "tags": [
  1004. "miscellaneous"
  1005. ],
  1006. "summary": "Returns information about a license template",
  1007. "operationId": "getLicenseTemplateInfo",
  1008. "parameters": [
  1009. {
  1010. "type": "string",
  1011. "description": "name of the license",
  1012. "name": "name",
  1013. "in": "path",
  1014. "required": true
  1015. }
  1016. ],
  1017. "responses": {
  1018. "200": {
  1019. "$ref": "#/responses/LicenseTemplateInfo"
  1020. },
  1021. "404": {
  1022. "$ref": "#/responses/notFound"
  1023. }
  1024. }
  1025. }
  1026. },
  1027. "/markdown": {
  1028. "post": {
  1029. "consumes": [
  1030. "application/json"
  1031. ],
  1032. "produces": [
  1033. "text/html"
  1034. ],
  1035. "tags": [
  1036. "miscellaneous"
  1037. ],
  1038. "summary": "Render a markdown document as HTML",
  1039. "operationId": "renderMarkdown",
  1040. "parameters": [
  1041. {
  1042. "name": "body",
  1043. "in": "body",
  1044. "schema": {
  1045. "$ref": "#/definitions/MarkdownOption"
  1046. }
  1047. }
  1048. ],
  1049. "responses": {
  1050. "200": {
  1051. "$ref": "#/responses/MarkdownRender"
  1052. },
  1053. "422": {
  1054. "$ref": "#/responses/validationError"
  1055. }
  1056. }
  1057. }
  1058. },
  1059. "/markdown/raw": {
  1060. "post": {
  1061. "consumes": [
  1062. "text/plain"
  1063. ],
  1064. "produces": [
  1065. "text/html"
  1066. ],
  1067. "tags": [
  1068. "miscellaneous"
  1069. ],
  1070. "summary": "Render raw markdown as HTML",
  1071. "operationId": "renderMarkdownRaw",
  1072. "parameters": [
  1073. {
  1074. "description": "Request body to render",
  1075. "name": "body",
  1076. "in": "body",
  1077. "required": true,
  1078. "schema": {
  1079. "type": "string"
  1080. }
  1081. }
  1082. ],
  1083. "responses": {
  1084. "200": {
  1085. "$ref": "#/responses/MarkdownRender"
  1086. },
  1087. "422": {
  1088. "$ref": "#/responses/validationError"
  1089. }
  1090. }
  1091. }
  1092. },
  1093. "/markup": {
  1094. "post": {
  1095. "consumes": [
  1096. "application/json"
  1097. ],
  1098. "produces": [
  1099. "text/html"
  1100. ],
  1101. "tags": [
  1102. "miscellaneous"
  1103. ],
  1104. "summary": "Render a markup document as HTML",
  1105. "operationId": "renderMarkup",
  1106. "parameters": [
  1107. {
  1108. "name": "body",
  1109. "in": "body",
  1110. "schema": {
  1111. "$ref": "#/definitions/MarkupOption"
  1112. }
  1113. }
  1114. ],
  1115. "responses": {
  1116. "200": {
  1117. "$ref": "#/responses/MarkupRender"
  1118. },
  1119. "422": {
  1120. "$ref": "#/responses/validationError"
  1121. }
  1122. }
  1123. }
  1124. },
  1125. "/nodeinfo": {
  1126. "get": {
  1127. "produces": [
  1128. "application/json"
  1129. ],
  1130. "tags": [
  1131. "miscellaneous"
  1132. ],
  1133. "summary": "Returns the nodeinfo of the Gitea application",
  1134. "operationId": "getNodeInfo",
  1135. "responses": {
  1136. "200": {
  1137. "$ref": "#/responses/NodeInfo"
  1138. }
  1139. }
  1140. }
  1141. },
  1142. "/notifications": {
  1143. "get": {
  1144. "consumes": [
  1145. "application/json"
  1146. ],
  1147. "produces": [
  1148. "application/json"
  1149. ],
  1150. "tags": [
  1151. "notification"
  1152. ],
  1153. "summary": "List users's notification threads",
  1154. "operationId": "notifyGetList",
  1155. "parameters": [
  1156. {
  1157. "type": "boolean",
  1158. "description": "If true, show notifications marked as read. Default value is false",
  1159. "name": "all",
  1160. "in": "query"
  1161. },
  1162. {
  1163. "type": "array",
  1164. "items": {
  1165. "type": "string"
  1166. },
  1167. "collectionFormat": "multi",
  1168. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
  1169. "name": "status-types",
  1170. "in": "query"
  1171. },
  1172. {
  1173. "type": "array",
  1174. "items": {
  1175. "enum": [
  1176. "issue",
  1177. "pull",
  1178. "commit",
  1179. "repository"
  1180. ],
  1181. "type": "string"
  1182. },
  1183. "collectionFormat": "multi",
  1184. "description": "filter notifications by subject type",
  1185. "name": "subject-type",
  1186. "in": "query"
  1187. },
  1188. {
  1189. "type": "string",
  1190. "format": "date-time",
  1191. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  1192. "name": "since",
  1193. "in": "query"
  1194. },
  1195. {
  1196. "type": "string",
  1197. "format": "date-time",
  1198. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  1199. "name": "before",
  1200. "in": "query"
  1201. },
  1202. {
  1203. "type": "integer",
  1204. "description": "page number of results to return (1-based)",
  1205. "name": "page",
  1206. "in": "query"
  1207. },
  1208. {
  1209. "type": "integer",
  1210. "description": "page size of results",
  1211. "name": "limit",
  1212. "in": "query"
  1213. }
  1214. ],
  1215. "responses": {
  1216. "200": {
  1217. "$ref": "#/responses/NotificationThreadList"
  1218. }
  1219. }
  1220. },
  1221. "put": {
  1222. "consumes": [
  1223. "application/json"
  1224. ],
  1225. "produces": [
  1226. "application/json"
  1227. ],
  1228. "tags": [
  1229. "notification"
  1230. ],
  1231. "summary": "Mark notification threads as read, pinned or unread",
  1232. "operationId": "notifyReadList",
  1233. "parameters": [
  1234. {
  1235. "type": "string",
  1236. "format": "date-time",
  1237. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  1238. "name": "last_read_at",
  1239. "in": "query"
  1240. },
  1241. {
  1242. "type": "string",
  1243. "description": "If true, mark all notifications on this repo. Default value is false",
  1244. "name": "all",
  1245. "in": "query"
  1246. },
  1247. {
  1248. "type": "array",
  1249. "items": {
  1250. "type": "string"
  1251. },
  1252. "collectionFormat": "multi",
  1253. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  1254. "name": "status-types",
  1255. "in": "query"
  1256. },
  1257. {
  1258. "type": "string",
  1259. "description": "Status to mark notifications as, Defaults to read.",
  1260. "name": "to-status",
  1261. "in": "query"
  1262. }
  1263. ],
  1264. "responses": {
  1265. "205": {
  1266. "$ref": "#/responses/NotificationThreadList"
  1267. }
  1268. }
  1269. }
  1270. },
  1271. "/notifications/new": {
  1272. "get": {
  1273. "tags": [
  1274. "notification"
  1275. ],
  1276. "summary": "Check if unread notifications exist",
  1277. "operationId": "notifyNewAvailable",
  1278. "responses": {
  1279. "200": {
  1280. "$ref": "#/responses/NotificationCount"
  1281. }
  1282. }
  1283. }
  1284. },
  1285. "/notifications/threads/{id}": {
  1286. "get": {
  1287. "consumes": [
  1288. "application/json"
  1289. ],
  1290. "produces": [
  1291. "application/json"
  1292. ],
  1293. "tags": [
  1294. "notification"
  1295. ],
  1296. "summary": "Get notification thread by ID",
  1297. "operationId": "notifyGetThread",
  1298. "parameters": [
  1299. {
  1300. "type": "string",
  1301. "description": "id of notification thread",
  1302. "name": "id",
  1303. "in": "path",
  1304. "required": true
  1305. }
  1306. ],
  1307. "responses": {
  1308. "200": {
  1309. "$ref": "#/responses/NotificationThread"
  1310. },
  1311. "403": {
  1312. "$ref": "#/responses/forbidden"
  1313. },
  1314. "404": {
  1315. "$ref": "#/responses/notFound"
  1316. }
  1317. }
  1318. },
  1319. "patch": {
  1320. "consumes": [
  1321. "application/json"
  1322. ],
  1323. "produces": [
  1324. "application/json"
  1325. ],
  1326. "tags": [
  1327. "notification"
  1328. ],
  1329. "summary": "Mark notification thread as read by ID",
  1330. "operationId": "notifyReadThread",
  1331. "parameters": [
  1332. {
  1333. "type": "string",
  1334. "description": "id of notification thread",
  1335. "name": "id",
  1336. "in": "path",
  1337. "required": true
  1338. },
  1339. {
  1340. "type": "string",
  1341. "default": "read",
  1342. "description": "Status to mark notifications as",
  1343. "name": "to-status",
  1344. "in": "query"
  1345. }
  1346. ],
  1347. "responses": {
  1348. "205": {
  1349. "$ref": "#/responses/NotificationThread"
  1350. },
  1351. "403": {
  1352. "$ref": "#/responses/forbidden"
  1353. },
  1354. "404": {
  1355. "$ref": "#/responses/notFound"
  1356. }
  1357. }
  1358. }
  1359. },
  1360. "/org/{org}/repos": {
  1361. "post": {
  1362. "consumes": [
  1363. "application/json"
  1364. ],
  1365. "produces": [
  1366. "application/json"
  1367. ],
  1368. "tags": [
  1369. "organization"
  1370. ],
  1371. "summary": "Create a repository in an organization",
  1372. "operationId": "createOrgRepoDeprecated",
  1373. "deprecated": true,
  1374. "parameters": [
  1375. {
  1376. "type": "string",
  1377. "description": "name of organization",
  1378. "name": "org",
  1379. "in": "path",
  1380. "required": true
  1381. },
  1382. {
  1383. "name": "body",
  1384. "in": "body",
  1385. "schema": {
  1386. "$ref": "#/definitions/CreateRepoOption"
  1387. }
  1388. }
  1389. ],
  1390. "responses": {
  1391. "201": {
  1392. "$ref": "#/responses/Repository"
  1393. },
  1394. "403": {
  1395. "$ref": "#/responses/forbidden"
  1396. },
  1397. "404": {
  1398. "$ref": "#/responses/notFound"
  1399. },
  1400. "422": {
  1401. "$ref": "#/responses/validationError"
  1402. }
  1403. }
  1404. }
  1405. },
  1406. "/orgs": {
  1407. "get": {
  1408. "produces": [
  1409. "application/json"
  1410. ],
  1411. "tags": [
  1412. "organization"
  1413. ],
  1414. "summary": "Get list of organizations",
  1415. "operationId": "orgGetAll",
  1416. "parameters": [
  1417. {
  1418. "type": "integer",
  1419. "description": "page number of results to return (1-based)",
  1420. "name": "page",
  1421. "in": "query"
  1422. },
  1423. {
  1424. "type": "integer",
  1425. "description": "page size of results",
  1426. "name": "limit",
  1427. "in": "query"
  1428. }
  1429. ],
  1430. "responses": {
  1431. "200": {
  1432. "$ref": "#/responses/OrganizationList"
  1433. }
  1434. }
  1435. },
  1436. "post": {
  1437. "consumes": [
  1438. "application/json"
  1439. ],
  1440. "produces": [
  1441. "application/json"
  1442. ],
  1443. "tags": [
  1444. "organization"
  1445. ],
  1446. "summary": "Create an organization",
  1447. "operationId": "orgCreate",
  1448. "parameters": [
  1449. {
  1450. "name": "organization",
  1451. "in": "body",
  1452. "required": true,
  1453. "schema": {
  1454. "$ref": "#/definitions/CreateOrgOption"
  1455. }
  1456. }
  1457. ],
  1458. "responses": {
  1459. "201": {
  1460. "$ref": "#/responses/Organization"
  1461. },
  1462. "403": {
  1463. "$ref": "#/responses/forbidden"
  1464. },
  1465. "422": {
  1466. "$ref": "#/responses/validationError"
  1467. }
  1468. }
  1469. }
  1470. },
  1471. "/orgs/{org}": {
  1472. "get": {
  1473. "produces": [
  1474. "application/json"
  1475. ],
  1476. "tags": [
  1477. "organization"
  1478. ],
  1479. "summary": "Get an organization",
  1480. "operationId": "orgGet",
  1481. "parameters": [
  1482. {
  1483. "type": "string",
  1484. "description": "name of the organization to get",
  1485. "name": "org",
  1486. "in": "path",
  1487. "required": true
  1488. }
  1489. ],
  1490. "responses": {
  1491. "200": {
  1492. "$ref": "#/responses/Organization"
  1493. },
  1494. "404": {
  1495. "$ref": "#/responses/notFound"
  1496. }
  1497. }
  1498. },
  1499. "delete": {
  1500. "produces": [
  1501. "application/json"
  1502. ],
  1503. "tags": [
  1504. "organization"
  1505. ],
  1506. "summary": "Delete an organization",
  1507. "operationId": "orgDelete",
  1508. "parameters": [
  1509. {
  1510. "type": "string",
  1511. "description": "organization that is to be deleted",
  1512. "name": "org",
  1513. "in": "path",
  1514. "required": true
  1515. }
  1516. ],
  1517. "responses": {
  1518. "204": {
  1519. "$ref": "#/responses/empty"
  1520. },
  1521. "404": {
  1522. "$ref": "#/responses/notFound"
  1523. }
  1524. }
  1525. },
  1526. "patch": {
  1527. "consumes": [
  1528. "application/json"
  1529. ],
  1530. "produces": [
  1531. "application/json"
  1532. ],
  1533. "tags": [
  1534. "organization"
  1535. ],
  1536. "summary": "Edit an organization",
  1537. "operationId": "orgEdit",
  1538. "parameters": [
  1539. {
  1540. "type": "string",
  1541. "description": "name of the organization to edit",
  1542. "name": "org",
  1543. "in": "path",
  1544. "required": true
  1545. },
  1546. {
  1547. "name": "body",
  1548. "in": "body",
  1549. "required": true,
  1550. "schema": {
  1551. "$ref": "#/definitions/EditOrgOption"
  1552. }
  1553. }
  1554. ],
  1555. "responses": {
  1556. "200": {
  1557. "$ref": "#/responses/Organization"
  1558. },
  1559. "404": {
  1560. "$ref": "#/responses/notFound"
  1561. }
  1562. }
  1563. }
  1564. },
  1565. "/orgs/{org}/actions/secrets": {
  1566. "get": {
  1567. "produces": [
  1568. "application/json"
  1569. ],
  1570. "tags": [
  1571. "organization"
  1572. ],
  1573. "summary": "List an organization's actions secrets",
  1574. "operationId": "orgListActionsSecrets",
  1575. "parameters": [
  1576. {
  1577. "type": "string",
  1578. "description": "name of the organization",
  1579. "name": "org",
  1580. "in": "path",
  1581. "required": true
  1582. },
  1583. {
  1584. "type": "integer",
  1585. "description": "page number of results to return (1-based)",
  1586. "name": "page",
  1587. "in": "query"
  1588. },
  1589. {
  1590. "type": "integer",
  1591. "description": "page size of results",
  1592. "name": "limit",
  1593. "in": "query"
  1594. }
  1595. ],
  1596. "responses": {
  1597. "200": {
  1598. "$ref": "#/responses/SecretList"
  1599. },
  1600. "404": {
  1601. "$ref": "#/responses/notFound"
  1602. }
  1603. }
  1604. }
  1605. },
  1606. "/orgs/{org}/actions/secrets/{secretname}": {
  1607. "put": {
  1608. "consumes": [
  1609. "application/json"
  1610. ],
  1611. "produces": [
  1612. "application/json"
  1613. ],
  1614. "tags": [
  1615. "organization"
  1616. ],
  1617. "summary": "Create or Update a secret value in an organization",
  1618. "operationId": "updateOrgSecret",
  1619. "parameters": [
  1620. {
  1621. "type": "string",
  1622. "description": "name of organization",
  1623. "name": "org",
  1624. "in": "path",
  1625. "required": true
  1626. },
  1627. {
  1628. "type": "string",
  1629. "description": "name of the secret",
  1630. "name": "secretname",
  1631. "in": "path",
  1632. "required": true
  1633. },
  1634. {
  1635. "name": "body",
  1636. "in": "body",
  1637. "schema": {
  1638. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  1639. }
  1640. }
  1641. ],
  1642. "responses": {
  1643. "201": {
  1644. "description": "response when creating a secret"
  1645. },
  1646. "204": {
  1647. "description": "response when updating a secret"
  1648. },
  1649. "400": {
  1650. "$ref": "#/responses/error"
  1651. },
  1652. "404": {
  1653. "$ref": "#/responses/notFound"
  1654. }
  1655. }
  1656. },
  1657. "delete": {
  1658. "consumes": [
  1659. "application/json"
  1660. ],
  1661. "produces": [
  1662. "application/json"
  1663. ],
  1664. "tags": [
  1665. "organization"
  1666. ],
  1667. "summary": "Delete a secret in an organization",
  1668. "operationId": "deleteOrgSecret",
  1669. "parameters": [
  1670. {
  1671. "type": "string",
  1672. "description": "name of organization",
  1673. "name": "org",
  1674. "in": "path",
  1675. "required": true
  1676. },
  1677. {
  1678. "type": "string",
  1679. "description": "name of the secret",
  1680. "name": "secretname",
  1681. "in": "path",
  1682. "required": true
  1683. }
  1684. ],
  1685. "responses": {
  1686. "204": {
  1687. "description": "delete one secret of the organization"
  1688. },
  1689. "400": {
  1690. "$ref": "#/responses/error"
  1691. },
  1692. "404": {
  1693. "$ref": "#/responses/notFound"
  1694. }
  1695. }
  1696. }
  1697. },
  1698. "/orgs/{org}/activities/feeds": {
  1699. "get": {
  1700. "produces": [
  1701. "application/json"
  1702. ],
  1703. "tags": [
  1704. "organization"
  1705. ],
  1706. "summary": "List an organization's activity feeds",
  1707. "operationId": "orgListActivityFeeds",
  1708. "parameters": [
  1709. {
  1710. "type": "string",
  1711. "description": "name of the org",
  1712. "name": "org",
  1713. "in": "path",
  1714. "required": true
  1715. },
  1716. {
  1717. "type": "string",
  1718. "format": "date",
  1719. "description": "the date of the activities to be found",
  1720. "name": "date",
  1721. "in": "query"
  1722. },
  1723. {
  1724. "type": "integer",
  1725. "description": "page number of results to return (1-based)",
  1726. "name": "page",
  1727. "in": "query"
  1728. },
  1729. {
  1730. "type": "integer",
  1731. "description": "page size of results",
  1732. "name": "limit",
  1733. "in": "query"
  1734. }
  1735. ],
  1736. "responses": {
  1737. "200": {
  1738. "$ref": "#/responses/ActivityFeedsList"
  1739. },
  1740. "404": {
  1741. "$ref": "#/responses/notFound"
  1742. }
  1743. }
  1744. }
  1745. },
  1746. "/orgs/{org}/avatar": {
  1747. "post": {
  1748. "produces": [
  1749. "application/json"
  1750. ],
  1751. "tags": [
  1752. "organization"
  1753. ],
  1754. "summary": "Update Avatar",
  1755. "operationId": "orgUpdateAvatar",
  1756. "parameters": [
  1757. {
  1758. "type": "string",
  1759. "description": "name of the organization",
  1760. "name": "org",
  1761. "in": "path",
  1762. "required": true
  1763. },
  1764. {
  1765. "name": "body",
  1766. "in": "body",
  1767. "schema": {
  1768. "$ref": "#/definitions/UpdateUserAvatarOption"
  1769. }
  1770. }
  1771. ],
  1772. "responses": {
  1773. "204": {
  1774. "$ref": "#/responses/empty"
  1775. },
  1776. "404": {
  1777. "$ref": "#/responses/notFound"
  1778. }
  1779. }
  1780. },
  1781. "delete": {
  1782. "produces": [
  1783. "application/json"
  1784. ],
  1785. "tags": [
  1786. "organization"
  1787. ],
  1788. "summary": "Delete Avatar",
  1789. "operationId": "orgDeleteAvatar",
  1790. "parameters": [
  1791. {
  1792. "type": "string",
  1793. "description": "name of the organization",
  1794. "name": "org",
  1795. "in": "path",
  1796. "required": true
  1797. }
  1798. ],
  1799. "responses": {
  1800. "204": {
  1801. "$ref": "#/responses/empty"
  1802. },
  1803. "404": {
  1804. "$ref": "#/responses/notFound"
  1805. }
  1806. }
  1807. }
  1808. },
  1809. "/orgs/{org}/hooks": {
  1810. "get": {
  1811. "produces": [
  1812. "application/json"
  1813. ],
  1814. "tags": [
  1815. "organization"
  1816. ],
  1817. "summary": "List an organization's webhooks",
  1818. "operationId": "orgListHooks",
  1819. "parameters": [
  1820. {
  1821. "type": "string",
  1822. "description": "name of the organization",
  1823. "name": "org",
  1824. "in": "path",
  1825. "required": true
  1826. },
  1827. {
  1828. "type": "integer",
  1829. "description": "page number of results to return (1-based)",
  1830. "name": "page",
  1831. "in": "query"
  1832. },
  1833. {
  1834. "type": "integer",
  1835. "description": "page size of results",
  1836. "name": "limit",
  1837. "in": "query"
  1838. }
  1839. ],
  1840. "responses": {
  1841. "200": {
  1842. "$ref": "#/responses/HookList"
  1843. },
  1844. "404": {
  1845. "$ref": "#/responses/notFound"
  1846. }
  1847. }
  1848. },
  1849. "post": {
  1850. "consumes": [
  1851. "application/json"
  1852. ],
  1853. "produces": [
  1854. "application/json"
  1855. ],
  1856. "tags": [
  1857. "organization"
  1858. ],
  1859. "summary": "Create a hook",
  1860. "operationId": "orgCreateHook",
  1861. "parameters": [
  1862. {
  1863. "type": "string",
  1864. "description": "name of the organization",
  1865. "name": "org",
  1866. "in": "path",
  1867. "required": true
  1868. },
  1869. {
  1870. "name": "body",
  1871. "in": "body",
  1872. "required": true,
  1873. "schema": {
  1874. "$ref": "#/definitions/CreateHookOption"
  1875. }
  1876. }
  1877. ],
  1878. "responses": {
  1879. "201": {
  1880. "$ref": "#/responses/Hook"
  1881. },
  1882. "404": {
  1883. "$ref": "#/responses/notFound"
  1884. }
  1885. }
  1886. }
  1887. },
  1888. "/orgs/{org}/hooks/{id}": {
  1889. "get": {
  1890. "produces": [
  1891. "application/json"
  1892. ],
  1893. "tags": [
  1894. "organization"
  1895. ],
  1896. "summary": "Get a hook",
  1897. "operationId": "orgGetHook",
  1898. "parameters": [
  1899. {
  1900. "type": "string",
  1901. "description": "name of the organization",
  1902. "name": "org",
  1903. "in": "path",
  1904. "required": true
  1905. },
  1906. {
  1907. "type": "integer",
  1908. "format": "int64",
  1909. "description": "id of the hook to get",
  1910. "name": "id",
  1911. "in": "path",
  1912. "required": true
  1913. }
  1914. ],
  1915. "responses": {
  1916. "200": {
  1917. "$ref": "#/responses/Hook"
  1918. },
  1919. "404": {
  1920. "$ref": "#/responses/notFound"
  1921. }
  1922. }
  1923. },
  1924. "delete": {
  1925. "produces": [
  1926. "application/json"
  1927. ],
  1928. "tags": [
  1929. "organization"
  1930. ],
  1931. "summary": "Delete a hook",
  1932. "operationId": "orgDeleteHook",
  1933. "parameters": [
  1934. {
  1935. "type": "string",
  1936. "description": "name of the organization",
  1937. "name": "org",
  1938. "in": "path",
  1939. "required": true
  1940. },
  1941. {
  1942. "type": "integer",
  1943. "format": "int64",
  1944. "description": "id of the hook to delete",
  1945. "name": "id",
  1946. "in": "path",
  1947. "required": true
  1948. }
  1949. ],
  1950. "responses": {
  1951. "204": {
  1952. "$ref": "#/responses/empty"
  1953. },
  1954. "404": {
  1955. "$ref": "#/responses/notFound"
  1956. }
  1957. }
  1958. },
  1959. "patch": {
  1960. "consumes": [
  1961. "application/json"
  1962. ],
  1963. "produces": [
  1964. "application/json"
  1965. ],
  1966. "tags": [
  1967. "organization"
  1968. ],
  1969. "summary": "Update a hook",
  1970. "operationId": "orgEditHook",
  1971. "parameters": [
  1972. {
  1973. "type": "string",
  1974. "description": "name of the organization",
  1975. "name": "org",
  1976. "in": "path",
  1977. "required": true
  1978. },
  1979. {
  1980. "type": "integer",
  1981. "format": "int64",
  1982. "description": "id of the hook to update",
  1983. "name": "id",
  1984. "in": "path",
  1985. "required": true
  1986. },
  1987. {
  1988. "name": "body",
  1989. "in": "body",
  1990. "schema": {
  1991. "$ref": "#/definitions/EditHookOption"
  1992. }
  1993. }
  1994. ],
  1995. "responses": {
  1996. "200": {
  1997. "$ref": "#/responses/Hook"
  1998. },
  1999. "404": {
  2000. "$ref": "#/responses/notFound"
  2001. }
  2002. }
  2003. }
  2004. },
  2005. "/orgs/{org}/labels": {
  2006. "get": {
  2007. "produces": [
  2008. "application/json"
  2009. ],
  2010. "tags": [
  2011. "organization"
  2012. ],
  2013. "summary": "List an organization's labels",
  2014. "operationId": "orgListLabels",
  2015. "parameters": [
  2016. {
  2017. "type": "string",
  2018. "description": "name of the organization",
  2019. "name": "org",
  2020. "in": "path",
  2021. "required": true
  2022. },
  2023. {
  2024. "type": "integer",
  2025. "description": "page number of results to return (1-based)",
  2026. "name": "page",
  2027. "in": "query"
  2028. },
  2029. {
  2030. "type": "integer",
  2031. "description": "page size of results",
  2032. "name": "limit",
  2033. "in": "query"
  2034. }
  2035. ],
  2036. "responses": {
  2037. "200": {
  2038. "$ref": "#/responses/LabelList"
  2039. },
  2040. "404": {
  2041. "$ref": "#/responses/notFound"
  2042. }
  2043. }
  2044. },
  2045. "post": {
  2046. "consumes": [
  2047. "application/json"
  2048. ],
  2049. "produces": [
  2050. "application/json"
  2051. ],
  2052. "tags": [
  2053. "organization"
  2054. ],
  2055. "summary": "Create a label for an organization",
  2056. "operationId": "orgCreateLabel",
  2057. "parameters": [
  2058. {
  2059. "type": "string",
  2060. "description": "name of the organization",
  2061. "name": "org",
  2062. "in": "path",
  2063. "required": true
  2064. },
  2065. {
  2066. "name": "body",
  2067. "in": "body",
  2068. "schema": {
  2069. "$ref": "#/definitions/CreateLabelOption"
  2070. }
  2071. }
  2072. ],
  2073. "responses": {
  2074. "201": {
  2075. "$ref": "#/responses/Label"
  2076. },
  2077. "404": {
  2078. "$ref": "#/responses/notFound"
  2079. },
  2080. "422": {
  2081. "$ref": "#/responses/validationError"
  2082. }
  2083. }
  2084. }
  2085. },
  2086. "/orgs/{org}/labels/{id}": {
  2087. "get": {
  2088. "produces": [
  2089. "application/json"
  2090. ],
  2091. "tags": [
  2092. "organization"
  2093. ],
  2094. "summary": "Get a single label",
  2095. "operationId": "orgGetLabel",
  2096. "parameters": [
  2097. {
  2098. "type": "string",
  2099. "description": "name of the organization",
  2100. "name": "org",
  2101. "in": "path",
  2102. "required": true
  2103. },
  2104. {
  2105. "type": "integer",
  2106. "format": "int64",
  2107. "description": "id of the label to get",
  2108. "name": "id",
  2109. "in": "path",
  2110. "required": true
  2111. }
  2112. ],
  2113. "responses": {
  2114. "200": {
  2115. "$ref": "#/responses/Label"
  2116. },
  2117. "404": {
  2118. "$ref": "#/responses/notFound"
  2119. }
  2120. }
  2121. },
  2122. "delete": {
  2123. "tags": [
  2124. "organization"
  2125. ],
  2126. "summary": "Delete a label",
  2127. "operationId": "orgDeleteLabel",
  2128. "parameters": [
  2129. {
  2130. "type": "string",
  2131. "description": "name of the organization",
  2132. "name": "org",
  2133. "in": "path",
  2134. "required": true
  2135. },
  2136. {
  2137. "type": "integer",
  2138. "format": "int64",
  2139. "description": "id of the label to delete",
  2140. "name": "id",
  2141. "in": "path",
  2142. "required": true
  2143. }
  2144. ],
  2145. "responses": {
  2146. "204": {
  2147. "$ref": "#/responses/empty"
  2148. },
  2149. "404": {
  2150. "$ref": "#/responses/notFound"
  2151. }
  2152. }
  2153. },
  2154. "patch": {
  2155. "consumes": [
  2156. "application/json"
  2157. ],
  2158. "produces": [
  2159. "application/json"
  2160. ],
  2161. "tags": [
  2162. "organization"
  2163. ],
  2164. "summary": "Update a label",
  2165. "operationId": "orgEditLabel",
  2166. "parameters": [
  2167. {
  2168. "type": "string",
  2169. "description": "name of the organization",
  2170. "name": "org",
  2171. "in": "path",
  2172. "required": true
  2173. },
  2174. {
  2175. "type": "integer",
  2176. "format": "int64",
  2177. "description": "id of the label to edit",
  2178. "name": "id",
  2179. "in": "path",
  2180. "required": true
  2181. },
  2182. {
  2183. "name": "body",
  2184. "in": "body",
  2185. "schema": {
  2186. "$ref": "#/definitions/EditLabelOption"
  2187. }
  2188. }
  2189. ],
  2190. "responses": {
  2191. "200": {
  2192. "$ref": "#/responses/Label"
  2193. },
  2194. "404": {
  2195. "$ref": "#/responses/notFound"
  2196. },
  2197. "422": {
  2198. "$ref": "#/responses/validationError"
  2199. }
  2200. }
  2201. }
  2202. },
  2203. "/orgs/{org}/members": {
  2204. "get": {
  2205. "produces": [
  2206. "application/json"
  2207. ],
  2208. "tags": [
  2209. "organization"
  2210. ],
  2211. "summary": "List an organization's members",
  2212. "operationId": "orgListMembers",
  2213. "parameters": [
  2214. {
  2215. "type": "string",
  2216. "description": "name of the organization",
  2217. "name": "org",
  2218. "in": "path",
  2219. "required": true
  2220. },
  2221. {
  2222. "type": "integer",
  2223. "description": "page number of results to return (1-based)",
  2224. "name": "page",
  2225. "in": "query"
  2226. },
  2227. {
  2228. "type": "integer",
  2229. "description": "page size of results",
  2230. "name": "limit",
  2231. "in": "query"
  2232. }
  2233. ],
  2234. "responses": {
  2235. "200": {
  2236. "$ref": "#/responses/UserList"
  2237. },
  2238. "404": {
  2239. "$ref": "#/responses/notFound"
  2240. }
  2241. }
  2242. }
  2243. },
  2244. "/orgs/{org}/members/{username}": {
  2245. "get": {
  2246. "tags": [
  2247. "organization"
  2248. ],
  2249. "summary": "Check if a user is a member of an organization",
  2250. "operationId": "orgIsMember",
  2251. "parameters": [
  2252. {
  2253. "type": "string",
  2254. "description": "name of the organization",
  2255. "name": "org",
  2256. "in": "path",
  2257. "required": true
  2258. },
  2259. {
  2260. "type": "string",
  2261. "description": "username of the user",
  2262. "name": "username",
  2263. "in": "path",
  2264. "required": true
  2265. }
  2266. ],
  2267. "responses": {
  2268. "204": {
  2269. "description": "user is a member"
  2270. },
  2271. "303": {
  2272. "description": "redirection to /orgs/{org}/public_members/{username}"
  2273. },
  2274. "404": {
  2275. "description": "user is not a member"
  2276. }
  2277. }
  2278. },
  2279. "delete": {
  2280. "produces": [
  2281. "application/json"
  2282. ],
  2283. "tags": [
  2284. "organization"
  2285. ],
  2286. "summary": "Remove a member from an organization",
  2287. "operationId": "orgDeleteMember",
  2288. "parameters": [
  2289. {
  2290. "type": "string",
  2291. "description": "name of the organization",
  2292. "name": "org",
  2293. "in": "path",
  2294. "required": true
  2295. },
  2296. {
  2297. "type": "string",
  2298. "description": "username of the user",
  2299. "name": "username",
  2300. "in": "path",
  2301. "required": true
  2302. }
  2303. ],
  2304. "responses": {
  2305. "204": {
  2306. "description": "member removed"
  2307. },
  2308. "404": {
  2309. "$ref": "#/responses/notFound"
  2310. }
  2311. }
  2312. }
  2313. },
  2314. "/orgs/{org}/public_members": {
  2315. "get": {
  2316. "produces": [
  2317. "application/json"
  2318. ],
  2319. "tags": [
  2320. "organization"
  2321. ],
  2322. "summary": "List an organization's public members",
  2323. "operationId": "orgListPublicMembers",
  2324. "parameters": [
  2325. {
  2326. "type": "string",
  2327. "description": "name of the organization",
  2328. "name": "org",
  2329. "in": "path",
  2330. "required": true
  2331. },
  2332. {
  2333. "type": "integer",
  2334. "description": "page number of results to return (1-based)",
  2335. "name": "page",
  2336. "in": "query"
  2337. },
  2338. {
  2339. "type": "integer",
  2340. "description": "page size of results",
  2341. "name": "limit",
  2342. "in": "query"
  2343. }
  2344. ],
  2345. "responses": {
  2346. "200": {
  2347. "$ref": "#/responses/UserList"
  2348. },
  2349. "404": {
  2350. "$ref": "#/responses/notFound"
  2351. }
  2352. }
  2353. }
  2354. },
  2355. "/orgs/{org}/public_members/{username}": {
  2356. "get": {
  2357. "tags": [
  2358. "organization"
  2359. ],
  2360. "summary": "Check if a user is a public member of an organization",
  2361. "operationId": "orgIsPublicMember",
  2362. "parameters": [
  2363. {
  2364. "type": "string",
  2365. "description": "name of the organization",
  2366. "name": "org",
  2367. "in": "path",
  2368. "required": true
  2369. },
  2370. {
  2371. "type": "string",
  2372. "description": "username of the user",
  2373. "name": "username",
  2374. "in": "path",
  2375. "required": true
  2376. }
  2377. ],
  2378. "responses": {
  2379. "204": {
  2380. "description": "user is a public member"
  2381. },
  2382. "404": {
  2383. "description": "user is not a public member"
  2384. }
  2385. }
  2386. },
  2387. "put": {
  2388. "produces": [
  2389. "application/json"
  2390. ],
  2391. "tags": [
  2392. "organization"
  2393. ],
  2394. "summary": "Publicize a user's membership",
  2395. "operationId": "orgPublicizeMember",
  2396. "parameters": [
  2397. {
  2398. "type": "string",
  2399. "description": "name of the organization",
  2400. "name": "org",
  2401. "in": "path",
  2402. "required": true
  2403. },
  2404. {
  2405. "type": "string",
  2406. "description": "username of the user",
  2407. "name": "username",
  2408. "in": "path",
  2409. "required": true
  2410. }
  2411. ],
  2412. "responses": {
  2413. "204": {
  2414. "description": "membership publicized"
  2415. },
  2416. "403": {
  2417. "$ref": "#/responses/forbidden"
  2418. },
  2419. "404": {
  2420. "$ref": "#/responses/notFound"
  2421. }
  2422. }
  2423. },
  2424. "delete": {
  2425. "produces": [
  2426. "application/json"
  2427. ],
  2428. "tags": [
  2429. "organization"
  2430. ],
  2431. "summary": "Conceal a user's membership",
  2432. "operationId": "orgConcealMember",
  2433. "parameters": [
  2434. {
  2435. "type": "string",
  2436. "description": "name of the organization",
  2437. "name": "org",
  2438. "in": "path",
  2439. "required": true
  2440. },
  2441. {
  2442. "type": "string",
  2443. "description": "username of the user",
  2444. "name": "username",
  2445. "in": "path",
  2446. "required": true
  2447. }
  2448. ],
  2449. "responses": {
  2450. "204": {
  2451. "$ref": "#/responses/empty"
  2452. },
  2453. "403": {
  2454. "$ref": "#/responses/forbidden"
  2455. },
  2456. "404": {
  2457. "$ref": "#/responses/notFound"
  2458. }
  2459. }
  2460. }
  2461. },
  2462. "/orgs/{org}/repos": {
  2463. "get": {
  2464. "produces": [
  2465. "application/json"
  2466. ],
  2467. "tags": [
  2468. "organization"
  2469. ],
  2470. "summary": "List an organization's repos",
  2471. "operationId": "orgListRepos",
  2472. "parameters": [
  2473. {
  2474. "type": "string",
  2475. "description": "name of the organization",
  2476. "name": "org",
  2477. "in": "path",
  2478. "required": true
  2479. },
  2480. {
  2481. "type": "integer",
  2482. "description": "page number of results to return (1-based)",
  2483. "name": "page",
  2484. "in": "query"
  2485. },
  2486. {
  2487. "type": "integer",
  2488. "description": "page size of results",
  2489. "name": "limit",
  2490. "in": "query"
  2491. }
  2492. ],
  2493. "responses": {
  2494. "200": {
  2495. "$ref": "#/responses/RepositoryList"
  2496. },
  2497. "404": {
  2498. "$ref": "#/responses/notFound"
  2499. }
  2500. }
  2501. },
  2502. "post": {
  2503. "consumes": [
  2504. "application/json"
  2505. ],
  2506. "produces": [
  2507. "application/json"
  2508. ],
  2509. "tags": [
  2510. "organization"
  2511. ],
  2512. "summary": "Create a repository in an organization",
  2513. "operationId": "createOrgRepo",
  2514. "parameters": [
  2515. {
  2516. "type": "string",
  2517. "description": "name of organization",
  2518. "name": "org",
  2519. "in": "path",
  2520. "required": true
  2521. },
  2522. {
  2523. "name": "body",
  2524. "in": "body",
  2525. "schema": {
  2526. "$ref": "#/definitions/CreateRepoOption"
  2527. }
  2528. }
  2529. ],
  2530. "responses": {
  2531. "201": {
  2532. "$ref": "#/responses/Repository"
  2533. },
  2534. "400": {
  2535. "$ref": "#/responses/error"
  2536. },
  2537. "403": {
  2538. "$ref": "#/responses/forbidden"
  2539. },
  2540. "404": {
  2541. "$ref": "#/responses/notFound"
  2542. }
  2543. }
  2544. }
  2545. },
  2546. "/orgs/{org}/teams": {
  2547. "get": {
  2548. "produces": [
  2549. "application/json"
  2550. ],
  2551. "tags": [
  2552. "organization"
  2553. ],
  2554. "summary": "List an organization's teams",
  2555. "operationId": "orgListTeams",
  2556. "parameters": [
  2557. {
  2558. "type": "string",
  2559. "description": "name of the organization",
  2560. "name": "org",
  2561. "in": "path",
  2562. "required": true
  2563. },
  2564. {
  2565. "type": "integer",
  2566. "description": "page number of results to return (1-based)",
  2567. "name": "page",
  2568. "in": "query"
  2569. },
  2570. {
  2571. "type": "integer",
  2572. "description": "page size of results",
  2573. "name": "limit",
  2574. "in": "query"
  2575. }
  2576. ],
  2577. "responses": {
  2578. "200": {
  2579. "$ref": "#/responses/TeamList"
  2580. },
  2581. "404": {
  2582. "$ref": "#/responses/notFound"
  2583. }
  2584. }
  2585. },
  2586. "post": {
  2587. "consumes": [
  2588. "application/json"
  2589. ],
  2590. "produces": [
  2591. "application/json"
  2592. ],
  2593. "tags": [
  2594. "organization"
  2595. ],
  2596. "summary": "Create a team",
  2597. "operationId": "orgCreateTeam",
  2598. "parameters": [
  2599. {
  2600. "type": "string",
  2601. "description": "name of the organization",
  2602. "name": "org",
  2603. "in": "path",
  2604. "required": true
  2605. },
  2606. {
  2607. "name": "body",
  2608. "in": "body",
  2609. "schema": {
  2610. "$ref": "#/definitions/CreateTeamOption"
  2611. }
  2612. }
  2613. ],
  2614. "responses": {
  2615. "201": {
  2616. "$ref": "#/responses/Team"
  2617. },
  2618. "404": {
  2619. "$ref": "#/responses/notFound"
  2620. },
  2621. "422": {
  2622. "$ref": "#/responses/validationError"
  2623. }
  2624. }
  2625. }
  2626. },
  2627. "/orgs/{org}/teams/search": {
  2628. "get": {
  2629. "produces": [
  2630. "application/json"
  2631. ],
  2632. "tags": [
  2633. "organization"
  2634. ],
  2635. "summary": "Search for teams within an organization",
  2636. "operationId": "teamSearch",
  2637. "parameters": [
  2638. {
  2639. "type": "string",
  2640. "description": "name of the organization",
  2641. "name": "org",
  2642. "in": "path",
  2643. "required": true
  2644. },
  2645. {
  2646. "type": "string",
  2647. "description": "keywords to search",
  2648. "name": "q",
  2649. "in": "query"
  2650. },
  2651. {
  2652. "type": "boolean",
  2653. "description": "include search within team description (defaults to true)",
  2654. "name": "include_desc",
  2655. "in": "query"
  2656. },
  2657. {
  2658. "type": "integer",
  2659. "description": "page number of results to return (1-based)",
  2660. "name": "page",
  2661. "in": "query"
  2662. },
  2663. {
  2664. "type": "integer",
  2665. "description": "page size of results",
  2666. "name": "limit",
  2667. "in": "query"
  2668. }
  2669. ],
  2670. "responses": {
  2671. "200": {
  2672. "description": "SearchResults of a successful search",
  2673. "schema": {
  2674. "type": "object",
  2675. "properties": {
  2676. "data": {
  2677. "type": "array",
  2678. "items": {
  2679. "$ref": "#/definitions/Team"
  2680. }
  2681. },
  2682. "ok": {
  2683. "type": "boolean"
  2684. }
  2685. }
  2686. }
  2687. },
  2688. "404": {
  2689. "$ref": "#/responses/notFound"
  2690. }
  2691. }
  2692. }
  2693. },
  2694. "/packages/{owner}": {
  2695. "get": {
  2696. "produces": [
  2697. "application/json"
  2698. ],
  2699. "tags": [
  2700. "package"
  2701. ],
  2702. "summary": "Gets all packages of an owner",
  2703. "operationId": "listPackages",
  2704. "parameters": [
  2705. {
  2706. "type": "string",
  2707. "description": "owner of the packages",
  2708. "name": "owner",
  2709. "in": "path",
  2710. "required": true
  2711. },
  2712. {
  2713. "type": "integer",
  2714. "description": "page number of results to return (1-based)",
  2715. "name": "page",
  2716. "in": "query"
  2717. },
  2718. {
  2719. "type": "integer",
  2720. "description": "page size of results",
  2721. "name": "limit",
  2722. "in": "query"
  2723. },
  2724. {
  2725. "enum": [
  2726. "alpine",
  2727. "cargo",
  2728. "chef",
  2729. "composer",
  2730. "conan",
  2731. "conda",
  2732. "container",
  2733. "cran",
  2734. "debian",
  2735. "generic",
  2736. "go",
  2737. "helm",
  2738. "maven",
  2739. "npm",
  2740. "nuget",
  2741. "pub",
  2742. "pypi",
  2743. "rpm",
  2744. "rubygems",
  2745. "swift",
  2746. "vagrant"
  2747. ],
  2748. "type": "string",
  2749. "description": "package type filter",
  2750. "name": "type",
  2751. "in": "query"
  2752. },
  2753. {
  2754. "type": "string",
  2755. "description": "name filter",
  2756. "name": "q",
  2757. "in": "query"
  2758. }
  2759. ],
  2760. "responses": {
  2761. "200": {
  2762. "$ref": "#/responses/PackageList"
  2763. },
  2764. "404": {
  2765. "$ref": "#/responses/notFound"
  2766. }
  2767. }
  2768. }
  2769. },
  2770. "/packages/{owner}/{type}/{name}/{version}": {
  2771. "get": {
  2772. "produces": [
  2773. "application/json"
  2774. ],
  2775. "tags": [
  2776. "package"
  2777. ],
  2778. "summary": "Gets a package",
  2779. "operationId": "getPackage",
  2780. "parameters": [
  2781. {
  2782. "type": "string",
  2783. "description": "owner of the package",
  2784. "name": "owner",
  2785. "in": "path",
  2786. "required": true
  2787. },
  2788. {
  2789. "type": "string",
  2790. "description": "type of the package",
  2791. "name": "type",
  2792. "in": "path",
  2793. "required": true
  2794. },
  2795. {
  2796. "type": "string",
  2797. "description": "name of the package",
  2798. "name": "name",
  2799. "in": "path",
  2800. "required": true
  2801. },
  2802. {
  2803. "type": "string",
  2804. "description": "version of the package",
  2805. "name": "version",
  2806. "in": "path",
  2807. "required": true
  2808. }
  2809. ],
  2810. "responses": {
  2811. "200": {
  2812. "$ref": "#/responses/Package"
  2813. },
  2814. "404": {
  2815. "$ref": "#/responses/notFound"
  2816. }
  2817. }
  2818. },
  2819. "delete": {
  2820. "tags": [
  2821. "package"
  2822. ],
  2823. "summary": "Delete a package",
  2824. "operationId": "deletePackage",
  2825. "parameters": [
  2826. {
  2827. "type": "string",
  2828. "description": "owner of the package",
  2829. "name": "owner",
  2830. "in": "path",
  2831. "required": true
  2832. },
  2833. {
  2834. "type": "string",
  2835. "description": "type of the package",
  2836. "name": "type",
  2837. "in": "path",
  2838. "required": true
  2839. },
  2840. {
  2841. "type": "string",
  2842. "description": "name of the package",
  2843. "name": "name",
  2844. "in": "path",
  2845. "required": true
  2846. },
  2847. {
  2848. "type": "string",
  2849. "description": "version of the package",
  2850. "name": "version",
  2851. "in": "path",
  2852. "required": true
  2853. }
  2854. ],
  2855. "responses": {
  2856. "204": {
  2857. "$ref": "#/responses/empty"
  2858. },
  2859. "404": {
  2860. "$ref": "#/responses/notFound"
  2861. }
  2862. }
  2863. }
  2864. },
  2865. "/packages/{owner}/{type}/{name}/{version}/files": {
  2866. "get": {
  2867. "produces": [
  2868. "application/json"
  2869. ],
  2870. "tags": [
  2871. "package"
  2872. ],
  2873. "summary": "Gets all files of a package",
  2874. "operationId": "listPackageFiles",
  2875. "parameters": [
  2876. {
  2877. "type": "string",
  2878. "description": "owner of the package",
  2879. "name": "owner",
  2880. "in": "path",
  2881. "required": true
  2882. },
  2883. {
  2884. "type": "string",
  2885. "description": "type of the package",
  2886. "name": "type",
  2887. "in": "path",
  2888. "required": true
  2889. },
  2890. {
  2891. "type": "string",
  2892. "description": "name of the package",
  2893. "name": "name",
  2894. "in": "path",
  2895. "required": true
  2896. },
  2897. {
  2898. "type": "string",
  2899. "description": "version of the package",
  2900. "name": "version",
  2901. "in": "path",
  2902. "required": true
  2903. }
  2904. ],
  2905. "responses": {
  2906. "200": {
  2907. "$ref": "#/responses/PackageFileList"
  2908. },
  2909. "404": {
  2910. "$ref": "#/responses/notFound"
  2911. }
  2912. }
  2913. }
  2914. },
  2915. "/repos/issues/search": {
  2916. "get": {
  2917. "produces": [
  2918. "application/json"
  2919. ],
  2920. "tags": [
  2921. "issue"
  2922. ],
  2923. "summary": "Search for issues across the repositories that the user has access to",
  2924. "operationId": "issueSearchIssues",
  2925. "parameters": [
  2926. {
  2927. "type": "string",
  2928. "description": "whether issue is open or closed",
  2929. "name": "state",
  2930. "in": "query"
  2931. },
  2932. {
  2933. "type": "string",
  2934. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  2935. "name": "labels",
  2936. "in": "query"
  2937. },
  2938. {
  2939. "type": "string",
  2940. "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
  2941. "name": "milestones",
  2942. "in": "query"
  2943. },
  2944. {
  2945. "type": "string",
  2946. "description": "search string",
  2947. "name": "q",
  2948. "in": "query"
  2949. },
  2950. {
  2951. "type": "integer",
  2952. "format": "int64",
  2953. "description": "repository to prioritize in the results",
  2954. "name": "priority_repo_id",
  2955. "in": "query"
  2956. },
  2957. {
  2958. "type": "string",
  2959. "description": "filter by type (issues / pulls) if set",
  2960. "name": "type",
  2961. "in": "query"
  2962. },
  2963. {
  2964. "type": "string",
  2965. "format": "date-time",
  2966. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  2967. "name": "since",
  2968. "in": "query"
  2969. },
  2970. {
  2971. "type": "string",
  2972. "format": "date-time",
  2973. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  2974. "name": "before",
  2975. "in": "query"
  2976. },
  2977. {
  2978. "type": "boolean",
  2979. "description": "filter (issues / pulls) assigned to you, default is false",
  2980. "name": "assigned",
  2981. "in": "query"
  2982. },
  2983. {
  2984. "type": "boolean",
  2985. "description": "filter (issues / pulls) created by you, default is false",
  2986. "name": "created",
  2987. "in": "query"
  2988. },
  2989. {
  2990. "type": "boolean",
  2991. "description": "filter (issues / pulls) mentioning you, default is false",
  2992. "name": "mentioned",
  2993. "in": "query"
  2994. },
  2995. {
  2996. "type": "boolean",
  2997. "description": "filter pulls requesting your review, default is false",
  2998. "name": "review_requested",
  2999. "in": "query"
  3000. },
  3001. {
  3002. "type": "boolean",
  3003. "description": "filter pulls reviewed by you, default is false",
  3004. "name": "reviewed",
  3005. "in": "query"
  3006. },
  3007. {
  3008. "type": "string",
  3009. "description": "filter by owner",
  3010. "name": "owner",
  3011. "in": "query"
  3012. },
  3013. {
  3014. "type": "string",
  3015. "description": "filter by team (requires organization owner parameter to be provided)",
  3016. "name": "team",
  3017. "in": "query"
  3018. },
  3019. {
  3020. "type": "integer",
  3021. "description": "page number of results to return (1-based)",
  3022. "name": "page",
  3023. "in": "query"
  3024. },
  3025. {
  3026. "type": "integer",
  3027. "description": "page size of results",
  3028. "name": "limit",
  3029. "in": "query"
  3030. }
  3031. ],
  3032. "responses": {
  3033. "200": {
  3034. "$ref": "#/responses/IssueList"
  3035. }
  3036. }
  3037. }
  3038. },
  3039. "/repos/migrate": {
  3040. "post": {
  3041. "consumes": [
  3042. "application/json"
  3043. ],
  3044. "produces": [
  3045. "application/json"
  3046. ],
  3047. "tags": [
  3048. "repository"
  3049. ],
  3050. "summary": "Migrate a remote git repository",
  3051. "operationId": "repoMigrate",
  3052. "parameters": [
  3053. {
  3054. "name": "body",
  3055. "in": "body",
  3056. "schema": {
  3057. "$ref": "#/definitions/MigrateRepoOptions"
  3058. }
  3059. }
  3060. ],
  3061. "responses": {
  3062. "201": {
  3063. "$ref": "#/responses/Repository"
  3064. },
  3065. "403": {
  3066. "$ref": "#/responses/forbidden"
  3067. },
  3068. "409": {
  3069. "description": "The repository with the same name already exists."
  3070. },
  3071. "422": {
  3072. "$ref": "#/responses/validationError"
  3073. }
  3074. }
  3075. }
  3076. },
  3077. "/repos/search": {
  3078. "get": {
  3079. "produces": [
  3080. "application/json"
  3081. ],
  3082. "tags": [
  3083. "repository"
  3084. ],
  3085. "summary": "Search for repositories",
  3086. "operationId": "repoSearch",
  3087. "parameters": [
  3088. {
  3089. "type": "string",
  3090. "description": "keyword",
  3091. "name": "q",
  3092. "in": "query"
  3093. },
  3094. {
  3095. "type": "boolean",
  3096. "description": "Limit search to repositories with keyword as topic",
  3097. "name": "topic",
  3098. "in": "query"
  3099. },
  3100. {
  3101. "type": "boolean",
  3102. "description": "include search of keyword within repository description",
  3103. "name": "includeDesc",
  3104. "in": "query"
  3105. },
  3106. {
  3107. "type": "integer",
  3108. "format": "int64",
  3109. "description": "search only for repos that the user with the given id owns or contributes to",
  3110. "name": "uid",
  3111. "in": "query"
  3112. },
  3113. {
  3114. "type": "integer",
  3115. "format": "int64",
  3116. "description": "repo owner to prioritize in the results",
  3117. "name": "priority_owner_id",
  3118. "in": "query"
  3119. },
  3120. {
  3121. "type": "integer",
  3122. "format": "int64",
  3123. "description": "search only for repos that belong to the given team id",
  3124. "name": "team_id",
  3125. "in": "query"
  3126. },
  3127. {
  3128. "type": "integer",
  3129. "format": "int64",
  3130. "description": "search only for repos that the user with the given id has starred",
  3131. "name": "starredBy",
  3132. "in": "query"
  3133. },
  3134. {
  3135. "type": "boolean",
  3136. "description": "include private repositories this user has access to (defaults to true)",
  3137. "name": "private",
  3138. "in": "query"
  3139. },
  3140. {
  3141. "type": "boolean",
  3142. "description": "show only pubic, private or all repositories (defaults to all)",
  3143. "name": "is_private",
  3144. "in": "query"
  3145. },
  3146. {
  3147. "type": "boolean",
  3148. "description": "include template repositories this user has access to (defaults to true)",
  3149. "name": "template",
  3150. "in": "query"
  3151. },
  3152. {
  3153. "type": "boolean",
  3154. "description": "show only archived, non-archived or all repositories (defaults to all)",
  3155. "name": "archived",
  3156. "in": "query"
  3157. },
  3158. {
  3159. "type": "string",
  3160. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  3161. "name": "mode",
  3162. "in": "query"
  3163. },
  3164. {
  3165. "type": "boolean",
  3166. "description": "if `uid` is given, search only for repos that the user owns",
  3167. "name": "exclusive",
  3168. "in": "query"
  3169. },
  3170. {
  3171. "type": "string",
  3172. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  3173. "name": "sort",
  3174. "in": "query"
  3175. },
  3176. {
  3177. "type": "string",
  3178. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  3179. "name": "order",
  3180. "in": "query"
  3181. },
  3182. {
  3183. "type": "integer",
  3184. "description": "page number of results to return (1-based)",
  3185. "name": "page",
  3186. "in": "query"
  3187. },
  3188. {
  3189. "type": "integer",
  3190. "description": "page size of results",
  3191. "name": "limit",
  3192. "in": "query"
  3193. }
  3194. ],
  3195. "responses": {
  3196. "200": {
  3197. "$ref": "#/responses/SearchResults"
  3198. },
  3199. "422": {
  3200. "$ref": "#/responses/validationError"
  3201. }
  3202. }
  3203. }
  3204. },
  3205. "/repos/{owner}/{repo}": {
  3206. "get": {
  3207. "produces": [
  3208. "application/json"
  3209. ],
  3210. "tags": [
  3211. "repository"
  3212. ],
  3213. "summary": "Get a repository",
  3214. "operationId": "repoGet",
  3215. "parameters": [
  3216. {
  3217. "type": "string",
  3218. "description": "owner of the repo",
  3219. "name": "owner",
  3220. "in": "path",
  3221. "required": true
  3222. },
  3223. {
  3224. "type": "string",
  3225. "description": "name of the repo",
  3226. "name": "repo",
  3227. "in": "path",
  3228. "required": true
  3229. }
  3230. ],
  3231. "responses": {
  3232. "200": {
  3233. "$ref": "#/responses/Repository"
  3234. },
  3235. "404": {
  3236. "$ref": "#/responses/notFound"
  3237. }
  3238. }
  3239. },
  3240. "delete": {
  3241. "produces": [
  3242. "application/json"
  3243. ],
  3244. "tags": [
  3245. "repository"
  3246. ],
  3247. "summary": "Delete a repository",
  3248. "operationId": "repoDelete",
  3249. "parameters": [
  3250. {
  3251. "type": "string",
  3252. "description": "owner of the repo to delete",
  3253. "name": "owner",
  3254. "in": "path",
  3255. "required": true
  3256. },
  3257. {
  3258. "type": "string",
  3259. "description": "name of the repo to delete",
  3260. "name": "repo",
  3261. "in": "path",
  3262. "required": true
  3263. }
  3264. ],
  3265. "responses": {
  3266. "204": {
  3267. "$ref": "#/responses/empty"
  3268. },
  3269. "403": {
  3270. "$ref": "#/responses/forbidden"
  3271. },
  3272. "404": {
  3273. "$ref": "#/responses/notFound"
  3274. }
  3275. }
  3276. },
  3277. "patch": {
  3278. "produces": [
  3279. "application/json"
  3280. ],
  3281. "tags": [
  3282. "repository"
  3283. ],
  3284. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  3285. "operationId": "repoEdit",
  3286. "parameters": [
  3287. {
  3288. "type": "string",
  3289. "description": "owner of the repo to edit",
  3290. "name": "owner",
  3291. "in": "path",
  3292. "required": true
  3293. },
  3294. {
  3295. "type": "string",
  3296. "description": "name of the repo to edit",
  3297. "name": "repo",
  3298. "in": "path",
  3299. "required": true
  3300. },
  3301. {
  3302. "description": "Properties of a repo that you can edit",
  3303. "name": "body",
  3304. "in": "body",
  3305. "schema": {
  3306. "$ref": "#/definitions/EditRepoOption"
  3307. }
  3308. }
  3309. ],
  3310. "responses": {
  3311. "200": {
  3312. "$ref": "#/responses/Repository"
  3313. },
  3314. "403": {
  3315. "$ref": "#/responses/forbidden"
  3316. },
  3317. "404": {
  3318. "$ref": "#/responses/notFound"
  3319. },
  3320. "422": {
  3321. "$ref": "#/responses/validationError"
  3322. }
  3323. }
  3324. }
  3325. },
  3326. "/repos/{owner}/{repo}/actions/secrets/{secretname}": {
  3327. "put": {
  3328. "consumes": [
  3329. "application/json"
  3330. ],
  3331. "produces": [
  3332. "application/json"
  3333. ],
  3334. "tags": [
  3335. "repository"
  3336. ],
  3337. "summary": "Create or Update a secret value in a repository",
  3338. "operationId": "updateRepoSecret",
  3339. "parameters": [
  3340. {
  3341. "type": "string",
  3342. "description": "owner of the repository",
  3343. "name": "owner",
  3344. "in": "path",
  3345. "required": true
  3346. },
  3347. {
  3348. "type": "string",
  3349. "description": "name of the repository",
  3350. "name": "repo",
  3351. "in": "path",
  3352. "required": true
  3353. },
  3354. {
  3355. "type": "string",
  3356. "description": "name of the secret",
  3357. "name": "secretname",
  3358. "in": "path",
  3359. "required": true
  3360. },
  3361. {
  3362. "name": "body",
  3363. "in": "body",
  3364. "schema": {
  3365. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  3366. }
  3367. }
  3368. ],
  3369. "responses": {
  3370. "201": {
  3371. "description": "response when creating a secret"
  3372. },
  3373. "204": {
  3374. "description": "response when updating a secret"
  3375. },
  3376. "400": {
  3377. "$ref": "#/responses/error"
  3378. },
  3379. "404": {
  3380. "$ref": "#/responses/notFound"
  3381. }
  3382. }
  3383. },
  3384. "delete": {
  3385. "consumes": [
  3386. "application/json"
  3387. ],
  3388. "produces": [
  3389. "application/json"
  3390. ],
  3391. "tags": [
  3392. "repository"
  3393. ],
  3394. "summary": "Delete a secret in a repository",
  3395. "operationId": "deleteRepoSecret",
  3396. "parameters": [
  3397. {
  3398. "type": "string",
  3399. "description": "owner of the repository",
  3400. "name": "owner",
  3401. "in": "path",
  3402. "required": true
  3403. },
  3404. {
  3405. "type": "string",
  3406. "description": "name of the repository",
  3407. "name": "repo",
  3408. "in": "path",
  3409. "required": true
  3410. },
  3411. {
  3412. "type": "string",
  3413. "description": "name of the secret",
  3414. "name": "secretname",
  3415. "in": "path",
  3416. "required": true
  3417. }
  3418. ],
  3419. "responses": {
  3420. "204": {
  3421. "description": "delete one secret of the organization"
  3422. },
  3423. "400": {
  3424. "$ref": "#/responses/error"
  3425. },
  3426. "404": {
  3427. "$ref": "#/responses/notFound"
  3428. }
  3429. }
  3430. }
  3431. },
  3432. "/repos/{owner}/{repo}/activities/feeds": {
  3433. "get": {
  3434. "produces": [
  3435. "application/json"
  3436. ],
  3437. "tags": [
  3438. "repository"
  3439. ],
  3440. "summary": "List a repository's activity feeds",
  3441. "operationId": "repoListActivityFeeds",
  3442. "parameters": [
  3443. {
  3444. "type": "string",
  3445. "description": "owner of the repo",
  3446. "name": "owner",
  3447. "in": "path",
  3448. "required": true
  3449. },
  3450. {
  3451. "type": "string",
  3452. "description": "name of the repo",
  3453. "name": "repo",
  3454. "in": "path",
  3455. "required": true
  3456. },
  3457. {
  3458. "type": "string",
  3459. "format": "date",
  3460. "description": "the date of the activities to be found",
  3461. "name": "date",
  3462. "in": "query"
  3463. },
  3464. {
  3465. "type": "integer",
  3466. "description": "page number of results to return (1-based)",
  3467. "name": "page",
  3468. "in": "query"
  3469. },
  3470. {
  3471. "type": "integer",
  3472. "description": "page size of results",
  3473. "name": "limit",
  3474. "in": "query"
  3475. }
  3476. ],
  3477. "responses": {
  3478. "200": {
  3479. "$ref": "#/responses/ActivityFeedsList"
  3480. },
  3481. "404": {
  3482. "$ref": "#/responses/notFound"
  3483. }
  3484. }
  3485. }
  3486. },
  3487. "/repos/{owner}/{repo}/archive/{archive}": {
  3488. "get": {
  3489. "produces": [
  3490. "application/json"
  3491. ],
  3492. "tags": [
  3493. "repository"
  3494. ],
  3495. "summary": "Get an archive of a repository",
  3496. "operationId": "repoGetArchive",
  3497. "parameters": [
  3498. {
  3499. "type": "string",
  3500. "description": "owner of the repo",
  3501. "name": "owner",
  3502. "in": "path",
  3503. "required": true
  3504. },
  3505. {
  3506. "type": "string",
  3507. "description": "name of the repo",
  3508. "name": "repo",
  3509. "in": "path",
  3510. "required": true
  3511. },
  3512. {
  3513. "type": "string",
  3514. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  3515. "name": "archive",
  3516. "in": "path",
  3517. "required": true
  3518. }
  3519. ],
  3520. "responses": {
  3521. "200": {
  3522. "description": "success"
  3523. },
  3524. "404": {
  3525. "$ref": "#/responses/notFound"
  3526. }
  3527. }
  3528. }
  3529. },
  3530. "/repos/{owner}/{repo}/assignees": {
  3531. "get": {
  3532. "produces": [
  3533. "application/json"
  3534. ],
  3535. "tags": [
  3536. "repository"
  3537. ],
  3538. "summary": "Return all users that have write access and can be assigned to issues",
  3539. "operationId": "repoGetAssignees",
  3540. "parameters": [
  3541. {
  3542. "type": "string",
  3543. "description": "owner of the repo",
  3544. "name": "owner",
  3545. "in": "path",
  3546. "required": true
  3547. },
  3548. {
  3549. "type": "string",
  3550. "description": "name of the repo",
  3551. "name": "repo",
  3552. "in": "path",
  3553. "required": true
  3554. }
  3555. ],
  3556. "responses": {
  3557. "200": {
  3558. "$ref": "#/responses/UserList"
  3559. },
  3560. "404": {
  3561. "$ref": "#/responses/notFound"
  3562. }
  3563. }
  3564. }
  3565. },
  3566. "/repos/{owner}/{repo}/avatar": {
  3567. "post": {
  3568. "produces": [
  3569. "application/json"
  3570. ],
  3571. "tags": [
  3572. "repository"
  3573. ],
  3574. "summary": "Update avatar",
  3575. "operationId": "repoUpdateAvatar",
  3576. "parameters": [
  3577. {
  3578. "type": "string",
  3579. "description": "owner of the repo",
  3580. "name": "owner",
  3581. "in": "path",
  3582. "required": true
  3583. },
  3584. {
  3585. "type": "string",
  3586. "description": "name of the repo",
  3587. "name": "repo",
  3588. "in": "path",
  3589. "required": true
  3590. },
  3591. {
  3592. "name": "body",
  3593. "in": "body",
  3594. "schema": {
  3595. "$ref": "#/definitions/UpdateRepoAvatarOption"
  3596. }
  3597. }
  3598. ],
  3599. "responses": {
  3600. "204": {
  3601. "$ref": "#/responses/empty"
  3602. },
  3603. "404": {
  3604. "$ref": "#/responses/notFound"
  3605. }
  3606. }
  3607. },
  3608. "delete": {
  3609. "produces": [
  3610. "application/json"
  3611. ],
  3612. "tags": [
  3613. "repository"
  3614. ],
  3615. "summary": "Delete avatar",
  3616. "operationId": "repoDeleteAvatar",
  3617. "parameters": [
  3618. {
  3619. "type": "string",
  3620. "description": "owner of the repo",
  3621. "name": "owner",
  3622. "in": "path",
  3623. "required": true
  3624. },
  3625. {
  3626. "type": "string",
  3627. "description": "name of the repo",
  3628. "name": "repo",
  3629. "in": "path",
  3630. "required": true
  3631. }
  3632. ],
  3633. "responses": {
  3634. "204": {
  3635. "$ref": "#/responses/empty"
  3636. },
  3637. "404": {
  3638. "$ref": "#/responses/notFound"
  3639. }
  3640. }
  3641. }
  3642. },
  3643. "/repos/{owner}/{repo}/branch_protections": {
  3644. "get": {
  3645. "produces": [
  3646. "application/json"
  3647. ],
  3648. "tags": [
  3649. "repository"
  3650. ],
  3651. "summary": "List branch protections for a repository",
  3652. "operationId": "repoListBranchProtection",
  3653. "parameters": [
  3654. {
  3655. "type": "string",
  3656. "description": "owner of the repo",
  3657. "name": "owner",
  3658. "in": "path",
  3659. "required": true
  3660. },
  3661. {
  3662. "type": "string",
  3663. "description": "name of the repo",
  3664. "name": "repo",
  3665. "in": "path",
  3666. "required": true
  3667. }
  3668. ],
  3669. "responses": {
  3670. "200": {
  3671. "$ref": "#/responses/BranchProtectionList"
  3672. }
  3673. }
  3674. },
  3675. "post": {
  3676. "consumes": [
  3677. "application/json"
  3678. ],
  3679. "produces": [
  3680. "application/json"
  3681. ],
  3682. "tags": [
  3683. "repository"
  3684. ],
  3685. "summary": "Create a branch protections for a repository",
  3686. "operationId": "repoCreateBranchProtection",
  3687. "parameters": [
  3688. {
  3689. "type": "string",
  3690. "description": "owner of the repo",
  3691. "name": "owner",
  3692. "in": "path",
  3693. "required": true
  3694. },
  3695. {
  3696. "type": "string",
  3697. "description": "name of the repo",
  3698. "name": "repo",
  3699. "in": "path",
  3700. "required": true
  3701. },
  3702. {
  3703. "name": "body",
  3704. "in": "body",
  3705. "schema": {
  3706. "$ref": "#/definitions/CreateBranchProtectionOption"
  3707. }
  3708. }
  3709. ],
  3710. "responses": {
  3711. "201": {
  3712. "$ref": "#/responses/BranchProtection"
  3713. },
  3714. "403": {
  3715. "$ref": "#/responses/forbidden"
  3716. },
  3717. "404": {
  3718. "$ref": "#/responses/notFound"
  3719. },
  3720. "422": {
  3721. "$ref": "#/responses/validationError"
  3722. }
  3723. }
  3724. }
  3725. },
  3726. "/repos/{owner}/{repo}/branch_protections/{name}": {
  3727. "get": {
  3728. "produces": [
  3729. "application/json"
  3730. ],
  3731. "tags": [
  3732. "repository"
  3733. ],
  3734. "summary": "Get a specific branch protection for the repository",
  3735. "operationId": "repoGetBranchProtection",
  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. "description": "name of protected branch",
  3754. "name": "name",
  3755. "in": "path",
  3756. "required": true
  3757. }
  3758. ],
  3759. "responses": {
  3760. "200": {
  3761. "$ref": "#/responses/BranchProtection"
  3762. },
  3763. "404": {
  3764. "$ref": "#/responses/notFound"
  3765. }
  3766. }
  3767. },
  3768. "delete": {
  3769. "produces": [
  3770. "application/json"
  3771. ],
  3772. "tags": [
  3773. "repository"
  3774. ],
  3775. "summary": "Delete a specific branch protection for the repository",
  3776. "operationId": "repoDeleteBranchProtection",
  3777. "parameters": [
  3778. {
  3779. "type": "string",
  3780. "description": "owner of the repo",
  3781. "name": "owner",
  3782. "in": "path",
  3783. "required": true
  3784. },
  3785. {
  3786. "type": "string",
  3787. "description": "name of the repo",
  3788. "name": "repo",
  3789. "in": "path",
  3790. "required": true
  3791. },
  3792. {
  3793. "type": "string",
  3794. "description": "name of protected branch",
  3795. "name": "name",
  3796. "in": "path",
  3797. "required": true
  3798. }
  3799. ],
  3800. "responses": {
  3801. "204": {
  3802. "$ref": "#/responses/empty"
  3803. },
  3804. "404": {
  3805. "$ref": "#/responses/notFound"
  3806. }
  3807. }
  3808. },
  3809. "patch": {
  3810. "consumes": [
  3811. "application/json"
  3812. ],
  3813. "produces": [
  3814. "application/json"
  3815. ],
  3816. "tags": [
  3817. "repository"
  3818. ],
  3819. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  3820. "operationId": "repoEditBranchProtection",
  3821. "parameters": [
  3822. {
  3823. "type": "string",
  3824. "description": "owner of the repo",
  3825. "name": "owner",
  3826. "in": "path",
  3827. "required": true
  3828. },
  3829. {
  3830. "type": "string",
  3831. "description": "name of the repo",
  3832. "name": "repo",
  3833. "in": "path",
  3834. "required": true
  3835. },
  3836. {
  3837. "type": "string",
  3838. "description": "name of protected branch",
  3839. "name": "name",
  3840. "in": "path",
  3841. "required": true
  3842. },
  3843. {
  3844. "name": "body",
  3845. "in": "body",
  3846. "schema": {
  3847. "$ref": "#/definitions/EditBranchProtectionOption"
  3848. }
  3849. }
  3850. ],
  3851. "responses": {
  3852. "200": {
  3853. "$ref": "#/responses/BranchProtection"
  3854. },
  3855. "404": {
  3856. "$ref": "#/responses/notFound"
  3857. },
  3858. "422": {
  3859. "$ref": "#/responses/validationError"
  3860. }
  3861. }
  3862. }
  3863. },
  3864. "/repos/{owner}/{repo}/branches": {
  3865. "get": {
  3866. "produces": [
  3867. "application/json"
  3868. ],
  3869. "tags": [
  3870. "repository"
  3871. ],
  3872. "summary": "List a repository's branches",
  3873. "operationId": "repoListBranches",
  3874. "parameters": [
  3875. {
  3876. "type": "string",
  3877. "description": "owner of the repo",
  3878. "name": "owner",
  3879. "in": "path",
  3880. "required": true
  3881. },
  3882. {
  3883. "type": "string",
  3884. "description": "name of the repo",
  3885. "name": "repo",
  3886. "in": "path",
  3887. "required": true
  3888. },
  3889. {
  3890. "type": "integer",
  3891. "description": "page number of results to return (1-based)",
  3892. "name": "page",
  3893. "in": "query"
  3894. },
  3895. {
  3896. "type": "integer",
  3897. "description": "page size of results",
  3898. "name": "limit",
  3899. "in": "query"
  3900. }
  3901. ],
  3902. "responses": {
  3903. "200": {
  3904. "$ref": "#/responses/BranchList"
  3905. }
  3906. }
  3907. },
  3908. "post": {
  3909. "consumes": [
  3910. "application/json"
  3911. ],
  3912. "produces": [
  3913. "application/json"
  3914. ],
  3915. "tags": [
  3916. "repository"
  3917. ],
  3918. "summary": "Create a branch",
  3919. "operationId": "repoCreateBranch",
  3920. "parameters": [
  3921. {
  3922. "type": "string",
  3923. "description": "owner of the repo",
  3924. "name": "owner",
  3925. "in": "path",
  3926. "required": true
  3927. },
  3928. {
  3929. "type": "string",
  3930. "description": "name of the repo",
  3931. "name": "repo",
  3932. "in": "path",
  3933. "required": true
  3934. },
  3935. {
  3936. "name": "body",
  3937. "in": "body",
  3938. "schema": {
  3939. "$ref": "#/definitions/CreateBranchRepoOption"
  3940. }
  3941. }
  3942. ],
  3943. "responses": {
  3944. "201": {
  3945. "$ref": "#/responses/Branch"
  3946. },
  3947. "403": {
  3948. "description": "The branch is archived or a mirror."
  3949. },
  3950. "404": {
  3951. "description": "The old branch does not exist."
  3952. },
  3953. "409": {
  3954. "description": "The branch with the same name already exists."
  3955. }
  3956. }
  3957. }
  3958. },
  3959. "/repos/{owner}/{repo}/branches/{branch}": {
  3960. "get": {
  3961. "produces": [
  3962. "application/json"
  3963. ],
  3964. "tags": [
  3965. "repository"
  3966. ],
  3967. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  3968. "operationId": "repoGetBranch",
  3969. "parameters": [
  3970. {
  3971. "type": "string",
  3972. "description": "owner of the repo",
  3973. "name": "owner",
  3974. "in": "path",
  3975. "required": true
  3976. },
  3977. {
  3978. "type": "string",
  3979. "description": "name of the repo",
  3980. "name": "repo",
  3981. "in": "path",
  3982. "required": true
  3983. },
  3984. {
  3985. "type": "string",
  3986. "description": "branch to get",
  3987. "name": "branch",
  3988. "in": "path",
  3989. "required": true
  3990. }
  3991. ],
  3992. "responses": {
  3993. "200": {
  3994. "$ref": "#/responses/Branch"
  3995. },
  3996. "404": {
  3997. "$ref": "#/responses/notFound"
  3998. }
  3999. }
  4000. },
  4001. "delete": {
  4002. "produces": [
  4003. "application/json"
  4004. ],
  4005. "tags": [
  4006. "repository"
  4007. ],
  4008. "summary": "Delete a specific branch from a repository",
  4009. "operationId": "repoDeleteBranch",
  4010. "parameters": [
  4011. {
  4012. "type": "string",
  4013. "description": "owner of the repo",
  4014. "name": "owner",
  4015. "in": "path",
  4016. "required": true
  4017. },
  4018. {
  4019. "type": "string",
  4020. "description": "name of the repo",
  4021. "name": "repo",
  4022. "in": "path",
  4023. "required": true
  4024. },
  4025. {
  4026. "type": "string",
  4027. "description": "branch to delete",
  4028. "name": "branch",
  4029. "in": "path",
  4030. "required": true
  4031. }
  4032. ],
  4033. "responses": {
  4034. "204": {
  4035. "$ref": "#/responses/empty"
  4036. },
  4037. "403": {
  4038. "$ref": "#/responses/error"
  4039. },
  4040. "404": {
  4041. "$ref": "#/responses/notFound"
  4042. }
  4043. }
  4044. }
  4045. },
  4046. "/repos/{owner}/{repo}/collaborators": {
  4047. "get": {
  4048. "produces": [
  4049. "application/json"
  4050. ],
  4051. "tags": [
  4052. "repository"
  4053. ],
  4054. "summary": "List a repository's collaborators",
  4055. "operationId": "repoListCollaborators",
  4056. "parameters": [
  4057. {
  4058. "type": "string",
  4059. "description": "owner of the repo",
  4060. "name": "owner",
  4061. "in": "path",
  4062. "required": true
  4063. },
  4064. {
  4065. "type": "string",
  4066. "description": "name of the repo",
  4067. "name": "repo",
  4068. "in": "path",
  4069. "required": true
  4070. },
  4071. {
  4072. "type": "integer",
  4073. "description": "page number of results to return (1-based)",
  4074. "name": "page",
  4075. "in": "query"
  4076. },
  4077. {
  4078. "type": "integer",
  4079. "description": "page size of results",
  4080. "name": "limit",
  4081. "in": "query"
  4082. }
  4083. ],
  4084. "responses": {
  4085. "200": {
  4086. "$ref": "#/responses/UserList"
  4087. },
  4088. "404": {
  4089. "$ref": "#/responses/notFound"
  4090. }
  4091. }
  4092. }
  4093. },
  4094. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  4095. "get": {
  4096. "produces": [
  4097. "application/json"
  4098. ],
  4099. "tags": [
  4100. "repository"
  4101. ],
  4102. "summary": "Check if a user is a collaborator of a repository",
  4103. "operationId": "repoCheckCollaborator",
  4104. "parameters": [
  4105. {
  4106. "type": "string",
  4107. "description": "owner of the repo",
  4108. "name": "owner",
  4109. "in": "path",
  4110. "required": true
  4111. },
  4112. {
  4113. "type": "string",
  4114. "description": "name of the repo",
  4115. "name": "repo",
  4116. "in": "path",
  4117. "required": true
  4118. },
  4119. {
  4120. "type": "string",
  4121. "description": "username of the collaborator",
  4122. "name": "collaborator",
  4123. "in": "path",
  4124. "required": true
  4125. }
  4126. ],
  4127. "responses": {
  4128. "204": {
  4129. "$ref": "#/responses/empty"
  4130. },
  4131. "404": {
  4132. "$ref": "#/responses/notFound"
  4133. },
  4134. "422": {
  4135. "$ref": "#/responses/validationError"
  4136. }
  4137. }
  4138. },
  4139. "put": {
  4140. "produces": [
  4141. "application/json"
  4142. ],
  4143. "tags": [
  4144. "repository"
  4145. ],
  4146. "summary": "Add a collaborator to a repository",
  4147. "operationId": "repoAddCollaborator",
  4148. "parameters": [
  4149. {
  4150. "type": "string",
  4151. "description": "owner of the repo",
  4152. "name": "owner",
  4153. "in": "path",
  4154. "required": true
  4155. },
  4156. {
  4157. "type": "string",
  4158. "description": "name of the repo",
  4159. "name": "repo",
  4160. "in": "path",
  4161. "required": true
  4162. },
  4163. {
  4164. "type": "string",
  4165. "description": "username of the collaborator to add",
  4166. "name": "collaborator",
  4167. "in": "path",
  4168. "required": true
  4169. },
  4170. {
  4171. "name": "body",
  4172. "in": "body",
  4173. "schema": {
  4174. "$ref": "#/definitions/AddCollaboratorOption"
  4175. }
  4176. }
  4177. ],
  4178. "responses": {
  4179. "204": {
  4180. "$ref": "#/responses/empty"
  4181. },
  4182. "404": {
  4183. "$ref": "#/responses/notFound"
  4184. },
  4185. "422": {
  4186. "$ref": "#/responses/validationError"
  4187. }
  4188. }
  4189. },
  4190. "delete": {
  4191. "produces": [
  4192. "application/json"
  4193. ],
  4194. "tags": [
  4195. "repository"
  4196. ],
  4197. "summary": "Delete a collaborator from a repository",
  4198. "operationId": "repoDeleteCollaborator",
  4199. "parameters": [
  4200. {
  4201. "type": "string",
  4202. "description": "owner of the repo",
  4203. "name": "owner",
  4204. "in": "path",
  4205. "required": true
  4206. },
  4207. {
  4208. "type": "string",
  4209. "description": "name of the repo",
  4210. "name": "repo",
  4211. "in": "path",
  4212. "required": true
  4213. },
  4214. {
  4215. "type": "string",
  4216. "description": "username of the collaborator to delete",
  4217. "name": "collaborator",
  4218. "in": "path",
  4219. "required": true
  4220. }
  4221. ],
  4222. "responses": {
  4223. "204": {
  4224. "$ref": "#/responses/empty"
  4225. },
  4226. "404": {
  4227. "$ref": "#/responses/notFound"
  4228. },
  4229. "422": {
  4230. "$ref": "#/responses/validationError"
  4231. }
  4232. }
  4233. }
  4234. },
  4235. "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
  4236. "get": {
  4237. "produces": [
  4238. "application/json"
  4239. ],
  4240. "tags": [
  4241. "repository"
  4242. ],
  4243. "summary": "Get repository permissions for a user",
  4244. "operationId": "repoGetRepoPermissions",
  4245. "parameters": [
  4246. {
  4247. "type": "string",
  4248. "description": "owner of the repo",
  4249. "name": "owner",
  4250. "in": "path",
  4251. "required": true
  4252. },
  4253. {
  4254. "type": "string",
  4255. "description": "name of the repo",
  4256. "name": "repo",
  4257. "in": "path",
  4258. "required": true
  4259. },
  4260. {
  4261. "type": "string",
  4262. "description": "username of the collaborator",
  4263. "name": "collaborator",
  4264. "in": "path",
  4265. "required": true
  4266. }
  4267. ],
  4268. "responses": {
  4269. "200": {
  4270. "$ref": "#/responses/RepoCollaboratorPermission"
  4271. },
  4272. "403": {
  4273. "$ref": "#/responses/forbidden"
  4274. },
  4275. "404": {
  4276. "$ref": "#/responses/notFound"
  4277. }
  4278. }
  4279. }
  4280. },
  4281. "/repos/{owner}/{repo}/commits": {
  4282. "get": {
  4283. "produces": [
  4284. "application/json"
  4285. ],
  4286. "tags": [
  4287. "repository"
  4288. ],
  4289. "summary": "Get a list of all commits from a repository",
  4290. "operationId": "repoGetAllCommits",
  4291. "parameters": [
  4292. {
  4293. "type": "string",
  4294. "description": "owner of the repo",
  4295. "name": "owner",
  4296. "in": "path",
  4297. "required": true
  4298. },
  4299. {
  4300. "type": "string",
  4301. "description": "name of the repo",
  4302. "name": "repo",
  4303. "in": "path",
  4304. "required": true
  4305. },
  4306. {
  4307. "type": "string",
  4308. "description": "SHA or branch to start listing commits from (usually 'master')",
  4309. "name": "sha",
  4310. "in": "query"
  4311. },
  4312. {
  4313. "type": "string",
  4314. "description": "filepath of a file/dir",
  4315. "name": "path",
  4316. "in": "query"
  4317. },
  4318. {
  4319. "type": "boolean",
  4320. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  4321. "name": "stat",
  4322. "in": "query"
  4323. },
  4324. {
  4325. "type": "boolean",
  4326. "description": "include verification for every commit (disable for speedup, default 'true')",
  4327. "name": "verification",
  4328. "in": "query"
  4329. },
  4330. {
  4331. "type": "boolean",
  4332. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  4333. "name": "files",
  4334. "in": "query"
  4335. },
  4336. {
  4337. "type": "integer",
  4338. "description": "page number of results to return (1-based)",
  4339. "name": "page",
  4340. "in": "query"
  4341. },
  4342. {
  4343. "type": "integer",
  4344. "description": "page size of results (ignored if used with 'path')",
  4345. "name": "limit",
  4346. "in": "query"
  4347. },
  4348. {
  4349. "type": "string",
  4350. "description": "commits that match the given specifier will not be listed.",
  4351. "name": "not",
  4352. "in": "query"
  4353. }
  4354. ],
  4355. "responses": {
  4356. "200": {
  4357. "$ref": "#/responses/CommitList"
  4358. },
  4359. "404": {
  4360. "$ref": "#/responses/notFound"
  4361. },
  4362. "409": {
  4363. "$ref": "#/responses/EmptyRepository"
  4364. }
  4365. }
  4366. }
  4367. },
  4368. "/repos/{owner}/{repo}/commits/{ref}/status": {
  4369. "get": {
  4370. "produces": [
  4371. "application/json"
  4372. ],
  4373. "tags": [
  4374. "repository"
  4375. ],
  4376. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  4377. "operationId": "repoGetCombinedStatusByRef",
  4378. "parameters": [
  4379. {
  4380. "type": "string",
  4381. "description": "owner of the repo",
  4382. "name": "owner",
  4383. "in": "path",
  4384. "required": true
  4385. },
  4386. {
  4387. "type": "string",
  4388. "description": "name of the repo",
  4389. "name": "repo",
  4390. "in": "path",
  4391. "required": true
  4392. },
  4393. {
  4394. "type": "string",
  4395. "description": "name of branch/tag/commit",
  4396. "name": "ref",
  4397. "in": "path",
  4398. "required": true
  4399. },
  4400. {
  4401. "type": "integer",
  4402. "description": "page number of results to return (1-based)",
  4403. "name": "page",
  4404. "in": "query"
  4405. },
  4406. {
  4407. "type": "integer",
  4408. "description": "page size of results",
  4409. "name": "limit",
  4410. "in": "query"
  4411. }
  4412. ],
  4413. "responses": {
  4414. "200": {
  4415. "$ref": "#/responses/CombinedStatus"
  4416. },
  4417. "400": {
  4418. "$ref": "#/responses/error"
  4419. },
  4420. "404": {
  4421. "$ref": "#/responses/notFound"
  4422. }
  4423. }
  4424. }
  4425. },
  4426. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  4427. "get": {
  4428. "produces": [
  4429. "application/json"
  4430. ],
  4431. "tags": [
  4432. "repository"
  4433. ],
  4434. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  4435. "operationId": "repoListStatusesByRef",
  4436. "parameters": [
  4437. {
  4438. "type": "string",
  4439. "description": "owner of the repo",
  4440. "name": "owner",
  4441. "in": "path",
  4442. "required": true
  4443. },
  4444. {
  4445. "type": "string",
  4446. "description": "name of the repo",
  4447. "name": "repo",
  4448. "in": "path",
  4449. "required": true
  4450. },
  4451. {
  4452. "type": "string",
  4453. "description": "name of branch/tag/commit",
  4454. "name": "ref",
  4455. "in": "path",
  4456. "required": true
  4457. },
  4458. {
  4459. "enum": [
  4460. "oldest",
  4461. "recentupdate",
  4462. "leastupdate",
  4463. "leastindex",
  4464. "highestindex"
  4465. ],
  4466. "type": "string",
  4467. "description": "type of sort",
  4468. "name": "sort",
  4469. "in": "query"
  4470. },
  4471. {
  4472. "enum": [
  4473. "pending",
  4474. "success",
  4475. "error",
  4476. "failure",
  4477. "warning"
  4478. ],
  4479. "type": "string",
  4480. "description": "type of state",
  4481. "name": "state",
  4482. "in": "query"
  4483. },
  4484. {
  4485. "type": "integer",
  4486. "description": "page number of results to return (1-based)",
  4487. "name": "page",
  4488. "in": "query"
  4489. },
  4490. {
  4491. "type": "integer",
  4492. "description": "page size of results",
  4493. "name": "limit",
  4494. "in": "query"
  4495. }
  4496. ],
  4497. "responses": {
  4498. "200": {
  4499. "$ref": "#/responses/CommitStatusList"
  4500. },
  4501. "400": {
  4502. "$ref": "#/responses/error"
  4503. },
  4504. "404": {
  4505. "$ref": "#/responses/notFound"
  4506. }
  4507. }
  4508. }
  4509. },
  4510. "/repos/{owner}/{repo}/contents": {
  4511. "get": {
  4512. "produces": [
  4513. "application/json"
  4514. ],
  4515. "tags": [
  4516. "repository"
  4517. ],
  4518. "summary": "Gets the metadata of all the entries of the root dir",
  4519. "operationId": "repoGetContentsList",
  4520. "parameters": [
  4521. {
  4522. "type": "string",
  4523. "description": "owner of the repo",
  4524. "name": "owner",
  4525. "in": "path",
  4526. "required": true
  4527. },
  4528. {
  4529. "type": "string",
  4530. "description": "name of the repo",
  4531. "name": "repo",
  4532. "in": "path",
  4533. "required": true
  4534. },
  4535. {
  4536. "type": "string",
  4537. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4538. "name": "ref",
  4539. "in": "query"
  4540. }
  4541. ],
  4542. "responses": {
  4543. "200": {
  4544. "$ref": "#/responses/ContentsListResponse"
  4545. },
  4546. "404": {
  4547. "$ref": "#/responses/notFound"
  4548. }
  4549. }
  4550. },
  4551. "post": {
  4552. "consumes": [
  4553. "application/json"
  4554. ],
  4555. "produces": [
  4556. "application/json"
  4557. ],
  4558. "tags": [
  4559. "repository"
  4560. ],
  4561. "summary": "Modify multiple files in a repository",
  4562. "operationId": "repoChangeFiles",
  4563. "parameters": [
  4564. {
  4565. "type": "string",
  4566. "description": "owner of the repo",
  4567. "name": "owner",
  4568. "in": "path",
  4569. "required": true
  4570. },
  4571. {
  4572. "type": "string",
  4573. "description": "name of the repo",
  4574. "name": "repo",
  4575. "in": "path",
  4576. "required": true
  4577. },
  4578. {
  4579. "name": "body",
  4580. "in": "body",
  4581. "required": true,
  4582. "schema": {
  4583. "$ref": "#/definitions/ChangeFilesOptions"
  4584. }
  4585. }
  4586. ],
  4587. "responses": {
  4588. "201": {
  4589. "$ref": "#/responses/FilesResponse"
  4590. },
  4591. "403": {
  4592. "$ref": "#/responses/error"
  4593. },
  4594. "404": {
  4595. "$ref": "#/responses/notFound"
  4596. },
  4597. "422": {
  4598. "$ref": "#/responses/error"
  4599. }
  4600. }
  4601. }
  4602. },
  4603. "/repos/{owner}/{repo}/contents/{filepath}": {
  4604. "get": {
  4605. "produces": [
  4606. "application/json"
  4607. ],
  4608. "tags": [
  4609. "repository"
  4610. ],
  4611. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  4612. "operationId": "repoGetContents",
  4613. "parameters": [
  4614. {
  4615. "type": "string",
  4616. "description": "owner of the repo",
  4617. "name": "owner",
  4618. "in": "path",
  4619. "required": true
  4620. },
  4621. {
  4622. "type": "string",
  4623. "description": "name of the repo",
  4624. "name": "repo",
  4625. "in": "path",
  4626. "required": true
  4627. },
  4628. {
  4629. "type": "string",
  4630. "description": "path of the dir, file, symlink or submodule in the repo",
  4631. "name": "filepath",
  4632. "in": "path",
  4633. "required": true
  4634. },
  4635. {
  4636. "type": "string",
  4637. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4638. "name": "ref",
  4639. "in": "query"
  4640. }
  4641. ],
  4642. "responses": {
  4643. "200": {
  4644. "$ref": "#/responses/ContentsResponse"
  4645. },
  4646. "404": {
  4647. "$ref": "#/responses/notFound"
  4648. }
  4649. }
  4650. },
  4651. "put": {
  4652. "consumes": [
  4653. "application/json"
  4654. ],
  4655. "produces": [
  4656. "application/json"
  4657. ],
  4658. "tags": [
  4659. "repository"
  4660. ],
  4661. "summary": "Update a file in a repository",
  4662. "operationId": "repoUpdateFile",
  4663. "parameters": [
  4664. {
  4665. "type": "string",
  4666. "description": "owner of the repo",
  4667. "name": "owner",
  4668. "in": "path",
  4669. "required": true
  4670. },
  4671. {
  4672. "type": "string",
  4673. "description": "name of the repo",
  4674. "name": "repo",
  4675. "in": "path",
  4676. "required": true
  4677. },
  4678. {
  4679. "type": "string",
  4680. "description": "path of the file to update",
  4681. "name": "filepath",
  4682. "in": "path",
  4683. "required": true
  4684. },
  4685. {
  4686. "name": "body",
  4687. "in": "body",
  4688. "required": true,
  4689. "schema": {
  4690. "$ref": "#/definitions/UpdateFileOptions"
  4691. }
  4692. }
  4693. ],
  4694. "responses": {
  4695. "200": {
  4696. "$ref": "#/responses/FileResponse"
  4697. },
  4698. "403": {
  4699. "$ref": "#/responses/error"
  4700. },
  4701. "404": {
  4702. "$ref": "#/responses/notFound"
  4703. },
  4704. "422": {
  4705. "$ref": "#/responses/error"
  4706. }
  4707. }
  4708. },
  4709. "post": {
  4710. "consumes": [
  4711. "application/json"
  4712. ],
  4713. "produces": [
  4714. "application/json"
  4715. ],
  4716. "tags": [
  4717. "repository"
  4718. ],
  4719. "summary": "Create a file in a repository",
  4720. "operationId": "repoCreateFile",
  4721. "parameters": [
  4722. {
  4723. "type": "string",
  4724. "description": "owner of the repo",
  4725. "name": "owner",
  4726. "in": "path",
  4727. "required": true
  4728. },
  4729. {
  4730. "type": "string",
  4731. "description": "name of the repo",
  4732. "name": "repo",
  4733. "in": "path",
  4734. "required": true
  4735. },
  4736. {
  4737. "type": "string",
  4738. "description": "path of the file to create",
  4739. "name": "filepath",
  4740. "in": "path",
  4741. "required": true
  4742. },
  4743. {
  4744. "name": "body",
  4745. "in": "body",
  4746. "required": true,
  4747. "schema": {
  4748. "$ref": "#/definitions/CreateFileOptions"
  4749. }
  4750. }
  4751. ],
  4752. "responses": {
  4753. "201": {
  4754. "$ref": "#/responses/FileResponse"
  4755. },
  4756. "403": {
  4757. "$ref": "#/responses/error"
  4758. },
  4759. "404": {
  4760. "$ref": "#/responses/notFound"
  4761. },
  4762. "422": {
  4763. "$ref": "#/responses/error"
  4764. }
  4765. }
  4766. },
  4767. "delete": {
  4768. "consumes": [
  4769. "application/json"
  4770. ],
  4771. "produces": [
  4772. "application/json"
  4773. ],
  4774. "tags": [
  4775. "repository"
  4776. ],
  4777. "summary": "Delete a file in a repository",
  4778. "operationId": "repoDeleteFile",
  4779. "parameters": [
  4780. {
  4781. "type": "string",
  4782. "description": "owner of the repo",
  4783. "name": "owner",
  4784. "in": "path",
  4785. "required": true
  4786. },
  4787. {
  4788. "type": "string",
  4789. "description": "name of the repo",
  4790. "name": "repo",
  4791. "in": "path",
  4792. "required": true
  4793. },
  4794. {
  4795. "type": "string",
  4796. "description": "path of the file to delete",
  4797. "name": "filepath",
  4798. "in": "path",
  4799. "required": true
  4800. },
  4801. {
  4802. "name": "body",
  4803. "in": "body",
  4804. "required": true,
  4805. "schema": {
  4806. "$ref": "#/definitions/DeleteFileOptions"
  4807. }
  4808. }
  4809. ],
  4810. "responses": {
  4811. "200": {
  4812. "$ref": "#/responses/FileDeleteResponse"
  4813. },
  4814. "400": {
  4815. "$ref": "#/responses/error"
  4816. },
  4817. "403": {
  4818. "$ref": "#/responses/error"
  4819. },
  4820. "404": {
  4821. "$ref": "#/responses/error"
  4822. }
  4823. }
  4824. }
  4825. },
  4826. "/repos/{owner}/{repo}/diffpatch": {
  4827. "post": {
  4828. "consumes": [
  4829. "application/json"
  4830. ],
  4831. "produces": [
  4832. "application/json"
  4833. ],
  4834. "tags": [
  4835. "repository"
  4836. ],
  4837. "summary": "Apply diff patch to repository",
  4838. "operationId": "repoApplyDiffPatch",
  4839. "parameters": [
  4840. {
  4841. "type": "string",
  4842. "description": "owner of the repo",
  4843. "name": "owner",
  4844. "in": "path",
  4845. "required": true
  4846. },
  4847. {
  4848. "type": "string",
  4849. "description": "name of the repo",
  4850. "name": "repo",
  4851. "in": "path",
  4852. "required": true
  4853. },
  4854. {
  4855. "name": "body",
  4856. "in": "body",
  4857. "required": true,
  4858. "schema": {
  4859. "$ref": "#/definitions/UpdateFileOptions"
  4860. }
  4861. }
  4862. ],
  4863. "responses": {
  4864. "200": {
  4865. "$ref": "#/responses/FileResponse"
  4866. },
  4867. "404": {
  4868. "$ref": "#/responses/notFound"
  4869. }
  4870. }
  4871. }
  4872. },
  4873. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  4874. "get": {
  4875. "produces": [
  4876. "application/json"
  4877. ],
  4878. "tags": [
  4879. "repository"
  4880. ],
  4881. "summary": "Get the EditorConfig definitions of a file in a repository",
  4882. "operationId": "repoGetEditorConfig",
  4883. "parameters": [
  4884. {
  4885. "type": "string",
  4886. "description": "owner of the repo",
  4887. "name": "owner",
  4888. "in": "path",
  4889. "required": true
  4890. },
  4891. {
  4892. "type": "string",
  4893. "description": "name of the repo",
  4894. "name": "repo",
  4895. "in": "path",
  4896. "required": true
  4897. },
  4898. {
  4899. "type": "string",
  4900. "description": "filepath of file to get",
  4901. "name": "filepath",
  4902. "in": "path",
  4903. "required": true
  4904. },
  4905. {
  4906. "type": "string",
  4907. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4908. "name": "ref",
  4909. "in": "query"
  4910. }
  4911. ],
  4912. "responses": {
  4913. "200": {
  4914. "description": "success"
  4915. },
  4916. "404": {
  4917. "$ref": "#/responses/notFound"
  4918. }
  4919. }
  4920. }
  4921. },
  4922. "/repos/{owner}/{repo}/forks": {
  4923. "get": {
  4924. "produces": [
  4925. "application/json"
  4926. ],
  4927. "tags": [
  4928. "repository"
  4929. ],
  4930. "summary": "List a repository's forks",
  4931. "operationId": "listForks",
  4932. "parameters": [
  4933. {
  4934. "type": "string",
  4935. "description": "owner of the repo",
  4936. "name": "owner",
  4937. "in": "path",
  4938. "required": true
  4939. },
  4940. {
  4941. "type": "string",
  4942. "description": "name of the repo",
  4943. "name": "repo",
  4944. "in": "path",
  4945. "required": true
  4946. },
  4947. {
  4948. "type": "integer",
  4949. "description": "page number of results to return (1-based)",
  4950. "name": "page",
  4951. "in": "query"
  4952. },
  4953. {
  4954. "type": "integer",
  4955. "description": "page size of results",
  4956. "name": "limit",
  4957. "in": "query"
  4958. }
  4959. ],
  4960. "responses": {
  4961. "200": {
  4962. "$ref": "#/responses/RepositoryList"
  4963. },
  4964. "404": {
  4965. "$ref": "#/responses/notFound"
  4966. }
  4967. }
  4968. },
  4969. "post": {
  4970. "produces": [
  4971. "application/json"
  4972. ],
  4973. "tags": [
  4974. "repository"
  4975. ],
  4976. "summary": "Fork a repository",
  4977. "operationId": "createFork",
  4978. "parameters": [
  4979. {
  4980. "type": "string",
  4981. "description": "owner of the repo to fork",
  4982. "name": "owner",
  4983. "in": "path",
  4984. "required": true
  4985. },
  4986. {
  4987. "type": "string",
  4988. "description": "name of the repo to fork",
  4989. "name": "repo",
  4990. "in": "path",
  4991. "required": true
  4992. },
  4993. {
  4994. "name": "body",
  4995. "in": "body",
  4996. "schema": {
  4997. "$ref": "#/definitions/CreateForkOption"
  4998. }
  4999. }
  5000. ],
  5001. "responses": {
  5002. "202": {
  5003. "$ref": "#/responses/Repository"
  5004. },
  5005. "403": {
  5006. "$ref": "#/responses/forbidden"
  5007. },
  5008. "404": {
  5009. "$ref": "#/responses/notFound"
  5010. },
  5011. "409": {
  5012. "description": "The repository with the same name already exists."
  5013. },
  5014. "422": {
  5015. "$ref": "#/responses/validationError"
  5016. }
  5017. }
  5018. }
  5019. },
  5020. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  5021. "get": {
  5022. "produces": [
  5023. "application/json"
  5024. ],
  5025. "tags": [
  5026. "repository"
  5027. ],
  5028. "summary": "Gets the blob of a repository.",
  5029. "operationId": "GetBlob",
  5030. "parameters": [
  5031. {
  5032. "type": "string",
  5033. "description": "owner of the repo",
  5034. "name": "owner",
  5035. "in": "path",
  5036. "required": true
  5037. },
  5038. {
  5039. "type": "string",
  5040. "description": "name of the repo",
  5041. "name": "repo",
  5042. "in": "path",
  5043. "required": true
  5044. },
  5045. {
  5046. "type": "string",
  5047. "description": "sha of the commit",
  5048. "name": "sha",
  5049. "in": "path",
  5050. "required": true
  5051. }
  5052. ],
  5053. "responses": {
  5054. "200": {
  5055. "$ref": "#/responses/GitBlobResponse"
  5056. },
  5057. "400": {
  5058. "$ref": "#/responses/error"
  5059. },
  5060. "404": {
  5061. "$ref": "#/responses/notFound"
  5062. }
  5063. }
  5064. }
  5065. },
  5066. "/repos/{owner}/{repo}/git/commits/{sha}": {
  5067. "get": {
  5068. "produces": [
  5069. "application/json"
  5070. ],
  5071. "tags": [
  5072. "repository"
  5073. ],
  5074. "summary": "Get a single commit from a repository",
  5075. "operationId": "repoGetSingleCommit",
  5076. "parameters": [
  5077. {
  5078. "type": "string",
  5079. "description": "owner of the repo",
  5080. "name": "owner",
  5081. "in": "path",
  5082. "required": true
  5083. },
  5084. {
  5085. "type": "string",
  5086. "description": "name of the repo",
  5087. "name": "repo",
  5088. "in": "path",
  5089. "required": true
  5090. },
  5091. {
  5092. "type": "string",
  5093. "description": "a git ref or commit sha",
  5094. "name": "sha",
  5095. "in": "path",
  5096. "required": true
  5097. },
  5098. {
  5099. "type": "boolean",
  5100. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  5101. "name": "stat",
  5102. "in": "query"
  5103. },
  5104. {
  5105. "type": "boolean",
  5106. "description": "include verification for every commit (disable for speedup, default 'true')",
  5107. "name": "verification",
  5108. "in": "query"
  5109. },
  5110. {
  5111. "type": "boolean",
  5112. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5113. "name": "files",
  5114. "in": "query"
  5115. }
  5116. ],
  5117. "responses": {
  5118. "200": {
  5119. "$ref": "#/responses/Commit"
  5120. },
  5121. "404": {
  5122. "$ref": "#/responses/notFound"
  5123. },
  5124. "422": {
  5125. "$ref": "#/responses/validationError"
  5126. }
  5127. }
  5128. }
  5129. },
  5130. "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
  5131. "get": {
  5132. "produces": [
  5133. "text/plain"
  5134. ],
  5135. "tags": [
  5136. "repository"
  5137. ],
  5138. "summary": "Get a commit's diff or patch",
  5139. "operationId": "repoDownloadCommitDiffOrPatch",
  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": "SHA of the commit to get",
  5158. "name": "sha",
  5159. "in": "path",
  5160. "required": true
  5161. },
  5162. {
  5163. "enum": [
  5164. "diff",
  5165. "patch"
  5166. ],
  5167. "type": "string",
  5168. "description": "whether the output is diff or patch",
  5169. "name": "diffType",
  5170. "in": "path",
  5171. "required": true
  5172. }
  5173. ],
  5174. "responses": {
  5175. "200": {
  5176. "$ref": "#/responses/string"
  5177. },
  5178. "404": {
  5179. "$ref": "#/responses/notFound"
  5180. }
  5181. }
  5182. }
  5183. },
  5184. "/repos/{owner}/{repo}/git/notes/{sha}": {
  5185. "get": {
  5186. "produces": [
  5187. "application/json"
  5188. ],
  5189. "tags": [
  5190. "repository"
  5191. ],
  5192. "summary": "Get a note corresponding to a single commit from a repository",
  5193. "operationId": "repoGetNote",
  5194. "parameters": [
  5195. {
  5196. "type": "string",
  5197. "description": "owner of the repo",
  5198. "name": "owner",
  5199. "in": "path",
  5200. "required": true
  5201. },
  5202. {
  5203. "type": "string",
  5204. "description": "name of the repo",
  5205. "name": "repo",
  5206. "in": "path",
  5207. "required": true
  5208. },
  5209. {
  5210. "type": "string",
  5211. "description": "a git ref or commit sha",
  5212. "name": "sha",
  5213. "in": "path",
  5214. "required": true
  5215. },
  5216. {
  5217. "type": "boolean",
  5218. "description": "include verification for every commit (disable for speedup, default 'true')",
  5219. "name": "verification",
  5220. "in": "query"
  5221. },
  5222. {
  5223. "type": "boolean",
  5224. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5225. "name": "files",
  5226. "in": "query"
  5227. }
  5228. ],
  5229. "responses": {
  5230. "200": {
  5231. "$ref": "#/responses/Note"
  5232. },
  5233. "404": {
  5234. "$ref": "#/responses/notFound"
  5235. },
  5236. "422": {
  5237. "$ref": "#/responses/validationError"
  5238. }
  5239. }
  5240. }
  5241. },
  5242. "/repos/{owner}/{repo}/git/refs": {
  5243. "get": {
  5244. "produces": [
  5245. "application/json"
  5246. ],
  5247. "tags": [
  5248. "repository"
  5249. ],
  5250. "summary": "Get specified ref or filtered repository's refs",
  5251. "operationId": "repoListAllGitRefs",
  5252. "parameters": [
  5253. {
  5254. "type": "string",
  5255. "description": "owner of the repo",
  5256. "name": "owner",
  5257. "in": "path",
  5258. "required": true
  5259. },
  5260. {
  5261. "type": "string",
  5262. "description": "name of the repo",
  5263. "name": "repo",
  5264. "in": "path",
  5265. "required": true
  5266. }
  5267. ],
  5268. "responses": {
  5269. "200": {
  5270. "$ref": "#/responses/ReferenceList"
  5271. },
  5272. "404": {
  5273. "$ref": "#/responses/notFound"
  5274. }
  5275. }
  5276. }
  5277. },
  5278. "/repos/{owner}/{repo}/git/refs/{ref}": {
  5279. "get": {
  5280. "produces": [
  5281. "application/json"
  5282. ],
  5283. "tags": [
  5284. "repository"
  5285. ],
  5286. "summary": "Get specified ref or filtered repository's refs",
  5287. "operationId": "repoListGitRefs",
  5288. "parameters": [
  5289. {
  5290. "type": "string",
  5291. "description": "owner of the repo",
  5292. "name": "owner",
  5293. "in": "path",
  5294. "required": true
  5295. },
  5296. {
  5297. "type": "string",
  5298. "description": "name of the repo",
  5299. "name": "repo",
  5300. "in": "path",
  5301. "required": true
  5302. },
  5303. {
  5304. "type": "string",
  5305. "description": "part or full name of the ref",
  5306. "name": "ref",
  5307. "in": "path",
  5308. "required": true
  5309. }
  5310. ],
  5311. "responses": {
  5312. "200": {
  5313. "$ref": "#/responses/ReferenceList"
  5314. },
  5315. "404": {
  5316. "$ref": "#/responses/notFound"
  5317. }
  5318. }
  5319. }
  5320. },
  5321. "/repos/{owner}/{repo}/git/tags/{sha}": {
  5322. "get": {
  5323. "produces": [
  5324. "application/json"
  5325. ],
  5326. "tags": [
  5327. "repository"
  5328. ],
  5329. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  5330. "operationId": "GetAnnotatedTag",
  5331. "parameters": [
  5332. {
  5333. "type": "string",
  5334. "description": "owner of the repo",
  5335. "name": "owner",
  5336. "in": "path",
  5337. "required": true
  5338. },
  5339. {
  5340. "type": "string",
  5341. "description": "name of the repo",
  5342. "name": "repo",
  5343. "in": "path",
  5344. "required": true
  5345. },
  5346. {
  5347. "type": "string",
  5348. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  5349. "name": "sha",
  5350. "in": "path",
  5351. "required": true
  5352. }
  5353. ],
  5354. "responses": {
  5355. "200": {
  5356. "$ref": "#/responses/AnnotatedTag"
  5357. },
  5358. "400": {
  5359. "$ref": "#/responses/error"
  5360. },
  5361. "404": {
  5362. "$ref": "#/responses/notFound"
  5363. }
  5364. }
  5365. }
  5366. },
  5367. "/repos/{owner}/{repo}/git/trees/{sha}": {
  5368. "get": {
  5369. "produces": [
  5370. "application/json"
  5371. ],
  5372. "tags": [
  5373. "repository"
  5374. ],
  5375. "summary": "Gets the tree of a repository.",
  5376. "operationId": "GetTree",
  5377. "parameters": [
  5378. {
  5379. "type": "string",
  5380. "description": "owner of the repo",
  5381. "name": "owner",
  5382. "in": "path",
  5383. "required": true
  5384. },
  5385. {
  5386. "type": "string",
  5387. "description": "name of the repo",
  5388. "name": "repo",
  5389. "in": "path",
  5390. "required": true
  5391. },
  5392. {
  5393. "type": "string",
  5394. "description": "sha of the commit",
  5395. "name": "sha",
  5396. "in": "path",
  5397. "required": true
  5398. },
  5399. {
  5400. "type": "boolean",
  5401. "description": "show all directories and files",
  5402. "name": "recursive",
  5403. "in": "query"
  5404. },
  5405. {
  5406. "type": "integer",
  5407. "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",
  5408. "name": "page",
  5409. "in": "query"
  5410. },
  5411. {
  5412. "type": "integer",
  5413. "description": "number of items per page",
  5414. "name": "per_page",
  5415. "in": "query"
  5416. }
  5417. ],
  5418. "responses": {
  5419. "200": {
  5420. "$ref": "#/responses/GitTreeResponse"
  5421. },
  5422. "400": {
  5423. "$ref": "#/responses/error"
  5424. },
  5425. "404": {
  5426. "$ref": "#/responses/notFound"
  5427. }
  5428. }
  5429. }
  5430. },
  5431. "/repos/{owner}/{repo}/hooks": {
  5432. "get": {
  5433. "produces": [
  5434. "application/json"
  5435. ],
  5436. "tags": [
  5437. "repository"
  5438. ],
  5439. "summary": "List the hooks in a repository",
  5440. "operationId": "repoListHooks",
  5441. "parameters": [
  5442. {
  5443. "type": "string",
  5444. "description": "owner of the repo",
  5445. "name": "owner",
  5446. "in": "path",
  5447. "required": true
  5448. },
  5449. {
  5450. "type": "string",
  5451. "description": "name of the repo",
  5452. "name": "repo",
  5453. "in": "path",
  5454. "required": true
  5455. },
  5456. {
  5457. "type": "integer",
  5458. "description": "page number of results to return (1-based)",
  5459. "name": "page",
  5460. "in": "query"
  5461. },
  5462. {
  5463. "type": "integer",
  5464. "description": "page size of results",
  5465. "name": "limit",
  5466. "in": "query"
  5467. }
  5468. ],
  5469. "responses": {
  5470. "200": {
  5471. "$ref": "#/responses/HookList"
  5472. },
  5473. "404": {
  5474. "$ref": "#/responses/notFound"
  5475. }
  5476. }
  5477. },
  5478. "post": {
  5479. "consumes": [
  5480. "application/json"
  5481. ],
  5482. "produces": [
  5483. "application/json"
  5484. ],
  5485. "tags": [
  5486. "repository"
  5487. ],
  5488. "summary": "Create a hook",
  5489. "operationId": "repoCreateHook",
  5490. "parameters": [
  5491. {
  5492. "type": "string",
  5493. "description": "owner of the repo",
  5494. "name": "owner",
  5495. "in": "path",
  5496. "required": true
  5497. },
  5498. {
  5499. "type": "string",
  5500. "description": "name of the repo",
  5501. "name": "repo",
  5502. "in": "path",
  5503. "required": true
  5504. },
  5505. {
  5506. "name": "body",
  5507. "in": "body",
  5508. "schema": {
  5509. "$ref": "#/definitions/CreateHookOption"
  5510. }
  5511. }
  5512. ],
  5513. "responses": {
  5514. "201": {
  5515. "$ref": "#/responses/Hook"
  5516. },
  5517. "404": {
  5518. "$ref": "#/responses/notFound"
  5519. }
  5520. }
  5521. }
  5522. },
  5523. "/repos/{owner}/{repo}/hooks/git": {
  5524. "get": {
  5525. "produces": [
  5526. "application/json"
  5527. ],
  5528. "tags": [
  5529. "repository"
  5530. ],
  5531. "summary": "List the Git hooks in a repository",
  5532. "operationId": "repoListGitHooks",
  5533. "parameters": [
  5534. {
  5535. "type": "string",
  5536. "description": "owner of the repo",
  5537. "name": "owner",
  5538. "in": "path",
  5539. "required": true
  5540. },
  5541. {
  5542. "type": "string",
  5543. "description": "name of the repo",
  5544. "name": "repo",
  5545. "in": "path",
  5546. "required": true
  5547. }
  5548. ],
  5549. "responses": {
  5550. "200": {
  5551. "$ref": "#/responses/GitHookList"
  5552. },
  5553. "404": {
  5554. "$ref": "#/responses/notFound"
  5555. }
  5556. }
  5557. }
  5558. },
  5559. "/repos/{owner}/{repo}/hooks/git/{id}": {
  5560. "get": {
  5561. "produces": [
  5562. "application/json"
  5563. ],
  5564. "tags": [
  5565. "repository"
  5566. ],
  5567. "summary": "Get a Git hook",
  5568. "operationId": "repoGetGitHook",
  5569. "parameters": [
  5570. {
  5571. "type": "string",
  5572. "description": "owner of the repo",
  5573. "name": "owner",
  5574. "in": "path",
  5575. "required": true
  5576. },
  5577. {
  5578. "type": "string",
  5579. "description": "name of the repo",
  5580. "name": "repo",
  5581. "in": "path",
  5582. "required": true
  5583. },
  5584. {
  5585. "type": "string",
  5586. "description": "id of the hook to get",
  5587. "name": "id",
  5588. "in": "path",
  5589. "required": true
  5590. }
  5591. ],
  5592. "responses": {
  5593. "200": {
  5594. "$ref": "#/responses/GitHook"
  5595. },
  5596. "404": {
  5597. "$ref": "#/responses/notFound"
  5598. }
  5599. }
  5600. },
  5601. "delete": {
  5602. "produces": [
  5603. "application/json"
  5604. ],
  5605. "tags": [
  5606. "repository"
  5607. ],
  5608. "summary": "Delete a Git hook in a repository",
  5609. "operationId": "repoDeleteGitHook",
  5610. "parameters": [
  5611. {
  5612. "type": "string",
  5613. "description": "owner of the repo",
  5614. "name": "owner",
  5615. "in": "path",
  5616. "required": true
  5617. },
  5618. {
  5619. "type": "string",
  5620. "description": "name of the repo",
  5621. "name": "repo",
  5622. "in": "path",
  5623. "required": true
  5624. },
  5625. {
  5626. "type": "string",
  5627. "description": "id of the hook to get",
  5628. "name": "id",
  5629. "in": "path",
  5630. "required": true
  5631. }
  5632. ],
  5633. "responses": {
  5634. "204": {
  5635. "$ref": "#/responses/empty"
  5636. },
  5637. "404": {
  5638. "$ref": "#/responses/notFound"
  5639. }
  5640. }
  5641. },
  5642. "patch": {
  5643. "produces": [
  5644. "application/json"
  5645. ],
  5646. "tags": [
  5647. "repository"
  5648. ],
  5649. "summary": "Edit a Git hook in a repository",
  5650. "operationId": "repoEditGitHook",
  5651. "parameters": [
  5652. {
  5653. "type": "string",
  5654. "description": "owner of the repo",
  5655. "name": "owner",
  5656. "in": "path",
  5657. "required": true
  5658. },
  5659. {
  5660. "type": "string",
  5661. "description": "name of the repo",
  5662. "name": "repo",
  5663. "in": "path",
  5664. "required": true
  5665. },
  5666. {
  5667. "type": "string",
  5668. "description": "id of the hook to get",
  5669. "name": "id",
  5670. "in": "path",
  5671. "required": true
  5672. },
  5673. {
  5674. "name": "body",
  5675. "in": "body",
  5676. "schema": {
  5677. "$ref": "#/definitions/EditGitHookOption"
  5678. }
  5679. }
  5680. ],
  5681. "responses": {
  5682. "200": {
  5683. "$ref": "#/responses/GitHook"
  5684. },
  5685. "404": {
  5686. "$ref": "#/responses/notFound"
  5687. }
  5688. }
  5689. }
  5690. },
  5691. "/repos/{owner}/{repo}/hooks/{id}": {
  5692. "get": {
  5693. "produces": [
  5694. "application/json"
  5695. ],
  5696. "tags": [
  5697. "repository"
  5698. ],
  5699. "summary": "Get a hook",
  5700. "operationId": "repoGetHook",
  5701. "parameters": [
  5702. {
  5703. "type": "string",
  5704. "description": "owner of the repo",
  5705. "name": "owner",
  5706. "in": "path",
  5707. "required": true
  5708. },
  5709. {
  5710. "type": "string",
  5711. "description": "name of the repo",
  5712. "name": "repo",
  5713. "in": "path",
  5714. "required": true
  5715. },
  5716. {
  5717. "type": "integer",
  5718. "format": "int64",
  5719. "description": "id of the hook to get",
  5720. "name": "id",
  5721. "in": "path",
  5722. "required": true
  5723. }
  5724. ],
  5725. "responses": {
  5726. "200": {
  5727. "$ref": "#/responses/Hook"
  5728. },
  5729. "404": {
  5730. "$ref": "#/responses/notFound"
  5731. }
  5732. }
  5733. },
  5734. "delete": {
  5735. "produces": [
  5736. "application/json"
  5737. ],
  5738. "tags": [
  5739. "repository"
  5740. ],
  5741. "summary": "Delete a hook in a repository",
  5742. "operationId": "repoDeleteHook",
  5743. "parameters": [
  5744. {
  5745. "type": "string",
  5746. "description": "owner of the repo",
  5747. "name": "owner",
  5748. "in": "path",
  5749. "required": true
  5750. },
  5751. {
  5752. "type": "string",
  5753. "description": "name of the repo",
  5754. "name": "repo",
  5755. "in": "path",
  5756. "required": true
  5757. },
  5758. {
  5759. "type": "integer",
  5760. "format": "int64",
  5761. "description": "id of the hook to delete",
  5762. "name": "id",
  5763. "in": "path",
  5764. "required": true
  5765. }
  5766. ],
  5767. "responses": {
  5768. "204": {
  5769. "$ref": "#/responses/empty"
  5770. },
  5771. "404": {
  5772. "$ref": "#/responses/notFound"
  5773. }
  5774. }
  5775. },
  5776. "patch": {
  5777. "produces": [
  5778. "application/json"
  5779. ],
  5780. "tags": [
  5781. "repository"
  5782. ],
  5783. "summary": "Edit a hook in a repository",
  5784. "operationId": "repoEditHook",
  5785. "parameters": [
  5786. {
  5787. "type": "string",
  5788. "description": "owner of the repo",
  5789. "name": "owner",
  5790. "in": "path",
  5791. "required": true
  5792. },
  5793. {
  5794. "type": "string",
  5795. "description": "name of the repo",
  5796. "name": "repo",
  5797. "in": "path",
  5798. "required": true
  5799. },
  5800. {
  5801. "type": "integer",
  5802. "format": "int64",
  5803. "description": "index of the hook",
  5804. "name": "id",
  5805. "in": "path",
  5806. "required": true
  5807. },
  5808. {
  5809. "name": "body",
  5810. "in": "body",
  5811. "schema": {
  5812. "$ref": "#/definitions/EditHookOption"
  5813. }
  5814. }
  5815. ],
  5816. "responses": {
  5817. "200": {
  5818. "$ref": "#/responses/Hook"
  5819. },
  5820. "404": {
  5821. "$ref": "#/responses/notFound"
  5822. }
  5823. }
  5824. }
  5825. },
  5826. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  5827. "post": {
  5828. "produces": [
  5829. "application/json"
  5830. ],
  5831. "tags": [
  5832. "repository"
  5833. ],
  5834. "summary": "Test a push webhook",
  5835. "operationId": "repoTestHook",
  5836. "parameters": [
  5837. {
  5838. "type": "string",
  5839. "description": "owner of the repo",
  5840. "name": "owner",
  5841. "in": "path",
  5842. "required": true
  5843. },
  5844. {
  5845. "type": "string",
  5846. "description": "name of the repo",
  5847. "name": "repo",
  5848. "in": "path",
  5849. "required": true
  5850. },
  5851. {
  5852. "type": "integer",
  5853. "format": "int64",
  5854. "description": "id of the hook to test",
  5855. "name": "id",
  5856. "in": "path",
  5857. "required": true
  5858. },
  5859. {
  5860. "type": "string",
  5861. "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
  5862. "name": "ref",
  5863. "in": "query"
  5864. }
  5865. ],
  5866. "responses": {
  5867. "204": {
  5868. "$ref": "#/responses/empty"
  5869. },
  5870. "404": {
  5871. "$ref": "#/responses/notFound"
  5872. }
  5873. }
  5874. }
  5875. },
  5876. "/repos/{owner}/{repo}/issue_config": {
  5877. "get": {
  5878. "produces": [
  5879. "application/json"
  5880. ],
  5881. "tags": [
  5882. "repository"
  5883. ],
  5884. "summary": "Returns the issue config for a repo",
  5885. "operationId": "repoGetIssueConfig",
  5886. "parameters": [
  5887. {
  5888. "type": "string",
  5889. "description": "owner of the repo",
  5890. "name": "owner",
  5891. "in": "path",
  5892. "required": true
  5893. },
  5894. {
  5895. "type": "string",
  5896. "description": "name of the repo",
  5897. "name": "repo",
  5898. "in": "path",
  5899. "required": true
  5900. }
  5901. ],
  5902. "responses": {
  5903. "200": {
  5904. "$ref": "#/responses/RepoIssueConfig"
  5905. },
  5906. "404": {
  5907. "$ref": "#/responses/notFound"
  5908. }
  5909. }
  5910. }
  5911. },
  5912. "/repos/{owner}/{repo}/issue_config/validate": {
  5913. "get": {
  5914. "produces": [
  5915. "application/json"
  5916. ],
  5917. "tags": [
  5918. "repository"
  5919. ],
  5920. "summary": "Returns the validation information for a issue config",
  5921. "operationId": "repoValidateIssueConfig",
  5922. "parameters": [
  5923. {
  5924. "type": "string",
  5925. "description": "owner of the repo",
  5926. "name": "owner",
  5927. "in": "path",
  5928. "required": true
  5929. },
  5930. {
  5931. "type": "string",
  5932. "description": "name of the repo",
  5933. "name": "repo",
  5934. "in": "path",
  5935. "required": true
  5936. }
  5937. ],
  5938. "responses": {
  5939. "200": {
  5940. "$ref": "#/responses/RepoIssueConfigValidation"
  5941. },
  5942. "404": {
  5943. "$ref": "#/responses/notFound"
  5944. }
  5945. }
  5946. }
  5947. },
  5948. "/repos/{owner}/{repo}/issue_templates": {
  5949. "get": {
  5950. "produces": [
  5951. "application/json"
  5952. ],
  5953. "tags": [
  5954. "repository"
  5955. ],
  5956. "summary": "Get available issue templates for a repository",
  5957. "operationId": "repoGetIssueTemplates",
  5958. "parameters": [
  5959. {
  5960. "type": "string",
  5961. "description": "owner of the repo",
  5962. "name": "owner",
  5963. "in": "path",
  5964. "required": true
  5965. },
  5966. {
  5967. "type": "string",
  5968. "description": "name of the repo",
  5969. "name": "repo",
  5970. "in": "path",
  5971. "required": true
  5972. }
  5973. ],
  5974. "responses": {
  5975. "200": {
  5976. "$ref": "#/responses/IssueTemplates"
  5977. },
  5978. "404": {
  5979. "$ref": "#/responses/notFound"
  5980. }
  5981. }
  5982. }
  5983. },
  5984. "/repos/{owner}/{repo}/issues": {
  5985. "get": {
  5986. "produces": [
  5987. "application/json"
  5988. ],
  5989. "tags": [
  5990. "issue"
  5991. ],
  5992. "summary": "List a repository's issues",
  5993. "operationId": "issueListIssues",
  5994. "parameters": [
  5995. {
  5996. "type": "string",
  5997. "description": "owner of the repo",
  5998. "name": "owner",
  5999. "in": "path",
  6000. "required": true
  6001. },
  6002. {
  6003. "type": "string",
  6004. "description": "name of the repo",
  6005. "name": "repo",
  6006. "in": "path",
  6007. "required": true
  6008. },
  6009. {
  6010. "enum": [
  6011. "closed",
  6012. "open",
  6013. "all"
  6014. ],
  6015. "type": "string",
  6016. "description": "whether issue is open or closed",
  6017. "name": "state",
  6018. "in": "query"
  6019. },
  6020. {
  6021. "type": "string",
  6022. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  6023. "name": "labels",
  6024. "in": "query"
  6025. },
  6026. {
  6027. "type": "string",
  6028. "description": "search string",
  6029. "name": "q",
  6030. "in": "query"
  6031. },
  6032. {
  6033. "enum": [
  6034. "issues",
  6035. "pulls"
  6036. ],
  6037. "type": "string",
  6038. "description": "filter by type (issues / pulls) if set",
  6039. "name": "type",
  6040. "in": "query"
  6041. },
  6042. {
  6043. "type": "string",
  6044. "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",
  6045. "name": "milestones",
  6046. "in": "query"
  6047. },
  6048. {
  6049. "type": "string",
  6050. "format": "date-time",
  6051. "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
  6052. "name": "since",
  6053. "in": "query"
  6054. },
  6055. {
  6056. "type": "string",
  6057. "format": "date-time",
  6058. "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
  6059. "name": "before",
  6060. "in": "query"
  6061. },
  6062. {
  6063. "type": "string",
  6064. "description": "Only show items which were created by the the given user",
  6065. "name": "created_by",
  6066. "in": "query"
  6067. },
  6068. {
  6069. "type": "string",
  6070. "description": "Only show items for which the given user is assigned",
  6071. "name": "assigned_by",
  6072. "in": "query"
  6073. },
  6074. {
  6075. "type": "string",
  6076. "description": "Only show items in which the given user was mentioned",
  6077. "name": "mentioned_by",
  6078. "in": "query"
  6079. },
  6080. {
  6081. "type": "integer",
  6082. "description": "page number of results to return (1-based)",
  6083. "name": "page",
  6084. "in": "query"
  6085. },
  6086. {
  6087. "type": "integer",
  6088. "description": "page size of results",
  6089. "name": "limit",
  6090. "in": "query"
  6091. }
  6092. ],
  6093. "responses": {
  6094. "200": {
  6095. "$ref": "#/responses/IssueList"
  6096. },
  6097. "404": {
  6098. "$ref": "#/responses/notFound"
  6099. }
  6100. }
  6101. },
  6102. "post": {
  6103. "consumes": [
  6104. "application/json"
  6105. ],
  6106. "produces": [
  6107. "application/json"
  6108. ],
  6109. "tags": [
  6110. "issue"
  6111. ],
  6112. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6113. "operationId": "issueCreateIssue",
  6114. "parameters": [
  6115. {
  6116. "type": "string",
  6117. "description": "owner of the repo",
  6118. "name": "owner",
  6119. "in": "path",
  6120. "required": true
  6121. },
  6122. {
  6123. "type": "string",
  6124. "description": "name of the repo",
  6125. "name": "repo",
  6126. "in": "path",
  6127. "required": true
  6128. },
  6129. {
  6130. "name": "body",
  6131. "in": "body",
  6132. "schema": {
  6133. "$ref": "#/definitions/CreateIssueOption"
  6134. }
  6135. }
  6136. ],
  6137. "responses": {
  6138. "201": {
  6139. "$ref": "#/responses/Issue"
  6140. },
  6141. "403": {
  6142. "$ref": "#/responses/forbidden"
  6143. },
  6144. "404": {
  6145. "$ref": "#/responses/notFound"
  6146. },
  6147. "412": {
  6148. "$ref": "#/responses/error"
  6149. },
  6150. "422": {
  6151. "$ref": "#/responses/validationError"
  6152. }
  6153. }
  6154. }
  6155. },
  6156. "/repos/{owner}/{repo}/issues/comments": {
  6157. "get": {
  6158. "produces": [
  6159. "application/json"
  6160. ],
  6161. "tags": [
  6162. "issue"
  6163. ],
  6164. "summary": "List all comments in a repository",
  6165. "operationId": "issueGetRepoComments",
  6166. "parameters": [
  6167. {
  6168. "type": "string",
  6169. "description": "owner of the repo",
  6170. "name": "owner",
  6171. "in": "path",
  6172. "required": true
  6173. },
  6174. {
  6175. "type": "string",
  6176. "description": "name of the repo",
  6177. "name": "repo",
  6178. "in": "path",
  6179. "required": true
  6180. },
  6181. {
  6182. "type": "string",
  6183. "format": "date-time",
  6184. "description": "if provided, only comments updated since the provided time are returned.",
  6185. "name": "since",
  6186. "in": "query"
  6187. },
  6188. {
  6189. "type": "string",
  6190. "format": "date-time",
  6191. "description": "if provided, only comments updated before the provided time are returned.",
  6192. "name": "before",
  6193. "in": "query"
  6194. },
  6195. {
  6196. "type": "integer",
  6197. "description": "page number of results to return (1-based)",
  6198. "name": "page",
  6199. "in": "query"
  6200. },
  6201. {
  6202. "type": "integer",
  6203. "description": "page size of results",
  6204. "name": "limit",
  6205. "in": "query"
  6206. }
  6207. ],
  6208. "responses": {
  6209. "200": {
  6210. "$ref": "#/responses/CommentList"
  6211. },
  6212. "404": {
  6213. "$ref": "#/responses/notFound"
  6214. }
  6215. }
  6216. }
  6217. },
  6218. "/repos/{owner}/{repo}/issues/comments/{id}": {
  6219. "get": {
  6220. "consumes": [
  6221. "application/json"
  6222. ],
  6223. "produces": [
  6224. "application/json"
  6225. ],
  6226. "tags": [
  6227. "issue"
  6228. ],
  6229. "summary": "Get a comment",
  6230. "operationId": "issueGetComment",
  6231. "parameters": [
  6232. {
  6233. "type": "string",
  6234. "description": "owner of the repo",
  6235. "name": "owner",
  6236. "in": "path",
  6237. "required": true
  6238. },
  6239. {
  6240. "type": "string",
  6241. "description": "name of the repo",
  6242. "name": "repo",
  6243. "in": "path",
  6244. "required": true
  6245. },
  6246. {
  6247. "type": "integer",
  6248. "format": "int64",
  6249. "description": "id of the comment",
  6250. "name": "id",
  6251. "in": "path",
  6252. "required": true
  6253. }
  6254. ],
  6255. "responses": {
  6256. "200": {
  6257. "$ref": "#/responses/Comment"
  6258. },
  6259. "204": {
  6260. "$ref": "#/responses/empty"
  6261. },
  6262. "403": {
  6263. "$ref": "#/responses/forbidden"
  6264. },
  6265. "404": {
  6266. "$ref": "#/responses/notFound"
  6267. }
  6268. }
  6269. },
  6270. "delete": {
  6271. "tags": [
  6272. "issue"
  6273. ],
  6274. "summary": "Delete a comment",
  6275. "operationId": "issueDeleteComment",
  6276. "parameters": [
  6277. {
  6278. "type": "string",
  6279. "description": "owner of the repo",
  6280. "name": "owner",
  6281. "in": "path",
  6282. "required": true
  6283. },
  6284. {
  6285. "type": "string",
  6286. "description": "name of the repo",
  6287. "name": "repo",
  6288. "in": "path",
  6289. "required": true
  6290. },
  6291. {
  6292. "type": "integer",
  6293. "format": "int64",
  6294. "description": "id of comment to delete",
  6295. "name": "id",
  6296. "in": "path",
  6297. "required": true
  6298. }
  6299. ],
  6300. "responses": {
  6301. "204": {
  6302. "$ref": "#/responses/empty"
  6303. },
  6304. "403": {
  6305. "$ref": "#/responses/forbidden"
  6306. },
  6307. "404": {
  6308. "$ref": "#/responses/notFound"
  6309. }
  6310. }
  6311. },
  6312. "patch": {
  6313. "consumes": [
  6314. "application/json"
  6315. ],
  6316. "produces": [
  6317. "application/json"
  6318. ],
  6319. "tags": [
  6320. "issue"
  6321. ],
  6322. "summary": "Edit a comment",
  6323. "operationId": "issueEditComment",
  6324. "parameters": [
  6325. {
  6326. "type": "string",
  6327. "description": "owner of the repo",
  6328. "name": "owner",
  6329. "in": "path",
  6330. "required": true
  6331. },
  6332. {
  6333. "type": "string",
  6334. "description": "name of the repo",
  6335. "name": "repo",
  6336. "in": "path",
  6337. "required": true
  6338. },
  6339. {
  6340. "type": "integer",
  6341. "format": "int64",
  6342. "description": "id of the comment to edit",
  6343. "name": "id",
  6344. "in": "path",
  6345. "required": true
  6346. },
  6347. {
  6348. "name": "body",
  6349. "in": "body",
  6350. "schema": {
  6351. "$ref": "#/definitions/EditIssueCommentOption"
  6352. }
  6353. }
  6354. ],
  6355. "responses": {
  6356. "200": {
  6357. "$ref": "#/responses/Comment"
  6358. },
  6359. "204": {
  6360. "$ref": "#/responses/empty"
  6361. },
  6362. "403": {
  6363. "$ref": "#/responses/forbidden"
  6364. },
  6365. "404": {
  6366. "$ref": "#/responses/notFound"
  6367. }
  6368. }
  6369. }
  6370. },
  6371. "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
  6372. "get": {
  6373. "produces": [
  6374. "application/json"
  6375. ],
  6376. "tags": [
  6377. "issue"
  6378. ],
  6379. "summary": "List comment's attachments",
  6380. "operationId": "issueListIssueCommentAttachments",
  6381. "parameters": [
  6382. {
  6383. "type": "string",
  6384. "description": "owner of the repo",
  6385. "name": "owner",
  6386. "in": "path",
  6387. "required": true
  6388. },
  6389. {
  6390. "type": "string",
  6391. "description": "name of the repo",
  6392. "name": "repo",
  6393. "in": "path",
  6394. "required": true
  6395. },
  6396. {
  6397. "type": "integer",
  6398. "format": "int64",
  6399. "description": "id of the comment",
  6400. "name": "id",
  6401. "in": "path",
  6402. "required": true
  6403. }
  6404. ],
  6405. "responses": {
  6406. "200": {
  6407. "$ref": "#/responses/AttachmentList"
  6408. },
  6409. "404": {
  6410. "$ref": "#/responses/error"
  6411. }
  6412. }
  6413. },
  6414. "post": {
  6415. "consumes": [
  6416. "multipart/form-data"
  6417. ],
  6418. "produces": [
  6419. "application/json"
  6420. ],
  6421. "tags": [
  6422. "issue"
  6423. ],
  6424. "summary": "Create a comment attachment",
  6425. "operationId": "issueCreateIssueCommentAttachment",
  6426. "parameters": [
  6427. {
  6428. "type": "string",
  6429. "description": "owner of the repo",
  6430. "name": "owner",
  6431. "in": "path",
  6432. "required": true
  6433. },
  6434. {
  6435. "type": "string",
  6436. "description": "name of the repo",
  6437. "name": "repo",
  6438. "in": "path",
  6439. "required": true
  6440. },
  6441. {
  6442. "type": "integer",
  6443. "format": "int64",
  6444. "description": "id of the comment",
  6445. "name": "id",
  6446. "in": "path",
  6447. "required": true
  6448. },
  6449. {
  6450. "type": "string",
  6451. "description": "name of the attachment",
  6452. "name": "name",
  6453. "in": "query"
  6454. },
  6455. {
  6456. "type": "file",
  6457. "description": "attachment to upload",
  6458. "name": "attachment",
  6459. "in": "formData",
  6460. "required": true
  6461. }
  6462. ],
  6463. "responses": {
  6464. "201": {
  6465. "$ref": "#/responses/Attachment"
  6466. },
  6467. "400": {
  6468. "$ref": "#/responses/error"
  6469. },
  6470. "404": {
  6471. "$ref": "#/responses/error"
  6472. }
  6473. }
  6474. }
  6475. },
  6476. "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
  6477. "get": {
  6478. "produces": [
  6479. "application/json"
  6480. ],
  6481. "tags": [
  6482. "issue"
  6483. ],
  6484. "summary": "Get a comment attachment",
  6485. "operationId": "issueGetIssueCommentAttachment",
  6486. "parameters": [
  6487. {
  6488. "type": "string",
  6489. "description": "owner of the repo",
  6490. "name": "owner",
  6491. "in": "path",
  6492. "required": true
  6493. },
  6494. {
  6495. "type": "string",
  6496. "description": "name of the repo",
  6497. "name": "repo",
  6498. "in": "path",
  6499. "required": true
  6500. },
  6501. {
  6502. "type": "integer",
  6503. "format": "int64",
  6504. "description": "id of the comment",
  6505. "name": "id",
  6506. "in": "path",
  6507. "required": true
  6508. },
  6509. {
  6510. "type": "integer",
  6511. "format": "int64",
  6512. "description": "id of the attachment to get",
  6513. "name": "attachment_id",
  6514. "in": "path",
  6515. "required": true
  6516. }
  6517. ],
  6518. "responses": {
  6519. "200": {
  6520. "$ref": "#/responses/Attachment"
  6521. },
  6522. "404": {
  6523. "$ref": "#/responses/error"
  6524. }
  6525. }
  6526. },
  6527. "delete": {
  6528. "produces": [
  6529. "application/json"
  6530. ],
  6531. "tags": [
  6532. "issue"
  6533. ],
  6534. "summary": "Delete a comment attachment",
  6535. "operationId": "issueDeleteIssueCommentAttachment",
  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": "integer",
  6553. "format": "int64",
  6554. "description": "id of the comment",
  6555. "name": "id",
  6556. "in": "path",
  6557. "required": true
  6558. },
  6559. {
  6560. "type": "integer",
  6561. "format": "int64",
  6562. "description": "id of the attachment to delete",
  6563. "name": "attachment_id",
  6564. "in": "path",
  6565. "required": true
  6566. }
  6567. ],
  6568. "responses": {
  6569. "204": {
  6570. "$ref": "#/responses/empty"
  6571. },
  6572. "404": {
  6573. "$ref": "#/responses/error"
  6574. }
  6575. }
  6576. },
  6577. "patch": {
  6578. "consumes": [
  6579. "application/json"
  6580. ],
  6581. "produces": [
  6582. "application/json"
  6583. ],
  6584. "tags": [
  6585. "issue"
  6586. ],
  6587. "summary": "Edit a comment attachment",
  6588. "operationId": "issueEditIssueCommentAttachment",
  6589. "parameters": [
  6590. {
  6591. "type": "string",
  6592. "description": "owner of the repo",
  6593. "name": "owner",
  6594. "in": "path",
  6595. "required": true
  6596. },
  6597. {
  6598. "type": "string",
  6599. "description": "name of the repo",
  6600. "name": "repo",
  6601. "in": "path",
  6602. "required": true
  6603. },
  6604. {
  6605. "type": "integer",
  6606. "format": "int64",
  6607. "description": "id of the comment",
  6608. "name": "id",
  6609. "in": "path",
  6610. "required": true
  6611. },
  6612. {
  6613. "type": "integer",
  6614. "format": "int64",
  6615. "description": "id of the attachment to edit",
  6616. "name": "attachment_id",
  6617. "in": "path",
  6618. "required": true
  6619. },
  6620. {
  6621. "name": "body",
  6622. "in": "body",
  6623. "schema": {
  6624. "$ref": "#/definitions/EditAttachmentOptions"
  6625. }
  6626. }
  6627. ],
  6628. "responses": {
  6629. "201": {
  6630. "$ref": "#/responses/Attachment"
  6631. },
  6632. "404": {
  6633. "$ref": "#/responses/error"
  6634. }
  6635. }
  6636. }
  6637. },
  6638. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  6639. "get": {
  6640. "consumes": [
  6641. "application/json"
  6642. ],
  6643. "produces": [
  6644. "application/json"
  6645. ],
  6646. "tags": [
  6647. "issue"
  6648. ],
  6649. "summary": "Get a list of reactions from a comment of an issue",
  6650. "operationId": "issueGetCommentReactions",
  6651. "parameters": [
  6652. {
  6653. "type": "string",
  6654. "description": "owner of the repo",
  6655. "name": "owner",
  6656. "in": "path",
  6657. "required": true
  6658. },
  6659. {
  6660. "type": "string",
  6661. "description": "name of the repo",
  6662. "name": "repo",
  6663. "in": "path",
  6664. "required": true
  6665. },
  6666. {
  6667. "type": "integer",
  6668. "format": "int64",
  6669. "description": "id of the comment to edit",
  6670. "name": "id",
  6671. "in": "path",
  6672. "required": true
  6673. }
  6674. ],
  6675. "responses": {
  6676. "200": {
  6677. "$ref": "#/responses/ReactionList"
  6678. },
  6679. "403": {
  6680. "$ref": "#/responses/forbidden"
  6681. },
  6682. "404": {
  6683. "$ref": "#/responses/notFound"
  6684. }
  6685. }
  6686. },
  6687. "post": {
  6688. "consumes": [
  6689. "application/json"
  6690. ],
  6691. "produces": [
  6692. "application/json"
  6693. ],
  6694. "tags": [
  6695. "issue"
  6696. ],
  6697. "summary": "Add a reaction to a comment of an issue",
  6698. "operationId": "issuePostCommentReaction",
  6699. "parameters": [
  6700. {
  6701. "type": "string",
  6702. "description": "owner of the repo",
  6703. "name": "owner",
  6704. "in": "path",
  6705. "required": true
  6706. },
  6707. {
  6708. "type": "string",
  6709. "description": "name of the repo",
  6710. "name": "repo",
  6711. "in": "path",
  6712. "required": true
  6713. },
  6714. {
  6715. "type": "integer",
  6716. "format": "int64",
  6717. "description": "id of the comment to edit",
  6718. "name": "id",
  6719. "in": "path",
  6720. "required": true
  6721. },
  6722. {
  6723. "name": "content",
  6724. "in": "body",
  6725. "schema": {
  6726. "$ref": "#/definitions/EditReactionOption"
  6727. }
  6728. }
  6729. ],
  6730. "responses": {
  6731. "200": {
  6732. "$ref": "#/responses/Reaction"
  6733. },
  6734. "201": {
  6735. "$ref": "#/responses/Reaction"
  6736. },
  6737. "403": {
  6738. "$ref": "#/responses/forbidden"
  6739. },
  6740. "404": {
  6741. "$ref": "#/responses/notFound"
  6742. }
  6743. }
  6744. },
  6745. "delete": {
  6746. "consumes": [
  6747. "application/json"
  6748. ],
  6749. "produces": [
  6750. "application/json"
  6751. ],
  6752. "tags": [
  6753. "issue"
  6754. ],
  6755. "summary": "Remove a reaction from a comment of an issue",
  6756. "operationId": "issueDeleteCommentReaction",
  6757. "parameters": [
  6758. {
  6759. "type": "string",
  6760. "description": "owner of the repo",
  6761. "name": "owner",
  6762. "in": "path",
  6763. "required": true
  6764. },
  6765. {
  6766. "type": "string",
  6767. "description": "name of the repo",
  6768. "name": "repo",
  6769. "in": "path",
  6770. "required": true
  6771. },
  6772. {
  6773. "type": "integer",
  6774. "format": "int64",
  6775. "description": "id of the comment to edit",
  6776. "name": "id",
  6777. "in": "path",
  6778. "required": true
  6779. },
  6780. {
  6781. "name": "content",
  6782. "in": "body",
  6783. "schema": {
  6784. "$ref": "#/definitions/EditReactionOption"
  6785. }
  6786. }
  6787. ],
  6788. "responses": {
  6789. "200": {
  6790. "$ref": "#/responses/empty"
  6791. },
  6792. "403": {
  6793. "$ref": "#/responses/forbidden"
  6794. },
  6795. "404": {
  6796. "$ref": "#/responses/notFound"
  6797. }
  6798. }
  6799. }
  6800. },
  6801. "/repos/{owner}/{repo}/issues/pinned": {
  6802. "get": {
  6803. "produces": [
  6804. "application/json"
  6805. ],
  6806. "tags": [
  6807. "repository"
  6808. ],
  6809. "summary": "List a repo's pinned issues",
  6810. "operationId": "repoListPinnedIssues",
  6811. "parameters": [
  6812. {
  6813. "type": "string",
  6814. "description": "owner of the repo",
  6815. "name": "owner",
  6816. "in": "path",
  6817. "required": true
  6818. },
  6819. {
  6820. "type": "string",
  6821. "description": "name of the repo",
  6822. "name": "repo",
  6823. "in": "path",
  6824. "required": true
  6825. }
  6826. ],
  6827. "responses": {
  6828. "200": {
  6829. "$ref": "#/responses/IssueList"
  6830. },
  6831. "404": {
  6832. "$ref": "#/responses/notFound"
  6833. }
  6834. }
  6835. }
  6836. },
  6837. "/repos/{owner}/{repo}/issues/{index}": {
  6838. "get": {
  6839. "produces": [
  6840. "application/json"
  6841. ],
  6842. "tags": [
  6843. "issue"
  6844. ],
  6845. "summary": "Get an issue",
  6846. "operationId": "issueGetIssue",
  6847. "parameters": [
  6848. {
  6849. "type": "string",
  6850. "description": "owner of the repo",
  6851. "name": "owner",
  6852. "in": "path",
  6853. "required": true
  6854. },
  6855. {
  6856. "type": "string",
  6857. "description": "name of the repo",
  6858. "name": "repo",
  6859. "in": "path",
  6860. "required": true
  6861. },
  6862. {
  6863. "type": "integer",
  6864. "format": "int64",
  6865. "description": "index of the issue to get",
  6866. "name": "index",
  6867. "in": "path",
  6868. "required": true
  6869. }
  6870. ],
  6871. "responses": {
  6872. "200": {
  6873. "$ref": "#/responses/Issue"
  6874. },
  6875. "404": {
  6876. "$ref": "#/responses/notFound"
  6877. }
  6878. }
  6879. },
  6880. "delete": {
  6881. "tags": [
  6882. "issue"
  6883. ],
  6884. "summary": "Delete an issue",
  6885. "operationId": "issueDelete",
  6886. "parameters": [
  6887. {
  6888. "type": "string",
  6889. "description": "owner of the repo",
  6890. "name": "owner",
  6891. "in": "path",
  6892. "required": true
  6893. },
  6894. {
  6895. "type": "string",
  6896. "description": "name of the repo",
  6897. "name": "repo",
  6898. "in": "path",
  6899. "required": true
  6900. },
  6901. {
  6902. "type": "integer",
  6903. "format": "int64",
  6904. "description": "index of issue to delete",
  6905. "name": "index",
  6906. "in": "path",
  6907. "required": true
  6908. }
  6909. ],
  6910. "responses": {
  6911. "204": {
  6912. "$ref": "#/responses/empty"
  6913. },
  6914. "403": {
  6915. "$ref": "#/responses/forbidden"
  6916. },
  6917. "404": {
  6918. "$ref": "#/responses/notFound"
  6919. }
  6920. }
  6921. },
  6922. "patch": {
  6923. "consumes": [
  6924. "application/json"
  6925. ],
  6926. "produces": [
  6927. "application/json"
  6928. ],
  6929. "tags": [
  6930. "issue"
  6931. ],
  6932. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6933. "operationId": "issueEditIssue",
  6934. "parameters": [
  6935. {
  6936. "type": "string",
  6937. "description": "owner of the repo",
  6938. "name": "owner",
  6939. "in": "path",
  6940. "required": true
  6941. },
  6942. {
  6943. "type": "string",
  6944. "description": "name of the repo",
  6945. "name": "repo",
  6946. "in": "path",
  6947. "required": true
  6948. },
  6949. {
  6950. "type": "integer",
  6951. "format": "int64",
  6952. "description": "index of the issue to edit",
  6953. "name": "index",
  6954. "in": "path",
  6955. "required": true
  6956. },
  6957. {
  6958. "name": "body",
  6959. "in": "body",
  6960. "schema": {
  6961. "$ref": "#/definitions/EditIssueOption"
  6962. }
  6963. }
  6964. ],
  6965. "responses": {
  6966. "201": {
  6967. "$ref": "#/responses/Issue"
  6968. },
  6969. "403": {
  6970. "$ref": "#/responses/forbidden"
  6971. },
  6972. "404": {
  6973. "$ref": "#/responses/notFound"
  6974. },
  6975. "412": {
  6976. "$ref": "#/responses/error"
  6977. }
  6978. }
  6979. }
  6980. },
  6981. "/repos/{owner}/{repo}/issues/{index}/assets": {
  6982. "get": {
  6983. "produces": [
  6984. "application/json"
  6985. ],
  6986. "tags": [
  6987. "issue"
  6988. ],
  6989. "summary": "List issue's attachments",
  6990. "operationId": "issueListIssueAttachments",
  6991. "parameters": [
  6992. {
  6993. "type": "string",
  6994. "description": "owner of the repo",
  6995. "name": "owner",
  6996. "in": "path",
  6997. "required": true
  6998. },
  6999. {
  7000. "type": "string",
  7001. "description": "name of the repo",
  7002. "name": "repo",
  7003. "in": "path",
  7004. "required": true
  7005. },
  7006. {
  7007. "type": "integer",
  7008. "format": "int64",
  7009. "description": "index of the issue",
  7010. "name": "index",
  7011. "in": "path",
  7012. "required": true
  7013. }
  7014. ],
  7015. "responses": {
  7016. "200": {
  7017. "$ref": "#/responses/AttachmentList"
  7018. },
  7019. "404": {
  7020. "$ref": "#/responses/error"
  7021. }
  7022. }
  7023. },
  7024. "post": {
  7025. "consumes": [
  7026. "multipart/form-data"
  7027. ],
  7028. "produces": [
  7029. "application/json"
  7030. ],
  7031. "tags": [
  7032. "issue"
  7033. ],
  7034. "summary": "Create an issue attachment",
  7035. "operationId": "issueCreateIssueAttachment",
  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": "index of the issue",
  7055. "name": "index",
  7056. "in": "path",
  7057. "required": true
  7058. },
  7059. {
  7060. "type": "string",
  7061. "description": "name of the attachment",
  7062. "name": "name",
  7063. "in": "query"
  7064. },
  7065. {
  7066. "type": "file",
  7067. "description": "attachment to upload",
  7068. "name": "attachment",
  7069. "in": "formData",
  7070. "required": true
  7071. }
  7072. ],
  7073. "responses": {
  7074. "201": {
  7075. "$ref": "#/responses/Attachment"
  7076. },
  7077. "400": {
  7078. "$ref": "#/responses/error"
  7079. },
  7080. "404": {
  7081. "$ref": "#/responses/error"
  7082. }
  7083. }
  7084. }
  7085. },
  7086. "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
  7087. "get": {
  7088. "produces": [
  7089. "application/json"
  7090. ],
  7091. "tags": [
  7092. "issue"
  7093. ],
  7094. "summary": "Get an issue attachment",
  7095. "operationId": "issueGetIssueAttachment",
  7096. "parameters": [
  7097. {
  7098. "type": "string",
  7099. "description": "owner of the repo",
  7100. "name": "owner",
  7101. "in": "path",
  7102. "required": true
  7103. },
  7104. {
  7105. "type": "string",
  7106. "description": "name of the repo",
  7107. "name": "repo",
  7108. "in": "path",
  7109. "required": true
  7110. },
  7111. {
  7112. "type": "integer",
  7113. "format": "int64",
  7114. "description": "index of the issue",
  7115. "name": "index",
  7116. "in": "path",
  7117. "required": true
  7118. },
  7119. {
  7120. "type": "integer",
  7121. "format": "int64",
  7122. "description": "id of the attachment to get",
  7123. "name": "attachment_id",
  7124. "in": "path",
  7125. "required": true
  7126. }
  7127. ],
  7128. "responses": {
  7129. "200": {
  7130. "$ref": "#/responses/Attachment"
  7131. },
  7132. "404": {
  7133. "$ref": "#/responses/error"
  7134. }
  7135. }
  7136. },
  7137. "delete": {
  7138. "produces": [
  7139. "application/json"
  7140. ],
  7141. "tags": [
  7142. "issue"
  7143. ],
  7144. "summary": "Delete an issue attachment",
  7145. "operationId": "issueDeleteIssueAttachment",
  7146. "parameters": [
  7147. {
  7148. "type": "string",
  7149. "description": "owner of the repo",
  7150. "name": "owner",
  7151. "in": "path",
  7152. "required": true
  7153. },
  7154. {
  7155. "type": "string",
  7156. "description": "name of the repo",
  7157. "name": "repo",
  7158. "in": "path",
  7159. "required": true
  7160. },
  7161. {
  7162. "type": "integer",
  7163. "format": "int64",
  7164. "description": "index of the issue",
  7165. "name": "index",
  7166. "in": "path",
  7167. "required": true
  7168. },
  7169. {
  7170. "type": "integer",
  7171. "format": "int64",
  7172. "description": "id of the attachment to delete",
  7173. "name": "attachment_id",
  7174. "in": "path",
  7175. "required": true
  7176. }
  7177. ],
  7178. "responses": {
  7179. "204": {
  7180. "$ref": "#/responses/empty"
  7181. },
  7182. "404": {
  7183. "$ref": "#/responses/error"
  7184. }
  7185. }
  7186. },
  7187. "patch": {
  7188. "consumes": [
  7189. "application/json"
  7190. ],
  7191. "produces": [
  7192. "application/json"
  7193. ],
  7194. "tags": [
  7195. "issue"
  7196. ],
  7197. "summary": "Edit an issue attachment",
  7198. "operationId": "issueEditIssueAttachment",
  7199. "parameters": [
  7200. {
  7201. "type": "string",
  7202. "description": "owner of the repo",
  7203. "name": "owner",
  7204. "in": "path",
  7205. "required": true
  7206. },
  7207. {
  7208. "type": "string",
  7209. "description": "name of the repo",
  7210. "name": "repo",
  7211. "in": "path",
  7212. "required": true
  7213. },
  7214. {
  7215. "type": "integer",
  7216. "format": "int64",
  7217. "description": "index of the issue",
  7218. "name": "index",
  7219. "in": "path",
  7220. "required": true
  7221. },
  7222. {
  7223. "type": "integer",
  7224. "format": "int64",
  7225. "description": "id of the attachment to edit",
  7226. "name": "attachment_id",
  7227. "in": "path",
  7228. "required": true
  7229. },
  7230. {
  7231. "name": "body",
  7232. "in": "body",
  7233. "schema": {
  7234. "$ref": "#/definitions/EditAttachmentOptions"
  7235. }
  7236. }
  7237. ],
  7238. "responses": {
  7239. "201": {
  7240. "$ref": "#/responses/Attachment"
  7241. },
  7242. "404": {
  7243. "$ref": "#/responses/error"
  7244. }
  7245. }
  7246. }
  7247. },
  7248. "/repos/{owner}/{repo}/issues/{index}/blocks": {
  7249. "get": {
  7250. "produces": [
  7251. "application/json"
  7252. ],
  7253. "tags": [
  7254. "issue"
  7255. ],
  7256. "summary": "List issues that are blocked by this issue",
  7257. "operationId": "issueListBlocks",
  7258. "parameters": [
  7259. {
  7260. "type": "string",
  7261. "description": "owner of the repo",
  7262. "name": "owner",
  7263. "in": "path",
  7264. "required": true
  7265. },
  7266. {
  7267. "type": "string",
  7268. "description": "name of the repo",
  7269. "name": "repo",
  7270. "in": "path",
  7271. "required": true
  7272. },
  7273. {
  7274. "type": "string",
  7275. "description": "index of the issue",
  7276. "name": "index",
  7277. "in": "path",
  7278. "required": true
  7279. },
  7280. {
  7281. "type": "integer",
  7282. "description": "page number of results to return (1-based)",
  7283. "name": "page",
  7284. "in": "query"
  7285. },
  7286. {
  7287. "type": "integer",
  7288. "description": "page size of results",
  7289. "name": "limit",
  7290. "in": "query"
  7291. }
  7292. ],
  7293. "responses": {
  7294. "200": {
  7295. "$ref": "#/responses/IssueList"
  7296. },
  7297. "404": {
  7298. "$ref": "#/responses/notFound"
  7299. }
  7300. }
  7301. },
  7302. "post": {
  7303. "produces": [
  7304. "application/json"
  7305. ],
  7306. "tags": [
  7307. "issue"
  7308. ],
  7309. "summary": "Block the issue given in the body by the issue in path",
  7310. "operationId": "issueCreateIssueBlocking",
  7311. "parameters": [
  7312. {
  7313. "type": "string",
  7314. "description": "owner of the repo",
  7315. "name": "owner",
  7316. "in": "path",
  7317. "required": true
  7318. },
  7319. {
  7320. "type": "string",
  7321. "description": "name of the repo",
  7322. "name": "repo",
  7323. "in": "path",
  7324. "required": true
  7325. },
  7326. {
  7327. "type": "string",
  7328. "description": "index of the issue",
  7329. "name": "index",
  7330. "in": "path",
  7331. "required": true
  7332. },
  7333. {
  7334. "name": "body",
  7335. "in": "body",
  7336. "schema": {
  7337. "$ref": "#/definitions/IssueMeta"
  7338. }
  7339. }
  7340. ],
  7341. "responses": {
  7342. "201": {
  7343. "$ref": "#/responses/Issue"
  7344. },
  7345. "404": {
  7346. "description": "the issue does not exist"
  7347. }
  7348. }
  7349. },
  7350. "delete": {
  7351. "produces": [
  7352. "application/json"
  7353. ],
  7354. "tags": [
  7355. "issue"
  7356. ],
  7357. "summary": "Unblock the issue given in the body by the issue in path",
  7358. "operationId": "issueRemoveIssueBlocking",
  7359. "parameters": [
  7360. {
  7361. "type": "string",
  7362. "description": "owner of the repo",
  7363. "name": "owner",
  7364. "in": "path",
  7365. "required": true
  7366. },
  7367. {
  7368. "type": "string",
  7369. "description": "name of the repo",
  7370. "name": "repo",
  7371. "in": "path",
  7372. "required": true
  7373. },
  7374. {
  7375. "type": "string",
  7376. "description": "index of the issue",
  7377. "name": "index",
  7378. "in": "path",
  7379. "required": true
  7380. },
  7381. {
  7382. "name": "body",
  7383. "in": "body",
  7384. "schema": {
  7385. "$ref": "#/definitions/IssueMeta"
  7386. }
  7387. }
  7388. ],
  7389. "responses": {
  7390. "200": {
  7391. "$ref": "#/responses/Issue"
  7392. },
  7393. "404": {
  7394. "$ref": "#/responses/notFound"
  7395. }
  7396. }
  7397. }
  7398. },
  7399. "/repos/{owner}/{repo}/issues/{index}/comments": {
  7400. "get": {
  7401. "produces": [
  7402. "application/json"
  7403. ],
  7404. "tags": [
  7405. "issue"
  7406. ],
  7407. "summary": "List all comments on an issue",
  7408. "operationId": "issueGetComments",
  7409. "parameters": [
  7410. {
  7411. "type": "string",
  7412. "description": "owner of the repo",
  7413. "name": "owner",
  7414. "in": "path",
  7415. "required": true
  7416. },
  7417. {
  7418. "type": "string",
  7419. "description": "name of the repo",
  7420. "name": "repo",
  7421. "in": "path",
  7422. "required": true
  7423. },
  7424. {
  7425. "type": "integer",
  7426. "format": "int64",
  7427. "description": "index of the issue",
  7428. "name": "index",
  7429. "in": "path",
  7430. "required": true
  7431. },
  7432. {
  7433. "type": "string",
  7434. "format": "date-time",
  7435. "description": "if provided, only comments updated since the specified time are returned.",
  7436. "name": "since",
  7437. "in": "query"
  7438. },
  7439. {
  7440. "type": "string",
  7441. "format": "date-time",
  7442. "description": "if provided, only comments updated before the provided time are returned.",
  7443. "name": "before",
  7444. "in": "query"
  7445. }
  7446. ],
  7447. "responses": {
  7448. "200": {
  7449. "$ref": "#/responses/CommentList"
  7450. },
  7451. "404": {
  7452. "$ref": "#/responses/notFound"
  7453. }
  7454. }
  7455. },
  7456. "post": {
  7457. "consumes": [
  7458. "application/json"
  7459. ],
  7460. "produces": [
  7461. "application/json"
  7462. ],
  7463. "tags": [
  7464. "issue"
  7465. ],
  7466. "summary": "Add a comment to an issue",
  7467. "operationId": "issueCreateComment",
  7468. "parameters": [
  7469. {
  7470. "type": "string",
  7471. "description": "owner of the repo",
  7472. "name": "owner",
  7473. "in": "path",
  7474. "required": true
  7475. },
  7476. {
  7477. "type": "string",
  7478. "description": "name of the repo",
  7479. "name": "repo",
  7480. "in": "path",
  7481. "required": true
  7482. },
  7483. {
  7484. "type": "integer",
  7485. "format": "int64",
  7486. "description": "index of the issue",
  7487. "name": "index",
  7488. "in": "path",
  7489. "required": true
  7490. },
  7491. {
  7492. "name": "body",
  7493. "in": "body",
  7494. "schema": {
  7495. "$ref": "#/definitions/CreateIssueCommentOption"
  7496. }
  7497. }
  7498. ],
  7499. "responses": {
  7500. "201": {
  7501. "$ref": "#/responses/Comment"
  7502. },
  7503. "403": {
  7504. "$ref": "#/responses/forbidden"
  7505. },
  7506. "404": {
  7507. "$ref": "#/responses/notFound"
  7508. }
  7509. }
  7510. }
  7511. },
  7512. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  7513. "delete": {
  7514. "tags": [
  7515. "issue"
  7516. ],
  7517. "summary": "Delete a comment",
  7518. "operationId": "issueDeleteCommentDeprecated",
  7519. "deprecated": true,
  7520. "parameters": [
  7521. {
  7522. "type": "string",
  7523. "description": "owner of the repo",
  7524. "name": "owner",
  7525. "in": "path",
  7526. "required": true
  7527. },
  7528. {
  7529. "type": "string",
  7530. "description": "name of the repo",
  7531. "name": "repo",
  7532. "in": "path",
  7533. "required": true
  7534. },
  7535. {
  7536. "type": "integer",
  7537. "description": "this parameter is ignored",
  7538. "name": "index",
  7539. "in": "path",
  7540. "required": true
  7541. },
  7542. {
  7543. "type": "integer",
  7544. "format": "int64",
  7545. "description": "id of comment to delete",
  7546. "name": "id",
  7547. "in": "path",
  7548. "required": true
  7549. }
  7550. ],
  7551. "responses": {
  7552. "204": {
  7553. "$ref": "#/responses/empty"
  7554. },
  7555. "403": {
  7556. "$ref": "#/responses/forbidden"
  7557. },
  7558. "404": {
  7559. "$ref": "#/responses/notFound"
  7560. }
  7561. }
  7562. },
  7563. "patch": {
  7564. "consumes": [
  7565. "application/json"
  7566. ],
  7567. "produces": [
  7568. "application/json"
  7569. ],
  7570. "tags": [
  7571. "issue"
  7572. ],
  7573. "summary": "Edit a comment",
  7574. "operationId": "issueEditCommentDeprecated",
  7575. "deprecated": true,
  7576. "parameters": [
  7577. {
  7578. "type": "string",
  7579. "description": "owner of the repo",
  7580. "name": "owner",
  7581. "in": "path",
  7582. "required": true
  7583. },
  7584. {
  7585. "type": "string",
  7586. "description": "name of the repo",
  7587. "name": "repo",
  7588. "in": "path",
  7589. "required": true
  7590. },
  7591. {
  7592. "type": "integer",
  7593. "description": "this parameter is ignored",
  7594. "name": "index",
  7595. "in": "path",
  7596. "required": true
  7597. },
  7598. {
  7599. "type": "integer",
  7600. "format": "int64",
  7601. "description": "id of the comment to edit",
  7602. "name": "id",
  7603. "in": "path",
  7604. "required": true
  7605. },
  7606. {
  7607. "name": "body",
  7608. "in": "body",
  7609. "schema": {
  7610. "$ref": "#/definitions/EditIssueCommentOption"
  7611. }
  7612. }
  7613. ],
  7614. "responses": {
  7615. "200": {
  7616. "$ref": "#/responses/Comment"
  7617. },
  7618. "204": {
  7619. "$ref": "#/responses/empty"
  7620. },
  7621. "403": {
  7622. "$ref": "#/responses/forbidden"
  7623. },
  7624. "404": {
  7625. "$ref": "#/responses/notFound"
  7626. }
  7627. }
  7628. }
  7629. },
  7630. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  7631. "post": {
  7632. "consumes": [
  7633. "application/json"
  7634. ],
  7635. "produces": [
  7636. "application/json"
  7637. ],
  7638. "tags": [
  7639. "issue"
  7640. ],
  7641. "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.",
  7642. "operationId": "issueEditIssueDeadline",
  7643. "parameters": [
  7644. {
  7645. "type": "string",
  7646. "description": "owner of the repo",
  7647. "name": "owner",
  7648. "in": "path",
  7649. "required": true
  7650. },
  7651. {
  7652. "type": "string",
  7653. "description": "name of the repo",
  7654. "name": "repo",
  7655. "in": "path",
  7656. "required": true
  7657. },
  7658. {
  7659. "type": "integer",
  7660. "format": "int64",
  7661. "description": "index of the issue to create or update a deadline on",
  7662. "name": "index",
  7663. "in": "path",
  7664. "required": true
  7665. },
  7666. {
  7667. "name": "body",
  7668. "in": "body",
  7669. "schema": {
  7670. "$ref": "#/definitions/EditDeadlineOption"
  7671. }
  7672. }
  7673. ],
  7674. "responses": {
  7675. "201": {
  7676. "$ref": "#/responses/IssueDeadline"
  7677. },
  7678. "403": {
  7679. "$ref": "#/responses/forbidden"
  7680. },
  7681. "404": {
  7682. "$ref": "#/responses/notFound"
  7683. }
  7684. }
  7685. }
  7686. },
  7687. "/repos/{owner}/{repo}/issues/{index}/dependencies": {
  7688. "get": {
  7689. "produces": [
  7690. "application/json"
  7691. ],
  7692. "tags": [
  7693. "issue"
  7694. ],
  7695. "summary": "List an issue's dependencies, i.e all issues that block this issue.",
  7696. "operationId": "issueListIssueDependencies",
  7697. "parameters": [
  7698. {
  7699. "type": "string",
  7700. "description": "owner of the repo",
  7701. "name": "owner",
  7702. "in": "path",
  7703. "required": true
  7704. },
  7705. {
  7706. "type": "string",
  7707. "description": "name of the repo",
  7708. "name": "repo",
  7709. "in": "path",
  7710. "required": true
  7711. },
  7712. {
  7713. "type": "string",
  7714. "description": "index of the issue",
  7715. "name": "index",
  7716. "in": "path",
  7717. "required": true
  7718. },
  7719. {
  7720. "type": "integer",
  7721. "description": "page number of results to return (1-based)",
  7722. "name": "page",
  7723. "in": "query"
  7724. },
  7725. {
  7726. "type": "integer",
  7727. "description": "page size of results",
  7728. "name": "limit",
  7729. "in": "query"
  7730. }
  7731. ],
  7732. "responses": {
  7733. "200": {
  7734. "$ref": "#/responses/IssueList"
  7735. },
  7736. "404": {
  7737. "$ref": "#/responses/notFound"
  7738. }
  7739. }
  7740. },
  7741. "post": {
  7742. "produces": [
  7743. "application/json"
  7744. ],
  7745. "tags": [
  7746. "issue"
  7747. ],
  7748. "summary": "Make the issue in the url depend on the issue in the form.",
  7749. "operationId": "issueCreateIssueDependencies",
  7750. "parameters": [
  7751. {
  7752. "type": "string",
  7753. "description": "owner of the repo",
  7754. "name": "owner",
  7755. "in": "path",
  7756. "required": true
  7757. },
  7758. {
  7759. "type": "string",
  7760. "description": "name of the repo",
  7761. "name": "repo",
  7762. "in": "path",
  7763. "required": true
  7764. },
  7765. {
  7766. "type": "string",
  7767. "description": "index of the issue",
  7768. "name": "index",
  7769. "in": "path",
  7770. "required": true
  7771. },
  7772. {
  7773. "name": "body",
  7774. "in": "body",
  7775. "schema": {
  7776. "$ref": "#/definitions/IssueMeta"
  7777. }
  7778. }
  7779. ],
  7780. "responses": {
  7781. "201": {
  7782. "$ref": "#/responses/Issue"
  7783. },
  7784. "404": {
  7785. "description": "the issue does not exist"
  7786. }
  7787. }
  7788. },
  7789. "delete": {
  7790. "produces": [
  7791. "application/json"
  7792. ],
  7793. "tags": [
  7794. "issue"
  7795. ],
  7796. "summary": "Remove an issue dependency",
  7797. "operationId": "issueRemoveIssueDependencies",
  7798. "parameters": [
  7799. {
  7800. "type": "string",
  7801. "description": "owner of the repo",
  7802. "name": "owner",
  7803. "in": "path",
  7804. "required": true
  7805. },
  7806. {
  7807. "type": "string",
  7808. "description": "name of the repo",
  7809. "name": "repo",
  7810. "in": "path",
  7811. "required": true
  7812. },
  7813. {
  7814. "type": "string",
  7815. "description": "index of the issue",
  7816. "name": "index",
  7817. "in": "path",
  7818. "required": true
  7819. },
  7820. {
  7821. "name": "body",
  7822. "in": "body",
  7823. "schema": {
  7824. "$ref": "#/definitions/IssueMeta"
  7825. }
  7826. }
  7827. ],
  7828. "responses": {
  7829. "200": {
  7830. "$ref": "#/responses/Issue"
  7831. },
  7832. "404": {
  7833. "$ref": "#/responses/notFound"
  7834. }
  7835. }
  7836. }
  7837. },
  7838. "/repos/{owner}/{repo}/issues/{index}/labels": {
  7839. "get": {
  7840. "produces": [
  7841. "application/json"
  7842. ],
  7843. "tags": [
  7844. "issue"
  7845. ],
  7846. "summary": "Get an issue's labels",
  7847. "operationId": "issueGetLabels",
  7848. "parameters": [
  7849. {
  7850. "type": "string",
  7851. "description": "owner of the repo",
  7852. "name": "owner",
  7853. "in": "path",
  7854. "required": true
  7855. },
  7856. {
  7857. "type": "string",
  7858. "description": "name of the repo",
  7859. "name": "repo",
  7860. "in": "path",
  7861. "required": true
  7862. },
  7863. {
  7864. "type": "integer",
  7865. "format": "int64",
  7866. "description": "index of the issue",
  7867. "name": "index",
  7868. "in": "path",
  7869. "required": true
  7870. }
  7871. ],
  7872. "responses": {
  7873. "200": {
  7874. "$ref": "#/responses/LabelList"
  7875. },
  7876. "404": {
  7877. "$ref": "#/responses/notFound"
  7878. }
  7879. }
  7880. },
  7881. "put": {
  7882. "consumes": [
  7883. "application/json"
  7884. ],
  7885. "produces": [
  7886. "application/json"
  7887. ],
  7888. "tags": [
  7889. "issue"
  7890. ],
  7891. "summary": "Replace an issue's labels",
  7892. "operationId": "issueReplaceLabels",
  7893. "parameters": [
  7894. {
  7895. "type": "string",
  7896. "description": "owner of the repo",
  7897. "name": "owner",
  7898. "in": "path",
  7899. "required": true
  7900. },
  7901. {
  7902. "type": "string",
  7903. "description": "name of the repo",
  7904. "name": "repo",
  7905. "in": "path",
  7906. "required": true
  7907. },
  7908. {
  7909. "type": "integer",
  7910. "format": "int64",
  7911. "description": "index of the issue",
  7912. "name": "index",
  7913. "in": "path",
  7914. "required": true
  7915. },
  7916. {
  7917. "name": "body",
  7918. "in": "body",
  7919. "schema": {
  7920. "$ref": "#/definitions/IssueLabelsOption"
  7921. }
  7922. }
  7923. ],
  7924. "responses": {
  7925. "200": {
  7926. "$ref": "#/responses/LabelList"
  7927. },
  7928. "403": {
  7929. "$ref": "#/responses/forbidden"
  7930. },
  7931. "404": {
  7932. "$ref": "#/responses/notFound"
  7933. }
  7934. }
  7935. },
  7936. "post": {
  7937. "consumes": [
  7938. "application/json"
  7939. ],
  7940. "produces": [
  7941. "application/json"
  7942. ],
  7943. "tags": [
  7944. "issue"
  7945. ],
  7946. "summary": "Add a label to an issue",
  7947. "operationId": "issueAddLabel",
  7948. "parameters": [
  7949. {
  7950. "type": "string",
  7951. "description": "owner of the repo",
  7952. "name": "owner",
  7953. "in": "path",
  7954. "required": true
  7955. },
  7956. {
  7957. "type": "string",
  7958. "description": "name of the repo",
  7959. "name": "repo",
  7960. "in": "path",
  7961. "required": true
  7962. },
  7963. {
  7964. "type": "integer",
  7965. "format": "int64",
  7966. "description": "index of the issue",
  7967. "name": "index",
  7968. "in": "path",
  7969. "required": true
  7970. },
  7971. {
  7972. "name": "body",
  7973. "in": "body",
  7974. "schema": {
  7975. "$ref": "#/definitions/IssueLabelsOption"
  7976. }
  7977. }
  7978. ],
  7979. "responses": {
  7980. "200": {
  7981. "$ref": "#/responses/LabelList"
  7982. },
  7983. "403": {
  7984. "$ref": "#/responses/forbidden"
  7985. },
  7986. "404": {
  7987. "$ref": "#/responses/notFound"
  7988. }
  7989. }
  7990. },
  7991. "delete": {
  7992. "produces": [
  7993. "application/json"
  7994. ],
  7995. "tags": [
  7996. "issue"
  7997. ],
  7998. "summary": "Remove all labels from an issue",
  7999. "operationId": "issueClearLabels",
  8000. "parameters": [
  8001. {
  8002. "type": "string",
  8003. "description": "owner of the repo",
  8004. "name": "owner",
  8005. "in": "path",
  8006. "required": true
  8007. },
  8008. {
  8009. "type": "string",
  8010. "description": "name of the repo",
  8011. "name": "repo",
  8012. "in": "path",
  8013. "required": true
  8014. },
  8015. {
  8016. "type": "integer",
  8017. "format": "int64",
  8018. "description": "index of the issue",
  8019. "name": "index",
  8020. "in": "path",
  8021. "required": true
  8022. }
  8023. ],
  8024. "responses": {
  8025. "204": {
  8026. "$ref": "#/responses/empty"
  8027. },
  8028. "403": {
  8029. "$ref": "#/responses/forbidden"
  8030. },
  8031. "404": {
  8032. "$ref": "#/responses/notFound"
  8033. }
  8034. }
  8035. }
  8036. },
  8037. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  8038. "delete": {
  8039. "produces": [
  8040. "application/json"
  8041. ],
  8042. "tags": [
  8043. "issue"
  8044. ],
  8045. "summary": "Remove a label from an issue",
  8046. "operationId": "issueRemoveLabel",
  8047. "parameters": [
  8048. {
  8049. "type": "string",
  8050. "description": "owner of the repo",
  8051. "name": "owner",
  8052. "in": "path",
  8053. "required": true
  8054. },
  8055. {
  8056. "type": "string",
  8057. "description": "name of the repo",
  8058. "name": "repo",
  8059. "in": "path",
  8060. "required": true
  8061. },
  8062. {
  8063. "type": "integer",
  8064. "format": "int64",
  8065. "description": "index of the issue",
  8066. "name": "index",
  8067. "in": "path",
  8068. "required": true
  8069. },
  8070. {
  8071. "type": "integer",
  8072. "format": "int64",
  8073. "description": "id of the label to remove",
  8074. "name": "id",
  8075. "in": "path",
  8076. "required": true
  8077. }
  8078. ],
  8079. "responses": {
  8080. "204": {
  8081. "$ref": "#/responses/empty"
  8082. },
  8083. "403": {
  8084. "$ref": "#/responses/forbidden"
  8085. },
  8086. "404": {
  8087. "$ref": "#/responses/notFound"
  8088. },
  8089. "422": {
  8090. "$ref": "#/responses/validationError"
  8091. }
  8092. }
  8093. }
  8094. },
  8095. "/repos/{owner}/{repo}/issues/{index}/pin": {
  8096. "post": {
  8097. "tags": [
  8098. "issue"
  8099. ],
  8100. "summary": "Pin an Issue",
  8101. "operationId": "pinIssue",
  8102. "parameters": [
  8103. {
  8104. "type": "string",
  8105. "description": "owner of the repo",
  8106. "name": "owner",
  8107. "in": "path",
  8108. "required": true
  8109. },
  8110. {
  8111. "type": "string",
  8112. "description": "name of the repo",
  8113. "name": "repo",
  8114. "in": "path",
  8115. "required": true
  8116. },
  8117. {
  8118. "type": "integer",
  8119. "format": "int64",
  8120. "description": "index of issue to pin",
  8121. "name": "index",
  8122. "in": "path",
  8123. "required": true
  8124. }
  8125. ],
  8126. "responses": {
  8127. "204": {
  8128. "$ref": "#/responses/empty"
  8129. },
  8130. "403": {
  8131. "$ref": "#/responses/forbidden"
  8132. },
  8133. "404": {
  8134. "$ref": "#/responses/notFound"
  8135. }
  8136. }
  8137. },
  8138. "delete": {
  8139. "tags": [
  8140. "issue"
  8141. ],
  8142. "summary": "Unpin an Issue",
  8143. "operationId": "unpinIssue",
  8144. "parameters": [
  8145. {
  8146. "type": "string",
  8147. "description": "owner of the repo",
  8148. "name": "owner",
  8149. "in": "path",
  8150. "required": true
  8151. },
  8152. {
  8153. "type": "string",
  8154. "description": "name of the repo",
  8155. "name": "repo",
  8156. "in": "path",
  8157. "required": true
  8158. },
  8159. {
  8160. "type": "integer",
  8161. "format": "int64",
  8162. "description": "index of issue to unpin",
  8163. "name": "index",
  8164. "in": "path",
  8165. "required": true
  8166. }
  8167. ],
  8168. "responses": {
  8169. "204": {
  8170. "$ref": "#/responses/empty"
  8171. },
  8172. "403": {
  8173. "$ref": "#/responses/forbidden"
  8174. },
  8175. "404": {
  8176. "$ref": "#/responses/notFound"
  8177. }
  8178. }
  8179. }
  8180. },
  8181. "/repos/{owner}/{repo}/issues/{index}/pin/{position}": {
  8182. "patch": {
  8183. "tags": [
  8184. "issue"
  8185. ],
  8186. "summary": "Moves the Pin to the given Position",
  8187. "operationId": "moveIssuePin",
  8188. "parameters": [
  8189. {
  8190. "type": "string",
  8191. "description": "owner of the repo",
  8192. "name": "owner",
  8193. "in": "path",
  8194. "required": true
  8195. },
  8196. {
  8197. "type": "string",
  8198. "description": "name of the repo",
  8199. "name": "repo",
  8200. "in": "path",
  8201. "required": true
  8202. },
  8203. {
  8204. "type": "integer",
  8205. "format": "int64",
  8206. "description": "index of issue",
  8207. "name": "index",
  8208. "in": "path",
  8209. "required": true
  8210. },
  8211. {
  8212. "type": "integer",
  8213. "format": "int64",
  8214. "description": "the new position",
  8215. "name": "position",
  8216. "in": "path",
  8217. "required": true
  8218. }
  8219. ],
  8220. "responses": {
  8221. "204": {
  8222. "$ref": "#/responses/empty"
  8223. },
  8224. "403": {
  8225. "$ref": "#/responses/forbidden"
  8226. },
  8227. "404": {
  8228. "$ref": "#/responses/notFound"
  8229. }
  8230. }
  8231. }
  8232. },
  8233. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  8234. "get": {
  8235. "consumes": [
  8236. "application/json"
  8237. ],
  8238. "produces": [
  8239. "application/json"
  8240. ],
  8241. "tags": [
  8242. "issue"
  8243. ],
  8244. "summary": "Get a list reactions of an issue",
  8245. "operationId": "issueGetIssueReactions",
  8246. "parameters": [
  8247. {
  8248. "type": "string",
  8249. "description": "owner of the repo",
  8250. "name": "owner",
  8251. "in": "path",
  8252. "required": true
  8253. },
  8254. {
  8255. "type": "string",
  8256. "description": "name of the repo",
  8257. "name": "repo",
  8258. "in": "path",
  8259. "required": true
  8260. },
  8261. {
  8262. "type": "integer",
  8263. "format": "int64",
  8264. "description": "index of the issue",
  8265. "name": "index",
  8266. "in": "path",
  8267. "required": true
  8268. },
  8269. {
  8270. "type": "integer",
  8271. "description": "page number of results to return (1-based)",
  8272. "name": "page",
  8273. "in": "query"
  8274. },
  8275. {
  8276. "type": "integer",
  8277. "description": "page size of results",
  8278. "name": "limit",
  8279. "in": "query"
  8280. }
  8281. ],
  8282. "responses": {
  8283. "200": {
  8284. "$ref": "#/responses/ReactionList"
  8285. },
  8286. "403": {
  8287. "$ref": "#/responses/forbidden"
  8288. },
  8289. "404": {
  8290. "$ref": "#/responses/notFound"
  8291. }
  8292. }
  8293. },
  8294. "post": {
  8295. "consumes": [
  8296. "application/json"
  8297. ],
  8298. "produces": [
  8299. "application/json"
  8300. ],
  8301. "tags": [
  8302. "issue"
  8303. ],
  8304. "summary": "Add a reaction to an issue",
  8305. "operationId": "issuePostIssueReaction",
  8306. "parameters": [
  8307. {
  8308. "type": "string",
  8309. "description": "owner of the repo",
  8310. "name": "owner",
  8311. "in": "path",
  8312. "required": true
  8313. },
  8314. {
  8315. "type": "string",
  8316. "description": "name of the repo",
  8317. "name": "repo",
  8318. "in": "path",
  8319. "required": true
  8320. },
  8321. {
  8322. "type": "integer",
  8323. "format": "int64",
  8324. "description": "index of the issue",
  8325. "name": "index",
  8326. "in": "path",
  8327. "required": true
  8328. },
  8329. {
  8330. "name": "content",
  8331. "in": "body",
  8332. "schema": {
  8333. "$ref": "#/definitions/EditReactionOption"
  8334. }
  8335. }
  8336. ],
  8337. "responses": {
  8338. "200": {
  8339. "$ref": "#/responses/Reaction"
  8340. },
  8341. "201": {
  8342. "$ref": "#/responses/Reaction"
  8343. },
  8344. "403": {
  8345. "$ref": "#/responses/forbidden"
  8346. },
  8347. "404": {
  8348. "$ref": "#/responses/notFound"
  8349. }
  8350. }
  8351. },
  8352. "delete": {
  8353. "consumes": [
  8354. "application/json"
  8355. ],
  8356. "produces": [
  8357. "application/json"
  8358. ],
  8359. "tags": [
  8360. "issue"
  8361. ],
  8362. "summary": "Remove a reaction from an issue",
  8363. "operationId": "issueDeleteIssueReaction",
  8364. "parameters": [
  8365. {
  8366. "type": "string",
  8367. "description": "owner of the repo",
  8368. "name": "owner",
  8369. "in": "path",
  8370. "required": true
  8371. },
  8372. {
  8373. "type": "string",
  8374. "description": "name of the repo",
  8375. "name": "repo",
  8376. "in": "path",
  8377. "required": true
  8378. },
  8379. {
  8380. "type": "integer",
  8381. "format": "int64",
  8382. "description": "index of the issue",
  8383. "name": "index",
  8384. "in": "path",
  8385. "required": true
  8386. },
  8387. {
  8388. "name": "content",
  8389. "in": "body",
  8390. "schema": {
  8391. "$ref": "#/definitions/EditReactionOption"
  8392. }
  8393. }
  8394. ],
  8395. "responses": {
  8396. "200": {
  8397. "$ref": "#/responses/empty"
  8398. },
  8399. "403": {
  8400. "$ref": "#/responses/forbidden"
  8401. },
  8402. "404": {
  8403. "$ref": "#/responses/notFound"
  8404. }
  8405. }
  8406. }
  8407. },
  8408. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  8409. "delete": {
  8410. "consumes": [
  8411. "application/json"
  8412. ],
  8413. "produces": [
  8414. "application/json"
  8415. ],
  8416. "tags": [
  8417. "issue"
  8418. ],
  8419. "summary": "Delete an issue's existing stopwatch.",
  8420. "operationId": "issueDeleteStopWatch",
  8421. "parameters": [
  8422. {
  8423. "type": "string",
  8424. "description": "owner of the repo",
  8425. "name": "owner",
  8426. "in": "path",
  8427. "required": true
  8428. },
  8429. {
  8430. "type": "string",
  8431. "description": "name of the repo",
  8432. "name": "repo",
  8433. "in": "path",
  8434. "required": true
  8435. },
  8436. {
  8437. "type": "integer",
  8438. "format": "int64",
  8439. "description": "index of the issue to stop the stopwatch on",
  8440. "name": "index",
  8441. "in": "path",
  8442. "required": true
  8443. }
  8444. ],
  8445. "responses": {
  8446. "204": {
  8447. "$ref": "#/responses/empty"
  8448. },
  8449. "403": {
  8450. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8451. },
  8452. "404": {
  8453. "$ref": "#/responses/notFound"
  8454. },
  8455. "409": {
  8456. "description": "Cannot cancel a non existent stopwatch"
  8457. }
  8458. }
  8459. }
  8460. },
  8461. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  8462. "post": {
  8463. "consumes": [
  8464. "application/json"
  8465. ],
  8466. "produces": [
  8467. "application/json"
  8468. ],
  8469. "tags": [
  8470. "issue"
  8471. ],
  8472. "summary": "Start stopwatch on an issue.",
  8473. "operationId": "issueStartStopWatch",
  8474. "parameters": [
  8475. {
  8476. "type": "string",
  8477. "description": "owner of the repo",
  8478. "name": "owner",
  8479. "in": "path",
  8480. "required": true
  8481. },
  8482. {
  8483. "type": "string",
  8484. "description": "name of the repo",
  8485. "name": "repo",
  8486. "in": "path",
  8487. "required": true
  8488. },
  8489. {
  8490. "type": "integer",
  8491. "format": "int64",
  8492. "description": "index of the issue to create the stopwatch on",
  8493. "name": "index",
  8494. "in": "path",
  8495. "required": true
  8496. }
  8497. ],
  8498. "responses": {
  8499. "201": {
  8500. "$ref": "#/responses/empty"
  8501. },
  8502. "403": {
  8503. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8504. },
  8505. "404": {
  8506. "$ref": "#/responses/notFound"
  8507. },
  8508. "409": {
  8509. "description": "Cannot start a stopwatch again if it already exists"
  8510. }
  8511. }
  8512. }
  8513. },
  8514. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  8515. "post": {
  8516. "consumes": [
  8517. "application/json"
  8518. ],
  8519. "produces": [
  8520. "application/json"
  8521. ],
  8522. "tags": [
  8523. "issue"
  8524. ],
  8525. "summary": "Stop an issue's existing stopwatch.",
  8526. "operationId": "issueStopStopWatch",
  8527. "parameters": [
  8528. {
  8529. "type": "string",
  8530. "description": "owner of the repo",
  8531. "name": "owner",
  8532. "in": "path",
  8533. "required": true
  8534. },
  8535. {
  8536. "type": "string",
  8537. "description": "name of the repo",
  8538. "name": "repo",
  8539. "in": "path",
  8540. "required": true
  8541. },
  8542. {
  8543. "type": "integer",
  8544. "format": "int64",
  8545. "description": "index of the issue to stop the stopwatch on",
  8546. "name": "index",
  8547. "in": "path",
  8548. "required": true
  8549. }
  8550. ],
  8551. "responses": {
  8552. "201": {
  8553. "$ref": "#/responses/empty"
  8554. },
  8555. "403": {
  8556. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8557. },
  8558. "404": {
  8559. "$ref": "#/responses/notFound"
  8560. },
  8561. "409": {
  8562. "description": "Cannot stop a non existent stopwatch"
  8563. }
  8564. }
  8565. }
  8566. },
  8567. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  8568. "get": {
  8569. "consumes": [
  8570. "application/json"
  8571. ],
  8572. "produces": [
  8573. "application/json"
  8574. ],
  8575. "tags": [
  8576. "issue"
  8577. ],
  8578. "summary": "Get users who subscribed on an issue.",
  8579. "operationId": "issueSubscriptions",
  8580. "parameters": [
  8581. {
  8582. "type": "string",
  8583. "description": "owner of the repo",
  8584. "name": "owner",
  8585. "in": "path",
  8586. "required": true
  8587. },
  8588. {
  8589. "type": "string",
  8590. "description": "name of the repo",
  8591. "name": "repo",
  8592. "in": "path",
  8593. "required": true
  8594. },
  8595. {
  8596. "type": "integer",
  8597. "format": "int64",
  8598. "description": "index of the issue",
  8599. "name": "index",
  8600. "in": "path",
  8601. "required": true
  8602. },
  8603. {
  8604. "type": "integer",
  8605. "description": "page number of results to return (1-based)",
  8606. "name": "page",
  8607. "in": "query"
  8608. },
  8609. {
  8610. "type": "integer",
  8611. "description": "page size of results",
  8612. "name": "limit",
  8613. "in": "query"
  8614. }
  8615. ],
  8616. "responses": {
  8617. "200": {
  8618. "$ref": "#/responses/UserList"
  8619. },
  8620. "404": {
  8621. "$ref": "#/responses/notFound"
  8622. }
  8623. }
  8624. }
  8625. },
  8626. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  8627. "get": {
  8628. "consumes": [
  8629. "application/json"
  8630. ],
  8631. "produces": [
  8632. "application/json"
  8633. ],
  8634. "tags": [
  8635. "issue"
  8636. ],
  8637. "summary": "Check if user is subscribed to an issue",
  8638. "operationId": "issueCheckSubscription",
  8639. "parameters": [
  8640. {
  8641. "type": "string",
  8642. "description": "owner of the repo",
  8643. "name": "owner",
  8644. "in": "path",
  8645. "required": true
  8646. },
  8647. {
  8648. "type": "string",
  8649. "description": "name of the repo",
  8650. "name": "repo",
  8651. "in": "path",
  8652. "required": true
  8653. },
  8654. {
  8655. "type": "integer",
  8656. "format": "int64",
  8657. "description": "index of the issue",
  8658. "name": "index",
  8659. "in": "path",
  8660. "required": true
  8661. }
  8662. ],
  8663. "responses": {
  8664. "200": {
  8665. "$ref": "#/responses/WatchInfo"
  8666. },
  8667. "404": {
  8668. "$ref": "#/responses/notFound"
  8669. }
  8670. }
  8671. }
  8672. },
  8673. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  8674. "put": {
  8675. "consumes": [
  8676. "application/json"
  8677. ],
  8678. "produces": [
  8679. "application/json"
  8680. ],
  8681. "tags": [
  8682. "issue"
  8683. ],
  8684. "summary": "Subscribe user to issue",
  8685. "operationId": "issueAddSubscription",
  8686. "parameters": [
  8687. {
  8688. "type": "string",
  8689. "description": "owner of the repo",
  8690. "name": "owner",
  8691. "in": "path",
  8692. "required": true
  8693. },
  8694. {
  8695. "type": "string",
  8696. "description": "name of the repo",
  8697. "name": "repo",
  8698. "in": "path",
  8699. "required": true
  8700. },
  8701. {
  8702. "type": "integer",
  8703. "format": "int64",
  8704. "description": "index of the issue",
  8705. "name": "index",
  8706. "in": "path",
  8707. "required": true
  8708. },
  8709. {
  8710. "type": "string",
  8711. "description": "user to subscribe",
  8712. "name": "user",
  8713. "in": "path",
  8714. "required": true
  8715. }
  8716. ],
  8717. "responses": {
  8718. "200": {
  8719. "description": "Already subscribed"
  8720. },
  8721. "201": {
  8722. "description": "Successfully Subscribed"
  8723. },
  8724. "304": {
  8725. "description": "User can only subscribe itself if he is no admin"
  8726. },
  8727. "404": {
  8728. "$ref": "#/responses/notFound"
  8729. }
  8730. }
  8731. },
  8732. "delete": {
  8733. "consumes": [
  8734. "application/json"
  8735. ],
  8736. "produces": [
  8737. "application/json"
  8738. ],
  8739. "tags": [
  8740. "issue"
  8741. ],
  8742. "summary": "Unsubscribe user from issue",
  8743. "operationId": "issueDeleteSubscription",
  8744. "parameters": [
  8745. {
  8746. "type": "string",
  8747. "description": "owner of the repo",
  8748. "name": "owner",
  8749. "in": "path",
  8750. "required": true
  8751. },
  8752. {
  8753. "type": "string",
  8754. "description": "name of the repo",
  8755. "name": "repo",
  8756. "in": "path",
  8757. "required": true
  8758. },
  8759. {
  8760. "type": "integer",
  8761. "format": "int64",
  8762. "description": "index of the issue",
  8763. "name": "index",
  8764. "in": "path",
  8765. "required": true
  8766. },
  8767. {
  8768. "type": "string",
  8769. "description": "user witch unsubscribe",
  8770. "name": "user",
  8771. "in": "path",
  8772. "required": true
  8773. }
  8774. ],
  8775. "responses": {
  8776. "200": {
  8777. "description": "Already unsubscribed"
  8778. },
  8779. "201": {
  8780. "description": "Successfully Unsubscribed"
  8781. },
  8782. "304": {
  8783. "description": "User can only subscribe itself if he is no admin"
  8784. },
  8785. "404": {
  8786. "$ref": "#/responses/notFound"
  8787. }
  8788. }
  8789. }
  8790. },
  8791. "/repos/{owner}/{repo}/issues/{index}/timeline": {
  8792. "get": {
  8793. "produces": [
  8794. "application/json"
  8795. ],
  8796. "tags": [
  8797. "issue"
  8798. ],
  8799. "summary": "List all comments and events on an issue",
  8800. "operationId": "issueGetCommentsAndTimeline",
  8801. "parameters": [
  8802. {
  8803. "type": "string",
  8804. "description": "owner of the repo",
  8805. "name": "owner",
  8806. "in": "path",
  8807. "required": true
  8808. },
  8809. {
  8810. "type": "string",
  8811. "description": "name of the repo",
  8812. "name": "repo",
  8813. "in": "path",
  8814. "required": true
  8815. },
  8816. {
  8817. "type": "integer",
  8818. "format": "int64",
  8819. "description": "index of the issue",
  8820. "name": "index",
  8821. "in": "path",
  8822. "required": true
  8823. },
  8824. {
  8825. "type": "string",
  8826. "format": "date-time",
  8827. "description": "if provided, only comments updated since the specified time are returned.",
  8828. "name": "since",
  8829. "in": "query"
  8830. },
  8831. {
  8832. "type": "integer",
  8833. "description": "page number of results to return (1-based)",
  8834. "name": "page",
  8835. "in": "query"
  8836. },
  8837. {
  8838. "type": "integer",
  8839. "description": "page size of results",
  8840. "name": "limit",
  8841. "in": "query"
  8842. },
  8843. {
  8844. "type": "string",
  8845. "format": "date-time",
  8846. "description": "if provided, only comments updated before the provided time are returned.",
  8847. "name": "before",
  8848. "in": "query"
  8849. }
  8850. ],
  8851. "responses": {
  8852. "200": {
  8853. "$ref": "#/responses/TimelineList"
  8854. },
  8855. "404": {
  8856. "$ref": "#/responses/notFound"
  8857. }
  8858. }
  8859. }
  8860. },
  8861. "/repos/{owner}/{repo}/issues/{index}/times": {
  8862. "get": {
  8863. "produces": [
  8864. "application/json"
  8865. ],
  8866. "tags": [
  8867. "issue"
  8868. ],
  8869. "summary": "List an issue's tracked times",
  8870. "operationId": "issueTrackedTimes",
  8871. "parameters": [
  8872. {
  8873. "type": "string",
  8874. "description": "owner of the repo",
  8875. "name": "owner",
  8876. "in": "path",
  8877. "required": true
  8878. },
  8879. {
  8880. "type": "string",
  8881. "description": "name of the repo",
  8882. "name": "repo",
  8883. "in": "path",
  8884. "required": true
  8885. },
  8886. {
  8887. "type": "integer",
  8888. "format": "int64",
  8889. "description": "index of the issue",
  8890. "name": "index",
  8891. "in": "path",
  8892. "required": true
  8893. },
  8894. {
  8895. "type": "string",
  8896. "description": "optional filter by user (available for issue managers)",
  8897. "name": "user",
  8898. "in": "query"
  8899. },
  8900. {
  8901. "type": "string",
  8902. "format": "date-time",
  8903. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8904. "name": "since",
  8905. "in": "query"
  8906. },
  8907. {
  8908. "type": "string",
  8909. "format": "date-time",
  8910. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8911. "name": "before",
  8912. "in": "query"
  8913. },
  8914. {
  8915. "type": "integer",
  8916. "description": "page number of results to return (1-based)",
  8917. "name": "page",
  8918. "in": "query"
  8919. },
  8920. {
  8921. "type": "integer",
  8922. "description": "page size of results",
  8923. "name": "limit",
  8924. "in": "query"
  8925. }
  8926. ],
  8927. "responses": {
  8928. "200": {
  8929. "$ref": "#/responses/TrackedTimeList"
  8930. },
  8931. "404": {
  8932. "$ref": "#/responses/notFound"
  8933. }
  8934. }
  8935. },
  8936. "post": {
  8937. "consumes": [
  8938. "application/json"
  8939. ],
  8940. "produces": [
  8941. "application/json"
  8942. ],
  8943. "tags": [
  8944. "issue"
  8945. ],
  8946. "summary": "Add tracked time to a issue",
  8947. "operationId": "issueAddTime",
  8948. "parameters": [
  8949. {
  8950. "type": "string",
  8951. "description": "owner of the repo",
  8952. "name": "owner",
  8953. "in": "path",
  8954. "required": true
  8955. },
  8956. {
  8957. "type": "string",
  8958. "description": "name of the repo",
  8959. "name": "repo",
  8960. "in": "path",
  8961. "required": true
  8962. },
  8963. {
  8964. "type": "integer",
  8965. "format": "int64",
  8966. "description": "index of the issue",
  8967. "name": "index",
  8968. "in": "path",
  8969. "required": true
  8970. },
  8971. {
  8972. "name": "body",
  8973. "in": "body",
  8974. "schema": {
  8975. "$ref": "#/definitions/AddTimeOption"
  8976. }
  8977. }
  8978. ],
  8979. "responses": {
  8980. "200": {
  8981. "$ref": "#/responses/TrackedTime"
  8982. },
  8983. "400": {
  8984. "$ref": "#/responses/error"
  8985. },
  8986. "403": {
  8987. "$ref": "#/responses/forbidden"
  8988. },
  8989. "404": {
  8990. "$ref": "#/responses/notFound"
  8991. }
  8992. }
  8993. },
  8994. "delete": {
  8995. "consumes": [
  8996. "application/json"
  8997. ],
  8998. "produces": [
  8999. "application/json"
  9000. ],
  9001. "tags": [
  9002. "issue"
  9003. ],
  9004. "summary": "Reset a tracked time of an issue",
  9005. "operationId": "issueResetTime",
  9006. "parameters": [
  9007. {
  9008. "type": "string",
  9009. "description": "owner of the repo",
  9010. "name": "owner",
  9011. "in": "path",
  9012. "required": true
  9013. },
  9014. {
  9015. "type": "string",
  9016. "description": "name of the repo",
  9017. "name": "repo",
  9018. "in": "path",
  9019. "required": true
  9020. },
  9021. {
  9022. "type": "integer",
  9023. "format": "int64",
  9024. "description": "index of the issue to add tracked time to",
  9025. "name": "index",
  9026. "in": "path",
  9027. "required": true
  9028. }
  9029. ],
  9030. "responses": {
  9031. "204": {
  9032. "$ref": "#/responses/empty"
  9033. },
  9034. "400": {
  9035. "$ref": "#/responses/error"
  9036. },
  9037. "403": {
  9038. "$ref": "#/responses/forbidden"
  9039. },
  9040. "404": {
  9041. "$ref": "#/responses/notFound"
  9042. }
  9043. }
  9044. }
  9045. },
  9046. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  9047. "delete": {
  9048. "consumes": [
  9049. "application/json"
  9050. ],
  9051. "produces": [
  9052. "application/json"
  9053. ],
  9054. "tags": [
  9055. "issue"
  9056. ],
  9057. "summary": "Delete specific tracked time",
  9058. "operationId": "issueDeleteTime",
  9059. "parameters": [
  9060. {
  9061. "type": "string",
  9062. "description": "owner of the repo",
  9063. "name": "owner",
  9064. "in": "path",
  9065. "required": true
  9066. },
  9067. {
  9068. "type": "string",
  9069. "description": "name of the repo",
  9070. "name": "repo",
  9071. "in": "path",
  9072. "required": true
  9073. },
  9074. {
  9075. "type": "integer",
  9076. "format": "int64",
  9077. "description": "index of the issue",
  9078. "name": "index",
  9079. "in": "path",
  9080. "required": true
  9081. },
  9082. {
  9083. "type": "integer",
  9084. "format": "int64",
  9085. "description": "id of time to delete",
  9086. "name": "id",
  9087. "in": "path",
  9088. "required": true
  9089. }
  9090. ],
  9091. "responses": {
  9092. "204": {
  9093. "$ref": "#/responses/empty"
  9094. },
  9095. "400": {
  9096. "$ref": "#/responses/error"
  9097. },
  9098. "403": {
  9099. "$ref": "#/responses/forbidden"
  9100. },
  9101. "404": {
  9102. "$ref": "#/responses/notFound"
  9103. }
  9104. }
  9105. }
  9106. },
  9107. "/repos/{owner}/{repo}/keys": {
  9108. "get": {
  9109. "produces": [
  9110. "application/json"
  9111. ],
  9112. "tags": [
  9113. "repository"
  9114. ],
  9115. "summary": "List a repository's keys",
  9116. "operationId": "repoListKeys",
  9117. "parameters": [
  9118. {
  9119. "type": "string",
  9120. "description": "owner of the repo",
  9121. "name": "owner",
  9122. "in": "path",
  9123. "required": true
  9124. },
  9125. {
  9126. "type": "string",
  9127. "description": "name of the repo",
  9128. "name": "repo",
  9129. "in": "path",
  9130. "required": true
  9131. },
  9132. {
  9133. "type": "integer",
  9134. "description": "the key_id to search for",
  9135. "name": "key_id",
  9136. "in": "query"
  9137. },
  9138. {
  9139. "type": "string",
  9140. "description": "fingerprint of the key",
  9141. "name": "fingerprint",
  9142. "in": "query"
  9143. },
  9144. {
  9145. "type": "integer",
  9146. "description": "page number of results to return (1-based)",
  9147. "name": "page",
  9148. "in": "query"
  9149. },
  9150. {
  9151. "type": "integer",
  9152. "description": "page size of results",
  9153. "name": "limit",
  9154. "in": "query"
  9155. }
  9156. ],
  9157. "responses": {
  9158. "200": {
  9159. "$ref": "#/responses/DeployKeyList"
  9160. },
  9161. "404": {
  9162. "$ref": "#/responses/notFound"
  9163. }
  9164. }
  9165. },
  9166. "post": {
  9167. "consumes": [
  9168. "application/json"
  9169. ],
  9170. "produces": [
  9171. "application/json"
  9172. ],
  9173. "tags": [
  9174. "repository"
  9175. ],
  9176. "summary": "Add a key to a repository",
  9177. "operationId": "repoCreateKey",
  9178. "parameters": [
  9179. {
  9180. "type": "string",
  9181. "description": "owner of the repo",
  9182. "name": "owner",
  9183. "in": "path",
  9184. "required": true
  9185. },
  9186. {
  9187. "type": "string",
  9188. "description": "name of the repo",
  9189. "name": "repo",
  9190. "in": "path",
  9191. "required": true
  9192. },
  9193. {
  9194. "name": "body",
  9195. "in": "body",
  9196. "schema": {
  9197. "$ref": "#/definitions/CreateKeyOption"
  9198. }
  9199. }
  9200. ],
  9201. "responses": {
  9202. "201": {
  9203. "$ref": "#/responses/DeployKey"
  9204. },
  9205. "404": {
  9206. "$ref": "#/responses/notFound"
  9207. },
  9208. "422": {
  9209. "$ref": "#/responses/validationError"
  9210. }
  9211. }
  9212. }
  9213. },
  9214. "/repos/{owner}/{repo}/keys/{id}": {
  9215. "get": {
  9216. "produces": [
  9217. "application/json"
  9218. ],
  9219. "tags": [
  9220. "repository"
  9221. ],
  9222. "summary": "Get a repository's key by id",
  9223. "operationId": "repoGetKey",
  9224. "parameters": [
  9225. {
  9226. "type": "string",
  9227. "description": "owner of the repo",
  9228. "name": "owner",
  9229. "in": "path",
  9230. "required": true
  9231. },
  9232. {
  9233. "type": "string",
  9234. "description": "name of the repo",
  9235. "name": "repo",
  9236. "in": "path",
  9237. "required": true
  9238. },
  9239. {
  9240. "type": "integer",
  9241. "format": "int64",
  9242. "description": "id of the key to get",
  9243. "name": "id",
  9244. "in": "path",
  9245. "required": true
  9246. }
  9247. ],
  9248. "responses": {
  9249. "200": {
  9250. "$ref": "#/responses/DeployKey"
  9251. },
  9252. "404": {
  9253. "$ref": "#/responses/notFound"
  9254. }
  9255. }
  9256. },
  9257. "delete": {
  9258. "tags": [
  9259. "repository"
  9260. ],
  9261. "summary": "Delete a key from a repository",
  9262. "operationId": "repoDeleteKey",
  9263. "parameters": [
  9264. {
  9265. "type": "string",
  9266. "description": "owner of the repo",
  9267. "name": "owner",
  9268. "in": "path",
  9269. "required": true
  9270. },
  9271. {
  9272. "type": "string",
  9273. "description": "name of the repo",
  9274. "name": "repo",
  9275. "in": "path",
  9276. "required": true
  9277. },
  9278. {
  9279. "type": "integer",
  9280. "format": "int64",
  9281. "description": "id of the key to delete",
  9282. "name": "id",
  9283. "in": "path",
  9284. "required": true
  9285. }
  9286. ],
  9287. "responses": {
  9288. "204": {
  9289. "$ref": "#/responses/empty"
  9290. },
  9291. "403": {
  9292. "$ref": "#/responses/forbidden"
  9293. },
  9294. "404": {
  9295. "$ref": "#/responses/notFound"
  9296. }
  9297. }
  9298. }
  9299. },
  9300. "/repos/{owner}/{repo}/labels": {
  9301. "get": {
  9302. "produces": [
  9303. "application/json"
  9304. ],
  9305. "tags": [
  9306. "issue"
  9307. ],
  9308. "summary": "Get all of a repository's labels",
  9309. "operationId": "issueListLabels",
  9310. "parameters": [
  9311. {
  9312. "type": "string",
  9313. "description": "owner of the repo",
  9314. "name": "owner",
  9315. "in": "path",
  9316. "required": true
  9317. },
  9318. {
  9319. "type": "string",
  9320. "description": "name of the repo",
  9321. "name": "repo",
  9322. "in": "path",
  9323. "required": true
  9324. },
  9325. {
  9326. "type": "integer",
  9327. "description": "page number of results to return (1-based)",
  9328. "name": "page",
  9329. "in": "query"
  9330. },
  9331. {
  9332. "type": "integer",
  9333. "description": "page size of results",
  9334. "name": "limit",
  9335. "in": "query"
  9336. }
  9337. ],
  9338. "responses": {
  9339. "200": {
  9340. "$ref": "#/responses/LabelList"
  9341. },
  9342. "404": {
  9343. "$ref": "#/responses/notFound"
  9344. }
  9345. }
  9346. },
  9347. "post": {
  9348. "consumes": [
  9349. "application/json"
  9350. ],
  9351. "produces": [
  9352. "application/json"
  9353. ],
  9354. "tags": [
  9355. "issue"
  9356. ],
  9357. "summary": "Create a label",
  9358. "operationId": "issueCreateLabel",
  9359. "parameters": [
  9360. {
  9361. "type": "string",
  9362. "description": "owner of the repo",
  9363. "name": "owner",
  9364. "in": "path",
  9365. "required": true
  9366. },
  9367. {
  9368. "type": "string",
  9369. "description": "name of the repo",
  9370. "name": "repo",
  9371. "in": "path",
  9372. "required": true
  9373. },
  9374. {
  9375. "name": "body",
  9376. "in": "body",
  9377. "schema": {
  9378. "$ref": "#/definitions/CreateLabelOption"
  9379. }
  9380. }
  9381. ],
  9382. "responses": {
  9383. "201": {
  9384. "$ref": "#/responses/Label"
  9385. },
  9386. "404": {
  9387. "$ref": "#/responses/notFound"
  9388. },
  9389. "422": {
  9390. "$ref": "#/responses/validationError"
  9391. }
  9392. }
  9393. }
  9394. },
  9395. "/repos/{owner}/{repo}/labels/{id}": {
  9396. "get": {
  9397. "produces": [
  9398. "application/json"
  9399. ],
  9400. "tags": [
  9401. "issue"
  9402. ],
  9403. "summary": "Get a single label",
  9404. "operationId": "issueGetLabel",
  9405. "parameters": [
  9406. {
  9407. "type": "string",
  9408. "description": "owner of the repo",
  9409. "name": "owner",
  9410. "in": "path",
  9411. "required": true
  9412. },
  9413. {
  9414. "type": "string",
  9415. "description": "name of the repo",
  9416. "name": "repo",
  9417. "in": "path",
  9418. "required": true
  9419. },
  9420. {
  9421. "type": "integer",
  9422. "format": "int64",
  9423. "description": "id of the label to get",
  9424. "name": "id",
  9425. "in": "path",
  9426. "required": true
  9427. }
  9428. ],
  9429. "responses": {
  9430. "200": {
  9431. "$ref": "#/responses/Label"
  9432. },
  9433. "404": {
  9434. "$ref": "#/responses/notFound"
  9435. }
  9436. }
  9437. },
  9438. "delete": {
  9439. "tags": [
  9440. "issue"
  9441. ],
  9442. "summary": "Delete a label",
  9443. "operationId": "issueDeleteLabel",
  9444. "parameters": [
  9445. {
  9446. "type": "string",
  9447. "description": "owner of the repo",
  9448. "name": "owner",
  9449. "in": "path",
  9450. "required": true
  9451. },
  9452. {
  9453. "type": "string",
  9454. "description": "name of the repo",
  9455. "name": "repo",
  9456. "in": "path",
  9457. "required": true
  9458. },
  9459. {
  9460. "type": "integer",
  9461. "format": "int64",
  9462. "description": "id of the label to delete",
  9463. "name": "id",
  9464. "in": "path",
  9465. "required": true
  9466. }
  9467. ],
  9468. "responses": {
  9469. "204": {
  9470. "$ref": "#/responses/empty"
  9471. },
  9472. "404": {
  9473. "$ref": "#/responses/notFound"
  9474. }
  9475. }
  9476. },
  9477. "patch": {
  9478. "consumes": [
  9479. "application/json"
  9480. ],
  9481. "produces": [
  9482. "application/json"
  9483. ],
  9484. "tags": [
  9485. "issue"
  9486. ],
  9487. "summary": "Update a label",
  9488. "operationId": "issueEditLabel",
  9489. "parameters": [
  9490. {
  9491. "type": "string",
  9492. "description": "owner of the repo",
  9493. "name": "owner",
  9494. "in": "path",
  9495. "required": true
  9496. },
  9497. {
  9498. "type": "string",
  9499. "description": "name of the repo",
  9500. "name": "repo",
  9501. "in": "path",
  9502. "required": true
  9503. },
  9504. {
  9505. "type": "integer",
  9506. "format": "int64",
  9507. "description": "id of the label to edit",
  9508. "name": "id",
  9509. "in": "path",
  9510. "required": true
  9511. },
  9512. {
  9513. "name": "body",
  9514. "in": "body",
  9515. "schema": {
  9516. "$ref": "#/definitions/EditLabelOption"
  9517. }
  9518. }
  9519. ],
  9520. "responses": {
  9521. "200": {
  9522. "$ref": "#/responses/Label"
  9523. },
  9524. "404": {
  9525. "$ref": "#/responses/notFound"
  9526. },
  9527. "422": {
  9528. "$ref": "#/responses/validationError"
  9529. }
  9530. }
  9531. }
  9532. },
  9533. "/repos/{owner}/{repo}/languages": {
  9534. "get": {
  9535. "produces": [
  9536. "application/json"
  9537. ],
  9538. "tags": [
  9539. "repository"
  9540. ],
  9541. "summary": "Get languages and number of bytes of code written",
  9542. "operationId": "repoGetLanguages",
  9543. "parameters": [
  9544. {
  9545. "type": "string",
  9546. "description": "owner of the repo",
  9547. "name": "owner",
  9548. "in": "path",
  9549. "required": true
  9550. },
  9551. {
  9552. "type": "string",
  9553. "description": "name of the repo",
  9554. "name": "repo",
  9555. "in": "path",
  9556. "required": true
  9557. }
  9558. ],
  9559. "responses": {
  9560. "200": {
  9561. "$ref": "#/responses/LanguageStatistics"
  9562. },
  9563. "404": {
  9564. "$ref": "#/responses/notFound"
  9565. }
  9566. }
  9567. }
  9568. },
  9569. "/repos/{owner}/{repo}/media/{filepath}": {
  9570. "get": {
  9571. "tags": [
  9572. "repository"
  9573. ],
  9574. "summary": "Get a file or it's LFS object from a repository",
  9575. "operationId": "repoGetRawFileOrLFS",
  9576. "parameters": [
  9577. {
  9578. "type": "string",
  9579. "description": "owner of the repo",
  9580. "name": "owner",
  9581. "in": "path",
  9582. "required": true
  9583. },
  9584. {
  9585. "type": "string",
  9586. "description": "name of the repo",
  9587. "name": "repo",
  9588. "in": "path",
  9589. "required": true
  9590. },
  9591. {
  9592. "type": "string",
  9593. "description": "filepath of the file to get",
  9594. "name": "filepath",
  9595. "in": "path",
  9596. "required": true
  9597. },
  9598. {
  9599. "type": "string",
  9600. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  9601. "name": "ref",
  9602. "in": "query"
  9603. }
  9604. ],
  9605. "responses": {
  9606. "200": {
  9607. "description": "Returns raw file content."
  9608. },
  9609. "404": {
  9610. "$ref": "#/responses/notFound"
  9611. }
  9612. }
  9613. }
  9614. },
  9615. "/repos/{owner}/{repo}/milestones": {
  9616. "get": {
  9617. "produces": [
  9618. "application/json"
  9619. ],
  9620. "tags": [
  9621. "issue"
  9622. ],
  9623. "summary": "Get all of a repository's opened milestones",
  9624. "operationId": "issueGetMilestonesList",
  9625. "parameters": [
  9626. {
  9627. "type": "string",
  9628. "description": "owner of the repo",
  9629. "name": "owner",
  9630. "in": "path",
  9631. "required": true
  9632. },
  9633. {
  9634. "type": "string",
  9635. "description": "name of the repo",
  9636. "name": "repo",
  9637. "in": "path",
  9638. "required": true
  9639. },
  9640. {
  9641. "type": "string",
  9642. "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
  9643. "name": "state",
  9644. "in": "query"
  9645. },
  9646. {
  9647. "type": "string",
  9648. "description": "filter by milestone name",
  9649. "name": "name",
  9650. "in": "query"
  9651. },
  9652. {
  9653. "type": "integer",
  9654. "description": "page number of results to return (1-based)",
  9655. "name": "page",
  9656. "in": "query"
  9657. },
  9658. {
  9659. "type": "integer",
  9660. "description": "page size of results",
  9661. "name": "limit",
  9662. "in": "query"
  9663. }
  9664. ],
  9665. "responses": {
  9666. "200": {
  9667. "$ref": "#/responses/MilestoneList"
  9668. },
  9669. "404": {
  9670. "$ref": "#/responses/notFound"
  9671. }
  9672. }
  9673. },
  9674. "post": {
  9675. "consumes": [
  9676. "application/json"
  9677. ],
  9678. "produces": [
  9679. "application/json"
  9680. ],
  9681. "tags": [
  9682. "issue"
  9683. ],
  9684. "summary": "Create a milestone",
  9685. "operationId": "issueCreateMilestone",
  9686. "parameters": [
  9687. {
  9688. "type": "string",
  9689. "description": "owner of the repo",
  9690. "name": "owner",
  9691. "in": "path",
  9692. "required": true
  9693. },
  9694. {
  9695. "type": "string",
  9696. "description": "name of the repo",
  9697. "name": "repo",
  9698. "in": "path",
  9699. "required": true
  9700. },
  9701. {
  9702. "name": "body",
  9703. "in": "body",
  9704. "schema": {
  9705. "$ref": "#/definitions/CreateMilestoneOption"
  9706. }
  9707. }
  9708. ],
  9709. "responses": {
  9710. "201": {
  9711. "$ref": "#/responses/Milestone"
  9712. },
  9713. "404": {
  9714. "$ref": "#/responses/notFound"
  9715. }
  9716. }
  9717. }
  9718. },
  9719. "/repos/{owner}/{repo}/milestones/{id}": {
  9720. "get": {
  9721. "produces": [
  9722. "application/json"
  9723. ],
  9724. "tags": [
  9725. "issue"
  9726. ],
  9727. "summary": "Get a milestone",
  9728. "operationId": "issueGetMilestone",
  9729. "parameters": [
  9730. {
  9731. "type": "string",
  9732. "description": "owner of the repo",
  9733. "name": "owner",
  9734. "in": "path",
  9735. "required": true
  9736. },
  9737. {
  9738. "type": "string",
  9739. "description": "name of the repo",
  9740. "name": "repo",
  9741. "in": "path",
  9742. "required": true
  9743. },
  9744. {
  9745. "type": "string",
  9746. "description": "the milestone to get, identified by ID and if not available by name",
  9747. "name": "id",
  9748. "in": "path",
  9749. "required": true
  9750. }
  9751. ],
  9752. "responses": {
  9753. "200": {
  9754. "$ref": "#/responses/Milestone"
  9755. },
  9756. "404": {
  9757. "$ref": "#/responses/notFound"
  9758. }
  9759. }
  9760. },
  9761. "delete": {
  9762. "tags": [
  9763. "issue"
  9764. ],
  9765. "summary": "Delete a milestone",
  9766. "operationId": "issueDeleteMilestone",
  9767. "parameters": [
  9768. {
  9769. "type": "string",
  9770. "description": "owner of the repo",
  9771. "name": "owner",
  9772. "in": "path",
  9773. "required": true
  9774. },
  9775. {
  9776. "type": "string",
  9777. "description": "name of the repo",
  9778. "name": "repo",
  9779. "in": "path",
  9780. "required": true
  9781. },
  9782. {
  9783. "type": "string",
  9784. "description": "the milestone to delete, identified by ID and if not available by name",
  9785. "name": "id",
  9786. "in": "path",
  9787. "required": true
  9788. }
  9789. ],
  9790. "responses": {
  9791. "204": {
  9792. "$ref": "#/responses/empty"
  9793. },
  9794. "404": {
  9795. "$ref": "#/responses/notFound"
  9796. }
  9797. }
  9798. },
  9799. "patch": {
  9800. "consumes": [
  9801. "application/json"
  9802. ],
  9803. "produces": [
  9804. "application/json"
  9805. ],
  9806. "tags": [
  9807. "issue"
  9808. ],
  9809. "summary": "Update a milestone",
  9810. "operationId": "issueEditMilestone",
  9811. "parameters": [
  9812. {
  9813. "type": "string",
  9814. "description": "owner of the repo",
  9815. "name": "owner",
  9816. "in": "path",
  9817. "required": true
  9818. },
  9819. {
  9820. "type": "string",
  9821. "description": "name of the repo",
  9822. "name": "repo",
  9823. "in": "path",
  9824. "required": true
  9825. },
  9826. {
  9827. "type": "string",
  9828. "description": "the milestone to edit, identified by ID and if not available by name",
  9829. "name": "id",
  9830. "in": "path",
  9831. "required": true
  9832. },
  9833. {
  9834. "name": "body",
  9835. "in": "body",
  9836. "schema": {
  9837. "$ref": "#/definitions/EditMilestoneOption"
  9838. }
  9839. }
  9840. ],
  9841. "responses": {
  9842. "200": {
  9843. "$ref": "#/responses/Milestone"
  9844. },
  9845. "404": {
  9846. "$ref": "#/responses/notFound"
  9847. }
  9848. }
  9849. }
  9850. },
  9851. "/repos/{owner}/{repo}/mirror-sync": {
  9852. "post": {
  9853. "produces": [
  9854. "application/json"
  9855. ],
  9856. "tags": [
  9857. "repository"
  9858. ],
  9859. "summary": "Sync a mirrored repository",
  9860. "operationId": "repoMirrorSync",
  9861. "parameters": [
  9862. {
  9863. "type": "string",
  9864. "description": "owner of the repo to sync",
  9865. "name": "owner",
  9866. "in": "path",
  9867. "required": true
  9868. },
  9869. {
  9870. "type": "string",
  9871. "description": "name of the repo to sync",
  9872. "name": "repo",
  9873. "in": "path",
  9874. "required": true
  9875. }
  9876. ],
  9877. "responses": {
  9878. "200": {
  9879. "$ref": "#/responses/empty"
  9880. },
  9881. "403": {
  9882. "$ref": "#/responses/forbidden"
  9883. },
  9884. "404": {
  9885. "$ref": "#/responses/notFound"
  9886. }
  9887. }
  9888. }
  9889. },
  9890. "/repos/{owner}/{repo}/new_pin_allowed": {
  9891. "get": {
  9892. "produces": [
  9893. "application/json"
  9894. ],
  9895. "tags": [
  9896. "repository"
  9897. ],
  9898. "summary": "Returns if new Issue Pins are allowed",
  9899. "operationId": "repoNewPinAllowed",
  9900. "parameters": [
  9901. {
  9902. "type": "string",
  9903. "description": "owner of the repo",
  9904. "name": "owner",
  9905. "in": "path",
  9906. "required": true
  9907. },
  9908. {
  9909. "type": "string",
  9910. "description": "name of the repo",
  9911. "name": "repo",
  9912. "in": "path",
  9913. "required": true
  9914. }
  9915. ],
  9916. "responses": {
  9917. "200": {
  9918. "$ref": "#/responses/RepoNewIssuePinsAllowed"
  9919. },
  9920. "404": {
  9921. "$ref": "#/responses/notFound"
  9922. }
  9923. }
  9924. }
  9925. },
  9926. "/repos/{owner}/{repo}/notifications": {
  9927. "get": {
  9928. "consumes": [
  9929. "application/json"
  9930. ],
  9931. "produces": [
  9932. "application/json"
  9933. ],
  9934. "tags": [
  9935. "notification"
  9936. ],
  9937. "summary": "List users's notification threads on a specific repo",
  9938. "operationId": "notifyGetRepoList",
  9939. "parameters": [
  9940. {
  9941. "type": "string",
  9942. "description": "owner of the repo",
  9943. "name": "owner",
  9944. "in": "path",
  9945. "required": true
  9946. },
  9947. {
  9948. "type": "string",
  9949. "description": "name of the repo",
  9950. "name": "repo",
  9951. "in": "path",
  9952. "required": true
  9953. },
  9954. {
  9955. "type": "boolean",
  9956. "description": "If true, show notifications marked as read. Default value is false",
  9957. "name": "all",
  9958. "in": "query"
  9959. },
  9960. {
  9961. "type": "array",
  9962. "items": {
  9963. "type": "string"
  9964. },
  9965. "collectionFormat": "multi",
  9966. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  9967. "name": "status-types",
  9968. "in": "query"
  9969. },
  9970. {
  9971. "type": "array",
  9972. "items": {
  9973. "enum": [
  9974. "issue",
  9975. "pull",
  9976. "commit",
  9977. "repository"
  9978. ],
  9979. "type": "string"
  9980. },
  9981. "collectionFormat": "multi",
  9982. "description": "filter notifications by subject type",
  9983. "name": "subject-type",
  9984. "in": "query"
  9985. },
  9986. {
  9987. "type": "string",
  9988. "format": "date-time",
  9989. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  9990. "name": "since",
  9991. "in": "query"
  9992. },
  9993. {
  9994. "type": "string",
  9995. "format": "date-time",
  9996. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  9997. "name": "before",
  9998. "in": "query"
  9999. },
  10000. {
  10001. "type": "integer",
  10002. "description": "page number of results to return (1-based)",
  10003. "name": "page",
  10004. "in": "query"
  10005. },
  10006. {
  10007. "type": "integer",
  10008. "description": "page size of results",
  10009. "name": "limit",
  10010. "in": "query"
  10011. }
  10012. ],
  10013. "responses": {
  10014. "200": {
  10015. "$ref": "#/responses/NotificationThreadList"
  10016. }
  10017. }
  10018. },
  10019. "put": {
  10020. "consumes": [
  10021. "application/json"
  10022. ],
  10023. "produces": [
  10024. "application/json"
  10025. ],
  10026. "tags": [
  10027. "notification"
  10028. ],
  10029. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  10030. "operationId": "notifyReadRepoList",
  10031. "parameters": [
  10032. {
  10033. "type": "string",
  10034. "description": "owner of the repo",
  10035. "name": "owner",
  10036. "in": "path",
  10037. "required": true
  10038. },
  10039. {
  10040. "type": "string",
  10041. "description": "name of the repo",
  10042. "name": "repo",
  10043. "in": "path",
  10044. "required": true
  10045. },
  10046. {
  10047. "type": "string",
  10048. "description": "If true, mark all notifications on this repo. Default value is false",
  10049. "name": "all",
  10050. "in": "query"
  10051. },
  10052. {
  10053. "type": "array",
  10054. "items": {
  10055. "type": "string"
  10056. },
  10057. "collectionFormat": "multi",
  10058. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  10059. "name": "status-types",
  10060. "in": "query"
  10061. },
  10062. {
  10063. "type": "string",
  10064. "description": "Status to mark notifications as. Defaults to read.",
  10065. "name": "to-status",
  10066. "in": "query"
  10067. },
  10068. {
  10069. "type": "string",
  10070. "format": "date-time",
  10071. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  10072. "name": "last_read_at",
  10073. "in": "query"
  10074. }
  10075. ],
  10076. "responses": {
  10077. "205": {
  10078. "$ref": "#/responses/NotificationThreadList"
  10079. }
  10080. }
  10081. }
  10082. },
  10083. "/repos/{owner}/{repo}/pulls": {
  10084. "get": {
  10085. "produces": [
  10086. "application/json"
  10087. ],
  10088. "tags": [
  10089. "repository"
  10090. ],
  10091. "summary": "List a repo's pull requests",
  10092. "operationId": "repoListPullRequests",
  10093. "parameters": [
  10094. {
  10095. "type": "string",
  10096. "description": "owner of the repo",
  10097. "name": "owner",
  10098. "in": "path",
  10099. "required": true
  10100. },
  10101. {
  10102. "type": "string",
  10103. "description": "name of the repo",
  10104. "name": "repo",
  10105. "in": "path",
  10106. "required": true
  10107. },
  10108. {
  10109. "enum": [
  10110. "closed",
  10111. "open",
  10112. "all"
  10113. ],
  10114. "type": "string",
  10115. "description": "State of pull request: open or closed (optional)",
  10116. "name": "state",
  10117. "in": "query"
  10118. },
  10119. {
  10120. "enum": [
  10121. "oldest",
  10122. "recentupdate",
  10123. "leastupdate",
  10124. "mostcomment",
  10125. "leastcomment",
  10126. "priority"
  10127. ],
  10128. "type": "string",
  10129. "description": "Type of sort",
  10130. "name": "sort",
  10131. "in": "query"
  10132. },
  10133. {
  10134. "type": "integer",
  10135. "format": "int64",
  10136. "description": "ID of the milestone",
  10137. "name": "milestone",
  10138. "in": "query"
  10139. },
  10140. {
  10141. "type": "array",
  10142. "items": {
  10143. "type": "integer",
  10144. "format": "int64"
  10145. },
  10146. "collectionFormat": "multi",
  10147. "description": "Label IDs",
  10148. "name": "labels",
  10149. "in": "query"
  10150. },
  10151. {
  10152. "type": "integer",
  10153. "description": "page number of results to return (1-based)",
  10154. "name": "page",
  10155. "in": "query"
  10156. },
  10157. {
  10158. "type": "integer",
  10159. "description": "page size of results",
  10160. "name": "limit",
  10161. "in": "query"
  10162. }
  10163. ],
  10164. "responses": {
  10165. "200": {
  10166. "$ref": "#/responses/PullRequestList"
  10167. },
  10168. "404": {
  10169. "$ref": "#/responses/notFound"
  10170. }
  10171. }
  10172. },
  10173. "post": {
  10174. "consumes": [
  10175. "application/json"
  10176. ],
  10177. "produces": [
  10178. "application/json"
  10179. ],
  10180. "tags": [
  10181. "repository"
  10182. ],
  10183. "summary": "Create a pull request",
  10184. "operationId": "repoCreatePullRequest",
  10185. "parameters": [
  10186. {
  10187. "type": "string",
  10188. "description": "owner of the repo",
  10189. "name": "owner",
  10190. "in": "path",
  10191. "required": true
  10192. },
  10193. {
  10194. "type": "string",
  10195. "description": "name of the repo",
  10196. "name": "repo",
  10197. "in": "path",
  10198. "required": true
  10199. },
  10200. {
  10201. "name": "body",
  10202. "in": "body",
  10203. "schema": {
  10204. "$ref": "#/definitions/CreatePullRequestOption"
  10205. }
  10206. }
  10207. ],
  10208. "responses": {
  10209. "201": {
  10210. "$ref": "#/responses/PullRequest"
  10211. },
  10212. "404": {
  10213. "$ref": "#/responses/notFound"
  10214. },
  10215. "409": {
  10216. "$ref": "#/responses/error"
  10217. },
  10218. "422": {
  10219. "$ref": "#/responses/validationError"
  10220. }
  10221. }
  10222. }
  10223. },
  10224. "/repos/{owner}/{repo}/pulls/pinned": {
  10225. "get": {
  10226. "produces": [
  10227. "application/json"
  10228. ],
  10229. "tags": [
  10230. "repository"
  10231. ],
  10232. "summary": "List a repo's pinned pull requests",
  10233. "operationId": "repoListPinnedPullRequests",
  10234. "parameters": [
  10235. {
  10236. "type": "string",
  10237. "description": "owner of the repo",
  10238. "name": "owner",
  10239. "in": "path",
  10240. "required": true
  10241. },
  10242. {
  10243. "type": "string",
  10244. "description": "name of the repo",
  10245. "name": "repo",
  10246. "in": "path",
  10247. "required": true
  10248. }
  10249. ],
  10250. "responses": {
  10251. "200": {
  10252. "$ref": "#/responses/PullRequestList"
  10253. },
  10254. "404": {
  10255. "$ref": "#/responses/notFound"
  10256. }
  10257. }
  10258. }
  10259. },
  10260. "/repos/{owner}/{repo}/pulls/{index}": {
  10261. "get": {
  10262. "produces": [
  10263. "application/json"
  10264. ],
  10265. "tags": [
  10266. "repository"
  10267. ],
  10268. "summary": "Get a pull request",
  10269. "operationId": "repoGetPullRequest",
  10270. "parameters": [
  10271. {
  10272. "type": "string",
  10273. "description": "owner of the repo",
  10274. "name": "owner",
  10275. "in": "path",
  10276. "required": true
  10277. },
  10278. {
  10279. "type": "string",
  10280. "description": "name of the repo",
  10281. "name": "repo",
  10282. "in": "path",
  10283. "required": true
  10284. },
  10285. {
  10286. "type": "integer",
  10287. "format": "int64",
  10288. "description": "index of the pull request to get",
  10289. "name": "index",
  10290. "in": "path",
  10291. "required": true
  10292. }
  10293. ],
  10294. "responses": {
  10295. "200": {
  10296. "$ref": "#/responses/PullRequest"
  10297. },
  10298. "404": {
  10299. "$ref": "#/responses/notFound"
  10300. }
  10301. }
  10302. },
  10303. "patch": {
  10304. "consumes": [
  10305. "application/json"
  10306. ],
  10307. "produces": [
  10308. "application/json"
  10309. ],
  10310. "tags": [
  10311. "repository"
  10312. ],
  10313. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  10314. "operationId": "repoEditPullRequest",
  10315. "parameters": [
  10316. {
  10317. "type": "string",
  10318. "description": "owner of the repo",
  10319. "name": "owner",
  10320. "in": "path",
  10321. "required": true
  10322. },
  10323. {
  10324. "type": "string",
  10325. "description": "name of the repo",
  10326. "name": "repo",
  10327. "in": "path",
  10328. "required": true
  10329. },
  10330. {
  10331. "type": "integer",
  10332. "format": "int64",
  10333. "description": "index of the pull request to edit",
  10334. "name": "index",
  10335. "in": "path",
  10336. "required": true
  10337. },
  10338. {
  10339. "name": "body",
  10340. "in": "body",
  10341. "schema": {
  10342. "$ref": "#/definitions/EditPullRequestOption"
  10343. }
  10344. }
  10345. ],
  10346. "responses": {
  10347. "201": {
  10348. "$ref": "#/responses/PullRequest"
  10349. },
  10350. "403": {
  10351. "$ref": "#/responses/forbidden"
  10352. },
  10353. "404": {
  10354. "$ref": "#/responses/notFound"
  10355. },
  10356. "409": {
  10357. "$ref": "#/responses/error"
  10358. },
  10359. "412": {
  10360. "$ref": "#/responses/error"
  10361. },
  10362. "422": {
  10363. "$ref": "#/responses/validationError"
  10364. }
  10365. }
  10366. }
  10367. },
  10368. "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
  10369. "get": {
  10370. "produces": [
  10371. "text/plain"
  10372. ],
  10373. "tags": [
  10374. "repository"
  10375. ],
  10376. "summary": "Get a pull request diff or patch",
  10377. "operationId": "repoDownloadPullDiffOrPatch",
  10378. "parameters": [
  10379. {
  10380. "type": "string",
  10381. "description": "owner of the repo",
  10382. "name": "owner",
  10383. "in": "path",
  10384. "required": true
  10385. },
  10386. {
  10387. "type": "string",
  10388. "description": "name of the repo",
  10389. "name": "repo",
  10390. "in": "path",
  10391. "required": true
  10392. },
  10393. {
  10394. "type": "integer",
  10395. "format": "int64",
  10396. "description": "index of the pull request to get",
  10397. "name": "index",
  10398. "in": "path",
  10399. "required": true
  10400. },
  10401. {
  10402. "enum": [
  10403. "diff",
  10404. "patch"
  10405. ],
  10406. "type": "string",
  10407. "description": "whether the output is diff or patch",
  10408. "name": "diffType",
  10409. "in": "path",
  10410. "required": true
  10411. },
  10412. {
  10413. "type": "boolean",
  10414. "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
  10415. "name": "binary",
  10416. "in": "query"
  10417. }
  10418. ],
  10419. "responses": {
  10420. "200": {
  10421. "$ref": "#/responses/string"
  10422. },
  10423. "404": {
  10424. "$ref": "#/responses/notFound"
  10425. }
  10426. }
  10427. }
  10428. },
  10429. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  10430. "get": {
  10431. "produces": [
  10432. "application/json"
  10433. ],
  10434. "tags": [
  10435. "repository"
  10436. ],
  10437. "summary": "Get commits for a pull request",
  10438. "operationId": "repoGetPullRequestCommits",
  10439. "parameters": [
  10440. {
  10441. "type": "string",
  10442. "description": "owner of the repo",
  10443. "name": "owner",
  10444. "in": "path",
  10445. "required": true
  10446. },
  10447. {
  10448. "type": "string",
  10449. "description": "name of the repo",
  10450. "name": "repo",
  10451. "in": "path",
  10452. "required": true
  10453. },
  10454. {
  10455. "type": "integer",
  10456. "format": "int64",
  10457. "description": "index of the pull request to get",
  10458. "name": "index",
  10459. "in": "path",
  10460. "required": true
  10461. },
  10462. {
  10463. "type": "integer",
  10464. "description": "page number of results to return (1-based)",
  10465. "name": "page",
  10466. "in": "query"
  10467. },
  10468. {
  10469. "type": "integer",
  10470. "description": "page size of results",
  10471. "name": "limit",
  10472. "in": "query"
  10473. },
  10474. {
  10475. "type": "boolean",
  10476. "description": "include verification for every commit (disable for speedup, default 'true')",
  10477. "name": "verification",
  10478. "in": "query"
  10479. },
  10480. {
  10481. "type": "boolean",
  10482. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  10483. "name": "files",
  10484. "in": "query"
  10485. }
  10486. ],
  10487. "responses": {
  10488. "200": {
  10489. "$ref": "#/responses/CommitList"
  10490. },
  10491. "404": {
  10492. "$ref": "#/responses/notFound"
  10493. }
  10494. }
  10495. }
  10496. },
  10497. "/repos/{owner}/{repo}/pulls/{index}/files": {
  10498. "get": {
  10499. "produces": [
  10500. "application/json"
  10501. ],
  10502. "tags": [
  10503. "repository"
  10504. ],
  10505. "summary": "Get changed files for a pull request",
  10506. "operationId": "repoGetPullRequestFiles",
  10507. "parameters": [
  10508. {
  10509. "type": "string",
  10510. "description": "owner of the repo",
  10511. "name": "owner",
  10512. "in": "path",
  10513. "required": true
  10514. },
  10515. {
  10516. "type": "string",
  10517. "description": "name of the repo",
  10518. "name": "repo",
  10519. "in": "path",
  10520. "required": true
  10521. },
  10522. {
  10523. "type": "integer",
  10524. "format": "int64",
  10525. "description": "index of the pull request to get",
  10526. "name": "index",
  10527. "in": "path",
  10528. "required": true
  10529. },
  10530. {
  10531. "type": "string",
  10532. "description": "skip to given file",
  10533. "name": "skip-to",
  10534. "in": "query"
  10535. },
  10536. {
  10537. "enum": [
  10538. "ignore-all",
  10539. "ignore-change",
  10540. "ignore-eol",
  10541. "show-all"
  10542. ],
  10543. "type": "string",
  10544. "description": "whitespace behavior",
  10545. "name": "whitespace",
  10546. "in": "query"
  10547. },
  10548. {
  10549. "type": "integer",
  10550. "description": "page number of results to return (1-based)",
  10551. "name": "page",
  10552. "in": "query"
  10553. },
  10554. {
  10555. "type": "integer",
  10556. "description": "page size of results",
  10557. "name": "limit",
  10558. "in": "query"
  10559. }
  10560. ],
  10561. "responses": {
  10562. "200": {
  10563. "$ref": "#/responses/ChangedFileList"
  10564. },
  10565. "404": {
  10566. "$ref": "#/responses/notFound"
  10567. }
  10568. }
  10569. }
  10570. },
  10571. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  10572. "get": {
  10573. "produces": [
  10574. "application/json"
  10575. ],
  10576. "tags": [
  10577. "repository"
  10578. ],
  10579. "summary": "Check if a pull request has been merged",
  10580. "operationId": "repoPullRequestIsMerged",
  10581. "parameters": [
  10582. {
  10583. "type": "string",
  10584. "description": "owner of the repo",
  10585. "name": "owner",
  10586. "in": "path",
  10587. "required": true
  10588. },
  10589. {
  10590. "type": "string",
  10591. "description": "name of the repo",
  10592. "name": "repo",
  10593. "in": "path",
  10594. "required": true
  10595. },
  10596. {
  10597. "type": "integer",
  10598. "format": "int64",
  10599. "description": "index of the pull request",
  10600. "name": "index",
  10601. "in": "path",
  10602. "required": true
  10603. }
  10604. ],
  10605. "responses": {
  10606. "204": {
  10607. "description": "pull request has been merged"
  10608. },
  10609. "404": {
  10610. "description": "pull request has not been merged"
  10611. }
  10612. }
  10613. },
  10614. "post": {
  10615. "produces": [
  10616. "application/json"
  10617. ],
  10618. "tags": [
  10619. "repository"
  10620. ],
  10621. "summary": "Merge a pull request",
  10622. "operationId": "repoMergePullRequest",
  10623. "parameters": [
  10624. {
  10625. "type": "string",
  10626. "description": "owner of the repo",
  10627. "name": "owner",
  10628. "in": "path",
  10629. "required": true
  10630. },
  10631. {
  10632. "type": "string",
  10633. "description": "name of the repo",
  10634. "name": "repo",
  10635. "in": "path",
  10636. "required": true
  10637. },
  10638. {
  10639. "type": "integer",
  10640. "format": "int64",
  10641. "description": "index of the pull request to merge",
  10642. "name": "index",
  10643. "in": "path",
  10644. "required": true
  10645. },
  10646. {
  10647. "name": "body",
  10648. "in": "body",
  10649. "schema": {
  10650. "$ref": "#/definitions/MergePullRequestOption"
  10651. }
  10652. }
  10653. ],
  10654. "responses": {
  10655. "200": {
  10656. "$ref": "#/responses/empty"
  10657. },
  10658. "404": {
  10659. "$ref": "#/responses/notFound"
  10660. },
  10661. "405": {
  10662. "$ref": "#/responses/empty"
  10663. },
  10664. "409": {
  10665. "$ref": "#/responses/error"
  10666. }
  10667. }
  10668. },
  10669. "delete": {
  10670. "produces": [
  10671. "application/json"
  10672. ],
  10673. "tags": [
  10674. "repository"
  10675. ],
  10676. "summary": "Cancel the scheduled auto merge for the given pull request",
  10677. "operationId": "repoCancelScheduledAutoMerge",
  10678. "parameters": [
  10679. {
  10680. "type": "string",
  10681. "description": "owner of the repo",
  10682. "name": "owner",
  10683. "in": "path",
  10684. "required": true
  10685. },
  10686. {
  10687. "type": "string",
  10688. "description": "name of the repo",
  10689. "name": "repo",
  10690. "in": "path",
  10691. "required": true
  10692. },
  10693. {
  10694. "type": "integer",
  10695. "format": "int64",
  10696. "description": "index of the pull request to merge",
  10697. "name": "index",
  10698. "in": "path",
  10699. "required": true
  10700. }
  10701. ],
  10702. "responses": {
  10703. "204": {
  10704. "$ref": "#/responses/empty"
  10705. },
  10706. "403": {
  10707. "$ref": "#/responses/forbidden"
  10708. },
  10709. "404": {
  10710. "$ref": "#/responses/notFound"
  10711. }
  10712. }
  10713. }
  10714. },
  10715. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  10716. "post": {
  10717. "produces": [
  10718. "application/json"
  10719. ],
  10720. "tags": [
  10721. "repository"
  10722. ],
  10723. "summary": "create review requests for a pull request",
  10724. "operationId": "repoCreatePullReviewRequests",
  10725. "parameters": [
  10726. {
  10727. "type": "string",
  10728. "description": "owner of the repo",
  10729. "name": "owner",
  10730. "in": "path",
  10731. "required": true
  10732. },
  10733. {
  10734. "type": "string",
  10735. "description": "name of the repo",
  10736. "name": "repo",
  10737. "in": "path",
  10738. "required": true
  10739. },
  10740. {
  10741. "type": "integer",
  10742. "format": "int64",
  10743. "description": "index of the pull request",
  10744. "name": "index",
  10745. "in": "path",
  10746. "required": true
  10747. },
  10748. {
  10749. "name": "body",
  10750. "in": "body",
  10751. "required": true,
  10752. "schema": {
  10753. "$ref": "#/definitions/PullReviewRequestOptions"
  10754. }
  10755. }
  10756. ],
  10757. "responses": {
  10758. "201": {
  10759. "$ref": "#/responses/PullReviewList"
  10760. },
  10761. "404": {
  10762. "$ref": "#/responses/notFound"
  10763. },
  10764. "422": {
  10765. "$ref": "#/responses/validationError"
  10766. }
  10767. }
  10768. },
  10769. "delete": {
  10770. "produces": [
  10771. "application/json"
  10772. ],
  10773. "tags": [
  10774. "repository"
  10775. ],
  10776. "summary": "cancel review requests for a pull request",
  10777. "operationId": "repoDeletePullReviewRequests",
  10778. "parameters": [
  10779. {
  10780. "type": "string",
  10781. "description": "owner of the repo",
  10782. "name": "owner",
  10783. "in": "path",
  10784. "required": true
  10785. },
  10786. {
  10787. "type": "string",
  10788. "description": "name of the repo",
  10789. "name": "repo",
  10790. "in": "path",
  10791. "required": true
  10792. },
  10793. {
  10794. "type": "integer",
  10795. "format": "int64",
  10796. "description": "index of the pull request",
  10797. "name": "index",
  10798. "in": "path",
  10799. "required": true
  10800. },
  10801. {
  10802. "name": "body",
  10803. "in": "body",
  10804. "required": true,
  10805. "schema": {
  10806. "$ref": "#/definitions/PullReviewRequestOptions"
  10807. }
  10808. }
  10809. ],
  10810. "responses": {
  10811. "204": {
  10812. "$ref": "#/responses/empty"
  10813. },
  10814. "404": {
  10815. "$ref": "#/responses/notFound"
  10816. },
  10817. "422": {
  10818. "$ref": "#/responses/validationError"
  10819. }
  10820. }
  10821. }
  10822. },
  10823. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  10824. "get": {
  10825. "produces": [
  10826. "application/json"
  10827. ],
  10828. "tags": [
  10829. "repository"
  10830. ],
  10831. "summary": "List all reviews for a pull request",
  10832. "operationId": "repoListPullReviews",
  10833. "parameters": [
  10834. {
  10835. "type": "string",
  10836. "description": "owner of the repo",
  10837. "name": "owner",
  10838. "in": "path",
  10839. "required": true
  10840. },
  10841. {
  10842. "type": "string",
  10843. "description": "name of the repo",
  10844. "name": "repo",
  10845. "in": "path",
  10846. "required": true
  10847. },
  10848. {
  10849. "type": "integer",
  10850. "format": "int64",
  10851. "description": "index of the pull request",
  10852. "name": "index",
  10853. "in": "path",
  10854. "required": true
  10855. },
  10856. {
  10857. "type": "integer",
  10858. "description": "page number of results to return (1-based)",
  10859. "name": "page",
  10860. "in": "query"
  10861. },
  10862. {
  10863. "type": "integer",
  10864. "description": "page size of results",
  10865. "name": "limit",
  10866. "in": "query"
  10867. }
  10868. ],
  10869. "responses": {
  10870. "200": {
  10871. "$ref": "#/responses/PullReviewList"
  10872. },
  10873. "404": {
  10874. "$ref": "#/responses/notFound"
  10875. }
  10876. }
  10877. },
  10878. "post": {
  10879. "produces": [
  10880. "application/json"
  10881. ],
  10882. "tags": [
  10883. "repository"
  10884. ],
  10885. "summary": "Create a review to an pull request",
  10886. "operationId": "repoCreatePullReview",
  10887. "parameters": [
  10888. {
  10889. "type": "string",
  10890. "description": "owner of the repo",
  10891. "name": "owner",
  10892. "in": "path",
  10893. "required": true
  10894. },
  10895. {
  10896. "type": "string",
  10897. "description": "name of the repo",
  10898. "name": "repo",
  10899. "in": "path",
  10900. "required": true
  10901. },
  10902. {
  10903. "type": "integer",
  10904. "format": "int64",
  10905. "description": "index of the pull request",
  10906. "name": "index",
  10907. "in": "path",
  10908. "required": true
  10909. },
  10910. {
  10911. "name": "body",
  10912. "in": "body",
  10913. "required": true,
  10914. "schema": {
  10915. "$ref": "#/definitions/CreatePullReviewOptions"
  10916. }
  10917. }
  10918. ],
  10919. "responses": {
  10920. "200": {
  10921. "$ref": "#/responses/PullReview"
  10922. },
  10923. "404": {
  10924. "$ref": "#/responses/notFound"
  10925. },
  10926. "422": {
  10927. "$ref": "#/responses/validationError"
  10928. }
  10929. }
  10930. }
  10931. },
  10932. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  10933. "get": {
  10934. "produces": [
  10935. "application/json"
  10936. ],
  10937. "tags": [
  10938. "repository"
  10939. ],
  10940. "summary": "Get a specific review for a pull request",
  10941. "operationId": "repoGetPullReview",
  10942. "parameters": [
  10943. {
  10944. "type": "string",
  10945. "description": "owner of the repo",
  10946. "name": "owner",
  10947. "in": "path",
  10948. "required": true
  10949. },
  10950. {
  10951. "type": "string",
  10952. "description": "name of the repo",
  10953. "name": "repo",
  10954. "in": "path",
  10955. "required": true
  10956. },
  10957. {
  10958. "type": "integer",
  10959. "format": "int64",
  10960. "description": "index of the pull request",
  10961. "name": "index",
  10962. "in": "path",
  10963. "required": true
  10964. },
  10965. {
  10966. "type": "integer",
  10967. "format": "int64",
  10968. "description": "id of the review",
  10969. "name": "id",
  10970. "in": "path",
  10971. "required": true
  10972. }
  10973. ],
  10974. "responses": {
  10975. "200": {
  10976. "$ref": "#/responses/PullReview"
  10977. },
  10978. "404": {
  10979. "$ref": "#/responses/notFound"
  10980. }
  10981. }
  10982. },
  10983. "post": {
  10984. "produces": [
  10985. "application/json"
  10986. ],
  10987. "tags": [
  10988. "repository"
  10989. ],
  10990. "summary": "Submit a pending review to an pull request",
  10991. "operationId": "repoSubmitPullReview",
  10992. "parameters": [
  10993. {
  10994. "type": "string",
  10995. "description": "owner of the repo",
  10996. "name": "owner",
  10997. "in": "path",
  10998. "required": true
  10999. },
  11000. {
  11001. "type": "string",
  11002. "description": "name of the repo",
  11003. "name": "repo",
  11004. "in": "path",
  11005. "required": true
  11006. },
  11007. {
  11008. "type": "integer",
  11009. "format": "int64",
  11010. "description": "index of the pull request",
  11011. "name": "index",
  11012. "in": "path",
  11013. "required": true
  11014. },
  11015. {
  11016. "type": "integer",
  11017. "format": "int64",
  11018. "description": "id of the review",
  11019. "name": "id",
  11020. "in": "path",
  11021. "required": true
  11022. },
  11023. {
  11024. "name": "body",
  11025. "in": "body",
  11026. "required": true,
  11027. "schema": {
  11028. "$ref": "#/definitions/SubmitPullReviewOptions"
  11029. }
  11030. }
  11031. ],
  11032. "responses": {
  11033. "200": {
  11034. "$ref": "#/responses/PullReview"
  11035. },
  11036. "404": {
  11037. "$ref": "#/responses/notFound"
  11038. },
  11039. "422": {
  11040. "$ref": "#/responses/validationError"
  11041. }
  11042. }
  11043. },
  11044. "delete": {
  11045. "produces": [
  11046. "application/json"
  11047. ],
  11048. "tags": [
  11049. "repository"
  11050. ],
  11051. "summary": "Delete a specific review from a pull request",
  11052. "operationId": "repoDeletePullReview",
  11053. "parameters": [
  11054. {
  11055. "type": "string",
  11056. "description": "owner of the repo",
  11057. "name": "owner",
  11058. "in": "path",
  11059. "required": true
  11060. },
  11061. {
  11062. "type": "string",
  11063. "description": "name of the repo",
  11064. "name": "repo",
  11065. "in": "path",
  11066. "required": true
  11067. },
  11068. {
  11069. "type": "integer",
  11070. "format": "int64",
  11071. "description": "index of the pull request",
  11072. "name": "index",
  11073. "in": "path",
  11074. "required": true
  11075. },
  11076. {
  11077. "type": "integer",
  11078. "format": "int64",
  11079. "description": "id of the review",
  11080. "name": "id",
  11081. "in": "path",
  11082. "required": true
  11083. }
  11084. ],
  11085. "responses": {
  11086. "204": {
  11087. "$ref": "#/responses/empty"
  11088. },
  11089. "403": {
  11090. "$ref": "#/responses/forbidden"
  11091. },
  11092. "404": {
  11093. "$ref": "#/responses/notFound"
  11094. }
  11095. }
  11096. }
  11097. },
  11098. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  11099. "get": {
  11100. "produces": [
  11101. "application/json"
  11102. ],
  11103. "tags": [
  11104. "repository"
  11105. ],
  11106. "summary": "Get a specific review for a pull request",
  11107. "operationId": "repoGetPullReviewComments",
  11108. "parameters": [
  11109. {
  11110. "type": "string",
  11111. "description": "owner of the repo",
  11112. "name": "owner",
  11113. "in": "path",
  11114. "required": true
  11115. },
  11116. {
  11117. "type": "string",
  11118. "description": "name of the repo",
  11119. "name": "repo",
  11120. "in": "path",
  11121. "required": true
  11122. },
  11123. {
  11124. "type": "integer",
  11125. "format": "int64",
  11126. "description": "index of the pull request",
  11127. "name": "index",
  11128. "in": "path",
  11129. "required": true
  11130. },
  11131. {
  11132. "type": "integer",
  11133. "format": "int64",
  11134. "description": "id of the review",
  11135. "name": "id",
  11136. "in": "path",
  11137. "required": true
  11138. }
  11139. ],
  11140. "responses": {
  11141. "200": {
  11142. "$ref": "#/responses/PullReviewCommentList"
  11143. },
  11144. "404": {
  11145. "$ref": "#/responses/notFound"
  11146. }
  11147. }
  11148. }
  11149. },
  11150. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  11151. "post": {
  11152. "produces": [
  11153. "application/json"
  11154. ],
  11155. "tags": [
  11156. "repository"
  11157. ],
  11158. "summary": "Dismiss a review for a pull request",
  11159. "operationId": "repoDismissPullReview",
  11160. "parameters": [
  11161. {
  11162. "type": "string",
  11163. "description": "owner of the repo",
  11164. "name": "owner",
  11165. "in": "path",
  11166. "required": true
  11167. },
  11168. {
  11169. "type": "string",
  11170. "description": "name of the repo",
  11171. "name": "repo",
  11172. "in": "path",
  11173. "required": true
  11174. },
  11175. {
  11176. "type": "integer",
  11177. "format": "int64",
  11178. "description": "index of the pull request",
  11179. "name": "index",
  11180. "in": "path",
  11181. "required": true
  11182. },
  11183. {
  11184. "type": "integer",
  11185. "format": "int64",
  11186. "description": "id of the review",
  11187. "name": "id",
  11188. "in": "path",
  11189. "required": true
  11190. },
  11191. {
  11192. "name": "body",
  11193. "in": "body",
  11194. "required": true,
  11195. "schema": {
  11196. "$ref": "#/definitions/DismissPullReviewOptions"
  11197. }
  11198. }
  11199. ],
  11200. "responses": {
  11201. "200": {
  11202. "$ref": "#/responses/PullReview"
  11203. },
  11204. "403": {
  11205. "$ref": "#/responses/forbidden"
  11206. },
  11207. "404": {
  11208. "$ref": "#/responses/notFound"
  11209. },
  11210. "422": {
  11211. "$ref": "#/responses/validationError"
  11212. }
  11213. }
  11214. }
  11215. },
  11216. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  11217. "post": {
  11218. "produces": [
  11219. "application/json"
  11220. ],
  11221. "tags": [
  11222. "repository"
  11223. ],
  11224. "summary": "Cancel to dismiss a review for a pull request",
  11225. "operationId": "repoUnDismissPullReview",
  11226. "parameters": [
  11227. {
  11228. "type": "string",
  11229. "description": "owner of the repo",
  11230. "name": "owner",
  11231. "in": "path",
  11232. "required": true
  11233. },
  11234. {
  11235. "type": "string",
  11236. "description": "name of the repo",
  11237. "name": "repo",
  11238. "in": "path",
  11239. "required": true
  11240. },
  11241. {
  11242. "type": "integer",
  11243. "format": "int64",
  11244. "description": "index of the pull request",
  11245. "name": "index",
  11246. "in": "path",
  11247. "required": true
  11248. },
  11249. {
  11250. "type": "integer",
  11251. "format": "int64",
  11252. "description": "id of the review",
  11253. "name": "id",
  11254. "in": "path",
  11255. "required": true
  11256. }
  11257. ],
  11258. "responses": {
  11259. "200": {
  11260. "$ref": "#/responses/PullReview"
  11261. },
  11262. "403": {
  11263. "$ref": "#/responses/forbidden"
  11264. },
  11265. "404": {
  11266. "$ref": "#/responses/notFound"
  11267. },
  11268. "422": {
  11269. "$ref": "#/responses/validationError"
  11270. }
  11271. }
  11272. }
  11273. },
  11274. "/repos/{owner}/{repo}/pulls/{index}/update": {
  11275. "post": {
  11276. "produces": [
  11277. "application/json"
  11278. ],
  11279. "tags": [
  11280. "repository"
  11281. ],
  11282. "summary": "Merge PR's baseBranch into headBranch",
  11283. "operationId": "repoUpdatePullRequest",
  11284. "parameters": [
  11285. {
  11286. "type": "string",
  11287. "description": "owner of the repo",
  11288. "name": "owner",
  11289. "in": "path",
  11290. "required": true
  11291. },
  11292. {
  11293. "type": "string",
  11294. "description": "name of the repo",
  11295. "name": "repo",
  11296. "in": "path",
  11297. "required": true
  11298. },
  11299. {
  11300. "type": "integer",
  11301. "format": "int64",
  11302. "description": "index of the pull request to get",
  11303. "name": "index",
  11304. "in": "path",
  11305. "required": true
  11306. },
  11307. {
  11308. "enum": [
  11309. "merge",
  11310. "rebase"
  11311. ],
  11312. "type": "string",
  11313. "description": "how to update pull request",
  11314. "name": "style",
  11315. "in": "query"
  11316. }
  11317. ],
  11318. "responses": {
  11319. "200": {
  11320. "$ref": "#/responses/empty"
  11321. },
  11322. "403": {
  11323. "$ref": "#/responses/forbidden"
  11324. },
  11325. "404": {
  11326. "$ref": "#/responses/notFound"
  11327. },
  11328. "409": {
  11329. "$ref": "#/responses/error"
  11330. },
  11331. "422": {
  11332. "$ref": "#/responses/validationError"
  11333. }
  11334. }
  11335. }
  11336. },
  11337. "/repos/{owner}/{repo}/push_mirrors": {
  11338. "get": {
  11339. "produces": [
  11340. "application/json"
  11341. ],
  11342. "tags": [
  11343. "repository"
  11344. ],
  11345. "summary": "Get all push mirrors of the repository",
  11346. "operationId": "repoListPushMirrors",
  11347. "parameters": [
  11348. {
  11349. "type": "string",
  11350. "description": "owner of the repo",
  11351. "name": "owner",
  11352. "in": "path",
  11353. "required": true
  11354. },
  11355. {
  11356. "type": "string",
  11357. "description": "name of the repo",
  11358. "name": "repo",
  11359. "in": "path",
  11360. "required": true
  11361. },
  11362. {
  11363. "type": "integer",
  11364. "description": "page number of results to return (1-based)",
  11365. "name": "page",
  11366. "in": "query"
  11367. },
  11368. {
  11369. "type": "integer",
  11370. "description": "page size of results",
  11371. "name": "limit",
  11372. "in": "query"
  11373. }
  11374. ],
  11375. "responses": {
  11376. "200": {
  11377. "$ref": "#/responses/PushMirrorList"
  11378. },
  11379. "400": {
  11380. "$ref": "#/responses/error"
  11381. },
  11382. "403": {
  11383. "$ref": "#/responses/forbidden"
  11384. },
  11385. "404": {
  11386. "$ref": "#/responses/notFound"
  11387. }
  11388. }
  11389. },
  11390. "post": {
  11391. "consumes": [
  11392. "application/json"
  11393. ],
  11394. "produces": [
  11395. "application/json"
  11396. ],
  11397. "tags": [
  11398. "repository"
  11399. ],
  11400. "summary": "add a push mirror to the repository",
  11401. "operationId": "repoAddPushMirror",
  11402. "parameters": [
  11403. {
  11404. "type": "string",
  11405. "description": "owner of the repo",
  11406. "name": "owner",
  11407. "in": "path",
  11408. "required": true
  11409. },
  11410. {
  11411. "type": "string",
  11412. "description": "name of the repo",
  11413. "name": "repo",
  11414. "in": "path",
  11415. "required": true
  11416. },
  11417. {
  11418. "name": "body",
  11419. "in": "body",
  11420. "schema": {
  11421. "$ref": "#/definitions/CreatePushMirrorOption"
  11422. }
  11423. }
  11424. ],
  11425. "responses": {
  11426. "200": {
  11427. "$ref": "#/responses/PushMirror"
  11428. },
  11429. "400": {
  11430. "$ref": "#/responses/error"
  11431. },
  11432. "403": {
  11433. "$ref": "#/responses/forbidden"
  11434. },
  11435. "404": {
  11436. "$ref": "#/responses/notFound"
  11437. }
  11438. }
  11439. }
  11440. },
  11441. "/repos/{owner}/{repo}/push_mirrors-sync": {
  11442. "post": {
  11443. "produces": [
  11444. "application/json"
  11445. ],
  11446. "tags": [
  11447. "repository"
  11448. ],
  11449. "summary": "Sync all push mirrored repository",
  11450. "operationId": "repoPushMirrorSync",
  11451. "parameters": [
  11452. {
  11453. "type": "string",
  11454. "description": "owner of the repo to sync",
  11455. "name": "owner",
  11456. "in": "path",
  11457. "required": true
  11458. },
  11459. {
  11460. "type": "string",
  11461. "description": "name of the repo to sync",
  11462. "name": "repo",
  11463. "in": "path",
  11464. "required": true
  11465. }
  11466. ],
  11467. "responses": {
  11468. "200": {
  11469. "$ref": "#/responses/empty"
  11470. },
  11471. "400": {
  11472. "$ref": "#/responses/error"
  11473. },
  11474. "403": {
  11475. "$ref": "#/responses/forbidden"
  11476. },
  11477. "404": {
  11478. "$ref": "#/responses/notFound"
  11479. }
  11480. }
  11481. }
  11482. },
  11483. "/repos/{owner}/{repo}/push_mirrors/{name}": {
  11484. "get": {
  11485. "produces": [
  11486. "application/json"
  11487. ],
  11488. "tags": [
  11489. "repository"
  11490. ],
  11491. "summary": "Get push mirror of the repository by remoteName",
  11492. "operationId": "repoGetPushMirrorByRemoteName",
  11493. "parameters": [
  11494. {
  11495. "type": "string",
  11496. "description": "owner of the repo",
  11497. "name": "owner",
  11498. "in": "path",
  11499. "required": true
  11500. },
  11501. {
  11502. "type": "string",
  11503. "description": "name of the repo",
  11504. "name": "repo",
  11505. "in": "path",
  11506. "required": true
  11507. },
  11508. {
  11509. "type": "string",
  11510. "description": "remote name of push mirror",
  11511. "name": "name",
  11512. "in": "path",
  11513. "required": true
  11514. }
  11515. ],
  11516. "responses": {
  11517. "200": {
  11518. "$ref": "#/responses/PushMirror"
  11519. },
  11520. "400": {
  11521. "$ref": "#/responses/error"
  11522. },
  11523. "403": {
  11524. "$ref": "#/responses/forbidden"
  11525. },
  11526. "404": {
  11527. "$ref": "#/responses/notFound"
  11528. }
  11529. }
  11530. },
  11531. "delete": {
  11532. "produces": [
  11533. "application/json"
  11534. ],
  11535. "tags": [
  11536. "repository"
  11537. ],
  11538. "summary": "deletes a push mirror from a repository by remoteName",
  11539. "operationId": "repoDeletePushMirror",
  11540. "parameters": [
  11541. {
  11542. "type": "string",
  11543. "description": "owner of the repo",
  11544. "name": "owner",
  11545. "in": "path",
  11546. "required": true
  11547. },
  11548. {
  11549. "type": "string",
  11550. "description": "name of the repo",
  11551. "name": "repo",
  11552. "in": "path",
  11553. "required": true
  11554. },
  11555. {
  11556. "type": "string",
  11557. "description": "remote name of the pushMirror",
  11558. "name": "name",
  11559. "in": "path",
  11560. "required": true
  11561. }
  11562. ],
  11563. "responses": {
  11564. "204": {
  11565. "$ref": "#/responses/empty"
  11566. },
  11567. "400": {
  11568. "$ref": "#/responses/error"
  11569. },
  11570. "404": {
  11571. "$ref": "#/responses/notFound"
  11572. }
  11573. }
  11574. }
  11575. },
  11576. "/repos/{owner}/{repo}/raw/{filepath}": {
  11577. "get": {
  11578. "produces": [
  11579. "application/json"
  11580. ],
  11581. "tags": [
  11582. "repository"
  11583. ],
  11584. "summary": "Get a file from a repository",
  11585. "operationId": "repoGetRawFile",
  11586. "parameters": [
  11587. {
  11588. "type": "string",
  11589. "description": "owner of the repo",
  11590. "name": "owner",
  11591. "in": "path",
  11592. "required": true
  11593. },
  11594. {
  11595. "type": "string",
  11596. "description": "name of the repo",
  11597. "name": "repo",
  11598. "in": "path",
  11599. "required": true
  11600. },
  11601. {
  11602. "type": "string",
  11603. "description": "filepath of the file to get",
  11604. "name": "filepath",
  11605. "in": "path",
  11606. "required": true
  11607. },
  11608. {
  11609. "type": "string",
  11610. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  11611. "name": "ref",
  11612. "in": "query"
  11613. }
  11614. ],
  11615. "responses": {
  11616. "200": {
  11617. "description": "Returns raw file content."
  11618. },
  11619. "404": {
  11620. "$ref": "#/responses/notFound"
  11621. }
  11622. }
  11623. }
  11624. },
  11625. "/repos/{owner}/{repo}/releases": {
  11626. "get": {
  11627. "produces": [
  11628. "application/json"
  11629. ],
  11630. "tags": [
  11631. "repository"
  11632. ],
  11633. "summary": "List a repo's releases",
  11634. "operationId": "repoListReleases",
  11635. "parameters": [
  11636. {
  11637. "type": "string",
  11638. "description": "owner of the repo",
  11639. "name": "owner",
  11640. "in": "path",
  11641. "required": true
  11642. },
  11643. {
  11644. "type": "string",
  11645. "description": "name of the repo",
  11646. "name": "repo",
  11647. "in": "path",
  11648. "required": true
  11649. },
  11650. {
  11651. "type": "boolean",
  11652. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  11653. "name": "draft",
  11654. "in": "query"
  11655. },
  11656. {
  11657. "type": "boolean",
  11658. "description": "filter (exclude / include) pre-releases",
  11659. "name": "pre-release",
  11660. "in": "query"
  11661. },
  11662. {
  11663. "type": "integer",
  11664. "description": "page size of results, deprecated - use limit",
  11665. "name": "per_page",
  11666. "in": "query"
  11667. },
  11668. {
  11669. "type": "integer",
  11670. "description": "page number of results to return (1-based)",
  11671. "name": "page",
  11672. "in": "query"
  11673. },
  11674. {
  11675. "type": "integer",
  11676. "description": "page size of results",
  11677. "name": "limit",
  11678. "in": "query"
  11679. }
  11680. ],
  11681. "responses": {
  11682. "200": {
  11683. "$ref": "#/responses/ReleaseList"
  11684. },
  11685. "404": {
  11686. "$ref": "#/responses/notFound"
  11687. }
  11688. }
  11689. },
  11690. "post": {
  11691. "consumes": [
  11692. "application/json"
  11693. ],
  11694. "produces": [
  11695. "application/json"
  11696. ],
  11697. "tags": [
  11698. "repository"
  11699. ],
  11700. "summary": "Create a release",
  11701. "operationId": "repoCreateRelease",
  11702. "parameters": [
  11703. {
  11704. "type": "string",
  11705. "description": "owner of the repo",
  11706. "name": "owner",
  11707. "in": "path",
  11708. "required": true
  11709. },
  11710. {
  11711. "type": "string",
  11712. "description": "name of the repo",
  11713. "name": "repo",
  11714. "in": "path",
  11715. "required": true
  11716. },
  11717. {
  11718. "name": "body",
  11719. "in": "body",
  11720. "schema": {
  11721. "$ref": "#/definitions/CreateReleaseOption"
  11722. }
  11723. }
  11724. ],
  11725. "responses": {
  11726. "201": {
  11727. "$ref": "#/responses/Release"
  11728. },
  11729. "404": {
  11730. "$ref": "#/responses/notFound"
  11731. },
  11732. "409": {
  11733. "$ref": "#/responses/error"
  11734. }
  11735. }
  11736. }
  11737. },
  11738. "/repos/{owner}/{repo}/releases/latest": {
  11739. "get": {
  11740. "produces": [
  11741. "application/json"
  11742. ],
  11743. "tags": [
  11744. "repository"
  11745. ],
  11746. "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
  11747. "operationId": "repoGetLatestRelease",
  11748. "parameters": [
  11749. {
  11750. "type": "string",
  11751. "description": "owner of the repo",
  11752. "name": "owner",
  11753. "in": "path",
  11754. "required": true
  11755. },
  11756. {
  11757. "type": "string",
  11758. "description": "name of the repo",
  11759. "name": "repo",
  11760. "in": "path",
  11761. "required": true
  11762. }
  11763. ],
  11764. "responses": {
  11765. "200": {
  11766. "$ref": "#/responses/Release"
  11767. },
  11768. "404": {
  11769. "$ref": "#/responses/notFound"
  11770. }
  11771. }
  11772. }
  11773. },
  11774. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  11775. "get": {
  11776. "produces": [
  11777. "application/json"
  11778. ],
  11779. "tags": [
  11780. "repository"
  11781. ],
  11782. "summary": "Get a release by tag name",
  11783. "operationId": "repoGetReleaseByTag",
  11784. "parameters": [
  11785. {
  11786. "type": "string",
  11787. "description": "owner of the repo",
  11788. "name": "owner",
  11789. "in": "path",
  11790. "required": true
  11791. },
  11792. {
  11793. "type": "string",
  11794. "description": "name of the repo",
  11795. "name": "repo",
  11796. "in": "path",
  11797. "required": true
  11798. },
  11799. {
  11800. "type": "string",
  11801. "description": "tag name of the release to get",
  11802. "name": "tag",
  11803. "in": "path",
  11804. "required": true
  11805. }
  11806. ],
  11807. "responses": {
  11808. "200": {
  11809. "$ref": "#/responses/Release"
  11810. },
  11811. "404": {
  11812. "$ref": "#/responses/notFound"
  11813. }
  11814. }
  11815. },
  11816. "delete": {
  11817. "tags": [
  11818. "repository"
  11819. ],
  11820. "summary": "Delete a release by tag name",
  11821. "operationId": "repoDeleteReleaseByTag",
  11822. "parameters": [
  11823. {
  11824. "type": "string",
  11825. "description": "owner of the repo",
  11826. "name": "owner",
  11827. "in": "path",
  11828. "required": true
  11829. },
  11830. {
  11831. "type": "string",
  11832. "description": "name of the repo",
  11833. "name": "repo",
  11834. "in": "path",
  11835. "required": true
  11836. },
  11837. {
  11838. "type": "string",
  11839. "description": "tag name of the release to delete",
  11840. "name": "tag",
  11841. "in": "path",
  11842. "required": true
  11843. }
  11844. ],
  11845. "responses": {
  11846. "204": {
  11847. "$ref": "#/responses/empty"
  11848. },
  11849. "404": {
  11850. "$ref": "#/responses/notFound"
  11851. },
  11852. "405": {
  11853. "$ref": "#/responses/empty"
  11854. }
  11855. }
  11856. }
  11857. },
  11858. "/repos/{owner}/{repo}/releases/{id}": {
  11859. "get": {
  11860. "produces": [
  11861. "application/json"
  11862. ],
  11863. "tags": [
  11864. "repository"
  11865. ],
  11866. "summary": "Get a release",
  11867. "operationId": "repoGetRelease",
  11868. "parameters": [
  11869. {
  11870. "type": "string",
  11871. "description": "owner of the repo",
  11872. "name": "owner",
  11873. "in": "path",
  11874. "required": true
  11875. },
  11876. {
  11877. "type": "string",
  11878. "description": "name of the repo",
  11879. "name": "repo",
  11880. "in": "path",
  11881. "required": true
  11882. },
  11883. {
  11884. "type": "integer",
  11885. "format": "int64",
  11886. "description": "id of the release to get",
  11887. "name": "id",
  11888. "in": "path",
  11889. "required": true
  11890. }
  11891. ],
  11892. "responses": {
  11893. "200": {
  11894. "$ref": "#/responses/Release"
  11895. },
  11896. "404": {
  11897. "$ref": "#/responses/notFound"
  11898. }
  11899. }
  11900. },
  11901. "delete": {
  11902. "tags": [
  11903. "repository"
  11904. ],
  11905. "summary": "Delete a release",
  11906. "operationId": "repoDeleteRelease",
  11907. "parameters": [
  11908. {
  11909. "type": "string",
  11910. "description": "owner of the repo",
  11911. "name": "owner",
  11912. "in": "path",
  11913. "required": true
  11914. },
  11915. {
  11916. "type": "string",
  11917. "description": "name of the repo",
  11918. "name": "repo",
  11919. "in": "path",
  11920. "required": true
  11921. },
  11922. {
  11923. "type": "integer",
  11924. "format": "int64",
  11925. "description": "id of the release to delete",
  11926. "name": "id",
  11927. "in": "path",
  11928. "required": true
  11929. }
  11930. ],
  11931. "responses": {
  11932. "204": {
  11933. "$ref": "#/responses/empty"
  11934. },
  11935. "404": {
  11936. "$ref": "#/responses/notFound"
  11937. },
  11938. "405": {
  11939. "$ref": "#/responses/empty"
  11940. }
  11941. }
  11942. },
  11943. "patch": {
  11944. "consumes": [
  11945. "application/json"
  11946. ],
  11947. "produces": [
  11948. "application/json"
  11949. ],
  11950. "tags": [
  11951. "repository"
  11952. ],
  11953. "summary": "Update a release",
  11954. "operationId": "repoEditRelease",
  11955. "parameters": [
  11956. {
  11957. "type": "string",
  11958. "description": "owner of the repo",
  11959. "name": "owner",
  11960. "in": "path",
  11961. "required": true
  11962. },
  11963. {
  11964. "type": "string",
  11965. "description": "name of the repo",
  11966. "name": "repo",
  11967. "in": "path",
  11968. "required": true
  11969. },
  11970. {
  11971. "type": "integer",
  11972. "format": "int64",
  11973. "description": "id of the release to edit",
  11974. "name": "id",
  11975. "in": "path",
  11976. "required": true
  11977. },
  11978. {
  11979. "name": "body",
  11980. "in": "body",
  11981. "schema": {
  11982. "$ref": "#/definitions/EditReleaseOption"
  11983. }
  11984. }
  11985. ],
  11986. "responses": {
  11987. "200": {
  11988. "$ref": "#/responses/Release"
  11989. },
  11990. "404": {
  11991. "$ref": "#/responses/notFound"
  11992. }
  11993. }
  11994. }
  11995. },
  11996. "/repos/{owner}/{repo}/releases/{id}/assets": {
  11997. "get": {
  11998. "produces": [
  11999. "application/json"
  12000. ],
  12001. "tags": [
  12002. "repository"
  12003. ],
  12004. "summary": "List release's attachments",
  12005. "operationId": "repoListReleaseAttachments",
  12006. "parameters": [
  12007. {
  12008. "type": "string",
  12009. "description": "owner of the repo",
  12010. "name": "owner",
  12011. "in": "path",
  12012. "required": true
  12013. },
  12014. {
  12015. "type": "string",
  12016. "description": "name of the repo",
  12017. "name": "repo",
  12018. "in": "path",
  12019. "required": true
  12020. },
  12021. {
  12022. "type": "integer",
  12023. "format": "int64",
  12024. "description": "id of the release",
  12025. "name": "id",
  12026. "in": "path",
  12027. "required": true
  12028. }
  12029. ],
  12030. "responses": {
  12031. "200": {
  12032. "$ref": "#/responses/AttachmentList"
  12033. },
  12034. "404": {
  12035. "$ref": "#/responses/notFound"
  12036. }
  12037. }
  12038. },
  12039. "post": {
  12040. "consumes": [
  12041. "multipart/form-data"
  12042. ],
  12043. "produces": [
  12044. "application/json"
  12045. ],
  12046. "tags": [
  12047. "repository"
  12048. ],
  12049. "summary": "Create a release attachment",
  12050. "operationId": "repoCreateReleaseAttachment",
  12051. "parameters": [
  12052. {
  12053. "type": "string",
  12054. "description": "owner of the repo",
  12055. "name": "owner",
  12056. "in": "path",
  12057. "required": true
  12058. },
  12059. {
  12060. "type": "string",
  12061. "description": "name of the repo",
  12062. "name": "repo",
  12063. "in": "path",
  12064. "required": true
  12065. },
  12066. {
  12067. "type": "integer",
  12068. "format": "int64",
  12069. "description": "id of the release",
  12070. "name": "id",
  12071. "in": "path",
  12072. "required": true
  12073. },
  12074. {
  12075. "type": "string",
  12076. "description": "name of the attachment",
  12077. "name": "name",
  12078. "in": "query"
  12079. },
  12080. {
  12081. "type": "file",
  12082. "description": "attachment to upload",
  12083. "name": "attachment",
  12084. "in": "formData",
  12085. "required": true
  12086. }
  12087. ],
  12088. "responses": {
  12089. "201": {
  12090. "$ref": "#/responses/Attachment"
  12091. },
  12092. "400": {
  12093. "$ref": "#/responses/error"
  12094. },
  12095. "404": {
  12096. "$ref": "#/responses/notFound"
  12097. }
  12098. }
  12099. }
  12100. },
  12101. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  12102. "get": {
  12103. "produces": [
  12104. "application/json"
  12105. ],
  12106. "tags": [
  12107. "repository"
  12108. ],
  12109. "summary": "Get a release attachment",
  12110. "operationId": "repoGetReleaseAttachment",
  12111. "parameters": [
  12112. {
  12113. "type": "string",
  12114. "description": "owner of the repo",
  12115. "name": "owner",
  12116. "in": "path",
  12117. "required": true
  12118. },
  12119. {
  12120. "type": "string",
  12121. "description": "name of the repo",
  12122. "name": "repo",
  12123. "in": "path",
  12124. "required": true
  12125. },
  12126. {
  12127. "type": "integer",
  12128. "format": "int64",
  12129. "description": "id of the release",
  12130. "name": "id",
  12131. "in": "path",
  12132. "required": true
  12133. },
  12134. {
  12135. "type": "integer",
  12136. "format": "int64",
  12137. "description": "id of the attachment to get",
  12138. "name": "attachment_id",
  12139. "in": "path",
  12140. "required": true
  12141. }
  12142. ],
  12143. "responses": {
  12144. "200": {
  12145. "$ref": "#/responses/Attachment"
  12146. },
  12147. "404": {
  12148. "$ref": "#/responses/notFound"
  12149. }
  12150. }
  12151. },
  12152. "delete": {
  12153. "produces": [
  12154. "application/json"
  12155. ],
  12156. "tags": [
  12157. "repository"
  12158. ],
  12159. "summary": "Delete a release attachment",
  12160. "operationId": "repoDeleteReleaseAttachment",
  12161. "parameters": [
  12162. {
  12163. "type": "string",
  12164. "description": "owner of the repo",
  12165. "name": "owner",
  12166. "in": "path",
  12167. "required": true
  12168. },
  12169. {
  12170. "type": "string",
  12171. "description": "name of the repo",
  12172. "name": "repo",
  12173. "in": "path",
  12174. "required": true
  12175. },
  12176. {
  12177. "type": "integer",
  12178. "format": "int64",
  12179. "description": "id of the release",
  12180. "name": "id",
  12181. "in": "path",
  12182. "required": true
  12183. },
  12184. {
  12185. "type": "integer",
  12186. "format": "int64",
  12187. "description": "id of the attachment to delete",
  12188. "name": "attachment_id",
  12189. "in": "path",
  12190. "required": true
  12191. }
  12192. ],
  12193. "responses": {
  12194. "204": {
  12195. "$ref": "#/responses/empty"
  12196. },
  12197. "404": {
  12198. "$ref": "#/responses/notFound"
  12199. }
  12200. }
  12201. },
  12202. "patch": {
  12203. "consumes": [
  12204. "application/json"
  12205. ],
  12206. "produces": [
  12207. "application/json"
  12208. ],
  12209. "tags": [
  12210. "repository"
  12211. ],
  12212. "summary": "Edit a release attachment",
  12213. "operationId": "repoEditReleaseAttachment",
  12214. "parameters": [
  12215. {
  12216. "type": "string",
  12217. "description": "owner of the repo",
  12218. "name": "owner",
  12219. "in": "path",
  12220. "required": true
  12221. },
  12222. {
  12223. "type": "string",
  12224. "description": "name of the repo",
  12225. "name": "repo",
  12226. "in": "path",
  12227. "required": true
  12228. },
  12229. {
  12230. "type": "integer",
  12231. "format": "int64",
  12232. "description": "id of the release",
  12233. "name": "id",
  12234. "in": "path",
  12235. "required": true
  12236. },
  12237. {
  12238. "type": "integer",
  12239. "format": "int64",
  12240. "description": "id of the attachment to edit",
  12241. "name": "attachment_id",
  12242. "in": "path",
  12243. "required": true
  12244. },
  12245. {
  12246. "name": "body",
  12247. "in": "body",
  12248. "schema": {
  12249. "$ref": "#/definitions/EditAttachmentOptions"
  12250. }
  12251. }
  12252. ],
  12253. "responses": {
  12254. "201": {
  12255. "$ref": "#/responses/Attachment"
  12256. },
  12257. "404": {
  12258. "$ref": "#/responses/notFound"
  12259. }
  12260. }
  12261. }
  12262. },
  12263. "/repos/{owner}/{repo}/reviewers": {
  12264. "get": {
  12265. "produces": [
  12266. "application/json"
  12267. ],
  12268. "tags": [
  12269. "repository"
  12270. ],
  12271. "summary": "Return all users that can be requested to review in this repo",
  12272. "operationId": "repoGetReviewers",
  12273. "parameters": [
  12274. {
  12275. "type": "string",
  12276. "description": "owner of the repo",
  12277. "name": "owner",
  12278. "in": "path",
  12279. "required": true
  12280. },
  12281. {
  12282. "type": "string",
  12283. "description": "name of the repo",
  12284. "name": "repo",
  12285. "in": "path",
  12286. "required": true
  12287. }
  12288. ],
  12289. "responses": {
  12290. "200": {
  12291. "$ref": "#/responses/UserList"
  12292. },
  12293. "404": {
  12294. "$ref": "#/responses/notFound"
  12295. }
  12296. }
  12297. }
  12298. },
  12299. "/repos/{owner}/{repo}/signing-key.gpg": {
  12300. "get": {
  12301. "produces": [
  12302. "text/plain"
  12303. ],
  12304. "tags": [
  12305. "repository"
  12306. ],
  12307. "summary": "Get signing-key.gpg for given repository",
  12308. "operationId": "repoSigningKey",
  12309. "parameters": [
  12310. {
  12311. "type": "string",
  12312. "description": "owner of the repo",
  12313. "name": "owner",
  12314. "in": "path",
  12315. "required": true
  12316. },
  12317. {
  12318. "type": "string",
  12319. "description": "name of the repo",
  12320. "name": "repo",
  12321. "in": "path",
  12322. "required": true
  12323. }
  12324. ],
  12325. "responses": {
  12326. "200": {
  12327. "description": "GPG armored public key",
  12328. "schema": {
  12329. "type": "string"
  12330. }
  12331. }
  12332. }
  12333. }
  12334. },
  12335. "/repos/{owner}/{repo}/stargazers": {
  12336. "get": {
  12337. "produces": [
  12338. "application/json"
  12339. ],
  12340. "tags": [
  12341. "repository"
  12342. ],
  12343. "summary": "List a repo's stargazers",
  12344. "operationId": "repoListStargazers",
  12345. "parameters": [
  12346. {
  12347. "type": "string",
  12348. "description": "owner of the repo",
  12349. "name": "owner",
  12350. "in": "path",
  12351. "required": true
  12352. },
  12353. {
  12354. "type": "string",
  12355. "description": "name of the repo",
  12356. "name": "repo",
  12357. "in": "path",
  12358. "required": true
  12359. },
  12360. {
  12361. "type": "integer",
  12362. "description": "page number of results to return (1-based)",
  12363. "name": "page",
  12364. "in": "query"
  12365. },
  12366. {
  12367. "type": "integer",
  12368. "description": "page size of results",
  12369. "name": "limit",
  12370. "in": "query"
  12371. }
  12372. ],
  12373. "responses": {
  12374. "200": {
  12375. "$ref": "#/responses/UserList"
  12376. },
  12377. "404": {
  12378. "$ref": "#/responses/notFound"
  12379. }
  12380. }
  12381. }
  12382. },
  12383. "/repos/{owner}/{repo}/statuses/{sha}": {
  12384. "get": {
  12385. "produces": [
  12386. "application/json"
  12387. ],
  12388. "tags": [
  12389. "repository"
  12390. ],
  12391. "summary": "Get a commit's statuses",
  12392. "operationId": "repoListStatuses",
  12393. "parameters": [
  12394. {
  12395. "type": "string",
  12396. "description": "owner of the repo",
  12397. "name": "owner",
  12398. "in": "path",
  12399. "required": true
  12400. },
  12401. {
  12402. "type": "string",
  12403. "description": "name of the repo",
  12404. "name": "repo",
  12405. "in": "path",
  12406. "required": true
  12407. },
  12408. {
  12409. "type": "string",
  12410. "description": "sha of the commit",
  12411. "name": "sha",
  12412. "in": "path",
  12413. "required": true
  12414. },
  12415. {
  12416. "enum": [
  12417. "oldest",
  12418. "recentupdate",
  12419. "leastupdate",
  12420. "leastindex",
  12421. "highestindex"
  12422. ],
  12423. "type": "string",
  12424. "description": "type of sort",
  12425. "name": "sort",
  12426. "in": "query"
  12427. },
  12428. {
  12429. "enum": [
  12430. "pending",
  12431. "success",
  12432. "error",
  12433. "failure",
  12434. "warning"
  12435. ],
  12436. "type": "string",
  12437. "description": "type of state",
  12438. "name": "state",
  12439. "in": "query"
  12440. },
  12441. {
  12442. "type": "integer",
  12443. "description": "page number of results to return (1-based)",
  12444. "name": "page",
  12445. "in": "query"
  12446. },
  12447. {
  12448. "type": "integer",
  12449. "description": "page size of results",
  12450. "name": "limit",
  12451. "in": "query"
  12452. }
  12453. ],
  12454. "responses": {
  12455. "200": {
  12456. "$ref": "#/responses/CommitStatusList"
  12457. },
  12458. "400": {
  12459. "$ref": "#/responses/error"
  12460. },
  12461. "404": {
  12462. "$ref": "#/responses/notFound"
  12463. }
  12464. }
  12465. },
  12466. "post": {
  12467. "produces": [
  12468. "application/json"
  12469. ],
  12470. "tags": [
  12471. "repository"
  12472. ],
  12473. "summary": "Create a commit status",
  12474. "operationId": "repoCreateStatus",
  12475. "parameters": [
  12476. {
  12477. "type": "string",
  12478. "description": "owner of the repo",
  12479. "name": "owner",
  12480. "in": "path",
  12481. "required": true
  12482. },
  12483. {
  12484. "type": "string",
  12485. "description": "name of the repo",
  12486. "name": "repo",
  12487. "in": "path",
  12488. "required": true
  12489. },
  12490. {
  12491. "type": "string",
  12492. "description": "sha of the commit",
  12493. "name": "sha",
  12494. "in": "path",
  12495. "required": true
  12496. },
  12497. {
  12498. "name": "body",
  12499. "in": "body",
  12500. "schema": {
  12501. "$ref": "#/definitions/CreateStatusOption"
  12502. }
  12503. }
  12504. ],
  12505. "responses": {
  12506. "201": {
  12507. "$ref": "#/responses/CommitStatus"
  12508. },
  12509. "400": {
  12510. "$ref": "#/responses/error"
  12511. },
  12512. "404": {
  12513. "$ref": "#/responses/notFound"
  12514. }
  12515. }
  12516. }
  12517. },
  12518. "/repos/{owner}/{repo}/subscribers": {
  12519. "get": {
  12520. "produces": [
  12521. "application/json"
  12522. ],
  12523. "tags": [
  12524. "repository"
  12525. ],
  12526. "summary": "List a repo's watchers",
  12527. "operationId": "repoListSubscribers",
  12528. "parameters": [
  12529. {
  12530. "type": "string",
  12531. "description": "owner of the repo",
  12532. "name": "owner",
  12533. "in": "path",
  12534. "required": true
  12535. },
  12536. {
  12537. "type": "string",
  12538. "description": "name of the repo",
  12539. "name": "repo",
  12540. "in": "path",
  12541. "required": true
  12542. },
  12543. {
  12544. "type": "integer",
  12545. "description": "page number of results to return (1-based)",
  12546. "name": "page",
  12547. "in": "query"
  12548. },
  12549. {
  12550. "type": "integer",
  12551. "description": "page size of results",
  12552. "name": "limit",
  12553. "in": "query"
  12554. }
  12555. ],
  12556. "responses": {
  12557. "200": {
  12558. "$ref": "#/responses/UserList"
  12559. },
  12560. "404": {
  12561. "$ref": "#/responses/notFound"
  12562. }
  12563. }
  12564. }
  12565. },
  12566. "/repos/{owner}/{repo}/subscription": {
  12567. "get": {
  12568. "tags": [
  12569. "repository"
  12570. ],
  12571. "summary": "Check if the current user is watching a repo",
  12572. "operationId": "userCurrentCheckSubscription",
  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. "responses": {
  12590. "200": {
  12591. "$ref": "#/responses/WatchInfo"
  12592. },
  12593. "404": {
  12594. "description": "User is not watching this repo or repo do not exist"
  12595. }
  12596. }
  12597. },
  12598. "put": {
  12599. "tags": [
  12600. "repository"
  12601. ],
  12602. "summary": "Watch a repo",
  12603. "operationId": "userCurrentPutSubscription",
  12604. "parameters": [
  12605. {
  12606. "type": "string",
  12607. "description": "owner of the repo",
  12608. "name": "owner",
  12609. "in": "path",
  12610. "required": true
  12611. },
  12612. {
  12613. "type": "string",
  12614. "description": "name of the repo",
  12615. "name": "repo",
  12616. "in": "path",
  12617. "required": true
  12618. }
  12619. ],
  12620. "responses": {
  12621. "200": {
  12622. "$ref": "#/responses/WatchInfo"
  12623. },
  12624. "404": {
  12625. "$ref": "#/responses/notFound"
  12626. }
  12627. }
  12628. },
  12629. "delete": {
  12630. "tags": [
  12631. "repository"
  12632. ],
  12633. "summary": "Unwatch a repo",
  12634. "operationId": "userCurrentDeleteSubscription",
  12635. "parameters": [
  12636. {
  12637. "type": "string",
  12638. "description": "owner of the repo",
  12639. "name": "owner",
  12640. "in": "path",
  12641. "required": true
  12642. },
  12643. {
  12644. "type": "string",
  12645. "description": "name of the repo",
  12646. "name": "repo",
  12647. "in": "path",
  12648. "required": true
  12649. }
  12650. ],
  12651. "responses": {
  12652. "204": {
  12653. "$ref": "#/responses/empty"
  12654. },
  12655. "404": {
  12656. "$ref": "#/responses/notFound"
  12657. }
  12658. }
  12659. }
  12660. },
  12661. "/repos/{owner}/{repo}/tags": {
  12662. "get": {
  12663. "produces": [
  12664. "application/json"
  12665. ],
  12666. "tags": [
  12667. "repository"
  12668. ],
  12669. "summary": "List a repository's tags",
  12670. "operationId": "repoListTags",
  12671. "parameters": [
  12672. {
  12673. "type": "string",
  12674. "description": "owner of the repo",
  12675. "name": "owner",
  12676. "in": "path",
  12677. "required": true
  12678. },
  12679. {
  12680. "type": "string",
  12681. "description": "name of the repo",
  12682. "name": "repo",
  12683. "in": "path",
  12684. "required": true
  12685. },
  12686. {
  12687. "type": "integer",
  12688. "description": "page number of results to return (1-based)",
  12689. "name": "page",
  12690. "in": "query"
  12691. },
  12692. {
  12693. "type": "integer",
  12694. "description": "page size of results, default maximum page size is 50",
  12695. "name": "limit",
  12696. "in": "query"
  12697. }
  12698. ],
  12699. "responses": {
  12700. "200": {
  12701. "$ref": "#/responses/TagList"
  12702. },
  12703. "404": {
  12704. "$ref": "#/responses/notFound"
  12705. }
  12706. }
  12707. },
  12708. "post": {
  12709. "produces": [
  12710. "application/json"
  12711. ],
  12712. "tags": [
  12713. "repository"
  12714. ],
  12715. "summary": "Create a new git tag in a repository",
  12716. "operationId": "repoCreateTag",
  12717. "parameters": [
  12718. {
  12719. "type": "string",
  12720. "description": "owner of the repo",
  12721. "name": "owner",
  12722. "in": "path",
  12723. "required": true
  12724. },
  12725. {
  12726. "type": "string",
  12727. "description": "name of the repo",
  12728. "name": "repo",
  12729. "in": "path",
  12730. "required": true
  12731. },
  12732. {
  12733. "name": "body",
  12734. "in": "body",
  12735. "schema": {
  12736. "$ref": "#/definitions/CreateTagOption"
  12737. }
  12738. }
  12739. ],
  12740. "responses": {
  12741. "200": {
  12742. "$ref": "#/responses/Tag"
  12743. },
  12744. "404": {
  12745. "$ref": "#/responses/notFound"
  12746. },
  12747. "405": {
  12748. "$ref": "#/responses/empty"
  12749. },
  12750. "409": {
  12751. "$ref": "#/responses/conflict"
  12752. }
  12753. }
  12754. }
  12755. },
  12756. "/repos/{owner}/{repo}/tags/{tag}": {
  12757. "get": {
  12758. "produces": [
  12759. "application/json"
  12760. ],
  12761. "tags": [
  12762. "repository"
  12763. ],
  12764. "summary": "Get the tag of a repository by tag name",
  12765. "operationId": "repoGetTag",
  12766. "parameters": [
  12767. {
  12768. "type": "string",
  12769. "description": "owner of the repo",
  12770. "name": "owner",
  12771. "in": "path",
  12772. "required": true
  12773. },
  12774. {
  12775. "type": "string",
  12776. "description": "name of the repo",
  12777. "name": "repo",
  12778. "in": "path",
  12779. "required": true
  12780. },
  12781. {
  12782. "type": "string",
  12783. "description": "name of tag",
  12784. "name": "tag",
  12785. "in": "path",
  12786. "required": true
  12787. }
  12788. ],
  12789. "responses": {
  12790. "200": {
  12791. "$ref": "#/responses/Tag"
  12792. },
  12793. "404": {
  12794. "$ref": "#/responses/notFound"
  12795. }
  12796. }
  12797. },
  12798. "delete": {
  12799. "produces": [
  12800. "application/json"
  12801. ],
  12802. "tags": [
  12803. "repository"
  12804. ],
  12805. "summary": "Delete a repository's tag by name",
  12806. "operationId": "repoDeleteTag",
  12807. "parameters": [
  12808. {
  12809. "type": "string",
  12810. "description": "owner of the repo",
  12811. "name": "owner",
  12812. "in": "path",
  12813. "required": true
  12814. },
  12815. {
  12816. "type": "string",
  12817. "description": "name of the repo",
  12818. "name": "repo",
  12819. "in": "path",
  12820. "required": true
  12821. },
  12822. {
  12823. "type": "string",
  12824. "description": "name of tag to delete",
  12825. "name": "tag",
  12826. "in": "path",
  12827. "required": true
  12828. }
  12829. ],
  12830. "responses": {
  12831. "204": {
  12832. "$ref": "#/responses/empty"
  12833. },
  12834. "404": {
  12835. "$ref": "#/responses/notFound"
  12836. },
  12837. "405": {
  12838. "$ref": "#/responses/empty"
  12839. },
  12840. "409": {
  12841. "$ref": "#/responses/conflict"
  12842. }
  12843. }
  12844. }
  12845. },
  12846. "/repos/{owner}/{repo}/teams": {
  12847. "get": {
  12848. "produces": [
  12849. "application/json"
  12850. ],
  12851. "tags": [
  12852. "repository"
  12853. ],
  12854. "summary": "List a repository's teams",
  12855. "operationId": "repoListTeams",
  12856. "parameters": [
  12857. {
  12858. "type": "string",
  12859. "description": "owner of the repo",
  12860. "name": "owner",
  12861. "in": "path",
  12862. "required": true
  12863. },
  12864. {
  12865. "type": "string",
  12866. "description": "name of the repo",
  12867. "name": "repo",
  12868. "in": "path",
  12869. "required": true
  12870. }
  12871. ],
  12872. "responses": {
  12873. "200": {
  12874. "$ref": "#/responses/TeamList"
  12875. },
  12876. "404": {
  12877. "$ref": "#/responses/notFound"
  12878. }
  12879. }
  12880. }
  12881. },
  12882. "/repos/{owner}/{repo}/teams/{team}": {
  12883. "get": {
  12884. "produces": [
  12885. "application/json"
  12886. ],
  12887. "tags": [
  12888. "repository"
  12889. ],
  12890. "summary": "Check if a team is assigned to a repository",
  12891. "operationId": "repoCheckTeam",
  12892. "parameters": [
  12893. {
  12894. "type": "string",
  12895. "description": "owner of the repo",
  12896. "name": "owner",
  12897. "in": "path",
  12898. "required": true
  12899. },
  12900. {
  12901. "type": "string",
  12902. "description": "name of the repo",
  12903. "name": "repo",
  12904. "in": "path",
  12905. "required": true
  12906. },
  12907. {
  12908. "type": "string",
  12909. "description": "team name",
  12910. "name": "team",
  12911. "in": "path",
  12912. "required": true
  12913. }
  12914. ],
  12915. "responses": {
  12916. "200": {
  12917. "$ref": "#/responses/Team"
  12918. },
  12919. "404": {
  12920. "$ref": "#/responses/notFound"
  12921. },
  12922. "405": {
  12923. "$ref": "#/responses/error"
  12924. }
  12925. }
  12926. },
  12927. "put": {
  12928. "produces": [
  12929. "application/json"
  12930. ],
  12931. "tags": [
  12932. "repository"
  12933. ],
  12934. "summary": "Add a team to a repository",
  12935. "operationId": "repoAddTeam",
  12936. "parameters": [
  12937. {
  12938. "type": "string",
  12939. "description": "owner of the repo",
  12940. "name": "owner",
  12941. "in": "path",
  12942. "required": true
  12943. },
  12944. {
  12945. "type": "string",
  12946. "description": "name of the repo",
  12947. "name": "repo",
  12948. "in": "path",
  12949. "required": true
  12950. },
  12951. {
  12952. "type": "string",
  12953. "description": "team name",
  12954. "name": "team",
  12955. "in": "path",
  12956. "required": true
  12957. }
  12958. ],
  12959. "responses": {
  12960. "204": {
  12961. "$ref": "#/responses/empty"
  12962. },
  12963. "404": {
  12964. "$ref": "#/responses/notFound"
  12965. },
  12966. "405": {
  12967. "$ref": "#/responses/error"
  12968. },
  12969. "422": {
  12970. "$ref": "#/responses/validationError"
  12971. }
  12972. }
  12973. },
  12974. "delete": {
  12975. "produces": [
  12976. "application/json"
  12977. ],
  12978. "tags": [
  12979. "repository"
  12980. ],
  12981. "summary": "Delete a team from a repository",
  12982. "operationId": "repoDeleteTeam",
  12983. "parameters": [
  12984. {
  12985. "type": "string",
  12986. "description": "owner of the repo",
  12987. "name": "owner",
  12988. "in": "path",
  12989. "required": true
  12990. },
  12991. {
  12992. "type": "string",
  12993. "description": "name of the repo",
  12994. "name": "repo",
  12995. "in": "path",
  12996. "required": true
  12997. },
  12998. {
  12999. "type": "string",
  13000. "description": "team name",
  13001. "name": "team",
  13002. "in": "path",
  13003. "required": true
  13004. }
  13005. ],
  13006. "responses": {
  13007. "204": {
  13008. "$ref": "#/responses/empty"
  13009. },
  13010. "404": {
  13011. "$ref": "#/responses/notFound"
  13012. },
  13013. "405": {
  13014. "$ref": "#/responses/error"
  13015. },
  13016. "422": {
  13017. "$ref": "#/responses/validationError"
  13018. }
  13019. }
  13020. }
  13021. },
  13022. "/repos/{owner}/{repo}/times": {
  13023. "get": {
  13024. "produces": [
  13025. "application/json"
  13026. ],
  13027. "tags": [
  13028. "repository"
  13029. ],
  13030. "summary": "List a repo's tracked times",
  13031. "operationId": "repoTrackedTimes",
  13032. "parameters": [
  13033. {
  13034. "type": "string",
  13035. "description": "owner of the repo",
  13036. "name": "owner",
  13037. "in": "path",
  13038. "required": true
  13039. },
  13040. {
  13041. "type": "string",
  13042. "description": "name of the repo",
  13043. "name": "repo",
  13044. "in": "path",
  13045. "required": true
  13046. },
  13047. {
  13048. "type": "string",
  13049. "description": "optional filter by user (available for issue managers)",
  13050. "name": "user",
  13051. "in": "query"
  13052. },
  13053. {
  13054. "type": "string",
  13055. "format": "date-time",
  13056. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  13057. "name": "since",
  13058. "in": "query"
  13059. },
  13060. {
  13061. "type": "string",
  13062. "format": "date-time",
  13063. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  13064. "name": "before",
  13065. "in": "query"
  13066. },
  13067. {
  13068. "type": "integer",
  13069. "description": "page number of results to return (1-based)",
  13070. "name": "page",
  13071. "in": "query"
  13072. },
  13073. {
  13074. "type": "integer",
  13075. "description": "page size of results",
  13076. "name": "limit",
  13077. "in": "query"
  13078. }
  13079. ],
  13080. "responses": {
  13081. "200": {
  13082. "$ref": "#/responses/TrackedTimeList"
  13083. },
  13084. "400": {
  13085. "$ref": "#/responses/error"
  13086. },
  13087. "403": {
  13088. "$ref": "#/responses/forbidden"
  13089. },
  13090. "404": {
  13091. "$ref": "#/responses/notFound"
  13092. }
  13093. }
  13094. }
  13095. },
  13096. "/repos/{owner}/{repo}/times/{user}": {
  13097. "get": {
  13098. "produces": [
  13099. "application/json"
  13100. ],
  13101. "tags": [
  13102. "repository"
  13103. ],
  13104. "summary": "List a user's tracked times in a repo",
  13105. "operationId": "userTrackedTimes",
  13106. "deprecated": true,
  13107. "parameters": [
  13108. {
  13109. "type": "string",
  13110. "description": "owner of the repo",
  13111. "name": "owner",
  13112. "in": "path",
  13113. "required": true
  13114. },
  13115. {
  13116. "type": "string",
  13117. "description": "name of the repo",
  13118. "name": "repo",
  13119. "in": "path",
  13120. "required": true
  13121. },
  13122. {
  13123. "type": "string",
  13124. "description": "username of user",
  13125. "name": "user",
  13126. "in": "path",
  13127. "required": true
  13128. }
  13129. ],
  13130. "responses": {
  13131. "200": {
  13132. "$ref": "#/responses/TrackedTimeList"
  13133. },
  13134. "400": {
  13135. "$ref": "#/responses/error"
  13136. },
  13137. "403": {
  13138. "$ref": "#/responses/forbidden"
  13139. },
  13140. "404": {
  13141. "$ref": "#/responses/notFound"
  13142. }
  13143. }
  13144. }
  13145. },
  13146. "/repos/{owner}/{repo}/topics": {
  13147. "get": {
  13148. "produces": [
  13149. "application/json"
  13150. ],
  13151. "tags": [
  13152. "repository"
  13153. ],
  13154. "summary": "Get list of topics that a repository has",
  13155. "operationId": "repoListTopics",
  13156. "parameters": [
  13157. {
  13158. "type": "string",
  13159. "description": "owner of the repo",
  13160. "name": "owner",
  13161. "in": "path",
  13162. "required": true
  13163. },
  13164. {
  13165. "type": "string",
  13166. "description": "name of the repo",
  13167. "name": "repo",
  13168. "in": "path",
  13169. "required": true
  13170. },
  13171. {
  13172. "type": "integer",
  13173. "description": "page number of results to return (1-based)",
  13174. "name": "page",
  13175. "in": "query"
  13176. },
  13177. {
  13178. "type": "integer",
  13179. "description": "page size of results",
  13180. "name": "limit",
  13181. "in": "query"
  13182. }
  13183. ],
  13184. "responses": {
  13185. "200": {
  13186. "$ref": "#/responses/TopicNames"
  13187. },
  13188. "404": {
  13189. "$ref": "#/responses/notFound"
  13190. }
  13191. }
  13192. },
  13193. "put": {
  13194. "produces": [
  13195. "application/json"
  13196. ],
  13197. "tags": [
  13198. "repository"
  13199. ],
  13200. "summary": "Replace list of topics for a repository",
  13201. "operationId": "repoUpdateTopics",
  13202. "parameters": [
  13203. {
  13204. "type": "string",
  13205. "description": "owner of the repo",
  13206. "name": "owner",
  13207. "in": "path",
  13208. "required": true
  13209. },
  13210. {
  13211. "type": "string",
  13212. "description": "name of the repo",
  13213. "name": "repo",
  13214. "in": "path",
  13215. "required": true
  13216. },
  13217. {
  13218. "name": "body",
  13219. "in": "body",
  13220. "schema": {
  13221. "$ref": "#/definitions/RepoTopicOptions"
  13222. }
  13223. }
  13224. ],
  13225. "responses": {
  13226. "204": {
  13227. "$ref": "#/responses/empty"
  13228. },
  13229. "404": {
  13230. "$ref": "#/responses/notFound"
  13231. },
  13232. "422": {
  13233. "$ref": "#/responses/invalidTopicsError"
  13234. }
  13235. }
  13236. }
  13237. },
  13238. "/repos/{owner}/{repo}/topics/{topic}": {
  13239. "put": {
  13240. "produces": [
  13241. "application/json"
  13242. ],
  13243. "tags": [
  13244. "repository"
  13245. ],
  13246. "summary": "Add a topic to a repository",
  13247. "operationId": "repoAddTopic",
  13248. "parameters": [
  13249. {
  13250. "type": "string",
  13251. "description": "owner of the repo",
  13252. "name": "owner",
  13253. "in": "path",
  13254. "required": true
  13255. },
  13256. {
  13257. "type": "string",
  13258. "description": "name of the repo",
  13259. "name": "repo",
  13260. "in": "path",
  13261. "required": true
  13262. },
  13263. {
  13264. "type": "string",
  13265. "description": "name of the topic to add",
  13266. "name": "topic",
  13267. "in": "path",
  13268. "required": true
  13269. }
  13270. ],
  13271. "responses": {
  13272. "204": {
  13273. "$ref": "#/responses/empty"
  13274. },
  13275. "404": {
  13276. "$ref": "#/responses/notFound"
  13277. },
  13278. "422": {
  13279. "$ref": "#/responses/invalidTopicsError"
  13280. }
  13281. }
  13282. },
  13283. "delete": {
  13284. "produces": [
  13285. "application/json"
  13286. ],
  13287. "tags": [
  13288. "repository"
  13289. ],
  13290. "summary": "Delete a topic from a repository",
  13291. "operationId": "repoDeleteTopic",
  13292. "parameters": [
  13293. {
  13294. "type": "string",
  13295. "description": "owner of the repo",
  13296. "name": "owner",
  13297. "in": "path",
  13298. "required": true
  13299. },
  13300. {
  13301. "type": "string",
  13302. "description": "name of the repo",
  13303. "name": "repo",
  13304. "in": "path",
  13305. "required": true
  13306. },
  13307. {
  13308. "type": "string",
  13309. "description": "name of the topic to delete",
  13310. "name": "topic",
  13311. "in": "path",
  13312. "required": true
  13313. }
  13314. ],
  13315. "responses": {
  13316. "204": {
  13317. "$ref": "#/responses/empty"
  13318. },
  13319. "404": {
  13320. "$ref": "#/responses/notFound"
  13321. },
  13322. "422": {
  13323. "$ref": "#/responses/invalidTopicsError"
  13324. }
  13325. }
  13326. }
  13327. },
  13328. "/repos/{owner}/{repo}/transfer": {
  13329. "post": {
  13330. "produces": [
  13331. "application/json"
  13332. ],
  13333. "tags": [
  13334. "repository"
  13335. ],
  13336. "summary": "Transfer a repo ownership",
  13337. "operationId": "repoTransfer",
  13338. "parameters": [
  13339. {
  13340. "type": "string",
  13341. "description": "owner of the repo to transfer",
  13342. "name": "owner",
  13343. "in": "path",
  13344. "required": true
  13345. },
  13346. {
  13347. "type": "string",
  13348. "description": "name of the repo to transfer",
  13349. "name": "repo",
  13350. "in": "path",
  13351. "required": true
  13352. },
  13353. {
  13354. "description": "Transfer Options",
  13355. "name": "body",
  13356. "in": "body",
  13357. "required": true,
  13358. "schema": {
  13359. "$ref": "#/definitions/TransferRepoOption"
  13360. }
  13361. }
  13362. ],
  13363. "responses": {
  13364. "202": {
  13365. "$ref": "#/responses/Repository"
  13366. },
  13367. "403": {
  13368. "$ref": "#/responses/forbidden"
  13369. },
  13370. "404": {
  13371. "$ref": "#/responses/notFound"
  13372. },
  13373. "422": {
  13374. "$ref": "#/responses/validationError"
  13375. }
  13376. }
  13377. }
  13378. },
  13379. "/repos/{owner}/{repo}/transfer/accept": {
  13380. "post": {
  13381. "produces": [
  13382. "application/json"
  13383. ],
  13384. "tags": [
  13385. "repository"
  13386. ],
  13387. "summary": "Accept a repo transfer",
  13388. "operationId": "acceptRepoTransfer",
  13389. "parameters": [
  13390. {
  13391. "type": "string",
  13392. "description": "owner of the repo to transfer",
  13393. "name": "owner",
  13394. "in": "path",
  13395. "required": true
  13396. },
  13397. {
  13398. "type": "string",
  13399. "description": "name of the repo to transfer",
  13400. "name": "repo",
  13401. "in": "path",
  13402. "required": true
  13403. }
  13404. ],
  13405. "responses": {
  13406. "202": {
  13407. "$ref": "#/responses/Repository"
  13408. },
  13409. "403": {
  13410. "$ref": "#/responses/forbidden"
  13411. },
  13412. "404": {
  13413. "$ref": "#/responses/notFound"
  13414. }
  13415. }
  13416. }
  13417. },
  13418. "/repos/{owner}/{repo}/transfer/reject": {
  13419. "post": {
  13420. "produces": [
  13421. "application/json"
  13422. ],
  13423. "tags": [
  13424. "repository"
  13425. ],
  13426. "summary": "Reject a repo transfer",
  13427. "operationId": "rejectRepoTransfer",
  13428. "parameters": [
  13429. {
  13430. "type": "string",
  13431. "description": "owner of the repo to transfer",
  13432. "name": "owner",
  13433. "in": "path",
  13434. "required": true
  13435. },
  13436. {
  13437. "type": "string",
  13438. "description": "name of the repo to transfer",
  13439. "name": "repo",
  13440. "in": "path",
  13441. "required": true
  13442. }
  13443. ],
  13444. "responses": {
  13445. "200": {
  13446. "$ref": "#/responses/Repository"
  13447. },
  13448. "403": {
  13449. "$ref": "#/responses/forbidden"
  13450. },
  13451. "404": {
  13452. "$ref": "#/responses/notFound"
  13453. }
  13454. }
  13455. }
  13456. },
  13457. "/repos/{owner}/{repo}/wiki/new": {
  13458. "post": {
  13459. "consumes": [
  13460. "application/json"
  13461. ],
  13462. "tags": [
  13463. "repository"
  13464. ],
  13465. "summary": "Create a wiki page",
  13466. "operationId": "repoCreateWikiPage",
  13467. "parameters": [
  13468. {
  13469. "type": "string",
  13470. "description": "owner of the repo",
  13471. "name": "owner",
  13472. "in": "path",
  13473. "required": true
  13474. },
  13475. {
  13476. "type": "string",
  13477. "description": "name of the repo",
  13478. "name": "repo",
  13479. "in": "path",
  13480. "required": true
  13481. },
  13482. {
  13483. "name": "body",
  13484. "in": "body",
  13485. "schema": {
  13486. "$ref": "#/definitions/CreateWikiPageOptions"
  13487. }
  13488. }
  13489. ],
  13490. "responses": {
  13491. "201": {
  13492. "$ref": "#/responses/WikiPage"
  13493. },
  13494. "400": {
  13495. "$ref": "#/responses/error"
  13496. },
  13497. "403": {
  13498. "$ref": "#/responses/forbidden"
  13499. },
  13500. "404": {
  13501. "$ref": "#/responses/notFound"
  13502. }
  13503. }
  13504. }
  13505. },
  13506. "/repos/{owner}/{repo}/wiki/page/{pageName}": {
  13507. "get": {
  13508. "produces": [
  13509. "application/json"
  13510. ],
  13511. "tags": [
  13512. "repository"
  13513. ],
  13514. "summary": "Get a wiki page",
  13515. "operationId": "repoGetWikiPage",
  13516. "parameters": [
  13517. {
  13518. "type": "string",
  13519. "description": "owner of the repo",
  13520. "name": "owner",
  13521. "in": "path",
  13522. "required": true
  13523. },
  13524. {
  13525. "type": "string",
  13526. "description": "name of the repo",
  13527. "name": "repo",
  13528. "in": "path",
  13529. "required": true
  13530. },
  13531. {
  13532. "type": "string",
  13533. "description": "name of the page",
  13534. "name": "pageName",
  13535. "in": "path",
  13536. "required": true
  13537. }
  13538. ],
  13539. "responses": {
  13540. "200": {
  13541. "$ref": "#/responses/WikiPage"
  13542. },
  13543. "404": {
  13544. "$ref": "#/responses/notFound"
  13545. }
  13546. }
  13547. },
  13548. "delete": {
  13549. "tags": [
  13550. "repository"
  13551. ],
  13552. "summary": "Delete a wiki page",
  13553. "operationId": "repoDeleteWikiPage",
  13554. "parameters": [
  13555. {
  13556. "type": "string",
  13557. "description": "owner of the repo",
  13558. "name": "owner",
  13559. "in": "path",
  13560. "required": true
  13561. },
  13562. {
  13563. "type": "string",
  13564. "description": "name of the repo",
  13565. "name": "repo",
  13566. "in": "path",
  13567. "required": true
  13568. },
  13569. {
  13570. "type": "string",
  13571. "description": "name of the page",
  13572. "name": "pageName",
  13573. "in": "path",
  13574. "required": true
  13575. }
  13576. ],
  13577. "responses": {
  13578. "204": {
  13579. "$ref": "#/responses/empty"
  13580. },
  13581. "403": {
  13582. "$ref": "#/responses/forbidden"
  13583. },
  13584. "404": {
  13585. "$ref": "#/responses/notFound"
  13586. }
  13587. }
  13588. },
  13589. "patch": {
  13590. "consumes": [
  13591. "application/json"
  13592. ],
  13593. "tags": [
  13594. "repository"
  13595. ],
  13596. "summary": "Edit a wiki page",
  13597. "operationId": "repoEditWikiPage",
  13598. "parameters": [
  13599. {
  13600. "type": "string",
  13601. "description": "owner of the repo",
  13602. "name": "owner",
  13603. "in": "path",
  13604. "required": true
  13605. },
  13606. {
  13607. "type": "string",
  13608. "description": "name of the repo",
  13609. "name": "repo",
  13610. "in": "path",
  13611. "required": true
  13612. },
  13613. {
  13614. "type": "string",
  13615. "description": "name of the page",
  13616. "name": "pageName",
  13617. "in": "path",
  13618. "required": true
  13619. },
  13620. {
  13621. "name": "body",
  13622. "in": "body",
  13623. "schema": {
  13624. "$ref": "#/definitions/CreateWikiPageOptions"
  13625. }
  13626. }
  13627. ],
  13628. "responses": {
  13629. "200": {
  13630. "$ref": "#/responses/WikiPage"
  13631. },
  13632. "400": {
  13633. "$ref": "#/responses/error"
  13634. },
  13635. "403": {
  13636. "$ref": "#/responses/forbidden"
  13637. },
  13638. "404": {
  13639. "$ref": "#/responses/notFound"
  13640. }
  13641. }
  13642. }
  13643. },
  13644. "/repos/{owner}/{repo}/wiki/pages": {
  13645. "get": {
  13646. "produces": [
  13647. "application/json"
  13648. ],
  13649. "tags": [
  13650. "repository"
  13651. ],
  13652. "summary": "Get all wiki pages",
  13653. "operationId": "repoGetWikiPages",
  13654. "parameters": [
  13655. {
  13656. "type": "string",
  13657. "description": "owner of the repo",
  13658. "name": "owner",
  13659. "in": "path",
  13660. "required": true
  13661. },
  13662. {
  13663. "type": "string",
  13664. "description": "name of the repo",
  13665. "name": "repo",
  13666. "in": "path",
  13667. "required": true
  13668. },
  13669. {
  13670. "type": "integer",
  13671. "description": "page number of results to return (1-based)",
  13672. "name": "page",
  13673. "in": "query"
  13674. },
  13675. {
  13676. "type": "integer",
  13677. "description": "page size of results",
  13678. "name": "limit",
  13679. "in": "query"
  13680. }
  13681. ],
  13682. "responses": {
  13683. "200": {
  13684. "$ref": "#/responses/WikiPageList"
  13685. },
  13686. "404": {
  13687. "$ref": "#/responses/notFound"
  13688. }
  13689. }
  13690. }
  13691. },
  13692. "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
  13693. "get": {
  13694. "produces": [
  13695. "application/json"
  13696. ],
  13697. "tags": [
  13698. "repository"
  13699. ],
  13700. "summary": "Get revisions of a wiki page",
  13701. "operationId": "repoGetWikiPageRevisions",
  13702. "parameters": [
  13703. {
  13704. "type": "string",
  13705. "description": "owner of the repo",
  13706. "name": "owner",
  13707. "in": "path",
  13708. "required": true
  13709. },
  13710. {
  13711. "type": "string",
  13712. "description": "name of the repo",
  13713. "name": "repo",
  13714. "in": "path",
  13715. "required": true
  13716. },
  13717. {
  13718. "type": "string",
  13719. "description": "name of the page",
  13720. "name": "pageName",
  13721. "in": "path",
  13722. "required": true
  13723. },
  13724. {
  13725. "type": "integer",
  13726. "description": "page number of results to return (1-based)",
  13727. "name": "page",
  13728. "in": "query"
  13729. }
  13730. ],
  13731. "responses": {
  13732. "200": {
  13733. "$ref": "#/responses/WikiCommitList"
  13734. },
  13735. "404": {
  13736. "$ref": "#/responses/notFound"
  13737. }
  13738. }
  13739. }
  13740. },
  13741. "/repos/{template_owner}/{template_repo}/generate": {
  13742. "post": {
  13743. "consumes": [
  13744. "application/json"
  13745. ],
  13746. "produces": [
  13747. "application/json"
  13748. ],
  13749. "tags": [
  13750. "repository"
  13751. ],
  13752. "summary": "Create a repository using a template",
  13753. "operationId": "generateRepo",
  13754. "parameters": [
  13755. {
  13756. "type": "string",
  13757. "description": "name of the template repository owner",
  13758. "name": "template_owner",
  13759. "in": "path",
  13760. "required": true
  13761. },
  13762. {
  13763. "type": "string",
  13764. "description": "name of the template repository",
  13765. "name": "template_repo",
  13766. "in": "path",
  13767. "required": true
  13768. },
  13769. {
  13770. "name": "body",
  13771. "in": "body",
  13772. "schema": {
  13773. "$ref": "#/definitions/GenerateRepoOption"
  13774. }
  13775. }
  13776. ],
  13777. "responses": {
  13778. "201": {
  13779. "$ref": "#/responses/Repository"
  13780. },
  13781. "403": {
  13782. "$ref": "#/responses/forbidden"
  13783. },
  13784. "404": {
  13785. "$ref": "#/responses/notFound"
  13786. },
  13787. "409": {
  13788. "description": "The repository with the same name already exists."
  13789. },
  13790. "422": {
  13791. "$ref": "#/responses/validationError"
  13792. }
  13793. }
  13794. }
  13795. },
  13796. "/repositories/{id}": {
  13797. "get": {
  13798. "produces": [
  13799. "application/json"
  13800. ],
  13801. "tags": [
  13802. "repository"
  13803. ],
  13804. "summary": "Get a repository by id",
  13805. "operationId": "repoGetByID",
  13806. "parameters": [
  13807. {
  13808. "type": "integer",
  13809. "format": "int64",
  13810. "description": "id of the repo to get",
  13811. "name": "id",
  13812. "in": "path",
  13813. "required": true
  13814. }
  13815. ],
  13816. "responses": {
  13817. "200": {
  13818. "$ref": "#/responses/Repository"
  13819. },
  13820. "404": {
  13821. "$ref": "#/responses/notFound"
  13822. }
  13823. }
  13824. }
  13825. },
  13826. "/settings/api": {
  13827. "get": {
  13828. "produces": [
  13829. "application/json"
  13830. ],
  13831. "tags": [
  13832. "settings"
  13833. ],
  13834. "summary": "Get instance's global settings for api",
  13835. "operationId": "getGeneralAPISettings",
  13836. "responses": {
  13837. "200": {
  13838. "$ref": "#/responses/GeneralAPISettings"
  13839. }
  13840. }
  13841. }
  13842. },
  13843. "/settings/attachment": {
  13844. "get": {
  13845. "produces": [
  13846. "application/json"
  13847. ],
  13848. "tags": [
  13849. "settings"
  13850. ],
  13851. "summary": "Get instance's global settings for Attachment",
  13852. "operationId": "getGeneralAttachmentSettings",
  13853. "responses": {
  13854. "200": {
  13855. "$ref": "#/responses/GeneralAttachmentSettings"
  13856. }
  13857. }
  13858. }
  13859. },
  13860. "/settings/repository": {
  13861. "get": {
  13862. "produces": [
  13863. "application/json"
  13864. ],
  13865. "tags": [
  13866. "settings"
  13867. ],
  13868. "summary": "Get instance's global settings for repositories",
  13869. "operationId": "getGeneralRepositorySettings",
  13870. "responses": {
  13871. "200": {
  13872. "$ref": "#/responses/GeneralRepoSettings"
  13873. }
  13874. }
  13875. }
  13876. },
  13877. "/settings/ui": {
  13878. "get": {
  13879. "produces": [
  13880. "application/json"
  13881. ],
  13882. "tags": [
  13883. "settings"
  13884. ],
  13885. "summary": "Get instance's global settings for ui",
  13886. "operationId": "getGeneralUISettings",
  13887. "responses": {
  13888. "200": {
  13889. "$ref": "#/responses/GeneralUISettings"
  13890. }
  13891. }
  13892. }
  13893. },
  13894. "/signing-key.gpg": {
  13895. "get": {
  13896. "produces": [
  13897. "text/plain"
  13898. ],
  13899. "tags": [
  13900. "miscellaneous"
  13901. ],
  13902. "summary": "Get default signing-key.gpg",
  13903. "operationId": "getSigningKey",
  13904. "responses": {
  13905. "200": {
  13906. "description": "GPG armored public key",
  13907. "schema": {
  13908. "type": "string"
  13909. }
  13910. }
  13911. }
  13912. }
  13913. },
  13914. "/teams/{id}": {
  13915. "get": {
  13916. "produces": [
  13917. "application/json"
  13918. ],
  13919. "tags": [
  13920. "organization"
  13921. ],
  13922. "summary": "Get a team",
  13923. "operationId": "orgGetTeam",
  13924. "parameters": [
  13925. {
  13926. "type": "integer",
  13927. "format": "int64",
  13928. "description": "id of the team to get",
  13929. "name": "id",
  13930. "in": "path",
  13931. "required": true
  13932. }
  13933. ],
  13934. "responses": {
  13935. "200": {
  13936. "$ref": "#/responses/Team"
  13937. },
  13938. "404": {
  13939. "$ref": "#/responses/notFound"
  13940. }
  13941. }
  13942. },
  13943. "delete": {
  13944. "tags": [
  13945. "organization"
  13946. ],
  13947. "summary": "Delete a team",
  13948. "operationId": "orgDeleteTeam",
  13949. "parameters": [
  13950. {
  13951. "type": "integer",
  13952. "format": "int64",
  13953. "description": "id of the team to delete",
  13954. "name": "id",
  13955. "in": "path",
  13956. "required": true
  13957. }
  13958. ],
  13959. "responses": {
  13960. "204": {
  13961. "description": "team deleted"
  13962. },
  13963. "404": {
  13964. "$ref": "#/responses/notFound"
  13965. }
  13966. }
  13967. },
  13968. "patch": {
  13969. "consumes": [
  13970. "application/json"
  13971. ],
  13972. "produces": [
  13973. "application/json"
  13974. ],
  13975. "tags": [
  13976. "organization"
  13977. ],
  13978. "summary": "Edit a team",
  13979. "operationId": "orgEditTeam",
  13980. "parameters": [
  13981. {
  13982. "type": "integer",
  13983. "description": "id of the team to edit",
  13984. "name": "id",
  13985. "in": "path",
  13986. "required": true
  13987. },
  13988. {
  13989. "name": "body",
  13990. "in": "body",
  13991. "schema": {
  13992. "$ref": "#/definitions/EditTeamOption"
  13993. }
  13994. }
  13995. ],
  13996. "responses": {
  13997. "200": {
  13998. "$ref": "#/responses/Team"
  13999. },
  14000. "404": {
  14001. "$ref": "#/responses/notFound"
  14002. }
  14003. }
  14004. }
  14005. },
  14006. "/teams/{id}/activities/feeds": {
  14007. "get": {
  14008. "produces": [
  14009. "application/json"
  14010. ],
  14011. "tags": [
  14012. "organization"
  14013. ],
  14014. "summary": "List a team's activity feeds",
  14015. "operationId": "orgListTeamActivityFeeds",
  14016. "parameters": [
  14017. {
  14018. "type": "integer",
  14019. "format": "int64",
  14020. "description": "id of the team",
  14021. "name": "id",
  14022. "in": "path",
  14023. "required": true
  14024. },
  14025. {
  14026. "type": "string",
  14027. "format": "date",
  14028. "description": "the date of the activities to be found",
  14029. "name": "date",
  14030. "in": "query"
  14031. },
  14032. {
  14033. "type": "integer",
  14034. "description": "page number of results to return (1-based)",
  14035. "name": "page",
  14036. "in": "query"
  14037. },
  14038. {
  14039. "type": "integer",
  14040. "description": "page size of results",
  14041. "name": "limit",
  14042. "in": "query"
  14043. }
  14044. ],
  14045. "responses": {
  14046. "200": {
  14047. "$ref": "#/responses/ActivityFeedsList"
  14048. },
  14049. "404": {
  14050. "$ref": "#/responses/notFound"
  14051. }
  14052. }
  14053. }
  14054. },
  14055. "/teams/{id}/members": {
  14056. "get": {
  14057. "produces": [
  14058. "application/json"
  14059. ],
  14060. "tags": [
  14061. "organization"
  14062. ],
  14063. "summary": "List a team's members",
  14064. "operationId": "orgListTeamMembers",
  14065. "parameters": [
  14066. {
  14067. "type": "integer",
  14068. "format": "int64",
  14069. "description": "id of the team",
  14070. "name": "id",
  14071. "in": "path",
  14072. "required": true
  14073. },
  14074. {
  14075. "type": "integer",
  14076. "description": "page number of results to return (1-based)",
  14077. "name": "page",
  14078. "in": "query"
  14079. },
  14080. {
  14081. "type": "integer",
  14082. "description": "page size of results",
  14083. "name": "limit",
  14084. "in": "query"
  14085. }
  14086. ],
  14087. "responses": {
  14088. "200": {
  14089. "$ref": "#/responses/UserList"
  14090. },
  14091. "404": {
  14092. "$ref": "#/responses/notFound"
  14093. }
  14094. }
  14095. }
  14096. },
  14097. "/teams/{id}/members/{username}": {
  14098. "get": {
  14099. "produces": [
  14100. "application/json"
  14101. ],
  14102. "tags": [
  14103. "organization"
  14104. ],
  14105. "summary": "List a particular member of team",
  14106. "operationId": "orgListTeamMember",
  14107. "parameters": [
  14108. {
  14109. "type": "integer",
  14110. "format": "int64",
  14111. "description": "id of the team",
  14112. "name": "id",
  14113. "in": "path",
  14114. "required": true
  14115. },
  14116. {
  14117. "type": "string",
  14118. "description": "username of the member to list",
  14119. "name": "username",
  14120. "in": "path",
  14121. "required": true
  14122. }
  14123. ],
  14124. "responses": {
  14125. "200": {
  14126. "$ref": "#/responses/User"
  14127. },
  14128. "404": {
  14129. "$ref": "#/responses/notFound"
  14130. }
  14131. }
  14132. },
  14133. "put": {
  14134. "produces": [
  14135. "application/json"
  14136. ],
  14137. "tags": [
  14138. "organization"
  14139. ],
  14140. "summary": "Add a team member",
  14141. "operationId": "orgAddTeamMember",
  14142. "parameters": [
  14143. {
  14144. "type": "integer",
  14145. "format": "int64",
  14146. "description": "id of the team",
  14147. "name": "id",
  14148. "in": "path",
  14149. "required": true
  14150. },
  14151. {
  14152. "type": "string",
  14153. "description": "username of the user to add",
  14154. "name": "username",
  14155. "in": "path",
  14156. "required": true
  14157. }
  14158. ],
  14159. "responses": {
  14160. "204": {
  14161. "$ref": "#/responses/empty"
  14162. },
  14163. "404": {
  14164. "$ref": "#/responses/notFound"
  14165. }
  14166. }
  14167. },
  14168. "delete": {
  14169. "produces": [
  14170. "application/json"
  14171. ],
  14172. "tags": [
  14173. "organization"
  14174. ],
  14175. "summary": "Remove a team member",
  14176. "operationId": "orgRemoveTeamMember",
  14177. "parameters": [
  14178. {
  14179. "type": "integer",
  14180. "format": "int64",
  14181. "description": "id of the team",
  14182. "name": "id",
  14183. "in": "path",
  14184. "required": true
  14185. },
  14186. {
  14187. "type": "string",
  14188. "description": "username of the user to remove",
  14189. "name": "username",
  14190. "in": "path",
  14191. "required": true
  14192. }
  14193. ],
  14194. "responses": {
  14195. "204": {
  14196. "$ref": "#/responses/empty"
  14197. },
  14198. "404": {
  14199. "$ref": "#/responses/notFound"
  14200. }
  14201. }
  14202. }
  14203. },
  14204. "/teams/{id}/repos": {
  14205. "get": {
  14206. "produces": [
  14207. "application/json"
  14208. ],
  14209. "tags": [
  14210. "organization"
  14211. ],
  14212. "summary": "List a team's repos",
  14213. "operationId": "orgListTeamRepos",
  14214. "parameters": [
  14215. {
  14216. "type": "integer",
  14217. "format": "int64",
  14218. "description": "id of the team",
  14219. "name": "id",
  14220. "in": "path",
  14221. "required": true
  14222. },
  14223. {
  14224. "type": "integer",
  14225. "description": "page number of results to return (1-based)",
  14226. "name": "page",
  14227. "in": "query"
  14228. },
  14229. {
  14230. "type": "integer",
  14231. "description": "page size of results",
  14232. "name": "limit",
  14233. "in": "query"
  14234. }
  14235. ],
  14236. "responses": {
  14237. "200": {
  14238. "$ref": "#/responses/RepositoryList"
  14239. },
  14240. "404": {
  14241. "$ref": "#/responses/notFound"
  14242. }
  14243. }
  14244. }
  14245. },
  14246. "/teams/{id}/repos/{org}/{repo}": {
  14247. "get": {
  14248. "produces": [
  14249. "application/json"
  14250. ],
  14251. "tags": [
  14252. "organization"
  14253. ],
  14254. "summary": "List a particular repo of team",
  14255. "operationId": "orgListTeamRepo",
  14256. "parameters": [
  14257. {
  14258. "type": "integer",
  14259. "format": "int64",
  14260. "description": "id of the team",
  14261. "name": "id",
  14262. "in": "path",
  14263. "required": true
  14264. },
  14265. {
  14266. "type": "string",
  14267. "description": "organization that owns the repo to list",
  14268. "name": "org",
  14269. "in": "path",
  14270. "required": true
  14271. },
  14272. {
  14273. "type": "string",
  14274. "description": "name of the repo to list",
  14275. "name": "repo",
  14276. "in": "path",
  14277. "required": true
  14278. }
  14279. ],
  14280. "responses": {
  14281. "200": {
  14282. "$ref": "#/responses/Repository"
  14283. },
  14284. "404": {
  14285. "$ref": "#/responses/notFound"
  14286. }
  14287. }
  14288. },
  14289. "put": {
  14290. "produces": [
  14291. "application/json"
  14292. ],
  14293. "tags": [
  14294. "organization"
  14295. ],
  14296. "summary": "Add a repository to a team",
  14297. "operationId": "orgAddTeamRepository",
  14298. "parameters": [
  14299. {
  14300. "type": "integer",
  14301. "format": "int64",
  14302. "description": "id of the team",
  14303. "name": "id",
  14304. "in": "path",
  14305. "required": true
  14306. },
  14307. {
  14308. "type": "string",
  14309. "description": "organization that owns the repo to add",
  14310. "name": "org",
  14311. "in": "path",
  14312. "required": true
  14313. },
  14314. {
  14315. "type": "string",
  14316. "description": "name of the repo to add",
  14317. "name": "repo",
  14318. "in": "path",
  14319. "required": true
  14320. }
  14321. ],
  14322. "responses": {
  14323. "204": {
  14324. "$ref": "#/responses/empty"
  14325. },
  14326. "403": {
  14327. "$ref": "#/responses/forbidden"
  14328. },
  14329. "404": {
  14330. "$ref": "#/responses/notFound"
  14331. }
  14332. }
  14333. },
  14334. "delete": {
  14335. "description": "This does not delete the repository, it only removes the repository from the team.",
  14336. "produces": [
  14337. "application/json"
  14338. ],
  14339. "tags": [
  14340. "organization"
  14341. ],
  14342. "summary": "Remove a repository from a team",
  14343. "operationId": "orgRemoveTeamRepository",
  14344. "parameters": [
  14345. {
  14346. "type": "integer",
  14347. "format": "int64",
  14348. "description": "id of the team",
  14349. "name": "id",
  14350. "in": "path",
  14351. "required": true
  14352. },
  14353. {
  14354. "type": "string",
  14355. "description": "organization that owns the repo to remove",
  14356. "name": "org",
  14357. "in": "path",
  14358. "required": true
  14359. },
  14360. {
  14361. "type": "string",
  14362. "description": "name of the repo to remove",
  14363. "name": "repo",
  14364. "in": "path",
  14365. "required": true
  14366. }
  14367. ],
  14368. "responses": {
  14369. "204": {
  14370. "$ref": "#/responses/empty"
  14371. },
  14372. "403": {
  14373. "$ref": "#/responses/forbidden"
  14374. },
  14375. "404": {
  14376. "$ref": "#/responses/notFound"
  14377. }
  14378. }
  14379. }
  14380. },
  14381. "/topics/search": {
  14382. "get": {
  14383. "produces": [
  14384. "application/json"
  14385. ],
  14386. "tags": [
  14387. "repository"
  14388. ],
  14389. "summary": "search topics via keyword",
  14390. "operationId": "topicSearch",
  14391. "parameters": [
  14392. {
  14393. "type": "string",
  14394. "description": "keywords to search",
  14395. "name": "q",
  14396. "in": "query",
  14397. "required": true
  14398. },
  14399. {
  14400. "type": "integer",
  14401. "description": "page number of results to return (1-based)",
  14402. "name": "page",
  14403. "in": "query"
  14404. },
  14405. {
  14406. "type": "integer",
  14407. "description": "page size of results",
  14408. "name": "limit",
  14409. "in": "query"
  14410. }
  14411. ],
  14412. "responses": {
  14413. "200": {
  14414. "$ref": "#/responses/TopicListResponse"
  14415. },
  14416. "403": {
  14417. "$ref": "#/responses/forbidden"
  14418. },
  14419. "404": {
  14420. "$ref": "#/responses/notFound"
  14421. }
  14422. }
  14423. }
  14424. },
  14425. "/user": {
  14426. "get": {
  14427. "produces": [
  14428. "application/json"
  14429. ],
  14430. "tags": [
  14431. "user"
  14432. ],
  14433. "summary": "Get the authenticated user",
  14434. "operationId": "userGetCurrent",
  14435. "responses": {
  14436. "200": {
  14437. "$ref": "#/responses/User"
  14438. }
  14439. }
  14440. }
  14441. },
  14442. "/user/actions/secrets/{secretname}": {
  14443. "put": {
  14444. "consumes": [
  14445. "application/json"
  14446. ],
  14447. "produces": [
  14448. "application/json"
  14449. ],
  14450. "tags": [
  14451. "user"
  14452. ],
  14453. "summary": "Create or Update a secret value in a user scope",
  14454. "operationId": "updateUserSecret",
  14455. "parameters": [
  14456. {
  14457. "type": "string",
  14458. "description": "name of the secret",
  14459. "name": "secretname",
  14460. "in": "path",
  14461. "required": true
  14462. },
  14463. {
  14464. "name": "body",
  14465. "in": "body",
  14466. "schema": {
  14467. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  14468. }
  14469. }
  14470. ],
  14471. "responses": {
  14472. "201": {
  14473. "description": "response when creating a secret"
  14474. },
  14475. "204": {
  14476. "description": "response when updating a secret"
  14477. },
  14478. "400": {
  14479. "$ref": "#/responses/error"
  14480. },
  14481. "404": {
  14482. "$ref": "#/responses/notFound"
  14483. }
  14484. }
  14485. },
  14486. "delete": {
  14487. "consumes": [
  14488. "application/json"
  14489. ],
  14490. "produces": [
  14491. "application/json"
  14492. ],
  14493. "tags": [
  14494. "user"
  14495. ],
  14496. "summary": "Delete a secret in a user scope",
  14497. "operationId": "deleteUserSecret",
  14498. "parameters": [
  14499. {
  14500. "type": "string",
  14501. "description": "name of the secret",
  14502. "name": "secretname",
  14503. "in": "path",
  14504. "required": true
  14505. }
  14506. ],
  14507. "responses": {
  14508. "204": {
  14509. "description": "delete one secret of the user"
  14510. },
  14511. "400": {
  14512. "$ref": "#/responses/error"
  14513. },
  14514. "404": {
  14515. "$ref": "#/responses/notFound"
  14516. }
  14517. }
  14518. }
  14519. },
  14520. "/user/applications/oauth2": {
  14521. "get": {
  14522. "produces": [
  14523. "application/json"
  14524. ],
  14525. "tags": [
  14526. "user"
  14527. ],
  14528. "summary": "List the authenticated user's oauth2 applications",
  14529. "operationId": "userGetOauth2Application",
  14530. "parameters": [
  14531. {
  14532. "type": "integer",
  14533. "description": "page number of results to return (1-based)",
  14534. "name": "page",
  14535. "in": "query"
  14536. },
  14537. {
  14538. "type": "integer",
  14539. "description": "page size of results",
  14540. "name": "limit",
  14541. "in": "query"
  14542. }
  14543. ],
  14544. "responses": {
  14545. "200": {
  14546. "$ref": "#/responses/OAuth2ApplicationList"
  14547. }
  14548. }
  14549. },
  14550. "post": {
  14551. "produces": [
  14552. "application/json"
  14553. ],
  14554. "tags": [
  14555. "user"
  14556. ],
  14557. "summary": "creates a new OAuth2 application",
  14558. "operationId": "userCreateOAuth2Application",
  14559. "parameters": [
  14560. {
  14561. "name": "body",
  14562. "in": "body",
  14563. "required": true,
  14564. "schema": {
  14565. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14566. }
  14567. }
  14568. ],
  14569. "responses": {
  14570. "201": {
  14571. "$ref": "#/responses/OAuth2Application"
  14572. },
  14573. "400": {
  14574. "$ref": "#/responses/error"
  14575. }
  14576. }
  14577. }
  14578. },
  14579. "/user/applications/oauth2/{id}": {
  14580. "get": {
  14581. "produces": [
  14582. "application/json"
  14583. ],
  14584. "tags": [
  14585. "user"
  14586. ],
  14587. "summary": "get an OAuth2 Application",
  14588. "operationId": "userGetOAuth2Application",
  14589. "parameters": [
  14590. {
  14591. "type": "integer",
  14592. "format": "int64",
  14593. "description": "Application ID to be found",
  14594. "name": "id",
  14595. "in": "path",
  14596. "required": true
  14597. }
  14598. ],
  14599. "responses": {
  14600. "200": {
  14601. "$ref": "#/responses/OAuth2Application"
  14602. },
  14603. "404": {
  14604. "$ref": "#/responses/notFound"
  14605. }
  14606. }
  14607. },
  14608. "delete": {
  14609. "produces": [
  14610. "application/json"
  14611. ],
  14612. "tags": [
  14613. "user"
  14614. ],
  14615. "summary": "delete an OAuth2 Application",
  14616. "operationId": "userDeleteOAuth2Application",
  14617. "parameters": [
  14618. {
  14619. "type": "integer",
  14620. "format": "int64",
  14621. "description": "token to be deleted",
  14622. "name": "id",
  14623. "in": "path",
  14624. "required": true
  14625. }
  14626. ],
  14627. "responses": {
  14628. "204": {
  14629. "$ref": "#/responses/empty"
  14630. },
  14631. "404": {
  14632. "$ref": "#/responses/notFound"
  14633. }
  14634. }
  14635. },
  14636. "patch": {
  14637. "produces": [
  14638. "application/json"
  14639. ],
  14640. "tags": [
  14641. "user"
  14642. ],
  14643. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  14644. "operationId": "userUpdateOAuth2Application",
  14645. "parameters": [
  14646. {
  14647. "type": "integer",
  14648. "format": "int64",
  14649. "description": "application to be updated",
  14650. "name": "id",
  14651. "in": "path",
  14652. "required": true
  14653. },
  14654. {
  14655. "name": "body",
  14656. "in": "body",
  14657. "required": true,
  14658. "schema": {
  14659. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14660. }
  14661. }
  14662. ],
  14663. "responses": {
  14664. "200": {
  14665. "$ref": "#/responses/OAuth2Application"
  14666. },
  14667. "404": {
  14668. "$ref": "#/responses/notFound"
  14669. }
  14670. }
  14671. }
  14672. },
  14673. "/user/avatar": {
  14674. "post": {
  14675. "produces": [
  14676. "application/json"
  14677. ],
  14678. "tags": [
  14679. "user"
  14680. ],
  14681. "summary": "Update Avatar",
  14682. "operationId": "userUpdateAvatar",
  14683. "parameters": [
  14684. {
  14685. "name": "body",
  14686. "in": "body",
  14687. "schema": {
  14688. "$ref": "#/definitions/UpdateUserAvatarOption"
  14689. }
  14690. }
  14691. ],
  14692. "responses": {
  14693. "204": {
  14694. "$ref": "#/responses/empty"
  14695. }
  14696. }
  14697. },
  14698. "delete": {
  14699. "produces": [
  14700. "application/json"
  14701. ],
  14702. "tags": [
  14703. "user"
  14704. ],
  14705. "summary": "Delete Avatar",
  14706. "operationId": "userDeleteAvatar",
  14707. "responses": {
  14708. "204": {
  14709. "$ref": "#/responses/empty"
  14710. }
  14711. }
  14712. }
  14713. },
  14714. "/user/emails": {
  14715. "get": {
  14716. "produces": [
  14717. "application/json"
  14718. ],
  14719. "tags": [
  14720. "user"
  14721. ],
  14722. "summary": "List the authenticated user's email addresses",
  14723. "operationId": "userListEmails",
  14724. "responses": {
  14725. "200": {
  14726. "$ref": "#/responses/EmailList"
  14727. }
  14728. }
  14729. },
  14730. "post": {
  14731. "produces": [
  14732. "application/json"
  14733. ],
  14734. "tags": [
  14735. "user"
  14736. ],
  14737. "summary": "Add email addresses",
  14738. "operationId": "userAddEmail",
  14739. "parameters": [
  14740. {
  14741. "name": "body",
  14742. "in": "body",
  14743. "schema": {
  14744. "$ref": "#/definitions/CreateEmailOption"
  14745. }
  14746. }
  14747. ],
  14748. "responses": {
  14749. "201": {
  14750. "$ref": "#/responses/EmailList"
  14751. },
  14752. "422": {
  14753. "$ref": "#/responses/validationError"
  14754. }
  14755. }
  14756. },
  14757. "delete": {
  14758. "produces": [
  14759. "application/json"
  14760. ],
  14761. "tags": [
  14762. "user"
  14763. ],
  14764. "summary": "Delete email addresses",
  14765. "operationId": "userDeleteEmail",
  14766. "parameters": [
  14767. {
  14768. "name": "body",
  14769. "in": "body",
  14770. "schema": {
  14771. "$ref": "#/definitions/DeleteEmailOption"
  14772. }
  14773. }
  14774. ],
  14775. "responses": {
  14776. "204": {
  14777. "$ref": "#/responses/empty"
  14778. },
  14779. "404": {
  14780. "$ref": "#/responses/notFound"
  14781. }
  14782. }
  14783. }
  14784. },
  14785. "/user/followers": {
  14786. "get": {
  14787. "produces": [
  14788. "application/json"
  14789. ],
  14790. "tags": [
  14791. "user"
  14792. ],
  14793. "summary": "List the authenticated user's followers",
  14794. "operationId": "userCurrentListFollowers",
  14795. "parameters": [
  14796. {
  14797. "type": "integer",
  14798. "description": "page number of results to return (1-based)",
  14799. "name": "page",
  14800. "in": "query"
  14801. },
  14802. {
  14803. "type": "integer",
  14804. "description": "page size of results",
  14805. "name": "limit",
  14806. "in": "query"
  14807. }
  14808. ],
  14809. "responses": {
  14810. "200": {
  14811. "$ref": "#/responses/UserList"
  14812. }
  14813. }
  14814. }
  14815. },
  14816. "/user/following": {
  14817. "get": {
  14818. "produces": [
  14819. "application/json"
  14820. ],
  14821. "tags": [
  14822. "user"
  14823. ],
  14824. "summary": "List the users that the authenticated user is following",
  14825. "operationId": "userCurrentListFollowing",
  14826. "parameters": [
  14827. {
  14828. "type": "integer",
  14829. "description": "page number of results to return (1-based)",
  14830. "name": "page",
  14831. "in": "query"
  14832. },
  14833. {
  14834. "type": "integer",
  14835. "description": "page size of results",
  14836. "name": "limit",
  14837. "in": "query"
  14838. }
  14839. ],
  14840. "responses": {
  14841. "200": {
  14842. "$ref": "#/responses/UserList"
  14843. }
  14844. }
  14845. }
  14846. },
  14847. "/user/following/{username}": {
  14848. "get": {
  14849. "tags": [
  14850. "user"
  14851. ],
  14852. "summary": "Check whether a user is followed by the authenticated user",
  14853. "operationId": "userCurrentCheckFollowing",
  14854. "parameters": [
  14855. {
  14856. "type": "string",
  14857. "description": "username of followed user",
  14858. "name": "username",
  14859. "in": "path",
  14860. "required": true
  14861. }
  14862. ],
  14863. "responses": {
  14864. "204": {
  14865. "$ref": "#/responses/empty"
  14866. },
  14867. "404": {
  14868. "$ref": "#/responses/notFound"
  14869. }
  14870. }
  14871. },
  14872. "put": {
  14873. "tags": [
  14874. "user"
  14875. ],
  14876. "summary": "Follow a user",
  14877. "operationId": "userCurrentPutFollow",
  14878. "parameters": [
  14879. {
  14880. "type": "string",
  14881. "description": "username of user to follow",
  14882. "name": "username",
  14883. "in": "path",
  14884. "required": true
  14885. }
  14886. ],
  14887. "responses": {
  14888. "204": {
  14889. "$ref": "#/responses/empty"
  14890. },
  14891. "404": {
  14892. "$ref": "#/responses/notFound"
  14893. }
  14894. }
  14895. },
  14896. "delete": {
  14897. "tags": [
  14898. "user"
  14899. ],
  14900. "summary": "Unfollow a user",
  14901. "operationId": "userCurrentDeleteFollow",
  14902. "parameters": [
  14903. {
  14904. "type": "string",
  14905. "description": "username of user to unfollow",
  14906. "name": "username",
  14907. "in": "path",
  14908. "required": true
  14909. }
  14910. ],
  14911. "responses": {
  14912. "204": {
  14913. "$ref": "#/responses/empty"
  14914. },
  14915. "404": {
  14916. "$ref": "#/responses/notFound"
  14917. }
  14918. }
  14919. }
  14920. },
  14921. "/user/gpg_key_token": {
  14922. "get": {
  14923. "produces": [
  14924. "text/plain"
  14925. ],
  14926. "tags": [
  14927. "user"
  14928. ],
  14929. "summary": "Get a Token to verify",
  14930. "operationId": "getVerificationToken",
  14931. "responses": {
  14932. "200": {
  14933. "$ref": "#/responses/string"
  14934. },
  14935. "404": {
  14936. "$ref": "#/responses/notFound"
  14937. }
  14938. }
  14939. }
  14940. },
  14941. "/user/gpg_key_verify": {
  14942. "post": {
  14943. "consumes": [
  14944. "application/json"
  14945. ],
  14946. "produces": [
  14947. "application/json"
  14948. ],
  14949. "tags": [
  14950. "user"
  14951. ],
  14952. "summary": "Verify a GPG key",
  14953. "operationId": "userVerifyGPGKey",
  14954. "responses": {
  14955. "201": {
  14956. "$ref": "#/responses/GPGKey"
  14957. },
  14958. "404": {
  14959. "$ref": "#/responses/notFound"
  14960. },
  14961. "422": {
  14962. "$ref": "#/responses/validationError"
  14963. }
  14964. }
  14965. }
  14966. },
  14967. "/user/gpg_keys": {
  14968. "get": {
  14969. "produces": [
  14970. "application/json"
  14971. ],
  14972. "tags": [
  14973. "user"
  14974. ],
  14975. "summary": "List the authenticated user's GPG keys",
  14976. "operationId": "userCurrentListGPGKeys",
  14977. "parameters": [
  14978. {
  14979. "type": "integer",
  14980. "description": "page number of results to return (1-based)",
  14981. "name": "page",
  14982. "in": "query"
  14983. },
  14984. {
  14985. "type": "integer",
  14986. "description": "page size of results",
  14987. "name": "limit",
  14988. "in": "query"
  14989. }
  14990. ],
  14991. "responses": {
  14992. "200": {
  14993. "$ref": "#/responses/GPGKeyList"
  14994. }
  14995. }
  14996. },
  14997. "post": {
  14998. "consumes": [
  14999. "application/json"
  15000. ],
  15001. "produces": [
  15002. "application/json"
  15003. ],
  15004. "tags": [
  15005. "user"
  15006. ],
  15007. "summary": "Create a GPG key",
  15008. "operationId": "userCurrentPostGPGKey",
  15009. "parameters": [
  15010. {
  15011. "name": "Form",
  15012. "in": "body",
  15013. "schema": {
  15014. "$ref": "#/definitions/CreateGPGKeyOption"
  15015. }
  15016. }
  15017. ],
  15018. "responses": {
  15019. "201": {
  15020. "$ref": "#/responses/GPGKey"
  15021. },
  15022. "404": {
  15023. "$ref": "#/responses/notFound"
  15024. },
  15025. "422": {
  15026. "$ref": "#/responses/validationError"
  15027. }
  15028. }
  15029. }
  15030. },
  15031. "/user/gpg_keys/{id}": {
  15032. "get": {
  15033. "produces": [
  15034. "application/json"
  15035. ],
  15036. "tags": [
  15037. "user"
  15038. ],
  15039. "summary": "Get a GPG key",
  15040. "operationId": "userCurrentGetGPGKey",
  15041. "parameters": [
  15042. {
  15043. "type": "integer",
  15044. "format": "int64",
  15045. "description": "id of key to get",
  15046. "name": "id",
  15047. "in": "path",
  15048. "required": true
  15049. }
  15050. ],
  15051. "responses": {
  15052. "200": {
  15053. "$ref": "#/responses/GPGKey"
  15054. },
  15055. "404": {
  15056. "$ref": "#/responses/notFound"
  15057. }
  15058. }
  15059. },
  15060. "delete": {
  15061. "produces": [
  15062. "application/json"
  15063. ],
  15064. "tags": [
  15065. "user"
  15066. ],
  15067. "summary": "Remove a GPG key",
  15068. "operationId": "userCurrentDeleteGPGKey",
  15069. "parameters": [
  15070. {
  15071. "type": "integer",
  15072. "format": "int64",
  15073. "description": "id of key to delete",
  15074. "name": "id",
  15075. "in": "path",
  15076. "required": true
  15077. }
  15078. ],
  15079. "responses": {
  15080. "204": {
  15081. "$ref": "#/responses/empty"
  15082. },
  15083. "403": {
  15084. "$ref": "#/responses/forbidden"
  15085. },
  15086. "404": {
  15087. "$ref": "#/responses/notFound"
  15088. }
  15089. }
  15090. }
  15091. },
  15092. "/user/hooks": {
  15093. "get": {
  15094. "produces": [
  15095. "application/json"
  15096. ],
  15097. "tags": [
  15098. "user"
  15099. ],
  15100. "summary": "List the authenticated user's webhooks",
  15101. "operationId": "userListHooks",
  15102. "parameters": [
  15103. {
  15104. "type": "integer",
  15105. "description": "page number of results to return (1-based)",
  15106. "name": "page",
  15107. "in": "query"
  15108. },
  15109. {
  15110. "type": "integer",
  15111. "description": "page size of results",
  15112. "name": "limit",
  15113. "in": "query"
  15114. }
  15115. ],
  15116. "responses": {
  15117. "200": {
  15118. "$ref": "#/responses/HookList"
  15119. }
  15120. }
  15121. },
  15122. "post": {
  15123. "consumes": [
  15124. "application/json"
  15125. ],
  15126. "produces": [
  15127. "application/json"
  15128. ],
  15129. "tags": [
  15130. "user"
  15131. ],
  15132. "summary": "Create a hook",
  15133. "operationId": "userCreateHook",
  15134. "parameters": [
  15135. {
  15136. "name": "body",
  15137. "in": "body",
  15138. "required": true,
  15139. "schema": {
  15140. "$ref": "#/definitions/CreateHookOption"
  15141. }
  15142. }
  15143. ],
  15144. "responses": {
  15145. "201": {
  15146. "$ref": "#/responses/Hook"
  15147. }
  15148. }
  15149. }
  15150. },
  15151. "/user/hooks/{id}": {
  15152. "get": {
  15153. "produces": [
  15154. "application/json"
  15155. ],
  15156. "tags": [
  15157. "user"
  15158. ],
  15159. "summary": "Get a hook",
  15160. "operationId": "userGetHook",
  15161. "parameters": [
  15162. {
  15163. "type": "integer",
  15164. "format": "int64",
  15165. "description": "id of the hook to get",
  15166. "name": "id",
  15167. "in": "path",
  15168. "required": true
  15169. }
  15170. ],
  15171. "responses": {
  15172. "200": {
  15173. "$ref": "#/responses/Hook"
  15174. }
  15175. }
  15176. },
  15177. "delete": {
  15178. "produces": [
  15179. "application/json"
  15180. ],
  15181. "tags": [
  15182. "user"
  15183. ],
  15184. "summary": "Delete a hook",
  15185. "operationId": "userDeleteHook",
  15186. "parameters": [
  15187. {
  15188. "type": "integer",
  15189. "format": "int64",
  15190. "description": "id of the hook to delete",
  15191. "name": "id",
  15192. "in": "path",
  15193. "required": true
  15194. }
  15195. ],
  15196. "responses": {
  15197. "204": {
  15198. "$ref": "#/responses/empty"
  15199. }
  15200. }
  15201. },
  15202. "patch": {
  15203. "consumes": [
  15204. "application/json"
  15205. ],
  15206. "produces": [
  15207. "application/json"
  15208. ],
  15209. "tags": [
  15210. "user"
  15211. ],
  15212. "summary": "Update a hook",
  15213. "operationId": "userEditHook",
  15214. "parameters": [
  15215. {
  15216. "type": "integer",
  15217. "format": "int64",
  15218. "description": "id of the hook to update",
  15219. "name": "id",
  15220. "in": "path",
  15221. "required": true
  15222. },
  15223. {
  15224. "name": "body",
  15225. "in": "body",
  15226. "schema": {
  15227. "$ref": "#/definitions/EditHookOption"
  15228. }
  15229. }
  15230. ],
  15231. "responses": {
  15232. "200": {
  15233. "$ref": "#/responses/Hook"
  15234. }
  15235. }
  15236. }
  15237. },
  15238. "/user/keys": {
  15239. "get": {
  15240. "produces": [
  15241. "application/json"
  15242. ],
  15243. "tags": [
  15244. "user"
  15245. ],
  15246. "summary": "List the authenticated user's public keys",
  15247. "operationId": "userCurrentListKeys",
  15248. "parameters": [
  15249. {
  15250. "type": "string",
  15251. "description": "fingerprint of the key",
  15252. "name": "fingerprint",
  15253. "in": "query"
  15254. },
  15255. {
  15256. "type": "integer",
  15257. "description": "page number of results to return (1-based)",
  15258. "name": "page",
  15259. "in": "query"
  15260. },
  15261. {
  15262. "type": "integer",
  15263. "description": "page size of results",
  15264. "name": "limit",
  15265. "in": "query"
  15266. }
  15267. ],
  15268. "responses": {
  15269. "200": {
  15270. "$ref": "#/responses/PublicKeyList"
  15271. }
  15272. }
  15273. },
  15274. "post": {
  15275. "consumes": [
  15276. "application/json"
  15277. ],
  15278. "produces": [
  15279. "application/json"
  15280. ],
  15281. "tags": [
  15282. "user"
  15283. ],
  15284. "summary": "Create a public key",
  15285. "operationId": "userCurrentPostKey",
  15286. "parameters": [
  15287. {
  15288. "name": "body",
  15289. "in": "body",
  15290. "schema": {
  15291. "$ref": "#/definitions/CreateKeyOption"
  15292. }
  15293. }
  15294. ],
  15295. "responses": {
  15296. "201": {
  15297. "$ref": "#/responses/PublicKey"
  15298. },
  15299. "422": {
  15300. "$ref": "#/responses/validationError"
  15301. }
  15302. }
  15303. }
  15304. },
  15305. "/user/keys/{id}": {
  15306. "get": {
  15307. "produces": [
  15308. "application/json"
  15309. ],
  15310. "tags": [
  15311. "user"
  15312. ],
  15313. "summary": "Get a public key",
  15314. "operationId": "userCurrentGetKey",
  15315. "parameters": [
  15316. {
  15317. "type": "integer",
  15318. "format": "int64",
  15319. "description": "id of key to get",
  15320. "name": "id",
  15321. "in": "path",
  15322. "required": true
  15323. }
  15324. ],
  15325. "responses": {
  15326. "200": {
  15327. "$ref": "#/responses/PublicKey"
  15328. },
  15329. "404": {
  15330. "$ref": "#/responses/notFound"
  15331. }
  15332. }
  15333. },
  15334. "delete": {
  15335. "produces": [
  15336. "application/json"
  15337. ],
  15338. "tags": [
  15339. "user"
  15340. ],
  15341. "summary": "Delete a public key",
  15342. "operationId": "userCurrentDeleteKey",
  15343. "parameters": [
  15344. {
  15345. "type": "integer",
  15346. "format": "int64",
  15347. "description": "id of key to delete",
  15348. "name": "id",
  15349. "in": "path",
  15350. "required": true
  15351. }
  15352. ],
  15353. "responses": {
  15354. "204": {
  15355. "$ref": "#/responses/empty"
  15356. },
  15357. "403": {
  15358. "$ref": "#/responses/forbidden"
  15359. },
  15360. "404": {
  15361. "$ref": "#/responses/notFound"
  15362. }
  15363. }
  15364. }
  15365. },
  15366. "/user/orgs": {
  15367. "get": {
  15368. "produces": [
  15369. "application/json"
  15370. ],
  15371. "tags": [
  15372. "organization"
  15373. ],
  15374. "summary": "List the current user's organizations",
  15375. "operationId": "orgListCurrentUserOrgs",
  15376. "parameters": [
  15377. {
  15378. "type": "integer",
  15379. "description": "page number of results to return (1-based)",
  15380. "name": "page",
  15381. "in": "query"
  15382. },
  15383. {
  15384. "type": "integer",
  15385. "description": "page size of results",
  15386. "name": "limit",
  15387. "in": "query"
  15388. }
  15389. ],
  15390. "responses": {
  15391. "200": {
  15392. "$ref": "#/responses/OrganizationList"
  15393. },
  15394. "404": {
  15395. "$ref": "#/responses/notFound"
  15396. }
  15397. }
  15398. }
  15399. },
  15400. "/user/repos": {
  15401. "get": {
  15402. "produces": [
  15403. "application/json"
  15404. ],
  15405. "tags": [
  15406. "user"
  15407. ],
  15408. "summary": "List the repos that the authenticated user owns",
  15409. "operationId": "userCurrentListRepos",
  15410. "parameters": [
  15411. {
  15412. "type": "integer",
  15413. "description": "page number of results to return (1-based)",
  15414. "name": "page",
  15415. "in": "query"
  15416. },
  15417. {
  15418. "type": "integer",
  15419. "description": "page size of results",
  15420. "name": "limit",
  15421. "in": "query"
  15422. }
  15423. ],
  15424. "responses": {
  15425. "200": {
  15426. "$ref": "#/responses/RepositoryList"
  15427. }
  15428. }
  15429. },
  15430. "post": {
  15431. "consumes": [
  15432. "application/json"
  15433. ],
  15434. "produces": [
  15435. "application/json"
  15436. ],
  15437. "tags": [
  15438. "repository",
  15439. "user"
  15440. ],
  15441. "summary": "Create a repository",
  15442. "operationId": "createCurrentUserRepo",
  15443. "parameters": [
  15444. {
  15445. "name": "body",
  15446. "in": "body",
  15447. "schema": {
  15448. "$ref": "#/definitions/CreateRepoOption"
  15449. }
  15450. }
  15451. ],
  15452. "responses": {
  15453. "201": {
  15454. "$ref": "#/responses/Repository"
  15455. },
  15456. "400": {
  15457. "$ref": "#/responses/error"
  15458. },
  15459. "409": {
  15460. "description": "The repository with the same name already exists."
  15461. },
  15462. "422": {
  15463. "$ref": "#/responses/validationError"
  15464. }
  15465. }
  15466. }
  15467. },
  15468. "/user/settings": {
  15469. "get": {
  15470. "produces": [
  15471. "application/json"
  15472. ],
  15473. "tags": [
  15474. "user"
  15475. ],
  15476. "summary": "Get user settings",
  15477. "operationId": "getUserSettings",
  15478. "responses": {
  15479. "200": {
  15480. "$ref": "#/responses/UserSettings"
  15481. }
  15482. }
  15483. },
  15484. "patch": {
  15485. "produces": [
  15486. "application/json"
  15487. ],
  15488. "tags": [
  15489. "user"
  15490. ],
  15491. "summary": "Update user settings",
  15492. "operationId": "updateUserSettings",
  15493. "parameters": [
  15494. {
  15495. "name": "body",
  15496. "in": "body",
  15497. "schema": {
  15498. "$ref": "#/definitions/UserSettingsOptions"
  15499. }
  15500. }
  15501. ],
  15502. "responses": {
  15503. "200": {
  15504. "$ref": "#/responses/UserSettings"
  15505. }
  15506. }
  15507. }
  15508. },
  15509. "/user/starred": {
  15510. "get": {
  15511. "produces": [
  15512. "application/json"
  15513. ],
  15514. "tags": [
  15515. "user"
  15516. ],
  15517. "summary": "The repos that the authenticated user has starred",
  15518. "operationId": "userCurrentListStarred",
  15519. "parameters": [
  15520. {
  15521. "type": "integer",
  15522. "description": "page number of results to return (1-based)",
  15523. "name": "page",
  15524. "in": "query"
  15525. },
  15526. {
  15527. "type": "integer",
  15528. "description": "page size of results",
  15529. "name": "limit",
  15530. "in": "query"
  15531. }
  15532. ],
  15533. "responses": {
  15534. "200": {
  15535. "$ref": "#/responses/RepositoryList"
  15536. }
  15537. }
  15538. }
  15539. },
  15540. "/user/starred/{owner}/{repo}": {
  15541. "get": {
  15542. "tags": [
  15543. "user"
  15544. ],
  15545. "summary": "Whether the authenticated is starring the repo",
  15546. "operationId": "userCurrentCheckStarring",
  15547. "parameters": [
  15548. {
  15549. "type": "string",
  15550. "description": "owner of the repo",
  15551. "name": "owner",
  15552. "in": "path",
  15553. "required": true
  15554. },
  15555. {
  15556. "type": "string",
  15557. "description": "name of the repo",
  15558. "name": "repo",
  15559. "in": "path",
  15560. "required": true
  15561. }
  15562. ],
  15563. "responses": {
  15564. "204": {
  15565. "$ref": "#/responses/empty"
  15566. },
  15567. "404": {
  15568. "$ref": "#/responses/notFound"
  15569. }
  15570. }
  15571. },
  15572. "put": {
  15573. "tags": [
  15574. "user"
  15575. ],
  15576. "summary": "Star the given repo",
  15577. "operationId": "userCurrentPutStar",
  15578. "parameters": [
  15579. {
  15580. "type": "string",
  15581. "description": "owner of the repo to star",
  15582. "name": "owner",
  15583. "in": "path",
  15584. "required": true
  15585. },
  15586. {
  15587. "type": "string",
  15588. "description": "name of the repo to star",
  15589. "name": "repo",
  15590. "in": "path",
  15591. "required": true
  15592. }
  15593. ],
  15594. "responses": {
  15595. "204": {
  15596. "$ref": "#/responses/empty"
  15597. },
  15598. "404": {
  15599. "$ref": "#/responses/notFound"
  15600. }
  15601. }
  15602. },
  15603. "delete": {
  15604. "tags": [
  15605. "user"
  15606. ],
  15607. "summary": "Unstar the given repo",
  15608. "operationId": "userCurrentDeleteStar",
  15609. "parameters": [
  15610. {
  15611. "type": "string",
  15612. "description": "owner of the repo to unstar",
  15613. "name": "owner",
  15614. "in": "path",
  15615. "required": true
  15616. },
  15617. {
  15618. "type": "string",
  15619. "description": "name of the repo to unstar",
  15620. "name": "repo",
  15621. "in": "path",
  15622. "required": true
  15623. }
  15624. ],
  15625. "responses": {
  15626. "204": {
  15627. "$ref": "#/responses/empty"
  15628. },
  15629. "404": {
  15630. "$ref": "#/responses/notFound"
  15631. }
  15632. }
  15633. }
  15634. },
  15635. "/user/stopwatches": {
  15636. "get": {
  15637. "consumes": [
  15638. "application/json"
  15639. ],
  15640. "produces": [
  15641. "application/json"
  15642. ],
  15643. "tags": [
  15644. "user"
  15645. ],
  15646. "summary": "Get list of all existing stopwatches",
  15647. "operationId": "userGetStopWatches",
  15648. "parameters": [
  15649. {
  15650. "type": "integer",
  15651. "description": "page number of results to return (1-based)",
  15652. "name": "page",
  15653. "in": "query"
  15654. },
  15655. {
  15656. "type": "integer",
  15657. "description": "page size of results",
  15658. "name": "limit",
  15659. "in": "query"
  15660. }
  15661. ],
  15662. "responses": {
  15663. "200": {
  15664. "$ref": "#/responses/StopWatchList"
  15665. }
  15666. }
  15667. }
  15668. },
  15669. "/user/subscriptions": {
  15670. "get": {
  15671. "produces": [
  15672. "application/json"
  15673. ],
  15674. "tags": [
  15675. "user"
  15676. ],
  15677. "summary": "List repositories watched by the authenticated user",
  15678. "operationId": "userCurrentListSubscriptions",
  15679. "parameters": [
  15680. {
  15681. "type": "integer",
  15682. "description": "page number of results to return (1-based)",
  15683. "name": "page",
  15684. "in": "query"
  15685. },
  15686. {
  15687. "type": "integer",
  15688. "description": "page size of results",
  15689. "name": "limit",
  15690. "in": "query"
  15691. }
  15692. ],
  15693. "responses": {
  15694. "200": {
  15695. "$ref": "#/responses/RepositoryList"
  15696. }
  15697. }
  15698. }
  15699. },
  15700. "/user/teams": {
  15701. "get": {
  15702. "produces": [
  15703. "application/json"
  15704. ],
  15705. "tags": [
  15706. "user"
  15707. ],
  15708. "summary": "List all the teams a user belongs to",
  15709. "operationId": "userListTeams",
  15710. "parameters": [
  15711. {
  15712. "type": "integer",
  15713. "description": "page number of results to return (1-based)",
  15714. "name": "page",
  15715. "in": "query"
  15716. },
  15717. {
  15718. "type": "integer",
  15719. "description": "page size of results",
  15720. "name": "limit",
  15721. "in": "query"
  15722. }
  15723. ],
  15724. "responses": {
  15725. "200": {
  15726. "$ref": "#/responses/TeamList"
  15727. }
  15728. }
  15729. }
  15730. },
  15731. "/user/times": {
  15732. "get": {
  15733. "produces": [
  15734. "application/json"
  15735. ],
  15736. "tags": [
  15737. "user"
  15738. ],
  15739. "summary": "List the current user's tracked times",
  15740. "operationId": "userCurrentTrackedTimes",
  15741. "parameters": [
  15742. {
  15743. "type": "integer",
  15744. "description": "page number of results to return (1-based)",
  15745. "name": "page",
  15746. "in": "query"
  15747. },
  15748. {
  15749. "type": "integer",
  15750. "description": "page size of results",
  15751. "name": "limit",
  15752. "in": "query"
  15753. },
  15754. {
  15755. "type": "string",
  15756. "format": "date-time",
  15757. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  15758. "name": "since",
  15759. "in": "query"
  15760. },
  15761. {
  15762. "type": "string",
  15763. "format": "date-time",
  15764. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  15765. "name": "before",
  15766. "in": "query"
  15767. }
  15768. ],
  15769. "responses": {
  15770. "200": {
  15771. "$ref": "#/responses/TrackedTimeList"
  15772. }
  15773. }
  15774. }
  15775. },
  15776. "/users/search": {
  15777. "get": {
  15778. "produces": [
  15779. "application/json"
  15780. ],
  15781. "tags": [
  15782. "user"
  15783. ],
  15784. "summary": "Search for users",
  15785. "operationId": "userSearch",
  15786. "parameters": [
  15787. {
  15788. "type": "string",
  15789. "description": "keyword",
  15790. "name": "q",
  15791. "in": "query"
  15792. },
  15793. {
  15794. "type": "integer",
  15795. "format": "int64",
  15796. "description": "ID of the user to search for",
  15797. "name": "uid",
  15798. "in": "query"
  15799. },
  15800. {
  15801. "type": "integer",
  15802. "description": "page number of results to return (1-based)",
  15803. "name": "page",
  15804. "in": "query"
  15805. },
  15806. {
  15807. "type": "integer",
  15808. "description": "page size of results",
  15809. "name": "limit",
  15810. "in": "query"
  15811. }
  15812. ],
  15813. "responses": {
  15814. "200": {
  15815. "description": "SearchResults of a successful search",
  15816. "schema": {
  15817. "type": "object",
  15818. "properties": {
  15819. "data": {
  15820. "type": "array",
  15821. "items": {
  15822. "$ref": "#/definitions/User"
  15823. }
  15824. },
  15825. "ok": {
  15826. "type": "boolean"
  15827. }
  15828. }
  15829. }
  15830. }
  15831. }
  15832. }
  15833. },
  15834. "/users/{username}": {
  15835. "get": {
  15836. "produces": [
  15837. "application/json"
  15838. ],
  15839. "tags": [
  15840. "user"
  15841. ],
  15842. "summary": "Get a user",
  15843. "operationId": "userGet",
  15844. "parameters": [
  15845. {
  15846. "type": "string",
  15847. "description": "username of user to get",
  15848. "name": "username",
  15849. "in": "path",
  15850. "required": true
  15851. }
  15852. ],
  15853. "responses": {
  15854. "200": {
  15855. "$ref": "#/responses/User"
  15856. },
  15857. "404": {
  15858. "$ref": "#/responses/notFound"
  15859. }
  15860. }
  15861. }
  15862. },
  15863. "/users/{username}/activities/feeds": {
  15864. "get": {
  15865. "produces": [
  15866. "application/json"
  15867. ],
  15868. "tags": [
  15869. "user"
  15870. ],
  15871. "summary": "List a user's activity feeds",
  15872. "operationId": "userListActivityFeeds",
  15873. "parameters": [
  15874. {
  15875. "type": "string",
  15876. "description": "username of user",
  15877. "name": "username",
  15878. "in": "path",
  15879. "required": true
  15880. },
  15881. {
  15882. "type": "boolean",
  15883. "description": "if true, only show actions performed by the requested user",
  15884. "name": "only-performed-by",
  15885. "in": "query"
  15886. },
  15887. {
  15888. "type": "string",
  15889. "format": "date",
  15890. "description": "the date of the activities to be found",
  15891. "name": "date",
  15892. "in": "query"
  15893. },
  15894. {
  15895. "type": "integer",
  15896. "description": "page number of results to return (1-based)",
  15897. "name": "page",
  15898. "in": "query"
  15899. },
  15900. {
  15901. "type": "integer",
  15902. "description": "page size of results",
  15903. "name": "limit",
  15904. "in": "query"
  15905. }
  15906. ],
  15907. "responses": {
  15908. "200": {
  15909. "$ref": "#/responses/ActivityFeedsList"
  15910. },
  15911. "404": {
  15912. "$ref": "#/responses/notFound"
  15913. }
  15914. }
  15915. }
  15916. },
  15917. "/users/{username}/followers": {
  15918. "get": {
  15919. "produces": [
  15920. "application/json"
  15921. ],
  15922. "tags": [
  15923. "user"
  15924. ],
  15925. "summary": "List the given user's followers",
  15926. "operationId": "userListFollowers",
  15927. "parameters": [
  15928. {
  15929. "type": "string",
  15930. "description": "username of user",
  15931. "name": "username",
  15932. "in": "path",
  15933. "required": true
  15934. },
  15935. {
  15936. "type": "integer",
  15937. "description": "page number of results to return (1-based)",
  15938. "name": "page",
  15939. "in": "query"
  15940. },
  15941. {
  15942. "type": "integer",
  15943. "description": "page size of results",
  15944. "name": "limit",
  15945. "in": "query"
  15946. }
  15947. ],
  15948. "responses": {
  15949. "200": {
  15950. "$ref": "#/responses/UserList"
  15951. },
  15952. "404": {
  15953. "$ref": "#/responses/notFound"
  15954. }
  15955. }
  15956. }
  15957. },
  15958. "/users/{username}/following": {
  15959. "get": {
  15960. "produces": [
  15961. "application/json"
  15962. ],
  15963. "tags": [
  15964. "user"
  15965. ],
  15966. "summary": "List the users that the given user is following",
  15967. "operationId": "userListFollowing",
  15968. "parameters": [
  15969. {
  15970. "type": "string",
  15971. "description": "username of user",
  15972. "name": "username",
  15973. "in": "path",
  15974. "required": true
  15975. },
  15976. {
  15977. "type": "integer",
  15978. "description": "page number of results to return (1-based)",
  15979. "name": "page",
  15980. "in": "query"
  15981. },
  15982. {
  15983. "type": "integer",
  15984. "description": "page size of results",
  15985. "name": "limit",
  15986. "in": "query"
  15987. }
  15988. ],
  15989. "responses": {
  15990. "200": {
  15991. "$ref": "#/responses/UserList"
  15992. },
  15993. "404": {
  15994. "$ref": "#/responses/notFound"
  15995. }
  15996. }
  15997. }
  15998. },
  15999. "/users/{username}/following/{target}": {
  16000. "get": {
  16001. "tags": [
  16002. "user"
  16003. ],
  16004. "summary": "Check if one user is following another user",
  16005. "operationId": "userCheckFollowing",
  16006. "parameters": [
  16007. {
  16008. "type": "string",
  16009. "description": "username of following user",
  16010. "name": "username",
  16011. "in": "path",
  16012. "required": true
  16013. },
  16014. {
  16015. "type": "string",
  16016. "description": "username of followed user",
  16017. "name": "target",
  16018. "in": "path",
  16019. "required": true
  16020. }
  16021. ],
  16022. "responses": {
  16023. "204": {
  16024. "$ref": "#/responses/empty"
  16025. },
  16026. "404": {
  16027. "$ref": "#/responses/notFound"
  16028. }
  16029. }
  16030. }
  16031. },
  16032. "/users/{username}/gpg_keys": {
  16033. "get": {
  16034. "produces": [
  16035. "application/json"
  16036. ],
  16037. "tags": [
  16038. "user"
  16039. ],
  16040. "summary": "List the given user's GPG keys",
  16041. "operationId": "userListGPGKeys",
  16042. "parameters": [
  16043. {
  16044. "type": "string",
  16045. "description": "username of user",
  16046. "name": "username",
  16047. "in": "path",
  16048. "required": true
  16049. },
  16050. {
  16051. "type": "integer",
  16052. "description": "page number of results to return (1-based)",
  16053. "name": "page",
  16054. "in": "query"
  16055. },
  16056. {
  16057. "type": "integer",
  16058. "description": "page size of results",
  16059. "name": "limit",
  16060. "in": "query"
  16061. }
  16062. ],
  16063. "responses": {
  16064. "200": {
  16065. "$ref": "#/responses/GPGKeyList"
  16066. },
  16067. "404": {
  16068. "$ref": "#/responses/notFound"
  16069. }
  16070. }
  16071. }
  16072. },
  16073. "/users/{username}/heatmap": {
  16074. "get": {
  16075. "produces": [
  16076. "application/json"
  16077. ],
  16078. "tags": [
  16079. "user"
  16080. ],
  16081. "summary": "Get a user's heatmap",
  16082. "operationId": "userGetHeatmapData",
  16083. "parameters": [
  16084. {
  16085. "type": "string",
  16086. "description": "username of user to get",
  16087. "name": "username",
  16088. "in": "path",
  16089. "required": true
  16090. }
  16091. ],
  16092. "responses": {
  16093. "200": {
  16094. "$ref": "#/responses/UserHeatmapData"
  16095. },
  16096. "404": {
  16097. "$ref": "#/responses/notFound"
  16098. }
  16099. }
  16100. }
  16101. },
  16102. "/users/{username}/keys": {
  16103. "get": {
  16104. "produces": [
  16105. "application/json"
  16106. ],
  16107. "tags": [
  16108. "user"
  16109. ],
  16110. "summary": "List the given user's public keys",
  16111. "operationId": "userListKeys",
  16112. "parameters": [
  16113. {
  16114. "type": "string",
  16115. "description": "username of user",
  16116. "name": "username",
  16117. "in": "path",
  16118. "required": true
  16119. },
  16120. {
  16121. "type": "string",
  16122. "description": "fingerprint of the key",
  16123. "name": "fingerprint",
  16124. "in": "query"
  16125. },
  16126. {
  16127. "type": "integer",
  16128. "description": "page number of results to return (1-based)",
  16129. "name": "page",
  16130. "in": "query"
  16131. },
  16132. {
  16133. "type": "integer",
  16134. "description": "page size of results",
  16135. "name": "limit",
  16136. "in": "query"
  16137. }
  16138. ],
  16139. "responses": {
  16140. "200": {
  16141. "$ref": "#/responses/PublicKeyList"
  16142. },
  16143. "404": {
  16144. "$ref": "#/responses/notFound"
  16145. }
  16146. }
  16147. }
  16148. },
  16149. "/users/{username}/orgs": {
  16150. "get": {
  16151. "produces": [
  16152. "application/json"
  16153. ],
  16154. "tags": [
  16155. "organization"
  16156. ],
  16157. "summary": "List a user's organizations",
  16158. "operationId": "orgListUserOrgs",
  16159. "parameters": [
  16160. {
  16161. "type": "string",
  16162. "description": "username of user",
  16163. "name": "username",
  16164. "in": "path",
  16165. "required": true
  16166. },
  16167. {
  16168. "type": "integer",
  16169. "description": "page number of results to return (1-based)",
  16170. "name": "page",
  16171. "in": "query"
  16172. },
  16173. {
  16174. "type": "integer",
  16175. "description": "page size of results",
  16176. "name": "limit",
  16177. "in": "query"
  16178. }
  16179. ],
  16180. "responses": {
  16181. "200": {
  16182. "$ref": "#/responses/OrganizationList"
  16183. },
  16184. "404": {
  16185. "$ref": "#/responses/notFound"
  16186. }
  16187. }
  16188. }
  16189. },
  16190. "/users/{username}/orgs/{org}/permissions": {
  16191. "get": {
  16192. "produces": [
  16193. "application/json"
  16194. ],
  16195. "tags": [
  16196. "organization"
  16197. ],
  16198. "summary": "Get user permissions in organization",
  16199. "operationId": "orgGetUserPermissions",
  16200. "parameters": [
  16201. {
  16202. "type": "string",
  16203. "description": "username of user",
  16204. "name": "username",
  16205. "in": "path",
  16206. "required": true
  16207. },
  16208. {
  16209. "type": "string",
  16210. "description": "name of the organization",
  16211. "name": "org",
  16212. "in": "path",
  16213. "required": true
  16214. }
  16215. ],
  16216. "responses": {
  16217. "200": {
  16218. "$ref": "#/responses/OrganizationPermissions"
  16219. },
  16220. "403": {
  16221. "$ref": "#/responses/forbidden"
  16222. },
  16223. "404": {
  16224. "$ref": "#/responses/notFound"
  16225. }
  16226. }
  16227. }
  16228. },
  16229. "/users/{username}/repos": {
  16230. "get": {
  16231. "produces": [
  16232. "application/json"
  16233. ],
  16234. "tags": [
  16235. "user"
  16236. ],
  16237. "summary": "List the repos owned by the given user",
  16238. "operationId": "userListRepos",
  16239. "parameters": [
  16240. {
  16241. "type": "string",
  16242. "description": "username of user",
  16243. "name": "username",
  16244. "in": "path",
  16245. "required": true
  16246. },
  16247. {
  16248. "type": "integer",
  16249. "description": "page number of results to return (1-based)",
  16250. "name": "page",
  16251. "in": "query"
  16252. },
  16253. {
  16254. "type": "integer",
  16255. "description": "page size of results",
  16256. "name": "limit",
  16257. "in": "query"
  16258. }
  16259. ],
  16260. "responses": {
  16261. "200": {
  16262. "$ref": "#/responses/RepositoryList"
  16263. },
  16264. "404": {
  16265. "$ref": "#/responses/notFound"
  16266. }
  16267. }
  16268. }
  16269. },
  16270. "/users/{username}/starred": {
  16271. "get": {
  16272. "produces": [
  16273. "application/json"
  16274. ],
  16275. "tags": [
  16276. "user"
  16277. ],
  16278. "summary": "The repos that the given user has starred",
  16279. "operationId": "userListStarred",
  16280. "parameters": [
  16281. {
  16282. "type": "string",
  16283. "description": "username of user",
  16284. "name": "username",
  16285. "in": "path",
  16286. "required": true
  16287. },
  16288. {
  16289. "type": "integer",
  16290. "description": "page number of results to return (1-based)",
  16291. "name": "page",
  16292. "in": "query"
  16293. },
  16294. {
  16295. "type": "integer",
  16296. "description": "page size of results",
  16297. "name": "limit",
  16298. "in": "query"
  16299. }
  16300. ],
  16301. "responses": {
  16302. "200": {
  16303. "$ref": "#/responses/RepositoryList"
  16304. },
  16305. "404": {
  16306. "$ref": "#/responses/notFound"
  16307. }
  16308. }
  16309. }
  16310. },
  16311. "/users/{username}/subscriptions": {
  16312. "get": {
  16313. "produces": [
  16314. "application/json"
  16315. ],
  16316. "tags": [
  16317. "user"
  16318. ],
  16319. "summary": "List the repositories watched by a user",
  16320. "operationId": "userListSubscriptions",
  16321. "parameters": [
  16322. {
  16323. "type": "string",
  16324. "description": "username of the user",
  16325. "name": "username",
  16326. "in": "path",
  16327. "required": true
  16328. },
  16329. {
  16330. "type": "integer",
  16331. "description": "page number of results to return (1-based)",
  16332. "name": "page",
  16333. "in": "query"
  16334. },
  16335. {
  16336. "type": "integer",
  16337. "description": "page size of results",
  16338. "name": "limit",
  16339. "in": "query"
  16340. }
  16341. ],
  16342. "responses": {
  16343. "200": {
  16344. "$ref": "#/responses/RepositoryList"
  16345. },
  16346. "404": {
  16347. "$ref": "#/responses/notFound"
  16348. }
  16349. }
  16350. }
  16351. },
  16352. "/users/{username}/tokens": {
  16353. "get": {
  16354. "produces": [
  16355. "application/json"
  16356. ],
  16357. "tags": [
  16358. "user"
  16359. ],
  16360. "summary": "List the authenticated user's access tokens",
  16361. "operationId": "userGetTokens",
  16362. "parameters": [
  16363. {
  16364. "type": "string",
  16365. "description": "username of user",
  16366. "name": "username",
  16367. "in": "path",
  16368. "required": true
  16369. },
  16370. {
  16371. "type": "integer",
  16372. "description": "page number of results to return (1-based)",
  16373. "name": "page",
  16374. "in": "query"
  16375. },
  16376. {
  16377. "type": "integer",
  16378. "description": "page size of results",
  16379. "name": "limit",
  16380. "in": "query"
  16381. }
  16382. ],
  16383. "responses": {
  16384. "200": {
  16385. "$ref": "#/responses/AccessTokenList"
  16386. },
  16387. "403": {
  16388. "$ref": "#/responses/forbidden"
  16389. }
  16390. }
  16391. },
  16392. "post": {
  16393. "consumes": [
  16394. "application/json"
  16395. ],
  16396. "produces": [
  16397. "application/json"
  16398. ],
  16399. "tags": [
  16400. "user"
  16401. ],
  16402. "summary": "Create an access token",
  16403. "operationId": "userCreateToken",
  16404. "parameters": [
  16405. {
  16406. "type": "string",
  16407. "description": "username of user",
  16408. "name": "username",
  16409. "in": "path",
  16410. "required": true
  16411. },
  16412. {
  16413. "name": "body",
  16414. "in": "body",
  16415. "schema": {
  16416. "$ref": "#/definitions/CreateAccessTokenOption"
  16417. }
  16418. }
  16419. ],
  16420. "responses": {
  16421. "201": {
  16422. "$ref": "#/responses/AccessToken"
  16423. },
  16424. "400": {
  16425. "$ref": "#/responses/error"
  16426. },
  16427. "403": {
  16428. "$ref": "#/responses/forbidden"
  16429. }
  16430. }
  16431. }
  16432. },
  16433. "/users/{username}/tokens/{token}": {
  16434. "delete": {
  16435. "produces": [
  16436. "application/json"
  16437. ],
  16438. "tags": [
  16439. "user"
  16440. ],
  16441. "summary": "delete an access token",
  16442. "operationId": "userDeleteAccessToken",
  16443. "parameters": [
  16444. {
  16445. "type": "string",
  16446. "description": "username of user",
  16447. "name": "username",
  16448. "in": "path",
  16449. "required": true
  16450. },
  16451. {
  16452. "type": "string",
  16453. "description": "token to be deleted, identified by ID and if not available by name",
  16454. "name": "token",
  16455. "in": "path",
  16456. "required": true
  16457. }
  16458. ],
  16459. "responses": {
  16460. "204": {
  16461. "$ref": "#/responses/empty"
  16462. },
  16463. "403": {
  16464. "$ref": "#/responses/forbidden"
  16465. },
  16466. "404": {
  16467. "$ref": "#/responses/notFound"
  16468. },
  16469. "422": {
  16470. "$ref": "#/responses/error"
  16471. }
  16472. }
  16473. }
  16474. },
  16475. "/version": {
  16476. "get": {
  16477. "produces": [
  16478. "application/json"
  16479. ],
  16480. "tags": [
  16481. "miscellaneous"
  16482. ],
  16483. "summary": "Returns the version of the Gitea application",
  16484. "operationId": "getVersion",
  16485. "responses": {
  16486. "200": {
  16487. "$ref": "#/responses/ServerVersion"
  16488. }
  16489. }
  16490. }
  16491. }
  16492. },
  16493. "definitions": {
  16494. "APIError": {
  16495. "description": "APIError is an api error with a message",
  16496. "type": "object",
  16497. "properties": {
  16498. "message": {
  16499. "type": "string",
  16500. "x-go-name": "Message"
  16501. },
  16502. "url": {
  16503. "type": "string",
  16504. "x-go-name": "URL"
  16505. }
  16506. },
  16507. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16508. },
  16509. "AccessToken": {
  16510. "type": "object",
  16511. "title": "AccessToken represents an API access token.",
  16512. "properties": {
  16513. "id": {
  16514. "type": "integer",
  16515. "format": "int64",
  16516. "x-go-name": "ID"
  16517. },
  16518. "name": {
  16519. "type": "string",
  16520. "x-go-name": "Name"
  16521. },
  16522. "scopes": {
  16523. "type": "array",
  16524. "items": {
  16525. "type": "string"
  16526. },
  16527. "x-go-name": "Scopes"
  16528. },
  16529. "sha1": {
  16530. "type": "string",
  16531. "x-go-name": "Token"
  16532. },
  16533. "token_last_eight": {
  16534. "type": "string",
  16535. "x-go-name": "TokenLastEight"
  16536. }
  16537. },
  16538. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16539. },
  16540. "Activity": {
  16541. "type": "object",
  16542. "properties": {
  16543. "act_user": {
  16544. "$ref": "#/definitions/User"
  16545. },
  16546. "act_user_id": {
  16547. "type": "integer",
  16548. "format": "int64",
  16549. "x-go-name": "ActUserID"
  16550. },
  16551. "comment": {
  16552. "$ref": "#/definitions/Comment"
  16553. },
  16554. "comment_id": {
  16555. "type": "integer",
  16556. "format": "int64",
  16557. "x-go-name": "CommentID"
  16558. },
  16559. "content": {
  16560. "type": "string",
  16561. "x-go-name": "Content"
  16562. },
  16563. "created": {
  16564. "type": "string",
  16565. "format": "date-time",
  16566. "x-go-name": "Created"
  16567. },
  16568. "id": {
  16569. "type": "integer",
  16570. "format": "int64",
  16571. "x-go-name": "ID"
  16572. },
  16573. "is_private": {
  16574. "type": "boolean",
  16575. "x-go-name": "IsPrivate"
  16576. },
  16577. "op_type": {
  16578. "type": "string",
  16579. "x-go-name": "OpType"
  16580. },
  16581. "ref_name": {
  16582. "type": "string",
  16583. "x-go-name": "RefName"
  16584. },
  16585. "repo": {
  16586. "$ref": "#/definitions/Repository"
  16587. },
  16588. "repo_id": {
  16589. "type": "integer",
  16590. "format": "int64",
  16591. "x-go-name": "RepoID"
  16592. },
  16593. "user_id": {
  16594. "type": "integer",
  16595. "format": "int64",
  16596. "x-go-name": "UserID"
  16597. }
  16598. },
  16599. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16600. },
  16601. "ActivityPub": {
  16602. "description": "ActivityPub type",
  16603. "type": "object",
  16604. "properties": {
  16605. "@context": {
  16606. "type": "string",
  16607. "x-go-name": "Context"
  16608. }
  16609. },
  16610. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16611. },
  16612. "AddCollaboratorOption": {
  16613. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  16614. "type": "object",
  16615. "properties": {
  16616. "permission": {
  16617. "type": "string",
  16618. "x-go-name": "Permission"
  16619. }
  16620. },
  16621. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16622. },
  16623. "AddTimeOption": {
  16624. "description": "AddTimeOption options for adding time to an issue",
  16625. "type": "object",
  16626. "required": [
  16627. "time"
  16628. ],
  16629. "properties": {
  16630. "created": {
  16631. "type": "string",
  16632. "format": "date-time",
  16633. "x-go-name": "Created"
  16634. },
  16635. "time": {
  16636. "description": "time in seconds",
  16637. "type": "integer",
  16638. "format": "int64",
  16639. "x-go-name": "Time"
  16640. },
  16641. "user_name": {
  16642. "description": "User who spent the time (optional)",
  16643. "type": "string",
  16644. "x-go-name": "User"
  16645. }
  16646. },
  16647. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16648. },
  16649. "AnnotatedTag": {
  16650. "description": "AnnotatedTag represents an annotated tag",
  16651. "type": "object",
  16652. "properties": {
  16653. "message": {
  16654. "type": "string",
  16655. "x-go-name": "Message"
  16656. },
  16657. "object": {
  16658. "$ref": "#/definitions/AnnotatedTagObject"
  16659. },
  16660. "sha": {
  16661. "type": "string",
  16662. "x-go-name": "SHA"
  16663. },
  16664. "tag": {
  16665. "type": "string",
  16666. "x-go-name": "Tag"
  16667. },
  16668. "tagger": {
  16669. "$ref": "#/definitions/CommitUser"
  16670. },
  16671. "url": {
  16672. "type": "string",
  16673. "x-go-name": "URL"
  16674. },
  16675. "verification": {
  16676. "$ref": "#/definitions/PayloadCommitVerification"
  16677. }
  16678. },
  16679. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16680. },
  16681. "AnnotatedTagObject": {
  16682. "description": "AnnotatedTagObject contains meta information of the tag object",
  16683. "type": "object",
  16684. "properties": {
  16685. "sha": {
  16686. "type": "string",
  16687. "x-go-name": "SHA"
  16688. },
  16689. "type": {
  16690. "type": "string",
  16691. "x-go-name": "Type"
  16692. },
  16693. "url": {
  16694. "type": "string",
  16695. "x-go-name": "URL"
  16696. }
  16697. },
  16698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16699. },
  16700. "Attachment": {
  16701. "description": "Attachment a generic attachment",
  16702. "type": "object",
  16703. "properties": {
  16704. "browser_download_url": {
  16705. "type": "string",
  16706. "x-go-name": "DownloadURL"
  16707. },
  16708. "created_at": {
  16709. "type": "string",
  16710. "format": "date-time",
  16711. "x-go-name": "Created"
  16712. },
  16713. "download_count": {
  16714. "type": "integer",
  16715. "format": "int64",
  16716. "x-go-name": "DownloadCount"
  16717. },
  16718. "id": {
  16719. "type": "integer",
  16720. "format": "int64",
  16721. "x-go-name": "ID"
  16722. },
  16723. "name": {
  16724. "type": "string",
  16725. "x-go-name": "Name"
  16726. },
  16727. "size": {
  16728. "type": "integer",
  16729. "format": "int64",
  16730. "x-go-name": "Size"
  16731. },
  16732. "uuid": {
  16733. "type": "string",
  16734. "x-go-name": "UUID"
  16735. }
  16736. },
  16737. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16738. },
  16739. "Branch": {
  16740. "description": "Branch represents a repository branch",
  16741. "type": "object",
  16742. "properties": {
  16743. "commit": {
  16744. "$ref": "#/definitions/PayloadCommit"
  16745. },
  16746. "effective_branch_protection_name": {
  16747. "type": "string",
  16748. "x-go-name": "EffectiveBranchProtectionName"
  16749. },
  16750. "enable_status_check": {
  16751. "type": "boolean",
  16752. "x-go-name": "EnableStatusCheck"
  16753. },
  16754. "name": {
  16755. "type": "string",
  16756. "x-go-name": "Name"
  16757. },
  16758. "protected": {
  16759. "type": "boolean",
  16760. "x-go-name": "Protected"
  16761. },
  16762. "required_approvals": {
  16763. "type": "integer",
  16764. "format": "int64",
  16765. "x-go-name": "RequiredApprovals"
  16766. },
  16767. "status_check_contexts": {
  16768. "type": "array",
  16769. "items": {
  16770. "type": "string"
  16771. },
  16772. "x-go-name": "StatusCheckContexts"
  16773. },
  16774. "user_can_merge": {
  16775. "type": "boolean",
  16776. "x-go-name": "UserCanMerge"
  16777. },
  16778. "user_can_push": {
  16779. "type": "boolean",
  16780. "x-go-name": "UserCanPush"
  16781. }
  16782. },
  16783. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16784. },
  16785. "BranchProtection": {
  16786. "description": "BranchProtection represents a branch protection for a repository",
  16787. "type": "object",
  16788. "properties": {
  16789. "approvals_whitelist_teams": {
  16790. "type": "array",
  16791. "items": {
  16792. "type": "string"
  16793. },
  16794. "x-go-name": "ApprovalsWhitelistTeams"
  16795. },
  16796. "approvals_whitelist_username": {
  16797. "type": "array",
  16798. "items": {
  16799. "type": "string"
  16800. },
  16801. "x-go-name": "ApprovalsWhitelistUsernames"
  16802. },
  16803. "block_on_official_review_requests": {
  16804. "type": "boolean",
  16805. "x-go-name": "BlockOnOfficialReviewRequests"
  16806. },
  16807. "block_on_outdated_branch": {
  16808. "type": "boolean",
  16809. "x-go-name": "BlockOnOutdatedBranch"
  16810. },
  16811. "block_on_rejected_reviews": {
  16812. "type": "boolean",
  16813. "x-go-name": "BlockOnRejectedReviews"
  16814. },
  16815. "branch_name": {
  16816. "description": "Deprecated: true",
  16817. "type": "string",
  16818. "x-go-name": "BranchName"
  16819. },
  16820. "created_at": {
  16821. "type": "string",
  16822. "format": "date-time",
  16823. "x-go-name": "Created"
  16824. },
  16825. "dismiss_stale_approvals": {
  16826. "type": "boolean",
  16827. "x-go-name": "DismissStaleApprovals"
  16828. },
  16829. "enable_approvals_whitelist": {
  16830. "type": "boolean",
  16831. "x-go-name": "EnableApprovalsWhitelist"
  16832. },
  16833. "enable_merge_whitelist": {
  16834. "type": "boolean",
  16835. "x-go-name": "EnableMergeWhitelist"
  16836. },
  16837. "enable_push": {
  16838. "type": "boolean",
  16839. "x-go-name": "EnablePush"
  16840. },
  16841. "enable_push_whitelist": {
  16842. "type": "boolean",
  16843. "x-go-name": "EnablePushWhitelist"
  16844. },
  16845. "enable_status_check": {
  16846. "type": "boolean",
  16847. "x-go-name": "EnableStatusCheck"
  16848. },
  16849. "merge_whitelist_teams": {
  16850. "type": "array",
  16851. "items": {
  16852. "type": "string"
  16853. },
  16854. "x-go-name": "MergeWhitelistTeams"
  16855. },
  16856. "merge_whitelist_usernames": {
  16857. "type": "array",
  16858. "items": {
  16859. "type": "string"
  16860. },
  16861. "x-go-name": "MergeWhitelistUsernames"
  16862. },
  16863. "protected_file_patterns": {
  16864. "type": "string",
  16865. "x-go-name": "ProtectedFilePatterns"
  16866. },
  16867. "push_whitelist_deploy_keys": {
  16868. "type": "boolean",
  16869. "x-go-name": "PushWhitelistDeployKeys"
  16870. },
  16871. "push_whitelist_teams": {
  16872. "type": "array",
  16873. "items": {
  16874. "type": "string"
  16875. },
  16876. "x-go-name": "PushWhitelistTeams"
  16877. },
  16878. "push_whitelist_usernames": {
  16879. "type": "array",
  16880. "items": {
  16881. "type": "string"
  16882. },
  16883. "x-go-name": "PushWhitelistUsernames"
  16884. },
  16885. "require_signed_commits": {
  16886. "type": "boolean",
  16887. "x-go-name": "RequireSignedCommits"
  16888. },
  16889. "required_approvals": {
  16890. "type": "integer",
  16891. "format": "int64",
  16892. "x-go-name": "RequiredApprovals"
  16893. },
  16894. "rule_name": {
  16895. "type": "string",
  16896. "x-go-name": "RuleName"
  16897. },
  16898. "status_check_contexts": {
  16899. "type": "array",
  16900. "items": {
  16901. "type": "string"
  16902. },
  16903. "x-go-name": "StatusCheckContexts"
  16904. },
  16905. "unprotected_file_patterns": {
  16906. "type": "string",
  16907. "x-go-name": "UnprotectedFilePatterns"
  16908. },
  16909. "updated_at": {
  16910. "type": "string",
  16911. "format": "date-time",
  16912. "x-go-name": "Updated"
  16913. }
  16914. },
  16915. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16916. },
  16917. "ChangeFileOperation": {
  16918. "description": "ChangeFileOperation for creating, updating or deleting a file",
  16919. "type": "object",
  16920. "required": [
  16921. "operation",
  16922. "path"
  16923. ],
  16924. "properties": {
  16925. "content": {
  16926. "description": "new or updated file content, must be base64 encoded",
  16927. "type": "string",
  16928. "x-go-name": "ContentBase64"
  16929. },
  16930. "from_path": {
  16931. "description": "old path of the file to move",
  16932. "type": "string",
  16933. "x-go-name": "FromPath"
  16934. },
  16935. "operation": {
  16936. "description": "indicates what to do with the file",
  16937. "type": "string",
  16938. "enum": [
  16939. "create",
  16940. "update",
  16941. "delete"
  16942. ],
  16943. "x-go-name": "Operation"
  16944. },
  16945. "path": {
  16946. "description": "path to the existing or new file",
  16947. "type": "string",
  16948. "x-go-name": "Path"
  16949. },
  16950. "sha": {
  16951. "description": "sha is the SHA for the file that already exists, required for update or delete",
  16952. "type": "string",
  16953. "x-go-name": "SHA"
  16954. }
  16955. },
  16956. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16957. },
  16958. "ChangeFilesOptions": {
  16959. "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)",
  16960. "type": "object",
  16961. "required": [
  16962. "files"
  16963. ],
  16964. "properties": {
  16965. "author": {
  16966. "$ref": "#/definitions/Identity"
  16967. },
  16968. "branch": {
  16969. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  16970. "type": "string",
  16971. "x-go-name": "BranchName"
  16972. },
  16973. "committer": {
  16974. "$ref": "#/definitions/Identity"
  16975. },
  16976. "dates": {
  16977. "$ref": "#/definitions/CommitDateOptions"
  16978. },
  16979. "files": {
  16980. "description": "list of file operations",
  16981. "type": "array",
  16982. "items": {
  16983. "$ref": "#/definitions/ChangeFileOperation"
  16984. },
  16985. "x-go-name": "Files"
  16986. },
  16987. "message": {
  16988. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  16989. "type": "string",
  16990. "x-go-name": "Message"
  16991. },
  16992. "new_branch": {
  16993. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  16994. "type": "string",
  16995. "x-go-name": "NewBranchName"
  16996. },
  16997. "signoff": {
  16998. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  16999. "type": "boolean",
  17000. "x-go-name": "Signoff"
  17001. }
  17002. },
  17003. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17004. },
  17005. "ChangedFile": {
  17006. "description": "ChangedFile store information about files affected by the pull request",
  17007. "type": "object",
  17008. "properties": {
  17009. "additions": {
  17010. "type": "integer",
  17011. "format": "int64",
  17012. "x-go-name": "Additions"
  17013. },
  17014. "changes": {
  17015. "type": "integer",
  17016. "format": "int64",
  17017. "x-go-name": "Changes"
  17018. },
  17019. "contents_url": {
  17020. "type": "string",
  17021. "x-go-name": "ContentsURL"
  17022. },
  17023. "deletions": {
  17024. "type": "integer",
  17025. "format": "int64",
  17026. "x-go-name": "Deletions"
  17027. },
  17028. "filename": {
  17029. "type": "string",
  17030. "x-go-name": "Filename"
  17031. },
  17032. "html_url": {
  17033. "type": "string",
  17034. "x-go-name": "HTMLURL"
  17035. },
  17036. "previous_filename": {
  17037. "type": "string",
  17038. "x-go-name": "PreviousFilename"
  17039. },
  17040. "raw_url": {
  17041. "type": "string",
  17042. "x-go-name": "RawURL"
  17043. },
  17044. "status": {
  17045. "type": "string",
  17046. "x-go-name": "Status"
  17047. }
  17048. },
  17049. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17050. },
  17051. "CombinedStatus": {
  17052. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  17053. "type": "object",
  17054. "properties": {
  17055. "commit_url": {
  17056. "type": "string",
  17057. "x-go-name": "CommitURL"
  17058. },
  17059. "repository": {
  17060. "$ref": "#/definitions/Repository"
  17061. },
  17062. "sha": {
  17063. "type": "string",
  17064. "x-go-name": "SHA"
  17065. },
  17066. "state": {
  17067. "$ref": "#/definitions/CommitStatusState"
  17068. },
  17069. "statuses": {
  17070. "type": "array",
  17071. "items": {
  17072. "$ref": "#/definitions/CommitStatus"
  17073. },
  17074. "x-go-name": "Statuses"
  17075. },
  17076. "total_count": {
  17077. "type": "integer",
  17078. "format": "int64",
  17079. "x-go-name": "TotalCount"
  17080. },
  17081. "url": {
  17082. "type": "string",
  17083. "x-go-name": "URL"
  17084. }
  17085. },
  17086. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17087. },
  17088. "Comment": {
  17089. "description": "Comment represents a comment on a commit or issue",
  17090. "type": "object",
  17091. "properties": {
  17092. "assets": {
  17093. "type": "array",
  17094. "items": {
  17095. "$ref": "#/definitions/Attachment"
  17096. },
  17097. "x-go-name": "Attachments"
  17098. },
  17099. "body": {
  17100. "type": "string",
  17101. "x-go-name": "Body"
  17102. },
  17103. "created_at": {
  17104. "type": "string",
  17105. "format": "date-time",
  17106. "x-go-name": "Created"
  17107. },
  17108. "html_url": {
  17109. "type": "string",
  17110. "x-go-name": "HTMLURL"
  17111. },
  17112. "id": {
  17113. "type": "integer",
  17114. "format": "int64",
  17115. "x-go-name": "ID"
  17116. },
  17117. "issue_url": {
  17118. "type": "string",
  17119. "x-go-name": "IssueURL"
  17120. },
  17121. "original_author": {
  17122. "type": "string",
  17123. "x-go-name": "OriginalAuthor"
  17124. },
  17125. "original_author_id": {
  17126. "type": "integer",
  17127. "format": "int64",
  17128. "x-go-name": "OriginalAuthorID"
  17129. },
  17130. "pull_request_url": {
  17131. "type": "string",
  17132. "x-go-name": "PRURL"
  17133. },
  17134. "updated_at": {
  17135. "type": "string",
  17136. "format": "date-time",
  17137. "x-go-name": "Updated"
  17138. },
  17139. "user": {
  17140. "$ref": "#/definitions/User"
  17141. }
  17142. },
  17143. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17144. },
  17145. "Commit": {
  17146. "type": "object",
  17147. "title": "Commit contains information generated from a Git commit.",
  17148. "properties": {
  17149. "author": {
  17150. "$ref": "#/definitions/User"
  17151. },
  17152. "commit": {
  17153. "$ref": "#/definitions/RepoCommit"
  17154. },
  17155. "committer": {
  17156. "$ref": "#/definitions/User"
  17157. },
  17158. "created": {
  17159. "type": "string",
  17160. "format": "date-time",
  17161. "x-go-name": "Created"
  17162. },
  17163. "files": {
  17164. "type": "array",
  17165. "items": {
  17166. "$ref": "#/definitions/CommitAffectedFiles"
  17167. },
  17168. "x-go-name": "Files"
  17169. },
  17170. "html_url": {
  17171. "type": "string",
  17172. "x-go-name": "HTMLURL"
  17173. },
  17174. "parents": {
  17175. "type": "array",
  17176. "items": {
  17177. "$ref": "#/definitions/CommitMeta"
  17178. },
  17179. "x-go-name": "Parents"
  17180. },
  17181. "sha": {
  17182. "type": "string",
  17183. "x-go-name": "SHA"
  17184. },
  17185. "stats": {
  17186. "$ref": "#/definitions/CommitStats"
  17187. },
  17188. "url": {
  17189. "type": "string",
  17190. "x-go-name": "URL"
  17191. }
  17192. },
  17193. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17194. },
  17195. "CommitAffectedFiles": {
  17196. "description": "CommitAffectedFiles store information about files affected by the commit",
  17197. "type": "object",
  17198. "properties": {
  17199. "filename": {
  17200. "type": "string",
  17201. "x-go-name": "Filename"
  17202. },
  17203. "status": {
  17204. "type": "string",
  17205. "x-go-name": "Status"
  17206. }
  17207. },
  17208. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17209. },
  17210. "CommitDateOptions": {
  17211. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  17212. "type": "object",
  17213. "properties": {
  17214. "author": {
  17215. "type": "string",
  17216. "format": "date-time",
  17217. "x-go-name": "Author"
  17218. },
  17219. "committer": {
  17220. "type": "string",
  17221. "format": "date-time",
  17222. "x-go-name": "Committer"
  17223. }
  17224. },
  17225. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17226. },
  17227. "CommitMeta": {
  17228. "type": "object",
  17229. "title": "CommitMeta contains meta information of a commit in terms of API.",
  17230. "properties": {
  17231. "created": {
  17232. "type": "string",
  17233. "format": "date-time",
  17234. "x-go-name": "Created"
  17235. },
  17236. "sha": {
  17237. "type": "string",
  17238. "x-go-name": "SHA"
  17239. },
  17240. "url": {
  17241. "type": "string",
  17242. "x-go-name": "URL"
  17243. }
  17244. },
  17245. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17246. },
  17247. "CommitStats": {
  17248. "description": "CommitStats is statistics for a RepoCommit",
  17249. "type": "object",
  17250. "properties": {
  17251. "additions": {
  17252. "type": "integer",
  17253. "format": "int64",
  17254. "x-go-name": "Additions"
  17255. },
  17256. "deletions": {
  17257. "type": "integer",
  17258. "format": "int64",
  17259. "x-go-name": "Deletions"
  17260. },
  17261. "total": {
  17262. "type": "integer",
  17263. "format": "int64",
  17264. "x-go-name": "Total"
  17265. }
  17266. },
  17267. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17268. },
  17269. "CommitStatus": {
  17270. "description": "CommitStatus holds a single status of a single Commit",
  17271. "type": "object",
  17272. "properties": {
  17273. "context": {
  17274. "type": "string",
  17275. "x-go-name": "Context"
  17276. },
  17277. "created_at": {
  17278. "type": "string",
  17279. "format": "date-time",
  17280. "x-go-name": "Created"
  17281. },
  17282. "creator": {
  17283. "$ref": "#/definitions/User"
  17284. },
  17285. "description": {
  17286. "type": "string",
  17287. "x-go-name": "Description"
  17288. },
  17289. "id": {
  17290. "type": "integer",
  17291. "format": "int64",
  17292. "x-go-name": "ID"
  17293. },
  17294. "status": {
  17295. "$ref": "#/definitions/CommitStatusState"
  17296. },
  17297. "target_url": {
  17298. "type": "string",
  17299. "x-go-name": "TargetURL"
  17300. },
  17301. "updated_at": {
  17302. "type": "string",
  17303. "format": "date-time",
  17304. "x-go-name": "Updated"
  17305. },
  17306. "url": {
  17307. "type": "string",
  17308. "x-go-name": "URL"
  17309. }
  17310. },
  17311. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17312. },
  17313. "CommitStatusState": {
  17314. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"",
  17315. "type": "string",
  17316. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17317. },
  17318. "CommitUser": {
  17319. "type": "object",
  17320. "title": "CommitUser contains information of a user in the context of a commit.",
  17321. "properties": {
  17322. "date": {
  17323. "type": "string",
  17324. "x-go-name": "Date"
  17325. },
  17326. "email": {
  17327. "type": "string",
  17328. "format": "email",
  17329. "x-go-name": "Email"
  17330. },
  17331. "name": {
  17332. "type": "string",
  17333. "x-go-name": "Name"
  17334. }
  17335. },
  17336. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17337. },
  17338. "ContentsResponse": {
  17339. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  17340. "type": "object",
  17341. "properties": {
  17342. "_links": {
  17343. "$ref": "#/definitions/FileLinksResponse"
  17344. },
  17345. "content": {
  17346. "description": "`content` is populated when `type` is `file`, otherwise null",
  17347. "type": "string",
  17348. "x-go-name": "Content"
  17349. },
  17350. "download_url": {
  17351. "type": "string",
  17352. "x-go-name": "DownloadURL"
  17353. },
  17354. "encoding": {
  17355. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  17356. "type": "string",
  17357. "x-go-name": "Encoding"
  17358. },
  17359. "git_url": {
  17360. "type": "string",
  17361. "x-go-name": "GitURL"
  17362. },
  17363. "html_url": {
  17364. "type": "string",
  17365. "x-go-name": "HTMLURL"
  17366. },
  17367. "last_commit_sha": {
  17368. "type": "string",
  17369. "x-go-name": "LastCommitSHA"
  17370. },
  17371. "name": {
  17372. "type": "string",
  17373. "x-go-name": "Name"
  17374. },
  17375. "path": {
  17376. "type": "string",
  17377. "x-go-name": "Path"
  17378. },
  17379. "sha": {
  17380. "type": "string",
  17381. "x-go-name": "SHA"
  17382. },
  17383. "size": {
  17384. "type": "integer",
  17385. "format": "int64",
  17386. "x-go-name": "Size"
  17387. },
  17388. "submodule_git_url": {
  17389. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  17390. "type": "string",
  17391. "x-go-name": "SubmoduleGitURL"
  17392. },
  17393. "target": {
  17394. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  17395. "type": "string",
  17396. "x-go-name": "Target"
  17397. },
  17398. "type": {
  17399. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  17400. "type": "string",
  17401. "x-go-name": "Type"
  17402. },
  17403. "url": {
  17404. "type": "string",
  17405. "x-go-name": "URL"
  17406. }
  17407. },
  17408. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17409. },
  17410. "CreateAccessTokenOption": {
  17411. "description": "CreateAccessTokenOption options when create access token",
  17412. "type": "object",
  17413. "required": [
  17414. "name"
  17415. ],
  17416. "properties": {
  17417. "name": {
  17418. "type": "string",
  17419. "x-go-name": "Name"
  17420. },
  17421. "scopes": {
  17422. "type": "array",
  17423. "items": {
  17424. "type": "string"
  17425. },
  17426. "x-go-name": "Scopes"
  17427. }
  17428. },
  17429. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17430. },
  17431. "CreateBranchProtectionOption": {
  17432. "description": "CreateBranchProtectionOption options for creating a branch protection",
  17433. "type": "object",
  17434. "properties": {
  17435. "approvals_whitelist_teams": {
  17436. "type": "array",
  17437. "items": {
  17438. "type": "string"
  17439. },
  17440. "x-go-name": "ApprovalsWhitelistTeams"
  17441. },
  17442. "approvals_whitelist_username": {
  17443. "type": "array",
  17444. "items": {
  17445. "type": "string"
  17446. },
  17447. "x-go-name": "ApprovalsWhitelistUsernames"
  17448. },
  17449. "block_on_official_review_requests": {
  17450. "type": "boolean",
  17451. "x-go-name": "BlockOnOfficialReviewRequests"
  17452. },
  17453. "block_on_outdated_branch": {
  17454. "type": "boolean",
  17455. "x-go-name": "BlockOnOutdatedBranch"
  17456. },
  17457. "block_on_rejected_reviews": {
  17458. "type": "boolean",
  17459. "x-go-name": "BlockOnRejectedReviews"
  17460. },
  17461. "branch_name": {
  17462. "description": "Deprecated: true",
  17463. "type": "string",
  17464. "x-go-name": "BranchName"
  17465. },
  17466. "dismiss_stale_approvals": {
  17467. "type": "boolean",
  17468. "x-go-name": "DismissStaleApprovals"
  17469. },
  17470. "enable_approvals_whitelist": {
  17471. "type": "boolean",
  17472. "x-go-name": "EnableApprovalsWhitelist"
  17473. },
  17474. "enable_merge_whitelist": {
  17475. "type": "boolean",
  17476. "x-go-name": "EnableMergeWhitelist"
  17477. },
  17478. "enable_push": {
  17479. "type": "boolean",
  17480. "x-go-name": "EnablePush"
  17481. },
  17482. "enable_push_whitelist": {
  17483. "type": "boolean",
  17484. "x-go-name": "EnablePushWhitelist"
  17485. },
  17486. "enable_status_check": {
  17487. "type": "boolean",
  17488. "x-go-name": "EnableStatusCheck"
  17489. },
  17490. "merge_whitelist_teams": {
  17491. "type": "array",
  17492. "items": {
  17493. "type": "string"
  17494. },
  17495. "x-go-name": "MergeWhitelistTeams"
  17496. },
  17497. "merge_whitelist_usernames": {
  17498. "type": "array",
  17499. "items": {
  17500. "type": "string"
  17501. },
  17502. "x-go-name": "MergeWhitelistUsernames"
  17503. },
  17504. "protected_file_patterns": {
  17505. "type": "string",
  17506. "x-go-name": "ProtectedFilePatterns"
  17507. },
  17508. "push_whitelist_deploy_keys": {
  17509. "type": "boolean",
  17510. "x-go-name": "PushWhitelistDeployKeys"
  17511. },
  17512. "push_whitelist_teams": {
  17513. "type": "array",
  17514. "items": {
  17515. "type": "string"
  17516. },
  17517. "x-go-name": "PushWhitelistTeams"
  17518. },
  17519. "push_whitelist_usernames": {
  17520. "type": "array",
  17521. "items": {
  17522. "type": "string"
  17523. },
  17524. "x-go-name": "PushWhitelistUsernames"
  17525. },
  17526. "require_signed_commits": {
  17527. "type": "boolean",
  17528. "x-go-name": "RequireSignedCommits"
  17529. },
  17530. "required_approvals": {
  17531. "type": "integer",
  17532. "format": "int64",
  17533. "x-go-name": "RequiredApprovals"
  17534. },
  17535. "rule_name": {
  17536. "type": "string",
  17537. "x-go-name": "RuleName"
  17538. },
  17539. "status_check_contexts": {
  17540. "type": "array",
  17541. "items": {
  17542. "type": "string"
  17543. },
  17544. "x-go-name": "StatusCheckContexts"
  17545. },
  17546. "unprotected_file_patterns": {
  17547. "type": "string",
  17548. "x-go-name": "UnprotectedFilePatterns"
  17549. }
  17550. },
  17551. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17552. },
  17553. "CreateBranchRepoOption": {
  17554. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  17555. "type": "object",
  17556. "required": [
  17557. "new_branch_name"
  17558. ],
  17559. "properties": {
  17560. "new_branch_name": {
  17561. "description": "Name of the branch to create",
  17562. "type": "string",
  17563. "uniqueItems": true,
  17564. "x-go-name": "BranchName"
  17565. },
  17566. "old_branch_name": {
  17567. "description": "Deprecated: true\nName of the old branch to create from",
  17568. "type": "string",
  17569. "uniqueItems": true,
  17570. "x-go-name": "OldBranchName"
  17571. },
  17572. "old_ref_name": {
  17573. "description": "Name of the old branch/tag/commit to create from",
  17574. "type": "string",
  17575. "uniqueItems": true,
  17576. "x-go-name": "OldRefName"
  17577. }
  17578. },
  17579. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17580. },
  17581. "CreateEmailOption": {
  17582. "description": "CreateEmailOption options when creating email addresses",
  17583. "type": "object",
  17584. "properties": {
  17585. "emails": {
  17586. "description": "email addresses to add",
  17587. "type": "array",
  17588. "items": {
  17589. "type": "string"
  17590. },
  17591. "x-go-name": "Emails"
  17592. }
  17593. },
  17594. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17595. },
  17596. "CreateFileOptions": {
  17597. "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)",
  17598. "type": "object",
  17599. "required": [
  17600. "content"
  17601. ],
  17602. "properties": {
  17603. "author": {
  17604. "$ref": "#/definitions/Identity"
  17605. },
  17606. "branch": {
  17607. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  17608. "type": "string",
  17609. "x-go-name": "BranchName"
  17610. },
  17611. "committer": {
  17612. "$ref": "#/definitions/Identity"
  17613. },
  17614. "content": {
  17615. "description": "content must be base64 encoded",
  17616. "type": "string",
  17617. "x-go-name": "ContentBase64"
  17618. },
  17619. "dates": {
  17620. "$ref": "#/definitions/CommitDateOptions"
  17621. },
  17622. "message": {
  17623. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  17624. "type": "string",
  17625. "x-go-name": "Message"
  17626. },
  17627. "new_branch": {
  17628. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  17629. "type": "string",
  17630. "x-go-name": "NewBranchName"
  17631. },
  17632. "signoff": {
  17633. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  17634. "type": "boolean",
  17635. "x-go-name": "Signoff"
  17636. }
  17637. },
  17638. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17639. },
  17640. "CreateForkOption": {
  17641. "description": "CreateForkOption options for creating a fork",
  17642. "type": "object",
  17643. "properties": {
  17644. "name": {
  17645. "description": "name of the forked repository",
  17646. "type": "string",
  17647. "x-go-name": "Name"
  17648. },
  17649. "organization": {
  17650. "description": "organization name, if forking into an organization",
  17651. "type": "string",
  17652. "x-go-name": "Organization"
  17653. }
  17654. },
  17655. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17656. },
  17657. "CreateGPGKeyOption": {
  17658. "description": "CreateGPGKeyOption options create user GPG key",
  17659. "type": "object",
  17660. "required": [
  17661. "armored_public_key"
  17662. ],
  17663. "properties": {
  17664. "armored_public_key": {
  17665. "description": "An armored GPG key to add",
  17666. "type": "string",
  17667. "uniqueItems": true,
  17668. "x-go-name": "ArmoredKey"
  17669. },
  17670. "armored_signature": {
  17671. "type": "string",
  17672. "x-go-name": "Signature"
  17673. }
  17674. },
  17675. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17676. },
  17677. "CreateHookOption": {
  17678. "description": "CreateHookOption options when create a hook",
  17679. "type": "object",
  17680. "required": [
  17681. "type",
  17682. "config"
  17683. ],
  17684. "properties": {
  17685. "active": {
  17686. "type": "boolean",
  17687. "default": false,
  17688. "x-go-name": "Active"
  17689. },
  17690. "authorization_header": {
  17691. "type": "string",
  17692. "x-go-name": "AuthorizationHeader"
  17693. },
  17694. "branch_filter": {
  17695. "type": "string",
  17696. "x-go-name": "BranchFilter"
  17697. },
  17698. "config": {
  17699. "$ref": "#/definitions/CreateHookOptionConfig"
  17700. },
  17701. "events": {
  17702. "type": "array",
  17703. "items": {
  17704. "type": "string"
  17705. },
  17706. "x-go-name": "Events"
  17707. },
  17708. "type": {
  17709. "type": "string",
  17710. "enum": [
  17711. "dingtalk",
  17712. "discord",
  17713. "gitea",
  17714. "gogs",
  17715. "msteams",
  17716. "slack",
  17717. "telegram",
  17718. "feishu",
  17719. "wechatwork",
  17720. "packagist"
  17721. ],
  17722. "x-go-name": "Type"
  17723. }
  17724. },
  17725. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17726. },
  17727. "CreateHookOptionConfig": {
  17728. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  17729. "type": "object",
  17730. "additionalProperties": {
  17731. "type": "string"
  17732. },
  17733. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17734. },
  17735. "CreateIssueCommentOption": {
  17736. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  17737. "type": "object",
  17738. "required": [
  17739. "body"
  17740. ],
  17741. "properties": {
  17742. "body": {
  17743. "type": "string",
  17744. "x-go-name": "Body"
  17745. }
  17746. },
  17747. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17748. },
  17749. "CreateIssueOption": {
  17750. "description": "CreateIssueOption options to create one issue",
  17751. "type": "object",
  17752. "required": [
  17753. "title"
  17754. ],
  17755. "properties": {
  17756. "assignee": {
  17757. "description": "deprecated",
  17758. "type": "string",
  17759. "x-go-name": "Assignee"
  17760. },
  17761. "assignees": {
  17762. "type": "array",
  17763. "items": {
  17764. "type": "string"
  17765. },
  17766. "x-go-name": "Assignees"
  17767. },
  17768. "body": {
  17769. "type": "string",
  17770. "x-go-name": "Body"
  17771. },
  17772. "closed": {
  17773. "type": "boolean",
  17774. "x-go-name": "Closed"
  17775. },
  17776. "due_date": {
  17777. "type": "string",
  17778. "format": "date-time",
  17779. "x-go-name": "Deadline"
  17780. },
  17781. "labels": {
  17782. "description": "list of label ids",
  17783. "type": "array",
  17784. "items": {
  17785. "type": "integer",
  17786. "format": "int64"
  17787. },
  17788. "x-go-name": "Labels"
  17789. },
  17790. "milestone": {
  17791. "description": "milestone id",
  17792. "type": "integer",
  17793. "format": "int64",
  17794. "x-go-name": "Milestone"
  17795. },
  17796. "ref": {
  17797. "type": "string",
  17798. "x-go-name": "Ref"
  17799. },
  17800. "title": {
  17801. "type": "string",
  17802. "x-go-name": "Title"
  17803. }
  17804. },
  17805. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17806. },
  17807. "CreateKeyOption": {
  17808. "description": "CreateKeyOption options when creating a key",
  17809. "type": "object",
  17810. "required": [
  17811. "title",
  17812. "key"
  17813. ],
  17814. "properties": {
  17815. "key": {
  17816. "description": "An armored SSH key to add",
  17817. "type": "string",
  17818. "uniqueItems": true,
  17819. "x-go-name": "Key"
  17820. },
  17821. "read_only": {
  17822. "description": "Describe if the key has only read access or read/write",
  17823. "type": "boolean",
  17824. "x-go-name": "ReadOnly"
  17825. },
  17826. "title": {
  17827. "description": "Title of the key to add",
  17828. "type": "string",
  17829. "uniqueItems": true,
  17830. "x-go-name": "Title"
  17831. }
  17832. },
  17833. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17834. },
  17835. "CreateLabelOption": {
  17836. "description": "CreateLabelOption options for creating a label",
  17837. "type": "object",
  17838. "required": [
  17839. "name",
  17840. "color"
  17841. ],
  17842. "properties": {
  17843. "color": {
  17844. "type": "string",
  17845. "x-go-name": "Color",
  17846. "example": "#00aabb"
  17847. },
  17848. "description": {
  17849. "type": "string",
  17850. "x-go-name": "Description"
  17851. },
  17852. "exclusive": {
  17853. "type": "boolean",
  17854. "x-go-name": "Exclusive",
  17855. "example": false
  17856. },
  17857. "is_archived": {
  17858. "type": "boolean",
  17859. "x-go-name": "IsArchived",
  17860. "example": false
  17861. },
  17862. "name": {
  17863. "type": "string",
  17864. "x-go-name": "Name"
  17865. }
  17866. },
  17867. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17868. },
  17869. "CreateMilestoneOption": {
  17870. "description": "CreateMilestoneOption options for creating a milestone",
  17871. "type": "object",
  17872. "properties": {
  17873. "description": {
  17874. "type": "string",
  17875. "x-go-name": "Description"
  17876. },
  17877. "due_on": {
  17878. "type": "string",
  17879. "format": "date-time",
  17880. "x-go-name": "Deadline"
  17881. },
  17882. "state": {
  17883. "type": "string",
  17884. "enum": [
  17885. "open",
  17886. "closed"
  17887. ],
  17888. "x-go-name": "State"
  17889. },
  17890. "title": {
  17891. "type": "string",
  17892. "x-go-name": "Title"
  17893. }
  17894. },
  17895. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17896. },
  17897. "CreateOAuth2ApplicationOptions": {
  17898. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  17899. "type": "object",
  17900. "properties": {
  17901. "confidential_client": {
  17902. "type": "boolean",
  17903. "x-go-name": "ConfidentialClient"
  17904. },
  17905. "name": {
  17906. "type": "string",
  17907. "x-go-name": "Name"
  17908. },
  17909. "redirect_uris": {
  17910. "type": "array",
  17911. "items": {
  17912. "type": "string"
  17913. },
  17914. "x-go-name": "RedirectURIs"
  17915. }
  17916. },
  17917. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17918. },
  17919. "CreateOrUpdateSecretOption": {
  17920. "description": "CreateOrUpdateSecretOption options when creating or updating secret",
  17921. "type": "object",
  17922. "required": [
  17923. "data"
  17924. ],
  17925. "properties": {
  17926. "data": {
  17927. "description": "Data of the secret to update",
  17928. "type": "string",
  17929. "x-go-name": "Data"
  17930. }
  17931. },
  17932. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17933. },
  17934. "CreateOrgOption": {
  17935. "description": "CreateOrgOption options for creating an organization",
  17936. "type": "object",
  17937. "required": [
  17938. "username"
  17939. ],
  17940. "properties": {
  17941. "description": {
  17942. "type": "string",
  17943. "x-go-name": "Description"
  17944. },
  17945. "email": {
  17946. "type": "string",
  17947. "x-go-name": "Email"
  17948. },
  17949. "full_name": {
  17950. "type": "string",
  17951. "x-go-name": "FullName"
  17952. },
  17953. "location": {
  17954. "type": "string",
  17955. "x-go-name": "Location"
  17956. },
  17957. "repo_admin_change_team_access": {
  17958. "type": "boolean",
  17959. "x-go-name": "RepoAdminChangeTeamAccess"
  17960. },
  17961. "username": {
  17962. "type": "string",
  17963. "x-go-name": "UserName"
  17964. },
  17965. "visibility": {
  17966. "description": "possible values are `public` (default), `limited` or `private`",
  17967. "type": "string",
  17968. "enum": [
  17969. "public",
  17970. "limited",
  17971. "private"
  17972. ],
  17973. "x-go-name": "Visibility"
  17974. },
  17975. "website": {
  17976. "type": "string",
  17977. "x-go-name": "Website"
  17978. }
  17979. },
  17980. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17981. },
  17982. "CreatePullRequestOption": {
  17983. "description": "CreatePullRequestOption options when creating a pull request",
  17984. "type": "object",
  17985. "properties": {
  17986. "assignee": {
  17987. "type": "string",
  17988. "x-go-name": "Assignee"
  17989. },
  17990. "assignees": {
  17991. "type": "array",
  17992. "items": {
  17993. "type": "string"
  17994. },
  17995. "x-go-name": "Assignees"
  17996. },
  17997. "base": {
  17998. "type": "string",
  17999. "x-go-name": "Base"
  18000. },
  18001. "body": {
  18002. "type": "string",
  18003. "x-go-name": "Body"
  18004. },
  18005. "due_date": {
  18006. "type": "string",
  18007. "format": "date-time",
  18008. "x-go-name": "Deadline"
  18009. },
  18010. "head": {
  18011. "type": "string",
  18012. "x-go-name": "Head"
  18013. },
  18014. "labels": {
  18015. "type": "array",
  18016. "items": {
  18017. "type": "integer",
  18018. "format": "int64"
  18019. },
  18020. "x-go-name": "Labels"
  18021. },
  18022. "milestone": {
  18023. "type": "integer",
  18024. "format": "int64",
  18025. "x-go-name": "Milestone"
  18026. },
  18027. "title": {
  18028. "type": "string",
  18029. "x-go-name": "Title"
  18030. }
  18031. },
  18032. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18033. },
  18034. "CreatePullReviewComment": {
  18035. "description": "CreatePullReviewComment represent a review comment for creation api",
  18036. "type": "object",
  18037. "properties": {
  18038. "body": {
  18039. "type": "string",
  18040. "x-go-name": "Body"
  18041. },
  18042. "new_position": {
  18043. "description": "if comment to new file line or 0",
  18044. "type": "integer",
  18045. "format": "int64",
  18046. "x-go-name": "NewLineNum"
  18047. },
  18048. "old_position": {
  18049. "description": "if comment to old file line or 0",
  18050. "type": "integer",
  18051. "format": "int64",
  18052. "x-go-name": "OldLineNum"
  18053. },
  18054. "path": {
  18055. "description": "the tree path",
  18056. "type": "string",
  18057. "x-go-name": "Path"
  18058. }
  18059. },
  18060. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18061. },
  18062. "CreatePullReviewOptions": {
  18063. "description": "CreatePullReviewOptions are options to create a pull review",
  18064. "type": "object",
  18065. "properties": {
  18066. "body": {
  18067. "type": "string",
  18068. "x-go-name": "Body"
  18069. },
  18070. "comments": {
  18071. "type": "array",
  18072. "items": {
  18073. "$ref": "#/definitions/CreatePullReviewComment"
  18074. },
  18075. "x-go-name": "Comments"
  18076. },
  18077. "commit_id": {
  18078. "type": "string",
  18079. "x-go-name": "CommitID"
  18080. },
  18081. "event": {
  18082. "$ref": "#/definitions/ReviewStateType"
  18083. }
  18084. },
  18085. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18086. },
  18087. "CreatePushMirrorOption": {
  18088. "type": "object",
  18089. "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
  18090. "properties": {
  18091. "interval": {
  18092. "type": "string",
  18093. "x-go-name": "Interval"
  18094. },
  18095. "remote_address": {
  18096. "type": "string",
  18097. "x-go-name": "RemoteAddress"
  18098. },
  18099. "remote_password": {
  18100. "type": "string",
  18101. "x-go-name": "RemotePassword"
  18102. },
  18103. "remote_username": {
  18104. "type": "string",
  18105. "x-go-name": "RemoteUsername"
  18106. },
  18107. "sync_on_commit": {
  18108. "type": "boolean",
  18109. "x-go-name": "SyncOnCommit"
  18110. }
  18111. },
  18112. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18113. },
  18114. "CreateReleaseOption": {
  18115. "description": "CreateReleaseOption options when creating a release",
  18116. "type": "object",
  18117. "required": [
  18118. "tag_name"
  18119. ],
  18120. "properties": {
  18121. "body": {
  18122. "type": "string",
  18123. "x-go-name": "Note"
  18124. },
  18125. "draft": {
  18126. "type": "boolean",
  18127. "x-go-name": "IsDraft"
  18128. },
  18129. "name": {
  18130. "type": "string",
  18131. "x-go-name": "Title"
  18132. },
  18133. "prerelease": {
  18134. "type": "boolean",
  18135. "x-go-name": "IsPrerelease"
  18136. },
  18137. "tag_name": {
  18138. "type": "string",
  18139. "x-go-name": "TagName"
  18140. },
  18141. "target_commitish": {
  18142. "type": "string",
  18143. "x-go-name": "Target"
  18144. }
  18145. },
  18146. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18147. },
  18148. "CreateRepoOption": {
  18149. "description": "CreateRepoOption options when creating repository",
  18150. "type": "object",
  18151. "required": [
  18152. "name"
  18153. ],
  18154. "properties": {
  18155. "auto_init": {
  18156. "description": "Whether the repository should be auto-initialized?",
  18157. "type": "boolean",
  18158. "x-go-name": "AutoInit"
  18159. },
  18160. "default_branch": {
  18161. "description": "DefaultBranch of the repository (used when initializes and in template)",
  18162. "type": "string",
  18163. "x-go-name": "DefaultBranch"
  18164. },
  18165. "description": {
  18166. "description": "Description of the repository to create",
  18167. "type": "string",
  18168. "x-go-name": "Description"
  18169. },
  18170. "gitignores": {
  18171. "description": "Gitignores to use",
  18172. "type": "string",
  18173. "x-go-name": "Gitignores"
  18174. },
  18175. "issue_labels": {
  18176. "description": "Label-Set to use",
  18177. "type": "string",
  18178. "x-go-name": "IssueLabels"
  18179. },
  18180. "license": {
  18181. "description": "License to use",
  18182. "type": "string",
  18183. "x-go-name": "License"
  18184. },
  18185. "name": {
  18186. "description": "Name of the repository to create",
  18187. "type": "string",
  18188. "uniqueItems": true,
  18189. "x-go-name": "Name"
  18190. },
  18191. "private": {
  18192. "description": "Whether the repository is private",
  18193. "type": "boolean",
  18194. "x-go-name": "Private"
  18195. },
  18196. "readme": {
  18197. "description": "Readme of the repository to create",
  18198. "type": "string",
  18199. "x-go-name": "Readme"
  18200. },
  18201. "template": {
  18202. "description": "Whether the repository is template",
  18203. "type": "boolean",
  18204. "x-go-name": "Template"
  18205. },
  18206. "trust_model": {
  18207. "description": "TrustModel of the repository",
  18208. "type": "string",
  18209. "enum": [
  18210. "default",
  18211. "collaborator",
  18212. "committer",
  18213. "collaboratorcommitter"
  18214. ],
  18215. "x-go-name": "TrustModel"
  18216. }
  18217. },
  18218. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18219. },
  18220. "CreateStatusOption": {
  18221. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  18222. "type": "object",
  18223. "properties": {
  18224. "context": {
  18225. "type": "string",
  18226. "x-go-name": "Context"
  18227. },
  18228. "description": {
  18229. "type": "string",
  18230. "x-go-name": "Description"
  18231. },
  18232. "state": {
  18233. "$ref": "#/definitions/CommitStatusState"
  18234. },
  18235. "target_url": {
  18236. "type": "string",
  18237. "x-go-name": "TargetURL"
  18238. }
  18239. },
  18240. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18241. },
  18242. "CreateTagOption": {
  18243. "description": "CreateTagOption options when creating a tag",
  18244. "type": "object",
  18245. "required": [
  18246. "tag_name"
  18247. ],
  18248. "properties": {
  18249. "message": {
  18250. "type": "string",
  18251. "x-go-name": "Message"
  18252. },
  18253. "tag_name": {
  18254. "type": "string",
  18255. "x-go-name": "TagName"
  18256. },
  18257. "target": {
  18258. "type": "string",
  18259. "x-go-name": "Target"
  18260. }
  18261. },
  18262. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18263. },
  18264. "CreateTeamOption": {
  18265. "description": "CreateTeamOption options for creating a team",
  18266. "type": "object",
  18267. "required": [
  18268. "name"
  18269. ],
  18270. "properties": {
  18271. "can_create_org_repo": {
  18272. "type": "boolean",
  18273. "x-go-name": "CanCreateOrgRepo"
  18274. },
  18275. "description": {
  18276. "type": "string",
  18277. "x-go-name": "Description"
  18278. },
  18279. "includes_all_repositories": {
  18280. "type": "boolean",
  18281. "x-go-name": "IncludesAllRepositories"
  18282. },
  18283. "name": {
  18284. "type": "string",
  18285. "x-go-name": "Name"
  18286. },
  18287. "permission": {
  18288. "type": "string",
  18289. "enum": [
  18290. "read",
  18291. "write",
  18292. "admin"
  18293. ],
  18294. "x-go-name": "Permission"
  18295. },
  18296. "units": {
  18297. "type": "array",
  18298. "items": {
  18299. "type": "string"
  18300. },
  18301. "x-go-name": "Units",
  18302. "example": [
  18303. "repo.actions",
  18304. "repo.code",
  18305. "repo.issues",
  18306. "repo.ext_issues",
  18307. "repo.wiki",
  18308. "repo.ext_wiki",
  18309. "repo.pulls",
  18310. "repo.releases",
  18311. "repo.projects",
  18312. "repo.ext_wiki"
  18313. ]
  18314. },
  18315. "units_map": {
  18316. "type": "object",
  18317. "additionalProperties": {
  18318. "type": "string"
  18319. },
  18320. "x-go-name": "UnitsMap",
  18321. "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\"}"
  18322. }
  18323. },
  18324. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18325. },
  18326. "CreateUserOption": {
  18327. "description": "CreateUserOption create user options",
  18328. "type": "object",
  18329. "required": [
  18330. "username",
  18331. "email"
  18332. ],
  18333. "properties": {
  18334. "created_at": {
  18335. "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\".",
  18336. "type": "string",
  18337. "format": "date-time",
  18338. "x-go-name": "Created"
  18339. },
  18340. "email": {
  18341. "type": "string",
  18342. "format": "email",
  18343. "x-go-name": "Email"
  18344. },
  18345. "full_name": {
  18346. "type": "string",
  18347. "x-go-name": "FullName"
  18348. },
  18349. "login_name": {
  18350. "type": "string",
  18351. "x-go-name": "LoginName"
  18352. },
  18353. "must_change_password": {
  18354. "type": "boolean",
  18355. "x-go-name": "MustChangePassword"
  18356. },
  18357. "password": {
  18358. "type": "string",
  18359. "x-go-name": "Password"
  18360. },
  18361. "restricted": {
  18362. "type": "boolean",
  18363. "x-go-name": "Restricted"
  18364. },
  18365. "send_notify": {
  18366. "type": "boolean",
  18367. "x-go-name": "SendNotify"
  18368. },
  18369. "source_id": {
  18370. "type": "integer",
  18371. "format": "int64",
  18372. "x-go-name": "SourceID"
  18373. },
  18374. "username": {
  18375. "type": "string",
  18376. "x-go-name": "Username"
  18377. },
  18378. "visibility": {
  18379. "type": "string",
  18380. "x-go-name": "Visibility"
  18381. }
  18382. },
  18383. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18384. },
  18385. "CreateWikiPageOptions": {
  18386. "description": "CreateWikiPageOptions form for creating wiki",
  18387. "type": "object",
  18388. "properties": {
  18389. "content_base64": {
  18390. "description": "content must be base64 encoded",
  18391. "type": "string",
  18392. "x-go-name": "ContentBase64"
  18393. },
  18394. "message": {
  18395. "description": "optional commit message summarizing the change",
  18396. "type": "string",
  18397. "x-go-name": "Message"
  18398. },
  18399. "title": {
  18400. "description": "page title. leave empty to keep unchanged",
  18401. "type": "string",
  18402. "x-go-name": "Title"
  18403. }
  18404. },
  18405. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18406. },
  18407. "Cron": {
  18408. "description": "Cron represents a Cron task",
  18409. "type": "object",
  18410. "properties": {
  18411. "exec_times": {
  18412. "type": "integer",
  18413. "format": "int64",
  18414. "x-go-name": "ExecTimes"
  18415. },
  18416. "name": {
  18417. "type": "string",
  18418. "x-go-name": "Name"
  18419. },
  18420. "next": {
  18421. "type": "string",
  18422. "format": "date-time",
  18423. "x-go-name": "Next"
  18424. },
  18425. "prev": {
  18426. "type": "string",
  18427. "format": "date-time",
  18428. "x-go-name": "Prev"
  18429. },
  18430. "schedule": {
  18431. "type": "string",
  18432. "x-go-name": "Schedule"
  18433. }
  18434. },
  18435. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18436. },
  18437. "DeleteEmailOption": {
  18438. "description": "DeleteEmailOption options when deleting email addresses",
  18439. "type": "object",
  18440. "properties": {
  18441. "emails": {
  18442. "description": "email addresses to delete",
  18443. "type": "array",
  18444. "items": {
  18445. "type": "string"
  18446. },
  18447. "x-go-name": "Emails"
  18448. }
  18449. },
  18450. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18451. },
  18452. "DeleteFileOptions": {
  18453. "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)",
  18454. "type": "object",
  18455. "required": [
  18456. "sha"
  18457. ],
  18458. "properties": {
  18459. "author": {
  18460. "$ref": "#/definitions/Identity"
  18461. },
  18462. "branch": {
  18463. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  18464. "type": "string",
  18465. "x-go-name": "BranchName"
  18466. },
  18467. "committer": {
  18468. "$ref": "#/definitions/Identity"
  18469. },
  18470. "dates": {
  18471. "$ref": "#/definitions/CommitDateOptions"
  18472. },
  18473. "message": {
  18474. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  18475. "type": "string",
  18476. "x-go-name": "Message"
  18477. },
  18478. "new_branch": {
  18479. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  18480. "type": "string",
  18481. "x-go-name": "NewBranchName"
  18482. },
  18483. "sha": {
  18484. "description": "sha is the SHA for the file that already exists",
  18485. "type": "string",
  18486. "x-go-name": "SHA"
  18487. },
  18488. "signoff": {
  18489. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  18490. "type": "boolean",
  18491. "x-go-name": "Signoff"
  18492. }
  18493. },
  18494. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18495. },
  18496. "DeployKey": {
  18497. "description": "DeployKey a deploy key",
  18498. "type": "object",
  18499. "properties": {
  18500. "created_at": {
  18501. "type": "string",
  18502. "format": "date-time",
  18503. "x-go-name": "Created"
  18504. },
  18505. "fingerprint": {
  18506. "type": "string",
  18507. "x-go-name": "Fingerprint"
  18508. },
  18509. "id": {
  18510. "type": "integer",
  18511. "format": "int64",
  18512. "x-go-name": "ID"
  18513. },
  18514. "key": {
  18515. "type": "string",
  18516. "x-go-name": "Key"
  18517. },
  18518. "key_id": {
  18519. "type": "integer",
  18520. "format": "int64",
  18521. "x-go-name": "KeyID"
  18522. },
  18523. "read_only": {
  18524. "type": "boolean",
  18525. "x-go-name": "ReadOnly"
  18526. },
  18527. "repository": {
  18528. "$ref": "#/definitions/Repository"
  18529. },
  18530. "title": {
  18531. "type": "string",
  18532. "x-go-name": "Title"
  18533. },
  18534. "url": {
  18535. "type": "string",
  18536. "x-go-name": "URL"
  18537. }
  18538. },
  18539. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18540. },
  18541. "DismissPullReviewOptions": {
  18542. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  18543. "type": "object",
  18544. "properties": {
  18545. "message": {
  18546. "type": "string",
  18547. "x-go-name": "Message"
  18548. },
  18549. "priors": {
  18550. "type": "boolean",
  18551. "x-go-name": "Priors"
  18552. }
  18553. },
  18554. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18555. },
  18556. "EditAttachmentOptions": {
  18557. "description": "EditAttachmentOptions options for editing attachments",
  18558. "type": "object",
  18559. "properties": {
  18560. "name": {
  18561. "type": "string",
  18562. "x-go-name": "Name"
  18563. }
  18564. },
  18565. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18566. },
  18567. "EditBranchProtectionOption": {
  18568. "description": "EditBranchProtectionOption options for editing a branch protection",
  18569. "type": "object",
  18570. "properties": {
  18571. "approvals_whitelist_teams": {
  18572. "type": "array",
  18573. "items": {
  18574. "type": "string"
  18575. },
  18576. "x-go-name": "ApprovalsWhitelistTeams"
  18577. },
  18578. "approvals_whitelist_username": {
  18579. "type": "array",
  18580. "items": {
  18581. "type": "string"
  18582. },
  18583. "x-go-name": "ApprovalsWhitelistUsernames"
  18584. },
  18585. "block_on_official_review_requests": {
  18586. "type": "boolean",
  18587. "x-go-name": "BlockOnOfficialReviewRequests"
  18588. },
  18589. "block_on_outdated_branch": {
  18590. "type": "boolean",
  18591. "x-go-name": "BlockOnOutdatedBranch"
  18592. },
  18593. "block_on_rejected_reviews": {
  18594. "type": "boolean",
  18595. "x-go-name": "BlockOnRejectedReviews"
  18596. },
  18597. "dismiss_stale_approvals": {
  18598. "type": "boolean",
  18599. "x-go-name": "DismissStaleApprovals"
  18600. },
  18601. "enable_approvals_whitelist": {
  18602. "type": "boolean",
  18603. "x-go-name": "EnableApprovalsWhitelist"
  18604. },
  18605. "enable_merge_whitelist": {
  18606. "type": "boolean",
  18607. "x-go-name": "EnableMergeWhitelist"
  18608. },
  18609. "enable_push": {
  18610. "type": "boolean",
  18611. "x-go-name": "EnablePush"
  18612. },
  18613. "enable_push_whitelist": {
  18614. "type": "boolean",
  18615. "x-go-name": "EnablePushWhitelist"
  18616. },
  18617. "enable_status_check": {
  18618. "type": "boolean",
  18619. "x-go-name": "EnableStatusCheck"
  18620. },
  18621. "merge_whitelist_teams": {
  18622. "type": "array",
  18623. "items": {
  18624. "type": "string"
  18625. },
  18626. "x-go-name": "MergeWhitelistTeams"
  18627. },
  18628. "merge_whitelist_usernames": {
  18629. "type": "array",
  18630. "items": {
  18631. "type": "string"
  18632. },
  18633. "x-go-name": "MergeWhitelistUsernames"
  18634. },
  18635. "protected_file_patterns": {
  18636. "type": "string",
  18637. "x-go-name": "ProtectedFilePatterns"
  18638. },
  18639. "push_whitelist_deploy_keys": {
  18640. "type": "boolean",
  18641. "x-go-name": "PushWhitelistDeployKeys"
  18642. },
  18643. "push_whitelist_teams": {
  18644. "type": "array",
  18645. "items": {
  18646. "type": "string"
  18647. },
  18648. "x-go-name": "PushWhitelistTeams"
  18649. },
  18650. "push_whitelist_usernames": {
  18651. "type": "array",
  18652. "items": {
  18653. "type": "string"
  18654. },
  18655. "x-go-name": "PushWhitelistUsernames"
  18656. },
  18657. "require_signed_commits": {
  18658. "type": "boolean",
  18659. "x-go-name": "RequireSignedCommits"
  18660. },
  18661. "required_approvals": {
  18662. "type": "integer",
  18663. "format": "int64",
  18664. "x-go-name": "RequiredApprovals"
  18665. },
  18666. "status_check_contexts": {
  18667. "type": "array",
  18668. "items": {
  18669. "type": "string"
  18670. },
  18671. "x-go-name": "StatusCheckContexts"
  18672. },
  18673. "unprotected_file_patterns": {
  18674. "type": "string",
  18675. "x-go-name": "UnprotectedFilePatterns"
  18676. }
  18677. },
  18678. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18679. },
  18680. "EditDeadlineOption": {
  18681. "description": "EditDeadlineOption options for creating a deadline",
  18682. "type": "object",
  18683. "required": [
  18684. "due_date"
  18685. ],
  18686. "properties": {
  18687. "due_date": {
  18688. "type": "string",
  18689. "format": "date-time",
  18690. "x-go-name": "Deadline"
  18691. }
  18692. },
  18693. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18694. },
  18695. "EditGitHookOption": {
  18696. "description": "EditGitHookOption options when modifying one Git hook",
  18697. "type": "object",
  18698. "properties": {
  18699. "content": {
  18700. "type": "string",
  18701. "x-go-name": "Content"
  18702. }
  18703. },
  18704. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18705. },
  18706. "EditHookOption": {
  18707. "description": "EditHookOption options when modify one hook",
  18708. "type": "object",
  18709. "properties": {
  18710. "active": {
  18711. "type": "boolean",
  18712. "x-go-name": "Active"
  18713. },
  18714. "authorization_header": {
  18715. "type": "string",
  18716. "x-go-name": "AuthorizationHeader"
  18717. },
  18718. "branch_filter": {
  18719. "type": "string",
  18720. "x-go-name": "BranchFilter"
  18721. },
  18722. "config": {
  18723. "type": "object",
  18724. "additionalProperties": {
  18725. "type": "string"
  18726. },
  18727. "x-go-name": "Config"
  18728. },
  18729. "events": {
  18730. "type": "array",
  18731. "items": {
  18732. "type": "string"
  18733. },
  18734. "x-go-name": "Events"
  18735. }
  18736. },
  18737. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18738. },
  18739. "EditIssueCommentOption": {
  18740. "description": "EditIssueCommentOption options for editing a comment",
  18741. "type": "object",
  18742. "required": [
  18743. "body"
  18744. ],
  18745. "properties": {
  18746. "body": {
  18747. "type": "string",
  18748. "x-go-name": "Body"
  18749. }
  18750. },
  18751. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18752. },
  18753. "EditIssueOption": {
  18754. "description": "EditIssueOption options for editing an issue",
  18755. "type": "object",
  18756. "properties": {
  18757. "assignee": {
  18758. "description": "deprecated",
  18759. "type": "string",
  18760. "x-go-name": "Assignee"
  18761. },
  18762. "assignees": {
  18763. "type": "array",
  18764. "items": {
  18765. "type": "string"
  18766. },
  18767. "x-go-name": "Assignees"
  18768. },
  18769. "body": {
  18770. "type": "string",
  18771. "x-go-name": "Body"
  18772. },
  18773. "due_date": {
  18774. "type": "string",
  18775. "format": "date-time",
  18776. "x-go-name": "Deadline"
  18777. },
  18778. "milestone": {
  18779. "type": "integer",
  18780. "format": "int64",
  18781. "x-go-name": "Milestone"
  18782. },
  18783. "ref": {
  18784. "type": "string",
  18785. "x-go-name": "Ref"
  18786. },
  18787. "state": {
  18788. "type": "string",
  18789. "x-go-name": "State"
  18790. },
  18791. "title": {
  18792. "type": "string",
  18793. "x-go-name": "Title"
  18794. },
  18795. "unset_due_date": {
  18796. "type": "boolean",
  18797. "x-go-name": "RemoveDeadline"
  18798. }
  18799. },
  18800. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18801. },
  18802. "EditLabelOption": {
  18803. "description": "EditLabelOption options for editing a label",
  18804. "type": "object",
  18805. "properties": {
  18806. "color": {
  18807. "type": "string",
  18808. "x-go-name": "Color",
  18809. "example": "#00aabb"
  18810. },
  18811. "description": {
  18812. "type": "string",
  18813. "x-go-name": "Description"
  18814. },
  18815. "exclusive": {
  18816. "type": "boolean",
  18817. "x-go-name": "Exclusive",
  18818. "example": false
  18819. },
  18820. "is_archived": {
  18821. "type": "boolean",
  18822. "x-go-name": "IsArchived",
  18823. "example": false
  18824. },
  18825. "name": {
  18826. "type": "string",
  18827. "x-go-name": "Name"
  18828. }
  18829. },
  18830. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18831. },
  18832. "EditMilestoneOption": {
  18833. "description": "EditMilestoneOption options for editing a milestone",
  18834. "type": "object",
  18835. "properties": {
  18836. "description": {
  18837. "type": "string",
  18838. "x-go-name": "Description"
  18839. },
  18840. "due_on": {
  18841. "type": "string",
  18842. "format": "date-time",
  18843. "x-go-name": "Deadline"
  18844. },
  18845. "state": {
  18846. "type": "string",
  18847. "x-go-name": "State"
  18848. },
  18849. "title": {
  18850. "type": "string",
  18851. "x-go-name": "Title"
  18852. }
  18853. },
  18854. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18855. },
  18856. "EditOrgOption": {
  18857. "description": "EditOrgOption options for editing an organization",
  18858. "type": "object",
  18859. "properties": {
  18860. "description": {
  18861. "type": "string",
  18862. "x-go-name": "Description"
  18863. },
  18864. "email": {
  18865. "type": "string",
  18866. "x-go-name": "Email"
  18867. },
  18868. "full_name": {
  18869. "type": "string",
  18870. "x-go-name": "FullName"
  18871. },
  18872. "location": {
  18873. "type": "string",
  18874. "x-go-name": "Location"
  18875. },
  18876. "repo_admin_change_team_access": {
  18877. "type": "boolean",
  18878. "x-go-name": "RepoAdminChangeTeamAccess"
  18879. },
  18880. "visibility": {
  18881. "description": "possible values are `public`, `limited` or `private`",
  18882. "type": "string",
  18883. "enum": [
  18884. "public",
  18885. "limited",
  18886. "private"
  18887. ],
  18888. "x-go-name": "Visibility"
  18889. },
  18890. "website": {
  18891. "type": "string",
  18892. "x-go-name": "Website"
  18893. }
  18894. },
  18895. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18896. },
  18897. "EditPullRequestOption": {
  18898. "description": "EditPullRequestOption options when modify pull request",
  18899. "type": "object",
  18900. "properties": {
  18901. "allow_maintainer_edit": {
  18902. "type": "boolean",
  18903. "x-go-name": "AllowMaintainerEdit"
  18904. },
  18905. "assignee": {
  18906. "type": "string",
  18907. "x-go-name": "Assignee"
  18908. },
  18909. "assignees": {
  18910. "type": "array",
  18911. "items": {
  18912. "type": "string"
  18913. },
  18914. "x-go-name": "Assignees"
  18915. },
  18916. "base": {
  18917. "type": "string",
  18918. "x-go-name": "Base"
  18919. },
  18920. "body": {
  18921. "type": "string",
  18922. "x-go-name": "Body"
  18923. },
  18924. "due_date": {
  18925. "type": "string",
  18926. "format": "date-time",
  18927. "x-go-name": "Deadline"
  18928. },
  18929. "labels": {
  18930. "type": "array",
  18931. "items": {
  18932. "type": "integer",
  18933. "format": "int64"
  18934. },
  18935. "x-go-name": "Labels"
  18936. },
  18937. "milestone": {
  18938. "type": "integer",
  18939. "format": "int64",
  18940. "x-go-name": "Milestone"
  18941. },
  18942. "state": {
  18943. "type": "string",
  18944. "x-go-name": "State"
  18945. },
  18946. "title": {
  18947. "type": "string",
  18948. "x-go-name": "Title"
  18949. },
  18950. "unset_due_date": {
  18951. "type": "boolean",
  18952. "x-go-name": "RemoveDeadline"
  18953. }
  18954. },
  18955. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18956. },
  18957. "EditReactionOption": {
  18958. "description": "EditReactionOption contain the reaction type",
  18959. "type": "object",
  18960. "properties": {
  18961. "content": {
  18962. "type": "string",
  18963. "x-go-name": "Reaction"
  18964. }
  18965. },
  18966. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18967. },
  18968. "EditReleaseOption": {
  18969. "description": "EditReleaseOption options when editing a release",
  18970. "type": "object",
  18971. "properties": {
  18972. "body": {
  18973. "type": "string",
  18974. "x-go-name": "Note"
  18975. },
  18976. "draft": {
  18977. "type": "boolean",
  18978. "x-go-name": "IsDraft"
  18979. },
  18980. "name": {
  18981. "type": "string",
  18982. "x-go-name": "Title"
  18983. },
  18984. "prerelease": {
  18985. "type": "boolean",
  18986. "x-go-name": "IsPrerelease"
  18987. },
  18988. "tag_name": {
  18989. "type": "string",
  18990. "x-go-name": "TagName"
  18991. },
  18992. "target_commitish": {
  18993. "type": "string",
  18994. "x-go-name": "Target"
  18995. }
  18996. },
  18997. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18998. },
  18999. "EditRepoOption": {
  19000. "description": "EditRepoOption options when editing a repository's properties",
  19001. "type": "object",
  19002. "properties": {
  19003. "allow_manual_merge": {
  19004. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
  19005. "type": "boolean",
  19006. "x-go-name": "AllowManualMerge"
  19007. },
  19008. "allow_merge_commits": {
  19009. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  19010. "type": "boolean",
  19011. "x-go-name": "AllowMerge"
  19012. },
  19013. "allow_rebase": {
  19014. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  19015. "type": "boolean",
  19016. "x-go-name": "AllowRebase"
  19017. },
  19018. "allow_rebase_explicit": {
  19019. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
  19020. "type": "boolean",
  19021. "x-go-name": "AllowRebaseMerge"
  19022. },
  19023. "allow_rebase_update": {
  19024. "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
  19025. "type": "boolean",
  19026. "x-go-name": "AllowRebaseUpdate"
  19027. },
  19028. "allow_squash_merge": {
  19029. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  19030. "type": "boolean",
  19031. "x-go-name": "AllowSquash"
  19032. },
  19033. "archived": {
  19034. "description": "set to `true` to archive this repository.",
  19035. "type": "boolean",
  19036. "x-go-name": "Archived"
  19037. },
  19038. "autodetect_manual_merge": {
  19039. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
  19040. "type": "boolean",
  19041. "x-go-name": "AutodetectManualMerge"
  19042. },
  19043. "default_allow_maintainer_edit": {
  19044. "description": "set to `true` to allow edits from maintainers by default",
  19045. "type": "boolean",
  19046. "x-go-name": "DefaultAllowMaintainerEdit"
  19047. },
  19048. "default_branch": {
  19049. "description": "sets the default branch for this repository.",
  19050. "type": "string",
  19051. "x-go-name": "DefaultBranch"
  19052. },
  19053. "default_delete_branch_after_merge": {
  19054. "description": "set to `true` to delete pr branch after merge by default",
  19055. "type": "boolean",
  19056. "x-go-name": "DefaultDeleteBranchAfterMerge"
  19057. },
  19058. "default_merge_style": {
  19059. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", or \"squash\".",
  19060. "type": "string",
  19061. "x-go-name": "DefaultMergeStyle"
  19062. },
  19063. "description": {
  19064. "description": "a short description of the repository.",
  19065. "type": "string",
  19066. "x-go-name": "Description"
  19067. },
  19068. "enable_prune": {
  19069. "description": "enable prune - remove obsolete remote-tracking references",
  19070. "type": "boolean",
  19071. "x-go-name": "EnablePrune"
  19072. },
  19073. "external_tracker": {
  19074. "$ref": "#/definitions/ExternalTracker"
  19075. },
  19076. "external_wiki": {
  19077. "$ref": "#/definitions/ExternalWiki"
  19078. },
  19079. "has_actions": {
  19080. "description": "either `true` to enable actions unit, or `false` to disable them.",
  19081. "type": "boolean",
  19082. "x-go-name": "HasActions"
  19083. },
  19084. "has_issues": {
  19085. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  19086. "type": "boolean",
  19087. "x-go-name": "HasIssues"
  19088. },
  19089. "has_packages": {
  19090. "description": "either `true` to enable packages unit, or `false` to disable them.",
  19091. "type": "boolean",
  19092. "x-go-name": "HasPackages"
  19093. },
  19094. "has_projects": {
  19095. "description": "either `true` to enable project unit, or `false` to disable them.",
  19096. "type": "boolean",
  19097. "x-go-name": "HasProjects"
  19098. },
  19099. "has_pull_requests": {
  19100. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  19101. "type": "boolean",
  19102. "x-go-name": "HasPullRequests"
  19103. },
  19104. "has_releases": {
  19105. "description": "either `true` to enable releases unit, or `false` to disable them.",
  19106. "type": "boolean",
  19107. "x-go-name": "HasReleases"
  19108. },
  19109. "has_wiki": {
  19110. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  19111. "type": "boolean",
  19112. "x-go-name": "HasWiki"
  19113. },
  19114. "ignore_whitespace_conflicts": {
  19115. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
  19116. "type": "boolean",
  19117. "x-go-name": "IgnoreWhitespaceConflicts"
  19118. },
  19119. "internal_tracker": {
  19120. "$ref": "#/definitions/InternalTracker"
  19121. },
  19122. "mirror_interval": {
  19123. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  19124. "type": "string",
  19125. "x-go-name": "MirrorInterval"
  19126. },
  19127. "name": {
  19128. "description": "name of the repository",
  19129. "type": "string",
  19130. "uniqueItems": true,
  19131. "x-go-name": "Name"
  19132. },
  19133. "private": {
  19134. "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.",
  19135. "type": "boolean",
  19136. "x-go-name": "Private"
  19137. },
  19138. "template": {
  19139. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  19140. "type": "boolean",
  19141. "x-go-name": "Template"
  19142. },
  19143. "website": {
  19144. "description": "a URL with more information about the repository.",
  19145. "type": "string",
  19146. "x-go-name": "Website"
  19147. }
  19148. },
  19149. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19150. },
  19151. "EditTeamOption": {
  19152. "description": "EditTeamOption options for editing a team",
  19153. "type": "object",
  19154. "required": [
  19155. "name"
  19156. ],
  19157. "properties": {
  19158. "can_create_org_repo": {
  19159. "type": "boolean",
  19160. "x-go-name": "CanCreateOrgRepo"
  19161. },
  19162. "description": {
  19163. "type": "string",
  19164. "x-go-name": "Description"
  19165. },
  19166. "includes_all_repositories": {
  19167. "type": "boolean",
  19168. "x-go-name": "IncludesAllRepositories"
  19169. },
  19170. "name": {
  19171. "type": "string",
  19172. "x-go-name": "Name"
  19173. },
  19174. "permission": {
  19175. "type": "string",
  19176. "enum": [
  19177. "read",
  19178. "write",
  19179. "admin"
  19180. ],
  19181. "x-go-name": "Permission"
  19182. },
  19183. "units": {
  19184. "type": "array",
  19185. "items": {
  19186. "type": "string"
  19187. },
  19188. "x-go-name": "Units",
  19189. "example": [
  19190. "repo.code",
  19191. "repo.issues",
  19192. "repo.ext_issues",
  19193. "repo.wiki",
  19194. "repo.pulls",
  19195. "repo.releases",
  19196. "repo.projects",
  19197. "repo.ext_wiki"
  19198. ]
  19199. },
  19200. "units_map": {
  19201. "type": "object",
  19202. "additionalProperties": {
  19203. "type": "string"
  19204. },
  19205. "x-go-name": "UnitsMap",
  19206. "example": {
  19207. "repo.code": "read",
  19208. "repo.ext_issues": "none",
  19209. "repo.ext_wiki": "none",
  19210. "repo.issues": "write",
  19211. "repo.projects": "none",
  19212. "repo.pulls": "owner",
  19213. "repo.releases": "none",
  19214. "repo.wiki": "admin"
  19215. }
  19216. }
  19217. },
  19218. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19219. },
  19220. "EditUserOption": {
  19221. "description": "EditUserOption edit user options",
  19222. "type": "object",
  19223. "required": [
  19224. "source_id",
  19225. "login_name"
  19226. ],
  19227. "properties": {
  19228. "active": {
  19229. "type": "boolean",
  19230. "x-go-name": "Active"
  19231. },
  19232. "admin": {
  19233. "type": "boolean",
  19234. "x-go-name": "Admin"
  19235. },
  19236. "allow_create_organization": {
  19237. "type": "boolean",
  19238. "x-go-name": "AllowCreateOrganization"
  19239. },
  19240. "allow_git_hook": {
  19241. "type": "boolean",
  19242. "x-go-name": "AllowGitHook"
  19243. },
  19244. "allow_import_local": {
  19245. "type": "boolean",
  19246. "x-go-name": "AllowImportLocal"
  19247. },
  19248. "description": {
  19249. "type": "string",
  19250. "x-go-name": "Description"
  19251. },
  19252. "email": {
  19253. "type": "string",
  19254. "format": "email",
  19255. "x-go-name": "Email"
  19256. },
  19257. "full_name": {
  19258. "type": "string",
  19259. "x-go-name": "FullName"
  19260. },
  19261. "location": {
  19262. "type": "string",
  19263. "x-go-name": "Location"
  19264. },
  19265. "login_name": {
  19266. "type": "string",
  19267. "x-go-name": "LoginName"
  19268. },
  19269. "max_repo_creation": {
  19270. "type": "integer",
  19271. "format": "int64",
  19272. "x-go-name": "MaxRepoCreation"
  19273. },
  19274. "must_change_password": {
  19275. "type": "boolean",
  19276. "x-go-name": "MustChangePassword"
  19277. },
  19278. "password": {
  19279. "type": "string",
  19280. "x-go-name": "Password"
  19281. },
  19282. "prohibit_login": {
  19283. "type": "boolean",
  19284. "x-go-name": "ProhibitLogin"
  19285. },
  19286. "restricted": {
  19287. "type": "boolean",
  19288. "x-go-name": "Restricted"
  19289. },
  19290. "source_id": {
  19291. "type": "integer",
  19292. "format": "int64",
  19293. "x-go-name": "SourceID"
  19294. },
  19295. "visibility": {
  19296. "type": "string",
  19297. "x-go-name": "Visibility"
  19298. },
  19299. "website": {
  19300. "type": "string",
  19301. "x-go-name": "Website"
  19302. }
  19303. },
  19304. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19305. },
  19306. "Email": {
  19307. "description": "Email an email address belonging to a user",
  19308. "type": "object",
  19309. "properties": {
  19310. "email": {
  19311. "type": "string",
  19312. "format": "email",
  19313. "x-go-name": "Email"
  19314. },
  19315. "primary": {
  19316. "type": "boolean",
  19317. "x-go-name": "Primary"
  19318. },
  19319. "user_id": {
  19320. "type": "integer",
  19321. "format": "int64",
  19322. "x-go-name": "UserID"
  19323. },
  19324. "username": {
  19325. "type": "string",
  19326. "x-go-name": "UserName"
  19327. },
  19328. "verified": {
  19329. "type": "boolean",
  19330. "x-go-name": "Verified"
  19331. }
  19332. },
  19333. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19334. },
  19335. "ExternalTracker": {
  19336. "description": "ExternalTracker represents settings for external tracker",
  19337. "type": "object",
  19338. "properties": {
  19339. "external_tracker_format": {
  19340. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  19341. "type": "string",
  19342. "x-go-name": "ExternalTrackerFormat"
  19343. },
  19344. "external_tracker_regexp_pattern": {
  19345. "description": "External Issue Tracker issue regular expression",
  19346. "type": "string",
  19347. "x-go-name": "ExternalTrackerRegexpPattern"
  19348. },
  19349. "external_tracker_style": {
  19350. "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
  19351. "type": "string",
  19352. "x-go-name": "ExternalTrackerStyle"
  19353. },
  19354. "external_tracker_url": {
  19355. "description": "URL of external issue tracker.",
  19356. "type": "string",
  19357. "x-go-name": "ExternalTrackerURL"
  19358. }
  19359. },
  19360. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19361. },
  19362. "ExternalWiki": {
  19363. "description": "ExternalWiki represents setting for external wiki",
  19364. "type": "object",
  19365. "properties": {
  19366. "external_wiki_url": {
  19367. "description": "URL of external wiki.",
  19368. "type": "string",
  19369. "x-go-name": "ExternalWikiURL"
  19370. }
  19371. },
  19372. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19373. },
  19374. "FileCommitResponse": {
  19375. "type": "object",
  19376. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  19377. "properties": {
  19378. "author": {
  19379. "$ref": "#/definitions/CommitUser"
  19380. },
  19381. "committer": {
  19382. "$ref": "#/definitions/CommitUser"
  19383. },
  19384. "created": {
  19385. "type": "string",
  19386. "format": "date-time",
  19387. "x-go-name": "Created"
  19388. },
  19389. "html_url": {
  19390. "type": "string",
  19391. "x-go-name": "HTMLURL"
  19392. },
  19393. "message": {
  19394. "type": "string",
  19395. "x-go-name": "Message"
  19396. },
  19397. "parents": {
  19398. "type": "array",
  19399. "items": {
  19400. "$ref": "#/definitions/CommitMeta"
  19401. },
  19402. "x-go-name": "Parents"
  19403. },
  19404. "sha": {
  19405. "type": "string",
  19406. "x-go-name": "SHA"
  19407. },
  19408. "tree": {
  19409. "$ref": "#/definitions/CommitMeta"
  19410. },
  19411. "url": {
  19412. "type": "string",
  19413. "x-go-name": "URL"
  19414. }
  19415. },
  19416. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19417. },
  19418. "FileDeleteResponse": {
  19419. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  19420. "type": "object",
  19421. "properties": {
  19422. "commit": {
  19423. "$ref": "#/definitions/FileCommitResponse"
  19424. },
  19425. "content": {
  19426. "x-go-name": "Content"
  19427. },
  19428. "verification": {
  19429. "$ref": "#/definitions/PayloadCommitVerification"
  19430. }
  19431. },
  19432. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19433. },
  19434. "FileLinksResponse": {
  19435. "description": "FileLinksResponse contains the links for a repo's file",
  19436. "type": "object",
  19437. "properties": {
  19438. "git": {
  19439. "type": "string",
  19440. "x-go-name": "GitURL"
  19441. },
  19442. "html": {
  19443. "type": "string",
  19444. "x-go-name": "HTMLURL"
  19445. },
  19446. "self": {
  19447. "type": "string",
  19448. "x-go-name": "Self"
  19449. }
  19450. },
  19451. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19452. },
  19453. "FileResponse": {
  19454. "description": "FileResponse contains information about a repo's file",
  19455. "type": "object",
  19456. "properties": {
  19457. "commit": {
  19458. "$ref": "#/definitions/FileCommitResponse"
  19459. },
  19460. "content": {
  19461. "$ref": "#/definitions/ContentsResponse"
  19462. },
  19463. "verification": {
  19464. "$ref": "#/definitions/PayloadCommitVerification"
  19465. }
  19466. },
  19467. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19468. },
  19469. "FilesResponse": {
  19470. "description": "FilesResponse contains information about multiple files from a repo",
  19471. "type": "object",
  19472. "properties": {
  19473. "commit": {
  19474. "$ref": "#/definitions/FileCommitResponse"
  19475. },
  19476. "files": {
  19477. "type": "array",
  19478. "items": {
  19479. "$ref": "#/definitions/ContentsResponse"
  19480. },
  19481. "x-go-name": "Files"
  19482. },
  19483. "verification": {
  19484. "$ref": "#/definitions/PayloadCommitVerification"
  19485. }
  19486. },
  19487. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19488. },
  19489. "GPGKey": {
  19490. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  19491. "type": "object",
  19492. "properties": {
  19493. "can_certify": {
  19494. "type": "boolean",
  19495. "x-go-name": "CanCertify"
  19496. },
  19497. "can_encrypt_comms": {
  19498. "type": "boolean",
  19499. "x-go-name": "CanEncryptComms"
  19500. },
  19501. "can_encrypt_storage": {
  19502. "type": "boolean",
  19503. "x-go-name": "CanEncryptStorage"
  19504. },
  19505. "can_sign": {
  19506. "type": "boolean",
  19507. "x-go-name": "CanSign"
  19508. },
  19509. "created_at": {
  19510. "type": "string",
  19511. "format": "date-time",
  19512. "x-go-name": "Created"
  19513. },
  19514. "emails": {
  19515. "type": "array",
  19516. "items": {
  19517. "$ref": "#/definitions/GPGKeyEmail"
  19518. },
  19519. "x-go-name": "Emails"
  19520. },
  19521. "expires_at": {
  19522. "type": "string",
  19523. "format": "date-time",
  19524. "x-go-name": "Expires"
  19525. },
  19526. "id": {
  19527. "type": "integer",
  19528. "format": "int64",
  19529. "x-go-name": "ID"
  19530. },
  19531. "key_id": {
  19532. "type": "string",
  19533. "x-go-name": "KeyID"
  19534. },
  19535. "primary_key_id": {
  19536. "type": "string",
  19537. "x-go-name": "PrimaryKeyID"
  19538. },
  19539. "public_key": {
  19540. "type": "string",
  19541. "x-go-name": "PublicKey"
  19542. },
  19543. "subkeys": {
  19544. "type": "array",
  19545. "items": {
  19546. "$ref": "#/definitions/GPGKey"
  19547. },
  19548. "x-go-name": "SubsKey"
  19549. },
  19550. "verified": {
  19551. "type": "boolean",
  19552. "x-go-name": "Verified"
  19553. }
  19554. },
  19555. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19556. },
  19557. "GPGKeyEmail": {
  19558. "description": "GPGKeyEmail an email attached to a GPGKey",
  19559. "type": "object",
  19560. "properties": {
  19561. "email": {
  19562. "type": "string",
  19563. "x-go-name": "Email"
  19564. },
  19565. "verified": {
  19566. "type": "boolean",
  19567. "x-go-name": "Verified"
  19568. }
  19569. },
  19570. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19571. },
  19572. "GeneralAPISettings": {
  19573. "description": "GeneralAPISettings contains global api settings exposed by it",
  19574. "type": "object",
  19575. "properties": {
  19576. "default_git_trees_per_page": {
  19577. "type": "integer",
  19578. "format": "int64",
  19579. "x-go-name": "DefaultGitTreesPerPage"
  19580. },
  19581. "default_max_blob_size": {
  19582. "type": "integer",
  19583. "format": "int64",
  19584. "x-go-name": "DefaultMaxBlobSize"
  19585. },
  19586. "default_paging_num": {
  19587. "type": "integer",
  19588. "format": "int64",
  19589. "x-go-name": "DefaultPagingNum"
  19590. },
  19591. "max_response_items": {
  19592. "type": "integer",
  19593. "format": "int64",
  19594. "x-go-name": "MaxResponseItems"
  19595. }
  19596. },
  19597. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19598. },
  19599. "GeneralAttachmentSettings": {
  19600. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  19601. "type": "object",
  19602. "properties": {
  19603. "allowed_types": {
  19604. "type": "string",
  19605. "x-go-name": "AllowedTypes"
  19606. },
  19607. "enabled": {
  19608. "type": "boolean",
  19609. "x-go-name": "Enabled"
  19610. },
  19611. "max_files": {
  19612. "type": "integer",
  19613. "format": "int64",
  19614. "x-go-name": "MaxFiles"
  19615. },
  19616. "max_size": {
  19617. "type": "integer",
  19618. "format": "int64",
  19619. "x-go-name": "MaxSize"
  19620. }
  19621. },
  19622. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19623. },
  19624. "GeneralRepoSettings": {
  19625. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  19626. "type": "object",
  19627. "properties": {
  19628. "http_git_disabled": {
  19629. "type": "boolean",
  19630. "x-go-name": "HTTPGitDisabled"
  19631. },
  19632. "lfs_disabled": {
  19633. "type": "boolean",
  19634. "x-go-name": "LFSDisabled"
  19635. },
  19636. "migrations_disabled": {
  19637. "type": "boolean",
  19638. "x-go-name": "MigrationsDisabled"
  19639. },
  19640. "mirrors_disabled": {
  19641. "type": "boolean",
  19642. "x-go-name": "MirrorsDisabled"
  19643. },
  19644. "stars_disabled": {
  19645. "type": "boolean",
  19646. "x-go-name": "StarsDisabled"
  19647. },
  19648. "time_tracking_disabled": {
  19649. "type": "boolean",
  19650. "x-go-name": "TimeTrackingDisabled"
  19651. }
  19652. },
  19653. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19654. },
  19655. "GeneralUISettings": {
  19656. "description": "GeneralUISettings contains global ui settings exposed by API",
  19657. "type": "object",
  19658. "properties": {
  19659. "allowed_reactions": {
  19660. "type": "array",
  19661. "items": {
  19662. "type": "string"
  19663. },
  19664. "x-go-name": "AllowedReactions"
  19665. },
  19666. "custom_emojis": {
  19667. "type": "array",
  19668. "items": {
  19669. "type": "string"
  19670. },
  19671. "x-go-name": "CustomEmojis"
  19672. },
  19673. "default_theme": {
  19674. "type": "string",
  19675. "x-go-name": "DefaultTheme"
  19676. }
  19677. },
  19678. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19679. },
  19680. "GenerateRepoOption": {
  19681. "description": "GenerateRepoOption options when creating repository using a template",
  19682. "type": "object",
  19683. "required": [
  19684. "owner",
  19685. "name"
  19686. ],
  19687. "properties": {
  19688. "avatar": {
  19689. "description": "include avatar of the template repo",
  19690. "type": "boolean",
  19691. "x-go-name": "Avatar"
  19692. },
  19693. "default_branch": {
  19694. "description": "Default branch of the new repository",
  19695. "type": "string",
  19696. "x-go-name": "DefaultBranch"
  19697. },
  19698. "description": {
  19699. "description": "Description of the repository to create",
  19700. "type": "string",
  19701. "x-go-name": "Description"
  19702. },
  19703. "git_content": {
  19704. "description": "include git content of default branch in template repo",
  19705. "type": "boolean",
  19706. "x-go-name": "GitContent"
  19707. },
  19708. "git_hooks": {
  19709. "description": "include git hooks in template repo",
  19710. "type": "boolean",
  19711. "x-go-name": "GitHooks"
  19712. },
  19713. "labels": {
  19714. "description": "include labels in template repo",
  19715. "type": "boolean",
  19716. "x-go-name": "Labels"
  19717. },
  19718. "name": {
  19719. "description": "Name of the repository to create",
  19720. "type": "string",
  19721. "uniqueItems": true,
  19722. "x-go-name": "Name"
  19723. },
  19724. "owner": {
  19725. "description": "The organization or person who will own the new repository",
  19726. "type": "string",
  19727. "x-go-name": "Owner"
  19728. },
  19729. "private": {
  19730. "description": "Whether the repository is private",
  19731. "type": "boolean",
  19732. "x-go-name": "Private"
  19733. },
  19734. "protected_branch": {
  19735. "description": "include protected branches in template repo",
  19736. "type": "boolean",
  19737. "x-go-name": "ProtectedBranch"
  19738. },
  19739. "topics": {
  19740. "description": "include topics in template repo",
  19741. "type": "boolean",
  19742. "x-go-name": "Topics"
  19743. },
  19744. "webhooks": {
  19745. "description": "include webhooks in template repo",
  19746. "type": "boolean",
  19747. "x-go-name": "Webhooks"
  19748. }
  19749. },
  19750. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19751. },
  19752. "GitBlobResponse": {
  19753. "description": "GitBlobResponse represents a git blob",
  19754. "type": "object",
  19755. "properties": {
  19756. "content": {
  19757. "type": "string",
  19758. "x-go-name": "Content"
  19759. },
  19760. "encoding": {
  19761. "type": "string",
  19762. "x-go-name": "Encoding"
  19763. },
  19764. "sha": {
  19765. "type": "string",
  19766. "x-go-name": "SHA"
  19767. },
  19768. "size": {
  19769. "type": "integer",
  19770. "format": "int64",
  19771. "x-go-name": "Size"
  19772. },
  19773. "url": {
  19774. "type": "string",
  19775. "x-go-name": "URL"
  19776. }
  19777. },
  19778. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19779. },
  19780. "GitEntry": {
  19781. "description": "GitEntry represents a git tree",
  19782. "type": "object",
  19783. "properties": {
  19784. "mode": {
  19785. "type": "string",
  19786. "x-go-name": "Mode"
  19787. },
  19788. "path": {
  19789. "type": "string",
  19790. "x-go-name": "Path"
  19791. },
  19792. "sha": {
  19793. "type": "string",
  19794. "x-go-name": "SHA"
  19795. },
  19796. "size": {
  19797. "type": "integer",
  19798. "format": "int64",
  19799. "x-go-name": "Size"
  19800. },
  19801. "type": {
  19802. "type": "string",
  19803. "x-go-name": "Type"
  19804. },
  19805. "url": {
  19806. "type": "string",
  19807. "x-go-name": "URL"
  19808. }
  19809. },
  19810. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19811. },
  19812. "GitHook": {
  19813. "description": "GitHook represents a Git repository hook",
  19814. "type": "object",
  19815. "properties": {
  19816. "content": {
  19817. "type": "string",
  19818. "x-go-name": "Content"
  19819. },
  19820. "is_active": {
  19821. "type": "boolean",
  19822. "x-go-name": "IsActive"
  19823. },
  19824. "name": {
  19825. "type": "string",
  19826. "x-go-name": "Name"
  19827. }
  19828. },
  19829. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19830. },
  19831. "GitObject": {
  19832. "type": "object",
  19833. "title": "GitObject represents a Git object.",
  19834. "properties": {
  19835. "sha": {
  19836. "type": "string",
  19837. "x-go-name": "SHA"
  19838. },
  19839. "type": {
  19840. "type": "string",
  19841. "x-go-name": "Type"
  19842. },
  19843. "url": {
  19844. "type": "string",
  19845. "x-go-name": "URL"
  19846. }
  19847. },
  19848. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19849. },
  19850. "GitTreeResponse": {
  19851. "description": "GitTreeResponse returns a git tree",
  19852. "type": "object",
  19853. "properties": {
  19854. "page": {
  19855. "type": "integer",
  19856. "format": "int64",
  19857. "x-go-name": "Page"
  19858. },
  19859. "sha": {
  19860. "type": "string",
  19861. "x-go-name": "SHA"
  19862. },
  19863. "total_count": {
  19864. "type": "integer",
  19865. "format": "int64",
  19866. "x-go-name": "TotalCount"
  19867. },
  19868. "tree": {
  19869. "type": "array",
  19870. "items": {
  19871. "$ref": "#/definitions/GitEntry"
  19872. },
  19873. "x-go-name": "Entries"
  19874. },
  19875. "truncated": {
  19876. "type": "boolean",
  19877. "x-go-name": "Truncated"
  19878. },
  19879. "url": {
  19880. "type": "string",
  19881. "x-go-name": "URL"
  19882. }
  19883. },
  19884. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19885. },
  19886. "GitignoreTemplateInfo": {
  19887. "description": "GitignoreTemplateInfo name and text of a gitignore template",
  19888. "type": "object",
  19889. "properties": {
  19890. "name": {
  19891. "type": "string",
  19892. "x-go-name": "Name"
  19893. },
  19894. "source": {
  19895. "type": "string",
  19896. "x-go-name": "Source"
  19897. }
  19898. },
  19899. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19900. },
  19901. "Hook": {
  19902. "description": "Hook a hook is a web hook when one repository changed",
  19903. "type": "object",
  19904. "properties": {
  19905. "active": {
  19906. "type": "boolean",
  19907. "x-go-name": "Active"
  19908. },
  19909. "authorization_header": {
  19910. "type": "string",
  19911. "x-go-name": "AuthorizationHeader"
  19912. },
  19913. "branch_filter": {
  19914. "type": "string",
  19915. "x-go-name": "BranchFilter"
  19916. },
  19917. "config": {
  19918. "type": "object",
  19919. "additionalProperties": {
  19920. "type": "string"
  19921. },
  19922. "x-go-name": "Config"
  19923. },
  19924. "created_at": {
  19925. "type": "string",
  19926. "format": "date-time",
  19927. "x-go-name": "Created"
  19928. },
  19929. "events": {
  19930. "type": "array",
  19931. "items": {
  19932. "type": "string"
  19933. },
  19934. "x-go-name": "Events"
  19935. },
  19936. "id": {
  19937. "type": "integer",
  19938. "format": "int64",
  19939. "x-go-name": "ID"
  19940. },
  19941. "type": {
  19942. "type": "string",
  19943. "x-go-name": "Type"
  19944. },
  19945. "updated_at": {
  19946. "type": "string",
  19947. "format": "date-time",
  19948. "x-go-name": "Updated"
  19949. }
  19950. },
  19951. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19952. },
  19953. "Identity": {
  19954. "description": "Identity for a person's identity like an author or committer",
  19955. "type": "object",
  19956. "properties": {
  19957. "email": {
  19958. "type": "string",
  19959. "format": "email",
  19960. "x-go-name": "Email"
  19961. },
  19962. "name": {
  19963. "type": "string",
  19964. "x-go-name": "Name"
  19965. }
  19966. },
  19967. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19968. },
  19969. "InternalTracker": {
  19970. "description": "InternalTracker represents settings for internal tracker",
  19971. "type": "object",
  19972. "properties": {
  19973. "allow_only_contributors_to_track_time": {
  19974. "description": "Let only contributors track time (Built-in issue tracker)",
  19975. "type": "boolean",
  19976. "x-go-name": "AllowOnlyContributorsToTrackTime"
  19977. },
  19978. "enable_issue_dependencies": {
  19979. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  19980. "type": "boolean",
  19981. "x-go-name": "EnableIssueDependencies"
  19982. },
  19983. "enable_time_tracker": {
  19984. "description": "Enable time tracking (Built-in issue tracker)",
  19985. "type": "boolean",
  19986. "x-go-name": "EnableTimeTracker"
  19987. }
  19988. },
  19989. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19990. },
  19991. "Issue": {
  19992. "description": "Issue represents an issue in a repository",
  19993. "type": "object",
  19994. "properties": {
  19995. "assets": {
  19996. "type": "array",
  19997. "items": {
  19998. "$ref": "#/definitions/Attachment"
  19999. },
  20000. "x-go-name": "Attachments"
  20001. },
  20002. "assignee": {
  20003. "$ref": "#/definitions/User"
  20004. },
  20005. "assignees": {
  20006. "type": "array",
  20007. "items": {
  20008. "$ref": "#/definitions/User"
  20009. },
  20010. "x-go-name": "Assignees"
  20011. },
  20012. "body": {
  20013. "type": "string",
  20014. "x-go-name": "Body"
  20015. },
  20016. "closed_at": {
  20017. "type": "string",
  20018. "format": "date-time",
  20019. "x-go-name": "Closed"
  20020. },
  20021. "comments": {
  20022. "type": "integer",
  20023. "format": "int64",
  20024. "x-go-name": "Comments"
  20025. },
  20026. "created_at": {
  20027. "type": "string",
  20028. "format": "date-time",
  20029. "x-go-name": "Created"
  20030. },
  20031. "due_date": {
  20032. "type": "string",
  20033. "format": "date-time",
  20034. "x-go-name": "Deadline"
  20035. },
  20036. "html_url": {
  20037. "type": "string",
  20038. "x-go-name": "HTMLURL"
  20039. },
  20040. "id": {
  20041. "type": "integer",
  20042. "format": "int64",
  20043. "x-go-name": "ID"
  20044. },
  20045. "is_locked": {
  20046. "type": "boolean",
  20047. "x-go-name": "IsLocked"
  20048. },
  20049. "labels": {
  20050. "type": "array",
  20051. "items": {
  20052. "$ref": "#/definitions/Label"
  20053. },
  20054. "x-go-name": "Labels"
  20055. },
  20056. "milestone": {
  20057. "$ref": "#/definitions/Milestone"
  20058. },
  20059. "number": {
  20060. "type": "integer",
  20061. "format": "int64",
  20062. "x-go-name": "Index"
  20063. },
  20064. "original_author": {
  20065. "type": "string",
  20066. "x-go-name": "OriginalAuthor"
  20067. },
  20068. "original_author_id": {
  20069. "type": "integer",
  20070. "format": "int64",
  20071. "x-go-name": "OriginalAuthorID"
  20072. },
  20073. "pin_order": {
  20074. "type": "integer",
  20075. "format": "int64",
  20076. "x-go-name": "PinOrder"
  20077. },
  20078. "pull_request": {
  20079. "$ref": "#/definitions/PullRequestMeta"
  20080. },
  20081. "ref": {
  20082. "type": "string",
  20083. "x-go-name": "Ref"
  20084. },
  20085. "repository": {
  20086. "$ref": "#/definitions/RepositoryMeta"
  20087. },
  20088. "state": {
  20089. "$ref": "#/definitions/StateType"
  20090. },
  20091. "title": {
  20092. "type": "string",
  20093. "x-go-name": "Title"
  20094. },
  20095. "updated_at": {
  20096. "type": "string",
  20097. "format": "date-time",
  20098. "x-go-name": "Updated"
  20099. },
  20100. "url": {
  20101. "type": "string",
  20102. "x-go-name": "URL"
  20103. },
  20104. "user": {
  20105. "$ref": "#/definitions/User"
  20106. }
  20107. },
  20108. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20109. },
  20110. "IssueConfig": {
  20111. "type": "object",
  20112. "properties": {
  20113. "blank_issues_enabled": {
  20114. "type": "boolean",
  20115. "x-go-name": "BlankIssuesEnabled"
  20116. },
  20117. "contact_links": {
  20118. "type": "array",
  20119. "items": {
  20120. "$ref": "#/definitions/IssueConfigContactLink"
  20121. },
  20122. "x-go-name": "ContactLinks"
  20123. }
  20124. },
  20125. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20126. },
  20127. "IssueConfigContactLink": {
  20128. "type": "object",
  20129. "properties": {
  20130. "about": {
  20131. "type": "string",
  20132. "x-go-name": "About"
  20133. },
  20134. "name": {
  20135. "type": "string",
  20136. "x-go-name": "Name"
  20137. },
  20138. "url": {
  20139. "type": "string",
  20140. "x-go-name": "URL"
  20141. }
  20142. },
  20143. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20144. },
  20145. "IssueConfigValidation": {
  20146. "type": "object",
  20147. "properties": {
  20148. "message": {
  20149. "type": "string",
  20150. "x-go-name": "Message"
  20151. },
  20152. "valid": {
  20153. "type": "boolean",
  20154. "x-go-name": "Valid"
  20155. }
  20156. },
  20157. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20158. },
  20159. "IssueDeadline": {
  20160. "description": "IssueDeadline represents an issue deadline",
  20161. "type": "object",
  20162. "properties": {
  20163. "due_date": {
  20164. "type": "string",
  20165. "format": "date-time",
  20166. "x-go-name": "Deadline"
  20167. }
  20168. },
  20169. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20170. },
  20171. "IssueFormField": {
  20172. "description": "IssueFormField represents a form field",
  20173. "type": "object",
  20174. "properties": {
  20175. "attributes": {
  20176. "type": "object",
  20177. "additionalProperties": {},
  20178. "x-go-name": "Attributes"
  20179. },
  20180. "id": {
  20181. "type": "string",
  20182. "x-go-name": "ID"
  20183. },
  20184. "type": {
  20185. "$ref": "#/definitions/IssueFormFieldType"
  20186. },
  20187. "validations": {
  20188. "type": "object",
  20189. "additionalProperties": {},
  20190. "x-go-name": "Validations"
  20191. }
  20192. },
  20193. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20194. },
  20195. "IssueFormFieldType": {
  20196. "type": "string",
  20197. "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
  20198. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20199. },
  20200. "IssueLabelsOption": {
  20201. "description": "IssueLabelsOption a collection of labels",
  20202. "type": "object",
  20203. "properties": {
  20204. "labels": {
  20205. "description": "list of label IDs",
  20206. "type": "array",
  20207. "items": {
  20208. "type": "integer",
  20209. "format": "int64"
  20210. },
  20211. "x-go-name": "Labels"
  20212. }
  20213. },
  20214. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20215. },
  20216. "IssueMeta": {
  20217. "description": "IssueMeta basic issue information",
  20218. "type": "object",
  20219. "properties": {
  20220. "index": {
  20221. "type": "integer",
  20222. "format": "int64",
  20223. "x-go-name": "Index"
  20224. },
  20225. "owner": {
  20226. "type": "string",
  20227. "x-go-name": "Owner"
  20228. },
  20229. "repo": {
  20230. "type": "string",
  20231. "x-go-name": "Name"
  20232. }
  20233. },
  20234. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20235. },
  20236. "IssueTemplate": {
  20237. "description": "IssueTemplate represents an issue template for a repository",
  20238. "type": "object",
  20239. "properties": {
  20240. "about": {
  20241. "type": "string",
  20242. "x-go-name": "About"
  20243. },
  20244. "body": {
  20245. "type": "array",
  20246. "items": {
  20247. "$ref": "#/definitions/IssueFormField"
  20248. },
  20249. "x-go-name": "Fields"
  20250. },
  20251. "content": {
  20252. "type": "string",
  20253. "x-go-name": "Content"
  20254. },
  20255. "file_name": {
  20256. "type": "string",
  20257. "x-go-name": "FileName"
  20258. },
  20259. "labels": {
  20260. "$ref": "#/definitions/IssueTemplateLabels"
  20261. },
  20262. "name": {
  20263. "type": "string",
  20264. "x-go-name": "Name"
  20265. },
  20266. "ref": {
  20267. "type": "string",
  20268. "x-go-name": "Ref"
  20269. },
  20270. "title": {
  20271. "type": "string",
  20272. "x-go-name": "Title"
  20273. }
  20274. },
  20275. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20276. },
  20277. "IssueTemplateLabels": {
  20278. "type": "array",
  20279. "items": {
  20280. "type": "string"
  20281. },
  20282. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20283. },
  20284. "Label": {
  20285. "description": "Label a label to an issue or a pr",
  20286. "type": "object",
  20287. "properties": {
  20288. "color": {
  20289. "type": "string",
  20290. "x-go-name": "Color",
  20291. "example": "00aabb"
  20292. },
  20293. "description": {
  20294. "type": "string",
  20295. "x-go-name": "Description"
  20296. },
  20297. "exclusive": {
  20298. "type": "boolean",
  20299. "x-go-name": "Exclusive",
  20300. "example": false
  20301. },
  20302. "id": {
  20303. "type": "integer",
  20304. "format": "int64",
  20305. "x-go-name": "ID"
  20306. },
  20307. "is_archived": {
  20308. "type": "boolean",
  20309. "x-go-name": "IsArchived",
  20310. "example": false
  20311. },
  20312. "name": {
  20313. "type": "string",
  20314. "x-go-name": "Name"
  20315. },
  20316. "url": {
  20317. "type": "string",
  20318. "x-go-name": "URL"
  20319. }
  20320. },
  20321. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20322. },
  20323. "LabelTemplate": {
  20324. "description": "LabelTemplate info of a Label template",
  20325. "type": "object",
  20326. "properties": {
  20327. "color": {
  20328. "type": "string",
  20329. "x-go-name": "Color",
  20330. "example": "00aabb"
  20331. },
  20332. "description": {
  20333. "type": "string",
  20334. "x-go-name": "Description"
  20335. },
  20336. "exclusive": {
  20337. "type": "boolean",
  20338. "x-go-name": "Exclusive",
  20339. "example": false
  20340. },
  20341. "name": {
  20342. "type": "string",
  20343. "x-go-name": "Name"
  20344. }
  20345. },
  20346. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20347. },
  20348. "LicenseTemplateInfo": {
  20349. "description": "LicensesInfo contains information about a License",
  20350. "type": "object",
  20351. "properties": {
  20352. "body": {
  20353. "type": "string",
  20354. "x-go-name": "Body"
  20355. },
  20356. "implementation": {
  20357. "type": "string",
  20358. "x-go-name": "Implementation"
  20359. },
  20360. "key": {
  20361. "type": "string",
  20362. "x-go-name": "Key"
  20363. },
  20364. "name": {
  20365. "type": "string",
  20366. "x-go-name": "Name"
  20367. },
  20368. "url": {
  20369. "type": "string",
  20370. "x-go-name": "URL"
  20371. }
  20372. },
  20373. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20374. },
  20375. "LicensesTemplateListEntry": {
  20376. "description": "LicensesListEntry is used for the API",
  20377. "type": "object",
  20378. "properties": {
  20379. "key": {
  20380. "type": "string",
  20381. "x-go-name": "Key"
  20382. },
  20383. "name": {
  20384. "type": "string",
  20385. "x-go-name": "Name"
  20386. },
  20387. "url": {
  20388. "type": "string",
  20389. "x-go-name": "URL"
  20390. }
  20391. },
  20392. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20393. },
  20394. "MarkdownOption": {
  20395. "description": "MarkdownOption markdown options",
  20396. "type": "object",
  20397. "properties": {
  20398. "Context": {
  20399. "description": "Context to render\n\nin: body",
  20400. "type": "string"
  20401. },
  20402. "Mode": {
  20403. "description": "Mode to render (comment, gfm, markdown)\n\nin: body",
  20404. "type": "string"
  20405. },
  20406. "Text": {
  20407. "description": "Text markdown to render\n\nin: body",
  20408. "type": "string"
  20409. },
  20410. "Wiki": {
  20411. "description": "Is it a wiki page ?\n\nin: body",
  20412. "type": "boolean"
  20413. }
  20414. },
  20415. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20416. },
  20417. "MarkupOption": {
  20418. "description": "MarkupOption markup options",
  20419. "type": "object",
  20420. "properties": {
  20421. "Context": {
  20422. "description": "Context to render\n\nin: body",
  20423. "type": "string"
  20424. },
  20425. "FilePath": {
  20426. "description": "File path for detecting extension in file mode\n\nin: body",
  20427. "type": "string"
  20428. },
  20429. "Mode": {
  20430. "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body",
  20431. "type": "string"
  20432. },
  20433. "Text": {
  20434. "description": "Text markup to render\n\nin: body",
  20435. "type": "string"
  20436. },
  20437. "Wiki": {
  20438. "description": "Is it a wiki page ?\n\nin: body",
  20439. "type": "boolean"
  20440. }
  20441. },
  20442. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20443. },
  20444. "MergePullRequestOption": {
  20445. "description": "MergePullRequestForm form for merging Pull Request",
  20446. "type": "object",
  20447. "required": [
  20448. "Do"
  20449. ],
  20450. "properties": {
  20451. "Do": {
  20452. "type": "string",
  20453. "enum": [
  20454. "merge",
  20455. "rebase",
  20456. "rebase-merge",
  20457. "squash",
  20458. "manually-merged"
  20459. ]
  20460. },
  20461. "MergeCommitID": {
  20462. "type": "string"
  20463. },
  20464. "MergeMessageField": {
  20465. "type": "string"
  20466. },
  20467. "MergeTitleField": {
  20468. "type": "string"
  20469. },
  20470. "delete_branch_after_merge": {
  20471. "type": "boolean",
  20472. "x-go-name": "DeleteBranchAfterMerge"
  20473. },
  20474. "force_merge": {
  20475. "type": "boolean",
  20476. "x-go-name": "ForceMerge"
  20477. },
  20478. "head_commit_id": {
  20479. "type": "string",
  20480. "x-go-name": "HeadCommitID"
  20481. },
  20482. "merge_when_checks_succeed": {
  20483. "type": "boolean",
  20484. "x-go-name": "MergeWhenChecksSucceed"
  20485. }
  20486. },
  20487. "x-go-name": "MergePullRequestForm",
  20488. "x-go-package": "code.gitea.io/gitea/services/forms"
  20489. },
  20490. "MigrateRepoOptions": {
  20491. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  20492. "type": "object",
  20493. "required": [
  20494. "clone_addr",
  20495. "repo_name"
  20496. ],
  20497. "properties": {
  20498. "auth_password": {
  20499. "type": "string",
  20500. "x-go-name": "AuthPassword"
  20501. },
  20502. "auth_token": {
  20503. "type": "string",
  20504. "x-go-name": "AuthToken"
  20505. },
  20506. "auth_username": {
  20507. "type": "string",
  20508. "x-go-name": "AuthUsername"
  20509. },
  20510. "clone_addr": {
  20511. "type": "string",
  20512. "x-go-name": "CloneAddr"
  20513. },
  20514. "description": {
  20515. "type": "string",
  20516. "x-go-name": "Description"
  20517. },
  20518. "issues": {
  20519. "type": "boolean",
  20520. "x-go-name": "Issues"
  20521. },
  20522. "labels": {
  20523. "type": "boolean",
  20524. "x-go-name": "Labels"
  20525. },
  20526. "lfs": {
  20527. "type": "boolean",
  20528. "x-go-name": "LFS"
  20529. },
  20530. "lfs_endpoint": {
  20531. "type": "string",
  20532. "x-go-name": "LFSEndpoint"
  20533. },
  20534. "milestones": {
  20535. "type": "boolean",
  20536. "x-go-name": "Milestones"
  20537. },
  20538. "mirror": {
  20539. "type": "boolean",
  20540. "x-go-name": "Mirror"
  20541. },
  20542. "mirror_interval": {
  20543. "type": "string",
  20544. "x-go-name": "MirrorInterval"
  20545. },
  20546. "private": {
  20547. "type": "boolean",
  20548. "x-go-name": "Private"
  20549. },
  20550. "pull_requests": {
  20551. "type": "boolean",
  20552. "x-go-name": "PullRequests"
  20553. },
  20554. "releases": {
  20555. "type": "boolean",
  20556. "x-go-name": "Releases"
  20557. },
  20558. "repo_name": {
  20559. "type": "string",
  20560. "x-go-name": "RepoName"
  20561. },
  20562. "repo_owner": {
  20563. "description": "Name of User or Organisation who will own Repo after migration",
  20564. "type": "string",
  20565. "x-go-name": "RepoOwner"
  20566. },
  20567. "service": {
  20568. "type": "string",
  20569. "enum": [
  20570. "git",
  20571. "github",
  20572. "gitea",
  20573. "gitlab",
  20574. "gogs",
  20575. "onedev",
  20576. "gitbucket",
  20577. "codebase"
  20578. ],
  20579. "x-go-name": "Service"
  20580. },
  20581. "uid": {
  20582. "description": "deprecated (only for backwards compatibility)",
  20583. "type": "integer",
  20584. "format": "int64",
  20585. "x-go-name": "RepoOwnerID"
  20586. },
  20587. "wiki": {
  20588. "type": "boolean",
  20589. "x-go-name": "Wiki"
  20590. }
  20591. },
  20592. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20593. },
  20594. "Milestone": {
  20595. "description": "Milestone milestone is a collection of issues on one repository",
  20596. "type": "object",
  20597. "properties": {
  20598. "closed_at": {
  20599. "type": "string",
  20600. "format": "date-time",
  20601. "x-go-name": "Closed"
  20602. },
  20603. "closed_issues": {
  20604. "type": "integer",
  20605. "format": "int64",
  20606. "x-go-name": "ClosedIssues"
  20607. },
  20608. "created_at": {
  20609. "type": "string",
  20610. "format": "date-time",
  20611. "x-go-name": "Created"
  20612. },
  20613. "description": {
  20614. "type": "string",
  20615. "x-go-name": "Description"
  20616. },
  20617. "due_on": {
  20618. "type": "string",
  20619. "format": "date-time",
  20620. "x-go-name": "Deadline"
  20621. },
  20622. "id": {
  20623. "type": "integer",
  20624. "format": "int64",
  20625. "x-go-name": "ID"
  20626. },
  20627. "open_issues": {
  20628. "type": "integer",
  20629. "format": "int64",
  20630. "x-go-name": "OpenIssues"
  20631. },
  20632. "state": {
  20633. "$ref": "#/definitions/StateType"
  20634. },
  20635. "title": {
  20636. "type": "string",
  20637. "x-go-name": "Title"
  20638. },
  20639. "updated_at": {
  20640. "type": "string",
  20641. "format": "date-time",
  20642. "x-go-name": "Updated"
  20643. }
  20644. },
  20645. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20646. },
  20647. "NewIssuePinsAllowed": {
  20648. "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed",
  20649. "type": "object",
  20650. "properties": {
  20651. "issues": {
  20652. "type": "boolean",
  20653. "x-go-name": "Issues"
  20654. },
  20655. "pull_requests": {
  20656. "type": "boolean",
  20657. "x-go-name": "PullRequests"
  20658. }
  20659. },
  20660. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20661. },
  20662. "NodeInfo": {
  20663. "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
  20664. "type": "object",
  20665. "properties": {
  20666. "metadata": {
  20667. "type": "object",
  20668. "x-go-name": "Metadata"
  20669. },
  20670. "openRegistrations": {
  20671. "type": "boolean",
  20672. "x-go-name": "OpenRegistrations"
  20673. },
  20674. "protocols": {
  20675. "type": "array",
  20676. "items": {
  20677. "type": "string"
  20678. },
  20679. "x-go-name": "Protocols"
  20680. },
  20681. "services": {
  20682. "$ref": "#/definitions/NodeInfoServices"
  20683. },
  20684. "software": {
  20685. "$ref": "#/definitions/NodeInfoSoftware"
  20686. },
  20687. "usage": {
  20688. "$ref": "#/definitions/NodeInfoUsage"
  20689. },
  20690. "version": {
  20691. "type": "string",
  20692. "x-go-name": "Version"
  20693. }
  20694. },
  20695. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20696. },
  20697. "NodeInfoServices": {
  20698. "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
  20699. "type": "object",
  20700. "properties": {
  20701. "inbound": {
  20702. "type": "array",
  20703. "items": {
  20704. "type": "string"
  20705. },
  20706. "x-go-name": "Inbound"
  20707. },
  20708. "outbound": {
  20709. "type": "array",
  20710. "items": {
  20711. "type": "string"
  20712. },
  20713. "x-go-name": "Outbound"
  20714. }
  20715. },
  20716. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20717. },
  20718. "NodeInfoSoftware": {
  20719. "description": "NodeInfoSoftware contains Metadata about server software in use",
  20720. "type": "object",
  20721. "properties": {
  20722. "homepage": {
  20723. "type": "string",
  20724. "x-go-name": "Homepage"
  20725. },
  20726. "name": {
  20727. "type": "string",
  20728. "x-go-name": "Name"
  20729. },
  20730. "repository": {
  20731. "type": "string",
  20732. "x-go-name": "Repository"
  20733. },
  20734. "version": {
  20735. "type": "string",
  20736. "x-go-name": "Version"
  20737. }
  20738. },
  20739. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20740. },
  20741. "NodeInfoUsage": {
  20742. "description": "NodeInfoUsage contains usage statistics for this server",
  20743. "type": "object",
  20744. "properties": {
  20745. "localComments": {
  20746. "type": "integer",
  20747. "format": "int64",
  20748. "x-go-name": "LocalComments"
  20749. },
  20750. "localPosts": {
  20751. "type": "integer",
  20752. "format": "int64",
  20753. "x-go-name": "LocalPosts"
  20754. },
  20755. "users": {
  20756. "$ref": "#/definitions/NodeInfoUsageUsers"
  20757. }
  20758. },
  20759. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20760. },
  20761. "NodeInfoUsageUsers": {
  20762. "description": "NodeInfoUsageUsers contains statistics about the users of this server",
  20763. "type": "object",
  20764. "properties": {
  20765. "activeHalfyear": {
  20766. "type": "integer",
  20767. "format": "int64",
  20768. "x-go-name": "ActiveHalfyear"
  20769. },
  20770. "activeMonth": {
  20771. "type": "integer",
  20772. "format": "int64",
  20773. "x-go-name": "ActiveMonth"
  20774. },
  20775. "total": {
  20776. "type": "integer",
  20777. "format": "int64",
  20778. "x-go-name": "Total"
  20779. }
  20780. },
  20781. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20782. },
  20783. "Note": {
  20784. "description": "Note contains information related to a git note",
  20785. "type": "object",
  20786. "properties": {
  20787. "commit": {
  20788. "$ref": "#/definitions/Commit"
  20789. },
  20790. "message": {
  20791. "type": "string",
  20792. "x-go-name": "Message"
  20793. }
  20794. },
  20795. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20796. },
  20797. "NotificationCount": {
  20798. "description": "NotificationCount number of unread notifications",
  20799. "type": "object",
  20800. "properties": {
  20801. "new": {
  20802. "type": "integer",
  20803. "format": "int64",
  20804. "x-go-name": "New"
  20805. }
  20806. },
  20807. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20808. },
  20809. "NotificationSubject": {
  20810. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  20811. "type": "object",
  20812. "properties": {
  20813. "html_url": {
  20814. "type": "string",
  20815. "x-go-name": "HTMLURL"
  20816. },
  20817. "latest_comment_html_url": {
  20818. "type": "string",
  20819. "x-go-name": "LatestCommentHTMLURL"
  20820. },
  20821. "latest_comment_url": {
  20822. "type": "string",
  20823. "x-go-name": "LatestCommentURL"
  20824. },
  20825. "state": {
  20826. "$ref": "#/definitions/StateType"
  20827. },
  20828. "title": {
  20829. "type": "string",
  20830. "x-go-name": "Title"
  20831. },
  20832. "type": {
  20833. "$ref": "#/definitions/NotifySubjectType"
  20834. },
  20835. "url": {
  20836. "type": "string",
  20837. "x-go-name": "URL"
  20838. }
  20839. },
  20840. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20841. },
  20842. "NotificationThread": {
  20843. "description": "NotificationThread expose Notification on API",
  20844. "type": "object",
  20845. "properties": {
  20846. "id": {
  20847. "type": "integer",
  20848. "format": "int64",
  20849. "x-go-name": "ID"
  20850. },
  20851. "pinned": {
  20852. "type": "boolean",
  20853. "x-go-name": "Pinned"
  20854. },
  20855. "repository": {
  20856. "$ref": "#/definitions/Repository"
  20857. },
  20858. "subject": {
  20859. "$ref": "#/definitions/NotificationSubject"
  20860. },
  20861. "unread": {
  20862. "type": "boolean",
  20863. "x-go-name": "Unread"
  20864. },
  20865. "updated_at": {
  20866. "type": "string",
  20867. "format": "date-time",
  20868. "x-go-name": "UpdatedAt"
  20869. },
  20870. "url": {
  20871. "type": "string",
  20872. "x-go-name": "URL"
  20873. }
  20874. },
  20875. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20876. },
  20877. "NotifySubjectType": {
  20878. "description": "NotifySubjectType represent type of notification subject",
  20879. "type": "string",
  20880. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20881. },
  20882. "OAuth2Application": {
  20883. "type": "object",
  20884. "title": "OAuth2Application represents an OAuth2 application.",
  20885. "properties": {
  20886. "client_id": {
  20887. "type": "string",
  20888. "x-go-name": "ClientID"
  20889. },
  20890. "client_secret": {
  20891. "type": "string",
  20892. "x-go-name": "ClientSecret"
  20893. },
  20894. "confidential_client": {
  20895. "type": "boolean",
  20896. "x-go-name": "ConfidentialClient"
  20897. },
  20898. "created": {
  20899. "type": "string",
  20900. "format": "date-time",
  20901. "x-go-name": "Created"
  20902. },
  20903. "id": {
  20904. "type": "integer",
  20905. "format": "int64",
  20906. "x-go-name": "ID"
  20907. },
  20908. "name": {
  20909. "type": "string",
  20910. "x-go-name": "Name"
  20911. },
  20912. "redirect_uris": {
  20913. "type": "array",
  20914. "items": {
  20915. "type": "string"
  20916. },
  20917. "x-go-name": "RedirectURIs"
  20918. }
  20919. },
  20920. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20921. },
  20922. "Organization": {
  20923. "description": "Organization represents an organization",
  20924. "type": "object",
  20925. "properties": {
  20926. "avatar_url": {
  20927. "type": "string",
  20928. "x-go-name": "AvatarURL"
  20929. },
  20930. "description": {
  20931. "type": "string",
  20932. "x-go-name": "Description"
  20933. },
  20934. "email": {
  20935. "type": "string",
  20936. "x-go-name": "Email"
  20937. },
  20938. "full_name": {
  20939. "type": "string",
  20940. "x-go-name": "FullName"
  20941. },
  20942. "id": {
  20943. "type": "integer",
  20944. "format": "int64",
  20945. "x-go-name": "ID"
  20946. },
  20947. "location": {
  20948. "type": "string",
  20949. "x-go-name": "Location"
  20950. },
  20951. "name": {
  20952. "type": "string",
  20953. "x-go-name": "Name"
  20954. },
  20955. "repo_admin_change_team_access": {
  20956. "type": "boolean",
  20957. "x-go-name": "RepoAdminChangeTeamAccess"
  20958. },
  20959. "username": {
  20960. "description": "deprecated",
  20961. "type": "string",
  20962. "x-go-name": "UserName"
  20963. },
  20964. "visibility": {
  20965. "type": "string",
  20966. "x-go-name": "Visibility"
  20967. },
  20968. "website": {
  20969. "type": "string",
  20970. "x-go-name": "Website"
  20971. }
  20972. },
  20973. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20974. },
  20975. "OrganizationPermissions": {
  20976. "description": "OrganizationPermissions list different users permissions on an organization",
  20977. "type": "object",
  20978. "properties": {
  20979. "can_create_repository": {
  20980. "type": "boolean",
  20981. "x-go-name": "CanCreateRepository"
  20982. },
  20983. "can_read": {
  20984. "type": "boolean",
  20985. "x-go-name": "CanRead"
  20986. },
  20987. "can_write": {
  20988. "type": "boolean",
  20989. "x-go-name": "CanWrite"
  20990. },
  20991. "is_admin": {
  20992. "type": "boolean",
  20993. "x-go-name": "IsAdmin"
  20994. },
  20995. "is_owner": {
  20996. "type": "boolean",
  20997. "x-go-name": "IsOwner"
  20998. }
  20999. },
  21000. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21001. },
  21002. "PRBranchInfo": {
  21003. "description": "PRBranchInfo information about a branch",
  21004. "type": "object",
  21005. "properties": {
  21006. "label": {
  21007. "type": "string",
  21008. "x-go-name": "Name"
  21009. },
  21010. "ref": {
  21011. "type": "string",
  21012. "x-go-name": "Ref"
  21013. },
  21014. "repo": {
  21015. "$ref": "#/definitions/Repository"
  21016. },
  21017. "repo_id": {
  21018. "type": "integer",
  21019. "format": "int64",
  21020. "x-go-name": "RepoID"
  21021. },
  21022. "sha": {
  21023. "type": "string",
  21024. "x-go-name": "Sha"
  21025. }
  21026. },
  21027. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21028. },
  21029. "Package": {
  21030. "description": "Package represents a package",
  21031. "type": "object",
  21032. "properties": {
  21033. "created_at": {
  21034. "type": "string",
  21035. "format": "date-time",
  21036. "x-go-name": "CreatedAt"
  21037. },
  21038. "creator": {
  21039. "$ref": "#/definitions/User"
  21040. },
  21041. "html_url": {
  21042. "type": "string",
  21043. "x-go-name": "HTMLURL"
  21044. },
  21045. "id": {
  21046. "type": "integer",
  21047. "format": "int64",
  21048. "x-go-name": "ID"
  21049. },
  21050. "name": {
  21051. "type": "string",
  21052. "x-go-name": "Name"
  21053. },
  21054. "owner": {
  21055. "$ref": "#/definitions/User"
  21056. },
  21057. "repository": {
  21058. "$ref": "#/definitions/Repository"
  21059. },
  21060. "type": {
  21061. "type": "string",
  21062. "x-go-name": "Type"
  21063. },
  21064. "version": {
  21065. "type": "string",
  21066. "x-go-name": "Version"
  21067. }
  21068. },
  21069. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21070. },
  21071. "PackageFile": {
  21072. "description": "PackageFile represents a package file",
  21073. "type": "object",
  21074. "properties": {
  21075. "Size": {
  21076. "type": "integer",
  21077. "format": "int64"
  21078. },
  21079. "id": {
  21080. "type": "integer",
  21081. "format": "int64",
  21082. "x-go-name": "ID"
  21083. },
  21084. "md5": {
  21085. "type": "string",
  21086. "x-go-name": "HashMD5"
  21087. },
  21088. "name": {
  21089. "type": "string",
  21090. "x-go-name": "Name"
  21091. },
  21092. "sha1": {
  21093. "type": "string",
  21094. "x-go-name": "HashSHA1"
  21095. },
  21096. "sha256": {
  21097. "type": "string",
  21098. "x-go-name": "HashSHA256"
  21099. },
  21100. "sha512": {
  21101. "type": "string",
  21102. "x-go-name": "HashSHA512"
  21103. }
  21104. },
  21105. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21106. },
  21107. "PayloadCommit": {
  21108. "description": "PayloadCommit represents a commit",
  21109. "type": "object",
  21110. "properties": {
  21111. "added": {
  21112. "type": "array",
  21113. "items": {
  21114. "type": "string"
  21115. },
  21116. "x-go-name": "Added"
  21117. },
  21118. "author": {
  21119. "$ref": "#/definitions/PayloadUser"
  21120. },
  21121. "committer": {
  21122. "$ref": "#/definitions/PayloadUser"
  21123. },
  21124. "id": {
  21125. "description": "sha1 hash of the commit",
  21126. "type": "string",
  21127. "x-go-name": "ID"
  21128. },
  21129. "message": {
  21130. "type": "string",
  21131. "x-go-name": "Message"
  21132. },
  21133. "modified": {
  21134. "type": "array",
  21135. "items": {
  21136. "type": "string"
  21137. },
  21138. "x-go-name": "Modified"
  21139. },
  21140. "removed": {
  21141. "type": "array",
  21142. "items": {
  21143. "type": "string"
  21144. },
  21145. "x-go-name": "Removed"
  21146. },
  21147. "timestamp": {
  21148. "type": "string",
  21149. "format": "date-time",
  21150. "x-go-name": "Timestamp"
  21151. },
  21152. "url": {
  21153. "type": "string",
  21154. "x-go-name": "URL"
  21155. },
  21156. "verification": {
  21157. "$ref": "#/definitions/PayloadCommitVerification"
  21158. }
  21159. },
  21160. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21161. },
  21162. "PayloadCommitVerification": {
  21163. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  21164. "type": "object",
  21165. "properties": {
  21166. "payload": {
  21167. "type": "string",
  21168. "x-go-name": "Payload"
  21169. },
  21170. "reason": {
  21171. "type": "string",
  21172. "x-go-name": "Reason"
  21173. },
  21174. "signature": {
  21175. "type": "string",
  21176. "x-go-name": "Signature"
  21177. },
  21178. "signer": {
  21179. "$ref": "#/definitions/PayloadUser"
  21180. },
  21181. "verified": {
  21182. "type": "boolean",
  21183. "x-go-name": "Verified"
  21184. }
  21185. },
  21186. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21187. },
  21188. "PayloadUser": {
  21189. "description": "PayloadUser represents the author or committer of a commit",
  21190. "type": "object",
  21191. "properties": {
  21192. "email": {
  21193. "type": "string",
  21194. "format": "email",
  21195. "x-go-name": "Email"
  21196. },
  21197. "name": {
  21198. "description": "Full name of the commit author",
  21199. "type": "string",
  21200. "x-go-name": "Name"
  21201. },
  21202. "username": {
  21203. "type": "string",
  21204. "x-go-name": "UserName"
  21205. }
  21206. },
  21207. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21208. },
  21209. "Permission": {
  21210. "description": "Permission represents a set of permissions",
  21211. "type": "object",
  21212. "properties": {
  21213. "admin": {
  21214. "type": "boolean",
  21215. "x-go-name": "Admin"
  21216. },
  21217. "pull": {
  21218. "type": "boolean",
  21219. "x-go-name": "Pull"
  21220. },
  21221. "push": {
  21222. "type": "boolean",
  21223. "x-go-name": "Push"
  21224. }
  21225. },
  21226. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21227. },
  21228. "PublicKey": {
  21229. "description": "PublicKey publickey is a user key to push code to repository",
  21230. "type": "object",
  21231. "properties": {
  21232. "created_at": {
  21233. "type": "string",
  21234. "format": "date-time",
  21235. "x-go-name": "Created"
  21236. },
  21237. "fingerprint": {
  21238. "type": "string",
  21239. "x-go-name": "Fingerprint"
  21240. },
  21241. "id": {
  21242. "type": "integer",
  21243. "format": "int64",
  21244. "x-go-name": "ID"
  21245. },
  21246. "key": {
  21247. "type": "string",
  21248. "x-go-name": "Key"
  21249. },
  21250. "key_type": {
  21251. "type": "string",
  21252. "x-go-name": "KeyType"
  21253. },
  21254. "read_only": {
  21255. "type": "boolean",
  21256. "x-go-name": "ReadOnly"
  21257. },
  21258. "title": {
  21259. "type": "string",
  21260. "x-go-name": "Title"
  21261. },
  21262. "url": {
  21263. "type": "string",
  21264. "x-go-name": "URL"
  21265. },
  21266. "user": {
  21267. "$ref": "#/definitions/User"
  21268. }
  21269. },
  21270. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21271. },
  21272. "PullRequest": {
  21273. "description": "PullRequest represents a pull request",
  21274. "type": "object",
  21275. "properties": {
  21276. "allow_maintainer_edit": {
  21277. "type": "boolean",
  21278. "x-go-name": "AllowMaintainerEdit"
  21279. },
  21280. "assignee": {
  21281. "$ref": "#/definitions/User"
  21282. },
  21283. "assignees": {
  21284. "type": "array",
  21285. "items": {
  21286. "$ref": "#/definitions/User"
  21287. },
  21288. "x-go-name": "Assignees"
  21289. },
  21290. "base": {
  21291. "$ref": "#/definitions/PRBranchInfo"
  21292. },
  21293. "body": {
  21294. "type": "string",
  21295. "x-go-name": "Body"
  21296. },
  21297. "closed_at": {
  21298. "type": "string",
  21299. "format": "date-time",
  21300. "x-go-name": "Closed"
  21301. },
  21302. "comments": {
  21303. "type": "integer",
  21304. "format": "int64",
  21305. "x-go-name": "Comments"
  21306. },
  21307. "created_at": {
  21308. "type": "string",
  21309. "format": "date-time",
  21310. "x-go-name": "Created"
  21311. },
  21312. "diff_url": {
  21313. "type": "string",
  21314. "x-go-name": "DiffURL"
  21315. },
  21316. "due_date": {
  21317. "type": "string",
  21318. "format": "date-time",
  21319. "x-go-name": "Deadline"
  21320. },
  21321. "head": {
  21322. "$ref": "#/definitions/PRBranchInfo"
  21323. },
  21324. "html_url": {
  21325. "type": "string",
  21326. "x-go-name": "HTMLURL"
  21327. },
  21328. "id": {
  21329. "type": "integer",
  21330. "format": "int64",
  21331. "x-go-name": "ID"
  21332. },
  21333. "is_locked": {
  21334. "type": "boolean",
  21335. "x-go-name": "IsLocked"
  21336. },
  21337. "labels": {
  21338. "type": "array",
  21339. "items": {
  21340. "$ref": "#/definitions/Label"
  21341. },
  21342. "x-go-name": "Labels"
  21343. },
  21344. "merge_base": {
  21345. "type": "string",
  21346. "x-go-name": "MergeBase"
  21347. },
  21348. "merge_commit_sha": {
  21349. "type": "string",
  21350. "x-go-name": "MergedCommitID"
  21351. },
  21352. "mergeable": {
  21353. "type": "boolean",
  21354. "x-go-name": "Mergeable"
  21355. },
  21356. "merged": {
  21357. "type": "boolean",
  21358. "x-go-name": "HasMerged"
  21359. },
  21360. "merged_at": {
  21361. "type": "string",
  21362. "format": "date-time",
  21363. "x-go-name": "Merged"
  21364. },
  21365. "merged_by": {
  21366. "$ref": "#/definitions/User"
  21367. },
  21368. "milestone": {
  21369. "$ref": "#/definitions/Milestone"
  21370. },
  21371. "number": {
  21372. "type": "integer",
  21373. "format": "int64",
  21374. "x-go-name": "Index"
  21375. },
  21376. "patch_url": {
  21377. "type": "string",
  21378. "x-go-name": "PatchURL"
  21379. },
  21380. "pin_order": {
  21381. "type": "integer",
  21382. "format": "int64",
  21383. "x-go-name": "PinOrder"
  21384. },
  21385. "requested_reviewers": {
  21386. "type": "array",
  21387. "items": {
  21388. "$ref": "#/definitions/User"
  21389. },
  21390. "x-go-name": "RequestedReviewers"
  21391. },
  21392. "state": {
  21393. "$ref": "#/definitions/StateType"
  21394. },
  21395. "title": {
  21396. "type": "string",
  21397. "x-go-name": "Title"
  21398. },
  21399. "updated_at": {
  21400. "type": "string",
  21401. "format": "date-time",
  21402. "x-go-name": "Updated"
  21403. },
  21404. "url": {
  21405. "type": "string",
  21406. "x-go-name": "URL"
  21407. },
  21408. "user": {
  21409. "$ref": "#/definitions/User"
  21410. }
  21411. },
  21412. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21413. },
  21414. "PullRequestMeta": {
  21415. "description": "PullRequestMeta PR info if an issue is a PR",
  21416. "type": "object",
  21417. "properties": {
  21418. "merged": {
  21419. "type": "boolean",
  21420. "x-go-name": "HasMerged"
  21421. },
  21422. "merged_at": {
  21423. "type": "string",
  21424. "format": "date-time",
  21425. "x-go-name": "Merged"
  21426. }
  21427. },
  21428. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21429. },
  21430. "PullReview": {
  21431. "description": "PullReview represents a pull request review",
  21432. "type": "object",
  21433. "properties": {
  21434. "body": {
  21435. "type": "string",
  21436. "x-go-name": "Body"
  21437. },
  21438. "comments_count": {
  21439. "type": "integer",
  21440. "format": "int64",
  21441. "x-go-name": "CodeCommentsCount"
  21442. },
  21443. "commit_id": {
  21444. "type": "string",
  21445. "x-go-name": "CommitID"
  21446. },
  21447. "dismissed": {
  21448. "type": "boolean",
  21449. "x-go-name": "Dismissed"
  21450. },
  21451. "html_url": {
  21452. "type": "string",
  21453. "x-go-name": "HTMLURL"
  21454. },
  21455. "id": {
  21456. "type": "integer",
  21457. "format": "int64",
  21458. "x-go-name": "ID"
  21459. },
  21460. "official": {
  21461. "type": "boolean",
  21462. "x-go-name": "Official"
  21463. },
  21464. "pull_request_url": {
  21465. "type": "string",
  21466. "x-go-name": "HTMLPullURL"
  21467. },
  21468. "stale": {
  21469. "type": "boolean",
  21470. "x-go-name": "Stale"
  21471. },
  21472. "state": {
  21473. "$ref": "#/definitions/ReviewStateType"
  21474. },
  21475. "submitted_at": {
  21476. "type": "string",
  21477. "format": "date-time",
  21478. "x-go-name": "Submitted"
  21479. },
  21480. "team": {
  21481. "$ref": "#/definitions/Team"
  21482. },
  21483. "updated_at": {
  21484. "type": "string",
  21485. "format": "date-time",
  21486. "x-go-name": "Updated"
  21487. },
  21488. "user": {
  21489. "$ref": "#/definitions/User"
  21490. }
  21491. },
  21492. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21493. },
  21494. "PullReviewComment": {
  21495. "description": "PullReviewComment represents a comment on a pull request review",
  21496. "type": "object",
  21497. "properties": {
  21498. "body": {
  21499. "type": "string",
  21500. "x-go-name": "Body"
  21501. },
  21502. "commit_id": {
  21503. "type": "string",
  21504. "x-go-name": "CommitID"
  21505. },
  21506. "created_at": {
  21507. "type": "string",
  21508. "format": "date-time",
  21509. "x-go-name": "Created"
  21510. },
  21511. "diff_hunk": {
  21512. "type": "string",
  21513. "x-go-name": "DiffHunk"
  21514. },
  21515. "html_url": {
  21516. "type": "string",
  21517. "x-go-name": "HTMLURL"
  21518. },
  21519. "id": {
  21520. "type": "integer",
  21521. "format": "int64",
  21522. "x-go-name": "ID"
  21523. },
  21524. "original_commit_id": {
  21525. "type": "string",
  21526. "x-go-name": "OrigCommitID"
  21527. },
  21528. "original_position": {
  21529. "type": "integer",
  21530. "format": "uint64",
  21531. "x-go-name": "OldLineNum"
  21532. },
  21533. "path": {
  21534. "type": "string",
  21535. "x-go-name": "Path"
  21536. },
  21537. "position": {
  21538. "type": "integer",
  21539. "format": "uint64",
  21540. "x-go-name": "LineNum"
  21541. },
  21542. "pull_request_review_id": {
  21543. "type": "integer",
  21544. "format": "int64",
  21545. "x-go-name": "ReviewID"
  21546. },
  21547. "pull_request_url": {
  21548. "type": "string",
  21549. "x-go-name": "HTMLPullURL"
  21550. },
  21551. "resolver": {
  21552. "$ref": "#/definitions/User"
  21553. },
  21554. "updated_at": {
  21555. "type": "string",
  21556. "format": "date-time",
  21557. "x-go-name": "Updated"
  21558. },
  21559. "user": {
  21560. "$ref": "#/definitions/User"
  21561. }
  21562. },
  21563. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21564. },
  21565. "PullReviewRequestOptions": {
  21566. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  21567. "type": "object",
  21568. "properties": {
  21569. "reviewers": {
  21570. "type": "array",
  21571. "items": {
  21572. "type": "string"
  21573. },
  21574. "x-go-name": "Reviewers"
  21575. },
  21576. "team_reviewers": {
  21577. "type": "array",
  21578. "items": {
  21579. "type": "string"
  21580. },
  21581. "x-go-name": "TeamReviewers"
  21582. }
  21583. },
  21584. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21585. },
  21586. "PushMirror": {
  21587. "description": "PushMirror represents information of a push mirror",
  21588. "type": "object",
  21589. "properties": {
  21590. "created": {
  21591. "type": "string",
  21592. "x-go-name": "CreatedUnix"
  21593. },
  21594. "interval": {
  21595. "type": "string",
  21596. "x-go-name": "Interval"
  21597. },
  21598. "last_error": {
  21599. "type": "string",
  21600. "x-go-name": "LastError"
  21601. },
  21602. "last_update": {
  21603. "type": "string",
  21604. "x-go-name": "LastUpdateUnix"
  21605. },
  21606. "remote_address": {
  21607. "type": "string",
  21608. "x-go-name": "RemoteAddress"
  21609. },
  21610. "remote_name": {
  21611. "type": "string",
  21612. "x-go-name": "RemoteName"
  21613. },
  21614. "repo_name": {
  21615. "type": "string",
  21616. "x-go-name": "RepoName"
  21617. },
  21618. "sync_on_commit": {
  21619. "type": "boolean",
  21620. "x-go-name": "SyncOnCommit"
  21621. }
  21622. },
  21623. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21624. },
  21625. "Reaction": {
  21626. "description": "Reaction contain one reaction",
  21627. "type": "object",
  21628. "properties": {
  21629. "content": {
  21630. "type": "string",
  21631. "x-go-name": "Reaction"
  21632. },
  21633. "created_at": {
  21634. "type": "string",
  21635. "format": "date-time",
  21636. "x-go-name": "Created"
  21637. },
  21638. "user": {
  21639. "$ref": "#/definitions/User"
  21640. }
  21641. },
  21642. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21643. },
  21644. "Reference": {
  21645. "type": "object",
  21646. "title": "Reference represents a Git reference.",
  21647. "properties": {
  21648. "object": {
  21649. "$ref": "#/definitions/GitObject"
  21650. },
  21651. "ref": {
  21652. "type": "string",
  21653. "x-go-name": "Ref"
  21654. },
  21655. "url": {
  21656. "type": "string",
  21657. "x-go-name": "URL"
  21658. }
  21659. },
  21660. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21661. },
  21662. "Release": {
  21663. "description": "Release represents a repository release",
  21664. "type": "object",
  21665. "properties": {
  21666. "assets": {
  21667. "type": "array",
  21668. "items": {
  21669. "$ref": "#/definitions/Attachment"
  21670. },
  21671. "x-go-name": "Attachments"
  21672. },
  21673. "author": {
  21674. "$ref": "#/definitions/User"
  21675. },
  21676. "body": {
  21677. "type": "string",
  21678. "x-go-name": "Note"
  21679. },
  21680. "created_at": {
  21681. "type": "string",
  21682. "format": "date-time",
  21683. "x-go-name": "CreatedAt"
  21684. },
  21685. "draft": {
  21686. "type": "boolean",
  21687. "x-go-name": "IsDraft"
  21688. },
  21689. "html_url": {
  21690. "type": "string",
  21691. "x-go-name": "HTMLURL"
  21692. },
  21693. "id": {
  21694. "type": "integer",
  21695. "format": "int64",
  21696. "x-go-name": "ID"
  21697. },
  21698. "name": {
  21699. "type": "string",
  21700. "x-go-name": "Title"
  21701. },
  21702. "prerelease": {
  21703. "type": "boolean",
  21704. "x-go-name": "IsPrerelease"
  21705. },
  21706. "published_at": {
  21707. "type": "string",
  21708. "format": "date-time",
  21709. "x-go-name": "PublishedAt"
  21710. },
  21711. "tag_name": {
  21712. "type": "string",
  21713. "x-go-name": "TagName"
  21714. },
  21715. "tarball_url": {
  21716. "type": "string",
  21717. "x-go-name": "TarURL"
  21718. },
  21719. "target_commitish": {
  21720. "type": "string",
  21721. "x-go-name": "Target"
  21722. },
  21723. "upload_url": {
  21724. "type": "string",
  21725. "x-go-name": "UploadURL"
  21726. },
  21727. "url": {
  21728. "type": "string",
  21729. "x-go-name": "URL"
  21730. },
  21731. "zipball_url": {
  21732. "type": "string",
  21733. "x-go-name": "ZipURL"
  21734. }
  21735. },
  21736. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21737. },
  21738. "RenameUserOption": {
  21739. "description": "RenameUserOption options when renaming a user",
  21740. "type": "object",
  21741. "required": [
  21742. "new_username"
  21743. ],
  21744. "properties": {
  21745. "new_username": {
  21746. "description": "New username for this user. This name cannot be in use yet by any other user.",
  21747. "type": "string",
  21748. "uniqueItems": true,
  21749. "x-go-name": "NewName"
  21750. }
  21751. },
  21752. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21753. },
  21754. "RepoCollaboratorPermission": {
  21755. "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
  21756. "type": "object",
  21757. "properties": {
  21758. "permission": {
  21759. "type": "string",
  21760. "x-go-name": "Permission"
  21761. },
  21762. "role_name": {
  21763. "type": "string",
  21764. "x-go-name": "RoleName"
  21765. },
  21766. "user": {
  21767. "$ref": "#/definitions/User"
  21768. }
  21769. },
  21770. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21771. },
  21772. "RepoCommit": {
  21773. "type": "object",
  21774. "title": "RepoCommit contains information of a commit in the context of a repository.",
  21775. "properties": {
  21776. "author": {
  21777. "$ref": "#/definitions/CommitUser"
  21778. },
  21779. "committer": {
  21780. "$ref": "#/definitions/CommitUser"
  21781. },
  21782. "message": {
  21783. "type": "string",
  21784. "x-go-name": "Message"
  21785. },
  21786. "tree": {
  21787. "$ref": "#/definitions/CommitMeta"
  21788. },
  21789. "url": {
  21790. "type": "string",
  21791. "x-go-name": "URL"
  21792. },
  21793. "verification": {
  21794. "$ref": "#/definitions/PayloadCommitVerification"
  21795. }
  21796. },
  21797. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21798. },
  21799. "RepoTopicOptions": {
  21800. "description": "RepoTopicOptions a collection of repo topic names",
  21801. "type": "object",
  21802. "properties": {
  21803. "topics": {
  21804. "description": "list of topic names",
  21805. "type": "array",
  21806. "items": {
  21807. "type": "string"
  21808. },
  21809. "x-go-name": "Topics"
  21810. }
  21811. },
  21812. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21813. },
  21814. "RepoTransfer": {
  21815. "description": "RepoTransfer represents a pending repo transfer",
  21816. "type": "object",
  21817. "properties": {
  21818. "doer": {
  21819. "$ref": "#/definitions/User"
  21820. },
  21821. "recipient": {
  21822. "$ref": "#/definitions/User"
  21823. },
  21824. "teams": {
  21825. "type": "array",
  21826. "items": {
  21827. "$ref": "#/definitions/Team"
  21828. },
  21829. "x-go-name": "Teams"
  21830. }
  21831. },
  21832. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21833. },
  21834. "Repository": {
  21835. "description": "Repository represents a repository",
  21836. "type": "object",
  21837. "properties": {
  21838. "allow_merge_commits": {
  21839. "type": "boolean",
  21840. "x-go-name": "AllowMerge"
  21841. },
  21842. "allow_rebase": {
  21843. "type": "boolean",
  21844. "x-go-name": "AllowRebase"
  21845. },
  21846. "allow_rebase_explicit": {
  21847. "type": "boolean",
  21848. "x-go-name": "AllowRebaseMerge"
  21849. },
  21850. "allow_rebase_update": {
  21851. "type": "boolean",
  21852. "x-go-name": "AllowRebaseUpdate"
  21853. },
  21854. "allow_squash_merge": {
  21855. "type": "boolean",
  21856. "x-go-name": "AllowSquash"
  21857. },
  21858. "archived": {
  21859. "type": "boolean",
  21860. "x-go-name": "Archived"
  21861. },
  21862. "archived_at": {
  21863. "type": "string",
  21864. "format": "date-time",
  21865. "x-go-name": "ArchivedAt"
  21866. },
  21867. "avatar_url": {
  21868. "type": "string",
  21869. "x-go-name": "AvatarURL"
  21870. },
  21871. "clone_url": {
  21872. "type": "string",
  21873. "x-go-name": "CloneURL"
  21874. },
  21875. "created_at": {
  21876. "type": "string",
  21877. "format": "date-time",
  21878. "x-go-name": "Created"
  21879. },
  21880. "default_allow_maintainer_edit": {
  21881. "type": "boolean",
  21882. "x-go-name": "DefaultAllowMaintainerEdit"
  21883. },
  21884. "default_branch": {
  21885. "type": "string",
  21886. "x-go-name": "DefaultBranch"
  21887. },
  21888. "default_delete_branch_after_merge": {
  21889. "type": "boolean",
  21890. "x-go-name": "DefaultDeleteBranchAfterMerge"
  21891. },
  21892. "default_merge_style": {
  21893. "type": "string",
  21894. "x-go-name": "DefaultMergeStyle"
  21895. },
  21896. "description": {
  21897. "type": "string",
  21898. "x-go-name": "Description"
  21899. },
  21900. "empty": {
  21901. "type": "boolean",
  21902. "x-go-name": "Empty"
  21903. },
  21904. "external_tracker": {
  21905. "$ref": "#/definitions/ExternalTracker"
  21906. },
  21907. "external_wiki": {
  21908. "$ref": "#/definitions/ExternalWiki"
  21909. },
  21910. "fork": {
  21911. "type": "boolean",
  21912. "x-go-name": "Fork"
  21913. },
  21914. "forks_count": {
  21915. "type": "integer",
  21916. "format": "int64",
  21917. "x-go-name": "Forks"
  21918. },
  21919. "full_name": {
  21920. "type": "string",
  21921. "x-go-name": "FullName"
  21922. },
  21923. "has_actions": {
  21924. "type": "boolean",
  21925. "x-go-name": "HasActions"
  21926. },
  21927. "has_issues": {
  21928. "type": "boolean",
  21929. "x-go-name": "HasIssues"
  21930. },
  21931. "has_packages": {
  21932. "type": "boolean",
  21933. "x-go-name": "HasPackages"
  21934. },
  21935. "has_projects": {
  21936. "type": "boolean",
  21937. "x-go-name": "HasProjects"
  21938. },
  21939. "has_pull_requests": {
  21940. "type": "boolean",
  21941. "x-go-name": "HasPullRequests"
  21942. },
  21943. "has_releases": {
  21944. "type": "boolean",
  21945. "x-go-name": "HasReleases"
  21946. },
  21947. "has_wiki": {
  21948. "type": "boolean",
  21949. "x-go-name": "HasWiki"
  21950. },
  21951. "html_url": {
  21952. "type": "string",
  21953. "x-go-name": "HTMLURL"
  21954. },
  21955. "id": {
  21956. "type": "integer",
  21957. "format": "int64",
  21958. "x-go-name": "ID"
  21959. },
  21960. "ignore_whitespace_conflicts": {
  21961. "type": "boolean",
  21962. "x-go-name": "IgnoreWhitespaceConflicts"
  21963. },
  21964. "internal": {
  21965. "type": "boolean",
  21966. "x-go-name": "Internal"
  21967. },
  21968. "internal_tracker": {
  21969. "$ref": "#/definitions/InternalTracker"
  21970. },
  21971. "language": {
  21972. "type": "string",
  21973. "x-go-name": "Language"
  21974. },
  21975. "languages_url": {
  21976. "type": "string",
  21977. "x-go-name": "LanguagesURL"
  21978. },
  21979. "link": {
  21980. "type": "string",
  21981. "x-go-name": "Link"
  21982. },
  21983. "mirror": {
  21984. "type": "boolean",
  21985. "x-go-name": "Mirror"
  21986. },
  21987. "mirror_interval": {
  21988. "type": "string",
  21989. "x-go-name": "MirrorInterval"
  21990. },
  21991. "mirror_updated": {
  21992. "type": "string",
  21993. "format": "date-time",
  21994. "x-go-name": "MirrorUpdated"
  21995. },
  21996. "name": {
  21997. "type": "string",
  21998. "x-go-name": "Name"
  21999. },
  22000. "open_issues_count": {
  22001. "type": "integer",
  22002. "format": "int64",
  22003. "x-go-name": "OpenIssues"
  22004. },
  22005. "open_pr_counter": {
  22006. "type": "integer",
  22007. "format": "int64",
  22008. "x-go-name": "OpenPulls"
  22009. },
  22010. "original_url": {
  22011. "type": "string",
  22012. "x-go-name": "OriginalURL"
  22013. },
  22014. "owner": {
  22015. "$ref": "#/definitions/User"
  22016. },
  22017. "parent": {
  22018. "$ref": "#/definitions/Repository"
  22019. },
  22020. "permissions": {
  22021. "$ref": "#/definitions/Permission"
  22022. },
  22023. "private": {
  22024. "type": "boolean",
  22025. "x-go-name": "Private"
  22026. },
  22027. "release_counter": {
  22028. "type": "integer",
  22029. "format": "int64",
  22030. "x-go-name": "Releases"
  22031. },
  22032. "repo_transfer": {
  22033. "$ref": "#/definitions/RepoTransfer"
  22034. },
  22035. "size": {
  22036. "type": "integer",
  22037. "format": "int64",
  22038. "x-go-name": "Size"
  22039. },
  22040. "ssh_url": {
  22041. "type": "string",
  22042. "x-go-name": "SSHURL"
  22043. },
  22044. "stars_count": {
  22045. "type": "integer",
  22046. "format": "int64",
  22047. "x-go-name": "Stars"
  22048. },
  22049. "template": {
  22050. "type": "boolean",
  22051. "x-go-name": "Template"
  22052. },
  22053. "updated_at": {
  22054. "type": "string",
  22055. "format": "date-time",
  22056. "x-go-name": "Updated"
  22057. },
  22058. "url": {
  22059. "type": "string",
  22060. "x-go-name": "URL"
  22061. },
  22062. "watchers_count": {
  22063. "type": "integer",
  22064. "format": "int64",
  22065. "x-go-name": "Watchers"
  22066. },
  22067. "website": {
  22068. "type": "string",
  22069. "x-go-name": "Website"
  22070. }
  22071. },
  22072. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22073. },
  22074. "RepositoryMeta": {
  22075. "description": "RepositoryMeta basic repository information",
  22076. "type": "object",
  22077. "properties": {
  22078. "full_name": {
  22079. "type": "string",
  22080. "x-go-name": "FullName"
  22081. },
  22082. "id": {
  22083. "type": "integer",
  22084. "format": "int64",
  22085. "x-go-name": "ID"
  22086. },
  22087. "name": {
  22088. "type": "string",
  22089. "x-go-name": "Name"
  22090. },
  22091. "owner": {
  22092. "type": "string",
  22093. "x-go-name": "Owner"
  22094. }
  22095. },
  22096. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22097. },
  22098. "ReviewStateType": {
  22099. "description": "ReviewStateType review state type",
  22100. "type": "string",
  22101. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22102. },
  22103. "SearchResults": {
  22104. "description": "SearchResults results of a successful search",
  22105. "type": "object",
  22106. "properties": {
  22107. "data": {
  22108. "type": "array",
  22109. "items": {
  22110. "$ref": "#/definitions/Repository"
  22111. },
  22112. "x-go-name": "Data"
  22113. },
  22114. "ok": {
  22115. "type": "boolean",
  22116. "x-go-name": "OK"
  22117. }
  22118. },
  22119. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22120. },
  22121. "Secret": {
  22122. "description": "Secret represents a secret",
  22123. "type": "object",
  22124. "properties": {
  22125. "created_at": {
  22126. "type": "string",
  22127. "format": "date-time",
  22128. "x-go-name": "Created"
  22129. },
  22130. "name": {
  22131. "description": "the secret's name",
  22132. "type": "string",
  22133. "x-go-name": "Name"
  22134. }
  22135. },
  22136. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22137. },
  22138. "ServerVersion": {
  22139. "description": "ServerVersion wraps the version of the server",
  22140. "type": "object",
  22141. "properties": {
  22142. "version": {
  22143. "type": "string",
  22144. "x-go-name": "Version"
  22145. }
  22146. },
  22147. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22148. },
  22149. "StateType": {
  22150. "description": "StateType issue state type",
  22151. "type": "string",
  22152. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22153. },
  22154. "StopWatch": {
  22155. "description": "StopWatch represent a running stopwatch",
  22156. "type": "object",
  22157. "properties": {
  22158. "created": {
  22159. "type": "string",
  22160. "format": "date-time",
  22161. "x-go-name": "Created"
  22162. },
  22163. "duration": {
  22164. "type": "string",
  22165. "x-go-name": "Duration"
  22166. },
  22167. "issue_index": {
  22168. "type": "integer",
  22169. "format": "int64",
  22170. "x-go-name": "IssueIndex"
  22171. },
  22172. "issue_title": {
  22173. "type": "string",
  22174. "x-go-name": "IssueTitle"
  22175. },
  22176. "repo_name": {
  22177. "type": "string",
  22178. "x-go-name": "RepoName"
  22179. },
  22180. "repo_owner_name": {
  22181. "type": "string",
  22182. "x-go-name": "RepoOwnerName"
  22183. },
  22184. "seconds": {
  22185. "type": "integer",
  22186. "format": "int64",
  22187. "x-go-name": "Seconds"
  22188. }
  22189. },
  22190. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22191. },
  22192. "SubmitPullReviewOptions": {
  22193. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  22194. "type": "object",
  22195. "properties": {
  22196. "body": {
  22197. "type": "string",
  22198. "x-go-name": "Body"
  22199. },
  22200. "event": {
  22201. "$ref": "#/definitions/ReviewStateType"
  22202. }
  22203. },
  22204. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22205. },
  22206. "Tag": {
  22207. "description": "Tag represents a repository tag",
  22208. "type": "object",
  22209. "properties": {
  22210. "commit": {
  22211. "$ref": "#/definitions/CommitMeta"
  22212. },
  22213. "id": {
  22214. "type": "string",
  22215. "x-go-name": "ID"
  22216. },
  22217. "message": {
  22218. "type": "string",
  22219. "x-go-name": "Message"
  22220. },
  22221. "name": {
  22222. "type": "string",
  22223. "x-go-name": "Name"
  22224. },
  22225. "tarball_url": {
  22226. "type": "string",
  22227. "x-go-name": "TarballURL"
  22228. },
  22229. "zipball_url": {
  22230. "type": "string",
  22231. "x-go-name": "ZipballURL"
  22232. }
  22233. },
  22234. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22235. },
  22236. "Team": {
  22237. "description": "Team represents a team in an organization",
  22238. "type": "object",
  22239. "properties": {
  22240. "can_create_org_repo": {
  22241. "type": "boolean",
  22242. "x-go-name": "CanCreateOrgRepo"
  22243. },
  22244. "description": {
  22245. "type": "string",
  22246. "x-go-name": "Description"
  22247. },
  22248. "id": {
  22249. "type": "integer",
  22250. "format": "int64",
  22251. "x-go-name": "ID"
  22252. },
  22253. "includes_all_repositories": {
  22254. "type": "boolean",
  22255. "x-go-name": "IncludesAllRepositories"
  22256. },
  22257. "name": {
  22258. "type": "string",
  22259. "x-go-name": "Name"
  22260. },
  22261. "organization": {
  22262. "$ref": "#/definitions/Organization"
  22263. },
  22264. "permission": {
  22265. "type": "string",
  22266. "enum": [
  22267. "none",
  22268. "read",
  22269. "write",
  22270. "admin",
  22271. "owner"
  22272. ],
  22273. "x-go-name": "Permission"
  22274. },
  22275. "units": {
  22276. "type": "array",
  22277. "items": {
  22278. "type": "string"
  22279. },
  22280. "x-go-name": "Units",
  22281. "example": [
  22282. "repo.code",
  22283. "repo.issues",
  22284. "repo.ext_issues",
  22285. "repo.wiki",
  22286. "repo.pulls",
  22287. "repo.releases",
  22288. "repo.projects",
  22289. "repo.ext_wiki"
  22290. ]
  22291. },
  22292. "units_map": {
  22293. "type": "object",
  22294. "additionalProperties": {
  22295. "type": "string"
  22296. },
  22297. "x-go-name": "UnitsMap",
  22298. "example": {
  22299. "repo.code": "read",
  22300. "repo.ext_issues": "none",
  22301. "repo.ext_wiki": "none",
  22302. "repo.issues": "write",
  22303. "repo.projects": "none",
  22304. "repo.pulls": "owner",
  22305. "repo.releases": "none",
  22306. "repo.wiki": "admin"
  22307. }
  22308. }
  22309. },
  22310. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22311. },
  22312. "TimeStamp": {
  22313. "description": "TimeStamp defines a timestamp",
  22314. "type": "integer",
  22315. "format": "int64",
  22316. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  22317. },
  22318. "TimelineComment": {
  22319. "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
  22320. "type": "object",
  22321. "properties": {
  22322. "assignee": {
  22323. "$ref": "#/definitions/User"
  22324. },
  22325. "assignee_team": {
  22326. "$ref": "#/definitions/Team"
  22327. },
  22328. "body": {
  22329. "type": "string",
  22330. "x-go-name": "Body"
  22331. },
  22332. "created_at": {
  22333. "type": "string",
  22334. "format": "date-time",
  22335. "x-go-name": "Created"
  22336. },
  22337. "dependent_issue": {
  22338. "$ref": "#/definitions/Issue"
  22339. },
  22340. "html_url": {
  22341. "type": "string",
  22342. "x-go-name": "HTMLURL"
  22343. },
  22344. "id": {
  22345. "type": "integer",
  22346. "format": "int64",
  22347. "x-go-name": "ID"
  22348. },
  22349. "issue_url": {
  22350. "type": "string",
  22351. "x-go-name": "IssueURL"
  22352. },
  22353. "label": {
  22354. "$ref": "#/definitions/Label"
  22355. },
  22356. "milestone": {
  22357. "$ref": "#/definitions/Milestone"
  22358. },
  22359. "new_ref": {
  22360. "type": "string",
  22361. "x-go-name": "NewRef"
  22362. },
  22363. "new_title": {
  22364. "type": "string",
  22365. "x-go-name": "NewTitle"
  22366. },
  22367. "old_milestone": {
  22368. "$ref": "#/definitions/Milestone"
  22369. },
  22370. "old_project_id": {
  22371. "type": "integer",
  22372. "format": "int64",
  22373. "x-go-name": "OldProjectID"
  22374. },
  22375. "old_ref": {
  22376. "type": "string",
  22377. "x-go-name": "OldRef"
  22378. },
  22379. "old_title": {
  22380. "type": "string",
  22381. "x-go-name": "OldTitle"
  22382. },
  22383. "project_id": {
  22384. "type": "integer",
  22385. "format": "int64",
  22386. "x-go-name": "ProjectID"
  22387. },
  22388. "pull_request_url": {
  22389. "type": "string",
  22390. "x-go-name": "PRURL"
  22391. },
  22392. "ref_action": {
  22393. "type": "string",
  22394. "x-go-name": "RefAction"
  22395. },
  22396. "ref_comment": {
  22397. "$ref": "#/definitions/Comment"
  22398. },
  22399. "ref_commit_sha": {
  22400. "description": "commit SHA where issue/PR was referenced",
  22401. "type": "string",
  22402. "x-go-name": "RefCommitSHA"
  22403. },
  22404. "ref_issue": {
  22405. "$ref": "#/definitions/Issue"
  22406. },
  22407. "removed_assignee": {
  22408. "description": "whether the assignees were removed or added",
  22409. "type": "boolean",
  22410. "x-go-name": "RemovedAssignee"
  22411. },
  22412. "resolve_doer": {
  22413. "$ref": "#/definitions/User"
  22414. },
  22415. "review_id": {
  22416. "type": "integer",
  22417. "format": "int64",
  22418. "x-go-name": "ReviewID"
  22419. },
  22420. "tracked_time": {
  22421. "$ref": "#/definitions/TrackedTime"
  22422. },
  22423. "type": {
  22424. "type": "string",
  22425. "x-go-name": "Type"
  22426. },
  22427. "updated_at": {
  22428. "type": "string",
  22429. "format": "date-time",
  22430. "x-go-name": "Updated"
  22431. },
  22432. "user": {
  22433. "$ref": "#/definitions/User"
  22434. }
  22435. },
  22436. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22437. },
  22438. "TopicName": {
  22439. "description": "TopicName a list of repo topic names",
  22440. "type": "object",
  22441. "properties": {
  22442. "topics": {
  22443. "type": "array",
  22444. "items": {
  22445. "type": "string"
  22446. },
  22447. "x-go-name": "TopicNames"
  22448. }
  22449. },
  22450. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22451. },
  22452. "TopicResponse": {
  22453. "description": "TopicResponse for returning topics",
  22454. "type": "object",
  22455. "properties": {
  22456. "created": {
  22457. "type": "string",
  22458. "format": "date-time",
  22459. "x-go-name": "Created"
  22460. },
  22461. "id": {
  22462. "type": "integer",
  22463. "format": "int64",
  22464. "x-go-name": "ID"
  22465. },
  22466. "repo_count": {
  22467. "type": "integer",
  22468. "format": "int64",
  22469. "x-go-name": "RepoCount"
  22470. },
  22471. "topic_name": {
  22472. "type": "string",
  22473. "x-go-name": "Name"
  22474. },
  22475. "updated": {
  22476. "type": "string",
  22477. "format": "date-time",
  22478. "x-go-name": "Updated"
  22479. }
  22480. },
  22481. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22482. },
  22483. "TrackedTime": {
  22484. "description": "TrackedTime worked time for an issue / pr",
  22485. "type": "object",
  22486. "properties": {
  22487. "created": {
  22488. "type": "string",
  22489. "format": "date-time",
  22490. "x-go-name": "Created"
  22491. },
  22492. "id": {
  22493. "type": "integer",
  22494. "format": "int64",
  22495. "x-go-name": "ID"
  22496. },
  22497. "issue": {
  22498. "$ref": "#/definitions/Issue"
  22499. },
  22500. "issue_id": {
  22501. "description": "deprecated (only for backwards compatibility)",
  22502. "type": "integer",
  22503. "format": "int64",
  22504. "x-go-name": "IssueID"
  22505. },
  22506. "time": {
  22507. "description": "Time in seconds",
  22508. "type": "integer",
  22509. "format": "int64",
  22510. "x-go-name": "Time"
  22511. },
  22512. "user_id": {
  22513. "description": "deprecated (only for backwards compatibility)",
  22514. "type": "integer",
  22515. "format": "int64",
  22516. "x-go-name": "UserID"
  22517. },
  22518. "user_name": {
  22519. "type": "string",
  22520. "x-go-name": "UserName"
  22521. }
  22522. },
  22523. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22524. },
  22525. "TransferRepoOption": {
  22526. "description": "TransferRepoOption options when transfer a repository's ownership",
  22527. "type": "object",
  22528. "required": [
  22529. "new_owner"
  22530. ],
  22531. "properties": {
  22532. "new_owner": {
  22533. "type": "string",
  22534. "x-go-name": "NewOwner"
  22535. },
  22536. "team_ids": {
  22537. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  22538. "type": "array",
  22539. "items": {
  22540. "type": "integer",
  22541. "format": "int64"
  22542. },
  22543. "x-go-name": "TeamIDs"
  22544. }
  22545. },
  22546. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22547. },
  22548. "UpdateFileOptions": {
  22549. "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)",
  22550. "type": "object",
  22551. "required": [
  22552. "sha",
  22553. "content"
  22554. ],
  22555. "properties": {
  22556. "author": {
  22557. "$ref": "#/definitions/Identity"
  22558. },
  22559. "branch": {
  22560. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  22561. "type": "string",
  22562. "x-go-name": "BranchName"
  22563. },
  22564. "committer": {
  22565. "$ref": "#/definitions/Identity"
  22566. },
  22567. "content": {
  22568. "description": "content must be base64 encoded",
  22569. "type": "string",
  22570. "x-go-name": "ContentBase64"
  22571. },
  22572. "dates": {
  22573. "$ref": "#/definitions/CommitDateOptions"
  22574. },
  22575. "from_path": {
  22576. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  22577. "type": "string",
  22578. "x-go-name": "FromPath"
  22579. },
  22580. "message": {
  22581. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  22582. "type": "string",
  22583. "x-go-name": "Message"
  22584. },
  22585. "new_branch": {
  22586. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  22587. "type": "string",
  22588. "x-go-name": "NewBranchName"
  22589. },
  22590. "sha": {
  22591. "description": "sha is the SHA for the file that already exists",
  22592. "type": "string",
  22593. "x-go-name": "SHA"
  22594. },
  22595. "signoff": {
  22596. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  22597. "type": "boolean",
  22598. "x-go-name": "Signoff"
  22599. }
  22600. },
  22601. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22602. },
  22603. "UpdateRepoAvatarOption": {
  22604. "description": "UpdateRepoAvatarUserOption options when updating the repo avatar",
  22605. "type": "object",
  22606. "properties": {
  22607. "image": {
  22608. "description": "image must be base64 encoded",
  22609. "type": "string",
  22610. "x-go-name": "Image"
  22611. }
  22612. },
  22613. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22614. },
  22615. "UpdateUserAvatarOption": {
  22616. "description": "UpdateUserAvatarUserOption options when updating the user avatar",
  22617. "type": "object",
  22618. "properties": {
  22619. "image": {
  22620. "description": "image must be base64 encoded",
  22621. "type": "string",
  22622. "x-go-name": "Image"
  22623. }
  22624. },
  22625. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22626. },
  22627. "User": {
  22628. "description": "User represents a user",
  22629. "type": "object",
  22630. "properties": {
  22631. "active": {
  22632. "description": "Is user active",
  22633. "type": "boolean",
  22634. "x-go-name": "IsActive"
  22635. },
  22636. "avatar_url": {
  22637. "description": "URL to the user's avatar",
  22638. "type": "string",
  22639. "x-go-name": "AvatarURL"
  22640. },
  22641. "created": {
  22642. "type": "string",
  22643. "format": "date-time",
  22644. "x-go-name": "Created"
  22645. },
  22646. "description": {
  22647. "description": "the user's description",
  22648. "type": "string",
  22649. "x-go-name": "Description"
  22650. },
  22651. "email": {
  22652. "type": "string",
  22653. "format": "email",
  22654. "x-go-name": "Email"
  22655. },
  22656. "followers_count": {
  22657. "description": "user counts",
  22658. "type": "integer",
  22659. "format": "int64",
  22660. "x-go-name": "Followers"
  22661. },
  22662. "following_count": {
  22663. "type": "integer",
  22664. "format": "int64",
  22665. "x-go-name": "Following"
  22666. },
  22667. "full_name": {
  22668. "description": "the user's full name",
  22669. "type": "string",
  22670. "x-go-name": "FullName"
  22671. },
  22672. "id": {
  22673. "description": "the user's id",
  22674. "type": "integer",
  22675. "format": "int64",
  22676. "x-go-name": "ID"
  22677. },
  22678. "is_admin": {
  22679. "description": "Is the user an administrator",
  22680. "type": "boolean",
  22681. "x-go-name": "IsAdmin"
  22682. },
  22683. "language": {
  22684. "description": "User locale",
  22685. "type": "string",
  22686. "x-go-name": "Language"
  22687. },
  22688. "last_login": {
  22689. "type": "string",
  22690. "format": "date-time",
  22691. "x-go-name": "LastLogin"
  22692. },
  22693. "location": {
  22694. "description": "the user's location",
  22695. "type": "string",
  22696. "x-go-name": "Location"
  22697. },
  22698. "login": {
  22699. "description": "the user's username",
  22700. "type": "string",
  22701. "x-go-name": "UserName"
  22702. },
  22703. "login_name": {
  22704. "description": "the user's authentication sign-in name.",
  22705. "type": "string",
  22706. "default": "empty",
  22707. "x-go-name": "LoginName"
  22708. },
  22709. "prohibit_login": {
  22710. "description": "Is user login prohibited",
  22711. "type": "boolean",
  22712. "x-go-name": "ProhibitLogin"
  22713. },
  22714. "restricted": {
  22715. "description": "Is user restricted",
  22716. "type": "boolean",
  22717. "x-go-name": "Restricted"
  22718. },
  22719. "starred_repos_count": {
  22720. "type": "integer",
  22721. "format": "int64",
  22722. "x-go-name": "StarredRepos"
  22723. },
  22724. "visibility": {
  22725. "description": "User visibility level option: public, limited, private",
  22726. "type": "string",
  22727. "x-go-name": "Visibility"
  22728. },
  22729. "website": {
  22730. "description": "the user's website",
  22731. "type": "string",
  22732. "x-go-name": "Website"
  22733. }
  22734. },
  22735. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22736. },
  22737. "UserHeatmapData": {
  22738. "description": "UserHeatmapData represents the data needed to create a heatmap",
  22739. "type": "object",
  22740. "properties": {
  22741. "contributions": {
  22742. "type": "integer",
  22743. "format": "int64",
  22744. "x-go-name": "Contributions"
  22745. },
  22746. "timestamp": {
  22747. "$ref": "#/definitions/TimeStamp"
  22748. }
  22749. },
  22750. "x-go-package": "code.gitea.io/gitea/models/activities"
  22751. },
  22752. "UserSettings": {
  22753. "description": "UserSettings represents user settings",
  22754. "type": "object",
  22755. "properties": {
  22756. "description": {
  22757. "type": "string",
  22758. "x-go-name": "Description"
  22759. },
  22760. "diff_view_style": {
  22761. "type": "string",
  22762. "x-go-name": "DiffViewStyle"
  22763. },
  22764. "full_name": {
  22765. "type": "string",
  22766. "x-go-name": "FullName"
  22767. },
  22768. "hide_activity": {
  22769. "type": "boolean",
  22770. "x-go-name": "HideActivity"
  22771. },
  22772. "hide_email": {
  22773. "description": "Privacy",
  22774. "type": "boolean",
  22775. "x-go-name": "HideEmail"
  22776. },
  22777. "language": {
  22778. "type": "string",
  22779. "x-go-name": "Language"
  22780. },
  22781. "location": {
  22782. "type": "string",
  22783. "x-go-name": "Location"
  22784. },
  22785. "theme": {
  22786. "type": "string",
  22787. "x-go-name": "Theme"
  22788. },
  22789. "website": {
  22790. "type": "string",
  22791. "x-go-name": "Website"
  22792. }
  22793. },
  22794. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22795. },
  22796. "UserSettingsOptions": {
  22797. "description": "UserSettingsOptions represents options to change user settings",
  22798. "type": "object",
  22799. "properties": {
  22800. "description": {
  22801. "type": "string",
  22802. "x-go-name": "Description"
  22803. },
  22804. "diff_view_style": {
  22805. "type": "string",
  22806. "x-go-name": "DiffViewStyle"
  22807. },
  22808. "full_name": {
  22809. "type": "string",
  22810. "x-go-name": "FullName"
  22811. },
  22812. "hide_activity": {
  22813. "type": "boolean",
  22814. "x-go-name": "HideActivity"
  22815. },
  22816. "hide_email": {
  22817. "description": "Privacy",
  22818. "type": "boolean",
  22819. "x-go-name": "HideEmail"
  22820. },
  22821. "language": {
  22822. "type": "string",
  22823. "x-go-name": "Language"
  22824. },
  22825. "location": {
  22826. "type": "string",
  22827. "x-go-name": "Location"
  22828. },
  22829. "theme": {
  22830. "type": "string",
  22831. "x-go-name": "Theme"
  22832. },
  22833. "website": {
  22834. "type": "string",
  22835. "x-go-name": "Website"
  22836. }
  22837. },
  22838. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22839. },
  22840. "WatchInfo": {
  22841. "description": "WatchInfo represents an API watch status of one repository",
  22842. "type": "object",
  22843. "properties": {
  22844. "created_at": {
  22845. "type": "string",
  22846. "format": "date-time",
  22847. "x-go-name": "CreatedAt"
  22848. },
  22849. "ignored": {
  22850. "type": "boolean",
  22851. "x-go-name": "Ignored"
  22852. },
  22853. "reason": {
  22854. "x-go-name": "Reason"
  22855. },
  22856. "repository_url": {
  22857. "type": "string",
  22858. "x-go-name": "RepositoryURL"
  22859. },
  22860. "subscribed": {
  22861. "type": "boolean",
  22862. "x-go-name": "Subscribed"
  22863. },
  22864. "url": {
  22865. "type": "string",
  22866. "x-go-name": "URL"
  22867. }
  22868. },
  22869. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22870. },
  22871. "WikiCommit": {
  22872. "description": "WikiCommit page commit/revision",
  22873. "type": "object",
  22874. "properties": {
  22875. "author": {
  22876. "$ref": "#/definitions/CommitUser"
  22877. },
  22878. "commiter": {
  22879. "$ref": "#/definitions/CommitUser"
  22880. },
  22881. "message": {
  22882. "type": "string",
  22883. "x-go-name": "Message"
  22884. },
  22885. "sha": {
  22886. "type": "string",
  22887. "x-go-name": "ID"
  22888. }
  22889. },
  22890. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22891. },
  22892. "WikiCommitList": {
  22893. "description": "WikiCommitList commit/revision list",
  22894. "type": "object",
  22895. "properties": {
  22896. "commits": {
  22897. "type": "array",
  22898. "items": {
  22899. "$ref": "#/definitions/WikiCommit"
  22900. },
  22901. "x-go-name": "WikiCommits"
  22902. },
  22903. "count": {
  22904. "type": "integer",
  22905. "format": "int64",
  22906. "x-go-name": "Count"
  22907. }
  22908. },
  22909. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22910. },
  22911. "WikiPage": {
  22912. "description": "WikiPage a wiki page",
  22913. "type": "object",
  22914. "properties": {
  22915. "commit_count": {
  22916. "type": "integer",
  22917. "format": "int64",
  22918. "x-go-name": "CommitCount"
  22919. },
  22920. "content_base64": {
  22921. "description": "Page content, base64 encoded",
  22922. "type": "string",
  22923. "x-go-name": "ContentBase64"
  22924. },
  22925. "footer": {
  22926. "type": "string",
  22927. "x-go-name": "Footer"
  22928. },
  22929. "html_url": {
  22930. "type": "string",
  22931. "x-go-name": "HTMLURL"
  22932. },
  22933. "last_commit": {
  22934. "$ref": "#/definitions/WikiCommit"
  22935. },
  22936. "sidebar": {
  22937. "type": "string",
  22938. "x-go-name": "Sidebar"
  22939. },
  22940. "sub_url": {
  22941. "type": "string",
  22942. "x-go-name": "SubURL"
  22943. },
  22944. "title": {
  22945. "type": "string",
  22946. "x-go-name": "Title"
  22947. }
  22948. },
  22949. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22950. },
  22951. "WikiPageMetaData": {
  22952. "description": "WikiPageMetaData wiki page meta information",
  22953. "type": "object",
  22954. "properties": {
  22955. "html_url": {
  22956. "type": "string",
  22957. "x-go-name": "HTMLURL"
  22958. },
  22959. "last_commit": {
  22960. "$ref": "#/definitions/WikiCommit"
  22961. },
  22962. "sub_url": {
  22963. "type": "string",
  22964. "x-go-name": "SubURL"
  22965. },
  22966. "title": {
  22967. "type": "string",
  22968. "x-go-name": "Title"
  22969. }
  22970. },
  22971. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22972. }
  22973. },
  22974. "responses": {
  22975. "AccessToken": {
  22976. "description": "AccessToken represents an API access token.",
  22977. "schema": {
  22978. "$ref": "#/definitions/AccessToken"
  22979. }
  22980. },
  22981. "AccessTokenList": {
  22982. "description": "AccessTokenList represents a list of API access token.",
  22983. "schema": {
  22984. "type": "array",
  22985. "items": {
  22986. "$ref": "#/definitions/AccessToken"
  22987. }
  22988. }
  22989. },
  22990. "ActivityFeedsList": {
  22991. "description": "ActivityFeedsList",
  22992. "schema": {
  22993. "type": "array",
  22994. "items": {
  22995. "$ref": "#/definitions/Activity"
  22996. }
  22997. }
  22998. },
  22999. "ActivityPub": {
  23000. "description": "ActivityPub",
  23001. "schema": {
  23002. "$ref": "#/definitions/ActivityPub"
  23003. }
  23004. },
  23005. "AnnotatedTag": {
  23006. "description": "AnnotatedTag",
  23007. "schema": {
  23008. "$ref": "#/definitions/AnnotatedTag"
  23009. }
  23010. },
  23011. "Attachment": {
  23012. "description": "Attachment",
  23013. "schema": {
  23014. "$ref": "#/definitions/Attachment"
  23015. }
  23016. },
  23017. "AttachmentList": {
  23018. "description": "AttachmentList",
  23019. "schema": {
  23020. "type": "array",
  23021. "items": {
  23022. "$ref": "#/definitions/Attachment"
  23023. }
  23024. }
  23025. },
  23026. "Branch": {
  23027. "description": "Branch",
  23028. "schema": {
  23029. "$ref": "#/definitions/Branch"
  23030. }
  23031. },
  23032. "BranchList": {
  23033. "description": "BranchList",
  23034. "schema": {
  23035. "type": "array",
  23036. "items": {
  23037. "$ref": "#/definitions/Branch"
  23038. }
  23039. }
  23040. },
  23041. "BranchProtection": {
  23042. "description": "BranchProtection",
  23043. "schema": {
  23044. "$ref": "#/definitions/BranchProtection"
  23045. }
  23046. },
  23047. "BranchProtectionList": {
  23048. "description": "BranchProtectionList",
  23049. "schema": {
  23050. "type": "array",
  23051. "items": {
  23052. "$ref": "#/definitions/BranchProtection"
  23053. }
  23054. }
  23055. },
  23056. "ChangedFileList": {
  23057. "description": "ChangedFileList",
  23058. "schema": {
  23059. "type": "array",
  23060. "items": {
  23061. "$ref": "#/definitions/ChangedFile"
  23062. }
  23063. },
  23064. "headers": {
  23065. "X-HasMore": {
  23066. "type": "boolean",
  23067. "description": "True if there is another page"
  23068. },
  23069. "X-Page": {
  23070. "type": "integer",
  23071. "format": "int64",
  23072. "description": "The current page"
  23073. },
  23074. "X-PageCount": {
  23075. "type": "integer",
  23076. "format": "int64",
  23077. "description": "Total number of pages"
  23078. },
  23079. "X-PerPage": {
  23080. "type": "integer",
  23081. "format": "int64",
  23082. "description": "Commits per page"
  23083. },
  23084. "X-Total": {
  23085. "type": "integer",
  23086. "format": "int64",
  23087. "description": "Total commit count"
  23088. }
  23089. }
  23090. },
  23091. "CombinedStatus": {
  23092. "description": "CombinedStatus",
  23093. "schema": {
  23094. "$ref": "#/definitions/CombinedStatus"
  23095. }
  23096. },
  23097. "Comment": {
  23098. "description": "Comment",
  23099. "schema": {
  23100. "$ref": "#/definitions/Comment"
  23101. }
  23102. },
  23103. "CommentList": {
  23104. "description": "CommentList",
  23105. "schema": {
  23106. "type": "array",
  23107. "items": {
  23108. "$ref": "#/definitions/Comment"
  23109. }
  23110. }
  23111. },
  23112. "Commit": {
  23113. "description": "Commit",
  23114. "schema": {
  23115. "$ref": "#/definitions/Commit"
  23116. }
  23117. },
  23118. "CommitList": {
  23119. "description": "CommitList",
  23120. "schema": {
  23121. "type": "array",
  23122. "items": {
  23123. "$ref": "#/definitions/Commit"
  23124. }
  23125. },
  23126. "headers": {
  23127. "X-HasMore": {
  23128. "type": "boolean",
  23129. "description": "True if there is another page"
  23130. },
  23131. "X-Page": {
  23132. "type": "integer",
  23133. "format": "int64",
  23134. "description": "The current page"
  23135. },
  23136. "X-PageCount": {
  23137. "type": "integer",
  23138. "format": "int64",
  23139. "description": "Total number of pages"
  23140. },
  23141. "X-PerPage": {
  23142. "type": "integer",
  23143. "format": "int64",
  23144. "description": "Commits per page"
  23145. },
  23146. "X-Total": {
  23147. "type": "integer",
  23148. "format": "int64",
  23149. "description": "Total commit count"
  23150. }
  23151. }
  23152. },
  23153. "CommitStatus": {
  23154. "description": "CommitStatus",
  23155. "schema": {
  23156. "$ref": "#/definitions/CommitStatus"
  23157. }
  23158. },
  23159. "CommitStatusList": {
  23160. "description": "CommitStatusList",
  23161. "schema": {
  23162. "type": "array",
  23163. "items": {
  23164. "$ref": "#/definitions/CommitStatus"
  23165. }
  23166. }
  23167. },
  23168. "ContentsListResponse": {
  23169. "description": "ContentsListResponse",
  23170. "schema": {
  23171. "type": "array",
  23172. "items": {
  23173. "$ref": "#/definitions/ContentsResponse"
  23174. }
  23175. }
  23176. },
  23177. "ContentsResponse": {
  23178. "description": "ContentsResponse",
  23179. "schema": {
  23180. "$ref": "#/definitions/ContentsResponse"
  23181. }
  23182. },
  23183. "CronList": {
  23184. "description": "CronList",
  23185. "schema": {
  23186. "type": "array",
  23187. "items": {
  23188. "$ref": "#/definitions/Cron"
  23189. }
  23190. }
  23191. },
  23192. "DeployKey": {
  23193. "description": "DeployKey",
  23194. "schema": {
  23195. "$ref": "#/definitions/DeployKey"
  23196. }
  23197. },
  23198. "DeployKeyList": {
  23199. "description": "DeployKeyList",
  23200. "schema": {
  23201. "type": "array",
  23202. "items": {
  23203. "$ref": "#/definitions/DeployKey"
  23204. }
  23205. }
  23206. },
  23207. "EmailList": {
  23208. "description": "EmailList",
  23209. "schema": {
  23210. "type": "array",
  23211. "items": {
  23212. "$ref": "#/definitions/Email"
  23213. }
  23214. }
  23215. },
  23216. "EmptyRepository": {
  23217. "description": "EmptyRepository",
  23218. "schema": {
  23219. "$ref": "#/definitions/APIError"
  23220. }
  23221. },
  23222. "FileDeleteResponse": {
  23223. "description": "FileDeleteResponse",
  23224. "schema": {
  23225. "$ref": "#/definitions/FileDeleteResponse"
  23226. }
  23227. },
  23228. "FileResponse": {
  23229. "description": "FileResponse",
  23230. "schema": {
  23231. "$ref": "#/definitions/FileResponse"
  23232. }
  23233. },
  23234. "FilesResponse": {
  23235. "description": "FilesResponse",
  23236. "schema": {
  23237. "$ref": "#/definitions/FilesResponse"
  23238. }
  23239. },
  23240. "GPGKey": {
  23241. "description": "GPGKey",
  23242. "schema": {
  23243. "$ref": "#/definitions/GPGKey"
  23244. }
  23245. },
  23246. "GPGKeyList": {
  23247. "description": "GPGKeyList",
  23248. "schema": {
  23249. "type": "array",
  23250. "items": {
  23251. "$ref": "#/definitions/GPGKey"
  23252. }
  23253. }
  23254. },
  23255. "GeneralAPISettings": {
  23256. "description": "GeneralAPISettings",
  23257. "schema": {
  23258. "$ref": "#/definitions/GeneralAPISettings"
  23259. }
  23260. },
  23261. "GeneralAttachmentSettings": {
  23262. "description": "GeneralAttachmentSettings",
  23263. "schema": {
  23264. "$ref": "#/definitions/GeneralAttachmentSettings"
  23265. }
  23266. },
  23267. "GeneralRepoSettings": {
  23268. "description": "GeneralRepoSettings",
  23269. "schema": {
  23270. "$ref": "#/definitions/GeneralRepoSettings"
  23271. }
  23272. },
  23273. "GeneralUISettings": {
  23274. "description": "GeneralUISettings",
  23275. "schema": {
  23276. "$ref": "#/definitions/GeneralUISettings"
  23277. }
  23278. },
  23279. "GitBlobResponse": {
  23280. "description": "GitBlobResponse",
  23281. "schema": {
  23282. "$ref": "#/definitions/GitBlobResponse"
  23283. }
  23284. },
  23285. "GitHook": {
  23286. "description": "GitHook",
  23287. "schema": {
  23288. "$ref": "#/definitions/GitHook"
  23289. }
  23290. },
  23291. "GitHookList": {
  23292. "description": "GitHookList",
  23293. "schema": {
  23294. "type": "array",
  23295. "items": {
  23296. "$ref": "#/definitions/GitHook"
  23297. }
  23298. }
  23299. },
  23300. "GitTreeResponse": {
  23301. "description": "GitTreeResponse",
  23302. "schema": {
  23303. "$ref": "#/definitions/GitTreeResponse"
  23304. }
  23305. },
  23306. "GitignoreTemplateInfo": {
  23307. "description": "GitignoreTemplateInfo",
  23308. "schema": {
  23309. "$ref": "#/definitions/GitignoreTemplateInfo"
  23310. }
  23311. },
  23312. "GitignoreTemplateList": {
  23313. "description": "GitignoreTemplateList",
  23314. "schema": {
  23315. "type": "array",
  23316. "items": {
  23317. "type": "string"
  23318. }
  23319. }
  23320. },
  23321. "Hook": {
  23322. "description": "Hook",
  23323. "schema": {
  23324. "$ref": "#/definitions/Hook"
  23325. }
  23326. },
  23327. "HookList": {
  23328. "description": "HookList",
  23329. "schema": {
  23330. "type": "array",
  23331. "items": {
  23332. "$ref": "#/definitions/Hook"
  23333. }
  23334. }
  23335. },
  23336. "Issue": {
  23337. "description": "Issue",
  23338. "schema": {
  23339. "$ref": "#/definitions/Issue"
  23340. }
  23341. },
  23342. "IssueDeadline": {
  23343. "description": "IssueDeadline",
  23344. "schema": {
  23345. "$ref": "#/definitions/IssueDeadline"
  23346. }
  23347. },
  23348. "IssueList": {
  23349. "description": "IssueList",
  23350. "schema": {
  23351. "type": "array",
  23352. "items": {
  23353. "$ref": "#/definitions/Issue"
  23354. }
  23355. }
  23356. },
  23357. "IssueTemplates": {
  23358. "description": "IssueTemplates",
  23359. "schema": {
  23360. "type": "array",
  23361. "items": {
  23362. "$ref": "#/definitions/IssueTemplate"
  23363. }
  23364. }
  23365. },
  23366. "Label": {
  23367. "description": "Label",
  23368. "schema": {
  23369. "$ref": "#/definitions/Label"
  23370. }
  23371. },
  23372. "LabelList": {
  23373. "description": "LabelList",
  23374. "schema": {
  23375. "type": "array",
  23376. "items": {
  23377. "$ref": "#/definitions/Label"
  23378. }
  23379. }
  23380. },
  23381. "LabelTemplateInfo": {
  23382. "description": "LabelTemplateInfo",
  23383. "schema": {
  23384. "type": "array",
  23385. "items": {
  23386. "$ref": "#/definitions/LabelTemplate"
  23387. }
  23388. }
  23389. },
  23390. "LabelTemplateList": {
  23391. "description": "LabelTemplateList",
  23392. "schema": {
  23393. "type": "array",
  23394. "items": {
  23395. "type": "string"
  23396. }
  23397. }
  23398. },
  23399. "LanguageStatistics": {
  23400. "description": "LanguageStatistics",
  23401. "schema": {
  23402. "type": "object",
  23403. "additionalProperties": {
  23404. "type": "integer",
  23405. "format": "int64"
  23406. }
  23407. }
  23408. },
  23409. "LicenseTemplateInfo": {
  23410. "description": "LicenseTemplateInfo",
  23411. "schema": {
  23412. "$ref": "#/definitions/LicenseTemplateInfo"
  23413. }
  23414. },
  23415. "LicenseTemplateList": {
  23416. "description": "LicenseTemplateList",
  23417. "schema": {
  23418. "type": "array",
  23419. "items": {
  23420. "$ref": "#/definitions/LicensesTemplateListEntry"
  23421. }
  23422. }
  23423. },
  23424. "MarkdownRender": {
  23425. "description": "MarkdownRender is a rendered markdown document",
  23426. "schema": {
  23427. "type": "string"
  23428. }
  23429. },
  23430. "MarkupRender": {
  23431. "description": "MarkupRender is a rendered markup document",
  23432. "schema": {
  23433. "type": "string"
  23434. }
  23435. },
  23436. "Milestone": {
  23437. "description": "Milestone",
  23438. "schema": {
  23439. "$ref": "#/definitions/Milestone"
  23440. }
  23441. },
  23442. "MilestoneList": {
  23443. "description": "MilestoneList",
  23444. "schema": {
  23445. "type": "array",
  23446. "items": {
  23447. "$ref": "#/definitions/Milestone"
  23448. }
  23449. }
  23450. },
  23451. "NodeInfo": {
  23452. "description": "NodeInfo",
  23453. "schema": {
  23454. "$ref": "#/definitions/NodeInfo"
  23455. }
  23456. },
  23457. "Note": {
  23458. "description": "Note",
  23459. "schema": {
  23460. "$ref": "#/definitions/Note"
  23461. }
  23462. },
  23463. "NotificationCount": {
  23464. "description": "Number of unread notifications",
  23465. "schema": {
  23466. "$ref": "#/definitions/NotificationCount"
  23467. }
  23468. },
  23469. "NotificationThread": {
  23470. "description": "NotificationThread",
  23471. "schema": {
  23472. "$ref": "#/definitions/NotificationThread"
  23473. }
  23474. },
  23475. "NotificationThreadList": {
  23476. "description": "NotificationThreadList",
  23477. "schema": {
  23478. "type": "array",
  23479. "items": {
  23480. "$ref": "#/definitions/NotificationThread"
  23481. }
  23482. }
  23483. },
  23484. "OAuth2Application": {
  23485. "description": "OAuth2Application",
  23486. "schema": {
  23487. "$ref": "#/definitions/OAuth2Application"
  23488. }
  23489. },
  23490. "OAuth2ApplicationList": {
  23491. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  23492. "schema": {
  23493. "type": "array",
  23494. "items": {
  23495. "$ref": "#/definitions/OAuth2Application"
  23496. }
  23497. }
  23498. },
  23499. "Organization": {
  23500. "description": "Organization",
  23501. "schema": {
  23502. "$ref": "#/definitions/Organization"
  23503. }
  23504. },
  23505. "OrganizationList": {
  23506. "description": "OrganizationList",
  23507. "schema": {
  23508. "type": "array",
  23509. "items": {
  23510. "$ref": "#/definitions/Organization"
  23511. }
  23512. }
  23513. },
  23514. "OrganizationPermissions": {
  23515. "description": "OrganizationPermissions",
  23516. "schema": {
  23517. "$ref": "#/definitions/OrganizationPermissions"
  23518. }
  23519. },
  23520. "Package": {
  23521. "description": "Package",
  23522. "schema": {
  23523. "$ref": "#/definitions/Package"
  23524. }
  23525. },
  23526. "PackageFileList": {
  23527. "description": "PackageFileList",
  23528. "schema": {
  23529. "type": "array",
  23530. "items": {
  23531. "$ref": "#/definitions/PackageFile"
  23532. }
  23533. }
  23534. },
  23535. "PackageList": {
  23536. "description": "PackageList",
  23537. "schema": {
  23538. "type": "array",
  23539. "items": {
  23540. "$ref": "#/definitions/Package"
  23541. }
  23542. }
  23543. },
  23544. "PublicKey": {
  23545. "description": "PublicKey",
  23546. "schema": {
  23547. "$ref": "#/definitions/PublicKey"
  23548. }
  23549. },
  23550. "PublicKeyList": {
  23551. "description": "PublicKeyList",
  23552. "schema": {
  23553. "type": "array",
  23554. "items": {
  23555. "$ref": "#/definitions/PublicKey"
  23556. }
  23557. }
  23558. },
  23559. "PullRequest": {
  23560. "description": "PullRequest",
  23561. "schema": {
  23562. "$ref": "#/definitions/PullRequest"
  23563. }
  23564. },
  23565. "PullRequestList": {
  23566. "description": "PullRequestList",
  23567. "schema": {
  23568. "type": "array",
  23569. "items": {
  23570. "$ref": "#/definitions/PullRequest"
  23571. }
  23572. }
  23573. },
  23574. "PullReview": {
  23575. "description": "PullReview",
  23576. "schema": {
  23577. "$ref": "#/definitions/PullReview"
  23578. }
  23579. },
  23580. "PullReviewComment": {
  23581. "description": "PullComment",
  23582. "schema": {
  23583. "$ref": "#/definitions/PullReviewComment"
  23584. }
  23585. },
  23586. "PullReviewCommentList": {
  23587. "description": "PullCommentList",
  23588. "schema": {
  23589. "type": "array",
  23590. "items": {
  23591. "$ref": "#/definitions/PullReviewComment"
  23592. }
  23593. }
  23594. },
  23595. "PullReviewList": {
  23596. "description": "PullReviewList",
  23597. "schema": {
  23598. "type": "array",
  23599. "items": {
  23600. "$ref": "#/definitions/PullReview"
  23601. }
  23602. }
  23603. },
  23604. "PushMirror": {
  23605. "description": "PushMirror",
  23606. "schema": {
  23607. "$ref": "#/definitions/PushMirror"
  23608. }
  23609. },
  23610. "PushMirrorList": {
  23611. "description": "PushMirrorList",
  23612. "schema": {
  23613. "type": "array",
  23614. "items": {
  23615. "$ref": "#/definitions/PushMirror"
  23616. }
  23617. }
  23618. },
  23619. "Reaction": {
  23620. "description": "Reaction",
  23621. "schema": {
  23622. "$ref": "#/definitions/Reaction"
  23623. }
  23624. },
  23625. "ReactionList": {
  23626. "description": "ReactionList",
  23627. "schema": {
  23628. "type": "array",
  23629. "items": {
  23630. "$ref": "#/definitions/Reaction"
  23631. }
  23632. }
  23633. },
  23634. "Reference": {
  23635. "description": "Reference",
  23636. "schema": {
  23637. "$ref": "#/definitions/Reference"
  23638. }
  23639. },
  23640. "ReferenceList": {
  23641. "description": "ReferenceList",
  23642. "schema": {
  23643. "type": "array",
  23644. "items": {
  23645. "$ref": "#/definitions/Reference"
  23646. }
  23647. }
  23648. },
  23649. "Release": {
  23650. "description": "Release",
  23651. "schema": {
  23652. "$ref": "#/definitions/Release"
  23653. }
  23654. },
  23655. "ReleaseList": {
  23656. "description": "ReleaseList",
  23657. "schema": {
  23658. "type": "array",
  23659. "items": {
  23660. "$ref": "#/definitions/Release"
  23661. }
  23662. }
  23663. },
  23664. "RepoCollaboratorPermission": {
  23665. "description": "RepoCollaboratorPermission",
  23666. "schema": {
  23667. "$ref": "#/definitions/RepoCollaboratorPermission"
  23668. }
  23669. },
  23670. "RepoIssueConfig": {
  23671. "description": "RepoIssueConfig",
  23672. "schema": {
  23673. "$ref": "#/definitions/IssueConfig"
  23674. }
  23675. },
  23676. "RepoIssueConfigValidation": {
  23677. "description": "RepoIssueConfigValidation",
  23678. "schema": {
  23679. "$ref": "#/definitions/IssueConfigValidation"
  23680. }
  23681. },
  23682. "RepoNewIssuePinsAllowed": {
  23683. "description": "RepoNewIssuePinsAllowed",
  23684. "schema": {
  23685. "$ref": "#/definitions/NewIssuePinsAllowed"
  23686. }
  23687. },
  23688. "Repository": {
  23689. "description": "Repository",
  23690. "schema": {
  23691. "$ref": "#/definitions/Repository"
  23692. }
  23693. },
  23694. "RepositoryList": {
  23695. "description": "RepositoryList",
  23696. "schema": {
  23697. "type": "array",
  23698. "items": {
  23699. "$ref": "#/definitions/Repository"
  23700. }
  23701. }
  23702. },
  23703. "SearchResults": {
  23704. "description": "SearchResults",
  23705. "schema": {
  23706. "$ref": "#/definitions/SearchResults"
  23707. }
  23708. },
  23709. "Secret": {
  23710. "description": "Secret",
  23711. "schema": {
  23712. "$ref": "#/definitions/Secret"
  23713. }
  23714. },
  23715. "SecretList": {
  23716. "description": "SecretList",
  23717. "schema": {
  23718. "type": "array",
  23719. "items": {
  23720. "$ref": "#/definitions/Secret"
  23721. }
  23722. }
  23723. },
  23724. "ServerVersion": {
  23725. "description": "ServerVersion",
  23726. "schema": {
  23727. "$ref": "#/definitions/ServerVersion"
  23728. }
  23729. },
  23730. "StopWatch": {
  23731. "description": "StopWatch",
  23732. "schema": {
  23733. "$ref": "#/definitions/StopWatch"
  23734. }
  23735. },
  23736. "StopWatchList": {
  23737. "description": "StopWatchList",
  23738. "schema": {
  23739. "type": "array",
  23740. "items": {
  23741. "$ref": "#/definitions/StopWatch"
  23742. }
  23743. }
  23744. },
  23745. "StringSlice": {
  23746. "description": "StringSlice",
  23747. "schema": {
  23748. "type": "array",
  23749. "items": {
  23750. "type": "string"
  23751. }
  23752. }
  23753. },
  23754. "Tag": {
  23755. "description": "Tag",
  23756. "schema": {
  23757. "$ref": "#/definitions/Tag"
  23758. }
  23759. },
  23760. "TagList": {
  23761. "description": "TagList",
  23762. "schema": {
  23763. "type": "array",
  23764. "items": {
  23765. "$ref": "#/definitions/Tag"
  23766. }
  23767. }
  23768. },
  23769. "Team": {
  23770. "description": "Team",
  23771. "schema": {
  23772. "$ref": "#/definitions/Team"
  23773. }
  23774. },
  23775. "TeamList": {
  23776. "description": "TeamList",
  23777. "schema": {
  23778. "type": "array",
  23779. "items": {
  23780. "$ref": "#/definitions/Team"
  23781. }
  23782. }
  23783. },
  23784. "TimelineList": {
  23785. "description": "TimelineList",
  23786. "schema": {
  23787. "type": "array",
  23788. "items": {
  23789. "$ref": "#/definitions/TimelineComment"
  23790. }
  23791. }
  23792. },
  23793. "TopicListResponse": {
  23794. "description": "TopicListResponse",
  23795. "schema": {
  23796. "type": "array",
  23797. "items": {
  23798. "$ref": "#/definitions/TopicResponse"
  23799. }
  23800. }
  23801. },
  23802. "TopicNames": {
  23803. "description": "TopicNames",
  23804. "schema": {
  23805. "$ref": "#/definitions/TopicName"
  23806. }
  23807. },
  23808. "TrackedTime": {
  23809. "description": "TrackedTime",
  23810. "schema": {
  23811. "$ref": "#/definitions/TrackedTime"
  23812. }
  23813. },
  23814. "TrackedTimeList": {
  23815. "description": "TrackedTimeList",
  23816. "schema": {
  23817. "type": "array",
  23818. "items": {
  23819. "$ref": "#/definitions/TrackedTime"
  23820. }
  23821. }
  23822. },
  23823. "User": {
  23824. "description": "User",
  23825. "schema": {
  23826. "$ref": "#/definitions/User"
  23827. }
  23828. },
  23829. "UserHeatmapData": {
  23830. "description": "UserHeatmapData",
  23831. "schema": {
  23832. "type": "array",
  23833. "items": {
  23834. "$ref": "#/definitions/UserHeatmapData"
  23835. }
  23836. }
  23837. },
  23838. "UserList": {
  23839. "description": "UserList",
  23840. "schema": {
  23841. "type": "array",
  23842. "items": {
  23843. "$ref": "#/definitions/User"
  23844. }
  23845. }
  23846. },
  23847. "UserSettings": {
  23848. "description": "UserSettings",
  23849. "schema": {
  23850. "type": "array",
  23851. "items": {
  23852. "$ref": "#/definitions/UserSettings"
  23853. }
  23854. }
  23855. },
  23856. "WatchInfo": {
  23857. "description": "WatchInfo",
  23858. "schema": {
  23859. "$ref": "#/definitions/WatchInfo"
  23860. }
  23861. },
  23862. "WikiCommitList": {
  23863. "description": "WikiCommitList",
  23864. "schema": {
  23865. "$ref": "#/definitions/WikiCommitList"
  23866. }
  23867. },
  23868. "WikiPage": {
  23869. "description": "WikiPage",
  23870. "schema": {
  23871. "$ref": "#/definitions/WikiPage"
  23872. }
  23873. },
  23874. "WikiPageList": {
  23875. "description": "WikiPageList",
  23876. "schema": {
  23877. "type": "array",
  23878. "items": {
  23879. "$ref": "#/definitions/WikiPageMetaData"
  23880. }
  23881. }
  23882. },
  23883. "conflict": {
  23884. "description": "APIConflict is a conflict empty response"
  23885. },
  23886. "empty": {
  23887. "description": "APIEmpty is an empty response"
  23888. },
  23889. "error": {
  23890. "description": "APIError is error format response",
  23891. "headers": {
  23892. "message": {
  23893. "type": "string"
  23894. },
  23895. "url": {
  23896. "type": "string"
  23897. }
  23898. }
  23899. },
  23900. "forbidden": {
  23901. "description": "APIForbiddenError is a forbidden error response",
  23902. "headers": {
  23903. "message": {
  23904. "type": "string"
  23905. },
  23906. "url": {
  23907. "type": "string"
  23908. }
  23909. }
  23910. },
  23911. "invalidTopicsError": {
  23912. "description": "APIInvalidTopicsError is error format response to invalid topics",
  23913. "headers": {
  23914. "invalidTopics": {
  23915. "type": "array",
  23916. "items": {
  23917. "type": "string"
  23918. }
  23919. },
  23920. "message": {
  23921. "type": "string"
  23922. }
  23923. }
  23924. },
  23925. "notFound": {
  23926. "description": "APINotFound is a not found empty response"
  23927. },
  23928. "parameterBodies": {
  23929. "description": "parameterBodies",
  23930. "schema": {
  23931. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  23932. }
  23933. },
  23934. "redirect": {
  23935. "description": "APIRedirect is a redirect response"
  23936. },
  23937. "string": {
  23938. "description": "APIString is a string response",
  23939. "schema": {
  23940. "type": "string"
  23941. }
  23942. },
  23943. "validationError": {
  23944. "description": "APIValidationError is error format response related to input validation",
  23945. "headers": {
  23946. "message": {
  23947. "type": "string"
  23948. },
  23949. "url": {
  23950. "type": "string"
  23951. }
  23952. }
  23953. }
  23954. },
  23955. "securityDefinitions": {
  23956. "AccessToken": {
  23957. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  23958. "type": "apiKey",
  23959. "name": "access_token",
  23960. "in": "query"
  23961. },
  23962. "AuthorizationHeaderToken": {
  23963. "description": "API tokens must be prepended with \"token\" followed by a space.",
  23964. "type": "apiKey",
  23965. "name": "Authorization",
  23966. "in": "header"
  23967. },
  23968. "BasicAuth": {
  23969. "type": "basic"
  23970. },
  23971. "SudoHeader": {
  23972. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  23973. "type": "apiKey",
  23974. "name": "Sudo",
  23975. "in": "header"
  23976. },
  23977. "SudoParam": {
  23978. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  23979. "type": "apiKey",
  23980. "name": "sudo",
  23981. "in": "query"
  23982. },
  23983. "TOTPHeader": {
  23984. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  23985. "type": "apiKey",
  23986. "name": "X-GITEA-OTP",
  23987. "in": "header"
  23988. },
  23989. "Token": {
  23990. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  23991. "type": "apiKey",
  23992. "name": "token",
  23993. "in": "query"
  23994. }
  23995. },
  23996. "security": [
  23997. {
  23998. "BasicAuth": []
  23999. },
  24000. {
  24001. "Token": []
  24002. },
  24003. {
  24004. "AccessToken": []
  24005. },
  24006. {
  24007. "AuthorizationHeaderToken": []
  24008. },
  24009. {
  24010. "SudoParam": []
  24011. },
  24012. {
  24013. "SudoHeader": []
  24014. },
  24015. {
  24016. "TOTPHeader": []
  24017. }
  24018. ]
  24019. }