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

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986
  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/{username}": {
  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": "string",
  39. "description": "username of the user",
  40. "name": "username",
  41. "in": "path",
  42. "required": true
  43. }
  44. ],
  45. "responses": {
  46. "200": {
  47. "$ref": "#/responses/ActivityPub"
  48. }
  49. }
  50. }
  51. },
  52. "/activitypub/user/{username}/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": "string",
  65. "description": "username of the user",
  66. "name": "username",
  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/hooks": {
  142. "get": {
  143. "produces": [
  144. "application/json"
  145. ],
  146. "tags": [
  147. "admin"
  148. ],
  149. "summary": "List system's webhooks",
  150. "operationId": "adminListHooks",
  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/HookList"
  168. }
  169. }
  170. },
  171. "post": {
  172. "consumes": [
  173. "application/json"
  174. ],
  175. "produces": [
  176. "application/json"
  177. ],
  178. "tags": [
  179. "admin"
  180. ],
  181. "summary": "Create a hook",
  182. "operationId": "adminCreateHook",
  183. "parameters": [
  184. {
  185. "name": "body",
  186. "in": "body",
  187. "required": true,
  188. "schema": {
  189. "$ref": "#/definitions/CreateHookOption"
  190. }
  191. }
  192. ],
  193. "responses": {
  194. "201": {
  195. "$ref": "#/responses/Hook"
  196. }
  197. }
  198. }
  199. },
  200. "/admin/hooks/{id}": {
  201. "get": {
  202. "produces": [
  203. "application/json"
  204. ],
  205. "tags": [
  206. "admin"
  207. ],
  208. "summary": "Get a hook",
  209. "operationId": "adminGetHook",
  210. "parameters": [
  211. {
  212. "type": "integer",
  213. "format": "int64",
  214. "description": "id of the hook to get",
  215. "name": "id",
  216. "in": "path",
  217. "required": true
  218. }
  219. ],
  220. "responses": {
  221. "200": {
  222. "$ref": "#/responses/Hook"
  223. }
  224. }
  225. },
  226. "patch": {
  227. "consumes": [
  228. "application/json"
  229. ],
  230. "produces": [
  231. "application/json"
  232. ],
  233. "tags": [
  234. "admin"
  235. ],
  236. "summary": "Update a hook",
  237. "operationId": "adminEditHook",
  238. "parameters": [
  239. {
  240. "type": "integer",
  241. "format": "int64",
  242. "description": "id of the hook to update",
  243. "name": "id",
  244. "in": "path",
  245. "required": true
  246. },
  247. {
  248. "name": "body",
  249. "in": "body",
  250. "schema": {
  251. "$ref": "#/definitions/EditHookOption"
  252. }
  253. }
  254. ],
  255. "responses": {
  256. "200": {
  257. "$ref": "#/responses/Hook"
  258. }
  259. }
  260. }
  261. },
  262. "/admin/orgs": {
  263. "get": {
  264. "produces": [
  265. "application/json"
  266. ],
  267. "tags": [
  268. "admin"
  269. ],
  270. "summary": "List all organizations",
  271. "operationId": "adminGetAllOrgs",
  272. "parameters": [
  273. {
  274. "type": "integer",
  275. "description": "page number of results to return (1-based)",
  276. "name": "page",
  277. "in": "query"
  278. },
  279. {
  280. "type": "integer",
  281. "description": "page size of results",
  282. "name": "limit",
  283. "in": "query"
  284. }
  285. ],
  286. "responses": {
  287. "200": {
  288. "$ref": "#/responses/OrganizationList"
  289. },
  290. "403": {
  291. "$ref": "#/responses/forbidden"
  292. }
  293. }
  294. }
  295. },
  296. "/admin/unadopted": {
  297. "get": {
  298. "produces": [
  299. "application/json"
  300. ],
  301. "tags": [
  302. "admin"
  303. ],
  304. "summary": "List unadopted repositories",
  305. "operationId": "adminUnadoptedList",
  306. "parameters": [
  307. {
  308. "type": "integer",
  309. "description": "page number of results to return (1-based)",
  310. "name": "page",
  311. "in": "query"
  312. },
  313. {
  314. "type": "integer",
  315. "description": "page size of results",
  316. "name": "limit",
  317. "in": "query"
  318. },
  319. {
  320. "type": "string",
  321. "description": "pattern of repositories to search for",
  322. "name": "pattern",
  323. "in": "query"
  324. }
  325. ],
  326. "responses": {
  327. "200": {
  328. "$ref": "#/responses/StringSlice"
  329. },
  330. "403": {
  331. "$ref": "#/responses/forbidden"
  332. }
  333. }
  334. }
  335. },
  336. "/admin/unadopted/{owner}/{repo}": {
  337. "post": {
  338. "produces": [
  339. "application/json"
  340. ],
  341. "tags": [
  342. "admin"
  343. ],
  344. "summary": "Adopt unadopted files as a repository",
  345. "operationId": "adminAdoptRepository",
  346. "parameters": [
  347. {
  348. "type": "string",
  349. "description": "owner of the repo",
  350. "name": "owner",
  351. "in": "path",
  352. "required": true
  353. },
  354. {
  355. "type": "string",
  356. "description": "name of the repo",
  357. "name": "repo",
  358. "in": "path",
  359. "required": true
  360. }
  361. ],
  362. "responses": {
  363. "204": {
  364. "$ref": "#/responses/empty"
  365. },
  366. "403": {
  367. "$ref": "#/responses/forbidden"
  368. },
  369. "404": {
  370. "$ref": "#/responses/notFound"
  371. }
  372. }
  373. },
  374. "delete": {
  375. "produces": [
  376. "application/json"
  377. ],
  378. "tags": [
  379. "admin"
  380. ],
  381. "summary": "Delete unadopted files",
  382. "operationId": "adminDeleteUnadoptedRepository",
  383. "parameters": [
  384. {
  385. "type": "string",
  386. "description": "owner of the repo",
  387. "name": "owner",
  388. "in": "path",
  389. "required": true
  390. },
  391. {
  392. "type": "string",
  393. "description": "name of the repo",
  394. "name": "repo",
  395. "in": "path",
  396. "required": true
  397. }
  398. ],
  399. "responses": {
  400. "204": {
  401. "$ref": "#/responses/empty"
  402. },
  403. "403": {
  404. "$ref": "#/responses/forbidden"
  405. }
  406. }
  407. }
  408. },
  409. "/admin/users": {
  410. "get": {
  411. "produces": [
  412. "application/json"
  413. ],
  414. "tags": [
  415. "admin"
  416. ],
  417. "summary": "List all users",
  418. "operationId": "adminGetAllUsers",
  419. "parameters": [
  420. {
  421. "type": "integer",
  422. "description": "page number of results to return (1-based)",
  423. "name": "page",
  424. "in": "query"
  425. },
  426. {
  427. "type": "integer",
  428. "description": "page size of results",
  429. "name": "limit",
  430. "in": "query"
  431. }
  432. ],
  433. "responses": {
  434. "200": {
  435. "$ref": "#/responses/UserList"
  436. },
  437. "403": {
  438. "$ref": "#/responses/forbidden"
  439. }
  440. }
  441. },
  442. "post": {
  443. "consumes": [
  444. "application/json"
  445. ],
  446. "produces": [
  447. "application/json"
  448. ],
  449. "tags": [
  450. "admin"
  451. ],
  452. "summary": "Create a user",
  453. "operationId": "adminCreateUser",
  454. "parameters": [
  455. {
  456. "name": "body",
  457. "in": "body",
  458. "schema": {
  459. "$ref": "#/definitions/CreateUserOption"
  460. }
  461. }
  462. ],
  463. "responses": {
  464. "201": {
  465. "$ref": "#/responses/User"
  466. },
  467. "400": {
  468. "$ref": "#/responses/error"
  469. },
  470. "403": {
  471. "$ref": "#/responses/forbidden"
  472. },
  473. "422": {
  474. "$ref": "#/responses/validationError"
  475. }
  476. }
  477. }
  478. },
  479. "/admin/users/{username}": {
  480. "delete": {
  481. "produces": [
  482. "application/json"
  483. ],
  484. "tags": [
  485. "admin"
  486. ],
  487. "summary": "Delete a user",
  488. "operationId": "adminDeleteUser",
  489. "parameters": [
  490. {
  491. "type": "string",
  492. "description": "username of user to delete",
  493. "name": "username",
  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. "422": {
  506. "$ref": "#/responses/validationError"
  507. }
  508. }
  509. },
  510. "patch": {
  511. "consumes": [
  512. "application/json"
  513. ],
  514. "produces": [
  515. "application/json"
  516. ],
  517. "tags": [
  518. "admin"
  519. ],
  520. "summary": "Edit an existing user",
  521. "operationId": "adminEditUser",
  522. "parameters": [
  523. {
  524. "type": "string",
  525. "description": "username of user to edit",
  526. "name": "username",
  527. "in": "path",
  528. "required": true
  529. },
  530. {
  531. "name": "body",
  532. "in": "body",
  533. "schema": {
  534. "$ref": "#/definitions/EditUserOption"
  535. }
  536. }
  537. ],
  538. "responses": {
  539. "200": {
  540. "$ref": "#/responses/User"
  541. },
  542. "403": {
  543. "$ref": "#/responses/forbidden"
  544. },
  545. "422": {
  546. "$ref": "#/responses/validationError"
  547. }
  548. }
  549. }
  550. },
  551. "/admin/users/{username}/keys": {
  552. "post": {
  553. "consumes": [
  554. "application/json"
  555. ],
  556. "produces": [
  557. "application/json"
  558. ],
  559. "tags": [
  560. "admin"
  561. ],
  562. "summary": "Add a public key on behalf of a user",
  563. "operationId": "adminCreatePublicKey",
  564. "parameters": [
  565. {
  566. "type": "string",
  567. "description": "username of the user",
  568. "name": "username",
  569. "in": "path",
  570. "required": true
  571. },
  572. {
  573. "name": "key",
  574. "in": "body",
  575. "schema": {
  576. "$ref": "#/definitions/CreateKeyOption"
  577. }
  578. }
  579. ],
  580. "responses": {
  581. "201": {
  582. "$ref": "#/responses/PublicKey"
  583. },
  584. "403": {
  585. "$ref": "#/responses/forbidden"
  586. },
  587. "422": {
  588. "$ref": "#/responses/validationError"
  589. }
  590. }
  591. }
  592. },
  593. "/admin/users/{username}/keys/{id}": {
  594. "delete": {
  595. "produces": [
  596. "application/json"
  597. ],
  598. "tags": [
  599. "admin"
  600. ],
  601. "summary": "Delete a user's public key",
  602. "operationId": "adminDeleteUserPublicKey",
  603. "parameters": [
  604. {
  605. "type": "string",
  606. "description": "username of user",
  607. "name": "username",
  608. "in": "path",
  609. "required": true
  610. },
  611. {
  612. "type": "integer",
  613. "format": "int64",
  614. "description": "id of the key to delete",
  615. "name": "id",
  616. "in": "path",
  617. "required": true
  618. }
  619. ],
  620. "responses": {
  621. "204": {
  622. "$ref": "#/responses/empty"
  623. },
  624. "403": {
  625. "$ref": "#/responses/forbidden"
  626. },
  627. "404": {
  628. "$ref": "#/responses/notFound"
  629. }
  630. }
  631. }
  632. },
  633. "/admin/users/{username}/orgs": {
  634. "post": {
  635. "consumes": [
  636. "application/json"
  637. ],
  638. "produces": [
  639. "application/json"
  640. ],
  641. "tags": [
  642. "admin"
  643. ],
  644. "summary": "Create an organization",
  645. "operationId": "adminCreateOrg",
  646. "parameters": [
  647. {
  648. "type": "string",
  649. "description": "username of the user that will own the created organization",
  650. "name": "username",
  651. "in": "path",
  652. "required": true
  653. },
  654. {
  655. "name": "organization",
  656. "in": "body",
  657. "required": true,
  658. "schema": {
  659. "$ref": "#/definitions/CreateOrgOption"
  660. }
  661. }
  662. ],
  663. "responses": {
  664. "201": {
  665. "$ref": "#/responses/Organization"
  666. },
  667. "403": {
  668. "$ref": "#/responses/forbidden"
  669. },
  670. "422": {
  671. "$ref": "#/responses/validationError"
  672. }
  673. }
  674. }
  675. },
  676. "/admin/users/{username}/repos": {
  677. "post": {
  678. "consumes": [
  679. "application/json"
  680. ],
  681. "produces": [
  682. "application/json"
  683. ],
  684. "tags": [
  685. "admin"
  686. ],
  687. "summary": "Create a repository on behalf of a user",
  688. "operationId": "adminCreateRepo",
  689. "parameters": [
  690. {
  691. "type": "string",
  692. "description": "username of the user. This user will own the created repository",
  693. "name": "username",
  694. "in": "path",
  695. "required": true
  696. },
  697. {
  698. "name": "repository",
  699. "in": "body",
  700. "required": true,
  701. "schema": {
  702. "$ref": "#/definitions/CreateRepoOption"
  703. }
  704. }
  705. ],
  706. "responses": {
  707. "201": {
  708. "$ref": "#/responses/Repository"
  709. },
  710. "403": {
  711. "$ref": "#/responses/forbidden"
  712. },
  713. "404": {
  714. "$ref": "#/responses/notFound"
  715. },
  716. "409": {
  717. "$ref": "#/responses/error"
  718. },
  719. "422": {
  720. "$ref": "#/responses/validationError"
  721. }
  722. }
  723. }
  724. },
  725. "/amdin/hooks/{id}": {
  726. "delete": {
  727. "produces": [
  728. "application/json"
  729. ],
  730. "tags": [
  731. "admin"
  732. ],
  733. "summary": "Delete a hook",
  734. "operationId": "adminDeleteHook",
  735. "parameters": [
  736. {
  737. "type": "integer",
  738. "format": "int64",
  739. "description": "id of the hook to delete",
  740. "name": "id",
  741. "in": "path",
  742. "required": true
  743. }
  744. ],
  745. "responses": {
  746. "204": {
  747. "$ref": "#/responses/empty"
  748. }
  749. }
  750. }
  751. },
  752. "/markdown": {
  753. "post": {
  754. "consumes": [
  755. "application/json"
  756. ],
  757. "produces": [
  758. "text/html"
  759. ],
  760. "tags": [
  761. "miscellaneous"
  762. ],
  763. "summary": "Render a markdown document as HTML",
  764. "operationId": "renderMarkdown",
  765. "parameters": [
  766. {
  767. "name": "body",
  768. "in": "body",
  769. "schema": {
  770. "$ref": "#/definitions/MarkdownOption"
  771. }
  772. }
  773. ],
  774. "responses": {
  775. "200": {
  776. "$ref": "#/responses/MarkdownRender"
  777. },
  778. "422": {
  779. "$ref": "#/responses/validationError"
  780. }
  781. }
  782. }
  783. },
  784. "/markdown/raw": {
  785. "post": {
  786. "consumes": [
  787. "text/plain"
  788. ],
  789. "produces": [
  790. "text/html"
  791. ],
  792. "tags": [
  793. "miscellaneous"
  794. ],
  795. "summary": "Render raw markdown as HTML",
  796. "operationId": "renderMarkdownRaw",
  797. "parameters": [
  798. {
  799. "description": "Request body to render",
  800. "name": "body",
  801. "in": "body",
  802. "required": true,
  803. "schema": {
  804. "type": "string"
  805. }
  806. }
  807. ],
  808. "responses": {
  809. "200": {
  810. "$ref": "#/responses/MarkdownRender"
  811. },
  812. "422": {
  813. "$ref": "#/responses/validationError"
  814. }
  815. }
  816. }
  817. },
  818. "/nodeinfo": {
  819. "get": {
  820. "produces": [
  821. "application/json"
  822. ],
  823. "tags": [
  824. "miscellaneous"
  825. ],
  826. "summary": "Returns the nodeinfo of the Gitea application",
  827. "operationId": "getNodeInfo",
  828. "responses": {
  829. "200": {
  830. "$ref": "#/responses/NodeInfo"
  831. }
  832. }
  833. }
  834. },
  835. "/notifications": {
  836. "get": {
  837. "consumes": [
  838. "application/json"
  839. ],
  840. "produces": [
  841. "application/json"
  842. ],
  843. "tags": [
  844. "notification"
  845. ],
  846. "summary": "List users's notification threads",
  847. "operationId": "notifyGetList",
  848. "parameters": [
  849. {
  850. "type": "boolean",
  851. "description": "If true, show notifications marked as read. Default value is false",
  852. "name": "all",
  853. "in": "query"
  854. },
  855. {
  856. "type": "array",
  857. "items": {
  858. "type": "string"
  859. },
  860. "collectionFormat": "multi",
  861. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
  862. "name": "status-types",
  863. "in": "query"
  864. },
  865. {
  866. "type": "array",
  867. "items": {
  868. "enum": [
  869. "issue",
  870. "pull",
  871. "commit",
  872. "repository"
  873. ],
  874. "type": "string"
  875. },
  876. "collectionFormat": "multi",
  877. "description": "filter notifications by subject type",
  878. "name": "subject-type",
  879. "in": "query"
  880. },
  881. {
  882. "type": "string",
  883. "format": "date-time",
  884. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  885. "name": "since",
  886. "in": "query"
  887. },
  888. {
  889. "type": "string",
  890. "format": "date-time",
  891. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  892. "name": "before",
  893. "in": "query"
  894. },
  895. {
  896. "type": "integer",
  897. "description": "page number of results to return (1-based)",
  898. "name": "page",
  899. "in": "query"
  900. },
  901. {
  902. "type": "integer",
  903. "description": "page size of results",
  904. "name": "limit",
  905. "in": "query"
  906. }
  907. ],
  908. "responses": {
  909. "200": {
  910. "$ref": "#/responses/NotificationThreadList"
  911. }
  912. }
  913. },
  914. "put": {
  915. "consumes": [
  916. "application/json"
  917. ],
  918. "produces": [
  919. "application/json"
  920. ],
  921. "tags": [
  922. "notification"
  923. ],
  924. "summary": "Mark notification threads as read, pinned or unread",
  925. "operationId": "notifyReadList",
  926. "parameters": [
  927. {
  928. "type": "string",
  929. "format": "date-time",
  930. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  931. "name": "last_read_at",
  932. "in": "query"
  933. },
  934. {
  935. "type": "string",
  936. "description": "If true, mark all notifications on this repo. Default value is false",
  937. "name": "all",
  938. "in": "query"
  939. },
  940. {
  941. "type": "array",
  942. "items": {
  943. "type": "string"
  944. },
  945. "collectionFormat": "multi",
  946. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  947. "name": "status-types",
  948. "in": "query"
  949. },
  950. {
  951. "type": "string",
  952. "description": "Status to mark notifications as, Defaults to read.",
  953. "name": "to-status",
  954. "in": "query"
  955. }
  956. ],
  957. "responses": {
  958. "205": {
  959. "$ref": "#/responses/NotificationThreadList"
  960. }
  961. }
  962. }
  963. },
  964. "/notifications/new": {
  965. "get": {
  966. "tags": [
  967. "notification"
  968. ],
  969. "summary": "Check if unread notifications exist",
  970. "operationId": "notifyNewAvailable",
  971. "responses": {
  972. "200": {
  973. "$ref": "#/responses/NotificationCount"
  974. }
  975. }
  976. }
  977. },
  978. "/notifications/threads/{id}": {
  979. "get": {
  980. "consumes": [
  981. "application/json"
  982. ],
  983. "produces": [
  984. "application/json"
  985. ],
  986. "tags": [
  987. "notification"
  988. ],
  989. "summary": "Get notification thread by ID",
  990. "operationId": "notifyGetThread",
  991. "parameters": [
  992. {
  993. "type": "string",
  994. "description": "id of notification thread",
  995. "name": "id",
  996. "in": "path",
  997. "required": true
  998. }
  999. ],
  1000. "responses": {
  1001. "200": {
  1002. "$ref": "#/responses/NotificationThread"
  1003. },
  1004. "403": {
  1005. "$ref": "#/responses/forbidden"
  1006. },
  1007. "404": {
  1008. "$ref": "#/responses/notFound"
  1009. }
  1010. }
  1011. },
  1012. "patch": {
  1013. "consumes": [
  1014. "application/json"
  1015. ],
  1016. "produces": [
  1017. "application/json"
  1018. ],
  1019. "tags": [
  1020. "notification"
  1021. ],
  1022. "summary": "Mark notification thread as read by ID",
  1023. "operationId": "notifyReadThread",
  1024. "parameters": [
  1025. {
  1026. "type": "string",
  1027. "description": "id of notification thread",
  1028. "name": "id",
  1029. "in": "path",
  1030. "required": true
  1031. },
  1032. {
  1033. "type": "string",
  1034. "default": "read",
  1035. "description": "Status to mark notifications as",
  1036. "name": "to-status",
  1037. "in": "query"
  1038. }
  1039. ],
  1040. "responses": {
  1041. "205": {
  1042. "$ref": "#/responses/NotificationThread"
  1043. },
  1044. "403": {
  1045. "$ref": "#/responses/forbidden"
  1046. },
  1047. "404": {
  1048. "$ref": "#/responses/notFound"
  1049. }
  1050. }
  1051. }
  1052. },
  1053. "/org/{org}/repos": {
  1054. "post": {
  1055. "consumes": [
  1056. "application/json"
  1057. ],
  1058. "produces": [
  1059. "application/json"
  1060. ],
  1061. "tags": [
  1062. "organization"
  1063. ],
  1064. "summary": "Create a repository in an organization",
  1065. "operationId": "createOrgRepoDeprecated",
  1066. "deprecated": true,
  1067. "parameters": [
  1068. {
  1069. "type": "string",
  1070. "description": "name of organization",
  1071. "name": "org",
  1072. "in": "path",
  1073. "required": true
  1074. },
  1075. {
  1076. "name": "body",
  1077. "in": "body",
  1078. "schema": {
  1079. "$ref": "#/definitions/CreateRepoOption"
  1080. }
  1081. }
  1082. ],
  1083. "responses": {
  1084. "201": {
  1085. "$ref": "#/responses/Repository"
  1086. },
  1087. "403": {
  1088. "$ref": "#/responses/forbidden"
  1089. },
  1090. "422": {
  1091. "$ref": "#/responses/validationError"
  1092. }
  1093. }
  1094. }
  1095. },
  1096. "/orgs": {
  1097. "get": {
  1098. "produces": [
  1099. "application/json"
  1100. ],
  1101. "tags": [
  1102. "organization"
  1103. ],
  1104. "summary": "Get list of organizations",
  1105. "operationId": "orgGetAll",
  1106. "parameters": [
  1107. {
  1108. "type": "integer",
  1109. "description": "page number of results to return (1-based)",
  1110. "name": "page",
  1111. "in": "query"
  1112. },
  1113. {
  1114. "type": "integer",
  1115. "description": "page size of results",
  1116. "name": "limit",
  1117. "in": "query"
  1118. }
  1119. ],
  1120. "responses": {
  1121. "200": {
  1122. "$ref": "#/responses/OrganizationList"
  1123. }
  1124. }
  1125. },
  1126. "post": {
  1127. "consumes": [
  1128. "application/json"
  1129. ],
  1130. "produces": [
  1131. "application/json"
  1132. ],
  1133. "tags": [
  1134. "organization"
  1135. ],
  1136. "summary": "Create an organization",
  1137. "operationId": "orgCreate",
  1138. "parameters": [
  1139. {
  1140. "name": "organization",
  1141. "in": "body",
  1142. "required": true,
  1143. "schema": {
  1144. "$ref": "#/definitions/CreateOrgOption"
  1145. }
  1146. }
  1147. ],
  1148. "responses": {
  1149. "201": {
  1150. "$ref": "#/responses/Organization"
  1151. },
  1152. "403": {
  1153. "$ref": "#/responses/forbidden"
  1154. },
  1155. "422": {
  1156. "$ref": "#/responses/validationError"
  1157. }
  1158. }
  1159. }
  1160. },
  1161. "/orgs/{org}": {
  1162. "get": {
  1163. "produces": [
  1164. "application/json"
  1165. ],
  1166. "tags": [
  1167. "organization"
  1168. ],
  1169. "summary": "Get an organization",
  1170. "operationId": "orgGet",
  1171. "parameters": [
  1172. {
  1173. "type": "string",
  1174. "description": "name of the organization to get",
  1175. "name": "org",
  1176. "in": "path",
  1177. "required": true
  1178. }
  1179. ],
  1180. "responses": {
  1181. "200": {
  1182. "$ref": "#/responses/Organization"
  1183. }
  1184. }
  1185. },
  1186. "delete": {
  1187. "produces": [
  1188. "application/json"
  1189. ],
  1190. "tags": [
  1191. "organization"
  1192. ],
  1193. "summary": "Delete an organization",
  1194. "operationId": "orgDelete",
  1195. "parameters": [
  1196. {
  1197. "type": "string",
  1198. "description": "organization that is to be deleted",
  1199. "name": "org",
  1200. "in": "path",
  1201. "required": true
  1202. }
  1203. ],
  1204. "responses": {
  1205. "204": {
  1206. "$ref": "#/responses/empty"
  1207. }
  1208. }
  1209. },
  1210. "patch": {
  1211. "consumes": [
  1212. "application/json"
  1213. ],
  1214. "produces": [
  1215. "application/json"
  1216. ],
  1217. "tags": [
  1218. "organization"
  1219. ],
  1220. "summary": "Edit an organization",
  1221. "operationId": "orgEdit",
  1222. "parameters": [
  1223. {
  1224. "type": "string",
  1225. "description": "name of the organization to edit",
  1226. "name": "org",
  1227. "in": "path",
  1228. "required": true
  1229. },
  1230. {
  1231. "name": "body",
  1232. "in": "body",
  1233. "required": true,
  1234. "schema": {
  1235. "$ref": "#/definitions/EditOrgOption"
  1236. }
  1237. }
  1238. ],
  1239. "responses": {
  1240. "200": {
  1241. "$ref": "#/responses/Organization"
  1242. }
  1243. }
  1244. }
  1245. },
  1246. "/orgs/{org}/hooks": {
  1247. "get": {
  1248. "produces": [
  1249. "application/json"
  1250. ],
  1251. "tags": [
  1252. "organization"
  1253. ],
  1254. "summary": "List an organization's webhooks",
  1255. "operationId": "orgListHooks",
  1256. "parameters": [
  1257. {
  1258. "type": "string",
  1259. "description": "name of the organization",
  1260. "name": "org",
  1261. "in": "path",
  1262. "required": true
  1263. },
  1264. {
  1265. "type": "integer",
  1266. "description": "page number of results to return (1-based)",
  1267. "name": "page",
  1268. "in": "query"
  1269. },
  1270. {
  1271. "type": "integer",
  1272. "description": "page size of results",
  1273. "name": "limit",
  1274. "in": "query"
  1275. }
  1276. ],
  1277. "responses": {
  1278. "200": {
  1279. "$ref": "#/responses/HookList"
  1280. }
  1281. }
  1282. },
  1283. "post": {
  1284. "consumes": [
  1285. "application/json"
  1286. ],
  1287. "produces": [
  1288. "application/json"
  1289. ],
  1290. "tags": [
  1291. "organization"
  1292. ],
  1293. "summary": "Create a hook",
  1294. "operationId": "orgCreateHook",
  1295. "parameters": [
  1296. {
  1297. "type": "string",
  1298. "description": "name of the organization",
  1299. "name": "org",
  1300. "in": "path",
  1301. "required": true
  1302. },
  1303. {
  1304. "name": "body",
  1305. "in": "body",
  1306. "required": true,
  1307. "schema": {
  1308. "$ref": "#/definitions/CreateHookOption"
  1309. }
  1310. }
  1311. ],
  1312. "responses": {
  1313. "201": {
  1314. "$ref": "#/responses/Hook"
  1315. }
  1316. }
  1317. }
  1318. },
  1319. "/orgs/{org}/hooks/{id}": {
  1320. "get": {
  1321. "produces": [
  1322. "application/json"
  1323. ],
  1324. "tags": [
  1325. "organization"
  1326. ],
  1327. "summary": "Get a hook",
  1328. "operationId": "orgGetHook",
  1329. "parameters": [
  1330. {
  1331. "type": "string",
  1332. "description": "name of the organization",
  1333. "name": "org",
  1334. "in": "path",
  1335. "required": true
  1336. },
  1337. {
  1338. "type": "integer",
  1339. "format": "int64",
  1340. "description": "id of the hook to get",
  1341. "name": "id",
  1342. "in": "path",
  1343. "required": true
  1344. }
  1345. ],
  1346. "responses": {
  1347. "200": {
  1348. "$ref": "#/responses/Hook"
  1349. }
  1350. }
  1351. },
  1352. "delete": {
  1353. "produces": [
  1354. "application/json"
  1355. ],
  1356. "tags": [
  1357. "organization"
  1358. ],
  1359. "summary": "Delete a hook",
  1360. "operationId": "orgDeleteHook",
  1361. "parameters": [
  1362. {
  1363. "type": "string",
  1364. "description": "name of the organization",
  1365. "name": "org",
  1366. "in": "path",
  1367. "required": true
  1368. },
  1369. {
  1370. "type": "integer",
  1371. "format": "int64",
  1372. "description": "id of the hook to delete",
  1373. "name": "id",
  1374. "in": "path",
  1375. "required": true
  1376. }
  1377. ],
  1378. "responses": {
  1379. "204": {
  1380. "$ref": "#/responses/empty"
  1381. }
  1382. }
  1383. },
  1384. "patch": {
  1385. "consumes": [
  1386. "application/json"
  1387. ],
  1388. "produces": [
  1389. "application/json"
  1390. ],
  1391. "tags": [
  1392. "organization"
  1393. ],
  1394. "summary": "Update a hook",
  1395. "operationId": "orgEditHook",
  1396. "parameters": [
  1397. {
  1398. "type": "string",
  1399. "description": "name of the organization",
  1400. "name": "org",
  1401. "in": "path",
  1402. "required": true
  1403. },
  1404. {
  1405. "type": "integer",
  1406. "format": "int64",
  1407. "description": "id of the hook to update",
  1408. "name": "id",
  1409. "in": "path",
  1410. "required": true
  1411. },
  1412. {
  1413. "name": "body",
  1414. "in": "body",
  1415. "schema": {
  1416. "$ref": "#/definitions/EditHookOption"
  1417. }
  1418. }
  1419. ],
  1420. "responses": {
  1421. "200": {
  1422. "$ref": "#/responses/Hook"
  1423. }
  1424. }
  1425. }
  1426. },
  1427. "/orgs/{org}/labels": {
  1428. "get": {
  1429. "produces": [
  1430. "application/json"
  1431. ],
  1432. "tags": [
  1433. "organization"
  1434. ],
  1435. "summary": "List an organization's labels",
  1436. "operationId": "orgListLabels",
  1437. "parameters": [
  1438. {
  1439. "type": "string",
  1440. "description": "name of the organization",
  1441. "name": "org",
  1442. "in": "path",
  1443. "required": true
  1444. },
  1445. {
  1446. "type": "integer",
  1447. "description": "page number of results to return (1-based)",
  1448. "name": "page",
  1449. "in": "query"
  1450. },
  1451. {
  1452. "type": "integer",
  1453. "description": "page size of results",
  1454. "name": "limit",
  1455. "in": "query"
  1456. }
  1457. ],
  1458. "responses": {
  1459. "200": {
  1460. "$ref": "#/responses/LabelList"
  1461. }
  1462. }
  1463. },
  1464. "post": {
  1465. "consumes": [
  1466. "application/json"
  1467. ],
  1468. "produces": [
  1469. "application/json"
  1470. ],
  1471. "tags": [
  1472. "organization"
  1473. ],
  1474. "summary": "Create a label for an organization",
  1475. "operationId": "orgCreateLabel",
  1476. "parameters": [
  1477. {
  1478. "type": "string",
  1479. "description": "name of the organization",
  1480. "name": "org",
  1481. "in": "path",
  1482. "required": true
  1483. },
  1484. {
  1485. "name": "body",
  1486. "in": "body",
  1487. "schema": {
  1488. "$ref": "#/definitions/CreateLabelOption"
  1489. }
  1490. }
  1491. ],
  1492. "responses": {
  1493. "201": {
  1494. "$ref": "#/responses/Label"
  1495. },
  1496. "422": {
  1497. "$ref": "#/responses/validationError"
  1498. }
  1499. }
  1500. }
  1501. },
  1502. "/orgs/{org}/labels/{id}": {
  1503. "get": {
  1504. "produces": [
  1505. "application/json"
  1506. ],
  1507. "tags": [
  1508. "organization"
  1509. ],
  1510. "summary": "Get a single label",
  1511. "operationId": "orgGetLabel",
  1512. "parameters": [
  1513. {
  1514. "type": "string",
  1515. "description": "name of the organization",
  1516. "name": "org",
  1517. "in": "path",
  1518. "required": true
  1519. },
  1520. {
  1521. "type": "integer",
  1522. "format": "int64",
  1523. "description": "id of the label to get",
  1524. "name": "id",
  1525. "in": "path",
  1526. "required": true
  1527. }
  1528. ],
  1529. "responses": {
  1530. "200": {
  1531. "$ref": "#/responses/Label"
  1532. }
  1533. }
  1534. },
  1535. "delete": {
  1536. "tags": [
  1537. "organization"
  1538. ],
  1539. "summary": "Delete a label",
  1540. "operationId": "orgDeleteLabel",
  1541. "parameters": [
  1542. {
  1543. "type": "string",
  1544. "description": "name of the organization",
  1545. "name": "org",
  1546. "in": "path",
  1547. "required": true
  1548. },
  1549. {
  1550. "type": "integer",
  1551. "format": "int64",
  1552. "description": "id of the label to delete",
  1553. "name": "id",
  1554. "in": "path",
  1555. "required": true
  1556. }
  1557. ],
  1558. "responses": {
  1559. "204": {
  1560. "$ref": "#/responses/empty"
  1561. }
  1562. }
  1563. },
  1564. "patch": {
  1565. "consumes": [
  1566. "application/json"
  1567. ],
  1568. "produces": [
  1569. "application/json"
  1570. ],
  1571. "tags": [
  1572. "organization"
  1573. ],
  1574. "summary": "Update a label",
  1575. "operationId": "orgEditLabel",
  1576. "parameters": [
  1577. {
  1578. "type": "string",
  1579. "description": "name of the organization",
  1580. "name": "org",
  1581. "in": "path",
  1582. "required": true
  1583. },
  1584. {
  1585. "type": "integer",
  1586. "format": "int64",
  1587. "description": "id of the label to edit",
  1588. "name": "id",
  1589. "in": "path",
  1590. "required": true
  1591. },
  1592. {
  1593. "name": "body",
  1594. "in": "body",
  1595. "schema": {
  1596. "$ref": "#/definitions/EditLabelOption"
  1597. }
  1598. }
  1599. ],
  1600. "responses": {
  1601. "200": {
  1602. "$ref": "#/responses/Label"
  1603. },
  1604. "422": {
  1605. "$ref": "#/responses/validationError"
  1606. }
  1607. }
  1608. }
  1609. },
  1610. "/orgs/{org}/members": {
  1611. "get": {
  1612. "produces": [
  1613. "application/json"
  1614. ],
  1615. "tags": [
  1616. "organization"
  1617. ],
  1618. "summary": "List an organization's members",
  1619. "operationId": "orgListMembers",
  1620. "parameters": [
  1621. {
  1622. "type": "string",
  1623. "description": "name of the organization",
  1624. "name": "org",
  1625. "in": "path",
  1626. "required": true
  1627. },
  1628. {
  1629. "type": "integer",
  1630. "description": "page number of results to return (1-based)",
  1631. "name": "page",
  1632. "in": "query"
  1633. },
  1634. {
  1635. "type": "integer",
  1636. "description": "page size of results",
  1637. "name": "limit",
  1638. "in": "query"
  1639. }
  1640. ],
  1641. "responses": {
  1642. "200": {
  1643. "$ref": "#/responses/UserList"
  1644. }
  1645. }
  1646. }
  1647. },
  1648. "/orgs/{org}/members/{username}": {
  1649. "get": {
  1650. "tags": [
  1651. "organization"
  1652. ],
  1653. "summary": "Check if a user is a member of an organization",
  1654. "operationId": "orgIsMember",
  1655. "parameters": [
  1656. {
  1657. "type": "string",
  1658. "description": "name of the organization",
  1659. "name": "org",
  1660. "in": "path",
  1661. "required": true
  1662. },
  1663. {
  1664. "type": "string",
  1665. "description": "username of the user",
  1666. "name": "username",
  1667. "in": "path",
  1668. "required": true
  1669. }
  1670. ],
  1671. "responses": {
  1672. "204": {
  1673. "description": "user is a member"
  1674. },
  1675. "303": {
  1676. "description": "redirection to /orgs/{org}/public_members/{username}"
  1677. },
  1678. "404": {
  1679. "description": "user is not a member"
  1680. }
  1681. }
  1682. },
  1683. "delete": {
  1684. "produces": [
  1685. "application/json"
  1686. ],
  1687. "tags": [
  1688. "organization"
  1689. ],
  1690. "summary": "Remove a member from an organization",
  1691. "operationId": "orgDeleteMember",
  1692. "parameters": [
  1693. {
  1694. "type": "string",
  1695. "description": "name of the organization",
  1696. "name": "org",
  1697. "in": "path",
  1698. "required": true
  1699. },
  1700. {
  1701. "type": "string",
  1702. "description": "username of the user",
  1703. "name": "username",
  1704. "in": "path",
  1705. "required": true
  1706. }
  1707. ],
  1708. "responses": {
  1709. "204": {
  1710. "description": "member removed"
  1711. }
  1712. }
  1713. }
  1714. },
  1715. "/orgs/{org}/public_members": {
  1716. "get": {
  1717. "produces": [
  1718. "application/json"
  1719. ],
  1720. "tags": [
  1721. "organization"
  1722. ],
  1723. "summary": "List an organization's public members",
  1724. "operationId": "orgListPublicMembers",
  1725. "parameters": [
  1726. {
  1727. "type": "string",
  1728. "description": "name of the organization",
  1729. "name": "org",
  1730. "in": "path",
  1731. "required": true
  1732. },
  1733. {
  1734. "type": "integer",
  1735. "description": "page number of results to return (1-based)",
  1736. "name": "page",
  1737. "in": "query"
  1738. },
  1739. {
  1740. "type": "integer",
  1741. "description": "page size of results",
  1742. "name": "limit",
  1743. "in": "query"
  1744. }
  1745. ],
  1746. "responses": {
  1747. "200": {
  1748. "$ref": "#/responses/UserList"
  1749. }
  1750. }
  1751. }
  1752. },
  1753. "/orgs/{org}/public_members/{username}": {
  1754. "get": {
  1755. "tags": [
  1756. "organization"
  1757. ],
  1758. "summary": "Check if a user is a public member of an organization",
  1759. "operationId": "orgIsPublicMember",
  1760. "parameters": [
  1761. {
  1762. "type": "string",
  1763. "description": "name of the organization",
  1764. "name": "org",
  1765. "in": "path",
  1766. "required": true
  1767. },
  1768. {
  1769. "type": "string",
  1770. "description": "username of the user",
  1771. "name": "username",
  1772. "in": "path",
  1773. "required": true
  1774. }
  1775. ],
  1776. "responses": {
  1777. "204": {
  1778. "description": "user is a public member"
  1779. },
  1780. "404": {
  1781. "description": "user is not a public member"
  1782. }
  1783. }
  1784. },
  1785. "put": {
  1786. "produces": [
  1787. "application/json"
  1788. ],
  1789. "tags": [
  1790. "organization"
  1791. ],
  1792. "summary": "Publicize a user's membership",
  1793. "operationId": "orgPublicizeMember",
  1794. "parameters": [
  1795. {
  1796. "type": "string",
  1797. "description": "name of the organization",
  1798. "name": "org",
  1799. "in": "path",
  1800. "required": true
  1801. },
  1802. {
  1803. "type": "string",
  1804. "description": "username of the user",
  1805. "name": "username",
  1806. "in": "path",
  1807. "required": true
  1808. }
  1809. ],
  1810. "responses": {
  1811. "204": {
  1812. "description": "membership publicized"
  1813. },
  1814. "403": {
  1815. "$ref": "#/responses/forbidden"
  1816. }
  1817. }
  1818. },
  1819. "delete": {
  1820. "produces": [
  1821. "application/json"
  1822. ],
  1823. "tags": [
  1824. "organization"
  1825. ],
  1826. "summary": "Conceal a user's membership",
  1827. "operationId": "orgConcealMember",
  1828. "parameters": [
  1829. {
  1830. "type": "string",
  1831. "description": "name of the organization",
  1832. "name": "org",
  1833. "in": "path",
  1834. "required": true
  1835. },
  1836. {
  1837. "type": "string",
  1838. "description": "username of the user",
  1839. "name": "username",
  1840. "in": "path",
  1841. "required": true
  1842. }
  1843. ],
  1844. "responses": {
  1845. "204": {
  1846. "$ref": "#/responses/empty"
  1847. },
  1848. "403": {
  1849. "$ref": "#/responses/forbidden"
  1850. }
  1851. }
  1852. }
  1853. },
  1854. "/orgs/{org}/repos": {
  1855. "get": {
  1856. "produces": [
  1857. "application/json"
  1858. ],
  1859. "tags": [
  1860. "organization"
  1861. ],
  1862. "summary": "List an organization's repos",
  1863. "operationId": "orgListRepos",
  1864. "parameters": [
  1865. {
  1866. "type": "string",
  1867. "description": "name of the organization",
  1868. "name": "org",
  1869. "in": "path",
  1870. "required": true
  1871. },
  1872. {
  1873. "type": "integer",
  1874. "description": "page number of results to return (1-based)",
  1875. "name": "page",
  1876. "in": "query"
  1877. },
  1878. {
  1879. "type": "integer",
  1880. "description": "page size of results",
  1881. "name": "limit",
  1882. "in": "query"
  1883. }
  1884. ],
  1885. "responses": {
  1886. "200": {
  1887. "$ref": "#/responses/RepositoryList"
  1888. }
  1889. }
  1890. },
  1891. "post": {
  1892. "consumes": [
  1893. "application/json"
  1894. ],
  1895. "produces": [
  1896. "application/json"
  1897. ],
  1898. "tags": [
  1899. "organization"
  1900. ],
  1901. "summary": "Create a repository in an organization",
  1902. "operationId": "createOrgRepo",
  1903. "parameters": [
  1904. {
  1905. "type": "string",
  1906. "description": "name of organization",
  1907. "name": "org",
  1908. "in": "path",
  1909. "required": true
  1910. },
  1911. {
  1912. "name": "body",
  1913. "in": "body",
  1914. "schema": {
  1915. "$ref": "#/definitions/CreateRepoOption"
  1916. }
  1917. }
  1918. ],
  1919. "responses": {
  1920. "201": {
  1921. "$ref": "#/responses/Repository"
  1922. },
  1923. "403": {
  1924. "$ref": "#/responses/forbidden"
  1925. },
  1926. "404": {
  1927. "$ref": "#/responses/notFound"
  1928. }
  1929. }
  1930. }
  1931. },
  1932. "/orgs/{org}/teams": {
  1933. "get": {
  1934. "produces": [
  1935. "application/json"
  1936. ],
  1937. "tags": [
  1938. "organization"
  1939. ],
  1940. "summary": "List an organization's teams",
  1941. "operationId": "orgListTeams",
  1942. "parameters": [
  1943. {
  1944. "type": "string",
  1945. "description": "name of the organization",
  1946. "name": "org",
  1947. "in": "path",
  1948. "required": true
  1949. },
  1950. {
  1951. "type": "integer",
  1952. "description": "page number of results to return (1-based)",
  1953. "name": "page",
  1954. "in": "query"
  1955. },
  1956. {
  1957. "type": "integer",
  1958. "description": "page size of results",
  1959. "name": "limit",
  1960. "in": "query"
  1961. }
  1962. ],
  1963. "responses": {
  1964. "200": {
  1965. "$ref": "#/responses/TeamList"
  1966. }
  1967. }
  1968. },
  1969. "post": {
  1970. "consumes": [
  1971. "application/json"
  1972. ],
  1973. "produces": [
  1974. "application/json"
  1975. ],
  1976. "tags": [
  1977. "organization"
  1978. ],
  1979. "summary": "Create a team",
  1980. "operationId": "orgCreateTeam",
  1981. "parameters": [
  1982. {
  1983. "type": "string",
  1984. "description": "name of the organization",
  1985. "name": "org",
  1986. "in": "path",
  1987. "required": true
  1988. },
  1989. {
  1990. "name": "body",
  1991. "in": "body",
  1992. "schema": {
  1993. "$ref": "#/definitions/CreateTeamOption"
  1994. }
  1995. }
  1996. ],
  1997. "responses": {
  1998. "201": {
  1999. "$ref": "#/responses/Team"
  2000. },
  2001. "422": {
  2002. "$ref": "#/responses/validationError"
  2003. }
  2004. }
  2005. }
  2006. },
  2007. "/orgs/{org}/teams/search": {
  2008. "get": {
  2009. "produces": [
  2010. "application/json"
  2011. ],
  2012. "tags": [
  2013. "organization"
  2014. ],
  2015. "summary": "Search for teams within an organization",
  2016. "operationId": "teamSearch",
  2017. "parameters": [
  2018. {
  2019. "type": "string",
  2020. "description": "name of the organization",
  2021. "name": "org",
  2022. "in": "path",
  2023. "required": true
  2024. },
  2025. {
  2026. "type": "string",
  2027. "description": "keywords to search",
  2028. "name": "q",
  2029. "in": "query"
  2030. },
  2031. {
  2032. "type": "boolean",
  2033. "description": "include search within team description (defaults to true)",
  2034. "name": "include_desc",
  2035. "in": "query"
  2036. },
  2037. {
  2038. "type": "integer",
  2039. "description": "page number of results to return (1-based)",
  2040. "name": "page",
  2041. "in": "query"
  2042. },
  2043. {
  2044. "type": "integer",
  2045. "description": "page size of results",
  2046. "name": "limit",
  2047. "in": "query"
  2048. }
  2049. ],
  2050. "responses": {
  2051. "200": {
  2052. "description": "SearchResults of a successful search",
  2053. "schema": {
  2054. "type": "object",
  2055. "properties": {
  2056. "data": {
  2057. "type": "array",
  2058. "items": {
  2059. "$ref": "#/definitions/Team"
  2060. }
  2061. },
  2062. "ok": {
  2063. "type": "boolean"
  2064. }
  2065. }
  2066. }
  2067. }
  2068. }
  2069. }
  2070. },
  2071. "/packages/{owner}": {
  2072. "get": {
  2073. "produces": [
  2074. "application/json"
  2075. ],
  2076. "tags": [
  2077. "package"
  2078. ],
  2079. "summary": "Gets all packages of an owner",
  2080. "operationId": "listPackages",
  2081. "parameters": [
  2082. {
  2083. "type": "string",
  2084. "description": "owner of the packages",
  2085. "name": "owner",
  2086. "in": "path",
  2087. "required": true
  2088. },
  2089. {
  2090. "type": "integer",
  2091. "description": "page number of results to return (1-based)",
  2092. "name": "page",
  2093. "in": "query"
  2094. },
  2095. {
  2096. "type": "integer",
  2097. "description": "page size of results",
  2098. "name": "limit",
  2099. "in": "query"
  2100. },
  2101. {
  2102. "enum": [
  2103. "composer",
  2104. "conan",
  2105. "conda",
  2106. "container",
  2107. "generic",
  2108. "helm",
  2109. "maven",
  2110. "npm",
  2111. "nuget",
  2112. "pub",
  2113. "pypi",
  2114. "rubygems",
  2115. "vagrant"
  2116. ],
  2117. "type": "string",
  2118. "description": "package type filter",
  2119. "name": "type",
  2120. "in": "query"
  2121. },
  2122. {
  2123. "type": "string",
  2124. "description": "name filter",
  2125. "name": "q",
  2126. "in": "query"
  2127. }
  2128. ],
  2129. "responses": {
  2130. "200": {
  2131. "$ref": "#/responses/PackageList"
  2132. }
  2133. }
  2134. }
  2135. },
  2136. "/packages/{owner}/{type}/{name}/{version}": {
  2137. "get": {
  2138. "produces": [
  2139. "application/json"
  2140. ],
  2141. "tags": [
  2142. "package"
  2143. ],
  2144. "summary": "Gets a package",
  2145. "operationId": "getPackage",
  2146. "parameters": [
  2147. {
  2148. "type": "string",
  2149. "description": "owner of the package",
  2150. "name": "owner",
  2151. "in": "path",
  2152. "required": true
  2153. },
  2154. {
  2155. "type": "string",
  2156. "description": "type of the package",
  2157. "name": "type",
  2158. "in": "path",
  2159. "required": true
  2160. },
  2161. {
  2162. "type": "string",
  2163. "description": "name of the package",
  2164. "name": "name",
  2165. "in": "path",
  2166. "required": true
  2167. },
  2168. {
  2169. "type": "string",
  2170. "description": "version of the package",
  2171. "name": "version",
  2172. "in": "path",
  2173. "required": true
  2174. }
  2175. ],
  2176. "responses": {
  2177. "200": {
  2178. "$ref": "#/responses/Package"
  2179. },
  2180. "404": {
  2181. "$ref": "#/responses/notFound"
  2182. }
  2183. }
  2184. },
  2185. "delete": {
  2186. "tags": [
  2187. "package"
  2188. ],
  2189. "summary": "Delete a package",
  2190. "operationId": "deletePackage",
  2191. "parameters": [
  2192. {
  2193. "type": "string",
  2194. "description": "owner of the package",
  2195. "name": "owner",
  2196. "in": "path",
  2197. "required": true
  2198. },
  2199. {
  2200. "type": "string",
  2201. "description": "type of the package",
  2202. "name": "type",
  2203. "in": "path",
  2204. "required": true
  2205. },
  2206. {
  2207. "type": "string",
  2208. "description": "name of the package",
  2209. "name": "name",
  2210. "in": "path",
  2211. "required": true
  2212. },
  2213. {
  2214. "type": "string",
  2215. "description": "version of the package",
  2216. "name": "version",
  2217. "in": "path",
  2218. "required": true
  2219. }
  2220. ],
  2221. "responses": {
  2222. "204": {
  2223. "$ref": "#/responses/empty"
  2224. },
  2225. "404": {
  2226. "$ref": "#/responses/notFound"
  2227. }
  2228. }
  2229. }
  2230. },
  2231. "/packages/{owner}/{type}/{name}/{version}/files": {
  2232. "get": {
  2233. "produces": [
  2234. "application/json"
  2235. ],
  2236. "tags": [
  2237. "package"
  2238. ],
  2239. "summary": "Gets all files of a package",
  2240. "operationId": "listPackageFiles",
  2241. "parameters": [
  2242. {
  2243. "type": "string",
  2244. "description": "owner of the package",
  2245. "name": "owner",
  2246. "in": "path",
  2247. "required": true
  2248. },
  2249. {
  2250. "type": "string",
  2251. "description": "type of the package",
  2252. "name": "type",
  2253. "in": "path",
  2254. "required": true
  2255. },
  2256. {
  2257. "type": "string",
  2258. "description": "name of the package",
  2259. "name": "name",
  2260. "in": "path",
  2261. "required": true
  2262. },
  2263. {
  2264. "type": "string",
  2265. "description": "version of the package",
  2266. "name": "version",
  2267. "in": "path",
  2268. "required": true
  2269. }
  2270. ],
  2271. "responses": {
  2272. "200": {
  2273. "$ref": "#/responses/PackageFileList"
  2274. },
  2275. "404": {
  2276. "$ref": "#/responses/notFound"
  2277. }
  2278. }
  2279. }
  2280. },
  2281. "/repos/issues/search": {
  2282. "get": {
  2283. "produces": [
  2284. "application/json"
  2285. ],
  2286. "tags": [
  2287. "issue"
  2288. ],
  2289. "summary": "Search for issues across the repositories that the user has access to",
  2290. "operationId": "issueSearchIssues",
  2291. "parameters": [
  2292. {
  2293. "type": "string",
  2294. "description": "whether issue is open or closed",
  2295. "name": "state",
  2296. "in": "query"
  2297. },
  2298. {
  2299. "type": "string",
  2300. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  2301. "name": "labels",
  2302. "in": "query"
  2303. },
  2304. {
  2305. "type": "string",
  2306. "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
  2307. "name": "milestones",
  2308. "in": "query"
  2309. },
  2310. {
  2311. "type": "string",
  2312. "description": "search string",
  2313. "name": "q",
  2314. "in": "query"
  2315. },
  2316. {
  2317. "type": "integer",
  2318. "format": "int64",
  2319. "description": "repository to prioritize in the results",
  2320. "name": "priority_repo_id",
  2321. "in": "query"
  2322. },
  2323. {
  2324. "type": "string",
  2325. "description": "filter by type (issues / pulls) if set",
  2326. "name": "type",
  2327. "in": "query"
  2328. },
  2329. {
  2330. "type": "string",
  2331. "format": "date-time",
  2332. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  2333. "name": "since",
  2334. "in": "query"
  2335. },
  2336. {
  2337. "type": "string",
  2338. "format": "date-time",
  2339. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  2340. "name": "before",
  2341. "in": "query"
  2342. },
  2343. {
  2344. "type": "boolean",
  2345. "description": "filter (issues / pulls) assigned to you, default is false",
  2346. "name": "assigned",
  2347. "in": "query"
  2348. },
  2349. {
  2350. "type": "boolean",
  2351. "description": "filter (issues / pulls) created by you, default is false",
  2352. "name": "created",
  2353. "in": "query"
  2354. },
  2355. {
  2356. "type": "boolean",
  2357. "description": "filter (issues / pulls) mentioning you, default is false",
  2358. "name": "mentioned",
  2359. "in": "query"
  2360. },
  2361. {
  2362. "type": "boolean",
  2363. "description": "filter pulls requesting your review, default is false",
  2364. "name": "review_requested",
  2365. "in": "query"
  2366. },
  2367. {
  2368. "type": "string",
  2369. "description": "filter by owner",
  2370. "name": "owner",
  2371. "in": "query"
  2372. },
  2373. {
  2374. "type": "string",
  2375. "description": "filter by team (requires organization owner parameter to be provided)",
  2376. "name": "team",
  2377. "in": "query"
  2378. },
  2379. {
  2380. "type": "integer",
  2381. "description": "page number of results to return (1-based)",
  2382. "name": "page",
  2383. "in": "query"
  2384. },
  2385. {
  2386. "type": "integer",
  2387. "description": "page size of results",
  2388. "name": "limit",
  2389. "in": "query"
  2390. }
  2391. ],
  2392. "responses": {
  2393. "200": {
  2394. "$ref": "#/responses/IssueList"
  2395. }
  2396. }
  2397. }
  2398. },
  2399. "/repos/migrate": {
  2400. "post": {
  2401. "consumes": [
  2402. "application/json"
  2403. ],
  2404. "produces": [
  2405. "application/json"
  2406. ],
  2407. "tags": [
  2408. "repository"
  2409. ],
  2410. "summary": "Migrate a remote git repository",
  2411. "operationId": "repoMigrate",
  2412. "parameters": [
  2413. {
  2414. "name": "body",
  2415. "in": "body",
  2416. "schema": {
  2417. "$ref": "#/definitions/MigrateRepoOptions"
  2418. }
  2419. }
  2420. ],
  2421. "responses": {
  2422. "201": {
  2423. "$ref": "#/responses/Repository"
  2424. },
  2425. "403": {
  2426. "$ref": "#/responses/forbidden"
  2427. },
  2428. "409": {
  2429. "description": "The repository with the same name already exists."
  2430. },
  2431. "422": {
  2432. "$ref": "#/responses/validationError"
  2433. }
  2434. }
  2435. }
  2436. },
  2437. "/repos/search": {
  2438. "get": {
  2439. "produces": [
  2440. "application/json"
  2441. ],
  2442. "tags": [
  2443. "repository"
  2444. ],
  2445. "summary": "Search for repositories",
  2446. "operationId": "repoSearch",
  2447. "parameters": [
  2448. {
  2449. "type": "string",
  2450. "description": "keyword",
  2451. "name": "q",
  2452. "in": "query"
  2453. },
  2454. {
  2455. "type": "boolean",
  2456. "description": "Limit search to repositories with keyword as topic",
  2457. "name": "topic",
  2458. "in": "query"
  2459. },
  2460. {
  2461. "type": "boolean",
  2462. "description": "include search of keyword within repository description",
  2463. "name": "includeDesc",
  2464. "in": "query"
  2465. },
  2466. {
  2467. "type": "integer",
  2468. "format": "int64",
  2469. "description": "search only for repos that the user with the given id owns or contributes to",
  2470. "name": "uid",
  2471. "in": "query"
  2472. },
  2473. {
  2474. "type": "integer",
  2475. "format": "int64",
  2476. "description": "repo owner to prioritize in the results",
  2477. "name": "priority_owner_id",
  2478. "in": "query"
  2479. },
  2480. {
  2481. "type": "integer",
  2482. "format": "int64",
  2483. "description": "search only for repos that belong to the given team id",
  2484. "name": "team_id",
  2485. "in": "query"
  2486. },
  2487. {
  2488. "type": "integer",
  2489. "format": "int64",
  2490. "description": "search only for repos that the user with the given id has starred",
  2491. "name": "starredBy",
  2492. "in": "query"
  2493. },
  2494. {
  2495. "type": "boolean",
  2496. "description": "include private repositories this user has access to (defaults to true)",
  2497. "name": "private",
  2498. "in": "query"
  2499. },
  2500. {
  2501. "type": "boolean",
  2502. "description": "show only pubic, private or all repositories (defaults to all)",
  2503. "name": "is_private",
  2504. "in": "query"
  2505. },
  2506. {
  2507. "type": "boolean",
  2508. "description": "include template repositories this user has access to (defaults to true)",
  2509. "name": "template",
  2510. "in": "query"
  2511. },
  2512. {
  2513. "type": "boolean",
  2514. "description": "show only archived, non-archived or all repositories (defaults to all)",
  2515. "name": "archived",
  2516. "in": "query"
  2517. },
  2518. {
  2519. "type": "string",
  2520. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  2521. "name": "mode",
  2522. "in": "query"
  2523. },
  2524. {
  2525. "type": "boolean",
  2526. "description": "if `uid` is given, search only for repos that the user owns",
  2527. "name": "exclusive",
  2528. "in": "query"
  2529. },
  2530. {
  2531. "type": "string",
  2532. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  2533. "name": "sort",
  2534. "in": "query"
  2535. },
  2536. {
  2537. "type": "string",
  2538. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  2539. "name": "order",
  2540. "in": "query"
  2541. },
  2542. {
  2543. "type": "integer",
  2544. "description": "page number of results to return (1-based)",
  2545. "name": "page",
  2546. "in": "query"
  2547. },
  2548. {
  2549. "type": "integer",
  2550. "description": "page size of results",
  2551. "name": "limit",
  2552. "in": "query"
  2553. }
  2554. ],
  2555. "responses": {
  2556. "200": {
  2557. "$ref": "#/responses/SearchResults"
  2558. },
  2559. "422": {
  2560. "$ref": "#/responses/validationError"
  2561. }
  2562. }
  2563. }
  2564. },
  2565. "/repos/{owner}/{repo}": {
  2566. "get": {
  2567. "produces": [
  2568. "application/json"
  2569. ],
  2570. "tags": [
  2571. "repository"
  2572. ],
  2573. "summary": "Get a repository",
  2574. "operationId": "repoGet",
  2575. "parameters": [
  2576. {
  2577. "type": "string",
  2578. "description": "owner of the repo",
  2579. "name": "owner",
  2580. "in": "path",
  2581. "required": true
  2582. },
  2583. {
  2584. "type": "string",
  2585. "description": "name of the repo",
  2586. "name": "repo",
  2587. "in": "path",
  2588. "required": true
  2589. }
  2590. ],
  2591. "responses": {
  2592. "200": {
  2593. "$ref": "#/responses/Repository"
  2594. }
  2595. }
  2596. },
  2597. "delete": {
  2598. "produces": [
  2599. "application/json"
  2600. ],
  2601. "tags": [
  2602. "repository"
  2603. ],
  2604. "summary": "Delete a repository",
  2605. "operationId": "repoDelete",
  2606. "parameters": [
  2607. {
  2608. "type": "string",
  2609. "description": "owner of the repo to delete",
  2610. "name": "owner",
  2611. "in": "path",
  2612. "required": true
  2613. },
  2614. {
  2615. "type": "string",
  2616. "description": "name of the repo to delete",
  2617. "name": "repo",
  2618. "in": "path",
  2619. "required": true
  2620. }
  2621. ],
  2622. "responses": {
  2623. "204": {
  2624. "$ref": "#/responses/empty"
  2625. },
  2626. "403": {
  2627. "$ref": "#/responses/forbidden"
  2628. }
  2629. }
  2630. },
  2631. "patch": {
  2632. "produces": [
  2633. "application/json"
  2634. ],
  2635. "tags": [
  2636. "repository"
  2637. ],
  2638. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  2639. "operationId": "repoEdit",
  2640. "parameters": [
  2641. {
  2642. "type": "string",
  2643. "description": "owner of the repo to edit",
  2644. "name": "owner",
  2645. "in": "path",
  2646. "required": true
  2647. },
  2648. {
  2649. "type": "string",
  2650. "description": "name of the repo to edit",
  2651. "name": "repo",
  2652. "in": "path",
  2653. "required": true
  2654. },
  2655. {
  2656. "description": "Properties of a repo that you can edit",
  2657. "name": "body",
  2658. "in": "body",
  2659. "schema": {
  2660. "$ref": "#/definitions/EditRepoOption"
  2661. }
  2662. }
  2663. ],
  2664. "responses": {
  2665. "200": {
  2666. "$ref": "#/responses/Repository"
  2667. },
  2668. "403": {
  2669. "$ref": "#/responses/forbidden"
  2670. },
  2671. "422": {
  2672. "$ref": "#/responses/validationError"
  2673. }
  2674. }
  2675. }
  2676. },
  2677. "/repos/{owner}/{repo}/archive/{archive}": {
  2678. "get": {
  2679. "produces": [
  2680. "application/json"
  2681. ],
  2682. "tags": [
  2683. "repository"
  2684. ],
  2685. "summary": "Get an archive of a repository",
  2686. "operationId": "repoGetArchive",
  2687. "parameters": [
  2688. {
  2689. "type": "string",
  2690. "description": "owner of the repo",
  2691. "name": "owner",
  2692. "in": "path",
  2693. "required": true
  2694. },
  2695. {
  2696. "type": "string",
  2697. "description": "name of the repo",
  2698. "name": "repo",
  2699. "in": "path",
  2700. "required": true
  2701. },
  2702. {
  2703. "type": "string",
  2704. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  2705. "name": "archive",
  2706. "in": "path",
  2707. "required": true
  2708. }
  2709. ],
  2710. "responses": {
  2711. "200": {
  2712. "description": "success"
  2713. },
  2714. "404": {
  2715. "$ref": "#/responses/notFound"
  2716. }
  2717. }
  2718. }
  2719. },
  2720. "/repos/{owner}/{repo}/assignees": {
  2721. "get": {
  2722. "produces": [
  2723. "application/json"
  2724. ],
  2725. "tags": [
  2726. "repository"
  2727. ],
  2728. "summary": "Return all users that have write access and can be assigned to issues",
  2729. "operationId": "repoGetAssignees",
  2730. "parameters": [
  2731. {
  2732. "type": "string",
  2733. "description": "owner of the repo",
  2734. "name": "owner",
  2735. "in": "path",
  2736. "required": true
  2737. },
  2738. {
  2739. "type": "string",
  2740. "description": "name of the repo",
  2741. "name": "repo",
  2742. "in": "path",
  2743. "required": true
  2744. }
  2745. ],
  2746. "responses": {
  2747. "200": {
  2748. "$ref": "#/responses/UserList"
  2749. }
  2750. }
  2751. }
  2752. },
  2753. "/repos/{owner}/{repo}/branch_protections": {
  2754. "get": {
  2755. "produces": [
  2756. "application/json"
  2757. ],
  2758. "tags": [
  2759. "repository"
  2760. ],
  2761. "summary": "List branch protections for a repository",
  2762. "operationId": "repoListBranchProtection",
  2763. "parameters": [
  2764. {
  2765. "type": "string",
  2766. "description": "owner of the repo",
  2767. "name": "owner",
  2768. "in": "path",
  2769. "required": true
  2770. },
  2771. {
  2772. "type": "string",
  2773. "description": "name of the repo",
  2774. "name": "repo",
  2775. "in": "path",
  2776. "required": true
  2777. }
  2778. ],
  2779. "responses": {
  2780. "200": {
  2781. "$ref": "#/responses/BranchProtectionList"
  2782. }
  2783. }
  2784. },
  2785. "post": {
  2786. "consumes": [
  2787. "application/json"
  2788. ],
  2789. "produces": [
  2790. "application/json"
  2791. ],
  2792. "tags": [
  2793. "repository"
  2794. ],
  2795. "summary": "Create a branch protections for a repository",
  2796. "operationId": "repoCreateBranchProtection",
  2797. "parameters": [
  2798. {
  2799. "type": "string",
  2800. "description": "owner of the repo",
  2801. "name": "owner",
  2802. "in": "path",
  2803. "required": true
  2804. },
  2805. {
  2806. "type": "string",
  2807. "description": "name of the repo",
  2808. "name": "repo",
  2809. "in": "path",
  2810. "required": true
  2811. },
  2812. {
  2813. "name": "body",
  2814. "in": "body",
  2815. "schema": {
  2816. "$ref": "#/definitions/CreateBranchProtectionOption"
  2817. }
  2818. }
  2819. ],
  2820. "responses": {
  2821. "201": {
  2822. "$ref": "#/responses/BranchProtection"
  2823. },
  2824. "403": {
  2825. "$ref": "#/responses/forbidden"
  2826. },
  2827. "404": {
  2828. "$ref": "#/responses/notFound"
  2829. },
  2830. "422": {
  2831. "$ref": "#/responses/validationError"
  2832. }
  2833. }
  2834. }
  2835. },
  2836. "/repos/{owner}/{repo}/branch_protections/{name}": {
  2837. "get": {
  2838. "produces": [
  2839. "application/json"
  2840. ],
  2841. "tags": [
  2842. "repository"
  2843. ],
  2844. "summary": "Get a specific branch protection for the repository",
  2845. "operationId": "repoGetBranchProtection",
  2846. "parameters": [
  2847. {
  2848. "type": "string",
  2849. "description": "owner of the repo",
  2850. "name": "owner",
  2851. "in": "path",
  2852. "required": true
  2853. },
  2854. {
  2855. "type": "string",
  2856. "description": "name of the repo",
  2857. "name": "repo",
  2858. "in": "path",
  2859. "required": true
  2860. },
  2861. {
  2862. "type": "string",
  2863. "description": "name of protected branch",
  2864. "name": "name",
  2865. "in": "path",
  2866. "required": true
  2867. }
  2868. ],
  2869. "responses": {
  2870. "200": {
  2871. "$ref": "#/responses/BranchProtection"
  2872. },
  2873. "404": {
  2874. "$ref": "#/responses/notFound"
  2875. }
  2876. }
  2877. },
  2878. "delete": {
  2879. "produces": [
  2880. "application/json"
  2881. ],
  2882. "tags": [
  2883. "repository"
  2884. ],
  2885. "summary": "Delete a specific branch protection for the repository",
  2886. "operationId": "repoDeleteBranchProtection",
  2887. "parameters": [
  2888. {
  2889. "type": "string",
  2890. "description": "owner of the repo",
  2891. "name": "owner",
  2892. "in": "path",
  2893. "required": true
  2894. },
  2895. {
  2896. "type": "string",
  2897. "description": "name of the repo",
  2898. "name": "repo",
  2899. "in": "path",
  2900. "required": true
  2901. },
  2902. {
  2903. "type": "string",
  2904. "description": "name of protected branch",
  2905. "name": "name",
  2906. "in": "path",
  2907. "required": true
  2908. }
  2909. ],
  2910. "responses": {
  2911. "204": {
  2912. "$ref": "#/responses/empty"
  2913. },
  2914. "404": {
  2915. "$ref": "#/responses/notFound"
  2916. }
  2917. }
  2918. },
  2919. "patch": {
  2920. "consumes": [
  2921. "application/json"
  2922. ],
  2923. "produces": [
  2924. "application/json"
  2925. ],
  2926. "tags": [
  2927. "repository"
  2928. ],
  2929. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  2930. "operationId": "repoEditBranchProtection",
  2931. "parameters": [
  2932. {
  2933. "type": "string",
  2934. "description": "owner of the repo",
  2935. "name": "owner",
  2936. "in": "path",
  2937. "required": true
  2938. },
  2939. {
  2940. "type": "string",
  2941. "description": "name of the repo",
  2942. "name": "repo",
  2943. "in": "path",
  2944. "required": true
  2945. },
  2946. {
  2947. "type": "string",
  2948. "description": "name of protected branch",
  2949. "name": "name",
  2950. "in": "path",
  2951. "required": true
  2952. },
  2953. {
  2954. "name": "body",
  2955. "in": "body",
  2956. "schema": {
  2957. "$ref": "#/definitions/EditBranchProtectionOption"
  2958. }
  2959. }
  2960. ],
  2961. "responses": {
  2962. "200": {
  2963. "$ref": "#/responses/BranchProtection"
  2964. },
  2965. "404": {
  2966. "$ref": "#/responses/notFound"
  2967. },
  2968. "422": {
  2969. "$ref": "#/responses/validationError"
  2970. }
  2971. }
  2972. }
  2973. },
  2974. "/repos/{owner}/{repo}/branches": {
  2975. "get": {
  2976. "produces": [
  2977. "application/json"
  2978. ],
  2979. "tags": [
  2980. "repository"
  2981. ],
  2982. "summary": "List a repository's branches",
  2983. "operationId": "repoListBranches",
  2984. "parameters": [
  2985. {
  2986. "type": "string",
  2987. "description": "owner of the repo",
  2988. "name": "owner",
  2989. "in": "path",
  2990. "required": true
  2991. },
  2992. {
  2993. "type": "string",
  2994. "description": "name of the repo",
  2995. "name": "repo",
  2996. "in": "path",
  2997. "required": true
  2998. },
  2999. {
  3000. "type": "integer",
  3001. "description": "page number of results to return (1-based)",
  3002. "name": "page",
  3003. "in": "query"
  3004. },
  3005. {
  3006. "type": "integer",
  3007. "description": "page size of results",
  3008. "name": "limit",
  3009. "in": "query"
  3010. }
  3011. ],
  3012. "responses": {
  3013. "200": {
  3014. "$ref": "#/responses/BranchList"
  3015. }
  3016. }
  3017. },
  3018. "post": {
  3019. "consumes": [
  3020. "application/json"
  3021. ],
  3022. "produces": [
  3023. "application/json"
  3024. ],
  3025. "tags": [
  3026. "repository"
  3027. ],
  3028. "summary": "Create a branch",
  3029. "operationId": "repoCreateBranch",
  3030. "parameters": [
  3031. {
  3032. "type": "string",
  3033. "description": "owner of the repo",
  3034. "name": "owner",
  3035. "in": "path",
  3036. "required": true
  3037. },
  3038. {
  3039. "type": "string",
  3040. "description": "name of the repo",
  3041. "name": "repo",
  3042. "in": "path",
  3043. "required": true
  3044. },
  3045. {
  3046. "name": "body",
  3047. "in": "body",
  3048. "schema": {
  3049. "$ref": "#/definitions/CreateBranchRepoOption"
  3050. }
  3051. }
  3052. ],
  3053. "responses": {
  3054. "201": {
  3055. "$ref": "#/responses/Branch"
  3056. },
  3057. "404": {
  3058. "description": "The old branch does not exist."
  3059. },
  3060. "409": {
  3061. "description": "The branch with the same name already exists."
  3062. }
  3063. }
  3064. }
  3065. },
  3066. "/repos/{owner}/{repo}/branches/{branch}": {
  3067. "get": {
  3068. "produces": [
  3069. "application/json"
  3070. ],
  3071. "tags": [
  3072. "repository"
  3073. ],
  3074. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  3075. "operationId": "repoGetBranch",
  3076. "parameters": [
  3077. {
  3078. "type": "string",
  3079. "description": "owner of the repo",
  3080. "name": "owner",
  3081. "in": "path",
  3082. "required": true
  3083. },
  3084. {
  3085. "type": "string",
  3086. "description": "name of the repo",
  3087. "name": "repo",
  3088. "in": "path",
  3089. "required": true
  3090. },
  3091. {
  3092. "type": "string",
  3093. "description": "branch to get",
  3094. "name": "branch",
  3095. "in": "path",
  3096. "required": true
  3097. }
  3098. ],
  3099. "responses": {
  3100. "200": {
  3101. "$ref": "#/responses/Branch"
  3102. },
  3103. "404": {
  3104. "$ref": "#/responses/notFound"
  3105. }
  3106. }
  3107. },
  3108. "delete": {
  3109. "produces": [
  3110. "application/json"
  3111. ],
  3112. "tags": [
  3113. "repository"
  3114. ],
  3115. "summary": "Delete a specific branch from a repository",
  3116. "operationId": "repoDeleteBranch",
  3117. "parameters": [
  3118. {
  3119. "type": "string",
  3120. "description": "owner of the repo",
  3121. "name": "owner",
  3122. "in": "path",
  3123. "required": true
  3124. },
  3125. {
  3126. "type": "string",
  3127. "description": "name of the repo",
  3128. "name": "repo",
  3129. "in": "path",
  3130. "required": true
  3131. },
  3132. {
  3133. "type": "string",
  3134. "description": "branch to delete",
  3135. "name": "branch",
  3136. "in": "path",
  3137. "required": true
  3138. }
  3139. ],
  3140. "responses": {
  3141. "204": {
  3142. "$ref": "#/responses/empty"
  3143. },
  3144. "403": {
  3145. "$ref": "#/responses/error"
  3146. },
  3147. "404": {
  3148. "$ref": "#/responses/notFound"
  3149. }
  3150. }
  3151. }
  3152. },
  3153. "/repos/{owner}/{repo}/collaborators": {
  3154. "get": {
  3155. "produces": [
  3156. "application/json"
  3157. ],
  3158. "tags": [
  3159. "repository"
  3160. ],
  3161. "summary": "List a repository's collaborators",
  3162. "operationId": "repoListCollaborators",
  3163. "parameters": [
  3164. {
  3165. "type": "string",
  3166. "description": "owner of the repo",
  3167. "name": "owner",
  3168. "in": "path",
  3169. "required": true
  3170. },
  3171. {
  3172. "type": "string",
  3173. "description": "name of the repo",
  3174. "name": "repo",
  3175. "in": "path",
  3176. "required": true
  3177. },
  3178. {
  3179. "type": "integer",
  3180. "description": "page number of results to return (1-based)",
  3181. "name": "page",
  3182. "in": "query"
  3183. },
  3184. {
  3185. "type": "integer",
  3186. "description": "page size of results",
  3187. "name": "limit",
  3188. "in": "query"
  3189. }
  3190. ],
  3191. "responses": {
  3192. "200": {
  3193. "$ref": "#/responses/UserList"
  3194. }
  3195. }
  3196. }
  3197. },
  3198. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  3199. "get": {
  3200. "produces": [
  3201. "application/json"
  3202. ],
  3203. "tags": [
  3204. "repository"
  3205. ],
  3206. "summary": "Check if a user is a collaborator of a repository",
  3207. "operationId": "repoCheckCollaborator",
  3208. "parameters": [
  3209. {
  3210. "type": "string",
  3211. "description": "owner of the repo",
  3212. "name": "owner",
  3213. "in": "path",
  3214. "required": true
  3215. },
  3216. {
  3217. "type": "string",
  3218. "description": "name of the repo",
  3219. "name": "repo",
  3220. "in": "path",
  3221. "required": true
  3222. },
  3223. {
  3224. "type": "string",
  3225. "description": "username of the collaborator",
  3226. "name": "collaborator",
  3227. "in": "path",
  3228. "required": true
  3229. }
  3230. ],
  3231. "responses": {
  3232. "204": {
  3233. "$ref": "#/responses/empty"
  3234. },
  3235. "404": {
  3236. "$ref": "#/responses/notFound"
  3237. },
  3238. "422": {
  3239. "$ref": "#/responses/validationError"
  3240. }
  3241. }
  3242. },
  3243. "put": {
  3244. "produces": [
  3245. "application/json"
  3246. ],
  3247. "tags": [
  3248. "repository"
  3249. ],
  3250. "summary": "Add a collaborator to a repository",
  3251. "operationId": "repoAddCollaborator",
  3252. "parameters": [
  3253. {
  3254. "type": "string",
  3255. "description": "owner of the repo",
  3256. "name": "owner",
  3257. "in": "path",
  3258. "required": true
  3259. },
  3260. {
  3261. "type": "string",
  3262. "description": "name of the repo",
  3263. "name": "repo",
  3264. "in": "path",
  3265. "required": true
  3266. },
  3267. {
  3268. "type": "string",
  3269. "description": "username of the collaborator to add",
  3270. "name": "collaborator",
  3271. "in": "path",
  3272. "required": true
  3273. },
  3274. {
  3275. "name": "body",
  3276. "in": "body",
  3277. "schema": {
  3278. "$ref": "#/definitions/AddCollaboratorOption"
  3279. }
  3280. }
  3281. ],
  3282. "responses": {
  3283. "204": {
  3284. "$ref": "#/responses/empty"
  3285. },
  3286. "422": {
  3287. "$ref": "#/responses/validationError"
  3288. }
  3289. }
  3290. },
  3291. "delete": {
  3292. "produces": [
  3293. "application/json"
  3294. ],
  3295. "tags": [
  3296. "repository"
  3297. ],
  3298. "summary": "Delete a collaborator from a repository",
  3299. "operationId": "repoDeleteCollaborator",
  3300. "parameters": [
  3301. {
  3302. "type": "string",
  3303. "description": "owner of the repo",
  3304. "name": "owner",
  3305. "in": "path",
  3306. "required": true
  3307. },
  3308. {
  3309. "type": "string",
  3310. "description": "name of the repo",
  3311. "name": "repo",
  3312. "in": "path",
  3313. "required": true
  3314. },
  3315. {
  3316. "type": "string",
  3317. "description": "username of the collaborator to delete",
  3318. "name": "collaborator",
  3319. "in": "path",
  3320. "required": true
  3321. }
  3322. ],
  3323. "responses": {
  3324. "204": {
  3325. "$ref": "#/responses/empty"
  3326. },
  3327. "422": {
  3328. "$ref": "#/responses/validationError"
  3329. }
  3330. }
  3331. }
  3332. },
  3333. "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
  3334. "get": {
  3335. "produces": [
  3336. "application/json"
  3337. ],
  3338. "tags": [
  3339. "repository"
  3340. ],
  3341. "summary": "Get repository permissions for a user",
  3342. "operationId": "repoGetRepoPermissions",
  3343. "parameters": [
  3344. {
  3345. "type": "string",
  3346. "description": "owner of the repo",
  3347. "name": "owner",
  3348. "in": "path",
  3349. "required": true
  3350. },
  3351. {
  3352. "type": "string",
  3353. "description": "name of the repo",
  3354. "name": "repo",
  3355. "in": "path",
  3356. "required": true
  3357. },
  3358. {
  3359. "type": "string",
  3360. "description": "username of the collaborator",
  3361. "name": "collaborator",
  3362. "in": "path",
  3363. "required": true
  3364. }
  3365. ],
  3366. "responses": {
  3367. "200": {
  3368. "$ref": "#/responses/RepoCollaboratorPermission"
  3369. },
  3370. "403": {
  3371. "$ref": "#/responses/forbidden"
  3372. },
  3373. "404": {
  3374. "$ref": "#/responses/notFound"
  3375. }
  3376. }
  3377. }
  3378. },
  3379. "/repos/{owner}/{repo}/commits": {
  3380. "get": {
  3381. "produces": [
  3382. "application/json"
  3383. ],
  3384. "tags": [
  3385. "repository"
  3386. ],
  3387. "summary": "Get a list of all commits from a repository",
  3388. "operationId": "repoGetAllCommits",
  3389. "parameters": [
  3390. {
  3391. "type": "string",
  3392. "description": "owner of the repo",
  3393. "name": "owner",
  3394. "in": "path",
  3395. "required": true
  3396. },
  3397. {
  3398. "type": "string",
  3399. "description": "name of the repo",
  3400. "name": "repo",
  3401. "in": "path",
  3402. "required": true
  3403. },
  3404. {
  3405. "type": "string",
  3406. "description": "SHA or branch to start listing commits from (usually 'master')",
  3407. "name": "sha",
  3408. "in": "query"
  3409. },
  3410. {
  3411. "type": "string",
  3412. "description": "filepath of a file/dir",
  3413. "name": "path",
  3414. "in": "query"
  3415. },
  3416. {
  3417. "type": "boolean",
  3418. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  3419. "name": "stat",
  3420. "in": "query"
  3421. },
  3422. {
  3423. "type": "integer",
  3424. "description": "page number of results to return (1-based)",
  3425. "name": "page",
  3426. "in": "query"
  3427. },
  3428. {
  3429. "type": "integer",
  3430. "description": "page size of results (ignored if used with 'path')",
  3431. "name": "limit",
  3432. "in": "query"
  3433. }
  3434. ],
  3435. "responses": {
  3436. "200": {
  3437. "$ref": "#/responses/CommitList"
  3438. },
  3439. "404": {
  3440. "$ref": "#/responses/notFound"
  3441. },
  3442. "409": {
  3443. "$ref": "#/responses/EmptyRepository"
  3444. }
  3445. }
  3446. }
  3447. },
  3448. "/repos/{owner}/{repo}/commits/{ref}/status": {
  3449. "get": {
  3450. "produces": [
  3451. "application/json"
  3452. ],
  3453. "tags": [
  3454. "repository"
  3455. ],
  3456. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  3457. "operationId": "repoGetCombinedStatusByRef",
  3458. "parameters": [
  3459. {
  3460. "type": "string",
  3461. "description": "owner of the repo",
  3462. "name": "owner",
  3463. "in": "path",
  3464. "required": true
  3465. },
  3466. {
  3467. "type": "string",
  3468. "description": "name of the repo",
  3469. "name": "repo",
  3470. "in": "path",
  3471. "required": true
  3472. },
  3473. {
  3474. "type": "string",
  3475. "description": "name of branch/tag/commit",
  3476. "name": "ref",
  3477. "in": "path",
  3478. "required": true
  3479. },
  3480. {
  3481. "type": "integer",
  3482. "description": "page number of results to return (1-based)",
  3483. "name": "page",
  3484. "in": "query"
  3485. },
  3486. {
  3487. "type": "integer",
  3488. "description": "page size of results",
  3489. "name": "limit",
  3490. "in": "query"
  3491. }
  3492. ],
  3493. "responses": {
  3494. "200": {
  3495. "$ref": "#/responses/CombinedStatus"
  3496. },
  3497. "400": {
  3498. "$ref": "#/responses/error"
  3499. }
  3500. }
  3501. }
  3502. },
  3503. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  3504. "get": {
  3505. "produces": [
  3506. "application/json"
  3507. ],
  3508. "tags": [
  3509. "repository"
  3510. ],
  3511. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  3512. "operationId": "repoListStatusesByRef",
  3513. "parameters": [
  3514. {
  3515. "type": "string",
  3516. "description": "owner of the repo",
  3517. "name": "owner",
  3518. "in": "path",
  3519. "required": true
  3520. },
  3521. {
  3522. "type": "string",
  3523. "description": "name of the repo",
  3524. "name": "repo",
  3525. "in": "path",
  3526. "required": true
  3527. },
  3528. {
  3529. "type": "string",
  3530. "description": "name of branch/tag/commit",
  3531. "name": "ref",
  3532. "in": "path",
  3533. "required": true
  3534. },
  3535. {
  3536. "enum": [
  3537. "oldest",
  3538. "recentupdate",
  3539. "leastupdate",
  3540. "leastindex",
  3541. "highestindex"
  3542. ],
  3543. "type": "string",
  3544. "description": "type of sort",
  3545. "name": "sort",
  3546. "in": "query"
  3547. },
  3548. {
  3549. "enum": [
  3550. "pending",
  3551. "success",
  3552. "error",
  3553. "failure",
  3554. "warning"
  3555. ],
  3556. "type": "string",
  3557. "description": "type of state",
  3558. "name": "state",
  3559. "in": "query"
  3560. },
  3561. {
  3562. "type": "integer",
  3563. "description": "page number of results to return (1-based)",
  3564. "name": "page",
  3565. "in": "query"
  3566. },
  3567. {
  3568. "type": "integer",
  3569. "description": "page size of results",
  3570. "name": "limit",
  3571. "in": "query"
  3572. }
  3573. ],
  3574. "responses": {
  3575. "200": {
  3576. "$ref": "#/responses/CommitStatusList"
  3577. },
  3578. "400": {
  3579. "$ref": "#/responses/error"
  3580. }
  3581. }
  3582. }
  3583. },
  3584. "/repos/{owner}/{repo}/contents": {
  3585. "get": {
  3586. "produces": [
  3587. "application/json"
  3588. ],
  3589. "tags": [
  3590. "repository"
  3591. ],
  3592. "summary": "Gets the metadata of all the entries of the root dir",
  3593. "operationId": "repoGetContentsList",
  3594. "parameters": [
  3595. {
  3596. "type": "string",
  3597. "description": "owner of the repo",
  3598. "name": "owner",
  3599. "in": "path",
  3600. "required": true
  3601. },
  3602. {
  3603. "type": "string",
  3604. "description": "name of the repo",
  3605. "name": "repo",
  3606. "in": "path",
  3607. "required": true
  3608. },
  3609. {
  3610. "type": "string",
  3611. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  3612. "name": "ref",
  3613. "in": "query"
  3614. }
  3615. ],
  3616. "responses": {
  3617. "200": {
  3618. "$ref": "#/responses/ContentsListResponse"
  3619. },
  3620. "404": {
  3621. "$ref": "#/responses/notFound"
  3622. }
  3623. }
  3624. }
  3625. },
  3626. "/repos/{owner}/{repo}/contents/{filepath}": {
  3627. "get": {
  3628. "produces": [
  3629. "application/json"
  3630. ],
  3631. "tags": [
  3632. "repository"
  3633. ],
  3634. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  3635. "operationId": "repoGetContents",
  3636. "parameters": [
  3637. {
  3638. "type": "string",
  3639. "description": "owner of the repo",
  3640. "name": "owner",
  3641. "in": "path",
  3642. "required": true
  3643. },
  3644. {
  3645. "type": "string",
  3646. "description": "name of the repo",
  3647. "name": "repo",
  3648. "in": "path",
  3649. "required": true
  3650. },
  3651. {
  3652. "type": "string",
  3653. "description": "path of the dir, file, symlink or submodule in the repo",
  3654. "name": "filepath",
  3655. "in": "path",
  3656. "required": true
  3657. },
  3658. {
  3659. "type": "string",
  3660. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  3661. "name": "ref",
  3662. "in": "query"
  3663. }
  3664. ],
  3665. "responses": {
  3666. "200": {
  3667. "$ref": "#/responses/ContentsResponse"
  3668. },
  3669. "404": {
  3670. "$ref": "#/responses/notFound"
  3671. }
  3672. }
  3673. },
  3674. "put": {
  3675. "consumes": [
  3676. "application/json"
  3677. ],
  3678. "produces": [
  3679. "application/json"
  3680. ],
  3681. "tags": [
  3682. "repository"
  3683. ],
  3684. "summary": "Update a file in a repository",
  3685. "operationId": "repoUpdateFile",
  3686. "parameters": [
  3687. {
  3688. "type": "string",
  3689. "description": "owner of the repo",
  3690. "name": "owner",
  3691. "in": "path",
  3692. "required": true
  3693. },
  3694. {
  3695. "type": "string",
  3696. "description": "name of the repo",
  3697. "name": "repo",
  3698. "in": "path",
  3699. "required": true
  3700. },
  3701. {
  3702. "type": "string",
  3703. "description": "path of the file to update",
  3704. "name": "filepath",
  3705. "in": "path",
  3706. "required": true
  3707. },
  3708. {
  3709. "name": "body",
  3710. "in": "body",
  3711. "required": true,
  3712. "schema": {
  3713. "$ref": "#/definitions/UpdateFileOptions"
  3714. }
  3715. }
  3716. ],
  3717. "responses": {
  3718. "200": {
  3719. "$ref": "#/responses/FileResponse"
  3720. },
  3721. "403": {
  3722. "$ref": "#/responses/error"
  3723. },
  3724. "404": {
  3725. "$ref": "#/responses/notFound"
  3726. },
  3727. "422": {
  3728. "$ref": "#/responses/error"
  3729. }
  3730. }
  3731. },
  3732. "post": {
  3733. "consumes": [
  3734. "application/json"
  3735. ],
  3736. "produces": [
  3737. "application/json"
  3738. ],
  3739. "tags": [
  3740. "repository"
  3741. ],
  3742. "summary": "Create a file in a repository",
  3743. "operationId": "repoCreateFile",
  3744. "parameters": [
  3745. {
  3746. "type": "string",
  3747. "description": "owner of the repo",
  3748. "name": "owner",
  3749. "in": "path",
  3750. "required": true
  3751. },
  3752. {
  3753. "type": "string",
  3754. "description": "name of the repo",
  3755. "name": "repo",
  3756. "in": "path",
  3757. "required": true
  3758. },
  3759. {
  3760. "type": "string",
  3761. "description": "path of the file to create",
  3762. "name": "filepath",
  3763. "in": "path",
  3764. "required": true
  3765. },
  3766. {
  3767. "name": "body",
  3768. "in": "body",
  3769. "required": true,
  3770. "schema": {
  3771. "$ref": "#/definitions/CreateFileOptions"
  3772. }
  3773. }
  3774. ],
  3775. "responses": {
  3776. "201": {
  3777. "$ref": "#/responses/FileResponse"
  3778. },
  3779. "403": {
  3780. "$ref": "#/responses/error"
  3781. },
  3782. "404": {
  3783. "$ref": "#/responses/notFound"
  3784. },
  3785. "422": {
  3786. "$ref": "#/responses/error"
  3787. }
  3788. }
  3789. },
  3790. "delete": {
  3791. "consumes": [
  3792. "application/json"
  3793. ],
  3794. "produces": [
  3795. "application/json"
  3796. ],
  3797. "tags": [
  3798. "repository"
  3799. ],
  3800. "summary": "Delete a file in a repository",
  3801. "operationId": "repoDeleteFile",
  3802. "parameters": [
  3803. {
  3804. "type": "string",
  3805. "description": "owner of the repo",
  3806. "name": "owner",
  3807. "in": "path",
  3808. "required": true
  3809. },
  3810. {
  3811. "type": "string",
  3812. "description": "name of the repo",
  3813. "name": "repo",
  3814. "in": "path",
  3815. "required": true
  3816. },
  3817. {
  3818. "type": "string",
  3819. "description": "path of the file to delete",
  3820. "name": "filepath",
  3821. "in": "path",
  3822. "required": true
  3823. },
  3824. {
  3825. "name": "body",
  3826. "in": "body",
  3827. "required": true,
  3828. "schema": {
  3829. "$ref": "#/definitions/DeleteFileOptions"
  3830. }
  3831. }
  3832. ],
  3833. "responses": {
  3834. "200": {
  3835. "$ref": "#/responses/FileDeleteResponse"
  3836. },
  3837. "400": {
  3838. "$ref": "#/responses/error"
  3839. },
  3840. "403": {
  3841. "$ref": "#/responses/error"
  3842. },
  3843. "404": {
  3844. "$ref": "#/responses/error"
  3845. }
  3846. }
  3847. }
  3848. },
  3849. "/repos/{owner}/{repo}/diffpatch": {
  3850. "post": {
  3851. "consumes": [
  3852. "application/json"
  3853. ],
  3854. "produces": [
  3855. "application/json"
  3856. ],
  3857. "tags": [
  3858. "repository"
  3859. ],
  3860. "summary": "Apply diff patch to repository",
  3861. "operationId": "repoApplyDiffPatch",
  3862. "parameters": [
  3863. {
  3864. "type": "string",
  3865. "description": "owner of the repo",
  3866. "name": "owner",
  3867. "in": "path",
  3868. "required": true
  3869. },
  3870. {
  3871. "type": "string",
  3872. "description": "name of the repo",
  3873. "name": "repo",
  3874. "in": "path",
  3875. "required": true
  3876. },
  3877. {
  3878. "name": "body",
  3879. "in": "body",
  3880. "required": true,
  3881. "schema": {
  3882. "$ref": "#/definitions/UpdateFileOptions"
  3883. }
  3884. }
  3885. ],
  3886. "responses": {
  3887. "200": {
  3888. "$ref": "#/responses/FileResponse"
  3889. }
  3890. }
  3891. }
  3892. },
  3893. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  3894. "get": {
  3895. "produces": [
  3896. "application/json"
  3897. ],
  3898. "tags": [
  3899. "repository"
  3900. ],
  3901. "summary": "Get the EditorConfig definitions of a file in a repository",
  3902. "operationId": "repoGetEditorConfig",
  3903. "parameters": [
  3904. {
  3905. "type": "string",
  3906. "description": "owner of the repo",
  3907. "name": "owner",
  3908. "in": "path",
  3909. "required": true
  3910. },
  3911. {
  3912. "type": "string",
  3913. "description": "name of the repo",
  3914. "name": "repo",
  3915. "in": "path",
  3916. "required": true
  3917. },
  3918. {
  3919. "type": "string",
  3920. "description": "filepath of file to get",
  3921. "name": "filepath",
  3922. "in": "path",
  3923. "required": true
  3924. },
  3925. {
  3926. "type": "string",
  3927. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  3928. "name": "ref",
  3929. "in": "query"
  3930. }
  3931. ],
  3932. "responses": {
  3933. "200": {
  3934. "description": "success"
  3935. },
  3936. "404": {
  3937. "$ref": "#/responses/notFound"
  3938. }
  3939. }
  3940. }
  3941. },
  3942. "/repos/{owner}/{repo}/forks": {
  3943. "get": {
  3944. "produces": [
  3945. "application/json"
  3946. ],
  3947. "tags": [
  3948. "repository"
  3949. ],
  3950. "summary": "List a repository's forks",
  3951. "operationId": "listForks",
  3952. "parameters": [
  3953. {
  3954. "type": "string",
  3955. "description": "owner of the repo",
  3956. "name": "owner",
  3957. "in": "path",
  3958. "required": true
  3959. },
  3960. {
  3961. "type": "string",
  3962. "description": "name of the repo",
  3963. "name": "repo",
  3964. "in": "path",
  3965. "required": true
  3966. },
  3967. {
  3968. "type": "integer",
  3969. "description": "page number of results to return (1-based)",
  3970. "name": "page",
  3971. "in": "query"
  3972. },
  3973. {
  3974. "type": "integer",
  3975. "description": "page size of results",
  3976. "name": "limit",
  3977. "in": "query"
  3978. }
  3979. ],
  3980. "responses": {
  3981. "200": {
  3982. "$ref": "#/responses/RepositoryList"
  3983. }
  3984. }
  3985. },
  3986. "post": {
  3987. "produces": [
  3988. "application/json"
  3989. ],
  3990. "tags": [
  3991. "repository"
  3992. ],
  3993. "summary": "Fork a repository",
  3994. "operationId": "createFork",
  3995. "parameters": [
  3996. {
  3997. "type": "string",
  3998. "description": "owner of the repo to fork",
  3999. "name": "owner",
  4000. "in": "path",
  4001. "required": true
  4002. },
  4003. {
  4004. "type": "string",
  4005. "description": "name of the repo to fork",
  4006. "name": "repo",
  4007. "in": "path",
  4008. "required": true
  4009. },
  4010. {
  4011. "name": "body",
  4012. "in": "body",
  4013. "schema": {
  4014. "$ref": "#/definitions/CreateForkOption"
  4015. }
  4016. }
  4017. ],
  4018. "responses": {
  4019. "202": {
  4020. "$ref": "#/responses/Repository"
  4021. },
  4022. "403": {
  4023. "$ref": "#/responses/forbidden"
  4024. },
  4025. "409": {
  4026. "description": "The repository with the same name already exists."
  4027. },
  4028. "422": {
  4029. "$ref": "#/responses/validationError"
  4030. }
  4031. }
  4032. }
  4033. },
  4034. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  4035. "get": {
  4036. "produces": [
  4037. "application/json"
  4038. ],
  4039. "tags": [
  4040. "repository"
  4041. ],
  4042. "summary": "Gets the blob of a repository.",
  4043. "operationId": "GetBlob",
  4044. "parameters": [
  4045. {
  4046. "type": "string",
  4047. "description": "owner of the repo",
  4048. "name": "owner",
  4049. "in": "path",
  4050. "required": true
  4051. },
  4052. {
  4053. "type": "string",
  4054. "description": "name of the repo",
  4055. "name": "repo",
  4056. "in": "path",
  4057. "required": true
  4058. },
  4059. {
  4060. "type": "string",
  4061. "description": "sha of the commit",
  4062. "name": "sha",
  4063. "in": "path",
  4064. "required": true
  4065. }
  4066. ],
  4067. "responses": {
  4068. "200": {
  4069. "$ref": "#/responses/GitBlobResponse"
  4070. },
  4071. "400": {
  4072. "$ref": "#/responses/error"
  4073. }
  4074. }
  4075. }
  4076. },
  4077. "/repos/{owner}/{repo}/git/commits/{sha}": {
  4078. "get": {
  4079. "produces": [
  4080. "application/json"
  4081. ],
  4082. "tags": [
  4083. "repository"
  4084. ],
  4085. "summary": "Get a single commit from a repository",
  4086. "operationId": "repoGetSingleCommit",
  4087. "parameters": [
  4088. {
  4089. "type": "string",
  4090. "description": "owner of the repo",
  4091. "name": "owner",
  4092. "in": "path",
  4093. "required": true
  4094. },
  4095. {
  4096. "type": "string",
  4097. "description": "name of the repo",
  4098. "name": "repo",
  4099. "in": "path",
  4100. "required": true
  4101. },
  4102. {
  4103. "type": "string",
  4104. "description": "a git ref or commit sha",
  4105. "name": "sha",
  4106. "in": "path",
  4107. "required": true
  4108. }
  4109. ],
  4110. "responses": {
  4111. "200": {
  4112. "$ref": "#/responses/Commit"
  4113. },
  4114. "404": {
  4115. "$ref": "#/responses/notFound"
  4116. },
  4117. "422": {
  4118. "$ref": "#/responses/validationError"
  4119. }
  4120. }
  4121. }
  4122. },
  4123. "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
  4124. "get": {
  4125. "produces": [
  4126. "text/plain"
  4127. ],
  4128. "tags": [
  4129. "repository"
  4130. ],
  4131. "summary": "Get a commit's diff or patch",
  4132. "operationId": "repoDownloadCommitDiffOrPatch",
  4133. "parameters": [
  4134. {
  4135. "type": "string",
  4136. "description": "owner of the repo",
  4137. "name": "owner",
  4138. "in": "path",
  4139. "required": true
  4140. },
  4141. {
  4142. "type": "string",
  4143. "description": "name of the repo",
  4144. "name": "repo",
  4145. "in": "path",
  4146. "required": true
  4147. },
  4148. {
  4149. "type": "string",
  4150. "description": "SHA of the commit to get",
  4151. "name": "sha",
  4152. "in": "path",
  4153. "required": true
  4154. },
  4155. {
  4156. "enum": [
  4157. "diff",
  4158. "patch"
  4159. ],
  4160. "type": "string",
  4161. "description": "whether the output is diff or patch",
  4162. "name": "diffType",
  4163. "in": "path",
  4164. "required": true
  4165. }
  4166. ],
  4167. "responses": {
  4168. "200": {
  4169. "$ref": "#/responses/string"
  4170. },
  4171. "404": {
  4172. "$ref": "#/responses/notFound"
  4173. }
  4174. }
  4175. }
  4176. },
  4177. "/repos/{owner}/{repo}/git/notes/{sha}": {
  4178. "get": {
  4179. "produces": [
  4180. "application/json"
  4181. ],
  4182. "tags": [
  4183. "repository"
  4184. ],
  4185. "summary": "Get a note corresponding to a single commit from a repository",
  4186. "operationId": "repoGetNote",
  4187. "parameters": [
  4188. {
  4189. "type": "string",
  4190. "description": "owner of the repo",
  4191. "name": "owner",
  4192. "in": "path",
  4193. "required": true
  4194. },
  4195. {
  4196. "type": "string",
  4197. "description": "name of the repo",
  4198. "name": "repo",
  4199. "in": "path",
  4200. "required": true
  4201. },
  4202. {
  4203. "type": "string",
  4204. "description": "a git ref or commit sha",
  4205. "name": "sha",
  4206. "in": "path",
  4207. "required": true
  4208. }
  4209. ],
  4210. "responses": {
  4211. "200": {
  4212. "$ref": "#/responses/Note"
  4213. },
  4214. "404": {
  4215. "$ref": "#/responses/notFound"
  4216. },
  4217. "422": {
  4218. "$ref": "#/responses/validationError"
  4219. }
  4220. }
  4221. }
  4222. },
  4223. "/repos/{owner}/{repo}/git/refs": {
  4224. "get": {
  4225. "produces": [
  4226. "application/json"
  4227. ],
  4228. "tags": [
  4229. "repository"
  4230. ],
  4231. "summary": "Get specified ref or filtered repository's refs",
  4232. "operationId": "repoListAllGitRefs",
  4233. "parameters": [
  4234. {
  4235. "type": "string",
  4236. "description": "owner of the repo",
  4237. "name": "owner",
  4238. "in": "path",
  4239. "required": true
  4240. },
  4241. {
  4242. "type": "string",
  4243. "description": "name of the repo",
  4244. "name": "repo",
  4245. "in": "path",
  4246. "required": true
  4247. }
  4248. ],
  4249. "responses": {
  4250. "200": {
  4251. "$ref": "#/responses/ReferenceList"
  4252. },
  4253. "404": {
  4254. "$ref": "#/responses/notFound"
  4255. }
  4256. }
  4257. }
  4258. },
  4259. "/repos/{owner}/{repo}/git/refs/{ref}": {
  4260. "get": {
  4261. "produces": [
  4262. "application/json"
  4263. ],
  4264. "tags": [
  4265. "repository"
  4266. ],
  4267. "summary": "Get specified ref or filtered repository's refs",
  4268. "operationId": "repoListGitRefs",
  4269. "parameters": [
  4270. {
  4271. "type": "string",
  4272. "description": "owner of the repo",
  4273. "name": "owner",
  4274. "in": "path",
  4275. "required": true
  4276. },
  4277. {
  4278. "type": "string",
  4279. "description": "name of the repo",
  4280. "name": "repo",
  4281. "in": "path",
  4282. "required": true
  4283. },
  4284. {
  4285. "type": "string",
  4286. "description": "part or full name of the ref",
  4287. "name": "ref",
  4288. "in": "path",
  4289. "required": true
  4290. }
  4291. ],
  4292. "responses": {
  4293. "200": {
  4294. "$ref": "#/responses/ReferenceList"
  4295. },
  4296. "404": {
  4297. "$ref": "#/responses/notFound"
  4298. }
  4299. }
  4300. }
  4301. },
  4302. "/repos/{owner}/{repo}/git/tags/{sha}": {
  4303. "get": {
  4304. "produces": [
  4305. "application/json"
  4306. ],
  4307. "tags": [
  4308. "repository"
  4309. ],
  4310. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  4311. "operationId": "GetAnnotatedTag",
  4312. "parameters": [
  4313. {
  4314. "type": "string",
  4315. "description": "owner of the repo",
  4316. "name": "owner",
  4317. "in": "path",
  4318. "required": true
  4319. },
  4320. {
  4321. "type": "string",
  4322. "description": "name of the repo",
  4323. "name": "repo",
  4324. "in": "path",
  4325. "required": true
  4326. },
  4327. {
  4328. "type": "string",
  4329. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  4330. "name": "sha",
  4331. "in": "path",
  4332. "required": true
  4333. }
  4334. ],
  4335. "responses": {
  4336. "200": {
  4337. "$ref": "#/responses/AnnotatedTag"
  4338. },
  4339. "400": {
  4340. "$ref": "#/responses/error"
  4341. }
  4342. }
  4343. }
  4344. },
  4345. "/repos/{owner}/{repo}/git/trees/{sha}": {
  4346. "get": {
  4347. "produces": [
  4348. "application/json"
  4349. ],
  4350. "tags": [
  4351. "repository"
  4352. ],
  4353. "summary": "Gets the tree of a repository.",
  4354. "operationId": "GetTree",
  4355. "parameters": [
  4356. {
  4357. "type": "string",
  4358. "description": "owner of the repo",
  4359. "name": "owner",
  4360. "in": "path",
  4361. "required": true
  4362. },
  4363. {
  4364. "type": "string",
  4365. "description": "name of the repo",
  4366. "name": "repo",
  4367. "in": "path",
  4368. "required": true
  4369. },
  4370. {
  4371. "type": "string",
  4372. "description": "sha of the commit",
  4373. "name": "sha",
  4374. "in": "path",
  4375. "required": true
  4376. },
  4377. {
  4378. "type": "boolean",
  4379. "description": "show all directories and files",
  4380. "name": "recursive",
  4381. "in": "query"
  4382. },
  4383. {
  4384. "type": "integer",
  4385. "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",
  4386. "name": "page",
  4387. "in": "query"
  4388. },
  4389. {
  4390. "type": "integer",
  4391. "description": "number of items per page",
  4392. "name": "per_page",
  4393. "in": "query"
  4394. }
  4395. ],
  4396. "responses": {
  4397. "200": {
  4398. "$ref": "#/responses/GitTreeResponse"
  4399. },
  4400. "400": {
  4401. "$ref": "#/responses/error"
  4402. }
  4403. }
  4404. }
  4405. },
  4406. "/repos/{owner}/{repo}/hooks": {
  4407. "get": {
  4408. "produces": [
  4409. "application/json"
  4410. ],
  4411. "tags": [
  4412. "repository"
  4413. ],
  4414. "summary": "List the hooks in a repository",
  4415. "operationId": "repoListHooks",
  4416. "parameters": [
  4417. {
  4418. "type": "string",
  4419. "description": "owner of the repo",
  4420. "name": "owner",
  4421. "in": "path",
  4422. "required": true
  4423. },
  4424. {
  4425. "type": "string",
  4426. "description": "name of the repo",
  4427. "name": "repo",
  4428. "in": "path",
  4429. "required": true
  4430. },
  4431. {
  4432. "type": "integer",
  4433. "description": "page number of results to return (1-based)",
  4434. "name": "page",
  4435. "in": "query"
  4436. },
  4437. {
  4438. "type": "integer",
  4439. "description": "page size of results",
  4440. "name": "limit",
  4441. "in": "query"
  4442. }
  4443. ],
  4444. "responses": {
  4445. "200": {
  4446. "$ref": "#/responses/HookList"
  4447. }
  4448. }
  4449. },
  4450. "post": {
  4451. "consumes": [
  4452. "application/json"
  4453. ],
  4454. "produces": [
  4455. "application/json"
  4456. ],
  4457. "tags": [
  4458. "repository"
  4459. ],
  4460. "summary": "Create a hook",
  4461. "operationId": "repoCreateHook",
  4462. "parameters": [
  4463. {
  4464. "type": "string",
  4465. "description": "owner of the repo",
  4466. "name": "owner",
  4467. "in": "path",
  4468. "required": true
  4469. },
  4470. {
  4471. "type": "string",
  4472. "description": "name of the repo",
  4473. "name": "repo",
  4474. "in": "path",
  4475. "required": true
  4476. },
  4477. {
  4478. "name": "body",
  4479. "in": "body",
  4480. "schema": {
  4481. "$ref": "#/definitions/CreateHookOption"
  4482. }
  4483. }
  4484. ],
  4485. "responses": {
  4486. "201": {
  4487. "$ref": "#/responses/Hook"
  4488. }
  4489. }
  4490. }
  4491. },
  4492. "/repos/{owner}/{repo}/hooks/git": {
  4493. "get": {
  4494. "produces": [
  4495. "application/json"
  4496. ],
  4497. "tags": [
  4498. "repository"
  4499. ],
  4500. "summary": "List the Git hooks in a repository",
  4501. "operationId": "repoListGitHooks",
  4502. "parameters": [
  4503. {
  4504. "type": "string",
  4505. "description": "owner of the repo",
  4506. "name": "owner",
  4507. "in": "path",
  4508. "required": true
  4509. },
  4510. {
  4511. "type": "string",
  4512. "description": "name of the repo",
  4513. "name": "repo",
  4514. "in": "path",
  4515. "required": true
  4516. }
  4517. ],
  4518. "responses": {
  4519. "200": {
  4520. "$ref": "#/responses/GitHookList"
  4521. }
  4522. }
  4523. }
  4524. },
  4525. "/repos/{owner}/{repo}/hooks/git/{id}": {
  4526. "get": {
  4527. "produces": [
  4528. "application/json"
  4529. ],
  4530. "tags": [
  4531. "repository"
  4532. ],
  4533. "summary": "Get a Git hook",
  4534. "operationId": "repoGetGitHook",
  4535. "parameters": [
  4536. {
  4537. "type": "string",
  4538. "description": "owner of the repo",
  4539. "name": "owner",
  4540. "in": "path",
  4541. "required": true
  4542. },
  4543. {
  4544. "type": "string",
  4545. "description": "name of the repo",
  4546. "name": "repo",
  4547. "in": "path",
  4548. "required": true
  4549. },
  4550. {
  4551. "type": "string",
  4552. "description": "id of the hook to get",
  4553. "name": "id",
  4554. "in": "path",
  4555. "required": true
  4556. }
  4557. ],
  4558. "responses": {
  4559. "200": {
  4560. "$ref": "#/responses/GitHook"
  4561. },
  4562. "404": {
  4563. "$ref": "#/responses/notFound"
  4564. }
  4565. }
  4566. },
  4567. "delete": {
  4568. "produces": [
  4569. "application/json"
  4570. ],
  4571. "tags": [
  4572. "repository"
  4573. ],
  4574. "summary": "Delete a Git hook in a repository",
  4575. "operationId": "repoDeleteGitHook",
  4576. "parameters": [
  4577. {
  4578. "type": "string",
  4579. "description": "owner of the repo",
  4580. "name": "owner",
  4581. "in": "path",
  4582. "required": true
  4583. },
  4584. {
  4585. "type": "string",
  4586. "description": "name of the repo",
  4587. "name": "repo",
  4588. "in": "path",
  4589. "required": true
  4590. },
  4591. {
  4592. "type": "string",
  4593. "description": "id of the hook to get",
  4594. "name": "id",
  4595. "in": "path",
  4596. "required": true
  4597. }
  4598. ],
  4599. "responses": {
  4600. "204": {
  4601. "$ref": "#/responses/empty"
  4602. },
  4603. "404": {
  4604. "$ref": "#/responses/notFound"
  4605. }
  4606. }
  4607. },
  4608. "patch": {
  4609. "produces": [
  4610. "application/json"
  4611. ],
  4612. "tags": [
  4613. "repository"
  4614. ],
  4615. "summary": "Edit a Git hook in a repository",
  4616. "operationId": "repoEditGitHook",
  4617. "parameters": [
  4618. {
  4619. "type": "string",
  4620. "description": "owner of the repo",
  4621. "name": "owner",
  4622. "in": "path",
  4623. "required": true
  4624. },
  4625. {
  4626. "type": "string",
  4627. "description": "name of the repo",
  4628. "name": "repo",
  4629. "in": "path",
  4630. "required": true
  4631. },
  4632. {
  4633. "type": "string",
  4634. "description": "id of the hook to get",
  4635. "name": "id",
  4636. "in": "path",
  4637. "required": true
  4638. },
  4639. {
  4640. "name": "body",
  4641. "in": "body",
  4642. "schema": {
  4643. "$ref": "#/definitions/EditGitHookOption"
  4644. }
  4645. }
  4646. ],
  4647. "responses": {
  4648. "200": {
  4649. "$ref": "#/responses/GitHook"
  4650. },
  4651. "404": {
  4652. "$ref": "#/responses/notFound"
  4653. }
  4654. }
  4655. }
  4656. },
  4657. "/repos/{owner}/{repo}/hooks/{id}": {
  4658. "get": {
  4659. "produces": [
  4660. "application/json"
  4661. ],
  4662. "tags": [
  4663. "repository"
  4664. ],
  4665. "summary": "Get a hook",
  4666. "operationId": "repoGetHook",
  4667. "parameters": [
  4668. {
  4669. "type": "string",
  4670. "description": "owner of the repo",
  4671. "name": "owner",
  4672. "in": "path",
  4673. "required": true
  4674. },
  4675. {
  4676. "type": "string",
  4677. "description": "name of the repo",
  4678. "name": "repo",
  4679. "in": "path",
  4680. "required": true
  4681. },
  4682. {
  4683. "type": "integer",
  4684. "format": "int64",
  4685. "description": "id of the hook to get",
  4686. "name": "id",
  4687. "in": "path",
  4688. "required": true
  4689. }
  4690. ],
  4691. "responses": {
  4692. "200": {
  4693. "$ref": "#/responses/Hook"
  4694. },
  4695. "404": {
  4696. "$ref": "#/responses/notFound"
  4697. }
  4698. }
  4699. },
  4700. "delete": {
  4701. "produces": [
  4702. "application/json"
  4703. ],
  4704. "tags": [
  4705. "repository"
  4706. ],
  4707. "summary": "Delete a hook in a repository",
  4708. "operationId": "repoDeleteHook",
  4709. "parameters": [
  4710. {
  4711. "type": "string",
  4712. "description": "owner of the repo",
  4713. "name": "owner",
  4714. "in": "path",
  4715. "required": true
  4716. },
  4717. {
  4718. "type": "string",
  4719. "description": "name of the repo",
  4720. "name": "repo",
  4721. "in": "path",
  4722. "required": true
  4723. },
  4724. {
  4725. "type": "integer",
  4726. "format": "int64",
  4727. "description": "id of the hook to delete",
  4728. "name": "id",
  4729. "in": "path",
  4730. "required": true
  4731. }
  4732. ],
  4733. "responses": {
  4734. "204": {
  4735. "$ref": "#/responses/empty"
  4736. },
  4737. "404": {
  4738. "$ref": "#/responses/notFound"
  4739. }
  4740. }
  4741. },
  4742. "patch": {
  4743. "produces": [
  4744. "application/json"
  4745. ],
  4746. "tags": [
  4747. "repository"
  4748. ],
  4749. "summary": "Edit a hook in a repository",
  4750. "operationId": "repoEditHook",
  4751. "parameters": [
  4752. {
  4753. "type": "string",
  4754. "description": "owner of the repo",
  4755. "name": "owner",
  4756. "in": "path",
  4757. "required": true
  4758. },
  4759. {
  4760. "type": "string",
  4761. "description": "name of the repo",
  4762. "name": "repo",
  4763. "in": "path",
  4764. "required": true
  4765. },
  4766. {
  4767. "type": "integer",
  4768. "format": "int64",
  4769. "description": "index of the hook",
  4770. "name": "id",
  4771. "in": "path",
  4772. "required": true
  4773. },
  4774. {
  4775. "name": "body",
  4776. "in": "body",
  4777. "schema": {
  4778. "$ref": "#/definitions/EditHookOption"
  4779. }
  4780. }
  4781. ],
  4782. "responses": {
  4783. "200": {
  4784. "$ref": "#/responses/Hook"
  4785. }
  4786. }
  4787. }
  4788. },
  4789. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  4790. "post": {
  4791. "produces": [
  4792. "application/json"
  4793. ],
  4794. "tags": [
  4795. "repository"
  4796. ],
  4797. "summary": "Test a push webhook",
  4798. "operationId": "repoTestHook",
  4799. "parameters": [
  4800. {
  4801. "type": "string",
  4802. "description": "owner of the repo",
  4803. "name": "owner",
  4804. "in": "path",
  4805. "required": true
  4806. },
  4807. {
  4808. "type": "string",
  4809. "description": "name of the repo",
  4810. "name": "repo",
  4811. "in": "path",
  4812. "required": true
  4813. },
  4814. {
  4815. "type": "integer",
  4816. "format": "int64",
  4817. "description": "id of the hook to test",
  4818. "name": "id",
  4819. "in": "path",
  4820. "required": true
  4821. },
  4822. {
  4823. "type": "string",
  4824. "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
  4825. "name": "ref",
  4826. "in": "query"
  4827. }
  4828. ],
  4829. "responses": {
  4830. "204": {
  4831. "$ref": "#/responses/empty"
  4832. }
  4833. }
  4834. }
  4835. },
  4836. "/repos/{owner}/{repo}/issue_templates": {
  4837. "get": {
  4838. "produces": [
  4839. "application/json"
  4840. ],
  4841. "tags": [
  4842. "repository"
  4843. ],
  4844. "summary": "Get available issue templates for a repository",
  4845. "operationId": "repoGetIssueTemplates",
  4846. "parameters": [
  4847. {
  4848. "type": "string",
  4849. "description": "owner of the repo",
  4850. "name": "owner",
  4851. "in": "path",
  4852. "required": true
  4853. },
  4854. {
  4855. "type": "string",
  4856. "description": "name of the repo",
  4857. "name": "repo",
  4858. "in": "path",
  4859. "required": true
  4860. }
  4861. ],
  4862. "responses": {
  4863. "200": {
  4864. "$ref": "#/responses/IssueTemplates"
  4865. }
  4866. }
  4867. }
  4868. },
  4869. "/repos/{owner}/{repo}/issues": {
  4870. "get": {
  4871. "produces": [
  4872. "application/json"
  4873. ],
  4874. "tags": [
  4875. "issue"
  4876. ],
  4877. "summary": "List a repository's issues",
  4878. "operationId": "issueListIssues",
  4879. "parameters": [
  4880. {
  4881. "type": "string",
  4882. "description": "owner of the repo",
  4883. "name": "owner",
  4884. "in": "path",
  4885. "required": true
  4886. },
  4887. {
  4888. "type": "string",
  4889. "description": "name of the repo",
  4890. "name": "repo",
  4891. "in": "path",
  4892. "required": true
  4893. },
  4894. {
  4895. "enum": [
  4896. "closed",
  4897. "open",
  4898. "all"
  4899. ],
  4900. "type": "string",
  4901. "description": "whether issue is open or closed",
  4902. "name": "state",
  4903. "in": "query"
  4904. },
  4905. {
  4906. "type": "string",
  4907. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  4908. "name": "labels",
  4909. "in": "query"
  4910. },
  4911. {
  4912. "type": "string",
  4913. "description": "search string",
  4914. "name": "q",
  4915. "in": "query"
  4916. },
  4917. {
  4918. "enum": [
  4919. "issues",
  4920. "pulls"
  4921. ],
  4922. "type": "string",
  4923. "description": "filter by type (issues / pulls) if set",
  4924. "name": "type",
  4925. "in": "query"
  4926. },
  4927. {
  4928. "type": "string",
  4929. "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",
  4930. "name": "milestones",
  4931. "in": "query"
  4932. },
  4933. {
  4934. "type": "string",
  4935. "format": "date-time",
  4936. "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
  4937. "name": "since",
  4938. "in": "query"
  4939. },
  4940. {
  4941. "type": "string",
  4942. "format": "date-time",
  4943. "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
  4944. "name": "before",
  4945. "in": "query"
  4946. },
  4947. {
  4948. "type": "string",
  4949. "description": "Only show items which were created by the the given user",
  4950. "name": "created_by",
  4951. "in": "query"
  4952. },
  4953. {
  4954. "type": "string",
  4955. "description": "Only show items for which the given user is assigned",
  4956. "name": "assigned_by",
  4957. "in": "query"
  4958. },
  4959. {
  4960. "type": "string",
  4961. "description": "Only show items in which the given user was mentioned",
  4962. "name": "mentioned_by",
  4963. "in": "query"
  4964. },
  4965. {
  4966. "type": "integer",
  4967. "description": "page number of results to return (1-based)",
  4968. "name": "page",
  4969. "in": "query"
  4970. },
  4971. {
  4972. "type": "integer",
  4973. "description": "page size of results",
  4974. "name": "limit",
  4975. "in": "query"
  4976. }
  4977. ],
  4978. "responses": {
  4979. "200": {
  4980. "$ref": "#/responses/IssueList"
  4981. }
  4982. }
  4983. },
  4984. "post": {
  4985. "consumes": [
  4986. "application/json"
  4987. ],
  4988. "produces": [
  4989. "application/json"
  4990. ],
  4991. "tags": [
  4992. "issue"
  4993. ],
  4994. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4995. "operationId": "issueCreateIssue",
  4996. "parameters": [
  4997. {
  4998. "type": "string",
  4999. "description": "owner of the repo",
  5000. "name": "owner",
  5001. "in": "path",
  5002. "required": true
  5003. },
  5004. {
  5005. "type": "string",
  5006. "description": "name of the repo",
  5007. "name": "repo",
  5008. "in": "path",
  5009. "required": true
  5010. },
  5011. {
  5012. "name": "body",
  5013. "in": "body",
  5014. "schema": {
  5015. "$ref": "#/definitions/CreateIssueOption"
  5016. }
  5017. }
  5018. ],
  5019. "responses": {
  5020. "201": {
  5021. "$ref": "#/responses/Issue"
  5022. },
  5023. "403": {
  5024. "$ref": "#/responses/forbidden"
  5025. },
  5026. "412": {
  5027. "$ref": "#/responses/error"
  5028. },
  5029. "422": {
  5030. "$ref": "#/responses/validationError"
  5031. }
  5032. }
  5033. }
  5034. },
  5035. "/repos/{owner}/{repo}/issues/comments": {
  5036. "get": {
  5037. "produces": [
  5038. "application/json"
  5039. ],
  5040. "tags": [
  5041. "issue"
  5042. ],
  5043. "summary": "List all comments in a repository",
  5044. "operationId": "issueGetRepoComments",
  5045. "parameters": [
  5046. {
  5047. "type": "string",
  5048. "description": "owner of the repo",
  5049. "name": "owner",
  5050. "in": "path",
  5051. "required": true
  5052. },
  5053. {
  5054. "type": "string",
  5055. "description": "name of the repo",
  5056. "name": "repo",
  5057. "in": "path",
  5058. "required": true
  5059. },
  5060. {
  5061. "type": "string",
  5062. "format": "date-time",
  5063. "description": "if provided, only comments updated since the provided time are returned.",
  5064. "name": "since",
  5065. "in": "query"
  5066. },
  5067. {
  5068. "type": "string",
  5069. "format": "date-time",
  5070. "description": "if provided, only comments updated before the provided time are returned.",
  5071. "name": "before",
  5072. "in": "query"
  5073. },
  5074. {
  5075. "type": "integer",
  5076. "description": "page number of results to return (1-based)",
  5077. "name": "page",
  5078. "in": "query"
  5079. },
  5080. {
  5081. "type": "integer",
  5082. "description": "page size of results",
  5083. "name": "limit",
  5084. "in": "query"
  5085. }
  5086. ],
  5087. "responses": {
  5088. "200": {
  5089. "$ref": "#/responses/CommentList"
  5090. }
  5091. }
  5092. }
  5093. },
  5094. "/repos/{owner}/{repo}/issues/comments/{id}": {
  5095. "get": {
  5096. "consumes": [
  5097. "application/json"
  5098. ],
  5099. "produces": [
  5100. "application/json"
  5101. ],
  5102. "tags": [
  5103. "issue"
  5104. ],
  5105. "summary": "Get a comment",
  5106. "operationId": "issueGetComment",
  5107. "parameters": [
  5108. {
  5109. "type": "string",
  5110. "description": "owner of the repo",
  5111. "name": "owner",
  5112. "in": "path",
  5113. "required": true
  5114. },
  5115. {
  5116. "type": "string",
  5117. "description": "name of the repo",
  5118. "name": "repo",
  5119. "in": "path",
  5120. "required": true
  5121. },
  5122. {
  5123. "type": "integer",
  5124. "format": "int64",
  5125. "description": "id of the comment",
  5126. "name": "id",
  5127. "in": "path",
  5128. "required": true
  5129. }
  5130. ],
  5131. "responses": {
  5132. "200": {
  5133. "$ref": "#/responses/Comment"
  5134. },
  5135. "204": {
  5136. "$ref": "#/responses/empty"
  5137. },
  5138. "403": {
  5139. "$ref": "#/responses/forbidden"
  5140. },
  5141. "404": {
  5142. "$ref": "#/responses/notFound"
  5143. }
  5144. }
  5145. },
  5146. "delete": {
  5147. "tags": [
  5148. "issue"
  5149. ],
  5150. "summary": "Delete a comment",
  5151. "operationId": "issueDeleteComment",
  5152. "parameters": [
  5153. {
  5154. "type": "string",
  5155. "description": "owner of the repo",
  5156. "name": "owner",
  5157. "in": "path",
  5158. "required": true
  5159. },
  5160. {
  5161. "type": "string",
  5162. "description": "name of the repo",
  5163. "name": "repo",
  5164. "in": "path",
  5165. "required": true
  5166. },
  5167. {
  5168. "type": "integer",
  5169. "format": "int64",
  5170. "description": "id of comment to delete",
  5171. "name": "id",
  5172. "in": "path",
  5173. "required": true
  5174. }
  5175. ],
  5176. "responses": {
  5177. "204": {
  5178. "$ref": "#/responses/empty"
  5179. },
  5180. "403": {
  5181. "$ref": "#/responses/forbidden"
  5182. },
  5183. "404": {
  5184. "$ref": "#/responses/notFound"
  5185. }
  5186. }
  5187. },
  5188. "patch": {
  5189. "consumes": [
  5190. "application/json"
  5191. ],
  5192. "produces": [
  5193. "application/json"
  5194. ],
  5195. "tags": [
  5196. "issue"
  5197. ],
  5198. "summary": "Edit a comment",
  5199. "operationId": "issueEditComment",
  5200. "parameters": [
  5201. {
  5202. "type": "string",
  5203. "description": "owner of the repo",
  5204. "name": "owner",
  5205. "in": "path",
  5206. "required": true
  5207. },
  5208. {
  5209. "type": "string",
  5210. "description": "name of the repo",
  5211. "name": "repo",
  5212. "in": "path",
  5213. "required": true
  5214. },
  5215. {
  5216. "type": "integer",
  5217. "format": "int64",
  5218. "description": "id of the comment to edit",
  5219. "name": "id",
  5220. "in": "path",
  5221. "required": true
  5222. },
  5223. {
  5224. "name": "body",
  5225. "in": "body",
  5226. "schema": {
  5227. "$ref": "#/definitions/EditIssueCommentOption"
  5228. }
  5229. }
  5230. ],
  5231. "responses": {
  5232. "200": {
  5233. "$ref": "#/responses/Comment"
  5234. },
  5235. "204": {
  5236. "$ref": "#/responses/empty"
  5237. },
  5238. "403": {
  5239. "$ref": "#/responses/forbidden"
  5240. },
  5241. "404": {
  5242. "$ref": "#/responses/notFound"
  5243. }
  5244. }
  5245. }
  5246. },
  5247. "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
  5248. "get": {
  5249. "produces": [
  5250. "application/json"
  5251. ],
  5252. "tags": [
  5253. "issue"
  5254. ],
  5255. "summary": "List comment's attachments",
  5256. "operationId": "issueListIssueCommentAttachments",
  5257. "parameters": [
  5258. {
  5259. "type": "string",
  5260. "description": "owner of the repo",
  5261. "name": "owner",
  5262. "in": "path",
  5263. "required": true
  5264. },
  5265. {
  5266. "type": "string",
  5267. "description": "name of the repo",
  5268. "name": "repo",
  5269. "in": "path",
  5270. "required": true
  5271. },
  5272. {
  5273. "type": "integer",
  5274. "format": "int64",
  5275. "description": "id of the comment",
  5276. "name": "id",
  5277. "in": "path",
  5278. "required": true
  5279. }
  5280. ],
  5281. "responses": {
  5282. "200": {
  5283. "$ref": "#/responses/AttachmentList"
  5284. },
  5285. "404": {
  5286. "$ref": "#/responses/error"
  5287. }
  5288. }
  5289. },
  5290. "post": {
  5291. "consumes": [
  5292. "multipart/form-data"
  5293. ],
  5294. "produces": [
  5295. "application/json"
  5296. ],
  5297. "tags": [
  5298. "issue"
  5299. ],
  5300. "summary": "Create a comment attachment",
  5301. "operationId": "issueCreateIssueCommentAttachment",
  5302. "parameters": [
  5303. {
  5304. "type": "string",
  5305. "description": "owner of the repo",
  5306. "name": "owner",
  5307. "in": "path",
  5308. "required": true
  5309. },
  5310. {
  5311. "type": "string",
  5312. "description": "name of the repo",
  5313. "name": "repo",
  5314. "in": "path",
  5315. "required": true
  5316. },
  5317. {
  5318. "type": "integer",
  5319. "format": "int64",
  5320. "description": "id of the comment",
  5321. "name": "id",
  5322. "in": "path",
  5323. "required": true
  5324. },
  5325. {
  5326. "type": "string",
  5327. "description": "name of the attachment",
  5328. "name": "name",
  5329. "in": "query"
  5330. },
  5331. {
  5332. "type": "file",
  5333. "description": "attachment to upload",
  5334. "name": "attachment",
  5335. "in": "formData",
  5336. "required": true
  5337. }
  5338. ],
  5339. "responses": {
  5340. "201": {
  5341. "$ref": "#/responses/Attachment"
  5342. },
  5343. "400": {
  5344. "$ref": "#/responses/error"
  5345. },
  5346. "404": {
  5347. "$ref": "#/responses/error"
  5348. }
  5349. }
  5350. }
  5351. },
  5352. "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
  5353. "get": {
  5354. "produces": [
  5355. "application/json"
  5356. ],
  5357. "tags": [
  5358. "issue"
  5359. ],
  5360. "summary": "Get a comment attachment",
  5361. "operationId": "issueGetIssueCommentAttachment",
  5362. "parameters": [
  5363. {
  5364. "type": "string",
  5365. "description": "owner of the repo",
  5366. "name": "owner",
  5367. "in": "path",
  5368. "required": true
  5369. },
  5370. {
  5371. "type": "string",
  5372. "description": "name of the repo",
  5373. "name": "repo",
  5374. "in": "path",
  5375. "required": true
  5376. },
  5377. {
  5378. "type": "integer",
  5379. "format": "int64",
  5380. "description": "id of the comment",
  5381. "name": "id",
  5382. "in": "path",
  5383. "required": true
  5384. },
  5385. {
  5386. "type": "integer",
  5387. "format": "int64",
  5388. "description": "id of the attachment to get",
  5389. "name": "attachment_id",
  5390. "in": "path",
  5391. "required": true
  5392. }
  5393. ],
  5394. "responses": {
  5395. "200": {
  5396. "$ref": "#/responses/Attachment"
  5397. },
  5398. "404": {
  5399. "$ref": "#/responses/error"
  5400. }
  5401. }
  5402. },
  5403. "delete": {
  5404. "produces": [
  5405. "application/json"
  5406. ],
  5407. "tags": [
  5408. "issue"
  5409. ],
  5410. "summary": "Delete a comment attachment",
  5411. "operationId": "issueDeleteIssueCommentAttachment",
  5412. "parameters": [
  5413. {
  5414. "type": "string",
  5415. "description": "owner of the repo",
  5416. "name": "owner",
  5417. "in": "path",
  5418. "required": true
  5419. },
  5420. {
  5421. "type": "string",
  5422. "description": "name of the repo",
  5423. "name": "repo",
  5424. "in": "path",
  5425. "required": true
  5426. },
  5427. {
  5428. "type": "integer",
  5429. "format": "int64",
  5430. "description": "id of the comment",
  5431. "name": "id",
  5432. "in": "path",
  5433. "required": true
  5434. },
  5435. {
  5436. "type": "integer",
  5437. "format": "int64",
  5438. "description": "id of the attachment to delete",
  5439. "name": "attachment_id",
  5440. "in": "path",
  5441. "required": true
  5442. }
  5443. ],
  5444. "responses": {
  5445. "204": {
  5446. "$ref": "#/responses/empty"
  5447. },
  5448. "404": {
  5449. "$ref": "#/responses/error"
  5450. }
  5451. }
  5452. },
  5453. "patch": {
  5454. "consumes": [
  5455. "application/json"
  5456. ],
  5457. "produces": [
  5458. "application/json"
  5459. ],
  5460. "tags": [
  5461. "issue"
  5462. ],
  5463. "summary": "Edit a comment attachment",
  5464. "operationId": "issueEditIssueCommentAttachment",
  5465. "parameters": [
  5466. {
  5467. "type": "string",
  5468. "description": "owner of the repo",
  5469. "name": "owner",
  5470. "in": "path",
  5471. "required": true
  5472. },
  5473. {
  5474. "type": "string",
  5475. "description": "name of the repo",
  5476. "name": "repo",
  5477. "in": "path",
  5478. "required": true
  5479. },
  5480. {
  5481. "type": "integer",
  5482. "format": "int64",
  5483. "description": "id of the comment",
  5484. "name": "id",
  5485. "in": "path",
  5486. "required": true
  5487. },
  5488. {
  5489. "type": "integer",
  5490. "format": "int64",
  5491. "description": "id of the attachment to edit",
  5492. "name": "attachment_id",
  5493. "in": "path",
  5494. "required": true
  5495. },
  5496. {
  5497. "name": "body",
  5498. "in": "body",
  5499. "schema": {
  5500. "$ref": "#/definitions/EditAttachmentOptions"
  5501. }
  5502. }
  5503. ],
  5504. "responses": {
  5505. "201": {
  5506. "$ref": "#/responses/Attachment"
  5507. },
  5508. "404": {
  5509. "$ref": "#/responses/error"
  5510. }
  5511. }
  5512. }
  5513. },
  5514. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  5515. "get": {
  5516. "consumes": [
  5517. "application/json"
  5518. ],
  5519. "produces": [
  5520. "application/json"
  5521. ],
  5522. "tags": [
  5523. "issue"
  5524. ],
  5525. "summary": "Get a list of reactions from a comment of an issue",
  5526. "operationId": "issueGetCommentReactions",
  5527. "parameters": [
  5528. {
  5529. "type": "string",
  5530. "description": "owner of the repo",
  5531. "name": "owner",
  5532. "in": "path",
  5533. "required": true
  5534. },
  5535. {
  5536. "type": "string",
  5537. "description": "name of the repo",
  5538. "name": "repo",
  5539. "in": "path",
  5540. "required": true
  5541. },
  5542. {
  5543. "type": "integer",
  5544. "format": "int64",
  5545. "description": "id of the comment to edit",
  5546. "name": "id",
  5547. "in": "path",
  5548. "required": true
  5549. }
  5550. ],
  5551. "responses": {
  5552. "200": {
  5553. "$ref": "#/responses/ReactionList"
  5554. },
  5555. "403": {
  5556. "$ref": "#/responses/forbidden"
  5557. }
  5558. }
  5559. },
  5560. "post": {
  5561. "consumes": [
  5562. "application/json"
  5563. ],
  5564. "produces": [
  5565. "application/json"
  5566. ],
  5567. "tags": [
  5568. "issue"
  5569. ],
  5570. "summary": "Add a reaction to a comment of an issue",
  5571. "operationId": "issuePostCommentReaction",
  5572. "parameters": [
  5573. {
  5574. "type": "string",
  5575. "description": "owner of the repo",
  5576. "name": "owner",
  5577. "in": "path",
  5578. "required": true
  5579. },
  5580. {
  5581. "type": "string",
  5582. "description": "name of the repo",
  5583. "name": "repo",
  5584. "in": "path",
  5585. "required": true
  5586. },
  5587. {
  5588. "type": "integer",
  5589. "format": "int64",
  5590. "description": "id of the comment to edit",
  5591. "name": "id",
  5592. "in": "path",
  5593. "required": true
  5594. },
  5595. {
  5596. "name": "content",
  5597. "in": "body",
  5598. "schema": {
  5599. "$ref": "#/definitions/EditReactionOption"
  5600. }
  5601. }
  5602. ],
  5603. "responses": {
  5604. "200": {
  5605. "$ref": "#/responses/Reaction"
  5606. },
  5607. "201": {
  5608. "$ref": "#/responses/Reaction"
  5609. },
  5610. "403": {
  5611. "$ref": "#/responses/forbidden"
  5612. }
  5613. }
  5614. },
  5615. "delete": {
  5616. "consumes": [
  5617. "application/json"
  5618. ],
  5619. "produces": [
  5620. "application/json"
  5621. ],
  5622. "tags": [
  5623. "issue"
  5624. ],
  5625. "summary": "Remove a reaction from a comment of an issue",
  5626. "operationId": "issueDeleteCommentReaction",
  5627. "parameters": [
  5628. {
  5629. "type": "string",
  5630. "description": "owner of the repo",
  5631. "name": "owner",
  5632. "in": "path",
  5633. "required": true
  5634. },
  5635. {
  5636. "type": "string",
  5637. "description": "name of the repo",
  5638. "name": "repo",
  5639. "in": "path",
  5640. "required": true
  5641. },
  5642. {
  5643. "type": "integer",
  5644. "format": "int64",
  5645. "description": "id of the comment to edit",
  5646. "name": "id",
  5647. "in": "path",
  5648. "required": true
  5649. },
  5650. {
  5651. "name": "content",
  5652. "in": "body",
  5653. "schema": {
  5654. "$ref": "#/definitions/EditReactionOption"
  5655. }
  5656. }
  5657. ],
  5658. "responses": {
  5659. "200": {
  5660. "$ref": "#/responses/empty"
  5661. },
  5662. "403": {
  5663. "$ref": "#/responses/forbidden"
  5664. }
  5665. }
  5666. }
  5667. },
  5668. "/repos/{owner}/{repo}/issues/{index}": {
  5669. "get": {
  5670. "produces": [
  5671. "application/json"
  5672. ],
  5673. "tags": [
  5674. "issue"
  5675. ],
  5676. "summary": "Get an issue",
  5677. "operationId": "issueGetIssue",
  5678. "parameters": [
  5679. {
  5680. "type": "string",
  5681. "description": "owner of the repo",
  5682. "name": "owner",
  5683. "in": "path",
  5684. "required": true
  5685. },
  5686. {
  5687. "type": "string",
  5688. "description": "name of the repo",
  5689. "name": "repo",
  5690. "in": "path",
  5691. "required": true
  5692. },
  5693. {
  5694. "type": "integer",
  5695. "format": "int64",
  5696. "description": "index of the issue to get",
  5697. "name": "index",
  5698. "in": "path",
  5699. "required": true
  5700. }
  5701. ],
  5702. "responses": {
  5703. "200": {
  5704. "$ref": "#/responses/Issue"
  5705. },
  5706. "404": {
  5707. "$ref": "#/responses/notFound"
  5708. }
  5709. }
  5710. },
  5711. "delete": {
  5712. "tags": [
  5713. "issue"
  5714. ],
  5715. "summary": "Delete an issue",
  5716. "operationId": "issueDelete",
  5717. "parameters": [
  5718. {
  5719. "type": "string",
  5720. "description": "owner of the repo",
  5721. "name": "owner",
  5722. "in": "path",
  5723. "required": true
  5724. },
  5725. {
  5726. "type": "string",
  5727. "description": "name of the repo",
  5728. "name": "repo",
  5729. "in": "path",
  5730. "required": true
  5731. },
  5732. {
  5733. "type": "integer",
  5734. "format": "int64",
  5735. "description": "index of issue to delete",
  5736. "name": "index",
  5737. "in": "path",
  5738. "required": true
  5739. }
  5740. ],
  5741. "responses": {
  5742. "204": {
  5743. "$ref": "#/responses/empty"
  5744. },
  5745. "403": {
  5746. "$ref": "#/responses/forbidden"
  5747. },
  5748. "404": {
  5749. "$ref": "#/responses/notFound"
  5750. }
  5751. }
  5752. },
  5753. "patch": {
  5754. "consumes": [
  5755. "application/json"
  5756. ],
  5757. "produces": [
  5758. "application/json"
  5759. ],
  5760. "tags": [
  5761. "issue"
  5762. ],
  5763. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  5764. "operationId": "issueEditIssue",
  5765. "parameters": [
  5766. {
  5767. "type": "string",
  5768. "description": "owner of the repo",
  5769. "name": "owner",
  5770. "in": "path",
  5771. "required": true
  5772. },
  5773. {
  5774. "type": "string",
  5775. "description": "name of the repo",
  5776. "name": "repo",
  5777. "in": "path",
  5778. "required": true
  5779. },
  5780. {
  5781. "type": "integer",
  5782. "format": "int64",
  5783. "description": "index of the issue to edit",
  5784. "name": "index",
  5785. "in": "path",
  5786. "required": true
  5787. },
  5788. {
  5789. "name": "body",
  5790. "in": "body",
  5791. "schema": {
  5792. "$ref": "#/definitions/EditIssueOption"
  5793. }
  5794. }
  5795. ],
  5796. "responses": {
  5797. "201": {
  5798. "$ref": "#/responses/Issue"
  5799. },
  5800. "403": {
  5801. "$ref": "#/responses/forbidden"
  5802. },
  5803. "404": {
  5804. "$ref": "#/responses/notFound"
  5805. },
  5806. "412": {
  5807. "$ref": "#/responses/error"
  5808. }
  5809. }
  5810. }
  5811. },
  5812. "/repos/{owner}/{repo}/issues/{index}/assets": {
  5813. "get": {
  5814. "produces": [
  5815. "application/json"
  5816. ],
  5817. "tags": [
  5818. "issue"
  5819. ],
  5820. "summary": "List issue's attachments",
  5821. "operationId": "issueListIssueAttachments",
  5822. "parameters": [
  5823. {
  5824. "type": "string",
  5825. "description": "owner of the repo",
  5826. "name": "owner",
  5827. "in": "path",
  5828. "required": true
  5829. },
  5830. {
  5831. "type": "string",
  5832. "description": "name of the repo",
  5833. "name": "repo",
  5834. "in": "path",
  5835. "required": true
  5836. },
  5837. {
  5838. "type": "integer",
  5839. "format": "int64",
  5840. "description": "index of the issue",
  5841. "name": "index",
  5842. "in": "path",
  5843. "required": true
  5844. }
  5845. ],
  5846. "responses": {
  5847. "200": {
  5848. "$ref": "#/responses/AttachmentList"
  5849. },
  5850. "404": {
  5851. "$ref": "#/responses/error"
  5852. }
  5853. }
  5854. },
  5855. "post": {
  5856. "consumes": [
  5857. "multipart/form-data"
  5858. ],
  5859. "produces": [
  5860. "application/json"
  5861. ],
  5862. "tags": [
  5863. "issue"
  5864. ],
  5865. "summary": "Create an issue attachment",
  5866. "operationId": "issueCreateIssueAttachment",
  5867. "parameters": [
  5868. {
  5869. "type": "string",
  5870. "description": "owner of the repo",
  5871. "name": "owner",
  5872. "in": "path",
  5873. "required": true
  5874. },
  5875. {
  5876. "type": "string",
  5877. "description": "name of the repo",
  5878. "name": "repo",
  5879. "in": "path",
  5880. "required": true
  5881. },
  5882. {
  5883. "type": "integer",
  5884. "format": "int64",
  5885. "description": "index of the issue",
  5886. "name": "index",
  5887. "in": "path",
  5888. "required": true
  5889. },
  5890. {
  5891. "type": "string",
  5892. "description": "name of the attachment",
  5893. "name": "name",
  5894. "in": "query"
  5895. },
  5896. {
  5897. "type": "file",
  5898. "description": "attachment to upload",
  5899. "name": "attachment",
  5900. "in": "formData",
  5901. "required": true
  5902. }
  5903. ],
  5904. "responses": {
  5905. "201": {
  5906. "$ref": "#/responses/Attachment"
  5907. },
  5908. "400": {
  5909. "$ref": "#/responses/error"
  5910. },
  5911. "404": {
  5912. "$ref": "#/responses/error"
  5913. }
  5914. }
  5915. }
  5916. },
  5917. "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
  5918. "get": {
  5919. "produces": [
  5920. "application/json"
  5921. ],
  5922. "tags": [
  5923. "issue"
  5924. ],
  5925. "summary": "Get an issue attachment",
  5926. "operationId": "issueGetIssueAttachment",
  5927. "parameters": [
  5928. {
  5929. "type": "string",
  5930. "description": "owner of the repo",
  5931. "name": "owner",
  5932. "in": "path",
  5933. "required": true
  5934. },
  5935. {
  5936. "type": "string",
  5937. "description": "name of the repo",
  5938. "name": "repo",
  5939. "in": "path",
  5940. "required": true
  5941. },
  5942. {
  5943. "type": "integer",
  5944. "format": "int64",
  5945. "description": "index of the issue",
  5946. "name": "index",
  5947. "in": "path",
  5948. "required": true
  5949. },
  5950. {
  5951. "type": "integer",
  5952. "format": "int64",
  5953. "description": "id of the attachment to get",
  5954. "name": "attachment_id",
  5955. "in": "path",
  5956. "required": true
  5957. }
  5958. ],
  5959. "responses": {
  5960. "200": {
  5961. "$ref": "#/responses/Attachment"
  5962. },
  5963. "404": {
  5964. "$ref": "#/responses/error"
  5965. }
  5966. }
  5967. },
  5968. "delete": {
  5969. "produces": [
  5970. "application/json"
  5971. ],
  5972. "tags": [
  5973. "issue"
  5974. ],
  5975. "summary": "Delete an issue attachment",
  5976. "operationId": "issueDeleteIssueAttachment",
  5977. "parameters": [
  5978. {
  5979. "type": "string",
  5980. "description": "owner of the repo",
  5981. "name": "owner",
  5982. "in": "path",
  5983. "required": true
  5984. },
  5985. {
  5986. "type": "string",
  5987. "description": "name of the repo",
  5988. "name": "repo",
  5989. "in": "path",
  5990. "required": true
  5991. },
  5992. {
  5993. "type": "integer",
  5994. "format": "int64",
  5995. "description": "index of the issue",
  5996. "name": "index",
  5997. "in": "path",
  5998. "required": true
  5999. },
  6000. {
  6001. "type": "integer",
  6002. "format": "int64",
  6003. "description": "id of the attachment to delete",
  6004. "name": "attachment_id",
  6005. "in": "path",
  6006. "required": true
  6007. }
  6008. ],
  6009. "responses": {
  6010. "204": {
  6011. "$ref": "#/responses/empty"
  6012. },
  6013. "404": {
  6014. "$ref": "#/responses/error"
  6015. }
  6016. }
  6017. },
  6018. "patch": {
  6019. "consumes": [
  6020. "application/json"
  6021. ],
  6022. "produces": [
  6023. "application/json"
  6024. ],
  6025. "tags": [
  6026. "issue"
  6027. ],
  6028. "summary": "Edit an issue attachment",
  6029. "operationId": "issueEditIssueAttachment",
  6030. "parameters": [
  6031. {
  6032. "type": "string",
  6033. "description": "owner of the repo",
  6034. "name": "owner",
  6035. "in": "path",
  6036. "required": true
  6037. },
  6038. {
  6039. "type": "string",
  6040. "description": "name of the repo",
  6041. "name": "repo",
  6042. "in": "path",
  6043. "required": true
  6044. },
  6045. {
  6046. "type": "integer",
  6047. "format": "int64",
  6048. "description": "index of the issue",
  6049. "name": "index",
  6050. "in": "path",
  6051. "required": true
  6052. },
  6053. {
  6054. "type": "integer",
  6055. "format": "int64",
  6056. "description": "id of the attachment to edit",
  6057. "name": "attachment_id",
  6058. "in": "path",
  6059. "required": true
  6060. },
  6061. {
  6062. "name": "body",
  6063. "in": "body",
  6064. "schema": {
  6065. "$ref": "#/definitions/EditAttachmentOptions"
  6066. }
  6067. }
  6068. ],
  6069. "responses": {
  6070. "201": {
  6071. "$ref": "#/responses/Attachment"
  6072. },
  6073. "404": {
  6074. "$ref": "#/responses/error"
  6075. }
  6076. }
  6077. }
  6078. },
  6079. "/repos/{owner}/{repo}/issues/{index}/comments": {
  6080. "get": {
  6081. "produces": [
  6082. "application/json"
  6083. ],
  6084. "tags": [
  6085. "issue"
  6086. ],
  6087. "summary": "List all comments on an issue",
  6088. "operationId": "issueGetComments",
  6089. "parameters": [
  6090. {
  6091. "type": "string",
  6092. "description": "owner of the repo",
  6093. "name": "owner",
  6094. "in": "path",
  6095. "required": true
  6096. },
  6097. {
  6098. "type": "string",
  6099. "description": "name of the repo",
  6100. "name": "repo",
  6101. "in": "path",
  6102. "required": true
  6103. },
  6104. {
  6105. "type": "integer",
  6106. "format": "int64",
  6107. "description": "index of the issue",
  6108. "name": "index",
  6109. "in": "path",
  6110. "required": true
  6111. },
  6112. {
  6113. "type": "string",
  6114. "format": "date-time",
  6115. "description": "if provided, only comments updated since the specified time are returned.",
  6116. "name": "since",
  6117. "in": "query"
  6118. },
  6119. {
  6120. "type": "string",
  6121. "format": "date-time",
  6122. "description": "if provided, only comments updated before the provided time are returned.",
  6123. "name": "before",
  6124. "in": "query"
  6125. }
  6126. ],
  6127. "responses": {
  6128. "200": {
  6129. "$ref": "#/responses/CommentList"
  6130. }
  6131. }
  6132. },
  6133. "post": {
  6134. "consumes": [
  6135. "application/json"
  6136. ],
  6137. "produces": [
  6138. "application/json"
  6139. ],
  6140. "tags": [
  6141. "issue"
  6142. ],
  6143. "summary": "Add a comment to an issue",
  6144. "operationId": "issueCreateComment",
  6145. "parameters": [
  6146. {
  6147. "type": "string",
  6148. "description": "owner of the repo",
  6149. "name": "owner",
  6150. "in": "path",
  6151. "required": true
  6152. },
  6153. {
  6154. "type": "string",
  6155. "description": "name of the repo",
  6156. "name": "repo",
  6157. "in": "path",
  6158. "required": true
  6159. },
  6160. {
  6161. "type": "integer",
  6162. "format": "int64",
  6163. "description": "index of the issue",
  6164. "name": "index",
  6165. "in": "path",
  6166. "required": true
  6167. },
  6168. {
  6169. "name": "body",
  6170. "in": "body",
  6171. "schema": {
  6172. "$ref": "#/definitions/CreateIssueCommentOption"
  6173. }
  6174. }
  6175. ],
  6176. "responses": {
  6177. "201": {
  6178. "$ref": "#/responses/Comment"
  6179. },
  6180. "403": {
  6181. "$ref": "#/responses/forbidden"
  6182. }
  6183. }
  6184. }
  6185. },
  6186. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  6187. "delete": {
  6188. "tags": [
  6189. "issue"
  6190. ],
  6191. "summary": "Delete a comment",
  6192. "operationId": "issueDeleteCommentDeprecated",
  6193. "deprecated": true,
  6194. "parameters": [
  6195. {
  6196. "type": "string",
  6197. "description": "owner of the repo",
  6198. "name": "owner",
  6199. "in": "path",
  6200. "required": true
  6201. },
  6202. {
  6203. "type": "string",
  6204. "description": "name of the repo",
  6205. "name": "repo",
  6206. "in": "path",
  6207. "required": true
  6208. },
  6209. {
  6210. "type": "integer",
  6211. "description": "this parameter is ignored",
  6212. "name": "index",
  6213. "in": "path",
  6214. "required": true
  6215. },
  6216. {
  6217. "type": "integer",
  6218. "format": "int64",
  6219. "description": "id of comment to delete",
  6220. "name": "id",
  6221. "in": "path",
  6222. "required": true
  6223. }
  6224. ],
  6225. "responses": {
  6226. "204": {
  6227. "$ref": "#/responses/empty"
  6228. },
  6229. "403": {
  6230. "$ref": "#/responses/forbidden"
  6231. },
  6232. "404": {
  6233. "$ref": "#/responses/notFound"
  6234. }
  6235. }
  6236. },
  6237. "patch": {
  6238. "consumes": [
  6239. "application/json"
  6240. ],
  6241. "produces": [
  6242. "application/json"
  6243. ],
  6244. "tags": [
  6245. "issue"
  6246. ],
  6247. "summary": "Edit a comment",
  6248. "operationId": "issueEditCommentDeprecated",
  6249. "deprecated": true,
  6250. "parameters": [
  6251. {
  6252. "type": "string",
  6253. "description": "owner of the repo",
  6254. "name": "owner",
  6255. "in": "path",
  6256. "required": true
  6257. },
  6258. {
  6259. "type": "string",
  6260. "description": "name of the repo",
  6261. "name": "repo",
  6262. "in": "path",
  6263. "required": true
  6264. },
  6265. {
  6266. "type": "integer",
  6267. "description": "this parameter is ignored",
  6268. "name": "index",
  6269. "in": "path",
  6270. "required": true
  6271. },
  6272. {
  6273. "type": "integer",
  6274. "format": "int64",
  6275. "description": "id of the comment to edit",
  6276. "name": "id",
  6277. "in": "path",
  6278. "required": true
  6279. },
  6280. {
  6281. "name": "body",
  6282. "in": "body",
  6283. "schema": {
  6284. "$ref": "#/definitions/EditIssueCommentOption"
  6285. }
  6286. }
  6287. ],
  6288. "responses": {
  6289. "200": {
  6290. "$ref": "#/responses/Comment"
  6291. },
  6292. "204": {
  6293. "$ref": "#/responses/empty"
  6294. },
  6295. "403": {
  6296. "$ref": "#/responses/forbidden"
  6297. },
  6298. "404": {
  6299. "$ref": "#/responses/notFound"
  6300. }
  6301. }
  6302. }
  6303. },
  6304. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  6305. "post": {
  6306. "consumes": [
  6307. "application/json"
  6308. ],
  6309. "produces": [
  6310. "application/json"
  6311. ],
  6312. "tags": [
  6313. "issue"
  6314. ],
  6315. "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.",
  6316. "operationId": "issueEditIssueDeadline",
  6317. "parameters": [
  6318. {
  6319. "type": "string",
  6320. "description": "owner of the repo",
  6321. "name": "owner",
  6322. "in": "path",
  6323. "required": true
  6324. },
  6325. {
  6326. "type": "string",
  6327. "description": "name of the repo",
  6328. "name": "repo",
  6329. "in": "path",
  6330. "required": true
  6331. },
  6332. {
  6333. "type": "integer",
  6334. "format": "int64",
  6335. "description": "index of the issue to create or update a deadline on",
  6336. "name": "index",
  6337. "in": "path",
  6338. "required": true
  6339. },
  6340. {
  6341. "name": "body",
  6342. "in": "body",
  6343. "schema": {
  6344. "$ref": "#/definitions/EditDeadlineOption"
  6345. }
  6346. }
  6347. ],
  6348. "responses": {
  6349. "201": {
  6350. "$ref": "#/responses/IssueDeadline"
  6351. },
  6352. "403": {
  6353. "$ref": "#/responses/forbidden"
  6354. },
  6355. "404": {
  6356. "$ref": "#/responses/notFound"
  6357. }
  6358. }
  6359. }
  6360. },
  6361. "/repos/{owner}/{repo}/issues/{index}/labels": {
  6362. "get": {
  6363. "produces": [
  6364. "application/json"
  6365. ],
  6366. "tags": [
  6367. "issue"
  6368. ],
  6369. "summary": "Get an issue's labels",
  6370. "operationId": "issueGetLabels",
  6371. "parameters": [
  6372. {
  6373. "type": "string",
  6374. "description": "owner of the repo",
  6375. "name": "owner",
  6376. "in": "path",
  6377. "required": true
  6378. },
  6379. {
  6380. "type": "string",
  6381. "description": "name of the repo",
  6382. "name": "repo",
  6383. "in": "path",
  6384. "required": true
  6385. },
  6386. {
  6387. "type": "integer",
  6388. "format": "int64",
  6389. "description": "index of the issue",
  6390. "name": "index",
  6391. "in": "path",
  6392. "required": true
  6393. }
  6394. ],
  6395. "responses": {
  6396. "200": {
  6397. "$ref": "#/responses/LabelList"
  6398. },
  6399. "404": {
  6400. "$ref": "#/responses/notFound"
  6401. }
  6402. }
  6403. },
  6404. "put": {
  6405. "consumes": [
  6406. "application/json"
  6407. ],
  6408. "produces": [
  6409. "application/json"
  6410. ],
  6411. "tags": [
  6412. "issue"
  6413. ],
  6414. "summary": "Replace an issue's labels",
  6415. "operationId": "issueReplaceLabels",
  6416. "parameters": [
  6417. {
  6418. "type": "string",
  6419. "description": "owner of the repo",
  6420. "name": "owner",
  6421. "in": "path",
  6422. "required": true
  6423. },
  6424. {
  6425. "type": "string",
  6426. "description": "name of the repo",
  6427. "name": "repo",
  6428. "in": "path",
  6429. "required": true
  6430. },
  6431. {
  6432. "type": "integer",
  6433. "format": "int64",
  6434. "description": "index of the issue",
  6435. "name": "index",
  6436. "in": "path",
  6437. "required": true
  6438. },
  6439. {
  6440. "name": "body",
  6441. "in": "body",
  6442. "schema": {
  6443. "$ref": "#/definitions/IssueLabelsOption"
  6444. }
  6445. }
  6446. ],
  6447. "responses": {
  6448. "200": {
  6449. "$ref": "#/responses/LabelList"
  6450. },
  6451. "403": {
  6452. "$ref": "#/responses/forbidden"
  6453. }
  6454. }
  6455. },
  6456. "post": {
  6457. "consumes": [
  6458. "application/json"
  6459. ],
  6460. "produces": [
  6461. "application/json"
  6462. ],
  6463. "tags": [
  6464. "issue"
  6465. ],
  6466. "summary": "Add a label to an issue",
  6467. "operationId": "issueAddLabel",
  6468. "parameters": [
  6469. {
  6470. "type": "string",
  6471. "description": "owner of the repo",
  6472. "name": "owner",
  6473. "in": "path",
  6474. "required": true
  6475. },
  6476. {
  6477. "type": "string",
  6478. "description": "name of the repo",
  6479. "name": "repo",
  6480. "in": "path",
  6481. "required": true
  6482. },
  6483. {
  6484. "type": "integer",
  6485. "format": "int64",
  6486. "description": "index of the issue",
  6487. "name": "index",
  6488. "in": "path",
  6489. "required": true
  6490. },
  6491. {
  6492. "name": "body",
  6493. "in": "body",
  6494. "schema": {
  6495. "$ref": "#/definitions/IssueLabelsOption"
  6496. }
  6497. }
  6498. ],
  6499. "responses": {
  6500. "200": {
  6501. "$ref": "#/responses/LabelList"
  6502. },
  6503. "403": {
  6504. "$ref": "#/responses/forbidden"
  6505. }
  6506. }
  6507. },
  6508. "delete": {
  6509. "produces": [
  6510. "application/json"
  6511. ],
  6512. "tags": [
  6513. "issue"
  6514. ],
  6515. "summary": "Remove all labels from an issue",
  6516. "operationId": "issueClearLabels",
  6517. "parameters": [
  6518. {
  6519. "type": "string",
  6520. "description": "owner of the repo",
  6521. "name": "owner",
  6522. "in": "path",
  6523. "required": true
  6524. },
  6525. {
  6526. "type": "string",
  6527. "description": "name of the repo",
  6528. "name": "repo",
  6529. "in": "path",
  6530. "required": true
  6531. },
  6532. {
  6533. "type": "integer",
  6534. "format": "int64",
  6535. "description": "index of the issue",
  6536. "name": "index",
  6537. "in": "path",
  6538. "required": true
  6539. }
  6540. ],
  6541. "responses": {
  6542. "204": {
  6543. "$ref": "#/responses/empty"
  6544. },
  6545. "403": {
  6546. "$ref": "#/responses/forbidden"
  6547. }
  6548. }
  6549. }
  6550. },
  6551. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  6552. "delete": {
  6553. "produces": [
  6554. "application/json"
  6555. ],
  6556. "tags": [
  6557. "issue"
  6558. ],
  6559. "summary": "Remove a label from an issue",
  6560. "operationId": "issueRemoveLabel",
  6561. "parameters": [
  6562. {
  6563. "type": "string",
  6564. "description": "owner of the repo",
  6565. "name": "owner",
  6566. "in": "path",
  6567. "required": true
  6568. },
  6569. {
  6570. "type": "string",
  6571. "description": "name of the repo",
  6572. "name": "repo",
  6573. "in": "path",
  6574. "required": true
  6575. },
  6576. {
  6577. "type": "integer",
  6578. "format": "int64",
  6579. "description": "index of the issue",
  6580. "name": "index",
  6581. "in": "path",
  6582. "required": true
  6583. },
  6584. {
  6585. "type": "integer",
  6586. "format": "int64",
  6587. "description": "id of the label to remove",
  6588. "name": "id",
  6589. "in": "path",
  6590. "required": true
  6591. }
  6592. ],
  6593. "responses": {
  6594. "204": {
  6595. "$ref": "#/responses/empty"
  6596. },
  6597. "403": {
  6598. "$ref": "#/responses/forbidden"
  6599. },
  6600. "422": {
  6601. "$ref": "#/responses/validationError"
  6602. }
  6603. }
  6604. }
  6605. },
  6606. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  6607. "get": {
  6608. "consumes": [
  6609. "application/json"
  6610. ],
  6611. "produces": [
  6612. "application/json"
  6613. ],
  6614. "tags": [
  6615. "issue"
  6616. ],
  6617. "summary": "Get a list reactions of an issue",
  6618. "operationId": "issueGetIssueReactions",
  6619. "parameters": [
  6620. {
  6621. "type": "string",
  6622. "description": "owner of the repo",
  6623. "name": "owner",
  6624. "in": "path",
  6625. "required": true
  6626. },
  6627. {
  6628. "type": "string",
  6629. "description": "name of the repo",
  6630. "name": "repo",
  6631. "in": "path",
  6632. "required": true
  6633. },
  6634. {
  6635. "type": "integer",
  6636. "format": "int64",
  6637. "description": "index of the issue",
  6638. "name": "index",
  6639. "in": "path",
  6640. "required": true
  6641. },
  6642. {
  6643. "type": "integer",
  6644. "description": "page number of results to return (1-based)",
  6645. "name": "page",
  6646. "in": "query"
  6647. },
  6648. {
  6649. "type": "integer",
  6650. "description": "page size of results",
  6651. "name": "limit",
  6652. "in": "query"
  6653. }
  6654. ],
  6655. "responses": {
  6656. "200": {
  6657. "$ref": "#/responses/ReactionList"
  6658. },
  6659. "403": {
  6660. "$ref": "#/responses/forbidden"
  6661. }
  6662. }
  6663. },
  6664. "post": {
  6665. "consumes": [
  6666. "application/json"
  6667. ],
  6668. "produces": [
  6669. "application/json"
  6670. ],
  6671. "tags": [
  6672. "issue"
  6673. ],
  6674. "summary": "Add a reaction to an issue",
  6675. "operationId": "issuePostIssueReaction",
  6676. "parameters": [
  6677. {
  6678. "type": "string",
  6679. "description": "owner of the repo",
  6680. "name": "owner",
  6681. "in": "path",
  6682. "required": true
  6683. },
  6684. {
  6685. "type": "string",
  6686. "description": "name of the repo",
  6687. "name": "repo",
  6688. "in": "path",
  6689. "required": true
  6690. },
  6691. {
  6692. "type": "integer",
  6693. "format": "int64",
  6694. "description": "index of the issue",
  6695. "name": "index",
  6696. "in": "path",
  6697. "required": true
  6698. },
  6699. {
  6700. "name": "content",
  6701. "in": "body",
  6702. "schema": {
  6703. "$ref": "#/definitions/EditReactionOption"
  6704. }
  6705. }
  6706. ],
  6707. "responses": {
  6708. "200": {
  6709. "$ref": "#/responses/Reaction"
  6710. },
  6711. "201": {
  6712. "$ref": "#/responses/Reaction"
  6713. },
  6714. "403": {
  6715. "$ref": "#/responses/forbidden"
  6716. }
  6717. }
  6718. },
  6719. "delete": {
  6720. "consumes": [
  6721. "application/json"
  6722. ],
  6723. "produces": [
  6724. "application/json"
  6725. ],
  6726. "tags": [
  6727. "issue"
  6728. ],
  6729. "summary": "Remove a reaction from an issue",
  6730. "operationId": "issueDeleteIssueReaction",
  6731. "parameters": [
  6732. {
  6733. "type": "string",
  6734. "description": "owner of the repo",
  6735. "name": "owner",
  6736. "in": "path",
  6737. "required": true
  6738. },
  6739. {
  6740. "type": "string",
  6741. "description": "name of the repo",
  6742. "name": "repo",
  6743. "in": "path",
  6744. "required": true
  6745. },
  6746. {
  6747. "type": "integer",
  6748. "format": "int64",
  6749. "description": "index of the issue",
  6750. "name": "index",
  6751. "in": "path",
  6752. "required": true
  6753. },
  6754. {
  6755. "name": "content",
  6756. "in": "body",
  6757. "schema": {
  6758. "$ref": "#/definitions/EditReactionOption"
  6759. }
  6760. }
  6761. ],
  6762. "responses": {
  6763. "200": {
  6764. "$ref": "#/responses/empty"
  6765. },
  6766. "403": {
  6767. "$ref": "#/responses/forbidden"
  6768. }
  6769. }
  6770. }
  6771. },
  6772. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  6773. "delete": {
  6774. "consumes": [
  6775. "application/json"
  6776. ],
  6777. "produces": [
  6778. "application/json"
  6779. ],
  6780. "tags": [
  6781. "issue"
  6782. ],
  6783. "summary": "Delete an issue's existing stopwatch.",
  6784. "operationId": "issueDeleteStopWatch",
  6785. "parameters": [
  6786. {
  6787. "type": "string",
  6788. "description": "owner of the repo",
  6789. "name": "owner",
  6790. "in": "path",
  6791. "required": true
  6792. },
  6793. {
  6794. "type": "string",
  6795. "description": "name of the repo",
  6796. "name": "repo",
  6797. "in": "path",
  6798. "required": true
  6799. },
  6800. {
  6801. "type": "integer",
  6802. "format": "int64",
  6803. "description": "index of the issue to stop the stopwatch on",
  6804. "name": "index",
  6805. "in": "path",
  6806. "required": true
  6807. }
  6808. ],
  6809. "responses": {
  6810. "204": {
  6811. "$ref": "#/responses/empty"
  6812. },
  6813. "403": {
  6814. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  6815. },
  6816. "404": {
  6817. "$ref": "#/responses/notFound"
  6818. },
  6819. "409": {
  6820. "description": "Cannot cancel a non existent stopwatch"
  6821. }
  6822. }
  6823. }
  6824. },
  6825. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  6826. "post": {
  6827. "consumes": [
  6828. "application/json"
  6829. ],
  6830. "produces": [
  6831. "application/json"
  6832. ],
  6833. "tags": [
  6834. "issue"
  6835. ],
  6836. "summary": "Start stopwatch on an issue.",
  6837. "operationId": "issueStartStopWatch",
  6838. "parameters": [
  6839. {
  6840. "type": "string",
  6841. "description": "owner of the repo",
  6842. "name": "owner",
  6843. "in": "path",
  6844. "required": true
  6845. },
  6846. {
  6847. "type": "string",
  6848. "description": "name of the repo",
  6849. "name": "repo",
  6850. "in": "path",
  6851. "required": true
  6852. },
  6853. {
  6854. "type": "integer",
  6855. "format": "int64",
  6856. "description": "index of the issue to create the stopwatch on",
  6857. "name": "index",
  6858. "in": "path",
  6859. "required": true
  6860. }
  6861. ],
  6862. "responses": {
  6863. "201": {
  6864. "$ref": "#/responses/empty"
  6865. },
  6866. "403": {
  6867. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  6868. },
  6869. "404": {
  6870. "$ref": "#/responses/notFound"
  6871. },
  6872. "409": {
  6873. "description": "Cannot start a stopwatch again if it already exists"
  6874. }
  6875. }
  6876. }
  6877. },
  6878. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  6879. "post": {
  6880. "consumes": [
  6881. "application/json"
  6882. ],
  6883. "produces": [
  6884. "application/json"
  6885. ],
  6886. "tags": [
  6887. "issue"
  6888. ],
  6889. "summary": "Stop an issue's existing stopwatch.",
  6890. "operationId": "issueStopStopWatch",
  6891. "parameters": [
  6892. {
  6893. "type": "string",
  6894. "description": "owner of the repo",
  6895. "name": "owner",
  6896. "in": "path",
  6897. "required": true
  6898. },
  6899. {
  6900. "type": "string",
  6901. "description": "name of the repo",
  6902. "name": "repo",
  6903. "in": "path",
  6904. "required": true
  6905. },
  6906. {
  6907. "type": "integer",
  6908. "format": "int64",
  6909. "description": "index of the issue to stop the stopwatch on",
  6910. "name": "index",
  6911. "in": "path",
  6912. "required": true
  6913. }
  6914. ],
  6915. "responses": {
  6916. "201": {
  6917. "$ref": "#/responses/empty"
  6918. },
  6919. "403": {
  6920. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  6921. },
  6922. "404": {
  6923. "$ref": "#/responses/notFound"
  6924. },
  6925. "409": {
  6926. "description": "Cannot stop a non existent stopwatch"
  6927. }
  6928. }
  6929. }
  6930. },
  6931. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  6932. "get": {
  6933. "consumes": [
  6934. "application/json"
  6935. ],
  6936. "produces": [
  6937. "application/json"
  6938. ],
  6939. "tags": [
  6940. "issue"
  6941. ],
  6942. "summary": "Get users who subscribed on an issue.",
  6943. "operationId": "issueSubscriptions",
  6944. "parameters": [
  6945. {
  6946. "type": "string",
  6947. "description": "owner of the repo",
  6948. "name": "owner",
  6949. "in": "path",
  6950. "required": true
  6951. },
  6952. {
  6953. "type": "string",
  6954. "description": "name of the repo",
  6955. "name": "repo",
  6956. "in": "path",
  6957. "required": true
  6958. },
  6959. {
  6960. "type": "integer",
  6961. "format": "int64",
  6962. "description": "index of the issue",
  6963. "name": "index",
  6964. "in": "path",
  6965. "required": true
  6966. },
  6967. {
  6968. "type": "integer",
  6969. "description": "page number of results to return (1-based)",
  6970. "name": "page",
  6971. "in": "query"
  6972. },
  6973. {
  6974. "type": "integer",
  6975. "description": "page size of results",
  6976. "name": "limit",
  6977. "in": "query"
  6978. }
  6979. ],
  6980. "responses": {
  6981. "200": {
  6982. "$ref": "#/responses/UserList"
  6983. },
  6984. "404": {
  6985. "$ref": "#/responses/notFound"
  6986. }
  6987. }
  6988. }
  6989. },
  6990. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  6991. "get": {
  6992. "consumes": [
  6993. "application/json"
  6994. ],
  6995. "produces": [
  6996. "application/json"
  6997. ],
  6998. "tags": [
  6999. "issue"
  7000. ],
  7001. "summary": "Check if user is subscribed to an issue",
  7002. "operationId": "issueCheckSubscription",
  7003. "parameters": [
  7004. {
  7005. "type": "string",
  7006. "description": "owner of the repo",
  7007. "name": "owner",
  7008. "in": "path",
  7009. "required": true
  7010. },
  7011. {
  7012. "type": "string",
  7013. "description": "name of the repo",
  7014. "name": "repo",
  7015. "in": "path",
  7016. "required": true
  7017. },
  7018. {
  7019. "type": "integer",
  7020. "format": "int64",
  7021. "description": "index of the issue",
  7022. "name": "index",
  7023. "in": "path",
  7024. "required": true
  7025. }
  7026. ],
  7027. "responses": {
  7028. "200": {
  7029. "$ref": "#/responses/WatchInfo"
  7030. },
  7031. "404": {
  7032. "$ref": "#/responses/notFound"
  7033. }
  7034. }
  7035. }
  7036. },
  7037. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  7038. "put": {
  7039. "consumes": [
  7040. "application/json"
  7041. ],
  7042. "produces": [
  7043. "application/json"
  7044. ],
  7045. "tags": [
  7046. "issue"
  7047. ],
  7048. "summary": "Subscribe user to issue",
  7049. "operationId": "issueAddSubscription",
  7050. "parameters": [
  7051. {
  7052. "type": "string",
  7053. "description": "owner of the repo",
  7054. "name": "owner",
  7055. "in": "path",
  7056. "required": true
  7057. },
  7058. {
  7059. "type": "string",
  7060. "description": "name of the repo",
  7061. "name": "repo",
  7062. "in": "path",
  7063. "required": true
  7064. },
  7065. {
  7066. "type": "integer",
  7067. "format": "int64",
  7068. "description": "index of the issue",
  7069. "name": "index",
  7070. "in": "path",
  7071. "required": true
  7072. },
  7073. {
  7074. "type": "string",
  7075. "description": "user to subscribe",
  7076. "name": "user",
  7077. "in": "path",
  7078. "required": true
  7079. }
  7080. ],
  7081. "responses": {
  7082. "200": {
  7083. "description": "Already subscribed"
  7084. },
  7085. "201": {
  7086. "description": "Successfully Subscribed"
  7087. },
  7088. "304": {
  7089. "description": "User can only subscribe itself if he is no admin"
  7090. },
  7091. "404": {
  7092. "$ref": "#/responses/notFound"
  7093. }
  7094. }
  7095. },
  7096. "delete": {
  7097. "consumes": [
  7098. "application/json"
  7099. ],
  7100. "produces": [
  7101. "application/json"
  7102. ],
  7103. "tags": [
  7104. "issue"
  7105. ],
  7106. "summary": "Unsubscribe user from issue",
  7107. "operationId": "issueDeleteSubscription",
  7108. "parameters": [
  7109. {
  7110. "type": "string",
  7111. "description": "owner of the repo",
  7112. "name": "owner",
  7113. "in": "path",
  7114. "required": true
  7115. },
  7116. {
  7117. "type": "string",
  7118. "description": "name of the repo",
  7119. "name": "repo",
  7120. "in": "path",
  7121. "required": true
  7122. },
  7123. {
  7124. "type": "integer",
  7125. "format": "int64",
  7126. "description": "index of the issue",
  7127. "name": "index",
  7128. "in": "path",
  7129. "required": true
  7130. },
  7131. {
  7132. "type": "string",
  7133. "description": "user witch unsubscribe",
  7134. "name": "user",
  7135. "in": "path",
  7136. "required": true
  7137. }
  7138. ],
  7139. "responses": {
  7140. "200": {
  7141. "description": "Already unsubscribed"
  7142. },
  7143. "201": {
  7144. "description": "Successfully Unsubscribed"
  7145. },
  7146. "304": {
  7147. "description": "User can only subscribe itself if he is no admin"
  7148. },
  7149. "404": {
  7150. "$ref": "#/responses/notFound"
  7151. }
  7152. }
  7153. }
  7154. },
  7155. "/repos/{owner}/{repo}/issues/{index}/timeline": {
  7156. "get": {
  7157. "produces": [
  7158. "application/json"
  7159. ],
  7160. "tags": [
  7161. "issue"
  7162. ],
  7163. "summary": "List all comments and events on an issue",
  7164. "operationId": "issueGetCommentsAndTimeline",
  7165. "parameters": [
  7166. {
  7167. "type": "string",
  7168. "description": "owner of the repo",
  7169. "name": "owner",
  7170. "in": "path",
  7171. "required": true
  7172. },
  7173. {
  7174. "type": "string",
  7175. "description": "name of the repo",
  7176. "name": "repo",
  7177. "in": "path",
  7178. "required": true
  7179. },
  7180. {
  7181. "type": "integer",
  7182. "format": "int64",
  7183. "description": "index of the issue",
  7184. "name": "index",
  7185. "in": "path",
  7186. "required": true
  7187. },
  7188. {
  7189. "type": "string",
  7190. "format": "date-time",
  7191. "description": "if provided, only comments updated since the specified time are returned.",
  7192. "name": "since",
  7193. "in": "query"
  7194. },
  7195. {
  7196. "type": "integer",
  7197. "description": "page number of results to return (1-based)",
  7198. "name": "page",
  7199. "in": "query"
  7200. },
  7201. {
  7202. "type": "integer",
  7203. "description": "page size of results",
  7204. "name": "limit",
  7205. "in": "query"
  7206. },
  7207. {
  7208. "type": "string",
  7209. "format": "date-time",
  7210. "description": "if provided, only comments updated before the provided time are returned.",
  7211. "name": "before",
  7212. "in": "query"
  7213. }
  7214. ],
  7215. "responses": {
  7216. "200": {
  7217. "$ref": "#/responses/TimelineList"
  7218. }
  7219. }
  7220. }
  7221. },
  7222. "/repos/{owner}/{repo}/issues/{index}/times": {
  7223. "get": {
  7224. "produces": [
  7225. "application/json"
  7226. ],
  7227. "tags": [
  7228. "issue"
  7229. ],
  7230. "summary": "List an issue's tracked times",
  7231. "operationId": "issueTrackedTimes",
  7232. "parameters": [
  7233. {
  7234. "type": "string",
  7235. "description": "owner of the repo",
  7236. "name": "owner",
  7237. "in": "path",
  7238. "required": true
  7239. },
  7240. {
  7241. "type": "string",
  7242. "description": "name of the repo",
  7243. "name": "repo",
  7244. "in": "path",
  7245. "required": true
  7246. },
  7247. {
  7248. "type": "integer",
  7249. "format": "int64",
  7250. "description": "index of the issue",
  7251. "name": "index",
  7252. "in": "path",
  7253. "required": true
  7254. },
  7255. {
  7256. "type": "string",
  7257. "description": "optional filter by user (available for issue managers)",
  7258. "name": "user",
  7259. "in": "query"
  7260. },
  7261. {
  7262. "type": "string",
  7263. "format": "date-time",
  7264. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7265. "name": "since",
  7266. "in": "query"
  7267. },
  7268. {
  7269. "type": "string",
  7270. "format": "date-time",
  7271. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7272. "name": "before",
  7273. "in": "query"
  7274. },
  7275. {
  7276. "type": "integer",
  7277. "description": "page number of results to return (1-based)",
  7278. "name": "page",
  7279. "in": "query"
  7280. },
  7281. {
  7282. "type": "integer",
  7283. "description": "page size of results",
  7284. "name": "limit",
  7285. "in": "query"
  7286. }
  7287. ],
  7288. "responses": {
  7289. "200": {
  7290. "$ref": "#/responses/TrackedTimeList"
  7291. },
  7292. "404": {
  7293. "$ref": "#/responses/notFound"
  7294. }
  7295. }
  7296. },
  7297. "post": {
  7298. "consumes": [
  7299. "application/json"
  7300. ],
  7301. "produces": [
  7302. "application/json"
  7303. ],
  7304. "tags": [
  7305. "issue"
  7306. ],
  7307. "summary": "Add tracked time to a issue",
  7308. "operationId": "issueAddTime",
  7309. "parameters": [
  7310. {
  7311. "type": "string",
  7312. "description": "owner of the repo",
  7313. "name": "owner",
  7314. "in": "path",
  7315. "required": true
  7316. },
  7317. {
  7318. "type": "string",
  7319. "description": "name of the repo",
  7320. "name": "repo",
  7321. "in": "path",
  7322. "required": true
  7323. },
  7324. {
  7325. "type": "integer",
  7326. "format": "int64",
  7327. "description": "index of the issue",
  7328. "name": "index",
  7329. "in": "path",
  7330. "required": true
  7331. },
  7332. {
  7333. "name": "body",
  7334. "in": "body",
  7335. "schema": {
  7336. "$ref": "#/definitions/AddTimeOption"
  7337. }
  7338. }
  7339. ],
  7340. "responses": {
  7341. "200": {
  7342. "$ref": "#/responses/TrackedTime"
  7343. },
  7344. "400": {
  7345. "$ref": "#/responses/error"
  7346. },
  7347. "403": {
  7348. "$ref": "#/responses/forbidden"
  7349. }
  7350. }
  7351. },
  7352. "delete": {
  7353. "consumes": [
  7354. "application/json"
  7355. ],
  7356. "produces": [
  7357. "application/json"
  7358. ],
  7359. "tags": [
  7360. "issue"
  7361. ],
  7362. "summary": "Reset a tracked time of an issue",
  7363. "operationId": "issueResetTime",
  7364. "parameters": [
  7365. {
  7366. "type": "string",
  7367. "description": "owner of the repo",
  7368. "name": "owner",
  7369. "in": "path",
  7370. "required": true
  7371. },
  7372. {
  7373. "type": "string",
  7374. "description": "name of the repo",
  7375. "name": "repo",
  7376. "in": "path",
  7377. "required": true
  7378. },
  7379. {
  7380. "type": "integer",
  7381. "format": "int64",
  7382. "description": "index of the issue to add tracked time to",
  7383. "name": "index",
  7384. "in": "path",
  7385. "required": true
  7386. }
  7387. ],
  7388. "responses": {
  7389. "204": {
  7390. "$ref": "#/responses/empty"
  7391. },
  7392. "400": {
  7393. "$ref": "#/responses/error"
  7394. },
  7395. "403": {
  7396. "$ref": "#/responses/forbidden"
  7397. }
  7398. }
  7399. }
  7400. },
  7401. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  7402. "delete": {
  7403. "consumes": [
  7404. "application/json"
  7405. ],
  7406. "produces": [
  7407. "application/json"
  7408. ],
  7409. "tags": [
  7410. "issue"
  7411. ],
  7412. "summary": "Delete specific tracked time",
  7413. "operationId": "issueDeleteTime",
  7414. "parameters": [
  7415. {
  7416. "type": "string",
  7417. "description": "owner of the repo",
  7418. "name": "owner",
  7419. "in": "path",
  7420. "required": true
  7421. },
  7422. {
  7423. "type": "string",
  7424. "description": "name of the repo",
  7425. "name": "repo",
  7426. "in": "path",
  7427. "required": true
  7428. },
  7429. {
  7430. "type": "integer",
  7431. "format": "int64",
  7432. "description": "index of the issue",
  7433. "name": "index",
  7434. "in": "path",
  7435. "required": true
  7436. },
  7437. {
  7438. "type": "integer",
  7439. "format": "int64",
  7440. "description": "id of time to delete",
  7441. "name": "id",
  7442. "in": "path",
  7443. "required": true
  7444. }
  7445. ],
  7446. "responses": {
  7447. "204": {
  7448. "$ref": "#/responses/empty"
  7449. },
  7450. "400": {
  7451. "$ref": "#/responses/error"
  7452. },
  7453. "403": {
  7454. "$ref": "#/responses/forbidden"
  7455. }
  7456. }
  7457. }
  7458. },
  7459. "/repos/{owner}/{repo}/keys": {
  7460. "get": {
  7461. "produces": [
  7462. "application/json"
  7463. ],
  7464. "tags": [
  7465. "repository"
  7466. ],
  7467. "summary": "List a repository's keys",
  7468. "operationId": "repoListKeys",
  7469. "parameters": [
  7470. {
  7471. "type": "string",
  7472. "description": "owner of the repo",
  7473. "name": "owner",
  7474. "in": "path",
  7475. "required": true
  7476. },
  7477. {
  7478. "type": "string",
  7479. "description": "name of the repo",
  7480. "name": "repo",
  7481. "in": "path",
  7482. "required": true
  7483. },
  7484. {
  7485. "type": "integer",
  7486. "description": "the key_id to search for",
  7487. "name": "key_id",
  7488. "in": "query"
  7489. },
  7490. {
  7491. "type": "string",
  7492. "description": "fingerprint of the key",
  7493. "name": "fingerprint",
  7494. "in": "query"
  7495. },
  7496. {
  7497. "type": "integer",
  7498. "description": "page number of results to return (1-based)",
  7499. "name": "page",
  7500. "in": "query"
  7501. },
  7502. {
  7503. "type": "integer",
  7504. "description": "page size of results",
  7505. "name": "limit",
  7506. "in": "query"
  7507. }
  7508. ],
  7509. "responses": {
  7510. "200": {
  7511. "$ref": "#/responses/DeployKeyList"
  7512. }
  7513. }
  7514. },
  7515. "post": {
  7516. "consumes": [
  7517. "application/json"
  7518. ],
  7519. "produces": [
  7520. "application/json"
  7521. ],
  7522. "tags": [
  7523. "repository"
  7524. ],
  7525. "summary": "Add a key to a repository",
  7526. "operationId": "repoCreateKey",
  7527. "parameters": [
  7528. {
  7529. "type": "string",
  7530. "description": "owner of the repo",
  7531. "name": "owner",
  7532. "in": "path",
  7533. "required": true
  7534. },
  7535. {
  7536. "type": "string",
  7537. "description": "name of the repo",
  7538. "name": "repo",
  7539. "in": "path",
  7540. "required": true
  7541. },
  7542. {
  7543. "name": "body",
  7544. "in": "body",
  7545. "schema": {
  7546. "$ref": "#/definitions/CreateKeyOption"
  7547. }
  7548. }
  7549. ],
  7550. "responses": {
  7551. "201": {
  7552. "$ref": "#/responses/DeployKey"
  7553. },
  7554. "422": {
  7555. "$ref": "#/responses/validationError"
  7556. }
  7557. }
  7558. }
  7559. },
  7560. "/repos/{owner}/{repo}/keys/{id}": {
  7561. "get": {
  7562. "produces": [
  7563. "application/json"
  7564. ],
  7565. "tags": [
  7566. "repository"
  7567. ],
  7568. "summary": "Get a repository's key by id",
  7569. "operationId": "repoGetKey",
  7570. "parameters": [
  7571. {
  7572. "type": "string",
  7573. "description": "owner of the repo",
  7574. "name": "owner",
  7575. "in": "path",
  7576. "required": true
  7577. },
  7578. {
  7579. "type": "string",
  7580. "description": "name of the repo",
  7581. "name": "repo",
  7582. "in": "path",
  7583. "required": true
  7584. },
  7585. {
  7586. "type": "integer",
  7587. "format": "int64",
  7588. "description": "id of the key to get",
  7589. "name": "id",
  7590. "in": "path",
  7591. "required": true
  7592. }
  7593. ],
  7594. "responses": {
  7595. "200": {
  7596. "$ref": "#/responses/DeployKey"
  7597. }
  7598. }
  7599. },
  7600. "delete": {
  7601. "tags": [
  7602. "repository"
  7603. ],
  7604. "summary": "Delete a key from a repository",
  7605. "operationId": "repoDeleteKey",
  7606. "parameters": [
  7607. {
  7608. "type": "string",
  7609. "description": "owner of the repo",
  7610. "name": "owner",
  7611. "in": "path",
  7612. "required": true
  7613. },
  7614. {
  7615. "type": "string",
  7616. "description": "name of the repo",
  7617. "name": "repo",
  7618. "in": "path",
  7619. "required": true
  7620. },
  7621. {
  7622. "type": "integer",
  7623. "format": "int64",
  7624. "description": "id of the key to delete",
  7625. "name": "id",
  7626. "in": "path",
  7627. "required": true
  7628. }
  7629. ],
  7630. "responses": {
  7631. "204": {
  7632. "$ref": "#/responses/empty"
  7633. },
  7634. "403": {
  7635. "$ref": "#/responses/forbidden"
  7636. }
  7637. }
  7638. }
  7639. },
  7640. "/repos/{owner}/{repo}/labels": {
  7641. "get": {
  7642. "produces": [
  7643. "application/json"
  7644. ],
  7645. "tags": [
  7646. "issue"
  7647. ],
  7648. "summary": "Get all of a repository's labels",
  7649. "operationId": "issueListLabels",
  7650. "parameters": [
  7651. {
  7652. "type": "string",
  7653. "description": "owner of the repo",
  7654. "name": "owner",
  7655. "in": "path",
  7656. "required": true
  7657. },
  7658. {
  7659. "type": "string",
  7660. "description": "name of the repo",
  7661. "name": "repo",
  7662. "in": "path",
  7663. "required": true
  7664. },
  7665. {
  7666. "type": "integer",
  7667. "description": "page number of results to return (1-based)",
  7668. "name": "page",
  7669. "in": "query"
  7670. },
  7671. {
  7672. "type": "integer",
  7673. "description": "page size of results",
  7674. "name": "limit",
  7675. "in": "query"
  7676. }
  7677. ],
  7678. "responses": {
  7679. "200": {
  7680. "$ref": "#/responses/LabelList"
  7681. }
  7682. }
  7683. },
  7684. "post": {
  7685. "consumes": [
  7686. "application/json"
  7687. ],
  7688. "produces": [
  7689. "application/json"
  7690. ],
  7691. "tags": [
  7692. "issue"
  7693. ],
  7694. "summary": "Create a label",
  7695. "operationId": "issueCreateLabel",
  7696. "parameters": [
  7697. {
  7698. "type": "string",
  7699. "description": "owner of the repo",
  7700. "name": "owner",
  7701. "in": "path",
  7702. "required": true
  7703. },
  7704. {
  7705. "type": "string",
  7706. "description": "name of the repo",
  7707. "name": "repo",
  7708. "in": "path",
  7709. "required": true
  7710. },
  7711. {
  7712. "name": "body",
  7713. "in": "body",
  7714. "schema": {
  7715. "$ref": "#/definitions/CreateLabelOption"
  7716. }
  7717. }
  7718. ],
  7719. "responses": {
  7720. "201": {
  7721. "$ref": "#/responses/Label"
  7722. },
  7723. "422": {
  7724. "$ref": "#/responses/validationError"
  7725. }
  7726. }
  7727. }
  7728. },
  7729. "/repos/{owner}/{repo}/labels/{id}": {
  7730. "get": {
  7731. "produces": [
  7732. "application/json"
  7733. ],
  7734. "tags": [
  7735. "issue"
  7736. ],
  7737. "summary": "Get a single label",
  7738. "operationId": "issueGetLabel",
  7739. "parameters": [
  7740. {
  7741. "type": "string",
  7742. "description": "owner of the repo",
  7743. "name": "owner",
  7744. "in": "path",
  7745. "required": true
  7746. },
  7747. {
  7748. "type": "string",
  7749. "description": "name of the repo",
  7750. "name": "repo",
  7751. "in": "path",
  7752. "required": true
  7753. },
  7754. {
  7755. "type": "integer",
  7756. "format": "int64",
  7757. "description": "id of the label to get",
  7758. "name": "id",
  7759. "in": "path",
  7760. "required": true
  7761. }
  7762. ],
  7763. "responses": {
  7764. "200": {
  7765. "$ref": "#/responses/Label"
  7766. }
  7767. }
  7768. },
  7769. "delete": {
  7770. "tags": [
  7771. "issue"
  7772. ],
  7773. "summary": "Delete a label",
  7774. "operationId": "issueDeleteLabel",
  7775. "parameters": [
  7776. {
  7777. "type": "string",
  7778. "description": "owner of the repo",
  7779. "name": "owner",
  7780. "in": "path",
  7781. "required": true
  7782. },
  7783. {
  7784. "type": "string",
  7785. "description": "name of the repo",
  7786. "name": "repo",
  7787. "in": "path",
  7788. "required": true
  7789. },
  7790. {
  7791. "type": "integer",
  7792. "format": "int64",
  7793. "description": "id of the label to delete",
  7794. "name": "id",
  7795. "in": "path",
  7796. "required": true
  7797. }
  7798. ],
  7799. "responses": {
  7800. "204": {
  7801. "$ref": "#/responses/empty"
  7802. }
  7803. }
  7804. },
  7805. "patch": {
  7806. "consumes": [
  7807. "application/json"
  7808. ],
  7809. "produces": [
  7810. "application/json"
  7811. ],
  7812. "tags": [
  7813. "issue"
  7814. ],
  7815. "summary": "Update a label",
  7816. "operationId": "issueEditLabel",
  7817. "parameters": [
  7818. {
  7819. "type": "string",
  7820. "description": "owner of the repo",
  7821. "name": "owner",
  7822. "in": "path",
  7823. "required": true
  7824. },
  7825. {
  7826. "type": "string",
  7827. "description": "name of the repo",
  7828. "name": "repo",
  7829. "in": "path",
  7830. "required": true
  7831. },
  7832. {
  7833. "type": "integer",
  7834. "format": "int64",
  7835. "description": "id of the label to edit",
  7836. "name": "id",
  7837. "in": "path",
  7838. "required": true
  7839. },
  7840. {
  7841. "name": "body",
  7842. "in": "body",
  7843. "schema": {
  7844. "$ref": "#/definitions/EditLabelOption"
  7845. }
  7846. }
  7847. ],
  7848. "responses": {
  7849. "200": {
  7850. "$ref": "#/responses/Label"
  7851. },
  7852. "422": {
  7853. "$ref": "#/responses/validationError"
  7854. }
  7855. }
  7856. }
  7857. },
  7858. "/repos/{owner}/{repo}/languages": {
  7859. "get": {
  7860. "produces": [
  7861. "application/json"
  7862. ],
  7863. "tags": [
  7864. "repository"
  7865. ],
  7866. "summary": "Get languages and number of bytes of code written",
  7867. "operationId": "repoGetLanguages",
  7868. "parameters": [
  7869. {
  7870. "type": "string",
  7871. "description": "owner of the repo",
  7872. "name": "owner",
  7873. "in": "path",
  7874. "required": true
  7875. },
  7876. {
  7877. "type": "string",
  7878. "description": "name of the repo",
  7879. "name": "repo",
  7880. "in": "path",
  7881. "required": true
  7882. }
  7883. ],
  7884. "responses": {
  7885. "200": {
  7886. "$ref": "#/responses/LanguageStatistics"
  7887. },
  7888. "404": {
  7889. "$ref": "#/responses/notFound"
  7890. }
  7891. }
  7892. }
  7893. },
  7894. "/repos/{owner}/{repo}/media/{filepath}": {
  7895. "get": {
  7896. "tags": [
  7897. "repository"
  7898. ],
  7899. "summary": "Get a file or it's LFS object from a repository",
  7900. "operationId": "repoGetRawFileOrLFS",
  7901. "parameters": [
  7902. {
  7903. "type": "string",
  7904. "description": "owner of the repo",
  7905. "name": "owner",
  7906. "in": "path",
  7907. "required": true
  7908. },
  7909. {
  7910. "type": "string",
  7911. "description": "name of the repo",
  7912. "name": "repo",
  7913. "in": "path",
  7914. "required": true
  7915. },
  7916. {
  7917. "type": "string",
  7918. "description": "filepath of the file to get",
  7919. "name": "filepath",
  7920. "in": "path",
  7921. "required": true
  7922. },
  7923. {
  7924. "type": "string",
  7925. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  7926. "name": "ref",
  7927. "in": "query"
  7928. }
  7929. ],
  7930. "responses": {
  7931. "200": {
  7932. "description": "Returns raw file content."
  7933. },
  7934. "404": {
  7935. "$ref": "#/responses/notFound"
  7936. }
  7937. }
  7938. }
  7939. },
  7940. "/repos/{owner}/{repo}/milestones": {
  7941. "get": {
  7942. "produces": [
  7943. "application/json"
  7944. ],
  7945. "tags": [
  7946. "issue"
  7947. ],
  7948. "summary": "Get all of a repository's opened milestones",
  7949. "operationId": "issueGetMilestonesList",
  7950. "parameters": [
  7951. {
  7952. "type": "string",
  7953. "description": "owner of the repo",
  7954. "name": "owner",
  7955. "in": "path",
  7956. "required": true
  7957. },
  7958. {
  7959. "type": "string",
  7960. "description": "name of the repo",
  7961. "name": "repo",
  7962. "in": "path",
  7963. "required": true
  7964. },
  7965. {
  7966. "type": "string",
  7967. "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
  7968. "name": "state",
  7969. "in": "query"
  7970. },
  7971. {
  7972. "type": "string",
  7973. "description": "filter by milestone name",
  7974. "name": "name",
  7975. "in": "query"
  7976. },
  7977. {
  7978. "type": "integer",
  7979. "description": "page number of results to return (1-based)",
  7980. "name": "page",
  7981. "in": "query"
  7982. },
  7983. {
  7984. "type": "integer",
  7985. "description": "page size of results",
  7986. "name": "limit",
  7987. "in": "query"
  7988. }
  7989. ],
  7990. "responses": {
  7991. "200": {
  7992. "$ref": "#/responses/MilestoneList"
  7993. }
  7994. }
  7995. },
  7996. "post": {
  7997. "consumes": [
  7998. "application/json"
  7999. ],
  8000. "produces": [
  8001. "application/json"
  8002. ],
  8003. "tags": [
  8004. "issue"
  8005. ],
  8006. "summary": "Create a milestone",
  8007. "operationId": "issueCreateMilestone",
  8008. "parameters": [
  8009. {
  8010. "type": "string",
  8011. "description": "owner of the repo",
  8012. "name": "owner",
  8013. "in": "path",
  8014. "required": true
  8015. },
  8016. {
  8017. "type": "string",
  8018. "description": "name of the repo",
  8019. "name": "repo",
  8020. "in": "path",
  8021. "required": true
  8022. },
  8023. {
  8024. "name": "body",
  8025. "in": "body",
  8026. "schema": {
  8027. "$ref": "#/definitions/CreateMilestoneOption"
  8028. }
  8029. }
  8030. ],
  8031. "responses": {
  8032. "201": {
  8033. "$ref": "#/responses/Milestone"
  8034. }
  8035. }
  8036. }
  8037. },
  8038. "/repos/{owner}/{repo}/milestones/{id}": {
  8039. "get": {
  8040. "produces": [
  8041. "application/json"
  8042. ],
  8043. "tags": [
  8044. "issue"
  8045. ],
  8046. "summary": "Get a milestone",
  8047. "operationId": "issueGetMilestone",
  8048. "parameters": [
  8049. {
  8050. "type": "string",
  8051. "description": "owner of the repo",
  8052. "name": "owner",
  8053. "in": "path",
  8054. "required": true
  8055. },
  8056. {
  8057. "type": "string",
  8058. "description": "name of the repo",
  8059. "name": "repo",
  8060. "in": "path",
  8061. "required": true
  8062. },
  8063. {
  8064. "type": "string",
  8065. "description": "the milestone to get, identified by ID and if not available by name",
  8066. "name": "id",
  8067. "in": "path",
  8068. "required": true
  8069. }
  8070. ],
  8071. "responses": {
  8072. "200": {
  8073. "$ref": "#/responses/Milestone"
  8074. }
  8075. }
  8076. },
  8077. "delete": {
  8078. "tags": [
  8079. "issue"
  8080. ],
  8081. "summary": "Delete a milestone",
  8082. "operationId": "issueDeleteMilestone",
  8083. "parameters": [
  8084. {
  8085. "type": "string",
  8086. "description": "owner of the repo",
  8087. "name": "owner",
  8088. "in": "path",
  8089. "required": true
  8090. },
  8091. {
  8092. "type": "string",
  8093. "description": "name of the repo",
  8094. "name": "repo",
  8095. "in": "path",
  8096. "required": true
  8097. },
  8098. {
  8099. "type": "string",
  8100. "description": "the milestone to delete, identified by ID and if not available by name",
  8101. "name": "id",
  8102. "in": "path",
  8103. "required": true
  8104. }
  8105. ],
  8106. "responses": {
  8107. "204": {
  8108. "$ref": "#/responses/empty"
  8109. }
  8110. }
  8111. },
  8112. "patch": {
  8113. "consumes": [
  8114. "application/json"
  8115. ],
  8116. "produces": [
  8117. "application/json"
  8118. ],
  8119. "tags": [
  8120. "issue"
  8121. ],
  8122. "summary": "Update a milestone",
  8123. "operationId": "issueEditMilestone",
  8124. "parameters": [
  8125. {
  8126. "type": "string",
  8127. "description": "owner of the repo",
  8128. "name": "owner",
  8129. "in": "path",
  8130. "required": true
  8131. },
  8132. {
  8133. "type": "string",
  8134. "description": "name of the repo",
  8135. "name": "repo",
  8136. "in": "path",
  8137. "required": true
  8138. },
  8139. {
  8140. "type": "string",
  8141. "description": "the milestone to edit, identified by ID and if not available by name",
  8142. "name": "id",
  8143. "in": "path",
  8144. "required": true
  8145. },
  8146. {
  8147. "name": "body",
  8148. "in": "body",
  8149. "schema": {
  8150. "$ref": "#/definitions/EditMilestoneOption"
  8151. }
  8152. }
  8153. ],
  8154. "responses": {
  8155. "200": {
  8156. "$ref": "#/responses/Milestone"
  8157. }
  8158. }
  8159. }
  8160. },
  8161. "/repos/{owner}/{repo}/mirror-sync": {
  8162. "post": {
  8163. "produces": [
  8164. "application/json"
  8165. ],
  8166. "tags": [
  8167. "repository"
  8168. ],
  8169. "summary": "Sync a mirrored repository",
  8170. "operationId": "repoMirrorSync",
  8171. "parameters": [
  8172. {
  8173. "type": "string",
  8174. "description": "owner of the repo to sync",
  8175. "name": "owner",
  8176. "in": "path",
  8177. "required": true
  8178. },
  8179. {
  8180. "type": "string",
  8181. "description": "name of the repo to sync",
  8182. "name": "repo",
  8183. "in": "path",
  8184. "required": true
  8185. }
  8186. ],
  8187. "responses": {
  8188. "200": {
  8189. "$ref": "#/responses/empty"
  8190. },
  8191. "403": {
  8192. "$ref": "#/responses/forbidden"
  8193. }
  8194. }
  8195. }
  8196. },
  8197. "/repos/{owner}/{repo}/notifications": {
  8198. "get": {
  8199. "consumes": [
  8200. "application/json"
  8201. ],
  8202. "produces": [
  8203. "application/json"
  8204. ],
  8205. "tags": [
  8206. "notification"
  8207. ],
  8208. "summary": "List users's notification threads on a specific repo",
  8209. "operationId": "notifyGetRepoList",
  8210. "parameters": [
  8211. {
  8212. "type": "string",
  8213. "description": "owner of the repo",
  8214. "name": "owner",
  8215. "in": "path",
  8216. "required": true
  8217. },
  8218. {
  8219. "type": "string",
  8220. "description": "name of the repo",
  8221. "name": "repo",
  8222. "in": "path",
  8223. "required": true
  8224. },
  8225. {
  8226. "type": "boolean",
  8227. "description": "If true, show notifications marked as read. Default value is false",
  8228. "name": "all",
  8229. "in": "query"
  8230. },
  8231. {
  8232. "type": "array",
  8233. "items": {
  8234. "type": "string"
  8235. },
  8236. "collectionFormat": "multi",
  8237. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  8238. "name": "status-types",
  8239. "in": "query"
  8240. },
  8241. {
  8242. "type": "array",
  8243. "items": {
  8244. "enum": [
  8245. "issue",
  8246. "pull",
  8247. "commit",
  8248. "repository"
  8249. ],
  8250. "type": "string"
  8251. },
  8252. "collectionFormat": "multi",
  8253. "description": "filter notifications by subject type",
  8254. "name": "subject-type",
  8255. "in": "query"
  8256. },
  8257. {
  8258. "type": "string",
  8259. "format": "date-time",
  8260. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  8261. "name": "since",
  8262. "in": "query"
  8263. },
  8264. {
  8265. "type": "string",
  8266. "format": "date-time",
  8267. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  8268. "name": "before",
  8269. "in": "query"
  8270. },
  8271. {
  8272. "type": "integer",
  8273. "description": "page number of results to return (1-based)",
  8274. "name": "page",
  8275. "in": "query"
  8276. },
  8277. {
  8278. "type": "integer",
  8279. "description": "page size of results",
  8280. "name": "limit",
  8281. "in": "query"
  8282. }
  8283. ],
  8284. "responses": {
  8285. "200": {
  8286. "$ref": "#/responses/NotificationThreadList"
  8287. }
  8288. }
  8289. },
  8290. "put": {
  8291. "consumes": [
  8292. "application/json"
  8293. ],
  8294. "produces": [
  8295. "application/json"
  8296. ],
  8297. "tags": [
  8298. "notification"
  8299. ],
  8300. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  8301. "operationId": "notifyReadRepoList",
  8302. "parameters": [
  8303. {
  8304. "type": "string",
  8305. "description": "owner of the repo",
  8306. "name": "owner",
  8307. "in": "path",
  8308. "required": true
  8309. },
  8310. {
  8311. "type": "string",
  8312. "description": "name of the repo",
  8313. "name": "repo",
  8314. "in": "path",
  8315. "required": true
  8316. },
  8317. {
  8318. "type": "string",
  8319. "description": "If true, mark all notifications on this repo. Default value is false",
  8320. "name": "all",
  8321. "in": "query"
  8322. },
  8323. {
  8324. "type": "array",
  8325. "items": {
  8326. "type": "string"
  8327. },
  8328. "collectionFormat": "multi",
  8329. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  8330. "name": "status-types",
  8331. "in": "query"
  8332. },
  8333. {
  8334. "type": "string",
  8335. "description": "Status to mark notifications as. Defaults to read.",
  8336. "name": "to-status",
  8337. "in": "query"
  8338. },
  8339. {
  8340. "type": "string",
  8341. "format": "date-time",
  8342. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  8343. "name": "last_read_at",
  8344. "in": "query"
  8345. }
  8346. ],
  8347. "responses": {
  8348. "205": {
  8349. "$ref": "#/responses/NotificationThreadList"
  8350. }
  8351. }
  8352. }
  8353. },
  8354. "/repos/{owner}/{repo}/pulls": {
  8355. "get": {
  8356. "produces": [
  8357. "application/json"
  8358. ],
  8359. "tags": [
  8360. "repository"
  8361. ],
  8362. "summary": "List a repo's pull requests",
  8363. "operationId": "repoListPullRequests",
  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. "enum": [
  8381. "closed",
  8382. "open",
  8383. "all"
  8384. ],
  8385. "type": "string",
  8386. "description": "State of pull request: open or closed (optional)",
  8387. "name": "state",
  8388. "in": "query"
  8389. },
  8390. {
  8391. "enum": [
  8392. "oldest",
  8393. "recentupdate",
  8394. "leastupdate",
  8395. "mostcomment",
  8396. "leastcomment",
  8397. "priority"
  8398. ],
  8399. "type": "string",
  8400. "description": "Type of sort",
  8401. "name": "sort",
  8402. "in": "query"
  8403. },
  8404. {
  8405. "type": "integer",
  8406. "format": "int64",
  8407. "description": "ID of the milestone",
  8408. "name": "milestone",
  8409. "in": "query"
  8410. },
  8411. {
  8412. "type": "array",
  8413. "items": {
  8414. "type": "integer",
  8415. "format": "int64"
  8416. },
  8417. "collectionFormat": "multi",
  8418. "description": "Label IDs",
  8419. "name": "labels",
  8420. "in": "query"
  8421. },
  8422. {
  8423. "type": "integer",
  8424. "description": "page number of results to return (1-based)",
  8425. "name": "page",
  8426. "in": "query"
  8427. },
  8428. {
  8429. "type": "integer",
  8430. "description": "page size of results",
  8431. "name": "limit",
  8432. "in": "query"
  8433. }
  8434. ],
  8435. "responses": {
  8436. "200": {
  8437. "$ref": "#/responses/PullRequestList"
  8438. }
  8439. }
  8440. },
  8441. "post": {
  8442. "consumes": [
  8443. "application/json"
  8444. ],
  8445. "produces": [
  8446. "application/json"
  8447. ],
  8448. "tags": [
  8449. "repository"
  8450. ],
  8451. "summary": "Create a pull request",
  8452. "operationId": "repoCreatePullRequest",
  8453. "parameters": [
  8454. {
  8455. "type": "string",
  8456. "description": "owner of the repo",
  8457. "name": "owner",
  8458. "in": "path",
  8459. "required": true
  8460. },
  8461. {
  8462. "type": "string",
  8463. "description": "name of the repo",
  8464. "name": "repo",
  8465. "in": "path",
  8466. "required": true
  8467. },
  8468. {
  8469. "name": "body",
  8470. "in": "body",
  8471. "schema": {
  8472. "$ref": "#/definitions/CreatePullRequestOption"
  8473. }
  8474. }
  8475. ],
  8476. "responses": {
  8477. "201": {
  8478. "$ref": "#/responses/PullRequest"
  8479. },
  8480. "409": {
  8481. "$ref": "#/responses/error"
  8482. },
  8483. "422": {
  8484. "$ref": "#/responses/validationError"
  8485. }
  8486. }
  8487. }
  8488. },
  8489. "/repos/{owner}/{repo}/pulls/{index}": {
  8490. "get": {
  8491. "produces": [
  8492. "application/json"
  8493. ],
  8494. "tags": [
  8495. "repository"
  8496. ],
  8497. "summary": "Get a pull request",
  8498. "operationId": "repoGetPullRequest",
  8499. "parameters": [
  8500. {
  8501. "type": "string",
  8502. "description": "owner of the repo",
  8503. "name": "owner",
  8504. "in": "path",
  8505. "required": true
  8506. },
  8507. {
  8508. "type": "string",
  8509. "description": "name of the repo",
  8510. "name": "repo",
  8511. "in": "path",
  8512. "required": true
  8513. },
  8514. {
  8515. "type": "integer",
  8516. "format": "int64",
  8517. "description": "index of the pull request to get",
  8518. "name": "index",
  8519. "in": "path",
  8520. "required": true
  8521. }
  8522. ],
  8523. "responses": {
  8524. "200": {
  8525. "$ref": "#/responses/PullRequest"
  8526. },
  8527. "404": {
  8528. "$ref": "#/responses/notFound"
  8529. }
  8530. }
  8531. },
  8532. "patch": {
  8533. "consumes": [
  8534. "application/json"
  8535. ],
  8536. "produces": [
  8537. "application/json"
  8538. ],
  8539. "tags": [
  8540. "repository"
  8541. ],
  8542. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  8543. "operationId": "repoEditPullRequest",
  8544. "parameters": [
  8545. {
  8546. "type": "string",
  8547. "description": "owner of the repo",
  8548. "name": "owner",
  8549. "in": "path",
  8550. "required": true
  8551. },
  8552. {
  8553. "type": "string",
  8554. "description": "name of the repo",
  8555. "name": "repo",
  8556. "in": "path",
  8557. "required": true
  8558. },
  8559. {
  8560. "type": "integer",
  8561. "format": "int64",
  8562. "description": "index of the pull request to edit",
  8563. "name": "index",
  8564. "in": "path",
  8565. "required": true
  8566. },
  8567. {
  8568. "name": "body",
  8569. "in": "body",
  8570. "schema": {
  8571. "$ref": "#/definitions/EditPullRequestOption"
  8572. }
  8573. }
  8574. ],
  8575. "responses": {
  8576. "201": {
  8577. "$ref": "#/responses/PullRequest"
  8578. },
  8579. "403": {
  8580. "$ref": "#/responses/forbidden"
  8581. },
  8582. "409": {
  8583. "$ref": "#/responses/error"
  8584. },
  8585. "412": {
  8586. "$ref": "#/responses/error"
  8587. },
  8588. "422": {
  8589. "$ref": "#/responses/validationError"
  8590. }
  8591. }
  8592. }
  8593. },
  8594. "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
  8595. "get": {
  8596. "produces": [
  8597. "text/plain"
  8598. ],
  8599. "tags": [
  8600. "repository"
  8601. ],
  8602. "summary": "Get a pull request diff or patch",
  8603. "operationId": "repoDownloadPullDiffOrPatch",
  8604. "parameters": [
  8605. {
  8606. "type": "string",
  8607. "description": "owner of the repo",
  8608. "name": "owner",
  8609. "in": "path",
  8610. "required": true
  8611. },
  8612. {
  8613. "type": "string",
  8614. "description": "name of the repo",
  8615. "name": "repo",
  8616. "in": "path",
  8617. "required": true
  8618. },
  8619. {
  8620. "type": "integer",
  8621. "format": "int64",
  8622. "description": "index of the pull request to get",
  8623. "name": "index",
  8624. "in": "path",
  8625. "required": true
  8626. },
  8627. {
  8628. "enum": [
  8629. "diff",
  8630. "patch"
  8631. ],
  8632. "type": "string",
  8633. "description": "whether the output is diff or patch",
  8634. "name": "diffType",
  8635. "in": "path",
  8636. "required": true
  8637. },
  8638. {
  8639. "type": "boolean",
  8640. "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
  8641. "name": "binary",
  8642. "in": "query"
  8643. }
  8644. ],
  8645. "responses": {
  8646. "200": {
  8647. "$ref": "#/responses/string"
  8648. },
  8649. "404": {
  8650. "$ref": "#/responses/notFound"
  8651. }
  8652. }
  8653. }
  8654. },
  8655. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  8656. "get": {
  8657. "produces": [
  8658. "application/json"
  8659. ],
  8660. "tags": [
  8661. "repository"
  8662. ],
  8663. "summary": "Get commits for a pull request",
  8664. "operationId": "repoGetPullRequestCommits",
  8665. "parameters": [
  8666. {
  8667. "type": "string",
  8668. "description": "owner of the repo",
  8669. "name": "owner",
  8670. "in": "path",
  8671. "required": true
  8672. },
  8673. {
  8674. "type": "string",
  8675. "description": "name of the repo",
  8676. "name": "repo",
  8677. "in": "path",
  8678. "required": true
  8679. },
  8680. {
  8681. "type": "integer",
  8682. "format": "int64",
  8683. "description": "index of the pull request to get",
  8684. "name": "index",
  8685. "in": "path",
  8686. "required": true
  8687. },
  8688. {
  8689. "type": "integer",
  8690. "description": "page number of results to return (1-based)",
  8691. "name": "page",
  8692. "in": "query"
  8693. },
  8694. {
  8695. "type": "integer",
  8696. "description": "page size of results",
  8697. "name": "limit",
  8698. "in": "query"
  8699. }
  8700. ],
  8701. "responses": {
  8702. "200": {
  8703. "$ref": "#/responses/CommitList"
  8704. },
  8705. "404": {
  8706. "$ref": "#/responses/notFound"
  8707. }
  8708. }
  8709. }
  8710. },
  8711. "/repos/{owner}/{repo}/pulls/{index}/files": {
  8712. "get": {
  8713. "produces": [
  8714. "application/json"
  8715. ],
  8716. "tags": [
  8717. "repository"
  8718. ],
  8719. "summary": "Get changed files for a pull request",
  8720. "operationId": "repoGetPullRequestFiles",
  8721. "parameters": [
  8722. {
  8723. "type": "string",
  8724. "description": "owner of the repo",
  8725. "name": "owner",
  8726. "in": "path",
  8727. "required": true
  8728. },
  8729. {
  8730. "type": "string",
  8731. "description": "name of the repo",
  8732. "name": "repo",
  8733. "in": "path",
  8734. "required": true
  8735. },
  8736. {
  8737. "type": "integer",
  8738. "format": "int64",
  8739. "description": "index of the pull request to get",
  8740. "name": "index",
  8741. "in": "path",
  8742. "required": true
  8743. },
  8744. {
  8745. "type": "string",
  8746. "description": "skip to given file",
  8747. "name": "skip-to",
  8748. "in": "query"
  8749. },
  8750. {
  8751. "enum": [
  8752. "ignore-all",
  8753. "ignore-change",
  8754. "ignore-eol",
  8755. "show-all"
  8756. ],
  8757. "type": "string",
  8758. "description": "whitespace behavior",
  8759. "name": "whitespace",
  8760. "in": "query"
  8761. },
  8762. {
  8763. "type": "integer",
  8764. "description": "page number of results to return (1-based)",
  8765. "name": "page",
  8766. "in": "query"
  8767. },
  8768. {
  8769. "type": "integer",
  8770. "description": "page size of results",
  8771. "name": "limit",
  8772. "in": "query"
  8773. }
  8774. ],
  8775. "responses": {
  8776. "200": {
  8777. "$ref": "#/responses/ChangedFileList"
  8778. },
  8779. "404": {
  8780. "$ref": "#/responses/notFound"
  8781. }
  8782. }
  8783. }
  8784. },
  8785. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  8786. "get": {
  8787. "produces": [
  8788. "application/json"
  8789. ],
  8790. "tags": [
  8791. "repository"
  8792. ],
  8793. "summary": "Check if a pull request has been merged",
  8794. "operationId": "repoPullRequestIsMerged",
  8795. "parameters": [
  8796. {
  8797. "type": "string",
  8798. "description": "owner of the repo",
  8799. "name": "owner",
  8800. "in": "path",
  8801. "required": true
  8802. },
  8803. {
  8804. "type": "string",
  8805. "description": "name of the repo",
  8806. "name": "repo",
  8807. "in": "path",
  8808. "required": true
  8809. },
  8810. {
  8811. "type": "integer",
  8812. "format": "int64",
  8813. "description": "index of the pull request",
  8814. "name": "index",
  8815. "in": "path",
  8816. "required": true
  8817. }
  8818. ],
  8819. "responses": {
  8820. "204": {
  8821. "description": "pull request has been merged"
  8822. },
  8823. "404": {
  8824. "description": "pull request has not been merged"
  8825. }
  8826. }
  8827. },
  8828. "post": {
  8829. "produces": [
  8830. "application/json"
  8831. ],
  8832. "tags": [
  8833. "repository"
  8834. ],
  8835. "summary": "Merge a pull request",
  8836. "operationId": "repoMergePullRequest",
  8837. "parameters": [
  8838. {
  8839. "type": "string",
  8840. "description": "owner of the repo",
  8841. "name": "owner",
  8842. "in": "path",
  8843. "required": true
  8844. },
  8845. {
  8846. "type": "string",
  8847. "description": "name of the repo",
  8848. "name": "repo",
  8849. "in": "path",
  8850. "required": true
  8851. },
  8852. {
  8853. "type": "integer",
  8854. "format": "int64",
  8855. "description": "index of the pull request to merge",
  8856. "name": "index",
  8857. "in": "path",
  8858. "required": true
  8859. },
  8860. {
  8861. "name": "body",
  8862. "in": "body",
  8863. "schema": {
  8864. "$ref": "#/definitions/MergePullRequestOption"
  8865. }
  8866. }
  8867. ],
  8868. "responses": {
  8869. "200": {
  8870. "$ref": "#/responses/empty"
  8871. },
  8872. "405": {
  8873. "$ref": "#/responses/empty"
  8874. },
  8875. "409": {
  8876. "$ref": "#/responses/error"
  8877. }
  8878. }
  8879. },
  8880. "delete": {
  8881. "produces": [
  8882. "application/json"
  8883. ],
  8884. "tags": [
  8885. "repository"
  8886. ],
  8887. "summary": "Cancel the scheduled auto merge for the given pull request",
  8888. "operationId": "repoCancelScheduledAutoMerge",
  8889. "parameters": [
  8890. {
  8891. "type": "string",
  8892. "description": "owner of the repo",
  8893. "name": "owner",
  8894. "in": "path",
  8895. "required": true
  8896. },
  8897. {
  8898. "type": "string",
  8899. "description": "name of the repo",
  8900. "name": "repo",
  8901. "in": "path",
  8902. "required": true
  8903. },
  8904. {
  8905. "type": "integer",
  8906. "format": "int64",
  8907. "description": "index of the pull request to merge",
  8908. "name": "index",
  8909. "in": "path",
  8910. "required": true
  8911. }
  8912. ],
  8913. "responses": {
  8914. "204": {
  8915. "$ref": "#/responses/empty"
  8916. },
  8917. "403": {
  8918. "$ref": "#/responses/forbidden"
  8919. },
  8920. "404": {
  8921. "$ref": "#/responses/notFound"
  8922. }
  8923. }
  8924. }
  8925. },
  8926. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  8927. "post": {
  8928. "produces": [
  8929. "application/json"
  8930. ],
  8931. "tags": [
  8932. "repository"
  8933. ],
  8934. "summary": "create review requests for a pull request",
  8935. "operationId": "repoCreatePullReviewRequests",
  8936. "parameters": [
  8937. {
  8938. "type": "string",
  8939. "description": "owner of the repo",
  8940. "name": "owner",
  8941. "in": "path",
  8942. "required": true
  8943. },
  8944. {
  8945. "type": "string",
  8946. "description": "name of the repo",
  8947. "name": "repo",
  8948. "in": "path",
  8949. "required": true
  8950. },
  8951. {
  8952. "type": "integer",
  8953. "format": "int64",
  8954. "description": "index of the pull request",
  8955. "name": "index",
  8956. "in": "path",
  8957. "required": true
  8958. },
  8959. {
  8960. "name": "body",
  8961. "in": "body",
  8962. "required": true,
  8963. "schema": {
  8964. "$ref": "#/definitions/PullReviewRequestOptions"
  8965. }
  8966. }
  8967. ],
  8968. "responses": {
  8969. "201": {
  8970. "$ref": "#/responses/PullReviewList"
  8971. },
  8972. "404": {
  8973. "$ref": "#/responses/notFound"
  8974. },
  8975. "422": {
  8976. "$ref": "#/responses/validationError"
  8977. }
  8978. }
  8979. },
  8980. "delete": {
  8981. "produces": [
  8982. "application/json"
  8983. ],
  8984. "tags": [
  8985. "repository"
  8986. ],
  8987. "summary": "cancel review requests for a pull request",
  8988. "operationId": "repoDeletePullReviewRequests",
  8989. "parameters": [
  8990. {
  8991. "type": "string",
  8992. "description": "owner of the repo",
  8993. "name": "owner",
  8994. "in": "path",
  8995. "required": true
  8996. },
  8997. {
  8998. "type": "string",
  8999. "description": "name of the repo",
  9000. "name": "repo",
  9001. "in": "path",
  9002. "required": true
  9003. },
  9004. {
  9005. "type": "integer",
  9006. "format": "int64",
  9007. "description": "index of the pull request",
  9008. "name": "index",
  9009. "in": "path",
  9010. "required": true
  9011. },
  9012. {
  9013. "name": "body",
  9014. "in": "body",
  9015. "required": true,
  9016. "schema": {
  9017. "$ref": "#/definitions/PullReviewRequestOptions"
  9018. }
  9019. }
  9020. ],
  9021. "responses": {
  9022. "204": {
  9023. "$ref": "#/responses/empty"
  9024. },
  9025. "404": {
  9026. "$ref": "#/responses/notFound"
  9027. },
  9028. "422": {
  9029. "$ref": "#/responses/validationError"
  9030. }
  9031. }
  9032. }
  9033. },
  9034. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  9035. "get": {
  9036. "produces": [
  9037. "application/json"
  9038. ],
  9039. "tags": [
  9040. "repository"
  9041. ],
  9042. "summary": "List all reviews for a pull request",
  9043. "operationId": "repoListPullReviews",
  9044. "parameters": [
  9045. {
  9046. "type": "string",
  9047. "description": "owner of the repo",
  9048. "name": "owner",
  9049. "in": "path",
  9050. "required": true
  9051. },
  9052. {
  9053. "type": "string",
  9054. "description": "name of the repo",
  9055. "name": "repo",
  9056. "in": "path",
  9057. "required": true
  9058. },
  9059. {
  9060. "type": "integer",
  9061. "format": "int64",
  9062. "description": "index of the pull request",
  9063. "name": "index",
  9064. "in": "path",
  9065. "required": true
  9066. },
  9067. {
  9068. "type": "integer",
  9069. "description": "page number of results to return (1-based)",
  9070. "name": "page",
  9071. "in": "query"
  9072. },
  9073. {
  9074. "type": "integer",
  9075. "description": "page size of results",
  9076. "name": "limit",
  9077. "in": "query"
  9078. }
  9079. ],
  9080. "responses": {
  9081. "200": {
  9082. "$ref": "#/responses/PullReviewList"
  9083. },
  9084. "404": {
  9085. "$ref": "#/responses/notFound"
  9086. }
  9087. }
  9088. },
  9089. "post": {
  9090. "produces": [
  9091. "application/json"
  9092. ],
  9093. "tags": [
  9094. "repository"
  9095. ],
  9096. "summary": "Create a review to an pull request",
  9097. "operationId": "repoCreatePullReview",
  9098. "parameters": [
  9099. {
  9100. "type": "string",
  9101. "description": "owner of the repo",
  9102. "name": "owner",
  9103. "in": "path",
  9104. "required": true
  9105. },
  9106. {
  9107. "type": "string",
  9108. "description": "name of the repo",
  9109. "name": "repo",
  9110. "in": "path",
  9111. "required": true
  9112. },
  9113. {
  9114. "type": "integer",
  9115. "format": "int64",
  9116. "description": "index of the pull request",
  9117. "name": "index",
  9118. "in": "path",
  9119. "required": true
  9120. },
  9121. {
  9122. "name": "body",
  9123. "in": "body",
  9124. "required": true,
  9125. "schema": {
  9126. "$ref": "#/definitions/CreatePullReviewOptions"
  9127. }
  9128. }
  9129. ],
  9130. "responses": {
  9131. "200": {
  9132. "$ref": "#/responses/PullReview"
  9133. },
  9134. "404": {
  9135. "$ref": "#/responses/notFound"
  9136. },
  9137. "422": {
  9138. "$ref": "#/responses/validationError"
  9139. }
  9140. }
  9141. }
  9142. },
  9143. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  9144. "get": {
  9145. "produces": [
  9146. "application/json"
  9147. ],
  9148. "tags": [
  9149. "repository"
  9150. ],
  9151. "summary": "Get a specific review for a pull request",
  9152. "operationId": "repoGetPullReview",
  9153. "parameters": [
  9154. {
  9155. "type": "string",
  9156. "description": "owner of the repo",
  9157. "name": "owner",
  9158. "in": "path",
  9159. "required": true
  9160. },
  9161. {
  9162. "type": "string",
  9163. "description": "name of the repo",
  9164. "name": "repo",
  9165. "in": "path",
  9166. "required": true
  9167. },
  9168. {
  9169. "type": "integer",
  9170. "format": "int64",
  9171. "description": "index of the pull request",
  9172. "name": "index",
  9173. "in": "path",
  9174. "required": true
  9175. },
  9176. {
  9177. "type": "integer",
  9178. "format": "int64",
  9179. "description": "id of the review",
  9180. "name": "id",
  9181. "in": "path",
  9182. "required": true
  9183. }
  9184. ],
  9185. "responses": {
  9186. "200": {
  9187. "$ref": "#/responses/PullReview"
  9188. },
  9189. "404": {
  9190. "$ref": "#/responses/notFound"
  9191. }
  9192. }
  9193. },
  9194. "post": {
  9195. "produces": [
  9196. "application/json"
  9197. ],
  9198. "tags": [
  9199. "repository"
  9200. ],
  9201. "summary": "Submit a pending review to an pull request",
  9202. "operationId": "repoSubmitPullReview",
  9203. "parameters": [
  9204. {
  9205. "type": "string",
  9206. "description": "owner of the repo",
  9207. "name": "owner",
  9208. "in": "path",
  9209. "required": true
  9210. },
  9211. {
  9212. "type": "string",
  9213. "description": "name of the repo",
  9214. "name": "repo",
  9215. "in": "path",
  9216. "required": true
  9217. },
  9218. {
  9219. "type": "integer",
  9220. "format": "int64",
  9221. "description": "index of the pull request",
  9222. "name": "index",
  9223. "in": "path",
  9224. "required": true
  9225. },
  9226. {
  9227. "type": "integer",
  9228. "format": "int64",
  9229. "description": "id of the review",
  9230. "name": "id",
  9231. "in": "path",
  9232. "required": true
  9233. },
  9234. {
  9235. "name": "body",
  9236. "in": "body",
  9237. "required": true,
  9238. "schema": {
  9239. "$ref": "#/definitions/SubmitPullReviewOptions"
  9240. }
  9241. }
  9242. ],
  9243. "responses": {
  9244. "200": {
  9245. "$ref": "#/responses/PullReview"
  9246. },
  9247. "404": {
  9248. "$ref": "#/responses/notFound"
  9249. },
  9250. "422": {
  9251. "$ref": "#/responses/validationError"
  9252. }
  9253. }
  9254. },
  9255. "delete": {
  9256. "produces": [
  9257. "application/json"
  9258. ],
  9259. "tags": [
  9260. "repository"
  9261. ],
  9262. "summary": "Delete a specific review from a pull request",
  9263. "operationId": "repoDeletePullReview",
  9264. "parameters": [
  9265. {
  9266. "type": "string",
  9267. "description": "owner of the repo",
  9268. "name": "owner",
  9269. "in": "path",
  9270. "required": true
  9271. },
  9272. {
  9273. "type": "string",
  9274. "description": "name of the repo",
  9275. "name": "repo",
  9276. "in": "path",
  9277. "required": true
  9278. },
  9279. {
  9280. "type": "integer",
  9281. "format": "int64",
  9282. "description": "index of the pull request",
  9283. "name": "index",
  9284. "in": "path",
  9285. "required": true
  9286. },
  9287. {
  9288. "type": "integer",
  9289. "format": "int64",
  9290. "description": "id of the review",
  9291. "name": "id",
  9292. "in": "path",
  9293. "required": true
  9294. }
  9295. ],
  9296. "responses": {
  9297. "204": {
  9298. "$ref": "#/responses/empty"
  9299. },
  9300. "403": {
  9301. "$ref": "#/responses/forbidden"
  9302. },
  9303. "404": {
  9304. "$ref": "#/responses/notFound"
  9305. }
  9306. }
  9307. }
  9308. },
  9309. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  9310. "get": {
  9311. "produces": [
  9312. "application/json"
  9313. ],
  9314. "tags": [
  9315. "repository"
  9316. ],
  9317. "summary": "Get a specific review for a pull request",
  9318. "operationId": "repoGetPullReviewComments",
  9319. "parameters": [
  9320. {
  9321. "type": "string",
  9322. "description": "owner of the repo",
  9323. "name": "owner",
  9324. "in": "path",
  9325. "required": true
  9326. },
  9327. {
  9328. "type": "string",
  9329. "description": "name of the repo",
  9330. "name": "repo",
  9331. "in": "path",
  9332. "required": true
  9333. },
  9334. {
  9335. "type": "integer",
  9336. "format": "int64",
  9337. "description": "index of the pull request",
  9338. "name": "index",
  9339. "in": "path",
  9340. "required": true
  9341. },
  9342. {
  9343. "type": "integer",
  9344. "format": "int64",
  9345. "description": "id of the review",
  9346. "name": "id",
  9347. "in": "path",
  9348. "required": true
  9349. }
  9350. ],
  9351. "responses": {
  9352. "200": {
  9353. "$ref": "#/responses/PullReviewCommentList"
  9354. },
  9355. "404": {
  9356. "$ref": "#/responses/notFound"
  9357. }
  9358. }
  9359. }
  9360. },
  9361. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  9362. "post": {
  9363. "produces": [
  9364. "application/json"
  9365. ],
  9366. "tags": [
  9367. "repository"
  9368. ],
  9369. "summary": "Dismiss a review for a pull request",
  9370. "operationId": "repoDismissPullReview",
  9371. "parameters": [
  9372. {
  9373. "type": "string",
  9374. "description": "owner of the repo",
  9375. "name": "owner",
  9376. "in": "path",
  9377. "required": true
  9378. },
  9379. {
  9380. "type": "string",
  9381. "description": "name of the repo",
  9382. "name": "repo",
  9383. "in": "path",
  9384. "required": true
  9385. },
  9386. {
  9387. "type": "integer",
  9388. "format": "int64",
  9389. "description": "index of the pull request",
  9390. "name": "index",
  9391. "in": "path",
  9392. "required": true
  9393. },
  9394. {
  9395. "type": "integer",
  9396. "format": "int64",
  9397. "description": "id of the review",
  9398. "name": "id",
  9399. "in": "path",
  9400. "required": true
  9401. },
  9402. {
  9403. "name": "body",
  9404. "in": "body",
  9405. "required": true,
  9406. "schema": {
  9407. "$ref": "#/definitions/DismissPullReviewOptions"
  9408. }
  9409. }
  9410. ],
  9411. "responses": {
  9412. "200": {
  9413. "$ref": "#/responses/PullReview"
  9414. },
  9415. "403": {
  9416. "$ref": "#/responses/forbidden"
  9417. },
  9418. "422": {
  9419. "$ref": "#/responses/validationError"
  9420. }
  9421. }
  9422. }
  9423. },
  9424. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  9425. "post": {
  9426. "produces": [
  9427. "application/json"
  9428. ],
  9429. "tags": [
  9430. "repository"
  9431. ],
  9432. "summary": "Cancel to dismiss a review for a pull request",
  9433. "operationId": "repoUnDismissPullReview",
  9434. "parameters": [
  9435. {
  9436. "type": "string",
  9437. "description": "owner of the repo",
  9438. "name": "owner",
  9439. "in": "path",
  9440. "required": true
  9441. },
  9442. {
  9443. "type": "string",
  9444. "description": "name of the repo",
  9445. "name": "repo",
  9446. "in": "path",
  9447. "required": true
  9448. },
  9449. {
  9450. "type": "integer",
  9451. "format": "int64",
  9452. "description": "index of the pull request",
  9453. "name": "index",
  9454. "in": "path",
  9455. "required": true
  9456. },
  9457. {
  9458. "type": "integer",
  9459. "format": "int64",
  9460. "description": "id of the review",
  9461. "name": "id",
  9462. "in": "path",
  9463. "required": true
  9464. }
  9465. ],
  9466. "responses": {
  9467. "200": {
  9468. "$ref": "#/responses/PullReview"
  9469. },
  9470. "403": {
  9471. "$ref": "#/responses/forbidden"
  9472. },
  9473. "422": {
  9474. "$ref": "#/responses/validationError"
  9475. }
  9476. }
  9477. }
  9478. },
  9479. "/repos/{owner}/{repo}/pulls/{index}/update": {
  9480. "post": {
  9481. "produces": [
  9482. "application/json"
  9483. ],
  9484. "tags": [
  9485. "repository"
  9486. ],
  9487. "summary": "Merge PR's baseBranch into headBranch",
  9488. "operationId": "repoUpdatePullRequest",
  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": "index of the pull request to get",
  9508. "name": "index",
  9509. "in": "path",
  9510. "required": true
  9511. },
  9512. {
  9513. "enum": [
  9514. "merge",
  9515. "rebase"
  9516. ],
  9517. "type": "string",
  9518. "description": "how to update pull request",
  9519. "name": "style",
  9520. "in": "query"
  9521. }
  9522. ],
  9523. "responses": {
  9524. "200": {
  9525. "$ref": "#/responses/empty"
  9526. },
  9527. "403": {
  9528. "$ref": "#/responses/forbidden"
  9529. },
  9530. "404": {
  9531. "$ref": "#/responses/notFound"
  9532. },
  9533. "409": {
  9534. "$ref": "#/responses/error"
  9535. },
  9536. "422": {
  9537. "$ref": "#/responses/validationError"
  9538. }
  9539. }
  9540. }
  9541. },
  9542. "/repos/{owner}/{repo}/push_mirrors": {
  9543. "get": {
  9544. "produces": [
  9545. "application/json"
  9546. ],
  9547. "tags": [
  9548. "repository"
  9549. ],
  9550. "summary": "Get all push mirrors of the repository",
  9551. "operationId": "repoListPushMirrors",
  9552. "parameters": [
  9553. {
  9554. "type": "string",
  9555. "description": "owner of the repo",
  9556. "name": "owner",
  9557. "in": "path",
  9558. "required": true
  9559. },
  9560. {
  9561. "type": "string",
  9562. "description": "name of the repo",
  9563. "name": "repo",
  9564. "in": "path",
  9565. "required": true
  9566. },
  9567. {
  9568. "type": "integer",
  9569. "description": "page number of results to return (1-based)",
  9570. "name": "page",
  9571. "in": "query"
  9572. },
  9573. {
  9574. "type": "integer",
  9575. "description": "page size of results",
  9576. "name": "limit",
  9577. "in": "query"
  9578. }
  9579. ],
  9580. "responses": {
  9581. "200": {
  9582. "$ref": "#/responses/PushMirrorList"
  9583. },
  9584. "400": {
  9585. "$ref": "#/responses/error"
  9586. },
  9587. "403": {
  9588. "$ref": "#/responses/forbidden"
  9589. }
  9590. }
  9591. },
  9592. "post": {
  9593. "consumes": [
  9594. "application/json"
  9595. ],
  9596. "produces": [
  9597. "application/json"
  9598. ],
  9599. "tags": [
  9600. "repository"
  9601. ],
  9602. "summary": "add a push mirror to the repository",
  9603. "operationId": "repoAddPushMirror",
  9604. "parameters": [
  9605. {
  9606. "type": "string",
  9607. "description": "owner of the repo",
  9608. "name": "owner",
  9609. "in": "path",
  9610. "required": true
  9611. },
  9612. {
  9613. "type": "string",
  9614. "description": "name of the repo",
  9615. "name": "repo",
  9616. "in": "path",
  9617. "required": true
  9618. },
  9619. {
  9620. "name": "body",
  9621. "in": "body",
  9622. "schema": {
  9623. "$ref": "#/definitions/CreatePushMirrorOption"
  9624. }
  9625. }
  9626. ],
  9627. "responses": {
  9628. "201": {
  9629. "$ref": "#/responses/PushMirror"
  9630. },
  9631. "400": {
  9632. "$ref": "#/responses/error"
  9633. },
  9634. "403": {
  9635. "$ref": "#/responses/forbidden"
  9636. }
  9637. }
  9638. }
  9639. },
  9640. "/repos/{owner}/{repo}/push_mirrors-sync": {
  9641. "post": {
  9642. "produces": [
  9643. "application/json"
  9644. ],
  9645. "tags": [
  9646. "repository"
  9647. ],
  9648. "summary": "Sync all push mirrored repository",
  9649. "operationId": "repoPushMirrorSync",
  9650. "parameters": [
  9651. {
  9652. "type": "string",
  9653. "description": "owner of the repo to sync",
  9654. "name": "owner",
  9655. "in": "path",
  9656. "required": true
  9657. },
  9658. {
  9659. "type": "string",
  9660. "description": "name of the repo to sync",
  9661. "name": "repo",
  9662. "in": "path",
  9663. "required": true
  9664. }
  9665. ],
  9666. "responses": {
  9667. "200": {
  9668. "$ref": "#/responses/empty"
  9669. },
  9670. "400": {
  9671. "$ref": "#/responses/error"
  9672. },
  9673. "403": {
  9674. "$ref": "#/responses/forbidden"
  9675. }
  9676. }
  9677. }
  9678. },
  9679. "/repos/{owner}/{repo}/push_mirrors/{name}": {
  9680. "get": {
  9681. "produces": [
  9682. "application/json"
  9683. ],
  9684. "tags": [
  9685. "repository"
  9686. ],
  9687. "summary": "Get push mirror of the repository by remoteName",
  9688. "operationId": "repoGetPushMirrorByRemoteName",
  9689. "parameters": [
  9690. {
  9691. "type": "string",
  9692. "description": "owner of the repo",
  9693. "name": "owner",
  9694. "in": "path",
  9695. "required": true
  9696. },
  9697. {
  9698. "type": "string",
  9699. "description": "name of the repo",
  9700. "name": "repo",
  9701. "in": "path",
  9702. "required": true
  9703. },
  9704. {
  9705. "type": "string",
  9706. "description": "remote name of push mirror",
  9707. "name": "name",
  9708. "in": "path",
  9709. "required": true
  9710. }
  9711. ],
  9712. "responses": {
  9713. "200": {
  9714. "$ref": "#/responses/PushMirror"
  9715. },
  9716. "400": {
  9717. "$ref": "#/responses/error"
  9718. },
  9719. "403": {
  9720. "$ref": "#/responses/forbidden"
  9721. }
  9722. }
  9723. },
  9724. "delete": {
  9725. "produces": [
  9726. "application/json"
  9727. ],
  9728. "tags": [
  9729. "repository"
  9730. ],
  9731. "summary": "deletes a push mirror from a repository by remoteName",
  9732. "operationId": "repoDeletePushMirror",
  9733. "parameters": [
  9734. {
  9735. "type": "string",
  9736. "description": "owner of the repo",
  9737. "name": "owner",
  9738. "in": "path",
  9739. "required": true
  9740. },
  9741. {
  9742. "type": "string",
  9743. "description": "name of the repo",
  9744. "name": "repo",
  9745. "in": "path",
  9746. "required": true
  9747. },
  9748. {
  9749. "type": "string",
  9750. "description": "remote name of the pushMirror",
  9751. "name": "name",
  9752. "in": "path",
  9753. "required": true
  9754. }
  9755. ],
  9756. "responses": {
  9757. "204": {
  9758. "$ref": "#/responses/empty"
  9759. },
  9760. "400": {
  9761. "$ref": "#/responses/error"
  9762. },
  9763. "404": {
  9764. "$ref": "#/responses/notFound"
  9765. }
  9766. }
  9767. }
  9768. },
  9769. "/repos/{owner}/{repo}/raw/{filepath}": {
  9770. "get": {
  9771. "produces": [
  9772. "application/json"
  9773. ],
  9774. "tags": [
  9775. "repository"
  9776. ],
  9777. "summary": "Get a file from a repository",
  9778. "operationId": "repoGetRawFile",
  9779. "parameters": [
  9780. {
  9781. "type": "string",
  9782. "description": "owner of the repo",
  9783. "name": "owner",
  9784. "in": "path",
  9785. "required": true
  9786. },
  9787. {
  9788. "type": "string",
  9789. "description": "name of the repo",
  9790. "name": "repo",
  9791. "in": "path",
  9792. "required": true
  9793. },
  9794. {
  9795. "type": "string",
  9796. "description": "filepath of the file to get",
  9797. "name": "filepath",
  9798. "in": "path",
  9799. "required": true
  9800. },
  9801. {
  9802. "type": "string",
  9803. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  9804. "name": "ref",
  9805. "in": "query"
  9806. }
  9807. ],
  9808. "responses": {
  9809. "200": {
  9810. "description": "Returns raw file content."
  9811. },
  9812. "404": {
  9813. "$ref": "#/responses/notFound"
  9814. }
  9815. }
  9816. }
  9817. },
  9818. "/repos/{owner}/{repo}/releases": {
  9819. "get": {
  9820. "produces": [
  9821. "application/json"
  9822. ],
  9823. "tags": [
  9824. "repository"
  9825. ],
  9826. "summary": "List a repo's releases",
  9827. "operationId": "repoListReleases",
  9828. "parameters": [
  9829. {
  9830. "type": "string",
  9831. "description": "owner of the repo",
  9832. "name": "owner",
  9833. "in": "path",
  9834. "required": true
  9835. },
  9836. {
  9837. "type": "string",
  9838. "description": "name of the repo",
  9839. "name": "repo",
  9840. "in": "path",
  9841. "required": true
  9842. },
  9843. {
  9844. "type": "boolean",
  9845. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  9846. "name": "draft",
  9847. "in": "query"
  9848. },
  9849. {
  9850. "type": "boolean",
  9851. "description": "filter (exclude / include) pre-releases",
  9852. "name": "pre-release",
  9853. "in": "query"
  9854. },
  9855. {
  9856. "type": "integer",
  9857. "description": "page size of results, deprecated - use limit",
  9858. "name": "per_page",
  9859. "in": "query"
  9860. },
  9861. {
  9862. "type": "integer",
  9863. "description": "page number of results to return (1-based)",
  9864. "name": "page",
  9865. "in": "query"
  9866. },
  9867. {
  9868. "type": "integer",
  9869. "description": "page size of results",
  9870. "name": "limit",
  9871. "in": "query"
  9872. }
  9873. ],
  9874. "responses": {
  9875. "200": {
  9876. "$ref": "#/responses/ReleaseList"
  9877. }
  9878. }
  9879. },
  9880. "post": {
  9881. "consumes": [
  9882. "application/json"
  9883. ],
  9884. "produces": [
  9885. "application/json"
  9886. ],
  9887. "tags": [
  9888. "repository"
  9889. ],
  9890. "summary": "Create a release",
  9891. "operationId": "repoCreateRelease",
  9892. "parameters": [
  9893. {
  9894. "type": "string",
  9895. "description": "owner of the repo",
  9896. "name": "owner",
  9897. "in": "path",
  9898. "required": true
  9899. },
  9900. {
  9901. "type": "string",
  9902. "description": "name of the repo",
  9903. "name": "repo",
  9904. "in": "path",
  9905. "required": true
  9906. },
  9907. {
  9908. "name": "body",
  9909. "in": "body",
  9910. "schema": {
  9911. "$ref": "#/definitions/CreateReleaseOption"
  9912. }
  9913. }
  9914. ],
  9915. "responses": {
  9916. "201": {
  9917. "$ref": "#/responses/Release"
  9918. },
  9919. "404": {
  9920. "$ref": "#/responses/notFound"
  9921. },
  9922. "409": {
  9923. "$ref": "#/responses/error"
  9924. }
  9925. }
  9926. }
  9927. },
  9928. "/repos/{owner}/{repo}/releases/latest": {
  9929. "get": {
  9930. "produces": [
  9931. "application/json"
  9932. ],
  9933. "tags": [
  9934. "repository"
  9935. ],
  9936. "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
  9937. "operationId": "repoGetLatestRelease",
  9938. "parameters": [
  9939. {
  9940. "type": "string",
  9941. "description": "owner of the repo",
  9942. "name": "owner",
  9943. "in": "path",
  9944. "required": true
  9945. },
  9946. {
  9947. "type": "string",
  9948. "description": "name of the repo",
  9949. "name": "repo",
  9950. "in": "path",
  9951. "required": true
  9952. }
  9953. ],
  9954. "responses": {
  9955. "200": {
  9956. "$ref": "#/responses/Release"
  9957. },
  9958. "404": {
  9959. "$ref": "#/responses/notFound"
  9960. }
  9961. }
  9962. }
  9963. },
  9964. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  9965. "get": {
  9966. "produces": [
  9967. "application/json"
  9968. ],
  9969. "tags": [
  9970. "repository"
  9971. ],
  9972. "summary": "Get a release by tag name",
  9973. "operationId": "repoGetReleaseByTag",
  9974. "parameters": [
  9975. {
  9976. "type": "string",
  9977. "description": "owner of the repo",
  9978. "name": "owner",
  9979. "in": "path",
  9980. "required": true
  9981. },
  9982. {
  9983. "type": "string",
  9984. "description": "name of the repo",
  9985. "name": "repo",
  9986. "in": "path",
  9987. "required": true
  9988. },
  9989. {
  9990. "type": "string",
  9991. "description": "tag name of the release to get",
  9992. "name": "tag",
  9993. "in": "path",
  9994. "required": true
  9995. }
  9996. ],
  9997. "responses": {
  9998. "200": {
  9999. "$ref": "#/responses/Release"
  10000. },
  10001. "404": {
  10002. "$ref": "#/responses/notFound"
  10003. }
  10004. }
  10005. },
  10006. "delete": {
  10007. "tags": [
  10008. "repository"
  10009. ],
  10010. "summary": "Delete a release by tag name",
  10011. "operationId": "repoDeleteReleaseByTag",
  10012. "parameters": [
  10013. {
  10014. "type": "string",
  10015. "description": "owner of the repo",
  10016. "name": "owner",
  10017. "in": "path",
  10018. "required": true
  10019. },
  10020. {
  10021. "type": "string",
  10022. "description": "name of the repo",
  10023. "name": "repo",
  10024. "in": "path",
  10025. "required": true
  10026. },
  10027. {
  10028. "type": "string",
  10029. "description": "tag name of the release to delete",
  10030. "name": "tag",
  10031. "in": "path",
  10032. "required": true
  10033. }
  10034. ],
  10035. "responses": {
  10036. "204": {
  10037. "$ref": "#/responses/empty"
  10038. },
  10039. "404": {
  10040. "$ref": "#/responses/notFound"
  10041. },
  10042. "405": {
  10043. "$ref": "#/responses/empty"
  10044. }
  10045. }
  10046. }
  10047. },
  10048. "/repos/{owner}/{repo}/releases/{id}": {
  10049. "get": {
  10050. "produces": [
  10051. "application/json"
  10052. ],
  10053. "tags": [
  10054. "repository"
  10055. ],
  10056. "summary": "Get a release",
  10057. "operationId": "repoGetRelease",
  10058. "parameters": [
  10059. {
  10060. "type": "string",
  10061. "description": "owner of the repo",
  10062. "name": "owner",
  10063. "in": "path",
  10064. "required": true
  10065. },
  10066. {
  10067. "type": "string",
  10068. "description": "name of the repo",
  10069. "name": "repo",
  10070. "in": "path",
  10071. "required": true
  10072. },
  10073. {
  10074. "type": "integer",
  10075. "format": "int64",
  10076. "description": "id of the release to get",
  10077. "name": "id",
  10078. "in": "path",
  10079. "required": true
  10080. }
  10081. ],
  10082. "responses": {
  10083. "200": {
  10084. "$ref": "#/responses/Release"
  10085. },
  10086. "404": {
  10087. "$ref": "#/responses/notFound"
  10088. }
  10089. }
  10090. },
  10091. "delete": {
  10092. "tags": [
  10093. "repository"
  10094. ],
  10095. "summary": "Delete a release",
  10096. "operationId": "repoDeleteRelease",
  10097. "parameters": [
  10098. {
  10099. "type": "string",
  10100. "description": "owner of the repo",
  10101. "name": "owner",
  10102. "in": "path",
  10103. "required": true
  10104. },
  10105. {
  10106. "type": "string",
  10107. "description": "name of the repo",
  10108. "name": "repo",
  10109. "in": "path",
  10110. "required": true
  10111. },
  10112. {
  10113. "type": "integer",
  10114. "format": "int64",
  10115. "description": "id of the release to delete",
  10116. "name": "id",
  10117. "in": "path",
  10118. "required": true
  10119. }
  10120. ],
  10121. "responses": {
  10122. "204": {
  10123. "$ref": "#/responses/empty"
  10124. },
  10125. "404": {
  10126. "$ref": "#/responses/notFound"
  10127. },
  10128. "405": {
  10129. "$ref": "#/responses/empty"
  10130. }
  10131. }
  10132. },
  10133. "patch": {
  10134. "consumes": [
  10135. "application/json"
  10136. ],
  10137. "produces": [
  10138. "application/json"
  10139. ],
  10140. "tags": [
  10141. "repository"
  10142. ],
  10143. "summary": "Update a release",
  10144. "operationId": "repoEditRelease",
  10145. "parameters": [
  10146. {
  10147. "type": "string",
  10148. "description": "owner of the repo",
  10149. "name": "owner",
  10150. "in": "path",
  10151. "required": true
  10152. },
  10153. {
  10154. "type": "string",
  10155. "description": "name of the repo",
  10156. "name": "repo",
  10157. "in": "path",
  10158. "required": true
  10159. },
  10160. {
  10161. "type": "integer",
  10162. "format": "int64",
  10163. "description": "id of the release to edit",
  10164. "name": "id",
  10165. "in": "path",
  10166. "required": true
  10167. },
  10168. {
  10169. "name": "body",
  10170. "in": "body",
  10171. "schema": {
  10172. "$ref": "#/definitions/EditReleaseOption"
  10173. }
  10174. }
  10175. ],
  10176. "responses": {
  10177. "200": {
  10178. "$ref": "#/responses/Release"
  10179. },
  10180. "404": {
  10181. "$ref": "#/responses/notFound"
  10182. }
  10183. }
  10184. }
  10185. },
  10186. "/repos/{owner}/{repo}/releases/{id}/assets": {
  10187. "get": {
  10188. "produces": [
  10189. "application/json"
  10190. ],
  10191. "tags": [
  10192. "repository"
  10193. ],
  10194. "summary": "List release's attachments",
  10195. "operationId": "repoListReleaseAttachments",
  10196. "parameters": [
  10197. {
  10198. "type": "string",
  10199. "description": "owner of the repo",
  10200. "name": "owner",
  10201. "in": "path",
  10202. "required": true
  10203. },
  10204. {
  10205. "type": "string",
  10206. "description": "name of the repo",
  10207. "name": "repo",
  10208. "in": "path",
  10209. "required": true
  10210. },
  10211. {
  10212. "type": "integer",
  10213. "format": "int64",
  10214. "description": "id of the release",
  10215. "name": "id",
  10216. "in": "path",
  10217. "required": true
  10218. }
  10219. ],
  10220. "responses": {
  10221. "200": {
  10222. "$ref": "#/responses/AttachmentList"
  10223. }
  10224. }
  10225. },
  10226. "post": {
  10227. "consumes": [
  10228. "multipart/form-data"
  10229. ],
  10230. "produces": [
  10231. "application/json"
  10232. ],
  10233. "tags": [
  10234. "repository"
  10235. ],
  10236. "summary": "Create a release attachment",
  10237. "operationId": "repoCreateReleaseAttachment",
  10238. "parameters": [
  10239. {
  10240. "type": "string",
  10241. "description": "owner of the repo",
  10242. "name": "owner",
  10243. "in": "path",
  10244. "required": true
  10245. },
  10246. {
  10247. "type": "string",
  10248. "description": "name of the repo",
  10249. "name": "repo",
  10250. "in": "path",
  10251. "required": true
  10252. },
  10253. {
  10254. "type": "integer",
  10255. "format": "int64",
  10256. "description": "id of the release",
  10257. "name": "id",
  10258. "in": "path",
  10259. "required": true
  10260. },
  10261. {
  10262. "type": "string",
  10263. "description": "name of the attachment",
  10264. "name": "name",
  10265. "in": "query"
  10266. },
  10267. {
  10268. "type": "file",
  10269. "description": "attachment to upload",
  10270. "name": "attachment",
  10271. "in": "formData",
  10272. "required": true
  10273. }
  10274. ],
  10275. "responses": {
  10276. "201": {
  10277. "$ref": "#/responses/Attachment"
  10278. },
  10279. "400": {
  10280. "$ref": "#/responses/error"
  10281. }
  10282. }
  10283. }
  10284. },
  10285. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  10286. "get": {
  10287. "produces": [
  10288. "application/json"
  10289. ],
  10290. "tags": [
  10291. "repository"
  10292. ],
  10293. "summary": "Get a release attachment",
  10294. "operationId": "repoGetReleaseAttachment",
  10295. "parameters": [
  10296. {
  10297. "type": "string",
  10298. "description": "owner of the repo",
  10299. "name": "owner",
  10300. "in": "path",
  10301. "required": true
  10302. },
  10303. {
  10304. "type": "string",
  10305. "description": "name of the repo",
  10306. "name": "repo",
  10307. "in": "path",
  10308. "required": true
  10309. },
  10310. {
  10311. "type": "integer",
  10312. "format": "int64",
  10313. "description": "id of the release",
  10314. "name": "id",
  10315. "in": "path",
  10316. "required": true
  10317. },
  10318. {
  10319. "type": "integer",
  10320. "format": "int64",
  10321. "description": "id of the attachment to get",
  10322. "name": "attachment_id",
  10323. "in": "path",
  10324. "required": true
  10325. }
  10326. ],
  10327. "responses": {
  10328. "200": {
  10329. "$ref": "#/responses/Attachment"
  10330. }
  10331. }
  10332. },
  10333. "delete": {
  10334. "produces": [
  10335. "application/json"
  10336. ],
  10337. "tags": [
  10338. "repository"
  10339. ],
  10340. "summary": "Delete a release attachment",
  10341. "operationId": "repoDeleteReleaseAttachment",
  10342. "parameters": [
  10343. {
  10344. "type": "string",
  10345. "description": "owner of the repo",
  10346. "name": "owner",
  10347. "in": "path",
  10348. "required": true
  10349. },
  10350. {
  10351. "type": "string",
  10352. "description": "name of the repo",
  10353. "name": "repo",
  10354. "in": "path",
  10355. "required": true
  10356. },
  10357. {
  10358. "type": "integer",
  10359. "format": "int64",
  10360. "description": "id of the release",
  10361. "name": "id",
  10362. "in": "path",
  10363. "required": true
  10364. },
  10365. {
  10366. "type": "integer",
  10367. "format": "int64",
  10368. "description": "id of the attachment to delete",
  10369. "name": "attachment_id",
  10370. "in": "path",
  10371. "required": true
  10372. }
  10373. ],
  10374. "responses": {
  10375. "204": {
  10376. "$ref": "#/responses/empty"
  10377. }
  10378. }
  10379. },
  10380. "patch": {
  10381. "consumes": [
  10382. "application/json"
  10383. ],
  10384. "produces": [
  10385. "application/json"
  10386. ],
  10387. "tags": [
  10388. "repository"
  10389. ],
  10390. "summary": "Edit a release attachment",
  10391. "operationId": "repoEditReleaseAttachment",
  10392. "parameters": [
  10393. {
  10394. "type": "string",
  10395. "description": "owner of the repo",
  10396. "name": "owner",
  10397. "in": "path",
  10398. "required": true
  10399. },
  10400. {
  10401. "type": "string",
  10402. "description": "name of the repo",
  10403. "name": "repo",
  10404. "in": "path",
  10405. "required": true
  10406. },
  10407. {
  10408. "type": "integer",
  10409. "format": "int64",
  10410. "description": "id of the release",
  10411. "name": "id",
  10412. "in": "path",
  10413. "required": true
  10414. },
  10415. {
  10416. "type": "integer",
  10417. "format": "int64",
  10418. "description": "id of the attachment to edit",
  10419. "name": "attachment_id",
  10420. "in": "path",
  10421. "required": true
  10422. },
  10423. {
  10424. "name": "body",
  10425. "in": "body",
  10426. "schema": {
  10427. "$ref": "#/definitions/EditAttachmentOptions"
  10428. }
  10429. }
  10430. ],
  10431. "responses": {
  10432. "201": {
  10433. "$ref": "#/responses/Attachment"
  10434. }
  10435. }
  10436. }
  10437. },
  10438. "/repos/{owner}/{repo}/reviewers": {
  10439. "get": {
  10440. "produces": [
  10441. "application/json"
  10442. ],
  10443. "tags": [
  10444. "repository"
  10445. ],
  10446. "summary": "Return all users that can be requested to review in this repo",
  10447. "operationId": "repoGetReviewers",
  10448. "parameters": [
  10449. {
  10450. "type": "string",
  10451. "description": "owner of the repo",
  10452. "name": "owner",
  10453. "in": "path",
  10454. "required": true
  10455. },
  10456. {
  10457. "type": "string",
  10458. "description": "name of the repo",
  10459. "name": "repo",
  10460. "in": "path",
  10461. "required": true
  10462. }
  10463. ],
  10464. "responses": {
  10465. "200": {
  10466. "$ref": "#/responses/UserList"
  10467. }
  10468. }
  10469. }
  10470. },
  10471. "/repos/{owner}/{repo}/signing-key.gpg": {
  10472. "get": {
  10473. "produces": [
  10474. "text/plain"
  10475. ],
  10476. "tags": [
  10477. "repository"
  10478. ],
  10479. "summary": "Get signing-key.gpg for given repository",
  10480. "operationId": "repoSigningKey",
  10481. "parameters": [
  10482. {
  10483. "type": "string",
  10484. "description": "owner of the repo",
  10485. "name": "owner",
  10486. "in": "path",
  10487. "required": true
  10488. },
  10489. {
  10490. "type": "string",
  10491. "description": "name of the repo",
  10492. "name": "repo",
  10493. "in": "path",
  10494. "required": true
  10495. }
  10496. ],
  10497. "responses": {
  10498. "200": {
  10499. "description": "GPG armored public key",
  10500. "schema": {
  10501. "type": "string"
  10502. }
  10503. }
  10504. }
  10505. }
  10506. },
  10507. "/repos/{owner}/{repo}/stargazers": {
  10508. "get": {
  10509. "produces": [
  10510. "application/json"
  10511. ],
  10512. "tags": [
  10513. "repository"
  10514. ],
  10515. "summary": "List a repo's stargazers",
  10516. "operationId": "repoListStargazers",
  10517. "parameters": [
  10518. {
  10519. "type": "string",
  10520. "description": "owner of the repo",
  10521. "name": "owner",
  10522. "in": "path",
  10523. "required": true
  10524. },
  10525. {
  10526. "type": "string",
  10527. "description": "name of the repo",
  10528. "name": "repo",
  10529. "in": "path",
  10530. "required": true
  10531. },
  10532. {
  10533. "type": "integer",
  10534. "description": "page number of results to return (1-based)",
  10535. "name": "page",
  10536. "in": "query"
  10537. },
  10538. {
  10539. "type": "integer",
  10540. "description": "page size of results",
  10541. "name": "limit",
  10542. "in": "query"
  10543. }
  10544. ],
  10545. "responses": {
  10546. "200": {
  10547. "$ref": "#/responses/UserList"
  10548. }
  10549. }
  10550. }
  10551. },
  10552. "/repos/{owner}/{repo}/statuses/{sha}": {
  10553. "get": {
  10554. "produces": [
  10555. "application/json"
  10556. ],
  10557. "tags": [
  10558. "repository"
  10559. ],
  10560. "summary": "Get a commit's statuses",
  10561. "operationId": "repoListStatuses",
  10562. "parameters": [
  10563. {
  10564. "type": "string",
  10565. "description": "owner of the repo",
  10566. "name": "owner",
  10567. "in": "path",
  10568. "required": true
  10569. },
  10570. {
  10571. "type": "string",
  10572. "description": "name of the repo",
  10573. "name": "repo",
  10574. "in": "path",
  10575. "required": true
  10576. },
  10577. {
  10578. "type": "string",
  10579. "description": "sha of the commit",
  10580. "name": "sha",
  10581. "in": "path",
  10582. "required": true
  10583. },
  10584. {
  10585. "enum": [
  10586. "oldest",
  10587. "recentupdate",
  10588. "leastupdate",
  10589. "leastindex",
  10590. "highestindex"
  10591. ],
  10592. "type": "string",
  10593. "description": "type of sort",
  10594. "name": "sort",
  10595. "in": "query"
  10596. },
  10597. {
  10598. "enum": [
  10599. "pending",
  10600. "success",
  10601. "error",
  10602. "failure",
  10603. "warning"
  10604. ],
  10605. "type": "string",
  10606. "description": "type of state",
  10607. "name": "state",
  10608. "in": "query"
  10609. },
  10610. {
  10611. "type": "integer",
  10612. "description": "page number of results to return (1-based)",
  10613. "name": "page",
  10614. "in": "query"
  10615. },
  10616. {
  10617. "type": "integer",
  10618. "description": "page size of results",
  10619. "name": "limit",
  10620. "in": "query"
  10621. }
  10622. ],
  10623. "responses": {
  10624. "200": {
  10625. "$ref": "#/responses/CommitStatusList"
  10626. },
  10627. "400": {
  10628. "$ref": "#/responses/error"
  10629. }
  10630. }
  10631. },
  10632. "post": {
  10633. "produces": [
  10634. "application/json"
  10635. ],
  10636. "tags": [
  10637. "repository"
  10638. ],
  10639. "summary": "Create a commit status",
  10640. "operationId": "repoCreateStatus",
  10641. "parameters": [
  10642. {
  10643. "type": "string",
  10644. "description": "owner of the repo",
  10645. "name": "owner",
  10646. "in": "path",
  10647. "required": true
  10648. },
  10649. {
  10650. "type": "string",
  10651. "description": "name of the repo",
  10652. "name": "repo",
  10653. "in": "path",
  10654. "required": true
  10655. },
  10656. {
  10657. "type": "string",
  10658. "description": "sha of the commit",
  10659. "name": "sha",
  10660. "in": "path",
  10661. "required": true
  10662. },
  10663. {
  10664. "name": "body",
  10665. "in": "body",
  10666. "schema": {
  10667. "$ref": "#/definitions/CreateStatusOption"
  10668. }
  10669. }
  10670. ],
  10671. "responses": {
  10672. "201": {
  10673. "$ref": "#/responses/CommitStatus"
  10674. },
  10675. "400": {
  10676. "$ref": "#/responses/error"
  10677. }
  10678. }
  10679. }
  10680. },
  10681. "/repos/{owner}/{repo}/subscribers": {
  10682. "get": {
  10683. "produces": [
  10684. "application/json"
  10685. ],
  10686. "tags": [
  10687. "repository"
  10688. ],
  10689. "summary": "List a repo's watchers",
  10690. "operationId": "repoListSubscribers",
  10691. "parameters": [
  10692. {
  10693. "type": "string",
  10694. "description": "owner of the repo",
  10695. "name": "owner",
  10696. "in": "path",
  10697. "required": true
  10698. },
  10699. {
  10700. "type": "string",
  10701. "description": "name of the repo",
  10702. "name": "repo",
  10703. "in": "path",
  10704. "required": true
  10705. },
  10706. {
  10707. "type": "integer",
  10708. "description": "page number of results to return (1-based)",
  10709. "name": "page",
  10710. "in": "query"
  10711. },
  10712. {
  10713. "type": "integer",
  10714. "description": "page size of results",
  10715. "name": "limit",
  10716. "in": "query"
  10717. }
  10718. ],
  10719. "responses": {
  10720. "200": {
  10721. "$ref": "#/responses/UserList"
  10722. }
  10723. }
  10724. }
  10725. },
  10726. "/repos/{owner}/{repo}/subscription": {
  10727. "get": {
  10728. "tags": [
  10729. "repository"
  10730. ],
  10731. "summary": "Check if the current user is watching a repo",
  10732. "operationId": "userCurrentCheckSubscription",
  10733. "parameters": [
  10734. {
  10735. "type": "string",
  10736. "description": "owner of the repo",
  10737. "name": "owner",
  10738. "in": "path",
  10739. "required": true
  10740. },
  10741. {
  10742. "type": "string",
  10743. "description": "name of the repo",
  10744. "name": "repo",
  10745. "in": "path",
  10746. "required": true
  10747. }
  10748. ],
  10749. "responses": {
  10750. "200": {
  10751. "$ref": "#/responses/WatchInfo"
  10752. },
  10753. "404": {
  10754. "description": "User is not watching this repo or repo do not exist"
  10755. }
  10756. }
  10757. },
  10758. "put": {
  10759. "tags": [
  10760. "repository"
  10761. ],
  10762. "summary": "Watch a repo",
  10763. "operationId": "userCurrentPutSubscription",
  10764. "parameters": [
  10765. {
  10766. "type": "string",
  10767. "description": "owner of the repo",
  10768. "name": "owner",
  10769. "in": "path",
  10770. "required": true
  10771. },
  10772. {
  10773. "type": "string",
  10774. "description": "name of the repo",
  10775. "name": "repo",
  10776. "in": "path",
  10777. "required": true
  10778. }
  10779. ],
  10780. "responses": {
  10781. "200": {
  10782. "$ref": "#/responses/WatchInfo"
  10783. }
  10784. }
  10785. },
  10786. "delete": {
  10787. "tags": [
  10788. "repository"
  10789. ],
  10790. "summary": "Unwatch a repo",
  10791. "operationId": "userCurrentDeleteSubscription",
  10792. "parameters": [
  10793. {
  10794. "type": "string",
  10795. "description": "owner of the repo",
  10796. "name": "owner",
  10797. "in": "path",
  10798. "required": true
  10799. },
  10800. {
  10801. "type": "string",
  10802. "description": "name of the repo",
  10803. "name": "repo",
  10804. "in": "path",
  10805. "required": true
  10806. }
  10807. ],
  10808. "responses": {
  10809. "204": {
  10810. "$ref": "#/responses/empty"
  10811. }
  10812. }
  10813. }
  10814. },
  10815. "/repos/{owner}/{repo}/tags": {
  10816. "get": {
  10817. "produces": [
  10818. "application/json"
  10819. ],
  10820. "tags": [
  10821. "repository"
  10822. ],
  10823. "summary": "List a repository's tags",
  10824. "operationId": "repoListTags",
  10825. "parameters": [
  10826. {
  10827. "type": "string",
  10828. "description": "owner of the repo",
  10829. "name": "owner",
  10830. "in": "path",
  10831. "required": true
  10832. },
  10833. {
  10834. "type": "string",
  10835. "description": "name of the repo",
  10836. "name": "repo",
  10837. "in": "path",
  10838. "required": true
  10839. },
  10840. {
  10841. "type": "integer",
  10842. "description": "page number of results to return (1-based)",
  10843. "name": "page",
  10844. "in": "query"
  10845. },
  10846. {
  10847. "type": "integer",
  10848. "description": "page size of results, default maximum page size is 50",
  10849. "name": "limit",
  10850. "in": "query"
  10851. }
  10852. ],
  10853. "responses": {
  10854. "200": {
  10855. "$ref": "#/responses/TagList"
  10856. }
  10857. }
  10858. },
  10859. "post": {
  10860. "produces": [
  10861. "application/json"
  10862. ],
  10863. "tags": [
  10864. "repository"
  10865. ],
  10866. "summary": "Create a new git tag in a repository",
  10867. "operationId": "repoCreateTag",
  10868. "parameters": [
  10869. {
  10870. "type": "string",
  10871. "description": "owner of the repo",
  10872. "name": "owner",
  10873. "in": "path",
  10874. "required": true
  10875. },
  10876. {
  10877. "type": "string",
  10878. "description": "name of the repo",
  10879. "name": "repo",
  10880. "in": "path",
  10881. "required": true
  10882. },
  10883. {
  10884. "name": "body",
  10885. "in": "body",
  10886. "schema": {
  10887. "$ref": "#/definitions/CreateTagOption"
  10888. }
  10889. }
  10890. ],
  10891. "responses": {
  10892. "200": {
  10893. "$ref": "#/responses/Tag"
  10894. },
  10895. "404": {
  10896. "$ref": "#/responses/notFound"
  10897. },
  10898. "405": {
  10899. "$ref": "#/responses/empty"
  10900. },
  10901. "409": {
  10902. "$ref": "#/responses/conflict"
  10903. }
  10904. }
  10905. }
  10906. },
  10907. "/repos/{owner}/{repo}/tags/{tag}": {
  10908. "get": {
  10909. "produces": [
  10910. "application/json"
  10911. ],
  10912. "tags": [
  10913. "repository"
  10914. ],
  10915. "summary": "Get the tag of a repository by tag name",
  10916. "operationId": "repoGetTag",
  10917. "parameters": [
  10918. {
  10919. "type": "string",
  10920. "description": "owner of the repo",
  10921. "name": "owner",
  10922. "in": "path",
  10923. "required": true
  10924. },
  10925. {
  10926. "type": "string",
  10927. "description": "name of the repo",
  10928. "name": "repo",
  10929. "in": "path",
  10930. "required": true
  10931. },
  10932. {
  10933. "type": "string",
  10934. "description": "name of tag",
  10935. "name": "tag",
  10936. "in": "path",
  10937. "required": true
  10938. }
  10939. ],
  10940. "responses": {
  10941. "200": {
  10942. "$ref": "#/responses/Tag"
  10943. },
  10944. "404": {
  10945. "$ref": "#/responses/notFound"
  10946. }
  10947. }
  10948. },
  10949. "delete": {
  10950. "produces": [
  10951. "application/json"
  10952. ],
  10953. "tags": [
  10954. "repository"
  10955. ],
  10956. "summary": "Delete a repository's tag by name",
  10957. "operationId": "repoDeleteTag",
  10958. "parameters": [
  10959. {
  10960. "type": "string",
  10961. "description": "owner of the repo",
  10962. "name": "owner",
  10963. "in": "path",
  10964. "required": true
  10965. },
  10966. {
  10967. "type": "string",
  10968. "description": "name of the repo",
  10969. "name": "repo",
  10970. "in": "path",
  10971. "required": true
  10972. },
  10973. {
  10974. "type": "string",
  10975. "description": "name of tag to delete",
  10976. "name": "tag",
  10977. "in": "path",
  10978. "required": true
  10979. }
  10980. ],
  10981. "responses": {
  10982. "204": {
  10983. "$ref": "#/responses/empty"
  10984. },
  10985. "404": {
  10986. "$ref": "#/responses/notFound"
  10987. },
  10988. "405": {
  10989. "$ref": "#/responses/empty"
  10990. },
  10991. "409": {
  10992. "$ref": "#/responses/conflict"
  10993. }
  10994. }
  10995. }
  10996. },
  10997. "/repos/{owner}/{repo}/teams": {
  10998. "get": {
  10999. "produces": [
  11000. "application/json"
  11001. ],
  11002. "tags": [
  11003. "repository"
  11004. ],
  11005. "summary": "List a repository's teams",
  11006. "operationId": "repoListTeams",
  11007. "parameters": [
  11008. {
  11009. "type": "string",
  11010. "description": "owner of the repo",
  11011. "name": "owner",
  11012. "in": "path",
  11013. "required": true
  11014. },
  11015. {
  11016. "type": "string",
  11017. "description": "name of the repo",
  11018. "name": "repo",
  11019. "in": "path",
  11020. "required": true
  11021. }
  11022. ],
  11023. "responses": {
  11024. "200": {
  11025. "$ref": "#/responses/TeamList"
  11026. }
  11027. }
  11028. }
  11029. },
  11030. "/repos/{owner}/{repo}/teams/{team}": {
  11031. "get": {
  11032. "produces": [
  11033. "application/json"
  11034. ],
  11035. "tags": [
  11036. "repository"
  11037. ],
  11038. "summary": "Check if a team is assigned to a repository",
  11039. "operationId": "repoCheckTeam",
  11040. "parameters": [
  11041. {
  11042. "type": "string",
  11043. "description": "owner of the repo",
  11044. "name": "owner",
  11045. "in": "path",
  11046. "required": true
  11047. },
  11048. {
  11049. "type": "string",
  11050. "description": "name of the repo",
  11051. "name": "repo",
  11052. "in": "path",
  11053. "required": true
  11054. },
  11055. {
  11056. "type": "string",
  11057. "description": "team name",
  11058. "name": "team",
  11059. "in": "path",
  11060. "required": true
  11061. }
  11062. ],
  11063. "responses": {
  11064. "200": {
  11065. "$ref": "#/responses/Team"
  11066. },
  11067. "404": {
  11068. "$ref": "#/responses/notFound"
  11069. },
  11070. "405": {
  11071. "$ref": "#/responses/error"
  11072. }
  11073. }
  11074. },
  11075. "put": {
  11076. "produces": [
  11077. "application/json"
  11078. ],
  11079. "tags": [
  11080. "repository"
  11081. ],
  11082. "summary": "Add a team to a repository",
  11083. "operationId": "repoAddTeam",
  11084. "parameters": [
  11085. {
  11086. "type": "string",
  11087. "description": "owner of the repo",
  11088. "name": "owner",
  11089. "in": "path",
  11090. "required": true
  11091. },
  11092. {
  11093. "type": "string",
  11094. "description": "name of the repo",
  11095. "name": "repo",
  11096. "in": "path",
  11097. "required": true
  11098. },
  11099. {
  11100. "type": "string",
  11101. "description": "team name",
  11102. "name": "team",
  11103. "in": "path",
  11104. "required": true
  11105. }
  11106. ],
  11107. "responses": {
  11108. "204": {
  11109. "$ref": "#/responses/empty"
  11110. },
  11111. "405": {
  11112. "$ref": "#/responses/error"
  11113. },
  11114. "422": {
  11115. "$ref": "#/responses/validationError"
  11116. }
  11117. }
  11118. },
  11119. "delete": {
  11120. "produces": [
  11121. "application/json"
  11122. ],
  11123. "tags": [
  11124. "repository"
  11125. ],
  11126. "summary": "Delete a team from a repository",
  11127. "operationId": "repoDeleteTeam",
  11128. "parameters": [
  11129. {
  11130. "type": "string",
  11131. "description": "owner of the repo",
  11132. "name": "owner",
  11133. "in": "path",
  11134. "required": true
  11135. },
  11136. {
  11137. "type": "string",
  11138. "description": "name of the repo",
  11139. "name": "repo",
  11140. "in": "path",
  11141. "required": true
  11142. },
  11143. {
  11144. "type": "string",
  11145. "description": "team name",
  11146. "name": "team",
  11147. "in": "path",
  11148. "required": true
  11149. }
  11150. ],
  11151. "responses": {
  11152. "204": {
  11153. "$ref": "#/responses/empty"
  11154. },
  11155. "405": {
  11156. "$ref": "#/responses/error"
  11157. },
  11158. "422": {
  11159. "$ref": "#/responses/validationError"
  11160. }
  11161. }
  11162. }
  11163. },
  11164. "/repos/{owner}/{repo}/times": {
  11165. "get": {
  11166. "produces": [
  11167. "application/json"
  11168. ],
  11169. "tags": [
  11170. "repository"
  11171. ],
  11172. "summary": "List a repo's tracked times",
  11173. "operationId": "repoTrackedTimes",
  11174. "parameters": [
  11175. {
  11176. "type": "string",
  11177. "description": "owner of the repo",
  11178. "name": "owner",
  11179. "in": "path",
  11180. "required": true
  11181. },
  11182. {
  11183. "type": "string",
  11184. "description": "name of the repo",
  11185. "name": "repo",
  11186. "in": "path",
  11187. "required": true
  11188. },
  11189. {
  11190. "type": "string",
  11191. "description": "optional filter by user (available for issue managers)",
  11192. "name": "user",
  11193. "in": "query"
  11194. },
  11195. {
  11196. "type": "string",
  11197. "format": "date-time",
  11198. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  11199. "name": "since",
  11200. "in": "query"
  11201. },
  11202. {
  11203. "type": "string",
  11204. "format": "date-time",
  11205. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  11206. "name": "before",
  11207. "in": "query"
  11208. },
  11209. {
  11210. "type": "integer",
  11211. "description": "page number of results to return (1-based)",
  11212. "name": "page",
  11213. "in": "query"
  11214. },
  11215. {
  11216. "type": "integer",
  11217. "description": "page size of results",
  11218. "name": "limit",
  11219. "in": "query"
  11220. }
  11221. ],
  11222. "responses": {
  11223. "200": {
  11224. "$ref": "#/responses/TrackedTimeList"
  11225. },
  11226. "400": {
  11227. "$ref": "#/responses/error"
  11228. },
  11229. "403": {
  11230. "$ref": "#/responses/forbidden"
  11231. }
  11232. }
  11233. }
  11234. },
  11235. "/repos/{owner}/{repo}/times/{user}": {
  11236. "get": {
  11237. "produces": [
  11238. "application/json"
  11239. ],
  11240. "tags": [
  11241. "repository"
  11242. ],
  11243. "summary": "List a user's tracked times in a repo",
  11244. "operationId": "userTrackedTimes",
  11245. "deprecated": true,
  11246. "parameters": [
  11247. {
  11248. "type": "string",
  11249. "description": "owner of the repo",
  11250. "name": "owner",
  11251. "in": "path",
  11252. "required": true
  11253. },
  11254. {
  11255. "type": "string",
  11256. "description": "name of the repo",
  11257. "name": "repo",
  11258. "in": "path",
  11259. "required": true
  11260. },
  11261. {
  11262. "type": "string",
  11263. "description": "username of user",
  11264. "name": "user",
  11265. "in": "path",
  11266. "required": true
  11267. }
  11268. ],
  11269. "responses": {
  11270. "200": {
  11271. "$ref": "#/responses/TrackedTimeList"
  11272. },
  11273. "400": {
  11274. "$ref": "#/responses/error"
  11275. },
  11276. "403": {
  11277. "$ref": "#/responses/forbidden"
  11278. }
  11279. }
  11280. }
  11281. },
  11282. "/repos/{owner}/{repo}/topics": {
  11283. "get": {
  11284. "produces": [
  11285. "application/json"
  11286. ],
  11287. "tags": [
  11288. "repository"
  11289. ],
  11290. "summary": "Get list of topics that a repository has",
  11291. "operationId": "repoListTopics",
  11292. "parameters": [
  11293. {
  11294. "type": "string",
  11295. "description": "owner of the repo",
  11296. "name": "owner",
  11297. "in": "path",
  11298. "required": true
  11299. },
  11300. {
  11301. "type": "string",
  11302. "description": "name of the repo",
  11303. "name": "repo",
  11304. "in": "path",
  11305. "required": true
  11306. },
  11307. {
  11308. "type": "integer",
  11309. "description": "page number of results to return (1-based)",
  11310. "name": "page",
  11311. "in": "query"
  11312. },
  11313. {
  11314. "type": "integer",
  11315. "description": "page size of results",
  11316. "name": "limit",
  11317. "in": "query"
  11318. }
  11319. ],
  11320. "responses": {
  11321. "200": {
  11322. "$ref": "#/responses/TopicNames"
  11323. }
  11324. }
  11325. },
  11326. "put": {
  11327. "produces": [
  11328. "application/json"
  11329. ],
  11330. "tags": [
  11331. "repository"
  11332. ],
  11333. "summary": "Replace list of topics for a repository",
  11334. "operationId": "repoUpdateTopics",
  11335. "parameters": [
  11336. {
  11337. "type": "string",
  11338. "description": "owner of the repo",
  11339. "name": "owner",
  11340. "in": "path",
  11341. "required": true
  11342. },
  11343. {
  11344. "type": "string",
  11345. "description": "name of the repo",
  11346. "name": "repo",
  11347. "in": "path",
  11348. "required": true
  11349. },
  11350. {
  11351. "name": "body",
  11352. "in": "body",
  11353. "schema": {
  11354. "$ref": "#/definitions/RepoTopicOptions"
  11355. }
  11356. }
  11357. ],
  11358. "responses": {
  11359. "204": {
  11360. "$ref": "#/responses/empty"
  11361. },
  11362. "422": {
  11363. "$ref": "#/responses/invalidTopicsError"
  11364. }
  11365. }
  11366. }
  11367. },
  11368. "/repos/{owner}/{repo}/topics/{topic}": {
  11369. "put": {
  11370. "produces": [
  11371. "application/json"
  11372. ],
  11373. "tags": [
  11374. "repository"
  11375. ],
  11376. "summary": "Add a topic to a repository",
  11377. "operationId": "repoAddTopic",
  11378. "parameters": [
  11379. {
  11380. "type": "string",
  11381. "description": "owner of the repo",
  11382. "name": "owner",
  11383. "in": "path",
  11384. "required": true
  11385. },
  11386. {
  11387. "type": "string",
  11388. "description": "name of the repo",
  11389. "name": "repo",
  11390. "in": "path",
  11391. "required": true
  11392. },
  11393. {
  11394. "type": "string",
  11395. "description": "name of the topic to add",
  11396. "name": "topic",
  11397. "in": "path",
  11398. "required": true
  11399. }
  11400. ],
  11401. "responses": {
  11402. "204": {
  11403. "$ref": "#/responses/empty"
  11404. },
  11405. "422": {
  11406. "$ref": "#/responses/invalidTopicsError"
  11407. }
  11408. }
  11409. },
  11410. "delete": {
  11411. "produces": [
  11412. "application/json"
  11413. ],
  11414. "tags": [
  11415. "repository"
  11416. ],
  11417. "summary": "Delete a topic from a repository",
  11418. "operationId": "repoDeleteTopic",
  11419. "parameters": [
  11420. {
  11421. "type": "string",
  11422. "description": "owner of the repo",
  11423. "name": "owner",
  11424. "in": "path",
  11425. "required": true
  11426. },
  11427. {
  11428. "type": "string",
  11429. "description": "name of the repo",
  11430. "name": "repo",
  11431. "in": "path",
  11432. "required": true
  11433. },
  11434. {
  11435. "type": "string",
  11436. "description": "name of the topic to delete",
  11437. "name": "topic",
  11438. "in": "path",
  11439. "required": true
  11440. }
  11441. ],
  11442. "responses": {
  11443. "204": {
  11444. "$ref": "#/responses/empty"
  11445. },
  11446. "422": {
  11447. "$ref": "#/responses/invalidTopicsError"
  11448. }
  11449. }
  11450. }
  11451. },
  11452. "/repos/{owner}/{repo}/transfer": {
  11453. "post": {
  11454. "produces": [
  11455. "application/json"
  11456. ],
  11457. "tags": [
  11458. "repository"
  11459. ],
  11460. "summary": "Transfer a repo ownership",
  11461. "operationId": "repoTransfer",
  11462. "parameters": [
  11463. {
  11464. "type": "string",
  11465. "description": "owner of the repo to transfer",
  11466. "name": "owner",
  11467. "in": "path",
  11468. "required": true
  11469. },
  11470. {
  11471. "type": "string",
  11472. "description": "name of the repo to transfer",
  11473. "name": "repo",
  11474. "in": "path",
  11475. "required": true
  11476. },
  11477. {
  11478. "description": "Transfer Options",
  11479. "name": "body",
  11480. "in": "body",
  11481. "required": true,
  11482. "schema": {
  11483. "$ref": "#/definitions/TransferRepoOption"
  11484. }
  11485. }
  11486. ],
  11487. "responses": {
  11488. "202": {
  11489. "$ref": "#/responses/Repository"
  11490. },
  11491. "403": {
  11492. "$ref": "#/responses/forbidden"
  11493. },
  11494. "404": {
  11495. "$ref": "#/responses/notFound"
  11496. },
  11497. "422": {
  11498. "$ref": "#/responses/validationError"
  11499. }
  11500. }
  11501. }
  11502. },
  11503. "/repos/{owner}/{repo}/transfer/accept": {
  11504. "post": {
  11505. "produces": [
  11506. "application/json"
  11507. ],
  11508. "tags": [
  11509. "repository"
  11510. ],
  11511. "summary": "Accept a repo transfer",
  11512. "operationId": "acceptRepoTransfer",
  11513. "parameters": [
  11514. {
  11515. "type": "string",
  11516. "description": "owner of the repo to transfer",
  11517. "name": "owner",
  11518. "in": "path",
  11519. "required": true
  11520. },
  11521. {
  11522. "type": "string",
  11523. "description": "name of the repo to transfer",
  11524. "name": "repo",
  11525. "in": "path",
  11526. "required": true
  11527. }
  11528. ],
  11529. "responses": {
  11530. "202": {
  11531. "$ref": "#/responses/Repository"
  11532. },
  11533. "403": {
  11534. "$ref": "#/responses/forbidden"
  11535. },
  11536. "404": {
  11537. "$ref": "#/responses/notFound"
  11538. }
  11539. }
  11540. }
  11541. },
  11542. "/repos/{owner}/{repo}/transfer/reject": {
  11543. "post": {
  11544. "produces": [
  11545. "application/json"
  11546. ],
  11547. "tags": [
  11548. "repository"
  11549. ],
  11550. "summary": "Reject a repo transfer",
  11551. "operationId": "rejectRepoTransfer",
  11552. "parameters": [
  11553. {
  11554. "type": "string",
  11555. "description": "owner of the repo to transfer",
  11556. "name": "owner",
  11557. "in": "path",
  11558. "required": true
  11559. },
  11560. {
  11561. "type": "string",
  11562. "description": "name of the repo to transfer",
  11563. "name": "repo",
  11564. "in": "path",
  11565. "required": true
  11566. }
  11567. ],
  11568. "responses": {
  11569. "200": {
  11570. "$ref": "#/responses/Repository"
  11571. },
  11572. "403": {
  11573. "$ref": "#/responses/forbidden"
  11574. },
  11575. "404": {
  11576. "$ref": "#/responses/notFound"
  11577. }
  11578. }
  11579. }
  11580. },
  11581. "/repos/{owner}/{repo}/wiki/new": {
  11582. "post": {
  11583. "consumes": [
  11584. "application/json"
  11585. ],
  11586. "tags": [
  11587. "repository"
  11588. ],
  11589. "summary": "Create a wiki page",
  11590. "operationId": "repoCreateWikiPage",
  11591. "parameters": [
  11592. {
  11593. "type": "string",
  11594. "description": "owner of the repo",
  11595. "name": "owner",
  11596. "in": "path",
  11597. "required": true
  11598. },
  11599. {
  11600. "type": "string",
  11601. "description": "name of the repo",
  11602. "name": "repo",
  11603. "in": "path",
  11604. "required": true
  11605. },
  11606. {
  11607. "name": "body",
  11608. "in": "body",
  11609. "schema": {
  11610. "$ref": "#/definitions/CreateWikiPageOptions"
  11611. }
  11612. }
  11613. ],
  11614. "responses": {
  11615. "201": {
  11616. "$ref": "#/responses/WikiPage"
  11617. },
  11618. "400": {
  11619. "$ref": "#/responses/error"
  11620. },
  11621. "403": {
  11622. "$ref": "#/responses/forbidden"
  11623. }
  11624. }
  11625. }
  11626. },
  11627. "/repos/{owner}/{repo}/wiki/page/{pageName}": {
  11628. "get": {
  11629. "produces": [
  11630. "application/json"
  11631. ],
  11632. "tags": [
  11633. "repository"
  11634. ],
  11635. "summary": "Get a wiki page",
  11636. "operationId": "repoGetWikiPage",
  11637. "parameters": [
  11638. {
  11639. "type": "string",
  11640. "description": "owner of the repo",
  11641. "name": "owner",
  11642. "in": "path",
  11643. "required": true
  11644. },
  11645. {
  11646. "type": "string",
  11647. "description": "name of the repo",
  11648. "name": "repo",
  11649. "in": "path",
  11650. "required": true
  11651. },
  11652. {
  11653. "type": "string",
  11654. "description": "name of the page",
  11655. "name": "pageName",
  11656. "in": "path",
  11657. "required": true
  11658. }
  11659. ],
  11660. "responses": {
  11661. "200": {
  11662. "$ref": "#/responses/WikiPage"
  11663. },
  11664. "404": {
  11665. "$ref": "#/responses/notFound"
  11666. }
  11667. }
  11668. },
  11669. "delete": {
  11670. "tags": [
  11671. "repository"
  11672. ],
  11673. "summary": "Delete a wiki page",
  11674. "operationId": "repoDeleteWikiPage",
  11675. "parameters": [
  11676. {
  11677. "type": "string",
  11678. "description": "owner of the repo",
  11679. "name": "owner",
  11680. "in": "path",
  11681. "required": true
  11682. },
  11683. {
  11684. "type": "string",
  11685. "description": "name of the repo",
  11686. "name": "repo",
  11687. "in": "path",
  11688. "required": true
  11689. },
  11690. {
  11691. "type": "string",
  11692. "description": "name of the page",
  11693. "name": "pageName",
  11694. "in": "path",
  11695. "required": true
  11696. }
  11697. ],
  11698. "responses": {
  11699. "204": {
  11700. "$ref": "#/responses/empty"
  11701. },
  11702. "403": {
  11703. "$ref": "#/responses/forbidden"
  11704. },
  11705. "404": {
  11706. "$ref": "#/responses/notFound"
  11707. }
  11708. }
  11709. },
  11710. "patch": {
  11711. "consumes": [
  11712. "application/json"
  11713. ],
  11714. "tags": [
  11715. "repository"
  11716. ],
  11717. "summary": "Edit a wiki page",
  11718. "operationId": "repoEditWikiPage",
  11719. "parameters": [
  11720. {
  11721. "type": "string",
  11722. "description": "owner of the repo",
  11723. "name": "owner",
  11724. "in": "path",
  11725. "required": true
  11726. },
  11727. {
  11728. "type": "string",
  11729. "description": "name of the repo",
  11730. "name": "repo",
  11731. "in": "path",
  11732. "required": true
  11733. },
  11734. {
  11735. "type": "string",
  11736. "description": "name of the page",
  11737. "name": "pageName",
  11738. "in": "path",
  11739. "required": true
  11740. },
  11741. {
  11742. "name": "body",
  11743. "in": "body",
  11744. "schema": {
  11745. "$ref": "#/definitions/CreateWikiPageOptions"
  11746. }
  11747. }
  11748. ],
  11749. "responses": {
  11750. "200": {
  11751. "$ref": "#/responses/WikiPage"
  11752. },
  11753. "400": {
  11754. "$ref": "#/responses/error"
  11755. },
  11756. "403": {
  11757. "$ref": "#/responses/forbidden"
  11758. }
  11759. }
  11760. }
  11761. },
  11762. "/repos/{owner}/{repo}/wiki/pages": {
  11763. "get": {
  11764. "produces": [
  11765. "application/json"
  11766. ],
  11767. "tags": [
  11768. "repository"
  11769. ],
  11770. "summary": "Get all wiki pages",
  11771. "operationId": "repoGetWikiPages",
  11772. "parameters": [
  11773. {
  11774. "type": "string",
  11775. "description": "owner of the repo",
  11776. "name": "owner",
  11777. "in": "path",
  11778. "required": true
  11779. },
  11780. {
  11781. "type": "string",
  11782. "description": "name of the repo",
  11783. "name": "repo",
  11784. "in": "path",
  11785. "required": true
  11786. },
  11787. {
  11788. "type": "integer",
  11789. "description": "page number of results to return (1-based)",
  11790. "name": "page",
  11791. "in": "query"
  11792. },
  11793. {
  11794. "type": "integer",
  11795. "description": "page size of results",
  11796. "name": "limit",
  11797. "in": "query"
  11798. }
  11799. ],
  11800. "responses": {
  11801. "200": {
  11802. "$ref": "#/responses/WikiPageList"
  11803. },
  11804. "404": {
  11805. "$ref": "#/responses/notFound"
  11806. }
  11807. }
  11808. }
  11809. },
  11810. "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
  11811. "get": {
  11812. "produces": [
  11813. "application/json"
  11814. ],
  11815. "tags": [
  11816. "repository"
  11817. ],
  11818. "summary": "Get revisions of a wiki page",
  11819. "operationId": "repoGetWikiPageRevisions",
  11820. "parameters": [
  11821. {
  11822. "type": "string",
  11823. "description": "owner of the repo",
  11824. "name": "owner",
  11825. "in": "path",
  11826. "required": true
  11827. },
  11828. {
  11829. "type": "string",
  11830. "description": "name of the repo",
  11831. "name": "repo",
  11832. "in": "path",
  11833. "required": true
  11834. },
  11835. {
  11836. "type": "string",
  11837. "description": "name of the page",
  11838. "name": "pageName",
  11839. "in": "path",
  11840. "required": true
  11841. },
  11842. {
  11843. "type": "integer",
  11844. "description": "page number of results to return (1-based)",
  11845. "name": "page",
  11846. "in": "query"
  11847. }
  11848. ],
  11849. "responses": {
  11850. "200": {
  11851. "$ref": "#/responses/WikiCommitList"
  11852. },
  11853. "404": {
  11854. "$ref": "#/responses/notFound"
  11855. }
  11856. }
  11857. }
  11858. },
  11859. "/repos/{template_owner}/{template_repo}/generate": {
  11860. "post": {
  11861. "consumes": [
  11862. "application/json"
  11863. ],
  11864. "produces": [
  11865. "application/json"
  11866. ],
  11867. "tags": [
  11868. "repository"
  11869. ],
  11870. "summary": "Create a repository using a template",
  11871. "operationId": "generateRepo",
  11872. "parameters": [
  11873. {
  11874. "type": "string",
  11875. "description": "name of the template repository owner",
  11876. "name": "template_owner",
  11877. "in": "path",
  11878. "required": true
  11879. },
  11880. {
  11881. "type": "string",
  11882. "description": "name of the template repository",
  11883. "name": "template_repo",
  11884. "in": "path",
  11885. "required": true
  11886. },
  11887. {
  11888. "name": "body",
  11889. "in": "body",
  11890. "schema": {
  11891. "$ref": "#/definitions/GenerateRepoOption"
  11892. }
  11893. }
  11894. ],
  11895. "responses": {
  11896. "201": {
  11897. "$ref": "#/responses/Repository"
  11898. },
  11899. "403": {
  11900. "$ref": "#/responses/forbidden"
  11901. },
  11902. "404": {
  11903. "$ref": "#/responses/notFound"
  11904. },
  11905. "409": {
  11906. "description": "The repository with the same name already exists."
  11907. },
  11908. "422": {
  11909. "$ref": "#/responses/validationError"
  11910. }
  11911. }
  11912. }
  11913. },
  11914. "/repositories/{id}": {
  11915. "get": {
  11916. "produces": [
  11917. "application/json"
  11918. ],
  11919. "tags": [
  11920. "repository"
  11921. ],
  11922. "summary": "Get a repository by id",
  11923. "operationId": "repoGetByID",
  11924. "parameters": [
  11925. {
  11926. "type": "integer",
  11927. "format": "int64",
  11928. "description": "id of the repo to get",
  11929. "name": "id",
  11930. "in": "path",
  11931. "required": true
  11932. }
  11933. ],
  11934. "responses": {
  11935. "200": {
  11936. "$ref": "#/responses/Repository"
  11937. }
  11938. }
  11939. }
  11940. },
  11941. "/settings/api": {
  11942. "get": {
  11943. "produces": [
  11944. "application/json"
  11945. ],
  11946. "tags": [
  11947. "settings"
  11948. ],
  11949. "summary": "Get instance's global settings for api",
  11950. "operationId": "getGeneralAPISettings",
  11951. "responses": {
  11952. "200": {
  11953. "$ref": "#/responses/GeneralAPISettings"
  11954. }
  11955. }
  11956. }
  11957. },
  11958. "/settings/attachment": {
  11959. "get": {
  11960. "produces": [
  11961. "application/json"
  11962. ],
  11963. "tags": [
  11964. "settings"
  11965. ],
  11966. "summary": "Get instance's global settings for Attachment",
  11967. "operationId": "getGeneralAttachmentSettings",
  11968. "responses": {
  11969. "200": {
  11970. "$ref": "#/responses/GeneralAttachmentSettings"
  11971. }
  11972. }
  11973. }
  11974. },
  11975. "/settings/repository": {
  11976. "get": {
  11977. "produces": [
  11978. "application/json"
  11979. ],
  11980. "tags": [
  11981. "settings"
  11982. ],
  11983. "summary": "Get instance's global settings for repositories",
  11984. "operationId": "getGeneralRepositorySettings",
  11985. "responses": {
  11986. "200": {
  11987. "$ref": "#/responses/GeneralRepoSettings"
  11988. }
  11989. }
  11990. }
  11991. },
  11992. "/settings/ui": {
  11993. "get": {
  11994. "produces": [
  11995. "application/json"
  11996. ],
  11997. "tags": [
  11998. "settings"
  11999. ],
  12000. "summary": "Get instance's global settings for ui",
  12001. "operationId": "getGeneralUISettings",
  12002. "responses": {
  12003. "200": {
  12004. "$ref": "#/responses/GeneralUISettings"
  12005. }
  12006. }
  12007. }
  12008. },
  12009. "/signing-key.gpg": {
  12010. "get": {
  12011. "produces": [
  12012. "text/plain"
  12013. ],
  12014. "tags": [
  12015. "miscellaneous"
  12016. ],
  12017. "summary": "Get default signing-key.gpg",
  12018. "operationId": "getSigningKey",
  12019. "responses": {
  12020. "200": {
  12021. "description": "GPG armored public key",
  12022. "schema": {
  12023. "type": "string"
  12024. }
  12025. }
  12026. }
  12027. }
  12028. },
  12029. "/teams/{id}": {
  12030. "get": {
  12031. "produces": [
  12032. "application/json"
  12033. ],
  12034. "tags": [
  12035. "organization"
  12036. ],
  12037. "summary": "Get a team",
  12038. "operationId": "orgGetTeam",
  12039. "parameters": [
  12040. {
  12041. "type": "integer",
  12042. "format": "int64",
  12043. "description": "id of the team to get",
  12044. "name": "id",
  12045. "in": "path",
  12046. "required": true
  12047. }
  12048. ],
  12049. "responses": {
  12050. "200": {
  12051. "$ref": "#/responses/Team"
  12052. }
  12053. }
  12054. },
  12055. "delete": {
  12056. "tags": [
  12057. "organization"
  12058. ],
  12059. "summary": "Delete a team",
  12060. "operationId": "orgDeleteTeam",
  12061. "parameters": [
  12062. {
  12063. "type": "integer",
  12064. "format": "int64",
  12065. "description": "id of the team to delete",
  12066. "name": "id",
  12067. "in": "path",
  12068. "required": true
  12069. }
  12070. ],
  12071. "responses": {
  12072. "204": {
  12073. "description": "team deleted"
  12074. }
  12075. }
  12076. },
  12077. "patch": {
  12078. "consumes": [
  12079. "application/json"
  12080. ],
  12081. "produces": [
  12082. "application/json"
  12083. ],
  12084. "tags": [
  12085. "organization"
  12086. ],
  12087. "summary": "Edit a team",
  12088. "operationId": "orgEditTeam",
  12089. "parameters": [
  12090. {
  12091. "type": "integer",
  12092. "description": "id of the team to edit",
  12093. "name": "id",
  12094. "in": "path",
  12095. "required": true
  12096. },
  12097. {
  12098. "name": "body",
  12099. "in": "body",
  12100. "schema": {
  12101. "$ref": "#/definitions/EditTeamOption"
  12102. }
  12103. }
  12104. ],
  12105. "responses": {
  12106. "200": {
  12107. "$ref": "#/responses/Team"
  12108. }
  12109. }
  12110. }
  12111. },
  12112. "/teams/{id}/members": {
  12113. "get": {
  12114. "produces": [
  12115. "application/json"
  12116. ],
  12117. "tags": [
  12118. "organization"
  12119. ],
  12120. "summary": "List a team's members",
  12121. "operationId": "orgListTeamMembers",
  12122. "parameters": [
  12123. {
  12124. "type": "integer",
  12125. "format": "int64",
  12126. "description": "id of the team",
  12127. "name": "id",
  12128. "in": "path",
  12129. "required": true
  12130. },
  12131. {
  12132. "type": "integer",
  12133. "description": "page number of results to return (1-based)",
  12134. "name": "page",
  12135. "in": "query"
  12136. },
  12137. {
  12138. "type": "integer",
  12139. "description": "page size of results",
  12140. "name": "limit",
  12141. "in": "query"
  12142. }
  12143. ],
  12144. "responses": {
  12145. "200": {
  12146. "$ref": "#/responses/UserList"
  12147. }
  12148. }
  12149. }
  12150. },
  12151. "/teams/{id}/members/{username}": {
  12152. "get": {
  12153. "produces": [
  12154. "application/json"
  12155. ],
  12156. "tags": [
  12157. "organization"
  12158. ],
  12159. "summary": "List a particular member of team",
  12160. "operationId": "orgListTeamMember",
  12161. "parameters": [
  12162. {
  12163. "type": "integer",
  12164. "format": "int64",
  12165. "description": "id of the team",
  12166. "name": "id",
  12167. "in": "path",
  12168. "required": true
  12169. },
  12170. {
  12171. "type": "string",
  12172. "description": "username of the member to list",
  12173. "name": "username",
  12174. "in": "path",
  12175. "required": true
  12176. }
  12177. ],
  12178. "responses": {
  12179. "200": {
  12180. "$ref": "#/responses/User"
  12181. },
  12182. "404": {
  12183. "$ref": "#/responses/notFound"
  12184. }
  12185. }
  12186. },
  12187. "put": {
  12188. "produces": [
  12189. "application/json"
  12190. ],
  12191. "tags": [
  12192. "organization"
  12193. ],
  12194. "summary": "Add a team member",
  12195. "operationId": "orgAddTeamMember",
  12196. "parameters": [
  12197. {
  12198. "type": "integer",
  12199. "format": "int64",
  12200. "description": "id of the team",
  12201. "name": "id",
  12202. "in": "path",
  12203. "required": true
  12204. },
  12205. {
  12206. "type": "string",
  12207. "description": "username of the user to add",
  12208. "name": "username",
  12209. "in": "path",
  12210. "required": true
  12211. }
  12212. ],
  12213. "responses": {
  12214. "204": {
  12215. "$ref": "#/responses/empty"
  12216. },
  12217. "404": {
  12218. "$ref": "#/responses/notFound"
  12219. }
  12220. }
  12221. },
  12222. "delete": {
  12223. "produces": [
  12224. "application/json"
  12225. ],
  12226. "tags": [
  12227. "organization"
  12228. ],
  12229. "summary": "Remove a team member",
  12230. "operationId": "orgRemoveTeamMember",
  12231. "parameters": [
  12232. {
  12233. "type": "integer",
  12234. "format": "int64",
  12235. "description": "id of the team",
  12236. "name": "id",
  12237. "in": "path",
  12238. "required": true
  12239. },
  12240. {
  12241. "type": "string",
  12242. "description": "username of the user to remove",
  12243. "name": "username",
  12244. "in": "path",
  12245. "required": true
  12246. }
  12247. ],
  12248. "responses": {
  12249. "204": {
  12250. "$ref": "#/responses/empty"
  12251. },
  12252. "404": {
  12253. "$ref": "#/responses/notFound"
  12254. }
  12255. }
  12256. }
  12257. },
  12258. "/teams/{id}/repos": {
  12259. "get": {
  12260. "produces": [
  12261. "application/json"
  12262. ],
  12263. "tags": [
  12264. "organization"
  12265. ],
  12266. "summary": "List a team's repos",
  12267. "operationId": "orgListTeamRepos",
  12268. "parameters": [
  12269. {
  12270. "type": "integer",
  12271. "format": "int64",
  12272. "description": "id of the team",
  12273. "name": "id",
  12274. "in": "path",
  12275. "required": true
  12276. },
  12277. {
  12278. "type": "integer",
  12279. "description": "page number of results to return (1-based)",
  12280. "name": "page",
  12281. "in": "query"
  12282. },
  12283. {
  12284. "type": "integer",
  12285. "description": "page size of results",
  12286. "name": "limit",
  12287. "in": "query"
  12288. }
  12289. ],
  12290. "responses": {
  12291. "200": {
  12292. "$ref": "#/responses/RepositoryList"
  12293. }
  12294. }
  12295. }
  12296. },
  12297. "/teams/{id}/repos/{org}/{repo}": {
  12298. "get": {
  12299. "produces": [
  12300. "application/json"
  12301. ],
  12302. "tags": [
  12303. "organization"
  12304. ],
  12305. "summary": "List a particular repo of team",
  12306. "operationId": "orgListTeamRepo",
  12307. "parameters": [
  12308. {
  12309. "type": "integer",
  12310. "format": "int64",
  12311. "description": "id of the team",
  12312. "name": "id",
  12313. "in": "path",
  12314. "required": true
  12315. },
  12316. {
  12317. "type": "string",
  12318. "description": "organization that owns the repo to list",
  12319. "name": "org",
  12320. "in": "path",
  12321. "required": true
  12322. },
  12323. {
  12324. "type": "string",
  12325. "description": "name of the repo to list",
  12326. "name": "repo",
  12327. "in": "path",
  12328. "required": true
  12329. }
  12330. ],
  12331. "responses": {
  12332. "200": {
  12333. "$ref": "#/responses/Repository"
  12334. },
  12335. "404": {
  12336. "$ref": "#/responses/notFound"
  12337. }
  12338. }
  12339. },
  12340. "put": {
  12341. "produces": [
  12342. "application/json"
  12343. ],
  12344. "tags": [
  12345. "organization"
  12346. ],
  12347. "summary": "Add a repository to a team",
  12348. "operationId": "orgAddTeamRepository",
  12349. "parameters": [
  12350. {
  12351. "type": "integer",
  12352. "format": "int64",
  12353. "description": "id of the team",
  12354. "name": "id",
  12355. "in": "path",
  12356. "required": true
  12357. },
  12358. {
  12359. "type": "string",
  12360. "description": "organization that owns the repo to add",
  12361. "name": "org",
  12362. "in": "path",
  12363. "required": true
  12364. },
  12365. {
  12366. "type": "string",
  12367. "description": "name of the repo to add",
  12368. "name": "repo",
  12369. "in": "path",
  12370. "required": true
  12371. }
  12372. ],
  12373. "responses": {
  12374. "204": {
  12375. "$ref": "#/responses/empty"
  12376. },
  12377. "403": {
  12378. "$ref": "#/responses/forbidden"
  12379. }
  12380. }
  12381. },
  12382. "delete": {
  12383. "description": "This does not delete the repository, it only removes the repository from the team.",
  12384. "produces": [
  12385. "application/json"
  12386. ],
  12387. "tags": [
  12388. "organization"
  12389. ],
  12390. "summary": "Remove a repository from a team",
  12391. "operationId": "orgRemoveTeamRepository",
  12392. "parameters": [
  12393. {
  12394. "type": "integer",
  12395. "format": "int64",
  12396. "description": "id of the team",
  12397. "name": "id",
  12398. "in": "path",
  12399. "required": true
  12400. },
  12401. {
  12402. "type": "string",
  12403. "description": "organization that owns the repo to remove",
  12404. "name": "org",
  12405. "in": "path",
  12406. "required": true
  12407. },
  12408. {
  12409. "type": "string",
  12410. "description": "name of the repo to remove",
  12411. "name": "repo",
  12412. "in": "path",
  12413. "required": true
  12414. }
  12415. ],
  12416. "responses": {
  12417. "204": {
  12418. "$ref": "#/responses/empty"
  12419. },
  12420. "403": {
  12421. "$ref": "#/responses/forbidden"
  12422. }
  12423. }
  12424. }
  12425. },
  12426. "/topics/search": {
  12427. "get": {
  12428. "produces": [
  12429. "application/json"
  12430. ],
  12431. "tags": [
  12432. "repository"
  12433. ],
  12434. "summary": "search topics via keyword",
  12435. "operationId": "topicSearch",
  12436. "parameters": [
  12437. {
  12438. "type": "string",
  12439. "description": "keywords to search",
  12440. "name": "q",
  12441. "in": "query",
  12442. "required": true
  12443. },
  12444. {
  12445. "type": "integer",
  12446. "description": "page number of results to return (1-based)",
  12447. "name": "page",
  12448. "in": "query"
  12449. },
  12450. {
  12451. "type": "integer",
  12452. "description": "page size of results",
  12453. "name": "limit",
  12454. "in": "query"
  12455. }
  12456. ],
  12457. "responses": {
  12458. "200": {
  12459. "$ref": "#/responses/TopicListResponse"
  12460. },
  12461. "403": {
  12462. "$ref": "#/responses/forbidden"
  12463. }
  12464. }
  12465. }
  12466. },
  12467. "/user": {
  12468. "get": {
  12469. "produces": [
  12470. "application/json"
  12471. ],
  12472. "tags": [
  12473. "user"
  12474. ],
  12475. "summary": "Get the authenticated user",
  12476. "operationId": "userGetCurrent",
  12477. "responses": {
  12478. "200": {
  12479. "$ref": "#/responses/User"
  12480. }
  12481. }
  12482. }
  12483. },
  12484. "/user/applications/oauth2": {
  12485. "get": {
  12486. "produces": [
  12487. "application/json"
  12488. ],
  12489. "tags": [
  12490. "user"
  12491. ],
  12492. "summary": "List the authenticated user's oauth2 applications",
  12493. "operationId": "userGetOauth2Application",
  12494. "parameters": [
  12495. {
  12496. "type": "integer",
  12497. "description": "page number of results to return (1-based)",
  12498. "name": "page",
  12499. "in": "query"
  12500. },
  12501. {
  12502. "type": "integer",
  12503. "description": "page size of results",
  12504. "name": "limit",
  12505. "in": "query"
  12506. }
  12507. ],
  12508. "responses": {
  12509. "200": {
  12510. "$ref": "#/responses/OAuth2ApplicationList"
  12511. }
  12512. }
  12513. },
  12514. "post": {
  12515. "produces": [
  12516. "application/json"
  12517. ],
  12518. "tags": [
  12519. "user"
  12520. ],
  12521. "summary": "creates a new OAuth2 application",
  12522. "operationId": "userCreateOAuth2Application",
  12523. "parameters": [
  12524. {
  12525. "name": "body",
  12526. "in": "body",
  12527. "required": true,
  12528. "schema": {
  12529. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  12530. }
  12531. }
  12532. ],
  12533. "responses": {
  12534. "201": {
  12535. "$ref": "#/responses/OAuth2Application"
  12536. },
  12537. "400": {
  12538. "$ref": "#/responses/error"
  12539. }
  12540. }
  12541. }
  12542. },
  12543. "/user/applications/oauth2/{id}": {
  12544. "get": {
  12545. "produces": [
  12546. "application/json"
  12547. ],
  12548. "tags": [
  12549. "user"
  12550. ],
  12551. "summary": "get an OAuth2 Application",
  12552. "operationId": "userGetOAuth2Application",
  12553. "parameters": [
  12554. {
  12555. "type": "integer",
  12556. "format": "int64",
  12557. "description": "Application ID to be found",
  12558. "name": "id",
  12559. "in": "path",
  12560. "required": true
  12561. }
  12562. ],
  12563. "responses": {
  12564. "200": {
  12565. "$ref": "#/responses/OAuth2Application"
  12566. },
  12567. "404": {
  12568. "$ref": "#/responses/notFound"
  12569. }
  12570. }
  12571. },
  12572. "delete": {
  12573. "produces": [
  12574. "application/json"
  12575. ],
  12576. "tags": [
  12577. "user"
  12578. ],
  12579. "summary": "delete an OAuth2 Application",
  12580. "operationId": "userDeleteOAuth2Application",
  12581. "parameters": [
  12582. {
  12583. "type": "integer",
  12584. "format": "int64",
  12585. "description": "token to be deleted",
  12586. "name": "id",
  12587. "in": "path",
  12588. "required": true
  12589. }
  12590. ],
  12591. "responses": {
  12592. "204": {
  12593. "$ref": "#/responses/empty"
  12594. },
  12595. "404": {
  12596. "$ref": "#/responses/notFound"
  12597. }
  12598. }
  12599. },
  12600. "patch": {
  12601. "produces": [
  12602. "application/json"
  12603. ],
  12604. "tags": [
  12605. "user"
  12606. ],
  12607. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  12608. "operationId": "userUpdateOAuth2Application",
  12609. "parameters": [
  12610. {
  12611. "type": "integer",
  12612. "format": "int64",
  12613. "description": "application to be updated",
  12614. "name": "id",
  12615. "in": "path",
  12616. "required": true
  12617. },
  12618. {
  12619. "name": "body",
  12620. "in": "body",
  12621. "required": true,
  12622. "schema": {
  12623. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  12624. }
  12625. }
  12626. ],
  12627. "responses": {
  12628. "200": {
  12629. "$ref": "#/responses/OAuth2Application"
  12630. },
  12631. "404": {
  12632. "$ref": "#/responses/notFound"
  12633. }
  12634. }
  12635. }
  12636. },
  12637. "/user/emails": {
  12638. "get": {
  12639. "produces": [
  12640. "application/json"
  12641. ],
  12642. "tags": [
  12643. "user"
  12644. ],
  12645. "summary": "List the authenticated user's email addresses",
  12646. "operationId": "userListEmails",
  12647. "responses": {
  12648. "200": {
  12649. "$ref": "#/responses/EmailList"
  12650. }
  12651. }
  12652. },
  12653. "post": {
  12654. "produces": [
  12655. "application/json"
  12656. ],
  12657. "tags": [
  12658. "user"
  12659. ],
  12660. "summary": "Add email addresses",
  12661. "operationId": "userAddEmail",
  12662. "parameters": [
  12663. {
  12664. "name": "body",
  12665. "in": "body",
  12666. "schema": {
  12667. "$ref": "#/definitions/CreateEmailOption"
  12668. }
  12669. }
  12670. ],
  12671. "responses": {
  12672. "201": {
  12673. "$ref": "#/responses/EmailList"
  12674. },
  12675. "422": {
  12676. "$ref": "#/responses/validationError"
  12677. }
  12678. }
  12679. },
  12680. "delete": {
  12681. "produces": [
  12682. "application/json"
  12683. ],
  12684. "tags": [
  12685. "user"
  12686. ],
  12687. "summary": "Delete email addresses",
  12688. "operationId": "userDeleteEmail",
  12689. "parameters": [
  12690. {
  12691. "name": "body",
  12692. "in": "body",
  12693. "schema": {
  12694. "$ref": "#/definitions/DeleteEmailOption"
  12695. }
  12696. }
  12697. ],
  12698. "responses": {
  12699. "204": {
  12700. "$ref": "#/responses/empty"
  12701. },
  12702. "404": {
  12703. "$ref": "#/responses/notFound"
  12704. }
  12705. }
  12706. }
  12707. },
  12708. "/user/followers": {
  12709. "get": {
  12710. "produces": [
  12711. "application/json"
  12712. ],
  12713. "tags": [
  12714. "user"
  12715. ],
  12716. "summary": "List the authenticated user's followers",
  12717. "operationId": "userCurrentListFollowers",
  12718. "parameters": [
  12719. {
  12720. "type": "integer",
  12721. "description": "page number of results to return (1-based)",
  12722. "name": "page",
  12723. "in": "query"
  12724. },
  12725. {
  12726. "type": "integer",
  12727. "description": "page size of results",
  12728. "name": "limit",
  12729. "in": "query"
  12730. }
  12731. ],
  12732. "responses": {
  12733. "200": {
  12734. "$ref": "#/responses/UserList"
  12735. }
  12736. }
  12737. }
  12738. },
  12739. "/user/following": {
  12740. "get": {
  12741. "produces": [
  12742. "application/json"
  12743. ],
  12744. "tags": [
  12745. "user"
  12746. ],
  12747. "summary": "List the users that the authenticated user is following",
  12748. "operationId": "userCurrentListFollowing",
  12749. "parameters": [
  12750. {
  12751. "type": "integer",
  12752. "description": "page number of results to return (1-based)",
  12753. "name": "page",
  12754. "in": "query"
  12755. },
  12756. {
  12757. "type": "integer",
  12758. "description": "page size of results",
  12759. "name": "limit",
  12760. "in": "query"
  12761. }
  12762. ],
  12763. "responses": {
  12764. "200": {
  12765. "$ref": "#/responses/UserList"
  12766. }
  12767. }
  12768. }
  12769. },
  12770. "/user/following/{username}": {
  12771. "get": {
  12772. "tags": [
  12773. "user"
  12774. ],
  12775. "summary": "Check whether a user is followed by the authenticated user",
  12776. "operationId": "userCurrentCheckFollowing",
  12777. "parameters": [
  12778. {
  12779. "type": "string",
  12780. "description": "username of followed user",
  12781. "name": "username",
  12782. "in": "path",
  12783. "required": true
  12784. }
  12785. ],
  12786. "responses": {
  12787. "204": {
  12788. "$ref": "#/responses/empty"
  12789. },
  12790. "404": {
  12791. "$ref": "#/responses/notFound"
  12792. }
  12793. }
  12794. },
  12795. "put": {
  12796. "tags": [
  12797. "user"
  12798. ],
  12799. "summary": "Follow a user",
  12800. "operationId": "userCurrentPutFollow",
  12801. "parameters": [
  12802. {
  12803. "type": "string",
  12804. "description": "username of user to follow",
  12805. "name": "username",
  12806. "in": "path",
  12807. "required": true
  12808. }
  12809. ],
  12810. "responses": {
  12811. "204": {
  12812. "$ref": "#/responses/empty"
  12813. }
  12814. }
  12815. },
  12816. "delete": {
  12817. "tags": [
  12818. "user"
  12819. ],
  12820. "summary": "Unfollow a user",
  12821. "operationId": "userCurrentDeleteFollow",
  12822. "parameters": [
  12823. {
  12824. "type": "string",
  12825. "description": "username of user to unfollow",
  12826. "name": "username",
  12827. "in": "path",
  12828. "required": true
  12829. }
  12830. ],
  12831. "responses": {
  12832. "204": {
  12833. "$ref": "#/responses/empty"
  12834. }
  12835. }
  12836. }
  12837. },
  12838. "/user/gpg_key_token": {
  12839. "get": {
  12840. "produces": [
  12841. "text/plain"
  12842. ],
  12843. "tags": [
  12844. "user"
  12845. ],
  12846. "summary": "Get a Token to verify",
  12847. "operationId": "getVerificationToken",
  12848. "responses": {
  12849. "200": {
  12850. "$ref": "#/responses/string"
  12851. },
  12852. "404": {
  12853. "$ref": "#/responses/notFound"
  12854. }
  12855. }
  12856. }
  12857. },
  12858. "/user/gpg_key_verify": {
  12859. "post": {
  12860. "consumes": [
  12861. "application/json"
  12862. ],
  12863. "produces": [
  12864. "application/json"
  12865. ],
  12866. "tags": [
  12867. "user"
  12868. ],
  12869. "summary": "Verify a GPG key",
  12870. "operationId": "userVerifyGPGKey",
  12871. "responses": {
  12872. "201": {
  12873. "$ref": "#/responses/GPGKey"
  12874. },
  12875. "404": {
  12876. "$ref": "#/responses/notFound"
  12877. },
  12878. "422": {
  12879. "$ref": "#/responses/validationError"
  12880. }
  12881. }
  12882. }
  12883. },
  12884. "/user/gpg_keys": {
  12885. "get": {
  12886. "produces": [
  12887. "application/json"
  12888. ],
  12889. "tags": [
  12890. "user"
  12891. ],
  12892. "summary": "List the authenticated user's GPG keys",
  12893. "operationId": "userCurrentListGPGKeys",
  12894. "parameters": [
  12895. {
  12896. "type": "integer",
  12897. "description": "page number of results to return (1-based)",
  12898. "name": "page",
  12899. "in": "query"
  12900. },
  12901. {
  12902. "type": "integer",
  12903. "description": "page size of results",
  12904. "name": "limit",
  12905. "in": "query"
  12906. }
  12907. ],
  12908. "responses": {
  12909. "200": {
  12910. "$ref": "#/responses/GPGKeyList"
  12911. }
  12912. }
  12913. },
  12914. "post": {
  12915. "consumes": [
  12916. "application/json"
  12917. ],
  12918. "produces": [
  12919. "application/json"
  12920. ],
  12921. "tags": [
  12922. "user"
  12923. ],
  12924. "summary": "Create a GPG key",
  12925. "operationId": "userCurrentPostGPGKey",
  12926. "parameters": [
  12927. {
  12928. "name": "Form",
  12929. "in": "body",
  12930. "schema": {
  12931. "$ref": "#/definitions/CreateGPGKeyOption"
  12932. }
  12933. }
  12934. ],
  12935. "responses": {
  12936. "201": {
  12937. "$ref": "#/responses/GPGKey"
  12938. },
  12939. "404": {
  12940. "$ref": "#/responses/notFound"
  12941. },
  12942. "422": {
  12943. "$ref": "#/responses/validationError"
  12944. }
  12945. }
  12946. }
  12947. },
  12948. "/user/gpg_keys/{id}": {
  12949. "get": {
  12950. "produces": [
  12951. "application/json"
  12952. ],
  12953. "tags": [
  12954. "user"
  12955. ],
  12956. "summary": "Get a GPG key",
  12957. "operationId": "userCurrentGetGPGKey",
  12958. "parameters": [
  12959. {
  12960. "type": "integer",
  12961. "format": "int64",
  12962. "description": "id of key to get",
  12963. "name": "id",
  12964. "in": "path",
  12965. "required": true
  12966. }
  12967. ],
  12968. "responses": {
  12969. "200": {
  12970. "$ref": "#/responses/GPGKey"
  12971. },
  12972. "404": {
  12973. "$ref": "#/responses/notFound"
  12974. }
  12975. }
  12976. },
  12977. "delete": {
  12978. "produces": [
  12979. "application/json"
  12980. ],
  12981. "tags": [
  12982. "user"
  12983. ],
  12984. "summary": "Remove a GPG key",
  12985. "operationId": "userCurrentDeleteGPGKey",
  12986. "parameters": [
  12987. {
  12988. "type": "integer",
  12989. "format": "int64",
  12990. "description": "id of key to delete",
  12991. "name": "id",
  12992. "in": "path",
  12993. "required": true
  12994. }
  12995. ],
  12996. "responses": {
  12997. "204": {
  12998. "$ref": "#/responses/empty"
  12999. },
  13000. "403": {
  13001. "$ref": "#/responses/forbidden"
  13002. },
  13003. "404": {
  13004. "$ref": "#/responses/notFound"
  13005. }
  13006. }
  13007. }
  13008. },
  13009. "/user/keys": {
  13010. "get": {
  13011. "produces": [
  13012. "application/json"
  13013. ],
  13014. "tags": [
  13015. "user"
  13016. ],
  13017. "summary": "List the authenticated user's public keys",
  13018. "operationId": "userCurrentListKeys",
  13019. "parameters": [
  13020. {
  13021. "type": "string",
  13022. "description": "fingerprint of the key",
  13023. "name": "fingerprint",
  13024. "in": "query"
  13025. },
  13026. {
  13027. "type": "integer",
  13028. "description": "page number of results to return (1-based)",
  13029. "name": "page",
  13030. "in": "query"
  13031. },
  13032. {
  13033. "type": "integer",
  13034. "description": "page size of results",
  13035. "name": "limit",
  13036. "in": "query"
  13037. }
  13038. ],
  13039. "responses": {
  13040. "200": {
  13041. "$ref": "#/responses/PublicKeyList"
  13042. }
  13043. }
  13044. },
  13045. "post": {
  13046. "consumes": [
  13047. "application/json"
  13048. ],
  13049. "produces": [
  13050. "application/json"
  13051. ],
  13052. "tags": [
  13053. "user"
  13054. ],
  13055. "summary": "Create a public key",
  13056. "operationId": "userCurrentPostKey",
  13057. "parameters": [
  13058. {
  13059. "name": "body",
  13060. "in": "body",
  13061. "schema": {
  13062. "$ref": "#/definitions/CreateKeyOption"
  13063. }
  13064. }
  13065. ],
  13066. "responses": {
  13067. "201": {
  13068. "$ref": "#/responses/PublicKey"
  13069. },
  13070. "422": {
  13071. "$ref": "#/responses/validationError"
  13072. }
  13073. }
  13074. }
  13075. },
  13076. "/user/keys/{id}": {
  13077. "get": {
  13078. "produces": [
  13079. "application/json"
  13080. ],
  13081. "tags": [
  13082. "user"
  13083. ],
  13084. "summary": "Get a public key",
  13085. "operationId": "userCurrentGetKey",
  13086. "parameters": [
  13087. {
  13088. "type": "integer",
  13089. "format": "int64",
  13090. "description": "id of key to get",
  13091. "name": "id",
  13092. "in": "path",
  13093. "required": true
  13094. }
  13095. ],
  13096. "responses": {
  13097. "200": {
  13098. "$ref": "#/responses/PublicKey"
  13099. },
  13100. "404": {
  13101. "$ref": "#/responses/notFound"
  13102. }
  13103. }
  13104. },
  13105. "delete": {
  13106. "produces": [
  13107. "application/json"
  13108. ],
  13109. "tags": [
  13110. "user"
  13111. ],
  13112. "summary": "Delete a public key",
  13113. "operationId": "userCurrentDeleteKey",
  13114. "parameters": [
  13115. {
  13116. "type": "integer",
  13117. "format": "int64",
  13118. "description": "id of key to delete",
  13119. "name": "id",
  13120. "in": "path",
  13121. "required": true
  13122. }
  13123. ],
  13124. "responses": {
  13125. "204": {
  13126. "$ref": "#/responses/empty"
  13127. },
  13128. "403": {
  13129. "$ref": "#/responses/forbidden"
  13130. },
  13131. "404": {
  13132. "$ref": "#/responses/notFound"
  13133. }
  13134. }
  13135. }
  13136. },
  13137. "/user/orgs": {
  13138. "get": {
  13139. "produces": [
  13140. "application/json"
  13141. ],
  13142. "tags": [
  13143. "organization"
  13144. ],
  13145. "summary": "List the current user's organizations",
  13146. "operationId": "orgListCurrentUserOrgs",
  13147. "parameters": [
  13148. {
  13149. "type": "integer",
  13150. "description": "page number of results to return (1-based)",
  13151. "name": "page",
  13152. "in": "query"
  13153. },
  13154. {
  13155. "type": "integer",
  13156. "description": "page size of results",
  13157. "name": "limit",
  13158. "in": "query"
  13159. }
  13160. ],
  13161. "responses": {
  13162. "200": {
  13163. "$ref": "#/responses/OrganizationList"
  13164. }
  13165. }
  13166. }
  13167. },
  13168. "/user/repos": {
  13169. "get": {
  13170. "produces": [
  13171. "application/json"
  13172. ],
  13173. "tags": [
  13174. "user"
  13175. ],
  13176. "summary": "List the repos that the authenticated user owns",
  13177. "operationId": "userCurrentListRepos",
  13178. "parameters": [
  13179. {
  13180. "type": "integer",
  13181. "description": "page number of results to return (1-based)",
  13182. "name": "page",
  13183. "in": "query"
  13184. },
  13185. {
  13186. "type": "integer",
  13187. "description": "page size of results",
  13188. "name": "limit",
  13189. "in": "query"
  13190. }
  13191. ],
  13192. "responses": {
  13193. "200": {
  13194. "$ref": "#/responses/RepositoryList"
  13195. }
  13196. }
  13197. },
  13198. "post": {
  13199. "consumes": [
  13200. "application/json"
  13201. ],
  13202. "produces": [
  13203. "application/json"
  13204. ],
  13205. "tags": [
  13206. "repository",
  13207. "user"
  13208. ],
  13209. "summary": "Create a repository",
  13210. "operationId": "createCurrentUserRepo",
  13211. "parameters": [
  13212. {
  13213. "name": "body",
  13214. "in": "body",
  13215. "schema": {
  13216. "$ref": "#/definitions/CreateRepoOption"
  13217. }
  13218. }
  13219. ],
  13220. "responses": {
  13221. "201": {
  13222. "$ref": "#/responses/Repository"
  13223. },
  13224. "409": {
  13225. "description": "The repository with the same name already exists."
  13226. },
  13227. "422": {
  13228. "$ref": "#/responses/validationError"
  13229. }
  13230. }
  13231. }
  13232. },
  13233. "/user/settings": {
  13234. "get": {
  13235. "produces": [
  13236. "application/json"
  13237. ],
  13238. "tags": [
  13239. "user"
  13240. ],
  13241. "summary": "Get user settings",
  13242. "operationId": "getUserSettings",
  13243. "responses": {
  13244. "200": {
  13245. "$ref": "#/responses/UserSettings"
  13246. }
  13247. }
  13248. },
  13249. "patch": {
  13250. "produces": [
  13251. "application/json"
  13252. ],
  13253. "tags": [
  13254. "user"
  13255. ],
  13256. "summary": "Update user settings",
  13257. "operationId": "updateUserSettings",
  13258. "parameters": [
  13259. {
  13260. "name": "body",
  13261. "in": "body",
  13262. "schema": {
  13263. "$ref": "#/definitions/UserSettingsOptions"
  13264. }
  13265. }
  13266. ],
  13267. "responses": {
  13268. "200": {
  13269. "$ref": "#/responses/UserSettings"
  13270. }
  13271. }
  13272. }
  13273. },
  13274. "/user/starred": {
  13275. "get": {
  13276. "produces": [
  13277. "application/json"
  13278. ],
  13279. "tags": [
  13280. "user"
  13281. ],
  13282. "summary": "The repos that the authenticated user has starred",
  13283. "operationId": "userCurrentListStarred",
  13284. "parameters": [
  13285. {
  13286. "type": "integer",
  13287. "description": "page number of results to return (1-based)",
  13288. "name": "page",
  13289. "in": "query"
  13290. },
  13291. {
  13292. "type": "integer",
  13293. "description": "page size of results",
  13294. "name": "limit",
  13295. "in": "query"
  13296. }
  13297. ],
  13298. "responses": {
  13299. "200": {
  13300. "$ref": "#/responses/RepositoryList"
  13301. }
  13302. }
  13303. }
  13304. },
  13305. "/user/starred/{owner}/{repo}": {
  13306. "get": {
  13307. "tags": [
  13308. "user"
  13309. ],
  13310. "summary": "Whether the authenticated is starring the repo",
  13311. "operationId": "userCurrentCheckStarring",
  13312. "parameters": [
  13313. {
  13314. "type": "string",
  13315. "description": "owner of the repo",
  13316. "name": "owner",
  13317. "in": "path",
  13318. "required": true
  13319. },
  13320. {
  13321. "type": "string",
  13322. "description": "name of the repo",
  13323. "name": "repo",
  13324. "in": "path",
  13325. "required": true
  13326. }
  13327. ],
  13328. "responses": {
  13329. "204": {
  13330. "$ref": "#/responses/empty"
  13331. },
  13332. "404": {
  13333. "$ref": "#/responses/notFound"
  13334. }
  13335. }
  13336. },
  13337. "put": {
  13338. "tags": [
  13339. "user"
  13340. ],
  13341. "summary": "Star the given repo",
  13342. "operationId": "userCurrentPutStar",
  13343. "parameters": [
  13344. {
  13345. "type": "string",
  13346. "description": "owner of the repo to star",
  13347. "name": "owner",
  13348. "in": "path",
  13349. "required": true
  13350. },
  13351. {
  13352. "type": "string",
  13353. "description": "name of the repo to star",
  13354. "name": "repo",
  13355. "in": "path",
  13356. "required": true
  13357. }
  13358. ],
  13359. "responses": {
  13360. "204": {
  13361. "$ref": "#/responses/empty"
  13362. }
  13363. }
  13364. },
  13365. "delete": {
  13366. "tags": [
  13367. "user"
  13368. ],
  13369. "summary": "Unstar the given repo",
  13370. "operationId": "userCurrentDeleteStar",
  13371. "parameters": [
  13372. {
  13373. "type": "string",
  13374. "description": "owner of the repo to unstar",
  13375. "name": "owner",
  13376. "in": "path",
  13377. "required": true
  13378. },
  13379. {
  13380. "type": "string",
  13381. "description": "name of the repo to unstar",
  13382. "name": "repo",
  13383. "in": "path",
  13384. "required": true
  13385. }
  13386. ],
  13387. "responses": {
  13388. "204": {
  13389. "$ref": "#/responses/empty"
  13390. }
  13391. }
  13392. }
  13393. },
  13394. "/user/stopwatches": {
  13395. "get": {
  13396. "consumes": [
  13397. "application/json"
  13398. ],
  13399. "produces": [
  13400. "application/json"
  13401. ],
  13402. "tags": [
  13403. "user"
  13404. ],
  13405. "summary": "Get list of all existing stopwatches",
  13406. "operationId": "userGetStopWatches",
  13407. "parameters": [
  13408. {
  13409. "type": "integer",
  13410. "description": "page number of results to return (1-based)",
  13411. "name": "page",
  13412. "in": "query"
  13413. },
  13414. {
  13415. "type": "integer",
  13416. "description": "page size of results",
  13417. "name": "limit",
  13418. "in": "query"
  13419. }
  13420. ],
  13421. "responses": {
  13422. "200": {
  13423. "$ref": "#/responses/StopWatchList"
  13424. }
  13425. }
  13426. }
  13427. },
  13428. "/user/subscriptions": {
  13429. "get": {
  13430. "produces": [
  13431. "application/json"
  13432. ],
  13433. "tags": [
  13434. "user"
  13435. ],
  13436. "summary": "List repositories watched by the authenticated user",
  13437. "operationId": "userCurrentListSubscriptions",
  13438. "parameters": [
  13439. {
  13440. "type": "integer",
  13441. "description": "page number of results to return (1-based)",
  13442. "name": "page",
  13443. "in": "query"
  13444. },
  13445. {
  13446. "type": "integer",
  13447. "description": "page size of results",
  13448. "name": "limit",
  13449. "in": "query"
  13450. }
  13451. ],
  13452. "responses": {
  13453. "200": {
  13454. "$ref": "#/responses/RepositoryList"
  13455. }
  13456. }
  13457. }
  13458. },
  13459. "/user/teams": {
  13460. "get": {
  13461. "produces": [
  13462. "application/json"
  13463. ],
  13464. "tags": [
  13465. "user"
  13466. ],
  13467. "summary": "List all the teams a user belongs to",
  13468. "operationId": "userListTeams",
  13469. "parameters": [
  13470. {
  13471. "type": "integer",
  13472. "description": "page number of results to return (1-based)",
  13473. "name": "page",
  13474. "in": "query"
  13475. },
  13476. {
  13477. "type": "integer",
  13478. "description": "page size of results",
  13479. "name": "limit",
  13480. "in": "query"
  13481. }
  13482. ],
  13483. "responses": {
  13484. "200": {
  13485. "$ref": "#/responses/TeamList"
  13486. }
  13487. }
  13488. }
  13489. },
  13490. "/user/times": {
  13491. "get": {
  13492. "produces": [
  13493. "application/json"
  13494. ],
  13495. "tags": [
  13496. "user"
  13497. ],
  13498. "summary": "List the current user's tracked times",
  13499. "operationId": "userCurrentTrackedTimes",
  13500. "parameters": [
  13501. {
  13502. "type": "integer",
  13503. "description": "page number of results to return (1-based)",
  13504. "name": "page",
  13505. "in": "query"
  13506. },
  13507. {
  13508. "type": "integer",
  13509. "description": "page size of results",
  13510. "name": "limit",
  13511. "in": "query"
  13512. },
  13513. {
  13514. "type": "string",
  13515. "format": "date-time",
  13516. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  13517. "name": "since",
  13518. "in": "query"
  13519. },
  13520. {
  13521. "type": "string",
  13522. "format": "date-time",
  13523. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  13524. "name": "before",
  13525. "in": "query"
  13526. }
  13527. ],
  13528. "responses": {
  13529. "200": {
  13530. "$ref": "#/responses/TrackedTimeList"
  13531. }
  13532. }
  13533. }
  13534. },
  13535. "/users/search": {
  13536. "get": {
  13537. "produces": [
  13538. "application/json"
  13539. ],
  13540. "tags": [
  13541. "user"
  13542. ],
  13543. "summary": "Search for users",
  13544. "operationId": "userSearch",
  13545. "parameters": [
  13546. {
  13547. "type": "string",
  13548. "description": "keyword",
  13549. "name": "q",
  13550. "in": "query"
  13551. },
  13552. {
  13553. "type": "integer",
  13554. "format": "int64",
  13555. "description": "ID of the user to search for",
  13556. "name": "uid",
  13557. "in": "query"
  13558. },
  13559. {
  13560. "type": "integer",
  13561. "description": "page number of results to return (1-based)",
  13562. "name": "page",
  13563. "in": "query"
  13564. },
  13565. {
  13566. "type": "integer",
  13567. "description": "page size of results",
  13568. "name": "limit",
  13569. "in": "query"
  13570. }
  13571. ],
  13572. "responses": {
  13573. "200": {
  13574. "description": "SearchResults of a successful search",
  13575. "schema": {
  13576. "type": "object",
  13577. "properties": {
  13578. "data": {
  13579. "type": "array",
  13580. "items": {
  13581. "$ref": "#/definitions/User"
  13582. }
  13583. },
  13584. "ok": {
  13585. "type": "boolean"
  13586. }
  13587. }
  13588. }
  13589. }
  13590. }
  13591. }
  13592. },
  13593. "/users/{username}": {
  13594. "get": {
  13595. "produces": [
  13596. "application/json"
  13597. ],
  13598. "tags": [
  13599. "user"
  13600. ],
  13601. "summary": "Get a user",
  13602. "operationId": "userGet",
  13603. "parameters": [
  13604. {
  13605. "type": "string",
  13606. "description": "username of user to get",
  13607. "name": "username",
  13608. "in": "path",
  13609. "required": true
  13610. }
  13611. ],
  13612. "responses": {
  13613. "200": {
  13614. "$ref": "#/responses/User"
  13615. },
  13616. "404": {
  13617. "$ref": "#/responses/notFound"
  13618. }
  13619. }
  13620. }
  13621. },
  13622. "/users/{username}/followers": {
  13623. "get": {
  13624. "produces": [
  13625. "application/json"
  13626. ],
  13627. "tags": [
  13628. "user"
  13629. ],
  13630. "summary": "List the given user's followers",
  13631. "operationId": "userListFollowers",
  13632. "parameters": [
  13633. {
  13634. "type": "string",
  13635. "description": "username of user",
  13636. "name": "username",
  13637. "in": "path",
  13638. "required": true
  13639. },
  13640. {
  13641. "type": "integer",
  13642. "description": "page number of results to return (1-based)",
  13643. "name": "page",
  13644. "in": "query"
  13645. },
  13646. {
  13647. "type": "integer",
  13648. "description": "page size of results",
  13649. "name": "limit",
  13650. "in": "query"
  13651. }
  13652. ],
  13653. "responses": {
  13654. "200": {
  13655. "$ref": "#/responses/UserList"
  13656. }
  13657. }
  13658. }
  13659. },
  13660. "/users/{username}/following": {
  13661. "get": {
  13662. "produces": [
  13663. "application/json"
  13664. ],
  13665. "tags": [
  13666. "user"
  13667. ],
  13668. "summary": "List the users that the given user is following",
  13669. "operationId": "userListFollowing",
  13670. "parameters": [
  13671. {
  13672. "type": "string",
  13673. "description": "username of user",
  13674. "name": "username",
  13675. "in": "path",
  13676. "required": true
  13677. },
  13678. {
  13679. "type": "integer",
  13680. "description": "page number of results to return (1-based)",
  13681. "name": "page",
  13682. "in": "query"
  13683. },
  13684. {
  13685. "type": "integer",
  13686. "description": "page size of results",
  13687. "name": "limit",
  13688. "in": "query"
  13689. }
  13690. ],
  13691. "responses": {
  13692. "200": {
  13693. "$ref": "#/responses/UserList"
  13694. }
  13695. }
  13696. }
  13697. },
  13698. "/users/{username}/following/{target}": {
  13699. "get": {
  13700. "tags": [
  13701. "user"
  13702. ],
  13703. "summary": "Check if one user is following another user",
  13704. "operationId": "userCheckFollowing",
  13705. "parameters": [
  13706. {
  13707. "type": "string",
  13708. "description": "username of following user",
  13709. "name": "username",
  13710. "in": "path",
  13711. "required": true
  13712. },
  13713. {
  13714. "type": "string",
  13715. "description": "username of followed user",
  13716. "name": "target",
  13717. "in": "path",
  13718. "required": true
  13719. }
  13720. ],
  13721. "responses": {
  13722. "204": {
  13723. "$ref": "#/responses/empty"
  13724. },
  13725. "404": {
  13726. "$ref": "#/responses/notFound"
  13727. }
  13728. }
  13729. }
  13730. },
  13731. "/users/{username}/gpg_keys": {
  13732. "get": {
  13733. "produces": [
  13734. "application/json"
  13735. ],
  13736. "tags": [
  13737. "user"
  13738. ],
  13739. "summary": "List the given user's GPG keys",
  13740. "operationId": "userListGPGKeys",
  13741. "parameters": [
  13742. {
  13743. "type": "string",
  13744. "description": "username of user",
  13745. "name": "username",
  13746. "in": "path",
  13747. "required": true
  13748. },
  13749. {
  13750. "type": "integer",
  13751. "description": "page number of results to return (1-based)",
  13752. "name": "page",
  13753. "in": "query"
  13754. },
  13755. {
  13756. "type": "integer",
  13757. "description": "page size of results",
  13758. "name": "limit",
  13759. "in": "query"
  13760. }
  13761. ],
  13762. "responses": {
  13763. "200": {
  13764. "$ref": "#/responses/GPGKeyList"
  13765. }
  13766. }
  13767. }
  13768. },
  13769. "/users/{username}/heatmap": {
  13770. "get": {
  13771. "produces": [
  13772. "application/json"
  13773. ],
  13774. "tags": [
  13775. "user"
  13776. ],
  13777. "summary": "Get a user's heatmap",
  13778. "operationId": "userGetHeatmapData",
  13779. "parameters": [
  13780. {
  13781. "type": "string",
  13782. "description": "username of user to get",
  13783. "name": "username",
  13784. "in": "path",
  13785. "required": true
  13786. }
  13787. ],
  13788. "responses": {
  13789. "200": {
  13790. "$ref": "#/responses/UserHeatmapData"
  13791. },
  13792. "404": {
  13793. "$ref": "#/responses/notFound"
  13794. }
  13795. }
  13796. }
  13797. },
  13798. "/users/{username}/keys": {
  13799. "get": {
  13800. "produces": [
  13801. "application/json"
  13802. ],
  13803. "tags": [
  13804. "user"
  13805. ],
  13806. "summary": "List the given user's public keys",
  13807. "operationId": "userListKeys",
  13808. "parameters": [
  13809. {
  13810. "type": "string",
  13811. "description": "username of user",
  13812. "name": "username",
  13813. "in": "path",
  13814. "required": true
  13815. },
  13816. {
  13817. "type": "string",
  13818. "description": "fingerprint of the key",
  13819. "name": "fingerprint",
  13820. "in": "query"
  13821. },
  13822. {
  13823. "type": "integer",
  13824. "description": "page number of results to return (1-based)",
  13825. "name": "page",
  13826. "in": "query"
  13827. },
  13828. {
  13829. "type": "integer",
  13830. "description": "page size of results",
  13831. "name": "limit",
  13832. "in": "query"
  13833. }
  13834. ],
  13835. "responses": {
  13836. "200": {
  13837. "$ref": "#/responses/PublicKeyList"
  13838. }
  13839. }
  13840. }
  13841. },
  13842. "/users/{username}/orgs": {
  13843. "get": {
  13844. "produces": [
  13845. "application/json"
  13846. ],
  13847. "tags": [
  13848. "organization"
  13849. ],
  13850. "summary": "List a user's organizations",
  13851. "operationId": "orgListUserOrgs",
  13852. "parameters": [
  13853. {
  13854. "type": "string",
  13855. "description": "username of user",
  13856. "name": "username",
  13857. "in": "path",
  13858. "required": true
  13859. },
  13860. {
  13861. "type": "integer",
  13862. "description": "page number of results to return (1-based)",
  13863. "name": "page",
  13864. "in": "query"
  13865. },
  13866. {
  13867. "type": "integer",
  13868. "description": "page size of results",
  13869. "name": "limit",
  13870. "in": "query"
  13871. }
  13872. ],
  13873. "responses": {
  13874. "200": {
  13875. "$ref": "#/responses/OrganizationList"
  13876. }
  13877. }
  13878. }
  13879. },
  13880. "/users/{username}/orgs/{org}/permissions": {
  13881. "get": {
  13882. "produces": [
  13883. "application/json"
  13884. ],
  13885. "tags": [
  13886. "organization"
  13887. ],
  13888. "summary": "Get user permissions in organization",
  13889. "operationId": "orgGetUserPermissions",
  13890. "parameters": [
  13891. {
  13892. "type": "string",
  13893. "description": "username of user",
  13894. "name": "username",
  13895. "in": "path",
  13896. "required": true
  13897. },
  13898. {
  13899. "type": "string",
  13900. "description": "name of the organization",
  13901. "name": "org",
  13902. "in": "path",
  13903. "required": true
  13904. }
  13905. ],
  13906. "responses": {
  13907. "200": {
  13908. "$ref": "#/responses/OrganizationPermissions"
  13909. },
  13910. "403": {
  13911. "$ref": "#/responses/forbidden"
  13912. },
  13913. "404": {
  13914. "$ref": "#/responses/notFound"
  13915. }
  13916. }
  13917. }
  13918. },
  13919. "/users/{username}/repos": {
  13920. "get": {
  13921. "produces": [
  13922. "application/json"
  13923. ],
  13924. "tags": [
  13925. "user"
  13926. ],
  13927. "summary": "List the repos owned by the given user",
  13928. "operationId": "userListRepos",
  13929. "parameters": [
  13930. {
  13931. "type": "string",
  13932. "description": "username of user",
  13933. "name": "username",
  13934. "in": "path",
  13935. "required": true
  13936. },
  13937. {
  13938. "type": "integer",
  13939. "description": "page number of results to return (1-based)",
  13940. "name": "page",
  13941. "in": "query"
  13942. },
  13943. {
  13944. "type": "integer",
  13945. "description": "page size of results",
  13946. "name": "limit",
  13947. "in": "query"
  13948. }
  13949. ],
  13950. "responses": {
  13951. "200": {
  13952. "$ref": "#/responses/RepositoryList"
  13953. }
  13954. }
  13955. }
  13956. },
  13957. "/users/{username}/starred": {
  13958. "get": {
  13959. "produces": [
  13960. "application/json"
  13961. ],
  13962. "tags": [
  13963. "user"
  13964. ],
  13965. "summary": "The repos that the given user has starred",
  13966. "operationId": "userListStarred",
  13967. "parameters": [
  13968. {
  13969. "type": "string",
  13970. "description": "username of user",
  13971. "name": "username",
  13972. "in": "path",
  13973. "required": true
  13974. },
  13975. {
  13976. "type": "integer",
  13977. "description": "page number of results to return (1-based)",
  13978. "name": "page",
  13979. "in": "query"
  13980. },
  13981. {
  13982. "type": "integer",
  13983. "description": "page size of results",
  13984. "name": "limit",
  13985. "in": "query"
  13986. }
  13987. ],
  13988. "responses": {
  13989. "200": {
  13990. "$ref": "#/responses/RepositoryList"
  13991. }
  13992. }
  13993. }
  13994. },
  13995. "/users/{username}/subscriptions": {
  13996. "get": {
  13997. "produces": [
  13998. "application/json"
  13999. ],
  14000. "tags": [
  14001. "user"
  14002. ],
  14003. "summary": "List the repositories watched by a user",
  14004. "operationId": "userListSubscriptions",
  14005. "parameters": [
  14006. {
  14007. "type": "string",
  14008. "description": "username of the user",
  14009. "name": "username",
  14010. "in": "path",
  14011. "required": true
  14012. },
  14013. {
  14014. "type": "integer",
  14015. "description": "page number of results to return (1-based)",
  14016. "name": "page",
  14017. "in": "query"
  14018. },
  14019. {
  14020. "type": "integer",
  14021. "description": "page size of results",
  14022. "name": "limit",
  14023. "in": "query"
  14024. }
  14025. ],
  14026. "responses": {
  14027. "200": {
  14028. "$ref": "#/responses/RepositoryList"
  14029. }
  14030. }
  14031. }
  14032. },
  14033. "/users/{username}/tokens": {
  14034. "get": {
  14035. "produces": [
  14036. "application/json"
  14037. ],
  14038. "tags": [
  14039. "user"
  14040. ],
  14041. "summary": "List the authenticated user's access tokens",
  14042. "operationId": "userGetTokens",
  14043. "parameters": [
  14044. {
  14045. "type": "string",
  14046. "description": "username of user",
  14047. "name": "username",
  14048. "in": "path",
  14049. "required": true
  14050. },
  14051. {
  14052. "type": "integer",
  14053. "description": "page number of results to return (1-based)",
  14054. "name": "page",
  14055. "in": "query"
  14056. },
  14057. {
  14058. "type": "integer",
  14059. "description": "page size of results",
  14060. "name": "limit",
  14061. "in": "query"
  14062. }
  14063. ],
  14064. "responses": {
  14065. "200": {
  14066. "$ref": "#/responses/AccessTokenList"
  14067. }
  14068. }
  14069. },
  14070. "post": {
  14071. "consumes": [
  14072. "application/json"
  14073. ],
  14074. "produces": [
  14075. "application/json"
  14076. ],
  14077. "tags": [
  14078. "user"
  14079. ],
  14080. "summary": "Create an access token",
  14081. "operationId": "userCreateToken",
  14082. "parameters": [
  14083. {
  14084. "type": "string",
  14085. "x-go-name": "Name",
  14086. "description": "username of user",
  14087. "name": "username",
  14088. "in": "path",
  14089. "required": true
  14090. },
  14091. {
  14092. "name": "userCreateToken",
  14093. "in": "body",
  14094. "schema": {
  14095. "$ref": "#/definitions/CreateAccessTokenOption"
  14096. }
  14097. }
  14098. ],
  14099. "responses": {
  14100. "201": {
  14101. "$ref": "#/responses/AccessToken"
  14102. },
  14103. "400": {
  14104. "$ref": "#/responses/error"
  14105. }
  14106. }
  14107. }
  14108. },
  14109. "/users/{username}/tokens/{token}": {
  14110. "delete": {
  14111. "produces": [
  14112. "application/json"
  14113. ],
  14114. "tags": [
  14115. "user"
  14116. ],
  14117. "summary": "delete an access token",
  14118. "operationId": "userDeleteAccessToken",
  14119. "parameters": [
  14120. {
  14121. "type": "string",
  14122. "description": "username of user",
  14123. "name": "username",
  14124. "in": "path",
  14125. "required": true
  14126. },
  14127. {
  14128. "type": "string",
  14129. "description": "token to be deleted, identified by ID and if not available by name",
  14130. "name": "token",
  14131. "in": "path",
  14132. "required": true
  14133. }
  14134. ],
  14135. "responses": {
  14136. "204": {
  14137. "$ref": "#/responses/empty"
  14138. },
  14139. "404": {
  14140. "$ref": "#/responses/notFound"
  14141. },
  14142. "422": {
  14143. "$ref": "#/responses/error"
  14144. }
  14145. }
  14146. }
  14147. },
  14148. "/version": {
  14149. "get": {
  14150. "produces": [
  14151. "application/json"
  14152. ],
  14153. "tags": [
  14154. "miscellaneous"
  14155. ],
  14156. "summary": "Returns the version of the Gitea application",
  14157. "operationId": "getVersion",
  14158. "responses": {
  14159. "200": {
  14160. "$ref": "#/responses/ServerVersion"
  14161. }
  14162. }
  14163. }
  14164. }
  14165. },
  14166. "definitions": {
  14167. "APIError": {
  14168. "description": "APIError is an api error with a message",
  14169. "type": "object",
  14170. "properties": {
  14171. "message": {
  14172. "type": "string",
  14173. "x-go-name": "Message"
  14174. },
  14175. "url": {
  14176. "type": "string",
  14177. "x-go-name": "URL"
  14178. }
  14179. },
  14180. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14181. },
  14182. "AccessToken": {
  14183. "type": "object",
  14184. "title": "AccessToken represents an API access token.",
  14185. "properties": {
  14186. "id": {
  14187. "type": "integer",
  14188. "format": "int64",
  14189. "x-go-name": "ID"
  14190. },
  14191. "name": {
  14192. "type": "string",
  14193. "x-go-name": "Name"
  14194. },
  14195. "sha1": {
  14196. "type": "string",
  14197. "x-go-name": "Token"
  14198. },
  14199. "token_last_eight": {
  14200. "type": "string",
  14201. "x-go-name": "TokenLastEight"
  14202. }
  14203. },
  14204. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14205. },
  14206. "ActivityPub": {
  14207. "description": "ActivityPub type",
  14208. "type": "object",
  14209. "properties": {
  14210. "@context": {
  14211. "type": "string",
  14212. "x-go-name": "Context"
  14213. }
  14214. },
  14215. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14216. },
  14217. "AddCollaboratorOption": {
  14218. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  14219. "type": "object",
  14220. "properties": {
  14221. "permission": {
  14222. "type": "string",
  14223. "x-go-name": "Permission"
  14224. }
  14225. },
  14226. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14227. },
  14228. "AddTimeOption": {
  14229. "description": "AddTimeOption options for adding time to an issue",
  14230. "type": "object",
  14231. "required": [
  14232. "time"
  14233. ],
  14234. "properties": {
  14235. "created": {
  14236. "type": "string",
  14237. "format": "date-time",
  14238. "x-go-name": "Created"
  14239. },
  14240. "time": {
  14241. "description": "time in seconds",
  14242. "type": "integer",
  14243. "format": "int64",
  14244. "x-go-name": "Time"
  14245. },
  14246. "user_name": {
  14247. "description": "User who spent the time (optional)",
  14248. "type": "string",
  14249. "x-go-name": "User"
  14250. }
  14251. },
  14252. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14253. },
  14254. "AnnotatedTag": {
  14255. "description": "AnnotatedTag represents an annotated tag",
  14256. "type": "object",
  14257. "properties": {
  14258. "message": {
  14259. "type": "string",
  14260. "x-go-name": "Message"
  14261. },
  14262. "object": {
  14263. "$ref": "#/definitions/AnnotatedTagObject"
  14264. },
  14265. "sha": {
  14266. "type": "string",
  14267. "x-go-name": "SHA"
  14268. },
  14269. "tag": {
  14270. "type": "string",
  14271. "x-go-name": "Tag"
  14272. },
  14273. "tagger": {
  14274. "$ref": "#/definitions/CommitUser"
  14275. },
  14276. "url": {
  14277. "type": "string",
  14278. "x-go-name": "URL"
  14279. },
  14280. "verification": {
  14281. "$ref": "#/definitions/PayloadCommitVerification"
  14282. }
  14283. },
  14284. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14285. },
  14286. "AnnotatedTagObject": {
  14287. "description": "AnnotatedTagObject contains meta information of the tag object",
  14288. "type": "object",
  14289. "properties": {
  14290. "sha": {
  14291. "type": "string",
  14292. "x-go-name": "SHA"
  14293. },
  14294. "type": {
  14295. "type": "string",
  14296. "x-go-name": "Type"
  14297. },
  14298. "url": {
  14299. "type": "string",
  14300. "x-go-name": "URL"
  14301. }
  14302. },
  14303. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14304. },
  14305. "Attachment": {
  14306. "description": "Attachment a generic attachment",
  14307. "type": "object",
  14308. "properties": {
  14309. "browser_download_url": {
  14310. "type": "string",
  14311. "x-go-name": "DownloadURL"
  14312. },
  14313. "created_at": {
  14314. "type": "string",
  14315. "format": "date-time",
  14316. "x-go-name": "Created"
  14317. },
  14318. "download_count": {
  14319. "type": "integer",
  14320. "format": "int64",
  14321. "x-go-name": "DownloadCount"
  14322. },
  14323. "id": {
  14324. "type": "integer",
  14325. "format": "int64",
  14326. "x-go-name": "ID"
  14327. },
  14328. "name": {
  14329. "type": "string",
  14330. "x-go-name": "Name"
  14331. },
  14332. "size": {
  14333. "type": "integer",
  14334. "format": "int64",
  14335. "x-go-name": "Size"
  14336. },
  14337. "uuid": {
  14338. "type": "string",
  14339. "x-go-name": "UUID"
  14340. }
  14341. },
  14342. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14343. },
  14344. "Branch": {
  14345. "description": "Branch represents a repository branch",
  14346. "type": "object",
  14347. "properties": {
  14348. "commit": {
  14349. "$ref": "#/definitions/PayloadCommit"
  14350. },
  14351. "effective_branch_protection_name": {
  14352. "type": "string",
  14353. "x-go-name": "EffectiveBranchProtectionName"
  14354. },
  14355. "enable_status_check": {
  14356. "type": "boolean",
  14357. "x-go-name": "EnableStatusCheck"
  14358. },
  14359. "name": {
  14360. "type": "string",
  14361. "x-go-name": "Name"
  14362. },
  14363. "protected": {
  14364. "type": "boolean",
  14365. "x-go-name": "Protected"
  14366. },
  14367. "required_approvals": {
  14368. "type": "integer",
  14369. "format": "int64",
  14370. "x-go-name": "RequiredApprovals"
  14371. },
  14372. "status_check_contexts": {
  14373. "type": "array",
  14374. "items": {
  14375. "type": "string"
  14376. },
  14377. "x-go-name": "StatusCheckContexts"
  14378. },
  14379. "user_can_merge": {
  14380. "type": "boolean",
  14381. "x-go-name": "UserCanMerge"
  14382. },
  14383. "user_can_push": {
  14384. "type": "boolean",
  14385. "x-go-name": "UserCanPush"
  14386. }
  14387. },
  14388. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14389. },
  14390. "BranchProtection": {
  14391. "description": "BranchProtection represents a branch protection for a repository",
  14392. "type": "object",
  14393. "properties": {
  14394. "approvals_whitelist_teams": {
  14395. "type": "array",
  14396. "items": {
  14397. "type": "string"
  14398. },
  14399. "x-go-name": "ApprovalsWhitelistTeams"
  14400. },
  14401. "approvals_whitelist_username": {
  14402. "type": "array",
  14403. "items": {
  14404. "type": "string"
  14405. },
  14406. "x-go-name": "ApprovalsWhitelistUsernames"
  14407. },
  14408. "block_on_official_review_requests": {
  14409. "type": "boolean",
  14410. "x-go-name": "BlockOnOfficialReviewRequests"
  14411. },
  14412. "block_on_outdated_branch": {
  14413. "type": "boolean",
  14414. "x-go-name": "BlockOnOutdatedBranch"
  14415. },
  14416. "block_on_rejected_reviews": {
  14417. "type": "boolean",
  14418. "x-go-name": "BlockOnRejectedReviews"
  14419. },
  14420. "branch_name": {
  14421. "description": "Deprecated: true",
  14422. "type": "string",
  14423. "x-go-name": "BranchName"
  14424. },
  14425. "created_at": {
  14426. "type": "string",
  14427. "format": "date-time",
  14428. "x-go-name": "Created"
  14429. },
  14430. "dismiss_stale_approvals": {
  14431. "type": "boolean",
  14432. "x-go-name": "DismissStaleApprovals"
  14433. },
  14434. "enable_approvals_whitelist": {
  14435. "type": "boolean",
  14436. "x-go-name": "EnableApprovalsWhitelist"
  14437. },
  14438. "enable_merge_whitelist": {
  14439. "type": "boolean",
  14440. "x-go-name": "EnableMergeWhitelist"
  14441. },
  14442. "enable_push": {
  14443. "type": "boolean",
  14444. "x-go-name": "EnablePush"
  14445. },
  14446. "enable_push_whitelist": {
  14447. "type": "boolean",
  14448. "x-go-name": "EnablePushWhitelist"
  14449. },
  14450. "enable_status_check": {
  14451. "type": "boolean",
  14452. "x-go-name": "EnableStatusCheck"
  14453. },
  14454. "merge_whitelist_teams": {
  14455. "type": "array",
  14456. "items": {
  14457. "type": "string"
  14458. },
  14459. "x-go-name": "MergeWhitelistTeams"
  14460. },
  14461. "merge_whitelist_usernames": {
  14462. "type": "array",
  14463. "items": {
  14464. "type": "string"
  14465. },
  14466. "x-go-name": "MergeWhitelistUsernames"
  14467. },
  14468. "protected_file_patterns": {
  14469. "type": "string",
  14470. "x-go-name": "ProtectedFilePatterns"
  14471. },
  14472. "push_whitelist_deploy_keys": {
  14473. "type": "boolean",
  14474. "x-go-name": "PushWhitelistDeployKeys"
  14475. },
  14476. "push_whitelist_teams": {
  14477. "type": "array",
  14478. "items": {
  14479. "type": "string"
  14480. },
  14481. "x-go-name": "PushWhitelistTeams"
  14482. },
  14483. "push_whitelist_usernames": {
  14484. "type": "array",
  14485. "items": {
  14486. "type": "string"
  14487. },
  14488. "x-go-name": "PushWhitelistUsernames"
  14489. },
  14490. "require_signed_commits": {
  14491. "type": "boolean",
  14492. "x-go-name": "RequireSignedCommits"
  14493. },
  14494. "required_approvals": {
  14495. "type": "integer",
  14496. "format": "int64",
  14497. "x-go-name": "RequiredApprovals"
  14498. },
  14499. "rule_name": {
  14500. "type": "string",
  14501. "x-go-name": "RuleName"
  14502. },
  14503. "status_check_contexts": {
  14504. "type": "array",
  14505. "items": {
  14506. "type": "string"
  14507. },
  14508. "x-go-name": "StatusCheckContexts"
  14509. },
  14510. "unprotected_file_patterns": {
  14511. "type": "string",
  14512. "x-go-name": "UnprotectedFilePatterns"
  14513. },
  14514. "updated_at": {
  14515. "type": "string",
  14516. "format": "date-time",
  14517. "x-go-name": "Updated"
  14518. }
  14519. },
  14520. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14521. },
  14522. "ChangedFile": {
  14523. "description": "ChangedFile store information about files affected by the pull request",
  14524. "type": "object",
  14525. "properties": {
  14526. "additions": {
  14527. "type": "integer",
  14528. "format": "int64",
  14529. "x-go-name": "Additions"
  14530. },
  14531. "changes": {
  14532. "type": "integer",
  14533. "format": "int64",
  14534. "x-go-name": "Changes"
  14535. },
  14536. "contents_url": {
  14537. "type": "string",
  14538. "x-go-name": "ContentsURL"
  14539. },
  14540. "deletions": {
  14541. "type": "integer",
  14542. "format": "int64",
  14543. "x-go-name": "Deletions"
  14544. },
  14545. "filename": {
  14546. "type": "string",
  14547. "x-go-name": "Filename"
  14548. },
  14549. "html_url": {
  14550. "type": "string",
  14551. "x-go-name": "HTMLURL"
  14552. },
  14553. "previous_filename": {
  14554. "type": "string",
  14555. "x-go-name": "PreviousFilename"
  14556. },
  14557. "raw_url": {
  14558. "type": "string",
  14559. "x-go-name": "RawURL"
  14560. },
  14561. "status": {
  14562. "type": "string",
  14563. "x-go-name": "Status"
  14564. }
  14565. },
  14566. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14567. },
  14568. "CombinedStatus": {
  14569. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  14570. "type": "object",
  14571. "properties": {
  14572. "commit_url": {
  14573. "type": "string",
  14574. "x-go-name": "CommitURL"
  14575. },
  14576. "repository": {
  14577. "$ref": "#/definitions/Repository"
  14578. },
  14579. "sha": {
  14580. "type": "string",
  14581. "x-go-name": "SHA"
  14582. },
  14583. "state": {
  14584. "$ref": "#/definitions/CommitStatusState"
  14585. },
  14586. "statuses": {
  14587. "type": "array",
  14588. "items": {
  14589. "$ref": "#/definitions/CommitStatus"
  14590. },
  14591. "x-go-name": "Statuses"
  14592. },
  14593. "total_count": {
  14594. "type": "integer",
  14595. "format": "int64",
  14596. "x-go-name": "TotalCount"
  14597. },
  14598. "url": {
  14599. "type": "string",
  14600. "x-go-name": "URL"
  14601. }
  14602. },
  14603. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14604. },
  14605. "Comment": {
  14606. "description": "Comment represents a comment on a commit or issue",
  14607. "type": "object",
  14608. "properties": {
  14609. "assets": {
  14610. "type": "array",
  14611. "items": {
  14612. "$ref": "#/definitions/Attachment"
  14613. },
  14614. "x-go-name": "Attachments"
  14615. },
  14616. "body": {
  14617. "type": "string",
  14618. "x-go-name": "Body"
  14619. },
  14620. "created_at": {
  14621. "type": "string",
  14622. "format": "date-time",
  14623. "x-go-name": "Created"
  14624. },
  14625. "html_url": {
  14626. "type": "string",
  14627. "x-go-name": "HTMLURL"
  14628. },
  14629. "id": {
  14630. "type": "integer",
  14631. "format": "int64",
  14632. "x-go-name": "ID"
  14633. },
  14634. "issue_url": {
  14635. "type": "string",
  14636. "x-go-name": "IssueURL"
  14637. },
  14638. "original_author": {
  14639. "type": "string",
  14640. "x-go-name": "OriginalAuthor"
  14641. },
  14642. "original_author_id": {
  14643. "type": "integer",
  14644. "format": "int64",
  14645. "x-go-name": "OriginalAuthorID"
  14646. },
  14647. "pull_request_url": {
  14648. "type": "string",
  14649. "x-go-name": "PRURL"
  14650. },
  14651. "updated_at": {
  14652. "type": "string",
  14653. "format": "date-time",
  14654. "x-go-name": "Updated"
  14655. },
  14656. "user": {
  14657. "$ref": "#/definitions/User"
  14658. }
  14659. },
  14660. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14661. },
  14662. "Commit": {
  14663. "type": "object",
  14664. "title": "Commit contains information generated from a Git commit.",
  14665. "properties": {
  14666. "author": {
  14667. "$ref": "#/definitions/User"
  14668. },
  14669. "commit": {
  14670. "$ref": "#/definitions/RepoCommit"
  14671. },
  14672. "committer": {
  14673. "$ref": "#/definitions/User"
  14674. },
  14675. "created": {
  14676. "type": "string",
  14677. "format": "date-time",
  14678. "x-go-name": "Created"
  14679. },
  14680. "files": {
  14681. "type": "array",
  14682. "items": {
  14683. "$ref": "#/definitions/CommitAffectedFiles"
  14684. },
  14685. "x-go-name": "Files"
  14686. },
  14687. "html_url": {
  14688. "type": "string",
  14689. "x-go-name": "HTMLURL"
  14690. },
  14691. "parents": {
  14692. "type": "array",
  14693. "items": {
  14694. "$ref": "#/definitions/CommitMeta"
  14695. },
  14696. "x-go-name": "Parents"
  14697. },
  14698. "sha": {
  14699. "type": "string",
  14700. "x-go-name": "SHA"
  14701. },
  14702. "stats": {
  14703. "$ref": "#/definitions/CommitStats"
  14704. },
  14705. "url": {
  14706. "type": "string",
  14707. "x-go-name": "URL"
  14708. }
  14709. },
  14710. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14711. },
  14712. "CommitAffectedFiles": {
  14713. "description": "CommitAffectedFiles store information about files affected by the commit",
  14714. "type": "object",
  14715. "properties": {
  14716. "filename": {
  14717. "type": "string",
  14718. "x-go-name": "Filename"
  14719. }
  14720. },
  14721. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14722. },
  14723. "CommitDateOptions": {
  14724. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  14725. "type": "object",
  14726. "properties": {
  14727. "author": {
  14728. "type": "string",
  14729. "format": "date-time",
  14730. "x-go-name": "Author"
  14731. },
  14732. "committer": {
  14733. "type": "string",
  14734. "format": "date-time",
  14735. "x-go-name": "Committer"
  14736. }
  14737. },
  14738. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14739. },
  14740. "CommitMeta": {
  14741. "type": "object",
  14742. "title": "CommitMeta contains meta information of a commit in terms of API.",
  14743. "properties": {
  14744. "created": {
  14745. "type": "string",
  14746. "format": "date-time",
  14747. "x-go-name": "Created"
  14748. },
  14749. "sha": {
  14750. "type": "string",
  14751. "x-go-name": "SHA"
  14752. },
  14753. "url": {
  14754. "type": "string",
  14755. "x-go-name": "URL"
  14756. }
  14757. },
  14758. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14759. },
  14760. "CommitStats": {
  14761. "description": "CommitStats is statistics for a RepoCommit",
  14762. "type": "object",
  14763. "properties": {
  14764. "additions": {
  14765. "type": "integer",
  14766. "format": "int64",
  14767. "x-go-name": "Additions"
  14768. },
  14769. "deletions": {
  14770. "type": "integer",
  14771. "format": "int64",
  14772. "x-go-name": "Deletions"
  14773. },
  14774. "total": {
  14775. "type": "integer",
  14776. "format": "int64",
  14777. "x-go-name": "Total"
  14778. }
  14779. },
  14780. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14781. },
  14782. "CommitStatus": {
  14783. "description": "CommitStatus holds a single status of a single Commit",
  14784. "type": "object",
  14785. "properties": {
  14786. "context": {
  14787. "type": "string",
  14788. "x-go-name": "Context"
  14789. },
  14790. "created_at": {
  14791. "type": "string",
  14792. "format": "date-time",
  14793. "x-go-name": "Created"
  14794. },
  14795. "creator": {
  14796. "$ref": "#/definitions/User"
  14797. },
  14798. "description": {
  14799. "type": "string",
  14800. "x-go-name": "Description"
  14801. },
  14802. "id": {
  14803. "type": "integer",
  14804. "format": "int64",
  14805. "x-go-name": "ID"
  14806. },
  14807. "status": {
  14808. "$ref": "#/definitions/CommitStatusState"
  14809. },
  14810. "target_url": {
  14811. "type": "string",
  14812. "x-go-name": "TargetURL"
  14813. },
  14814. "updated_at": {
  14815. "type": "string",
  14816. "format": "date-time",
  14817. "x-go-name": "Updated"
  14818. },
  14819. "url": {
  14820. "type": "string",
  14821. "x-go-name": "URL"
  14822. }
  14823. },
  14824. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14825. },
  14826. "CommitStatusState": {
  14827. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  14828. "type": "string",
  14829. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14830. },
  14831. "CommitUser": {
  14832. "type": "object",
  14833. "title": "CommitUser contains information of a user in the context of a commit.",
  14834. "properties": {
  14835. "date": {
  14836. "type": "string",
  14837. "x-go-name": "Date"
  14838. },
  14839. "email": {
  14840. "type": "string",
  14841. "format": "email",
  14842. "x-go-name": "Email"
  14843. },
  14844. "name": {
  14845. "type": "string",
  14846. "x-go-name": "Name"
  14847. }
  14848. },
  14849. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14850. },
  14851. "ContentsResponse": {
  14852. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  14853. "type": "object",
  14854. "properties": {
  14855. "_links": {
  14856. "$ref": "#/definitions/FileLinksResponse"
  14857. },
  14858. "content": {
  14859. "description": "`content` is populated when `type` is `file`, otherwise null",
  14860. "type": "string",
  14861. "x-go-name": "Content"
  14862. },
  14863. "download_url": {
  14864. "type": "string",
  14865. "x-go-name": "DownloadURL"
  14866. },
  14867. "encoding": {
  14868. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  14869. "type": "string",
  14870. "x-go-name": "Encoding"
  14871. },
  14872. "git_url": {
  14873. "type": "string",
  14874. "x-go-name": "GitURL"
  14875. },
  14876. "html_url": {
  14877. "type": "string",
  14878. "x-go-name": "HTMLURL"
  14879. },
  14880. "last_commit_sha": {
  14881. "type": "string",
  14882. "x-go-name": "LastCommitSHA"
  14883. },
  14884. "name": {
  14885. "type": "string",
  14886. "x-go-name": "Name"
  14887. },
  14888. "path": {
  14889. "type": "string",
  14890. "x-go-name": "Path"
  14891. },
  14892. "sha": {
  14893. "type": "string",
  14894. "x-go-name": "SHA"
  14895. },
  14896. "size": {
  14897. "type": "integer",
  14898. "format": "int64",
  14899. "x-go-name": "Size"
  14900. },
  14901. "submodule_git_url": {
  14902. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  14903. "type": "string",
  14904. "x-go-name": "SubmoduleGitURL"
  14905. },
  14906. "target": {
  14907. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  14908. "type": "string",
  14909. "x-go-name": "Target"
  14910. },
  14911. "type": {
  14912. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  14913. "type": "string",
  14914. "x-go-name": "Type"
  14915. },
  14916. "url": {
  14917. "type": "string",
  14918. "x-go-name": "URL"
  14919. }
  14920. },
  14921. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14922. },
  14923. "CreateAccessTokenOption": {
  14924. "description": "CreateAccessTokenOption options when create access token",
  14925. "type": "object",
  14926. "properties": {
  14927. "name": {
  14928. "type": "string",
  14929. "x-go-name": "Name"
  14930. }
  14931. },
  14932. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14933. },
  14934. "CreateBranchProtectionOption": {
  14935. "description": "CreateBranchProtectionOption options for creating a branch protection",
  14936. "type": "object",
  14937. "properties": {
  14938. "approvals_whitelist_teams": {
  14939. "type": "array",
  14940. "items": {
  14941. "type": "string"
  14942. },
  14943. "x-go-name": "ApprovalsWhitelistTeams"
  14944. },
  14945. "approvals_whitelist_username": {
  14946. "type": "array",
  14947. "items": {
  14948. "type": "string"
  14949. },
  14950. "x-go-name": "ApprovalsWhitelistUsernames"
  14951. },
  14952. "block_on_official_review_requests": {
  14953. "type": "boolean",
  14954. "x-go-name": "BlockOnOfficialReviewRequests"
  14955. },
  14956. "block_on_outdated_branch": {
  14957. "type": "boolean",
  14958. "x-go-name": "BlockOnOutdatedBranch"
  14959. },
  14960. "block_on_rejected_reviews": {
  14961. "type": "boolean",
  14962. "x-go-name": "BlockOnRejectedReviews"
  14963. },
  14964. "branch_name": {
  14965. "description": "Deprecated: true",
  14966. "type": "string",
  14967. "x-go-name": "BranchName"
  14968. },
  14969. "dismiss_stale_approvals": {
  14970. "type": "boolean",
  14971. "x-go-name": "DismissStaleApprovals"
  14972. },
  14973. "enable_approvals_whitelist": {
  14974. "type": "boolean",
  14975. "x-go-name": "EnableApprovalsWhitelist"
  14976. },
  14977. "enable_merge_whitelist": {
  14978. "type": "boolean",
  14979. "x-go-name": "EnableMergeWhitelist"
  14980. },
  14981. "enable_push": {
  14982. "type": "boolean",
  14983. "x-go-name": "EnablePush"
  14984. },
  14985. "enable_push_whitelist": {
  14986. "type": "boolean",
  14987. "x-go-name": "EnablePushWhitelist"
  14988. },
  14989. "enable_status_check": {
  14990. "type": "boolean",
  14991. "x-go-name": "EnableStatusCheck"
  14992. },
  14993. "merge_whitelist_teams": {
  14994. "type": "array",
  14995. "items": {
  14996. "type": "string"
  14997. },
  14998. "x-go-name": "MergeWhitelistTeams"
  14999. },
  15000. "merge_whitelist_usernames": {
  15001. "type": "array",
  15002. "items": {
  15003. "type": "string"
  15004. },
  15005. "x-go-name": "MergeWhitelistUsernames"
  15006. },
  15007. "protected_file_patterns": {
  15008. "type": "string",
  15009. "x-go-name": "ProtectedFilePatterns"
  15010. },
  15011. "push_whitelist_deploy_keys": {
  15012. "type": "boolean",
  15013. "x-go-name": "PushWhitelistDeployKeys"
  15014. },
  15015. "push_whitelist_teams": {
  15016. "type": "array",
  15017. "items": {
  15018. "type": "string"
  15019. },
  15020. "x-go-name": "PushWhitelistTeams"
  15021. },
  15022. "push_whitelist_usernames": {
  15023. "type": "array",
  15024. "items": {
  15025. "type": "string"
  15026. },
  15027. "x-go-name": "PushWhitelistUsernames"
  15028. },
  15029. "require_signed_commits": {
  15030. "type": "boolean",
  15031. "x-go-name": "RequireSignedCommits"
  15032. },
  15033. "required_approvals": {
  15034. "type": "integer",
  15035. "format": "int64",
  15036. "x-go-name": "RequiredApprovals"
  15037. },
  15038. "rule_name": {
  15039. "type": "string",
  15040. "x-go-name": "RuleName"
  15041. },
  15042. "status_check_contexts": {
  15043. "type": "array",
  15044. "items": {
  15045. "type": "string"
  15046. },
  15047. "x-go-name": "StatusCheckContexts"
  15048. },
  15049. "unprotected_file_patterns": {
  15050. "type": "string",
  15051. "x-go-name": "UnprotectedFilePatterns"
  15052. }
  15053. },
  15054. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15055. },
  15056. "CreateBranchRepoOption": {
  15057. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  15058. "type": "object",
  15059. "required": [
  15060. "new_branch_name"
  15061. ],
  15062. "properties": {
  15063. "new_branch_name": {
  15064. "description": "Name of the branch to create",
  15065. "type": "string",
  15066. "uniqueItems": true,
  15067. "x-go-name": "BranchName"
  15068. },
  15069. "old_branch_name": {
  15070. "description": "Name of the old branch to create from",
  15071. "type": "string",
  15072. "uniqueItems": true,
  15073. "x-go-name": "OldBranchName"
  15074. }
  15075. },
  15076. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15077. },
  15078. "CreateEmailOption": {
  15079. "description": "CreateEmailOption options when creating email addresses",
  15080. "type": "object",
  15081. "properties": {
  15082. "emails": {
  15083. "description": "email addresses to add",
  15084. "type": "array",
  15085. "items": {
  15086. "type": "string"
  15087. },
  15088. "x-go-name": "Emails"
  15089. }
  15090. },
  15091. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15092. },
  15093. "CreateFileOptions": {
  15094. "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)",
  15095. "type": "object",
  15096. "required": [
  15097. "content"
  15098. ],
  15099. "properties": {
  15100. "author": {
  15101. "$ref": "#/definitions/Identity"
  15102. },
  15103. "branch": {
  15104. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  15105. "type": "string",
  15106. "x-go-name": "BranchName"
  15107. },
  15108. "committer": {
  15109. "$ref": "#/definitions/Identity"
  15110. },
  15111. "content": {
  15112. "description": "content must be base64 encoded",
  15113. "type": "string",
  15114. "x-go-name": "Content"
  15115. },
  15116. "dates": {
  15117. "$ref": "#/definitions/CommitDateOptions"
  15118. },
  15119. "message": {
  15120. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  15121. "type": "string",
  15122. "x-go-name": "Message"
  15123. },
  15124. "new_branch": {
  15125. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  15126. "type": "string",
  15127. "x-go-name": "NewBranchName"
  15128. },
  15129. "signoff": {
  15130. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  15131. "type": "boolean",
  15132. "x-go-name": "Signoff"
  15133. }
  15134. },
  15135. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15136. },
  15137. "CreateForkOption": {
  15138. "description": "CreateForkOption options for creating a fork",
  15139. "type": "object",
  15140. "properties": {
  15141. "name": {
  15142. "description": "name of the forked repository",
  15143. "type": "string",
  15144. "x-go-name": "Name"
  15145. },
  15146. "organization": {
  15147. "description": "organization name, if forking into an organization",
  15148. "type": "string",
  15149. "x-go-name": "Organization"
  15150. }
  15151. },
  15152. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15153. },
  15154. "CreateGPGKeyOption": {
  15155. "description": "CreateGPGKeyOption options create user GPG key",
  15156. "type": "object",
  15157. "required": [
  15158. "armored_public_key"
  15159. ],
  15160. "properties": {
  15161. "armored_public_key": {
  15162. "description": "An armored GPG key to add",
  15163. "type": "string",
  15164. "uniqueItems": true,
  15165. "x-go-name": "ArmoredKey"
  15166. },
  15167. "armored_signature": {
  15168. "type": "string",
  15169. "x-go-name": "Signature"
  15170. }
  15171. },
  15172. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15173. },
  15174. "CreateHookOption": {
  15175. "description": "CreateHookOption options when create a hook",
  15176. "type": "object",
  15177. "required": [
  15178. "type",
  15179. "config"
  15180. ],
  15181. "properties": {
  15182. "active": {
  15183. "type": "boolean",
  15184. "default": false,
  15185. "x-go-name": "Active"
  15186. },
  15187. "authorization_header": {
  15188. "type": "string",
  15189. "x-go-name": "AuthorizationHeader"
  15190. },
  15191. "branch_filter": {
  15192. "type": "string",
  15193. "x-go-name": "BranchFilter"
  15194. },
  15195. "config": {
  15196. "$ref": "#/definitions/CreateHookOptionConfig"
  15197. },
  15198. "events": {
  15199. "type": "array",
  15200. "items": {
  15201. "type": "string"
  15202. },
  15203. "x-go-name": "Events"
  15204. },
  15205. "type": {
  15206. "type": "string",
  15207. "enum": [
  15208. "dingtalk",
  15209. "discord",
  15210. "gitea",
  15211. "gogs",
  15212. "msteams",
  15213. "slack",
  15214. "telegram",
  15215. "feishu",
  15216. "wechatwork",
  15217. "packagist"
  15218. ],
  15219. "x-go-name": "Type"
  15220. }
  15221. },
  15222. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15223. },
  15224. "CreateHookOptionConfig": {
  15225. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  15226. "type": "object",
  15227. "additionalProperties": {
  15228. "type": "string"
  15229. },
  15230. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15231. },
  15232. "CreateIssueCommentOption": {
  15233. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  15234. "type": "object",
  15235. "required": [
  15236. "body"
  15237. ],
  15238. "properties": {
  15239. "body": {
  15240. "type": "string",
  15241. "x-go-name": "Body"
  15242. }
  15243. },
  15244. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15245. },
  15246. "CreateIssueOption": {
  15247. "description": "CreateIssueOption options to create one issue",
  15248. "type": "object",
  15249. "required": [
  15250. "title"
  15251. ],
  15252. "properties": {
  15253. "assignee": {
  15254. "description": "deprecated",
  15255. "type": "string",
  15256. "x-go-name": "Assignee"
  15257. },
  15258. "assignees": {
  15259. "type": "array",
  15260. "items": {
  15261. "type": "string"
  15262. },
  15263. "x-go-name": "Assignees"
  15264. },
  15265. "body": {
  15266. "type": "string",
  15267. "x-go-name": "Body"
  15268. },
  15269. "closed": {
  15270. "type": "boolean",
  15271. "x-go-name": "Closed"
  15272. },
  15273. "due_date": {
  15274. "type": "string",
  15275. "format": "date-time",
  15276. "x-go-name": "Deadline"
  15277. },
  15278. "labels": {
  15279. "description": "list of label ids",
  15280. "type": "array",
  15281. "items": {
  15282. "type": "integer",
  15283. "format": "int64"
  15284. },
  15285. "x-go-name": "Labels"
  15286. },
  15287. "milestone": {
  15288. "description": "milestone id",
  15289. "type": "integer",
  15290. "format": "int64",
  15291. "x-go-name": "Milestone"
  15292. },
  15293. "ref": {
  15294. "type": "string",
  15295. "x-go-name": "Ref"
  15296. },
  15297. "title": {
  15298. "type": "string",
  15299. "x-go-name": "Title"
  15300. }
  15301. },
  15302. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15303. },
  15304. "CreateKeyOption": {
  15305. "description": "CreateKeyOption options when creating a key",
  15306. "type": "object",
  15307. "required": [
  15308. "title",
  15309. "key"
  15310. ],
  15311. "properties": {
  15312. "key": {
  15313. "description": "An armored SSH key to add",
  15314. "type": "string",
  15315. "uniqueItems": true,
  15316. "x-go-name": "Key"
  15317. },
  15318. "read_only": {
  15319. "description": "Describe if the key has only read access or read/write",
  15320. "type": "boolean",
  15321. "x-go-name": "ReadOnly"
  15322. },
  15323. "title": {
  15324. "description": "Title of the key to add",
  15325. "type": "string",
  15326. "uniqueItems": true,
  15327. "x-go-name": "Title"
  15328. }
  15329. },
  15330. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15331. },
  15332. "CreateLabelOption": {
  15333. "description": "CreateLabelOption options for creating a label",
  15334. "type": "object",
  15335. "required": [
  15336. "name",
  15337. "color"
  15338. ],
  15339. "properties": {
  15340. "color": {
  15341. "type": "string",
  15342. "x-go-name": "Color",
  15343. "example": "#00aabb"
  15344. },
  15345. "description": {
  15346. "type": "string",
  15347. "x-go-name": "Description"
  15348. },
  15349. "name": {
  15350. "type": "string",
  15351. "x-go-name": "Name"
  15352. }
  15353. },
  15354. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15355. },
  15356. "CreateMilestoneOption": {
  15357. "description": "CreateMilestoneOption options for creating a milestone",
  15358. "type": "object",
  15359. "properties": {
  15360. "description": {
  15361. "type": "string",
  15362. "x-go-name": "Description"
  15363. },
  15364. "due_on": {
  15365. "type": "string",
  15366. "format": "date-time",
  15367. "x-go-name": "Deadline"
  15368. },
  15369. "state": {
  15370. "type": "string",
  15371. "enum": [
  15372. "open",
  15373. "closed"
  15374. ],
  15375. "x-go-name": "State"
  15376. },
  15377. "title": {
  15378. "type": "string",
  15379. "x-go-name": "Title"
  15380. }
  15381. },
  15382. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15383. },
  15384. "CreateOAuth2ApplicationOptions": {
  15385. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  15386. "type": "object",
  15387. "properties": {
  15388. "confidential_client": {
  15389. "type": "boolean",
  15390. "x-go-name": "ConfidentialClient"
  15391. },
  15392. "name": {
  15393. "type": "string",
  15394. "x-go-name": "Name"
  15395. },
  15396. "redirect_uris": {
  15397. "type": "array",
  15398. "items": {
  15399. "type": "string"
  15400. },
  15401. "x-go-name": "RedirectURIs"
  15402. }
  15403. },
  15404. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15405. },
  15406. "CreateOrgOption": {
  15407. "description": "CreateOrgOption options for creating an organization",
  15408. "type": "object",
  15409. "required": [
  15410. "username"
  15411. ],
  15412. "properties": {
  15413. "description": {
  15414. "type": "string",
  15415. "x-go-name": "Description"
  15416. },
  15417. "full_name": {
  15418. "type": "string",
  15419. "x-go-name": "FullName"
  15420. },
  15421. "location": {
  15422. "type": "string",
  15423. "x-go-name": "Location"
  15424. },
  15425. "repo_admin_change_team_access": {
  15426. "type": "boolean",
  15427. "x-go-name": "RepoAdminChangeTeamAccess"
  15428. },
  15429. "username": {
  15430. "type": "string",
  15431. "x-go-name": "UserName"
  15432. },
  15433. "visibility": {
  15434. "description": "possible values are `public` (default), `limited` or `private`",
  15435. "type": "string",
  15436. "enum": [
  15437. "public",
  15438. "limited",
  15439. "private"
  15440. ],
  15441. "x-go-name": "Visibility"
  15442. },
  15443. "website": {
  15444. "type": "string",
  15445. "x-go-name": "Website"
  15446. }
  15447. },
  15448. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15449. },
  15450. "CreatePullRequestOption": {
  15451. "description": "CreatePullRequestOption options when creating a pull request",
  15452. "type": "object",
  15453. "properties": {
  15454. "assignee": {
  15455. "type": "string",
  15456. "x-go-name": "Assignee"
  15457. },
  15458. "assignees": {
  15459. "type": "array",
  15460. "items": {
  15461. "type": "string"
  15462. },
  15463. "x-go-name": "Assignees"
  15464. },
  15465. "base": {
  15466. "type": "string",
  15467. "x-go-name": "Base"
  15468. },
  15469. "body": {
  15470. "type": "string",
  15471. "x-go-name": "Body"
  15472. },
  15473. "due_date": {
  15474. "type": "string",
  15475. "format": "date-time",
  15476. "x-go-name": "Deadline"
  15477. },
  15478. "head": {
  15479. "type": "string",
  15480. "x-go-name": "Head"
  15481. },
  15482. "labels": {
  15483. "type": "array",
  15484. "items": {
  15485. "type": "integer",
  15486. "format": "int64"
  15487. },
  15488. "x-go-name": "Labels"
  15489. },
  15490. "milestone": {
  15491. "type": "integer",
  15492. "format": "int64",
  15493. "x-go-name": "Milestone"
  15494. },
  15495. "title": {
  15496. "type": "string",
  15497. "x-go-name": "Title"
  15498. }
  15499. },
  15500. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15501. },
  15502. "CreatePullReviewComment": {
  15503. "description": "CreatePullReviewComment represent a review comment for creation api",
  15504. "type": "object",
  15505. "properties": {
  15506. "body": {
  15507. "type": "string",
  15508. "x-go-name": "Body"
  15509. },
  15510. "new_position": {
  15511. "description": "if comment to new file line or 0",
  15512. "type": "integer",
  15513. "format": "int64",
  15514. "x-go-name": "NewLineNum"
  15515. },
  15516. "old_position": {
  15517. "description": "if comment to old file line or 0",
  15518. "type": "integer",
  15519. "format": "int64",
  15520. "x-go-name": "OldLineNum"
  15521. },
  15522. "path": {
  15523. "description": "the tree path",
  15524. "type": "string",
  15525. "x-go-name": "Path"
  15526. }
  15527. },
  15528. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15529. },
  15530. "CreatePullReviewOptions": {
  15531. "description": "CreatePullReviewOptions are options to create a pull review",
  15532. "type": "object",
  15533. "properties": {
  15534. "body": {
  15535. "type": "string",
  15536. "x-go-name": "Body"
  15537. },
  15538. "comments": {
  15539. "type": "array",
  15540. "items": {
  15541. "$ref": "#/definitions/CreatePullReviewComment"
  15542. },
  15543. "x-go-name": "Comments"
  15544. },
  15545. "commit_id": {
  15546. "type": "string",
  15547. "x-go-name": "CommitID"
  15548. },
  15549. "event": {
  15550. "$ref": "#/definitions/ReviewStateType"
  15551. }
  15552. },
  15553. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15554. },
  15555. "CreatePushMirrorOption": {
  15556. "type": "object",
  15557. "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
  15558. "properties": {
  15559. "interval": {
  15560. "type": "string",
  15561. "x-go-name": "Interval"
  15562. },
  15563. "remote_address": {
  15564. "type": "string",
  15565. "x-go-name": "RemoteAddress"
  15566. },
  15567. "remote_password": {
  15568. "type": "string",
  15569. "x-go-name": "RemotePassword"
  15570. },
  15571. "remote_username": {
  15572. "type": "string",
  15573. "x-go-name": "RemoteUsername"
  15574. },
  15575. "sync_on_commit": {
  15576. "type": "boolean",
  15577. "x-go-name": "SyncOnCommit"
  15578. }
  15579. },
  15580. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15581. },
  15582. "CreateReleaseOption": {
  15583. "description": "CreateReleaseOption options when creating a release",
  15584. "type": "object",
  15585. "required": [
  15586. "tag_name"
  15587. ],
  15588. "properties": {
  15589. "body": {
  15590. "type": "string",
  15591. "x-go-name": "Note"
  15592. },
  15593. "draft": {
  15594. "type": "boolean",
  15595. "x-go-name": "IsDraft"
  15596. },
  15597. "name": {
  15598. "type": "string",
  15599. "x-go-name": "Title"
  15600. },
  15601. "prerelease": {
  15602. "type": "boolean",
  15603. "x-go-name": "IsPrerelease"
  15604. },
  15605. "tag_name": {
  15606. "type": "string",
  15607. "x-go-name": "TagName"
  15608. },
  15609. "target_commitish": {
  15610. "type": "string",
  15611. "x-go-name": "Target"
  15612. }
  15613. },
  15614. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15615. },
  15616. "CreateRepoOption": {
  15617. "description": "CreateRepoOption options when creating repository",
  15618. "type": "object",
  15619. "required": [
  15620. "name"
  15621. ],
  15622. "properties": {
  15623. "auto_init": {
  15624. "description": "Whether the repository should be auto-initialized?",
  15625. "type": "boolean",
  15626. "x-go-name": "AutoInit"
  15627. },
  15628. "default_branch": {
  15629. "description": "DefaultBranch of the repository (used when initializes and in template)",
  15630. "type": "string",
  15631. "x-go-name": "DefaultBranch"
  15632. },
  15633. "description": {
  15634. "description": "Description of the repository to create",
  15635. "type": "string",
  15636. "x-go-name": "Description"
  15637. },
  15638. "gitignores": {
  15639. "description": "Gitignores to use",
  15640. "type": "string",
  15641. "x-go-name": "Gitignores"
  15642. },
  15643. "issue_labels": {
  15644. "description": "Label-Set to use",
  15645. "type": "string",
  15646. "x-go-name": "IssueLabels"
  15647. },
  15648. "license": {
  15649. "description": "License to use",
  15650. "type": "string",
  15651. "x-go-name": "License"
  15652. },
  15653. "name": {
  15654. "description": "Name of the repository to create",
  15655. "type": "string",
  15656. "uniqueItems": true,
  15657. "x-go-name": "Name"
  15658. },
  15659. "private": {
  15660. "description": "Whether the repository is private",
  15661. "type": "boolean",
  15662. "x-go-name": "Private"
  15663. },
  15664. "readme": {
  15665. "description": "Readme of the repository to create",
  15666. "type": "string",
  15667. "x-go-name": "Readme"
  15668. },
  15669. "template": {
  15670. "description": "Whether the repository is template",
  15671. "type": "boolean",
  15672. "x-go-name": "Template"
  15673. },
  15674. "trust_model": {
  15675. "description": "TrustModel of the repository",
  15676. "type": "string",
  15677. "enum": [
  15678. "default",
  15679. "collaborator",
  15680. "committer",
  15681. "collaboratorcommitter"
  15682. ],
  15683. "x-go-name": "TrustModel"
  15684. }
  15685. },
  15686. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15687. },
  15688. "CreateStatusOption": {
  15689. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  15690. "type": "object",
  15691. "properties": {
  15692. "context": {
  15693. "type": "string",
  15694. "x-go-name": "Context"
  15695. },
  15696. "description": {
  15697. "type": "string",
  15698. "x-go-name": "Description"
  15699. },
  15700. "state": {
  15701. "$ref": "#/definitions/CommitStatusState"
  15702. },
  15703. "target_url": {
  15704. "type": "string",
  15705. "x-go-name": "TargetURL"
  15706. }
  15707. },
  15708. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15709. },
  15710. "CreateTagOption": {
  15711. "description": "CreateTagOption options when creating a tag",
  15712. "type": "object",
  15713. "required": [
  15714. "tag_name"
  15715. ],
  15716. "properties": {
  15717. "message": {
  15718. "type": "string",
  15719. "x-go-name": "Message"
  15720. },
  15721. "tag_name": {
  15722. "type": "string",
  15723. "x-go-name": "TagName"
  15724. },
  15725. "target": {
  15726. "type": "string",
  15727. "x-go-name": "Target"
  15728. }
  15729. },
  15730. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15731. },
  15732. "CreateTeamOption": {
  15733. "description": "CreateTeamOption options for creating a team",
  15734. "type": "object",
  15735. "required": [
  15736. "name"
  15737. ],
  15738. "properties": {
  15739. "can_create_org_repo": {
  15740. "type": "boolean",
  15741. "x-go-name": "CanCreateOrgRepo"
  15742. },
  15743. "description": {
  15744. "type": "string",
  15745. "x-go-name": "Description"
  15746. },
  15747. "includes_all_repositories": {
  15748. "type": "boolean",
  15749. "x-go-name": "IncludesAllRepositories"
  15750. },
  15751. "name": {
  15752. "type": "string",
  15753. "x-go-name": "Name"
  15754. },
  15755. "permission": {
  15756. "type": "string",
  15757. "enum": [
  15758. "read",
  15759. "write",
  15760. "admin"
  15761. ],
  15762. "x-go-name": "Permission"
  15763. },
  15764. "units": {
  15765. "type": "array",
  15766. "items": {
  15767. "type": "string"
  15768. },
  15769. "x-go-name": "Units",
  15770. "example": [
  15771. "repo.code",
  15772. "repo.issues",
  15773. "repo.ext_issues",
  15774. "repo.wiki",
  15775. "repo.pulls",
  15776. "repo.releases",
  15777. "repo.projects",
  15778. "repo.ext_wiki"
  15779. ]
  15780. },
  15781. "units_map": {
  15782. "type": "object",
  15783. "additionalProperties": {
  15784. "type": "string"
  15785. },
  15786. "x-go-name": "UnitsMap",
  15787. "example": {
  15788. "repo.code": "read",
  15789. "repo.ext_issues": "none",
  15790. "repo.ext_wiki": "none",
  15791. "repo.issues": "write",
  15792. "repo.projects": "none",
  15793. "repo.pulls": "owner",
  15794. "repo.releases": "none",
  15795. "repo.wiki": "admin"
  15796. }
  15797. }
  15798. },
  15799. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15800. },
  15801. "CreateUserOption": {
  15802. "description": "CreateUserOption create user options",
  15803. "type": "object",
  15804. "required": [
  15805. "username",
  15806. "email",
  15807. "password"
  15808. ],
  15809. "properties": {
  15810. "email": {
  15811. "type": "string",
  15812. "format": "email",
  15813. "x-go-name": "Email"
  15814. },
  15815. "full_name": {
  15816. "type": "string",
  15817. "x-go-name": "FullName"
  15818. },
  15819. "login_name": {
  15820. "type": "string",
  15821. "x-go-name": "LoginName"
  15822. },
  15823. "must_change_password": {
  15824. "type": "boolean",
  15825. "x-go-name": "MustChangePassword"
  15826. },
  15827. "password": {
  15828. "type": "string",
  15829. "x-go-name": "Password"
  15830. },
  15831. "restricted": {
  15832. "type": "boolean",
  15833. "x-go-name": "Restricted"
  15834. },
  15835. "send_notify": {
  15836. "type": "boolean",
  15837. "x-go-name": "SendNotify"
  15838. },
  15839. "source_id": {
  15840. "type": "integer",
  15841. "format": "int64",
  15842. "x-go-name": "SourceID"
  15843. },
  15844. "username": {
  15845. "type": "string",
  15846. "x-go-name": "Username"
  15847. },
  15848. "visibility": {
  15849. "type": "string",
  15850. "x-go-name": "Visibility"
  15851. }
  15852. },
  15853. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15854. },
  15855. "CreateWikiPageOptions": {
  15856. "description": "CreateWikiPageOptions form for creating wiki",
  15857. "type": "object",
  15858. "properties": {
  15859. "content_base64": {
  15860. "description": "content must be base64 encoded",
  15861. "type": "string",
  15862. "x-go-name": "ContentBase64"
  15863. },
  15864. "message": {
  15865. "description": "optional commit message summarizing the change",
  15866. "type": "string",
  15867. "x-go-name": "Message"
  15868. },
  15869. "title": {
  15870. "description": "page title. leave empty to keep unchanged",
  15871. "type": "string",
  15872. "x-go-name": "Title"
  15873. }
  15874. },
  15875. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15876. },
  15877. "Cron": {
  15878. "description": "Cron represents a Cron task",
  15879. "type": "object",
  15880. "properties": {
  15881. "exec_times": {
  15882. "type": "integer",
  15883. "format": "int64",
  15884. "x-go-name": "ExecTimes"
  15885. },
  15886. "name": {
  15887. "type": "string",
  15888. "x-go-name": "Name"
  15889. },
  15890. "next": {
  15891. "type": "string",
  15892. "format": "date-time",
  15893. "x-go-name": "Next"
  15894. },
  15895. "prev": {
  15896. "type": "string",
  15897. "format": "date-time",
  15898. "x-go-name": "Prev"
  15899. },
  15900. "schedule": {
  15901. "type": "string",
  15902. "x-go-name": "Schedule"
  15903. }
  15904. },
  15905. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15906. },
  15907. "DeleteEmailOption": {
  15908. "description": "DeleteEmailOption options when deleting email addresses",
  15909. "type": "object",
  15910. "properties": {
  15911. "emails": {
  15912. "description": "email addresses to delete",
  15913. "type": "array",
  15914. "items": {
  15915. "type": "string"
  15916. },
  15917. "x-go-name": "Emails"
  15918. }
  15919. },
  15920. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15921. },
  15922. "DeleteFileOptions": {
  15923. "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)",
  15924. "type": "object",
  15925. "required": [
  15926. "sha"
  15927. ],
  15928. "properties": {
  15929. "author": {
  15930. "$ref": "#/definitions/Identity"
  15931. },
  15932. "branch": {
  15933. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  15934. "type": "string",
  15935. "x-go-name": "BranchName"
  15936. },
  15937. "committer": {
  15938. "$ref": "#/definitions/Identity"
  15939. },
  15940. "dates": {
  15941. "$ref": "#/definitions/CommitDateOptions"
  15942. },
  15943. "message": {
  15944. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  15945. "type": "string",
  15946. "x-go-name": "Message"
  15947. },
  15948. "new_branch": {
  15949. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  15950. "type": "string",
  15951. "x-go-name": "NewBranchName"
  15952. },
  15953. "sha": {
  15954. "description": "sha is the SHA for the file that already exists",
  15955. "type": "string",
  15956. "x-go-name": "SHA"
  15957. },
  15958. "signoff": {
  15959. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  15960. "type": "boolean",
  15961. "x-go-name": "Signoff"
  15962. }
  15963. },
  15964. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15965. },
  15966. "DeployKey": {
  15967. "description": "DeployKey a deploy key",
  15968. "type": "object",
  15969. "properties": {
  15970. "created_at": {
  15971. "type": "string",
  15972. "format": "date-time",
  15973. "x-go-name": "Created"
  15974. },
  15975. "fingerprint": {
  15976. "type": "string",
  15977. "x-go-name": "Fingerprint"
  15978. },
  15979. "id": {
  15980. "type": "integer",
  15981. "format": "int64",
  15982. "x-go-name": "ID"
  15983. },
  15984. "key": {
  15985. "type": "string",
  15986. "x-go-name": "Key"
  15987. },
  15988. "key_id": {
  15989. "type": "integer",
  15990. "format": "int64",
  15991. "x-go-name": "KeyID"
  15992. },
  15993. "read_only": {
  15994. "type": "boolean",
  15995. "x-go-name": "ReadOnly"
  15996. },
  15997. "repository": {
  15998. "$ref": "#/definitions/Repository"
  15999. },
  16000. "title": {
  16001. "type": "string",
  16002. "x-go-name": "Title"
  16003. },
  16004. "url": {
  16005. "type": "string",
  16006. "x-go-name": "URL"
  16007. }
  16008. },
  16009. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16010. },
  16011. "DismissPullReviewOptions": {
  16012. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  16013. "type": "object",
  16014. "properties": {
  16015. "message": {
  16016. "type": "string",
  16017. "x-go-name": "Message"
  16018. },
  16019. "priors": {
  16020. "type": "boolean",
  16021. "x-go-name": "Priors"
  16022. }
  16023. },
  16024. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16025. },
  16026. "EditAttachmentOptions": {
  16027. "description": "EditAttachmentOptions options for editing attachments",
  16028. "type": "object",
  16029. "properties": {
  16030. "name": {
  16031. "type": "string",
  16032. "x-go-name": "Name"
  16033. }
  16034. },
  16035. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16036. },
  16037. "EditBranchProtectionOption": {
  16038. "description": "EditBranchProtectionOption options for editing a branch protection",
  16039. "type": "object",
  16040. "properties": {
  16041. "approvals_whitelist_teams": {
  16042. "type": "array",
  16043. "items": {
  16044. "type": "string"
  16045. },
  16046. "x-go-name": "ApprovalsWhitelistTeams"
  16047. },
  16048. "approvals_whitelist_username": {
  16049. "type": "array",
  16050. "items": {
  16051. "type": "string"
  16052. },
  16053. "x-go-name": "ApprovalsWhitelistUsernames"
  16054. },
  16055. "block_on_official_review_requests": {
  16056. "type": "boolean",
  16057. "x-go-name": "BlockOnOfficialReviewRequests"
  16058. },
  16059. "block_on_outdated_branch": {
  16060. "type": "boolean",
  16061. "x-go-name": "BlockOnOutdatedBranch"
  16062. },
  16063. "block_on_rejected_reviews": {
  16064. "type": "boolean",
  16065. "x-go-name": "BlockOnRejectedReviews"
  16066. },
  16067. "dismiss_stale_approvals": {
  16068. "type": "boolean",
  16069. "x-go-name": "DismissStaleApprovals"
  16070. },
  16071. "enable_approvals_whitelist": {
  16072. "type": "boolean",
  16073. "x-go-name": "EnableApprovalsWhitelist"
  16074. },
  16075. "enable_merge_whitelist": {
  16076. "type": "boolean",
  16077. "x-go-name": "EnableMergeWhitelist"
  16078. },
  16079. "enable_push": {
  16080. "type": "boolean",
  16081. "x-go-name": "EnablePush"
  16082. },
  16083. "enable_push_whitelist": {
  16084. "type": "boolean",
  16085. "x-go-name": "EnablePushWhitelist"
  16086. },
  16087. "enable_status_check": {
  16088. "type": "boolean",
  16089. "x-go-name": "EnableStatusCheck"
  16090. },
  16091. "merge_whitelist_teams": {
  16092. "type": "array",
  16093. "items": {
  16094. "type": "string"
  16095. },
  16096. "x-go-name": "MergeWhitelistTeams"
  16097. },
  16098. "merge_whitelist_usernames": {
  16099. "type": "array",
  16100. "items": {
  16101. "type": "string"
  16102. },
  16103. "x-go-name": "MergeWhitelistUsernames"
  16104. },
  16105. "protected_file_patterns": {
  16106. "type": "string",
  16107. "x-go-name": "ProtectedFilePatterns"
  16108. },
  16109. "push_whitelist_deploy_keys": {
  16110. "type": "boolean",
  16111. "x-go-name": "PushWhitelistDeployKeys"
  16112. },
  16113. "push_whitelist_teams": {
  16114. "type": "array",
  16115. "items": {
  16116. "type": "string"
  16117. },
  16118. "x-go-name": "PushWhitelistTeams"
  16119. },
  16120. "push_whitelist_usernames": {
  16121. "type": "array",
  16122. "items": {
  16123. "type": "string"
  16124. },
  16125. "x-go-name": "PushWhitelistUsernames"
  16126. },
  16127. "require_signed_commits": {
  16128. "type": "boolean",
  16129. "x-go-name": "RequireSignedCommits"
  16130. },
  16131. "required_approvals": {
  16132. "type": "integer",
  16133. "format": "int64",
  16134. "x-go-name": "RequiredApprovals"
  16135. },
  16136. "status_check_contexts": {
  16137. "type": "array",
  16138. "items": {
  16139. "type": "string"
  16140. },
  16141. "x-go-name": "StatusCheckContexts"
  16142. },
  16143. "unprotected_file_patterns": {
  16144. "type": "string",
  16145. "x-go-name": "UnprotectedFilePatterns"
  16146. }
  16147. },
  16148. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16149. },
  16150. "EditDeadlineOption": {
  16151. "description": "EditDeadlineOption options for creating a deadline",
  16152. "type": "object",
  16153. "required": [
  16154. "due_date"
  16155. ],
  16156. "properties": {
  16157. "due_date": {
  16158. "type": "string",
  16159. "format": "date-time",
  16160. "x-go-name": "Deadline"
  16161. }
  16162. },
  16163. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16164. },
  16165. "EditGitHookOption": {
  16166. "description": "EditGitHookOption options when modifying one Git hook",
  16167. "type": "object",
  16168. "properties": {
  16169. "content": {
  16170. "type": "string",
  16171. "x-go-name": "Content"
  16172. }
  16173. },
  16174. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16175. },
  16176. "EditHookOption": {
  16177. "description": "EditHookOption options when modify one hook",
  16178. "type": "object",
  16179. "properties": {
  16180. "active": {
  16181. "type": "boolean",
  16182. "x-go-name": "Active"
  16183. },
  16184. "authorization_header": {
  16185. "type": "string",
  16186. "x-go-name": "AuthorizationHeader"
  16187. },
  16188. "branch_filter": {
  16189. "type": "string",
  16190. "x-go-name": "BranchFilter"
  16191. },
  16192. "config": {
  16193. "type": "object",
  16194. "additionalProperties": {
  16195. "type": "string"
  16196. },
  16197. "x-go-name": "Config"
  16198. },
  16199. "events": {
  16200. "type": "array",
  16201. "items": {
  16202. "type": "string"
  16203. },
  16204. "x-go-name": "Events"
  16205. }
  16206. },
  16207. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16208. },
  16209. "EditIssueCommentOption": {
  16210. "description": "EditIssueCommentOption options for editing a comment",
  16211. "type": "object",
  16212. "required": [
  16213. "body"
  16214. ],
  16215. "properties": {
  16216. "body": {
  16217. "type": "string",
  16218. "x-go-name": "Body"
  16219. }
  16220. },
  16221. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16222. },
  16223. "EditIssueOption": {
  16224. "description": "EditIssueOption options for editing an issue",
  16225. "type": "object",
  16226. "properties": {
  16227. "assignee": {
  16228. "description": "deprecated",
  16229. "type": "string",
  16230. "x-go-name": "Assignee"
  16231. },
  16232. "assignees": {
  16233. "type": "array",
  16234. "items": {
  16235. "type": "string"
  16236. },
  16237. "x-go-name": "Assignees"
  16238. },
  16239. "body": {
  16240. "type": "string",
  16241. "x-go-name": "Body"
  16242. },
  16243. "due_date": {
  16244. "type": "string",
  16245. "format": "date-time",
  16246. "x-go-name": "Deadline"
  16247. },
  16248. "milestone": {
  16249. "type": "integer",
  16250. "format": "int64",
  16251. "x-go-name": "Milestone"
  16252. },
  16253. "ref": {
  16254. "type": "string",
  16255. "x-go-name": "Ref"
  16256. },
  16257. "state": {
  16258. "type": "string",
  16259. "x-go-name": "State"
  16260. },
  16261. "title": {
  16262. "type": "string",
  16263. "x-go-name": "Title"
  16264. },
  16265. "unset_due_date": {
  16266. "type": "boolean",
  16267. "x-go-name": "RemoveDeadline"
  16268. }
  16269. },
  16270. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16271. },
  16272. "EditLabelOption": {
  16273. "description": "EditLabelOption options for editing a label",
  16274. "type": "object",
  16275. "properties": {
  16276. "color": {
  16277. "type": "string",
  16278. "x-go-name": "Color"
  16279. },
  16280. "description": {
  16281. "type": "string",
  16282. "x-go-name": "Description"
  16283. },
  16284. "name": {
  16285. "type": "string",
  16286. "x-go-name": "Name"
  16287. }
  16288. },
  16289. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16290. },
  16291. "EditMilestoneOption": {
  16292. "description": "EditMilestoneOption options for editing a milestone",
  16293. "type": "object",
  16294. "properties": {
  16295. "description": {
  16296. "type": "string",
  16297. "x-go-name": "Description"
  16298. },
  16299. "due_on": {
  16300. "type": "string",
  16301. "format": "date-time",
  16302. "x-go-name": "Deadline"
  16303. },
  16304. "state": {
  16305. "type": "string",
  16306. "x-go-name": "State"
  16307. },
  16308. "title": {
  16309. "type": "string",
  16310. "x-go-name": "Title"
  16311. }
  16312. },
  16313. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16314. },
  16315. "EditOrgOption": {
  16316. "description": "EditOrgOption options for editing an organization",
  16317. "type": "object",
  16318. "properties": {
  16319. "description": {
  16320. "type": "string",
  16321. "x-go-name": "Description"
  16322. },
  16323. "full_name": {
  16324. "type": "string",
  16325. "x-go-name": "FullName"
  16326. },
  16327. "location": {
  16328. "type": "string",
  16329. "x-go-name": "Location"
  16330. },
  16331. "repo_admin_change_team_access": {
  16332. "type": "boolean",
  16333. "x-go-name": "RepoAdminChangeTeamAccess"
  16334. },
  16335. "visibility": {
  16336. "description": "possible values are `public`, `limited` or `private`",
  16337. "type": "string",
  16338. "enum": [
  16339. "public",
  16340. "limited",
  16341. "private"
  16342. ],
  16343. "x-go-name": "Visibility"
  16344. },
  16345. "website": {
  16346. "type": "string",
  16347. "x-go-name": "Website"
  16348. }
  16349. },
  16350. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16351. },
  16352. "EditPullRequestOption": {
  16353. "description": "EditPullRequestOption options when modify pull request",
  16354. "type": "object",
  16355. "properties": {
  16356. "allow_maintainer_edit": {
  16357. "type": "boolean",
  16358. "x-go-name": "AllowMaintainerEdit"
  16359. },
  16360. "assignee": {
  16361. "type": "string",
  16362. "x-go-name": "Assignee"
  16363. },
  16364. "assignees": {
  16365. "type": "array",
  16366. "items": {
  16367. "type": "string"
  16368. },
  16369. "x-go-name": "Assignees"
  16370. },
  16371. "base": {
  16372. "type": "string",
  16373. "x-go-name": "Base"
  16374. },
  16375. "body": {
  16376. "type": "string",
  16377. "x-go-name": "Body"
  16378. },
  16379. "due_date": {
  16380. "type": "string",
  16381. "format": "date-time",
  16382. "x-go-name": "Deadline"
  16383. },
  16384. "labels": {
  16385. "type": "array",
  16386. "items": {
  16387. "type": "integer",
  16388. "format": "int64"
  16389. },
  16390. "x-go-name": "Labels"
  16391. },
  16392. "milestone": {
  16393. "type": "integer",
  16394. "format": "int64",
  16395. "x-go-name": "Milestone"
  16396. },
  16397. "state": {
  16398. "type": "string",
  16399. "x-go-name": "State"
  16400. },
  16401. "title": {
  16402. "type": "string",
  16403. "x-go-name": "Title"
  16404. },
  16405. "unset_due_date": {
  16406. "type": "boolean",
  16407. "x-go-name": "RemoveDeadline"
  16408. }
  16409. },
  16410. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16411. },
  16412. "EditReactionOption": {
  16413. "description": "EditReactionOption contain the reaction type",
  16414. "type": "object",
  16415. "properties": {
  16416. "content": {
  16417. "type": "string",
  16418. "x-go-name": "Reaction"
  16419. }
  16420. },
  16421. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16422. },
  16423. "EditReleaseOption": {
  16424. "description": "EditReleaseOption options when editing a release",
  16425. "type": "object",
  16426. "properties": {
  16427. "body": {
  16428. "type": "string",
  16429. "x-go-name": "Note"
  16430. },
  16431. "draft": {
  16432. "type": "boolean",
  16433. "x-go-name": "IsDraft"
  16434. },
  16435. "name": {
  16436. "type": "string",
  16437. "x-go-name": "Title"
  16438. },
  16439. "prerelease": {
  16440. "type": "boolean",
  16441. "x-go-name": "IsPrerelease"
  16442. },
  16443. "tag_name": {
  16444. "type": "string",
  16445. "x-go-name": "TagName"
  16446. },
  16447. "target_commitish": {
  16448. "type": "string",
  16449. "x-go-name": "Target"
  16450. }
  16451. },
  16452. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16453. },
  16454. "EditRepoOption": {
  16455. "description": "EditRepoOption options when editing a repository's properties",
  16456. "type": "object",
  16457. "properties": {
  16458. "allow_manual_merge": {
  16459. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
  16460. "type": "boolean",
  16461. "x-go-name": "AllowManualMerge"
  16462. },
  16463. "allow_merge_commits": {
  16464. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  16465. "type": "boolean",
  16466. "x-go-name": "AllowMerge"
  16467. },
  16468. "allow_rebase": {
  16469. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  16470. "type": "boolean",
  16471. "x-go-name": "AllowRebase"
  16472. },
  16473. "allow_rebase_explicit": {
  16474. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
  16475. "type": "boolean",
  16476. "x-go-name": "AllowRebaseMerge"
  16477. },
  16478. "allow_rebase_update": {
  16479. "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
  16480. "type": "boolean",
  16481. "x-go-name": "AllowRebaseUpdate"
  16482. },
  16483. "allow_squash_merge": {
  16484. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  16485. "type": "boolean",
  16486. "x-go-name": "AllowSquash"
  16487. },
  16488. "archived": {
  16489. "description": "set to `true` to archive this repository.",
  16490. "type": "boolean",
  16491. "x-go-name": "Archived"
  16492. },
  16493. "autodetect_manual_merge": {
  16494. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
  16495. "type": "boolean",
  16496. "x-go-name": "AutodetectManualMerge"
  16497. },
  16498. "default_branch": {
  16499. "description": "sets the default branch for this repository.",
  16500. "type": "string",
  16501. "x-go-name": "DefaultBranch"
  16502. },
  16503. "default_delete_branch_after_merge": {
  16504. "description": "set to `true` to delete pr branch after merge by default",
  16505. "type": "boolean",
  16506. "x-go-name": "DefaultDeleteBranchAfterMerge"
  16507. },
  16508. "default_merge_style": {
  16509. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", or \"squash\".",
  16510. "type": "string",
  16511. "x-go-name": "DefaultMergeStyle"
  16512. },
  16513. "description": {
  16514. "description": "a short description of the repository.",
  16515. "type": "string",
  16516. "x-go-name": "Description"
  16517. },
  16518. "enable_prune": {
  16519. "description": "enable prune - remove obsolete remote-tracking references",
  16520. "type": "boolean",
  16521. "x-go-name": "EnablePrune"
  16522. },
  16523. "external_tracker": {
  16524. "$ref": "#/definitions/ExternalTracker"
  16525. },
  16526. "external_wiki": {
  16527. "$ref": "#/definitions/ExternalWiki"
  16528. },
  16529. "has_issues": {
  16530. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  16531. "type": "boolean",
  16532. "x-go-name": "HasIssues"
  16533. },
  16534. "has_projects": {
  16535. "description": "either `true` to enable project unit, or `false` to disable them.",
  16536. "type": "boolean",
  16537. "x-go-name": "HasProjects"
  16538. },
  16539. "has_pull_requests": {
  16540. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  16541. "type": "boolean",
  16542. "x-go-name": "HasPullRequests"
  16543. },
  16544. "has_wiki": {
  16545. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  16546. "type": "boolean",
  16547. "x-go-name": "HasWiki"
  16548. },
  16549. "ignore_whitespace_conflicts": {
  16550. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
  16551. "type": "boolean",
  16552. "x-go-name": "IgnoreWhitespaceConflicts"
  16553. },
  16554. "internal_tracker": {
  16555. "$ref": "#/definitions/InternalTracker"
  16556. },
  16557. "mirror_interval": {
  16558. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  16559. "type": "string",
  16560. "x-go-name": "MirrorInterval"
  16561. },
  16562. "name": {
  16563. "description": "name of the repository",
  16564. "type": "string",
  16565. "uniqueItems": true,
  16566. "x-go-name": "Name"
  16567. },
  16568. "private": {
  16569. "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.",
  16570. "type": "boolean",
  16571. "x-go-name": "Private"
  16572. },
  16573. "template": {
  16574. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  16575. "type": "boolean",
  16576. "x-go-name": "Template"
  16577. },
  16578. "website": {
  16579. "description": "a URL with more information about the repository.",
  16580. "type": "string",
  16581. "x-go-name": "Website"
  16582. }
  16583. },
  16584. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16585. },
  16586. "EditTeamOption": {
  16587. "description": "EditTeamOption options for editing a team",
  16588. "type": "object",
  16589. "required": [
  16590. "name"
  16591. ],
  16592. "properties": {
  16593. "can_create_org_repo": {
  16594. "type": "boolean",
  16595. "x-go-name": "CanCreateOrgRepo"
  16596. },
  16597. "description": {
  16598. "type": "string",
  16599. "x-go-name": "Description"
  16600. },
  16601. "includes_all_repositories": {
  16602. "type": "boolean",
  16603. "x-go-name": "IncludesAllRepositories"
  16604. },
  16605. "name": {
  16606. "type": "string",
  16607. "x-go-name": "Name"
  16608. },
  16609. "permission": {
  16610. "type": "string",
  16611. "enum": [
  16612. "read",
  16613. "write",
  16614. "admin"
  16615. ],
  16616. "x-go-name": "Permission"
  16617. },
  16618. "units": {
  16619. "type": "array",
  16620. "items": {
  16621. "type": "string"
  16622. },
  16623. "x-go-name": "Units",
  16624. "example": [
  16625. "repo.code",
  16626. "repo.issues",
  16627. "repo.ext_issues",
  16628. "repo.wiki",
  16629. "repo.pulls",
  16630. "repo.releases",
  16631. "repo.projects",
  16632. "repo.ext_wiki"
  16633. ]
  16634. },
  16635. "units_map": {
  16636. "type": "object",
  16637. "additionalProperties": {
  16638. "type": "string"
  16639. },
  16640. "x-go-name": "UnitsMap",
  16641. "example": {
  16642. "repo.code": "read",
  16643. "repo.ext_issues": "none",
  16644. "repo.ext_wiki": "none",
  16645. "repo.issues": "write",
  16646. "repo.projects": "none",
  16647. "repo.pulls": "owner",
  16648. "repo.releases": "none",
  16649. "repo.wiki": "admin"
  16650. }
  16651. }
  16652. },
  16653. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16654. },
  16655. "EditUserOption": {
  16656. "description": "EditUserOption edit user options",
  16657. "type": "object",
  16658. "required": [
  16659. "source_id",
  16660. "login_name"
  16661. ],
  16662. "properties": {
  16663. "active": {
  16664. "type": "boolean",
  16665. "x-go-name": "Active"
  16666. },
  16667. "admin": {
  16668. "type": "boolean",
  16669. "x-go-name": "Admin"
  16670. },
  16671. "allow_create_organization": {
  16672. "type": "boolean",
  16673. "x-go-name": "AllowCreateOrganization"
  16674. },
  16675. "allow_git_hook": {
  16676. "type": "boolean",
  16677. "x-go-name": "AllowGitHook"
  16678. },
  16679. "allow_import_local": {
  16680. "type": "boolean",
  16681. "x-go-name": "AllowImportLocal"
  16682. },
  16683. "description": {
  16684. "type": "string",
  16685. "x-go-name": "Description"
  16686. },
  16687. "email": {
  16688. "type": "string",
  16689. "format": "email",
  16690. "x-go-name": "Email"
  16691. },
  16692. "full_name": {
  16693. "type": "string",
  16694. "x-go-name": "FullName"
  16695. },
  16696. "location": {
  16697. "type": "string",
  16698. "x-go-name": "Location"
  16699. },
  16700. "login_name": {
  16701. "type": "string",
  16702. "x-go-name": "LoginName"
  16703. },
  16704. "max_repo_creation": {
  16705. "type": "integer",
  16706. "format": "int64",
  16707. "x-go-name": "MaxRepoCreation"
  16708. },
  16709. "must_change_password": {
  16710. "type": "boolean",
  16711. "x-go-name": "MustChangePassword"
  16712. },
  16713. "password": {
  16714. "type": "string",
  16715. "x-go-name": "Password"
  16716. },
  16717. "prohibit_login": {
  16718. "type": "boolean",
  16719. "x-go-name": "ProhibitLogin"
  16720. },
  16721. "restricted": {
  16722. "type": "boolean",
  16723. "x-go-name": "Restricted"
  16724. },
  16725. "source_id": {
  16726. "type": "integer",
  16727. "format": "int64",
  16728. "x-go-name": "SourceID"
  16729. },
  16730. "visibility": {
  16731. "type": "string",
  16732. "x-go-name": "Visibility"
  16733. },
  16734. "website": {
  16735. "type": "string",
  16736. "x-go-name": "Website"
  16737. }
  16738. },
  16739. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16740. },
  16741. "Email": {
  16742. "description": "Email an email address belonging to a user",
  16743. "type": "object",
  16744. "properties": {
  16745. "email": {
  16746. "type": "string",
  16747. "format": "email",
  16748. "x-go-name": "Email"
  16749. },
  16750. "primary": {
  16751. "type": "boolean",
  16752. "x-go-name": "Primary"
  16753. },
  16754. "verified": {
  16755. "type": "boolean",
  16756. "x-go-name": "Verified"
  16757. }
  16758. },
  16759. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16760. },
  16761. "ExternalTracker": {
  16762. "description": "ExternalTracker represents settings for external tracker",
  16763. "type": "object",
  16764. "properties": {
  16765. "external_tracker_format": {
  16766. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  16767. "type": "string",
  16768. "x-go-name": "ExternalTrackerFormat"
  16769. },
  16770. "external_tracker_regexp_pattern": {
  16771. "description": "External Issue Tracker issue regular expression",
  16772. "type": "string",
  16773. "x-go-name": "ExternalTrackerRegexpPattern"
  16774. },
  16775. "external_tracker_style": {
  16776. "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
  16777. "type": "string",
  16778. "x-go-name": "ExternalTrackerStyle"
  16779. },
  16780. "external_tracker_url": {
  16781. "description": "URL of external issue tracker.",
  16782. "type": "string",
  16783. "x-go-name": "ExternalTrackerURL"
  16784. }
  16785. },
  16786. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16787. },
  16788. "ExternalWiki": {
  16789. "description": "ExternalWiki represents setting for external wiki",
  16790. "type": "object",
  16791. "properties": {
  16792. "external_wiki_url": {
  16793. "description": "URL of external wiki.",
  16794. "type": "string",
  16795. "x-go-name": "ExternalWikiURL"
  16796. }
  16797. },
  16798. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16799. },
  16800. "FileCommitResponse": {
  16801. "type": "object",
  16802. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  16803. "properties": {
  16804. "author": {
  16805. "$ref": "#/definitions/CommitUser"
  16806. },
  16807. "committer": {
  16808. "$ref": "#/definitions/CommitUser"
  16809. },
  16810. "created": {
  16811. "type": "string",
  16812. "format": "date-time",
  16813. "x-go-name": "Created"
  16814. },
  16815. "html_url": {
  16816. "type": "string",
  16817. "x-go-name": "HTMLURL"
  16818. },
  16819. "message": {
  16820. "type": "string",
  16821. "x-go-name": "Message"
  16822. },
  16823. "parents": {
  16824. "type": "array",
  16825. "items": {
  16826. "$ref": "#/definitions/CommitMeta"
  16827. },
  16828. "x-go-name": "Parents"
  16829. },
  16830. "sha": {
  16831. "type": "string",
  16832. "x-go-name": "SHA"
  16833. },
  16834. "tree": {
  16835. "$ref": "#/definitions/CommitMeta"
  16836. },
  16837. "url": {
  16838. "type": "string",
  16839. "x-go-name": "URL"
  16840. }
  16841. },
  16842. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16843. },
  16844. "FileDeleteResponse": {
  16845. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  16846. "type": "object",
  16847. "properties": {
  16848. "commit": {
  16849. "$ref": "#/definitions/FileCommitResponse"
  16850. },
  16851. "content": {
  16852. "x-go-name": "Content"
  16853. },
  16854. "verification": {
  16855. "$ref": "#/definitions/PayloadCommitVerification"
  16856. }
  16857. },
  16858. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16859. },
  16860. "FileLinksResponse": {
  16861. "description": "FileLinksResponse contains the links for a repo's file",
  16862. "type": "object",
  16863. "properties": {
  16864. "git": {
  16865. "type": "string",
  16866. "x-go-name": "GitURL"
  16867. },
  16868. "html": {
  16869. "type": "string",
  16870. "x-go-name": "HTMLURL"
  16871. },
  16872. "self": {
  16873. "type": "string",
  16874. "x-go-name": "Self"
  16875. }
  16876. },
  16877. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16878. },
  16879. "FileResponse": {
  16880. "description": "FileResponse contains information about a repo's file",
  16881. "type": "object",
  16882. "properties": {
  16883. "commit": {
  16884. "$ref": "#/definitions/FileCommitResponse"
  16885. },
  16886. "content": {
  16887. "$ref": "#/definitions/ContentsResponse"
  16888. },
  16889. "verification": {
  16890. "$ref": "#/definitions/PayloadCommitVerification"
  16891. }
  16892. },
  16893. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16894. },
  16895. "GPGKey": {
  16896. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  16897. "type": "object",
  16898. "properties": {
  16899. "can_certify": {
  16900. "type": "boolean",
  16901. "x-go-name": "CanCertify"
  16902. },
  16903. "can_encrypt_comms": {
  16904. "type": "boolean",
  16905. "x-go-name": "CanEncryptComms"
  16906. },
  16907. "can_encrypt_storage": {
  16908. "type": "boolean",
  16909. "x-go-name": "CanEncryptStorage"
  16910. },
  16911. "can_sign": {
  16912. "type": "boolean",
  16913. "x-go-name": "CanSign"
  16914. },
  16915. "created_at": {
  16916. "type": "string",
  16917. "format": "date-time",
  16918. "x-go-name": "Created"
  16919. },
  16920. "emails": {
  16921. "type": "array",
  16922. "items": {
  16923. "$ref": "#/definitions/GPGKeyEmail"
  16924. },
  16925. "x-go-name": "Emails"
  16926. },
  16927. "expires_at": {
  16928. "type": "string",
  16929. "format": "date-time",
  16930. "x-go-name": "Expires"
  16931. },
  16932. "id": {
  16933. "type": "integer",
  16934. "format": "int64",
  16935. "x-go-name": "ID"
  16936. },
  16937. "key_id": {
  16938. "type": "string",
  16939. "x-go-name": "KeyID"
  16940. },
  16941. "primary_key_id": {
  16942. "type": "string",
  16943. "x-go-name": "PrimaryKeyID"
  16944. },
  16945. "public_key": {
  16946. "type": "string",
  16947. "x-go-name": "PublicKey"
  16948. },
  16949. "subkeys": {
  16950. "type": "array",
  16951. "items": {
  16952. "$ref": "#/definitions/GPGKey"
  16953. },
  16954. "x-go-name": "SubsKey"
  16955. },
  16956. "verified": {
  16957. "type": "boolean",
  16958. "x-go-name": "Verified"
  16959. }
  16960. },
  16961. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16962. },
  16963. "GPGKeyEmail": {
  16964. "description": "GPGKeyEmail an email attached to a GPGKey",
  16965. "type": "object",
  16966. "properties": {
  16967. "email": {
  16968. "type": "string",
  16969. "x-go-name": "Email"
  16970. },
  16971. "verified": {
  16972. "type": "boolean",
  16973. "x-go-name": "Verified"
  16974. }
  16975. },
  16976. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16977. },
  16978. "GeneralAPISettings": {
  16979. "description": "GeneralAPISettings contains global api settings exposed by it",
  16980. "type": "object",
  16981. "properties": {
  16982. "default_git_trees_per_page": {
  16983. "type": "integer",
  16984. "format": "int64",
  16985. "x-go-name": "DefaultGitTreesPerPage"
  16986. },
  16987. "default_max_blob_size": {
  16988. "type": "integer",
  16989. "format": "int64",
  16990. "x-go-name": "DefaultMaxBlobSize"
  16991. },
  16992. "default_paging_num": {
  16993. "type": "integer",
  16994. "format": "int64",
  16995. "x-go-name": "DefaultPagingNum"
  16996. },
  16997. "max_response_items": {
  16998. "type": "integer",
  16999. "format": "int64",
  17000. "x-go-name": "MaxResponseItems"
  17001. }
  17002. },
  17003. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17004. },
  17005. "GeneralAttachmentSettings": {
  17006. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  17007. "type": "object",
  17008. "properties": {
  17009. "allowed_types": {
  17010. "type": "string",
  17011. "x-go-name": "AllowedTypes"
  17012. },
  17013. "enabled": {
  17014. "type": "boolean",
  17015. "x-go-name": "Enabled"
  17016. },
  17017. "max_files": {
  17018. "type": "integer",
  17019. "format": "int64",
  17020. "x-go-name": "MaxFiles"
  17021. },
  17022. "max_size": {
  17023. "type": "integer",
  17024. "format": "int64",
  17025. "x-go-name": "MaxSize"
  17026. }
  17027. },
  17028. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17029. },
  17030. "GeneralRepoSettings": {
  17031. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  17032. "type": "object",
  17033. "properties": {
  17034. "http_git_disabled": {
  17035. "type": "boolean",
  17036. "x-go-name": "HTTPGitDisabled"
  17037. },
  17038. "lfs_disabled": {
  17039. "type": "boolean",
  17040. "x-go-name": "LFSDisabled"
  17041. },
  17042. "migrations_disabled": {
  17043. "type": "boolean",
  17044. "x-go-name": "MigrationsDisabled"
  17045. },
  17046. "mirrors_disabled": {
  17047. "type": "boolean",
  17048. "x-go-name": "MirrorsDisabled"
  17049. },
  17050. "stars_disabled": {
  17051. "type": "boolean",
  17052. "x-go-name": "StarsDisabled"
  17053. },
  17054. "time_tracking_disabled": {
  17055. "type": "boolean",
  17056. "x-go-name": "TimeTrackingDisabled"
  17057. }
  17058. },
  17059. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17060. },
  17061. "GeneralUISettings": {
  17062. "description": "GeneralUISettings contains global ui settings exposed by API",
  17063. "type": "object",
  17064. "properties": {
  17065. "allowed_reactions": {
  17066. "type": "array",
  17067. "items": {
  17068. "type": "string"
  17069. },
  17070. "x-go-name": "AllowedReactions"
  17071. },
  17072. "custom_emojis": {
  17073. "type": "array",
  17074. "items": {
  17075. "type": "string"
  17076. },
  17077. "x-go-name": "CustomEmojis"
  17078. },
  17079. "default_theme": {
  17080. "type": "string",
  17081. "x-go-name": "DefaultTheme"
  17082. }
  17083. },
  17084. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17085. },
  17086. "GenerateRepoOption": {
  17087. "description": "GenerateRepoOption options when creating repository using a template",
  17088. "type": "object",
  17089. "required": [
  17090. "owner",
  17091. "name"
  17092. ],
  17093. "properties": {
  17094. "avatar": {
  17095. "description": "include avatar of the template repo",
  17096. "type": "boolean",
  17097. "x-go-name": "Avatar"
  17098. },
  17099. "default_branch": {
  17100. "description": "Default branch of the new repository",
  17101. "type": "string",
  17102. "x-go-name": "DefaultBranch"
  17103. },
  17104. "description": {
  17105. "description": "Description of the repository to create",
  17106. "type": "string",
  17107. "x-go-name": "Description"
  17108. },
  17109. "git_content": {
  17110. "description": "include git content of default branch in template repo",
  17111. "type": "boolean",
  17112. "x-go-name": "GitContent"
  17113. },
  17114. "git_hooks": {
  17115. "description": "include git hooks in template repo",
  17116. "type": "boolean",
  17117. "x-go-name": "GitHooks"
  17118. },
  17119. "labels": {
  17120. "description": "include labels in template repo",
  17121. "type": "boolean",
  17122. "x-go-name": "Labels"
  17123. },
  17124. "name": {
  17125. "description": "Name of the repository to create",
  17126. "type": "string",
  17127. "uniqueItems": true,
  17128. "x-go-name": "Name"
  17129. },
  17130. "owner": {
  17131. "description": "The organization or person who will own the new repository",
  17132. "type": "string",
  17133. "x-go-name": "Owner"
  17134. },
  17135. "private": {
  17136. "description": "Whether the repository is private",
  17137. "type": "boolean",
  17138. "x-go-name": "Private"
  17139. },
  17140. "topics": {
  17141. "description": "include topics in template repo",
  17142. "type": "boolean",
  17143. "x-go-name": "Topics"
  17144. },
  17145. "webhooks": {
  17146. "description": "include webhooks in template repo",
  17147. "type": "boolean",
  17148. "x-go-name": "Webhooks"
  17149. }
  17150. },
  17151. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17152. },
  17153. "GitBlobResponse": {
  17154. "description": "GitBlobResponse represents a git blob",
  17155. "type": "object",
  17156. "properties": {
  17157. "content": {
  17158. "type": "string",
  17159. "x-go-name": "Content"
  17160. },
  17161. "encoding": {
  17162. "type": "string",
  17163. "x-go-name": "Encoding"
  17164. },
  17165. "sha": {
  17166. "type": "string",
  17167. "x-go-name": "SHA"
  17168. },
  17169. "size": {
  17170. "type": "integer",
  17171. "format": "int64",
  17172. "x-go-name": "Size"
  17173. },
  17174. "url": {
  17175. "type": "string",
  17176. "x-go-name": "URL"
  17177. }
  17178. },
  17179. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17180. },
  17181. "GitEntry": {
  17182. "description": "GitEntry represents a git tree",
  17183. "type": "object",
  17184. "properties": {
  17185. "mode": {
  17186. "type": "string",
  17187. "x-go-name": "Mode"
  17188. },
  17189. "path": {
  17190. "type": "string",
  17191. "x-go-name": "Path"
  17192. },
  17193. "sha": {
  17194. "type": "string",
  17195. "x-go-name": "SHA"
  17196. },
  17197. "size": {
  17198. "type": "integer",
  17199. "format": "int64",
  17200. "x-go-name": "Size"
  17201. },
  17202. "type": {
  17203. "type": "string",
  17204. "x-go-name": "Type"
  17205. },
  17206. "url": {
  17207. "type": "string",
  17208. "x-go-name": "URL"
  17209. }
  17210. },
  17211. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17212. },
  17213. "GitHook": {
  17214. "description": "GitHook represents a Git repository hook",
  17215. "type": "object",
  17216. "properties": {
  17217. "content": {
  17218. "type": "string",
  17219. "x-go-name": "Content"
  17220. },
  17221. "is_active": {
  17222. "type": "boolean",
  17223. "x-go-name": "IsActive"
  17224. },
  17225. "name": {
  17226. "type": "string",
  17227. "x-go-name": "Name"
  17228. }
  17229. },
  17230. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17231. },
  17232. "GitObject": {
  17233. "type": "object",
  17234. "title": "GitObject represents a Git object.",
  17235. "properties": {
  17236. "sha": {
  17237. "type": "string",
  17238. "x-go-name": "SHA"
  17239. },
  17240. "type": {
  17241. "type": "string",
  17242. "x-go-name": "Type"
  17243. },
  17244. "url": {
  17245. "type": "string",
  17246. "x-go-name": "URL"
  17247. }
  17248. },
  17249. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17250. },
  17251. "GitTreeResponse": {
  17252. "description": "GitTreeResponse returns a git tree",
  17253. "type": "object",
  17254. "properties": {
  17255. "page": {
  17256. "type": "integer",
  17257. "format": "int64",
  17258. "x-go-name": "Page"
  17259. },
  17260. "sha": {
  17261. "type": "string",
  17262. "x-go-name": "SHA"
  17263. },
  17264. "total_count": {
  17265. "type": "integer",
  17266. "format": "int64",
  17267. "x-go-name": "TotalCount"
  17268. },
  17269. "tree": {
  17270. "type": "array",
  17271. "items": {
  17272. "$ref": "#/definitions/GitEntry"
  17273. },
  17274. "x-go-name": "Entries"
  17275. },
  17276. "truncated": {
  17277. "type": "boolean",
  17278. "x-go-name": "Truncated"
  17279. },
  17280. "url": {
  17281. "type": "string",
  17282. "x-go-name": "URL"
  17283. }
  17284. },
  17285. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17286. },
  17287. "Hook": {
  17288. "description": "Hook a hook is a web hook when one repository changed",
  17289. "type": "object",
  17290. "properties": {
  17291. "active": {
  17292. "type": "boolean",
  17293. "x-go-name": "Active"
  17294. },
  17295. "authorization_header": {
  17296. "type": "string",
  17297. "x-go-name": "AuthorizationHeader"
  17298. },
  17299. "config": {
  17300. "type": "object",
  17301. "additionalProperties": {
  17302. "type": "string"
  17303. },
  17304. "x-go-name": "Config"
  17305. },
  17306. "created_at": {
  17307. "type": "string",
  17308. "format": "date-time",
  17309. "x-go-name": "Created"
  17310. },
  17311. "events": {
  17312. "type": "array",
  17313. "items": {
  17314. "type": "string"
  17315. },
  17316. "x-go-name": "Events"
  17317. },
  17318. "id": {
  17319. "type": "integer",
  17320. "format": "int64",
  17321. "x-go-name": "ID"
  17322. },
  17323. "type": {
  17324. "type": "string",
  17325. "x-go-name": "Type"
  17326. },
  17327. "updated_at": {
  17328. "type": "string",
  17329. "format": "date-time",
  17330. "x-go-name": "Updated"
  17331. }
  17332. },
  17333. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17334. },
  17335. "Identity": {
  17336. "description": "Identity for a person's identity like an author or committer",
  17337. "type": "object",
  17338. "properties": {
  17339. "email": {
  17340. "type": "string",
  17341. "format": "email",
  17342. "x-go-name": "Email"
  17343. },
  17344. "name": {
  17345. "type": "string",
  17346. "x-go-name": "Name"
  17347. }
  17348. },
  17349. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17350. },
  17351. "InternalTracker": {
  17352. "description": "InternalTracker represents settings for internal tracker",
  17353. "type": "object",
  17354. "properties": {
  17355. "allow_only_contributors_to_track_time": {
  17356. "description": "Let only contributors track time (Built-in issue tracker)",
  17357. "type": "boolean",
  17358. "x-go-name": "AllowOnlyContributorsToTrackTime"
  17359. },
  17360. "enable_issue_dependencies": {
  17361. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  17362. "type": "boolean",
  17363. "x-go-name": "EnableIssueDependencies"
  17364. },
  17365. "enable_time_tracker": {
  17366. "description": "Enable time tracking (Built-in issue tracker)",
  17367. "type": "boolean",
  17368. "x-go-name": "EnableTimeTracker"
  17369. }
  17370. },
  17371. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17372. },
  17373. "Issue": {
  17374. "description": "Issue represents an issue in a repository",
  17375. "type": "object",
  17376. "properties": {
  17377. "assets": {
  17378. "type": "array",
  17379. "items": {
  17380. "$ref": "#/definitions/Attachment"
  17381. },
  17382. "x-go-name": "Attachments"
  17383. },
  17384. "assignee": {
  17385. "$ref": "#/definitions/User"
  17386. },
  17387. "assignees": {
  17388. "type": "array",
  17389. "items": {
  17390. "$ref": "#/definitions/User"
  17391. },
  17392. "x-go-name": "Assignees"
  17393. },
  17394. "body": {
  17395. "type": "string",
  17396. "x-go-name": "Body"
  17397. },
  17398. "closed_at": {
  17399. "type": "string",
  17400. "format": "date-time",
  17401. "x-go-name": "Closed"
  17402. },
  17403. "comments": {
  17404. "type": "integer",
  17405. "format": "int64",
  17406. "x-go-name": "Comments"
  17407. },
  17408. "created_at": {
  17409. "type": "string",
  17410. "format": "date-time",
  17411. "x-go-name": "Created"
  17412. },
  17413. "due_date": {
  17414. "type": "string",
  17415. "format": "date-time",
  17416. "x-go-name": "Deadline"
  17417. },
  17418. "html_url": {
  17419. "type": "string",
  17420. "x-go-name": "HTMLURL"
  17421. },
  17422. "id": {
  17423. "type": "integer",
  17424. "format": "int64",
  17425. "x-go-name": "ID"
  17426. },
  17427. "is_locked": {
  17428. "type": "boolean",
  17429. "x-go-name": "IsLocked"
  17430. },
  17431. "labels": {
  17432. "type": "array",
  17433. "items": {
  17434. "$ref": "#/definitions/Label"
  17435. },
  17436. "x-go-name": "Labels"
  17437. },
  17438. "milestone": {
  17439. "$ref": "#/definitions/Milestone"
  17440. },
  17441. "number": {
  17442. "type": "integer",
  17443. "format": "int64",
  17444. "x-go-name": "Index"
  17445. },
  17446. "original_author": {
  17447. "type": "string",
  17448. "x-go-name": "OriginalAuthor"
  17449. },
  17450. "original_author_id": {
  17451. "type": "integer",
  17452. "format": "int64",
  17453. "x-go-name": "OriginalAuthorID"
  17454. },
  17455. "pull_request": {
  17456. "$ref": "#/definitions/PullRequestMeta"
  17457. },
  17458. "ref": {
  17459. "type": "string",
  17460. "x-go-name": "Ref"
  17461. },
  17462. "repository": {
  17463. "$ref": "#/definitions/RepositoryMeta"
  17464. },
  17465. "state": {
  17466. "$ref": "#/definitions/StateType"
  17467. },
  17468. "title": {
  17469. "type": "string",
  17470. "x-go-name": "Title"
  17471. },
  17472. "updated_at": {
  17473. "type": "string",
  17474. "format": "date-time",
  17475. "x-go-name": "Updated"
  17476. },
  17477. "url": {
  17478. "type": "string",
  17479. "x-go-name": "URL"
  17480. },
  17481. "user": {
  17482. "$ref": "#/definitions/User"
  17483. }
  17484. },
  17485. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17486. },
  17487. "IssueDeadline": {
  17488. "description": "IssueDeadline represents an issue deadline",
  17489. "type": "object",
  17490. "properties": {
  17491. "due_date": {
  17492. "type": "string",
  17493. "format": "date-time",
  17494. "x-go-name": "Deadline"
  17495. }
  17496. },
  17497. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17498. },
  17499. "IssueFormField": {
  17500. "description": "IssueFormField represents a form field",
  17501. "type": "object",
  17502. "properties": {
  17503. "attributes": {
  17504. "type": "object",
  17505. "additionalProperties": {},
  17506. "x-go-name": "Attributes"
  17507. },
  17508. "id": {
  17509. "type": "string",
  17510. "x-go-name": "ID"
  17511. },
  17512. "type": {
  17513. "$ref": "#/definitions/IssueFormFieldType"
  17514. },
  17515. "validations": {
  17516. "type": "object",
  17517. "additionalProperties": {},
  17518. "x-go-name": "Validations"
  17519. }
  17520. },
  17521. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17522. },
  17523. "IssueFormFieldType": {
  17524. "type": "string",
  17525. "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
  17526. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17527. },
  17528. "IssueLabelsOption": {
  17529. "description": "IssueLabelsOption a collection of labels",
  17530. "type": "object",
  17531. "properties": {
  17532. "labels": {
  17533. "description": "list of label IDs",
  17534. "type": "array",
  17535. "items": {
  17536. "type": "integer",
  17537. "format": "int64"
  17538. },
  17539. "x-go-name": "Labels"
  17540. }
  17541. },
  17542. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17543. },
  17544. "IssueTemplate": {
  17545. "description": "IssueTemplate represents an issue template for a repository",
  17546. "type": "object",
  17547. "properties": {
  17548. "about": {
  17549. "type": "string",
  17550. "x-go-name": "About"
  17551. },
  17552. "body": {
  17553. "type": "array",
  17554. "items": {
  17555. "$ref": "#/definitions/IssueFormField"
  17556. },
  17557. "x-go-name": "Fields"
  17558. },
  17559. "content": {
  17560. "type": "string",
  17561. "x-go-name": "Content"
  17562. },
  17563. "file_name": {
  17564. "type": "string",
  17565. "x-go-name": "FileName"
  17566. },
  17567. "labels": {
  17568. "$ref": "#/definitions/IssueTemplateLabels"
  17569. },
  17570. "name": {
  17571. "type": "string",
  17572. "x-go-name": "Name"
  17573. },
  17574. "ref": {
  17575. "type": "string",
  17576. "x-go-name": "Ref"
  17577. },
  17578. "title": {
  17579. "type": "string",
  17580. "x-go-name": "Title"
  17581. }
  17582. },
  17583. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17584. },
  17585. "IssueTemplateLabels": {
  17586. "type": "array",
  17587. "items": {
  17588. "type": "string"
  17589. },
  17590. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17591. },
  17592. "Label": {
  17593. "description": "Label a label to an issue or a pr",
  17594. "type": "object",
  17595. "properties": {
  17596. "color": {
  17597. "type": "string",
  17598. "x-go-name": "Color",
  17599. "example": "00aabb"
  17600. },
  17601. "description": {
  17602. "type": "string",
  17603. "x-go-name": "Description"
  17604. },
  17605. "id": {
  17606. "type": "integer",
  17607. "format": "int64",
  17608. "x-go-name": "ID"
  17609. },
  17610. "name": {
  17611. "type": "string",
  17612. "x-go-name": "Name"
  17613. },
  17614. "url": {
  17615. "type": "string",
  17616. "x-go-name": "URL"
  17617. }
  17618. },
  17619. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17620. },
  17621. "MarkdownOption": {
  17622. "description": "MarkdownOption markdown options",
  17623. "type": "object",
  17624. "properties": {
  17625. "Context": {
  17626. "description": "Context to render\n\nin: body",
  17627. "type": "string"
  17628. },
  17629. "Mode": {
  17630. "description": "Mode to render\n\nin: body",
  17631. "type": "string"
  17632. },
  17633. "Text": {
  17634. "description": "Text markdown to render\n\nin: body",
  17635. "type": "string"
  17636. },
  17637. "Wiki": {
  17638. "description": "Is it a wiki page ?\n\nin: body",
  17639. "type": "boolean"
  17640. }
  17641. },
  17642. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17643. },
  17644. "MergePullRequestOption": {
  17645. "description": "MergePullRequestForm form for merging Pull Request",
  17646. "type": "object",
  17647. "required": [
  17648. "Do"
  17649. ],
  17650. "properties": {
  17651. "Do": {
  17652. "type": "string",
  17653. "enum": [
  17654. "merge",
  17655. "rebase",
  17656. "rebase-merge",
  17657. "squash",
  17658. "manually-merged"
  17659. ]
  17660. },
  17661. "MergeCommitID": {
  17662. "type": "string"
  17663. },
  17664. "MergeMessageField": {
  17665. "type": "string"
  17666. },
  17667. "MergeTitleField": {
  17668. "type": "string"
  17669. },
  17670. "delete_branch_after_merge": {
  17671. "type": "boolean",
  17672. "x-go-name": "DeleteBranchAfterMerge"
  17673. },
  17674. "force_merge": {
  17675. "type": "boolean",
  17676. "x-go-name": "ForceMerge"
  17677. },
  17678. "head_commit_id": {
  17679. "type": "string",
  17680. "x-go-name": "HeadCommitID"
  17681. },
  17682. "merge_when_checks_succeed": {
  17683. "type": "boolean",
  17684. "x-go-name": "MergeWhenChecksSucceed"
  17685. }
  17686. },
  17687. "x-go-name": "MergePullRequestForm",
  17688. "x-go-package": "code.gitea.io/gitea/services/forms"
  17689. },
  17690. "MigrateRepoOptions": {
  17691. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  17692. "type": "object",
  17693. "required": [
  17694. "clone_addr",
  17695. "repo_name"
  17696. ],
  17697. "properties": {
  17698. "auth_password": {
  17699. "type": "string",
  17700. "x-go-name": "AuthPassword"
  17701. },
  17702. "auth_token": {
  17703. "type": "string",
  17704. "x-go-name": "AuthToken"
  17705. },
  17706. "auth_username": {
  17707. "type": "string",
  17708. "x-go-name": "AuthUsername"
  17709. },
  17710. "clone_addr": {
  17711. "type": "string",
  17712. "x-go-name": "CloneAddr"
  17713. },
  17714. "description": {
  17715. "type": "string",
  17716. "x-go-name": "Description"
  17717. },
  17718. "issues": {
  17719. "type": "boolean",
  17720. "x-go-name": "Issues"
  17721. },
  17722. "labels": {
  17723. "type": "boolean",
  17724. "x-go-name": "Labels"
  17725. },
  17726. "lfs": {
  17727. "type": "boolean",
  17728. "x-go-name": "LFS"
  17729. },
  17730. "lfs_endpoint": {
  17731. "type": "string",
  17732. "x-go-name": "LFSEndpoint"
  17733. },
  17734. "milestones": {
  17735. "type": "boolean",
  17736. "x-go-name": "Milestones"
  17737. },
  17738. "mirror": {
  17739. "type": "boolean",
  17740. "x-go-name": "Mirror"
  17741. },
  17742. "mirror_interval": {
  17743. "type": "string",
  17744. "x-go-name": "MirrorInterval"
  17745. },
  17746. "private": {
  17747. "type": "boolean",
  17748. "x-go-name": "Private"
  17749. },
  17750. "pull_requests": {
  17751. "type": "boolean",
  17752. "x-go-name": "PullRequests"
  17753. },
  17754. "releases": {
  17755. "type": "boolean",
  17756. "x-go-name": "Releases"
  17757. },
  17758. "repo_name": {
  17759. "type": "string",
  17760. "x-go-name": "RepoName"
  17761. },
  17762. "repo_owner": {
  17763. "description": "Name of User or Organisation who will own Repo after migration",
  17764. "type": "string",
  17765. "x-go-name": "RepoOwner"
  17766. },
  17767. "service": {
  17768. "type": "string",
  17769. "enum": [
  17770. "git",
  17771. "github",
  17772. "gitea",
  17773. "gitlab"
  17774. ],
  17775. "x-go-name": "Service"
  17776. },
  17777. "uid": {
  17778. "description": "deprecated (only for backwards compatibility)",
  17779. "type": "integer",
  17780. "format": "int64",
  17781. "x-go-name": "RepoOwnerID"
  17782. },
  17783. "wiki": {
  17784. "type": "boolean",
  17785. "x-go-name": "Wiki"
  17786. }
  17787. },
  17788. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17789. },
  17790. "Milestone": {
  17791. "description": "Milestone milestone is a collection of issues on one repository",
  17792. "type": "object",
  17793. "properties": {
  17794. "closed_at": {
  17795. "type": "string",
  17796. "format": "date-time",
  17797. "x-go-name": "Closed"
  17798. },
  17799. "closed_issues": {
  17800. "type": "integer",
  17801. "format": "int64",
  17802. "x-go-name": "ClosedIssues"
  17803. },
  17804. "created_at": {
  17805. "type": "string",
  17806. "format": "date-time",
  17807. "x-go-name": "Created"
  17808. },
  17809. "description": {
  17810. "type": "string",
  17811. "x-go-name": "Description"
  17812. },
  17813. "due_on": {
  17814. "type": "string",
  17815. "format": "date-time",
  17816. "x-go-name": "Deadline"
  17817. },
  17818. "id": {
  17819. "type": "integer",
  17820. "format": "int64",
  17821. "x-go-name": "ID"
  17822. },
  17823. "open_issues": {
  17824. "type": "integer",
  17825. "format": "int64",
  17826. "x-go-name": "OpenIssues"
  17827. },
  17828. "state": {
  17829. "$ref": "#/definitions/StateType"
  17830. },
  17831. "title": {
  17832. "type": "string",
  17833. "x-go-name": "Title"
  17834. },
  17835. "updated_at": {
  17836. "type": "string",
  17837. "format": "date-time",
  17838. "x-go-name": "Updated"
  17839. }
  17840. },
  17841. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17842. },
  17843. "NodeInfo": {
  17844. "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
  17845. "type": "object",
  17846. "properties": {
  17847. "metadata": {
  17848. "type": "object",
  17849. "x-go-name": "Metadata"
  17850. },
  17851. "openRegistrations": {
  17852. "type": "boolean",
  17853. "x-go-name": "OpenRegistrations"
  17854. },
  17855. "protocols": {
  17856. "type": "array",
  17857. "items": {
  17858. "type": "string"
  17859. },
  17860. "x-go-name": "Protocols"
  17861. },
  17862. "services": {
  17863. "$ref": "#/definitions/NodeInfoServices"
  17864. },
  17865. "software": {
  17866. "$ref": "#/definitions/NodeInfoSoftware"
  17867. },
  17868. "usage": {
  17869. "$ref": "#/definitions/NodeInfoUsage"
  17870. },
  17871. "version": {
  17872. "type": "string",
  17873. "x-go-name": "Version"
  17874. }
  17875. },
  17876. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17877. },
  17878. "NodeInfoServices": {
  17879. "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
  17880. "type": "object",
  17881. "properties": {
  17882. "inbound": {
  17883. "type": "array",
  17884. "items": {
  17885. "type": "string"
  17886. },
  17887. "x-go-name": "Inbound"
  17888. },
  17889. "outbound": {
  17890. "type": "array",
  17891. "items": {
  17892. "type": "string"
  17893. },
  17894. "x-go-name": "Outbound"
  17895. }
  17896. },
  17897. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17898. },
  17899. "NodeInfoSoftware": {
  17900. "description": "NodeInfoSoftware contains Metadata about server software in use",
  17901. "type": "object",
  17902. "properties": {
  17903. "homepage": {
  17904. "type": "string",
  17905. "x-go-name": "Homepage"
  17906. },
  17907. "name": {
  17908. "type": "string",
  17909. "x-go-name": "Name"
  17910. },
  17911. "repository": {
  17912. "type": "string",
  17913. "x-go-name": "Repository"
  17914. },
  17915. "version": {
  17916. "type": "string",
  17917. "x-go-name": "Version"
  17918. }
  17919. },
  17920. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17921. },
  17922. "NodeInfoUsage": {
  17923. "description": "NodeInfoUsage contains usage statistics for this server",
  17924. "type": "object",
  17925. "properties": {
  17926. "localComments": {
  17927. "type": "integer",
  17928. "format": "int64",
  17929. "x-go-name": "LocalComments"
  17930. },
  17931. "localPosts": {
  17932. "type": "integer",
  17933. "format": "int64",
  17934. "x-go-name": "LocalPosts"
  17935. },
  17936. "users": {
  17937. "$ref": "#/definitions/NodeInfoUsageUsers"
  17938. }
  17939. },
  17940. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17941. },
  17942. "NodeInfoUsageUsers": {
  17943. "description": "NodeInfoUsageUsers contains statistics about the users of this server",
  17944. "type": "object",
  17945. "properties": {
  17946. "activeHalfyear": {
  17947. "type": "integer",
  17948. "format": "int64",
  17949. "x-go-name": "ActiveHalfyear"
  17950. },
  17951. "activeMonth": {
  17952. "type": "integer",
  17953. "format": "int64",
  17954. "x-go-name": "ActiveMonth"
  17955. },
  17956. "total": {
  17957. "type": "integer",
  17958. "format": "int64",
  17959. "x-go-name": "Total"
  17960. }
  17961. },
  17962. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17963. },
  17964. "Note": {
  17965. "description": "Note contains information related to a git note",
  17966. "type": "object",
  17967. "properties": {
  17968. "commit": {
  17969. "$ref": "#/definitions/Commit"
  17970. },
  17971. "message": {
  17972. "type": "string",
  17973. "x-go-name": "Message"
  17974. }
  17975. },
  17976. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17977. },
  17978. "NotificationCount": {
  17979. "description": "NotificationCount number of unread notifications",
  17980. "type": "object",
  17981. "properties": {
  17982. "new": {
  17983. "type": "integer",
  17984. "format": "int64",
  17985. "x-go-name": "New"
  17986. }
  17987. },
  17988. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17989. },
  17990. "NotificationSubject": {
  17991. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  17992. "type": "object",
  17993. "properties": {
  17994. "html_url": {
  17995. "type": "string",
  17996. "x-go-name": "HTMLURL"
  17997. },
  17998. "latest_comment_html_url": {
  17999. "type": "string",
  18000. "x-go-name": "LatestCommentHTMLURL"
  18001. },
  18002. "latest_comment_url": {
  18003. "type": "string",
  18004. "x-go-name": "LatestCommentURL"
  18005. },
  18006. "state": {
  18007. "$ref": "#/definitions/StateType"
  18008. },
  18009. "title": {
  18010. "type": "string",
  18011. "x-go-name": "Title"
  18012. },
  18013. "type": {
  18014. "$ref": "#/definitions/NotifySubjectType"
  18015. },
  18016. "url": {
  18017. "type": "string",
  18018. "x-go-name": "URL"
  18019. }
  18020. },
  18021. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18022. },
  18023. "NotificationThread": {
  18024. "description": "NotificationThread expose Notification on API",
  18025. "type": "object",
  18026. "properties": {
  18027. "id": {
  18028. "type": "integer",
  18029. "format": "int64",
  18030. "x-go-name": "ID"
  18031. },
  18032. "pinned": {
  18033. "type": "boolean",
  18034. "x-go-name": "Pinned"
  18035. },
  18036. "repository": {
  18037. "$ref": "#/definitions/Repository"
  18038. },
  18039. "subject": {
  18040. "$ref": "#/definitions/NotificationSubject"
  18041. },
  18042. "unread": {
  18043. "type": "boolean",
  18044. "x-go-name": "Unread"
  18045. },
  18046. "updated_at": {
  18047. "type": "string",
  18048. "format": "date-time",
  18049. "x-go-name": "UpdatedAt"
  18050. },
  18051. "url": {
  18052. "type": "string",
  18053. "x-go-name": "URL"
  18054. }
  18055. },
  18056. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18057. },
  18058. "NotifySubjectType": {
  18059. "description": "NotifySubjectType represent type of notification subject",
  18060. "type": "string",
  18061. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18062. },
  18063. "OAuth2Application": {
  18064. "type": "object",
  18065. "title": "OAuth2Application represents an OAuth2 application.",
  18066. "properties": {
  18067. "client_id": {
  18068. "type": "string",
  18069. "x-go-name": "ClientID"
  18070. },
  18071. "client_secret": {
  18072. "type": "string",
  18073. "x-go-name": "ClientSecret"
  18074. },
  18075. "confidential_client": {
  18076. "type": "boolean",
  18077. "x-go-name": "ConfidentialClient"
  18078. },
  18079. "created": {
  18080. "type": "string",
  18081. "format": "date-time",
  18082. "x-go-name": "Created"
  18083. },
  18084. "id": {
  18085. "type": "integer",
  18086. "format": "int64",
  18087. "x-go-name": "ID"
  18088. },
  18089. "name": {
  18090. "type": "string",
  18091. "x-go-name": "Name"
  18092. },
  18093. "redirect_uris": {
  18094. "type": "array",
  18095. "items": {
  18096. "type": "string"
  18097. },
  18098. "x-go-name": "RedirectURIs"
  18099. }
  18100. },
  18101. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18102. },
  18103. "Organization": {
  18104. "description": "Organization represents an organization",
  18105. "type": "object",
  18106. "properties": {
  18107. "avatar_url": {
  18108. "type": "string",
  18109. "x-go-name": "AvatarURL"
  18110. },
  18111. "description": {
  18112. "type": "string",
  18113. "x-go-name": "Description"
  18114. },
  18115. "full_name": {
  18116. "type": "string",
  18117. "x-go-name": "FullName"
  18118. },
  18119. "id": {
  18120. "type": "integer",
  18121. "format": "int64",
  18122. "x-go-name": "ID"
  18123. },
  18124. "location": {
  18125. "type": "string",
  18126. "x-go-name": "Location"
  18127. },
  18128. "name": {
  18129. "type": "string",
  18130. "x-go-name": "Name"
  18131. },
  18132. "repo_admin_change_team_access": {
  18133. "type": "boolean",
  18134. "x-go-name": "RepoAdminChangeTeamAccess"
  18135. },
  18136. "username": {
  18137. "description": "deprecated",
  18138. "type": "string",
  18139. "x-go-name": "UserName"
  18140. },
  18141. "visibility": {
  18142. "type": "string",
  18143. "x-go-name": "Visibility"
  18144. },
  18145. "website": {
  18146. "type": "string",
  18147. "x-go-name": "Website"
  18148. }
  18149. },
  18150. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18151. },
  18152. "OrganizationPermissions": {
  18153. "description": "OrganizationPermissions list different users permissions on an organization",
  18154. "type": "object",
  18155. "properties": {
  18156. "can_create_repository": {
  18157. "type": "boolean",
  18158. "x-go-name": "CanCreateRepository"
  18159. },
  18160. "can_read": {
  18161. "type": "boolean",
  18162. "x-go-name": "CanRead"
  18163. },
  18164. "can_write": {
  18165. "type": "boolean",
  18166. "x-go-name": "CanWrite"
  18167. },
  18168. "is_admin": {
  18169. "type": "boolean",
  18170. "x-go-name": "IsAdmin"
  18171. },
  18172. "is_owner": {
  18173. "type": "boolean",
  18174. "x-go-name": "IsOwner"
  18175. }
  18176. },
  18177. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18178. },
  18179. "PRBranchInfo": {
  18180. "description": "PRBranchInfo information about a branch",
  18181. "type": "object",
  18182. "properties": {
  18183. "label": {
  18184. "type": "string",
  18185. "x-go-name": "Name"
  18186. },
  18187. "ref": {
  18188. "type": "string",
  18189. "x-go-name": "Ref"
  18190. },
  18191. "repo": {
  18192. "$ref": "#/definitions/Repository"
  18193. },
  18194. "repo_id": {
  18195. "type": "integer",
  18196. "format": "int64",
  18197. "x-go-name": "RepoID"
  18198. },
  18199. "sha": {
  18200. "type": "string",
  18201. "x-go-name": "Sha"
  18202. }
  18203. },
  18204. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18205. },
  18206. "Package": {
  18207. "description": "Package represents a package",
  18208. "type": "object",
  18209. "properties": {
  18210. "created_at": {
  18211. "type": "string",
  18212. "format": "date-time",
  18213. "x-go-name": "CreatedAt"
  18214. },
  18215. "creator": {
  18216. "$ref": "#/definitions/User"
  18217. },
  18218. "id": {
  18219. "type": "integer",
  18220. "format": "int64",
  18221. "x-go-name": "ID"
  18222. },
  18223. "name": {
  18224. "type": "string",
  18225. "x-go-name": "Name"
  18226. },
  18227. "owner": {
  18228. "$ref": "#/definitions/User"
  18229. },
  18230. "repository": {
  18231. "$ref": "#/definitions/Repository"
  18232. },
  18233. "type": {
  18234. "type": "string",
  18235. "x-go-name": "Type"
  18236. },
  18237. "version": {
  18238. "type": "string",
  18239. "x-go-name": "Version"
  18240. }
  18241. },
  18242. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18243. },
  18244. "PackageFile": {
  18245. "description": "PackageFile represents a package file",
  18246. "type": "object",
  18247. "properties": {
  18248. "Size": {
  18249. "type": "integer",
  18250. "format": "int64"
  18251. },
  18252. "id": {
  18253. "type": "integer",
  18254. "format": "int64",
  18255. "x-go-name": "ID"
  18256. },
  18257. "md5": {
  18258. "type": "string",
  18259. "x-go-name": "HashMD5"
  18260. },
  18261. "name": {
  18262. "type": "string",
  18263. "x-go-name": "Name"
  18264. },
  18265. "sha1": {
  18266. "type": "string",
  18267. "x-go-name": "HashSHA1"
  18268. },
  18269. "sha256": {
  18270. "type": "string",
  18271. "x-go-name": "HashSHA256"
  18272. },
  18273. "sha512": {
  18274. "type": "string",
  18275. "x-go-name": "HashSHA512"
  18276. }
  18277. },
  18278. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18279. },
  18280. "PayloadCommit": {
  18281. "description": "PayloadCommit represents a commit",
  18282. "type": "object",
  18283. "properties": {
  18284. "added": {
  18285. "type": "array",
  18286. "items": {
  18287. "type": "string"
  18288. },
  18289. "x-go-name": "Added"
  18290. },
  18291. "author": {
  18292. "$ref": "#/definitions/PayloadUser"
  18293. },
  18294. "committer": {
  18295. "$ref": "#/definitions/PayloadUser"
  18296. },
  18297. "id": {
  18298. "description": "sha1 hash of the commit",
  18299. "type": "string",
  18300. "x-go-name": "ID"
  18301. },
  18302. "message": {
  18303. "type": "string",
  18304. "x-go-name": "Message"
  18305. },
  18306. "modified": {
  18307. "type": "array",
  18308. "items": {
  18309. "type": "string"
  18310. },
  18311. "x-go-name": "Modified"
  18312. },
  18313. "removed": {
  18314. "type": "array",
  18315. "items": {
  18316. "type": "string"
  18317. },
  18318. "x-go-name": "Removed"
  18319. },
  18320. "timestamp": {
  18321. "type": "string",
  18322. "format": "date-time",
  18323. "x-go-name": "Timestamp"
  18324. },
  18325. "url": {
  18326. "type": "string",
  18327. "x-go-name": "URL"
  18328. },
  18329. "verification": {
  18330. "$ref": "#/definitions/PayloadCommitVerification"
  18331. }
  18332. },
  18333. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18334. },
  18335. "PayloadCommitVerification": {
  18336. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  18337. "type": "object",
  18338. "properties": {
  18339. "payload": {
  18340. "type": "string",
  18341. "x-go-name": "Payload"
  18342. },
  18343. "reason": {
  18344. "type": "string",
  18345. "x-go-name": "Reason"
  18346. },
  18347. "signature": {
  18348. "type": "string",
  18349. "x-go-name": "Signature"
  18350. },
  18351. "signer": {
  18352. "$ref": "#/definitions/PayloadUser"
  18353. },
  18354. "verified": {
  18355. "type": "boolean",
  18356. "x-go-name": "Verified"
  18357. }
  18358. },
  18359. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18360. },
  18361. "PayloadUser": {
  18362. "description": "PayloadUser represents the author or committer of a commit",
  18363. "type": "object",
  18364. "properties": {
  18365. "email": {
  18366. "type": "string",
  18367. "format": "email",
  18368. "x-go-name": "Email"
  18369. },
  18370. "name": {
  18371. "description": "Full name of the commit author",
  18372. "type": "string",
  18373. "x-go-name": "Name"
  18374. },
  18375. "username": {
  18376. "type": "string",
  18377. "x-go-name": "UserName"
  18378. }
  18379. },
  18380. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18381. },
  18382. "Permission": {
  18383. "description": "Permission represents a set of permissions",
  18384. "type": "object",
  18385. "properties": {
  18386. "admin": {
  18387. "type": "boolean",
  18388. "x-go-name": "Admin"
  18389. },
  18390. "pull": {
  18391. "type": "boolean",
  18392. "x-go-name": "Pull"
  18393. },
  18394. "push": {
  18395. "type": "boolean",
  18396. "x-go-name": "Push"
  18397. }
  18398. },
  18399. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18400. },
  18401. "PublicKey": {
  18402. "description": "PublicKey publickey is a user key to push code to repository",
  18403. "type": "object",
  18404. "properties": {
  18405. "created_at": {
  18406. "type": "string",
  18407. "format": "date-time",
  18408. "x-go-name": "Created"
  18409. },
  18410. "fingerprint": {
  18411. "type": "string",
  18412. "x-go-name": "Fingerprint"
  18413. },
  18414. "id": {
  18415. "type": "integer",
  18416. "format": "int64",
  18417. "x-go-name": "ID"
  18418. },
  18419. "key": {
  18420. "type": "string",
  18421. "x-go-name": "Key"
  18422. },
  18423. "key_type": {
  18424. "type": "string",
  18425. "x-go-name": "KeyType"
  18426. },
  18427. "read_only": {
  18428. "type": "boolean",
  18429. "x-go-name": "ReadOnly"
  18430. },
  18431. "title": {
  18432. "type": "string",
  18433. "x-go-name": "Title"
  18434. },
  18435. "url": {
  18436. "type": "string",
  18437. "x-go-name": "URL"
  18438. },
  18439. "user": {
  18440. "$ref": "#/definitions/User"
  18441. }
  18442. },
  18443. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18444. },
  18445. "PullRequest": {
  18446. "description": "PullRequest represents a pull request",
  18447. "type": "object",
  18448. "properties": {
  18449. "allow_maintainer_edit": {
  18450. "type": "boolean",
  18451. "x-go-name": "AllowMaintainerEdit"
  18452. },
  18453. "assignee": {
  18454. "$ref": "#/definitions/User"
  18455. },
  18456. "assignees": {
  18457. "type": "array",
  18458. "items": {
  18459. "$ref": "#/definitions/User"
  18460. },
  18461. "x-go-name": "Assignees"
  18462. },
  18463. "base": {
  18464. "$ref": "#/definitions/PRBranchInfo"
  18465. },
  18466. "body": {
  18467. "type": "string",
  18468. "x-go-name": "Body"
  18469. },
  18470. "closed_at": {
  18471. "type": "string",
  18472. "format": "date-time",
  18473. "x-go-name": "Closed"
  18474. },
  18475. "comments": {
  18476. "type": "integer",
  18477. "format": "int64",
  18478. "x-go-name": "Comments"
  18479. },
  18480. "created_at": {
  18481. "type": "string",
  18482. "format": "date-time",
  18483. "x-go-name": "Created"
  18484. },
  18485. "diff_url": {
  18486. "type": "string",
  18487. "x-go-name": "DiffURL"
  18488. },
  18489. "due_date": {
  18490. "type": "string",
  18491. "format": "date-time",
  18492. "x-go-name": "Deadline"
  18493. },
  18494. "head": {
  18495. "$ref": "#/definitions/PRBranchInfo"
  18496. },
  18497. "html_url": {
  18498. "type": "string",
  18499. "x-go-name": "HTMLURL"
  18500. },
  18501. "id": {
  18502. "type": "integer",
  18503. "format": "int64",
  18504. "x-go-name": "ID"
  18505. },
  18506. "is_locked": {
  18507. "type": "boolean",
  18508. "x-go-name": "IsLocked"
  18509. },
  18510. "labels": {
  18511. "type": "array",
  18512. "items": {
  18513. "$ref": "#/definitions/Label"
  18514. },
  18515. "x-go-name": "Labels"
  18516. },
  18517. "merge_base": {
  18518. "type": "string",
  18519. "x-go-name": "MergeBase"
  18520. },
  18521. "merge_commit_sha": {
  18522. "type": "string",
  18523. "x-go-name": "MergedCommitID"
  18524. },
  18525. "mergeable": {
  18526. "type": "boolean",
  18527. "x-go-name": "Mergeable"
  18528. },
  18529. "merged": {
  18530. "type": "boolean",
  18531. "x-go-name": "HasMerged"
  18532. },
  18533. "merged_at": {
  18534. "type": "string",
  18535. "format": "date-time",
  18536. "x-go-name": "Merged"
  18537. },
  18538. "merged_by": {
  18539. "$ref": "#/definitions/User"
  18540. },
  18541. "milestone": {
  18542. "$ref": "#/definitions/Milestone"
  18543. },
  18544. "number": {
  18545. "type": "integer",
  18546. "format": "int64",
  18547. "x-go-name": "Index"
  18548. },
  18549. "patch_url": {
  18550. "type": "string",
  18551. "x-go-name": "PatchURL"
  18552. },
  18553. "state": {
  18554. "$ref": "#/definitions/StateType"
  18555. },
  18556. "title": {
  18557. "type": "string",
  18558. "x-go-name": "Title"
  18559. },
  18560. "updated_at": {
  18561. "type": "string",
  18562. "format": "date-time",
  18563. "x-go-name": "Updated"
  18564. },
  18565. "url": {
  18566. "type": "string",
  18567. "x-go-name": "URL"
  18568. },
  18569. "user": {
  18570. "$ref": "#/definitions/User"
  18571. }
  18572. },
  18573. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18574. },
  18575. "PullRequestMeta": {
  18576. "description": "PullRequestMeta PR info if an issue is a PR",
  18577. "type": "object",
  18578. "properties": {
  18579. "merged": {
  18580. "type": "boolean",
  18581. "x-go-name": "HasMerged"
  18582. },
  18583. "merged_at": {
  18584. "type": "string",
  18585. "format": "date-time",
  18586. "x-go-name": "Merged"
  18587. }
  18588. },
  18589. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18590. },
  18591. "PullReview": {
  18592. "description": "PullReview represents a pull request review",
  18593. "type": "object",
  18594. "properties": {
  18595. "body": {
  18596. "type": "string",
  18597. "x-go-name": "Body"
  18598. },
  18599. "comments_count": {
  18600. "type": "integer",
  18601. "format": "int64",
  18602. "x-go-name": "CodeCommentsCount"
  18603. },
  18604. "commit_id": {
  18605. "type": "string",
  18606. "x-go-name": "CommitID"
  18607. },
  18608. "dismissed": {
  18609. "type": "boolean",
  18610. "x-go-name": "Dismissed"
  18611. },
  18612. "html_url": {
  18613. "type": "string",
  18614. "x-go-name": "HTMLURL"
  18615. },
  18616. "id": {
  18617. "type": "integer",
  18618. "format": "int64",
  18619. "x-go-name": "ID"
  18620. },
  18621. "official": {
  18622. "type": "boolean",
  18623. "x-go-name": "Official"
  18624. },
  18625. "pull_request_url": {
  18626. "type": "string",
  18627. "x-go-name": "HTMLPullURL"
  18628. },
  18629. "stale": {
  18630. "type": "boolean",
  18631. "x-go-name": "Stale"
  18632. },
  18633. "state": {
  18634. "$ref": "#/definitions/ReviewStateType"
  18635. },
  18636. "submitted_at": {
  18637. "type": "string",
  18638. "format": "date-time",
  18639. "x-go-name": "Submitted"
  18640. },
  18641. "team": {
  18642. "$ref": "#/definitions/Team"
  18643. },
  18644. "updated_at": {
  18645. "type": "string",
  18646. "format": "date-time",
  18647. "x-go-name": "Updated"
  18648. },
  18649. "user": {
  18650. "$ref": "#/definitions/User"
  18651. }
  18652. },
  18653. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18654. },
  18655. "PullReviewComment": {
  18656. "description": "PullReviewComment represents a comment on a pull request review",
  18657. "type": "object",
  18658. "properties": {
  18659. "body": {
  18660. "type": "string",
  18661. "x-go-name": "Body"
  18662. },
  18663. "commit_id": {
  18664. "type": "string",
  18665. "x-go-name": "CommitID"
  18666. },
  18667. "created_at": {
  18668. "type": "string",
  18669. "format": "date-time",
  18670. "x-go-name": "Created"
  18671. },
  18672. "diff_hunk": {
  18673. "type": "string",
  18674. "x-go-name": "DiffHunk"
  18675. },
  18676. "html_url": {
  18677. "type": "string",
  18678. "x-go-name": "HTMLURL"
  18679. },
  18680. "id": {
  18681. "type": "integer",
  18682. "format": "int64",
  18683. "x-go-name": "ID"
  18684. },
  18685. "original_commit_id": {
  18686. "type": "string",
  18687. "x-go-name": "OrigCommitID"
  18688. },
  18689. "original_position": {
  18690. "type": "integer",
  18691. "format": "uint64",
  18692. "x-go-name": "OldLineNum"
  18693. },
  18694. "path": {
  18695. "type": "string",
  18696. "x-go-name": "Path"
  18697. },
  18698. "position": {
  18699. "type": "integer",
  18700. "format": "uint64",
  18701. "x-go-name": "LineNum"
  18702. },
  18703. "pull_request_review_id": {
  18704. "type": "integer",
  18705. "format": "int64",
  18706. "x-go-name": "ReviewID"
  18707. },
  18708. "pull_request_url": {
  18709. "type": "string",
  18710. "x-go-name": "HTMLPullURL"
  18711. },
  18712. "resolver": {
  18713. "$ref": "#/definitions/User"
  18714. },
  18715. "updated_at": {
  18716. "type": "string",
  18717. "format": "date-time",
  18718. "x-go-name": "Updated"
  18719. },
  18720. "user": {
  18721. "$ref": "#/definitions/User"
  18722. }
  18723. },
  18724. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18725. },
  18726. "PullReviewRequestOptions": {
  18727. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  18728. "type": "object",
  18729. "properties": {
  18730. "reviewers": {
  18731. "type": "array",
  18732. "items": {
  18733. "type": "string"
  18734. },
  18735. "x-go-name": "Reviewers"
  18736. },
  18737. "team_reviewers": {
  18738. "type": "array",
  18739. "items": {
  18740. "type": "string"
  18741. },
  18742. "x-go-name": "TeamReviewers"
  18743. }
  18744. },
  18745. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18746. },
  18747. "PushMirror": {
  18748. "description": "PushMirror represents information of a push mirror",
  18749. "type": "object",
  18750. "properties": {
  18751. "created": {
  18752. "type": "string",
  18753. "x-go-name": "CreatedUnix"
  18754. },
  18755. "interval": {
  18756. "type": "string",
  18757. "x-go-name": "Interval"
  18758. },
  18759. "last_error": {
  18760. "type": "string",
  18761. "x-go-name": "LastError"
  18762. },
  18763. "last_update": {
  18764. "type": "string",
  18765. "x-go-name": "LastUpdateUnix"
  18766. },
  18767. "remote_address": {
  18768. "type": "string",
  18769. "x-go-name": "RemoteAddress"
  18770. },
  18771. "remote_name": {
  18772. "type": "string",
  18773. "x-go-name": "RemoteName"
  18774. },
  18775. "repo_name": {
  18776. "type": "string",
  18777. "x-go-name": "RepoName"
  18778. },
  18779. "sync_on_commit": {
  18780. "type": "boolean",
  18781. "x-go-name": "SyncOnCommit"
  18782. }
  18783. },
  18784. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18785. },
  18786. "Reaction": {
  18787. "description": "Reaction contain one reaction",
  18788. "type": "object",
  18789. "properties": {
  18790. "content": {
  18791. "type": "string",
  18792. "x-go-name": "Reaction"
  18793. },
  18794. "created_at": {
  18795. "type": "string",
  18796. "format": "date-time",
  18797. "x-go-name": "Created"
  18798. },
  18799. "user": {
  18800. "$ref": "#/definitions/User"
  18801. }
  18802. },
  18803. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18804. },
  18805. "Reference": {
  18806. "type": "object",
  18807. "title": "Reference represents a Git reference.",
  18808. "properties": {
  18809. "object": {
  18810. "$ref": "#/definitions/GitObject"
  18811. },
  18812. "ref": {
  18813. "type": "string",
  18814. "x-go-name": "Ref"
  18815. },
  18816. "url": {
  18817. "type": "string",
  18818. "x-go-name": "URL"
  18819. }
  18820. },
  18821. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18822. },
  18823. "Release": {
  18824. "description": "Release represents a repository release",
  18825. "type": "object",
  18826. "properties": {
  18827. "assets": {
  18828. "type": "array",
  18829. "items": {
  18830. "$ref": "#/definitions/Attachment"
  18831. },
  18832. "x-go-name": "Attachments"
  18833. },
  18834. "author": {
  18835. "$ref": "#/definitions/User"
  18836. },
  18837. "body": {
  18838. "type": "string",
  18839. "x-go-name": "Note"
  18840. },
  18841. "created_at": {
  18842. "type": "string",
  18843. "format": "date-time",
  18844. "x-go-name": "CreatedAt"
  18845. },
  18846. "draft": {
  18847. "type": "boolean",
  18848. "x-go-name": "IsDraft"
  18849. },
  18850. "html_url": {
  18851. "type": "string",
  18852. "x-go-name": "HTMLURL"
  18853. },
  18854. "id": {
  18855. "type": "integer",
  18856. "format": "int64",
  18857. "x-go-name": "ID"
  18858. },
  18859. "name": {
  18860. "type": "string",
  18861. "x-go-name": "Title"
  18862. },
  18863. "prerelease": {
  18864. "type": "boolean",
  18865. "x-go-name": "IsPrerelease"
  18866. },
  18867. "published_at": {
  18868. "type": "string",
  18869. "format": "date-time",
  18870. "x-go-name": "PublishedAt"
  18871. },
  18872. "tag_name": {
  18873. "type": "string",
  18874. "x-go-name": "TagName"
  18875. },
  18876. "tarball_url": {
  18877. "type": "string",
  18878. "x-go-name": "TarURL"
  18879. },
  18880. "target_commitish": {
  18881. "type": "string",
  18882. "x-go-name": "Target"
  18883. },
  18884. "url": {
  18885. "type": "string",
  18886. "x-go-name": "URL"
  18887. },
  18888. "zipball_url": {
  18889. "type": "string",
  18890. "x-go-name": "ZipURL"
  18891. }
  18892. },
  18893. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18894. },
  18895. "RepoCollaboratorPermission": {
  18896. "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
  18897. "type": "object",
  18898. "properties": {
  18899. "permission": {
  18900. "type": "string",
  18901. "x-go-name": "Permission"
  18902. },
  18903. "role_name": {
  18904. "type": "string",
  18905. "x-go-name": "RoleName"
  18906. },
  18907. "user": {
  18908. "$ref": "#/definitions/User"
  18909. }
  18910. },
  18911. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18912. },
  18913. "RepoCommit": {
  18914. "type": "object",
  18915. "title": "RepoCommit contains information of a commit in the context of a repository.",
  18916. "properties": {
  18917. "author": {
  18918. "$ref": "#/definitions/CommitUser"
  18919. },
  18920. "committer": {
  18921. "$ref": "#/definitions/CommitUser"
  18922. },
  18923. "message": {
  18924. "type": "string",
  18925. "x-go-name": "Message"
  18926. },
  18927. "tree": {
  18928. "$ref": "#/definitions/CommitMeta"
  18929. },
  18930. "url": {
  18931. "type": "string",
  18932. "x-go-name": "URL"
  18933. },
  18934. "verification": {
  18935. "$ref": "#/definitions/PayloadCommitVerification"
  18936. }
  18937. },
  18938. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18939. },
  18940. "RepoTopicOptions": {
  18941. "description": "RepoTopicOptions a collection of repo topic names",
  18942. "type": "object",
  18943. "properties": {
  18944. "topics": {
  18945. "description": "list of topic names",
  18946. "type": "array",
  18947. "items": {
  18948. "type": "string"
  18949. },
  18950. "x-go-name": "Topics"
  18951. }
  18952. },
  18953. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18954. },
  18955. "RepoTransfer": {
  18956. "description": "RepoTransfer represents a pending repo transfer",
  18957. "type": "object",
  18958. "properties": {
  18959. "doer": {
  18960. "$ref": "#/definitions/User"
  18961. },
  18962. "recipient": {
  18963. "$ref": "#/definitions/User"
  18964. },
  18965. "teams": {
  18966. "type": "array",
  18967. "items": {
  18968. "$ref": "#/definitions/Team"
  18969. },
  18970. "x-go-name": "Teams"
  18971. }
  18972. },
  18973. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18974. },
  18975. "Repository": {
  18976. "description": "Repository represents a repository",
  18977. "type": "object",
  18978. "properties": {
  18979. "allow_merge_commits": {
  18980. "type": "boolean",
  18981. "x-go-name": "AllowMerge"
  18982. },
  18983. "allow_rebase": {
  18984. "type": "boolean",
  18985. "x-go-name": "AllowRebase"
  18986. },
  18987. "allow_rebase_explicit": {
  18988. "type": "boolean",
  18989. "x-go-name": "AllowRebaseMerge"
  18990. },
  18991. "allow_rebase_update": {
  18992. "type": "boolean",
  18993. "x-go-name": "AllowRebaseUpdate"
  18994. },
  18995. "allow_squash_merge": {
  18996. "type": "boolean",
  18997. "x-go-name": "AllowSquash"
  18998. },
  18999. "archived": {
  19000. "type": "boolean",
  19001. "x-go-name": "Archived"
  19002. },
  19003. "avatar_url": {
  19004. "type": "string",
  19005. "x-go-name": "AvatarURL"
  19006. },
  19007. "clone_url": {
  19008. "type": "string",
  19009. "x-go-name": "CloneURL"
  19010. },
  19011. "created_at": {
  19012. "type": "string",
  19013. "format": "date-time",
  19014. "x-go-name": "Created"
  19015. },
  19016. "default_branch": {
  19017. "type": "string",
  19018. "x-go-name": "DefaultBranch"
  19019. },
  19020. "default_delete_branch_after_merge": {
  19021. "type": "boolean",
  19022. "x-go-name": "DefaultDeleteBranchAfterMerge"
  19023. },
  19024. "default_merge_style": {
  19025. "type": "string",
  19026. "x-go-name": "DefaultMergeStyle"
  19027. },
  19028. "description": {
  19029. "type": "string",
  19030. "x-go-name": "Description"
  19031. },
  19032. "empty": {
  19033. "type": "boolean",
  19034. "x-go-name": "Empty"
  19035. },
  19036. "external_tracker": {
  19037. "$ref": "#/definitions/ExternalTracker"
  19038. },
  19039. "external_wiki": {
  19040. "$ref": "#/definitions/ExternalWiki"
  19041. },
  19042. "fork": {
  19043. "type": "boolean",
  19044. "x-go-name": "Fork"
  19045. },
  19046. "forks_count": {
  19047. "type": "integer",
  19048. "format": "int64",
  19049. "x-go-name": "Forks"
  19050. },
  19051. "full_name": {
  19052. "type": "string",
  19053. "x-go-name": "FullName"
  19054. },
  19055. "has_issues": {
  19056. "type": "boolean",
  19057. "x-go-name": "HasIssues"
  19058. },
  19059. "has_projects": {
  19060. "type": "boolean",
  19061. "x-go-name": "HasProjects"
  19062. },
  19063. "has_pull_requests": {
  19064. "type": "boolean",
  19065. "x-go-name": "HasPullRequests"
  19066. },
  19067. "has_wiki": {
  19068. "type": "boolean",
  19069. "x-go-name": "HasWiki"
  19070. },
  19071. "html_url": {
  19072. "type": "string",
  19073. "x-go-name": "HTMLURL"
  19074. },
  19075. "id": {
  19076. "type": "integer",
  19077. "format": "int64",
  19078. "x-go-name": "ID"
  19079. },
  19080. "ignore_whitespace_conflicts": {
  19081. "type": "boolean",
  19082. "x-go-name": "IgnoreWhitespaceConflicts"
  19083. },
  19084. "internal": {
  19085. "type": "boolean",
  19086. "x-go-name": "Internal"
  19087. },
  19088. "internal_tracker": {
  19089. "$ref": "#/definitions/InternalTracker"
  19090. },
  19091. "language": {
  19092. "type": "string",
  19093. "x-go-name": "Language"
  19094. },
  19095. "languages_url": {
  19096. "type": "string",
  19097. "x-go-name": "LanguagesURL"
  19098. },
  19099. "mirror": {
  19100. "type": "boolean",
  19101. "x-go-name": "Mirror"
  19102. },
  19103. "mirror_interval": {
  19104. "type": "string",
  19105. "x-go-name": "MirrorInterval"
  19106. },
  19107. "mirror_updated": {
  19108. "type": "string",
  19109. "format": "date-time",
  19110. "x-go-name": "MirrorUpdated"
  19111. },
  19112. "name": {
  19113. "type": "string",
  19114. "x-go-name": "Name"
  19115. },
  19116. "open_issues_count": {
  19117. "type": "integer",
  19118. "format": "int64",
  19119. "x-go-name": "OpenIssues"
  19120. },
  19121. "open_pr_counter": {
  19122. "type": "integer",
  19123. "format": "int64",
  19124. "x-go-name": "OpenPulls"
  19125. },
  19126. "original_url": {
  19127. "type": "string",
  19128. "x-go-name": "OriginalURL"
  19129. },
  19130. "owner": {
  19131. "$ref": "#/definitions/User"
  19132. },
  19133. "parent": {
  19134. "$ref": "#/definitions/Repository"
  19135. },
  19136. "permissions": {
  19137. "$ref": "#/definitions/Permission"
  19138. },
  19139. "private": {
  19140. "type": "boolean",
  19141. "x-go-name": "Private"
  19142. },
  19143. "release_counter": {
  19144. "type": "integer",
  19145. "format": "int64",
  19146. "x-go-name": "Releases"
  19147. },
  19148. "repo_transfer": {
  19149. "$ref": "#/definitions/RepoTransfer"
  19150. },
  19151. "size": {
  19152. "type": "integer",
  19153. "format": "int64",
  19154. "x-go-name": "Size"
  19155. },
  19156. "ssh_url": {
  19157. "type": "string",
  19158. "x-go-name": "SSHURL"
  19159. },
  19160. "stars_count": {
  19161. "type": "integer",
  19162. "format": "int64",
  19163. "x-go-name": "Stars"
  19164. },
  19165. "template": {
  19166. "type": "boolean",
  19167. "x-go-name": "Template"
  19168. },
  19169. "updated_at": {
  19170. "type": "string",
  19171. "format": "date-time",
  19172. "x-go-name": "Updated"
  19173. },
  19174. "watchers_count": {
  19175. "type": "integer",
  19176. "format": "int64",
  19177. "x-go-name": "Watchers"
  19178. },
  19179. "website": {
  19180. "type": "string",
  19181. "x-go-name": "Website"
  19182. }
  19183. },
  19184. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19185. },
  19186. "RepositoryMeta": {
  19187. "description": "RepositoryMeta basic repository information",
  19188. "type": "object",
  19189. "properties": {
  19190. "full_name": {
  19191. "type": "string",
  19192. "x-go-name": "FullName"
  19193. },
  19194. "id": {
  19195. "type": "integer",
  19196. "format": "int64",
  19197. "x-go-name": "ID"
  19198. },
  19199. "name": {
  19200. "type": "string",
  19201. "x-go-name": "Name"
  19202. },
  19203. "owner": {
  19204. "type": "string",
  19205. "x-go-name": "Owner"
  19206. }
  19207. },
  19208. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19209. },
  19210. "ReviewStateType": {
  19211. "description": "ReviewStateType review state type",
  19212. "type": "string",
  19213. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19214. },
  19215. "SearchResults": {
  19216. "description": "SearchResults results of a successful search",
  19217. "type": "object",
  19218. "properties": {
  19219. "data": {
  19220. "type": "array",
  19221. "items": {
  19222. "$ref": "#/definitions/Repository"
  19223. },
  19224. "x-go-name": "Data"
  19225. },
  19226. "ok": {
  19227. "type": "boolean",
  19228. "x-go-name": "OK"
  19229. }
  19230. },
  19231. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19232. },
  19233. "ServerVersion": {
  19234. "description": "ServerVersion wraps the version of the server",
  19235. "type": "object",
  19236. "properties": {
  19237. "version": {
  19238. "type": "string",
  19239. "x-go-name": "Version"
  19240. }
  19241. },
  19242. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19243. },
  19244. "StateType": {
  19245. "description": "StateType issue state type",
  19246. "type": "string",
  19247. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19248. },
  19249. "StopWatch": {
  19250. "description": "StopWatch represent a running stopwatch",
  19251. "type": "object",
  19252. "properties": {
  19253. "created": {
  19254. "type": "string",
  19255. "format": "date-time",
  19256. "x-go-name": "Created"
  19257. },
  19258. "duration": {
  19259. "type": "string",
  19260. "x-go-name": "Duration"
  19261. },
  19262. "issue_index": {
  19263. "type": "integer",
  19264. "format": "int64",
  19265. "x-go-name": "IssueIndex"
  19266. },
  19267. "issue_title": {
  19268. "type": "string",
  19269. "x-go-name": "IssueTitle"
  19270. },
  19271. "repo_name": {
  19272. "type": "string",
  19273. "x-go-name": "RepoName"
  19274. },
  19275. "repo_owner_name": {
  19276. "type": "string",
  19277. "x-go-name": "RepoOwnerName"
  19278. },
  19279. "seconds": {
  19280. "type": "integer",
  19281. "format": "int64",
  19282. "x-go-name": "Seconds"
  19283. }
  19284. },
  19285. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19286. },
  19287. "SubmitPullReviewOptions": {
  19288. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  19289. "type": "object",
  19290. "properties": {
  19291. "body": {
  19292. "type": "string",
  19293. "x-go-name": "Body"
  19294. },
  19295. "event": {
  19296. "$ref": "#/definitions/ReviewStateType"
  19297. }
  19298. },
  19299. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19300. },
  19301. "Tag": {
  19302. "description": "Tag represents a repository tag",
  19303. "type": "object",
  19304. "properties": {
  19305. "commit": {
  19306. "$ref": "#/definitions/CommitMeta"
  19307. },
  19308. "id": {
  19309. "type": "string",
  19310. "x-go-name": "ID"
  19311. },
  19312. "message": {
  19313. "type": "string",
  19314. "x-go-name": "Message"
  19315. },
  19316. "name": {
  19317. "type": "string",
  19318. "x-go-name": "Name"
  19319. },
  19320. "tarball_url": {
  19321. "type": "string",
  19322. "x-go-name": "TarballURL"
  19323. },
  19324. "zipball_url": {
  19325. "type": "string",
  19326. "x-go-name": "ZipballURL"
  19327. }
  19328. },
  19329. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19330. },
  19331. "Team": {
  19332. "description": "Team represents a team in an organization",
  19333. "type": "object",
  19334. "properties": {
  19335. "can_create_org_repo": {
  19336. "type": "boolean",
  19337. "x-go-name": "CanCreateOrgRepo"
  19338. },
  19339. "description": {
  19340. "type": "string",
  19341. "x-go-name": "Description"
  19342. },
  19343. "id": {
  19344. "type": "integer",
  19345. "format": "int64",
  19346. "x-go-name": "ID"
  19347. },
  19348. "includes_all_repositories": {
  19349. "type": "boolean",
  19350. "x-go-name": "IncludesAllRepositories"
  19351. },
  19352. "name": {
  19353. "type": "string",
  19354. "x-go-name": "Name"
  19355. },
  19356. "organization": {
  19357. "$ref": "#/definitions/Organization"
  19358. },
  19359. "permission": {
  19360. "type": "string",
  19361. "enum": [
  19362. "none",
  19363. "read",
  19364. "write",
  19365. "admin",
  19366. "owner"
  19367. ],
  19368. "x-go-name": "Permission"
  19369. },
  19370. "units": {
  19371. "type": "array",
  19372. "items": {
  19373. "type": "string"
  19374. },
  19375. "x-go-name": "Units",
  19376. "example": [
  19377. "repo.code",
  19378. "repo.issues",
  19379. "repo.ext_issues",
  19380. "repo.wiki",
  19381. "repo.pulls",
  19382. "repo.releases",
  19383. "repo.projects",
  19384. "repo.ext_wiki"
  19385. ]
  19386. },
  19387. "units_map": {
  19388. "type": "object",
  19389. "additionalProperties": {
  19390. "type": "string"
  19391. },
  19392. "x-go-name": "UnitsMap",
  19393. "example": {
  19394. "repo.code": "read",
  19395. "repo.ext_issues": "none",
  19396. "repo.ext_wiki": "none",
  19397. "repo.issues": "write",
  19398. "repo.projects": "none",
  19399. "repo.pulls": "owner",
  19400. "repo.releases": "none",
  19401. "repo.wiki": "admin"
  19402. }
  19403. }
  19404. },
  19405. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19406. },
  19407. "TimeStamp": {
  19408. "description": "TimeStamp defines a timestamp",
  19409. "type": "integer",
  19410. "format": "int64",
  19411. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  19412. },
  19413. "TimelineComment": {
  19414. "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
  19415. "type": "object",
  19416. "properties": {
  19417. "assignee": {
  19418. "$ref": "#/definitions/User"
  19419. },
  19420. "assignee_team": {
  19421. "$ref": "#/definitions/Team"
  19422. },
  19423. "body": {
  19424. "type": "string",
  19425. "x-go-name": "Body"
  19426. },
  19427. "created_at": {
  19428. "type": "string",
  19429. "format": "date-time",
  19430. "x-go-name": "Created"
  19431. },
  19432. "dependent_issue": {
  19433. "$ref": "#/definitions/Issue"
  19434. },
  19435. "html_url": {
  19436. "type": "string",
  19437. "x-go-name": "HTMLURL"
  19438. },
  19439. "id": {
  19440. "type": "integer",
  19441. "format": "int64",
  19442. "x-go-name": "ID"
  19443. },
  19444. "issue_url": {
  19445. "type": "string",
  19446. "x-go-name": "IssueURL"
  19447. },
  19448. "label": {
  19449. "$ref": "#/definitions/Label"
  19450. },
  19451. "milestone": {
  19452. "$ref": "#/definitions/Milestone"
  19453. },
  19454. "new_ref": {
  19455. "type": "string",
  19456. "x-go-name": "NewRef"
  19457. },
  19458. "new_title": {
  19459. "type": "string",
  19460. "x-go-name": "NewTitle"
  19461. },
  19462. "old_milestone": {
  19463. "$ref": "#/definitions/Milestone"
  19464. },
  19465. "old_project_id": {
  19466. "type": "integer",
  19467. "format": "int64",
  19468. "x-go-name": "OldProjectID"
  19469. },
  19470. "old_ref": {
  19471. "type": "string",
  19472. "x-go-name": "OldRef"
  19473. },
  19474. "old_title": {
  19475. "type": "string",
  19476. "x-go-name": "OldTitle"
  19477. },
  19478. "project_id": {
  19479. "type": "integer",
  19480. "format": "int64",
  19481. "x-go-name": "ProjectID"
  19482. },
  19483. "pull_request_url": {
  19484. "type": "string",
  19485. "x-go-name": "PRURL"
  19486. },
  19487. "ref_action": {
  19488. "type": "string",
  19489. "x-go-name": "RefAction"
  19490. },
  19491. "ref_comment": {
  19492. "$ref": "#/definitions/Comment"
  19493. },
  19494. "ref_commit_sha": {
  19495. "description": "commit SHA where issue/PR was referenced",
  19496. "type": "string",
  19497. "x-go-name": "RefCommitSHA"
  19498. },
  19499. "ref_issue": {
  19500. "$ref": "#/definitions/Issue"
  19501. },
  19502. "removed_assignee": {
  19503. "description": "whether the assignees were removed or added",
  19504. "type": "boolean",
  19505. "x-go-name": "RemovedAssignee"
  19506. },
  19507. "resolve_doer": {
  19508. "$ref": "#/definitions/User"
  19509. },
  19510. "review_id": {
  19511. "type": "integer",
  19512. "format": "int64",
  19513. "x-go-name": "ReviewID"
  19514. },
  19515. "tracked_time": {
  19516. "$ref": "#/definitions/TrackedTime"
  19517. },
  19518. "type": {
  19519. "type": "string",
  19520. "x-go-name": "Type"
  19521. },
  19522. "updated_at": {
  19523. "type": "string",
  19524. "format": "date-time",
  19525. "x-go-name": "Updated"
  19526. },
  19527. "user": {
  19528. "$ref": "#/definitions/User"
  19529. }
  19530. },
  19531. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19532. },
  19533. "TopicName": {
  19534. "description": "TopicName a list of repo topic names",
  19535. "type": "object",
  19536. "properties": {
  19537. "topics": {
  19538. "type": "array",
  19539. "items": {
  19540. "type": "string"
  19541. },
  19542. "x-go-name": "TopicNames"
  19543. }
  19544. },
  19545. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19546. },
  19547. "TopicResponse": {
  19548. "description": "TopicResponse for returning topics",
  19549. "type": "object",
  19550. "properties": {
  19551. "created": {
  19552. "type": "string",
  19553. "format": "date-time",
  19554. "x-go-name": "Created"
  19555. },
  19556. "id": {
  19557. "type": "integer",
  19558. "format": "int64",
  19559. "x-go-name": "ID"
  19560. },
  19561. "repo_count": {
  19562. "type": "integer",
  19563. "format": "int64",
  19564. "x-go-name": "RepoCount"
  19565. },
  19566. "topic_name": {
  19567. "type": "string",
  19568. "x-go-name": "Name"
  19569. },
  19570. "updated": {
  19571. "type": "string",
  19572. "format": "date-time",
  19573. "x-go-name": "Updated"
  19574. }
  19575. },
  19576. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19577. },
  19578. "TrackedTime": {
  19579. "description": "TrackedTime worked time for an issue / pr",
  19580. "type": "object",
  19581. "properties": {
  19582. "created": {
  19583. "type": "string",
  19584. "format": "date-time",
  19585. "x-go-name": "Created"
  19586. },
  19587. "id": {
  19588. "type": "integer",
  19589. "format": "int64",
  19590. "x-go-name": "ID"
  19591. },
  19592. "issue": {
  19593. "$ref": "#/definitions/Issue"
  19594. },
  19595. "issue_id": {
  19596. "description": "deprecated (only for backwards compatibility)",
  19597. "type": "integer",
  19598. "format": "int64",
  19599. "x-go-name": "IssueID"
  19600. },
  19601. "time": {
  19602. "description": "Time in seconds",
  19603. "type": "integer",
  19604. "format": "int64",
  19605. "x-go-name": "Time"
  19606. },
  19607. "user_id": {
  19608. "description": "deprecated (only for backwards compatibility)",
  19609. "type": "integer",
  19610. "format": "int64",
  19611. "x-go-name": "UserID"
  19612. },
  19613. "user_name": {
  19614. "type": "string",
  19615. "x-go-name": "UserName"
  19616. }
  19617. },
  19618. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19619. },
  19620. "TransferRepoOption": {
  19621. "description": "TransferRepoOption options when transfer a repository's ownership",
  19622. "type": "object",
  19623. "required": [
  19624. "new_owner"
  19625. ],
  19626. "properties": {
  19627. "new_owner": {
  19628. "type": "string",
  19629. "x-go-name": "NewOwner"
  19630. },
  19631. "team_ids": {
  19632. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  19633. "type": "array",
  19634. "items": {
  19635. "type": "integer",
  19636. "format": "int64"
  19637. },
  19638. "x-go-name": "TeamIDs"
  19639. }
  19640. },
  19641. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19642. },
  19643. "UpdateFileOptions": {
  19644. "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)",
  19645. "type": "object",
  19646. "required": [
  19647. "sha",
  19648. "content"
  19649. ],
  19650. "properties": {
  19651. "author": {
  19652. "$ref": "#/definitions/Identity"
  19653. },
  19654. "branch": {
  19655. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  19656. "type": "string",
  19657. "x-go-name": "BranchName"
  19658. },
  19659. "committer": {
  19660. "$ref": "#/definitions/Identity"
  19661. },
  19662. "content": {
  19663. "description": "content must be base64 encoded",
  19664. "type": "string",
  19665. "x-go-name": "Content"
  19666. },
  19667. "dates": {
  19668. "$ref": "#/definitions/CommitDateOptions"
  19669. },
  19670. "from_path": {
  19671. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  19672. "type": "string",
  19673. "x-go-name": "FromPath"
  19674. },
  19675. "message": {
  19676. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  19677. "type": "string",
  19678. "x-go-name": "Message"
  19679. },
  19680. "new_branch": {
  19681. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  19682. "type": "string",
  19683. "x-go-name": "NewBranchName"
  19684. },
  19685. "sha": {
  19686. "description": "sha is the SHA for the file that already exists",
  19687. "type": "string",
  19688. "x-go-name": "SHA"
  19689. },
  19690. "signoff": {
  19691. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  19692. "type": "boolean",
  19693. "x-go-name": "Signoff"
  19694. }
  19695. },
  19696. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19697. },
  19698. "User": {
  19699. "description": "User represents a user",
  19700. "type": "object",
  19701. "properties": {
  19702. "active": {
  19703. "description": "Is user active",
  19704. "type": "boolean",
  19705. "x-go-name": "IsActive"
  19706. },
  19707. "avatar_url": {
  19708. "description": "URL to the user's avatar",
  19709. "type": "string",
  19710. "x-go-name": "AvatarURL"
  19711. },
  19712. "created": {
  19713. "type": "string",
  19714. "format": "date-time",
  19715. "x-go-name": "Created"
  19716. },
  19717. "description": {
  19718. "description": "the user's description",
  19719. "type": "string",
  19720. "x-go-name": "Description"
  19721. },
  19722. "email": {
  19723. "type": "string",
  19724. "format": "email",
  19725. "x-go-name": "Email"
  19726. },
  19727. "followers_count": {
  19728. "description": "user counts",
  19729. "type": "integer",
  19730. "format": "int64",
  19731. "x-go-name": "Followers"
  19732. },
  19733. "following_count": {
  19734. "type": "integer",
  19735. "format": "int64",
  19736. "x-go-name": "Following"
  19737. },
  19738. "full_name": {
  19739. "description": "the user's full name",
  19740. "type": "string",
  19741. "x-go-name": "FullName"
  19742. },
  19743. "id": {
  19744. "description": "the user's id",
  19745. "type": "integer",
  19746. "format": "int64",
  19747. "x-go-name": "ID"
  19748. },
  19749. "is_admin": {
  19750. "description": "Is the user an administrator",
  19751. "type": "boolean",
  19752. "x-go-name": "IsAdmin"
  19753. },
  19754. "language": {
  19755. "description": "User locale",
  19756. "type": "string",
  19757. "x-go-name": "Language"
  19758. },
  19759. "last_login": {
  19760. "type": "string",
  19761. "format": "date-time",
  19762. "x-go-name": "LastLogin"
  19763. },
  19764. "location": {
  19765. "description": "the user's location",
  19766. "type": "string",
  19767. "x-go-name": "Location"
  19768. },
  19769. "login": {
  19770. "description": "the user's username",
  19771. "type": "string",
  19772. "x-go-name": "UserName"
  19773. },
  19774. "login_name": {
  19775. "description": "the user's authentication sign-in name.",
  19776. "type": "string",
  19777. "default": "empty",
  19778. "x-go-name": "LoginName"
  19779. },
  19780. "prohibit_login": {
  19781. "description": "Is user login prohibited",
  19782. "type": "boolean",
  19783. "x-go-name": "ProhibitLogin"
  19784. },
  19785. "restricted": {
  19786. "description": "Is user restricted",
  19787. "type": "boolean",
  19788. "x-go-name": "Restricted"
  19789. },
  19790. "starred_repos_count": {
  19791. "type": "integer",
  19792. "format": "int64",
  19793. "x-go-name": "StarredRepos"
  19794. },
  19795. "visibility": {
  19796. "description": "User visibility level option: public, limited, private",
  19797. "type": "string",
  19798. "x-go-name": "Visibility"
  19799. },
  19800. "website": {
  19801. "description": "the user's website",
  19802. "type": "string",
  19803. "x-go-name": "Website"
  19804. }
  19805. },
  19806. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19807. },
  19808. "UserHeatmapData": {
  19809. "description": "UserHeatmapData represents the data needed to create a heatmap",
  19810. "type": "object",
  19811. "properties": {
  19812. "contributions": {
  19813. "type": "integer",
  19814. "format": "int64",
  19815. "x-go-name": "Contributions"
  19816. },
  19817. "timestamp": {
  19818. "$ref": "#/definitions/TimeStamp"
  19819. }
  19820. },
  19821. "x-go-package": "code.gitea.io/gitea/models/activities"
  19822. },
  19823. "UserSettings": {
  19824. "description": "UserSettings represents user settings",
  19825. "type": "object",
  19826. "properties": {
  19827. "description": {
  19828. "type": "string",
  19829. "x-go-name": "Description"
  19830. },
  19831. "diff_view_style": {
  19832. "type": "string",
  19833. "x-go-name": "DiffViewStyle"
  19834. },
  19835. "full_name": {
  19836. "type": "string",
  19837. "x-go-name": "FullName"
  19838. },
  19839. "hide_activity": {
  19840. "type": "boolean",
  19841. "x-go-name": "HideActivity"
  19842. },
  19843. "hide_email": {
  19844. "description": "Privacy",
  19845. "type": "boolean",
  19846. "x-go-name": "HideEmail"
  19847. },
  19848. "language": {
  19849. "type": "string",
  19850. "x-go-name": "Language"
  19851. },
  19852. "location": {
  19853. "type": "string",
  19854. "x-go-name": "Location"
  19855. },
  19856. "theme": {
  19857. "type": "string",
  19858. "x-go-name": "Theme"
  19859. },
  19860. "website": {
  19861. "type": "string",
  19862. "x-go-name": "Website"
  19863. }
  19864. },
  19865. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19866. },
  19867. "UserSettingsOptions": {
  19868. "description": "UserSettingsOptions represents options to change user settings",
  19869. "type": "object",
  19870. "properties": {
  19871. "description": {
  19872. "type": "string",
  19873. "x-go-name": "Description"
  19874. },
  19875. "diff_view_style": {
  19876. "type": "string",
  19877. "x-go-name": "DiffViewStyle"
  19878. },
  19879. "full_name": {
  19880. "type": "string",
  19881. "x-go-name": "FullName"
  19882. },
  19883. "hide_activity": {
  19884. "type": "boolean",
  19885. "x-go-name": "HideActivity"
  19886. },
  19887. "hide_email": {
  19888. "description": "Privacy",
  19889. "type": "boolean",
  19890. "x-go-name": "HideEmail"
  19891. },
  19892. "language": {
  19893. "type": "string",
  19894. "x-go-name": "Language"
  19895. },
  19896. "location": {
  19897. "type": "string",
  19898. "x-go-name": "Location"
  19899. },
  19900. "theme": {
  19901. "type": "string",
  19902. "x-go-name": "Theme"
  19903. },
  19904. "website": {
  19905. "type": "string",
  19906. "x-go-name": "Website"
  19907. }
  19908. },
  19909. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19910. },
  19911. "WatchInfo": {
  19912. "description": "WatchInfo represents an API watch status of one repository",
  19913. "type": "object",
  19914. "properties": {
  19915. "created_at": {
  19916. "type": "string",
  19917. "format": "date-time",
  19918. "x-go-name": "CreatedAt"
  19919. },
  19920. "ignored": {
  19921. "type": "boolean",
  19922. "x-go-name": "Ignored"
  19923. },
  19924. "reason": {
  19925. "x-go-name": "Reason"
  19926. },
  19927. "repository_url": {
  19928. "type": "string",
  19929. "x-go-name": "RepositoryURL"
  19930. },
  19931. "subscribed": {
  19932. "type": "boolean",
  19933. "x-go-name": "Subscribed"
  19934. },
  19935. "url": {
  19936. "type": "string",
  19937. "x-go-name": "URL"
  19938. }
  19939. },
  19940. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19941. },
  19942. "WikiCommit": {
  19943. "description": "WikiCommit page commit/revision",
  19944. "type": "object",
  19945. "properties": {
  19946. "author": {
  19947. "$ref": "#/definitions/CommitUser"
  19948. },
  19949. "commiter": {
  19950. "$ref": "#/definitions/CommitUser"
  19951. },
  19952. "message": {
  19953. "type": "string",
  19954. "x-go-name": "Message"
  19955. },
  19956. "sha": {
  19957. "type": "string",
  19958. "x-go-name": "ID"
  19959. }
  19960. },
  19961. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19962. },
  19963. "WikiCommitList": {
  19964. "description": "WikiCommitList commit/revision list",
  19965. "type": "object",
  19966. "properties": {
  19967. "commits": {
  19968. "type": "array",
  19969. "items": {
  19970. "$ref": "#/definitions/WikiCommit"
  19971. },
  19972. "x-go-name": "WikiCommits"
  19973. },
  19974. "count": {
  19975. "type": "integer",
  19976. "format": "int64",
  19977. "x-go-name": "Count"
  19978. }
  19979. },
  19980. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19981. },
  19982. "WikiPage": {
  19983. "description": "WikiPage a wiki page",
  19984. "type": "object",
  19985. "properties": {
  19986. "commit_count": {
  19987. "type": "integer",
  19988. "format": "int64",
  19989. "x-go-name": "CommitCount"
  19990. },
  19991. "content_base64": {
  19992. "description": "Page content, base64 encoded",
  19993. "type": "string",
  19994. "x-go-name": "ContentBase64"
  19995. },
  19996. "footer": {
  19997. "type": "string",
  19998. "x-go-name": "Footer"
  19999. },
  20000. "html_url": {
  20001. "type": "string",
  20002. "x-go-name": "HTMLURL"
  20003. },
  20004. "last_commit": {
  20005. "$ref": "#/definitions/WikiCommit"
  20006. },
  20007. "sidebar": {
  20008. "type": "string",
  20009. "x-go-name": "Sidebar"
  20010. },
  20011. "sub_url": {
  20012. "type": "string",
  20013. "x-go-name": "SubURL"
  20014. },
  20015. "title": {
  20016. "type": "string",
  20017. "x-go-name": "Title"
  20018. }
  20019. },
  20020. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20021. },
  20022. "WikiPageMetaData": {
  20023. "description": "WikiPageMetaData wiki page meta information",
  20024. "type": "object",
  20025. "properties": {
  20026. "html_url": {
  20027. "type": "string",
  20028. "x-go-name": "HTMLURL"
  20029. },
  20030. "last_commit": {
  20031. "$ref": "#/definitions/WikiCommit"
  20032. },
  20033. "sub_url": {
  20034. "type": "string",
  20035. "x-go-name": "SubURL"
  20036. },
  20037. "title": {
  20038. "type": "string",
  20039. "x-go-name": "Title"
  20040. }
  20041. },
  20042. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20043. }
  20044. },
  20045. "responses": {
  20046. "AccessToken": {
  20047. "description": "AccessToken represents an API access token.",
  20048. "schema": {
  20049. "$ref": "#/definitions/AccessToken"
  20050. }
  20051. },
  20052. "AccessTokenList": {
  20053. "description": "AccessTokenList represents a list of API access token.",
  20054. "schema": {
  20055. "type": "array",
  20056. "items": {
  20057. "$ref": "#/definitions/AccessToken"
  20058. }
  20059. }
  20060. },
  20061. "ActivityPub": {
  20062. "description": "ActivityPub",
  20063. "schema": {
  20064. "$ref": "#/definitions/ActivityPub"
  20065. }
  20066. },
  20067. "AnnotatedTag": {
  20068. "description": "AnnotatedTag",
  20069. "schema": {
  20070. "$ref": "#/definitions/AnnotatedTag"
  20071. }
  20072. },
  20073. "Attachment": {
  20074. "description": "Attachment",
  20075. "schema": {
  20076. "$ref": "#/definitions/Attachment"
  20077. }
  20078. },
  20079. "AttachmentList": {
  20080. "description": "AttachmentList",
  20081. "schema": {
  20082. "type": "array",
  20083. "items": {
  20084. "$ref": "#/definitions/Attachment"
  20085. }
  20086. }
  20087. },
  20088. "Branch": {
  20089. "description": "Branch",
  20090. "schema": {
  20091. "$ref": "#/definitions/Branch"
  20092. }
  20093. },
  20094. "BranchList": {
  20095. "description": "BranchList",
  20096. "schema": {
  20097. "type": "array",
  20098. "items": {
  20099. "$ref": "#/definitions/Branch"
  20100. }
  20101. }
  20102. },
  20103. "BranchProtection": {
  20104. "description": "BranchProtection",
  20105. "schema": {
  20106. "$ref": "#/definitions/BranchProtection"
  20107. }
  20108. },
  20109. "BranchProtectionList": {
  20110. "description": "BranchProtectionList",
  20111. "schema": {
  20112. "type": "array",
  20113. "items": {
  20114. "$ref": "#/definitions/BranchProtection"
  20115. }
  20116. }
  20117. },
  20118. "ChangedFileList": {
  20119. "description": "ChangedFileList",
  20120. "schema": {
  20121. "type": "array",
  20122. "items": {
  20123. "$ref": "#/definitions/ChangedFile"
  20124. }
  20125. },
  20126. "headers": {
  20127. "X-HasMore": {
  20128. "type": "boolean",
  20129. "description": "True if there is another page"
  20130. },
  20131. "X-Page": {
  20132. "type": "integer",
  20133. "format": "int64",
  20134. "description": "The current page"
  20135. },
  20136. "X-PageCount": {
  20137. "type": "integer",
  20138. "format": "int64",
  20139. "description": "Total number of pages"
  20140. },
  20141. "X-PerPage": {
  20142. "type": "integer",
  20143. "format": "int64",
  20144. "description": "Commits per page"
  20145. },
  20146. "X-Total": {
  20147. "type": "integer",
  20148. "format": "int64",
  20149. "description": "Total commit count"
  20150. }
  20151. }
  20152. },
  20153. "CombinedStatus": {
  20154. "description": "CombinedStatus",
  20155. "schema": {
  20156. "$ref": "#/definitions/CombinedStatus"
  20157. }
  20158. },
  20159. "Comment": {
  20160. "description": "Comment",
  20161. "schema": {
  20162. "$ref": "#/definitions/Comment"
  20163. }
  20164. },
  20165. "CommentList": {
  20166. "description": "CommentList",
  20167. "schema": {
  20168. "type": "array",
  20169. "items": {
  20170. "$ref": "#/definitions/Comment"
  20171. }
  20172. }
  20173. },
  20174. "Commit": {
  20175. "description": "Commit",
  20176. "schema": {
  20177. "$ref": "#/definitions/Commit"
  20178. }
  20179. },
  20180. "CommitList": {
  20181. "description": "CommitList",
  20182. "schema": {
  20183. "type": "array",
  20184. "items": {
  20185. "$ref": "#/definitions/Commit"
  20186. }
  20187. },
  20188. "headers": {
  20189. "X-HasMore": {
  20190. "type": "boolean",
  20191. "description": "True if there is another page"
  20192. },
  20193. "X-Page": {
  20194. "type": "integer",
  20195. "format": "int64",
  20196. "description": "The current page"
  20197. },
  20198. "X-PageCount": {
  20199. "type": "integer",
  20200. "format": "int64",
  20201. "description": "Total number of pages"
  20202. },
  20203. "X-PerPage": {
  20204. "type": "integer",
  20205. "format": "int64",
  20206. "description": "Commits per page"
  20207. },
  20208. "X-Total": {
  20209. "type": "integer",
  20210. "format": "int64",
  20211. "description": "Total commit count"
  20212. }
  20213. }
  20214. },
  20215. "CommitStatus": {
  20216. "description": "CommitStatus",
  20217. "schema": {
  20218. "$ref": "#/definitions/CommitStatus"
  20219. }
  20220. },
  20221. "CommitStatusList": {
  20222. "description": "CommitStatusList",
  20223. "schema": {
  20224. "type": "array",
  20225. "items": {
  20226. "$ref": "#/definitions/CommitStatus"
  20227. }
  20228. }
  20229. },
  20230. "ContentsListResponse": {
  20231. "description": "ContentsListResponse",
  20232. "schema": {
  20233. "type": "array",
  20234. "items": {
  20235. "$ref": "#/definitions/ContentsResponse"
  20236. }
  20237. }
  20238. },
  20239. "ContentsResponse": {
  20240. "description": "ContentsResponse",
  20241. "schema": {
  20242. "$ref": "#/definitions/ContentsResponse"
  20243. }
  20244. },
  20245. "CronList": {
  20246. "description": "CronList",
  20247. "schema": {
  20248. "type": "array",
  20249. "items": {
  20250. "$ref": "#/definitions/Cron"
  20251. }
  20252. }
  20253. },
  20254. "DeployKey": {
  20255. "description": "DeployKey",
  20256. "schema": {
  20257. "$ref": "#/definitions/DeployKey"
  20258. }
  20259. },
  20260. "DeployKeyList": {
  20261. "description": "DeployKeyList",
  20262. "schema": {
  20263. "type": "array",
  20264. "items": {
  20265. "$ref": "#/definitions/DeployKey"
  20266. }
  20267. }
  20268. },
  20269. "EmailList": {
  20270. "description": "EmailList",
  20271. "schema": {
  20272. "type": "array",
  20273. "items": {
  20274. "$ref": "#/definitions/Email"
  20275. }
  20276. }
  20277. },
  20278. "EmptyRepository": {
  20279. "description": "EmptyRepository",
  20280. "schema": {
  20281. "$ref": "#/definitions/APIError"
  20282. }
  20283. },
  20284. "FileDeleteResponse": {
  20285. "description": "FileDeleteResponse",
  20286. "schema": {
  20287. "$ref": "#/definitions/FileDeleteResponse"
  20288. }
  20289. },
  20290. "FileResponse": {
  20291. "description": "FileResponse",
  20292. "schema": {
  20293. "$ref": "#/definitions/FileResponse"
  20294. }
  20295. },
  20296. "GPGKey": {
  20297. "description": "GPGKey",
  20298. "schema": {
  20299. "$ref": "#/definitions/GPGKey"
  20300. }
  20301. },
  20302. "GPGKeyList": {
  20303. "description": "GPGKeyList",
  20304. "schema": {
  20305. "type": "array",
  20306. "items": {
  20307. "$ref": "#/definitions/GPGKey"
  20308. }
  20309. }
  20310. },
  20311. "GeneralAPISettings": {
  20312. "description": "GeneralAPISettings",
  20313. "schema": {
  20314. "$ref": "#/definitions/GeneralAPISettings"
  20315. }
  20316. },
  20317. "GeneralAttachmentSettings": {
  20318. "description": "GeneralAttachmentSettings",
  20319. "schema": {
  20320. "$ref": "#/definitions/GeneralAttachmentSettings"
  20321. }
  20322. },
  20323. "GeneralRepoSettings": {
  20324. "description": "GeneralRepoSettings",
  20325. "schema": {
  20326. "$ref": "#/definitions/GeneralRepoSettings"
  20327. }
  20328. },
  20329. "GeneralUISettings": {
  20330. "description": "GeneralUISettings",
  20331. "schema": {
  20332. "$ref": "#/definitions/GeneralUISettings"
  20333. }
  20334. },
  20335. "GitBlobResponse": {
  20336. "description": "GitBlobResponse",
  20337. "schema": {
  20338. "$ref": "#/definitions/GitBlobResponse"
  20339. }
  20340. },
  20341. "GitHook": {
  20342. "description": "GitHook",
  20343. "schema": {
  20344. "$ref": "#/definitions/GitHook"
  20345. }
  20346. },
  20347. "GitHookList": {
  20348. "description": "GitHookList",
  20349. "schema": {
  20350. "type": "array",
  20351. "items": {
  20352. "$ref": "#/definitions/GitHook"
  20353. }
  20354. }
  20355. },
  20356. "GitTreeResponse": {
  20357. "description": "GitTreeResponse",
  20358. "schema": {
  20359. "$ref": "#/definitions/GitTreeResponse"
  20360. }
  20361. },
  20362. "Hook": {
  20363. "description": "Hook",
  20364. "schema": {
  20365. "$ref": "#/definitions/Hook"
  20366. }
  20367. },
  20368. "HookList": {
  20369. "description": "HookList",
  20370. "schema": {
  20371. "type": "array",
  20372. "items": {
  20373. "$ref": "#/definitions/Hook"
  20374. }
  20375. }
  20376. },
  20377. "Issue": {
  20378. "description": "Issue",
  20379. "schema": {
  20380. "$ref": "#/definitions/Issue"
  20381. }
  20382. },
  20383. "IssueDeadline": {
  20384. "description": "IssueDeadline",
  20385. "schema": {
  20386. "$ref": "#/definitions/IssueDeadline"
  20387. }
  20388. },
  20389. "IssueList": {
  20390. "description": "IssueList",
  20391. "schema": {
  20392. "type": "array",
  20393. "items": {
  20394. "$ref": "#/definitions/Issue"
  20395. }
  20396. }
  20397. },
  20398. "IssueTemplates": {
  20399. "description": "IssueTemplates",
  20400. "schema": {
  20401. "type": "array",
  20402. "items": {
  20403. "$ref": "#/definitions/IssueTemplate"
  20404. }
  20405. }
  20406. },
  20407. "Label": {
  20408. "description": "Label",
  20409. "schema": {
  20410. "$ref": "#/definitions/Label"
  20411. }
  20412. },
  20413. "LabelList": {
  20414. "description": "LabelList",
  20415. "schema": {
  20416. "type": "array",
  20417. "items": {
  20418. "$ref": "#/definitions/Label"
  20419. }
  20420. }
  20421. },
  20422. "LanguageStatistics": {
  20423. "description": "LanguageStatistics",
  20424. "schema": {
  20425. "type": "object",
  20426. "additionalProperties": {
  20427. "type": "integer",
  20428. "format": "int64"
  20429. }
  20430. }
  20431. },
  20432. "MarkdownRender": {
  20433. "description": "MarkdownRender is a rendered markdown document",
  20434. "schema": {
  20435. "type": "string"
  20436. }
  20437. },
  20438. "Milestone": {
  20439. "description": "Milestone",
  20440. "schema": {
  20441. "$ref": "#/definitions/Milestone"
  20442. }
  20443. },
  20444. "MilestoneList": {
  20445. "description": "MilestoneList",
  20446. "schema": {
  20447. "type": "array",
  20448. "items": {
  20449. "$ref": "#/definitions/Milestone"
  20450. }
  20451. }
  20452. },
  20453. "NodeInfo": {
  20454. "description": "NodeInfo",
  20455. "schema": {
  20456. "$ref": "#/definitions/NodeInfo"
  20457. }
  20458. },
  20459. "Note": {
  20460. "description": "Note",
  20461. "schema": {
  20462. "$ref": "#/definitions/Note"
  20463. }
  20464. },
  20465. "NotificationCount": {
  20466. "description": "Number of unread notifications",
  20467. "schema": {
  20468. "$ref": "#/definitions/NotificationCount"
  20469. }
  20470. },
  20471. "NotificationThread": {
  20472. "description": "NotificationThread",
  20473. "schema": {
  20474. "$ref": "#/definitions/NotificationThread"
  20475. }
  20476. },
  20477. "NotificationThreadList": {
  20478. "description": "NotificationThreadList",
  20479. "schema": {
  20480. "type": "array",
  20481. "items": {
  20482. "$ref": "#/definitions/NotificationThread"
  20483. }
  20484. }
  20485. },
  20486. "OAuth2Application": {
  20487. "description": "OAuth2Application",
  20488. "schema": {
  20489. "$ref": "#/definitions/OAuth2Application"
  20490. }
  20491. },
  20492. "OAuth2ApplicationList": {
  20493. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  20494. "schema": {
  20495. "type": "array",
  20496. "items": {
  20497. "$ref": "#/definitions/OAuth2Application"
  20498. }
  20499. }
  20500. },
  20501. "Organization": {
  20502. "description": "Organization",
  20503. "schema": {
  20504. "$ref": "#/definitions/Organization"
  20505. }
  20506. },
  20507. "OrganizationList": {
  20508. "description": "OrganizationList",
  20509. "schema": {
  20510. "type": "array",
  20511. "items": {
  20512. "$ref": "#/definitions/Organization"
  20513. }
  20514. }
  20515. },
  20516. "OrganizationPermissions": {
  20517. "description": "OrganizationPermissions",
  20518. "schema": {
  20519. "$ref": "#/definitions/OrganizationPermissions"
  20520. }
  20521. },
  20522. "Package": {
  20523. "description": "Package",
  20524. "schema": {
  20525. "$ref": "#/definitions/Package"
  20526. }
  20527. },
  20528. "PackageFileList": {
  20529. "description": "PackageFileList",
  20530. "schema": {
  20531. "type": "array",
  20532. "items": {
  20533. "$ref": "#/definitions/PackageFile"
  20534. }
  20535. }
  20536. },
  20537. "PackageList": {
  20538. "description": "PackageList",
  20539. "schema": {
  20540. "type": "array",
  20541. "items": {
  20542. "$ref": "#/definitions/Package"
  20543. }
  20544. }
  20545. },
  20546. "PublicKey": {
  20547. "description": "PublicKey",
  20548. "schema": {
  20549. "$ref": "#/definitions/PublicKey"
  20550. }
  20551. },
  20552. "PublicKeyList": {
  20553. "description": "PublicKeyList",
  20554. "schema": {
  20555. "type": "array",
  20556. "items": {
  20557. "$ref": "#/definitions/PublicKey"
  20558. }
  20559. }
  20560. },
  20561. "PullRequest": {
  20562. "description": "PullRequest",
  20563. "schema": {
  20564. "$ref": "#/definitions/PullRequest"
  20565. }
  20566. },
  20567. "PullRequestList": {
  20568. "description": "PullRequestList",
  20569. "schema": {
  20570. "type": "array",
  20571. "items": {
  20572. "$ref": "#/definitions/PullRequest"
  20573. }
  20574. }
  20575. },
  20576. "PullReview": {
  20577. "description": "PullReview",
  20578. "schema": {
  20579. "$ref": "#/definitions/PullReview"
  20580. }
  20581. },
  20582. "PullReviewComment": {
  20583. "description": "PullComment",
  20584. "schema": {
  20585. "$ref": "#/definitions/PullReviewComment"
  20586. }
  20587. },
  20588. "PullReviewCommentList": {
  20589. "description": "PullCommentList",
  20590. "schema": {
  20591. "type": "array",
  20592. "items": {
  20593. "$ref": "#/definitions/PullReviewComment"
  20594. }
  20595. }
  20596. },
  20597. "PullReviewList": {
  20598. "description": "PullReviewList",
  20599. "schema": {
  20600. "type": "array",
  20601. "items": {
  20602. "$ref": "#/definitions/PullReview"
  20603. }
  20604. }
  20605. },
  20606. "PushMirror": {
  20607. "description": "PushMirror",
  20608. "schema": {
  20609. "$ref": "#/definitions/PushMirror"
  20610. }
  20611. },
  20612. "PushMirrorList": {
  20613. "description": "PushMirrorList",
  20614. "schema": {
  20615. "type": "array",
  20616. "items": {
  20617. "$ref": "#/definitions/PushMirror"
  20618. }
  20619. }
  20620. },
  20621. "Reaction": {
  20622. "description": "Reaction",
  20623. "schema": {
  20624. "$ref": "#/definitions/Reaction"
  20625. }
  20626. },
  20627. "ReactionList": {
  20628. "description": "ReactionList",
  20629. "schema": {
  20630. "type": "array",
  20631. "items": {
  20632. "$ref": "#/definitions/Reaction"
  20633. }
  20634. }
  20635. },
  20636. "Reference": {
  20637. "description": "Reference",
  20638. "schema": {
  20639. "$ref": "#/definitions/Reference"
  20640. }
  20641. },
  20642. "ReferenceList": {
  20643. "description": "ReferenceList",
  20644. "schema": {
  20645. "type": "array",
  20646. "items": {
  20647. "$ref": "#/definitions/Reference"
  20648. }
  20649. }
  20650. },
  20651. "Release": {
  20652. "description": "Release",
  20653. "schema": {
  20654. "$ref": "#/definitions/Release"
  20655. }
  20656. },
  20657. "ReleaseList": {
  20658. "description": "ReleaseList",
  20659. "schema": {
  20660. "type": "array",
  20661. "items": {
  20662. "$ref": "#/definitions/Release"
  20663. }
  20664. }
  20665. },
  20666. "RepoCollaboratorPermission": {
  20667. "description": "RepoCollaboratorPermission",
  20668. "schema": {
  20669. "$ref": "#/definitions/RepoCollaboratorPermission"
  20670. }
  20671. },
  20672. "Repository": {
  20673. "description": "Repository",
  20674. "schema": {
  20675. "$ref": "#/definitions/Repository"
  20676. }
  20677. },
  20678. "RepositoryList": {
  20679. "description": "RepositoryList",
  20680. "schema": {
  20681. "type": "array",
  20682. "items": {
  20683. "$ref": "#/definitions/Repository"
  20684. }
  20685. }
  20686. },
  20687. "SearchResults": {
  20688. "description": "SearchResults",
  20689. "schema": {
  20690. "$ref": "#/definitions/SearchResults"
  20691. }
  20692. },
  20693. "ServerVersion": {
  20694. "description": "ServerVersion",
  20695. "schema": {
  20696. "$ref": "#/definitions/ServerVersion"
  20697. }
  20698. },
  20699. "StopWatch": {
  20700. "description": "StopWatch",
  20701. "schema": {
  20702. "$ref": "#/definitions/StopWatch"
  20703. }
  20704. },
  20705. "StopWatchList": {
  20706. "description": "StopWatchList",
  20707. "schema": {
  20708. "type": "array",
  20709. "items": {
  20710. "$ref": "#/definitions/StopWatch"
  20711. }
  20712. }
  20713. },
  20714. "StringSlice": {
  20715. "description": "StringSlice",
  20716. "schema": {
  20717. "type": "array",
  20718. "items": {
  20719. "type": "string"
  20720. }
  20721. }
  20722. },
  20723. "Tag": {
  20724. "description": "Tag",
  20725. "schema": {
  20726. "$ref": "#/definitions/Tag"
  20727. }
  20728. },
  20729. "TagList": {
  20730. "description": "TagList",
  20731. "schema": {
  20732. "type": "array",
  20733. "items": {
  20734. "$ref": "#/definitions/Tag"
  20735. }
  20736. }
  20737. },
  20738. "Team": {
  20739. "description": "Team",
  20740. "schema": {
  20741. "$ref": "#/definitions/Team"
  20742. }
  20743. },
  20744. "TeamList": {
  20745. "description": "TeamList",
  20746. "schema": {
  20747. "type": "array",
  20748. "items": {
  20749. "$ref": "#/definitions/Team"
  20750. }
  20751. }
  20752. },
  20753. "TimelineList": {
  20754. "description": "TimelineList",
  20755. "schema": {
  20756. "type": "array",
  20757. "items": {
  20758. "$ref": "#/definitions/TimelineComment"
  20759. }
  20760. }
  20761. },
  20762. "TopicListResponse": {
  20763. "description": "TopicListResponse",
  20764. "schema": {
  20765. "type": "array",
  20766. "items": {
  20767. "$ref": "#/definitions/TopicResponse"
  20768. }
  20769. }
  20770. },
  20771. "TopicNames": {
  20772. "description": "TopicNames",
  20773. "schema": {
  20774. "$ref": "#/definitions/TopicName"
  20775. }
  20776. },
  20777. "TrackedTime": {
  20778. "description": "TrackedTime",
  20779. "schema": {
  20780. "$ref": "#/definitions/TrackedTime"
  20781. }
  20782. },
  20783. "TrackedTimeList": {
  20784. "description": "TrackedTimeList",
  20785. "schema": {
  20786. "type": "array",
  20787. "items": {
  20788. "$ref": "#/definitions/TrackedTime"
  20789. }
  20790. }
  20791. },
  20792. "User": {
  20793. "description": "User",
  20794. "schema": {
  20795. "$ref": "#/definitions/User"
  20796. }
  20797. },
  20798. "UserHeatmapData": {
  20799. "description": "UserHeatmapData",
  20800. "schema": {
  20801. "type": "array",
  20802. "items": {
  20803. "$ref": "#/definitions/UserHeatmapData"
  20804. }
  20805. }
  20806. },
  20807. "UserList": {
  20808. "description": "UserList",
  20809. "schema": {
  20810. "type": "array",
  20811. "items": {
  20812. "$ref": "#/definitions/User"
  20813. }
  20814. }
  20815. },
  20816. "UserSettings": {
  20817. "description": "UserSettings",
  20818. "schema": {
  20819. "type": "array",
  20820. "items": {
  20821. "$ref": "#/definitions/UserSettings"
  20822. }
  20823. }
  20824. },
  20825. "WatchInfo": {
  20826. "description": "WatchInfo",
  20827. "schema": {
  20828. "$ref": "#/definitions/WatchInfo"
  20829. }
  20830. },
  20831. "WikiCommitList": {
  20832. "description": "WikiCommitList",
  20833. "schema": {
  20834. "$ref": "#/definitions/WikiCommitList"
  20835. }
  20836. },
  20837. "WikiPage": {
  20838. "description": "WikiPage",
  20839. "schema": {
  20840. "$ref": "#/definitions/WikiPage"
  20841. }
  20842. },
  20843. "WikiPageList": {
  20844. "description": "WikiPageList",
  20845. "schema": {
  20846. "type": "array",
  20847. "items": {
  20848. "$ref": "#/definitions/WikiPageMetaData"
  20849. }
  20850. }
  20851. },
  20852. "conflict": {
  20853. "description": "APIConflict is a conflict empty response"
  20854. },
  20855. "empty": {
  20856. "description": "APIEmpty is an empty response"
  20857. },
  20858. "error": {
  20859. "description": "APIError is error format response",
  20860. "headers": {
  20861. "message": {
  20862. "type": "string"
  20863. },
  20864. "url": {
  20865. "type": "string"
  20866. }
  20867. }
  20868. },
  20869. "forbidden": {
  20870. "description": "APIForbiddenError is a forbidden error response",
  20871. "headers": {
  20872. "message": {
  20873. "type": "string"
  20874. },
  20875. "url": {
  20876. "type": "string"
  20877. }
  20878. }
  20879. },
  20880. "invalidTopicsError": {
  20881. "description": "APIInvalidTopicsError is error format response to invalid topics",
  20882. "headers": {
  20883. "invalidTopics": {
  20884. "type": "array",
  20885. "items": {
  20886. "type": "string"
  20887. }
  20888. },
  20889. "message": {
  20890. "type": "string"
  20891. }
  20892. }
  20893. },
  20894. "notFound": {
  20895. "description": "APINotFound is a not found empty response"
  20896. },
  20897. "parameterBodies": {
  20898. "description": "parameterBodies",
  20899. "schema": {
  20900. "$ref": "#/definitions/CreatePushMirrorOption"
  20901. }
  20902. },
  20903. "redirect": {
  20904. "description": "APIRedirect is a redirect response"
  20905. },
  20906. "string": {
  20907. "description": "APIString is a string response",
  20908. "schema": {
  20909. "type": "string"
  20910. }
  20911. },
  20912. "validationError": {
  20913. "description": "APIValidationError is error format response related to input validation",
  20914. "headers": {
  20915. "message": {
  20916. "type": "string"
  20917. },
  20918. "url": {
  20919. "type": "string"
  20920. }
  20921. }
  20922. }
  20923. },
  20924. "securityDefinitions": {
  20925. "AccessToken": {
  20926. "type": "apiKey",
  20927. "name": "access_token",
  20928. "in": "query"
  20929. },
  20930. "AuthorizationHeaderToken": {
  20931. "description": "API tokens must be prepended with \"token\" followed by a space.",
  20932. "type": "apiKey",
  20933. "name": "Authorization",
  20934. "in": "header"
  20935. },
  20936. "BasicAuth": {
  20937. "type": "basic"
  20938. },
  20939. "SudoHeader": {
  20940. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  20941. "type": "apiKey",
  20942. "name": "Sudo",
  20943. "in": "header"
  20944. },
  20945. "SudoParam": {
  20946. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  20947. "type": "apiKey",
  20948. "name": "sudo",
  20949. "in": "query"
  20950. },
  20951. "TOTPHeader": {
  20952. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  20953. "type": "apiKey",
  20954. "name": "X-GITEA-OTP",
  20955. "in": "header"
  20956. },
  20957. "Token": {
  20958. "type": "apiKey",
  20959. "name": "token",
  20960. "in": "query"
  20961. }
  20962. },
  20963. "security": [
  20964. {
  20965. "BasicAuth": []
  20966. },
  20967. {
  20968. "Token": []
  20969. },
  20970. {
  20971. "AccessToken": []
  20972. },
  20973. {
  20974. "AuthorizationHeaderToken": []
  20975. },
  20976. {
  20977. "SudoParam": []
  20978. },
  20979. {
  20980. "SudoHeader": []
  20981. },
  20982. {
  20983. "TOTPHeader": []
  20984. }
  20985. ]
  20986. }