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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139
  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. "/admin/cron": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "admin"
  33. ],
  34. "summary": "List cron tasks",
  35. "operationId": "adminCronList",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "page number of results to return (1-based)",
  40. "name": "page",
  41. "in": "query"
  42. },
  43. {
  44. "type": "integer",
  45. "description": "page size of results",
  46. "name": "limit",
  47. "in": "query"
  48. }
  49. ],
  50. "responses": {
  51. "200": {
  52. "$ref": "#/responses/CronList"
  53. },
  54. "403": {
  55. "$ref": "#/responses/forbidden"
  56. }
  57. }
  58. }
  59. },
  60. "/admin/cron/{task}": {
  61. "post": {
  62. "produces": [
  63. "application/json"
  64. ],
  65. "tags": [
  66. "admin"
  67. ],
  68. "summary": "Run cron task",
  69. "operationId": "adminCronRun",
  70. "parameters": [
  71. {
  72. "type": "string",
  73. "description": "task to run",
  74. "name": "task",
  75. "in": "path",
  76. "required": true
  77. }
  78. ],
  79. "responses": {
  80. "204": {
  81. "$ref": "#/responses/empty"
  82. },
  83. "404": {
  84. "$ref": "#/responses/notFound"
  85. }
  86. }
  87. }
  88. },
  89. "/admin/orgs": {
  90. "get": {
  91. "produces": [
  92. "application/json"
  93. ],
  94. "tags": [
  95. "admin"
  96. ],
  97. "summary": "List all organizations",
  98. "operationId": "adminGetAllOrgs",
  99. "parameters": [
  100. {
  101. "type": "integer",
  102. "description": "page number of results to return (1-based)",
  103. "name": "page",
  104. "in": "query"
  105. },
  106. {
  107. "type": "integer",
  108. "description": "page size of results",
  109. "name": "limit",
  110. "in": "query"
  111. }
  112. ],
  113. "responses": {
  114. "200": {
  115. "$ref": "#/responses/OrganizationList"
  116. },
  117. "403": {
  118. "$ref": "#/responses/forbidden"
  119. }
  120. }
  121. }
  122. },
  123. "/admin/unadopted": {
  124. "get": {
  125. "produces": [
  126. "application/json"
  127. ],
  128. "tags": [
  129. "admin"
  130. ],
  131. "summary": "List unadopted repositories",
  132. "operationId": "adminUnadoptedList",
  133. "parameters": [
  134. {
  135. "type": "integer",
  136. "description": "page number of results to return (1-based)",
  137. "name": "page",
  138. "in": "query"
  139. },
  140. {
  141. "type": "integer",
  142. "description": "page size of results",
  143. "name": "limit",
  144. "in": "query"
  145. },
  146. {
  147. "type": "string",
  148. "description": "pattern of repositories to search for",
  149. "name": "pattern",
  150. "in": "query"
  151. }
  152. ],
  153. "responses": {
  154. "200": {
  155. "$ref": "#/responses/StringSlice"
  156. },
  157. "403": {
  158. "$ref": "#/responses/forbidden"
  159. }
  160. }
  161. }
  162. },
  163. "/admin/unadopted/{owner}/{repo}": {
  164. "post": {
  165. "produces": [
  166. "application/json"
  167. ],
  168. "tags": [
  169. "admin"
  170. ],
  171. "summary": "Adopt unadopted files as a repository",
  172. "operationId": "adminAdoptRepository",
  173. "parameters": [
  174. {
  175. "type": "string",
  176. "description": "owner of the repo",
  177. "name": "owner",
  178. "in": "path",
  179. "required": true
  180. },
  181. {
  182. "type": "string",
  183. "description": "name of the repo",
  184. "name": "repo",
  185. "in": "path",
  186. "required": true
  187. }
  188. ],
  189. "responses": {
  190. "204": {
  191. "$ref": "#/responses/empty"
  192. },
  193. "403": {
  194. "$ref": "#/responses/forbidden"
  195. },
  196. "404": {
  197. "$ref": "#/responses/notFound"
  198. }
  199. }
  200. },
  201. "delete": {
  202. "produces": [
  203. "application/json"
  204. ],
  205. "tags": [
  206. "admin"
  207. ],
  208. "summary": "Delete unadopted files",
  209. "operationId": "adminDeleteUnadoptedRepository",
  210. "parameters": [
  211. {
  212. "type": "string",
  213. "description": "owner of the repo",
  214. "name": "owner",
  215. "in": "path",
  216. "required": true
  217. },
  218. {
  219. "type": "string",
  220. "description": "name of the repo",
  221. "name": "repo",
  222. "in": "path",
  223. "required": true
  224. }
  225. ],
  226. "responses": {
  227. "204": {
  228. "$ref": "#/responses/empty"
  229. },
  230. "403": {
  231. "$ref": "#/responses/forbidden"
  232. }
  233. }
  234. }
  235. },
  236. "/admin/users": {
  237. "get": {
  238. "produces": [
  239. "application/json"
  240. ],
  241. "tags": [
  242. "admin"
  243. ],
  244. "summary": "List all users",
  245. "operationId": "adminGetAllUsers",
  246. "parameters": [
  247. {
  248. "type": "integer",
  249. "description": "page number of results to return (1-based)",
  250. "name": "page",
  251. "in": "query"
  252. },
  253. {
  254. "type": "integer",
  255. "description": "page size of results",
  256. "name": "limit",
  257. "in": "query"
  258. }
  259. ],
  260. "responses": {
  261. "200": {
  262. "$ref": "#/responses/UserList"
  263. },
  264. "403": {
  265. "$ref": "#/responses/forbidden"
  266. }
  267. }
  268. },
  269. "post": {
  270. "consumes": [
  271. "application/json"
  272. ],
  273. "produces": [
  274. "application/json"
  275. ],
  276. "tags": [
  277. "admin"
  278. ],
  279. "summary": "Create a user",
  280. "operationId": "adminCreateUser",
  281. "parameters": [
  282. {
  283. "name": "body",
  284. "in": "body",
  285. "schema": {
  286. "$ref": "#/definitions/CreateUserOption"
  287. }
  288. }
  289. ],
  290. "responses": {
  291. "201": {
  292. "$ref": "#/responses/User"
  293. },
  294. "400": {
  295. "$ref": "#/responses/error"
  296. },
  297. "403": {
  298. "$ref": "#/responses/forbidden"
  299. },
  300. "422": {
  301. "$ref": "#/responses/validationError"
  302. }
  303. }
  304. }
  305. },
  306. "/admin/users/{username}": {
  307. "delete": {
  308. "produces": [
  309. "application/json"
  310. ],
  311. "tags": [
  312. "admin"
  313. ],
  314. "summary": "Delete a user",
  315. "operationId": "adminDeleteUser",
  316. "parameters": [
  317. {
  318. "type": "string",
  319. "description": "username of user to delete",
  320. "name": "username",
  321. "in": "path",
  322. "required": true
  323. }
  324. ],
  325. "responses": {
  326. "204": {
  327. "$ref": "#/responses/empty"
  328. },
  329. "403": {
  330. "$ref": "#/responses/forbidden"
  331. },
  332. "422": {
  333. "$ref": "#/responses/validationError"
  334. }
  335. }
  336. },
  337. "patch": {
  338. "consumes": [
  339. "application/json"
  340. ],
  341. "produces": [
  342. "application/json"
  343. ],
  344. "tags": [
  345. "admin"
  346. ],
  347. "summary": "Edit an existing user",
  348. "operationId": "adminEditUser",
  349. "parameters": [
  350. {
  351. "type": "string",
  352. "description": "username of user to edit",
  353. "name": "username",
  354. "in": "path",
  355. "required": true
  356. },
  357. {
  358. "name": "body",
  359. "in": "body",
  360. "schema": {
  361. "$ref": "#/definitions/EditUserOption"
  362. }
  363. }
  364. ],
  365. "responses": {
  366. "200": {
  367. "$ref": "#/responses/User"
  368. },
  369. "403": {
  370. "$ref": "#/responses/forbidden"
  371. },
  372. "422": {
  373. "$ref": "#/responses/validationError"
  374. }
  375. }
  376. }
  377. },
  378. "/admin/users/{username}/keys": {
  379. "post": {
  380. "consumes": [
  381. "application/json"
  382. ],
  383. "produces": [
  384. "application/json"
  385. ],
  386. "tags": [
  387. "admin"
  388. ],
  389. "summary": "Add a public key on behalf of a user",
  390. "operationId": "adminCreatePublicKey",
  391. "parameters": [
  392. {
  393. "type": "string",
  394. "description": "username of the user",
  395. "name": "username",
  396. "in": "path",
  397. "required": true
  398. },
  399. {
  400. "name": "key",
  401. "in": "body",
  402. "schema": {
  403. "$ref": "#/definitions/CreateKeyOption"
  404. }
  405. }
  406. ],
  407. "responses": {
  408. "201": {
  409. "$ref": "#/responses/PublicKey"
  410. },
  411. "403": {
  412. "$ref": "#/responses/forbidden"
  413. },
  414. "422": {
  415. "$ref": "#/responses/validationError"
  416. }
  417. }
  418. }
  419. },
  420. "/admin/users/{username}/keys/{id}": {
  421. "delete": {
  422. "produces": [
  423. "application/json"
  424. ],
  425. "tags": [
  426. "admin"
  427. ],
  428. "summary": "Delete a user's public key",
  429. "operationId": "adminDeleteUserPublicKey",
  430. "parameters": [
  431. {
  432. "type": "string",
  433. "description": "username of user",
  434. "name": "username",
  435. "in": "path",
  436. "required": true
  437. },
  438. {
  439. "type": "integer",
  440. "format": "int64",
  441. "description": "id of the key to delete",
  442. "name": "id",
  443. "in": "path",
  444. "required": true
  445. }
  446. ],
  447. "responses": {
  448. "204": {
  449. "$ref": "#/responses/empty"
  450. },
  451. "403": {
  452. "$ref": "#/responses/forbidden"
  453. },
  454. "404": {
  455. "$ref": "#/responses/notFound"
  456. }
  457. }
  458. }
  459. },
  460. "/admin/users/{username}/orgs": {
  461. "post": {
  462. "consumes": [
  463. "application/json"
  464. ],
  465. "produces": [
  466. "application/json"
  467. ],
  468. "tags": [
  469. "admin"
  470. ],
  471. "summary": "Create an organization",
  472. "operationId": "adminCreateOrg",
  473. "parameters": [
  474. {
  475. "type": "string",
  476. "description": "username of the user that will own the created organization",
  477. "name": "username",
  478. "in": "path",
  479. "required": true
  480. },
  481. {
  482. "name": "organization",
  483. "in": "body",
  484. "required": true,
  485. "schema": {
  486. "$ref": "#/definitions/CreateOrgOption"
  487. }
  488. }
  489. ],
  490. "responses": {
  491. "201": {
  492. "$ref": "#/responses/Organization"
  493. },
  494. "403": {
  495. "$ref": "#/responses/forbidden"
  496. },
  497. "422": {
  498. "$ref": "#/responses/validationError"
  499. }
  500. }
  501. }
  502. },
  503. "/admin/users/{username}/repos": {
  504. "post": {
  505. "consumes": [
  506. "application/json"
  507. ],
  508. "produces": [
  509. "application/json"
  510. ],
  511. "tags": [
  512. "admin"
  513. ],
  514. "summary": "Create a repository on behalf of a user",
  515. "operationId": "adminCreateRepo",
  516. "parameters": [
  517. {
  518. "type": "string",
  519. "description": "username of the user. This user will own the created repository",
  520. "name": "username",
  521. "in": "path",
  522. "required": true
  523. },
  524. {
  525. "name": "repository",
  526. "in": "body",
  527. "required": true,
  528. "schema": {
  529. "$ref": "#/definitions/CreateRepoOption"
  530. }
  531. }
  532. ],
  533. "responses": {
  534. "201": {
  535. "$ref": "#/responses/Repository"
  536. },
  537. "403": {
  538. "$ref": "#/responses/forbidden"
  539. },
  540. "404": {
  541. "$ref": "#/responses/notFound"
  542. },
  543. "409": {
  544. "$ref": "#/responses/error"
  545. },
  546. "422": {
  547. "$ref": "#/responses/validationError"
  548. }
  549. }
  550. }
  551. },
  552. "/markdown": {
  553. "post": {
  554. "consumes": [
  555. "application/json"
  556. ],
  557. "produces": [
  558. "text/html"
  559. ],
  560. "tags": [
  561. "miscellaneous"
  562. ],
  563. "summary": "Render a markdown document as HTML",
  564. "operationId": "renderMarkdown",
  565. "parameters": [
  566. {
  567. "name": "body",
  568. "in": "body",
  569. "schema": {
  570. "$ref": "#/definitions/MarkdownOption"
  571. }
  572. }
  573. ],
  574. "responses": {
  575. "200": {
  576. "$ref": "#/responses/MarkdownRender"
  577. },
  578. "422": {
  579. "$ref": "#/responses/validationError"
  580. }
  581. }
  582. }
  583. },
  584. "/markdown/raw": {
  585. "post": {
  586. "consumes": [
  587. "text/plain"
  588. ],
  589. "produces": [
  590. "text/html"
  591. ],
  592. "tags": [
  593. "miscellaneous"
  594. ],
  595. "summary": "Render raw markdown as HTML",
  596. "operationId": "renderMarkdownRaw",
  597. "parameters": [
  598. {
  599. "description": "Request body to render",
  600. "name": "body",
  601. "in": "body",
  602. "required": true,
  603. "schema": {
  604. "type": "string"
  605. }
  606. }
  607. ],
  608. "responses": {
  609. "200": {
  610. "$ref": "#/responses/MarkdownRender"
  611. },
  612. "422": {
  613. "$ref": "#/responses/validationError"
  614. }
  615. }
  616. }
  617. },
  618. "/notifications": {
  619. "get": {
  620. "consumes": [
  621. "application/json"
  622. ],
  623. "produces": [
  624. "application/json"
  625. ],
  626. "tags": [
  627. "notification"
  628. ],
  629. "summary": "List users's notification threads",
  630. "operationId": "notifyGetList",
  631. "parameters": [
  632. {
  633. "type": "string",
  634. "description": "If true, show notifications marked as read. Default value is false",
  635. "name": "all",
  636. "in": "query"
  637. },
  638. {
  639. "type": "array",
  640. "items": {
  641. "type": "string"
  642. },
  643. "collectionFormat": "multi",
  644. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
  645. "name": "status-types",
  646. "in": "query"
  647. },
  648. {
  649. "type": "string",
  650. "format": "date-time",
  651. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  652. "name": "since",
  653. "in": "query"
  654. },
  655. {
  656. "type": "string",
  657. "format": "date-time",
  658. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  659. "name": "before",
  660. "in": "query"
  661. },
  662. {
  663. "type": "integer",
  664. "description": "page number of results to return (1-based)",
  665. "name": "page",
  666. "in": "query"
  667. },
  668. {
  669. "type": "integer",
  670. "description": "page size of results",
  671. "name": "limit",
  672. "in": "query"
  673. }
  674. ],
  675. "responses": {
  676. "200": {
  677. "$ref": "#/responses/NotificationThreadList"
  678. }
  679. }
  680. },
  681. "put": {
  682. "consumes": [
  683. "application/json"
  684. ],
  685. "produces": [
  686. "application/json"
  687. ],
  688. "tags": [
  689. "notification"
  690. ],
  691. "summary": "Mark notification threads as read, pinned or unread",
  692. "operationId": "notifyReadList",
  693. "parameters": [
  694. {
  695. "type": "string",
  696. "format": "date-time",
  697. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  698. "name": "last_read_at",
  699. "in": "query"
  700. },
  701. {
  702. "type": "string",
  703. "description": "If true, mark all notifications on this repo. Default value is false",
  704. "name": "all",
  705. "in": "query"
  706. },
  707. {
  708. "type": "array",
  709. "items": {
  710. "type": "string"
  711. },
  712. "collectionFormat": "multi",
  713. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  714. "name": "status-types",
  715. "in": "query"
  716. },
  717. {
  718. "type": "string",
  719. "description": "Status to mark notifications as, Defaults to read.",
  720. "name": "to-status",
  721. "in": "query"
  722. }
  723. ],
  724. "responses": {
  725. "205": {
  726. "$ref": "#/responses/empty"
  727. }
  728. }
  729. }
  730. },
  731. "/notifications/new": {
  732. "get": {
  733. "tags": [
  734. "notification"
  735. ],
  736. "summary": "Check if unread notifications exist",
  737. "operationId": "notifyNewAvailable",
  738. "responses": {
  739. "200": {
  740. "$ref": "#/responses/NotificationCount"
  741. }
  742. }
  743. }
  744. },
  745. "/notifications/threads/{id}": {
  746. "get": {
  747. "consumes": [
  748. "application/json"
  749. ],
  750. "produces": [
  751. "application/json"
  752. ],
  753. "tags": [
  754. "notification"
  755. ],
  756. "summary": "Get notification thread by ID",
  757. "operationId": "notifyGetThread",
  758. "parameters": [
  759. {
  760. "type": "string",
  761. "description": "id of notification thread",
  762. "name": "id",
  763. "in": "path",
  764. "required": true
  765. }
  766. ],
  767. "responses": {
  768. "200": {
  769. "$ref": "#/responses/NotificationThread"
  770. },
  771. "403": {
  772. "$ref": "#/responses/forbidden"
  773. },
  774. "404": {
  775. "$ref": "#/responses/notFound"
  776. }
  777. }
  778. },
  779. "patch": {
  780. "consumes": [
  781. "application/json"
  782. ],
  783. "produces": [
  784. "application/json"
  785. ],
  786. "tags": [
  787. "notification"
  788. ],
  789. "summary": "Mark notification thread as read by ID",
  790. "operationId": "notifyReadThread",
  791. "parameters": [
  792. {
  793. "type": "string",
  794. "description": "id of notification thread",
  795. "name": "id",
  796. "in": "path",
  797. "required": true
  798. },
  799. {
  800. "type": "string",
  801. "default": "read",
  802. "description": "Status to mark notifications as",
  803. "name": "to-status",
  804. "in": "query"
  805. }
  806. ],
  807. "responses": {
  808. "205": {
  809. "$ref": "#/responses/empty"
  810. },
  811. "403": {
  812. "$ref": "#/responses/forbidden"
  813. },
  814. "404": {
  815. "$ref": "#/responses/notFound"
  816. }
  817. }
  818. }
  819. },
  820. "/org/{org}/repos": {
  821. "post": {
  822. "consumes": [
  823. "application/json"
  824. ],
  825. "produces": [
  826. "application/json"
  827. ],
  828. "tags": [
  829. "organization"
  830. ],
  831. "summary": "Create a repository in an organization",
  832. "operationId": "createOrgRepoDeprecated",
  833. "deprecated": true,
  834. "parameters": [
  835. {
  836. "type": "string",
  837. "description": "name of organization",
  838. "name": "org",
  839. "in": "path",
  840. "required": true
  841. },
  842. {
  843. "name": "body",
  844. "in": "body",
  845. "schema": {
  846. "$ref": "#/definitions/CreateRepoOption"
  847. }
  848. }
  849. ],
  850. "responses": {
  851. "201": {
  852. "$ref": "#/responses/Repository"
  853. },
  854. "403": {
  855. "$ref": "#/responses/forbidden"
  856. },
  857. "422": {
  858. "$ref": "#/responses/validationError"
  859. }
  860. }
  861. }
  862. },
  863. "/orgs": {
  864. "get": {
  865. "produces": [
  866. "application/json"
  867. ],
  868. "tags": [
  869. "organization"
  870. ],
  871. "summary": "Get list of organizations",
  872. "operationId": "orgGetAll",
  873. "parameters": [
  874. {
  875. "type": "integer",
  876. "description": "page number of results to return (1-based)",
  877. "name": "page",
  878. "in": "query"
  879. },
  880. {
  881. "type": "integer",
  882. "description": "page size of results",
  883. "name": "limit",
  884. "in": "query"
  885. }
  886. ],
  887. "responses": {
  888. "200": {
  889. "$ref": "#/responses/OrganizationList"
  890. }
  891. }
  892. },
  893. "post": {
  894. "consumes": [
  895. "application/json"
  896. ],
  897. "produces": [
  898. "application/json"
  899. ],
  900. "tags": [
  901. "organization"
  902. ],
  903. "summary": "Create an organization",
  904. "operationId": "orgCreate",
  905. "parameters": [
  906. {
  907. "name": "organization",
  908. "in": "body",
  909. "required": true,
  910. "schema": {
  911. "$ref": "#/definitions/CreateOrgOption"
  912. }
  913. }
  914. ],
  915. "responses": {
  916. "201": {
  917. "$ref": "#/responses/Organization"
  918. },
  919. "403": {
  920. "$ref": "#/responses/forbidden"
  921. },
  922. "422": {
  923. "$ref": "#/responses/validationError"
  924. }
  925. }
  926. }
  927. },
  928. "/orgs/{org}": {
  929. "get": {
  930. "produces": [
  931. "application/json"
  932. ],
  933. "tags": [
  934. "organization"
  935. ],
  936. "summary": "Get an organization",
  937. "operationId": "orgGet",
  938. "parameters": [
  939. {
  940. "type": "string",
  941. "description": "name of the organization to get",
  942. "name": "org",
  943. "in": "path",
  944. "required": true
  945. }
  946. ],
  947. "responses": {
  948. "200": {
  949. "$ref": "#/responses/Organization"
  950. }
  951. }
  952. },
  953. "delete": {
  954. "produces": [
  955. "application/json"
  956. ],
  957. "tags": [
  958. "organization"
  959. ],
  960. "summary": "Delete an organization",
  961. "operationId": "orgDelete",
  962. "parameters": [
  963. {
  964. "type": "string",
  965. "description": "organization that is to be deleted",
  966. "name": "org",
  967. "in": "path",
  968. "required": true
  969. }
  970. ],
  971. "responses": {
  972. "204": {
  973. "$ref": "#/responses/empty"
  974. }
  975. }
  976. },
  977. "patch": {
  978. "consumes": [
  979. "application/json"
  980. ],
  981. "produces": [
  982. "application/json"
  983. ],
  984. "tags": [
  985. "organization"
  986. ],
  987. "summary": "Edit an organization",
  988. "operationId": "orgEdit",
  989. "parameters": [
  990. {
  991. "type": "string",
  992. "description": "name of the organization to edit",
  993. "name": "org",
  994. "in": "path",
  995. "required": true
  996. },
  997. {
  998. "name": "body",
  999. "in": "body",
  1000. "required": true,
  1001. "schema": {
  1002. "$ref": "#/definitions/EditOrgOption"
  1003. }
  1004. }
  1005. ],
  1006. "responses": {
  1007. "200": {
  1008. "$ref": "#/responses/Organization"
  1009. }
  1010. }
  1011. }
  1012. },
  1013. "/orgs/{org}/hooks": {
  1014. "get": {
  1015. "produces": [
  1016. "application/json"
  1017. ],
  1018. "tags": [
  1019. "organization"
  1020. ],
  1021. "summary": "List an organization's webhooks",
  1022. "operationId": "orgListHooks",
  1023. "parameters": [
  1024. {
  1025. "type": "string",
  1026. "description": "name of the organization",
  1027. "name": "org",
  1028. "in": "path",
  1029. "required": true
  1030. },
  1031. {
  1032. "type": "integer",
  1033. "description": "page number of results to return (1-based)",
  1034. "name": "page",
  1035. "in": "query"
  1036. },
  1037. {
  1038. "type": "integer",
  1039. "description": "page size of results",
  1040. "name": "limit",
  1041. "in": "query"
  1042. }
  1043. ],
  1044. "responses": {
  1045. "200": {
  1046. "$ref": "#/responses/HookList"
  1047. }
  1048. }
  1049. }
  1050. },
  1051. "/orgs/{org}/hooks/": {
  1052. "post": {
  1053. "consumes": [
  1054. "application/json"
  1055. ],
  1056. "produces": [
  1057. "application/json"
  1058. ],
  1059. "tags": [
  1060. "organization"
  1061. ],
  1062. "summary": "Create a hook",
  1063. "operationId": "orgCreateHook",
  1064. "parameters": [
  1065. {
  1066. "type": "string",
  1067. "description": "name of the organization",
  1068. "name": "org",
  1069. "in": "path",
  1070. "required": true
  1071. },
  1072. {
  1073. "name": "body",
  1074. "in": "body",
  1075. "required": true,
  1076. "schema": {
  1077. "$ref": "#/definitions/CreateHookOption"
  1078. }
  1079. }
  1080. ],
  1081. "responses": {
  1082. "201": {
  1083. "$ref": "#/responses/Hook"
  1084. }
  1085. }
  1086. }
  1087. },
  1088. "/orgs/{org}/hooks/{id}": {
  1089. "get": {
  1090. "produces": [
  1091. "application/json"
  1092. ],
  1093. "tags": [
  1094. "organization"
  1095. ],
  1096. "summary": "Get a hook",
  1097. "operationId": "orgGetHook",
  1098. "parameters": [
  1099. {
  1100. "type": "string",
  1101. "description": "name of the organization",
  1102. "name": "org",
  1103. "in": "path",
  1104. "required": true
  1105. },
  1106. {
  1107. "type": "integer",
  1108. "format": "int64",
  1109. "description": "id of the hook to get",
  1110. "name": "id",
  1111. "in": "path",
  1112. "required": true
  1113. }
  1114. ],
  1115. "responses": {
  1116. "200": {
  1117. "$ref": "#/responses/Hook"
  1118. }
  1119. }
  1120. },
  1121. "delete": {
  1122. "produces": [
  1123. "application/json"
  1124. ],
  1125. "tags": [
  1126. "organization"
  1127. ],
  1128. "summary": "Delete a hook",
  1129. "operationId": "orgDeleteHook",
  1130. "parameters": [
  1131. {
  1132. "type": "string",
  1133. "description": "name of the organization",
  1134. "name": "org",
  1135. "in": "path",
  1136. "required": true
  1137. },
  1138. {
  1139. "type": "integer",
  1140. "format": "int64",
  1141. "description": "id of the hook to delete",
  1142. "name": "id",
  1143. "in": "path",
  1144. "required": true
  1145. }
  1146. ],
  1147. "responses": {
  1148. "204": {
  1149. "$ref": "#/responses/empty"
  1150. }
  1151. }
  1152. },
  1153. "patch": {
  1154. "consumes": [
  1155. "application/json"
  1156. ],
  1157. "produces": [
  1158. "application/json"
  1159. ],
  1160. "tags": [
  1161. "organization"
  1162. ],
  1163. "summary": "Update a hook",
  1164. "operationId": "orgEditHook",
  1165. "parameters": [
  1166. {
  1167. "type": "string",
  1168. "description": "name of the organization",
  1169. "name": "org",
  1170. "in": "path",
  1171. "required": true
  1172. },
  1173. {
  1174. "type": "integer",
  1175. "format": "int64",
  1176. "description": "id of the hook to update",
  1177. "name": "id",
  1178. "in": "path",
  1179. "required": true
  1180. },
  1181. {
  1182. "name": "body",
  1183. "in": "body",
  1184. "schema": {
  1185. "$ref": "#/definitions/EditHookOption"
  1186. }
  1187. }
  1188. ],
  1189. "responses": {
  1190. "200": {
  1191. "$ref": "#/responses/Hook"
  1192. }
  1193. }
  1194. }
  1195. },
  1196. "/orgs/{org}/labels": {
  1197. "get": {
  1198. "produces": [
  1199. "application/json"
  1200. ],
  1201. "tags": [
  1202. "organization"
  1203. ],
  1204. "summary": "List an organization's labels",
  1205. "operationId": "orgListLabels",
  1206. "parameters": [
  1207. {
  1208. "type": "string",
  1209. "description": "name of the organization",
  1210. "name": "org",
  1211. "in": "path",
  1212. "required": true
  1213. },
  1214. {
  1215. "type": "integer",
  1216. "description": "page number of results to return (1-based)",
  1217. "name": "page",
  1218. "in": "query"
  1219. },
  1220. {
  1221. "type": "integer",
  1222. "description": "page size of results",
  1223. "name": "limit",
  1224. "in": "query"
  1225. }
  1226. ],
  1227. "responses": {
  1228. "200": {
  1229. "$ref": "#/responses/LabelList"
  1230. }
  1231. }
  1232. },
  1233. "post": {
  1234. "consumes": [
  1235. "application/json"
  1236. ],
  1237. "produces": [
  1238. "application/json"
  1239. ],
  1240. "tags": [
  1241. "organization"
  1242. ],
  1243. "summary": "Create a label for an organization",
  1244. "operationId": "orgCreateLabel",
  1245. "parameters": [
  1246. {
  1247. "type": "string",
  1248. "description": "name of the organization",
  1249. "name": "org",
  1250. "in": "path",
  1251. "required": true
  1252. },
  1253. {
  1254. "name": "body",
  1255. "in": "body",
  1256. "schema": {
  1257. "$ref": "#/definitions/CreateLabelOption"
  1258. }
  1259. }
  1260. ],
  1261. "responses": {
  1262. "201": {
  1263. "$ref": "#/responses/Label"
  1264. },
  1265. "422": {
  1266. "$ref": "#/responses/validationError"
  1267. }
  1268. }
  1269. }
  1270. },
  1271. "/orgs/{org}/labels/{id}": {
  1272. "get": {
  1273. "produces": [
  1274. "application/json"
  1275. ],
  1276. "tags": [
  1277. "organization"
  1278. ],
  1279. "summary": "Get a single label",
  1280. "operationId": "orgGetLabel",
  1281. "parameters": [
  1282. {
  1283. "type": "string",
  1284. "description": "name of the organization",
  1285. "name": "org",
  1286. "in": "path",
  1287. "required": true
  1288. },
  1289. {
  1290. "type": "integer",
  1291. "format": "int64",
  1292. "description": "id of the label to get",
  1293. "name": "id",
  1294. "in": "path",
  1295. "required": true
  1296. }
  1297. ],
  1298. "responses": {
  1299. "200": {
  1300. "$ref": "#/responses/Label"
  1301. }
  1302. }
  1303. },
  1304. "delete": {
  1305. "tags": [
  1306. "organization"
  1307. ],
  1308. "summary": "Delete a label",
  1309. "operationId": "orgDeleteLabel",
  1310. "parameters": [
  1311. {
  1312. "type": "string",
  1313. "description": "name of the organization",
  1314. "name": "org",
  1315. "in": "path",
  1316. "required": true
  1317. },
  1318. {
  1319. "type": "integer",
  1320. "format": "int64",
  1321. "description": "id of the label to delete",
  1322. "name": "id",
  1323. "in": "path",
  1324. "required": true
  1325. }
  1326. ],
  1327. "responses": {
  1328. "204": {
  1329. "$ref": "#/responses/empty"
  1330. }
  1331. }
  1332. },
  1333. "patch": {
  1334. "consumes": [
  1335. "application/json"
  1336. ],
  1337. "produces": [
  1338. "application/json"
  1339. ],
  1340. "tags": [
  1341. "organization"
  1342. ],
  1343. "summary": "Update a label",
  1344. "operationId": "orgEditLabel",
  1345. "parameters": [
  1346. {
  1347. "type": "string",
  1348. "description": "name of the organization",
  1349. "name": "org",
  1350. "in": "path",
  1351. "required": true
  1352. },
  1353. {
  1354. "type": "integer",
  1355. "format": "int64",
  1356. "description": "id of the label to edit",
  1357. "name": "id",
  1358. "in": "path",
  1359. "required": true
  1360. },
  1361. {
  1362. "name": "body",
  1363. "in": "body",
  1364. "schema": {
  1365. "$ref": "#/definitions/EditLabelOption"
  1366. }
  1367. }
  1368. ],
  1369. "responses": {
  1370. "200": {
  1371. "$ref": "#/responses/Label"
  1372. },
  1373. "422": {
  1374. "$ref": "#/responses/validationError"
  1375. }
  1376. }
  1377. }
  1378. },
  1379. "/orgs/{org}/members": {
  1380. "get": {
  1381. "produces": [
  1382. "application/json"
  1383. ],
  1384. "tags": [
  1385. "organization"
  1386. ],
  1387. "summary": "List an organization's members",
  1388. "operationId": "orgListMembers",
  1389. "parameters": [
  1390. {
  1391. "type": "string",
  1392. "description": "name of the organization",
  1393. "name": "org",
  1394. "in": "path",
  1395. "required": true
  1396. },
  1397. {
  1398. "type": "integer",
  1399. "description": "page number of results to return (1-based)",
  1400. "name": "page",
  1401. "in": "query"
  1402. },
  1403. {
  1404. "type": "integer",
  1405. "description": "page size of results",
  1406. "name": "limit",
  1407. "in": "query"
  1408. }
  1409. ],
  1410. "responses": {
  1411. "200": {
  1412. "$ref": "#/responses/UserList"
  1413. }
  1414. }
  1415. }
  1416. },
  1417. "/orgs/{org}/members/{username}": {
  1418. "get": {
  1419. "tags": [
  1420. "organization"
  1421. ],
  1422. "summary": "Check if a user is a member of an organization",
  1423. "operationId": "orgIsMember",
  1424. "parameters": [
  1425. {
  1426. "type": "string",
  1427. "description": "name of the organization",
  1428. "name": "org",
  1429. "in": "path",
  1430. "required": true
  1431. },
  1432. {
  1433. "type": "string",
  1434. "description": "username of the user",
  1435. "name": "username",
  1436. "in": "path",
  1437. "required": true
  1438. }
  1439. ],
  1440. "responses": {
  1441. "204": {
  1442. "description": "user is a member"
  1443. },
  1444. "302": {
  1445. "description": "redirection to /orgs/{org}/public_members/{username}"
  1446. },
  1447. "404": {
  1448. "description": "user is not a member"
  1449. }
  1450. }
  1451. },
  1452. "delete": {
  1453. "produces": [
  1454. "application/json"
  1455. ],
  1456. "tags": [
  1457. "organization"
  1458. ],
  1459. "summary": "Remove a member from an organization",
  1460. "operationId": "orgDeleteMember",
  1461. "parameters": [
  1462. {
  1463. "type": "string",
  1464. "description": "name of the organization",
  1465. "name": "org",
  1466. "in": "path",
  1467. "required": true
  1468. },
  1469. {
  1470. "type": "string",
  1471. "description": "username of the user",
  1472. "name": "username",
  1473. "in": "path",
  1474. "required": true
  1475. }
  1476. ],
  1477. "responses": {
  1478. "204": {
  1479. "description": "member removed"
  1480. }
  1481. }
  1482. }
  1483. },
  1484. "/orgs/{org}/public_members": {
  1485. "get": {
  1486. "produces": [
  1487. "application/json"
  1488. ],
  1489. "tags": [
  1490. "organization"
  1491. ],
  1492. "summary": "List an organization's public members",
  1493. "operationId": "orgListPublicMembers",
  1494. "parameters": [
  1495. {
  1496. "type": "string",
  1497. "description": "name of the organization",
  1498. "name": "org",
  1499. "in": "path",
  1500. "required": true
  1501. },
  1502. {
  1503. "type": "integer",
  1504. "description": "page number of results to return (1-based)",
  1505. "name": "page",
  1506. "in": "query"
  1507. },
  1508. {
  1509. "type": "integer",
  1510. "description": "page size of results",
  1511. "name": "limit",
  1512. "in": "query"
  1513. }
  1514. ],
  1515. "responses": {
  1516. "200": {
  1517. "$ref": "#/responses/UserList"
  1518. }
  1519. }
  1520. }
  1521. },
  1522. "/orgs/{org}/public_members/{username}": {
  1523. "get": {
  1524. "tags": [
  1525. "organization"
  1526. ],
  1527. "summary": "Check if a user is a public member of an organization",
  1528. "operationId": "orgIsPublicMember",
  1529. "parameters": [
  1530. {
  1531. "type": "string",
  1532. "description": "name of the organization",
  1533. "name": "org",
  1534. "in": "path",
  1535. "required": true
  1536. },
  1537. {
  1538. "type": "string",
  1539. "description": "username of the user",
  1540. "name": "username",
  1541. "in": "path",
  1542. "required": true
  1543. }
  1544. ],
  1545. "responses": {
  1546. "204": {
  1547. "description": "user is a public member"
  1548. },
  1549. "404": {
  1550. "description": "user is not a public member"
  1551. }
  1552. }
  1553. },
  1554. "put": {
  1555. "produces": [
  1556. "application/json"
  1557. ],
  1558. "tags": [
  1559. "organization"
  1560. ],
  1561. "summary": "Publicize a user's membership",
  1562. "operationId": "orgPublicizeMember",
  1563. "parameters": [
  1564. {
  1565. "type": "string",
  1566. "description": "name of the organization",
  1567. "name": "org",
  1568. "in": "path",
  1569. "required": true
  1570. },
  1571. {
  1572. "type": "string",
  1573. "description": "username of the user",
  1574. "name": "username",
  1575. "in": "path",
  1576. "required": true
  1577. }
  1578. ],
  1579. "responses": {
  1580. "204": {
  1581. "description": "membership publicized"
  1582. },
  1583. "403": {
  1584. "$ref": "#/responses/forbidden"
  1585. }
  1586. }
  1587. },
  1588. "delete": {
  1589. "produces": [
  1590. "application/json"
  1591. ],
  1592. "tags": [
  1593. "organization"
  1594. ],
  1595. "summary": "Conceal a user's membership",
  1596. "operationId": "orgConcealMember",
  1597. "parameters": [
  1598. {
  1599. "type": "string",
  1600. "description": "name of the organization",
  1601. "name": "org",
  1602. "in": "path",
  1603. "required": true
  1604. },
  1605. {
  1606. "type": "string",
  1607. "description": "username of the user",
  1608. "name": "username",
  1609. "in": "path",
  1610. "required": true
  1611. }
  1612. ],
  1613. "responses": {
  1614. "204": {
  1615. "$ref": "#/responses/empty"
  1616. },
  1617. "403": {
  1618. "$ref": "#/responses/forbidden"
  1619. }
  1620. }
  1621. }
  1622. },
  1623. "/orgs/{org}/repos": {
  1624. "get": {
  1625. "produces": [
  1626. "application/json"
  1627. ],
  1628. "tags": [
  1629. "organization"
  1630. ],
  1631. "summary": "List an organization's repos",
  1632. "operationId": "orgListRepos",
  1633. "parameters": [
  1634. {
  1635. "type": "string",
  1636. "description": "name of the organization",
  1637. "name": "org",
  1638. "in": "path",
  1639. "required": true
  1640. },
  1641. {
  1642. "type": "integer",
  1643. "description": "page number of results to return (1-based)",
  1644. "name": "page",
  1645. "in": "query"
  1646. },
  1647. {
  1648. "type": "integer",
  1649. "description": "page size of results",
  1650. "name": "limit",
  1651. "in": "query"
  1652. }
  1653. ],
  1654. "responses": {
  1655. "200": {
  1656. "$ref": "#/responses/RepositoryList"
  1657. }
  1658. }
  1659. },
  1660. "post": {
  1661. "consumes": [
  1662. "application/json"
  1663. ],
  1664. "produces": [
  1665. "application/json"
  1666. ],
  1667. "tags": [
  1668. "organization"
  1669. ],
  1670. "summary": "Create a repository in an organization",
  1671. "operationId": "createOrgRepo",
  1672. "parameters": [
  1673. {
  1674. "type": "string",
  1675. "description": "name of organization",
  1676. "name": "org",
  1677. "in": "path",
  1678. "required": true
  1679. },
  1680. {
  1681. "name": "body",
  1682. "in": "body",
  1683. "schema": {
  1684. "$ref": "#/definitions/CreateRepoOption"
  1685. }
  1686. }
  1687. ],
  1688. "responses": {
  1689. "201": {
  1690. "$ref": "#/responses/Repository"
  1691. },
  1692. "403": {
  1693. "$ref": "#/responses/forbidden"
  1694. },
  1695. "404": {
  1696. "$ref": "#/responses/notFound"
  1697. }
  1698. }
  1699. }
  1700. },
  1701. "/orgs/{org}/teams": {
  1702. "get": {
  1703. "produces": [
  1704. "application/json"
  1705. ],
  1706. "tags": [
  1707. "organization"
  1708. ],
  1709. "summary": "List an organization's teams",
  1710. "operationId": "orgListTeams",
  1711. "parameters": [
  1712. {
  1713. "type": "string",
  1714. "description": "name of the organization",
  1715. "name": "org",
  1716. "in": "path",
  1717. "required": true
  1718. },
  1719. {
  1720. "type": "integer",
  1721. "description": "page number of results to return (1-based)",
  1722. "name": "page",
  1723. "in": "query"
  1724. },
  1725. {
  1726. "type": "integer",
  1727. "description": "page size of results",
  1728. "name": "limit",
  1729. "in": "query"
  1730. }
  1731. ],
  1732. "responses": {
  1733. "200": {
  1734. "$ref": "#/responses/TeamList"
  1735. }
  1736. }
  1737. },
  1738. "post": {
  1739. "consumes": [
  1740. "application/json"
  1741. ],
  1742. "produces": [
  1743. "application/json"
  1744. ],
  1745. "tags": [
  1746. "organization"
  1747. ],
  1748. "summary": "Create a team",
  1749. "operationId": "orgCreateTeam",
  1750. "parameters": [
  1751. {
  1752. "type": "string",
  1753. "description": "name of the organization",
  1754. "name": "org",
  1755. "in": "path",
  1756. "required": true
  1757. },
  1758. {
  1759. "name": "body",
  1760. "in": "body",
  1761. "schema": {
  1762. "$ref": "#/definitions/CreateTeamOption"
  1763. }
  1764. }
  1765. ],
  1766. "responses": {
  1767. "201": {
  1768. "$ref": "#/responses/Team"
  1769. },
  1770. "422": {
  1771. "$ref": "#/responses/validationError"
  1772. }
  1773. }
  1774. }
  1775. },
  1776. "/orgs/{org}/teams/search": {
  1777. "get": {
  1778. "produces": [
  1779. "application/json"
  1780. ],
  1781. "tags": [
  1782. "organization"
  1783. ],
  1784. "summary": "Search for teams within an organization",
  1785. "operationId": "teamSearch",
  1786. "parameters": [
  1787. {
  1788. "type": "string",
  1789. "description": "name of the organization",
  1790. "name": "org",
  1791. "in": "path",
  1792. "required": true
  1793. },
  1794. {
  1795. "type": "string",
  1796. "description": "keywords to search",
  1797. "name": "q",
  1798. "in": "query"
  1799. },
  1800. {
  1801. "type": "boolean",
  1802. "description": "include search within team description (defaults to true)",
  1803. "name": "include_desc",
  1804. "in": "query"
  1805. },
  1806. {
  1807. "type": "integer",
  1808. "description": "page number of results to return (1-based)",
  1809. "name": "page",
  1810. "in": "query"
  1811. },
  1812. {
  1813. "type": "integer",
  1814. "description": "page size of results",
  1815. "name": "limit",
  1816. "in": "query"
  1817. }
  1818. ],
  1819. "responses": {
  1820. "200": {
  1821. "description": "SearchResults of a successful search",
  1822. "schema": {
  1823. "type": "object",
  1824. "properties": {
  1825. "data": {
  1826. "type": "array",
  1827. "items": {
  1828. "$ref": "#/definitions/Team"
  1829. }
  1830. },
  1831. "ok": {
  1832. "type": "boolean"
  1833. }
  1834. }
  1835. }
  1836. }
  1837. }
  1838. }
  1839. },
  1840. "/repos/issues/search": {
  1841. "get": {
  1842. "produces": [
  1843. "application/json"
  1844. ],
  1845. "tags": [
  1846. "issue"
  1847. ],
  1848. "summary": "Search for issues across the repositories that the user has access to",
  1849. "operationId": "issueSearchIssues",
  1850. "parameters": [
  1851. {
  1852. "type": "string",
  1853. "description": "whether issue is open or closed",
  1854. "name": "state",
  1855. "in": "query"
  1856. },
  1857. {
  1858. "type": "string",
  1859. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1860. "name": "labels",
  1861. "in": "query"
  1862. },
  1863. {
  1864. "type": "string",
  1865. "description": "search string",
  1866. "name": "q",
  1867. "in": "query"
  1868. },
  1869. {
  1870. "type": "integer",
  1871. "format": "int64",
  1872. "description": "repository to prioritize in the results",
  1873. "name": "priority_repo_id",
  1874. "in": "query"
  1875. },
  1876. {
  1877. "type": "string",
  1878. "description": "filter by type (issues / pulls) if set",
  1879. "name": "type",
  1880. "in": "query"
  1881. },
  1882. {
  1883. "type": "string",
  1884. "format": "date-time",
  1885. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  1886. "name": "since",
  1887. "in": "query"
  1888. },
  1889. {
  1890. "type": "string",
  1891. "format": "date-time",
  1892. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  1893. "name": "before",
  1894. "in": "query"
  1895. },
  1896. {
  1897. "type": "boolean",
  1898. "description": "filter (issues / pulls) assigned to you, default is false",
  1899. "name": "assigned",
  1900. "in": "query"
  1901. },
  1902. {
  1903. "type": "boolean",
  1904. "description": "filter (issues / pulls) created by you, default is false",
  1905. "name": "created",
  1906. "in": "query"
  1907. },
  1908. {
  1909. "type": "boolean",
  1910. "description": "filter (issues / pulls) mentioning you, default is false",
  1911. "name": "mentioned",
  1912. "in": "query"
  1913. },
  1914. {
  1915. "type": "boolean",
  1916. "description": "filter pulls requesting your review, default is false",
  1917. "name": "review_requested",
  1918. "in": "query"
  1919. },
  1920. {
  1921. "type": "integer",
  1922. "description": "page number of results to return (1-based)",
  1923. "name": "page",
  1924. "in": "query"
  1925. },
  1926. {
  1927. "type": "integer",
  1928. "description": "page size of results",
  1929. "name": "limit",
  1930. "in": "query"
  1931. }
  1932. ],
  1933. "responses": {
  1934. "200": {
  1935. "$ref": "#/responses/IssueList"
  1936. }
  1937. }
  1938. }
  1939. },
  1940. "/repos/migrate": {
  1941. "post": {
  1942. "consumes": [
  1943. "application/json"
  1944. ],
  1945. "produces": [
  1946. "application/json"
  1947. ],
  1948. "tags": [
  1949. "repository"
  1950. ],
  1951. "summary": "Migrate a remote git repository",
  1952. "operationId": "repoMigrate",
  1953. "parameters": [
  1954. {
  1955. "name": "body",
  1956. "in": "body",
  1957. "schema": {
  1958. "$ref": "#/definitions/MigrateRepoOptions"
  1959. }
  1960. }
  1961. ],
  1962. "responses": {
  1963. "201": {
  1964. "$ref": "#/responses/Repository"
  1965. },
  1966. "403": {
  1967. "$ref": "#/responses/forbidden"
  1968. },
  1969. "422": {
  1970. "$ref": "#/responses/validationError"
  1971. }
  1972. }
  1973. }
  1974. },
  1975. "/repos/search": {
  1976. "get": {
  1977. "produces": [
  1978. "application/json"
  1979. ],
  1980. "tags": [
  1981. "repository"
  1982. ],
  1983. "summary": "Search for repositories",
  1984. "operationId": "repoSearch",
  1985. "parameters": [
  1986. {
  1987. "type": "string",
  1988. "description": "keyword",
  1989. "name": "q",
  1990. "in": "query"
  1991. },
  1992. {
  1993. "type": "boolean",
  1994. "description": "Limit search to repositories with keyword as topic",
  1995. "name": "topic",
  1996. "in": "query"
  1997. },
  1998. {
  1999. "type": "boolean",
  2000. "description": "include search of keyword within repository description",
  2001. "name": "includeDesc",
  2002. "in": "query"
  2003. },
  2004. {
  2005. "type": "integer",
  2006. "format": "int64",
  2007. "description": "search only for repos that the user with the given id owns or contributes to",
  2008. "name": "uid",
  2009. "in": "query"
  2010. },
  2011. {
  2012. "type": "integer",
  2013. "format": "int64",
  2014. "description": "repo owner to prioritize in the results",
  2015. "name": "priority_owner_id",
  2016. "in": "query"
  2017. },
  2018. {
  2019. "type": "integer",
  2020. "format": "int64",
  2021. "description": "search only for repos that belong to the given team id",
  2022. "name": "team_id",
  2023. "in": "query"
  2024. },
  2025. {
  2026. "type": "integer",
  2027. "format": "int64",
  2028. "description": "search only for repos that the user with the given id has starred",
  2029. "name": "starredBy",
  2030. "in": "query"
  2031. },
  2032. {
  2033. "type": "boolean",
  2034. "description": "include private repositories this user has access to (defaults to true)",
  2035. "name": "private",
  2036. "in": "query"
  2037. },
  2038. {
  2039. "type": "boolean",
  2040. "description": "show only pubic, private or all repositories (defaults to all)",
  2041. "name": "is_private",
  2042. "in": "query"
  2043. },
  2044. {
  2045. "type": "boolean",
  2046. "description": "include template repositories this user has access to (defaults to true)",
  2047. "name": "template",
  2048. "in": "query"
  2049. },
  2050. {
  2051. "type": "boolean",
  2052. "description": "show only archived, non-archived or all repositories (defaults to all)",
  2053. "name": "archived",
  2054. "in": "query"
  2055. },
  2056. {
  2057. "type": "string",
  2058. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  2059. "name": "mode",
  2060. "in": "query"
  2061. },
  2062. {
  2063. "type": "boolean",
  2064. "description": "if `uid` is given, search only for repos that the user owns",
  2065. "name": "exclusive",
  2066. "in": "query"
  2067. },
  2068. {
  2069. "type": "string",
  2070. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  2071. "name": "sort",
  2072. "in": "query"
  2073. },
  2074. {
  2075. "type": "string",
  2076. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  2077. "name": "order",
  2078. "in": "query"
  2079. },
  2080. {
  2081. "type": "integer",
  2082. "description": "page number of results to return (1-based)",
  2083. "name": "page",
  2084. "in": "query"
  2085. },
  2086. {
  2087. "type": "integer",
  2088. "description": "page size of results",
  2089. "name": "limit",
  2090. "in": "query"
  2091. }
  2092. ],
  2093. "responses": {
  2094. "200": {
  2095. "$ref": "#/responses/SearchResults"
  2096. },
  2097. "422": {
  2098. "$ref": "#/responses/validationError"
  2099. }
  2100. }
  2101. }
  2102. },
  2103. "/repos/{owner}/{repo}": {
  2104. "get": {
  2105. "produces": [
  2106. "application/json"
  2107. ],
  2108. "tags": [
  2109. "repository"
  2110. ],
  2111. "summary": "Get a repository",
  2112. "operationId": "repoGet",
  2113. "parameters": [
  2114. {
  2115. "type": "string",
  2116. "description": "owner of the repo",
  2117. "name": "owner",
  2118. "in": "path",
  2119. "required": true
  2120. },
  2121. {
  2122. "type": "string",
  2123. "description": "name of the repo",
  2124. "name": "repo",
  2125. "in": "path",
  2126. "required": true
  2127. }
  2128. ],
  2129. "responses": {
  2130. "200": {
  2131. "$ref": "#/responses/Repository"
  2132. }
  2133. }
  2134. },
  2135. "delete": {
  2136. "produces": [
  2137. "application/json"
  2138. ],
  2139. "tags": [
  2140. "repository"
  2141. ],
  2142. "summary": "Delete a repository",
  2143. "operationId": "repoDelete",
  2144. "parameters": [
  2145. {
  2146. "type": "string",
  2147. "description": "owner of the repo to delete",
  2148. "name": "owner",
  2149. "in": "path",
  2150. "required": true
  2151. },
  2152. {
  2153. "type": "string",
  2154. "description": "name of the repo to delete",
  2155. "name": "repo",
  2156. "in": "path",
  2157. "required": true
  2158. }
  2159. ],
  2160. "responses": {
  2161. "204": {
  2162. "$ref": "#/responses/empty"
  2163. },
  2164. "403": {
  2165. "$ref": "#/responses/forbidden"
  2166. }
  2167. }
  2168. },
  2169. "patch": {
  2170. "produces": [
  2171. "application/json"
  2172. ],
  2173. "tags": [
  2174. "repository"
  2175. ],
  2176. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  2177. "operationId": "repoEdit",
  2178. "parameters": [
  2179. {
  2180. "type": "string",
  2181. "description": "owner of the repo to edit",
  2182. "name": "owner",
  2183. "in": "path",
  2184. "required": true
  2185. },
  2186. {
  2187. "type": "string",
  2188. "description": "name of the repo to edit",
  2189. "name": "repo",
  2190. "in": "path",
  2191. "required": true
  2192. },
  2193. {
  2194. "description": "Properties of a repo that you can edit",
  2195. "name": "body",
  2196. "in": "body",
  2197. "schema": {
  2198. "$ref": "#/definitions/EditRepoOption"
  2199. }
  2200. }
  2201. ],
  2202. "responses": {
  2203. "200": {
  2204. "$ref": "#/responses/Repository"
  2205. },
  2206. "403": {
  2207. "$ref": "#/responses/forbidden"
  2208. },
  2209. "422": {
  2210. "$ref": "#/responses/validationError"
  2211. }
  2212. }
  2213. }
  2214. },
  2215. "/repos/{owner}/{repo}/archive/{archive}": {
  2216. "get": {
  2217. "produces": [
  2218. "application/json"
  2219. ],
  2220. "tags": [
  2221. "repository"
  2222. ],
  2223. "summary": "Get an archive of a repository",
  2224. "operationId": "repoGetArchive",
  2225. "parameters": [
  2226. {
  2227. "type": "string",
  2228. "description": "owner of the repo",
  2229. "name": "owner",
  2230. "in": "path",
  2231. "required": true
  2232. },
  2233. {
  2234. "type": "string",
  2235. "description": "name of the repo",
  2236. "name": "repo",
  2237. "in": "path",
  2238. "required": true
  2239. },
  2240. {
  2241. "type": "string",
  2242. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  2243. "name": "archive",
  2244. "in": "path",
  2245. "required": true
  2246. }
  2247. ],
  2248. "responses": {
  2249. "200": {
  2250. "description": "success"
  2251. },
  2252. "404": {
  2253. "$ref": "#/responses/notFound"
  2254. }
  2255. }
  2256. }
  2257. },
  2258. "/repos/{owner}/{repo}/branch_protections": {
  2259. "get": {
  2260. "produces": [
  2261. "application/json"
  2262. ],
  2263. "tags": [
  2264. "repository"
  2265. ],
  2266. "summary": "List branch protections for a repository",
  2267. "operationId": "repoListBranchProtection",
  2268. "parameters": [
  2269. {
  2270. "type": "string",
  2271. "description": "owner of the repo",
  2272. "name": "owner",
  2273. "in": "path",
  2274. "required": true
  2275. },
  2276. {
  2277. "type": "string",
  2278. "description": "name of the repo",
  2279. "name": "repo",
  2280. "in": "path",
  2281. "required": true
  2282. }
  2283. ],
  2284. "responses": {
  2285. "200": {
  2286. "$ref": "#/responses/BranchProtectionList"
  2287. }
  2288. }
  2289. },
  2290. "post": {
  2291. "consumes": [
  2292. "application/json"
  2293. ],
  2294. "produces": [
  2295. "application/json"
  2296. ],
  2297. "tags": [
  2298. "repository"
  2299. ],
  2300. "summary": "Create a branch protections for a repository",
  2301. "operationId": "repoCreateBranchProtection",
  2302. "parameters": [
  2303. {
  2304. "type": "string",
  2305. "description": "owner of the repo",
  2306. "name": "owner",
  2307. "in": "path",
  2308. "required": true
  2309. },
  2310. {
  2311. "type": "string",
  2312. "description": "name of the repo",
  2313. "name": "repo",
  2314. "in": "path",
  2315. "required": true
  2316. },
  2317. {
  2318. "name": "body",
  2319. "in": "body",
  2320. "schema": {
  2321. "$ref": "#/definitions/CreateBranchProtectionOption"
  2322. }
  2323. }
  2324. ],
  2325. "responses": {
  2326. "201": {
  2327. "$ref": "#/responses/BranchProtection"
  2328. },
  2329. "403": {
  2330. "$ref": "#/responses/forbidden"
  2331. },
  2332. "404": {
  2333. "$ref": "#/responses/notFound"
  2334. },
  2335. "422": {
  2336. "$ref": "#/responses/validationError"
  2337. }
  2338. }
  2339. }
  2340. },
  2341. "/repos/{owner}/{repo}/branch_protections/{name}": {
  2342. "get": {
  2343. "produces": [
  2344. "application/json"
  2345. ],
  2346. "tags": [
  2347. "repository"
  2348. ],
  2349. "summary": "Get a specific branch protection for the repository",
  2350. "operationId": "repoGetBranchProtection",
  2351. "parameters": [
  2352. {
  2353. "type": "string",
  2354. "description": "owner of the repo",
  2355. "name": "owner",
  2356. "in": "path",
  2357. "required": true
  2358. },
  2359. {
  2360. "type": "string",
  2361. "description": "name of the repo",
  2362. "name": "repo",
  2363. "in": "path",
  2364. "required": true
  2365. },
  2366. {
  2367. "type": "string",
  2368. "description": "name of protected branch",
  2369. "name": "name",
  2370. "in": "path",
  2371. "required": true
  2372. }
  2373. ],
  2374. "responses": {
  2375. "200": {
  2376. "$ref": "#/responses/BranchProtection"
  2377. },
  2378. "404": {
  2379. "$ref": "#/responses/notFound"
  2380. }
  2381. }
  2382. },
  2383. "delete": {
  2384. "produces": [
  2385. "application/json"
  2386. ],
  2387. "tags": [
  2388. "repository"
  2389. ],
  2390. "summary": "Delete a specific branch protection for the repository",
  2391. "operationId": "repoDeleteBranchProtection",
  2392. "parameters": [
  2393. {
  2394. "type": "string",
  2395. "description": "owner of the repo",
  2396. "name": "owner",
  2397. "in": "path",
  2398. "required": true
  2399. },
  2400. {
  2401. "type": "string",
  2402. "description": "name of the repo",
  2403. "name": "repo",
  2404. "in": "path",
  2405. "required": true
  2406. },
  2407. {
  2408. "type": "string",
  2409. "description": "name of protected branch",
  2410. "name": "name",
  2411. "in": "path",
  2412. "required": true
  2413. }
  2414. ],
  2415. "responses": {
  2416. "204": {
  2417. "$ref": "#/responses/empty"
  2418. },
  2419. "404": {
  2420. "$ref": "#/responses/notFound"
  2421. }
  2422. }
  2423. },
  2424. "patch": {
  2425. "consumes": [
  2426. "application/json"
  2427. ],
  2428. "produces": [
  2429. "application/json"
  2430. ],
  2431. "tags": [
  2432. "repository"
  2433. ],
  2434. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  2435. "operationId": "repoEditBranchProtection",
  2436. "parameters": [
  2437. {
  2438. "type": "string",
  2439. "description": "owner of the repo",
  2440. "name": "owner",
  2441. "in": "path",
  2442. "required": true
  2443. },
  2444. {
  2445. "type": "string",
  2446. "description": "name of the repo",
  2447. "name": "repo",
  2448. "in": "path",
  2449. "required": true
  2450. },
  2451. {
  2452. "type": "string",
  2453. "description": "name of protected branch",
  2454. "name": "name",
  2455. "in": "path",
  2456. "required": true
  2457. },
  2458. {
  2459. "name": "body",
  2460. "in": "body",
  2461. "schema": {
  2462. "$ref": "#/definitions/EditBranchProtectionOption"
  2463. }
  2464. }
  2465. ],
  2466. "responses": {
  2467. "200": {
  2468. "$ref": "#/responses/BranchProtection"
  2469. },
  2470. "404": {
  2471. "$ref": "#/responses/notFound"
  2472. },
  2473. "422": {
  2474. "$ref": "#/responses/validationError"
  2475. }
  2476. }
  2477. }
  2478. },
  2479. "/repos/{owner}/{repo}/branches": {
  2480. "get": {
  2481. "produces": [
  2482. "application/json"
  2483. ],
  2484. "tags": [
  2485. "repository"
  2486. ],
  2487. "summary": "List a repository's branches",
  2488. "operationId": "repoListBranches",
  2489. "parameters": [
  2490. {
  2491. "type": "string",
  2492. "description": "owner of the repo",
  2493. "name": "owner",
  2494. "in": "path",
  2495. "required": true
  2496. },
  2497. {
  2498. "type": "string",
  2499. "description": "name of the repo",
  2500. "name": "repo",
  2501. "in": "path",
  2502. "required": true
  2503. },
  2504. {
  2505. "type": "integer",
  2506. "description": "page number of results to return (1-based)",
  2507. "name": "page",
  2508. "in": "query"
  2509. },
  2510. {
  2511. "type": "integer",
  2512. "description": "page size of results",
  2513. "name": "limit",
  2514. "in": "query"
  2515. }
  2516. ],
  2517. "responses": {
  2518. "200": {
  2519. "$ref": "#/responses/BranchList"
  2520. }
  2521. }
  2522. },
  2523. "post": {
  2524. "consumes": [
  2525. "application/json"
  2526. ],
  2527. "produces": [
  2528. "application/json"
  2529. ],
  2530. "tags": [
  2531. "repository"
  2532. ],
  2533. "summary": "Create a branch",
  2534. "operationId": "repoCreateBranch",
  2535. "parameters": [
  2536. {
  2537. "type": "string",
  2538. "description": "owner of the repo",
  2539. "name": "owner",
  2540. "in": "path",
  2541. "required": true
  2542. },
  2543. {
  2544. "type": "string",
  2545. "description": "name of the repo",
  2546. "name": "repo",
  2547. "in": "path",
  2548. "required": true
  2549. },
  2550. {
  2551. "name": "body",
  2552. "in": "body",
  2553. "schema": {
  2554. "$ref": "#/definitions/CreateBranchRepoOption"
  2555. }
  2556. }
  2557. ],
  2558. "responses": {
  2559. "201": {
  2560. "$ref": "#/responses/Branch"
  2561. },
  2562. "404": {
  2563. "description": "The old branch does not exist."
  2564. },
  2565. "409": {
  2566. "description": "The branch with the same name already exists."
  2567. }
  2568. }
  2569. }
  2570. },
  2571. "/repos/{owner}/{repo}/branches/{branch}": {
  2572. "get": {
  2573. "produces": [
  2574. "application/json"
  2575. ],
  2576. "tags": [
  2577. "repository"
  2578. ],
  2579. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  2580. "operationId": "repoGetBranch",
  2581. "parameters": [
  2582. {
  2583. "type": "string",
  2584. "description": "owner of the repo",
  2585. "name": "owner",
  2586. "in": "path",
  2587. "required": true
  2588. },
  2589. {
  2590. "type": "string",
  2591. "description": "name of the repo",
  2592. "name": "repo",
  2593. "in": "path",
  2594. "required": true
  2595. },
  2596. {
  2597. "type": "string",
  2598. "description": "branch to get",
  2599. "name": "branch",
  2600. "in": "path",
  2601. "required": true
  2602. }
  2603. ],
  2604. "responses": {
  2605. "200": {
  2606. "$ref": "#/responses/Branch"
  2607. },
  2608. "404": {
  2609. "$ref": "#/responses/notFound"
  2610. }
  2611. }
  2612. },
  2613. "delete": {
  2614. "produces": [
  2615. "application/json"
  2616. ],
  2617. "tags": [
  2618. "repository"
  2619. ],
  2620. "summary": "Delete a specific branch from a repository",
  2621. "operationId": "repoDeleteBranch",
  2622. "parameters": [
  2623. {
  2624. "type": "string",
  2625. "description": "owner of the repo",
  2626. "name": "owner",
  2627. "in": "path",
  2628. "required": true
  2629. },
  2630. {
  2631. "type": "string",
  2632. "description": "name of the repo",
  2633. "name": "repo",
  2634. "in": "path",
  2635. "required": true
  2636. },
  2637. {
  2638. "type": "string",
  2639. "description": "branch to delete",
  2640. "name": "branch",
  2641. "in": "path",
  2642. "required": true
  2643. }
  2644. ],
  2645. "responses": {
  2646. "204": {
  2647. "$ref": "#/responses/empty"
  2648. },
  2649. "403": {
  2650. "$ref": "#/responses/error"
  2651. },
  2652. "404": {
  2653. "$ref": "#/responses/notFound"
  2654. }
  2655. }
  2656. }
  2657. },
  2658. "/repos/{owner}/{repo}/collaborators": {
  2659. "get": {
  2660. "produces": [
  2661. "application/json"
  2662. ],
  2663. "tags": [
  2664. "repository"
  2665. ],
  2666. "summary": "List a repository's collaborators",
  2667. "operationId": "repoListCollaborators",
  2668. "parameters": [
  2669. {
  2670. "type": "string",
  2671. "description": "owner of the repo",
  2672. "name": "owner",
  2673. "in": "path",
  2674. "required": true
  2675. },
  2676. {
  2677. "type": "string",
  2678. "description": "name of the repo",
  2679. "name": "repo",
  2680. "in": "path",
  2681. "required": true
  2682. },
  2683. {
  2684. "type": "integer",
  2685. "description": "page number of results to return (1-based)",
  2686. "name": "page",
  2687. "in": "query"
  2688. },
  2689. {
  2690. "type": "integer",
  2691. "description": "page size of results",
  2692. "name": "limit",
  2693. "in": "query"
  2694. }
  2695. ],
  2696. "responses": {
  2697. "200": {
  2698. "$ref": "#/responses/UserList"
  2699. }
  2700. }
  2701. }
  2702. },
  2703. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  2704. "get": {
  2705. "produces": [
  2706. "application/json"
  2707. ],
  2708. "tags": [
  2709. "repository"
  2710. ],
  2711. "summary": "Check if a user is a collaborator of a repository",
  2712. "operationId": "repoCheckCollaborator",
  2713. "parameters": [
  2714. {
  2715. "type": "string",
  2716. "description": "owner of the repo",
  2717. "name": "owner",
  2718. "in": "path",
  2719. "required": true
  2720. },
  2721. {
  2722. "type": "string",
  2723. "description": "name of the repo",
  2724. "name": "repo",
  2725. "in": "path",
  2726. "required": true
  2727. },
  2728. {
  2729. "type": "string",
  2730. "description": "username of the collaborator",
  2731. "name": "collaborator",
  2732. "in": "path",
  2733. "required": true
  2734. }
  2735. ],
  2736. "responses": {
  2737. "204": {
  2738. "$ref": "#/responses/empty"
  2739. },
  2740. "404": {
  2741. "$ref": "#/responses/notFound"
  2742. },
  2743. "422": {
  2744. "$ref": "#/responses/validationError"
  2745. }
  2746. }
  2747. },
  2748. "put": {
  2749. "produces": [
  2750. "application/json"
  2751. ],
  2752. "tags": [
  2753. "repository"
  2754. ],
  2755. "summary": "Add a collaborator to a repository",
  2756. "operationId": "repoAddCollaborator",
  2757. "parameters": [
  2758. {
  2759. "type": "string",
  2760. "description": "owner of the repo",
  2761. "name": "owner",
  2762. "in": "path",
  2763. "required": true
  2764. },
  2765. {
  2766. "type": "string",
  2767. "description": "name of the repo",
  2768. "name": "repo",
  2769. "in": "path",
  2770. "required": true
  2771. },
  2772. {
  2773. "type": "string",
  2774. "description": "username of the collaborator to add",
  2775. "name": "collaborator",
  2776. "in": "path",
  2777. "required": true
  2778. },
  2779. {
  2780. "name": "body",
  2781. "in": "body",
  2782. "schema": {
  2783. "$ref": "#/definitions/AddCollaboratorOption"
  2784. }
  2785. }
  2786. ],
  2787. "responses": {
  2788. "204": {
  2789. "$ref": "#/responses/empty"
  2790. },
  2791. "422": {
  2792. "$ref": "#/responses/validationError"
  2793. }
  2794. }
  2795. },
  2796. "delete": {
  2797. "produces": [
  2798. "application/json"
  2799. ],
  2800. "tags": [
  2801. "repository"
  2802. ],
  2803. "summary": "Delete a collaborator from a repository",
  2804. "operationId": "repoDeleteCollaborator",
  2805. "parameters": [
  2806. {
  2807. "type": "string",
  2808. "description": "owner of the repo",
  2809. "name": "owner",
  2810. "in": "path",
  2811. "required": true
  2812. },
  2813. {
  2814. "type": "string",
  2815. "description": "name of the repo",
  2816. "name": "repo",
  2817. "in": "path",
  2818. "required": true
  2819. },
  2820. {
  2821. "type": "string",
  2822. "description": "username of the collaborator to delete",
  2823. "name": "collaborator",
  2824. "in": "path",
  2825. "required": true
  2826. }
  2827. ],
  2828. "responses": {
  2829. "204": {
  2830. "$ref": "#/responses/empty"
  2831. },
  2832. "422": {
  2833. "$ref": "#/responses/validationError"
  2834. }
  2835. }
  2836. }
  2837. },
  2838. "/repos/{owner}/{repo}/commits": {
  2839. "get": {
  2840. "produces": [
  2841. "application/json"
  2842. ],
  2843. "tags": [
  2844. "repository"
  2845. ],
  2846. "summary": "Get a list of all commits from a repository",
  2847. "operationId": "repoGetAllCommits",
  2848. "parameters": [
  2849. {
  2850. "type": "string",
  2851. "description": "owner of the repo",
  2852. "name": "owner",
  2853. "in": "path",
  2854. "required": true
  2855. },
  2856. {
  2857. "type": "string",
  2858. "description": "name of the repo",
  2859. "name": "repo",
  2860. "in": "path",
  2861. "required": true
  2862. },
  2863. {
  2864. "type": "string",
  2865. "description": "SHA or branch to start listing commits from (usually 'master')",
  2866. "name": "sha",
  2867. "in": "query"
  2868. },
  2869. {
  2870. "type": "integer",
  2871. "description": "page number of results to return (1-based)",
  2872. "name": "page",
  2873. "in": "query"
  2874. },
  2875. {
  2876. "type": "integer",
  2877. "description": "page size of results",
  2878. "name": "limit",
  2879. "in": "query"
  2880. }
  2881. ],
  2882. "responses": {
  2883. "200": {
  2884. "$ref": "#/responses/CommitList"
  2885. },
  2886. "404": {
  2887. "$ref": "#/responses/notFound"
  2888. },
  2889. "409": {
  2890. "$ref": "#/responses/EmptyRepository"
  2891. }
  2892. }
  2893. }
  2894. },
  2895. "/repos/{owner}/{repo}/commits/{ref}/status": {
  2896. "get": {
  2897. "produces": [
  2898. "application/json"
  2899. ],
  2900. "tags": [
  2901. "repository"
  2902. ],
  2903. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2904. "operationId": "repoGetCombinedStatusByRef",
  2905. "parameters": [
  2906. {
  2907. "type": "string",
  2908. "description": "owner of the repo",
  2909. "name": "owner",
  2910. "in": "path",
  2911. "required": true
  2912. },
  2913. {
  2914. "type": "string",
  2915. "description": "name of the repo",
  2916. "name": "repo",
  2917. "in": "path",
  2918. "required": true
  2919. },
  2920. {
  2921. "type": "string",
  2922. "description": "name of branch/tag/commit",
  2923. "name": "ref",
  2924. "in": "path",
  2925. "required": true
  2926. },
  2927. {
  2928. "type": "integer",
  2929. "description": "page number of results to return (1-based)",
  2930. "name": "page",
  2931. "in": "query"
  2932. },
  2933. {
  2934. "type": "integer",
  2935. "description": "page size of results",
  2936. "name": "limit",
  2937. "in": "query"
  2938. }
  2939. ],
  2940. "responses": {
  2941. "200": {
  2942. "$ref": "#/responses/CombinedStatus"
  2943. },
  2944. "400": {
  2945. "$ref": "#/responses/error"
  2946. }
  2947. }
  2948. }
  2949. },
  2950. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2951. "get": {
  2952. "produces": [
  2953. "application/json"
  2954. ],
  2955. "tags": [
  2956. "repository"
  2957. ],
  2958. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  2959. "operationId": "repoListStatusesByRef",
  2960. "parameters": [
  2961. {
  2962. "type": "string",
  2963. "description": "owner of the repo",
  2964. "name": "owner",
  2965. "in": "path",
  2966. "required": true
  2967. },
  2968. {
  2969. "type": "string",
  2970. "description": "name of the repo",
  2971. "name": "repo",
  2972. "in": "path",
  2973. "required": true
  2974. },
  2975. {
  2976. "type": "string",
  2977. "description": "name of branch/tag/commit",
  2978. "name": "ref",
  2979. "in": "path",
  2980. "required": true
  2981. },
  2982. {
  2983. "enum": [
  2984. "oldest",
  2985. "recentupdate",
  2986. "leastupdate",
  2987. "leastindex",
  2988. "highestindex"
  2989. ],
  2990. "type": "string",
  2991. "description": "type of sort",
  2992. "name": "sort",
  2993. "in": "query"
  2994. },
  2995. {
  2996. "enum": [
  2997. "pending",
  2998. "success",
  2999. "error",
  3000. "failure",
  3001. "warning"
  3002. ],
  3003. "type": "string",
  3004. "description": "type of state",
  3005. "name": "state",
  3006. "in": "query"
  3007. },
  3008. {
  3009. "type": "integer",
  3010. "description": "page number of results to return (1-based)",
  3011. "name": "page",
  3012. "in": "query"
  3013. },
  3014. {
  3015. "type": "integer",
  3016. "description": "page size of results",
  3017. "name": "limit",
  3018. "in": "query"
  3019. }
  3020. ],
  3021. "responses": {
  3022. "200": {
  3023. "$ref": "#/responses/CommitStatusList"
  3024. },
  3025. "400": {
  3026. "$ref": "#/responses/error"
  3027. }
  3028. }
  3029. }
  3030. },
  3031. "/repos/{owner}/{repo}/contents": {
  3032. "get": {
  3033. "produces": [
  3034. "application/json"
  3035. ],
  3036. "tags": [
  3037. "repository"
  3038. ],
  3039. "summary": "Gets the metadata of all the entries of the root dir",
  3040. "operationId": "repoGetContentsList",
  3041. "parameters": [
  3042. {
  3043. "type": "string",
  3044. "description": "owner of the repo",
  3045. "name": "owner",
  3046. "in": "path",
  3047. "required": true
  3048. },
  3049. {
  3050. "type": "string",
  3051. "description": "name of the repo",
  3052. "name": "repo",
  3053. "in": "path",
  3054. "required": true
  3055. },
  3056. {
  3057. "type": "string",
  3058. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  3059. "name": "ref",
  3060. "in": "query"
  3061. }
  3062. ],
  3063. "responses": {
  3064. "200": {
  3065. "$ref": "#/responses/ContentsListResponse"
  3066. },
  3067. "404": {
  3068. "$ref": "#/responses/notFound"
  3069. }
  3070. }
  3071. }
  3072. },
  3073. "/repos/{owner}/{repo}/contents/{filepath}": {
  3074. "get": {
  3075. "produces": [
  3076. "application/json"
  3077. ],
  3078. "tags": [
  3079. "repository"
  3080. ],
  3081. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  3082. "operationId": "repoGetContents",
  3083. "parameters": [
  3084. {
  3085. "type": "string",
  3086. "description": "owner of the repo",
  3087. "name": "owner",
  3088. "in": "path",
  3089. "required": true
  3090. },
  3091. {
  3092. "type": "string",
  3093. "description": "name of the repo",
  3094. "name": "repo",
  3095. "in": "path",
  3096. "required": true
  3097. },
  3098. {
  3099. "type": "string",
  3100. "description": "path of the dir, file, symlink or submodule in the repo",
  3101. "name": "filepath",
  3102. "in": "path",
  3103. "required": true
  3104. },
  3105. {
  3106. "type": "string",
  3107. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  3108. "name": "ref",
  3109. "in": "query"
  3110. }
  3111. ],
  3112. "responses": {
  3113. "200": {
  3114. "$ref": "#/responses/ContentsResponse"
  3115. },
  3116. "404": {
  3117. "$ref": "#/responses/notFound"
  3118. }
  3119. }
  3120. },
  3121. "put": {
  3122. "consumes": [
  3123. "application/json"
  3124. ],
  3125. "produces": [
  3126. "application/json"
  3127. ],
  3128. "tags": [
  3129. "repository"
  3130. ],
  3131. "summary": "Update a file in a repository",
  3132. "operationId": "repoUpdateFile",
  3133. "parameters": [
  3134. {
  3135. "type": "string",
  3136. "description": "owner of the repo",
  3137. "name": "owner",
  3138. "in": "path",
  3139. "required": true
  3140. },
  3141. {
  3142. "type": "string",
  3143. "description": "name of the repo",
  3144. "name": "repo",
  3145. "in": "path",
  3146. "required": true
  3147. },
  3148. {
  3149. "type": "string",
  3150. "description": "path of the file to update",
  3151. "name": "filepath",
  3152. "in": "path",
  3153. "required": true
  3154. },
  3155. {
  3156. "name": "body",
  3157. "in": "body",
  3158. "required": true,
  3159. "schema": {
  3160. "$ref": "#/definitions/UpdateFileOptions"
  3161. }
  3162. }
  3163. ],
  3164. "responses": {
  3165. "200": {
  3166. "$ref": "#/responses/FileResponse"
  3167. },
  3168. "403": {
  3169. "$ref": "#/responses/error"
  3170. },
  3171. "404": {
  3172. "$ref": "#/responses/notFound"
  3173. },
  3174. "422": {
  3175. "$ref": "#/responses/error"
  3176. }
  3177. }
  3178. },
  3179. "post": {
  3180. "consumes": [
  3181. "application/json"
  3182. ],
  3183. "produces": [
  3184. "application/json"
  3185. ],
  3186. "tags": [
  3187. "repository"
  3188. ],
  3189. "summary": "Create a file in a repository",
  3190. "operationId": "repoCreateFile",
  3191. "parameters": [
  3192. {
  3193. "type": "string",
  3194. "description": "owner of the repo",
  3195. "name": "owner",
  3196. "in": "path",
  3197. "required": true
  3198. },
  3199. {
  3200. "type": "string",
  3201. "description": "name of the repo",
  3202. "name": "repo",
  3203. "in": "path",
  3204. "required": true
  3205. },
  3206. {
  3207. "type": "string",
  3208. "description": "path of the file to create",
  3209. "name": "filepath",
  3210. "in": "path",
  3211. "required": true
  3212. },
  3213. {
  3214. "name": "body",
  3215. "in": "body",
  3216. "required": true,
  3217. "schema": {
  3218. "$ref": "#/definitions/CreateFileOptions"
  3219. }
  3220. }
  3221. ],
  3222. "responses": {
  3223. "201": {
  3224. "$ref": "#/responses/FileResponse"
  3225. },
  3226. "403": {
  3227. "$ref": "#/responses/error"
  3228. },
  3229. "404": {
  3230. "$ref": "#/responses/notFound"
  3231. },
  3232. "422": {
  3233. "$ref": "#/responses/error"
  3234. }
  3235. }
  3236. },
  3237. "delete": {
  3238. "consumes": [
  3239. "application/json"
  3240. ],
  3241. "produces": [
  3242. "application/json"
  3243. ],
  3244. "tags": [
  3245. "repository"
  3246. ],
  3247. "summary": "Delete a file in a repository",
  3248. "operationId": "repoDeleteFile",
  3249. "parameters": [
  3250. {
  3251. "type": "string",
  3252. "description": "owner of the repo",
  3253. "name": "owner",
  3254. "in": "path",
  3255. "required": true
  3256. },
  3257. {
  3258. "type": "string",
  3259. "description": "name of the repo",
  3260. "name": "repo",
  3261. "in": "path",
  3262. "required": true
  3263. },
  3264. {
  3265. "type": "string",
  3266. "description": "path of the file to delete",
  3267. "name": "filepath",
  3268. "in": "path",
  3269. "required": true
  3270. },
  3271. {
  3272. "name": "body",
  3273. "in": "body",
  3274. "required": true,
  3275. "schema": {
  3276. "$ref": "#/definitions/DeleteFileOptions"
  3277. }
  3278. }
  3279. ],
  3280. "responses": {
  3281. "200": {
  3282. "$ref": "#/responses/FileDeleteResponse"
  3283. },
  3284. "400": {
  3285. "$ref": "#/responses/error"
  3286. },
  3287. "403": {
  3288. "$ref": "#/responses/error"
  3289. },
  3290. "404": {
  3291. "$ref": "#/responses/error"
  3292. }
  3293. }
  3294. }
  3295. },
  3296. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  3297. "get": {
  3298. "produces": [
  3299. "application/json"
  3300. ],
  3301. "tags": [
  3302. "repository"
  3303. ],
  3304. "summary": "Get the EditorConfig definitions of a file in a repository",
  3305. "operationId": "repoGetEditorConfig",
  3306. "parameters": [
  3307. {
  3308. "type": "string",
  3309. "description": "owner of the repo",
  3310. "name": "owner",
  3311. "in": "path",
  3312. "required": true
  3313. },
  3314. {
  3315. "type": "string",
  3316. "description": "name of the repo",
  3317. "name": "repo",
  3318. "in": "path",
  3319. "required": true
  3320. },
  3321. {
  3322. "type": "string",
  3323. "description": "filepath of file to get",
  3324. "name": "filepath",
  3325. "in": "path",
  3326. "required": true
  3327. }
  3328. ],
  3329. "responses": {
  3330. "200": {
  3331. "description": "success"
  3332. },
  3333. "404": {
  3334. "$ref": "#/responses/notFound"
  3335. }
  3336. }
  3337. }
  3338. },
  3339. "/repos/{owner}/{repo}/forks": {
  3340. "get": {
  3341. "produces": [
  3342. "application/json"
  3343. ],
  3344. "tags": [
  3345. "repository"
  3346. ],
  3347. "summary": "List a repository's forks",
  3348. "operationId": "listForks",
  3349. "parameters": [
  3350. {
  3351. "type": "string",
  3352. "description": "owner of the repo",
  3353. "name": "owner",
  3354. "in": "path",
  3355. "required": true
  3356. },
  3357. {
  3358. "type": "string",
  3359. "description": "name of the repo",
  3360. "name": "repo",
  3361. "in": "path",
  3362. "required": true
  3363. },
  3364. {
  3365. "type": "integer",
  3366. "description": "page number of results to return (1-based)",
  3367. "name": "page",
  3368. "in": "query"
  3369. },
  3370. {
  3371. "type": "integer",
  3372. "description": "page size of results",
  3373. "name": "limit",
  3374. "in": "query"
  3375. }
  3376. ],
  3377. "responses": {
  3378. "200": {
  3379. "$ref": "#/responses/RepositoryList"
  3380. }
  3381. }
  3382. },
  3383. "post": {
  3384. "produces": [
  3385. "application/json"
  3386. ],
  3387. "tags": [
  3388. "repository"
  3389. ],
  3390. "summary": "Fork a repository",
  3391. "operationId": "createFork",
  3392. "parameters": [
  3393. {
  3394. "type": "string",
  3395. "description": "owner of the repo to fork",
  3396. "name": "owner",
  3397. "in": "path",
  3398. "required": true
  3399. },
  3400. {
  3401. "type": "string",
  3402. "description": "name of the repo to fork",
  3403. "name": "repo",
  3404. "in": "path",
  3405. "required": true
  3406. },
  3407. {
  3408. "name": "body",
  3409. "in": "body",
  3410. "schema": {
  3411. "$ref": "#/definitions/CreateForkOption"
  3412. }
  3413. }
  3414. ],
  3415. "responses": {
  3416. "202": {
  3417. "$ref": "#/responses/Repository"
  3418. },
  3419. "403": {
  3420. "$ref": "#/responses/forbidden"
  3421. },
  3422. "422": {
  3423. "$ref": "#/responses/validationError"
  3424. }
  3425. }
  3426. }
  3427. },
  3428. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  3429. "get": {
  3430. "produces": [
  3431. "application/json"
  3432. ],
  3433. "tags": [
  3434. "repository"
  3435. ],
  3436. "summary": "Gets the blob of a repository.",
  3437. "operationId": "GetBlob",
  3438. "parameters": [
  3439. {
  3440. "type": "string",
  3441. "description": "owner of the repo",
  3442. "name": "owner",
  3443. "in": "path",
  3444. "required": true
  3445. },
  3446. {
  3447. "type": "string",
  3448. "description": "name of the repo",
  3449. "name": "repo",
  3450. "in": "path",
  3451. "required": true
  3452. },
  3453. {
  3454. "type": "string",
  3455. "description": "sha of the commit",
  3456. "name": "sha",
  3457. "in": "path",
  3458. "required": true
  3459. }
  3460. ],
  3461. "responses": {
  3462. "200": {
  3463. "$ref": "#/responses/GitBlobResponse"
  3464. },
  3465. "400": {
  3466. "$ref": "#/responses/error"
  3467. }
  3468. }
  3469. }
  3470. },
  3471. "/repos/{owner}/{repo}/git/commits/{sha}": {
  3472. "get": {
  3473. "produces": [
  3474. "application/json"
  3475. ],
  3476. "tags": [
  3477. "repository"
  3478. ],
  3479. "summary": "Get a single commit from a repository",
  3480. "operationId": "repoGetSingleCommit",
  3481. "parameters": [
  3482. {
  3483. "type": "string",
  3484. "description": "owner of the repo",
  3485. "name": "owner",
  3486. "in": "path",
  3487. "required": true
  3488. },
  3489. {
  3490. "type": "string",
  3491. "description": "name of the repo",
  3492. "name": "repo",
  3493. "in": "path",
  3494. "required": true
  3495. },
  3496. {
  3497. "type": "string",
  3498. "description": "a git ref or commit sha",
  3499. "name": "sha",
  3500. "in": "path",
  3501. "required": true
  3502. }
  3503. ],
  3504. "responses": {
  3505. "200": {
  3506. "$ref": "#/responses/Commit"
  3507. },
  3508. "404": {
  3509. "$ref": "#/responses/notFound"
  3510. },
  3511. "422": {
  3512. "$ref": "#/responses/validationError"
  3513. }
  3514. }
  3515. }
  3516. },
  3517. "/repos/{owner}/{repo}/git/refs": {
  3518. "get": {
  3519. "produces": [
  3520. "application/json"
  3521. ],
  3522. "tags": [
  3523. "repository"
  3524. ],
  3525. "summary": "Get specified ref or filtered repository's refs",
  3526. "operationId": "repoListAllGitRefs",
  3527. "parameters": [
  3528. {
  3529. "type": "string",
  3530. "description": "owner of the repo",
  3531. "name": "owner",
  3532. "in": "path",
  3533. "required": true
  3534. },
  3535. {
  3536. "type": "string",
  3537. "description": "name of the repo",
  3538. "name": "repo",
  3539. "in": "path",
  3540. "required": true
  3541. }
  3542. ],
  3543. "responses": {
  3544. "200": {
  3545. "$ref": "#/responses/ReferenceList"
  3546. },
  3547. "404": {
  3548. "$ref": "#/responses/notFound"
  3549. }
  3550. }
  3551. }
  3552. },
  3553. "/repos/{owner}/{repo}/git/refs/{ref}": {
  3554. "get": {
  3555. "produces": [
  3556. "application/json"
  3557. ],
  3558. "tags": [
  3559. "repository"
  3560. ],
  3561. "summary": "Get specified ref or filtered repository's refs",
  3562. "operationId": "repoListGitRefs",
  3563. "parameters": [
  3564. {
  3565. "type": "string",
  3566. "description": "owner of the repo",
  3567. "name": "owner",
  3568. "in": "path",
  3569. "required": true
  3570. },
  3571. {
  3572. "type": "string",
  3573. "description": "name of the repo",
  3574. "name": "repo",
  3575. "in": "path",
  3576. "required": true
  3577. },
  3578. {
  3579. "type": "string",
  3580. "description": "part or full name of the ref",
  3581. "name": "ref",
  3582. "in": "path",
  3583. "required": true
  3584. }
  3585. ],
  3586. "responses": {
  3587. "200": {
  3588. "$ref": "#/responses/ReferenceList"
  3589. },
  3590. "404": {
  3591. "$ref": "#/responses/notFound"
  3592. }
  3593. }
  3594. }
  3595. },
  3596. "/repos/{owner}/{repo}/git/tags/{sha}": {
  3597. "get": {
  3598. "produces": [
  3599. "application/json"
  3600. ],
  3601. "tags": [
  3602. "repository"
  3603. ],
  3604. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  3605. "operationId": "GetTag",
  3606. "parameters": [
  3607. {
  3608. "type": "string",
  3609. "description": "owner of the repo",
  3610. "name": "owner",
  3611. "in": "path",
  3612. "required": true
  3613. },
  3614. {
  3615. "type": "string",
  3616. "description": "name of the repo",
  3617. "name": "repo",
  3618. "in": "path",
  3619. "required": true
  3620. },
  3621. {
  3622. "type": "string",
  3623. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  3624. "name": "sha",
  3625. "in": "path",
  3626. "required": true
  3627. }
  3628. ],
  3629. "responses": {
  3630. "200": {
  3631. "$ref": "#/responses/AnnotatedTag"
  3632. },
  3633. "400": {
  3634. "$ref": "#/responses/error"
  3635. }
  3636. }
  3637. }
  3638. },
  3639. "/repos/{owner}/{repo}/git/trees/{sha}": {
  3640. "get": {
  3641. "produces": [
  3642. "application/json"
  3643. ],
  3644. "tags": [
  3645. "repository"
  3646. ],
  3647. "summary": "Gets the tree of a repository.",
  3648. "operationId": "GetTree",
  3649. "parameters": [
  3650. {
  3651. "type": "string",
  3652. "description": "owner of the repo",
  3653. "name": "owner",
  3654. "in": "path",
  3655. "required": true
  3656. },
  3657. {
  3658. "type": "string",
  3659. "description": "name of the repo",
  3660. "name": "repo",
  3661. "in": "path",
  3662. "required": true
  3663. },
  3664. {
  3665. "type": "string",
  3666. "description": "sha of the commit",
  3667. "name": "sha",
  3668. "in": "path",
  3669. "required": true
  3670. },
  3671. {
  3672. "type": "boolean",
  3673. "description": "show all directories and files",
  3674. "name": "recursive",
  3675. "in": "query"
  3676. },
  3677. {
  3678. "type": "integer",
  3679. "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",
  3680. "name": "page",
  3681. "in": "query"
  3682. },
  3683. {
  3684. "type": "integer",
  3685. "description": "number of items per page",
  3686. "name": "per_page",
  3687. "in": "query"
  3688. }
  3689. ],
  3690. "responses": {
  3691. "200": {
  3692. "$ref": "#/responses/GitTreeResponse"
  3693. },
  3694. "400": {
  3695. "$ref": "#/responses/error"
  3696. }
  3697. }
  3698. }
  3699. },
  3700. "/repos/{owner}/{repo}/hooks": {
  3701. "get": {
  3702. "produces": [
  3703. "application/json"
  3704. ],
  3705. "tags": [
  3706. "repository"
  3707. ],
  3708. "summary": "List the hooks in a repository",
  3709. "operationId": "repoListHooks",
  3710. "parameters": [
  3711. {
  3712. "type": "string",
  3713. "description": "owner of the repo",
  3714. "name": "owner",
  3715. "in": "path",
  3716. "required": true
  3717. },
  3718. {
  3719. "type": "string",
  3720. "description": "name of the repo",
  3721. "name": "repo",
  3722. "in": "path",
  3723. "required": true
  3724. },
  3725. {
  3726. "type": "integer",
  3727. "description": "page number of results to return (1-based)",
  3728. "name": "page",
  3729. "in": "query"
  3730. },
  3731. {
  3732. "type": "integer",
  3733. "description": "page size of results",
  3734. "name": "limit",
  3735. "in": "query"
  3736. }
  3737. ],
  3738. "responses": {
  3739. "200": {
  3740. "$ref": "#/responses/HookList"
  3741. }
  3742. }
  3743. },
  3744. "post": {
  3745. "consumes": [
  3746. "application/json"
  3747. ],
  3748. "produces": [
  3749. "application/json"
  3750. ],
  3751. "tags": [
  3752. "repository"
  3753. ],
  3754. "summary": "Create a hook",
  3755. "operationId": "repoCreateHook",
  3756. "parameters": [
  3757. {
  3758. "type": "string",
  3759. "description": "owner of the repo",
  3760. "name": "owner",
  3761. "in": "path",
  3762. "required": true
  3763. },
  3764. {
  3765. "type": "string",
  3766. "description": "name of the repo",
  3767. "name": "repo",
  3768. "in": "path",
  3769. "required": true
  3770. },
  3771. {
  3772. "name": "body",
  3773. "in": "body",
  3774. "schema": {
  3775. "$ref": "#/definitions/CreateHookOption"
  3776. }
  3777. }
  3778. ],
  3779. "responses": {
  3780. "201": {
  3781. "$ref": "#/responses/Hook"
  3782. }
  3783. }
  3784. }
  3785. },
  3786. "/repos/{owner}/{repo}/hooks/git": {
  3787. "get": {
  3788. "produces": [
  3789. "application/json"
  3790. ],
  3791. "tags": [
  3792. "repository"
  3793. ],
  3794. "summary": "List the Git hooks in a repository",
  3795. "operationId": "repoListGitHooks",
  3796. "parameters": [
  3797. {
  3798. "type": "string",
  3799. "description": "owner of the repo",
  3800. "name": "owner",
  3801. "in": "path",
  3802. "required": true
  3803. },
  3804. {
  3805. "type": "string",
  3806. "description": "name of the repo",
  3807. "name": "repo",
  3808. "in": "path",
  3809. "required": true
  3810. }
  3811. ],
  3812. "responses": {
  3813. "200": {
  3814. "$ref": "#/responses/GitHookList"
  3815. }
  3816. }
  3817. }
  3818. },
  3819. "/repos/{owner}/{repo}/hooks/git/{id}": {
  3820. "get": {
  3821. "produces": [
  3822. "application/json"
  3823. ],
  3824. "tags": [
  3825. "repository"
  3826. ],
  3827. "summary": "Get a Git hook",
  3828. "operationId": "repoGetGitHook",
  3829. "parameters": [
  3830. {
  3831. "type": "string",
  3832. "description": "owner of the repo",
  3833. "name": "owner",
  3834. "in": "path",
  3835. "required": true
  3836. },
  3837. {
  3838. "type": "string",
  3839. "description": "name of the repo",
  3840. "name": "repo",
  3841. "in": "path",
  3842. "required": true
  3843. },
  3844. {
  3845. "type": "string",
  3846. "description": "id of the hook to get",
  3847. "name": "id",
  3848. "in": "path",
  3849. "required": true
  3850. }
  3851. ],
  3852. "responses": {
  3853. "200": {
  3854. "$ref": "#/responses/GitHook"
  3855. },
  3856. "404": {
  3857. "$ref": "#/responses/notFound"
  3858. }
  3859. }
  3860. },
  3861. "delete": {
  3862. "produces": [
  3863. "application/json"
  3864. ],
  3865. "tags": [
  3866. "repository"
  3867. ],
  3868. "summary": "Delete a Git hook in a repository",
  3869. "operationId": "repoDeleteGitHook",
  3870. "parameters": [
  3871. {
  3872. "type": "string",
  3873. "description": "owner of the repo",
  3874. "name": "owner",
  3875. "in": "path",
  3876. "required": true
  3877. },
  3878. {
  3879. "type": "string",
  3880. "description": "name of the repo",
  3881. "name": "repo",
  3882. "in": "path",
  3883. "required": true
  3884. },
  3885. {
  3886. "type": "string",
  3887. "description": "id of the hook to get",
  3888. "name": "id",
  3889. "in": "path",
  3890. "required": true
  3891. }
  3892. ],
  3893. "responses": {
  3894. "204": {
  3895. "$ref": "#/responses/empty"
  3896. },
  3897. "404": {
  3898. "$ref": "#/responses/notFound"
  3899. }
  3900. }
  3901. },
  3902. "patch": {
  3903. "produces": [
  3904. "application/json"
  3905. ],
  3906. "tags": [
  3907. "repository"
  3908. ],
  3909. "summary": "Edit a Git hook in a repository",
  3910. "operationId": "repoEditGitHook",
  3911. "parameters": [
  3912. {
  3913. "type": "string",
  3914. "description": "owner of the repo",
  3915. "name": "owner",
  3916. "in": "path",
  3917. "required": true
  3918. },
  3919. {
  3920. "type": "string",
  3921. "description": "name of the repo",
  3922. "name": "repo",
  3923. "in": "path",
  3924. "required": true
  3925. },
  3926. {
  3927. "type": "string",
  3928. "description": "id of the hook to get",
  3929. "name": "id",
  3930. "in": "path",
  3931. "required": true
  3932. },
  3933. {
  3934. "name": "body",
  3935. "in": "body",
  3936. "schema": {
  3937. "$ref": "#/definitions/EditGitHookOption"
  3938. }
  3939. }
  3940. ],
  3941. "responses": {
  3942. "200": {
  3943. "$ref": "#/responses/GitHook"
  3944. },
  3945. "404": {
  3946. "$ref": "#/responses/notFound"
  3947. }
  3948. }
  3949. }
  3950. },
  3951. "/repos/{owner}/{repo}/hooks/{id}": {
  3952. "get": {
  3953. "produces": [
  3954. "application/json"
  3955. ],
  3956. "tags": [
  3957. "repository"
  3958. ],
  3959. "summary": "Get a hook",
  3960. "operationId": "repoGetHook",
  3961. "parameters": [
  3962. {
  3963. "type": "string",
  3964. "description": "owner of the repo",
  3965. "name": "owner",
  3966. "in": "path",
  3967. "required": true
  3968. },
  3969. {
  3970. "type": "string",
  3971. "description": "name of the repo",
  3972. "name": "repo",
  3973. "in": "path",
  3974. "required": true
  3975. },
  3976. {
  3977. "type": "integer",
  3978. "format": "int64",
  3979. "description": "id of the hook to get",
  3980. "name": "id",
  3981. "in": "path",
  3982. "required": true
  3983. }
  3984. ],
  3985. "responses": {
  3986. "200": {
  3987. "$ref": "#/responses/Hook"
  3988. },
  3989. "404": {
  3990. "$ref": "#/responses/notFound"
  3991. }
  3992. }
  3993. },
  3994. "delete": {
  3995. "produces": [
  3996. "application/json"
  3997. ],
  3998. "tags": [
  3999. "repository"
  4000. ],
  4001. "summary": "Delete a hook in a repository",
  4002. "operationId": "repoDeleteHook",
  4003. "parameters": [
  4004. {
  4005. "type": "string",
  4006. "description": "owner of the repo",
  4007. "name": "owner",
  4008. "in": "path",
  4009. "required": true
  4010. },
  4011. {
  4012. "type": "string",
  4013. "description": "name of the repo",
  4014. "name": "repo",
  4015. "in": "path",
  4016. "required": true
  4017. },
  4018. {
  4019. "type": "integer",
  4020. "format": "int64",
  4021. "description": "id of the hook to delete",
  4022. "name": "id",
  4023. "in": "path",
  4024. "required": true
  4025. }
  4026. ],
  4027. "responses": {
  4028. "204": {
  4029. "$ref": "#/responses/empty"
  4030. },
  4031. "404": {
  4032. "$ref": "#/responses/notFound"
  4033. }
  4034. }
  4035. },
  4036. "patch": {
  4037. "produces": [
  4038. "application/json"
  4039. ],
  4040. "tags": [
  4041. "repository"
  4042. ],
  4043. "summary": "Edit a hook in a repository",
  4044. "operationId": "repoEditHook",
  4045. "parameters": [
  4046. {
  4047. "type": "string",
  4048. "description": "owner of the repo",
  4049. "name": "owner",
  4050. "in": "path",
  4051. "required": true
  4052. },
  4053. {
  4054. "type": "string",
  4055. "description": "name of the repo",
  4056. "name": "repo",
  4057. "in": "path",
  4058. "required": true
  4059. },
  4060. {
  4061. "type": "integer",
  4062. "format": "int64",
  4063. "description": "index of the hook",
  4064. "name": "id",
  4065. "in": "path",
  4066. "required": true
  4067. },
  4068. {
  4069. "name": "body",
  4070. "in": "body",
  4071. "schema": {
  4072. "$ref": "#/definitions/EditHookOption"
  4073. }
  4074. }
  4075. ],
  4076. "responses": {
  4077. "200": {
  4078. "$ref": "#/responses/Hook"
  4079. }
  4080. }
  4081. }
  4082. },
  4083. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  4084. "post": {
  4085. "produces": [
  4086. "application/json"
  4087. ],
  4088. "tags": [
  4089. "repository"
  4090. ],
  4091. "summary": "Test a push webhook",
  4092. "operationId": "repoTestHook",
  4093. "parameters": [
  4094. {
  4095. "type": "string",
  4096. "description": "owner of the repo",
  4097. "name": "owner",
  4098. "in": "path",
  4099. "required": true
  4100. },
  4101. {
  4102. "type": "string",
  4103. "description": "name of the repo",
  4104. "name": "repo",
  4105. "in": "path",
  4106. "required": true
  4107. },
  4108. {
  4109. "type": "integer",
  4110. "format": "int64",
  4111. "description": "id of the hook to test",
  4112. "name": "id",
  4113. "in": "path",
  4114. "required": true
  4115. }
  4116. ],
  4117. "responses": {
  4118. "204": {
  4119. "$ref": "#/responses/empty"
  4120. }
  4121. }
  4122. }
  4123. },
  4124. "/repos/{owner}/{repo}/issue_templates": {
  4125. "get": {
  4126. "produces": [
  4127. "application/json"
  4128. ],
  4129. "tags": [
  4130. "repository"
  4131. ],
  4132. "summary": "Get available issue templates for a repository",
  4133. "operationId": "repoGetIssueTemplates",
  4134. "parameters": [
  4135. {
  4136. "type": "string",
  4137. "description": "owner of the repo",
  4138. "name": "owner",
  4139. "in": "path",
  4140. "required": true
  4141. },
  4142. {
  4143. "type": "string",
  4144. "description": "name of the repo",
  4145. "name": "repo",
  4146. "in": "path",
  4147. "required": true
  4148. }
  4149. ],
  4150. "responses": {
  4151. "200": {
  4152. "$ref": "#/responses/IssueTemplates"
  4153. }
  4154. }
  4155. }
  4156. },
  4157. "/repos/{owner}/{repo}/issues": {
  4158. "get": {
  4159. "produces": [
  4160. "application/json"
  4161. ],
  4162. "tags": [
  4163. "issue"
  4164. ],
  4165. "summary": "List a repository's issues",
  4166. "operationId": "issueListIssues",
  4167. "parameters": [
  4168. {
  4169. "type": "string",
  4170. "description": "owner of the repo",
  4171. "name": "owner",
  4172. "in": "path",
  4173. "required": true
  4174. },
  4175. {
  4176. "type": "string",
  4177. "description": "name of the repo",
  4178. "name": "repo",
  4179. "in": "path",
  4180. "required": true
  4181. },
  4182. {
  4183. "enum": [
  4184. "closed",
  4185. "open",
  4186. "all"
  4187. ],
  4188. "type": "string",
  4189. "description": "whether issue is open or closed",
  4190. "name": "state",
  4191. "in": "query"
  4192. },
  4193. {
  4194. "type": "string",
  4195. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  4196. "name": "labels",
  4197. "in": "query"
  4198. },
  4199. {
  4200. "type": "string",
  4201. "description": "search string",
  4202. "name": "q",
  4203. "in": "query"
  4204. },
  4205. {
  4206. "enum": [
  4207. "issues",
  4208. "pulls"
  4209. ],
  4210. "type": "string",
  4211. "description": "filter by type (issues / pulls) if set",
  4212. "name": "type",
  4213. "in": "query"
  4214. },
  4215. {
  4216. "type": "string",
  4217. "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",
  4218. "name": "milestones",
  4219. "in": "query"
  4220. },
  4221. {
  4222. "type": "integer",
  4223. "description": "page number of results to return (1-based)",
  4224. "name": "page",
  4225. "in": "query"
  4226. },
  4227. {
  4228. "type": "integer",
  4229. "description": "page size of results",
  4230. "name": "limit",
  4231. "in": "query"
  4232. }
  4233. ],
  4234. "responses": {
  4235. "200": {
  4236. "$ref": "#/responses/IssueList"
  4237. }
  4238. }
  4239. },
  4240. "post": {
  4241. "consumes": [
  4242. "application/json"
  4243. ],
  4244. "produces": [
  4245. "application/json"
  4246. ],
  4247. "tags": [
  4248. "issue"
  4249. ],
  4250. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4251. "operationId": "issueCreateIssue",
  4252. "parameters": [
  4253. {
  4254. "type": "string",
  4255. "description": "owner of the repo",
  4256. "name": "owner",
  4257. "in": "path",
  4258. "required": true
  4259. },
  4260. {
  4261. "type": "string",
  4262. "description": "name of the repo",
  4263. "name": "repo",
  4264. "in": "path",
  4265. "required": true
  4266. },
  4267. {
  4268. "name": "body",
  4269. "in": "body",
  4270. "schema": {
  4271. "$ref": "#/definitions/CreateIssueOption"
  4272. }
  4273. }
  4274. ],
  4275. "responses": {
  4276. "201": {
  4277. "$ref": "#/responses/Issue"
  4278. },
  4279. "403": {
  4280. "$ref": "#/responses/forbidden"
  4281. },
  4282. "412": {
  4283. "$ref": "#/responses/error"
  4284. },
  4285. "422": {
  4286. "$ref": "#/responses/validationError"
  4287. }
  4288. }
  4289. }
  4290. },
  4291. "/repos/{owner}/{repo}/issues/comments": {
  4292. "get": {
  4293. "produces": [
  4294. "application/json"
  4295. ],
  4296. "tags": [
  4297. "issue"
  4298. ],
  4299. "summary": "List all comments in a repository",
  4300. "operationId": "issueGetRepoComments",
  4301. "parameters": [
  4302. {
  4303. "type": "string",
  4304. "description": "owner of the repo",
  4305. "name": "owner",
  4306. "in": "path",
  4307. "required": true
  4308. },
  4309. {
  4310. "type": "string",
  4311. "description": "name of the repo",
  4312. "name": "repo",
  4313. "in": "path",
  4314. "required": true
  4315. },
  4316. {
  4317. "type": "string",
  4318. "format": "date-time",
  4319. "description": "if provided, only comments updated since the provided time are returned.",
  4320. "name": "since",
  4321. "in": "query"
  4322. },
  4323. {
  4324. "type": "string",
  4325. "format": "date-time",
  4326. "description": "if provided, only comments updated before the provided time are returned.",
  4327. "name": "before",
  4328. "in": "query"
  4329. },
  4330. {
  4331. "type": "integer",
  4332. "description": "page number of results to return (1-based)",
  4333. "name": "page",
  4334. "in": "query"
  4335. },
  4336. {
  4337. "type": "integer",
  4338. "description": "page size of results",
  4339. "name": "limit",
  4340. "in": "query"
  4341. }
  4342. ],
  4343. "responses": {
  4344. "200": {
  4345. "$ref": "#/responses/CommentList"
  4346. }
  4347. }
  4348. }
  4349. },
  4350. "/repos/{owner}/{repo}/issues/comments/{id}": {
  4351. "get": {
  4352. "consumes": [
  4353. "application/json"
  4354. ],
  4355. "produces": [
  4356. "application/json"
  4357. ],
  4358. "tags": [
  4359. "issue"
  4360. ],
  4361. "summary": "Get a comment",
  4362. "operationId": "issueGetComment",
  4363. "parameters": [
  4364. {
  4365. "type": "string",
  4366. "description": "owner of the repo",
  4367. "name": "owner",
  4368. "in": "path",
  4369. "required": true
  4370. },
  4371. {
  4372. "type": "string",
  4373. "description": "name of the repo",
  4374. "name": "repo",
  4375. "in": "path",
  4376. "required": true
  4377. },
  4378. {
  4379. "type": "integer",
  4380. "format": "int64",
  4381. "description": "id of the comment",
  4382. "name": "id",
  4383. "in": "path",
  4384. "required": true
  4385. }
  4386. ],
  4387. "responses": {
  4388. "200": {
  4389. "$ref": "#/responses/Comment"
  4390. },
  4391. "204": {
  4392. "$ref": "#/responses/empty"
  4393. },
  4394. "403": {
  4395. "$ref": "#/responses/forbidden"
  4396. },
  4397. "404": {
  4398. "$ref": "#/responses/notFound"
  4399. }
  4400. }
  4401. },
  4402. "delete": {
  4403. "tags": [
  4404. "issue"
  4405. ],
  4406. "summary": "Delete a comment",
  4407. "operationId": "issueDeleteComment",
  4408. "parameters": [
  4409. {
  4410. "type": "string",
  4411. "description": "owner of the repo",
  4412. "name": "owner",
  4413. "in": "path",
  4414. "required": true
  4415. },
  4416. {
  4417. "type": "string",
  4418. "description": "name of the repo",
  4419. "name": "repo",
  4420. "in": "path",
  4421. "required": true
  4422. },
  4423. {
  4424. "type": "integer",
  4425. "format": "int64",
  4426. "description": "id of comment to delete",
  4427. "name": "id",
  4428. "in": "path",
  4429. "required": true
  4430. }
  4431. ],
  4432. "responses": {
  4433. "204": {
  4434. "$ref": "#/responses/empty"
  4435. },
  4436. "403": {
  4437. "$ref": "#/responses/forbidden"
  4438. },
  4439. "404": {
  4440. "$ref": "#/responses/notFound"
  4441. }
  4442. }
  4443. },
  4444. "patch": {
  4445. "consumes": [
  4446. "application/json"
  4447. ],
  4448. "produces": [
  4449. "application/json"
  4450. ],
  4451. "tags": [
  4452. "issue"
  4453. ],
  4454. "summary": "Edit a comment",
  4455. "operationId": "issueEditComment",
  4456. "parameters": [
  4457. {
  4458. "type": "string",
  4459. "description": "owner of the repo",
  4460. "name": "owner",
  4461. "in": "path",
  4462. "required": true
  4463. },
  4464. {
  4465. "type": "string",
  4466. "description": "name of the repo",
  4467. "name": "repo",
  4468. "in": "path",
  4469. "required": true
  4470. },
  4471. {
  4472. "type": "integer",
  4473. "format": "int64",
  4474. "description": "id of the comment to edit",
  4475. "name": "id",
  4476. "in": "path",
  4477. "required": true
  4478. },
  4479. {
  4480. "name": "body",
  4481. "in": "body",
  4482. "schema": {
  4483. "$ref": "#/definitions/EditIssueCommentOption"
  4484. }
  4485. }
  4486. ],
  4487. "responses": {
  4488. "200": {
  4489. "$ref": "#/responses/Comment"
  4490. },
  4491. "204": {
  4492. "$ref": "#/responses/empty"
  4493. },
  4494. "403": {
  4495. "$ref": "#/responses/forbidden"
  4496. },
  4497. "404": {
  4498. "$ref": "#/responses/notFound"
  4499. }
  4500. }
  4501. }
  4502. },
  4503. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  4504. "get": {
  4505. "consumes": [
  4506. "application/json"
  4507. ],
  4508. "produces": [
  4509. "application/json"
  4510. ],
  4511. "tags": [
  4512. "issue"
  4513. ],
  4514. "summary": "Get a list of reactions from a comment of an issue",
  4515. "operationId": "issueGetCommentReactions",
  4516. "parameters": [
  4517. {
  4518. "type": "string",
  4519. "description": "owner of the repo",
  4520. "name": "owner",
  4521. "in": "path",
  4522. "required": true
  4523. },
  4524. {
  4525. "type": "string",
  4526. "description": "name of the repo",
  4527. "name": "repo",
  4528. "in": "path",
  4529. "required": true
  4530. },
  4531. {
  4532. "type": "integer",
  4533. "format": "int64",
  4534. "description": "id of the comment to edit",
  4535. "name": "id",
  4536. "in": "path",
  4537. "required": true
  4538. }
  4539. ],
  4540. "responses": {
  4541. "200": {
  4542. "$ref": "#/responses/ReactionList"
  4543. },
  4544. "403": {
  4545. "$ref": "#/responses/forbidden"
  4546. }
  4547. }
  4548. },
  4549. "post": {
  4550. "consumes": [
  4551. "application/json"
  4552. ],
  4553. "produces": [
  4554. "application/json"
  4555. ],
  4556. "tags": [
  4557. "issue"
  4558. ],
  4559. "summary": "Add a reaction to a comment of an issue",
  4560. "operationId": "issuePostCommentReaction",
  4561. "parameters": [
  4562. {
  4563. "type": "string",
  4564. "description": "owner of the repo",
  4565. "name": "owner",
  4566. "in": "path",
  4567. "required": true
  4568. },
  4569. {
  4570. "type": "string",
  4571. "description": "name of the repo",
  4572. "name": "repo",
  4573. "in": "path",
  4574. "required": true
  4575. },
  4576. {
  4577. "type": "integer",
  4578. "format": "int64",
  4579. "description": "id of the comment to edit",
  4580. "name": "id",
  4581. "in": "path",
  4582. "required": true
  4583. },
  4584. {
  4585. "name": "content",
  4586. "in": "body",
  4587. "schema": {
  4588. "$ref": "#/definitions/EditReactionOption"
  4589. }
  4590. }
  4591. ],
  4592. "responses": {
  4593. "200": {
  4594. "$ref": "#/responses/Reaction"
  4595. },
  4596. "201": {
  4597. "$ref": "#/responses/Reaction"
  4598. },
  4599. "403": {
  4600. "$ref": "#/responses/forbidden"
  4601. }
  4602. }
  4603. },
  4604. "delete": {
  4605. "consumes": [
  4606. "application/json"
  4607. ],
  4608. "produces": [
  4609. "application/json"
  4610. ],
  4611. "tags": [
  4612. "issue"
  4613. ],
  4614. "summary": "Remove a reaction from a comment of an issue",
  4615. "operationId": "issueDeleteCommentReaction",
  4616. "parameters": [
  4617. {
  4618. "type": "string",
  4619. "description": "owner of the repo",
  4620. "name": "owner",
  4621. "in": "path",
  4622. "required": true
  4623. },
  4624. {
  4625. "type": "string",
  4626. "description": "name of the repo",
  4627. "name": "repo",
  4628. "in": "path",
  4629. "required": true
  4630. },
  4631. {
  4632. "type": "integer",
  4633. "format": "int64",
  4634. "description": "id of the comment to edit",
  4635. "name": "id",
  4636. "in": "path",
  4637. "required": true
  4638. },
  4639. {
  4640. "name": "content",
  4641. "in": "body",
  4642. "schema": {
  4643. "$ref": "#/definitions/EditReactionOption"
  4644. }
  4645. }
  4646. ],
  4647. "responses": {
  4648. "200": {
  4649. "$ref": "#/responses/empty"
  4650. },
  4651. "403": {
  4652. "$ref": "#/responses/forbidden"
  4653. }
  4654. }
  4655. }
  4656. },
  4657. "/repos/{owner}/{repo}/issues/{index}": {
  4658. "get": {
  4659. "produces": [
  4660. "application/json"
  4661. ],
  4662. "tags": [
  4663. "issue"
  4664. ],
  4665. "summary": "Get an issue",
  4666. "operationId": "issueGetIssue",
  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": "index of the issue to get",
  4686. "name": "index",
  4687. "in": "path",
  4688. "required": true
  4689. }
  4690. ],
  4691. "responses": {
  4692. "200": {
  4693. "$ref": "#/responses/Issue"
  4694. },
  4695. "404": {
  4696. "$ref": "#/responses/notFound"
  4697. }
  4698. }
  4699. },
  4700. "patch": {
  4701. "consumes": [
  4702. "application/json"
  4703. ],
  4704. "produces": [
  4705. "application/json"
  4706. ],
  4707. "tags": [
  4708. "issue"
  4709. ],
  4710. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4711. "operationId": "issueEditIssue",
  4712. "parameters": [
  4713. {
  4714. "type": "string",
  4715. "description": "owner of the repo",
  4716. "name": "owner",
  4717. "in": "path",
  4718. "required": true
  4719. },
  4720. {
  4721. "type": "string",
  4722. "description": "name of the repo",
  4723. "name": "repo",
  4724. "in": "path",
  4725. "required": true
  4726. },
  4727. {
  4728. "type": "integer",
  4729. "format": "int64",
  4730. "description": "index of the issue to edit",
  4731. "name": "index",
  4732. "in": "path",
  4733. "required": true
  4734. },
  4735. {
  4736. "name": "body",
  4737. "in": "body",
  4738. "schema": {
  4739. "$ref": "#/definitions/EditIssueOption"
  4740. }
  4741. }
  4742. ],
  4743. "responses": {
  4744. "201": {
  4745. "$ref": "#/responses/Issue"
  4746. },
  4747. "403": {
  4748. "$ref": "#/responses/forbidden"
  4749. },
  4750. "404": {
  4751. "$ref": "#/responses/notFound"
  4752. },
  4753. "412": {
  4754. "$ref": "#/responses/error"
  4755. }
  4756. }
  4757. }
  4758. },
  4759. "/repos/{owner}/{repo}/issues/{index}/comments": {
  4760. "get": {
  4761. "produces": [
  4762. "application/json"
  4763. ],
  4764. "tags": [
  4765. "issue"
  4766. ],
  4767. "summary": "List all comments on an issue",
  4768. "operationId": "issueGetComments",
  4769. "parameters": [
  4770. {
  4771. "type": "string",
  4772. "description": "owner of the repo",
  4773. "name": "owner",
  4774. "in": "path",
  4775. "required": true
  4776. },
  4777. {
  4778. "type": "string",
  4779. "description": "name of the repo",
  4780. "name": "repo",
  4781. "in": "path",
  4782. "required": true
  4783. },
  4784. {
  4785. "type": "integer",
  4786. "format": "int64",
  4787. "description": "index of the issue",
  4788. "name": "index",
  4789. "in": "path",
  4790. "required": true
  4791. },
  4792. {
  4793. "type": "string",
  4794. "format": "date-time",
  4795. "description": "if provided, only comments updated since the specified time are returned.",
  4796. "name": "since",
  4797. "in": "query"
  4798. },
  4799. {
  4800. "type": "string",
  4801. "format": "date-time",
  4802. "description": "if provided, only comments updated before the provided time are returned.",
  4803. "name": "before",
  4804. "in": "query"
  4805. }
  4806. ],
  4807. "responses": {
  4808. "200": {
  4809. "$ref": "#/responses/CommentList"
  4810. }
  4811. }
  4812. },
  4813. "post": {
  4814. "consumes": [
  4815. "application/json"
  4816. ],
  4817. "produces": [
  4818. "application/json"
  4819. ],
  4820. "tags": [
  4821. "issue"
  4822. ],
  4823. "summary": "Add a comment to an issue",
  4824. "operationId": "issueCreateComment",
  4825. "parameters": [
  4826. {
  4827. "type": "string",
  4828. "description": "owner of the repo",
  4829. "name": "owner",
  4830. "in": "path",
  4831. "required": true
  4832. },
  4833. {
  4834. "type": "string",
  4835. "description": "name of the repo",
  4836. "name": "repo",
  4837. "in": "path",
  4838. "required": true
  4839. },
  4840. {
  4841. "type": "integer",
  4842. "format": "int64",
  4843. "description": "index of the issue",
  4844. "name": "index",
  4845. "in": "path",
  4846. "required": true
  4847. },
  4848. {
  4849. "name": "body",
  4850. "in": "body",
  4851. "schema": {
  4852. "$ref": "#/definitions/CreateIssueCommentOption"
  4853. }
  4854. }
  4855. ],
  4856. "responses": {
  4857. "201": {
  4858. "$ref": "#/responses/Comment"
  4859. },
  4860. "403": {
  4861. "$ref": "#/responses/forbidden"
  4862. }
  4863. }
  4864. }
  4865. },
  4866. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  4867. "delete": {
  4868. "tags": [
  4869. "issue"
  4870. ],
  4871. "summary": "Delete a comment",
  4872. "operationId": "issueDeleteCommentDeprecated",
  4873. "deprecated": true,
  4874. "parameters": [
  4875. {
  4876. "type": "string",
  4877. "description": "owner of the repo",
  4878. "name": "owner",
  4879. "in": "path",
  4880. "required": true
  4881. },
  4882. {
  4883. "type": "string",
  4884. "description": "name of the repo",
  4885. "name": "repo",
  4886. "in": "path",
  4887. "required": true
  4888. },
  4889. {
  4890. "type": "integer",
  4891. "description": "this parameter is ignored",
  4892. "name": "index",
  4893. "in": "path",
  4894. "required": true
  4895. },
  4896. {
  4897. "type": "integer",
  4898. "format": "int64",
  4899. "description": "id of comment to delete",
  4900. "name": "id",
  4901. "in": "path",
  4902. "required": true
  4903. }
  4904. ],
  4905. "responses": {
  4906. "204": {
  4907. "$ref": "#/responses/empty"
  4908. },
  4909. "403": {
  4910. "$ref": "#/responses/forbidden"
  4911. },
  4912. "404": {
  4913. "$ref": "#/responses/notFound"
  4914. }
  4915. }
  4916. },
  4917. "patch": {
  4918. "consumes": [
  4919. "application/json"
  4920. ],
  4921. "produces": [
  4922. "application/json"
  4923. ],
  4924. "tags": [
  4925. "issue"
  4926. ],
  4927. "summary": "Edit a comment",
  4928. "operationId": "issueEditCommentDeprecated",
  4929. "deprecated": true,
  4930. "parameters": [
  4931. {
  4932. "type": "string",
  4933. "description": "owner of the repo",
  4934. "name": "owner",
  4935. "in": "path",
  4936. "required": true
  4937. },
  4938. {
  4939. "type": "string",
  4940. "description": "name of the repo",
  4941. "name": "repo",
  4942. "in": "path",
  4943. "required": true
  4944. },
  4945. {
  4946. "type": "integer",
  4947. "description": "this parameter is ignored",
  4948. "name": "index",
  4949. "in": "path",
  4950. "required": true
  4951. },
  4952. {
  4953. "type": "integer",
  4954. "format": "int64",
  4955. "description": "id of the comment to edit",
  4956. "name": "id",
  4957. "in": "path",
  4958. "required": true
  4959. },
  4960. {
  4961. "name": "body",
  4962. "in": "body",
  4963. "schema": {
  4964. "$ref": "#/definitions/EditIssueCommentOption"
  4965. }
  4966. }
  4967. ],
  4968. "responses": {
  4969. "200": {
  4970. "$ref": "#/responses/Comment"
  4971. },
  4972. "204": {
  4973. "$ref": "#/responses/empty"
  4974. },
  4975. "403": {
  4976. "$ref": "#/responses/forbidden"
  4977. },
  4978. "404": {
  4979. "$ref": "#/responses/notFound"
  4980. }
  4981. }
  4982. }
  4983. },
  4984. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4985. "post": {
  4986. "consumes": [
  4987. "application/json"
  4988. ],
  4989. "produces": [
  4990. "application/json"
  4991. ],
  4992. "tags": [
  4993. "issue"
  4994. ],
  4995. "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.",
  4996. "operationId": "issueEditIssueDeadline",
  4997. "parameters": [
  4998. {
  4999. "type": "string",
  5000. "description": "owner of the repo",
  5001. "name": "owner",
  5002. "in": "path",
  5003. "required": true
  5004. },
  5005. {
  5006. "type": "string",
  5007. "description": "name of the repo",
  5008. "name": "repo",
  5009. "in": "path",
  5010. "required": true
  5011. },
  5012. {
  5013. "type": "integer",
  5014. "format": "int64",
  5015. "description": "index of the issue to create or update a deadline on",
  5016. "name": "index",
  5017. "in": "path",
  5018. "required": true
  5019. },
  5020. {
  5021. "name": "body",
  5022. "in": "body",
  5023. "schema": {
  5024. "$ref": "#/definitions/EditDeadlineOption"
  5025. }
  5026. }
  5027. ],
  5028. "responses": {
  5029. "201": {
  5030. "$ref": "#/responses/IssueDeadline"
  5031. },
  5032. "403": {
  5033. "$ref": "#/responses/forbidden"
  5034. },
  5035. "404": {
  5036. "$ref": "#/responses/notFound"
  5037. }
  5038. }
  5039. }
  5040. },
  5041. "/repos/{owner}/{repo}/issues/{index}/labels": {
  5042. "get": {
  5043. "produces": [
  5044. "application/json"
  5045. ],
  5046. "tags": [
  5047. "issue"
  5048. ],
  5049. "summary": "Get an issue's labels",
  5050. "operationId": "issueGetLabels",
  5051. "parameters": [
  5052. {
  5053. "type": "string",
  5054. "description": "owner of the repo",
  5055. "name": "owner",
  5056. "in": "path",
  5057. "required": true
  5058. },
  5059. {
  5060. "type": "string",
  5061. "description": "name of the repo",
  5062. "name": "repo",
  5063. "in": "path",
  5064. "required": true
  5065. },
  5066. {
  5067. "type": "integer",
  5068. "format": "int64",
  5069. "description": "index of the issue",
  5070. "name": "index",
  5071. "in": "path",
  5072. "required": true
  5073. }
  5074. ],
  5075. "responses": {
  5076. "200": {
  5077. "$ref": "#/responses/LabelList"
  5078. },
  5079. "404": {
  5080. "$ref": "#/responses/notFound"
  5081. }
  5082. }
  5083. },
  5084. "put": {
  5085. "consumes": [
  5086. "application/json"
  5087. ],
  5088. "produces": [
  5089. "application/json"
  5090. ],
  5091. "tags": [
  5092. "issue"
  5093. ],
  5094. "summary": "Replace an issue's labels",
  5095. "operationId": "issueReplaceLabels",
  5096. "parameters": [
  5097. {
  5098. "type": "string",
  5099. "description": "owner of the repo",
  5100. "name": "owner",
  5101. "in": "path",
  5102. "required": true
  5103. },
  5104. {
  5105. "type": "string",
  5106. "description": "name of the repo",
  5107. "name": "repo",
  5108. "in": "path",
  5109. "required": true
  5110. },
  5111. {
  5112. "type": "integer",
  5113. "format": "int64",
  5114. "description": "index of the issue",
  5115. "name": "index",
  5116. "in": "path",
  5117. "required": true
  5118. },
  5119. {
  5120. "name": "body",
  5121. "in": "body",
  5122. "schema": {
  5123. "$ref": "#/definitions/IssueLabelsOption"
  5124. }
  5125. }
  5126. ],
  5127. "responses": {
  5128. "200": {
  5129. "$ref": "#/responses/LabelList"
  5130. },
  5131. "403": {
  5132. "$ref": "#/responses/forbidden"
  5133. }
  5134. }
  5135. },
  5136. "post": {
  5137. "consumes": [
  5138. "application/json"
  5139. ],
  5140. "produces": [
  5141. "application/json"
  5142. ],
  5143. "tags": [
  5144. "issue"
  5145. ],
  5146. "summary": "Add a label to an issue",
  5147. "operationId": "issueAddLabel",
  5148. "parameters": [
  5149. {
  5150. "type": "string",
  5151. "description": "owner of the repo",
  5152. "name": "owner",
  5153. "in": "path",
  5154. "required": true
  5155. },
  5156. {
  5157. "type": "string",
  5158. "description": "name of the repo",
  5159. "name": "repo",
  5160. "in": "path",
  5161. "required": true
  5162. },
  5163. {
  5164. "type": "integer",
  5165. "format": "int64",
  5166. "description": "index of the issue",
  5167. "name": "index",
  5168. "in": "path",
  5169. "required": true
  5170. },
  5171. {
  5172. "name": "body",
  5173. "in": "body",
  5174. "schema": {
  5175. "$ref": "#/definitions/IssueLabelsOption"
  5176. }
  5177. }
  5178. ],
  5179. "responses": {
  5180. "200": {
  5181. "$ref": "#/responses/LabelList"
  5182. },
  5183. "403": {
  5184. "$ref": "#/responses/forbidden"
  5185. }
  5186. }
  5187. },
  5188. "delete": {
  5189. "produces": [
  5190. "application/json"
  5191. ],
  5192. "tags": [
  5193. "issue"
  5194. ],
  5195. "summary": "Remove all labels from an issue",
  5196. "operationId": "issueClearLabels",
  5197. "parameters": [
  5198. {
  5199. "type": "string",
  5200. "description": "owner of the repo",
  5201. "name": "owner",
  5202. "in": "path",
  5203. "required": true
  5204. },
  5205. {
  5206. "type": "string",
  5207. "description": "name of the repo",
  5208. "name": "repo",
  5209. "in": "path",
  5210. "required": true
  5211. },
  5212. {
  5213. "type": "integer",
  5214. "format": "int64",
  5215. "description": "index of the issue",
  5216. "name": "index",
  5217. "in": "path",
  5218. "required": true
  5219. }
  5220. ],
  5221. "responses": {
  5222. "204": {
  5223. "$ref": "#/responses/empty"
  5224. },
  5225. "403": {
  5226. "$ref": "#/responses/forbidden"
  5227. }
  5228. }
  5229. }
  5230. },
  5231. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  5232. "delete": {
  5233. "produces": [
  5234. "application/json"
  5235. ],
  5236. "tags": [
  5237. "issue"
  5238. ],
  5239. "summary": "Remove a label from an issue",
  5240. "operationId": "issueRemoveLabel",
  5241. "parameters": [
  5242. {
  5243. "type": "string",
  5244. "description": "owner of the repo",
  5245. "name": "owner",
  5246. "in": "path",
  5247. "required": true
  5248. },
  5249. {
  5250. "type": "string",
  5251. "description": "name of the repo",
  5252. "name": "repo",
  5253. "in": "path",
  5254. "required": true
  5255. },
  5256. {
  5257. "type": "integer",
  5258. "format": "int64",
  5259. "description": "index of the issue",
  5260. "name": "index",
  5261. "in": "path",
  5262. "required": true
  5263. },
  5264. {
  5265. "type": "integer",
  5266. "format": "int64",
  5267. "description": "id of the label to remove",
  5268. "name": "id",
  5269. "in": "path",
  5270. "required": true
  5271. }
  5272. ],
  5273. "responses": {
  5274. "204": {
  5275. "$ref": "#/responses/empty"
  5276. },
  5277. "403": {
  5278. "$ref": "#/responses/forbidden"
  5279. },
  5280. "422": {
  5281. "$ref": "#/responses/validationError"
  5282. }
  5283. }
  5284. }
  5285. },
  5286. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  5287. "get": {
  5288. "consumes": [
  5289. "application/json"
  5290. ],
  5291. "produces": [
  5292. "application/json"
  5293. ],
  5294. "tags": [
  5295. "issue"
  5296. ],
  5297. "summary": "Get a list reactions of an issue",
  5298. "operationId": "issueGetIssueReactions",
  5299. "parameters": [
  5300. {
  5301. "type": "string",
  5302. "description": "owner of the repo",
  5303. "name": "owner",
  5304. "in": "path",
  5305. "required": true
  5306. },
  5307. {
  5308. "type": "string",
  5309. "description": "name of the repo",
  5310. "name": "repo",
  5311. "in": "path",
  5312. "required": true
  5313. },
  5314. {
  5315. "type": "integer",
  5316. "format": "int64",
  5317. "description": "index of the issue",
  5318. "name": "index",
  5319. "in": "path",
  5320. "required": true
  5321. },
  5322. {
  5323. "type": "integer",
  5324. "description": "page number of results to return (1-based)",
  5325. "name": "page",
  5326. "in": "query"
  5327. },
  5328. {
  5329. "type": "integer",
  5330. "description": "page size of results",
  5331. "name": "limit",
  5332. "in": "query"
  5333. }
  5334. ],
  5335. "responses": {
  5336. "200": {
  5337. "$ref": "#/responses/ReactionList"
  5338. },
  5339. "403": {
  5340. "$ref": "#/responses/forbidden"
  5341. }
  5342. }
  5343. },
  5344. "post": {
  5345. "consumes": [
  5346. "application/json"
  5347. ],
  5348. "produces": [
  5349. "application/json"
  5350. ],
  5351. "tags": [
  5352. "issue"
  5353. ],
  5354. "summary": "Add a reaction to an issue",
  5355. "operationId": "issuePostIssueReaction",
  5356. "parameters": [
  5357. {
  5358. "type": "string",
  5359. "description": "owner of the repo",
  5360. "name": "owner",
  5361. "in": "path",
  5362. "required": true
  5363. },
  5364. {
  5365. "type": "string",
  5366. "description": "name of the repo",
  5367. "name": "repo",
  5368. "in": "path",
  5369. "required": true
  5370. },
  5371. {
  5372. "type": "integer",
  5373. "format": "int64",
  5374. "description": "index of the issue",
  5375. "name": "index",
  5376. "in": "path",
  5377. "required": true
  5378. },
  5379. {
  5380. "name": "content",
  5381. "in": "body",
  5382. "schema": {
  5383. "$ref": "#/definitions/EditReactionOption"
  5384. }
  5385. }
  5386. ],
  5387. "responses": {
  5388. "200": {
  5389. "$ref": "#/responses/Reaction"
  5390. },
  5391. "201": {
  5392. "$ref": "#/responses/Reaction"
  5393. },
  5394. "403": {
  5395. "$ref": "#/responses/forbidden"
  5396. }
  5397. }
  5398. },
  5399. "delete": {
  5400. "consumes": [
  5401. "application/json"
  5402. ],
  5403. "produces": [
  5404. "application/json"
  5405. ],
  5406. "tags": [
  5407. "issue"
  5408. ],
  5409. "summary": "Remove a reaction from an issue",
  5410. "operationId": "issueDeleteIssueReaction",
  5411. "parameters": [
  5412. {
  5413. "type": "string",
  5414. "description": "owner of the repo",
  5415. "name": "owner",
  5416. "in": "path",
  5417. "required": true
  5418. },
  5419. {
  5420. "type": "string",
  5421. "description": "name of the repo",
  5422. "name": "repo",
  5423. "in": "path",
  5424. "required": true
  5425. },
  5426. {
  5427. "type": "integer",
  5428. "format": "int64",
  5429. "description": "index of the issue",
  5430. "name": "index",
  5431. "in": "path",
  5432. "required": true
  5433. },
  5434. {
  5435. "name": "content",
  5436. "in": "body",
  5437. "schema": {
  5438. "$ref": "#/definitions/EditReactionOption"
  5439. }
  5440. }
  5441. ],
  5442. "responses": {
  5443. "200": {
  5444. "$ref": "#/responses/empty"
  5445. },
  5446. "403": {
  5447. "$ref": "#/responses/forbidden"
  5448. }
  5449. }
  5450. }
  5451. },
  5452. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  5453. "delete": {
  5454. "consumes": [
  5455. "application/json"
  5456. ],
  5457. "produces": [
  5458. "application/json"
  5459. ],
  5460. "tags": [
  5461. "issue"
  5462. ],
  5463. "summary": "Delete an issue's existing stopwatch.",
  5464. "operationId": "issueDeleteStopWatch",
  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": "index of the issue to stop the stopwatch on",
  5484. "name": "index",
  5485. "in": "path",
  5486. "required": true
  5487. }
  5488. ],
  5489. "responses": {
  5490. "204": {
  5491. "$ref": "#/responses/empty"
  5492. },
  5493. "403": {
  5494. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5495. },
  5496. "404": {
  5497. "$ref": "#/responses/notFound"
  5498. },
  5499. "409": {
  5500. "description": "Cannot cancel a non existent stopwatch"
  5501. }
  5502. }
  5503. }
  5504. },
  5505. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  5506. "post": {
  5507. "consumes": [
  5508. "application/json"
  5509. ],
  5510. "produces": [
  5511. "application/json"
  5512. ],
  5513. "tags": [
  5514. "issue"
  5515. ],
  5516. "summary": "Start stopwatch on an issue.",
  5517. "operationId": "issueStartStopWatch",
  5518. "parameters": [
  5519. {
  5520. "type": "string",
  5521. "description": "owner of the repo",
  5522. "name": "owner",
  5523. "in": "path",
  5524. "required": true
  5525. },
  5526. {
  5527. "type": "string",
  5528. "description": "name of the repo",
  5529. "name": "repo",
  5530. "in": "path",
  5531. "required": true
  5532. },
  5533. {
  5534. "type": "integer",
  5535. "format": "int64",
  5536. "description": "index of the issue to create the stopwatch on",
  5537. "name": "index",
  5538. "in": "path",
  5539. "required": true
  5540. }
  5541. ],
  5542. "responses": {
  5543. "201": {
  5544. "$ref": "#/responses/empty"
  5545. },
  5546. "403": {
  5547. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5548. },
  5549. "404": {
  5550. "$ref": "#/responses/notFound"
  5551. },
  5552. "409": {
  5553. "description": "Cannot start a stopwatch again if it already exists"
  5554. }
  5555. }
  5556. }
  5557. },
  5558. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  5559. "post": {
  5560. "consumes": [
  5561. "application/json"
  5562. ],
  5563. "produces": [
  5564. "application/json"
  5565. ],
  5566. "tags": [
  5567. "issue"
  5568. ],
  5569. "summary": "Stop an issue's existing stopwatch.",
  5570. "operationId": "issueStopStopWatch",
  5571. "parameters": [
  5572. {
  5573. "type": "string",
  5574. "description": "owner of the repo",
  5575. "name": "owner",
  5576. "in": "path",
  5577. "required": true
  5578. },
  5579. {
  5580. "type": "string",
  5581. "description": "name of the repo",
  5582. "name": "repo",
  5583. "in": "path",
  5584. "required": true
  5585. },
  5586. {
  5587. "type": "integer",
  5588. "format": "int64",
  5589. "description": "index of the issue to stop the stopwatch on",
  5590. "name": "index",
  5591. "in": "path",
  5592. "required": true
  5593. }
  5594. ],
  5595. "responses": {
  5596. "201": {
  5597. "$ref": "#/responses/empty"
  5598. },
  5599. "403": {
  5600. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5601. },
  5602. "404": {
  5603. "$ref": "#/responses/notFound"
  5604. },
  5605. "409": {
  5606. "description": "Cannot stop a non existent stopwatch"
  5607. }
  5608. }
  5609. }
  5610. },
  5611. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  5612. "get": {
  5613. "consumes": [
  5614. "application/json"
  5615. ],
  5616. "produces": [
  5617. "application/json"
  5618. ],
  5619. "tags": [
  5620. "issue"
  5621. ],
  5622. "summary": "Get users who subscribed on an issue.",
  5623. "operationId": "issueSubscriptions",
  5624. "parameters": [
  5625. {
  5626. "type": "string",
  5627. "description": "owner of the repo",
  5628. "name": "owner",
  5629. "in": "path",
  5630. "required": true
  5631. },
  5632. {
  5633. "type": "string",
  5634. "description": "name of the repo",
  5635. "name": "repo",
  5636. "in": "path",
  5637. "required": true
  5638. },
  5639. {
  5640. "type": "integer",
  5641. "format": "int64",
  5642. "description": "index of the issue",
  5643. "name": "index",
  5644. "in": "path",
  5645. "required": true
  5646. },
  5647. {
  5648. "type": "integer",
  5649. "description": "page number of results to return (1-based)",
  5650. "name": "page",
  5651. "in": "query"
  5652. },
  5653. {
  5654. "type": "integer",
  5655. "description": "page size of results",
  5656. "name": "limit",
  5657. "in": "query"
  5658. }
  5659. ],
  5660. "responses": {
  5661. "200": {
  5662. "$ref": "#/responses/UserList"
  5663. },
  5664. "404": {
  5665. "$ref": "#/responses/notFound"
  5666. }
  5667. }
  5668. }
  5669. },
  5670. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  5671. "get": {
  5672. "consumes": [
  5673. "application/json"
  5674. ],
  5675. "produces": [
  5676. "application/json"
  5677. ],
  5678. "tags": [
  5679. "issue"
  5680. ],
  5681. "summary": "Check if user is subscribed to an issue",
  5682. "operationId": "issueCheckSubscription",
  5683. "parameters": [
  5684. {
  5685. "type": "string",
  5686. "description": "owner of the repo",
  5687. "name": "owner",
  5688. "in": "path",
  5689. "required": true
  5690. },
  5691. {
  5692. "type": "string",
  5693. "description": "name of the repo",
  5694. "name": "repo",
  5695. "in": "path",
  5696. "required": true
  5697. },
  5698. {
  5699. "type": "integer",
  5700. "format": "int64",
  5701. "description": "index of the issue",
  5702. "name": "index",
  5703. "in": "path",
  5704. "required": true
  5705. }
  5706. ],
  5707. "responses": {
  5708. "200": {
  5709. "$ref": "#/responses/WatchInfo"
  5710. },
  5711. "404": {
  5712. "$ref": "#/responses/notFound"
  5713. }
  5714. }
  5715. }
  5716. },
  5717. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  5718. "put": {
  5719. "consumes": [
  5720. "application/json"
  5721. ],
  5722. "produces": [
  5723. "application/json"
  5724. ],
  5725. "tags": [
  5726. "issue"
  5727. ],
  5728. "summary": "Subscribe user to issue",
  5729. "operationId": "issueAddSubscription",
  5730. "parameters": [
  5731. {
  5732. "type": "string",
  5733. "description": "owner of the repo",
  5734. "name": "owner",
  5735. "in": "path",
  5736. "required": true
  5737. },
  5738. {
  5739. "type": "string",
  5740. "description": "name of the repo",
  5741. "name": "repo",
  5742. "in": "path",
  5743. "required": true
  5744. },
  5745. {
  5746. "type": "integer",
  5747. "format": "int64",
  5748. "description": "index of the issue",
  5749. "name": "index",
  5750. "in": "path",
  5751. "required": true
  5752. },
  5753. {
  5754. "type": "string",
  5755. "description": "user to subscribe",
  5756. "name": "user",
  5757. "in": "path",
  5758. "required": true
  5759. }
  5760. ],
  5761. "responses": {
  5762. "200": {
  5763. "description": "Already subscribed"
  5764. },
  5765. "201": {
  5766. "description": "Successfully Subscribed"
  5767. },
  5768. "304": {
  5769. "description": "User can only subscribe itself if he is no admin"
  5770. },
  5771. "404": {
  5772. "$ref": "#/responses/notFound"
  5773. }
  5774. }
  5775. },
  5776. "delete": {
  5777. "consumes": [
  5778. "application/json"
  5779. ],
  5780. "produces": [
  5781. "application/json"
  5782. ],
  5783. "tags": [
  5784. "issue"
  5785. ],
  5786. "summary": "Unsubscribe user from issue",
  5787. "operationId": "issueDeleteSubscription",
  5788. "parameters": [
  5789. {
  5790. "type": "string",
  5791. "description": "owner of the repo",
  5792. "name": "owner",
  5793. "in": "path",
  5794. "required": true
  5795. },
  5796. {
  5797. "type": "string",
  5798. "description": "name of the repo",
  5799. "name": "repo",
  5800. "in": "path",
  5801. "required": true
  5802. },
  5803. {
  5804. "type": "integer",
  5805. "format": "int64",
  5806. "description": "index of the issue",
  5807. "name": "index",
  5808. "in": "path",
  5809. "required": true
  5810. },
  5811. {
  5812. "type": "string",
  5813. "description": "user witch unsubscribe",
  5814. "name": "user",
  5815. "in": "path",
  5816. "required": true
  5817. }
  5818. ],
  5819. "responses": {
  5820. "200": {
  5821. "description": "Already unsubscribed"
  5822. },
  5823. "201": {
  5824. "description": "Successfully Unsubscribed"
  5825. },
  5826. "304": {
  5827. "description": "User can only subscribe itself if he is no admin"
  5828. },
  5829. "404": {
  5830. "$ref": "#/responses/notFound"
  5831. }
  5832. }
  5833. }
  5834. },
  5835. "/repos/{owner}/{repo}/issues/{index}/times": {
  5836. "get": {
  5837. "produces": [
  5838. "application/json"
  5839. ],
  5840. "tags": [
  5841. "issue"
  5842. ],
  5843. "summary": "List an issue's tracked times",
  5844. "operationId": "issueTrackedTimes",
  5845. "parameters": [
  5846. {
  5847. "type": "string",
  5848. "description": "owner of the repo",
  5849. "name": "owner",
  5850. "in": "path",
  5851. "required": true
  5852. },
  5853. {
  5854. "type": "string",
  5855. "description": "name of the repo",
  5856. "name": "repo",
  5857. "in": "path",
  5858. "required": true
  5859. },
  5860. {
  5861. "type": "integer",
  5862. "format": "int64",
  5863. "description": "index of the issue",
  5864. "name": "index",
  5865. "in": "path",
  5866. "required": true
  5867. },
  5868. {
  5869. "type": "string",
  5870. "description": "optional filter by user (available for issue managers)",
  5871. "name": "user",
  5872. "in": "query"
  5873. },
  5874. {
  5875. "type": "string",
  5876. "format": "date-time",
  5877. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  5878. "name": "since",
  5879. "in": "query"
  5880. },
  5881. {
  5882. "type": "string",
  5883. "format": "date-time",
  5884. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  5885. "name": "before",
  5886. "in": "query"
  5887. },
  5888. {
  5889. "type": "integer",
  5890. "description": "page number of results to return (1-based)",
  5891. "name": "page",
  5892. "in": "query"
  5893. },
  5894. {
  5895. "type": "integer",
  5896. "description": "page size of results",
  5897. "name": "limit",
  5898. "in": "query"
  5899. }
  5900. ],
  5901. "responses": {
  5902. "200": {
  5903. "$ref": "#/responses/TrackedTimeList"
  5904. },
  5905. "404": {
  5906. "$ref": "#/responses/notFound"
  5907. }
  5908. }
  5909. },
  5910. "post": {
  5911. "consumes": [
  5912. "application/json"
  5913. ],
  5914. "produces": [
  5915. "application/json"
  5916. ],
  5917. "tags": [
  5918. "issue"
  5919. ],
  5920. "summary": "Add tracked time to a issue",
  5921. "operationId": "issueAddTime",
  5922. "parameters": [
  5923. {
  5924. "type": "string",
  5925. "description": "owner of the repo",
  5926. "name": "owner",
  5927. "in": "path",
  5928. "required": true
  5929. },
  5930. {
  5931. "type": "string",
  5932. "description": "name of the repo",
  5933. "name": "repo",
  5934. "in": "path",
  5935. "required": true
  5936. },
  5937. {
  5938. "type": "integer",
  5939. "format": "int64",
  5940. "description": "index of the issue",
  5941. "name": "index",
  5942. "in": "path",
  5943. "required": true
  5944. },
  5945. {
  5946. "name": "body",
  5947. "in": "body",
  5948. "schema": {
  5949. "$ref": "#/definitions/AddTimeOption"
  5950. }
  5951. }
  5952. ],
  5953. "responses": {
  5954. "200": {
  5955. "$ref": "#/responses/TrackedTime"
  5956. },
  5957. "400": {
  5958. "$ref": "#/responses/error"
  5959. },
  5960. "403": {
  5961. "$ref": "#/responses/forbidden"
  5962. }
  5963. }
  5964. },
  5965. "delete": {
  5966. "consumes": [
  5967. "application/json"
  5968. ],
  5969. "produces": [
  5970. "application/json"
  5971. ],
  5972. "tags": [
  5973. "issue"
  5974. ],
  5975. "summary": "Reset a tracked time of an issue",
  5976. "operationId": "issueResetTime",
  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 to add tracked time to",
  5996. "name": "index",
  5997. "in": "path",
  5998. "required": true
  5999. }
  6000. ],
  6001. "responses": {
  6002. "204": {
  6003. "$ref": "#/responses/empty"
  6004. },
  6005. "400": {
  6006. "$ref": "#/responses/error"
  6007. },
  6008. "403": {
  6009. "$ref": "#/responses/forbidden"
  6010. }
  6011. }
  6012. }
  6013. },
  6014. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  6015. "delete": {
  6016. "consumes": [
  6017. "application/json"
  6018. ],
  6019. "produces": [
  6020. "application/json"
  6021. ],
  6022. "tags": [
  6023. "issue"
  6024. ],
  6025. "summary": "Delete specific tracked time",
  6026. "operationId": "issueDeleteTime",
  6027. "parameters": [
  6028. {
  6029. "type": "string",
  6030. "description": "owner of the repo",
  6031. "name": "owner",
  6032. "in": "path",
  6033. "required": true
  6034. },
  6035. {
  6036. "type": "string",
  6037. "description": "name of the repo",
  6038. "name": "repo",
  6039. "in": "path",
  6040. "required": true
  6041. },
  6042. {
  6043. "type": "integer",
  6044. "format": "int64",
  6045. "description": "index of the issue",
  6046. "name": "index",
  6047. "in": "path",
  6048. "required": true
  6049. },
  6050. {
  6051. "type": "integer",
  6052. "format": "int64",
  6053. "description": "id of time to delete",
  6054. "name": "id",
  6055. "in": "path",
  6056. "required": true
  6057. }
  6058. ],
  6059. "responses": {
  6060. "204": {
  6061. "$ref": "#/responses/empty"
  6062. },
  6063. "400": {
  6064. "$ref": "#/responses/error"
  6065. },
  6066. "403": {
  6067. "$ref": "#/responses/forbidden"
  6068. }
  6069. }
  6070. }
  6071. },
  6072. "/repos/{owner}/{repo}/keys": {
  6073. "get": {
  6074. "produces": [
  6075. "application/json"
  6076. ],
  6077. "tags": [
  6078. "repository"
  6079. ],
  6080. "summary": "List a repository's keys",
  6081. "operationId": "repoListKeys",
  6082. "parameters": [
  6083. {
  6084. "type": "string",
  6085. "description": "owner of the repo",
  6086. "name": "owner",
  6087. "in": "path",
  6088. "required": true
  6089. },
  6090. {
  6091. "type": "string",
  6092. "description": "name of the repo",
  6093. "name": "repo",
  6094. "in": "path",
  6095. "required": true
  6096. },
  6097. {
  6098. "type": "integer",
  6099. "description": "the key_id to search for",
  6100. "name": "key_id",
  6101. "in": "query"
  6102. },
  6103. {
  6104. "type": "string",
  6105. "description": "fingerprint of the key",
  6106. "name": "fingerprint",
  6107. "in": "query"
  6108. },
  6109. {
  6110. "type": "integer",
  6111. "description": "page number of results to return (1-based)",
  6112. "name": "page",
  6113. "in": "query"
  6114. },
  6115. {
  6116. "type": "integer",
  6117. "description": "page size of results",
  6118. "name": "limit",
  6119. "in": "query"
  6120. }
  6121. ],
  6122. "responses": {
  6123. "200": {
  6124. "$ref": "#/responses/DeployKeyList"
  6125. }
  6126. }
  6127. },
  6128. "post": {
  6129. "consumes": [
  6130. "application/json"
  6131. ],
  6132. "produces": [
  6133. "application/json"
  6134. ],
  6135. "tags": [
  6136. "repository"
  6137. ],
  6138. "summary": "Add a key to a repository",
  6139. "operationId": "repoCreateKey",
  6140. "parameters": [
  6141. {
  6142. "type": "string",
  6143. "description": "owner of the repo",
  6144. "name": "owner",
  6145. "in": "path",
  6146. "required": true
  6147. },
  6148. {
  6149. "type": "string",
  6150. "description": "name of the repo",
  6151. "name": "repo",
  6152. "in": "path",
  6153. "required": true
  6154. },
  6155. {
  6156. "name": "body",
  6157. "in": "body",
  6158. "schema": {
  6159. "$ref": "#/definitions/CreateKeyOption"
  6160. }
  6161. }
  6162. ],
  6163. "responses": {
  6164. "201": {
  6165. "$ref": "#/responses/DeployKey"
  6166. },
  6167. "422": {
  6168. "$ref": "#/responses/validationError"
  6169. }
  6170. }
  6171. }
  6172. },
  6173. "/repos/{owner}/{repo}/keys/{id}": {
  6174. "get": {
  6175. "produces": [
  6176. "application/json"
  6177. ],
  6178. "tags": [
  6179. "repository"
  6180. ],
  6181. "summary": "Get a repository's key by id",
  6182. "operationId": "repoGetKey",
  6183. "parameters": [
  6184. {
  6185. "type": "string",
  6186. "description": "owner of the repo",
  6187. "name": "owner",
  6188. "in": "path",
  6189. "required": true
  6190. },
  6191. {
  6192. "type": "string",
  6193. "description": "name of the repo",
  6194. "name": "repo",
  6195. "in": "path",
  6196. "required": true
  6197. },
  6198. {
  6199. "type": "integer",
  6200. "format": "int64",
  6201. "description": "id of the key to get",
  6202. "name": "id",
  6203. "in": "path",
  6204. "required": true
  6205. }
  6206. ],
  6207. "responses": {
  6208. "200": {
  6209. "$ref": "#/responses/DeployKey"
  6210. }
  6211. }
  6212. },
  6213. "delete": {
  6214. "tags": [
  6215. "repository"
  6216. ],
  6217. "summary": "Delete a key from a repository",
  6218. "operationId": "repoDeleteKey",
  6219. "parameters": [
  6220. {
  6221. "type": "string",
  6222. "description": "owner of the repo",
  6223. "name": "owner",
  6224. "in": "path",
  6225. "required": true
  6226. },
  6227. {
  6228. "type": "string",
  6229. "description": "name of the repo",
  6230. "name": "repo",
  6231. "in": "path",
  6232. "required": true
  6233. },
  6234. {
  6235. "type": "integer",
  6236. "format": "int64",
  6237. "description": "id of the key to delete",
  6238. "name": "id",
  6239. "in": "path",
  6240. "required": true
  6241. }
  6242. ],
  6243. "responses": {
  6244. "204": {
  6245. "$ref": "#/responses/empty"
  6246. },
  6247. "403": {
  6248. "$ref": "#/responses/forbidden"
  6249. }
  6250. }
  6251. }
  6252. },
  6253. "/repos/{owner}/{repo}/labels": {
  6254. "get": {
  6255. "produces": [
  6256. "application/json"
  6257. ],
  6258. "tags": [
  6259. "issue"
  6260. ],
  6261. "summary": "Get all of a repository's labels",
  6262. "operationId": "issueListLabels",
  6263. "parameters": [
  6264. {
  6265. "type": "string",
  6266. "description": "owner of the repo",
  6267. "name": "owner",
  6268. "in": "path",
  6269. "required": true
  6270. },
  6271. {
  6272. "type": "string",
  6273. "description": "name of the repo",
  6274. "name": "repo",
  6275. "in": "path",
  6276. "required": true
  6277. },
  6278. {
  6279. "type": "integer",
  6280. "description": "page number of results to return (1-based)",
  6281. "name": "page",
  6282. "in": "query"
  6283. },
  6284. {
  6285. "type": "integer",
  6286. "description": "page size of results",
  6287. "name": "limit",
  6288. "in": "query"
  6289. }
  6290. ],
  6291. "responses": {
  6292. "200": {
  6293. "$ref": "#/responses/LabelList"
  6294. }
  6295. }
  6296. },
  6297. "post": {
  6298. "consumes": [
  6299. "application/json"
  6300. ],
  6301. "produces": [
  6302. "application/json"
  6303. ],
  6304. "tags": [
  6305. "issue"
  6306. ],
  6307. "summary": "Create a label",
  6308. "operationId": "issueCreateLabel",
  6309. "parameters": [
  6310. {
  6311. "type": "string",
  6312. "description": "owner of the repo",
  6313. "name": "owner",
  6314. "in": "path",
  6315. "required": true
  6316. },
  6317. {
  6318. "type": "string",
  6319. "description": "name of the repo",
  6320. "name": "repo",
  6321. "in": "path",
  6322. "required": true
  6323. },
  6324. {
  6325. "name": "body",
  6326. "in": "body",
  6327. "schema": {
  6328. "$ref": "#/definitions/CreateLabelOption"
  6329. }
  6330. }
  6331. ],
  6332. "responses": {
  6333. "201": {
  6334. "$ref": "#/responses/Label"
  6335. },
  6336. "422": {
  6337. "$ref": "#/responses/validationError"
  6338. }
  6339. }
  6340. }
  6341. },
  6342. "/repos/{owner}/{repo}/labels/{id}": {
  6343. "get": {
  6344. "produces": [
  6345. "application/json"
  6346. ],
  6347. "tags": [
  6348. "issue"
  6349. ],
  6350. "summary": "Get a single label",
  6351. "operationId": "issueGetLabel",
  6352. "parameters": [
  6353. {
  6354. "type": "string",
  6355. "description": "owner of the repo",
  6356. "name": "owner",
  6357. "in": "path",
  6358. "required": true
  6359. },
  6360. {
  6361. "type": "string",
  6362. "description": "name of the repo",
  6363. "name": "repo",
  6364. "in": "path",
  6365. "required": true
  6366. },
  6367. {
  6368. "type": "integer",
  6369. "format": "int64",
  6370. "description": "id of the label to get",
  6371. "name": "id",
  6372. "in": "path",
  6373. "required": true
  6374. }
  6375. ],
  6376. "responses": {
  6377. "200": {
  6378. "$ref": "#/responses/Label"
  6379. }
  6380. }
  6381. },
  6382. "delete": {
  6383. "tags": [
  6384. "issue"
  6385. ],
  6386. "summary": "Delete a label",
  6387. "operationId": "issueDeleteLabel",
  6388. "parameters": [
  6389. {
  6390. "type": "string",
  6391. "description": "owner of the repo",
  6392. "name": "owner",
  6393. "in": "path",
  6394. "required": true
  6395. },
  6396. {
  6397. "type": "string",
  6398. "description": "name of the repo",
  6399. "name": "repo",
  6400. "in": "path",
  6401. "required": true
  6402. },
  6403. {
  6404. "type": "integer",
  6405. "format": "int64",
  6406. "description": "id of the label to delete",
  6407. "name": "id",
  6408. "in": "path",
  6409. "required": true
  6410. }
  6411. ],
  6412. "responses": {
  6413. "204": {
  6414. "$ref": "#/responses/empty"
  6415. }
  6416. }
  6417. },
  6418. "patch": {
  6419. "consumes": [
  6420. "application/json"
  6421. ],
  6422. "produces": [
  6423. "application/json"
  6424. ],
  6425. "tags": [
  6426. "issue"
  6427. ],
  6428. "summary": "Update a label",
  6429. "operationId": "issueEditLabel",
  6430. "parameters": [
  6431. {
  6432. "type": "string",
  6433. "description": "owner of the repo",
  6434. "name": "owner",
  6435. "in": "path",
  6436. "required": true
  6437. },
  6438. {
  6439. "type": "string",
  6440. "description": "name of the repo",
  6441. "name": "repo",
  6442. "in": "path",
  6443. "required": true
  6444. },
  6445. {
  6446. "type": "integer",
  6447. "format": "int64",
  6448. "description": "id of the label to edit",
  6449. "name": "id",
  6450. "in": "path",
  6451. "required": true
  6452. },
  6453. {
  6454. "name": "body",
  6455. "in": "body",
  6456. "schema": {
  6457. "$ref": "#/definitions/EditLabelOption"
  6458. }
  6459. }
  6460. ],
  6461. "responses": {
  6462. "200": {
  6463. "$ref": "#/responses/Label"
  6464. },
  6465. "422": {
  6466. "$ref": "#/responses/validationError"
  6467. }
  6468. }
  6469. }
  6470. },
  6471. "/repos/{owner}/{repo}/languages": {
  6472. "get": {
  6473. "produces": [
  6474. "application/json"
  6475. ],
  6476. "tags": [
  6477. "repository"
  6478. ],
  6479. "summary": "Get languages and number of bytes of code written",
  6480. "operationId": "repoGetLanguages",
  6481. "parameters": [
  6482. {
  6483. "type": "string",
  6484. "description": "owner of the repo",
  6485. "name": "owner",
  6486. "in": "path",
  6487. "required": true
  6488. },
  6489. {
  6490. "type": "string",
  6491. "description": "name of the repo",
  6492. "name": "repo",
  6493. "in": "path",
  6494. "required": true
  6495. }
  6496. ],
  6497. "responses": {
  6498. "200": {
  6499. "$ref": "#/responses/LanguageStatistics"
  6500. },
  6501. "404": {
  6502. "$ref": "#/responses/notFound"
  6503. }
  6504. }
  6505. }
  6506. },
  6507. "/repos/{owner}/{repo}/milestones": {
  6508. "get": {
  6509. "produces": [
  6510. "application/json"
  6511. ],
  6512. "tags": [
  6513. "issue"
  6514. ],
  6515. "summary": "Get all of a repository's opened milestones",
  6516. "operationId": "issueGetMilestonesList",
  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": "string",
  6534. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  6535. "name": "state",
  6536. "in": "query"
  6537. },
  6538. {
  6539. "type": "string",
  6540. "description": "filter by milestone name",
  6541. "name": "name",
  6542. "in": "query"
  6543. },
  6544. {
  6545. "type": "integer",
  6546. "description": "page number of results to return (1-based)",
  6547. "name": "page",
  6548. "in": "query"
  6549. },
  6550. {
  6551. "type": "integer",
  6552. "description": "page size of results",
  6553. "name": "limit",
  6554. "in": "query"
  6555. }
  6556. ],
  6557. "responses": {
  6558. "200": {
  6559. "$ref": "#/responses/MilestoneList"
  6560. }
  6561. }
  6562. },
  6563. "post": {
  6564. "consumes": [
  6565. "application/json"
  6566. ],
  6567. "produces": [
  6568. "application/json"
  6569. ],
  6570. "tags": [
  6571. "issue"
  6572. ],
  6573. "summary": "Create a milestone",
  6574. "operationId": "issueCreateMilestone",
  6575. "parameters": [
  6576. {
  6577. "type": "string",
  6578. "description": "owner of the repo",
  6579. "name": "owner",
  6580. "in": "path",
  6581. "required": true
  6582. },
  6583. {
  6584. "type": "string",
  6585. "description": "name of the repo",
  6586. "name": "repo",
  6587. "in": "path",
  6588. "required": true
  6589. },
  6590. {
  6591. "name": "body",
  6592. "in": "body",
  6593. "schema": {
  6594. "$ref": "#/definitions/CreateMilestoneOption"
  6595. }
  6596. }
  6597. ],
  6598. "responses": {
  6599. "201": {
  6600. "$ref": "#/responses/Milestone"
  6601. }
  6602. }
  6603. }
  6604. },
  6605. "/repos/{owner}/{repo}/milestones/{id}": {
  6606. "get": {
  6607. "produces": [
  6608. "application/json"
  6609. ],
  6610. "tags": [
  6611. "issue"
  6612. ],
  6613. "summary": "Get a milestone",
  6614. "operationId": "issueGetMilestone",
  6615. "parameters": [
  6616. {
  6617. "type": "string",
  6618. "description": "owner of the repo",
  6619. "name": "owner",
  6620. "in": "path",
  6621. "required": true
  6622. },
  6623. {
  6624. "type": "string",
  6625. "description": "name of the repo",
  6626. "name": "repo",
  6627. "in": "path",
  6628. "required": true
  6629. },
  6630. {
  6631. "type": "string",
  6632. "description": "the milestone to get, identified by ID and if not available by name",
  6633. "name": "id",
  6634. "in": "path",
  6635. "required": true
  6636. }
  6637. ],
  6638. "responses": {
  6639. "200": {
  6640. "$ref": "#/responses/Milestone"
  6641. }
  6642. }
  6643. },
  6644. "delete": {
  6645. "tags": [
  6646. "issue"
  6647. ],
  6648. "summary": "Delete a milestone",
  6649. "operationId": "issueDeleteMilestone",
  6650. "parameters": [
  6651. {
  6652. "type": "string",
  6653. "description": "owner of the repo",
  6654. "name": "owner",
  6655. "in": "path",
  6656. "required": true
  6657. },
  6658. {
  6659. "type": "string",
  6660. "description": "name of the repo",
  6661. "name": "repo",
  6662. "in": "path",
  6663. "required": true
  6664. },
  6665. {
  6666. "type": "string",
  6667. "description": "the milestone to delete, identified by ID and if not available by name",
  6668. "name": "id",
  6669. "in": "path",
  6670. "required": true
  6671. }
  6672. ],
  6673. "responses": {
  6674. "204": {
  6675. "$ref": "#/responses/empty"
  6676. }
  6677. }
  6678. },
  6679. "patch": {
  6680. "consumes": [
  6681. "application/json"
  6682. ],
  6683. "produces": [
  6684. "application/json"
  6685. ],
  6686. "tags": [
  6687. "issue"
  6688. ],
  6689. "summary": "Update a milestone",
  6690. "operationId": "issueEditMilestone",
  6691. "parameters": [
  6692. {
  6693. "type": "string",
  6694. "description": "owner of the repo",
  6695. "name": "owner",
  6696. "in": "path",
  6697. "required": true
  6698. },
  6699. {
  6700. "type": "string",
  6701. "description": "name of the repo",
  6702. "name": "repo",
  6703. "in": "path",
  6704. "required": true
  6705. },
  6706. {
  6707. "type": "string",
  6708. "description": "the milestone to edit, identified by ID and if not available by name",
  6709. "name": "id",
  6710. "in": "path",
  6711. "required": true
  6712. },
  6713. {
  6714. "name": "body",
  6715. "in": "body",
  6716. "schema": {
  6717. "$ref": "#/definitions/EditMilestoneOption"
  6718. }
  6719. }
  6720. ],
  6721. "responses": {
  6722. "200": {
  6723. "$ref": "#/responses/Milestone"
  6724. }
  6725. }
  6726. }
  6727. },
  6728. "/repos/{owner}/{repo}/mirror-sync": {
  6729. "post": {
  6730. "produces": [
  6731. "application/json"
  6732. ],
  6733. "tags": [
  6734. "repository"
  6735. ],
  6736. "summary": "Sync a mirrored repository",
  6737. "operationId": "repoMirrorSync",
  6738. "parameters": [
  6739. {
  6740. "type": "string",
  6741. "description": "owner of the repo to sync",
  6742. "name": "owner",
  6743. "in": "path",
  6744. "required": true
  6745. },
  6746. {
  6747. "type": "string",
  6748. "description": "name of the repo to sync",
  6749. "name": "repo",
  6750. "in": "path",
  6751. "required": true
  6752. }
  6753. ],
  6754. "responses": {
  6755. "200": {
  6756. "$ref": "#/responses/empty"
  6757. },
  6758. "403": {
  6759. "$ref": "#/responses/forbidden"
  6760. }
  6761. }
  6762. }
  6763. },
  6764. "/repos/{owner}/{repo}/notifications": {
  6765. "get": {
  6766. "consumes": [
  6767. "application/json"
  6768. ],
  6769. "produces": [
  6770. "application/json"
  6771. ],
  6772. "tags": [
  6773. "notification"
  6774. ],
  6775. "summary": "List users's notification threads on a specific repo",
  6776. "operationId": "notifyGetRepoList",
  6777. "parameters": [
  6778. {
  6779. "type": "string",
  6780. "description": "owner of the repo",
  6781. "name": "owner",
  6782. "in": "path",
  6783. "required": true
  6784. },
  6785. {
  6786. "type": "string",
  6787. "description": "name of the repo",
  6788. "name": "repo",
  6789. "in": "path",
  6790. "required": true
  6791. },
  6792. {
  6793. "type": "string",
  6794. "description": "If true, show notifications marked as read. Default value is false",
  6795. "name": "all",
  6796. "in": "query"
  6797. },
  6798. {
  6799. "type": "array",
  6800. "items": {
  6801. "type": "string"
  6802. },
  6803. "collectionFormat": "multi",
  6804. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  6805. "name": "status-types",
  6806. "in": "query"
  6807. },
  6808. {
  6809. "type": "string",
  6810. "format": "date-time",
  6811. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  6812. "name": "since",
  6813. "in": "query"
  6814. },
  6815. {
  6816. "type": "string",
  6817. "format": "date-time",
  6818. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  6819. "name": "before",
  6820. "in": "query"
  6821. },
  6822. {
  6823. "type": "integer",
  6824. "description": "page number of results to return (1-based)",
  6825. "name": "page",
  6826. "in": "query"
  6827. },
  6828. {
  6829. "type": "integer",
  6830. "description": "page size of results",
  6831. "name": "limit",
  6832. "in": "query"
  6833. }
  6834. ],
  6835. "responses": {
  6836. "200": {
  6837. "$ref": "#/responses/NotificationThreadList"
  6838. }
  6839. }
  6840. },
  6841. "put": {
  6842. "consumes": [
  6843. "application/json"
  6844. ],
  6845. "produces": [
  6846. "application/json"
  6847. ],
  6848. "tags": [
  6849. "notification"
  6850. ],
  6851. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  6852. "operationId": "notifyReadRepoList",
  6853. "parameters": [
  6854. {
  6855. "type": "string",
  6856. "description": "owner of the repo",
  6857. "name": "owner",
  6858. "in": "path",
  6859. "required": true
  6860. },
  6861. {
  6862. "type": "string",
  6863. "description": "name of the repo",
  6864. "name": "repo",
  6865. "in": "path",
  6866. "required": true
  6867. },
  6868. {
  6869. "type": "string",
  6870. "description": "If true, mark all notifications on this repo. Default value is false",
  6871. "name": "all",
  6872. "in": "query"
  6873. },
  6874. {
  6875. "type": "array",
  6876. "items": {
  6877. "type": "string"
  6878. },
  6879. "collectionFormat": "multi",
  6880. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  6881. "name": "status-types",
  6882. "in": "query"
  6883. },
  6884. {
  6885. "type": "string",
  6886. "description": "Status to mark notifications as. Defaults to read.",
  6887. "name": "to-status",
  6888. "in": "query"
  6889. },
  6890. {
  6891. "type": "string",
  6892. "format": "date-time",
  6893. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  6894. "name": "last_read_at",
  6895. "in": "query"
  6896. }
  6897. ],
  6898. "responses": {
  6899. "205": {
  6900. "$ref": "#/responses/empty"
  6901. }
  6902. }
  6903. }
  6904. },
  6905. "/repos/{owner}/{repo}/pulls": {
  6906. "get": {
  6907. "produces": [
  6908. "application/json"
  6909. ],
  6910. "tags": [
  6911. "repository"
  6912. ],
  6913. "summary": "List a repo's pull requests",
  6914. "operationId": "repoListPullRequests",
  6915. "parameters": [
  6916. {
  6917. "type": "string",
  6918. "description": "owner of the repo",
  6919. "name": "owner",
  6920. "in": "path",
  6921. "required": true
  6922. },
  6923. {
  6924. "type": "string",
  6925. "description": "name of the repo",
  6926. "name": "repo",
  6927. "in": "path",
  6928. "required": true
  6929. },
  6930. {
  6931. "enum": [
  6932. "closed",
  6933. "open",
  6934. "all"
  6935. ],
  6936. "type": "string",
  6937. "description": "State of pull request: open or closed (optional)",
  6938. "name": "state",
  6939. "in": "query"
  6940. },
  6941. {
  6942. "enum": [
  6943. "oldest",
  6944. "recentupdate",
  6945. "leastupdate",
  6946. "mostcomment",
  6947. "leastcomment",
  6948. "priority"
  6949. ],
  6950. "type": "string",
  6951. "description": "Type of sort",
  6952. "name": "sort",
  6953. "in": "query"
  6954. },
  6955. {
  6956. "type": "integer",
  6957. "format": "int64",
  6958. "description": "ID of the milestone",
  6959. "name": "milestone",
  6960. "in": "query"
  6961. },
  6962. {
  6963. "type": "array",
  6964. "items": {
  6965. "type": "integer",
  6966. "format": "int64"
  6967. },
  6968. "collectionFormat": "multi",
  6969. "description": "Label IDs",
  6970. "name": "labels",
  6971. "in": "query"
  6972. },
  6973. {
  6974. "type": "integer",
  6975. "description": "page number of results to return (1-based)",
  6976. "name": "page",
  6977. "in": "query"
  6978. },
  6979. {
  6980. "type": "integer",
  6981. "description": "page size of results",
  6982. "name": "limit",
  6983. "in": "query"
  6984. }
  6985. ],
  6986. "responses": {
  6987. "200": {
  6988. "$ref": "#/responses/PullRequestList"
  6989. }
  6990. }
  6991. },
  6992. "post": {
  6993. "consumes": [
  6994. "application/json"
  6995. ],
  6996. "produces": [
  6997. "application/json"
  6998. ],
  6999. "tags": [
  7000. "repository"
  7001. ],
  7002. "summary": "Create a pull request",
  7003. "operationId": "repoCreatePullRequest",
  7004. "parameters": [
  7005. {
  7006. "type": "string",
  7007. "description": "owner of the repo",
  7008. "name": "owner",
  7009. "in": "path",
  7010. "required": true
  7011. },
  7012. {
  7013. "type": "string",
  7014. "description": "name of the repo",
  7015. "name": "repo",
  7016. "in": "path",
  7017. "required": true
  7018. },
  7019. {
  7020. "name": "body",
  7021. "in": "body",
  7022. "schema": {
  7023. "$ref": "#/definitions/CreatePullRequestOption"
  7024. }
  7025. }
  7026. ],
  7027. "responses": {
  7028. "201": {
  7029. "$ref": "#/responses/PullRequest"
  7030. },
  7031. "409": {
  7032. "$ref": "#/responses/error"
  7033. },
  7034. "422": {
  7035. "$ref": "#/responses/validationError"
  7036. }
  7037. }
  7038. }
  7039. },
  7040. "/repos/{owner}/{repo}/pulls/{index}": {
  7041. "get": {
  7042. "produces": [
  7043. "application/json"
  7044. ],
  7045. "tags": [
  7046. "repository"
  7047. ],
  7048. "summary": "Get a pull request",
  7049. "operationId": "repoGetPullRequest",
  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 pull request to get",
  7069. "name": "index",
  7070. "in": "path",
  7071. "required": true
  7072. }
  7073. ],
  7074. "responses": {
  7075. "200": {
  7076. "$ref": "#/responses/PullRequest"
  7077. },
  7078. "404": {
  7079. "$ref": "#/responses/notFound"
  7080. }
  7081. }
  7082. },
  7083. "patch": {
  7084. "consumes": [
  7085. "application/json"
  7086. ],
  7087. "produces": [
  7088. "application/json"
  7089. ],
  7090. "tags": [
  7091. "repository"
  7092. ],
  7093. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  7094. "operationId": "repoEditPullRequest",
  7095. "parameters": [
  7096. {
  7097. "type": "string",
  7098. "description": "owner of the repo",
  7099. "name": "owner",
  7100. "in": "path",
  7101. "required": true
  7102. },
  7103. {
  7104. "type": "string",
  7105. "description": "name of the repo",
  7106. "name": "repo",
  7107. "in": "path",
  7108. "required": true
  7109. },
  7110. {
  7111. "type": "integer",
  7112. "format": "int64",
  7113. "description": "index of the pull request to edit",
  7114. "name": "index",
  7115. "in": "path",
  7116. "required": true
  7117. },
  7118. {
  7119. "name": "body",
  7120. "in": "body",
  7121. "schema": {
  7122. "$ref": "#/definitions/EditPullRequestOption"
  7123. }
  7124. }
  7125. ],
  7126. "responses": {
  7127. "201": {
  7128. "$ref": "#/responses/PullRequest"
  7129. },
  7130. "403": {
  7131. "$ref": "#/responses/forbidden"
  7132. },
  7133. "409": {
  7134. "$ref": "#/responses/error"
  7135. },
  7136. "412": {
  7137. "$ref": "#/responses/error"
  7138. },
  7139. "422": {
  7140. "$ref": "#/responses/validationError"
  7141. }
  7142. }
  7143. }
  7144. },
  7145. "/repos/{owner}/{repo}/pulls/{index}.diff": {
  7146. "get": {
  7147. "produces": [
  7148. "text/plain"
  7149. ],
  7150. "tags": [
  7151. "repository"
  7152. ],
  7153. "summary": "Get a pull request diff",
  7154. "operationId": "repoDownloadPullDiff",
  7155. "parameters": [
  7156. {
  7157. "type": "string",
  7158. "description": "owner of the repo",
  7159. "name": "owner",
  7160. "in": "path",
  7161. "required": true
  7162. },
  7163. {
  7164. "type": "string",
  7165. "description": "name of the repo",
  7166. "name": "repo",
  7167. "in": "path",
  7168. "required": true
  7169. },
  7170. {
  7171. "type": "integer",
  7172. "format": "int64",
  7173. "description": "index of the pull request to get",
  7174. "name": "index",
  7175. "in": "path",
  7176. "required": true
  7177. }
  7178. ],
  7179. "responses": {
  7180. "200": {
  7181. "$ref": "#/responses/string"
  7182. },
  7183. "404": {
  7184. "$ref": "#/responses/notFound"
  7185. }
  7186. }
  7187. }
  7188. },
  7189. "/repos/{owner}/{repo}/pulls/{index}.patch": {
  7190. "get": {
  7191. "produces": [
  7192. "text/plain"
  7193. ],
  7194. "tags": [
  7195. "repository"
  7196. ],
  7197. "summary": "Get a pull request patch file",
  7198. "operationId": "repoDownloadPullPatch",
  7199. "parameters": [
  7200. {
  7201. "type": "string",
  7202. "description": "owner of the repo",
  7203. "name": "owner",
  7204. "in": "path",
  7205. "required": true
  7206. },
  7207. {
  7208. "type": "string",
  7209. "description": "name of the repo",
  7210. "name": "repo",
  7211. "in": "path",
  7212. "required": true
  7213. },
  7214. {
  7215. "type": "integer",
  7216. "format": "int64",
  7217. "description": "index of the pull request to get",
  7218. "name": "index",
  7219. "in": "path",
  7220. "required": true
  7221. }
  7222. ],
  7223. "responses": {
  7224. "200": {
  7225. "$ref": "#/responses/string"
  7226. },
  7227. "404": {
  7228. "$ref": "#/responses/notFound"
  7229. }
  7230. }
  7231. }
  7232. },
  7233. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  7234. "get": {
  7235. "produces": [
  7236. "application/json"
  7237. ],
  7238. "tags": [
  7239. "repository"
  7240. ],
  7241. "summary": "Check if a pull request has been merged",
  7242. "operationId": "repoPullRequestIsMerged",
  7243. "parameters": [
  7244. {
  7245. "type": "string",
  7246. "description": "owner of the repo",
  7247. "name": "owner",
  7248. "in": "path",
  7249. "required": true
  7250. },
  7251. {
  7252. "type": "string",
  7253. "description": "name of the repo",
  7254. "name": "repo",
  7255. "in": "path",
  7256. "required": true
  7257. },
  7258. {
  7259. "type": "integer",
  7260. "format": "int64",
  7261. "description": "index of the pull request",
  7262. "name": "index",
  7263. "in": "path",
  7264. "required": true
  7265. }
  7266. ],
  7267. "responses": {
  7268. "204": {
  7269. "description": "pull request has been merged"
  7270. },
  7271. "404": {
  7272. "description": "pull request has not been merged"
  7273. }
  7274. }
  7275. },
  7276. "post": {
  7277. "produces": [
  7278. "application/json"
  7279. ],
  7280. "tags": [
  7281. "repository"
  7282. ],
  7283. "summary": "Merge a pull request",
  7284. "operationId": "repoMergePullRequest",
  7285. "parameters": [
  7286. {
  7287. "type": "string",
  7288. "description": "owner of the repo",
  7289. "name": "owner",
  7290. "in": "path",
  7291. "required": true
  7292. },
  7293. {
  7294. "type": "string",
  7295. "description": "name of the repo",
  7296. "name": "repo",
  7297. "in": "path",
  7298. "required": true
  7299. },
  7300. {
  7301. "type": "integer",
  7302. "format": "int64",
  7303. "description": "index of the pull request to merge",
  7304. "name": "index",
  7305. "in": "path",
  7306. "required": true
  7307. },
  7308. {
  7309. "name": "body",
  7310. "in": "body",
  7311. "schema": {
  7312. "$ref": "#/definitions/MergePullRequestOption"
  7313. }
  7314. }
  7315. ],
  7316. "responses": {
  7317. "200": {
  7318. "$ref": "#/responses/empty"
  7319. },
  7320. "405": {
  7321. "$ref": "#/responses/empty"
  7322. },
  7323. "409": {
  7324. "$ref": "#/responses/error"
  7325. }
  7326. }
  7327. }
  7328. },
  7329. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  7330. "post": {
  7331. "produces": [
  7332. "application/json"
  7333. ],
  7334. "tags": [
  7335. "repository"
  7336. ],
  7337. "summary": "create review requests for a pull request",
  7338. "operationId": "repoCreatePullReviewRequests",
  7339. "parameters": [
  7340. {
  7341. "type": "string",
  7342. "description": "owner of the repo",
  7343. "name": "owner",
  7344. "in": "path",
  7345. "required": true
  7346. },
  7347. {
  7348. "type": "string",
  7349. "description": "name of the repo",
  7350. "name": "repo",
  7351. "in": "path",
  7352. "required": true
  7353. },
  7354. {
  7355. "type": "integer",
  7356. "format": "int64",
  7357. "description": "index of the pull request",
  7358. "name": "index",
  7359. "in": "path",
  7360. "required": true
  7361. },
  7362. {
  7363. "name": "body",
  7364. "in": "body",
  7365. "required": true,
  7366. "schema": {
  7367. "$ref": "#/definitions/PullReviewRequestOptions"
  7368. }
  7369. }
  7370. ],
  7371. "responses": {
  7372. "201": {
  7373. "$ref": "#/responses/PullReviewList"
  7374. },
  7375. "404": {
  7376. "$ref": "#/responses/notFound"
  7377. },
  7378. "422": {
  7379. "$ref": "#/responses/validationError"
  7380. }
  7381. }
  7382. },
  7383. "delete": {
  7384. "produces": [
  7385. "application/json"
  7386. ],
  7387. "tags": [
  7388. "repository"
  7389. ],
  7390. "summary": "cancel review requests for a pull request",
  7391. "operationId": "repoDeletePullReviewRequests",
  7392. "parameters": [
  7393. {
  7394. "type": "string",
  7395. "description": "owner of the repo",
  7396. "name": "owner",
  7397. "in": "path",
  7398. "required": true
  7399. },
  7400. {
  7401. "type": "string",
  7402. "description": "name of the repo",
  7403. "name": "repo",
  7404. "in": "path",
  7405. "required": true
  7406. },
  7407. {
  7408. "type": "integer",
  7409. "format": "int64",
  7410. "description": "index of the pull request",
  7411. "name": "index",
  7412. "in": "path",
  7413. "required": true
  7414. },
  7415. {
  7416. "name": "body",
  7417. "in": "body",
  7418. "required": true,
  7419. "schema": {
  7420. "$ref": "#/definitions/PullReviewRequestOptions"
  7421. }
  7422. }
  7423. ],
  7424. "responses": {
  7425. "204": {
  7426. "$ref": "#/responses/empty"
  7427. },
  7428. "404": {
  7429. "$ref": "#/responses/notFound"
  7430. },
  7431. "422": {
  7432. "$ref": "#/responses/validationError"
  7433. }
  7434. }
  7435. }
  7436. },
  7437. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  7438. "get": {
  7439. "produces": [
  7440. "application/json"
  7441. ],
  7442. "tags": [
  7443. "repository"
  7444. ],
  7445. "summary": "List all reviews for a pull request",
  7446. "operationId": "repoListPullReviews",
  7447. "parameters": [
  7448. {
  7449. "type": "string",
  7450. "description": "owner of the repo",
  7451. "name": "owner",
  7452. "in": "path",
  7453. "required": true
  7454. },
  7455. {
  7456. "type": "string",
  7457. "description": "name of the repo",
  7458. "name": "repo",
  7459. "in": "path",
  7460. "required": true
  7461. },
  7462. {
  7463. "type": "integer",
  7464. "format": "int64",
  7465. "description": "index of the pull request",
  7466. "name": "index",
  7467. "in": "path",
  7468. "required": true
  7469. },
  7470. {
  7471. "type": "integer",
  7472. "description": "page number of results to return (1-based)",
  7473. "name": "page",
  7474. "in": "query"
  7475. },
  7476. {
  7477. "type": "integer",
  7478. "description": "page size of results",
  7479. "name": "limit",
  7480. "in": "query"
  7481. }
  7482. ],
  7483. "responses": {
  7484. "200": {
  7485. "$ref": "#/responses/PullReviewList"
  7486. },
  7487. "404": {
  7488. "$ref": "#/responses/notFound"
  7489. }
  7490. }
  7491. },
  7492. "post": {
  7493. "produces": [
  7494. "application/json"
  7495. ],
  7496. "tags": [
  7497. "repository"
  7498. ],
  7499. "summary": "Create a review to an pull request",
  7500. "operationId": "repoCreatePullReview",
  7501. "parameters": [
  7502. {
  7503. "type": "string",
  7504. "description": "owner of the repo",
  7505. "name": "owner",
  7506. "in": "path",
  7507. "required": true
  7508. },
  7509. {
  7510. "type": "string",
  7511. "description": "name of the repo",
  7512. "name": "repo",
  7513. "in": "path",
  7514. "required": true
  7515. },
  7516. {
  7517. "type": "integer",
  7518. "format": "int64",
  7519. "description": "index of the pull request",
  7520. "name": "index",
  7521. "in": "path",
  7522. "required": true
  7523. },
  7524. {
  7525. "name": "body",
  7526. "in": "body",
  7527. "required": true,
  7528. "schema": {
  7529. "$ref": "#/definitions/CreatePullReviewOptions"
  7530. }
  7531. }
  7532. ],
  7533. "responses": {
  7534. "200": {
  7535. "$ref": "#/responses/PullReview"
  7536. },
  7537. "404": {
  7538. "$ref": "#/responses/notFound"
  7539. },
  7540. "422": {
  7541. "$ref": "#/responses/validationError"
  7542. }
  7543. }
  7544. }
  7545. },
  7546. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  7547. "get": {
  7548. "produces": [
  7549. "application/json"
  7550. ],
  7551. "tags": [
  7552. "repository"
  7553. ],
  7554. "summary": "Get a specific review for a pull request",
  7555. "operationId": "repoGetPullReview",
  7556. "parameters": [
  7557. {
  7558. "type": "string",
  7559. "description": "owner of the repo",
  7560. "name": "owner",
  7561. "in": "path",
  7562. "required": true
  7563. },
  7564. {
  7565. "type": "string",
  7566. "description": "name of the repo",
  7567. "name": "repo",
  7568. "in": "path",
  7569. "required": true
  7570. },
  7571. {
  7572. "type": "integer",
  7573. "format": "int64",
  7574. "description": "index of the pull request",
  7575. "name": "index",
  7576. "in": "path",
  7577. "required": true
  7578. },
  7579. {
  7580. "type": "integer",
  7581. "format": "int64",
  7582. "description": "id of the review",
  7583. "name": "id",
  7584. "in": "path",
  7585. "required": true
  7586. }
  7587. ],
  7588. "responses": {
  7589. "200": {
  7590. "$ref": "#/responses/PullReview"
  7591. },
  7592. "404": {
  7593. "$ref": "#/responses/notFound"
  7594. }
  7595. }
  7596. },
  7597. "post": {
  7598. "produces": [
  7599. "application/json"
  7600. ],
  7601. "tags": [
  7602. "repository"
  7603. ],
  7604. "summary": "Submit a pending review to an pull request",
  7605. "operationId": "repoSubmitPullReview",
  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": "index of the pull request",
  7625. "name": "index",
  7626. "in": "path",
  7627. "required": true
  7628. },
  7629. {
  7630. "type": "integer",
  7631. "format": "int64",
  7632. "description": "id of the review",
  7633. "name": "id",
  7634. "in": "path",
  7635. "required": true
  7636. },
  7637. {
  7638. "name": "body",
  7639. "in": "body",
  7640. "required": true,
  7641. "schema": {
  7642. "$ref": "#/definitions/SubmitPullReviewOptions"
  7643. }
  7644. }
  7645. ],
  7646. "responses": {
  7647. "200": {
  7648. "$ref": "#/responses/PullReview"
  7649. },
  7650. "404": {
  7651. "$ref": "#/responses/notFound"
  7652. },
  7653. "422": {
  7654. "$ref": "#/responses/validationError"
  7655. }
  7656. }
  7657. },
  7658. "delete": {
  7659. "produces": [
  7660. "application/json"
  7661. ],
  7662. "tags": [
  7663. "repository"
  7664. ],
  7665. "summary": "Delete a specific review from a pull request",
  7666. "operationId": "repoDeletePullReview",
  7667. "parameters": [
  7668. {
  7669. "type": "string",
  7670. "description": "owner of the repo",
  7671. "name": "owner",
  7672. "in": "path",
  7673. "required": true
  7674. },
  7675. {
  7676. "type": "string",
  7677. "description": "name of the repo",
  7678. "name": "repo",
  7679. "in": "path",
  7680. "required": true
  7681. },
  7682. {
  7683. "type": "integer",
  7684. "format": "int64",
  7685. "description": "index of the pull request",
  7686. "name": "index",
  7687. "in": "path",
  7688. "required": true
  7689. },
  7690. {
  7691. "type": "integer",
  7692. "format": "int64",
  7693. "description": "id of the review",
  7694. "name": "id",
  7695. "in": "path",
  7696. "required": true
  7697. }
  7698. ],
  7699. "responses": {
  7700. "204": {
  7701. "$ref": "#/responses/empty"
  7702. },
  7703. "403": {
  7704. "$ref": "#/responses/forbidden"
  7705. },
  7706. "404": {
  7707. "$ref": "#/responses/notFound"
  7708. }
  7709. }
  7710. }
  7711. },
  7712. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  7713. "get": {
  7714. "produces": [
  7715. "application/json"
  7716. ],
  7717. "tags": [
  7718. "repository"
  7719. ],
  7720. "summary": "Get a specific review for a pull request",
  7721. "operationId": "repoGetPullReviewComments",
  7722. "parameters": [
  7723. {
  7724. "type": "string",
  7725. "description": "owner of the repo",
  7726. "name": "owner",
  7727. "in": "path",
  7728. "required": true
  7729. },
  7730. {
  7731. "type": "string",
  7732. "description": "name of the repo",
  7733. "name": "repo",
  7734. "in": "path",
  7735. "required": true
  7736. },
  7737. {
  7738. "type": "integer",
  7739. "format": "int64",
  7740. "description": "index of the pull request",
  7741. "name": "index",
  7742. "in": "path",
  7743. "required": true
  7744. },
  7745. {
  7746. "type": "integer",
  7747. "format": "int64",
  7748. "description": "id of the review",
  7749. "name": "id",
  7750. "in": "path",
  7751. "required": true
  7752. }
  7753. ],
  7754. "responses": {
  7755. "200": {
  7756. "$ref": "#/responses/PullReviewCommentList"
  7757. },
  7758. "404": {
  7759. "$ref": "#/responses/notFound"
  7760. }
  7761. }
  7762. }
  7763. },
  7764. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  7765. "post": {
  7766. "produces": [
  7767. "application/json"
  7768. ],
  7769. "tags": [
  7770. "repository"
  7771. ],
  7772. "summary": "Dismiss a review for a pull request",
  7773. "operationId": "repoDismissPullReview",
  7774. "parameters": [
  7775. {
  7776. "type": "string",
  7777. "description": "owner of the repo",
  7778. "name": "owner",
  7779. "in": "path",
  7780. "required": true
  7781. },
  7782. {
  7783. "type": "string",
  7784. "description": "name of the repo",
  7785. "name": "repo",
  7786. "in": "path",
  7787. "required": true
  7788. },
  7789. {
  7790. "type": "integer",
  7791. "format": "int64",
  7792. "description": "index of the pull request",
  7793. "name": "index",
  7794. "in": "path",
  7795. "required": true
  7796. },
  7797. {
  7798. "type": "integer",
  7799. "format": "int64",
  7800. "description": "id of the review",
  7801. "name": "id",
  7802. "in": "path",
  7803. "required": true
  7804. },
  7805. {
  7806. "name": "body",
  7807. "in": "body",
  7808. "required": true,
  7809. "schema": {
  7810. "$ref": "#/definitions/DismissPullReviewOptions"
  7811. }
  7812. }
  7813. ],
  7814. "responses": {
  7815. "200": {
  7816. "$ref": "#/responses/PullReview"
  7817. },
  7818. "403": {
  7819. "$ref": "#/responses/forbidden"
  7820. },
  7821. "422": {
  7822. "$ref": "#/responses/validationError"
  7823. }
  7824. }
  7825. }
  7826. },
  7827. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  7828. "post": {
  7829. "produces": [
  7830. "application/json"
  7831. ],
  7832. "tags": [
  7833. "repository"
  7834. ],
  7835. "summary": "Cancel to dismiss a review for a pull request",
  7836. "operationId": "repoUnDismissPullReview",
  7837. "parameters": [
  7838. {
  7839. "type": "string",
  7840. "description": "owner of the repo",
  7841. "name": "owner",
  7842. "in": "path",
  7843. "required": true
  7844. },
  7845. {
  7846. "type": "string",
  7847. "description": "name of the repo",
  7848. "name": "repo",
  7849. "in": "path",
  7850. "required": true
  7851. },
  7852. {
  7853. "type": "integer",
  7854. "format": "int64",
  7855. "description": "index of the pull request",
  7856. "name": "index",
  7857. "in": "path",
  7858. "required": true
  7859. },
  7860. {
  7861. "type": "integer",
  7862. "format": "int64",
  7863. "description": "id of the review",
  7864. "name": "id",
  7865. "in": "path",
  7866. "required": true
  7867. }
  7868. ],
  7869. "responses": {
  7870. "200": {
  7871. "$ref": "#/responses/PullReview"
  7872. },
  7873. "403": {
  7874. "$ref": "#/responses/forbidden"
  7875. },
  7876. "422": {
  7877. "$ref": "#/responses/validationError"
  7878. }
  7879. }
  7880. }
  7881. },
  7882. "/repos/{owner}/{repo}/pulls/{index}/update": {
  7883. "post": {
  7884. "produces": [
  7885. "application/json"
  7886. ],
  7887. "tags": [
  7888. "repository"
  7889. ],
  7890. "summary": "Merge PR's baseBranch into headBranch",
  7891. "operationId": "repoUpdatePullRequest",
  7892. "parameters": [
  7893. {
  7894. "type": "string",
  7895. "description": "owner of the repo",
  7896. "name": "owner",
  7897. "in": "path",
  7898. "required": true
  7899. },
  7900. {
  7901. "type": "string",
  7902. "description": "name of the repo",
  7903. "name": "repo",
  7904. "in": "path",
  7905. "required": true
  7906. },
  7907. {
  7908. "type": "integer",
  7909. "format": "int64",
  7910. "description": "index of the pull request to get",
  7911. "name": "index",
  7912. "in": "path",
  7913. "required": true
  7914. }
  7915. ],
  7916. "responses": {
  7917. "200": {
  7918. "$ref": "#/responses/empty"
  7919. },
  7920. "403": {
  7921. "$ref": "#/responses/forbidden"
  7922. },
  7923. "404": {
  7924. "$ref": "#/responses/notFound"
  7925. },
  7926. "409": {
  7927. "$ref": "#/responses/error"
  7928. },
  7929. "422": {
  7930. "$ref": "#/responses/validationError"
  7931. }
  7932. }
  7933. }
  7934. },
  7935. "/repos/{owner}/{repo}/raw/{filepath}": {
  7936. "get": {
  7937. "produces": [
  7938. "application/json"
  7939. ],
  7940. "tags": [
  7941. "repository"
  7942. ],
  7943. "summary": "Get a file from a repository",
  7944. "operationId": "repoGetRawFile",
  7945. "parameters": [
  7946. {
  7947. "type": "string",
  7948. "description": "owner of the repo",
  7949. "name": "owner",
  7950. "in": "path",
  7951. "required": true
  7952. },
  7953. {
  7954. "type": "string",
  7955. "description": "name of the repo",
  7956. "name": "repo",
  7957. "in": "path",
  7958. "required": true
  7959. },
  7960. {
  7961. "type": "string",
  7962. "description": "filepath of the file to get",
  7963. "name": "filepath",
  7964. "in": "path",
  7965. "required": true
  7966. },
  7967. {
  7968. "type": "string",
  7969. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  7970. "name": "ref",
  7971. "in": "query"
  7972. }
  7973. ],
  7974. "responses": {
  7975. "200": {
  7976. "description": "success"
  7977. },
  7978. "404": {
  7979. "$ref": "#/responses/notFound"
  7980. }
  7981. }
  7982. }
  7983. },
  7984. "/repos/{owner}/{repo}/releases": {
  7985. "get": {
  7986. "produces": [
  7987. "application/json"
  7988. ],
  7989. "tags": [
  7990. "repository"
  7991. ],
  7992. "summary": "List a repo's releases",
  7993. "operationId": "repoListReleases",
  7994. "parameters": [
  7995. {
  7996. "type": "string",
  7997. "description": "owner of the repo",
  7998. "name": "owner",
  7999. "in": "path",
  8000. "required": true
  8001. },
  8002. {
  8003. "type": "string",
  8004. "description": "name of the repo",
  8005. "name": "repo",
  8006. "in": "path",
  8007. "required": true
  8008. },
  8009. {
  8010. "type": "integer",
  8011. "description": "page size of results, deprecated - use limit",
  8012. "name": "per_page",
  8013. "in": "query"
  8014. },
  8015. {
  8016. "type": "integer",
  8017. "description": "page number of results to return (1-based)",
  8018. "name": "page",
  8019. "in": "query"
  8020. },
  8021. {
  8022. "type": "integer",
  8023. "description": "page size of results",
  8024. "name": "limit",
  8025. "in": "query"
  8026. }
  8027. ],
  8028. "responses": {
  8029. "200": {
  8030. "$ref": "#/responses/ReleaseList"
  8031. }
  8032. }
  8033. },
  8034. "post": {
  8035. "consumes": [
  8036. "application/json"
  8037. ],
  8038. "produces": [
  8039. "application/json"
  8040. ],
  8041. "tags": [
  8042. "repository"
  8043. ],
  8044. "summary": "Create a release",
  8045. "operationId": "repoCreateRelease",
  8046. "parameters": [
  8047. {
  8048. "type": "string",
  8049. "description": "owner of the repo",
  8050. "name": "owner",
  8051. "in": "path",
  8052. "required": true
  8053. },
  8054. {
  8055. "type": "string",
  8056. "description": "name of the repo",
  8057. "name": "repo",
  8058. "in": "path",
  8059. "required": true
  8060. },
  8061. {
  8062. "name": "body",
  8063. "in": "body",
  8064. "schema": {
  8065. "$ref": "#/definitions/CreateReleaseOption"
  8066. }
  8067. }
  8068. ],
  8069. "responses": {
  8070. "201": {
  8071. "$ref": "#/responses/Release"
  8072. },
  8073. "404": {
  8074. "$ref": "#/responses/notFound"
  8075. },
  8076. "409": {
  8077. "$ref": "#/responses/error"
  8078. }
  8079. }
  8080. }
  8081. },
  8082. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  8083. "get": {
  8084. "produces": [
  8085. "application/json"
  8086. ],
  8087. "tags": [
  8088. "repository"
  8089. ],
  8090. "summary": "Get a release by tag name",
  8091. "operationId": "repoGetReleaseByTag",
  8092. "parameters": [
  8093. {
  8094. "type": "string",
  8095. "description": "owner of the repo",
  8096. "name": "owner",
  8097. "in": "path",
  8098. "required": true
  8099. },
  8100. {
  8101. "type": "string",
  8102. "description": "name of the repo",
  8103. "name": "repo",
  8104. "in": "path",
  8105. "required": true
  8106. },
  8107. {
  8108. "type": "string",
  8109. "description": "tag name of the release to get",
  8110. "name": "tag",
  8111. "in": "path",
  8112. "required": true
  8113. }
  8114. ],
  8115. "responses": {
  8116. "200": {
  8117. "$ref": "#/responses/Release"
  8118. },
  8119. "404": {
  8120. "$ref": "#/responses/notFound"
  8121. }
  8122. }
  8123. },
  8124. "delete": {
  8125. "tags": [
  8126. "repository"
  8127. ],
  8128. "summary": "Delete a release by tag name",
  8129. "operationId": "repoDeleteReleaseByTag",
  8130. "parameters": [
  8131. {
  8132. "type": "string",
  8133. "description": "owner of the repo",
  8134. "name": "owner",
  8135. "in": "path",
  8136. "required": true
  8137. },
  8138. {
  8139. "type": "string",
  8140. "description": "name of the repo",
  8141. "name": "repo",
  8142. "in": "path",
  8143. "required": true
  8144. },
  8145. {
  8146. "type": "string",
  8147. "description": "tag name of the release to delete",
  8148. "name": "tag",
  8149. "in": "path",
  8150. "required": true
  8151. }
  8152. ],
  8153. "responses": {
  8154. "204": {
  8155. "$ref": "#/responses/empty"
  8156. },
  8157. "404": {
  8158. "$ref": "#/responses/notFound"
  8159. }
  8160. }
  8161. }
  8162. },
  8163. "/repos/{owner}/{repo}/releases/{id}": {
  8164. "get": {
  8165. "produces": [
  8166. "application/json"
  8167. ],
  8168. "tags": [
  8169. "repository"
  8170. ],
  8171. "summary": "Get a release",
  8172. "operationId": "repoGetRelease",
  8173. "parameters": [
  8174. {
  8175. "type": "string",
  8176. "description": "owner of the repo",
  8177. "name": "owner",
  8178. "in": "path",
  8179. "required": true
  8180. },
  8181. {
  8182. "type": "string",
  8183. "description": "name of the repo",
  8184. "name": "repo",
  8185. "in": "path",
  8186. "required": true
  8187. },
  8188. {
  8189. "type": "integer",
  8190. "format": "int64",
  8191. "description": "id of the release to get",
  8192. "name": "id",
  8193. "in": "path",
  8194. "required": true
  8195. }
  8196. ],
  8197. "responses": {
  8198. "200": {
  8199. "$ref": "#/responses/Release"
  8200. },
  8201. "404": {
  8202. "$ref": "#/responses/notFound"
  8203. }
  8204. }
  8205. },
  8206. "delete": {
  8207. "tags": [
  8208. "repository"
  8209. ],
  8210. "summary": "Delete a release",
  8211. "operationId": "repoDeleteRelease",
  8212. "parameters": [
  8213. {
  8214. "type": "string",
  8215. "description": "owner of the repo",
  8216. "name": "owner",
  8217. "in": "path",
  8218. "required": true
  8219. },
  8220. {
  8221. "type": "string",
  8222. "description": "name of the repo",
  8223. "name": "repo",
  8224. "in": "path",
  8225. "required": true
  8226. },
  8227. {
  8228. "type": "integer",
  8229. "format": "int64",
  8230. "description": "id of the release to delete",
  8231. "name": "id",
  8232. "in": "path",
  8233. "required": true
  8234. }
  8235. ],
  8236. "responses": {
  8237. "204": {
  8238. "$ref": "#/responses/empty"
  8239. },
  8240. "404": {
  8241. "$ref": "#/responses/notFound"
  8242. }
  8243. }
  8244. },
  8245. "patch": {
  8246. "consumes": [
  8247. "application/json"
  8248. ],
  8249. "produces": [
  8250. "application/json"
  8251. ],
  8252. "tags": [
  8253. "repository"
  8254. ],
  8255. "summary": "Update a release",
  8256. "operationId": "repoEditRelease",
  8257. "parameters": [
  8258. {
  8259. "type": "string",
  8260. "description": "owner of the repo",
  8261. "name": "owner",
  8262. "in": "path",
  8263. "required": true
  8264. },
  8265. {
  8266. "type": "string",
  8267. "description": "name of the repo",
  8268. "name": "repo",
  8269. "in": "path",
  8270. "required": true
  8271. },
  8272. {
  8273. "type": "integer",
  8274. "format": "int64",
  8275. "description": "id of the release to edit",
  8276. "name": "id",
  8277. "in": "path",
  8278. "required": true
  8279. },
  8280. {
  8281. "name": "body",
  8282. "in": "body",
  8283. "schema": {
  8284. "$ref": "#/definitions/EditReleaseOption"
  8285. }
  8286. }
  8287. ],
  8288. "responses": {
  8289. "200": {
  8290. "$ref": "#/responses/Release"
  8291. },
  8292. "404": {
  8293. "$ref": "#/responses/notFound"
  8294. }
  8295. }
  8296. }
  8297. },
  8298. "/repos/{owner}/{repo}/releases/{id}/assets": {
  8299. "get": {
  8300. "produces": [
  8301. "application/json"
  8302. ],
  8303. "tags": [
  8304. "repository"
  8305. ],
  8306. "summary": "List release's attachments",
  8307. "operationId": "repoListReleaseAttachments",
  8308. "parameters": [
  8309. {
  8310. "type": "string",
  8311. "description": "owner of the repo",
  8312. "name": "owner",
  8313. "in": "path",
  8314. "required": true
  8315. },
  8316. {
  8317. "type": "string",
  8318. "description": "name of the repo",
  8319. "name": "repo",
  8320. "in": "path",
  8321. "required": true
  8322. },
  8323. {
  8324. "type": "integer",
  8325. "format": "int64",
  8326. "description": "id of the release",
  8327. "name": "id",
  8328. "in": "path",
  8329. "required": true
  8330. }
  8331. ],
  8332. "responses": {
  8333. "200": {
  8334. "$ref": "#/responses/AttachmentList"
  8335. }
  8336. }
  8337. },
  8338. "post": {
  8339. "consumes": [
  8340. "multipart/form-data"
  8341. ],
  8342. "produces": [
  8343. "application/json"
  8344. ],
  8345. "tags": [
  8346. "repository"
  8347. ],
  8348. "summary": "Create a release attachment",
  8349. "operationId": "repoCreateReleaseAttachment",
  8350. "parameters": [
  8351. {
  8352. "type": "string",
  8353. "description": "owner of the repo",
  8354. "name": "owner",
  8355. "in": "path",
  8356. "required": true
  8357. },
  8358. {
  8359. "type": "string",
  8360. "description": "name of the repo",
  8361. "name": "repo",
  8362. "in": "path",
  8363. "required": true
  8364. },
  8365. {
  8366. "type": "integer",
  8367. "format": "int64",
  8368. "description": "id of the release",
  8369. "name": "id",
  8370. "in": "path",
  8371. "required": true
  8372. },
  8373. {
  8374. "type": "string",
  8375. "description": "name of the attachment",
  8376. "name": "name",
  8377. "in": "query"
  8378. },
  8379. {
  8380. "type": "file",
  8381. "description": "attachment to upload",
  8382. "name": "attachment",
  8383. "in": "formData",
  8384. "required": true
  8385. }
  8386. ],
  8387. "responses": {
  8388. "201": {
  8389. "$ref": "#/responses/Attachment"
  8390. },
  8391. "400": {
  8392. "$ref": "#/responses/error"
  8393. }
  8394. }
  8395. }
  8396. },
  8397. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  8398. "get": {
  8399. "produces": [
  8400. "application/json"
  8401. ],
  8402. "tags": [
  8403. "repository"
  8404. ],
  8405. "summary": "Get a release attachment",
  8406. "operationId": "repoGetReleaseAttachment",
  8407. "parameters": [
  8408. {
  8409. "type": "string",
  8410. "description": "owner of the repo",
  8411. "name": "owner",
  8412. "in": "path",
  8413. "required": true
  8414. },
  8415. {
  8416. "type": "string",
  8417. "description": "name of the repo",
  8418. "name": "repo",
  8419. "in": "path",
  8420. "required": true
  8421. },
  8422. {
  8423. "type": "integer",
  8424. "format": "int64",
  8425. "description": "id of the release",
  8426. "name": "id",
  8427. "in": "path",
  8428. "required": true
  8429. },
  8430. {
  8431. "type": "integer",
  8432. "format": "int64",
  8433. "description": "id of the attachment to get",
  8434. "name": "attachment_id",
  8435. "in": "path",
  8436. "required": true
  8437. }
  8438. ],
  8439. "responses": {
  8440. "200": {
  8441. "$ref": "#/responses/Attachment"
  8442. }
  8443. }
  8444. },
  8445. "delete": {
  8446. "produces": [
  8447. "application/json"
  8448. ],
  8449. "tags": [
  8450. "repository"
  8451. ],
  8452. "summary": "Delete a release attachment",
  8453. "operationId": "repoDeleteReleaseAttachment",
  8454. "parameters": [
  8455. {
  8456. "type": "string",
  8457. "description": "owner of the repo",
  8458. "name": "owner",
  8459. "in": "path",
  8460. "required": true
  8461. },
  8462. {
  8463. "type": "string",
  8464. "description": "name of the repo",
  8465. "name": "repo",
  8466. "in": "path",
  8467. "required": true
  8468. },
  8469. {
  8470. "type": "integer",
  8471. "format": "int64",
  8472. "description": "id of the release",
  8473. "name": "id",
  8474. "in": "path",
  8475. "required": true
  8476. },
  8477. {
  8478. "type": "integer",
  8479. "format": "int64",
  8480. "description": "id of the attachment to delete",
  8481. "name": "attachment_id",
  8482. "in": "path",
  8483. "required": true
  8484. }
  8485. ],
  8486. "responses": {
  8487. "204": {
  8488. "$ref": "#/responses/empty"
  8489. }
  8490. }
  8491. },
  8492. "patch": {
  8493. "consumes": [
  8494. "application/json"
  8495. ],
  8496. "produces": [
  8497. "application/json"
  8498. ],
  8499. "tags": [
  8500. "repository"
  8501. ],
  8502. "summary": "Edit a release attachment",
  8503. "operationId": "repoEditReleaseAttachment",
  8504. "parameters": [
  8505. {
  8506. "type": "string",
  8507. "description": "owner of the repo",
  8508. "name": "owner",
  8509. "in": "path",
  8510. "required": true
  8511. },
  8512. {
  8513. "type": "string",
  8514. "description": "name of the repo",
  8515. "name": "repo",
  8516. "in": "path",
  8517. "required": true
  8518. },
  8519. {
  8520. "type": "integer",
  8521. "format": "int64",
  8522. "description": "id of the release",
  8523. "name": "id",
  8524. "in": "path",
  8525. "required": true
  8526. },
  8527. {
  8528. "type": "integer",
  8529. "format": "int64",
  8530. "description": "id of the attachment to edit",
  8531. "name": "attachment_id",
  8532. "in": "path",
  8533. "required": true
  8534. },
  8535. {
  8536. "name": "body",
  8537. "in": "body",
  8538. "schema": {
  8539. "$ref": "#/definitions/EditAttachmentOptions"
  8540. }
  8541. }
  8542. ],
  8543. "responses": {
  8544. "201": {
  8545. "$ref": "#/responses/Attachment"
  8546. }
  8547. }
  8548. }
  8549. },
  8550. "/repos/{owner}/{repo}/signing-key.gpg": {
  8551. "get": {
  8552. "produces": [
  8553. "text/plain"
  8554. ],
  8555. "tags": [
  8556. "repository"
  8557. ],
  8558. "summary": "Get signing-key.gpg for given repository",
  8559. "operationId": "repoSigningKey",
  8560. "parameters": [
  8561. {
  8562. "type": "string",
  8563. "description": "owner of the repo",
  8564. "name": "owner",
  8565. "in": "path",
  8566. "required": true
  8567. },
  8568. {
  8569. "type": "string",
  8570. "description": "name of the repo",
  8571. "name": "repo",
  8572. "in": "path",
  8573. "required": true
  8574. }
  8575. ],
  8576. "responses": {
  8577. "200": {
  8578. "description": "GPG armored public key",
  8579. "schema": {
  8580. "type": "string"
  8581. }
  8582. }
  8583. }
  8584. }
  8585. },
  8586. "/repos/{owner}/{repo}/stargazers": {
  8587. "get": {
  8588. "produces": [
  8589. "application/json"
  8590. ],
  8591. "tags": [
  8592. "repository"
  8593. ],
  8594. "summary": "List a repo's stargazers",
  8595. "operationId": "repoListStargazers",
  8596. "parameters": [
  8597. {
  8598. "type": "string",
  8599. "description": "owner of the repo",
  8600. "name": "owner",
  8601. "in": "path",
  8602. "required": true
  8603. },
  8604. {
  8605. "type": "string",
  8606. "description": "name of the repo",
  8607. "name": "repo",
  8608. "in": "path",
  8609. "required": true
  8610. },
  8611. {
  8612. "type": "integer",
  8613. "description": "page number of results to return (1-based)",
  8614. "name": "page",
  8615. "in": "query"
  8616. },
  8617. {
  8618. "type": "integer",
  8619. "description": "page size of results",
  8620. "name": "limit",
  8621. "in": "query"
  8622. }
  8623. ],
  8624. "responses": {
  8625. "200": {
  8626. "$ref": "#/responses/UserList"
  8627. }
  8628. }
  8629. }
  8630. },
  8631. "/repos/{owner}/{repo}/statuses/{sha}": {
  8632. "get": {
  8633. "produces": [
  8634. "application/json"
  8635. ],
  8636. "tags": [
  8637. "repository"
  8638. ],
  8639. "summary": "Get a commit's statuses",
  8640. "operationId": "repoListStatuses",
  8641. "parameters": [
  8642. {
  8643. "type": "string",
  8644. "description": "owner of the repo",
  8645. "name": "owner",
  8646. "in": "path",
  8647. "required": true
  8648. },
  8649. {
  8650. "type": "string",
  8651. "description": "name of the repo",
  8652. "name": "repo",
  8653. "in": "path",
  8654. "required": true
  8655. },
  8656. {
  8657. "type": "string",
  8658. "description": "sha of the commit",
  8659. "name": "sha",
  8660. "in": "path",
  8661. "required": true
  8662. },
  8663. {
  8664. "enum": [
  8665. "oldest",
  8666. "recentupdate",
  8667. "leastupdate",
  8668. "leastindex",
  8669. "highestindex"
  8670. ],
  8671. "type": "string",
  8672. "description": "type of sort",
  8673. "name": "sort",
  8674. "in": "query"
  8675. },
  8676. {
  8677. "enum": [
  8678. "pending",
  8679. "success",
  8680. "error",
  8681. "failure",
  8682. "warning"
  8683. ],
  8684. "type": "string",
  8685. "description": "type of state",
  8686. "name": "state",
  8687. "in": "query"
  8688. },
  8689. {
  8690. "type": "integer",
  8691. "description": "page number of results to return (1-based)",
  8692. "name": "page",
  8693. "in": "query"
  8694. },
  8695. {
  8696. "type": "integer",
  8697. "description": "page size of results",
  8698. "name": "limit",
  8699. "in": "query"
  8700. }
  8701. ],
  8702. "responses": {
  8703. "200": {
  8704. "$ref": "#/responses/CommitStatusList"
  8705. },
  8706. "400": {
  8707. "$ref": "#/responses/error"
  8708. }
  8709. }
  8710. },
  8711. "post": {
  8712. "produces": [
  8713. "application/json"
  8714. ],
  8715. "tags": [
  8716. "repository"
  8717. ],
  8718. "summary": "Create a commit status",
  8719. "operationId": "repoCreateStatus",
  8720. "parameters": [
  8721. {
  8722. "type": "string",
  8723. "description": "owner of the repo",
  8724. "name": "owner",
  8725. "in": "path",
  8726. "required": true
  8727. },
  8728. {
  8729. "type": "string",
  8730. "description": "name of the repo",
  8731. "name": "repo",
  8732. "in": "path",
  8733. "required": true
  8734. },
  8735. {
  8736. "type": "string",
  8737. "description": "sha of the commit",
  8738. "name": "sha",
  8739. "in": "path",
  8740. "required": true
  8741. },
  8742. {
  8743. "name": "body",
  8744. "in": "body",
  8745. "schema": {
  8746. "$ref": "#/definitions/CreateStatusOption"
  8747. }
  8748. }
  8749. ],
  8750. "responses": {
  8751. "201": {
  8752. "$ref": "#/responses/CommitStatus"
  8753. },
  8754. "400": {
  8755. "$ref": "#/responses/error"
  8756. }
  8757. }
  8758. }
  8759. },
  8760. "/repos/{owner}/{repo}/subscribers": {
  8761. "get": {
  8762. "produces": [
  8763. "application/json"
  8764. ],
  8765. "tags": [
  8766. "repository"
  8767. ],
  8768. "summary": "List a repo's watchers",
  8769. "operationId": "repoListSubscribers",
  8770. "parameters": [
  8771. {
  8772. "type": "string",
  8773. "description": "owner of the repo",
  8774. "name": "owner",
  8775. "in": "path",
  8776. "required": true
  8777. },
  8778. {
  8779. "type": "string",
  8780. "description": "name of the repo",
  8781. "name": "repo",
  8782. "in": "path",
  8783. "required": true
  8784. },
  8785. {
  8786. "type": "integer",
  8787. "description": "page number of results to return (1-based)",
  8788. "name": "page",
  8789. "in": "query"
  8790. },
  8791. {
  8792. "type": "integer",
  8793. "description": "page size of results",
  8794. "name": "limit",
  8795. "in": "query"
  8796. }
  8797. ],
  8798. "responses": {
  8799. "200": {
  8800. "$ref": "#/responses/UserList"
  8801. }
  8802. }
  8803. }
  8804. },
  8805. "/repos/{owner}/{repo}/subscription": {
  8806. "get": {
  8807. "tags": [
  8808. "repository"
  8809. ],
  8810. "summary": "Check if the current user is watching a repo",
  8811. "operationId": "userCurrentCheckSubscription",
  8812. "parameters": [
  8813. {
  8814. "type": "string",
  8815. "description": "owner of the repo",
  8816. "name": "owner",
  8817. "in": "path",
  8818. "required": true
  8819. },
  8820. {
  8821. "type": "string",
  8822. "description": "name of the repo",
  8823. "name": "repo",
  8824. "in": "path",
  8825. "required": true
  8826. }
  8827. ],
  8828. "responses": {
  8829. "200": {
  8830. "$ref": "#/responses/WatchInfo"
  8831. },
  8832. "404": {
  8833. "description": "User is not watching this repo or repo do not exist"
  8834. }
  8835. }
  8836. },
  8837. "put": {
  8838. "tags": [
  8839. "repository"
  8840. ],
  8841. "summary": "Watch a repo",
  8842. "operationId": "userCurrentPutSubscription",
  8843. "parameters": [
  8844. {
  8845. "type": "string",
  8846. "description": "owner of the repo",
  8847. "name": "owner",
  8848. "in": "path",
  8849. "required": true
  8850. },
  8851. {
  8852. "type": "string",
  8853. "description": "name of the repo",
  8854. "name": "repo",
  8855. "in": "path",
  8856. "required": true
  8857. }
  8858. ],
  8859. "responses": {
  8860. "200": {
  8861. "$ref": "#/responses/WatchInfo"
  8862. }
  8863. }
  8864. },
  8865. "delete": {
  8866. "tags": [
  8867. "repository"
  8868. ],
  8869. "summary": "Unwatch a repo",
  8870. "operationId": "userCurrentDeleteSubscription",
  8871. "parameters": [
  8872. {
  8873. "type": "string",
  8874. "description": "owner of the repo",
  8875. "name": "owner",
  8876. "in": "path",
  8877. "required": true
  8878. },
  8879. {
  8880. "type": "string",
  8881. "description": "name of the repo",
  8882. "name": "repo",
  8883. "in": "path",
  8884. "required": true
  8885. }
  8886. ],
  8887. "responses": {
  8888. "204": {
  8889. "$ref": "#/responses/empty"
  8890. }
  8891. }
  8892. }
  8893. },
  8894. "/repos/{owner}/{repo}/tags": {
  8895. "get": {
  8896. "produces": [
  8897. "application/json"
  8898. ],
  8899. "tags": [
  8900. "repository"
  8901. ],
  8902. "summary": "List a repository's tags",
  8903. "operationId": "repoListTags",
  8904. "parameters": [
  8905. {
  8906. "type": "string",
  8907. "description": "owner of the repo",
  8908. "name": "owner",
  8909. "in": "path",
  8910. "required": true
  8911. },
  8912. {
  8913. "type": "string",
  8914. "description": "name of the repo",
  8915. "name": "repo",
  8916. "in": "path",
  8917. "required": true
  8918. },
  8919. {
  8920. "type": "integer",
  8921. "description": "page number of results to return (1-based)",
  8922. "name": "page",
  8923. "in": "query"
  8924. },
  8925. {
  8926. "type": "integer",
  8927. "description": "page size of results, default maximum page size is 50",
  8928. "name": "limit",
  8929. "in": "query"
  8930. }
  8931. ],
  8932. "responses": {
  8933. "200": {
  8934. "$ref": "#/responses/TagList"
  8935. }
  8936. }
  8937. }
  8938. },
  8939. "/repos/{owner}/{repo}/tags/{tag}": {
  8940. "delete": {
  8941. "produces": [
  8942. "application/json"
  8943. ],
  8944. "tags": [
  8945. "repository"
  8946. ],
  8947. "summary": "Delete a repository's tag by name",
  8948. "operationId": "repoDeleteTag",
  8949. "parameters": [
  8950. {
  8951. "type": "string",
  8952. "description": "owner of the repo",
  8953. "name": "owner",
  8954. "in": "path",
  8955. "required": true
  8956. },
  8957. {
  8958. "type": "string",
  8959. "description": "name of the repo",
  8960. "name": "repo",
  8961. "in": "path",
  8962. "required": true
  8963. },
  8964. {
  8965. "type": "string",
  8966. "description": "name of tag to delete",
  8967. "name": "tag",
  8968. "in": "path",
  8969. "required": true
  8970. }
  8971. ],
  8972. "responses": {
  8973. "204": {
  8974. "$ref": "#/responses/empty"
  8975. },
  8976. "404": {
  8977. "$ref": "#/responses/notFound"
  8978. },
  8979. "409": {
  8980. "$ref": "#/responses/conflict"
  8981. }
  8982. }
  8983. }
  8984. },
  8985. "/repos/{owner}/{repo}/teams": {
  8986. "get": {
  8987. "produces": [
  8988. "application/json"
  8989. ],
  8990. "tags": [
  8991. "repository"
  8992. ],
  8993. "summary": "List a repository's teams",
  8994. "operationId": "repoListTeams",
  8995. "parameters": [
  8996. {
  8997. "type": "string",
  8998. "description": "owner of the repo",
  8999. "name": "owner",
  9000. "in": "path",
  9001. "required": true
  9002. },
  9003. {
  9004. "type": "string",
  9005. "description": "name of the repo",
  9006. "name": "repo",
  9007. "in": "path",
  9008. "required": true
  9009. }
  9010. ],
  9011. "responses": {
  9012. "200": {
  9013. "$ref": "#/responses/TeamList"
  9014. }
  9015. }
  9016. }
  9017. },
  9018. "/repos/{owner}/{repo}/teams/{team}": {
  9019. "get": {
  9020. "produces": [
  9021. "application/json"
  9022. ],
  9023. "tags": [
  9024. "repository"
  9025. ],
  9026. "summary": "Check if a team is assigned to a repository",
  9027. "operationId": "repoCheckTeam",
  9028. "parameters": [
  9029. {
  9030. "type": "string",
  9031. "description": "owner of the repo",
  9032. "name": "owner",
  9033. "in": "path",
  9034. "required": true
  9035. },
  9036. {
  9037. "type": "string",
  9038. "description": "name of the repo",
  9039. "name": "repo",
  9040. "in": "path",
  9041. "required": true
  9042. },
  9043. {
  9044. "type": "string",
  9045. "description": "team name",
  9046. "name": "team",
  9047. "in": "path",
  9048. "required": true
  9049. }
  9050. ],
  9051. "responses": {
  9052. "200": {
  9053. "$ref": "#/responses/Team"
  9054. },
  9055. "404": {
  9056. "$ref": "#/responses/notFound"
  9057. },
  9058. "405": {
  9059. "$ref": "#/responses/error"
  9060. }
  9061. }
  9062. },
  9063. "put": {
  9064. "produces": [
  9065. "application/json"
  9066. ],
  9067. "tags": [
  9068. "repository"
  9069. ],
  9070. "summary": "Add a team to a repository",
  9071. "operationId": "repoAddTeam",
  9072. "parameters": [
  9073. {
  9074. "type": "string",
  9075. "description": "owner of the repo",
  9076. "name": "owner",
  9077. "in": "path",
  9078. "required": true
  9079. },
  9080. {
  9081. "type": "string",
  9082. "description": "name of the repo",
  9083. "name": "repo",
  9084. "in": "path",
  9085. "required": true
  9086. },
  9087. {
  9088. "type": "string",
  9089. "description": "team name",
  9090. "name": "team",
  9091. "in": "path",
  9092. "required": true
  9093. }
  9094. ],
  9095. "responses": {
  9096. "204": {
  9097. "$ref": "#/responses/empty"
  9098. },
  9099. "405": {
  9100. "$ref": "#/responses/error"
  9101. },
  9102. "422": {
  9103. "$ref": "#/responses/validationError"
  9104. }
  9105. }
  9106. },
  9107. "delete": {
  9108. "produces": [
  9109. "application/json"
  9110. ],
  9111. "tags": [
  9112. "repository"
  9113. ],
  9114. "summary": "Delete a team from a repository",
  9115. "operationId": "repoDeleteTeam",
  9116. "parameters": [
  9117. {
  9118. "type": "string",
  9119. "description": "owner of the repo",
  9120. "name": "owner",
  9121. "in": "path",
  9122. "required": true
  9123. },
  9124. {
  9125. "type": "string",
  9126. "description": "name of the repo",
  9127. "name": "repo",
  9128. "in": "path",
  9129. "required": true
  9130. },
  9131. {
  9132. "type": "string",
  9133. "description": "team name",
  9134. "name": "team",
  9135. "in": "path",
  9136. "required": true
  9137. }
  9138. ],
  9139. "responses": {
  9140. "204": {
  9141. "$ref": "#/responses/empty"
  9142. },
  9143. "405": {
  9144. "$ref": "#/responses/error"
  9145. },
  9146. "422": {
  9147. "$ref": "#/responses/validationError"
  9148. }
  9149. }
  9150. }
  9151. },
  9152. "/repos/{owner}/{repo}/times": {
  9153. "get": {
  9154. "produces": [
  9155. "application/json"
  9156. ],
  9157. "tags": [
  9158. "repository"
  9159. ],
  9160. "summary": "List a repo's tracked times",
  9161. "operationId": "repoTrackedTimes",
  9162. "parameters": [
  9163. {
  9164. "type": "string",
  9165. "description": "owner of the repo",
  9166. "name": "owner",
  9167. "in": "path",
  9168. "required": true
  9169. },
  9170. {
  9171. "type": "string",
  9172. "description": "name of the repo",
  9173. "name": "repo",
  9174. "in": "path",
  9175. "required": true
  9176. },
  9177. {
  9178. "type": "string",
  9179. "description": "optional filter by user (available for issue managers)",
  9180. "name": "user",
  9181. "in": "query"
  9182. },
  9183. {
  9184. "type": "string",
  9185. "format": "date-time",
  9186. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9187. "name": "since",
  9188. "in": "query"
  9189. },
  9190. {
  9191. "type": "string",
  9192. "format": "date-time",
  9193. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9194. "name": "before",
  9195. "in": "query"
  9196. },
  9197. {
  9198. "type": "integer",
  9199. "description": "page number of results to return (1-based)",
  9200. "name": "page",
  9201. "in": "query"
  9202. },
  9203. {
  9204. "type": "integer",
  9205. "description": "page size of results",
  9206. "name": "limit",
  9207. "in": "query"
  9208. }
  9209. ],
  9210. "responses": {
  9211. "200": {
  9212. "$ref": "#/responses/TrackedTimeList"
  9213. },
  9214. "400": {
  9215. "$ref": "#/responses/error"
  9216. },
  9217. "403": {
  9218. "$ref": "#/responses/forbidden"
  9219. }
  9220. }
  9221. }
  9222. },
  9223. "/repos/{owner}/{repo}/times/{user}": {
  9224. "get": {
  9225. "produces": [
  9226. "application/json"
  9227. ],
  9228. "tags": [
  9229. "repository"
  9230. ],
  9231. "summary": "List a user's tracked times in a repo",
  9232. "operationId": "userTrackedTimes",
  9233. "deprecated": true,
  9234. "parameters": [
  9235. {
  9236. "type": "string",
  9237. "description": "owner of the repo",
  9238. "name": "owner",
  9239. "in": "path",
  9240. "required": true
  9241. },
  9242. {
  9243. "type": "string",
  9244. "description": "name of the repo",
  9245. "name": "repo",
  9246. "in": "path",
  9247. "required": true
  9248. },
  9249. {
  9250. "type": "string",
  9251. "description": "username of user",
  9252. "name": "user",
  9253. "in": "path",
  9254. "required": true
  9255. }
  9256. ],
  9257. "responses": {
  9258. "200": {
  9259. "$ref": "#/responses/TrackedTimeList"
  9260. },
  9261. "400": {
  9262. "$ref": "#/responses/error"
  9263. },
  9264. "403": {
  9265. "$ref": "#/responses/forbidden"
  9266. }
  9267. }
  9268. }
  9269. },
  9270. "/repos/{owner}/{repo}/topics": {
  9271. "get": {
  9272. "produces": [
  9273. "application/json"
  9274. ],
  9275. "tags": [
  9276. "repository"
  9277. ],
  9278. "summary": "Get list of topics that a repository has",
  9279. "operationId": "repoListTopics",
  9280. "parameters": [
  9281. {
  9282. "type": "string",
  9283. "description": "owner of the repo",
  9284. "name": "owner",
  9285. "in": "path",
  9286. "required": true
  9287. },
  9288. {
  9289. "type": "string",
  9290. "description": "name of the repo",
  9291. "name": "repo",
  9292. "in": "path",
  9293. "required": true
  9294. },
  9295. {
  9296. "type": "integer",
  9297. "description": "page number of results to return (1-based)",
  9298. "name": "page",
  9299. "in": "query"
  9300. },
  9301. {
  9302. "type": "integer",
  9303. "description": "page size of results",
  9304. "name": "limit",
  9305. "in": "query"
  9306. }
  9307. ],
  9308. "responses": {
  9309. "200": {
  9310. "$ref": "#/responses/TopicNames"
  9311. }
  9312. }
  9313. },
  9314. "put": {
  9315. "produces": [
  9316. "application/json"
  9317. ],
  9318. "tags": [
  9319. "repository"
  9320. ],
  9321. "summary": "Replace list of topics for a repository",
  9322. "operationId": "repoUpdateTopics",
  9323. "parameters": [
  9324. {
  9325. "type": "string",
  9326. "description": "owner of the repo",
  9327. "name": "owner",
  9328. "in": "path",
  9329. "required": true
  9330. },
  9331. {
  9332. "type": "string",
  9333. "description": "name of the repo",
  9334. "name": "repo",
  9335. "in": "path",
  9336. "required": true
  9337. },
  9338. {
  9339. "name": "body",
  9340. "in": "body",
  9341. "schema": {
  9342. "$ref": "#/definitions/RepoTopicOptions"
  9343. }
  9344. }
  9345. ],
  9346. "responses": {
  9347. "204": {
  9348. "$ref": "#/responses/empty"
  9349. },
  9350. "422": {
  9351. "$ref": "#/responses/invalidTopicsError"
  9352. }
  9353. }
  9354. }
  9355. },
  9356. "/repos/{owner}/{repo}/topics/{topic}": {
  9357. "put": {
  9358. "produces": [
  9359. "application/json"
  9360. ],
  9361. "tags": [
  9362. "repository"
  9363. ],
  9364. "summary": "Add a topic to a repository",
  9365. "operationId": "repoAddTopíc",
  9366. "parameters": [
  9367. {
  9368. "type": "string",
  9369. "description": "owner of the repo",
  9370. "name": "owner",
  9371. "in": "path",
  9372. "required": true
  9373. },
  9374. {
  9375. "type": "string",
  9376. "description": "name of the repo",
  9377. "name": "repo",
  9378. "in": "path",
  9379. "required": true
  9380. },
  9381. {
  9382. "type": "string",
  9383. "description": "name of the topic to add",
  9384. "name": "topic",
  9385. "in": "path",
  9386. "required": true
  9387. }
  9388. ],
  9389. "responses": {
  9390. "204": {
  9391. "$ref": "#/responses/empty"
  9392. },
  9393. "422": {
  9394. "$ref": "#/responses/invalidTopicsError"
  9395. }
  9396. }
  9397. },
  9398. "delete": {
  9399. "produces": [
  9400. "application/json"
  9401. ],
  9402. "tags": [
  9403. "repository"
  9404. ],
  9405. "summary": "Delete a topic from a repository",
  9406. "operationId": "repoDeleteTopic",
  9407. "parameters": [
  9408. {
  9409. "type": "string",
  9410. "description": "owner of the repo",
  9411. "name": "owner",
  9412. "in": "path",
  9413. "required": true
  9414. },
  9415. {
  9416. "type": "string",
  9417. "description": "name of the repo",
  9418. "name": "repo",
  9419. "in": "path",
  9420. "required": true
  9421. },
  9422. {
  9423. "type": "string",
  9424. "description": "name of the topic to delete",
  9425. "name": "topic",
  9426. "in": "path",
  9427. "required": true
  9428. }
  9429. ],
  9430. "responses": {
  9431. "204": {
  9432. "$ref": "#/responses/empty"
  9433. },
  9434. "422": {
  9435. "$ref": "#/responses/invalidTopicsError"
  9436. }
  9437. }
  9438. }
  9439. },
  9440. "/repos/{owner}/{repo}/transfer": {
  9441. "post": {
  9442. "produces": [
  9443. "application/json"
  9444. ],
  9445. "tags": [
  9446. "repository"
  9447. ],
  9448. "summary": "Transfer a repo ownership",
  9449. "operationId": "repoTransfer",
  9450. "parameters": [
  9451. {
  9452. "type": "string",
  9453. "description": "owner of the repo to transfer",
  9454. "name": "owner",
  9455. "in": "path",
  9456. "required": true
  9457. },
  9458. {
  9459. "type": "string",
  9460. "description": "name of the repo to transfer",
  9461. "name": "repo",
  9462. "in": "path",
  9463. "required": true
  9464. },
  9465. {
  9466. "description": "Transfer Options",
  9467. "name": "body",
  9468. "in": "body",
  9469. "required": true,
  9470. "schema": {
  9471. "$ref": "#/definitions/TransferRepoOption"
  9472. }
  9473. }
  9474. ],
  9475. "responses": {
  9476. "202": {
  9477. "$ref": "#/responses/Repository"
  9478. },
  9479. "403": {
  9480. "$ref": "#/responses/forbidden"
  9481. },
  9482. "404": {
  9483. "$ref": "#/responses/notFound"
  9484. },
  9485. "422": {
  9486. "$ref": "#/responses/validationError"
  9487. }
  9488. }
  9489. }
  9490. },
  9491. "/repositories/{id}": {
  9492. "get": {
  9493. "produces": [
  9494. "application/json"
  9495. ],
  9496. "tags": [
  9497. "repository"
  9498. ],
  9499. "summary": "Get a repository by id",
  9500. "operationId": "repoGetByID",
  9501. "parameters": [
  9502. {
  9503. "type": "integer",
  9504. "format": "int64",
  9505. "description": "id of the repo to get",
  9506. "name": "id",
  9507. "in": "path",
  9508. "required": true
  9509. }
  9510. ],
  9511. "responses": {
  9512. "200": {
  9513. "$ref": "#/responses/Repository"
  9514. }
  9515. }
  9516. }
  9517. },
  9518. "/settings/api": {
  9519. "get": {
  9520. "produces": [
  9521. "application/json"
  9522. ],
  9523. "tags": [
  9524. "settings"
  9525. ],
  9526. "summary": "Get instance's global settings for api",
  9527. "operationId": "getGeneralAPISettings",
  9528. "responses": {
  9529. "200": {
  9530. "$ref": "#/responses/GeneralAPISettings"
  9531. }
  9532. }
  9533. }
  9534. },
  9535. "/settings/attachment": {
  9536. "get": {
  9537. "produces": [
  9538. "application/json"
  9539. ],
  9540. "tags": [
  9541. "settings"
  9542. ],
  9543. "summary": "Get instance's global settings for Attachment",
  9544. "operationId": "getGeneralAttachmentSettings",
  9545. "responses": {
  9546. "200": {
  9547. "$ref": "#/responses/GeneralAttachmentSettings"
  9548. }
  9549. }
  9550. }
  9551. },
  9552. "/settings/repository": {
  9553. "get": {
  9554. "produces": [
  9555. "application/json"
  9556. ],
  9557. "tags": [
  9558. "settings"
  9559. ],
  9560. "summary": "Get instance's global settings for repositories",
  9561. "operationId": "getGeneralRepositorySettings",
  9562. "responses": {
  9563. "200": {
  9564. "$ref": "#/responses/GeneralRepoSettings"
  9565. }
  9566. }
  9567. }
  9568. },
  9569. "/settings/ui": {
  9570. "get": {
  9571. "produces": [
  9572. "application/json"
  9573. ],
  9574. "tags": [
  9575. "settings"
  9576. ],
  9577. "summary": "Get instance's global settings for ui",
  9578. "operationId": "getGeneralUISettings",
  9579. "responses": {
  9580. "200": {
  9581. "$ref": "#/responses/GeneralUISettings"
  9582. }
  9583. }
  9584. }
  9585. },
  9586. "/signing-key.gpg": {
  9587. "get": {
  9588. "produces": [
  9589. "text/plain"
  9590. ],
  9591. "tags": [
  9592. "miscellaneous"
  9593. ],
  9594. "summary": "Get default signing-key.gpg",
  9595. "operationId": "getSigningKey",
  9596. "responses": {
  9597. "200": {
  9598. "description": "GPG armored public key",
  9599. "schema": {
  9600. "type": "string"
  9601. }
  9602. }
  9603. }
  9604. }
  9605. },
  9606. "/teams/{id}": {
  9607. "get": {
  9608. "produces": [
  9609. "application/json"
  9610. ],
  9611. "tags": [
  9612. "organization"
  9613. ],
  9614. "summary": "Get a team",
  9615. "operationId": "orgGetTeam",
  9616. "parameters": [
  9617. {
  9618. "type": "integer",
  9619. "format": "int64",
  9620. "description": "id of the team to get",
  9621. "name": "id",
  9622. "in": "path",
  9623. "required": true
  9624. }
  9625. ],
  9626. "responses": {
  9627. "200": {
  9628. "$ref": "#/responses/Team"
  9629. }
  9630. }
  9631. },
  9632. "delete": {
  9633. "tags": [
  9634. "organization"
  9635. ],
  9636. "summary": "Delete a team",
  9637. "operationId": "orgDeleteTeam",
  9638. "parameters": [
  9639. {
  9640. "type": "integer",
  9641. "format": "int64",
  9642. "description": "id of the team to delete",
  9643. "name": "id",
  9644. "in": "path",
  9645. "required": true
  9646. }
  9647. ],
  9648. "responses": {
  9649. "204": {
  9650. "description": "team deleted"
  9651. }
  9652. }
  9653. },
  9654. "patch": {
  9655. "consumes": [
  9656. "application/json"
  9657. ],
  9658. "produces": [
  9659. "application/json"
  9660. ],
  9661. "tags": [
  9662. "organization"
  9663. ],
  9664. "summary": "Edit a team",
  9665. "operationId": "orgEditTeam",
  9666. "parameters": [
  9667. {
  9668. "type": "integer",
  9669. "description": "id of the team to edit",
  9670. "name": "id",
  9671. "in": "path",
  9672. "required": true
  9673. },
  9674. {
  9675. "name": "body",
  9676. "in": "body",
  9677. "schema": {
  9678. "$ref": "#/definitions/EditTeamOption"
  9679. }
  9680. }
  9681. ],
  9682. "responses": {
  9683. "200": {
  9684. "$ref": "#/responses/Team"
  9685. }
  9686. }
  9687. }
  9688. },
  9689. "/teams/{id}/members": {
  9690. "get": {
  9691. "produces": [
  9692. "application/json"
  9693. ],
  9694. "tags": [
  9695. "organization"
  9696. ],
  9697. "summary": "List a team's members",
  9698. "operationId": "orgListTeamMembers",
  9699. "parameters": [
  9700. {
  9701. "type": "integer",
  9702. "format": "int64",
  9703. "description": "id of the team",
  9704. "name": "id",
  9705. "in": "path",
  9706. "required": true
  9707. },
  9708. {
  9709. "type": "integer",
  9710. "description": "page number of results to return (1-based)",
  9711. "name": "page",
  9712. "in": "query"
  9713. },
  9714. {
  9715. "type": "integer",
  9716. "description": "page size of results",
  9717. "name": "limit",
  9718. "in": "query"
  9719. }
  9720. ],
  9721. "responses": {
  9722. "200": {
  9723. "$ref": "#/responses/UserList"
  9724. }
  9725. }
  9726. }
  9727. },
  9728. "/teams/{id}/members/{username}": {
  9729. "get": {
  9730. "produces": [
  9731. "application/json"
  9732. ],
  9733. "tags": [
  9734. "organization"
  9735. ],
  9736. "summary": "List a particular member of team",
  9737. "operationId": "orgListTeamMember",
  9738. "parameters": [
  9739. {
  9740. "type": "integer",
  9741. "format": "int64",
  9742. "description": "id of the team",
  9743. "name": "id",
  9744. "in": "path",
  9745. "required": true
  9746. },
  9747. {
  9748. "type": "string",
  9749. "description": "username of the member to list",
  9750. "name": "username",
  9751. "in": "path",
  9752. "required": true
  9753. }
  9754. ],
  9755. "responses": {
  9756. "200": {
  9757. "$ref": "#/responses/User"
  9758. },
  9759. "404": {
  9760. "$ref": "#/responses/notFound"
  9761. }
  9762. }
  9763. },
  9764. "put": {
  9765. "produces": [
  9766. "application/json"
  9767. ],
  9768. "tags": [
  9769. "organization"
  9770. ],
  9771. "summary": "Add a team member",
  9772. "operationId": "orgAddTeamMember",
  9773. "parameters": [
  9774. {
  9775. "type": "integer",
  9776. "format": "int64",
  9777. "description": "id of the team",
  9778. "name": "id",
  9779. "in": "path",
  9780. "required": true
  9781. },
  9782. {
  9783. "type": "string",
  9784. "description": "username of the user to add",
  9785. "name": "username",
  9786. "in": "path",
  9787. "required": true
  9788. }
  9789. ],
  9790. "responses": {
  9791. "204": {
  9792. "$ref": "#/responses/empty"
  9793. },
  9794. "404": {
  9795. "$ref": "#/responses/notFound"
  9796. }
  9797. }
  9798. },
  9799. "delete": {
  9800. "produces": [
  9801. "application/json"
  9802. ],
  9803. "tags": [
  9804. "organization"
  9805. ],
  9806. "summary": "Remove a team member",
  9807. "operationId": "orgRemoveTeamMember",
  9808. "parameters": [
  9809. {
  9810. "type": "integer",
  9811. "format": "int64",
  9812. "description": "id of the team",
  9813. "name": "id",
  9814. "in": "path",
  9815. "required": true
  9816. },
  9817. {
  9818. "type": "string",
  9819. "description": "username of the user to remove",
  9820. "name": "username",
  9821. "in": "path",
  9822. "required": true
  9823. }
  9824. ],
  9825. "responses": {
  9826. "204": {
  9827. "$ref": "#/responses/empty"
  9828. },
  9829. "404": {
  9830. "$ref": "#/responses/notFound"
  9831. }
  9832. }
  9833. }
  9834. },
  9835. "/teams/{id}/repos": {
  9836. "get": {
  9837. "produces": [
  9838. "application/json"
  9839. ],
  9840. "tags": [
  9841. "organization"
  9842. ],
  9843. "summary": "List a team's repos",
  9844. "operationId": "orgListTeamRepos",
  9845. "parameters": [
  9846. {
  9847. "type": "integer",
  9848. "format": "int64",
  9849. "description": "id of the team",
  9850. "name": "id",
  9851. "in": "path",
  9852. "required": true
  9853. },
  9854. {
  9855. "type": "integer",
  9856. "description": "page number of results to return (1-based)",
  9857. "name": "page",
  9858. "in": "query"
  9859. },
  9860. {
  9861. "type": "integer",
  9862. "description": "page size of results",
  9863. "name": "limit",
  9864. "in": "query"
  9865. }
  9866. ],
  9867. "responses": {
  9868. "200": {
  9869. "$ref": "#/responses/RepositoryList"
  9870. }
  9871. }
  9872. }
  9873. },
  9874. "/teams/{id}/repos/{org}/{repo}": {
  9875. "put": {
  9876. "produces": [
  9877. "application/json"
  9878. ],
  9879. "tags": [
  9880. "organization"
  9881. ],
  9882. "summary": "Add a repository to a team",
  9883. "operationId": "orgAddTeamRepository",
  9884. "parameters": [
  9885. {
  9886. "type": "integer",
  9887. "format": "int64",
  9888. "description": "id of the team",
  9889. "name": "id",
  9890. "in": "path",
  9891. "required": true
  9892. },
  9893. {
  9894. "type": "string",
  9895. "description": "organization that owns the repo to add",
  9896. "name": "org",
  9897. "in": "path",
  9898. "required": true
  9899. },
  9900. {
  9901. "type": "string",
  9902. "description": "name of the repo to add",
  9903. "name": "repo",
  9904. "in": "path",
  9905. "required": true
  9906. }
  9907. ],
  9908. "responses": {
  9909. "204": {
  9910. "$ref": "#/responses/empty"
  9911. },
  9912. "403": {
  9913. "$ref": "#/responses/forbidden"
  9914. }
  9915. }
  9916. },
  9917. "delete": {
  9918. "description": "This does not delete the repository, it only removes the repository from the team.",
  9919. "produces": [
  9920. "application/json"
  9921. ],
  9922. "tags": [
  9923. "organization"
  9924. ],
  9925. "summary": "Remove a repository from a team",
  9926. "operationId": "orgRemoveTeamRepository",
  9927. "parameters": [
  9928. {
  9929. "type": "integer",
  9930. "format": "int64",
  9931. "description": "id of the team",
  9932. "name": "id",
  9933. "in": "path",
  9934. "required": true
  9935. },
  9936. {
  9937. "type": "string",
  9938. "description": "organization that owns the repo to remove",
  9939. "name": "org",
  9940. "in": "path",
  9941. "required": true
  9942. },
  9943. {
  9944. "type": "string",
  9945. "description": "name of the repo to remove",
  9946. "name": "repo",
  9947. "in": "path",
  9948. "required": true
  9949. }
  9950. ],
  9951. "responses": {
  9952. "204": {
  9953. "$ref": "#/responses/empty"
  9954. },
  9955. "403": {
  9956. "$ref": "#/responses/forbidden"
  9957. }
  9958. }
  9959. }
  9960. },
  9961. "/topics/search": {
  9962. "get": {
  9963. "produces": [
  9964. "application/json"
  9965. ],
  9966. "tags": [
  9967. "repository"
  9968. ],
  9969. "summary": "search topics via keyword",
  9970. "operationId": "topicSearch",
  9971. "parameters": [
  9972. {
  9973. "type": "string",
  9974. "description": "keywords to search",
  9975. "name": "q",
  9976. "in": "query",
  9977. "required": true
  9978. },
  9979. {
  9980. "type": "integer",
  9981. "description": "page number of results to return (1-based)",
  9982. "name": "page",
  9983. "in": "query"
  9984. },
  9985. {
  9986. "type": "integer",
  9987. "description": "page size of results",
  9988. "name": "limit",
  9989. "in": "query"
  9990. }
  9991. ],
  9992. "responses": {
  9993. "200": {
  9994. "$ref": "#/responses/TopicListResponse"
  9995. },
  9996. "403": {
  9997. "$ref": "#/responses/forbidden"
  9998. }
  9999. }
  10000. }
  10001. },
  10002. "/user": {
  10003. "get": {
  10004. "produces": [
  10005. "application/json"
  10006. ],
  10007. "tags": [
  10008. "user"
  10009. ],
  10010. "summary": "Get the authenticated user",
  10011. "operationId": "userGetCurrent",
  10012. "responses": {
  10013. "200": {
  10014. "$ref": "#/responses/User"
  10015. }
  10016. }
  10017. }
  10018. },
  10019. "/user/applications/oauth2": {
  10020. "get": {
  10021. "produces": [
  10022. "application/json"
  10023. ],
  10024. "tags": [
  10025. "user"
  10026. ],
  10027. "summary": "List the authenticated user's oauth2 applications",
  10028. "operationId": "userGetOauth2Application",
  10029. "parameters": [
  10030. {
  10031. "type": "integer",
  10032. "description": "page number of results to return (1-based)",
  10033. "name": "page",
  10034. "in": "query"
  10035. },
  10036. {
  10037. "type": "integer",
  10038. "description": "page size of results",
  10039. "name": "limit",
  10040. "in": "query"
  10041. }
  10042. ],
  10043. "responses": {
  10044. "200": {
  10045. "$ref": "#/responses/OAuth2ApplicationList"
  10046. }
  10047. }
  10048. },
  10049. "post": {
  10050. "produces": [
  10051. "application/json"
  10052. ],
  10053. "tags": [
  10054. "user"
  10055. ],
  10056. "summary": "creates a new OAuth2 application",
  10057. "operationId": "userCreateOAuth2Application",
  10058. "parameters": [
  10059. {
  10060. "name": "body",
  10061. "in": "body",
  10062. "required": true,
  10063. "schema": {
  10064. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  10065. }
  10066. }
  10067. ],
  10068. "responses": {
  10069. "201": {
  10070. "$ref": "#/responses/OAuth2Application"
  10071. }
  10072. }
  10073. }
  10074. },
  10075. "/user/applications/oauth2/{id}": {
  10076. "get": {
  10077. "produces": [
  10078. "application/json"
  10079. ],
  10080. "tags": [
  10081. "user"
  10082. ],
  10083. "summary": "get an OAuth2 Application",
  10084. "operationId": "userGetOAuth2Application",
  10085. "parameters": [
  10086. {
  10087. "type": "integer",
  10088. "format": "int64",
  10089. "description": "Application ID to be found",
  10090. "name": "id",
  10091. "in": "path",
  10092. "required": true
  10093. }
  10094. ],
  10095. "responses": {
  10096. "200": {
  10097. "$ref": "#/responses/OAuth2Application"
  10098. }
  10099. }
  10100. },
  10101. "delete": {
  10102. "produces": [
  10103. "application/json"
  10104. ],
  10105. "tags": [
  10106. "user"
  10107. ],
  10108. "summary": "delete an OAuth2 Application",
  10109. "operationId": "userDeleteOAuth2Application",
  10110. "parameters": [
  10111. {
  10112. "type": "integer",
  10113. "format": "int64",
  10114. "description": "token to be deleted",
  10115. "name": "id",
  10116. "in": "path",
  10117. "required": true
  10118. }
  10119. ],
  10120. "responses": {
  10121. "204": {
  10122. "$ref": "#/responses/empty"
  10123. }
  10124. }
  10125. },
  10126. "patch": {
  10127. "produces": [
  10128. "application/json"
  10129. ],
  10130. "tags": [
  10131. "user"
  10132. ],
  10133. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  10134. "operationId": "userUpdateOAuth2Application",
  10135. "parameters": [
  10136. {
  10137. "type": "integer",
  10138. "format": "int64",
  10139. "description": "application to be updated",
  10140. "name": "id",
  10141. "in": "path",
  10142. "required": true
  10143. },
  10144. {
  10145. "name": "body",
  10146. "in": "body",
  10147. "required": true,
  10148. "schema": {
  10149. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  10150. }
  10151. }
  10152. ],
  10153. "responses": {
  10154. "200": {
  10155. "$ref": "#/responses/OAuth2Application"
  10156. }
  10157. }
  10158. }
  10159. },
  10160. "/user/emails": {
  10161. "get": {
  10162. "produces": [
  10163. "application/json"
  10164. ],
  10165. "tags": [
  10166. "user"
  10167. ],
  10168. "summary": "List the authenticated user's email addresses",
  10169. "operationId": "userListEmails",
  10170. "responses": {
  10171. "200": {
  10172. "$ref": "#/responses/EmailList"
  10173. }
  10174. }
  10175. },
  10176. "post": {
  10177. "produces": [
  10178. "application/json"
  10179. ],
  10180. "tags": [
  10181. "user"
  10182. ],
  10183. "summary": "Add email addresses",
  10184. "operationId": "userAddEmail",
  10185. "parameters": [
  10186. {
  10187. "name": "body",
  10188. "in": "body",
  10189. "schema": {
  10190. "$ref": "#/definitions/CreateEmailOption"
  10191. }
  10192. }
  10193. ],
  10194. "responses": {
  10195. "201": {
  10196. "$ref": "#/responses/EmailList"
  10197. },
  10198. "422": {
  10199. "$ref": "#/responses/validationError"
  10200. }
  10201. }
  10202. },
  10203. "delete": {
  10204. "produces": [
  10205. "application/json"
  10206. ],
  10207. "tags": [
  10208. "user"
  10209. ],
  10210. "summary": "Delete email addresses",
  10211. "operationId": "userDeleteEmail",
  10212. "parameters": [
  10213. {
  10214. "name": "body",
  10215. "in": "body",
  10216. "schema": {
  10217. "$ref": "#/definitions/DeleteEmailOption"
  10218. }
  10219. }
  10220. ],
  10221. "responses": {
  10222. "204": {
  10223. "$ref": "#/responses/empty"
  10224. },
  10225. "404": {
  10226. "$ref": "#/responses/notFound"
  10227. }
  10228. }
  10229. }
  10230. },
  10231. "/user/followers": {
  10232. "get": {
  10233. "produces": [
  10234. "application/json"
  10235. ],
  10236. "tags": [
  10237. "user"
  10238. ],
  10239. "summary": "List the authenticated user's followers",
  10240. "operationId": "userCurrentListFollowers",
  10241. "parameters": [
  10242. {
  10243. "type": "integer",
  10244. "description": "page number of results to return (1-based)",
  10245. "name": "page",
  10246. "in": "query"
  10247. },
  10248. {
  10249. "type": "integer",
  10250. "description": "page size of results",
  10251. "name": "limit",
  10252. "in": "query"
  10253. }
  10254. ],
  10255. "responses": {
  10256. "200": {
  10257. "$ref": "#/responses/UserList"
  10258. }
  10259. }
  10260. }
  10261. },
  10262. "/user/following": {
  10263. "get": {
  10264. "produces": [
  10265. "application/json"
  10266. ],
  10267. "tags": [
  10268. "user"
  10269. ],
  10270. "summary": "List the users that the authenticated user is following",
  10271. "operationId": "userCurrentListFollowing",
  10272. "parameters": [
  10273. {
  10274. "type": "integer",
  10275. "description": "page number of results to return (1-based)",
  10276. "name": "page",
  10277. "in": "query"
  10278. },
  10279. {
  10280. "type": "integer",
  10281. "description": "page size of results",
  10282. "name": "limit",
  10283. "in": "query"
  10284. }
  10285. ],
  10286. "responses": {
  10287. "200": {
  10288. "$ref": "#/responses/UserList"
  10289. }
  10290. }
  10291. }
  10292. },
  10293. "/user/following/{username}": {
  10294. "get": {
  10295. "tags": [
  10296. "user"
  10297. ],
  10298. "summary": "Check whether a user is followed by the authenticated user",
  10299. "operationId": "userCurrentCheckFollowing",
  10300. "parameters": [
  10301. {
  10302. "type": "string",
  10303. "description": "username of followed user",
  10304. "name": "username",
  10305. "in": "path",
  10306. "required": true
  10307. }
  10308. ],
  10309. "responses": {
  10310. "204": {
  10311. "$ref": "#/responses/empty"
  10312. },
  10313. "404": {
  10314. "$ref": "#/responses/notFound"
  10315. }
  10316. }
  10317. },
  10318. "put": {
  10319. "tags": [
  10320. "user"
  10321. ],
  10322. "summary": "Follow a user",
  10323. "operationId": "userCurrentPutFollow",
  10324. "parameters": [
  10325. {
  10326. "type": "string",
  10327. "description": "username of user to follow",
  10328. "name": "username",
  10329. "in": "path",
  10330. "required": true
  10331. }
  10332. ],
  10333. "responses": {
  10334. "204": {
  10335. "$ref": "#/responses/empty"
  10336. }
  10337. }
  10338. },
  10339. "delete": {
  10340. "tags": [
  10341. "user"
  10342. ],
  10343. "summary": "Unfollow a user",
  10344. "operationId": "userCurrentDeleteFollow",
  10345. "parameters": [
  10346. {
  10347. "type": "string",
  10348. "description": "username of user to unfollow",
  10349. "name": "username",
  10350. "in": "path",
  10351. "required": true
  10352. }
  10353. ],
  10354. "responses": {
  10355. "204": {
  10356. "$ref": "#/responses/empty"
  10357. }
  10358. }
  10359. }
  10360. },
  10361. "/user/gpg_keys": {
  10362. "get": {
  10363. "produces": [
  10364. "application/json"
  10365. ],
  10366. "tags": [
  10367. "user"
  10368. ],
  10369. "summary": "List the authenticated user's GPG keys",
  10370. "operationId": "userCurrentListGPGKeys",
  10371. "parameters": [
  10372. {
  10373. "type": "integer",
  10374. "description": "page number of results to return (1-based)",
  10375. "name": "page",
  10376. "in": "query"
  10377. },
  10378. {
  10379. "type": "integer",
  10380. "description": "page size of results",
  10381. "name": "limit",
  10382. "in": "query"
  10383. }
  10384. ],
  10385. "responses": {
  10386. "200": {
  10387. "$ref": "#/responses/GPGKeyList"
  10388. }
  10389. }
  10390. },
  10391. "post": {
  10392. "consumes": [
  10393. "application/json"
  10394. ],
  10395. "produces": [
  10396. "application/json"
  10397. ],
  10398. "tags": [
  10399. "user"
  10400. ],
  10401. "summary": "Create a GPG key",
  10402. "operationId": "userCurrentPostGPGKey",
  10403. "parameters": [
  10404. {
  10405. "name": "Form",
  10406. "in": "body",
  10407. "schema": {
  10408. "$ref": "#/definitions/CreateGPGKeyOption"
  10409. }
  10410. }
  10411. ],
  10412. "responses": {
  10413. "201": {
  10414. "$ref": "#/responses/GPGKey"
  10415. },
  10416. "404": {
  10417. "$ref": "#/responses/notFound"
  10418. },
  10419. "422": {
  10420. "$ref": "#/responses/validationError"
  10421. }
  10422. }
  10423. }
  10424. },
  10425. "/user/gpg_keys/{id}": {
  10426. "get": {
  10427. "produces": [
  10428. "application/json"
  10429. ],
  10430. "tags": [
  10431. "user"
  10432. ],
  10433. "summary": "Get a GPG key",
  10434. "operationId": "userCurrentGetGPGKey",
  10435. "parameters": [
  10436. {
  10437. "type": "integer",
  10438. "format": "int64",
  10439. "description": "id of key to get",
  10440. "name": "id",
  10441. "in": "path",
  10442. "required": true
  10443. }
  10444. ],
  10445. "responses": {
  10446. "200": {
  10447. "$ref": "#/responses/GPGKey"
  10448. },
  10449. "404": {
  10450. "$ref": "#/responses/notFound"
  10451. }
  10452. }
  10453. },
  10454. "delete": {
  10455. "produces": [
  10456. "application/json"
  10457. ],
  10458. "tags": [
  10459. "user"
  10460. ],
  10461. "summary": "Remove a GPG key",
  10462. "operationId": "userCurrentDeleteGPGKey",
  10463. "parameters": [
  10464. {
  10465. "type": "integer",
  10466. "format": "int64",
  10467. "description": "id of key to delete",
  10468. "name": "id",
  10469. "in": "path",
  10470. "required": true
  10471. }
  10472. ],
  10473. "responses": {
  10474. "204": {
  10475. "$ref": "#/responses/empty"
  10476. },
  10477. "403": {
  10478. "$ref": "#/responses/forbidden"
  10479. },
  10480. "404": {
  10481. "$ref": "#/responses/notFound"
  10482. }
  10483. }
  10484. }
  10485. },
  10486. "/user/keys": {
  10487. "get": {
  10488. "produces": [
  10489. "application/json"
  10490. ],
  10491. "tags": [
  10492. "user"
  10493. ],
  10494. "summary": "List the authenticated user's public keys",
  10495. "operationId": "userCurrentListKeys",
  10496. "parameters": [
  10497. {
  10498. "type": "string",
  10499. "description": "fingerprint of the key",
  10500. "name": "fingerprint",
  10501. "in": "query"
  10502. },
  10503. {
  10504. "type": "integer",
  10505. "description": "page number of results to return (1-based)",
  10506. "name": "page",
  10507. "in": "query"
  10508. },
  10509. {
  10510. "type": "integer",
  10511. "description": "page size of results",
  10512. "name": "limit",
  10513. "in": "query"
  10514. }
  10515. ],
  10516. "responses": {
  10517. "200": {
  10518. "$ref": "#/responses/PublicKeyList"
  10519. }
  10520. }
  10521. },
  10522. "post": {
  10523. "consumes": [
  10524. "application/json"
  10525. ],
  10526. "produces": [
  10527. "application/json"
  10528. ],
  10529. "tags": [
  10530. "user"
  10531. ],
  10532. "summary": "Create a public key",
  10533. "operationId": "userCurrentPostKey",
  10534. "parameters": [
  10535. {
  10536. "name": "body",
  10537. "in": "body",
  10538. "schema": {
  10539. "$ref": "#/definitions/CreateKeyOption"
  10540. }
  10541. }
  10542. ],
  10543. "responses": {
  10544. "201": {
  10545. "$ref": "#/responses/PublicKey"
  10546. },
  10547. "422": {
  10548. "$ref": "#/responses/validationError"
  10549. }
  10550. }
  10551. }
  10552. },
  10553. "/user/keys/{id}": {
  10554. "get": {
  10555. "produces": [
  10556. "application/json"
  10557. ],
  10558. "tags": [
  10559. "user"
  10560. ],
  10561. "summary": "Get a public key",
  10562. "operationId": "userCurrentGetKey",
  10563. "parameters": [
  10564. {
  10565. "type": "integer",
  10566. "format": "int64",
  10567. "description": "id of key to get",
  10568. "name": "id",
  10569. "in": "path",
  10570. "required": true
  10571. }
  10572. ],
  10573. "responses": {
  10574. "200": {
  10575. "$ref": "#/responses/PublicKey"
  10576. },
  10577. "404": {
  10578. "$ref": "#/responses/notFound"
  10579. }
  10580. }
  10581. },
  10582. "delete": {
  10583. "produces": [
  10584. "application/json"
  10585. ],
  10586. "tags": [
  10587. "user"
  10588. ],
  10589. "summary": "Delete a public key",
  10590. "operationId": "userCurrentDeleteKey",
  10591. "parameters": [
  10592. {
  10593. "type": "integer",
  10594. "format": "int64",
  10595. "description": "id of key to delete",
  10596. "name": "id",
  10597. "in": "path",
  10598. "required": true
  10599. }
  10600. ],
  10601. "responses": {
  10602. "204": {
  10603. "$ref": "#/responses/empty"
  10604. },
  10605. "403": {
  10606. "$ref": "#/responses/forbidden"
  10607. },
  10608. "404": {
  10609. "$ref": "#/responses/notFound"
  10610. }
  10611. }
  10612. }
  10613. },
  10614. "/user/orgs": {
  10615. "get": {
  10616. "produces": [
  10617. "application/json"
  10618. ],
  10619. "tags": [
  10620. "organization"
  10621. ],
  10622. "summary": "List the current user's organizations",
  10623. "operationId": "orgListCurrentUserOrgs",
  10624. "parameters": [
  10625. {
  10626. "type": "integer",
  10627. "description": "page number of results to return (1-based)",
  10628. "name": "page",
  10629. "in": "query"
  10630. },
  10631. {
  10632. "type": "integer",
  10633. "description": "page size of results",
  10634. "name": "limit",
  10635. "in": "query"
  10636. }
  10637. ],
  10638. "responses": {
  10639. "200": {
  10640. "$ref": "#/responses/OrganizationList"
  10641. }
  10642. }
  10643. }
  10644. },
  10645. "/user/repos": {
  10646. "get": {
  10647. "produces": [
  10648. "application/json"
  10649. ],
  10650. "tags": [
  10651. "user"
  10652. ],
  10653. "summary": "List the repos that the authenticated user owns or has access to",
  10654. "operationId": "userCurrentListRepos",
  10655. "parameters": [
  10656. {
  10657. "type": "integer",
  10658. "description": "page number of results to return (1-based)",
  10659. "name": "page",
  10660. "in": "query"
  10661. },
  10662. {
  10663. "type": "integer",
  10664. "description": "page size of results",
  10665. "name": "limit",
  10666. "in": "query"
  10667. }
  10668. ],
  10669. "responses": {
  10670. "200": {
  10671. "$ref": "#/responses/RepositoryList"
  10672. }
  10673. }
  10674. },
  10675. "post": {
  10676. "consumes": [
  10677. "application/json"
  10678. ],
  10679. "produces": [
  10680. "application/json"
  10681. ],
  10682. "tags": [
  10683. "repository",
  10684. "user"
  10685. ],
  10686. "summary": "Create a repository",
  10687. "operationId": "createCurrentUserRepo",
  10688. "parameters": [
  10689. {
  10690. "name": "body",
  10691. "in": "body",
  10692. "schema": {
  10693. "$ref": "#/definitions/CreateRepoOption"
  10694. }
  10695. }
  10696. ],
  10697. "responses": {
  10698. "201": {
  10699. "$ref": "#/responses/Repository"
  10700. },
  10701. "409": {
  10702. "description": "The repository with the same name already exists."
  10703. },
  10704. "422": {
  10705. "$ref": "#/responses/validationError"
  10706. }
  10707. }
  10708. }
  10709. },
  10710. "/user/starred": {
  10711. "get": {
  10712. "produces": [
  10713. "application/json"
  10714. ],
  10715. "tags": [
  10716. "user"
  10717. ],
  10718. "summary": "The repos that the authenticated user has starred",
  10719. "operationId": "userCurrentListStarred",
  10720. "parameters": [
  10721. {
  10722. "type": "integer",
  10723. "description": "page number of results to return (1-based)",
  10724. "name": "page",
  10725. "in": "query"
  10726. },
  10727. {
  10728. "type": "integer",
  10729. "description": "page size of results",
  10730. "name": "limit",
  10731. "in": "query"
  10732. }
  10733. ],
  10734. "responses": {
  10735. "200": {
  10736. "$ref": "#/responses/RepositoryList"
  10737. }
  10738. }
  10739. }
  10740. },
  10741. "/user/starred/{owner}/{repo}": {
  10742. "get": {
  10743. "tags": [
  10744. "user"
  10745. ],
  10746. "summary": "Whether the authenticated is starring the repo",
  10747. "operationId": "userCurrentCheckStarring",
  10748. "parameters": [
  10749. {
  10750. "type": "string",
  10751. "description": "owner of the repo",
  10752. "name": "owner",
  10753. "in": "path",
  10754. "required": true
  10755. },
  10756. {
  10757. "type": "string",
  10758. "description": "name of the repo",
  10759. "name": "repo",
  10760. "in": "path",
  10761. "required": true
  10762. }
  10763. ],
  10764. "responses": {
  10765. "204": {
  10766. "$ref": "#/responses/empty"
  10767. },
  10768. "404": {
  10769. "$ref": "#/responses/notFound"
  10770. }
  10771. }
  10772. },
  10773. "put": {
  10774. "tags": [
  10775. "user"
  10776. ],
  10777. "summary": "Star the given repo",
  10778. "operationId": "userCurrentPutStar",
  10779. "parameters": [
  10780. {
  10781. "type": "string",
  10782. "description": "owner of the repo to star",
  10783. "name": "owner",
  10784. "in": "path",
  10785. "required": true
  10786. },
  10787. {
  10788. "type": "string",
  10789. "description": "name of the repo to star",
  10790. "name": "repo",
  10791. "in": "path",
  10792. "required": true
  10793. }
  10794. ],
  10795. "responses": {
  10796. "204": {
  10797. "$ref": "#/responses/empty"
  10798. }
  10799. }
  10800. },
  10801. "delete": {
  10802. "tags": [
  10803. "user"
  10804. ],
  10805. "summary": "Unstar the given repo",
  10806. "operationId": "userCurrentDeleteStar",
  10807. "parameters": [
  10808. {
  10809. "type": "string",
  10810. "description": "owner of the repo to unstar",
  10811. "name": "owner",
  10812. "in": "path",
  10813. "required": true
  10814. },
  10815. {
  10816. "type": "string",
  10817. "description": "name of the repo to unstar",
  10818. "name": "repo",
  10819. "in": "path",
  10820. "required": true
  10821. }
  10822. ],
  10823. "responses": {
  10824. "204": {
  10825. "$ref": "#/responses/empty"
  10826. }
  10827. }
  10828. }
  10829. },
  10830. "/user/stopwatches": {
  10831. "get": {
  10832. "consumes": [
  10833. "application/json"
  10834. ],
  10835. "produces": [
  10836. "application/json"
  10837. ],
  10838. "tags": [
  10839. "user"
  10840. ],
  10841. "summary": "Get list of all existing stopwatches",
  10842. "operationId": "userGetStopWatches",
  10843. "parameters": [
  10844. {
  10845. "type": "integer",
  10846. "description": "page number of results to return (1-based)",
  10847. "name": "page",
  10848. "in": "query"
  10849. },
  10850. {
  10851. "type": "integer",
  10852. "description": "page size of results",
  10853. "name": "limit",
  10854. "in": "query"
  10855. }
  10856. ],
  10857. "responses": {
  10858. "200": {
  10859. "$ref": "#/responses/StopWatchList"
  10860. }
  10861. }
  10862. }
  10863. },
  10864. "/user/subscriptions": {
  10865. "get": {
  10866. "produces": [
  10867. "application/json"
  10868. ],
  10869. "tags": [
  10870. "user"
  10871. ],
  10872. "summary": "List repositories watched by the authenticated user",
  10873. "operationId": "userCurrentListSubscriptions",
  10874. "parameters": [
  10875. {
  10876. "type": "integer",
  10877. "description": "page number of results to return (1-based)",
  10878. "name": "page",
  10879. "in": "query"
  10880. },
  10881. {
  10882. "type": "integer",
  10883. "description": "page size of results",
  10884. "name": "limit",
  10885. "in": "query"
  10886. }
  10887. ],
  10888. "responses": {
  10889. "200": {
  10890. "$ref": "#/responses/RepositoryList"
  10891. }
  10892. }
  10893. }
  10894. },
  10895. "/user/teams": {
  10896. "get": {
  10897. "produces": [
  10898. "application/json"
  10899. ],
  10900. "tags": [
  10901. "user"
  10902. ],
  10903. "summary": "List all the teams a user belongs to",
  10904. "operationId": "userListTeams",
  10905. "parameters": [
  10906. {
  10907. "type": "integer",
  10908. "description": "page number of results to return (1-based)",
  10909. "name": "page",
  10910. "in": "query"
  10911. },
  10912. {
  10913. "type": "integer",
  10914. "description": "page size of results",
  10915. "name": "limit",
  10916. "in": "query"
  10917. }
  10918. ],
  10919. "responses": {
  10920. "200": {
  10921. "$ref": "#/responses/TeamList"
  10922. }
  10923. }
  10924. }
  10925. },
  10926. "/user/times": {
  10927. "get": {
  10928. "produces": [
  10929. "application/json"
  10930. ],
  10931. "tags": [
  10932. "user"
  10933. ],
  10934. "summary": "List the current user's tracked times",
  10935. "operationId": "userCurrentTrackedTimes",
  10936. "parameters": [
  10937. {
  10938. "type": "string",
  10939. "format": "date-time",
  10940. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  10941. "name": "since",
  10942. "in": "query"
  10943. },
  10944. {
  10945. "type": "string",
  10946. "format": "date-time",
  10947. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  10948. "name": "before",
  10949. "in": "query"
  10950. }
  10951. ],
  10952. "responses": {
  10953. "200": {
  10954. "$ref": "#/responses/TrackedTimeList"
  10955. }
  10956. }
  10957. }
  10958. },
  10959. "/users/search": {
  10960. "get": {
  10961. "produces": [
  10962. "application/json"
  10963. ],
  10964. "tags": [
  10965. "user"
  10966. ],
  10967. "summary": "Search for users",
  10968. "operationId": "userSearch",
  10969. "parameters": [
  10970. {
  10971. "type": "string",
  10972. "description": "keyword",
  10973. "name": "q",
  10974. "in": "query"
  10975. },
  10976. {
  10977. "type": "integer",
  10978. "format": "int64",
  10979. "description": "ID of the user to search for",
  10980. "name": "uid",
  10981. "in": "query"
  10982. },
  10983. {
  10984. "type": "integer",
  10985. "description": "page number of results to return (1-based)",
  10986. "name": "page",
  10987. "in": "query"
  10988. },
  10989. {
  10990. "type": "integer",
  10991. "description": "page size of results",
  10992. "name": "limit",
  10993. "in": "query"
  10994. }
  10995. ],
  10996. "responses": {
  10997. "200": {
  10998. "description": "SearchResults of a successful search",
  10999. "schema": {
  11000. "type": "object",
  11001. "properties": {
  11002. "data": {
  11003. "type": "array",
  11004. "items": {
  11005. "$ref": "#/definitions/User"
  11006. }
  11007. },
  11008. "ok": {
  11009. "type": "boolean"
  11010. }
  11011. }
  11012. }
  11013. }
  11014. }
  11015. }
  11016. },
  11017. "/users/{follower}/following/{followee}": {
  11018. "get": {
  11019. "tags": [
  11020. "user"
  11021. ],
  11022. "summary": "Check if one user is following another user",
  11023. "operationId": "userCheckFollowing",
  11024. "parameters": [
  11025. {
  11026. "type": "string",
  11027. "description": "username of following user",
  11028. "name": "follower",
  11029. "in": "path",
  11030. "required": true
  11031. },
  11032. {
  11033. "type": "string",
  11034. "description": "username of followed user",
  11035. "name": "followee",
  11036. "in": "path",
  11037. "required": true
  11038. }
  11039. ],
  11040. "responses": {
  11041. "204": {
  11042. "$ref": "#/responses/empty"
  11043. },
  11044. "404": {
  11045. "$ref": "#/responses/notFound"
  11046. }
  11047. }
  11048. }
  11049. },
  11050. "/users/{username}": {
  11051. "get": {
  11052. "produces": [
  11053. "application/json"
  11054. ],
  11055. "tags": [
  11056. "user"
  11057. ],
  11058. "summary": "Get a user",
  11059. "operationId": "userGet",
  11060. "parameters": [
  11061. {
  11062. "type": "string",
  11063. "description": "username of user to get",
  11064. "name": "username",
  11065. "in": "path",
  11066. "required": true
  11067. }
  11068. ],
  11069. "responses": {
  11070. "200": {
  11071. "$ref": "#/responses/User"
  11072. },
  11073. "404": {
  11074. "$ref": "#/responses/notFound"
  11075. }
  11076. }
  11077. }
  11078. },
  11079. "/users/{username}/followers": {
  11080. "get": {
  11081. "produces": [
  11082. "application/json"
  11083. ],
  11084. "tags": [
  11085. "user"
  11086. ],
  11087. "summary": "List the given user's followers",
  11088. "operationId": "userListFollowers",
  11089. "parameters": [
  11090. {
  11091. "type": "string",
  11092. "description": "username of user",
  11093. "name": "username",
  11094. "in": "path",
  11095. "required": true
  11096. },
  11097. {
  11098. "type": "integer",
  11099. "description": "page number of results to return (1-based)",
  11100. "name": "page",
  11101. "in": "query"
  11102. },
  11103. {
  11104. "type": "integer",
  11105. "description": "page size of results",
  11106. "name": "limit",
  11107. "in": "query"
  11108. }
  11109. ],
  11110. "responses": {
  11111. "200": {
  11112. "$ref": "#/responses/UserList"
  11113. }
  11114. }
  11115. }
  11116. },
  11117. "/users/{username}/following": {
  11118. "get": {
  11119. "produces": [
  11120. "application/json"
  11121. ],
  11122. "tags": [
  11123. "user"
  11124. ],
  11125. "summary": "List the users that the given user is following",
  11126. "operationId": "userListFollowing",
  11127. "parameters": [
  11128. {
  11129. "type": "string",
  11130. "description": "username of user",
  11131. "name": "username",
  11132. "in": "path",
  11133. "required": true
  11134. },
  11135. {
  11136. "type": "integer",
  11137. "description": "page number of results to return (1-based)",
  11138. "name": "page",
  11139. "in": "query"
  11140. },
  11141. {
  11142. "type": "integer",
  11143. "description": "page size of results",
  11144. "name": "limit",
  11145. "in": "query"
  11146. }
  11147. ],
  11148. "responses": {
  11149. "200": {
  11150. "$ref": "#/responses/UserList"
  11151. }
  11152. }
  11153. }
  11154. },
  11155. "/users/{username}/gpg_keys": {
  11156. "get": {
  11157. "produces": [
  11158. "application/json"
  11159. ],
  11160. "tags": [
  11161. "user"
  11162. ],
  11163. "summary": "List the given user's GPG keys",
  11164. "operationId": "userListGPGKeys",
  11165. "parameters": [
  11166. {
  11167. "type": "string",
  11168. "description": "username of user",
  11169. "name": "username",
  11170. "in": "path",
  11171. "required": true
  11172. },
  11173. {
  11174. "type": "integer",
  11175. "description": "page number of results to return (1-based)",
  11176. "name": "page",
  11177. "in": "query"
  11178. },
  11179. {
  11180. "type": "integer",
  11181. "description": "page size of results",
  11182. "name": "limit",
  11183. "in": "query"
  11184. }
  11185. ],
  11186. "responses": {
  11187. "200": {
  11188. "$ref": "#/responses/GPGKeyList"
  11189. }
  11190. }
  11191. }
  11192. },
  11193. "/users/{username}/heatmap": {
  11194. "get": {
  11195. "produces": [
  11196. "application/json"
  11197. ],
  11198. "tags": [
  11199. "user"
  11200. ],
  11201. "summary": "Get a user's heatmap",
  11202. "operationId": "userGetHeatmapData",
  11203. "parameters": [
  11204. {
  11205. "type": "string",
  11206. "description": "username of user to get",
  11207. "name": "username",
  11208. "in": "path",
  11209. "required": true
  11210. }
  11211. ],
  11212. "responses": {
  11213. "200": {
  11214. "$ref": "#/responses/UserHeatmapData"
  11215. },
  11216. "404": {
  11217. "$ref": "#/responses/notFound"
  11218. }
  11219. }
  11220. }
  11221. },
  11222. "/users/{username}/keys": {
  11223. "get": {
  11224. "produces": [
  11225. "application/json"
  11226. ],
  11227. "tags": [
  11228. "user"
  11229. ],
  11230. "summary": "List the given user's public keys",
  11231. "operationId": "userListKeys",
  11232. "parameters": [
  11233. {
  11234. "type": "string",
  11235. "description": "username of user",
  11236. "name": "username",
  11237. "in": "path",
  11238. "required": true
  11239. },
  11240. {
  11241. "type": "string",
  11242. "description": "fingerprint of the key",
  11243. "name": "fingerprint",
  11244. "in": "query"
  11245. },
  11246. {
  11247. "type": "integer",
  11248. "description": "page number of results to return (1-based)",
  11249. "name": "page",
  11250. "in": "query"
  11251. },
  11252. {
  11253. "type": "integer",
  11254. "description": "page size of results",
  11255. "name": "limit",
  11256. "in": "query"
  11257. }
  11258. ],
  11259. "responses": {
  11260. "200": {
  11261. "$ref": "#/responses/PublicKeyList"
  11262. }
  11263. }
  11264. }
  11265. },
  11266. "/users/{username}/orgs": {
  11267. "get": {
  11268. "produces": [
  11269. "application/json"
  11270. ],
  11271. "tags": [
  11272. "organization"
  11273. ],
  11274. "summary": "List a user's organizations",
  11275. "operationId": "orgListUserOrgs",
  11276. "parameters": [
  11277. {
  11278. "type": "string",
  11279. "description": "username of user",
  11280. "name": "username",
  11281. "in": "path",
  11282. "required": true
  11283. },
  11284. {
  11285. "type": "integer",
  11286. "description": "page number of results to return (1-based)",
  11287. "name": "page",
  11288. "in": "query"
  11289. },
  11290. {
  11291. "type": "integer",
  11292. "description": "page size of results",
  11293. "name": "limit",
  11294. "in": "query"
  11295. }
  11296. ],
  11297. "responses": {
  11298. "200": {
  11299. "$ref": "#/responses/OrganizationList"
  11300. }
  11301. }
  11302. }
  11303. },
  11304. "/users/{username}/repos": {
  11305. "get": {
  11306. "produces": [
  11307. "application/json"
  11308. ],
  11309. "tags": [
  11310. "user"
  11311. ],
  11312. "summary": "List the repos owned by the given user",
  11313. "operationId": "userListRepos",
  11314. "parameters": [
  11315. {
  11316. "type": "string",
  11317. "description": "username of user",
  11318. "name": "username",
  11319. "in": "path",
  11320. "required": true
  11321. },
  11322. {
  11323. "type": "integer",
  11324. "description": "page number of results to return (1-based)",
  11325. "name": "page",
  11326. "in": "query"
  11327. },
  11328. {
  11329. "type": "integer",
  11330. "description": "page size of results",
  11331. "name": "limit",
  11332. "in": "query"
  11333. }
  11334. ],
  11335. "responses": {
  11336. "200": {
  11337. "$ref": "#/responses/RepositoryList"
  11338. }
  11339. }
  11340. }
  11341. },
  11342. "/users/{username}/starred": {
  11343. "get": {
  11344. "produces": [
  11345. "application/json"
  11346. ],
  11347. "tags": [
  11348. "user"
  11349. ],
  11350. "summary": "The repos that the given user has starred",
  11351. "operationId": "userListStarred",
  11352. "parameters": [
  11353. {
  11354. "type": "string",
  11355. "description": "username of user",
  11356. "name": "username",
  11357. "in": "path",
  11358. "required": true
  11359. },
  11360. {
  11361. "type": "integer",
  11362. "description": "page number of results to return (1-based)",
  11363. "name": "page",
  11364. "in": "query"
  11365. },
  11366. {
  11367. "type": "integer",
  11368. "description": "page size of results",
  11369. "name": "limit",
  11370. "in": "query"
  11371. }
  11372. ],
  11373. "responses": {
  11374. "200": {
  11375. "$ref": "#/responses/RepositoryList"
  11376. }
  11377. }
  11378. }
  11379. },
  11380. "/users/{username}/subscriptions": {
  11381. "get": {
  11382. "produces": [
  11383. "application/json"
  11384. ],
  11385. "tags": [
  11386. "user"
  11387. ],
  11388. "summary": "List the repositories watched by a user",
  11389. "operationId": "userListSubscriptions",
  11390. "parameters": [
  11391. {
  11392. "type": "string",
  11393. "description": "username of the user",
  11394. "name": "username",
  11395. "in": "path",
  11396. "required": true
  11397. },
  11398. {
  11399. "type": "integer",
  11400. "description": "page number of results to return (1-based)",
  11401. "name": "page",
  11402. "in": "query"
  11403. },
  11404. {
  11405. "type": "integer",
  11406. "description": "page size of results",
  11407. "name": "limit",
  11408. "in": "query"
  11409. }
  11410. ],
  11411. "responses": {
  11412. "200": {
  11413. "$ref": "#/responses/RepositoryList"
  11414. }
  11415. }
  11416. }
  11417. },
  11418. "/users/{username}/tokens": {
  11419. "get": {
  11420. "produces": [
  11421. "application/json"
  11422. ],
  11423. "tags": [
  11424. "user"
  11425. ],
  11426. "summary": "List the authenticated user's access tokens",
  11427. "operationId": "userGetTokens",
  11428. "parameters": [
  11429. {
  11430. "type": "string",
  11431. "description": "username of user",
  11432. "name": "username",
  11433. "in": "path",
  11434. "required": true
  11435. },
  11436. {
  11437. "type": "integer",
  11438. "description": "page number of results to return (1-based)",
  11439. "name": "page",
  11440. "in": "query"
  11441. },
  11442. {
  11443. "type": "integer",
  11444. "description": "page size of results",
  11445. "name": "limit",
  11446. "in": "query"
  11447. }
  11448. ],
  11449. "responses": {
  11450. "200": {
  11451. "$ref": "#/responses/AccessTokenList"
  11452. }
  11453. }
  11454. },
  11455. "post": {
  11456. "consumes": [
  11457. "application/json"
  11458. ],
  11459. "produces": [
  11460. "application/json"
  11461. ],
  11462. "tags": [
  11463. "user"
  11464. ],
  11465. "summary": "Create an access token",
  11466. "operationId": "userCreateToken",
  11467. "parameters": [
  11468. {
  11469. "type": "string",
  11470. "x-go-name": "Name",
  11471. "description": "username of user",
  11472. "name": "username",
  11473. "in": "path",
  11474. "required": true
  11475. },
  11476. {
  11477. "name": "accessToken",
  11478. "in": "body",
  11479. "schema": {
  11480. "type": "object",
  11481. "required": [
  11482. "name"
  11483. ],
  11484. "properties": {
  11485. "name": {
  11486. "type": "string"
  11487. }
  11488. }
  11489. }
  11490. }
  11491. ],
  11492. "responses": {
  11493. "201": {
  11494. "$ref": "#/responses/AccessToken"
  11495. }
  11496. }
  11497. }
  11498. },
  11499. "/users/{username}/tokens/{token}": {
  11500. "delete": {
  11501. "produces": [
  11502. "application/json"
  11503. ],
  11504. "tags": [
  11505. "user"
  11506. ],
  11507. "summary": "delete an access token",
  11508. "operationId": "userDeleteAccessToken",
  11509. "parameters": [
  11510. {
  11511. "type": "string",
  11512. "description": "username of user",
  11513. "name": "username",
  11514. "in": "path",
  11515. "required": true
  11516. },
  11517. {
  11518. "type": "string",
  11519. "description": "token to be deleted, identified by ID and if not available by name",
  11520. "name": "token",
  11521. "in": "path",
  11522. "required": true
  11523. }
  11524. ],
  11525. "responses": {
  11526. "204": {
  11527. "$ref": "#/responses/empty"
  11528. },
  11529. "422": {
  11530. "$ref": "#/responses/error"
  11531. }
  11532. }
  11533. }
  11534. },
  11535. "/version": {
  11536. "get": {
  11537. "produces": [
  11538. "application/json"
  11539. ],
  11540. "tags": [
  11541. "miscellaneous"
  11542. ],
  11543. "summary": "Returns the version of the Gitea application",
  11544. "operationId": "getVersion",
  11545. "responses": {
  11546. "200": {
  11547. "$ref": "#/responses/ServerVersion"
  11548. }
  11549. }
  11550. }
  11551. }
  11552. },
  11553. "definitions": {
  11554. "APIError": {
  11555. "description": "APIError is an api error with a message",
  11556. "type": "object",
  11557. "properties": {
  11558. "message": {
  11559. "type": "string",
  11560. "x-go-name": "Message"
  11561. },
  11562. "url": {
  11563. "type": "string",
  11564. "x-go-name": "URL"
  11565. }
  11566. },
  11567. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11568. },
  11569. "AccessToken": {
  11570. "type": "object",
  11571. "title": "AccessToken represents an API access token.",
  11572. "properties": {
  11573. "id": {
  11574. "type": "integer",
  11575. "format": "int64",
  11576. "x-go-name": "ID"
  11577. },
  11578. "name": {
  11579. "type": "string",
  11580. "x-go-name": "Name"
  11581. },
  11582. "sha1": {
  11583. "type": "string",
  11584. "x-go-name": "Token"
  11585. },
  11586. "token_last_eight": {
  11587. "type": "string",
  11588. "x-go-name": "TokenLastEight"
  11589. }
  11590. },
  11591. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11592. },
  11593. "AddCollaboratorOption": {
  11594. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  11595. "type": "object",
  11596. "properties": {
  11597. "permission": {
  11598. "type": "string",
  11599. "x-go-name": "Permission"
  11600. }
  11601. },
  11602. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11603. },
  11604. "AddTimeOption": {
  11605. "description": "AddTimeOption options for adding time to an issue",
  11606. "type": "object",
  11607. "required": [
  11608. "time"
  11609. ],
  11610. "properties": {
  11611. "created": {
  11612. "type": "string",
  11613. "format": "date-time",
  11614. "x-go-name": "Created"
  11615. },
  11616. "time": {
  11617. "description": "time in seconds",
  11618. "type": "integer",
  11619. "format": "int64",
  11620. "x-go-name": "Time"
  11621. },
  11622. "user_name": {
  11623. "description": "User who spent the time (optional)",
  11624. "type": "string",
  11625. "x-go-name": "User"
  11626. }
  11627. },
  11628. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11629. },
  11630. "AnnotatedTag": {
  11631. "description": "AnnotatedTag represents an annotated tag",
  11632. "type": "object",
  11633. "properties": {
  11634. "message": {
  11635. "type": "string",
  11636. "x-go-name": "Message"
  11637. },
  11638. "object": {
  11639. "$ref": "#/definitions/AnnotatedTagObject"
  11640. },
  11641. "sha": {
  11642. "type": "string",
  11643. "x-go-name": "SHA"
  11644. },
  11645. "tag": {
  11646. "type": "string",
  11647. "x-go-name": "Tag"
  11648. },
  11649. "tagger": {
  11650. "$ref": "#/definitions/CommitUser"
  11651. },
  11652. "url": {
  11653. "type": "string",
  11654. "x-go-name": "URL"
  11655. },
  11656. "verification": {
  11657. "$ref": "#/definitions/PayloadCommitVerification"
  11658. }
  11659. },
  11660. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11661. },
  11662. "AnnotatedTagObject": {
  11663. "description": "AnnotatedTagObject contains meta information of the tag object",
  11664. "type": "object",
  11665. "properties": {
  11666. "sha": {
  11667. "type": "string",
  11668. "x-go-name": "SHA"
  11669. },
  11670. "type": {
  11671. "type": "string",
  11672. "x-go-name": "Type"
  11673. },
  11674. "url": {
  11675. "type": "string",
  11676. "x-go-name": "URL"
  11677. }
  11678. },
  11679. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11680. },
  11681. "Attachment": {
  11682. "description": "Attachment a generic attachment",
  11683. "type": "object",
  11684. "properties": {
  11685. "browser_download_url": {
  11686. "type": "string",
  11687. "x-go-name": "DownloadURL"
  11688. },
  11689. "created_at": {
  11690. "type": "string",
  11691. "format": "date-time",
  11692. "x-go-name": "Created"
  11693. },
  11694. "download_count": {
  11695. "type": "integer",
  11696. "format": "int64",
  11697. "x-go-name": "DownloadCount"
  11698. },
  11699. "id": {
  11700. "type": "integer",
  11701. "format": "int64",
  11702. "x-go-name": "ID"
  11703. },
  11704. "name": {
  11705. "type": "string",
  11706. "x-go-name": "Name"
  11707. },
  11708. "size": {
  11709. "type": "integer",
  11710. "format": "int64",
  11711. "x-go-name": "Size"
  11712. },
  11713. "uuid": {
  11714. "type": "string",
  11715. "x-go-name": "UUID"
  11716. }
  11717. },
  11718. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11719. },
  11720. "Branch": {
  11721. "description": "Branch represents a repository branch",
  11722. "type": "object",
  11723. "properties": {
  11724. "commit": {
  11725. "$ref": "#/definitions/PayloadCommit"
  11726. },
  11727. "effective_branch_protection_name": {
  11728. "type": "string",
  11729. "x-go-name": "EffectiveBranchProtectionName"
  11730. },
  11731. "enable_status_check": {
  11732. "type": "boolean",
  11733. "x-go-name": "EnableStatusCheck"
  11734. },
  11735. "name": {
  11736. "type": "string",
  11737. "x-go-name": "Name"
  11738. },
  11739. "protected": {
  11740. "type": "boolean",
  11741. "x-go-name": "Protected"
  11742. },
  11743. "required_approvals": {
  11744. "type": "integer",
  11745. "format": "int64",
  11746. "x-go-name": "RequiredApprovals"
  11747. },
  11748. "status_check_contexts": {
  11749. "type": "array",
  11750. "items": {
  11751. "type": "string"
  11752. },
  11753. "x-go-name": "StatusCheckContexts"
  11754. },
  11755. "user_can_merge": {
  11756. "type": "boolean",
  11757. "x-go-name": "UserCanMerge"
  11758. },
  11759. "user_can_push": {
  11760. "type": "boolean",
  11761. "x-go-name": "UserCanPush"
  11762. }
  11763. },
  11764. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11765. },
  11766. "BranchProtection": {
  11767. "description": "BranchProtection represents a branch protection for a repository",
  11768. "type": "object",
  11769. "properties": {
  11770. "approvals_whitelist_teams": {
  11771. "type": "array",
  11772. "items": {
  11773. "type": "string"
  11774. },
  11775. "x-go-name": "ApprovalsWhitelistTeams"
  11776. },
  11777. "approvals_whitelist_username": {
  11778. "type": "array",
  11779. "items": {
  11780. "type": "string"
  11781. },
  11782. "x-go-name": "ApprovalsWhitelistUsernames"
  11783. },
  11784. "block_on_official_review_requests": {
  11785. "type": "boolean",
  11786. "x-go-name": "BlockOnOfficialReviewRequests"
  11787. },
  11788. "block_on_outdated_branch": {
  11789. "type": "boolean",
  11790. "x-go-name": "BlockOnOutdatedBranch"
  11791. },
  11792. "block_on_rejected_reviews": {
  11793. "type": "boolean",
  11794. "x-go-name": "BlockOnRejectedReviews"
  11795. },
  11796. "branch_name": {
  11797. "type": "string",
  11798. "x-go-name": "BranchName"
  11799. },
  11800. "created_at": {
  11801. "type": "string",
  11802. "format": "date-time",
  11803. "x-go-name": "Created"
  11804. },
  11805. "dismiss_stale_approvals": {
  11806. "type": "boolean",
  11807. "x-go-name": "DismissStaleApprovals"
  11808. },
  11809. "enable_approvals_whitelist": {
  11810. "type": "boolean",
  11811. "x-go-name": "EnableApprovalsWhitelist"
  11812. },
  11813. "enable_merge_whitelist": {
  11814. "type": "boolean",
  11815. "x-go-name": "EnableMergeWhitelist"
  11816. },
  11817. "enable_push": {
  11818. "type": "boolean",
  11819. "x-go-name": "EnablePush"
  11820. },
  11821. "enable_push_whitelist": {
  11822. "type": "boolean",
  11823. "x-go-name": "EnablePushWhitelist"
  11824. },
  11825. "enable_status_check": {
  11826. "type": "boolean",
  11827. "x-go-name": "EnableStatusCheck"
  11828. },
  11829. "merge_whitelist_teams": {
  11830. "type": "array",
  11831. "items": {
  11832. "type": "string"
  11833. },
  11834. "x-go-name": "MergeWhitelistTeams"
  11835. },
  11836. "merge_whitelist_usernames": {
  11837. "type": "array",
  11838. "items": {
  11839. "type": "string"
  11840. },
  11841. "x-go-name": "MergeWhitelistUsernames"
  11842. },
  11843. "protected_file_patterns": {
  11844. "type": "string",
  11845. "x-go-name": "ProtectedFilePatterns"
  11846. },
  11847. "push_whitelist_deploy_keys": {
  11848. "type": "boolean",
  11849. "x-go-name": "PushWhitelistDeployKeys"
  11850. },
  11851. "push_whitelist_teams": {
  11852. "type": "array",
  11853. "items": {
  11854. "type": "string"
  11855. },
  11856. "x-go-name": "PushWhitelistTeams"
  11857. },
  11858. "push_whitelist_usernames": {
  11859. "type": "array",
  11860. "items": {
  11861. "type": "string"
  11862. },
  11863. "x-go-name": "PushWhitelistUsernames"
  11864. },
  11865. "require_signed_commits": {
  11866. "type": "boolean",
  11867. "x-go-name": "RequireSignedCommits"
  11868. },
  11869. "required_approvals": {
  11870. "type": "integer",
  11871. "format": "int64",
  11872. "x-go-name": "RequiredApprovals"
  11873. },
  11874. "status_check_contexts": {
  11875. "type": "array",
  11876. "items": {
  11877. "type": "string"
  11878. },
  11879. "x-go-name": "StatusCheckContexts"
  11880. },
  11881. "updated_at": {
  11882. "type": "string",
  11883. "format": "date-time",
  11884. "x-go-name": "Updated"
  11885. }
  11886. },
  11887. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11888. },
  11889. "CombinedStatus": {
  11890. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  11891. "type": "object",
  11892. "properties": {
  11893. "commit_url": {
  11894. "type": "string",
  11895. "x-go-name": "CommitURL"
  11896. },
  11897. "repository": {
  11898. "$ref": "#/definitions/Repository"
  11899. },
  11900. "sha": {
  11901. "type": "string",
  11902. "x-go-name": "SHA"
  11903. },
  11904. "state": {
  11905. "$ref": "#/definitions/CommitStatusState"
  11906. },
  11907. "statuses": {
  11908. "type": "array",
  11909. "items": {
  11910. "$ref": "#/definitions/CommitStatus"
  11911. },
  11912. "x-go-name": "Statuses"
  11913. },
  11914. "total_count": {
  11915. "type": "integer",
  11916. "format": "int64",
  11917. "x-go-name": "TotalCount"
  11918. },
  11919. "url": {
  11920. "type": "string",
  11921. "x-go-name": "URL"
  11922. }
  11923. },
  11924. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11925. },
  11926. "Comment": {
  11927. "description": "Comment represents a comment on a commit or issue",
  11928. "type": "object",
  11929. "properties": {
  11930. "body": {
  11931. "type": "string",
  11932. "x-go-name": "Body"
  11933. },
  11934. "created_at": {
  11935. "type": "string",
  11936. "format": "date-time",
  11937. "x-go-name": "Created"
  11938. },
  11939. "html_url": {
  11940. "type": "string",
  11941. "x-go-name": "HTMLURL"
  11942. },
  11943. "id": {
  11944. "type": "integer",
  11945. "format": "int64",
  11946. "x-go-name": "ID"
  11947. },
  11948. "issue_url": {
  11949. "type": "string",
  11950. "x-go-name": "IssueURL"
  11951. },
  11952. "original_author": {
  11953. "type": "string",
  11954. "x-go-name": "OriginalAuthor"
  11955. },
  11956. "original_author_id": {
  11957. "type": "integer",
  11958. "format": "int64",
  11959. "x-go-name": "OriginalAuthorID"
  11960. },
  11961. "pull_request_url": {
  11962. "type": "string",
  11963. "x-go-name": "PRURL"
  11964. },
  11965. "updated_at": {
  11966. "type": "string",
  11967. "format": "date-time",
  11968. "x-go-name": "Updated"
  11969. },
  11970. "user": {
  11971. "$ref": "#/definitions/User"
  11972. }
  11973. },
  11974. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11975. },
  11976. "Commit": {
  11977. "type": "object",
  11978. "title": "Commit contains information generated from a Git commit.",
  11979. "properties": {
  11980. "author": {
  11981. "$ref": "#/definitions/User"
  11982. },
  11983. "commit": {
  11984. "$ref": "#/definitions/RepoCommit"
  11985. },
  11986. "committer": {
  11987. "$ref": "#/definitions/User"
  11988. },
  11989. "created": {
  11990. "type": "string",
  11991. "format": "date-time",
  11992. "x-go-name": "Created"
  11993. },
  11994. "files": {
  11995. "type": "array",
  11996. "items": {
  11997. "$ref": "#/definitions/CommitAffectedFiles"
  11998. },
  11999. "x-go-name": "Files"
  12000. },
  12001. "html_url": {
  12002. "type": "string",
  12003. "x-go-name": "HTMLURL"
  12004. },
  12005. "parents": {
  12006. "type": "array",
  12007. "items": {
  12008. "$ref": "#/definitions/CommitMeta"
  12009. },
  12010. "x-go-name": "Parents"
  12011. },
  12012. "sha": {
  12013. "type": "string",
  12014. "x-go-name": "SHA"
  12015. },
  12016. "url": {
  12017. "type": "string",
  12018. "x-go-name": "URL"
  12019. }
  12020. },
  12021. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12022. },
  12023. "CommitAffectedFiles": {
  12024. "description": "CommitAffectedFiles store information about files affected by the commit",
  12025. "type": "object",
  12026. "properties": {
  12027. "filename": {
  12028. "type": "string",
  12029. "x-go-name": "Filename"
  12030. }
  12031. },
  12032. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12033. },
  12034. "CommitDateOptions": {
  12035. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  12036. "type": "object",
  12037. "properties": {
  12038. "author": {
  12039. "type": "string",
  12040. "format": "date-time",
  12041. "x-go-name": "Author"
  12042. },
  12043. "committer": {
  12044. "type": "string",
  12045. "format": "date-time",
  12046. "x-go-name": "Committer"
  12047. }
  12048. },
  12049. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12050. },
  12051. "CommitMeta": {
  12052. "type": "object",
  12053. "title": "CommitMeta contains meta information of a commit in terms of API.",
  12054. "properties": {
  12055. "created": {
  12056. "type": "string",
  12057. "format": "date-time",
  12058. "x-go-name": "Created"
  12059. },
  12060. "sha": {
  12061. "type": "string",
  12062. "x-go-name": "SHA"
  12063. },
  12064. "url": {
  12065. "type": "string",
  12066. "x-go-name": "URL"
  12067. }
  12068. },
  12069. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12070. },
  12071. "CommitStatus": {
  12072. "description": "CommitStatus holds a single status of a single Commit",
  12073. "type": "object",
  12074. "properties": {
  12075. "context": {
  12076. "type": "string",
  12077. "x-go-name": "Context"
  12078. },
  12079. "created_at": {
  12080. "type": "string",
  12081. "format": "date-time",
  12082. "x-go-name": "Created"
  12083. },
  12084. "creator": {
  12085. "$ref": "#/definitions/User"
  12086. },
  12087. "description": {
  12088. "type": "string",
  12089. "x-go-name": "Description"
  12090. },
  12091. "id": {
  12092. "type": "integer",
  12093. "format": "int64",
  12094. "x-go-name": "ID"
  12095. },
  12096. "status": {
  12097. "$ref": "#/definitions/CommitStatusState"
  12098. },
  12099. "target_url": {
  12100. "type": "string",
  12101. "x-go-name": "TargetURL"
  12102. },
  12103. "updated_at": {
  12104. "type": "string",
  12105. "format": "date-time",
  12106. "x-go-name": "Updated"
  12107. },
  12108. "url": {
  12109. "type": "string",
  12110. "x-go-name": "URL"
  12111. }
  12112. },
  12113. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12114. },
  12115. "CommitStatusState": {
  12116. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  12117. "type": "string",
  12118. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12119. },
  12120. "CommitUser": {
  12121. "type": "object",
  12122. "title": "CommitUser contains information of a user in the context of a commit.",
  12123. "properties": {
  12124. "date": {
  12125. "type": "string",
  12126. "x-go-name": "Date"
  12127. },
  12128. "email": {
  12129. "type": "string",
  12130. "format": "email",
  12131. "x-go-name": "Email"
  12132. },
  12133. "name": {
  12134. "type": "string",
  12135. "x-go-name": "Name"
  12136. }
  12137. },
  12138. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12139. },
  12140. "ContentsResponse": {
  12141. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  12142. "type": "object",
  12143. "properties": {
  12144. "_links": {
  12145. "$ref": "#/definitions/FileLinksResponse"
  12146. },
  12147. "content": {
  12148. "description": "`content` is populated when `type` is `file`, otherwise null",
  12149. "type": "string",
  12150. "x-go-name": "Content"
  12151. },
  12152. "download_url": {
  12153. "type": "string",
  12154. "x-go-name": "DownloadURL"
  12155. },
  12156. "encoding": {
  12157. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  12158. "type": "string",
  12159. "x-go-name": "Encoding"
  12160. },
  12161. "git_url": {
  12162. "type": "string",
  12163. "x-go-name": "GitURL"
  12164. },
  12165. "html_url": {
  12166. "type": "string",
  12167. "x-go-name": "HTMLURL"
  12168. },
  12169. "name": {
  12170. "type": "string",
  12171. "x-go-name": "Name"
  12172. },
  12173. "path": {
  12174. "type": "string",
  12175. "x-go-name": "Path"
  12176. },
  12177. "sha": {
  12178. "type": "string",
  12179. "x-go-name": "SHA"
  12180. },
  12181. "size": {
  12182. "type": "integer",
  12183. "format": "int64",
  12184. "x-go-name": "Size"
  12185. },
  12186. "submodule_git_url": {
  12187. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  12188. "type": "string",
  12189. "x-go-name": "SubmoduleGitURL"
  12190. },
  12191. "target": {
  12192. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  12193. "type": "string",
  12194. "x-go-name": "Target"
  12195. },
  12196. "type": {
  12197. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  12198. "type": "string",
  12199. "x-go-name": "Type"
  12200. },
  12201. "url": {
  12202. "type": "string",
  12203. "x-go-name": "URL"
  12204. }
  12205. },
  12206. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12207. },
  12208. "CreateBranchProtectionOption": {
  12209. "description": "CreateBranchProtectionOption options for creating a branch protection",
  12210. "type": "object",
  12211. "properties": {
  12212. "approvals_whitelist_teams": {
  12213. "type": "array",
  12214. "items": {
  12215. "type": "string"
  12216. },
  12217. "x-go-name": "ApprovalsWhitelistTeams"
  12218. },
  12219. "approvals_whitelist_username": {
  12220. "type": "array",
  12221. "items": {
  12222. "type": "string"
  12223. },
  12224. "x-go-name": "ApprovalsWhitelistUsernames"
  12225. },
  12226. "block_on_official_review_requests": {
  12227. "type": "boolean",
  12228. "x-go-name": "BlockOnOfficialReviewRequests"
  12229. },
  12230. "block_on_outdated_branch": {
  12231. "type": "boolean",
  12232. "x-go-name": "BlockOnOutdatedBranch"
  12233. },
  12234. "block_on_rejected_reviews": {
  12235. "type": "boolean",
  12236. "x-go-name": "BlockOnRejectedReviews"
  12237. },
  12238. "branch_name": {
  12239. "type": "string",
  12240. "x-go-name": "BranchName"
  12241. },
  12242. "dismiss_stale_approvals": {
  12243. "type": "boolean",
  12244. "x-go-name": "DismissStaleApprovals"
  12245. },
  12246. "enable_approvals_whitelist": {
  12247. "type": "boolean",
  12248. "x-go-name": "EnableApprovalsWhitelist"
  12249. },
  12250. "enable_merge_whitelist": {
  12251. "type": "boolean",
  12252. "x-go-name": "EnableMergeWhitelist"
  12253. },
  12254. "enable_push": {
  12255. "type": "boolean",
  12256. "x-go-name": "EnablePush"
  12257. },
  12258. "enable_push_whitelist": {
  12259. "type": "boolean",
  12260. "x-go-name": "EnablePushWhitelist"
  12261. },
  12262. "enable_status_check": {
  12263. "type": "boolean",
  12264. "x-go-name": "EnableStatusCheck"
  12265. },
  12266. "merge_whitelist_teams": {
  12267. "type": "array",
  12268. "items": {
  12269. "type": "string"
  12270. },
  12271. "x-go-name": "MergeWhitelistTeams"
  12272. },
  12273. "merge_whitelist_usernames": {
  12274. "type": "array",
  12275. "items": {
  12276. "type": "string"
  12277. },
  12278. "x-go-name": "MergeWhitelistUsernames"
  12279. },
  12280. "protected_file_patterns": {
  12281. "type": "string",
  12282. "x-go-name": "ProtectedFilePatterns"
  12283. },
  12284. "push_whitelist_deploy_keys": {
  12285. "type": "boolean",
  12286. "x-go-name": "PushWhitelistDeployKeys"
  12287. },
  12288. "push_whitelist_teams": {
  12289. "type": "array",
  12290. "items": {
  12291. "type": "string"
  12292. },
  12293. "x-go-name": "PushWhitelistTeams"
  12294. },
  12295. "push_whitelist_usernames": {
  12296. "type": "array",
  12297. "items": {
  12298. "type": "string"
  12299. },
  12300. "x-go-name": "PushWhitelistUsernames"
  12301. },
  12302. "require_signed_commits": {
  12303. "type": "boolean",
  12304. "x-go-name": "RequireSignedCommits"
  12305. },
  12306. "required_approvals": {
  12307. "type": "integer",
  12308. "format": "int64",
  12309. "x-go-name": "RequiredApprovals"
  12310. },
  12311. "status_check_contexts": {
  12312. "type": "array",
  12313. "items": {
  12314. "type": "string"
  12315. },
  12316. "x-go-name": "StatusCheckContexts"
  12317. }
  12318. },
  12319. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12320. },
  12321. "CreateBranchRepoOption": {
  12322. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  12323. "type": "object",
  12324. "required": [
  12325. "new_branch_name"
  12326. ],
  12327. "properties": {
  12328. "new_branch_name": {
  12329. "description": "Name of the branch to create",
  12330. "type": "string",
  12331. "uniqueItems": true,
  12332. "x-go-name": "BranchName"
  12333. },
  12334. "old_branch_name": {
  12335. "description": "Name of the old branch to create from",
  12336. "type": "string",
  12337. "uniqueItems": true,
  12338. "x-go-name": "OldBranchName"
  12339. }
  12340. },
  12341. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12342. },
  12343. "CreateEmailOption": {
  12344. "description": "CreateEmailOption options when creating email addresses",
  12345. "type": "object",
  12346. "properties": {
  12347. "emails": {
  12348. "description": "email addresses to add",
  12349. "type": "array",
  12350. "items": {
  12351. "type": "string"
  12352. },
  12353. "x-go-name": "Emails"
  12354. }
  12355. },
  12356. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12357. },
  12358. "CreateFileOptions": {
  12359. "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)",
  12360. "type": "object",
  12361. "required": [
  12362. "content"
  12363. ],
  12364. "properties": {
  12365. "author": {
  12366. "$ref": "#/definitions/Identity"
  12367. },
  12368. "branch": {
  12369. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  12370. "type": "string",
  12371. "x-go-name": "BranchName"
  12372. },
  12373. "committer": {
  12374. "$ref": "#/definitions/Identity"
  12375. },
  12376. "content": {
  12377. "description": "content must be base64 encoded",
  12378. "type": "string",
  12379. "x-go-name": "Content"
  12380. },
  12381. "dates": {
  12382. "$ref": "#/definitions/CommitDateOptions"
  12383. },
  12384. "message": {
  12385. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  12386. "type": "string",
  12387. "x-go-name": "Message"
  12388. },
  12389. "new_branch": {
  12390. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  12391. "type": "string",
  12392. "x-go-name": "NewBranchName"
  12393. },
  12394. "signoff": {
  12395. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  12396. "type": "boolean",
  12397. "x-go-name": "Signoff"
  12398. }
  12399. },
  12400. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12401. },
  12402. "CreateForkOption": {
  12403. "description": "CreateForkOption options for creating a fork",
  12404. "type": "object",
  12405. "properties": {
  12406. "organization": {
  12407. "description": "organization name, if forking into an organization",
  12408. "type": "string",
  12409. "x-go-name": "Organization"
  12410. }
  12411. },
  12412. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12413. },
  12414. "CreateGPGKeyOption": {
  12415. "description": "CreateGPGKeyOption options create user GPG key",
  12416. "type": "object",
  12417. "required": [
  12418. "armored_public_key"
  12419. ],
  12420. "properties": {
  12421. "armored_public_key": {
  12422. "description": "An armored GPG key to add",
  12423. "type": "string",
  12424. "uniqueItems": true,
  12425. "x-go-name": "ArmoredKey"
  12426. }
  12427. },
  12428. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12429. },
  12430. "CreateHookOption": {
  12431. "description": "CreateHookOption options when create a hook",
  12432. "type": "object",
  12433. "required": [
  12434. "type",
  12435. "config"
  12436. ],
  12437. "properties": {
  12438. "active": {
  12439. "type": "boolean",
  12440. "default": false,
  12441. "x-go-name": "Active"
  12442. },
  12443. "branch_filter": {
  12444. "type": "string",
  12445. "x-go-name": "BranchFilter"
  12446. },
  12447. "config": {
  12448. "$ref": "#/definitions/CreateHookOptionConfig"
  12449. },
  12450. "events": {
  12451. "type": "array",
  12452. "items": {
  12453. "type": "string"
  12454. },
  12455. "x-go-name": "Events"
  12456. },
  12457. "type": {
  12458. "type": "string",
  12459. "enum": [
  12460. "dingtalk",
  12461. "discord",
  12462. "gitea",
  12463. "gogs",
  12464. "msteams",
  12465. "slack",
  12466. "telegram",
  12467. "feishu"
  12468. ],
  12469. "x-go-name": "Type"
  12470. }
  12471. },
  12472. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12473. },
  12474. "CreateHookOptionConfig": {
  12475. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  12476. "type": "object",
  12477. "additionalProperties": {
  12478. "type": "string"
  12479. },
  12480. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12481. },
  12482. "CreateIssueCommentOption": {
  12483. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  12484. "type": "object",
  12485. "required": [
  12486. "body"
  12487. ],
  12488. "properties": {
  12489. "body": {
  12490. "type": "string",
  12491. "x-go-name": "Body"
  12492. }
  12493. },
  12494. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12495. },
  12496. "CreateIssueOption": {
  12497. "description": "CreateIssueOption options to create one issue",
  12498. "type": "object",
  12499. "required": [
  12500. "title"
  12501. ],
  12502. "properties": {
  12503. "assignee": {
  12504. "description": "deprecated",
  12505. "type": "string",
  12506. "x-go-name": "Assignee"
  12507. },
  12508. "assignees": {
  12509. "type": "array",
  12510. "items": {
  12511. "type": "string"
  12512. },
  12513. "x-go-name": "Assignees"
  12514. },
  12515. "body": {
  12516. "type": "string",
  12517. "x-go-name": "Body"
  12518. },
  12519. "closed": {
  12520. "type": "boolean",
  12521. "x-go-name": "Closed"
  12522. },
  12523. "due_date": {
  12524. "type": "string",
  12525. "format": "date-time",
  12526. "x-go-name": "Deadline"
  12527. },
  12528. "labels": {
  12529. "description": "list of label ids",
  12530. "type": "array",
  12531. "items": {
  12532. "type": "integer",
  12533. "format": "int64"
  12534. },
  12535. "x-go-name": "Labels"
  12536. },
  12537. "milestone": {
  12538. "description": "milestone id",
  12539. "type": "integer",
  12540. "format": "int64",
  12541. "x-go-name": "Milestone"
  12542. },
  12543. "ref": {
  12544. "type": "string",
  12545. "x-go-name": "Ref"
  12546. },
  12547. "title": {
  12548. "type": "string",
  12549. "x-go-name": "Title"
  12550. }
  12551. },
  12552. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12553. },
  12554. "CreateKeyOption": {
  12555. "description": "CreateKeyOption options when creating a key",
  12556. "type": "object",
  12557. "required": [
  12558. "title",
  12559. "key"
  12560. ],
  12561. "properties": {
  12562. "key": {
  12563. "description": "An armored SSH key to add",
  12564. "type": "string",
  12565. "uniqueItems": true,
  12566. "x-go-name": "Key"
  12567. },
  12568. "read_only": {
  12569. "description": "Describe if the key has only read access or read/write",
  12570. "type": "boolean",
  12571. "x-go-name": "ReadOnly"
  12572. },
  12573. "title": {
  12574. "description": "Title of the key to add",
  12575. "type": "string",
  12576. "uniqueItems": true,
  12577. "x-go-name": "Title"
  12578. }
  12579. },
  12580. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12581. },
  12582. "CreateLabelOption": {
  12583. "description": "CreateLabelOption options for creating a label",
  12584. "type": "object",
  12585. "required": [
  12586. "name",
  12587. "color"
  12588. ],
  12589. "properties": {
  12590. "color": {
  12591. "type": "string",
  12592. "x-go-name": "Color",
  12593. "example": "#00aabb"
  12594. },
  12595. "description": {
  12596. "type": "string",
  12597. "x-go-name": "Description"
  12598. },
  12599. "name": {
  12600. "type": "string",
  12601. "x-go-name": "Name"
  12602. }
  12603. },
  12604. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12605. },
  12606. "CreateMilestoneOption": {
  12607. "description": "CreateMilestoneOption options for creating a milestone",
  12608. "type": "object",
  12609. "properties": {
  12610. "description": {
  12611. "type": "string",
  12612. "x-go-name": "Description"
  12613. },
  12614. "due_on": {
  12615. "type": "string",
  12616. "format": "date-time",
  12617. "x-go-name": "Deadline"
  12618. },
  12619. "state": {
  12620. "type": "string",
  12621. "enum": [
  12622. "open",
  12623. "closed"
  12624. ],
  12625. "x-go-name": "State"
  12626. },
  12627. "title": {
  12628. "type": "string",
  12629. "x-go-name": "Title"
  12630. }
  12631. },
  12632. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12633. },
  12634. "CreateOAuth2ApplicationOptions": {
  12635. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  12636. "type": "object",
  12637. "properties": {
  12638. "name": {
  12639. "type": "string",
  12640. "x-go-name": "Name"
  12641. },
  12642. "redirect_uris": {
  12643. "type": "array",
  12644. "items": {
  12645. "type": "string"
  12646. },
  12647. "x-go-name": "RedirectURIs"
  12648. }
  12649. },
  12650. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12651. },
  12652. "CreateOrgOption": {
  12653. "description": "CreateOrgOption options for creating an organization",
  12654. "type": "object",
  12655. "required": [
  12656. "username"
  12657. ],
  12658. "properties": {
  12659. "description": {
  12660. "type": "string",
  12661. "x-go-name": "Description"
  12662. },
  12663. "full_name": {
  12664. "type": "string",
  12665. "x-go-name": "FullName"
  12666. },
  12667. "location": {
  12668. "type": "string",
  12669. "x-go-name": "Location"
  12670. },
  12671. "repo_admin_change_team_access": {
  12672. "type": "boolean",
  12673. "x-go-name": "RepoAdminChangeTeamAccess"
  12674. },
  12675. "username": {
  12676. "type": "string",
  12677. "x-go-name": "UserName"
  12678. },
  12679. "visibility": {
  12680. "description": "possible values are `public` (default), `limited` or `private`",
  12681. "type": "string",
  12682. "enum": [
  12683. "public",
  12684. "limited",
  12685. "private"
  12686. ],
  12687. "x-go-name": "Visibility"
  12688. },
  12689. "website": {
  12690. "type": "string",
  12691. "x-go-name": "Website"
  12692. }
  12693. },
  12694. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12695. },
  12696. "CreatePullRequestOption": {
  12697. "description": "CreatePullRequestOption options when creating a pull request",
  12698. "type": "object",
  12699. "properties": {
  12700. "assignee": {
  12701. "type": "string",
  12702. "x-go-name": "Assignee"
  12703. },
  12704. "assignees": {
  12705. "type": "array",
  12706. "items": {
  12707. "type": "string"
  12708. },
  12709. "x-go-name": "Assignees"
  12710. },
  12711. "base": {
  12712. "type": "string",
  12713. "x-go-name": "Base"
  12714. },
  12715. "body": {
  12716. "type": "string",
  12717. "x-go-name": "Body"
  12718. },
  12719. "due_date": {
  12720. "type": "string",
  12721. "format": "date-time",
  12722. "x-go-name": "Deadline"
  12723. },
  12724. "head": {
  12725. "type": "string",
  12726. "x-go-name": "Head"
  12727. },
  12728. "labels": {
  12729. "type": "array",
  12730. "items": {
  12731. "type": "integer",
  12732. "format": "int64"
  12733. },
  12734. "x-go-name": "Labels"
  12735. },
  12736. "milestone": {
  12737. "type": "integer",
  12738. "format": "int64",
  12739. "x-go-name": "Milestone"
  12740. },
  12741. "title": {
  12742. "type": "string",
  12743. "x-go-name": "Title"
  12744. }
  12745. },
  12746. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12747. },
  12748. "CreatePullReviewComment": {
  12749. "description": "CreatePullReviewComment represent a review comment for creation api",
  12750. "type": "object",
  12751. "properties": {
  12752. "body": {
  12753. "type": "string",
  12754. "x-go-name": "Body"
  12755. },
  12756. "new_position": {
  12757. "description": "if comment to new file line or 0",
  12758. "type": "integer",
  12759. "format": "int64",
  12760. "x-go-name": "NewLineNum"
  12761. },
  12762. "old_position": {
  12763. "description": "if comment to old file line or 0",
  12764. "type": "integer",
  12765. "format": "int64",
  12766. "x-go-name": "OldLineNum"
  12767. },
  12768. "path": {
  12769. "description": "the tree path",
  12770. "type": "string",
  12771. "x-go-name": "Path"
  12772. }
  12773. },
  12774. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12775. },
  12776. "CreatePullReviewOptions": {
  12777. "description": "CreatePullReviewOptions are options to create a pull review",
  12778. "type": "object",
  12779. "properties": {
  12780. "body": {
  12781. "type": "string",
  12782. "x-go-name": "Body"
  12783. },
  12784. "comments": {
  12785. "type": "array",
  12786. "items": {
  12787. "$ref": "#/definitions/CreatePullReviewComment"
  12788. },
  12789. "x-go-name": "Comments"
  12790. },
  12791. "commit_id": {
  12792. "type": "string",
  12793. "x-go-name": "CommitID"
  12794. },
  12795. "event": {
  12796. "$ref": "#/definitions/ReviewStateType"
  12797. }
  12798. },
  12799. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12800. },
  12801. "CreateReleaseOption": {
  12802. "description": "CreateReleaseOption options when creating a release",
  12803. "type": "object",
  12804. "required": [
  12805. "tag_name"
  12806. ],
  12807. "properties": {
  12808. "body": {
  12809. "type": "string",
  12810. "x-go-name": "Note"
  12811. },
  12812. "draft": {
  12813. "type": "boolean",
  12814. "x-go-name": "IsDraft"
  12815. },
  12816. "name": {
  12817. "type": "string",
  12818. "x-go-name": "Title"
  12819. },
  12820. "prerelease": {
  12821. "type": "boolean",
  12822. "x-go-name": "IsPrerelease"
  12823. },
  12824. "tag_name": {
  12825. "type": "string",
  12826. "x-go-name": "TagName"
  12827. },
  12828. "target_commitish": {
  12829. "type": "string",
  12830. "x-go-name": "Target"
  12831. }
  12832. },
  12833. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12834. },
  12835. "CreateRepoOption": {
  12836. "description": "CreateRepoOption options when creating repository",
  12837. "type": "object",
  12838. "required": [
  12839. "name"
  12840. ],
  12841. "properties": {
  12842. "auto_init": {
  12843. "description": "Whether the repository should be auto-intialized?",
  12844. "type": "boolean",
  12845. "x-go-name": "AutoInit"
  12846. },
  12847. "default_branch": {
  12848. "description": "DefaultBranch of the repository (used when initializes and in template)",
  12849. "type": "string",
  12850. "x-go-name": "DefaultBranch"
  12851. },
  12852. "description": {
  12853. "description": "Description of the repository to create",
  12854. "type": "string",
  12855. "x-go-name": "Description"
  12856. },
  12857. "gitignores": {
  12858. "description": "Gitignores to use",
  12859. "type": "string",
  12860. "x-go-name": "Gitignores"
  12861. },
  12862. "issue_labels": {
  12863. "description": "Label-Set to use",
  12864. "type": "string",
  12865. "x-go-name": "IssueLabels"
  12866. },
  12867. "license": {
  12868. "description": "License to use",
  12869. "type": "string",
  12870. "x-go-name": "License"
  12871. },
  12872. "name": {
  12873. "description": "Name of the repository to create",
  12874. "type": "string",
  12875. "uniqueItems": true,
  12876. "x-go-name": "Name"
  12877. },
  12878. "private": {
  12879. "description": "Whether the repository is private",
  12880. "type": "boolean",
  12881. "x-go-name": "Private"
  12882. },
  12883. "readme": {
  12884. "description": "Readme of the repository to create",
  12885. "type": "string",
  12886. "x-go-name": "Readme"
  12887. },
  12888. "template": {
  12889. "description": "Whether the repository is template",
  12890. "type": "boolean",
  12891. "x-go-name": "Template"
  12892. },
  12893. "trust_model": {
  12894. "description": "TrustModel of the repository",
  12895. "type": "string",
  12896. "enum": [
  12897. "default",
  12898. "collaborator",
  12899. "committer",
  12900. "collaboratorcommitter"
  12901. ],
  12902. "x-go-name": "TrustModel"
  12903. }
  12904. },
  12905. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12906. },
  12907. "CreateStatusOption": {
  12908. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  12909. "type": "object",
  12910. "properties": {
  12911. "context": {
  12912. "type": "string",
  12913. "x-go-name": "Context"
  12914. },
  12915. "description": {
  12916. "type": "string",
  12917. "x-go-name": "Description"
  12918. },
  12919. "state": {
  12920. "$ref": "#/definitions/CommitStatusState"
  12921. },
  12922. "target_url": {
  12923. "type": "string",
  12924. "x-go-name": "TargetURL"
  12925. }
  12926. },
  12927. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12928. },
  12929. "CreateTeamOption": {
  12930. "description": "CreateTeamOption options for creating a team",
  12931. "type": "object",
  12932. "required": [
  12933. "name"
  12934. ],
  12935. "properties": {
  12936. "can_create_org_repo": {
  12937. "type": "boolean",
  12938. "x-go-name": "CanCreateOrgRepo"
  12939. },
  12940. "description": {
  12941. "type": "string",
  12942. "x-go-name": "Description"
  12943. },
  12944. "includes_all_repositories": {
  12945. "type": "boolean",
  12946. "x-go-name": "IncludesAllRepositories"
  12947. },
  12948. "name": {
  12949. "type": "string",
  12950. "x-go-name": "Name"
  12951. },
  12952. "permission": {
  12953. "type": "string",
  12954. "enum": [
  12955. "read",
  12956. "write",
  12957. "admin"
  12958. ],
  12959. "x-go-name": "Permission"
  12960. },
  12961. "units": {
  12962. "type": "array",
  12963. "items": {
  12964. "type": "string"
  12965. },
  12966. "x-go-name": "Units",
  12967. "example": [
  12968. "repo.code",
  12969. "repo.issues",
  12970. "repo.ext_issues",
  12971. "repo.wiki",
  12972. "repo.pulls",
  12973. "repo.releases",
  12974. "repo.projects",
  12975. "repo.ext_wiki"
  12976. ]
  12977. }
  12978. },
  12979. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12980. },
  12981. "CreateUserOption": {
  12982. "description": "CreateUserOption create user options",
  12983. "type": "object",
  12984. "required": [
  12985. "username",
  12986. "email",
  12987. "password"
  12988. ],
  12989. "properties": {
  12990. "email": {
  12991. "type": "string",
  12992. "format": "email",
  12993. "x-go-name": "Email"
  12994. },
  12995. "full_name": {
  12996. "type": "string",
  12997. "x-go-name": "FullName"
  12998. },
  12999. "login_name": {
  13000. "type": "string",
  13001. "x-go-name": "LoginName"
  13002. },
  13003. "must_change_password": {
  13004. "type": "boolean",
  13005. "x-go-name": "MustChangePassword"
  13006. },
  13007. "password": {
  13008. "type": "string",
  13009. "x-go-name": "Password"
  13010. },
  13011. "send_notify": {
  13012. "type": "boolean",
  13013. "x-go-name": "SendNotify"
  13014. },
  13015. "source_id": {
  13016. "type": "integer",
  13017. "format": "int64",
  13018. "x-go-name": "SourceID"
  13019. },
  13020. "username": {
  13021. "type": "string",
  13022. "x-go-name": "Username"
  13023. }
  13024. },
  13025. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13026. },
  13027. "Cron": {
  13028. "description": "Cron represents a Cron task",
  13029. "type": "object",
  13030. "properties": {
  13031. "exec_times": {
  13032. "type": "integer",
  13033. "format": "int64",
  13034. "x-go-name": "ExecTimes"
  13035. },
  13036. "name": {
  13037. "type": "string",
  13038. "x-go-name": "Name"
  13039. },
  13040. "next": {
  13041. "type": "string",
  13042. "format": "date-time",
  13043. "x-go-name": "Next"
  13044. },
  13045. "prev": {
  13046. "type": "string",
  13047. "format": "date-time",
  13048. "x-go-name": "Prev"
  13049. },
  13050. "schedule": {
  13051. "type": "string",
  13052. "x-go-name": "Schedule"
  13053. }
  13054. },
  13055. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13056. },
  13057. "DeleteEmailOption": {
  13058. "description": "DeleteEmailOption options when deleting email addresses",
  13059. "type": "object",
  13060. "properties": {
  13061. "emails": {
  13062. "description": "email addresses to delete",
  13063. "type": "array",
  13064. "items": {
  13065. "type": "string"
  13066. },
  13067. "x-go-name": "Emails"
  13068. }
  13069. },
  13070. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13071. },
  13072. "DeleteFileOptions": {
  13073. "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)",
  13074. "type": "object",
  13075. "required": [
  13076. "sha"
  13077. ],
  13078. "properties": {
  13079. "author": {
  13080. "$ref": "#/definitions/Identity"
  13081. },
  13082. "branch": {
  13083. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  13084. "type": "string",
  13085. "x-go-name": "BranchName"
  13086. },
  13087. "committer": {
  13088. "$ref": "#/definitions/Identity"
  13089. },
  13090. "dates": {
  13091. "$ref": "#/definitions/CommitDateOptions"
  13092. },
  13093. "message": {
  13094. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  13095. "type": "string",
  13096. "x-go-name": "Message"
  13097. },
  13098. "new_branch": {
  13099. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  13100. "type": "string",
  13101. "x-go-name": "NewBranchName"
  13102. },
  13103. "sha": {
  13104. "description": "sha is the SHA for the file that already exists",
  13105. "type": "string",
  13106. "x-go-name": "SHA"
  13107. },
  13108. "signoff": {
  13109. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  13110. "type": "boolean",
  13111. "x-go-name": "Signoff"
  13112. }
  13113. },
  13114. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13115. },
  13116. "DeployKey": {
  13117. "description": "DeployKey a deploy key",
  13118. "type": "object",
  13119. "properties": {
  13120. "created_at": {
  13121. "type": "string",
  13122. "format": "date-time",
  13123. "x-go-name": "Created"
  13124. },
  13125. "fingerprint": {
  13126. "type": "string",
  13127. "x-go-name": "Fingerprint"
  13128. },
  13129. "id": {
  13130. "type": "integer",
  13131. "format": "int64",
  13132. "x-go-name": "ID"
  13133. },
  13134. "key": {
  13135. "type": "string",
  13136. "x-go-name": "Key"
  13137. },
  13138. "key_id": {
  13139. "type": "integer",
  13140. "format": "int64",
  13141. "x-go-name": "KeyID"
  13142. },
  13143. "read_only": {
  13144. "type": "boolean",
  13145. "x-go-name": "ReadOnly"
  13146. },
  13147. "repository": {
  13148. "$ref": "#/definitions/Repository"
  13149. },
  13150. "title": {
  13151. "type": "string",
  13152. "x-go-name": "Title"
  13153. },
  13154. "url": {
  13155. "type": "string",
  13156. "x-go-name": "URL"
  13157. }
  13158. },
  13159. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13160. },
  13161. "DismissPullReviewOptions": {
  13162. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  13163. "type": "object",
  13164. "properties": {
  13165. "message": {
  13166. "type": "string",
  13167. "x-go-name": "Message"
  13168. }
  13169. },
  13170. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13171. },
  13172. "EditAttachmentOptions": {
  13173. "description": "EditAttachmentOptions options for editing attachments",
  13174. "type": "object",
  13175. "properties": {
  13176. "name": {
  13177. "type": "string",
  13178. "x-go-name": "Name"
  13179. }
  13180. },
  13181. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13182. },
  13183. "EditBranchProtectionOption": {
  13184. "description": "EditBranchProtectionOption options for editing a branch protection",
  13185. "type": "object",
  13186. "properties": {
  13187. "approvals_whitelist_teams": {
  13188. "type": "array",
  13189. "items": {
  13190. "type": "string"
  13191. },
  13192. "x-go-name": "ApprovalsWhitelistTeams"
  13193. },
  13194. "approvals_whitelist_username": {
  13195. "type": "array",
  13196. "items": {
  13197. "type": "string"
  13198. },
  13199. "x-go-name": "ApprovalsWhitelistUsernames"
  13200. },
  13201. "block_on_official_review_requests": {
  13202. "type": "boolean",
  13203. "x-go-name": "BlockOnOfficialReviewRequests"
  13204. },
  13205. "block_on_outdated_branch": {
  13206. "type": "boolean",
  13207. "x-go-name": "BlockOnOutdatedBranch"
  13208. },
  13209. "block_on_rejected_reviews": {
  13210. "type": "boolean",
  13211. "x-go-name": "BlockOnRejectedReviews"
  13212. },
  13213. "dismiss_stale_approvals": {
  13214. "type": "boolean",
  13215. "x-go-name": "DismissStaleApprovals"
  13216. },
  13217. "enable_approvals_whitelist": {
  13218. "type": "boolean",
  13219. "x-go-name": "EnableApprovalsWhitelist"
  13220. },
  13221. "enable_merge_whitelist": {
  13222. "type": "boolean",
  13223. "x-go-name": "EnableMergeWhitelist"
  13224. },
  13225. "enable_push": {
  13226. "type": "boolean",
  13227. "x-go-name": "EnablePush"
  13228. },
  13229. "enable_push_whitelist": {
  13230. "type": "boolean",
  13231. "x-go-name": "EnablePushWhitelist"
  13232. },
  13233. "enable_status_check": {
  13234. "type": "boolean",
  13235. "x-go-name": "EnableStatusCheck"
  13236. },
  13237. "merge_whitelist_teams": {
  13238. "type": "array",
  13239. "items": {
  13240. "type": "string"
  13241. },
  13242. "x-go-name": "MergeWhitelistTeams"
  13243. },
  13244. "merge_whitelist_usernames": {
  13245. "type": "array",
  13246. "items": {
  13247. "type": "string"
  13248. },
  13249. "x-go-name": "MergeWhitelistUsernames"
  13250. },
  13251. "protected_file_patterns": {
  13252. "type": "string",
  13253. "x-go-name": "ProtectedFilePatterns"
  13254. },
  13255. "push_whitelist_deploy_keys": {
  13256. "type": "boolean",
  13257. "x-go-name": "PushWhitelistDeployKeys"
  13258. },
  13259. "push_whitelist_teams": {
  13260. "type": "array",
  13261. "items": {
  13262. "type": "string"
  13263. },
  13264. "x-go-name": "PushWhitelistTeams"
  13265. },
  13266. "push_whitelist_usernames": {
  13267. "type": "array",
  13268. "items": {
  13269. "type": "string"
  13270. },
  13271. "x-go-name": "PushWhitelistUsernames"
  13272. },
  13273. "require_signed_commits": {
  13274. "type": "boolean",
  13275. "x-go-name": "RequireSignedCommits"
  13276. },
  13277. "required_approvals": {
  13278. "type": "integer",
  13279. "format": "int64",
  13280. "x-go-name": "RequiredApprovals"
  13281. },
  13282. "status_check_contexts": {
  13283. "type": "array",
  13284. "items": {
  13285. "type": "string"
  13286. },
  13287. "x-go-name": "StatusCheckContexts"
  13288. }
  13289. },
  13290. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13291. },
  13292. "EditDeadlineOption": {
  13293. "description": "EditDeadlineOption options for creating a deadline",
  13294. "type": "object",
  13295. "required": [
  13296. "due_date"
  13297. ],
  13298. "properties": {
  13299. "due_date": {
  13300. "type": "string",
  13301. "format": "date-time",
  13302. "x-go-name": "Deadline"
  13303. }
  13304. },
  13305. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13306. },
  13307. "EditGitHookOption": {
  13308. "description": "EditGitHookOption options when modifying one Git hook",
  13309. "type": "object",
  13310. "properties": {
  13311. "content": {
  13312. "type": "string",
  13313. "x-go-name": "Content"
  13314. }
  13315. },
  13316. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13317. },
  13318. "EditHookOption": {
  13319. "description": "EditHookOption options when modify one hook",
  13320. "type": "object",
  13321. "properties": {
  13322. "active": {
  13323. "type": "boolean",
  13324. "x-go-name": "Active"
  13325. },
  13326. "branch_filter": {
  13327. "type": "string",
  13328. "x-go-name": "BranchFilter"
  13329. },
  13330. "config": {
  13331. "type": "object",
  13332. "additionalProperties": {
  13333. "type": "string"
  13334. },
  13335. "x-go-name": "Config"
  13336. },
  13337. "events": {
  13338. "type": "array",
  13339. "items": {
  13340. "type": "string"
  13341. },
  13342. "x-go-name": "Events"
  13343. }
  13344. },
  13345. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13346. },
  13347. "EditIssueCommentOption": {
  13348. "description": "EditIssueCommentOption options for editing a comment",
  13349. "type": "object",
  13350. "required": [
  13351. "body"
  13352. ],
  13353. "properties": {
  13354. "body": {
  13355. "type": "string",
  13356. "x-go-name": "Body"
  13357. }
  13358. },
  13359. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13360. },
  13361. "EditIssueOption": {
  13362. "description": "EditIssueOption options for editing an issue",
  13363. "type": "object",
  13364. "properties": {
  13365. "assignee": {
  13366. "description": "deprecated",
  13367. "type": "string",
  13368. "x-go-name": "Assignee"
  13369. },
  13370. "assignees": {
  13371. "type": "array",
  13372. "items": {
  13373. "type": "string"
  13374. },
  13375. "x-go-name": "Assignees"
  13376. },
  13377. "body": {
  13378. "type": "string",
  13379. "x-go-name": "Body"
  13380. },
  13381. "due_date": {
  13382. "type": "string",
  13383. "format": "date-time",
  13384. "x-go-name": "Deadline"
  13385. },
  13386. "milestone": {
  13387. "type": "integer",
  13388. "format": "int64",
  13389. "x-go-name": "Milestone"
  13390. },
  13391. "ref": {
  13392. "type": "string",
  13393. "x-go-name": "Ref"
  13394. },
  13395. "state": {
  13396. "type": "string",
  13397. "x-go-name": "State"
  13398. },
  13399. "title": {
  13400. "type": "string",
  13401. "x-go-name": "Title"
  13402. },
  13403. "unset_due_date": {
  13404. "type": "boolean",
  13405. "x-go-name": "RemoveDeadline"
  13406. }
  13407. },
  13408. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13409. },
  13410. "EditLabelOption": {
  13411. "description": "EditLabelOption options for editing a label",
  13412. "type": "object",
  13413. "properties": {
  13414. "color": {
  13415. "type": "string",
  13416. "x-go-name": "Color"
  13417. },
  13418. "description": {
  13419. "type": "string",
  13420. "x-go-name": "Description"
  13421. },
  13422. "name": {
  13423. "type": "string",
  13424. "x-go-name": "Name"
  13425. }
  13426. },
  13427. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13428. },
  13429. "EditMilestoneOption": {
  13430. "description": "EditMilestoneOption options for editing a milestone",
  13431. "type": "object",
  13432. "properties": {
  13433. "description": {
  13434. "type": "string",
  13435. "x-go-name": "Description"
  13436. },
  13437. "due_on": {
  13438. "type": "string",
  13439. "format": "date-time",
  13440. "x-go-name": "Deadline"
  13441. },
  13442. "state": {
  13443. "type": "string",
  13444. "x-go-name": "State"
  13445. },
  13446. "title": {
  13447. "type": "string",
  13448. "x-go-name": "Title"
  13449. }
  13450. },
  13451. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13452. },
  13453. "EditOrgOption": {
  13454. "description": "EditOrgOption options for editing an organization",
  13455. "type": "object",
  13456. "properties": {
  13457. "description": {
  13458. "type": "string",
  13459. "x-go-name": "Description"
  13460. },
  13461. "full_name": {
  13462. "type": "string",
  13463. "x-go-name": "FullName"
  13464. },
  13465. "location": {
  13466. "type": "string",
  13467. "x-go-name": "Location"
  13468. },
  13469. "repo_admin_change_team_access": {
  13470. "type": "boolean",
  13471. "x-go-name": "RepoAdminChangeTeamAccess"
  13472. },
  13473. "visibility": {
  13474. "description": "possible values are `public`, `limited` or `private`",
  13475. "type": "string",
  13476. "enum": [
  13477. "public",
  13478. "limited",
  13479. "private"
  13480. ],
  13481. "x-go-name": "Visibility"
  13482. },
  13483. "website": {
  13484. "type": "string",
  13485. "x-go-name": "Website"
  13486. }
  13487. },
  13488. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13489. },
  13490. "EditPullRequestOption": {
  13491. "description": "EditPullRequestOption options when modify pull request",
  13492. "type": "object",
  13493. "properties": {
  13494. "assignee": {
  13495. "type": "string",
  13496. "x-go-name": "Assignee"
  13497. },
  13498. "assignees": {
  13499. "type": "array",
  13500. "items": {
  13501. "type": "string"
  13502. },
  13503. "x-go-name": "Assignees"
  13504. },
  13505. "base": {
  13506. "type": "string",
  13507. "x-go-name": "Base"
  13508. },
  13509. "body": {
  13510. "type": "string",
  13511. "x-go-name": "Body"
  13512. },
  13513. "due_date": {
  13514. "type": "string",
  13515. "format": "date-time",
  13516. "x-go-name": "Deadline"
  13517. },
  13518. "labels": {
  13519. "type": "array",
  13520. "items": {
  13521. "type": "integer",
  13522. "format": "int64"
  13523. },
  13524. "x-go-name": "Labels"
  13525. },
  13526. "milestone": {
  13527. "type": "integer",
  13528. "format": "int64",
  13529. "x-go-name": "Milestone"
  13530. },
  13531. "state": {
  13532. "type": "string",
  13533. "x-go-name": "State"
  13534. },
  13535. "title": {
  13536. "type": "string",
  13537. "x-go-name": "Title"
  13538. },
  13539. "unset_due_date": {
  13540. "type": "boolean",
  13541. "x-go-name": "RemoveDeadline"
  13542. }
  13543. },
  13544. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13545. },
  13546. "EditReactionOption": {
  13547. "description": "EditReactionOption contain the reaction type",
  13548. "type": "object",
  13549. "properties": {
  13550. "content": {
  13551. "type": "string",
  13552. "x-go-name": "Reaction"
  13553. }
  13554. },
  13555. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13556. },
  13557. "EditReleaseOption": {
  13558. "description": "EditReleaseOption options when editing a release",
  13559. "type": "object",
  13560. "properties": {
  13561. "body": {
  13562. "type": "string",
  13563. "x-go-name": "Note"
  13564. },
  13565. "draft": {
  13566. "type": "boolean",
  13567. "x-go-name": "IsDraft"
  13568. },
  13569. "name": {
  13570. "type": "string",
  13571. "x-go-name": "Title"
  13572. },
  13573. "prerelease": {
  13574. "type": "boolean",
  13575. "x-go-name": "IsPrerelease"
  13576. },
  13577. "tag_name": {
  13578. "type": "string",
  13579. "x-go-name": "TagName"
  13580. },
  13581. "target_commitish": {
  13582. "type": "string",
  13583. "x-go-name": "Target"
  13584. }
  13585. },
  13586. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13587. },
  13588. "EditRepoOption": {
  13589. "description": "EditRepoOption options when editing a repository's properties",
  13590. "type": "object",
  13591. "properties": {
  13592. "allow_manual_merge": {
  13593. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it. `has_pull_requests` must be `true`.",
  13594. "type": "boolean",
  13595. "x-go-name": "AllowManualMerge"
  13596. },
  13597. "allow_merge_commits": {
  13598. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.",
  13599. "type": "boolean",
  13600. "x-go-name": "AllowMerge"
  13601. },
  13602. "allow_rebase": {
  13603. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  13604. "type": "boolean",
  13605. "x-go-name": "AllowRebase"
  13606. },
  13607. "allow_rebase_explicit": {
  13608. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.",
  13609. "type": "boolean",
  13610. "x-go-name": "AllowRebaseMerge"
  13611. },
  13612. "allow_squash_merge": {
  13613. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  13614. "type": "boolean",
  13615. "x-go-name": "AllowSquash"
  13616. },
  13617. "archived": {
  13618. "description": "set to `true` to archive this repository.",
  13619. "type": "boolean",
  13620. "x-go-name": "Archived"
  13621. },
  13622. "autodetect_manual_merge": {
  13623. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. `has_pull_requests` must be `true`, Note: In some special cases, misjudgments can occur.",
  13624. "type": "boolean",
  13625. "x-go-name": "AutodetectManualMerge"
  13626. },
  13627. "default_branch": {
  13628. "description": "sets the default branch for this repository.",
  13629. "type": "string",
  13630. "x-go-name": "DefaultBranch"
  13631. },
  13632. "default_merge_style": {
  13633. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", or \"squash\". `has_pull_requests` must be `true`.",
  13634. "type": "string",
  13635. "x-go-name": "DefaultMergeStyle"
  13636. },
  13637. "description": {
  13638. "description": "a short description of the repository.",
  13639. "type": "string",
  13640. "x-go-name": "Description"
  13641. },
  13642. "external_tracker": {
  13643. "$ref": "#/definitions/ExternalTracker"
  13644. },
  13645. "external_wiki": {
  13646. "$ref": "#/definitions/ExternalWiki"
  13647. },
  13648. "has_issues": {
  13649. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  13650. "type": "boolean",
  13651. "x-go-name": "HasIssues"
  13652. },
  13653. "has_projects": {
  13654. "description": "either `true` to enable project unit, or `false` to disable them.",
  13655. "type": "boolean",
  13656. "x-go-name": "HasProjects"
  13657. },
  13658. "has_pull_requests": {
  13659. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  13660. "type": "boolean",
  13661. "x-go-name": "HasPullRequests"
  13662. },
  13663. "has_wiki": {
  13664. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  13665. "type": "boolean",
  13666. "x-go-name": "HasWiki"
  13667. },
  13668. "ignore_whitespace_conflicts": {
  13669. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  13670. "type": "boolean",
  13671. "x-go-name": "IgnoreWhitespaceConflicts"
  13672. },
  13673. "internal_tracker": {
  13674. "$ref": "#/definitions/InternalTracker"
  13675. },
  13676. "mirror_interval": {
  13677. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  13678. "type": "string",
  13679. "x-go-name": "MirrorInterval"
  13680. },
  13681. "name": {
  13682. "description": "name of the repository",
  13683. "type": "string",
  13684. "uniqueItems": true,
  13685. "x-go-name": "Name"
  13686. },
  13687. "private": {
  13688. "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.",
  13689. "type": "boolean",
  13690. "x-go-name": "Private"
  13691. },
  13692. "template": {
  13693. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  13694. "type": "boolean",
  13695. "x-go-name": "Template"
  13696. },
  13697. "website": {
  13698. "description": "a URL with more information about the repository.",
  13699. "type": "string",
  13700. "x-go-name": "Website"
  13701. }
  13702. },
  13703. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13704. },
  13705. "EditTeamOption": {
  13706. "description": "EditTeamOption options for editing a team",
  13707. "type": "object",
  13708. "required": [
  13709. "name"
  13710. ],
  13711. "properties": {
  13712. "can_create_org_repo": {
  13713. "type": "boolean",
  13714. "x-go-name": "CanCreateOrgRepo"
  13715. },
  13716. "description": {
  13717. "type": "string",
  13718. "x-go-name": "Description"
  13719. },
  13720. "includes_all_repositories": {
  13721. "type": "boolean",
  13722. "x-go-name": "IncludesAllRepositories"
  13723. },
  13724. "name": {
  13725. "type": "string",
  13726. "x-go-name": "Name"
  13727. },
  13728. "permission": {
  13729. "type": "string",
  13730. "enum": [
  13731. "read",
  13732. "write",
  13733. "admin"
  13734. ],
  13735. "x-go-name": "Permission"
  13736. },
  13737. "units": {
  13738. "type": "array",
  13739. "items": {
  13740. "type": "string"
  13741. },
  13742. "x-go-name": "Units",
  13743. "example": [
  13744. "repo.code",
  13745. "repo.issues",
  13746. "repo.ext_issues",
  13747. "repo.wiki",
  13748. "repo.pulls",
  13749. "repo.releases",
  13750. "repo.projects",
  13751. "repo.ext_wiki"
  13752. ]
  13753. }
  13754. },
  13755. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13756. },
  13757. "EditUserOption": {
  13758. "description": "EditUserOption edit user options",
  13759. "type": "object",
  13760. "required": [
  13761. "source_id",
  13762. "login_name"
  13763. ],
  13764. "properties": {
  13765. "active": {
  13766. "type": "boolean",
  13767. "x-go-name": "Active"
  13768. },
  13769. "admin": {
  13770. "type": "boolean",
  13771. "x-go-name": "Admin"
  13772. },
  13773. "allow_create_organization": {
  13774. "type": "boolean",
  13775. "x-go-name": "AllowCreateOrganization"
  13776. },
  13777. "allow_git_hook": {
  13778. "type": "boolean",
  13779. "x-go-name": "AllowGitHook"
  13780. },
  13781. "allow_import_local": {
  13782. "type": "boolean",
  13783. "x-go-name": "AllowImportLocal"
  13784. },
  13785. "email": {
  13786. "type": "string",
  13787. "format": "email",
  13788. "x-go-name": "Email"
  13789. },
  13790. "full_name": {
  13791. "type": "string",
  13792. "x-go-name": "FullName"
  13793. },
  13794. "location": {
  13795. "type": "string",
  13796. "x-go-name": "Location"
  13797. },
  13798. "login_name": {
  13799. "type": "string",
  13800. "x-go-name": "LoginName"
  13801. },
  13802. "max_repo_creation": {
  13803. "type": "integer",
  13804. "format": "int64",
  13805. "x-go-name": "MaxRepoCreation"
  13806. },
  13807. "must_change_password": {
  13808. "type": "boolean",
  13809. "x-go-name": "MustChangePassword"
  13810. },
  13811. "password": {
  13812. "type": "string",
  13813. "x-go-name": "Password"
  13814. },
  13815. "prohibit_login": {
  13816. "type": "boolean",
  13817. "x-go-name": "ProhibitLogin"
  13818. },
  13819. "restricted": {
  13820. "type": "boolean",
  13821. "x-go-name": "Restricted"
  13822. },
  13823. "source_id": {
  13824. "type": "integer",
  13825. "format": "int64",
  13826. "x-go-name": "SourceID"
  13827. },
  13828. "website": {
  13829. "type": "string",
  13830. "x-go-name": "Website"
  13831. }
  13832. },
  13833. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13834. },
  13835. "Email": {
  13836. "description": "Email an email address belonging to a user",
  13837. "type": "object",
  13838. "properties": {
  13839. "email": {
  13840. "type": "string",
  13841. "format": "email",
  13842. "x-go-name": "Email"
  13843. },
  13844. "primary": {
  13845. "type": "boolean",
  13846. "x-go-name": "Primary"
  13847. },
  13848. "verified": {
  13849. "type": "boolean",
  13850. "x-go-name": "Verified"
  13851. }
  13852. },
  13853. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13854. },
  13855. "ExternalTracker": {
  13856. "description": "ExternalTracker represents settings for external tracker",
  13857. "type": "object",
  13858. "properties": {
  13859. "external_tracker_format": {
  13860. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  13861. "type": "string",
  13862. "x-go-name": "ExternalTrackerFormat"
  13863. },
  13864. "external_tracker_style": {
  13865. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  13866. "type": "string",
  13867. "x-go-name": "ExternalTrackerStyle"
  13868. },
  13869. "external_tracker_url": {
  13870. "description": "URL of external issue tracker.",
  13871. "type": "string",
  13872. "x-go-name": "ExternalTrackerURL"
  13873. }
  13874. },
  13875. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13876. },
  13877. "ExternalWiki": {
  13878. "description": "ExternalWiki represents setting for external wiki",
  13879. "type": "object",
  13880. "properties": {
  13881. "external_wiki_url": {
  13882. "description": "URL of external wiki.",
  13883. "type": "string",
  13884. "x-go-name": "ExternalWikiURL"
  13885. }
  13886. },
  13887. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13888. },
  13889. "FileCommitResponse": {
  13890. "type": "object",
  13891. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  13892. "properties": {
  13893. "author": {
  13894. "$ref": "#/definitions/CommitUser"
  13895. },
  13896. "committer": {
  13897. "$ref": "#/definitions/CommitUser"
  13898. },
  13899. "created": {
  13900. "type": "string",
  13901. "format": "date-time",
  13902. "x-go-name": "Created"
  13903. },
  13904. "html_url": {
  13905. "type": "string",
  13906. "x-go-name": "HTMLURL"
  13907. },
  13908. "message": {
  13909. "type": "string",
  13910. "x-go-name": "Message"
  13911. },
  13912. "parents": {
  13913. "type": "array",
  13914. "items": {
  13915. "$ref": "#/definitions/CommitMeta"
  13916. },
  13917. "x-go-name": "Parents"
  13918. },
  13919. "sha": {
  13920. "type": "string",
  13921. "x-go-name": "SHA"
  13922. },
  13923. "tree": {
  13924. "$ref": "#/definitions/CommitMeta"
  13925. },
  13926. "url": {
  13927. "type": "string",
  13928. "x-go-name": "URL"
  13929. }
  13930. },
  13931. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13932. },
  13933. "FileDeleteResponse": {
  13934. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  13935. "type": "object",
  13936. "properties": {
  13937. "commit": {
  13938. "$ref": "#/definitions/FileCommitResponse"
  13939. },
  13940. "content": {
  13941. "type": "object",
  13942. "x-go-name": "Content"
  13943. },
  13944. "verification": {
  13945. "$ref": "#/definitions/PayloadCommitVerification"
  13946. }
  13947. },
  13948. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13949. },
  13950. "FileLinksResponse": {
  13951. "description": "FileLinksResponse contains the links for a repo's file",
  13952. "type": "object",
  13953. "properties": {
  13954. "git": {
  13955. "type": "string",
  13956. "x-go-name": "GitURL"
  13957. },
  13958. "html": {
  13959. "type": "string",
  13960. "x-go-name": "HTMLURL"
  13961. },
  13962. "self": {
  13963. "type": "string",
  13964. "x-go-name": "Self"
  13965. }
  13966. },
  13967. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13968. },
  13969. "FileResponse": {
  13970. "description": "FileResponse contains information about a repo's file",
  13971. "type": "object",
  13972. "properties": {
  13973. "commit": {
  13974. "$ref": "#/definitions/FileCommitResponse"
  13975. },
  13976. "content": {
  13977. "$ref": "#/definitions/ContentsResponse"
  13978. },
  13979. "verification": {
  13980. "$ref": "#/definitions/PayloadCommitVerification"
  13981. }
  13982. },
  13983. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13984. },
  13985. "GPGKey": {
  13986. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  13987. "type": "object",
  13988. "properties": {
  13989. "can_certify": {
  13990. "type": "boolean",
  13991. "x-go-name": "CanCertify"
  13992. },
  13993. "can_encrypt_comms": {
  13994. "type": "boolean",
  13995. "x-go-name": "CanEncryptComms"
  13996. },
  13997. "can_encrypt_storage": {
  13998. "type": "boolean",
  13999. "x-go-name": "CanEncryptStorage"
  14000. },
  14001. "can_sign": {
  14002. "type": "boolean",
  14003. "x-go-name": "CanSign"
  14004. },
  14005. "created_at": {
  14006. "type": "string",
  14007. "format": "date-time",
  14008. "x-go-name": "Created"
  14009. },
  14010. "emails": {
  14011. "type": "array",
  14012. "items": {
  14013. "$ref": "#/definitions/GPGKeyEmail"
  14014. },
  14015. "x-go-name": "Emails"
  14016. },
  14017. "expires_at": {
  14018. "type": "string",
  14019. "format": "date-time",
  14020. "x-go-name": "Expires"
  14021. },
  14022. "id": {
  14023. "type": "integer",
  14024. "format": "int64",
  14025. "x-go-name": "ID"
  14026. },
  14027. "key_id": {
  14028. "type": "string",
  14029. "x-go-name": "KeyID"
  14030. },
  14031. "primary_key_id": {
  14032. "type": "string",
  14033. "x-go-name": "PrimaryKeyID"
  14034. },
  14035. "public_key": {
  14036. "type": "string",
  14037. "x-go-name": "PublicKey"
  14038. },
  14039. "subkeys": {
  14040. "type": "array",
  14041. "items": {
  14042. "$ref": "#/definitions/GPGKey"
  14043. },
  14044. "x-go-name": "SubsKey"
  14045. }
  14046. },
  14047. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14048. },
  14049. "GPGKeyEmail": {
  14050. "description": "GPGKeyEmail an email attached to a GPGKey",
  14051. "type": "object",
  14052. "properties": {
  14053. "email": {
  14054. "type": "string",
  14055. "x-go-name": "Email"
  14056. },
  14057. "verified": {
  14058. "type": "boolean",
  14059. "x-go-name": "Verified"
  14060. }
  14061. },
  14062. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14063. },
  14064. "GeneralAPISettings": {
  14065. "description": "GeneralAPISettings contains global api settings exposed by it",
  14066. "type": "object",
  14067. "properties": {
  14068. "default_git_trees_per_page": {
  14069. "type": "integer",
  14070. "format": "int64",
  14071. "x-go-name": "DefaultGitTreesPerPage"
  14072. },
  14073. "default_max_blob_size": {
  14074. "type": "integer",
  14075. "format": "int64",
  14076. "x-go-name": "DefaultMaxBlobSize"
  14077. },
  14078. "default_paging_num": {
  14079. "type": "integer",
  14080. "format": "int64",
  14081. "x-go-name": "DefaultPagingNum"
  14082. },
  14083. "max_response_items": {
  14084. "type": "integer",
  14085. "format": "int64",
  14086. "x-go-name": "MaxResponseItems"
  14087. }
  14088. },
  14089. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14090. },
  14091. "GeneralAttachmentSettings": {
  14092. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  14093. "type": "object",
  14094. "properties": {
  14095. "allowed_types": {
  14096. "type": "string",
  14097. "x-go-name": "AllowedTypes"
  14098. },
  14099. "enabled": {
  14100. "type": "boolean",
  14101. "x-go-name": "Enabled"
  14102. },
  14103. "max_files": {
  14104. "type": "integer",
  14105. "format": "int64",
  14106. "x-go-name": "MaxFiles"
  14107. },
  14108. "max_size": {
  14109. "type": "integer",
  14110. "format": "int64",
  14111. "x-go-name": "MaxSize"
  14112. }
  14113. },
  14114. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14115. },
  14116. "GeneralRepoSettings": {
  14117. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  14118. "type": "object",
  14119. "properties": {
  14120. "http_git_disabled": {
  14121. "type": "boolean",
  14122. "x-go-name": "HTTPGitDisabled"
  14123. },
  14124. "lfs_disabled": {
  14125. "type": "boolean",
  14126. "x-go-name": "LFSDisabled"
  14127. },
  14128. "migrations_disabled": {
  14129. "type": "boolean",
  14130. "x-go-name": "MigrationsDisabled"
  14131. },
  14132. "mirrors_disabled": {
  14133. "type": "boolean",
  14134. "x-go-name": "MirrorsDisabled"
  14135. },
  14136. "time_tracking_disabled": {
  14137. "type": "boolean",
  14138. "x-go-name": "TimeTrackingDisabled"
  14139. }
  14140. },
  14141. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14142. },
  14143. "GeneralUISettings": {
  14144. "description": "GeneralUISettings contains global ui settings exposed by API",
  14145. "type": "object",
  14146. "properties": {
  14147. "allowed_reactions": {
  14148. "type": "array",
  14149. "items": {
  14150. "type": "string"
  14151. },
  14152. "x-go-name": "AllowedReactions"
  14153. },
  14154. "default_theme": {
  14155. "type": "string",
  14156. "x-go-name": "DefaultTheme"
  14157. }
  14158. },
  14159. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14160. },
  14161. "GitBlobResponse": {
  14162. "description": "GitBlobResponse represents a git blob",
  14163. "type": "object",
  14164. "properties": {
  14165. "content": {
  14166. "type": "string",
  14167. "x-go-name": "Content"
  14168. },
  14169. "encoding": {
  14170. "type": "string",
  14171. "x-go-name": "Encoding"
  14172. },
  14173. "sha": {
  14174. "type": "string",
  14175. "x-go-name": "SHA"
  14176. },
  14177. "size": {
  14178. "type": "integer",
  14179. "format": "int64",
  14180. "x-go-name": "Size"
  14181. },
  14182. "url": {
  14183. "type": "string",
  14184. "x-go-name": "URL"
  14185. }
  14186. },
  14187. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14188. },
  14189. "GitEntry": {
  14190. "description": "GitEntry represents a git tree",
  14191. "type": "object",
  14192. "properties": {
  14193. "mode": {
  14194. "type": "string",
  14195. "x-go-name": "Mode"
  14196. },
  14197. "path": {
  14198. "type": "string",
  14199. "x-go-name": "Path"
  14200. },
  14201. "sha": {
  14202. "type": "string",
  14203. "x-go-name": "SHA"
  14204. },
  14205. "size": {
  14206. "type": "integer",
  14207. "format": "int64",
  14208. "x-go-name": "Size"
  14209. },
  14210. "type": {
  14211. "type": "string",
  14212. "x-go-name": "Type"
  14213. },
  14214. "url": {
  14215. "type": "string",
  14216. "x-go-name": "URL"
  14217. }
  14218. },
  14219. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14220. },
  14221. "GitHook": {
  14222. "description": "GitHook represents a Git repository hook",
  14223. "type": "object",
  14224. "properties": {
  14225. "content": {
  14226. "type": "string",
  14227. "x-go-name": "Content"
  14228. },
  14229. "is_active": {
  14230. "type": "boolean",
  14231. "x-go-name": "IsActive"
  14232. },
  14233. "name": {
  14234. "type": "string",
  14235. "x-go-name": "Name"
  14236. }
  14237. },
  14238. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14239. },
  14240. "GitObject": {
  14241. "type": "object",
  14242. "title": "GitObject represents a Git object.",
  14243. "properties": {
  14244. "sha": {
  14245. "type": "string",
  14246. "x-go-name": "SHA"
  14247. },
  14248. "type": {
  14249. "type": "string",
  14250. "x-go-name": "Type"
  14251. },
  14252. "url": {
  14253. "type": "string",
  14254. "x-go-name": "URL"
  14255. }
  14256. },
  14257. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14258. },
  14259. "GitServiceType": {
  14260. "description": "GitServiceType represents a git service",
  14261. "type": "integer",
  14262. "format": "int64",
  14263. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14264. },
  14265. "GitTreeResponse": {
  14266. "description": "GitTreeResponse returns a git tree",
  14267. "type": "object",
  14268. "properties": {
  14269. "page": {
  14270. "type": "integer",
  14271. "format": "int64",
  14272. "x-go-name": "Page"
  14273. },
  14274. "sha": {
  14275. "type": "string",
  14276. "x-go-name": "SHA"
  14277. },
  14278. "total_count": {
  14279. "type": "integer",
  14280. "format": "int64",
  14281. "x-go-name": "TotalCount"
  14282. },
  14283. "tree": {
  14284. "type": "array",
  14285. "items": {
  14286. "$ref": "#/definitions/GitEntry"
  14287. },
  14288. "x-go-name": "Entries"
  14289. },
  14290. "truncated": {
  14291. "type": "boolean",
  14292. "x-go-name": "Truncated"
  14293. },
  14294. "url": {
  14295. "type": "string",
  14296. "x-go-name": "URL"
  14297. }
  14298. },
  14299. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14300. },
  14301. "Hook": {
  14302. "description": "Hook a hook is a web hook when one repository changed",
  14303. "type": "object",
  14304. "properties": {
  14305. "active": {
  14306. "type": "boolean",
  14307. "x-go-name": "Active"
  14308. },
  14309. "config": {
  14310. "type": "object",
  14311. "additionalProperties": {
  14312. "type": "string"
  14313. },
  14314. "x-go-name": "Config"
  14315. },
  14316. "created_at": {
  14317. "type": "string",
  14318. "format": "date-time",
  14319. "x-go-name": "Created"
  14320. },
  14321. "events": {
  14322. "type": "array",
  14323. "items": {
  14324. "type": "string"
  14325. },
  14326. "x-go-name": "Events"
  14327. },
  14328. "id": {
  14329. "type": "integer",
  14330. "format": "int64",
  14331. "x-go-name": "ID"
  14332. },
  14333. "type": {
  14334. "type": "string",
  14335. "x-go-name": "Type"
  14336. },
  14337. "updated_at": {
  14338. "type": "string",
  14339. "format": "date-time",
  14340. "x-go-name": "Updated"
  14341. }
  14342. },
  14343. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14344. },
  14345. "Identity": {
  14346. "description": "Identity for a person's identity like an author or committer",
  14347. "type": "object",
  14348. "properties": {
  14349. "email": {
  14350. "type": "string",
  14351. "format": "email",
  14352. "x-go-name": "Email"
  14353. },
  14354. "name": {
  14355. "type": "string",
  14356. "x-go-name": "Name"
  14357. }
  14358. },
  14359. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14360. },
  14361. "InternalTracker": {
  14362. "description": "InternalTracker represents settings for internal tracker",
  14363. "type": "object",
  14364. "properties": {
  14365. "allow_only_contributors_to_track_time": {
  14366. "description": "Let only contributors track time (Built-in issue tracker)",
  14367. "type": "boolean",
  14368. "x-go-name": "AllowOnlyContributorsToTrackTime"
  14369. },
  14370. "enable_issue_dependencies": {
  14371. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  14372. "type": "boolean",
  14373. "x-go-name": "EnableIssueDependencies"
  14374. },
  14375. "enable_time_tracker": {
  14376. "description": "Enable time tracking (Built-in issue tracker)",
  14377. "type": "boolean",
  14378. "x-go-name": "EnableTimeTracker"
  14379. }
  14380. },
  14381. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14382. },
  14383. "Issue": {
  14384. "description": "Issue represents an issue in a repository",
  14385. "type": "object",
  14386. "properties": {
  14387. "assignee": {
  14388. "$ref": "#/definitions/User"
  14389. },
  14390. "assignees": {
  14391. "type": "array",
  14392. "items": {
  14393. "$ref": "#/definitions/User"
  14394. },
  14395. "x-go-name": "Assignees"
  14396. },
  14397. "body": {
  14398. "type": "string",
  14399. "x-go-name": "Body"
  14400. },
  14401. "closed_at": {
  14402. "type": "string",
  14403. "format": "date-time",
  14404. "x-go-name": "Closed"
  14405. },
  14406. "comments": {
  14407. "type": "integer",
  14408. "format": "int64",
  14409. "x-go-name": "Comments"
  14410. },
  14411. "created_at": {
  14412. "type": "string",
  14413. "format": "date-time",
  14414. "x-go-name": "Created"
  14415. },
  14416. "due_date": {
  14417. "type": "string",
  14418. "format": "date-time",
  14419. "x-go-name": "Deadline"
  14420. },
  14421. "html_url": {
  14422. "type": "string",
  14423. "x-go-name": "HTMLURL"
  14424. },
  14425. "id": {
  14426. "type": "integer",
  14427. "format": "int64",
  14428. "x-go-name": "ID"
  14429. },
  14430. "is_locked": {
  14431. "type": "boolean",
  14432. "x-go-name": "IsLocked"
  14433. },
  14434. "labels": {
  14435. "type": "array",
  14436. "items": {
  14437. "$ref": "#/definitions/Label"
  14438. },
  14439. "x-go-name": "Labels"
  14440. },
  14441. "milestone": {
  14442. "$ref": "#/definitions/Milestone"
  14443. },
  14444. "number": {
  14445. "type": "integer",
  14446. "format": "int64",
  14447. "x-go-name": "Index"
  14448. },
  14449. "original_author": {
  14450. "type": "string",
  14451. "x-go-name": "OriginalAuthor"
  14452. },
  14453. "original_author_id": {
  14454. "type": "integer",
  14455. "format": "int64",
  14456. "x-go-name": "OriginalAuthorID"
  14457. },
  14458. "pull_request": {
  14459. "$ref": "#/definitions/PullRequestMeta"
  14460. },
  14461. "ref": {
  14462. "type": "string",
  14463. "x-go-name": "Ref"
  14464. },
  14465. "repository": {
  14466. "$ref": "#/definitions/RepositoryMeta"
  14467. },
  14468. "state": {
  14469. "$ref": "#/definitions/StateType"
  14470. },
  14471. "title": {
  14472. "type": "string",
  14473. "x-go-name": "Title"
  14474. },
  14475. "updated_at": {
  14476. "type": "string",
  14477. "format": "date-time",
  14478. "x-go-name": "Updated"
  14479. },
  14480. "url": {
  14481. "type": "string",
  14482. "x-go-name": "URL"
  14483. },
  14484. "user": {
  14485. "$ref": "#/definitions/User"
  14486. }
  14487. },
  14488. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14489. },
  14490. "IssueDeadline": {
  14491. "description": "IssueDeadline represents an issue deadline",
  14492. "type": "object",
  14493. "properties": {
  14494. "due_date": {
  14495. "type": "string",
  14496. "format": "date-time",
  14497. "x-go-name": "Deadline"
  14498. }
  14499. },
  14500. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14501. },
  14502. "IssueLabelsOption": {
  14503. "description": "IssueLabelsOption a collection of labels",
  14504. "type": "object",
  14505. "properties": {
  14506. "labels": {
  14507. "description": "list of label IDs",
  14508. "type": "array",
  14509. "items": {
  14510. "type": "integer",
  14511. "format": "int64"
  14512. },
  14513. "x-go-name": "Labels"
  14514. }
  14515. },
  14516. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14517. },
  14518. "IssueTemplate": {
  14519. "description": "IssueTemplate represents an issue template for a repository",
  14520. "type": "object",
  14521. "properties": {
  14522. "about": {
  14523. "type": "string",
  14524. "x-go-name": "About"
  14525. },
  14526. "content": {
  14527. "type": "string",
  14528. "x-go-name": "Content"
  14529. },
  14530. "file_name": {
  14531. "type": "string",
  14532. "x-go-name": "FileName"
  14533. },
  14534. "labels": {
  14535. "type": "array",
  14536. "items": {
  14537. "type": "string"
  14538. },
  14539. "x-go-name": "Labels"
  14540. },
  14541. "name": {
  14542. "type": "string",
  14543. "x-go-name": "Name"
  14544. },
  14545. "title": {
  14546. "type": "string",
  14547. "x-go-name": "Title"
  14548. }
  14549. },
  14550. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14551. },
  14552. "Label": {
  14553. "description": "Label a label to an issue or a pr",
  14554. "type": "object",
  14555. "properties": {
  14556. "color": {
  14557. "type": "string",
  14558. "x-go-name": "Color",
  14559. "example": "00aabb"
  14560. },
  14561. "description": {
  14562. "type": "string",
  14563. "x-go-name": "Description"
  14564. },
  14565. "id": {
  14566. "type": "integer",
  14567. "format": "int64",
  14568. "x-go-name": "ID"
  14569. },
  14570. "name": {
  14571. "type": "string",
  14572. "x-go-name": "Name"
  14573. },
  14574. "url": {
  14575. "type": "string",
  14576. "x-go-name": "URL"
  14577. }
  14578. },
  14579. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14580. },
  14581. "MarkdownOption": {
  14582. "description": "MarkdownOption markdown options",
  14583. "type": "object",
  14584. "properties": {
  14585. "Context": {
  14586. "description": "Context to render\n\nin: body",
  14587. "type": "string"
  14588. },
  14589. "Mode": {
  14590. "description": "Mode to render\n\nin: body",
  14591. "type": "string"
  14592. },
  14593. "Text": {
  14594. "description": "Text markdown to render\n\nin: body",
  14595. "type": "string"
  14596. },
  14597. "Wiki": {
  14598. "description": "Is it a wiki page ?\n\nin: body",
  14599. "type": "boolean"
  14600. }
  14601. },
  14602. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14603. },
  14604. "MergePullRequestOption": {
  14605. "description": "MergePullRequestForm form for merging Pull Request",
  14606. "type": "object",
  14607. "required": [
  14608. "Do"
  14609. ],
  14610. "properties": {
  14611. "Do": {
  14612. "type": "string",
  14613. "enum": [
  14614. "merge",
  14615. "rebase",
  14616. "rebase-merge",
  14617. "squash",
  14618. "manually-merged"
  14619. ]
  14620. },
  14621. "MergeCommitID": {
  14622. "type": "string"
  14623. },
  14624. "MergeMessageField": {
  14625. "type": "string"
  14626. },
  14627. "MergeTitleField": {
  14628. "type": "string"
  14629. },
  14630. "force_merge": {
  14631. "type": "boolean",
  14632. "x-go-name": "ForceMerge"
  14633. }
  14634. },
  14635. "x-go-name": "MergePullRequestForm",
  14636. "x-go-package": "code.gitea.io/gitea/services/forms"
  14637. },
  14638. "MigrateRepoForm": {
  14639. "description": "MigrateRepoForm form for migrating repository\nthis is used to interact with web ui",
  14640. "type": "object",
  14641. "required": [
  14642. "clone_addr",
  14643. "uid",
  14644. "repo_name"
  14645. ],
  14646. "properties": {
  14647. "auth_password": {
  14648. "type": "string",
  14649. "x-go-name": "AuthPassword"
  14650. },
  14651. "auth_token": {
  14652. "type": "string",
  14653. "x-go-name": "AuthToken"
  14654. },
  14655. "auth_username": {
  14656. "type": "string",
  14657. "x-go-name": "AuthUsername"
  14658. },
  14659. "clone_addr": {
  14660. "type": "string",
  14661. "x-go-name": "CloneAddr"
  14662. },
  14663. "description": {
  14664. "type": "string",
  14665. "x-go-name": "Description"
  14666. },
  14667. "issues": {
  14668. "type": "boolean",
  14669. "x-go-name": "Issues"
  14670. },
  14671. "labels": {
  14672. "type": "boolean",
  14673. "x-go-name": "Labels"
  14674. },
  14675. "lfs": {
  14676. "type": "boolean",
  14677. "x-go-name": "LFS"
  14678. },
  14679. "lfs_endpoint": {
  14680. "type": "string",
  14681. "x-go-name": "LFSEndpoint"
  14682. },
  14683. "milestones": {
  14684. "type": "boolean",
  14685. "x-go-name": "Milestones"
  14686. },
  14687. "mirror": {
  14688. "type": "boolean",
  14689. "x-go-name": "Mirror"
  14690. },
  14691. "mirror_interval": {
  14692. "type": "string",
  14693. "x-go-name": "MirrorInterval"
  14694. },
  14695. "private": {
  14696. "type": "boolean",
  14697. "x-go-name": "Private"
  14698. },
  14699. "pull_requests": {
  14700. "type": "boolean",
  14701. "x-go-name": "PullRequests"
  14702. },
  14703. "releases": {
  14704. "type": "boolean",
  14705. "x-go-name": "Releases"
  14706. },
  14707. "repo_name": {
  14708. "type": "string",
  14709. "x-go-name": "RepoName"
  14710. },
  14711. "service": {
  14712. "$ref": "#/definitions/GitServiceType"
  14713. },
  14714. "uid": {
  14715. "type": "integer",
  14716. "format": "int64",
  14717. "x-go-name": "UID"
  14718. },
  14719. "wiki": {
  14720. "type": "boolean",
  14721. "x-go-name": "Wiki"
  14722. }
  14723. },
  14724. "x-go-package": "code.gitea.io/gitea/services/forms"
  14725. },
  14726. "MigrateRepoOptions": {
  14727. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  14728. "type": "object",
  14729. "required": [
  14730. "clone_addr",
  14731. "repo_name"
  14732. ],
  14733. "properties": {
  14734. "auth_password": {
  14735. "type": "string",
  14736. "x-go-name": "AuthPassword"
  14737. },
  14738. "auth_token": {
  14739. "type": "string",
  14740. "x-go-name": "AuthToken"
  14741. },
  14742. "auth_username": {
  14743. "type": "string",
  14744. "x-go-name": "AuthUsername"
  14745. },
  14746. "clone_addr": {
  14747. "type": "string",
  14748. "x-go-name": "CloneAddr"
  14749. },
  14750. "description": {
  14751. "type": "string",
  14752. "x-go-name": "Description"
  14753. },
  14754. "issues": {
  14755. "type": "boolean",
  14756. "x-go-name": "Issues"
  14757. },
  14758. "labels": {
  14759. "type": "boolean",
  14760. "x-go-name": "Labels"
  14761. },
  14762. "lfs": {
  14763. "type": "boolean",
  14764. "x-go-name": "LFS"
  14765. },
  14766. "lfs_endpoint": {
  14767. "type": "string",
  14768. "x-go-name": "LFSEndpoint"
  14769. },
  14770. "milestones": {
  14771. "type": "boolean",
  14772. "x-go-name": "Milestones"
  14773. },
  14774. "mirror": {
  14775. "type": "boolean",
  14776. "x-go-name": "Mirror"
  14777. },
  14778. "mirror_interval": {
  14779. "type": "string",
  14780. "x-go-name": "MirrorInterval"
  14781. },
  14782. "private": {
  14783. "type": "boolean",
  14784. "x-go-name": "Private"
  14785. },
  14786. "pull_requests": {
  14787. "type": "boolean",
  14788. "x-go-name": "PullRequests"
  14789. },
  14790. "releases": {
  14791. "type": "boolean",
  14792. "x-go-name": "Releases"
  14793. },
  14794. "repo_name": {
  14795. "type": "string",
  14796. "x-go-name": "RepoName"
  14797. },
  14798. "repo_owner": {
  14799. "description": "Name of User or Organisation who will own Repo after migration",
  14800. "type": "string",
  14801. "x-go-name": "RepoOwner"
  14802. },
  14803. "service": {
  14804. "type": "string",
  14805. "enum": [
  14806. "git",
  14807. "github",
  14808. "gitea",
  14809. "gitlab"
  14810. ],
  14811. "x-go-name": "Service"
  14812. },
  14813. "uid": {
  14814. "description": "deprecated (only for backwards compatibility)",
  14815. "type": "integer",
  14816. "format": "int64",
  14817. "x-go-name": "RepoOwnerID"
  14818. },
  14819. "wiki": {
  14820. "type": "boolean",
  14821. "x-go-name": "Wiki"
  14822. }
  14823. },
  14824. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14825. },
  14826. "Milestone": {
  14827. "description": "Milestone milestone is a collection of issues on one repository",
  14828. "type": "object",
  14829. "properties": {
  14830. "closed_at": {
  14831. "type": "string",
  14832. "format": "date-time",
  14833. "x-go-name": "Closed"
  14834. },
  14835. "closed_issues": {
  14836. "type": "integer",
  14837. "format": "int64",
  14838. "x-go-name": "ClosedIssues"
  14839. },
  14840. "created_at": {
  14841. "type": "string",
  14842. "format": "date-time",
  14843. "x-go-name": "Created"
  14844. },
  14845. "description": {
  14846. "type": "string",
  14847. "x-go-name": "Description"
  14848. },
  14849. "due_on": {
  14850. "type": "string",
  14851. "format": "date-time",
  14852. "x-go-name": "Deadline"
  14853. },
  14854. "id": {
  14855. "type": "integer",
  14856. "format": "int64",
  14857. "x-go-name": "ID"
  14858. },
  14859. "open_issues": {
  14860. "type": "integer",
  14861. "format": "int64",
  14862. "x-go-name": "OpenIssues"
  14863. },
  14864. "state": {
  14865. "$ref": "#/definitions/StateType"
  14866. },
  14867. "title": {
  14868. "type": "string",
  14869. "x-go-name": "Title"
  14870. },
  14871. "updated_at": {
  14872. "type": "string",
  14873. "format": "date-time",
  14874. "x-go-name": "Updated"
  14875. }
  14876. },
  14877. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14878. },
  14879. "NotificationCount": {
  14880. "description": "NotificationCount number of unread notifications",
  14881. "type": "object",
  14882. "properties": {
  14883. "new": {
  14884. "type": "integer",
  14885. "format": "int64",
  14886. "x-go-name": "New"
  14887. }
  14888. },
  14889. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14890. },
  14891. "NotificationSubject": {
  14892. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  14893. "type": "object",
  14894. "properties": {
  14895. "latest_comment_url": {
  14896. "type": "string",
  14897. "x-go-name": "LatestCommentURL"
  14898. },
  14899. "state": {
  14900. "$ref": "#/definitions/StateType"
  14901. },
  14902. "title": {
  14903. "type": "string",
  14904. "x-go-name": "Title"
  14905. },
  14906. "type": {
  14907. "type": "string",
  14908. "x-go-name": "Type"
  14909. },
  14910. "url": {
  14911. "type": "string",
  14912. "x-go-name": "URL"
  14913. }
  14914. },
  14915. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14916. },
  14917. "NotificationThread": {
  14918. "description": "NotificationThread expose Notification on API",
  14919. "type": "object",
  14920. "properties": {
  14921. "id": {
  14922. "type": "integer",
  14923. "format": "int64",
  14924. "x-go-name": "ID"
  14925. },
  14926. "pinned": {
  14927. "type": "boolean",
  14928. "x-go-name": "Pinned"
  14929. },
  14930. "repository": {
  14931. "$ref": "#/definitions/Repository"
  14932. },
  14933. "subject": {
  14934. "$ref": "#/definitions/NotificationSubject"
  14935. },
  14936. "unread": {
  14937. "type": "boolean",
  14938. "x-go-name": "Unread"
  14939. },
  14940. "updated_at": {
  14941. "type": "string",
  14942. "format": "date-time",
  14943. "x-go-name": "UpdatedAt"
  14944. },
  14945. "url": {
  14946. "type": "string",
  14947. "x-go-name": "URL"
  14948. }
  14949. },
  14950. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14951. },
  14952. "OAuth2Application": {
  14953. "type": "object",
  14954. "title": "OAuth2Application represents an OAuth2 application.",
  14955. "properties": {
  14956. "client_id": {
  14957. "type": "string",
  14958. "x-go-name": "ClientID"
  14959. },
  14960. "client_secret": {
  14961. "type": "string",
  14962. "x-go-name": "ClientSecret"
  14963. },
  14964. "created": {
  14965. "type": "string",
  14966. "format": "date-time",
  14967. "x-go-name": "Created"
  14968. },
  14969. "id": {
  14970. "type": "integer",
  14971. "format": "int64",
  14972. "x-go-name": "ID"
  14973. },
  14974. "name": {
  14975. "type": "string",
  14976. "x-go-name": "Name"
  14977. },
  14978. "redirect_uris": {
  14979. "type": "array",
  14980. "items": {
  14981. "type": "string"
  14982. },
  14983. "x-go-name": "RedirectURIs"
  14984. }
  14985. },
  14986. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14987. },
  14988. "Organization": {
  14989. "description": "Organization represents an organization",
  14990. "type": "object",
  14991. "properties": {
  14992. "avatar_url": {
  14993. "type": "string",
  14994. "x-go-name": "AvatarURL"
  14995. },
  14996. "description": {
  14997. "type": "string",
  14998. "x-go-name": "Description"
  14999. },
  15000. "full_name": {
  15001. "type": "string",
  15002. "x-go-name": "FullName"
  15003. },
  15004. "id": {
  15005. "type": "integer",
  15006. "format": "int64",
  15007. "x-go-name": "ID"
  15008. },
  15009. "location": {
  15010. "type": "string",
  15011. "x-go-name": "Location"
  15012. },
  15013. "repo_admin_change_team_access": {
  15014. "type": "boolean",
  15015. "x-go-name": "RepoAdminChangeTeamAccess"
  15016. },
  15017. "username": {
  15018. "type": "string",
  15019. "x-go-name": "UserName"
  15020. },
  15021. "visibility": {
  15022. "type": "string",
  15023. "x-go-name": "Visibility"
  15024. },
  15025. "website": {
  15026. "type": "string",
  15027. "x-go-name": "Website"
  15028. }
  15029. },
  15030. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15031. },
  15032. "PRBranchInfo": {
  15033. "description": "PRBranchInfo information about a branch",
  15034. "type": "object",
  15035. "properties": {
  15036. "label": {
  15037. "type": "string",
  15038. "x-go-name": "Name"
  15039. },
  15040. "ref": {
  15041. "type": "string",
  15042. "x-go-name": "Ref"
  15043. },
  15044. "repo": {
  15045. "$ref": "#/definitions/Repository"
  15046. },
  15047. "repo_id": {
  15048. "type": "integer",
  15049. "format": "int64",
  15050. "x-go-name": "RepoID"
  15051. },
  15052. "sha": {
  15053. "type": "string",
  15054. "x-go-name": "Sha"
  15055. }
  15056. },
  15057. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15058. },
  15059. "PayloadCommit": {
  15060. "description": "PayloadCommit represents a commit",
  15061. "type": "object",
  15062. "properties": {
  15063. "added": {
  15064. "type": "array",
  15065. "items": {
  15066. "type": "string"
  15067. },
  15068. "x-go-name": "Added"
  15069. },
  15070. "author": {
  15071. "$ref": "#/definitions/PayloadUser"
  15072. },
  15073. "committer": {
  15074. "$ref": "#/definitions/PayloadUser"
  15075. },
  15076. "id": {
  15077. "description": "sha1 hash of the commit",
  15078. "type": "string",
  15079. "x-go-name": "ID"
  15080. },
  15081. "message": {
  15082. "type": "string",
  15083. "x-go-name": "Message"
  15084. },
  15085. "modified": {
  15086. "type": "array",
  15087. "items": {
  15088. "type": "string"
  15089. },
  15090. "x-go-name": "Modified"
  15091. },
  15092. "removed": {
  15093. "type": "array",
  15094. "items": {
  15095. "type": "string"
  15096. },
  15097. "x-go-name": "Removed"
  15098. },
  15099. "timestamp": {
  15100. "type": "string",
  15101. "format": "date-time",
  15102. "x-go-name": "Timestamp"
  15103. },
  15104. "url": {
  15105. "type": "string",
  15106. "x-go-name": "URL"
  15107. },
  15108. "verification": {
  15109. "$ref": "#/definitions/PayloadCommitVerification"
  15110. }
  15111. },
  15112. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15113. },
  15114. "PayloadCommitVerification": {
  15115. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  15116. "type": "object",
  15117. "properties": {
  15118. "payload": {
  15119. "type": "string",
  15120. "x-go-name": "Payload"
  15121. },
  15122. "reason": {
  15123. "type": "string",
  15124. "x-go-name": "Reason"
  15125. },
  15126. "signature": {
  15127. "type": "string",
  15128. "x-go-name": "Signature"
  15129. },
  15130. "signer": {
  15131. "$ref": "#/definitions/PayloadUser"
  15132. },
  15133. "verified": {
  15134. "type": "boolean",
  15135. "x-go-name": "Verified"
  15136. }
  15137. },
  15138. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15139. },
  15140. "PayloadUser": {
  15141. "description": "PayloadUser represents the author or committer of a commit",
  15142. "type": "object",
  15143. "properties": {
  15144. "email": {
  15145. "type": "string",
  15146. "format": "email",
  15147. "x-go-name": "Email"
  15148. },
  15149. "name": {
  15150. "description": "Full name of the commit author",
  15151. "type": "string",
  15152. "x-go-name": "Name"
  15153. },
  15154. "username": {
  15155. "type": "string",
  15156. "x-go-name": "UserName"
  15157. }
  15158. },
  15159. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15160. },
  15161. "Permission": {
  15162. "description": "Permission represents a set of permissions",
  15163. "type": "object",
  15164. "properties": {
  15165. "admin": {
  15166. "type": "boolean",
  15167. "x-go-name": "Admin"
  15168. },
  15169. "pull": {
  15170. "type": "boolean",
  15171. "x-go-name": "Pull"
  15172. },
  15173. "push": {
  15174. "type": "boolean",
  15175. "x-go-name": "Push"
  15176. }
  15177. },
  15178. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15179. },
  15180. "PublicKey": {
  15181. "description": "PublicKey publickey is a user key to push code to repository",
  15182. "type": "object",
  15183. "properties": {
  15184. "created_at": {
  15185. "type": "string",
  15186. "format": "date-time",
  15187. "x-go-name": "Created"
  15188. },
  15189. "fingerprint": {
  15190. "type": "string",
  15191. "x-go-name": "Fingerprint"
  15192. },
  15193. "id": {
  15194. "type": "integer",
  15195. "format": "int64",
  15196. "x-go-name": "ID"
  15197. },
  15198. "key": {
  15199. "type": "string",
  15200. "x-go-name": "Key"
  15201. },
  15202. "key_type": {
  15203. "type": "string",
  15204. "x-go-name": "KeyType"
  15205. },
  15206. "read_only": {
  15207. "type": "boolean",
  15208. "x-go-name": "ReadOnly"
  15209. },
  15210. "title": {
  15211. "type": "string",
  15212. "x-go-name": "Title"
  15213. },
  15214. "url": {
  15215. "type": "string",
  15216. "x-go-name": "URL"
  15217. },
  15218. "user": {
  15219. "$ref": "#/definitions/User"
  15220. }
  15221. },
  15222. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15223. },
  15224. "PullRequest": {
  15225. "description": "PullRequest represents a pull request",
  15226. "type": "object",
  15227. "properties": {
  15228. "assignee": {
  15229. "$ref": "#/definitions/User"
  15230. },
  15231. "assignees": {
  15232. "type": "array",
  15233. "items": {
  15234. "$ref": "#/definitions/User"
  15235. },
  15236. "x-go-name": "Assignees"
  15237. },
  15238. "base": {
  15239. "$ref": "#/definitions/PRBranchInfo"
  15240. },
  15241. "body": {
  15242. "type": "string",
  15243. "x-go-name": "Body"
  15244. },
  15245. "closed_at": {
  15246. "type": "string",
  15247. "format": "date-time",
  15248. "x-go-name": "Closed"
  15249. },
  15250. "comments": {
  15251. "type": "integer",
  15252. "format": "int64",
  15253. "x-go-name": "Comments"
  15254. },
  15255. "created_at": {
  15256. "type": "string",
  15257. "format": "date-time",
  15258. "x-go-name": "Created"
  15259. },
  15260. "diff_url": {
  15261. "type": "string",
  15262. "x-go-name": "DiffURL"
  15263. },
  15264. "due_date": {
  15265. "type": "string",
  15266. "format": "date-time",
  15267. "x-go-name": "Deadline"
  15268. },
  15269. "head": {
  15270. "$ref": "#/definitions/PRBranchInfo"
  15271. },
  15272. "html_url": {
  15273. "type": "string",
  15274. "x-go-name": "HTMLURL"
  15275. },
  15276. "id": {
  15277. "type": "integer",
  15278. "format": "int64",
  15279. "x-go-name": "ID"
  15280. },
  15281. "is_locked": {
  15282. "type": "boolean",
  15283. "x-go-name": "IsLocked"
  15284. },
  15285. "labels": {
  15286. "type": "array",
  15287. "items": {
  15288. "$ref": "#/definitions/Label"
  15289. },
  15290. "x-go-name": "Labels"
  15291. },
  15292. "merge_base": {
  15293. "type": "string",
  15294. "x-go-name": "MergeBase"
  15295. },
  15296. "merge_commit_sha": {
  15297. "type": "string",
  15298. "x-go-name": "MergedCommitID"
  15299. },
  15300. "mergeable": {
  15301. "type": "boolean",
  15302. "x-go-name": "Mergeable"
  15303. },
  15304. "merged": {
  15305. "type": "boolean",
  15306. "x-go-name": "HasMerged"
  15307. },
  15308. "merged_at": {
  15309. "type": "string",
  15310. "format": "date-time",
  15311. "x-go-name": "Merged"
  15312. },
  15313. "merged_by": {
  15314. "$ref": "#/definitions/User"
  15315. },
  15316. "milestone": {
  15317. "$ref": "#/definitions/Milestone"
  15318. },
  15319. "number": {
  15320. "type": "integer",
  15321. "format": "int64",
  15322. "x-go-name": "Index"
  15323. },
  15324. "patch_url": {
  15325. "type": "string",
  15326. "x-go-name": "PatchURL"
  15327. },
  15328. "state": {
  15329. "$ref": "#/definitions/StateType"
  15330. },
  15331. "title": {
  15332. "type": "string",
  15333. "x-go-name": "Title"
  15334. },
  15335. "updated_at": {
  15336. "type": "string",
  15337. "format": "date-time",
  15338. "x-go-name": "Updated"
  15339. },
  15340. "url": {
  15341. "type": "string",
  15342. "x-go-name": "URL"
  15343. },
  15344. "user": {
  15345. "$ref": "#/definitions/User"
  15346. }
  15347. },
  15348. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15349. },
  15350. "PullRequestMeta": {
  15351. "description": "PullRequestMeta PR info if an issue is a PR",
  15352. "type": "object",
  15353. "properties": {
  15354. "merged": {
  15355. "type": "boolean",
  15356. "x-go-name": "HasMerged"
  15357. },
  15358. "merged_at": {
  15359. "type": "string",
  15360. "format": "date-time",
  15361. "x-go-name": "Merged"
  15362. }
  15363. },
  15364. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15365. },
  15366. "PullReview": {
  15367. "description": "PullReview represents a pull request review",
  15368. "type": "object",
  15369. "properties": {
  15370. "body": {
  15371. "type": "string",
  15372. "x-go-name": "Body"
  15373. },
  15374. "comments_count": {
  15375. "type": "integer",
  15376. "format": "int64",
  15377. "x-go-name": "CodeCommentsCount"
  15378. },
  15379. "commit_id": {
  15380. "type": "string",
  15381. "x-go-name": "CommitID"
  15382. },
  15383. "dismissed": {
  15384. "type": "boolean",
  15385. "x-go-name": "Dismissed"
  15386. },
  15387. "html_url": {
  15388. "type": "string",
  15389. "x-go-name": "HTMLURL"
  15390. },
  15391. "id": {
  15392. "type": "integer",
  15393. "format": "int64",
  15394. "x-go-name": "ID"
  15395. },
  15396. "official": {
  15397. "type": "boolean",
  15398. "x-go-name": "Official"
  15399. },
  15400. "pull_request_url": {
  15401. "type": "string",
  15402. "x-go-name": "HTMLPullURL"
  15403. },
  15404. "stale": {
  15405. "type": "boolean",
  15406. "x-go-name": "Stale"
  15407. },
  15408. "state": {
  15409. "$ref": "#/definitions/ReviewStateType"
  15410. },
  15411. "submitted_at": {
  15412. "type": "string",
  15413. "format": "date-time",
  15414. "x-go-name": "Submitted"
  15415. },
  15416. "team": {
  15417. "$ref": "#/definitions/Team"
  15418. },
  15419. "user": {
  15420. "$ref": "#/definitions/User"
  15421. }
  15422. },
  15423. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15424. },
  15425. "PullReviewComment": {
  15426. "description": "PullReviewComment represents a comment on a pull request review",
  15427. "type": "object",
  15428. "properties": {
  15429. "body": {
  15430. "type": "string",
  15431. "x-go-name": "Body"
  15432. },
  15433. "commit_id": {
  15434. "type": "string",
  15435. "x-go-name": "CommitID"
  15436. },
  15437. "created_at": {
  15438. "type": "string",
  15439. "format": "date-time",
  15440. "x-go-name": "Created"
  15441. },
  15442. "diff_hunk": {
  15443. "type": "string",
  15444. "x-go-name": "DiffHunk"
  15445. },
  15446. "html_url": {
  15447. "type": "string",
  15448. "x-go-name": "HTMLURL"
  15449. },
  15450. "id": {
  15451. "type": "integer",
  15452. "format": "int64",
  15453. "x-go-name": "ID"
  15454. },
  15455. "original_commit_id": {
  15456. "type": "string",
  15457. "x-go-name": "OrigCommitID"
  15458. },
  15459. "original_position": {
  15460. "type": "integer",
  15461. "format": "uint64",
  15462. "x-go-name": "OldLineNum"
  15463. },
  15464. "path": {
  15465. "type": "string",
  15466. "x-go-name": "Path"
  15467. },
  15468. "position": {
  15469. "type": "integer",
  15470. "format": "uint64",
  15471. "x-go-name": "LineNum"
  15472. },
  15473. "pull_request_review_id": {
  15474. "type": "integer",
  15475. "format": "int64",
  15476. "x-go-name": "ReviewID"
  15477. },
  15478. "pull_request_url": {
  15479. "type": "string",
  15480. "x-go-name": "HTMLPullURL"
  15481. },
  15482. "resolver": {
  15483. "$ref": "#/definitions/User"
  15484. },
  15485. "updated_at": {
  15486. "type": "string",
  15487. "format": "date-time",
  15488. "x-go-name": "Updated"
  15489. },
  15490. "user": {
  15491. "$ref": "#/definitions/User"
  15492. }
  15493. },
  15494. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15495. },
  15496. "PullReviewRequestOptions": {
  15497. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  15498. "type": "object",
  15499. "properties": {
  15500. "reviewers": {
  15501. "type": "array",
  15502. "items": {
  15503. "type": "string"
  15504. },
  15505. "x-go-name": "Reviewers"
  15506. },
  15507. "team_reviewers": {
  15508. "type": "array",
  15509. "items": {
  15510. "type": "string"
  15511. },
  15512. "x-go-name": "TeamReviewers"
  15513. }
  15514. },
  15515. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15516. },
  15517. "Reaction": {
  15518. "description": "Reaction contain one reaction",
  15519. "type": "object",
  15520. "properties": {
  15521. "content": {
  15522. "type": "string",
  15523. "x-go-name": "Reaction"
  15524. },
  15525. "created_at": {
  15526. "type": "string",
  15527. "format": "date-time",
  15528. "x-go-name": "Created"
  15529. },
  15530. "user": {
  15531. "$ref": "#/definitions/User"
  15532. }
  15533. },
  15534. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15535. },
  15536. "Reference": {
  15537. "type": "object",
  15538. "title": "Reference represents a Git reference.",
  15539. "properties": {
  15540. "object": {
  15541. "$ref": "#/definitions/GitObject"
  15542. },
  15543. "ref": {
  15544. "type": "string",
  15545. "x-go-name": "Ref"
  15546. },
  15547. "url": {
  15548. "type": "string",
  15549. "x-go-name": "URL"
  15550. }
  15551. },
  15552. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15553. },
  15554. "Release": {
  15555. "description": "Release represents a repository release",
  15556. "type": "object",
  15557. "properties": {
  15558. "assets": {
  15559. "type": "array",
  15560. "items": {
  15561. "$ref": "#/definitions/Attachment"
  15562. },
  15563. "x-go-name": "Attachments"
  15564. },
  15565. "author": {
  15566. "$ref": "#/definitions/User"
  15567. },
  15568. "body": {
  15569. "type": "string",
  15570. "x-go-name": "Note"
  15571. },
  15572. "created_at": {
  15573. "type": "string",
  15574. "format": "date-time",
  15575. "x-go-name": "CreatedAt"
  15576. },
  15577. "draft": {
  15578. "type": "boolean",
  15579. "x-go-name": "IsDraft"
  15580. },
  15581. "html_url": {
  15582. "type": "string",
  15583. "x-go-name": "HTMLURL"
  15584. },
  15585. "id": {
  15586. "type": "integer",
  15587. "format": "int64",
  15588. "x-go-name": "ID"
  15589. },
  15590. "name": {
  15591. "type": "string",
  15592. "x-go-name": "Title"
  15593. },
  15594. "prerelease": {
  15595. "type": "boolean",
  15596. "x-go-name": "IsPrerelease"
  15597. },
  15598. "published_at": {
  15599. "type": "string",
  15600. "format": "date-time",
  15601. "x-go-name": "PublishedAt"
  15602. },
  15603. "tag_name": {
  15604. "type": "string",
  15605. "x-go-name": "TagName"
  15606. },
  15607. "tarball_url": {
  15608. "type": "string",
  15609. "x-go-name": "TarURL"
  15610. },
  15611. "target_commitish": {
  15612. "type": "string",
  15613. "x-go-name": "Target"
  15614. },
  15615. "url": {
  15616. "type": "string",
  15617. "x-go-name": "URL"
  15618. },
  15619. "zipball_url": {
  15620. "type": "string",
  15621. "x-go-name": "ZipURL"
  15622. }
  15623. },
  15624. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15625. },
  15626. "RepoCommit": {
  15627. "type": "object",
  15628. "title": "RepoCommit contains information of a commit in the context of a repository.",
  15629. "properties": {
  15630. "author": {
  15631. "$ref": "#/definitions/CommitUser"
  15632. },
  15633. "committer": {
  15634. "$ref": "#/definitions/CommitUser"
  15635. },
  15636. "message": {
  15637. "type": "string",
  15638. "x-go-name": "Message"
  15639. },
  15640. "tree": {
  15641. "$ref": "#/definitions/CommitMeta"
  15642. },
  15643. "url": {
  15644. "type": "string",
  15645. "x-go-name": "URL"
  15646. }
  15647. },
  15648. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15649. },
  15650. "RepoTopicOptions": {
  15651. "description": "RepoTopicOptions a collection of repo topic names",
  15652. "type": "object",
  15653. "properties": {
  15654. "topics": {
  15655. "description": "list of topic names",
  15656. "type": "array",
  15657. "items": {
  15658. "type": "string"
  15659. },
  15660. "x-go-name": "Topics"
  15661. }
  15662. },
  15663. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15664. },
  15665. "Repository": {
  15666. "description": "Repository represents a repository",
  15667. "type": "object",
  15668. "properties": {
  15669. "allow_merge_commits": {
  15670. "type": "boolean",
  15671. "x-go-name": "AllowMerge"
  15672. },
  15673. "allow_rebase": {
  15674. "type": "boolean",
  15675. "x-go-name": "AllowRebase"
  15676. },
  15677. "allow_rebase_explicit": {
  15678. "type": "boolean",
  15679. "x-go-name": "AllowRebaseMerge"
  15680. },
  15681. "allow_squash_merge": {
  15682. "type": "boolean",
  15683. "x-go-name": "AllowSquash"
  15684. },
  15685. "archived": {
  15686. "type": "boolean",
  15687. "x-go-name": "Archived"
  15688. },
  15689. "avatar_url": {
  15690. "type": "string",
  15691. "x-go-name": "AvatarURL"
  15692. },
  15693. "clone_url": {
  15694. "type": "string",
  15695. "x-go-name": "CloneURL"
  15696. },
  15697. "created_at": {
  15698. "type": "string",
  15699. "format": "date-time",
  15700. "x-go-name": "Created"
  15701. },
  15702. "default_branch": {
  15703. "type": "string",
  15704. "x-go-name": "DefaultBranch"
  15705. },
  15706. "default_merge_style": {
  15707. "type": "string",
  15708. "x-go-name": "DefaultMergeStyle"
  15709. },
  15710. "description": {
  15711. "type": "string",
  15712. "x-go-name": "Description"
  15713. },
  15714. "empty": {
  15715. "type": "boolean",
  15716. "x-go-name": "Empty"
  15717. },
  15718. "external_tracker": {
  15719. "$ref": "#/definitions/ExternalTracker"
  15720. },
  15721. "external_wiki": {
  15722. "$ref": "#/definitions/ExternalWiki"
  15723. },
  15724. "fork": {
  15725. "type": "boolean",
  15726. "x-go-name": "Fork"
  15727. },
  15728. "forks_count": {
  15729. "type": "integer",
  15730. "format": "int64",
  15731. "x-go-name": "Forks"
  15732. },
  15733. "full_name": {
  15734. "type": "string",
  15735. "x-go-name": "FullName"
  15736. },
  15737. "has_issues": {
  15738. "type": "boolean",
  15739. "x-go-name": "HasIssues"
  15740. },
  15741. "has_projects": {
  15742. "type": "boolean",
  15743. "x-go-name": "HasProjects"
  15744. },
  15745. "has_pull_requests": {
  15746. "type": "boolean",
  15747. "x-go-name": "HasPullRequests"
  15748. },
  15749. "has_wiki": {
  15750. "type": "boolean",
  15751. "x-go-name": "HasWiki"
  15752. },
  15753. "html_url": {
  15754. "type": "string",
  15755. "x-go-name": "HTMLURL"
  15756. },
  15757. "id": {
  15758. "type": "integer",
  15759. "format": "int64",
  15760. "x-go-name": "ID"
  15761. },
  15762. "ignore_whitespace_conflicts": {
  15763. "type": "boolean",
  15764. "x-go-name": "IgnoreWhitespaceConflicts"
  15765. },
  15766. "internal": {
  15767. "type": "boolean",
  15768. "x-go-name": "Internal"
  15769. },
  15770. "internal_tracker": {
  15771. "$ref": "#/definitions/InternalTracker"
  15772. },
  15773. "mirror": {
  15774. "type": "boolean",
  15775. "x-go-name": "Mirror"
  15776. },
  15777. "mirror_interval": {
  15778. "type": "string",
  15779. "x-go-name": "MirrorInterval"
  15780. },
  15781. "name": {
  15782. "type": "string",
  15783. "x-go-name": "Name"
  15784. },
  15785. "open_issues_count": {
  15786. "type": "integer",
  15787. "format": "int64",
  15788. "x-go-name": "OpenIssues"
  15789. },
  15790. "open_pr_counter": {
  15791. "type": "integer",
  15792. "format": "int64",
  15793. "x-go-name": "OpenPulls"
  15794. },
  15795. "original_url": {
  15796. "type": "string",
  15797. "x-go-name": "OriginalURL"
  15798. },
  15799. "owner": {
  15800. "$ref": "#/definitions/User"
  15801. },
  15802. "parent": {
  15803. "$ref": "#/definitions/Repository"
  15804. },
  15805. "permissions": {
  15806. "$ref": "#/definitions/Permission"
  15807. },
  15808. "private": {
  15809. "type": "boolean",
  15810. "x-go-name": "Private"
  15811. },
  15812. "release_counter": {
  15813. "type": "integer",
  15814. "format": "int64",
  15815. "x-go-name": "Releases"
  15816. },
  15817. "size": {
  15818. "type": "integer",
  15819. "format": "int64",
  15820. "x-go-name": "Size"
  15821. },
  15822. "ssh_url": {
  15823. "type": "string",
  15824. "x-go-name": "SSHURL"
  15825. },
  15826. "stars_count": {
  15827. "type": "integer",
  15828. "format": "int64",
  15829. "x-go-name": "Stars"
  15830. },
  15831. "template": {
  15832. "type": "boolean",
  15833. "x-go-name": "Template"
  15834. },
  15835. "updated_at": {
  15836. "type": "string",
  15837. "format": "date-time",
  15838. "x-go-name": "Updated"
  15839. },
  15840. "watchers_count": {
  15841. "type": "integer",
  15842. "format": "int64",
  15843. "x-go-name": "Watchers"
  15844. },
  15845. "website": {
  15846. "type": "string",
  15847. "x-go-name": "Website"
  15848. }
  15849. },
  15850. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15851. },
  15852. "RepositoryMeta": {
  15853. "description": "RepositoryMeta basic repository information",
  15854. "type": "object",
  15855. "properties": {
  15856. "full_name": {
  15857. "type": "string",
  15858. "x-go-name": "FullName"
  15859. },
  15860. "id": {
  15861. "type": "integer",
  15862. "format": "int64",
  15863. "x-go-name": "ID"
  15864. },
  15865. "name": {
  15866. "type": "string",
  15867. "x-go-name": "Name"
  15868. },
  15869. "owner": {
  15870. "type": "string",
  15871. "x-go-name": "Owner"
  15872. }
  15873. },
  15874. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15875. },
  15876. "ReviewStateType": {
  15877. "description": "ReviewStateType review state type",
  15878. "type": "string",
  15879. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15880. },
  15881. "SearchResults": {
  15882. "description": "SearchResults results of a successful search",
  15883. "type": "object",
  15884. "properties": {
  15885. "data": {
  15886. "type": "array",
  15887. "items": {
  15888. "$ref": "#/definitions/Repository"
  15889. },
  15890. "x-go-name": "Data"
  15891. },
  15892. "ok": {
  15893. "type": "boolean",
  15894. "x-go-name": "OK"
  15895. }
  15896. },
  15897. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15898. },
  15899. "ServerVersion": {
  15900. "description": "ServerVersion wraps the version of the server",
  15901. "type": "object",
  15902. "properties": {
  15903. "version": {
  15904. "type": "string",
  15905. "x-go-name": "Version"
  15906. }
  15907. },
  15908. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15909. },
  15910. "StateType": {
  15911. "description": "StateType issue state type",
  15912. "type": "string",
  15913. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15914. },
  15915. "StopWatch": {
  15916. "description": "StopWatch represent a running stopwatch",
  15917. "type": "object",
  15918. "properties": {
  15919. "created": {
  15920. "type": "string",
  15921. "format": "date-time",
  15922. "x-go-name": "Created"
  15923. },
  15924. "duration": {
  15925. "type": "string",
  15926. "x-go-name": "Duration"
  15927. },
  15928. "issue_index": {
  15929. "type": "integer",
  15930. "format": "int64",
  15931. "x-go-name": "IssueIndex"
  15932. },
  15933. "issue_title": {
  15934. "type": "string",
  15935. "x-go-name": "IssueTitle"
  15936. },
  15937. "repo_name": {
  15938. "type": "string",
  15939. "x-go-name": "RepoName"
  15940. },
  15941. "repo_owner_name": {
  15942. "type": "string",
  15943. "x-go-name": "RepoOwnerName"
  15944. },
  15945. "seconds": {
  15946. "type": "integer",
  15947. "format": "int64",
  15948. "x-go-name": "Seconds"
  15949. }
  15950. },
  15951. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15952. },
  15953. "SubmitPullReviewOptions": {
  15954. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  15955. "type": "object",
  15956. "properties": {
  15957. "body": {
  15958. "type": "string",
  15959. "x-go-name": "Body"
  15960. },
  15961. "event": {
  15962. "$ref": "#/definitions/ReviewStateType"
  15963. }
  15964. },
  15965. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15966. },
  15967. "Tag": {
  15968. "description": "Tag represents a repository tag",
  15969. "type": "object",
  15970. "properties": {
  15971. "commit": {
  15972. "$ref": "#/definitions/CommitMeta"
  15973. },
  15974. "id": {
  15975. "type": "string",
  15976. "x-go-name": "ID"
  15977. },
  15978. "name": {
  15979. "type": "string",
  15980. "x-go-name": "Name"
  15981. },
  15982. "tarball_url": {
  15983. "type": "string",
  15984. "x-go-name": "TarballURL"
  15985. },
  15986. "zipball_url": {
  15987. "type": "string",
  15988. "x-go-name": "ZipballURL"
  15989. }
  15990. },
  15991. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15992. },
  15993. "Team": {
  15994. "description": "Team represents a team in an organization",
  15995. "type": "object",
  15996. "properties": {
  15997. "can_create_org_repo": {
  15998. "type": "boolean",
  15999. "x-go-name": "CanCreateOrgRepo"
  16000. },
  16001. "description": {
  16002. "type": "string",
  16003. "x-go-name": "Description"
  16004. },
  16005. "id": {
  16006. "type": "integer",
  16007. "format": "int64",
  16008. "x-go-name": "ID"
  16009. },
  16010. "includes_all_repositories": {
  16011. "type": "boolean",
  16012. "x-go-name": "IncludesAllRepositories"
  16013. },
  16014. "name": {
  16015. "type": "string",
  16016. "x-go-name": "Name"
  16017. },
  16018. "organization": {
  16019. "$ref": "#/definitions/Organization"
  16020. },
  16021. "permission": {
  16022. "type": "string",
  16023. "enum": [
  16024. "none",
  16025. "read",
  16026. "write",
  16027. "admin",
  16028. "owner"
  16029. ],
  16030. "x-go-name": "Permission"
  16031. },
  16032. "units": {
  16033. "type": "array",
  16034. "items": {
  16035. "type": "string"
  16036. },
  16037. "x-go-name": "Units",
  16038. "example": [
  16039. "repo.code",
  16040. "repo.issues",
  16041. "repo.ext_issues",
  16042. "repo.wiki",
  16043. "repo.pulls",
  16044. "repo.releases",
  16045. "repo.projects",
  16046. "repo.ext_wiki"
  16047. ]
  16048. }
  16049. },
  16050. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16051. },
  16052. "TimeStamp": {
  16053. "description": "TimeStamp defines a timestamp",
  16054. "type": "integer",
  16055. "format": "int64",
  16056. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  16057. },
  16058. "TopicName": {
  16059. "description": "TopicName a list of repo topic names",
  16060. "type": "object",
  16061. "properties": {
  16062. "topics": {
  16063. "type": "array",
  16064. "items": {
  16065. "type": "string"
  16066. },
  16067. "x-go-name": "TopicNames"
  16068. }
  16069. },
  16070. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16071. },
  16072. "TopicResponse": {
  16073. "description": "TopicResponse for returning topics",
  16074. "type": "object",
  16075. "properties": {
  16076. "created": {
  16077. "type": "string",
  16078. "format": "date-time",
  16079. "x-go-name": "Created"
  16080. },
  16081. "id": {
  16082. "type": "integer",
  16083. "format": "int64",
  16084. "x-go-name": "ID"
  16085. },
  16086. "repo_count": {
  16087. "type": "integer",
  16088. "format": "int64",
  16089. "x-go-name": "RepoCount"
  16090. },
  16091. "topic_name": {
  16092. "type": "string",
  16093. "x-go-name": "Name"
  16094. },
  16095. "updated": {
  16096. "type": "string",
  16097. "format": "date-time",
  16098. "x-go-name": "Updated"
  16099. }
  16100. },
  16101. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16102. },
  16103. "TrackedTime": {
  16104. "description": "TrackedTime worked time for an issue / pr",
  16105. "type": "object",
  16106. "properties": {
  16107. "created": {
  16108. "type": "string",
  16109. "format": "date-time",
  16110. "x-go-name": "Created"
  16111. },
  16112. "id": {
  16113. "type": "integer",
  16114. "format": "int64",
  16115. "x-go-name": "ID"
  16116. },
  16117. "issue": {
  16118. "$ref": "#/definitions/Issue"
  16119. },
  16120. "issue_id": {
  16121. "description": "deprecated (only for backwards compatibility)",
  16122. "type": "integer",
  16123. "format": "int64",
  16124. "x-go-name": "IssueID"
  16125. },
  16126. "time": {
  16127. "description": "Time in seconds",
  16128. "type": "integer",
  16129. "format": "int64",
  16130. "x-go-name": "Time"
  16131. },
  16132. "user_id": {
  16133. "description": "deprecated (only for backwards compatibility)",
  16134. "type": "integer",
  16135. "format": "int64",
  16136. "x-go-name": "UserID"
  16137. },
  16138. "user_name": {
  16139. "type": "string",
  16140. "x-go-name": "UserName"
  16141. }
  16142. },
  16143. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16144. },
  16145. "TransferRepoOption": {
  16146. "description": "TransferRepoOption options when transfer a repository's ownership",
  16147. "type": "object",
  16148. "required": [
  16149. "new_owner"
  16150. ],
  16151. "properties": {
  16152. "new_owner": {
  16153. "type": "string",
  16154. "x-go-name": "NewOwner"
  16155. },
  16156. "team_ids": {
  16157. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  16158. "type": "array",
  16159. "items": {
  16160. "type": "integer",
  16161. "format": "int64"
  16162. },
  16163. "x-go-name": "TeamIDs"
  16164. }
  16165. },
  16166. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16167. },
  16168. "UpdateFileOptions": {
  16169. "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)",
  16170. "type": "object",
  16171. "required": [
  16172. "sha",
  16173. "content"
  16174. ],
  16175. "properties": {
  16176. "author": {
  16177. "$ref": "#/definitions/Identity"
  16178. },
  16179. "branch": {
  16180. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  16181. "type": "string",
  16182. "x-go-name": "BranchName"
  16183. },
  16184. "committer": {
  16185. "$ref": "#/definitions/Identity"
  16186. },
  16187. "content": {
  16188. "description": "content must be base64 encoded",
  16189. "type": "string",
  16190. "x-go-name": "Content"
  16191. },
  16192. "dates": {
  16193. "$ref": "#/definitions/CommitDateOptions"
  16194. },
  16195. "from_path": {
  16196. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  16197. "type": "string",
  16198. "x-go-name": "FromPath"
  16199. },
  16200. "message": {
  16201. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  16202. "type": "string",
  16203. "x-go-name": "Message"
  16204. },
  16205. "new_branch": {
  16206. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  16207. "type": "string",
  16208. "x-go-name": "NewBranchName"
  16209. },
  16210. "sha": {
  16211. "description": "sha is the SHA for the file that already exists",
  16212. "type": "string",
  16213. "x-go-name": "SHA"
  16214. },
  16215. "signoff": {
  16216. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  16217. "type": "boolean",
  16218. "x-go-name": "Signoff"
  16219. }
  16220. },
  16221. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16222. },
  16223. "User": {
  16224. "description": "User represents a user",
  16225. "type": "object",
  16226. "properties": {
  16227. "avatar_url": {
  16228. "description": "URL to the user's avatar",
  16229. "type": "string",
  16230. "x-go-name": "AvatarURL"
  16231. },
  16232. "created": {
  16233. "type": "string",
  16234. "format": "date-time",
  16235. "x-go-name": "Created"
  16236. },
  16237. "email": {
  16238. "type": "string",
  16239. "format": "email",
  16240. "x-go-name": "Email"
  16241. },
  16242. "full_name": {
  16243. "description": "the user's full name",
  16244. "type": "string",
  16245. "x-go-name": "FullName"
  16246. },
  16247. "id": {
  16248. "description": "the user's id",
  16249. "type": "integer",
  16250. "format": "int64",
  16251. "x-go-name": "ID"
  16252. },
  16253. "is_admin": {
  16254. "description": "Is the user an administrator",
  16255. "type": "boolean",
  16256. "x-go-name": "IsAdmin"
  16257. },
  16258. "language": {
  16259. "description": "User locale",
  16260. "type": "string",
  16261. "x-go-name": "Language"
  16262. },
  16263. "last_login": {
  16264. "type": "string",
  16265. "format": "date-time",
  16266. "x-go-name": "LastLogin"
  16267. },
  16268. "login": {
  16269. "description": "the user's username",
  16270. "type": "string",
  16271. "x-go-name": "UserName"
  16272. },
  16273. "restricted": {
  16274. "description": "Is user restricted",
  16275. "type": "boolean",
  16276. "x-go-name": "Restricted"
  16277. }
  16278. },
  16279. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16280. },
  16281. "UserHeatmapData": {
  16282. "description": "UserHeatmapData represents the data needed to create a heatmap",
  16283. "type": "object",
  16284. "properties": {
  16285. "contributions": {
  16286. "type": "integer",
  16287. "format": "int64",
  16288. "x-go-name": "Contributions"
  16289. },
  16290. "timestamp": {
  16291. "$ref": "#/definitions/TimeStamp"
  16292. }
  16293. },
  16294. "x-go-package": "code.gitea.io/gitea/models"
  16295. },
  16296. "WatchInfo": {
  16297. "description": "WatchInfo represents an API watch status of one repository",
  16298. "type": "object",
  16299. "properties": {
  16300. "created_at": {
  16301. "type": "string",
  16302. "format": "date-time",
  16303. "x-go-name": "CreatedAt"
  16304. },
  16305. "ignored": {
  16306. "type": "boolean",
  16307. "x-go-name": "Ignored"
  16308. },
  16309. "reason": {
  16310. "type": "object",
  16311. "x-go-name": "Reason"
  16312. },
  16313. "repository_url": {
  16314. "type": "string",
  16315. "x-go-name": "RepositoryURL"
  16316. },
  16317. "subscribed": {
  16318. "type": "boolean",
  16319. "x-go-name": "Subscribed"
  16320. },
  16321. "url": {
  16322. "type": "string",
  16323. "x-go-name": "URL"
  16324. }
  16325. },
  16326. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16327. }
  16328. },
  16329. "responses": {
  16330. "AccessToken": {
  16331. "description": "AccessToken represents an API access token.",
  16332. "headers": {
  16333. "id": {
  16334. "type": "integer",
  16335. "format": "int64"
  16336. },
  16337. "name": {
  16338. "type": "string"
  16339. },
  16340. "sha1": {
  16341. "type": "string"
  16342. },
  16343. "token_last_eight": {
  16344. "type": "string"
  16345. }
  16346. }
  16347. },
  16348. "AccessTokenList": {
  16349. "description": "AccessTokenList represents a list of API access token.",
  16350. "schema": {
  16351. "type": "array",
  16352. "items": {
  16353. "$ref": "#/definitions/AccessToken"
  16354. }
  16355. }
  16356. },
  16357. "AnnotatedTag": {
  16358. "description": "AnnotatedTag",
  16359. "schema": {
  16360. "$ref": "#/definitions/AnnotatedTag"
  16361. }
  16362. },
  16363. "Attachment": {
  16364. "description": "Attachment",
  16365. "schema": {
  16366. "$ref": "#/definitions/Attachment"
  16367. }
  16368. },
  16369. "AttachmentList": {
  16370. "description": "AttachmentList",
  16371. "schema": {
  16372. "type": "array",
  16373. "items": {
  16374. "$ref": "#/definitions/Attachment"
  16375. }
  16376. }
  16377. },
  16378. "Branch": {
  16379. "description": "Branch",
  16380. "schema": {
  16381. "$ref": "#/definitions/Branch"
  16382. }
  16383. },
  16384. "BranchList": {
  16385. "description": "BranchList",
  16386. "schema": {
  16387. "type": "array",
  16388. "items": {
  16389. "$ref": "#/definitions/Branch"
  16390. }
  16391. }
  16392. },
  16393. "BranchProtection": {
  16394. "description": "BranchProtection",
  16395. "schema": {
  16396. "$ref": "#/definitions/BranchProtection"
  16397. }
  16398. },
  16399. "BranchProtectionList": {
  16400. "description": "BranchProtectionList",
  16401. "schema": {
  16402. "type": "array",
  16403. "items": {
  16404. "$ref": "#/definitions/BranchProtection"
  16405. }
  16406. }
  16407. },
  16408. "CombinedStatus": {
  16409. "description": "CombinedStatus",
  16410. "schema": {
  16411. "$ref": "#/definitions/CombinedStatus"
  16412. }
  16413. },
  16414. "Comment": {
  16415. "description": "Comment",
  16416. "schema": {
  16417. "$ref": "#/definitions/Comment"
  16418. }
  16419. },
  16420. "CommentList": {
  16421. "description": "CommentList",
  16422. "schema": {
  16423. "type": "array",
  16424. "items": {
  16425. "$ref": "#/definitions/Comment"
  16426. }
  16427. }
  16428. },
  16429. "Commit": {
  16430. "description": "Commit",
  16431. "schema": {
  16432. "$ref": "#/definitions/Commit"
  16433. }
  16434. },
  16435. "CommitList": {
  16436. "description": "CommitList",
  16437. "schema": {
  16438. "type": "array",
  16439. "items": {
  16440. "$ref": "#/definitions/Commit"
  16441. }
  16442. },
  16443. "headers": {
  16444. "X-HasMore": {
  16445. "type": "boolean",
  16446. "description": "True if there is another page"
  16447. },
  16448. "X-Page": {
  16449. "type": "integer",
  16450. "format": "int64",
  16451. "description": "The current page"
  16452. },
  16453. "X-PageCount": {
  16454. "type": "integer",
  16455. "format": "int64",
  16456. "description": "Total number of pages"
  16457. },
  16458. "X-PerPage": {
  16459. "type": "integer",
  16460. "format": "int64",
  16461. "description": "Commits per page"
  16462. },
  16463. "X-Total": {
  16464. "type": "integer",
  16465. "format": "int64",
  16466. "description": "Total commit count"
  16467. }
  16468. }
  16469. },
  16470. "CommitStatus": {
  16471. "description": "CommitStatus",
  16472. "schema": {
  16473. "$ref": "#/definitions/CommitStatus"
  16474. }
  16475. },
  16476. "CommitStatusList": {
  16477. "description": "CommitStatusList",
  16478. "schema": {
  16479. "type": "array",
  16480. "items": {
  16481. "$ref": "#/definitions/CommitStatus"
  16482. }
  16483. }
  16484. },
  16485. "ContentsListResponse": {
  16486. "description": "ContentsListResponse",
  16487. "schema": {
  16488. "type": "array",
  16489. "items": {
  16490. "$ref": "#/definitions/ContentsResponse"
  16491. }
  16492. }
  16493. },
  16494. "ContentsResponse": {
  16495. "description": "ContentsResponse",
  16496. "schema": {
  16497. "$ref": "#/definitions/ContentsResponse"
  16498. }
  16499. },
  16500. "CronList": {
  16501. "description": "CronList",
  16502. "schema": {
  16503. "type": "array",
  16504. "items": {
  16505. "$ref": "#/definitions/Cron"
  16506. }
  16507. }
  16508. },
  16509. "DeployKey": {
  16510. "description": "DeployKey",
  16511. "schema": {
  16512. "$ref": "#/definitions/DeployKey"
  16513. }
  16514. },
  16515. "DeployKeyList": {
  16516. "description": "DeployKeyList",
  16517. "schema": {
  16518. "type": "array",
  16519. "items": {
  16520. "$ref": "#/definitions/DeployKey"
  16521. }
  16522. }
  16523. },
  16524. "EmailList": {
  16525. "description": "EmailList",
  16526. "schema": {
  16527. "type": "array",
  16528. "items": {
  16529. "$ref": "#/definitions/Email"
  16530. }
  16531. }
  16532. },
  16533. "EmptyRepository": {
  16534. "description": "EmptyRepository",
  16535. "schema": {
  16536. "$ref": "#/definitions/APIError"
  16537. }
  16538. },
  16539. "FileDeleteResponse": {
  16540. "description": "FileDeleteResponse",
  16541. "schema": {
  16542. "$ref": "#/definitions/FileDeleteResponse"
  16543. }
  16544. },
  16545. "FileResponse": {
  16546. "description": "FileResponse",
  16547. "schema": {
  16548. "$ref": "#/definitions/FileResponse"
  16549. }
  16550. },
  16551. "GPGKey": {
  16552. "description": "GPGKey",
  16553. "schema": {
  16554. "$ref": "#/definitions/GPGKey"
  16555. }
  16556. },
  16557. "GPGKeyList": {
  16558. "description": "GPGKeyList",
  16559. "schema": {
  16560. "type": "array",
  16561. "items": {
  16562. "$ref": "#/definitions/GPGKey"
  16563. }
  16564. }
  16565. },
  16566. "GeneralAPISettings": {
  16567. "description": "GeneralAPISettings",
  16568. "schema": {
  16569. "$ref": "#/definitions/GeneralAPISettings"
  16570. }
  16571. },
  16572. "GeneralAttachmentSettings": {
  16573. "description": "GeneralAttachmentSettings",
  16574. "schema": {
  16575. "$ref": "#/definitions/GeneralAttachmentSettings"
  16576. }
  16577. },
  16578. "GeneralRepoSettings": {
  16579. "description": "GeneralRepoSettings",
  16580. "schema": {
  16581. "$ref": "#/definitions/GeneralRepoSettings"
  16582. }
  16583. },
  16584. "GeneralUISettings": {
  16585. "description": "GeneralUISettings",
  16586. "schema": {
  16587. "$ref": "#/definitions/GeneralUISettings"
  16588. }
  16589. },
  16590. "GitBlobResponse": {
  16591. "description": "GitBlobResponse",
  16592. "schema": {
  16593. "$ref": "#/definitions/GitBlobResponse"
  16594. }
  16595. },
  16596. "GitHook": {
  16597. "description": "GitHook",
  16598. "schema": {
  16599. "$ref": "#/definitions/GitHook"
  16600. }
  16601. },
  16602. "GitHookList": {
  16603. "description": "GitHookList",
  16604. "schema": {
  16605. "type": "array",
  16606. "items": {
  16607. "$ref": "#/definitions/GitHook"
  16608. }
  16609. }
  16610. },
  16611. "GitTreeResponse": {
  16612. "description": "GitTreeResponse",
  16613. "schema": {
  16614. "$ref": "#/definitions/GitTreeResponse"
  16615. }
  16616. },
  16617. "Hook": {
  16618. "description": "Hook",
  16619. "schema": {
  16620. "$ref": "#/definitions/Hook"
  16621. }
  16622. },
  16623. "HookList": {
  16624. "description": "HookList",
  16625. "schema": {
  16626. "type": "array",
  16627. "items": {
  16628. "$ref": "#/definitions/Hook"
  16629. }
  16630. }
  16631. },
  16632. "Issue": {
  16633. "description": "Issue",
  16634. "schema": {
  16635. "$ref": "#/definitions/Issue"
  16636. }
  16637. },
  16638. "IssueDeadline": {
  16639. "description": "IssueDeadline",
  16640. "schema": {
  16641. "$ref": "#/definitions/IssueDeadline"
  16642. }
  16643. },
  16644. "IssueList": {
  16645. "description": "IssueList",
  16646. "schema": {
  16647. "type": "array",
  16648. "items": {
  16649. "$ref": "#/definitions/Issue"
  16650. }
  16651. }
  16652. },
  16653. "IssueTemplates": {
  16654. "description": "IssueTemplates",
  16655. "schema": {
  16656. "type": "array",
  16657. "items": {
  16658. "$ref": "#/definitions/IssueTemplate"
  16659. }
  16660. }
  16661. },
  16662. "Label": {
  16663. "description": "Label",
  16664. "schema": {
  16665. "$ref": "#/definitions/Label"
  16666. }
  16667. },
  16668. "LabelList": {
  16669. "description": "LabelList",
  16670. "schema": {
  16671. "type": "array",
  16672. "items": {
  16673. "$ref": "#/definitions/Label"
  16674. }
  16675. }
  16676. },
  16677. "LanguageStatistics": {
  16678. "description": "LanguageStatistics",
  16679. "schema": {
  16680. "type": "object",
  16681. "additionalProperties": {
  16682. "type": "integer",
  16683. "format": "int64"
  16684. }
  16685. }
  16686. },
  16687. "MarkdownRender": {
  16688. "description": "MarkdownRender is a rendered markdown document",
  16689. "schema": {
  16690. "type": "string"
  16691. }
  16692. },
  16693. "Milestone": {
  16694. "description": "Milestone",
  16695. "schema": {
  16696. "$ref": "#/definitions/Milestone"
  16697. }
  16698. },
  16699. "MilestoneList": {
  16700. "description": "MilestoneList",
  16701. "schema": {
  16702. "type": "array",
  16703. "items": {
  16704. "$ref": "#/definitions/Milestone"
  16705. }
  16706. }
  16707. },
  16708. "NotificationCount": {
  16709. "description": "Number of unread notifications",
  16710. "schema": {
  16711. "$ref": "#/definitions/NotificationCount"
  16712. }
  16713. },
  16714. "NotificationThread": {
  16715. "description": "NotificationThread",
  16716. "schema": {
  16717. "$ref": "#/definitions/NotificationThread"
  16718. }
  16719. },
  16720. "NotificationThreadList": {
  16721. "description": "NotificationThreadList",
  16722. "schema": {
  16723. "type": "array",
  16724. "items": {
  16725. "$ref": "#/definitions/NotificationThread"
  16726. }
  16727. }
  16728. },
  16729. "OAuth2Application": {
  16730. "description": "OAuth2Application",
  16731. "schema": {
  16732. "$ref": "#/definitions/OAuth2Application"
  16733. }
  16734. },
  16735. "OAuth2ApplicationList": {
  16736. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  16737. "schema": {
  16738. "type": "array",
  16739. "items": {
  16740. "$ref": "#/definitions/OAuth2Application"
  16741. }
  16742. }
  16743. },
  16744. "Organization": {
  16745. "description": "Organization",
  16746. "schema": {
  16747. "$ref": "#/definitions/Organization"
  16748. }
  16749. },
  16750. "OrganizationList": {
  16751. "description": "OrganizationList",
  16752. "schema": {
  16753. "type": "array",
  16754. "items": {
  16755. "$ref": "#/definitions/Organization"
  16756. }
  16757. }
  16758. },
  16759. "PublicKey": {
  16760. "description": "PublicKey",
  16761. "schema": {
  16762. "$ref": "#/definitions/PublicKey"
  16763. }
  16764. },
  16765. "PublicKeyList": {
  16766. "description": "PublicKeyList",
  16767. "schema": {
  16768. "type": "array",
  16769. "items": {
  16770. "$ref": "#/definitions/PublicKey"
  16771. }
  16772. }
  16773. },
  16774. "PullRequest": {
  16775. "description": "PullRequest",
  16776. "schema": {
  16777. "$ref": "#/definitions/PullRequest"
  16778. }
  16779. },
  16780. "PullRequestList": {
  16781. "description": "PullRequestList",
  16782. "schema": {
  16783. "type": "array",
  16784. "items": {
  16785. "$ref": "#/definitions/PullRequest"
  16786. }
  16787. }
  16788. },
  16789. "PullReview": {
  16790. "description": "PullReview",
  16791. "schema": {
  16792. "$ref": "#/definitions/PullReview"
  16793. }
  16794. },
  16795. "PullReviewComment": {
  16796. "description": "PullComment",
  16797. "schema": {
  16798. "$ref": "#/definitions/PullReviewComment"
  16799. }
  16800. },
  16801. "PullReviewCommentList": {
  16802. "description": "PullCommentList",
  16803. "schema": {
  16804. "type": "array",
  16805. "items": {
  16806. "$ref": "#/definitions/PullReviewComment"
  16807. }
  16808. }
  16809. },
  16810. "PullReviewList": {
  16811. "description": "PullReviewList",
  16812. "schema": {
  16813. "type": "array",
  16814. "items": {
  16815. "$ref": "#/definitions/PullReview"
  16816. }
  16817. }
  16818. },
  16819. "Reaction": {
  16820. "description": "Reaction",
  16821. "schema": {
  16822. "$ref": "#/definitions/Reaction"
  16823. }
  16824. },
  16825. "ReactionList": {
  16826. "description": "ReactionList",
  16827. "schema": {
  16828. "type": "array",
  16829. "items": {
  16830. "$ref": "#/definitions/Reaction"
  16831. }
  16832. }
  16833. },
  16834. "Reference": {
  16835. "description": "Reference",
  16836. "schema": {
  16837. "$ref": "#/definitions/Reference"
  16838. }
  16839. },
  16840. "ReferenceList": {
  16841. "description": "ReferenceList",
  16842. "schema": {
  16843. "type": "array",
  16844. "items": {
  16845. "$ref": "#/definitions/Reference"
  16846. }
  16847. }
  16848. },
  16849. "Release": {
  16850. "description": "Release",
  16851. "schema": {
  16852. "$ref": "#/definitions/Release"
  16853. }
  16854. },
  16855. "ReleaseList": {
  16856. "description": "ReleaseList",
  16857. "schema": {
  16858. "type": "array",
  16859. "items": {
  16860. "$ref": "#/definitions/Release"
  16861. }
  16862. }
  16863. },
  16864. "Repository": {
  16865. "description": "Repository",
  16866. "schema": {
  16867. "$ref": "#/definitions/Repository"
  16868. }
  16869. },
  16870. "RepositoryList": {
  16871. "description": "RepositoryList",
  16872. "schema": {
  16873. "type": "array",
  16874. "items": {
  16875. "$ref": "#/definitions/Repository"
  16876. }
  16877. }
  16878. },
  16879. "SearchResults": {
  16880. "description": "SearchResults",
  16881. "schema": {
  16882. "$ref": "#/definitions/SearchResults"
  16883. }
  16884. },
  16885. "ServerVersion": {
  16886. "description": "ServerVersion",
  16887. "schema": {
  16888. "$ref": "#/definitions/ServerVersion"
  16889. }
  16890. },
  16891. "StopWatch": {
  16892. "description": "StopWatch",
  16893. "schema": {
  16894. "$ref": "#/definitions/StopWatch"
  16895. }
  16896. },
  16897. "StopWatchList": {
  16898. "description": "StopWatchList",
  16899. "schema": {
  16900. "type": "array",
  16901. "items": {
  16902. "$ref": "#/definitions/StopWatch"
  16903. }
  16904. }
  16905. },
  16906. "StringSlice": {
  16907. "description": "StringSlice",
  16908. "schema": {
  16909. "type": "array",
  16910. "items": {
  16911. "type": "string"
  16912. }
  16913. }
  16914. },
  16915. "Tag": {
  16916. "description": "Tag",
  16917. "schema": {
  16918. "$ref": "#/definitions/Tag"
  16919. }
  16920. },
  16921. "TagList": {
  16922. "description": "TagList",
  16923. "schema": {
  16924. "type": "array",
  16925. "items": {
  16926. "$ref": "#/definitions/Tag"
  16927. }
  16928. }
  16929. },
  16930. "Team": {
  16931. "description": "Team",
  16932. "schema": {
  16933. "$ref": "#/definitions/Team"
  16934. }
  16935. },
  16936. "TeamList": {
  16937. "description": "TeamList",
  16938. "schema": {
  16939. "type": "array",
  16940. "items": {
  16941. "$ref": "#/definitions/Team"
  16942. }
  16943. }
  16944. },
  16945. "TopicListResponse": {
  16946. "description": "TopicListResponse",
  16947. "schema": {
  16948. "type": "array",
  16949. "items": {
  16950. "$ref": "#/definitions/TopicResponse"
  16951. }
  16952. }
  16953. },
  16954. "TopicNames": {
  16955. "description": "TopicNames",
  16956. "schema": {
  16957. "$ref": "#/definitions/TopicName"
  16958. }
  16959. },
  16960. "TrackedTime": {
  16961. "description": "TrackedTime",
  16962. "schema": {
  16963. "$ref": "#/definitions/TrackedTime"
  16964. }
  16965. },
  16966. "TrackedTimeList": {
  16967. "description": "TrackedTimeList",
  16968. "schema": {
  16969. "type": "array",
  16970. "items": {
  16971. "$ref": "#/definitions/TrackedTime"
  16972. }
  16973. }
  16974. },
  16975. "User": {
  16976. "description": "User",
  16977. "schema": {
  16978. "$ref": "#/definitions/User"
  16979. }
  16980. },
  16981. "UserHeatmapData": {
  16982. "description": "UserHeatmapData",
  16983. "schema": {
  16984. "type": "array",
  16985. "items": {
  16986. "$ref": "#/definitions/UserHeatmapData"
  16987. }
  16988. }
  16989. },
  16990. "UserList": {
  16991. "description": "UserList",
  16992. "schema": {
  16993. "type": "array",
  16994. "items": {
  16995. "$ref": "#/definitions/User"
  16996. }
  16997. }
  16998. },
  16999. "WatchInfo": {
  17000. "description": "WatchInfo",
  17001. "schema": {
  17002. "$ref": "#/definitions/WatchInfo"
  17003. }
  17004. },
  17005. "conflict": {
  17006. "description": "APIConflict is a conflict empty response"
  17007. },
  17008. "empty": {
  17009. "description": "APIEmpty is an empty response"
  17010. },
  17011. "error": {
  17012. "description": "APIError is error format response",
  17013. "headers": {
  17014. "message": {
  17015. "type": "string"
  17016. },
  17017. "url": {
  17018. "type": "string"
  17019. }
  17020. }
  17021. },
  17022. "forbidden": {
  17023. "description": "APIForbiddenError is a forbidden error response",
  17024. "headers": {
  17025. "message": {
  17026. "type": "string"
  17027. },
  17028. "url": {
  17029. "type": "string"
  17030. }
  17031. }
  17032. },
  17033. "invalidTopicsError": {
  17034. "description": "APIInvalidTopicsError is error format response to invalid topics",
  17035. "headers": {
  17036. "invalidTopics": {
  17037. "type": "array",
  17038. "items": {
  17039. "type": "string"
  17040. }
  17041. },
  17042. "message": {
  17043. "type": "string"
  17044. }
  17045. }
  17046. },
  17047. "notFound": {
  17048. "description": "APINotFound is a not found empty response"
  17049. },
  17050. "parameterBodies": {
  17051. "description": "parameterBodies",
  17052. "schema": {
  17053. "$ref": "#/definitions/PullReviewRequestOptions"
  17054. }
  17055. },
  17056. "redirect": {
  17057. "description": "APIRedirect is a redirect response"
  17058. },
  17059. "string": {
  17060. "description": "APIString is a string response",
  17061. "schema": {
  17062. "type": "string"
  17063. }
  17064. },
  17065. "validationError": {
  17066. "description": "APIValidationError is error format response related to input validation",
  17067. "headers": {
  17068. "message": {
  17069. "type": "string"
  17070. },
  17071. "url": {
  17072. "type": "string"
  17073. }
  17074. }
  17075. }
  17076. },
  17077. "securityDefinitions": {
  17078. "AccessToken": {
  17079. "type": "apiKey",
  17080. "name": "access_token",
  17081. "in": "query"
  17082. },
  17083. "AuthorizationHeaderToken": {
  17084. "description": "API tokens must be prepended with \"token\" followed by a space.",
  17085. "type": "apiKey",
  17086. "name": "Authorization",
  17087. "in": "header"
  17088. },
  17089. "BasicAuth": {
  17090. "type": "basic"
  17091. },
  17092. "SudoHeader": {
  17093. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  17094. "type": "apiKey",
  17095. "name": "Sudo",
  17096. "in": "header"
  17097. },
  17098. "SudoParam": {
  17099. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  17100. "type": "apiKey",
  17101. "name": "sudo",
  17102. "in": "query"
  17103. },
  17104. "TOTPHeader": {
  17105. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  17106. "type": "apiKey",
  17107. "name": "X-GITEA-OTP",
  17108. "in": "header"
  17109. },
  17110. "Token": {
  17111. "type": "apiKey",
  17112. "name": "token",
  17113. "in": "query"
  17114. }
  17115. },
  17116. "security": [
  17117. {
  17118. "BasicAuth": []
  17119. },
  17120. {
  17121. "Token": []
  17122. },
  17123. {
  17124. "AccessToken": []
  17125. },
  17126. {
  17127. "AuthorizationHeaderToken": []
  17128. },
  17129. {
  17130. "SudoParam": []
  17131. },
  17132. {
  17133. "SudoHeader": []
  17134. },
  17135. {
  17136. "TOTPHeader": []
  17137. }
  17138. ]
  17139. }