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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955
  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": "boolean",
  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": "array",
  650. "items": {
  651. "enum": [
  652. "issue",
  653. "pull",
  654. "commit",
  655. "repository"
  656. ],
  657. "type": "string"
  658. },
  659. "collectionFormat": "multi",
  660. "description": "filter notifications by subject type",
  661. "name": "subject-type",
  662. "in": "query"
  663. },
  664. {
  665. "type": "string",
  666. "format": "date-time",
  667. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  668. "name": "since",
  669. "in": "query"
  670. },
  671. {
  672. "type": "string",
  673. "format": "date-time",
  674. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  675. "name": "before",
  676. "in": "query"
  677. },
  678. {
  679. "type": "integer",
  680. "description": "page number of results to return (1-based)",
  681. "name": "page",
  682. "in": "query"
  683. },
  684. {
  685. "type": "integer",
  686. "description": "page size of results",
  687. "name": "limit",
  688. "in": "query"
  689. }
  690. ],
  691. "responses": {
  692. "200": {
  693. "$ref": "#/responses/NotificationThreadList"
  694. }
  695. }
  696. },
  697. "put": {
  698. "consumes": [
  699. "application/json"
  700. ],
  701. "produces": [
  702. "application/json"
  703. ],
  704. "tags": [
  705. "notification"
  706. ],
  707. "summary": "Mark notification threads as read, pinned or unread",
  708. "operationId": "notifyReadList",
  709. "parameters": [
  710. {
  711. "type": "string",
  712. "format": "date-time",
  713. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  714. "name": "last_read_at",
  715. "in": "query"
  716. },
  717. {
  718. "type": "string",
  719. "description": "If true, mark all notifications on this repo. Default value is false",
  720. "name": "all",
  721. "in": "query"
  722. },
  723. {
  724. "type": "array",
  725. "items": {
  726. "type": "string"
  727. },
  728. "collectionFormat": "multi",
  729. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  730. "name": "status-types",
  731. "in": "query"
  732. },
  733. {
  734. "type": "string",
  735. "description": "Status to mark notifications as, Defaults to read.",
  736. "name": "to-status",
  737. "in": "query"
  738. }
  739. ],
  740. "responses": {
  741. "205": {
  742. "$ref": "#/responses/NotificationThreadList"
  743. }
  744. }
  745. }
  746. },
  747. "/notifications/new": {
  748. "get": {
  749. "tags": [
  750. "notification"
  751. ],
  752. "summary": "Check if unread notifications exist",
  753. "operationId": "notifyNewAvailable",
  754. "responses": {
  755. "200": {
  756. "$ref": "#/responses/NotificationCount"
  757. }
  758. }
  759. }
  760. },
  761. "/notifications/threads/{id}": {
  762. "get": {
  763. "consumes": [
  764. "application/json"
  765. ],
  766. "produces": [
  767. "application/json"
  768. ],
  769. "tags": [
  770. "notification"
  771. ],
  772. "summary": "Get notification thread by ID",
  773. "operationId": "notifyGetThread",
  774. "parameters": [
  775. {
  776. "type": "string",
  777. "description": "id of notification thread",
  778. "name": "id",
  779. "in": "path",
  780. "required": true
  781. }
  782. ],
  783. "responses": {
  784. "200": {
  785. "$ref": "#/responses/NotificationThread"
  786. },
  787. "403": {
  788. "$ref": "#/responses/forbidden"
  789. },
  790. "404": {
  791. "$ref": "#/responses/notFound"
  792. }
  793. }
  794. },
  795. "patch": {
  796. "consumes": [
  797. "application/json"
  798. ],
  799. "produces": [
  800. "application/json"
  801. ],
  802. "tags": [
  803. "notification"
  804. ],
  805. "summary": "Mark notification thread as read by ID",
  806. "operationId": "notifyReadThread",
  807. "parameters": [
  808. {
  809. "type": "string",
  810. "description": "id of notification thread",
  811. "name": "id",
  812. "in": "path",
  813. "required": true
  814. },
  815. {
  816. "type": "string",
  817. "default": "read",
  818. "description": "Status to mark notifications as",
  819. "name": "to-status",
  820. "in": "query"
  821. }
  822. ],
  823. "responses": {
  824. "205": {
  825. "$ref": "#/responses/NotificationThread"
  826. },
  827. "403": {
  828. "$ref": "#/responses/forbidden"
  829. },
  830. "404": {
  831. "$ref": "#/responses/notFound"
  832. }
  833. }
  834. }
  835. },
  836. "/org/{org}/repos": {
  837. "post": {
  838. "consumes": [
  839. "application/json"
  840. ],
  841. "produces": [
  842. "application/json"
  843. ],
  844. "tags": [
  845. "organization"
  846. ],
  847. "summary": "Create a repository in an organization",
  848. "operationId": "createOrgRepoDeprecated",
  849. "deprecated": true,
  850. "parameters": [
  851. {
  852. "type": "string",
  853. "description": "name of organization",
  854. "name": "org",
  855. "in": "path",
  856. "required": true
  857. },
  858. {
  859. "name": "body",
  860. "in": "body",
  861. "schema": {
  862. "$ref": "#/definitions/CreateRepoOption"
  863. }
  864. }
  865. ],
  866. "responses": {
  867. "201": {
  868. "$ref": "#/responses/Repository"
  869. },
  870. "403": {
  871. "$ref": "#/responses/forbidden"
  872. },
  873. "422": {
  874. "$ref": "#/responses/validationError"
  875. }
  876. }
  877. }
  878. },
  879. "/orgs": {
  880. "get": {
  881. "produces": [
  882. "application/json"
  883. ],
  884. "tags": [
  885. "organization"
  886. ],
  887. "summary": "Get list of organizations",
  888. "operationId": "orgGetAll",
  889. "parameters": [
  890. {
  891. "type": "integer",
  892. "description": "page number of results to return (1-based)",
  893. "name": "page",
  894. "in": "query"
  895. },
  896. {
  897. "type": "integer",
  898. "description": "page size of results",
  899. "name": "limit",
  900. "in": "query"
  901. }
  902. ],
  903. "responses": {
  904. "200": {
  905. "$ref": "#/responses/OrganizationList"
  906. }
  907. }
  908. },
  909. "post": {
  910. "consumes": [
  911. "application/json"
  912. ],
  913. "produces": [
  914. "application/json"
  915. ],
  916. "tags": [
  917. "organization"
  918. ],
  919. "summary": "Create an organization",
  920. "operationId": "orgCreate",
  921. "parameters": [
  922. {
  923. "name": "organization",
  924. "in": "body",
  925. "required": true,
  926. "schema": {
  927. "$ref": "#/definitions/CreateOrgOption"
  928. }
  929. }
  930. ],
  931. "responses": {
  932. "201": {
  933. "$ref": "#/responses/Organization"
  934. },
  935. "403": {
  936. "$ref": "#/responses/forbidden"
  937. },
  938. "422": {
  939. "$ref": "#/responses/validationError"
  940. }
  941. }
  942. }
  943. },
  944. "/orgs/{org}": {
  945. "get": {
  946. "produces": [
  947. "application/json"
  948. ],
  949. "tags": [
  950. "organization"
  951. ],
  952. "summary": "Get an organization",
  953. "operationId": "orgGet",
  954. "parameters": [
  955. {
  956. "type": "string",
  957. "description": "name of the organization to get",
  958. "name": "org",
  959. "in": "path",
  960. "required": true
  961. }
  962. ],
  963. "responses": {
  964. "200": {
  965. "$ref": "#/responses/Organization"
  966. }
  967. }
  968. },
  969. "delete": {
  970. "produces": [
  971. "application/json"
  972. ],
  973. "tags": [
  974. "organization"
  975. ],
  976. "summary": "Delete an organization",
  977. "operationId": "orgDelete",
  978. "parameters": [
  979. {
  980. "type": "string",
  981. "description": "organization that is to be deleted",
  982. "name": "org",
  983. "in": "path",
  984. "required": true
  985. }
  986. ],
  987. "responses": {
  988. "204": {
  989. "$ref": "#/responses/empty"
  990. }
  991. }
  992. },
  993. "patch": {
  994. "consumes": [
  995. "application/json"
  996. ],
  997. "produces": [
  998. "application/json"
  999. ],
  1000. "tags": [
  1001. "organization"
  1002. ],
  1003. "summary": "Edit an organization",
  1004. "operationId": "orgEdit",
  1005. "parameters": [
  1006. {
  1007. "type": "string",
  1008. "description": "name of the organization to edit",
  1009. "name": "org",
  1010. "in": "path",
  1011. "required": true
  1012. },
  1013. {
  1014. "name": "body",
  1015. "in": "body",
  1016. "required": true,
  1017. "schema": {
  1018. "$ref": "#/definitions/EditOrgOption"
  1019. }
  1020. }
  1021. ],
  1022. "responses": {
  1023. "200": {
  1024. "$ref": "#/responses/Organization"
  1025. }
  1026. }
  1027. }
  1028. },
  1029. "/orgs/{org}/hooks": {
  1030. "get": {
  1031. "produces": [
  1032. "application/json"
  1033. ],
  1034. "tags": [
  1035. "organization"
  1036. ],
  1037. "summary": "List an organization's webhooks",
  1038. "operationId": "orgListHooks",
  1039. "parameters": [
  1040. {
  1041. "type": "string",
  1042. "description": "name of the organization",
  1043. "name": "org",
  1044. "in": "path",
  1045. "required": true
  1046. },
  1047. {
  1048. "type": "integer",
  1049. "description": "page number of results to return (1-based)",
  1050. "name": "page",
  1051. "in": "query"
  1052. },
  1053. {
  1054. "type": "integer",
  1055. "description": "page size of results",
  1056. "name": "limit",
  1057. "in": "query"
  1058. }
  1059. ],
  1060. "responses": {
  1061. "200": {
  1062. "$ref": "#/responses/HookList"
  1063. }
  1064. }
  1065. }
  1066. },
  1067. "/orgs/{org}/hooks/": {
  1068. "post": {
  1069. "consumes": [
  1070. "application/json"
  1071. ],
  1072. "produces": [
  1073. "application/json"
  1074. ],
  1075. "tags": [
  1076. "organization"
  1077. ],
  1078. "summary": "Create a hook",
  1079. "operationId": "orgCreateHook",
  1080. "parameters": [
  1081. {
  1082. "type": "string",
  1083. "description": "name of the organization",
  1084. "name": "org",
  1085. "in": "path",
  1086. "required": true
  1087. },
  1088. {
  1089. "name": "body",
  1090. "in": "body",
  1091. "required": true,
  1092. "schema": {
  1093. "$ref": "#/definitions/CreateHookOption"
  1094. }
  1095. }
  1096. ],
  1097. "responses": {
  1098. "201": {
  1099. "$ref": "#/responses/Hook"
  1100. }
  1101. }
  1102. }
  1103. },
  1104. "/orgs/{org}/hooks/{id}": {
  1105. "get": {
  1106. "produces": [
  1107. "application/json"
  1108. ],
  1109. "tags": [
  1110. "organization"
  1111. ],
  1112. "summary": "Get a hook",
  1113. "operationId": "orgGetHook",
  1114. "parameters": [
  1115. {
  1116. "type": "string",
  1117. "description": "name of the organization",
  1118. "name": "org",
  1119. "in": "path",
  1120. "required": true
  1121. },
  1122. {
  1123. "type": "integer",
  1124. "format": "int64",
  1125. "description": "id of the hook to get",
  1126. "name": "id",
  1127. "in": "path",
  1128. "required": true
  1129. }
  1130. ],
  1131. "responses": {
  1132. "200": {
  1133. "$ref": "#/responses/Hook"
  1134. }
  1135. }
  1136. },
  1137. "delete": {
  1138. "produces": [
  1139. "application/json"
  1140. ],
  1141. "tags": [
  1142. "organization"
  1143. ],
  1144. "summary": "Delete a hook",
  1145. "operationId": "orgDeleteHook",
  1146. "parameters": [
  1147. {
  1148. "type": "string",
  1149. "description": "name of the organization",
  1150. "name": "org",
  1151. "in": "path",
  1152. "required": true
  1153. },
  1154. {
  1155. "type": "integer",
  1156. "format": "int64",
  1157. "description": "id of the hook to delete",
  1158. "name": "id",
  1159. "in": "path",
  1160. "required": true
  1161. }
  1162. ],
  1163. "responses": {
  1164. "204": {
  1165. "$ref": "#/responses/empty"
  1166. }
  1167. }
  1168. },
  1169. "patch": {
  1170. "consumes": [
  1171. "application/json"
  1172. ],
  1173. "produces": [
  1174. "application/json"
  1175. ],
  1176. "tags": [
  1177. "organization"
  1178. ],
  1179. "summary": "Update a hook",
  1180. "operationId": "orgEditHook",
  1181. "parameters": [
  1182. {
  1183. "type": "string",
  1184. "description": "name of the organization",
  1185. "name": "org",
  1186. "in": "path",
  1187. "required": true
  1188. },
  1189. {
  1190. "type": "integer",
  1191. "format": "int64",
  1192. "description": "id of the hook to update",
  1193. "name": "id",
  1194. "in": "path",
  1195. "required": true
  1196. },
  1197. {
  1198. "name": "body",
  1199. "in": "body",
  1200. "schema": {
  1201. "$ref": "#/definitions/EditHookOption"
  1202. }
  1203. }
  1204. ],
  1205. "responses": {
  1206. "200": {
  1207. "$ref": "#/responses/Hook"
  1208. }
  1209. }
  1210. }
  1211. },
  1212. "/orgs/{org}/labels": {
  1213. "get": {
  1214. "produces": [
  1215. "application/json"
  1216. ],
  1217. "tags": [
  1218. "organization"
  1219. ],
  1220. "summary": "List an organization's labels",
  1221. "operationId": "orgListLabels",
  1222. "parameters": [
  1223. {
  1224. "type": "string",
  1225. "description": "name of the organization",
  1226. "name": "org",
  1227. "in": "path",
  1228. "required": true
  1229. },
  1230. {
  1231. "type": "integer",
  1232. "description": "page number of results to return (1-based)",
  1233. "name": "page",
  1234. "in": "query"
  1235. },
  1236. {
  1237. "type": "integer",
  1238. "description": "page size of results",
  1239. "name": "limit",
  1240. "in": "query"
  1241. }
  1242. ],
  1243. "responses": {
  1244. "200": {
  1245. "$ref": "#/responses/LabelList"
  1246. }
  1247. }
  1248. },
  1249. "post": {
  1250. "consumes": [
  1251. "application/json"
  1252. ],
  1253. "produces": [
  1254. "application/json"
  1255. ],
  1256. "tags": [
  1257. "organization"
  1258. ],
  1259. "summary": "Create a label for an organization",
  1260. "operationId": "orgCreateLabel",
  1261. "parameters": [
  1262. {
  1263. "type": "string",
  1264. "description": "name of the organization",
  1265. "name": "org",
  1266. "in": "path",
  1267. "required": true
  1268. },
  1269. {
  1270. "name": "body",
  1271. "in": "body",
  1272. "schema": {
  1273. "$ref": "#/definitions/CreateLabelOption"
  1274. }
  1275. }
  1276. ],
  1277. "responses": {
  1278. "201": {
  1279. "$ref": "#/responses/Label"
  1280. },
  1281. "422": {
  1282. "$ref": "#/responses/validationError"
  1283. }
  1284. }
  1285. }
  1286. },
  1287. "/orgs/{org}/labels/{id}": {
  1288. "get": {
  1289. "produces": [
  1290. "application/json"
  1291. ],
  1292. "tags": [
  1293. "organization"
  1294. ],
  1295. "summary": "Get a single label",
  1296. "operationId": "orgGetLabel",
  1297. "parameters": [
  1298. {
  1299. "type": "string",
  1300. "description": "name of the organization",
  1301. "name": "org",
  1302. "in": "path",
  1303. "required": true
  1304. },
  1305. {
  1306. "type": "integer",
  1307. "format": "int64",
  1308. "description": "id of the label to get",
  1309. "name": "id",
  1310. "in": "path",
  1311. "required": true
  1312. }
  1313. ],
  1314. "responses": {
  1315. "200": {
  1316. "$ref": "#/responses/Label"
  1317. }
  1318. }
  1319. },
  1320. "delete": {
  1321. "tags": [
  1322. "organization"
  1323. ],
  1324. "summary": "Delete a label",
  1325. "operationId": "orgDeleteLabel",
  1326. "parameters": [
  1327. {
  1328. "type": "string",
  1329. "description": "name of the organization",
  1330. "name": "org",
  1331. "in": "path",
  1332. "required": true
  1333. },
  1334. {
  1335. "type": "integer",
  1336. "format": "int64",
  1337. "description": "id of the label to delete",
  1338. "name": "id",
  1339. "in": "path",
  1340. "required": true
  1341. }
  1342. ],
  1343. "responses": {
  1344. "204": {
  1345. "$ref": "#/responses/empty"
  1346. }
  1347. }
  1348. },
  1349. "patch": {
  1350. "consumes": [
  1351. "application/json"
  1352. ],
  1353. "produces": [
  1354. "application/json"
  1355. ],
  1356. "tags": [
  1357. "organization"
  1358. ],
  1359. "summary": "Update a label",
  1360. "operationId": "orgEditLabel",
  1361. "parameters": [
  1362. {
  1363. "type": "string",
  1364. "description": "name of the organization",
  1365. "name": "org",
  1366. "in": "path",
  1367. "required": true
  1368. },
  1369. {
  1370. "type": "integer",
  1371. "format": "int64",
  1372. "description": "id of the label to edit",
  1373. "name": "id",
  1374. "in": "path",
  1375. "required": true
  1376. },
  1377. {
  1378. "name": "body",
  1379. "in": "body",
  1380. "schema": {
  1381. "$ref": "#/definitions/EditLabelOption"
  1382. }
  1383. }
  1384. ],
  1385. "responses": {
  1386. "200": {
  1387. "$ref": "#/responses/Label"
  1388. },
  1389. "422": {
  1390. "$ref": "#/responses/validationError"
  1391. }
  1392. }
  1393. }
  1394. },
  1395. "/orgs/{org}/members": {
  1396. "get": {
  1397. "produces": [
  1398. "application/json"
  1399. ],
  1400. "tags": [
  1401. "organization"
  1402. ],
  1403. "summary": "List an organization's members",
  1404. "operationId": "orgListMembers",
  1405. "parameters": [
  1406. {
  1407. "type": "string",
  1408. "description": "name of the organization",
  1409. "name": "org",
  1410. "in": "path",
  1411. "required": true
  1412. },
  1413. {
  1414. "type": "integer",
  1415. "description": "page number of results to return (1-based)",
  1416. "name": "page",
  1417. "in": "query"
  1418. },
  1419. {
  1420. "type": "integer",
  1421. "description": "page size of results",
  1422. "name": "limit",
  1423. "in": "query"
  1424. }
  1425. ],
  1426. "responses": {
  1427. "200": {
  1428. "$ref": "#/responses/UserList"
  1429. }
  1430. }
  1431. }
  1432. },
  1433. "/orgs/{org}/members/{username}": {
  1434. "get": {
  1435. "tags": [
  1436. "organization"
  1437. ],
  1438. "summary": "Check if a user is a member of an organization",
  1439. "operationId": "orgIsMember",
  1440. "parameters": [
  1441. {
  1442. "type": "string",
  1443. "description": "name of the organization",
  1444. "name": "org",
  1445. "in": "path",
  1446. "required": true
  1447. },
  1448. {
  1449. "type": "string",
  1450. "description": "username of the user",
  1451. "name": "username",
  1452. "in": "path",
  1453. "required": true
  1454. }
  1455. ],
  1456. "responses": {
  1457. "204": {
  1458. "description": "user is a member"
  1459. },
  1460. "302": {
  1461. "description": "redirection to /orgs/{org}/public_members/{username}"
  1462. },
  1463. "404": {
  1464. "description": "user is not a member"
  1465. }
  1466. }
  1467. },
  1468. "delete": {
  1469. "produces": [
  1470. "application/json"
  1471. ],
  1472. "tags": [
  1473. "organization"
  1474. ],
  1475. "summary": "Remove a member from an organization",
  1476. "operationId": "orgDeleteMember",
  1477. "parameters": [
  1478. {
  1479. "type": "string",
  1480. "description": "name of the organization",
  1481. "name": "org",
  1482. "in": "path",
  1483. "required": true
  1484. },
  1485. {
  1486. "type": "string",
  1487. "description": "username of the user",
  1488. "name": "username",
  1489. "in": "path",
  1490. "required": true
  1491. }
  1492. ],
  1493. "responses": {
  1494. "204": {
  1495. "description": "member removed"
  1496. }
  1497. }
  1498. }
  1499. },
  1500. "/orgs/{org}/public_members": {
  1501. "get": {
  1502. "produces": [
  1503. "application/json"
  1504. ],
  1505. "tags": [
  1506. "organization"
  1507. ],
  1508. "summary": "List an organization's public members",
  1509. "operationId": "orgListPublicMembers",
  1510. "parameters": [
  1511. {
  1512. "type": "string",
  1513. "description": "name of the organization",
  1514. "name": "org",
  1515. "in": "path",
  1516. "required": true
  1517. },
  1518. {
  1519. "type": "integer",
  1520. "description": "page number of results to return (1-based)",
  1521. "name": "page",
  1522. "in": "query"
  1523. },
  1524. {
  1525. "type": "integer",
  1526. "description": "page size of results",
  1527. "name": "limit",
  1528. "in": "query"
  1529. }
  1530. ],
  1531. "responses": {
  1532. "200": {
  1533. "$ref": "#/responses/UserList"
  1534. }
  1535. }
  1536. }
  1537. },
  1538. "/orgs/{org}/public_members/{username}": {
  1539. "get": {
  1540. "tags": [
  1541. "organization"
  1542. ],
  1543. "summary": "Check if a user is a public member of an organization",
  1544. "operationId": "orgIsPublicMember",
  1545. "parameters": [
  1546. {
  1547. "type": "string",
  1548. "description": "name of the organization",
  1549. "name": "org",
  1550. "in": "path",
  1551. "required": true
  1552. },
  1553. {
  1554. "type": "string",
  1555. "description": "username of the user",
  1556. "name": "username",
  1557. "in": "path",
  1558. "required": true
  1559. }
  1560. ],
  1561. "responses": {
  1562. "204": {
  1563. "description": "user is a public member"
  1564. },
  1565. "404": {
  1566. "description": "user is not a public member"
  1567. }
  1568. }
  1569. },
  1570. "put": {
  1571. "produces": [
  1572. "application/json"
  1573. ],
  1574. "tags": [
  1575. "organization"
  1576. ],
  1577. "summary": "Publicize a user's membership",
  1578. "operationId": "orgPublicizeMember",
  1579. "parameters": [
  1580. {
  1581. "type": "string",
  1582. "description": "name of the organization",
  1583. "name": "org",
  1584. "in": "path",
  1585. "required": true
  1586. },
  1587. {
  1588. "type": "string",
  1589. "description": "username of the user",
  1590. "name": "username",
  1591. "in": "path",
  1592. "required": true
  1593. }
  1594. ],
  1595. "responses": {
  1596. "204": {
  1597. "description": "membership publicized"
  1598. },
  1599. "403": {
  1600. "$ref": "#/responses/forbidden"
  1601. }
  1602. }
  1603. },
  1604. "delete": {
  1605. "produces": [
  1606. "application/json"
  1607. ],
  1608. "tags": [
  1609. "organization"
  1610. ],
  1611. "summary": "Conceal a user's membership",
  1612. "operationId": "orgConcealMember",
  1613. "parameters": [
  1614. {
  1615. "type": "string",
  1616. "description": "name of the organization",
  1617. "name": "org",
  1618. "in": "path",
  1619. "required": true
  1620. },
  1621. {
  1622. "type": "string",
  1623. "description": "username of the user",
  1624. "name": "username",
  1625. "in": "path",
  1626. "required": true
  1627. }
  1628. ],
  1629. "responses": {
  1630. "204": {
  1631. "$ref": "#/responses/empty"
  1632. },
  1633. "403": {
  1634. "$ref": "#/responses/forbidden"
  1635. }
  1636. }
  1637. }
  1638. },
  1639. "/orgs/{org}/repos": {
  1640. "get": {
  1641. "produces": [
  1642. "application/json"
  1643. ],
  1644. "tags": [
  1645. "organization"
  1646. ],
  1647. "summary": "List an organization's repos",
  1648. "operationId": "orgListRepos",
  1649. "parameters": [
  1650. {
  1651. "type": "string",
  1652. "description": "name of the organization",
  1653. "name": "org",
  1654. "in": "path",
  1655. "required": true
  1656. },
  1657. {
  1658. "type": "integer",
  1659. "description": "page number of results to return (1-based)",
  1660. "name": "page",
  1661. "in": "query"
  1662. },
  1663. {
  1664. "type": "integer",
  1665. "description": "page size of results",
  1666. "name": "limit",
  1667. "in": "query"
  1668. }
  1669. ],
  1670. "responses": {
  1671. "200": {
  1672. "$ref": "#/responses/RepositoryList"
  1673. }
  1674. }
  1675. },
  1676. "post": {
  1677. "consumes": [
  1678. "application/json"
  1679. ],
  1680. "produces": [
  1681. "application/json"
  1682. ],
  1683. "tags": [
  1684. "organization"
  1685. ],
  1686. "summary": "Create a repository in an organization",
  1687. "operationId": "createOrgRepo",
  1688. "parameters": [
  1689. {
  1690. "type": "string",
  1691. "description": "name of organization",
  1692. "name": "org",
  1693. "in": "path",
  1694. "required": true
  1695. },
  1696. {
  1697. "name": "body",
  1698. "in": "body",
  1699. "schema": {
  1700. "$ref": "#/definitions/CreateRepoOption"
  1701. }
  1702. }
  1703. ],
  1704. "responses": {
  1705. "201": {
  1706. "$ref": "#/responses/Repository"
  1707. },
  1708. "403": {
  1709. "$ref": "#/responses/forbidden"
  1710. },
  1711. "404": {
  1712. "$ref": "#/responses/notFound"
  1713. }
  1714. }
  1715. }
  1716. },
  1717. "/orgs/{org}/teams": {
  1718. "get": {
  1719. "produces": [
  1720. "application/json"
  1721. ],
  1722. "tags": [
  1723. "organization"
  1724. ],
  1725. "summary": "List an organization's teams",
  1726. "operationId": "orgListTeams",
  1727. "parameters": [
  1728. {
  1729. "type": "string",
  1730. "description": "name of the organization",
  1731. "name": "org",
  1732. "in": "path",
  1733. "required": true
  1734. },
  1735. {
  1736. "type": "integer",
  1737. "description": "page number of results to return (1-based)",
  1738. "name": "page",
  1739. "in": "query"
  1740. },
  1741. {
  1742. "type": "integer",
  1743. "description": "page size of results",
  1744. "name": "limit",
  1745. "in": "query"
  1746. }
  1747. ],
  1748. "responses": {
  1749. "200": {
  1750. "$ref": "#/responses/TeamList"
  1751. }
  1752. }
  1753. },
  1754. "post": {
  1755. "consumes": [
  1756. "application/json"
  1757. ],
  1758. "produces": [
  1759. "application/json"
  1760. ],
  1761. "tags": [
  1762. "organization"
  1763. ],
  1764. "summary": "Create a team",
  1765. "operationId": "orgCreateTeam",
  1766. "parameters": [
  1767. {
  1768. "type": "string",
  1769. "description": "name of the organization",
  1770. "name": "org",
  1771. "in": "path",
  1772. "required": true
  1773. },
  1774. {
  1775. "name": "body",
  1776. "in": "body",
  1777. "schema": {
  1778. "$ref": "#/definitions/CreateTeamOption"
  1779. }
  1780. }
  1781. ],
  1782. "responses": {
  1783. "201": {
  1784. "$ref": "#/responses/Team"
  1785. },
  1786. "422": {
  1787. "$ref": "#/responses/validationError"
  1788. }
  1789. }
  1790. }
  1791. },
  1792. "/orgs/{org}/teams/search": {
  1793. "get": {
  1794. "produces": [
  1795. "application/json"
  1796. ],
  1797. "tags": [
  1798. "organization"
  1799. ],
  1800. "summary": "Search for teams within an organization",
  1801. "operationId": "teamSearch",
  1802. "parameters": [
  1803. {
  1804. "type": "string",
  1805. "description": "name of the organization",
  1806. "name": "org",
  1807. "in": "path",
  1808. "required": true
  1809. },
  1810. {
  1811. "type": "string",
  1812. "description": "keywords to search",
  1813. "name": "q",
  1814. "in": "query"
  1815. },
  1816. {
  1817. "type": "boolean",
  1818. "description": "include search within team description (defaults to true)",
  1819. "name": "include_desc",
  1820. "in": "query"
  1821. },
  1822. {
  1823. "type": "integer",
  1824. "description": "page number of results to return (1-based)",
  1825. "name": "page",
  1826. "in": "query"
  1827. },
  1828. {
  1829. "type": "integer",
  1830. "description": "page size of results",
  1831. "name": "limit",
  1832. "in": "query"
  1833. }
  1834. ],
  1835. "responses": {
  1836. "200": {
  1837. "description": "SearchResults of a successful search",
  1838. "schema": {
  1839. "type": "object",
  1840. "properties": {
  1841. "data": {
  1842. "type": "array",
  1843. "items": {
  1844. "$ref": "#/definitions/Team"
  1845. }
  1846. },
  1847. "ok": {
  1848. "type": "boolean"
  1849. }
  1850. }
  1851. }
  1852. }
  1853. }
  1854. }
  1855. },
  1856. "/repos/issues/search": {
  1857. "get": {
  1858. "produces": [
  1859. "application/json"
  1860. ],
  1861. "tags": [
  1862. "issue"
  1863. ],
  1864. "summary": "Search for issues across the repositories that the user has access to",
  1865. "operationId": "issueSearchIssues",
  1866. "parameters": [
  1867. {
  1868. "type": "string",
  1869. "description": "whether issue is open or closed",
  1870. "name": "state",
  1871. "in": "query"
  1872. },
  1873. {
  1874. "type": "string",
  1875. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1876. "name": "labels",
  1877. "in": "query"
  1878. },
  1879. {
  1880. "type": "string",
  1881. "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
  1882. "name": "milestones",
  1883. "in": "query"
  1884. },
  1885. {
  1886. "type": "string",
  1887. "description": "search string",
  1888. "name": "q",
  1889. "in": "query"
  1890. },
  1891. {
  1892. "type": "integer",
  1893. "format": "int64",
  1894. "description": "repository to prioritize in the results",
  1895. "name": "priority_repo_id",
  1896. "in": "query"
  1897. },
  1898. {
  1899. "type": "string",
  1900. "description": "filter by type (issues / pulls) if set",
  1901. "name": "type",
  1902. "in": "query"
  1903. },
  1904. {
  1905. "type": "string",
  1906. "format": "date-time",
  1907. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  1908. "name": "since",
  1909. "in": "query"
  1910. },
  1911. {
  1912. "type": "string",
  1913. "format": "date-time",
  1914. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  1915. "name": "before",
  1916. "in": "query"
  1917. },
  1918. {
  1919. "type": "boolean",
  1920. "description": "filter (issues / pulls) assigned to you, default is false",
  1921. "name": "assigned",
  1922. "in": "query"
  1923. },
  1924. {
  1925. "type": "boolean",
  1926. "description": "filter (issues / pulls) created by you, default is false",
  1927. "name": "created",
  1928. "in": "query"
  1929. },
  1930. {
  1931. "type": "boolean",
  1932. "description": "filter (issues / pulls) mentioning you, default is false",
  1933. "name": "mentioned",
  1934. "in": "query"
  1935. },
  1936. {
  1937. "type": "boolean",
  1938. "description": "filter pulls requesting your review, default is false",
  1939. "name": "review_requested",
  1940. "in": "query"
  1941. },
  1942. {
  1943. "type": "string",
  1944. "description": "filter by owner",
  1945. "name": "owner",
  1946. "in": "query"
  1947. },
  1948. {
  1949. "type": "string",
  1950. "description": "filter by team (requires organization owner parameter to be provided)",
  1951. "name": "team",
  1952. "in": "query"
  1953. },
  1954. {
  1955. "type": "integer",
  1956. "description": "page number of results to return (1-based)",
  1957. "name": "page",
  1958. "in": "query"
  1959. },
  1960. {
  1961. "type": "integer",
  1962. "description": "page size of results",
  1963. "name": "limit",
  1964. "in": "query"
  1965. }
  1966. ],
  1967. "responses": {
  1968. "200": {
  1969. "$ref": "#/responses/IssueList"
  1970. }
  1971. }
  1972. }
  1973. },
  1974. "/repos/migrate": {
  1975. "post": {
  1976. "consumes": [
  1977. "application/json"
  1978. ],
  1979. "produces": [
  1980. "application/json"
  1981. ],
  1982. "tags": [
  1983. "repository"
  1984. ],
  1985. "summary": "Migrate a remote git repository",
  1986. "operationId": "repoMigrate",
  1987. "parameters": [
  1988. {
  1989. "name": "body",
  1990. "in": "body",
  1991. "schema": {
  1992. "$ref": "#/definitions/MigrateRepoOptions"
  1993. }
  1994. }
  1995. ],
  1996. "responses": {
  1997. "201": {
  1998. "$ref": "#/responses/Repository"
  1999. },
  2000. "403": {
  2001. "$ref": "#/responses/forbidden"
  2002. },
  2003. "422": {
  2004. "$ref": "#/responses/validationError"
  2005. }
  2006. }
  2007. }
  2008. },
  2009. "/repos/search": {
  2010. "get": {
  2011. "produces": [
  2012. "application/json"
  2013. ],
  2014. "tags": [
  2015. "repository"
  2016. ],
  2017. "summary": "Search for repositories",
  2018. "operationId": "repoSearch",
  2019. "parameters": [
  2020. {
  2021. "type": "string",
  2022. "description": "keyword",
  2023. "name": "q",
  2024. "in": "query"
  2025. },
  2026. {
  2027. "type": "boolean",
  2028. "description": "Limit search to repositories with keyword as topic",
  2029. "name": "topic",
  2030. "in": "query"
  2031. },
  2032. {
  2033. "type": "boolean",
  2034. "description": "include search of keyword within repository description",
  2035. "name": "includeDesc",
  2036. "in": "query"
  2037. },
  2038. {
  2039. "type": "integer",
  2040. "format": "int64",
  2041. "description": "search only for repos that the user with the given id owns or contributes to",
  2042. "name": "uid",
  2043. "in": "query"
  2044. },
  2045. {
  2046. "type": "integer",
  2047. "format": "int64",
  2048. "description": "repo owner to prioritize in the results",
  2049. "name": "priority_owner_id",
  2050. "in": "query"
  2051. },
  2052. {
  2053. "type": "integer",
  2054. "format": "int64",
  2055. "description": "search only for repos that belong to the given team id",
  2056. "name": "team_id",
  2057. "in": "query"
  2058. },
  2059. {
  2060. "type": "integer",
  2061. "format": "int64",
  2062. "description": "search only for repos that the user with the given id has starred",
  2063. "name": "starredBy",
  2064. "in": "query"
  2065. },
  2066. {
  2067. "type": "boolean",
  2068. "description": "include private repositories this user has access to (defaults to true)",
  2069. "name": "private",
  2070. "in": "query"
  2071. },
  2072. {
  2073. "type": "boolean",
  2074. "description": "show only pubic, private or all repositories (defaults to all)",
  2075. "name": "is_private",
  2076. "in": "query"
  2077. },
  2078. {
  2079. "type": "boolean",
  2080. "description": "include template repositories this user has access to (defaults to true)",
  2081. "name": "template",
  2082. "in": "query"
  2083. },
  2084. {
  2085. "type": "boolean",
  2086. "description": "show only archived, non-archived or all repositories (defaults to all)",
  2087. "name": "archived",
  2088. "in": "query"
  2089. },
  2090. {
  2091. "type": "string",
  2092. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  2093. "name": "mode",
  2094. "in": "query"
  2095. },
  2096. {
  2097. "type": "boolean",
  2098. "description": "if `uid` is given, search only for repos that the user owns",
  2099. "name": "exclusive",
  2100. "in": "query"
  2101. },
  2102. {
  2103. "type": "string",
  2104. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  2105. "name": "sort",
  2106. "in": "query"
  2107. },
  2108. {
  2109. "type": "string",
  2110. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  2111. "name": "order",
  2112. "in": "query"
  2113. },
  2114. {
  2115. "type": "integer",
  2116. "description": "page number of results to return (1-based)",
  2117. "name": "page",
  2118. "in": "query"
  2119. },
  2120. {
  2121. "type": "integer",
  2122. "description": "page size of results",
  2123. "name": "limit",
  2124. "in": "query"
  2125. }
  2126. ],
  2127. "responses": {
  2128. "200": {
  2129. "$ref": "#/responses/SearchResults"
  2130. },
  2131. "422": {
  2132. "$ref": "#/responses/validationError"
  2133. }
  2134. }
  2135. }
  2136. },
  2137. "/repos/{owner}/{repo}": {
  2138. "get": {
  2139. "produces": [
  2140. "application/json"
  2141. ],
  2142. "tags": [
  2143. "repository"
  2144. ],
  2145. "summary": "Get a repository",
  2146. "operationId": "repoGet",
  2147. "parameters": [
  2148. {
  2149. "type": "string",
  2150. "description": "owner of the repo",
  2151. "name": "owner",
  2152. "in": "path",
  2153. "required": true
  2154. },
  2155. {
  2156. "type": "string",
  2157. "description": "name of the repo",
  2158. "name": "repo",
  2159. "in": "path",
  2160. "required": true
  2161. }
  2162. ],
  2163. "responses": {
  2164. "200": {
  2165. "$ref": "#/responses/Repository"
  2166. }
  2167. }
  2168. },
  2169. "delete": {
  2170. "produces": [
  2171. "application/json"
  2172. ],
  2173. "tags": [
  2174. "repository"
  2175. ],
  2176. "summary": "Delete a repository",
  2177. "operationId": "repoDelete",
  2178. "parameters": [
  2179. {
  2180. "type": "string",
  2181. "description": "owner of the repo to delete",
  2182. "name": "owner",
  2183. "in": "path",
  2184. "required": true
  2185. },
  2186. {
  2187. "type": "string",
  2188. "description": "name of the repo to delete",
  2189. "name": "repo",
  2190. "in": "path",
  2191. "required": true
  2192. }
  2193. ],
  2194. "responses": {
  2195. "204": {
  2196. "$ref": "#/responses/empty"
  2197. },
  2198. "403": {
  2199. "$ref": "#/responses/forbidden"
  2200. }
  2201. }
  2202. },
  2203. "patch": {
  2204. "produces": [
  2205. "application/json"
  2206. ],
  2207. "tags": [
  2208. "repository"
  2209. ],
  2210. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  2211. "operationId": "repoEdit",
  2212. "parameters": [
  2213. {
  2214. "type": "string",
  2215. "description": "owner of the repo to edit",
  2216. "name": "owner",
  2217. "in": "path",
  2218. "required": true
  2219. },
  2220. {
  2221. "type": "string",
  2222. "description": "name of the repo to edit",
  2223. "name": "repo",
  2224. "in": "path",
  2225. "required": true
  2226. },
  2227. {
  2228. "description": "Properties of a repo that you can edit",
  2229. "name": "body",
  2230. "in": "body",
  2231. "schema": {
  2232. "$ref": "#/definitions/EditRepoOption"
  2233. }
  2234. }
  2235. ],
  2236. "responses": {
  2237. "200": {
  2238. "$ref": "#/responses/Repository"
  2239. },
  2240. "403": {
  2241. "$ref": "#/responses/forbidden"
  2242. },
  2243. "422": {
  2244. "$ref": "#/responses/validationError"
  2245. }
  2246. }
  2247. }
  2248. },
  2249. "/repos/{owner}/{repo}/archive/{archive}": {
  2250. "get": {
  2251. "produces": [
  2252. "application/json"
  2253. ],
  2254. "tags": [
  2255. "repository"
  2256. ],
  2257. "summary": "Get an archive of a repository",
  2258. "operationId": "repoGetArchive",
  2259. "parameters": [
  2260. {
  2261. "type": "string",
  2262. "description": "owner of the repo",
  2263. "name": "owner",
  2264. "in": "path",
  2265. "required": true
  2266. },
  2267. {
  2268. "type": "string",
  2269. "description": "name of the repo",
  2270. "name": "repo",
  2271. "in": "path",
  2272. "required": true
  2273. },
  2274. {
  2275. "type": "string",
  2276. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  2277. "name": "archive",
  2278. "in": "path",
  2279. "required": true
  2280. }
  2281. ],
  2282. "responses": {
  2283. "200": {
  2284. "description": "success"
  2285. },
  2286. "404": {
  2287. "$ref": "#/responses/notFound"
  2288. }
  2289. }
  2290. }
  2291. },
  2292. "/repos/{owner}/{repo}/assignees": {
  2293. "get": {
  2294. "produces": [
  2295. "application/json"
  2296. ],
  2297. "tags": [
  2298. "repository"
  2299. ],
  2300. "summary": "Return all users that have write access and can be assigned to issues",
  2301. "operationId": "repoGetAssignees",
  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. "responses": {
  2319. "200": {
  2320. "$ref": "#/responses/UserList"
  2321. }
  2322. }
  2323. }
  2324. },
  2325. "/repos/{owner}/{repo}/branch_protections": {
  2326. "get": {
  2327. "produces": [
  2328. "application/json"
  2329. ],
  2330. "tags": [
  2331. "repository"
  2332. ],
  2333. "summary": "List branch protections for a repository",
  2334. "operationId": "repoListBranchProtection",
  2335. "parameters": [
  2336. {
  2337. "type": "string",
  2338. "description": "owner of the repo",
  2339. "name": "owner",
  2340. "in": "path",
  2341. "required": true
  2342. },
  2343. {
  2344. "type": "string",
  2345. "description": "name of the repo",
  2346. "name": "repo",
  2347. "in": "path",
  2348. "required": true
  2349. }
  2350. ],
  2351. "responses": {
  2352. "200": {
  2353. "$ref": "#/responses/BranchProtectionList"
  2354. }
  2355. }
  2356. },
  2357. "post": {
  2358. "consumes": [
  2359. "application/json"
  2360. ],
  2361. "produces": [
  2362. "application/json"
  2363. ],
  2364. "tags": [
  2365. "repository"
  2366. ],
  2367. "summary": "Create a branch protections for a repository",
  2368. "operationId": "repoCreateBranchProtection",
  2369. "parameters": [
  2370. {
  2371. "type": "string",
  2372. "description": "owner of the repo",
  2373. "name": "owner",
  2374. "in": "path",
  2375. "required": true
  2376. },
  2377. {
  2378. "type": "string",
  2379. "description": "name of the repo",
  2380. "name": "repo",
  2381. "in": "path",
  2382. "required": true
  2383. },
  2384. {
  2385. "name": "body",
  2386. "in": "body",
  2387. "schema": {
  2388. "$ref": "#/definitions/CreateBranchProtectionOption"
  2389. }
  2390. }
  2391. ],
  2392. "responses": {
  2393. "201": {
  2394. "$ref": "#/responses/BranchProtection"
  2395. },
  2396. "403": {
  2397. "$ref": "#/responses/forbidden"
  2398. },
  2399. "404": {
  2400. "$ref": "#/responses/notFound"
  2401. },
  2402. "422": {
  2403. "$ref": "#/responses/validationError"
  2404. }
  2405. }
  2406. }
  2407. },
  2408. "/repos/{owner}/{repo}/branch_protections/{name}": {
  2409. "get": {
  2410. "produces": [
  2411. "application/json"
  2412. ],
  2413. "tags": [
  2414. "repository"
  2415. ],
  2416. "summary": "Get a specific branch protection for the repository",
  2417. "operationId": "repoGetBranchProtection",
  2418. "parameters": [
  2419. {
  2420. "type": "string",
  2421. "description": "owner of the repo",
  2422. "name": "owner",
  2423. "in": "path",
  2424. "required": true
  2425. },
  2426. {
  2427. "type": "string",
  2428. "description": "name of the repo",
  2429. "name": "repo",
  2430. "in": "path",
  2431. "required": true
  2432. },
  2433. {
  2434. "type": "string",
  2435. "description": "name of protected branch",
  2436. "name": "name",
  2437. "in": "path",
  2438. "required": true
  2439. }
  2440. ],
  2441. "responses": {
  2442. "200": {
  2443. "$ref": "#/responses/BranchProtection"
  2444. },
  2445. "404": {
  2446. "$ref": "#/responses/notFound"
  2447. }
  2448. }
  2449. },
  2450. "delete": {
  2451. "produces": [
  2452. "application/json"
  2453. ],
  2454. "tags": [
  2455. "repository"
  2456. ],
  2457. "summary": "Delete a specific branch protection for the repository",
  2458. "operationId": "repoDeleteBranchProtection",
  2459. "parameters": [
  2460. {
  2461. "type": "string",
  2462. "description": "owner of the repo",
  2463. "name": "owner",
  2464. "in": "path",
  2465. "required": true
  2466. },
  2467. {
  2468. "type": "string",
  2469. "description": "name of the repo",
  2470. "name": "repo",
  2471. "in": "path",
  2472. "required": true
  2473. },
  2474. {
  2475. "type": "string",
  2476. "description": "name of protected branch",
  2477. "name": "name",
  2478. "in": "path",
  2479. "required": true
  2480. }
  2481. ],
  2482. "responses": {
  2483. "204": {
  2484. "$ref": "#/responses/empty"
  2485. },
  2486. "404": {
  2487. "$ref": "#/responses/notFound"
  2488. }
  2489. }
  2490. },
  2491. "patch": {
  2492. "consumes": [
  2493. "application/json"
  2494. ],
  2495. "produces": [
  2496. "application/json"
  2497. ],
  2498. "tags": [
  2499. "repository"
  2500. ],
  2501. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  2502. "operationId": "repoEditBranchProtection",
  2503. "parameters": [
  2504. {
  2505. "type": "string",
  2506. "description": "owner of the repo",
  2507. "name": "owner",
  2508. "in": "path",
  2509. "required": true
  2510. },
  2511. {
  2512. "type": "string",
  2513. "description": "name of the repo",
  2514. "name": "repo",
  2515. "in": "path",
  2516. "required": true
  2517. },
  2518. {
  2519. "type": "string",
  2520. "description": "name of protected branch",
  2521. "name": "name",
  2522. "in": "path",
  2523. "required": true
  2524. },
  2525. {
  2526. "name": "body",
  2527. "in": "body",
  2528. "schema": {
  2529. "$ref": "#/definitions/EditBranchProtectionOption"
  2530. }
  2531. }
  2532. ],
  2533. "responses": {
  2534. "200": {
  2535. "$ref": "#/responses/BranchProtection"
  2536. },
  2537. "404": {
  2538. "$ref": "#/responses/notFound"
  2539. },
  2540. "422": {
  2541. "$ref": "#/responses/validationError"
  2542. }
  2543. }
  2544. }
  2545. },
  2546. "/repos/{owner}/{repo}/branches": {
  2547. "get": {
  2548. "produces": [
  2549. "application/json"
  2550. ],
  2551. "tags": [
  2552. "repository"
  2553. ],
  2554. "summary": "List a repository's branches",
  2555. "operationId": "repoListBranches",
  2556. "parameters": [
  2557. {
  2558. "type": "string",
  2559. "description": "owner of the repo",
  2560. "name": "owner",
  2561. "in": "path",
  2562. "required": true
  2563. },
  2564. {
  2565. "type": "string",
  2566. "description": "name of the repo",
  2567. "name": "repo",
  2568. "in": "path",
  2569. "required": true
  2570. },
  2571. {
  2572. "type": "integer",
  2573. "description": "page number of results to return (1-based)",
  2574. "name": "page",
  2575. "in": "query"
  2576. },
  2577. {
  2578. "type": "integer",
  2579. "description": "page size of results",
  2580. "name": "limit",
  2581. "in": "query"
  2582. }
  2583. ],
  2584. "responses": {
  2585. "200": {
  2586. "$ref": "#/responses/BranchList"
  2587. }
  2588. }
  2589. },
  2590. "post": {
  2591. "consumes": [
  2592. "application/json"
  2593. ],
  2594. "produces": [
  2595. "application/json"
  2596. ],
  2597. "tags": [
  2598. "repository"
  2599. ],
  2600. "summary": "Create a branch",
  2601. "operationId": "repoCreateBranch",
  2602. "parameters": [
  2603. {
  2604. "type": "string",
  2605. "description": "owner of the repo",
  2606. "name": "owner",
  2607. "in": "path",
  2608. "required": true
  2609. },
  2610. {
  2611. "type": "string",
  2612. "description": "name of the repo",
  2613. "name": "repo",
  2614. "in": "path",
  2615. "required": true
  2616. },
  2617. {
  2618. "name": "body",
  2619. "in": "body",
  2620. "schema": {
  2621. "$ref": "#/definitions/CreateBranchRepoOption"
  2622. }
  2623. }
  2624. ],
  2625. "responses": {
  2626. "201": {
  2627. "$ref": "#/responses/Branch"
  2628. },
  2629. "404": {
  2630. "description": "The old branch does not exist."
  2631. },
  2632. "409": {
  2633. "description": "The branch with the same name already exists."
  2634. }
  2635. }
  2636. }
  2637. },
  2638. "/repos/{owner}/{repo}/branches/{branch}": {
  2639. "get": {
  2640. "produces": [
  2641. "application/json"
  2642. ],
  2643. "tags": [
  2644. "repository"
  2645. ],
  2646. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  2647. "operationId": "repoGetBranch",
  2648. "parameters": [
  2649. {
  2650. "type": "string",
  2651. "description": "owner of the repo",
  2652. "name": "owner",
  2653. "in": "path",
  2654. "required": true
  2655. },
  2656. {
  2657. "type": "string",
  2658. "description": "name of the repo",
  2659. "name": "repo",
  2660. "in": "path",
  2661. "required": true
  2662. },
  2663. {
  2664. "type": "string",
  2665. "description": "branch to get",
  2666. "name": "branch",
  2667. "in": "path",
  2668. "required": true
  2669. }
  2670. ],
  2671. "responses": {
  2672. "200": {
  2673. "$ref": "#/responses/Branch"
  2674. },
  2675. "404": {
  2676. "$ref": "#/responses/notFound"
  2677. }
  2678. }
  2679. },
  2680. "delete": {
  2681. "produces": [
  2682. "application/json"
  2683. ],
  2684. "tags": [
  2685. "repository"
  2686. ],
  2687. "summary": "Delete a specific branch from a repository",
  2688. "operationId": "repoDeleteBranch",
  2689. "parameters": [
  2690. {
  2691. "type": "string",
  2692. "description": "owner of the repo",
  2693. "name": "owner",
  2694. "in": "path",
  2695. "required": true
  2696. },
  2697. {
  2698. "type": "string",
  2699. "description": "name of the repo",
  2700. "name": "repo",
  2701. "in": "path",
  2702. "required": true
  2703. },
  2704. {
  2705. "type": "string",
  2706. "description": "branch to delete",
  2707. "name": "branch",
  2708. "in": "path",
  2709. "required": true
  2710. }
  2711. ],
  2712. "responses": {
  2713. "204": {
  2714. "$ref": "#/responses/empty"
  2715. },
  2716. "403": {
  2717. "$ref": "#/responses/error"
  2718. },
  2719. "404": {
  2720. "$ref": "#/responses/notFound"
  2721. }
  2722. }
  2723. }
  2724. },
  2725. "/repos/{owner}/{repo}/collaborators": {
  2726. "get": {
  2727. "produces": [
  2728. "application/json"
  2729. ],
  2730. "tags": [
  2731. "repository"
  2732. ],
  2733. "summary": "List a repository's collaborators",
  2734. "operationId": "repoListCollaborators",
  2735. "parameters": [
  2736. {
  2737. "type": "string",
  2738. "description": "owner of the repo",
  2739. "name": "owner",
  2740. "in": "path",
  2741. "required": true
  2742. },
  2743. {
  2744. "type": "string",
  2745. "description": "name of the repo",
  2746. "name": "repo",
  2747. "in": "path",
  2748. "required": true
  2749. },
  2750. {
  2751. "type": "integer",
  2752. "description": "page number of results to return (1-based)",
  2753. "name": "page",
  2754. "in": "query"
  2755. },
  2756. {
  2757. "type": "integer",
  2758. "description": "page size of results",
  2759. "name": "limit",
  2760. "in": "query"
  2761. }
  2762. ],
  2763. "responses": {
  2764. "200": {
  2765. "$ref": "#/responses/UserList"
  2766. }
  2767. }
  2768. }
  2769. },
  2770. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  2771. "get": {
  2772. "produces": [
  2773. "application/json"
  2774. ],
  2775. "tags": [
  2776. "repository"
  2777. ],
  2778. "summary": "Check if a user is a collaborator of a repository",
  2779. "operationId": "repoCheckCollaborator",
  2780. "parameters": [
  2781. {
  2782. "type": "string",
  2783. "description": "owner of the repo",
  2784. "name": "owner",
  2785. "in": "path",
  2786. "required": true
  2787. },
  2788. {
  2789. "type": "string",
  2790. "description": "name of the repo",
  2791. "name": "repo",
  2792. "in": "path",
  2793. "required": true
  2794. },
  2795. {
  2796. "type": "string",
  2797. "description": "username of the collaborator",
  2798. "name": "collaborator",
  2799. "in": "path",
  2800. "required": true
  2801. }
  2802. ],
  2803. "responses": {
  2804. "204": {
  2805. "$ref": "#/responses/empty"
  2806. },
  2807. "404": {
  2808. "$ref": "#/responses/notFound"
  2809. },
  2810. "422": {
  2811. "$ref": "#/responses/validationError"
  2812. }
  2813. }
  2814. },
  2815. "put": {
  2816. "produces": [
  2817. "application/json"
  2818. ],
  2819. "tags": [
  2820. "repository"
  2821. ],
  2822. "summary": "Add a collaborator to a repository",
  2823. "operationId": "repoAddCollaborator",
  2824. "parameters": [
  2825. {
  2826. "type": "string",
  2827. "description": "owner of the repo",
  2828. "name": "owner",
  2829. "in": "path",
  2830. "required": true
  2831. },
  2832. {
  2833. "type": "string",
  2834. "description": "name of the repo",
  2835. "name": "repo",
  2836. "in": "path",
  2837. "required": true
  2838. },
  2839. {
  2840. "type": "string",
  2841. "description": "username of the collaborator to add",
  2842. "name": "collaborator",
  2843. "in": "path",
  2844. "required": true
  2845. },
  2846. {
  2847. "name": "body",
  2848. "in": "body",
  2849. "schema": {
  2850. "$ref": "#/definitions/AddCollaboratorOption"
  2851. }
  2852. }
  2853. ],
  2854. "responses": {
  2855. "204": {
  2856. "$ref": "#/responses/empty"
  2857. },
  2858. "422": {
  2859. "$ref": "#/responses/validationError"
  2860. }
  2861. }
  2862. },
  2863. "delete": {
  2864. "produces": [
  2865. "application/json"
  2866. ],
  2867. "tags": [
  2868. "repository"
  2869. ],
  2870. "summary": "Delete a collaborator from a repository",
  2871. "operationId": "repoDeleteCollaborator",
  2872. "parameters": [
  2873. {
  2874. "type": "string",
  2875. "description": "owner of the repo",
  2876. "name": "owner",
  2877. "in": "path",
  2878. "required": true
  2879. },
  2880. {
  2881. "type": "string",
  2882. "description": "name of the repo",
  2883. "name": "repo",
  2884. "in": "path",
  2885. "required": true
  2886. },
  2887. {
  2888. "type": "string",
  2889. "description": "username of the collaborator to delete",
  2890. "name": "collaborator",
  2891. "in": "path",
  2892. "required": true
  2893. }
  2894. ],
  2895. "responses": {
  2896. "204": {
  2897. "$ref": "#/responses/empty"
  2898. },
  2899. "422": {
  2900. "$ref": "#/responses/validationError"
  2901. }
  2902. }
  2903. }
  2904. },
  2905. "/repos/{owner}/{repo}/commits": {
  2906. "get": {
  2907. "produces": [
  2908. "application/json"
  2909. ],
  2910. "tags": [
  2911. "repository"
  2912. ],
  2913. "summary": "Get a list of all commits from a repository",
  2914. "operationId": "repoGetAllCommits",
  2915. "parameters": [
  2916. {
  2917. "type": "string",
  2918. "description": "owner of the repo",
  2919. "name": "owner",
  2920. "in": "path",
  2921. "required": true
  2922. },
  2923. {
  2924. "type": "string",
  2925. "description": "name of the repo",
  2926. "name": "repo",
  2927. "in": "path",
  2928. "required": true
  2929. },
  2930. {
  2931. "type": "string",
  2932. "description": "SHA or branch to start listing commits from (usually 'master')",
  2933. "name": "sha",
  2934. "in": "query"
  2935. },
  2936. {
  2937. "type": "integer",
  2938. "description": "page number of results to return (1-based)",
  2939. "name": "page",
  2940. "in": "query"
  2941. },
  2942. {
  2943. "type": "integer",
  2944. "description": "page size of results",
  2945. "name": "limit",
  2946. "in": "query"
  2947. }
  2948. ],
  2949. "responses": {
  2950. "200": {
  2951. "$ref": "#/responses/CommitList"
  2952. },
  2953. "404": {
  2954. "$ref": "#/responses/notFound"
  2955. },
  2956. "409": {
  2957. "$ref": "#/responses/EmptyRepository"
  2958. }
  2959. }
  2960. }
  2961. },
  2962. "/repos/{owner}/{repo}/commits/{ref}/status": {
  2963. "get": {
  2964. "produces": [
  2965. "application/json"
  2966. ],
  2967. "tags": [
  2968. "repository"
  2969. ],
  2970. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2971. "operationId": "repoGetCombinedStatusByRef",
  2972. "parameters": [
  2973. {
  2974. "type": "string",
  2975. "description": "owner of the repo",
  2976. "name": "owner",
  2977. "in": "path",
  2978. "required": true
  2979. },
  2980. {
  2981. "type": "string",
  2982. "description": "name of the repo",
  2983. "name": "repo",
  2984. "in": "path",
  2985. "required": true
  2986. },
  2987. {
  2988. "type": "string",
  2989. "description": "name of branch/tag/commit",
  2990. "name": "ref",
  2991. "in": "path",
  2992. "required": true
  2993. },
  2994. {
  2995. "type": "integer",
  2996. "description": "page number of results to return (1-based)",
  2997. "name": "page",
  2998. "in": "query"
  2999. },
  3000. {
  3001. "type": "integer",
  3002. "description": "page size of results",
  3003. "name": "limit",
  3004. "in": "query"
  3005. }
  3006. ],
  3007. "responses": {
  3008. "200": {
  3009. "$ref": "#/responses/CombinedStatus"
  3010. },
  3011. "400": {
  3012. "$ref": "#/responses/error"
  3013. }
  3014. }
  3015. }
  3016. },
  3017. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  3018. "get": {
  3019. "produces": [
  3020. "application/json"
  3021. ],
  3022. "tags": [
  3023. "repository"
  3024. ],
  3025. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  3026. "operationId": "repoListStatusesByRef",
  3027. "parameters": [
  3028. {
  3029. "type": "string",
  3030. "description": "owner of the repo",
  3031. "name": "owner",
  3032. "in": "path",
  3033. "required": true
  3034. },
  3035. {
  3036. "type": "string",
  3037. "description": "name of the repo",
  3038. "name": "repo",
  3039. "in": "path",
  3040. "required": true
  3041. },
  3042. {
  3043. "type": "string",
  3044. "description": "name of branch/tag/commit",
  3045. "name": "ref",
  3046. "in": "path",
  3047. "required": true
  3048. },
  3049. {
  3050. "enum": [
  3051. "oldest",
  3052. "recentupdate",
  3053. "leastupdate",
  3054. "leastindex",
  3055. "highestindex"
  3056. ],
  3057. "type": "string",
  3058. "description": "type of sort",
  3059. "name": "sort",
  3060. "in": "query"
  3061. },
  3062. {
  3063. "enum": [
  3064. "pending",
  3065. "success",
  3066. "error",
  3067. "failure",
  3068. "warning"
  3069. ],
  3070. "type": "string",
  3071. "description": "type of state",
  3072. "name": "state",
  3073. "in": "query"
  3074. },
  3075. {
  3076. "type": "integer",
  3077. "description": "page number of results to return (1-based)",
  3078. "name": "page",
  3079. "in": "query"
  3080. },
  3081. {
  3082. "type": "integer",
  3083. "description": "page size of results",
  3084. "name": "limit",
  3085. "in": "query"
  3086. }
  3087. ],
  3088. "responses": {
  3089. "200": {
  3090. "$ref": "#/responses/CommitStatusList"
  3091. },
  3092. "400": {
  3093. "$ref": "#/responses/error"
  3094. }
  3095. }
  3096. }
  3097. },
  3098. "/repos/{owner}/{repo}/contents": {
  3099. "get": {
  3100. "produces": [
  3101. "application/json"
  3102. ],
  3103. "tags": [
  3104. "repository"
  3105. ],
  3106. "summary": "Gets the metadata of all the entries of the root dir",
  3107. "operationId": "repoGetContentsList",
  3108. "parameters": [
  3109. {
  3110. "type": "string",
  3111. "description": "owner of the repo",
  3112. "name": "owner",
  3113. "in": "path",
  3114. "required": true
  3115. },
  3116. {
  3117. "type": "string",
  3118. "description": "name of the repo",
  3119. "name": "repo",
  3120. "in": "path",
  3121. "required": true
  3122. },
  3123. {
  3124. "type": "string",
  3125. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  3126. "name": "ref",
  3127. "in": "query"
  3128. }
  3129. ],
  3130. "responses": {
  3131. "200": {
  3132. "$ref": "#/responses/ContentsListResponse"
  3133. },
  3134. "404": {
  3135. "$ref": "#/responses/notFound"
  3136. }
  3137. }
  3138. }
  3139. },
  3140. "/repos/{owner}/{repo}/contents/{filepath}": {
  3141. "get": {
  3142. "produces": [
  3143. "application/json"
  3144. ],
  3145. "tags": [
  3146. "repository"
  3147. ],
  3148. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  3149. "operationId": "repoGetContents",
  3150. "parameters": [
  3151. {
  3152. "type": "string",
  3153. "description": "owner of the repo",
  3154. "name": "owner",
  3155. "in": "path",
  3156. "required": true
  3157. },
  3158. {
  3159. "type": "string",
  3160. "description": "name of the repo",
  3161. "name": "repo",
  3162. "in": "path",
  3163. "required": true
  3164. },
  3165. {
  3166. "type": "string",
  3167. "description": "path of the dir, file, symlink or submodule in the repo",
  3168. "name": "filepath",
  3169. "in": "path",
  3170. "required": true
  3171. },
  3172. {
  3173. "type": "string",
  3174. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  3175. "name": "ref",
  3176. "in": "query"
  3177. }
  3178. ],
  3179. "responses": {
  3180. "200": {
  3181. "$ref": "#/responses/ContentsResponse"
  3182. },
  3183. "404": {
  3184. "$ref": "#/responses/notFound"
  3185. }
  3186. }
  3187. },
  3188. "put": {
  3189. "consumes": [
  3190. "application/json"
  3191. ],
  3192. "produces": [
  3193. "application/json"
  3194. ],
  3195. "tags": [
  3196. "repository"
  3197. ],
  3198. "summary": "Update a file in a repository",
  3199. "operationId": "repoUpdateFile",
  3200. "parameters": [
  3201. {
  3202. "type": "string",
  3203. "description": "owner of the repo",
  3204. "name": "owner",
  3205. "in": "path",
  3206. "required": true
  3207. },
  3208. {
  3209. "type": "string",
  3210. "description": "name of the repo",
  3211. "name": "repo",
  3212. "in": "path",
  3213. "required": true
  3214. },
  3215. {
  3216. "type": "string",
  3217. "description": "path of the file to update",
  3218. "name": "filepath",
  3219. "in": "path",
  3220. "required": true
  3221. },
  3222. {
  3223. "name": "body",
  3224. "in": "body",
  3225. "required": true,
  3226. "schema": {
  3227. "$ref": "#/definitions/UpdateFileOptions"
  3228. }
  3229. }
  3230. ],
  3231. "responses": {
  3232. "200": {
  3233. "$ref": "#/responses/FileResponse"
  3234. },
  3235. "403": {
  3236. "$ref": "#/responses/error"
  3237. },
  3238. "404": {
  3239. "$ref": "#/responses/notFound"
  3240. },
  3241. "422": {
  3242. "$ref": "#/responses/error"
  3243. }
  3244. }
  3245. },
  3246. "post": {
  3247. "consumes": [
  3248. "application/json"
  3249. ],
  3250. "produces": [
  3251. "application/json"
  3252. ],
  3253. "tags": [
  3254. "repository"
  3255. ],
  3256. "summary": "Create a file in a repository",
  3257. "operationId": "repoCreateFile",
  3258. "parameters": [
  3259. {
  3260. "type": "string",
  3261. "description": "owner of the repo",
  3262. "name": "owner",
  3263. "in": "path",
  3264. "required": true
  3265. },
  3266. {
  3267. "type": "string",
  3268. "description": "name of the repo",
  3269. "name": "repo",
  3270. "in": "path",
  3271. "required": true
  3272. },
  3273. {
  3274. "type": "string",
  3275. "description": "path of the file to create",
  3276. "name": "filepath",
  3277. "in": "path",
  3278. "required": true
  3279. },
  3280. {
  3281. "name": "body",
  3282. "in": "body",
  3283. "required": true,
  3284. "schema": {
  3285. "$ref": "#/definitions/CreateFileOptions"
  3286. }
  3287. }
  3288. ],
  3289. "responses": {
  3290. "201": {
  3291. "$ref": "#/responses/FileResponse"
  3292. },
  3293. "403": {
  3294. "$ref": "#/responses/error"
  3295. },
  3296. "404": {
  3297. "$ref": "#/responses/notFound"
  3298. },
  3299. "422": {
  3300. "$ref": "#/responses/error"
  3301. }
  3302. }
  3303. },
  3304. "delete": {
  3305. "consumes": [
  3306. "application/json"
  3307. ],
  3308. "produces": [
  3309. "application/json"
  3310. ],
  3311. "tags": [
  3312. "repository"
  3313. ],
  3314. "summary": "Delete a file in a repository",
  3315. "operationId": "repoDeleteFile",
  3316. "parameters": [
  3317. {
  3318. "type": "string",
  3319. "description": "owner of the repo",
  3320. "name": "owner",
  3321. "in": "path",
  3322. "required": true
  3323. },
  3324. {
  3325. "type": "string",
  3326. "description": "name of the repo",
  3327. "name": "repo",
  3328. "in": "path",
  3329. "required": true
  3330. },
  3331. {
  3332. "type": "string",
  3333. "description": "path of the file to delete",
  3334. "name": "filepath",
  3335. "in": "path",
  3336. "required": true
  3337. },
  3338. {
  3339. "name": "body",
  3340. "in": "body",
  3341. "required": true,
  3342. "schema": {
  3343. "$ref": "#/definitions/DeleteFileOptions"
  3344. }
  3345. }
  3346. ],
  3347. "responses": {
  3348. "200": {
  3349. "$ref": "#/responses/FileDeleteResponse"
  3350. },
  3351. "400": {
  3352. "$ref": "#/responses/error"
  3353. },
  3354. "403": {
  3355. "$ref": "#/responses/error"
  3356. },
  3357. "404": {
  3358. "$ref": "#/responses/error"
  3359. }
  3360. }
  3361. }
  3362. },
  3363. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  3364. "get": {
  3365. "produces": [
  3366. "application/json"
  3367. ],
  3368. "tags": [
  3369. "repository"
  3370. ],
  3371. "summary": "Get the EditorConfig definitions of a file in a repository",
  3372. "operationId": "repoGetEditorConfig",
  3373. "parameters": [
  3374. {
  3375. "type": "string",
  3376. "description": "owner of the repo",
  3377. "name": "owner",
  3378. "in": "path",
  3379. "required": true
  3380. },
  3381. {
  3382. "type": "string",
  3383. "description": "name of the repo",
  3384. "name": "repo",
  3385. "in": "path",
  3386. "required": true
  3387. },
  3388. {
  3389. "type": "string",
  3390. "description": "filepath of file to get",
  3391. "name": "filepath",
  3392. "in": "path",
  3393. "required": true
  3394. }
  3395. ],
  3396. "responses": {
  3397. "200": {
  3398. "description": "success"
  3399. },
  3400. "404": {
  3401. "$ref": "#/responses/notFound"
  3402. }
  3403. }
  3404. }
  3405. },
  3406. "/repos/{owner}/{repo}/forks": {
  3407. "get": {
  3408. "produces": [
  3409. "application/json"
  3410. ],
  3411. "tags": [
  3412. "repository"
  3413. ],
  3414. "summary": "List a repository's forks",
  3415. "operationId": "listForks",
  3416. "parameters": [
  3417. {
  3418. "type": "string",
  3419. "description": "owner of the repo",
  3420. "name": "owner",
  3421. "in": "path",
  3422. "required": true
  3423. },
  3424. {
  3425. "type": "string",
  3426. "description": "name of the repo",
  3427. "name": "repo",
  3428. "in": "path",
  3429. "required": true
  3430. },
  3431. {
  3432. "type": "integer",
  3433. "description": "page number of results to return (1-based)",
  3434. "name": "page",
  3435. "in": "query"
  3436. },
  3437. {
  3438. "type": "integer",
  3439. "description": "page size of results",
  3440. "name": "limit",
  3441. "in": "query"
  3442. }
  3443. ],
  3444. "responses": {
  3445. "200": {
  3446. "$ref": "#/responses/RepositoryList"
  3447. }
  3448. }
  3449. },
  3450. "post": {
  3451. "produces": [
  3452. "application/json"
  3453. ],
  3454. "tags": [
  3455. "repository"
  3456. ],
  3457. "summary": "Fork a repository",
  3458. "operationId": "createFork",
  3459. "parameters": [
  3460. {
  3461. "type": "string",
  3462. "description": "owner of the repo to fork",
  3463. "name": "owner",
  3464. "in": "path",
  3465. "required": true
  3466. },
  3467. {
  3468. "type": "string",
  3469. "description": "name of the repo to fork",
  3470. "name": "repo",
  3471. "in": "path",
  3472. "required": true
  3473. },
  3474. {
  3475. "name": "body",
  3476. "in": "body",
  3477. "schema": {
  3478. "$ref": "#/definitions/CreateForkOption"
  3479. }
  3480. }
  3481. ],
  3482. "responses": {
  3483. "202": {
  3484. "$ref": "#/responses/Repository"
  3485. },
  3486. "403": {
  3487. "$ref": "#/responses/forbidden"
  3488. },
  3489. "422": {
  3490. "$ref": "#/responses/validationError"
  3491. }
  3492. }
  3493. }
  3494. },
  3495. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  3496. "get": {
  3497. "produces": [
  3498. "application/json"
  3499. ],
  3500. "tags": [
  3501. "repository"
  3502. ],
  3503. "summary": "Gets the blob of a repository.",
  3504. "operationId": "GetBlob",
  3505. "parameters": [
  3506. {
  3507. "type": "string",
  3508. "description": "owner of the repo",
  3509. "name": "owner",
  3510. "in": "path",
  3511. "required": true
  3512. },
  3513. {
  3514. "type": "string",
  3515. "description": "name of the repo",
  3516. "name": "repo",
  3517. "in": "path",
  3518. "required": true
  3519. },
  3520. {
  3521. "type": "string",
  3522. "description": "sha of the commit",
  3523. "name": "sha",
  3524. "in": "path",
  3525. "required": true
  3526. }
  3527. ],
  3528. "responses": {
  3529. "200": {
  3530. "$ref": "#/responses/GitBlobResponse"
  3531. },
  3532. "400": {
  3533. "$ref": "#/responses/error"
  3534. }
  3535. }
  3536. }
  3537. },
  3538. "/repos/{owner}/{repo}/git/commits/{sha}": {
  3539. "get": {
  3540. "produces": [
  3541. "application/json"
  3542. ],
  3543. "tags": [
  3544. "repository"
  3545. ],
  3546. "summary": "Get a single commit from a repository",
  3547. "operationId": "repoGetSingleCommit",
  3548. "parameters": [
  3549. {
  3550. "type": "string",
  3551. "description": "owner of the repo",
  3552. "name": "owner",
  3553. "in": "path",
  3554. "required": true
  3555. },
  3556. {
  3557. "type": "string",
  3558. "description": "name of the repo",
  3559. "name": "repo",
  3560. "in": "path",
  3561. "required": true
  3562. },
  3563. {
  3564. "type": "string",
  3565. "description": "a git ref or commit sha",
  3566. "name": "sha",
  3567. "in": "path",
  3568. "required": true
  3569. }
  3570. ],
  3571. "responses": {
  3572. "200": {
  3573. "$ref": "#/responses/Commit"
  3574. },
  3575. "404": {
  3576. "$ref": "#/responses/notFound"
  3577. },
  3578. "422": {
  3579. "$ref": "#/responses/validationError"
  3580. }
  3581. }
  3582. }
  3583. },
  3584. "/repos/{owner}/{repo}/git/notes/{sha}": {
  3585. "get": {
  3586. "produces": [
  3587. "application/json"
  3588. ],
  3589. "tags": [
  3590. "repository"
  3591. ],
  3592. "summary": "Get a note corresponding to a single commit from a repository",
  3593. "operationId": "repoGetNote",
  3594. "parameters": [
  3595. {
  3596. "type": "string",
  3597. "description": "owner of the repo",
  3598. "name": "owner",
  3599. "in": "path",
  3600. "required": true
  3601. },
  3602. {
  3603. "type": "string",
  3604. "description": "name of the repo",
  3605. "name": "repo",
  3606. "in": "path",
  3607. "required": true
  3608. },
  3609. {
  3610. "type": "string",
  3611. "description": "a git ref or commit sha",
  3612. "name": "sha",
  3613. "in": "path",
  3614. "required": true
  3615. }
  3616. ],
  3617. "responses": {
  3618. "200": {
  3619. "$ref": "#/responses/Note"
  3620. },
  3621. "404": {
  3622. "$ref": "#/responses/notFound"
  3623. },
  3624. "422": {
  3625. "$ref": "#/responses/validationError"
  3626. }
  3627. }
  3628. }
  3629. },
  3630. "/repos/{owner}/{repo}/git/refs": {
  3631. "get": {
  3632. "produces": [
  3633. "application/json"
  3634. ],
  3635. "tags": [
  3636. "repository"
  3637. ],
  3638. "summary": "Get specified ref or filtered repository's refs",
  3639. "operationId": "repoListAllGitRefs",
  3640. "parameters": [
  3641. {
  3642. "type": "string",
  3643. "description": "owner of the repo",
  3644. "name": "owner",
  3645. "in": "path",
  3646. "required": true
  3647. },
  3648. {
  3649. "type": "string",
  3650. "description": "name of the repo",
  3651. "name": "repo",
  3652. "in": "path",
  3653. "required": true
  3654. }
  3655. ],
  3656. "responses": {
  3657. "200": {
  3658. "$ref": "#/responses/ReferenceList"
  3659. },
  3660. "404": {
  3661. "$ref": "#/responses/notFound"
  3662. }
  3663. }
  3664. }
  3665. },
  3666. "/repos/{owner}/{repo}/git/refs/{ref}": {
  3667. "get": {
  3668. "produces": [
  3669. "application/json"
  3670. ],
  3671. "tags": [
  3672. "repository"
  3673. ],
  3674. "summary": "Get specified ref or filtered repository's refs",
  3675. "operationId": "repoListGitRefs",
  3676. "parameters": [
  3677. {
  3678. "type": "string",
  3679. "description": "owner of the repo",
  3680. "name": "owner",
  3681. "in": "path",
  3682. "required": true
  3683. },
  3684. {
  3685. "type": "string",
  3686. "description": "name of the repo",
  3687. "name": "repo",
  3688. "in": "path",
  3689. "required": true
  3690. },
  3691. {
  3692. "type": "string",
  3693. "description": "part or full name of the ref",
  3694. "name": "ref",
  3695. "in": "path",
  3696. "required": true
  3697. }
  3698. ],
  3699. "responses": {
  3700. "200": {
  3701. "$ref": "#/responses/ReferenceList"
  3702. },
  3703. "404": {
  3704. "$ref": "#/responses/notFound"
  3705. }
  3706. }
  3707. }
  3708. },
  3709. "/repos/{owner}/{repo}/git/tags/{sha}": {
  3710. "get": {
  3711. "produces": [
  3712. "application/json"
  3713. ],
  3714. "tags": [
  3715. "repository"
  3716. ],
  3717. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  3718. "operationId": "GetAnnotatedTag",
  3719. "parameters": [
  3720. {
  3721. "type": "string",
  3722. "description": "owner of the repo",
  3723. "name": "owner",
  3724. "in": "path",
  3725. "required": true
  3726. },
  3727. {
  3728. "type": "string",
  3729. "description": "name of the repo",
  3730. "name": "repo",
  3731. "in": "path",
  3732. "required": true
  3733. },
  3734. {
  3735. "type": "string",
  3736. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  3737. "name": "sha",
  3738. "in": "path",
  3739. "required": true
  3740. }
  3741. ],
  3742. "responses": {
  3743. "200": {
  3744. "$ref": "#/responses/AnnotatedTag"
  3745. },
  3746. "400": {
  3747. "$ref": "#/responses/error"
  3748. }
  3749. }
  3750. }
  3751. },
  3752. "/repos/{owner}/{repo}/git/trees/{sha}": {
  3753. "get": {
  3754. "produces": [
  3755. "application/json"
  3756. ],
  3757. "tags": [
  3758. "repository"
  3759. ],
  3760. "summary": "Gets the tree of a repository.",
  3761. "operationId": "GetTree",
  3762. "parameters": [
  3763. {
  3764. "type": "string",
  3765. "description": "owner of the repo",
  3766. "name": "owner",
  3767. "in": "path",
  3768. "required": true
  3769. },
  3770. {
  3771. "type": "string",
  3772. "description": "name of the repo",
  3773. "name": "repo",
  3774. "in": "path",
  3775. "required": true
  3776. },
  3777. {
  3778. "type": "string",
  3779. "description": "sha of the commit",
  3780. "name": "sha",
  3781. "in": "path",
  3782. "required": true
  3783. },
  3784. {
  3785. "type": "boolean",
  3786. "description": "show all directories and files",
  3787. "name": "recursive",
  3788. "in": "query"
  3789. },
  3790. {
  3791. "type": "integer",
  3792. "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",
  3793. "name": "page",
  3794. "in": "query"
  3795. },
  3796. {
  3797. "type": "integer",
  3798. "description": "number of items per page",
  3799. "name": "per_page",
  3800. "in": "query"
  3801. }
  3802. ],
  3803. "responses": {
  3804. "200": {
  3805. "$ref": "#/responses/GitTreeResponse"
  3806. },
  3807. "400": {
  3808. "$ref": "#/responses/error"
  3809. }
  3810. }
  3811. }
  3812. },
  3813. "/repos/{owner}/{repo}/hooks": {
  3814. "get": {
  3815. "produces": [
  3816. "application/json"
  3817. ],
  3818. "tags": [
  3819. "repository"
  3820. ],
  3821. "summary": "List the hooks in a repository",
  3822. "operationId": "repoListHooks",
  3823. "parameters": [
  3824. {
  3825. "type": "string",
  3826. "description": "owner of the repo",
  3827. "name": "owner",
  3828. "in": "path",
  3829. "required": true
  3830. },
  3831. {
  3832. "type": "string",
  3833. "description": "name of the repo",
  3834. "name": "repo",
  3835. "in": "path",
  3836. "required": true
  3837. },
  3838. {
  3839. "type": "integer",
  3840. "description": "page number of results to return (1-based)",
  3841. "name": "page",
  3842. "in": "query"
  3843. },
  3844. {
  3845. "type": "integer",
  3846. "description": "page size of results",
  3847. "name": "limit",
  3848. "in": "query"
  3849. }
  3850. ],
  3851. "responses": {
  3852. "200": {
  3853. "$ref": "#/responses/HookList"
  3854. }
  3855. }
  3856. },
  3857. "post": {
  3858. "consumes": [
  3859. "application/json"
  3860. ],
  3861. "produces": [
  3862. "application/json"
  3863. ],
  3864. "tags": [
  3865. "repository"
  3866. ],
  3867. "summary": "Create a hook",
  3868. "operationId": "repoCreateHook",
  3869. "parameters": [
  3870. {
  3871. "type": "string",
  3872. "description": "owner of the repo",
  3873. "name": "owner",
  3874. "in": "path",
  3875. "required": true
  3876. },
  3877. {
  3878. "type": "string",
  3879. "description": "name of the repo",
  3880. "name": "repo",
  3881. "in": "path",
  3882. "required": true
  3883. },
  3884. {
  3885. "name": "body",
  3886. "in": "body",
  3887. "schema": {
  3888. "$ref": "#/definitions/CreateHookOption"
  3889. }
  3890. }
  3891. ],
  3892. "responses": {
  3893. "201": {
  3894. "$ref": "#/responses/Hook"
  3895. }
  3896. }
  3897. }
  3898. },
  3899. "/repos/{owner}/{repo}/hooks/git": {
  3900. "get": {
  3901. "produces": [
  3902. "application/json"
  3903. ],
  3904. "tags": [
  3905. "repository"
  3906. ],
  3907. "summary": "List the Git hooks in a repository",
  3908. "operationId": "repoListGitHooks",
  3909. "parameters": [
  3910. {
  3911. "type": "string",
  3912. "description": "owner of the repo",
  3913. "name": "owner",
  3914. "in": "path",
  3915. "required": true
  3916. },
  3917. {
  3918. "type": "string",
  3919. "description": "name of the repo",
  3920. "name": "repo",
  3921. "in": "path",
  3922. "required": true
  3923. }
  3924. ],
  3925. "responses": {
  3926. "200": {
  3927. "$ref": "#/responses/GitHookList"
  3928. }
  3929. }
  3930. }
  3931. },
  3932. "/repos/{owner}/{repo}/hooks/git/{id}": {
  3933. "get": {
  3934. "produces": [
  3935. "application/json"
  3936. ],
  3937. "tags": [
  3938. "repository"
  3939. ],
  3940. "summary": "Get a Git hook",
  3941. "operationId": "repoGetGitHook",
  3942. "parameters": [
  3943. {
  3944. "type": "string",
  3945. "description": "owner of the repo",
  3946. "name": "owner",
  3947. "in": "path",
  3948. "required": true
  3949. },
  3950. {
  3951. "type": "string",
  3952. "description": "name of the repo",
  3953. "name": "repo",
  3954. "in": "path",
  3955. "required": true
  3956. },
  3957. {
  3958. "type": "string",
  3959. "description": "id of the hook to get",
  3960. "name": "id",
  3961. "in": "path",
  3962. "required": true
  3963. }
  3964. ],
  3965. "responses": {
  3966. "200": {
  3967. "$ref": "#/responses/GitHook"
  3968. },
  3969. "404": {
  3970. "$ref": "#/responses/notFound"
  3971. }
  3972. }
  3973. },
  3974. "delete": {
  3975. "produces": [
  3976. "application/json"
  3977. ],
  3978. "tags": [
  3979. "repository"
  3980. ],
  3981. "summary": "Delete a Git hook in a repository",
  3982. "operationId": "repoDeleteGitHook",
  3983. "parameters": [
  3984. {
  3985. "type": "string",
  3986. "description": "owner of the repo",
  3987. "name": "owner",
  3988. "in": "path",
  3989. "required": true
  3990. },
  3991. {
  3992. "type": "string",
  3993. "description": "name of the repo",
  3994. "name": "repo",
  3995. "in": "path",
  3996. "required": true
  3997. },
  3998. {
  3999. "type": "string",
  4000. "description": "id of the hook to get",
  4001. "name": "id",
  4002. "in": "path",
  4003. "required": true
  4004. }
  4005. ],
  4006. "responses": {
  4007. "204": {
  4008. "$ref": "#/responses/empty"
  4009. },
  4010. "404": {
  4011. "$ref": "#/responses/notFound"
  4012. }
  4013. }
  4014. },
  4015. "patch": {
  4016. "produces": [
  4017. "application/json"
  4018. ],
  4019. "tags": [
  4020. "repository"
  4021. ],
  4022. "summary": "Edit a Git hook in a repository",
  4023. "operationId": "repoEditGitHook",
  4024. "parameters": [
  4025. {
  4026. "type": "string",
  4027. "description": "owner of the repo",
  4028. "name": "owner",
  4029. "in": "path",
  4030. "required": true
  4031. },
  4032. {
  4033. "type": "string",
  4034. "description": "name of the repo",
  4035. "name": "repo",
  4036. "in": "path",
  4037. "required": true
  4038. },
  4039. {
  4040. "type": "string",
  4041. "description": "id of the hook to get",
  4042. "name": "id",
  4043. "in": "path",
  4044. "required": true
  4045. },
  4046. {
  4047. "name": "body",
  4048. "in": "body",
  4049. "schema": {
  4050. "$ref": "#/definitions/EditGitHookOption"
  4051. }
  4052. }
  4053. ],
  4054. "responses": {
  4055. "200": {
  4056. "$ref": "#/responses/GitHook"
  4057. },
  4058. "404": {
  4059. "$ref": "#/responses/notFound"
  4060. }
  4061. }
  4062. }
  4063. },
  4064. "/repos/{owner}/{repo}/hooks/{id}": {
  4065. "get": {
  4066. "produces": [
  4067. "application/json"
  4068. ],
  4069. "tags": [
  4070. "repository"
  4071. ],
  4072. "summary": "Get a hook",
  4073. "operationId": "repoGetHook",
  4074. "parameters": [
  4075. {
  4076. "type": "string",
  4077. "description": "owner of the repo",
  4078. "name": "owner",
  4079. "in": "path",
  4080. "required": true
  4081. },
  4082. {
  4083. "type": "string",
  4084. "description": "name of the repo",
  4085. "name": "repo",
  4086. "in": "path",
  4087. "required": true
  4088. },
  4089. {
  4090. "type": "integer",
  4091. "format": "int64",
  4092. "description": "id of the hook to get",
  4093. "name": "id",
  4094. "in": "path",
  4095. "required": true
  4096. }
  4097. ],
  4098. "responses": {
  4099. "200": {
  4100. "$ref": "#/responses/Hook"
  4101. },
  4102. "404": {
  4103. "$ref": "#/responses/notFound"
  4104. }
  4105. }
  4106. },
  4107. "delete": {
  4108. "produces": [
  4109. "application/json"
  4110. ],
  4111. "tags": [
  4112. "repository"
  4113. ],
  4114. "summary": "Delete a hook in a repository",
  4115. "operationId": "repoDeleteHook",
  4116. "parameters": [
  4117. {
  4118. "type": "string",
  4119. "description": "owner of the repo",
  4120. "name": "owner",
  4121. "in": "path",
  4122. "required": true
  4123. },
  4124. {
  4125. "type": "string",
  4126. "description": "name of the repo",
  4127. "name": "repo",
  4128. "in": "path",
  4129. "required": true
  4130. },
  4131. {
  4132. "type": "integer",
  4133. "format": "int64",
  4134. "description": "id of the hook to delete",
  4135. "name": "id",
  4136. "in": "path",
  4137. "required": true
  4138. }
  4139. ],
  4140. "responses": {
  4141. "204": {
  4142. "$ref": "#/responses/empty"
  4143. },
  4144. "404": {
  4145. "$ref": "#/responses/notFound"
  4146. }
  4147. }
  4148. },
  4149. "patch": {
  4150. "produces": [
  4151. "application/json"
  4152. ],
  4153. "tags": [
  4154. "repository"
  4155. ],
  4156. "summary": "Edit a hook in a repository",
  4157. "operationId": "repoEditHook",
  4158. "parameters": [
  4159. {
  4160. "type": "string",
  4161. "description": "owner of the repo",
  4162. "name": "owner",
  4163. "in": "path",
  4164. "required": true
  4165. },
  4166. {
  4167. "type": "string",
  4168. "description": "name of the repo",
  4169. "name": "repo",
  4170. "in": "path",
  4171. "required": true
  4172. },
  4173. {
  4174. "type": "integer",
  4175. "format": "int64",
  4176. "description": "index of the hook",
  4177. "name": "id",
  4178. "in": "path",
  4179. "required": true
  4180. },
  4181. {
  4182. "name": "body",
  4183. "in": "body",
  4184. "schema": {
  4185. "$ref": "#/definitions/EditHookOption"
  4186. }
  4187. }
  4188. ],
  4189. "responses": {
  4190. "200": {
  4191. "$ref": "#/responses/Hook"
  4192. }
  4193. }
  4194. }
  4195. },
  4196. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  4197. "post": {
  4198. "produces": [
  4199. "application/json"
  4200. ],
  4201. "tags": [
  4202. "repository"
  4203. ],
  4204. "summary": "Test a push webhook",
  4205. "operationId": "repoTestHook",
  4206. "parameters": [
  4207. {
  4208. "type": "string",
  4209. "description": "owner of the repo",
  4210. "name": "owner",
  4211. "in": "path",
  4212. "required": true
  4213. },
  4214. {
  4215. "type": "string",
  4216. "description": "name of the repo",
  4217. "name": "repo",
  4218. "in": "path",
  4219. "required": true
  4220. },
  4221. {
  4222. "type": "integer",
  4223. "format": "int64",
  4224. "description": "id of the hook to test",
  4225. "name": "id",
  4226. "in": "path",
  4227. "required": true
  4228. }
  4229. ],
  4230. "responses": {
  4231. "204": {
  4232. "$ref": "#/responses/empty"
  4233. }
  4234. }
  4235. }
  4236. },
  4237. "/repos/{owner}/{repo}/issue_templates": {
  4238. "get": {
  4239. "produces": [
  4240. "application/json"
  4241. ],
  4242. "tags": [
  4243. "repository"
  4244. ],
  4245. "summary": "Get available issue templates for a repository",
  4246. "operationId": "repoGetIssueTemplates",
  4247. "parameters": [
  4248. {
  4249. "type": "string",
  4250. "description": "owner of the repo",
  4251. "name": "owner",
  4252. "in": "path",
  4253. "required": true
  4254. },
  4255. {
  4256. "type": "string",
  4257. "description": "name of the repo",
  4258. "name": "repo",
  4259. "in": "path",
  4260. "required": true
  4261. }
  4262. ],
  4263. "responses": {
  4264. "200": {
  4265. "$ref": "#/responses/IssueTemplates"
  4266. }
  4267. }
  4268. }
  4269. },
  4270. "/repos/{owner}/{repo}/issues": {
  4271. "get": {
  4272. "produces": [
  4273. "application/json"
  4274. ],
  4275. "tags": [
  4276. "issue"
  4277. ],
  4278. "summary": "List a repository's issues",
  4279. "operationId": "issueListIssues",
  4280. "parameters": [
  4281. {
  4282. "type": "string",
  4283. "description": "owner of the repo",
  4284. "name": "owner",
  4285. "in": "path",
  4286. "required": true
  4287. },
  4288. {
  4289. "type": "string",
  4290. "description": "name of the repo",
  4291. "name": "repo",
  4292. "in": "path",
  4293. "required": true
  4294. },
  4295. {
  4296. "enum": [
  4297. "closed",
  4298. "open",
  4299. "all"
  4300. ],
  4301. "type": "string",
  4302. "description": "whether issue is open or closed",
  4303. "name": "state",
  4304. "in": "query"
  4305. },
  4306. {
  4307. "type": "string",
  4308. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  4309. "name": "labels",
  4310. "in": "query"
  4311. },
  4312. {
  4313. "type": "string",
  4314. "description": "search string",
  4315. "name": "q",
  4316. "in": "query"
  4317. },
  4318. {
  4319. "enum": [
  4320. "issues",
  4321. "pulls"
  4322. ],
  4323. "type": "string",
  4324. "description": "filter by type (issues / pulls) if set",
  4325. "name": "type",
  4326. "in": "query"
  4327. },
  4328. {
  4329. "type": "string",
  4330. "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",
  4331. "name": "milestones",
  4332. "in": "query"
  4333. },
  4334. {
  4335. "type": "string",
  4336. "format": "date-time",
  4337. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  4338. "name": "since",
  4339. "in": "query"
  4340. },
  4341. {
  4342. "type": "string",
  4343. "format": "date-time",
  4344. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  4345. "name": "before",
  4346. "in": "query"
  4347. },
  4348. {
  4349. "type": "string",
  4350. "description": "filter (issues / pulls) created to",
  4351. "name": "created_by",
  4352. "in": "query"
  4353. },
  4354. {
  4355. "type": "string",
  4356. "description": "filter (issues / pulls) assigned to",
  4357. "name": "assigned_by",
  4358. "in": "query"
  4359. },
  4360. {
  4361. "type": "string",
  4362. "description": "filter (issues / pulls) mentioning to",
  4363. "name": "mentioned_by",
  4364. "in": "query"
  4365. },
  4366. {
  4367. "type": "integer",
  4368. "description": "page number of results to return (1-based)",
  4369. "name": "page",
  4370. "in": "query"
  4371. },
  4372. {
  4373. "type": "integer",
  4374. "description": "page size of results",
  4375. "name": "limit",
  4376. "in": "query"
  4377. }
  4378. ],
  4379. "responses": {
  4380. "200": {
  4381. "$ref": "#/responses/IssueList"
  4382. }
  4383. }
  4384. },
  4385. "post": {
  4386. "consumes": [
  4387. "application/json"
  4388. ],
  4389. "produces": [
  4390. "application/json"
  4391. ],
  4392. "tags": [
  4393. "issue"
  4394. ],
  4395. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4396. "operationId": "issueCreateIssue",
  4397. "parameters": [
  4398. {
  4399. "type": "string",
  4400. "description": "owner of the repo",
  4401. "name": "owner",
  4402. "in": "path",
  4403. "required": true
  4404. },
  4405. {
  4406. "type": "string",
  4407. "description": "name of the repo",
  4408. "name": "repo",
  4409. "in": "path",
  4410. "required": true
  4411. },
  4412. {
  4413. "name": "body",
  4414. "in": "body",
  4415. "schema": {
  4416. "$ref": "#/definitions/CreateIssueOption"
  4417. }
  4418. }
  4419. ],
  4420. "responses": {
  4421. "201": {
  4422. "$ref": "#/responses/Issue"
  4423. },
  4424. "403": {
  4425. "$ref": "#/responses/forbidden"
  4426. },
  4427. "412": {
  4428. "$ref": "#/responses/error"
  4429. },
  4430. "422": {
  4431. "$ref": "#/responses/validationError"
  4432. }
  4433. }
  4434. }
  4435. },
  4436. "/repos/{owner}/{repo}/issues/comments": {
  4437. "get": {
  4438. "produces": [
  4439. "application/json"
  4440. ],
  4441. "tags": [
  4442. "issue"
  4443. ],
  4444. "summary": "List all comments in a repository",
  4445. "operationId": "issueGetRepoComments",
  4446. "parameters": [
  4447. {
  4448. "type": "string",
  4449. "description": "owner of the repo",
  4450. "name": "owner",
  4451. "in": "path",
  4452. "required": true
  4453. },
  4454. {
  4455. "type": "string",
  4456. "description": "name of the repo",
  4457. "name": "repo",
  4458. "in": "path",
  4459. "required": true
  4460. },
  4461. {
  4462. "type": "string",
  4463. "format": "date-time",
  4464. "description": "if provided, only comments updated since the provided time are returned.",
  4465. "name": "since",
  4466. "in": "query"
  4467. },
  4468. {
  4469. "type": "string",
  4470. "format": "date-time",
  4471. "description": "if provided, only comments updated before the provided time are returned.",
  4472. "name": "before",
  4473. "in": "query"
  4474. },
  4475. {
  4476. "type": "integer",
  4477. "description": "page number of results to return (1-based)",
  4478. "name": "page",
  4479. "in": "query"
  4480. },
  4481. {
  4482. "type": "integer",
  4483. "description": "page size of results",
  4484. "name": "limit",
  4485. "in": "query"
  4486. }
  4487. ],
  4488. "responses": {
  4489. "200": {
  4490. "$ref": "#/responses/CommentList"
  4491. }
  4492. }
  4493. }
  4494. },
  4495. "/repos/{owner}/{repo}/issues/comments/{id}": {
  4496. "get": {
  4497. "consumes": [
  4498. "application/json"
  4499. ],
  4500. "produces": [
  4501. "application/json"
  4502. ],
  4503. "tags": [
  4504. "issue"
  4505. ],
  4506. "summary": "Get a comment",
  4507. "operationId": "issueGetComment",
  4508. "parameters": [
  4509. {
  4510. "type": "string",
  4511. "description": "owner of the repo",
  4512. "name": "owner",
  4513. "in": "path",
  4514. "required": true
  4515. },
  4516. {
  4517. "type": "string",
  4518. "description": "name of the repo",
  4519. "name": "repo",
  4520. "in": "path",
  4521. "required": true
  4522. },
  4523. {
  4524. "type": "integer",
  4525. "format": "int64",
  4526. "description": "id of the comment",
  4527. "name": "id",
  4528. "in": "path",
  4529. "required": true
  4530. }
  4531. ],
  4532. "responses": {
  4533. "200": {
  4534. "$ref": "#/responses/Comment"
  4535. },
  4536. "204": {
  4537. "$ref": "#/responses/empty"
  4538. },
  4539. "403": {
  4540. "$ref": "#/responses/forbidden"
  4541. },
  4542. "404": {
  4543. "$ref": "#/responses/notFound"
  4544. }
  4545. }
  4546. },
  4547. "delete": {
  4548. "tags": [
  4549. "issue"
  4550. ],
  4551. "summary": "Delete a comment",
  4552. "operationId": "issueDeleteComment",
  4553. "parameters": [
  4554. {
  4555. "type": "string",
  4556. "description": "owner of the repo",
  4557. "name": "owner",
  4558. "in": "path",
  4559. "required": true
  4560. },
  4561. {
  4562. "type": "string",
  4563. "description": "name of the repo",
  4564. "name": "repo",
  4565. "in": "path",
  4566. "required": true
  4567. },
  4568. {
  4569. "type": "integer",
  4570. "format": "int64",
  4571. "description": "id of comment to delete",
  4572. "name": "id",
  4573. "in": "path",
  4574. "required": true
  4575. }
  4576. ],
  4577. "responses": {
  4578. "204": {
  4579. "$ref": "#/responses/empty"
  4580. },
  4581. "403": {
  4582. "$ref": "#/responses/forbidden"
  4583. },
  4584. "404": {
  4585. "$ref": "#/responses/notFound"
  4586. }
  4587. }
  4588. },
  4589. "patch": {
  4590. "consumes": [
  4591. "application/json"
  4592. ],
  4593. "produces": [
  4594. "application/json"
  4595. ],
  4596. "tags": [
  4597. "issue"
  4598. ],
  4599. "summary": "Edit a comment",
  4600. "operationId": "issueEditComment",
  4601. "parameters": [
  4602. {
  4603. "type": "string",
  4604. "description": "owner of the repo",
  4605. "name": "owner",
  4606. "in": "path",
  4607. "required": true
  4608. },
  4609. {
  4610. "type": "string",
  4611. "description": "name of the repo",
  4612. "name": "repo",
  4613. "in": "path",
  4614. "required": true
  4615. },
  4616. {
  4617. "type": "integer",
  4618. "format": "int64",
  4619. "description": "id of the comment to edit",
  4620. "name": "id",
  4621. "in": "path",
  4622. "required": true
  4623. },
  4624. {
  4625. "name": "body",
  4626. "in": "body",
  4627. "schema": {
  4628. "$ref": "#/definitions/EditIssueCommentOption"
  4629. }
  4630. }
  4631. ],
  4632. "responses": {
  4633. "200": {
  4634. "$ref": "#/responses/Comment"
  4635. },
  4636. "204": {
  4637. "$ref": "#/responses/empty"
  4638. },
  4639. "403": {
  4640. "$ref": "#/responses/forbidden"
  4641. },
  4642. "404": {
  4643. "$ref": "#/responses/notFound"
  4644. }
  4645. }
  4646. }
  4647. },
  4648. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  4649. "get": {
  4650. "consumes": [
  4651. "application/json"
  4652. ],
  4653. "produces": [
  4654. "application/json"
  4655. ],
  4656. "tags": [
  4657. "issue"
  4658. ],
  4659. "summary": "Get a list of reactions from a comment of an issue",
  4660. "operationId": "issueGetCommentReactions",
  4661. "parameters": [
  4662. {
  4663. "type": "string",
  4664. "description": "owner of the repo",
  4665. "name": "owner",
  4666. "in": "path",
  4667. "required": true
  4668. },
  4669. {
  4670. "type": "string",
  4671. "description": "name of the repo",
  4672. "name": "repo",
  4673. "in": "path",
  4674. "required": true
  4675. },
  4676. {
  4677. "type": "integer",
  4678. "format": "int64",
  4679. "description": "id of the comment to edit",
  4680. "name": "id",
  4681. "in": "path",
  4682. "required": true
  4683. }
  4684. ],
  4685. "responses": {
  4686. "200": {
  4687. "$ref": "#/responses/ReactionList"
  4688. },
  4689. "403": {
  4690. "$ref": "#/responses/forbidden"
  4691. }
  4692. }
  4693. },
  4694. "post": {
  4695. "consumes": [
  4696. "application/json"
  4697. ],
  4698. "produces": [
  4699. "application/json"
  4700. ],
  4701. "tags": [
  4702. "issue"
  4703. ],
  4704. "summary": "Add a reaction to a comment of an issue",
  4705. "operationId": "issuePostCommentReaction",
  4706. "parameters": [
  4707. {
  4708. "type": "string",
  4709. "description": "owner of the repo",
  4710. "name": "owner",
  4711. "in": "path",
  4712. "required": true
  4713. },
  4714. {
  4715. "type": "string",
  4716. "description": "name of the repo",
  4717. "name": "repo",
  4718. "in": "path",
  4719. "required": true
  4720. },
  4721. {
  4722. "type": "integer",
  4723. "format": "int64",
  4724. "description": "id of the comment to edit",
  4725. "name": "id",
  4726. "in": "path",
  4727. "required": true
  4728. },
  4729. {
  4730. "name": "content",
  4731. "in": "body",
  4732. "schema": {
  4733. "$ref": "#/definitions/EditReactionOption"
  4734. }
  4735. }
  4736. ],
  4737. "responses": {
  4738. "200": {
  4739. "$ref": "#/responses/Reaction"
  4740. },
  4741. "201": {
  4742. "$ref": "#/responses/Reaction"
  4743. },
  4744. "403": {
  4745. "$ref": "#/responses/forbidden"
  4746. }
  4747. }
  4748. },
  4749. "delete": {
  4750. "consumes": [
  4751. "application/json"
  4752. ],
  4753. "produces": [
  4754. "application/json"
  4755. ],
  4756. "tags": [
  4757. "issue"
  4758. ],
  4759. "summary": "Remove a reaction from a comment of an issue",
  4760. "operationId": "issueDeleteCommentReaction",
  4761. "parameters": [
  4762. {
  4763. "type": "string",
  4764. "description": "owner of the repo",
  4765. "name": "owner",
  4766. "in": "path",
  4767. "required": true
  4768. },
  4769. {
  4770. "type": "string",
  4771. "description": "name of the repo",
  4772. "name": "repo",
  4773. "in": "path",
  4774. "required": true
  4775. },
  4776. {
  4777. "type": "integer",
  4778. "format": "int64",
  4779. "description": "id of the comment to edit",
  4780. "name": "id",
  4781. "in": "path",
  4782. "required": true
  4783. },
  4784. {
  4785. "name": "content",
  4786. "in": "body",
  4787. "schema": {
  4788. "$ref": "#/definitions/EditReactionOption"
  4789. }
  4790. }
  4791. ],
  4792. "responses": {
  4793. "200": {
  4794. "$ref": "#/responses/empty"
  4795. },
  4796. "403": {
  4797. "$ref": "#/responses/forbidden"
  4798. }
  4799. }
  4800. }
  4801. },
  4802. "/repos/{owner}/{repo}/issues/{index}": {
  4803. "get": {
  4804. "produces": [
  4805. "application/json"
  4806. ],
  4807. "tags": [
  4808. "issue"
  4809. ],
  4810. "summary": "Get an issue",
  4811. "operationId": "issueGetIssue",
  4812. "parameters": [
  4813. {
  4814. "type": "string",
  4815. "description": "owner of the repo",
  4816. "name": "owner",
  4817. "in": "path",
  4818. "required": true
  4819. },
  4820. {
  4821. "type": "string",
  4822. "description": "name of the repo",
  4823. "name": "repo",
  4824. "in": "path",
  4825. "required": true
  4826. },
  4827. {
  4828. "type": "integer",
  4829. "format": "int64",
  4830. "description": "index of the issue to get",
  4831. "name": "index",
  4832. "in": "path",
  4833. "required": true
  4834. }
  4835. ],
  4836. "responses": {
  4837. "200": {
  4838. "$ref": "#/responses/Issue"
  4839. },
  4840. "404": {
  4841. "$ref": "#/responses/notFound"
  4842. }
  4843. }
  4844. },
  4845. "patch": {
  4846. "consumes": [
  4847. "application/json"
  4848. ],
  4849. "produces": [
  4850. "application/json"
  4851. ],
  4852. "tags": [
  4853. "issue"
  4854. ],
  4855. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4856. "operationId": "issueEditIssue",
  4857. "parameters": [
  4858. {
  4859. "type": "string",
  4860. "description": "owner of the repo",
  4861. "name": "owner",
  4862. "in": "path",
  4863. "required": true
  4864. },
  4865. {
  4866. "type": "string",
  4867. "description": "name of the repo",
  4868. "name": "repo",
  4869. "in": "path",
  4870. "required": true
  4871. },
  4872. {
  4873. "type": "integer",
  4874. "format": "int64",
  4875. "description": "index of the issue to edit",
  4876. "name": "index",
  4877. "in": "path",
  4878. "required": true
  4879. },
  4880. {
  4881. "name": "body",
  4882. "in": "body",
  4883. "schema": {
  4884. "$ref": "#/definitions/EditIssueOption"
  4885. }
  4886. }
  4887. ],
  4888. "responses": {
  4889. "201": {
  4890. "$ref": "#/responses/Issue"
  4891. },
  4892. "403": {
  4893. "$ref": "#/responses/forbidden"
  4894. },
  4895. "404": {
  4896. "$ref": "#/responses/notFound"
  4897. },
  4898. "412": {
  4899. "$ref": "#/responses/error"
  4900. }
  4901. }
  4902. }
  4903. },
  4904. "/repos/{owner}/{repo}/issues/{index}/comments": {
  4905. "get": {
  4906. "produces": [
  4907. "application/json"
  4908. ],
  4909. "tags": [
  4910. "issue"
  4911. ],
  4912. "summary": "List all comments on an issue",
  4913. "operationId": "issueGetComments",
  4914. "parameters": [
  4915. {
  4916. "type": "string",
  4917. "description": "owner of the repo",
  4918. "name": "owner",
  4919. "in": "path",
  4920. "required": true
  4921. },
  4922. {
  4923. "type": "string",
  4924. "description": "name of the repo",
  4925. "name": "repo",
  4926. "in": "path",
  4927. "required": true
  4928. },
  4929. {
  4930. "type": "integer",
  4931. "format": "int64",
  4932. "description": "index of the issue",
  4933. "name": "index",
  4934. "in": "path",
  4935. "required": true
  4936. },
  4937. {
  4938. "type": "string",
  4939. "format": "date-time",
  4940. "description": "if provided, only comments updated since the specified time are returned.",
  4941. "name": "since",
  4942. "in": "query"
  4943. },
  4944. {
  4945. "type": "string",
  4946. "format": "date-time",
  4947. "description": "if provided, only comments updated before the provided time are returned.",
  4948. "name": "before",
  4949. "in": "query"
  4950. }
  4951. ],
  4952. "responses": {
  4953. "200": {
  4954. "$ref": "#/responses/CommentList"
  4955. }
  4956. }
  4957. },
  4958. "post": {
  4959. "consumes": [
  4960. "application/json"
  4961. ],
  4962. "produces": [
  4963. "application/json"
  4964. ],
  4965. "tags": [
  4966. "issue"
  4967. ],
  4968. "summary": "Add a comment to an issue",
  4969. "operationId": "issueCreateComment",
  4970. "parameters": [
  4971. {
  4972. "type": "string",
  4973. "description": "owner of the repo",
  4974. "name": "owner",
  4975. "in": "path",
  4976. "required": true
  4977. },
  4978. {
  4979. "type": "string",
  4980. "description": "name of the repo",
  4981. "name": "repo",
  4982. "in": "path",
  4983. "required": true
  4984. },
  4985. {
  4986. "type": "integer",
  4987. "format": "int64",
  4988. "description": "index of the issue",
  4989. "name": "index",
  4990. "in": "path",
  4991. "required": true
  4992. },
  4993. {
  4994. "name": "body",
  4995. "in": "body",
  4996. "schema": {
  4997. "$ref": "#/definitions/CreateIssueCommentOption"
  4998. }
  4999. }
  5000. ],
  5001. "responses": {
  5002. "201": {
  5003. "$ref": "#/responses/Comment"
  5004. },
  5005. "403": {
  5006. "$ref": "#/responses/forbidden"
  5007. }
  5008. }
  5009. }
  5010. },
  5011. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  5012. "delete": {
  5013. "tags": [
  5014. "issue"
  5015. ],
  5016. "summary": "Delete a comment",
  5017. "operationId": "issueDeleteCommentDeprecated",
  5018. "deprecated": true,
  5019. "parameters": [
  5020. {
  5021. "type": "string",
  5022. "description": "owner of the repo",
  5023. "name": "owner",
  5024. "in": "path",
  5025. "required": true
  5026. },
  5027. {
  5028. "type": "string",
  5029. "description": "name of the repo",
  5030. "name": "repo",
  5031. "in": "path",
  5032. "required": true
  5033. },
  5034. {
  5035. "type": "integer",
  5036. "description": "this parameter is ignored",
  5037. "name": "index",
  5038. "in": "path",
  5039. "required": true
  5040. },
  5041. {
  5042. "type": "integer",
  5043. "format": "int64",
  5044. "description": "id of comment to delete",
  5045. "name": "id",
  5046. "in": "path",
  5047. "required": true
  5048. }
  5049. ],
  5050. "responses": {
  5051. "204": {
  5052. "$ref": "#/responses/empty"
  5053. },
  5054. "403": {
  5055. "$ref": "#/responses/forbidden"
  5056. },
  5057. "404": {
  5058. "$ref": "#/responses/notFound"
  5059. }
  5060. }
  5061. },
  5062. "patch": {
  5063. "consumes": [
  5064. "application/json"
  5065. ],
  5066. "produces": [
  5067. "application/json"
  5068. ],
  5069. "tags": [
  5070. "issue"
  5071. ],
  5072. "summary": "Edit a comment",
  5073. "operationId": "issueEditCommentDeprecated",
  5074. "deprecated": true,
  5075. "parameters": [
  5076. {
  5077. "type": "string",
  5078. "description": "owner of the repo",
  5079. "name": "owner",
  5080. "in": "path",
  5081. "required": true
  5082. },
  5083. {
  5084. "type": "string",
  5085. "description": "name of the repo",
  5086. "name": "repo",
  5087. "in": "path",
  5088. "required": true
  5089. },
  5090. {
  5091. "type": "integer",
  5092. "description": "this parameter is ignored",
  5093. "name": "index",
  5094. "in": "path",
  5095. "required": true
  5096. },
  5097. {
  5098. "type": "integer",
  5099. "format": "int64",
  5100. "description": "id of the comment to edit",
  5101. "name": "id",
  5102. "in": "path",
  5103. "required": true
  5104. },
  5105. {
  5106. "name": "body",
  5107. "in": "body",
  5108. "schema": {
  5109. "$ref": "#/definitions/EditIssueCommentOption"
  5110. }
  5111. }
  5112. ],
  5113. "responses": {
  5114. "200": {
  5115. "$ref": "#/responses/Comment"
  5116. },
  5117. "204": {
  5118. "$ref": "#/responses/empty"
  5119. },
  5120. "403": {
  5121. "$ref": "#/responses/forbidden"
  5122. },
  5123. "404": {
  5124. "$ref": "#/responses/notFound"
  5125. }
  5126. }
  5127. }
  5128. },
  5129. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  5130. "post": {
  5131. "consumes": [
  5132. "application/json"
  5133. ],
  5134. "produces": [
  5135. "application/json"
  5136. ],
  5137. "tags": [
  5138. "issue"
  5139. ],
  5140. "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.",
  5141. "operationId": "issueEditIssueDeadline",
  5142. "parameters": [
  5143. {
  5144. "type": "string",
  5145. "description": "owner of the repo",
  5146. "name": "owner",
  5147. "in": "path",
  5148. "required": true
  5149. },
  5150. {
  5151. "type": "string",
  5152. "description": "name of the repo",
  5153. "name": "repo",
  5154. "in": "path",
  5155. "required": true
  5156. },
  5157. {
  5158. "type": "integer",
  5159. "format": "int64",
  5160. "description": "index of the issue to create or update a deadline on",
  5161. "name": "index",
  5162. "in": "path",
  5163. "required": true
  5164. },
  5165. {
  5166. "name": "body",
  5167. "in": "body",
  5168. "schema": {
  5169. "$ref": "#/definitions/EditDeadlineOption"
  5170. }
  5171. }
  5172. ],
  5173. "responses": {
  5174. "201": {
  5175. "$ref": "#/responses/IssueDeadline"
  5176. },
  5177. "403": {
  5178. "$ref": "#/responses/forbidden"
  5179. },
  5180. "404": {
  5181. "$ref": "#/responses/notFound"
  5182. }
  5183. }
  5184. }
  5185. },
  5186. "/repos/{owner}/{repo}/issues/{index}/labels": {
  5187. "get": {
  5188. "produces": [
  5189. "application/json"
  5190. ],
  5191. "tags": [
  5192. "issue"
  5193. ],
  5194. "summary": "Get an issue's labels",
  5195. "operationId": "issueGetLabels",
  5196. "parameters": [
  5197. {
  5198. "type": "string",
  5199. "description": "owner of the repo",
  5200. "name": "owner",
  5201. "in": "path",
  5202. "required": true
  5203. },
  5204. {
  5205. "type": "string",
  5206. "description": "name of the repo",
  5207. "name": "repo",
  5208. "in": "path",
  5209. "required": true
  5210. },
  5211. {
  5212. "type": "integer",
  5213. "format": "int64",
  5214. "description": "index of the issue",
  5215. "name": "index",
  5216. "in": "path",
  5217. "required": true
  5218. }
  5219. ],
  5220. "responses": {
  5221. "200": {
  5222. "$ref": "#/responses/LabelList"
  5223. },
  5224. "404": {
  5225. "$ref": "#/responses/notFound"
  5226. }
  5227. }
  5228. },
  5229. "put": {
  5230. "consumes": [
  5231. "application/json"
  5232. ],
  5233. "produces": [
  5234. "application/json"
  5235. ],
  5236. "tags": [
  5237. "issue"
  5238. ],
  5239. "summary": "Replace an issue's labels",
  5240. "operationId": "issueReplaceLabels",
  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. "name": "body",
  5266. "in": "body",
  5267. "schema": {
  5268. "$ref": "#/definitions/IssueLabelsOption"
  5269. }
  5270. }
  5271. ],
  5272. "responses": {
  5273. "200": {
  5274. "$ref": "#/responses/LabelList"
  5275. },
  5276. "403": {
  5277. "$ref": "#/responses/forbidden"
  5278. }
  5279. }
  5280. },
  5281. "post": {
  5282. "consumes": [
  5283. "application/json"
  5284. ],
  5285. "produces": [
  5286. "application/json"
  5287. ],
  5288. "tags": [
  5289. "issue"
  5290. ],
  5291. "summary": "Add a label to an issue",
  5292. "operationId": "issueAddLabel",
  5293. "parameters": [
  5294. {
  5295. "type": "string",
  5296. "description": "owner of the repo",
  5297. "name": "owner",
  5298. "in": "path",
  5299. "required": true
  5300. },
  5301. {
  5302. "type": "string",
  5303. "description": "name of the repo",
  5304. "name": "repo",
  5305. "in": "path",
  5306. "required": true
  5307. },
  5308. {
  5309. "type": "integer",
  5310. "format": "int64",
  5311. "description": "index of the issue",
  5312. "name": "index",
  5313. "in": "path",
  5314. "required": true
  5315. },
  5316. {
  5317. "name": "body",
  5318. "in": "body",
  5319. "schema": {
  5320. "$ref": "#/definitions/IssueLabelsOption"
  5321. }
  5322. }
  5323. ],
  5324. "responses": {
  5325. "200": {
  5326. "$ref": "#/responses/LabelList"
  5327. },
  5328. "403": {
  5329. "$ref": "#/responses/forbidden"
  5330. }
  5331. }
  5332. },
  5333. "delete": {
  5334. "produces": [
  5335. "application/json"
  5336. ],
  5337. "tags": [
  5338. "issue"
  5339. ],
  5340. "summary": "Remove all labels from an issue",
  5341. "operationId": "issueClearLabels",
  5342. "parameters": [
  5343. {
  5344. "type": "string",
  5345. "description": "owner of the repo",
  5346. "name": "owner",
  5347. "in": "path",
  5348. "required": true
  5349. },
  5350. {
  5351. "type": "string",
  5352. "description": "name of the repo",
  5353. "name": "repo",
  5354. "in": "path",
  5355. "required": true
  5356. },
  5357. {
  5358. "type": "integer",
  5359. "format": "int64",
  5360. "description": "index of the issue",
  5361. "name": "index",
  5362. "in": "path",
  5363. "required": true
  5364. }
  5365. ],
  5366. "responses": {
  5367. "204": {
  5368. "$ref": "#/responses/empty"
  5369. },
  5370. "403": {
  5371. "$ref": "#/responses/forbidden"
  5372. }
  5373. }
  5374. }
  5375. },
  5376. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  5377. "delete": {
  5378. "produces": [
  5379. "application/json"
  5380. ],
  5381. "tags": [
  5382. "issue"
  5383. ],
  5384. "summary": "Remove a label from an issue",
  5385. "operationId": "issueRemoveLabel",
  5386. "parameters": [
  5387. {
  5388. "type": "string",
  5389. "description": "owner of the repo",
  5390. "name": "owner",
  5391. "in": "path",
  5392. "required": true
  5393. },
  5394. {
  5395. "type": "string",
  5396. "description": "name of the repo",
  5397. "name": "repo",
  5398. "in": "path",
  5399. "required": true
  5400. },
  5401. {
  5402. "type": "integer",
  5403. "format": "int64",
  5404. "description": "index of the issue",
  5405. "name": "index",
  5406. "in": "path",
  5407. "required": true
  5408. },
  5409. {
  5410. "type": "integer",
  5411. "format": "int64",
  5412. "description": "id of the label to remove",
  5413. "name": "id",
  5414. "in": "path",
  5415. "required": true
  5416. }
  5417. ],
  5418. "responses": {
  5419. "204": {
  5420. "$ref": "#/responses/empty"
  5421. },
  5422. "403": {
  5423. "$ref": "#/responses/forbidden"
  5424. },
  5425. "422": {
  5426. "$ref": "#/responses/validationError"
  5427. }
  5428. }
  5429. }
  5430. },
  5431. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  5432. "get": {
  5433. "consumes": [
  5434. "application/json"
  5435. ],
  5436. "produces": [
  5437. "application/json"
  5438. ],
  5439. "tags": [
  5440. "issue"
  5441. ],
  5442. "summary": "Get a list reactions of an issue",
  5443. "operationId": "issueGetIssueReactions",
  5444. "parameters": [
  5445. {
  5446. "type": "string",
  5447. "description": "owner of the repo",
  5448. "name": "owner",
  5449. "in": "path",
  5450. "required": true
  5451. },
  5452. {
  5453. "type": "string",
  5454. "description": "name of the repo",
  5455. "name": "repo",
  5456. "in": "path",
  5457. "required": true
  5458. },
  5459. {
  5460. "type": "integer",
  5461. "format": "int64",
  5462. "description": "index of the issue",
  5463. "name": "index",
  5464. "in": "path",
  5465. "required": true
  5466. },
  5467. {
  5468. "type": "integer",
  5469. "description": "page number of results to return (1-based)",
  5470. "name": "page",
  5471. "in": "query"
  5472. },
  5473. {
  5474. "type": "integer",
  5475. "description": "page size of results",
  5476. "name": "limit",
  5477. "in": "query"
  5478. }
  5479. ],
  5480. "responses": {
  5481. "200": {
  5482. "$ref": "#/responses/ReactionList"
  5483. },
  5484. "403": {
  5485. "$ref": "#/responses/forbidden"
  5486. }
  5487. }
  5488. },
  5489. "post": {
  5490. "consumes": [
  5491. "application/json"
  5492. ],
  5493. "produces": [
  5494. "application/json"
  5495. ],
  5496. "tags": [
  5497. "issue"
  5498. ],
  5499. "summary": "Add a reaction to an issue",
  5500. "operationId": "issuePostIssueReaction",
  5501. "parameters": [
  5502. {
  5503. "type": "string",
  5504. "description": "owner of the repo",
  5505. "name": "owner",
  5506. "in": "path",
  5507. "required": true
  5508. },
  5509. {
  5510. "type": "string",
  5511. "description": "name of the repo",
  5512. "name": "repo",
  5513. "in": "path",
  5514. "required": true
  5515. },
  5516. {
  5517. "type": "integer",
  5518. "format": "int64",
  5519. "description": "index of the issue",
  5520. "name": "index",
  5521. "in": "path",
  5522. "required": true
  5523. },
  5524. {
  5525. "name": "content",
  5526. "in": "body",
  5527. "schema": {
  5528. "$ref": "#/definitions/EditReactionOption"
  5529. }
  5530. }
  5531. ],
  5532. "responses": {
  5533. "200": {
  5534. "$ref": "#/responses/Reaction"
  5535. },
  5536. "201": {
  5537. "$ref": "#/responses/Reaction"
  5538. },
  5539. "403": {
  5540. "$ref": "#/responses/forbidden"
  5541. }
  5542. }
  5543. },
  5544. "delete": {
  5545. "consumes": [
  5546. "application/json"
  5547. ],
  5548. "produces": [
  5549. "application/json"
  5550. ],
  5551. "tags": [
  5552. "issue"
  5553. ],
  5554. "summary": "Remove a reaction from an issue",
  5555. "operationId": "issueDeleteIssueReaction",
  5556. "parameters": [
  5557. {
  5558. "type": "string",
  5559. "description": "owner of the repo",
  5560. "name": "owner",
  5561. "in": "path",
  5562. "required": true
  5563. },
  5564. {
  5565. "type": "string",
  5566. "description": "name of the repo",
  5567. "name": "repo",
  5568. "in": "path",
  5569. "required": true
  5570. },
  5571. {
  5572. "type": "integer",
  5573. "format": "int64",
  5574. "description": "index of the issue",
  5575. "name": "index",
  5576. "in": "path",
  5577. "required": true
  5578. },
  5579. {
  5580. "name": "content",
  5581. "in": "body",
  5582. "schema": {
  5583. "$ref": "#/definitions/EditReactionOption"
  5584. }
  5585. }
  5586. ],
  5587. "responses": {
  5588. "200": {
  5589. "$ref": "#/responses/empty"
  5590. },
  5591. "403": {
  5592. "$ref": "#/responses/forbidden"
  5593. }
  5594. }
  5595. }
  5596. },
  5597. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  5598. "delete": {
  5599. "consumes": [
  5600. "application/json"
  5601. ],
  5602. "produces": [
  5603. "application/json"
  5604. ],
  5605. "tags": [
  5606. "issue"
  5607. ],
  5608. "summary": "Delete an issue's existing stopwatch.",
  5609. "operationId": "issueDeleteStopWatch",
  5610. "parameters": [
  5611. {
  5612. "type": "string",
  5613. "description": "owner of the repo",
  5614. "name": "owner",
  5615. "in": "path",
  5616. "required": true
  5617. },
  5618. {
  5619. "type": "string",
  5620. "description": "name of the repo",
  5621. "name": "repo",
  5622. "in": "path",
  5623. "required": true
  5624. },
  5625. {
  5626. "type": "integer",
  5627. "format": "int64",
  5628. "description": "index of the issue to stop the stopwatch on",
  5629. "name": "index",
  5630. "in": "path",
  5631. "required": true
  5632. }
  5633. ],
  5634. "responses": {
  5635. "204": {
  5636. "$ref": "#/responses/empty"
  5637. },
  5638. "403": {
  5639. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5640. },
  5641. "404": {
  5642. "$ref": "#/responses/notFound"
  5643. },
  5644. "409": {
  5645. "description": "Cannot cancel a non existent stopwatch"
  5646. }
  5647. }
  5648. }
  5649. },
  5650. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  5651. "post": {
  5652. "consumes": [
  5653. "application/json"
  5654. ],
  5655. "produces": [
  5656. "application/json"
  5657. ],
  5658. "tags": [
  5659. "issue"
  5660. ],
  5661. "summary": "Start stopwatch on an issue.",
  5662. "operationId": "issueStartStopWatch",
  5663. "parameters": [
  5664. {
  5665. "type": "string",
  5666. "description": "owner of the repo",
  5667. "name": "owner",
  5668. "in": "path",
  5669. "required": true
  5670. },
  5671. {
  5672. "type": "string",
  5673. "description": "name of the repo",
  5674. "name": "repo",
  5675. "in": "path",
  5676. "required": true
  5677. },
  5678. {
  5679. "type": "integer",
  5680. "format": "int64",
  5681. "description": "index of the issue to create the stopwatch on",
  5682. "name": "index",
  5683. "in": "path",
  5684. "required": true
  5685. }
  5686. ],
  5687. "responses": {
  5688. "201": {
  5689. "$ref": "#/responses/empty"
  5690. },
  5691. "403": {
  5692. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5693. },
  5694. "404": {
  5695. "$ref": "#/responses/notFound"
  5696. },
  5697. "409": {
  5698. "description": "Cannot start a stopwatch again if it already exists"
  5699. }
  5700. }
  5701. }
  5702. },
  5703. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  5704. "post": {
  5705. "consumes": [
  5706. "application/json"
  5707. ],
  5708. "produces": [
  5709. "application/json"
  5710. ],
  5711. "tags": [
  5712. "issue"
  5713. ],
  5714. "summary": "Stop an issue's existing stopwatch.",
  5715. "operationId": "issueStopStopWatch",
  5716. "parameters": [
  5717. {
  5718. "type": "string",
  5719. "description": "owner of the repo",
  5720. "name": "owner",
  5721. "in": "path",
  5722. "required": true
  5723. },
  5724. {
  5725. "type": "string",
  5726. "description": "name of the repo",
  5727. "name": "repo",
  5728. "in": "path",
  5729. "required": true
  5730. },
  5731. {
  5732. "type": "integer",
  5733. "format": "int64",
  5734. "description": "index of the issue to stop the stopwatch on",
  5735. "name": "index",
  5736. "in": "path",
  5737. "required": true
  5738. }
  5739. ],
  5740. "responses": {
  5741. "201": {
  5742. "$ref": "#/responses/empty"
  5743. },
  5744. "403": {
  5745. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5746. },
  5747. "404": {
  5748. "$ref": "#/responses/notFound"
  5749. },
  5750. "409": {
  5751. "description": "Cannot stop a non existent stopwatch"
  5752. }
  5753. }
  5754. }
  5755. },
  5756. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  5757. "get": {
  5758. "consumes": [
  5759. "application/json"
  5760. ],
  5761. "produces": [
  5762. "application/json"
  5763. ],
  5764. "tags": [
  5765. "issue"
  5766. ],
  5767. "summary": "Get users who subscribed on an issue.",
  5768. "operationId": "issueSubscriptions",
  5769. "parameters": [
  5770. {
  5771. "type": "string",
  5772. "description": "owner of the repo",
  5773. "name": "owner",
  5774. "in": "path",
  5775. "required": true
  5776. },
  5777. {
  5778. "type": "string",
  5779. "description": "name of the repo",
  5780. "name": "repo",
  5781. "in": "path",
  5782. "required": true
  5783. },
  5784. {
  5785. "type": "integer",
  5786. "format": "int64",
  5787. "description": "index of the issue",
  5788. "name": "index",
  5789. "in": "path",
  5790. "required": true
  5791. },
  5792. {
  5793. "type": "integer",
  5794. "description": "page number of results to return (1-based)",
  5795. "name": "page",
  5796. "in": "query"
  5797. },
  5798. {
  5799. "type": "integer",
  5800. "description": "page size of results",
  5801. "name": "limit",
  5802. "in": "query"
  5803. }
  5804. ],
  5805. "responses": {
  5806. "200": {
  5807. "$ref": "#/responses/UserList"
  5808. },
  5809. "404": {
  5810. "$ref": "#/responses/notFound"
  5811. }
  5812. }
  5813. }
  5814. },
  5815. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  5816. "get": {
  5817. "consumes": [
  5818. "application/json"
  5819. ],
  5820. "produces": [
  5821. "application/json"
  5822. ],
  5823. "tags": [
  5824. "issue"
  5825. ],
  5826. "summary": "Check if user is subscribed to an issue",
  5827. "operationId": "issueCheckSubscription",
  5828. "parameters": [
  5829. {
  5830. "type": "string",
  5831. "description": "owner of the repo",
  5832. "name": "owner",
  5833. "in": "path",
  5834. "required": true
  5835. },
  5836. {
  5837. "type": "string",
  5838. "description": "name of the repo",
  5839. "name": "repo",
  5840. "in": "path",
  5841. "required": true
  5842. },
  5843. {
  5844. "type": "integer",
  5845. "format": "int64",
  5846. "description": "index of the issue",
  5847. "name": "index",
  5848. "in": "path",
  5849. "required": true
  5850. }
  5851. ],
  5852. "responses": {
  5853. "200": {
  5854. "$ref": "#/responses/WatchInfo"
  5855. },
  5856. "404": {
  5857. "$ref": "#/responses/notFound"
  5858. }
  5859. }
  5860. }
  5861. },
  5862. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  5863. "put": {
  5864. "consumes": [
  5865. "application/json"
  5866. ],
  5867. "produces": [
  5868. "application/json"
  5869. ],
  5870. "tags": [
  5871. "issue"
  5872. ],
  5873. "summary": "Subscribe user to issue",
  5874. "operationId": "issueAddSubscription",
  5875. "parameters": [
  5876. {
  5877. "type": "string",
  5878. "description": "owner of the repo",
  5879. "name": "owner",
  5880. "in": "path",
  5881. "required": true
  5882. },
  5883. {
  5884. "type": "string",
  5885. "description": "name of the repo",
  5886. "name": "repo",
  5887. "in": "path",
  5888. "required": true
  5889. },
  5890. {
  5891. "type": "integer",
  5892. "format": "int64",
  5893. "description": "index of the issue",
  5894. "name": "index",
  5895. "in": "path",
  5896. "required": true
  5897. },
  5898. {
  5899. "type": "string",
  5900. "description": "user to subscribe",
  5901. "name": "user",
  5902. "in": "path",
  5903. "required": true
  5904. }
  5905. ],
  5906. "responses": {
  5907. "200": {
  5908. "description": "Already subscribed"
  5909. },
  5910. "201": {
  5911. "description": "Successfully Subscribed"
  5912. },
  5913. "304": {
  5914. "description": "User can only subscribe itself if he is no admin"
  5915. },
  5916. "404": {
  5917. "$ref": "#/responses/notFound"
  5918. }
  5919. }
  5920. },
  5921. "delete": {
  5922. "consumes": [
  5923. "application/json"
  5924. ],
  5925. "produces": [
  5926. "application/json"
  5927. ],
  5928. "tags": [
  5929. "issue"
  5930. ],
  5931. "summary": "Unsubscribe user from issue",
  5932. "operationId": "issueDeleteSubscription",
  5933. "parameters": [
  5934. {
  5935. "type": "string",
  5936. "description": "owner of the repo",
  5937. "name": "owner",
  5938. "in": "path",
  5939. "required": true
  5940. },
  5941. {
  5942. "type": "string",
  5943. "description": "name of the repo",
  5944. "name": "repo",
  5945. "in": "path",
  5946. "required": true
  5947. },
  5948. {
  5949. "type": "integer",
  5950. "format": "int64",
  5951. "description": "index of the issue",
  5952. "name": "index",
  5953. "in": "path",
  5954. "required": true
  5955. },
  5956. {
  5957. "type": "string",
  5958. "description": "user witch unsubscribe",
  5959. "name": "user",
  5960. "in": "path",
  5961. "required": true
  5962. }
  5963. ],
  5964. "responses": {
  5965. "200": {
  5966. "description": "Already unsubscribed"
  5967. },
  5968. "201": {
  5969. "description": "Successfully Unsubscribed"
  5970. },
  5971. "304": {
  5972. "description": "User can only subscribe itself if he is no admin"
  5973. },
  5974. "404": {
  5975. "$ref": "#/responses/notFound"
  5976. }
  5977. }
  5978. }
  5979. },
  5980. "/repos/{owner}/{repo}/issues/{index}/times": {
  5981. "get": {
  5982. "produces": [
  5983. "application/json"
  5984. ],
  5985. "tags": [
  5986. "issue"
  5987. ],
  5988. "summary": "List an issue's tracked times",
  5989. "operationId": "issueTrackedTimes",
  5990. "parameters": [
  5991. {
  5992. "type": "string",
  5993. "description": "owner of the repo",
  5994. "name": "owner",
  5995. "in": "path",
  5996. "required": true
  5997. },
  5998. {
  5999. "type": "string",
  6000. "description": "name of the repo",
  6001. "name": "repo",
  6002. "in": "path",
  6003. "required": true
  6004. },
  6005. {
  6006. "type": "integer",
  6007. "format": "int64",
  6008. "description": "index of the issue",
  6009. "name": "index",
  6010. "in": "path",
  6011. "required": true
  6012. },
  6013. {
  6014. "type": "string",
  6015. "description": "optional filter by user (available for issue managers)",
  6016. "name": "user",
  6017. "in": "query"
  6018. },
  6019. {
  6020. "type": "string",
  6021. "format": "date-time",
  6022. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  6023. "name": "since",
  6024. "in": "query"
  6025. },
  6026. {
  6027. "type": "string",
  6028. "format": "date-time",
  6029. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  6030. "name": "before",
  6031. "in": "query"
  6032. },
  6033. {
  6034. "type": "integer",
  6035. "description": "page number of results to return (1-based)",
  6036. "name": "page",
  6037. "in": "query"
  6038. },
  6039. {
  6040. "type": "integer",
  6041. "description": "page size of results",
  6042. "name": "limit",
  6043. "in": "query"
  6044. }
  6045. ],
  6046. "responses": {
  6047. "200": {
  6048. "$ref": "#/responses/TrackedTimeList"
  6049. },
  6050. "404": {
  6051. "$ref": "#/responses/notFound"
  6052. }
  6053. }
  6054. },
  6055. "post": {
  6056. "consumes": [
  6057. "application/json"
  6058. ],
  6059. "produces": [
  6060. "application/json"
  6061. ],
  6062. "tags": [
  6063. "issue"
  6064. ],
  6065. "summary": "Add tracked time to a issue",
  6066. "operationId": "issueAddTime",
  6067. "parameters": [
  6068. {
  6069. "type": "string",
  6070. "description": "owner of the repo",
  6071. "name": "owner",
  6072. "in": "path",
  6073. "required": true
  6074. },
  6075. {
  6076. "type": "string",
  6077. "description": "name of the repo",
  6078. "name": "repo",
  6079. "in": "path",
  6080. "required": true
  6081. },
  6082. {
  6083. "type": "integer",
  6084. "format": "int64",
  6085. "description": "index of the issue",
  6086. "name": "index",
  6087. "in": "path",
  6088. "required": true
  6089. },
  6090. {
  6091. "name": "body",
  6092. "in": "body",
  6093. "schema": {
  6094. "$ref": "#/definitions/AddTimeOption"
  6095. }
  6096. }
  6097. ],
  6098. "responses": {
  6099. "200": {
  6100. "$ref": "#/responses/TrackedTime"
  6101. },
  6102. "400": {
  6103. "$ref": "#/responses/error"
  6104. },
  6105. "403": {
  6106. "$ref": "#/responses/forbidden"
  6107. }
  6108. }
  6109. },
  6110. "delete": {
  6111. "consumes": [
  6112. "application/json"
  6113. ],
  6114. "produces": [
  6115. "application/json"
  6116. ],
  6117. "tags": [
  6118. "issue"
  6119. ],
  6120. "summary": "Reset a tracked time of an issue",
  6121. "operationId": "issueResetTime",
  6122. "parameters": [
  6123. {
  6124. "type": "string",
  6125. "description": "owner of the repo",
  6126. "name": "owner",
  6127. "in": "path",
  6128. "required": true
  6129. },
  6130. {
  6131. "type": "string",
  6132. "description": "name of the repo",
  6133. "name": "repo",
  6134. "in": "path",
  6135. "required": true
  6136. },
  6137. {
  6138. "type": "integer",
  6139. "format": "int64",
  6140. "description": "index of the issue to add tracked time to",
  6141. "name": "index",
  6142. "in": "path",
  6143. "required": true
  6144. }
  6145. ],
  6146. "responses": {
  6147. "204": {
  6148. "$ref": "#/responses/empty"
  6149. },
  6150. "400": {
  6151. "$ref": "#/responses/error"
  6152. },
  6153. "403": {
  6154. "$ref": "#/responses/forbidden"
  6155. }
  6156. }
  6157. }
  6158. },
  6159. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  6160. "delete": {
  6161. "consumes": [
  6162. "application/json"
  6163. ],
  6164. "produces": [
  6165. "application/json"
  6166. ],
  6167. "tags": [
  6168. "issue"
  6169. ],
  6170. "summary": "Delete specific tracked time",
  6171. "operationId": "issueDeleteTime",
  6172. "parameters": [
  6173. {
  6174. "type": "string",
  6175. "description": "owner of the repo",
  6176. "name": "owner",
  6177. "in": "path",
  6178. "required": true
  6179. },
  6180. {
  6181. "type": "string",
  6182. "description": "name of the repo",
  6183. "name": "repo",
  6184. "in": "path",
  6185. "required": true
  6186. },
  6187. {
  6188. "type": "integer",
  6189. "format": "int64",
  6190. "description": "index of the issue",
  6191. "name": "index",
  6192. "in": "path",
  6193. "required": true
  6194. },
  6195. {
  6196. "type": "integer",
  6197. "format": "int64",
  6198. "description": "id of time to delete",
  6199. "name": "id",
  6200. "in": "path",
  6201. "required": true
  6202. }
  6203. ],
  6204. "responses": {
  6205. "204": {
  6206. "$ref": "#/responses/empty"
  6207. },
  6208. "400": {
  6209. "$ref": "#/responses/error"
  6210. },
  6211. "403": {
  6212. "$ref": "#/responses/forbidden"
  6213. }
  6214. }
  6215. }
  6216. },
  6217. "/repos/{owner}/{repo}/keys": {
  6218. "get": {
  6219. "produces": [
  6220. "application/json"
  6221. ],
  6222. "tags": [
  6223. "repository"
  6224. ],
  6225. "summary": "List a repository's keys",
  6226. "operationId": "repoListKeys",
  6227. "parameters": [
  6228. {
  6229. "type": "string",
  6230. "description": "owner of the repo",
  6231. "name": "owner",
  6232. "in": "path",
  6233. "required": true
  6234. },
  6235. {
  6236. "type": "string",
  6237. "description": "name of the repo",
  6238. "name": "repo",
  6239. "in": "path",
  6240. "required": true
  6241. },
  6242. {
  6243. "type": "integer",
  6244. "description": "the key_id to search for",
  6245. "name": "key_id",
  6246. "in": "query"
  6247. },
  6248. {
  6249. "type": "string",
  6250. "description": "fingerprint of the key",
  6251. "name": "fingerprint",
  6252. "in": "query"
  6253. },
  6254. {
  6255. "type": "integer",
  6256. "description": "page number of results to return (1-based)",
  6257. "name": "page",
  6258. "in": "query"
  6259. },
  6260. {
  6261. "type": "integer",
  6262. "description": "page size of results",
  6263. "name": "limit",
  6264. "in": "query"
  6265. }
  6266. ],
  6267. "responses": {
  6268. "200": {
  6269. "$ref": "#/responses/DeployKeyList"
  6270. }
  6271. }
  6272. },
  6273. "post": {
  6274. "consumes": [
  6275. "application/json"
  6276. ],
  6277. "produces": [
  6278. "application/json"
  6279. ],
  6280. "tags": [
  6281. "repository"
  6282. ],
  6283. "summary": "Add a key to a repository",
  6284. "operationId": "repoCreateKey",
  6285. "parameters": [
  6286. {
  6287. "type": "string",
  6288. "description": "owner of the repo",
  6289. "name": "owner",
  6290. "in": "path",
  6291. "required": true
  6292. },
  6293. {
  6294. "type": "string",
  6295. "description": "name of the repo",
  6296. "name": "repo",
  6297. "in": "path",
  6298. "required": true
  6299. },
  6300. {
  6301. "name": "body",
  6302. "in": "body",
  6303. "schema": {
  6304. "$ref": "#/definitions/CreateKeyOption"
  6305. }
  6306. }
  6307. ],
  6308. "responses": {
  6309. "201": {
  6310. "$ref": "#/responses/DeployKey"
  6311. },
  6312. "422": {
  6313. "$ref": "#/responses/validationError"
  6314. }
  6315. }
  6316. }
  6317. },
  6318. "/repos/{owner}/{repo}/keys/{id}": {
  6319. "get": {
  6320. "produces": [
  6321. "application/json"
  6322. ],
  6323. "tags": [
  6324. "repository"
  6325. ],
  6326. "summary": "Get a repository's key by id",
  6327. "operationId": "repoGetKey",
  6328. "parameters": [
  6329. {
  6330. "type": "string",
  6331. "description": "owner of the repo",
  6332. "name": "owner",
  6333. "in": "path",
  6334. "required": true
  6335. },
  6336. {
  6337. "type": "string",
  6338. "description": "name of the repo",
  6339. "name": "repo",
  6340. "in": "path",
  6341. "required": true
  6342. },
  6343. {
  6344. "type": "integer",
  6345. "format": "int64",
  6346. "description": "id of the key to get",
  6347. "name": "id",
  6348. "in": "path",
  6349. "required": true
  6350. }
  6351. ],
  6352. "responses": {
  6353. "200": {
  6354. "$ref": "#/responses/DeployKey"
  6355. }
  6356. }
  6357. },
  6358. "delete": {
  6359. "tags": [
  6360. "repository"
  6361. ],
  6362. "summary": "Delete a key from a repository",
  6363. "operationId": "repoDeleteKey",
  6364. "parameters": [
  6365. {
  6366. "type": "string",
  6367. "description": "owner of the repo",
  6368. "name": "owner",
  6369. "in": "path",
  6370. "required": true
  6371. },
  6372. {
  6373. "type": "string",
  6374. "description": "name of the repo",
  6375. "name": "repo",
  6376. "in": "path",
  6377. "required": true
  6378. },
  6379. {
  6380. "type": "integer",
  6381. "format": "int64",
  6382. "description": "id of the key to delete",
  6383. "name": "id",
  6384. "in": "path",
  6385. "required": true
  6386. }
  6387. ],
  6388. "responses": {
  6389. "204": {
  6390. "$ref": "#/responses/empty"
  6391. },
  6392. "403": {
  6393. "$ref": "#/responses/forbidden"
  6394. }
  6395. }
  6396. }
  6397. },
  6398. "/repos/{owner}/{repo}/labels": {
  6399. "get": {
  6400. "produces": [
  6401. "application/json"
  6402. ],
  6403. "tags": [
  6404. "issue"
  6405. ],
  6406. "summary": "Get all of a repository's labels",
  6407. "operationId": "issueListLabels",
  6408. "parameters": [
  6409. {
  6410. "type": "string",
  6411. "description": "owner of the repo",
  6412. "name": "owner",
  6413. "in": "path",
  6414. "required": true
  6415. },
  6416. {
  6417. "type": "string",
  6418. "description": "name of the repo",
  6419. "name": "repo",
  6420. "in": "path",
  6421. "required": true
  6422. },
  6423. {
  6424. "type": "integer",
  6425. "description": "page number of results to return (1-based)",
  6426. "name": "page",
  6427. "in": "query"
  6428. },
  6429. {
  6430. "type": "integer",
  6431. "description": "page size of results",
  6432. "name": "limit",
  6433. "in": "query"
  6434. }
  6435. ],
  6436. "responses": {
  6437. "200": {
  6438. "$ref": "#/responses/LabelList"
  6439. }
  6440. }
  6441. },
  6442. "post": {
  6443. "consumes": [
  6444. "application/json"
  6445. ],
  6446. "produces": [
  6447. "application/json"
  6448. ],
  6449. "tags": [
  6450. "issue"
  6451. ],
  6452. "summary": "Create a label",
  6453. "operationId": "issueCreateLabel",
  6454. "parameters": [
  6455. {
  6456. "type": "string",
  6457. "description": "owner of the repo",
  6458. "name": "owner",
  6459. "in": "path",
  6460. "required": true
  6461. },
  6462. {
  6463. "type": "string",
  6464. "description": "name of the repo",
  6465. "name": "repo",
  6466. "in": "path",
  6467. "required": true
  6468. },
  6469. {
  6470. "name": "body",
  6471. "in": "body",
  6472. "schema": {
  6473. "$ref": "#/definitions/CreateLabelOption"
  6474. }
  6475. }
  6476. ],
  6477. "responses": {
  6478. "201": {
  6479. "$ref": "#/responses/Label"
  6480. },
  6481. "422": {
  6482. "$ref": "#/responses/validationError"
  6483. }
  6484. }
  6485. }
  6486. },
  6487. "/repos/{owner}/{repo}/labels/{id}": {
  6488. "get": {
  6489. "produces": [
  6490. "application/json"
  6491. ],
  6492. "tags": [
  6493. "issue"
  6494. ],
  6495. "summary": "Get a single label",
  6496. "operationId": "issueGetLabel",
  6497. "parameters": [
  6498. {
  6499. "type": "string",
  6500. "description": "owner of the repo",
  6501. "name": "owner",
  6502. "in": "path",
  6503. "required": true
  6504. },
  6505. {
  6506. "type": "string",
  6507. "description": "name of the repo",
  6508. "name": "repo",
  6509. "in": "path",
  6510. "required": true
  6511. },
  6512. {
  6513. "type": "integer",
  6514. "format": "int64",
  6515. "description": "id of the label to get",
  6516. "name": "id",
  6517. "in": "path",
  6518. "required": true
  6519. }
  6520. ],
  6521. "responses": {
  6522. "200": {
  6523. "$ref": "#/responses/Label"
  6524. }
  6525. }
  6526. },
  6527. "delete": {
  6528. "tags": [
  6529. "issue"
  6530. ],
  6531. "summary": "Delete a label",
  6532. "operationId": "issueDeleteLabel",
  6533. "parameters": [
  6534. {
  6535. "type": "string",
  6536. "description": "owner of the repo",
  6537. "name": "owner",
  6538. "in": "path",
  6539. "required": true
  6540. },
  6541. {
  6542. "type": "string",
  6543. "description": "name of the repo",
  6544. "name": "repo",
  6545. "in": "path",
  6546. "required": true
  6547. },
  6548. {
  6549. "type": "integer",
  6550. "format": "int64",
  6551. "description": "id of the label to delete",
  6552. "name": "id",
  6553. "in": "path",
  6554. "required": true
  6555. }
  6556. ],
  6557. "responses": {
  6558. "204": {
  6559. "$ref": "#/responses/empty"
  6560. }
  6561. }
  6562. },
  6563. "patch": {
  6564. "consumes": [
  6565. "application/json"
  6566. ],
  6567. "produces": [
  6568. "application/json"
  6569. ],
  6570. "tags": [
  6571. "issue"
  6572. ],
  6573. "summary": "Update a label",
  6574. "operationId": "issueEditLabel",
  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. "type": "integer",
  6592. "format": "int64",
  6593. "description": "id of the label to edit",
  6594. "name": "id",
  6595. "in": "path",
  6596. "required": true
  6597. },
  6598. {
  6599. "name": "body",
  6600. "in": "body",
  6601. "schema": {
  6602. "$ref": "#/definitions/EditLabelOption"
  6603. }
  6604. }
  6605. ],
  6606. "responses": {
  6607. "200": {
  6608. "$ref": "#/responses/Label"
  6609. },
  6610. "422": {
  6611. "$ref": "#/responses/validationError"
  6612. }
  6613. }
  6614. }
  6615. },
  6616. "/repos/{owner}/{repo}/languages": {
  6617. "get": {
  6618. "produces": [
  6619. "application/json"
  6620. ],
  6621. "tags": [
  6622. "repository"
  6623. ],
  6624. "summary": "Get languages and number of bytes of code written",
  6625. "operationId": "repoGetLanguages",
  6626. "parameters": [
  6627. {
  6628. "type": "string",
  6629. "description": "owner of the repo",
  6630. "name": "owner",
  6631. "in": "path",
  6632. "required": true
  6633. },
  6634. {
  6635. "type": "string",
  6636. "description": "name of the repo",
  6637. "name": "repo",
  6638. "in": "path",
  6639. "required": true
  6640. }
  6641. ],
  6642. "responses": {
  6643. "200": {
  6644. "$ref": "#/responses/LanguageStatistics"
  6645. },
  6646. "404": {
  6647. "$ref": "#/responses/notFound"
  6648. }
  6649. }
  6650. }
  6651. },
  6652. "/repos/{owner}/{repo}/milestones": {
  6653. "get": {
  6654. "produces": [
  6655. "application/json"
  6656. ],
  6657. "tags": [
  6658. "issue"
  6659. ],
  6660. "summary": "Get all of a repository's opened milestones",
  6661. "operationId": "issueGetMilestonesList",
  6662. "parameters": [
  6663. {
  6664. "type": "string",
  6665. "description": "owner of the repo",
  6666. "name": "owner",
  6667. "in": "path",
  6668. "required": true
  6669. },
  6670. {
  6671. "type": "string",
  6672. "description": "name of the repo",
  6673. "name": "repo",
  6674. "in": "path",
  6675. "required": true
  6676. },
  6677. {
  6678. "type": "string",
  6679. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  6680. "name": "state",
  6681. "in": "query"
  6682. },
  6683. {
  6684. "type": "string",
  6685. "description": "filter by milestone name",
  6686. "name": "name",
  6687. "in": "query"
  6688. },
  6689. {
  6690. "type": "integer",
  6691. "description": "page number of results to return (1-based)",
  6692. "name": "page",
  6693. "in": "query"
  6694. },
  6695. {
  6696. "type": "integer",
  6697. "description": "page size of results",
  6698. "name": "limit",
  6699. "in": "query"
  6700. }
  6701. ],
  6702. "responses": {
  6703. "200": {
  6704. "$ref": "#/responses/MilestoneList"
  6705. }
  6706. }
  6707. },
  6708. "post": {
  6709. "consumes": [
  6710. "application/json"
  6711. ],
  6712. "produces": [
  6713. "application/json"
  6714. ],
  6715. "tags": [
  6716. "issue"
  6717. ],
  6718. "summary": "Create a milestone",
  6719. "operationId": "issueCreateMilestone",
  6720. "parameters": [
  6721. {
  6722. "type": "string",
  6723. "description": "owner of the repo",
  6724. "name": "owner",
  6725. "in": "path",
  6726. "required": true
  6727. },
  6728. {
  6729. "type": "string",
  6730. "description": "name of the repo",
  6731. "name": "repo",
  6732. "in": "path",
  6733. "required": true
  6734. },
  6735. {
  6736. "name": "body",
  6737. "in": "body",
  6738. "schema": {
  6739. "$ref": "#/definitions/CreateMilestoneOption"
  6740. }
  6741. }
  6742. ],
  6743. "responses": {
  6744. "201": {
  6745. "$ref": "#/responses/Milestone"
  6746. }
  6747. }
  6748. }
  6749. },
  6750. "/repos/{owner}/{repo}/milestones/{id}": {
  6751. "get": {
  6752. "produces": [
  6753. "application/json"
  6754. ],
  6755. "tags": [
  6756. "issue"
  6757. ],
  6758. "summary": "Get a milestone",
  6759. "operationId": "issueGetMilestone",
  6760. "parameters": [
  6761. {
  6762. "type": "string",
  6763. "description": "owner of the repo",
  6764. "name": "owner",
  6765. "in": "path",
  6766. "required": true
  6767. },
  6768. {
  6769. "type": "string",
  6770. "description": "name of the repo",
  6771. "name": "repo",
  6772. "in": "path",
  6773. "required": true
  6774. },
  6775. {
  6776. "type": "string",
  6777. "description": "the milestone to get, identified by ID and if not available by name",
  6778. "name": "id",
  6779. "in": "path",
  6780. "required": true
  6781. }
  6782. ],
  6783. "responses": {
  6784. "200": {
  6785. "$ref": "#/responses/Milestone"
  6786. }
  6787. }
  6788. },
  6789. "delete": {
  6790. "tags": [
  6791. "issue"
  6792. ],
  6793. "summary": "Delete a milestone",
  6794. "operationId": "issueDeleteMilestone",
  6795. "parameters": [
  6796. {
  6797. "type": "string",
  6798. "description": "owner of the repo",
  6799. "name": "owner",
  6800. "in": "path",
  6801. "required": true
  6802. },
  6803. {
  6804. "type": "string",
  6805. "description": "name of the repo",
  6806. "name": "repo",
  6807. "in": "path",
  6808. "required": true
  6809. },
  6810. {
  6811. "type": "string",
  6812. "description": "the milestone to delete, identified by ID and if not available by name",
  6813. "name": "id",
  6814. "in": "path",
  6815. "required": true
  6816. }
  6817. ],
  6818. "responses": {
  6819. "204": {
  6820. "$ref": "#/responses/empty"
  6821. }
  6822. }
  6823. },
  6824. "patch": {
  6825. "consumes": [
  6826. "application/json"
  6827. ],
  6828. "produces": [
  6829. "application/json"
  6830. ],
  6831. "tags": [
  6832. "issue"
  6833. ],
  6834. "summary": "Update a milestone",
  6835. "operationId": "issueEditMilestone",
  6836. "parameters": [
  6837. {
  6838. "type": "string",
  6839. "description": "owner of the repo",
  6840. "name": "owner",
  6841. "in": "path",
  6842. "required": true
  6843. },
  6844. {
  6845. "type": "string",
  6846. "description": "name of the repo",
  6847. "name": "repo",
  6848. "in": "path",
  6849. "required": true
  6850. },
  6851. {
  6852. "type": "string",
  6853. "description": "the milestone to edit, identified by ID and if not available by name",
  6854. "name": "id",
  6855. "in": "path",
  6856. "required": true
  6857. },
  6858. {
  6859. "name": "body",
  6860. "in": "body",
  6861. "schema": {
  6862. "$ref": "#/definitions/EditMilestoneOption"
  6863. }
  6864. }
  6865. ],
  6866. "responses": {
  6867. "200": {
  6868. "$ref": "#/responses/Milestone"
  6869. }
  6870. }
  6871. }
  6872. },
  6873. "/repos/{owner}/{repo}/mirror-sync": {
  6874. "post": {
  6875. "produces": [
  6876. "application/json"
  6877. ],
  6878. "tags": [
  6879. "repository"
  6880. ],
  6881. "summary": "Sync a mirrored repository",
  6882. "operationId": "repoMirrorSync",
  6883. "parameters": [
  6884. {
  6885. "type": "string",
  6886. "description": "owner of the repo to sync",
  6887. "name": "owner",
  6888. "in": "path",
  6889. "required": true
  6890. },
  6891. {
  6892. "type": "string",
  6893. "description": "name of the repo to sync",
  6894. "name": "repo",
  6895. "in": "path",
  6896. "required": true
  6897. }
  6898. ],
  6899. "responses": {
  6900. "200": {
  6901. "$ref": "#/responses/empty"
  6902. },
  6903. "403": {
  6904. "$ref": "#/responses/forbidden"
  6905. }
  6906. }
  6907. }
  6908. },
  6909. "/repos/{owner}/{repo}/notifications": {
  6910. "get": {
  6911. "consumes": [
  6912. "application/json"
  6913. ],
  6914. "produces": [
  6915. "application/json"
  6916. ],
  6917. "tags": [
  6918. "notification"
  6919. ],
  6920. "summary": "List users's notification threads on a specific repo",
  6921. "operationId": "notifyGetRepoList",
  6922. "parameters": [
  6923. {
  6924. "type": "string",
  6925. "description": "owner of the repo",
  6926. "name": "owner",
  6927. "in": "path",
  6928. "required": true
  6929. },
  6930. {
  6931. "type": "string",
  6932. "description": "name of the repo",
  6933. "name": "repo",
  6934. "in": "path",
  6935. "required": true
  6936. },
  6937. {
  6938. "type": "boolean",
  6939. "description": "If true, show notifications marked as read. Default value is false",
  6940. "name": "all",
  6941. "in": "query"
  6942. },
  6943. {
  6944. "type": "array",
  6945. "items": {
  6946. "type": "string"
  6947. },
  6948. "collectionFormat": "multi",
  6949. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  6950. "name": "status-types",
  6951. "in": "query"
  6952. },
  6953. {
  6954. "type": "array",
  6955. "items": {
  6956. "enum": [
  6957. "issue",
  6958. "pull",
  6959. "commit",
  6960. "repository"
  6961. ],
  6962. "type": "string"
  6963. },
  6964. "collectionFormat": "multi",
  6965. "description": "filter notifications by subject type",
  6966. "name": "subject-type",
  6967. "in": "query"
  6968. },
  6969. {
  6970. "type": "string",
  6971. "format": "date-time",
  6972. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  6973. "name": "since",
  6974. "in": "query"
  6975. },
  6976. {
  6977. "type": "string",
  6978. "format": "date-time",
  6979. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  6980. "name": "before",
  6981. "in": "query"
  6982. },
  6983. {
  6984. "type": "integer",
  6985. "description": "page number of results to return (1-based)",
  6986. "name": "page",
  6987. "in": "query"
  6988. },
  6989. {
  6990. "type": "integer",
  6991. "description": "page size of results",
  6992. "name": "limit",
  6993. "in": "query"
  6994. }
  6995. ],
  6996. "responses": {
  6997. "200": {
  6998. "$ref": "#/responses/NotificationThreadList"
  6999. }
  7000. }
  7001. },
  7002. "put": {
  7003. "consumes": [
  7004. "application/json"
  7005. ],
  7006. "produces": [
  7007. "application/json"
  7008. ],
  7009. "tags": [
  7010. "notification"
  7011. ],
  7012. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  7013. "operationId": "notifyReadRepoList",
  7014. "parameters": [
  7015. {
  7016. "type": "string",
  7017. "description": "owner of the repo",
  7018. "name": "owner",
  7019. "in": "path",
  7020. "required": true
  7021. },
  7022. {
  7023. "type": "string",
  7024. "description": "name of the repo",
  7025. "name": "repo",
  7026. "in": "path",
  7027. "required": true
  7028. },
  7029. {
  7030. "type": "string",
  7031. "description": "If true, mark all notifications on this repo. Default value is false",
  7032. "name": "all",
  7033. "in": "query"
  7034. },
  7035. {
  7036. "type": "array",
  7037. "items": {
  7038. "type": "string"
  7039. },
  7040. "collectionFormat": "multi",
  7041. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  7042. "name": "status-types",
  7043. "in": "query"
  7044. },
  7045. {
  7046. "type": "string",
  7047. "description": "Status to mark notifications as. Defaults to read.",
  7048. "name": "to-status",
  7049. "in": "query"
  7050. },
  7051. {
  7052. "type": "string",
  7053. "format": "date-time",
  7054. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  7055. "name": "last_read_at",
  7056. "in": "query"
  7057. }
  7058. ],
  7059. "responses": {
  7060. "205": {
  7061. "$ref": "#/responses/NotificationThreadList"
  7062. }
  7063. }
  7064. }
  7065. },
  7066. "/repos/{owner}/{repo}/pulls": {
  7067. "get": {
  7068. "produces": [
  7069. "application/json"
  7070. ],
  7071. "tags": [
  7072. "repository"
  7073. ],
  7074. "summary": "List a repo's pull requests",
  7075. "operationId": "repoListPullRequests",
  7076. "parameters": [
  7077. {
  7078. "type": "string",
  7079. "description": "owner of the repo",
  7080. "name": "owner",
  7081. "in": "path",
  7082. "required": true
  7083. },
  7084. {
  7085. "type": "string",
  7086. "description": "name of the repo",
  7087. "name": "repo",
  7088. "in": "path",
  7089. "required": true
  7090. },
  7091. {
  7092. "enum": [
  7093. "closed",
  7094. "open",
  7095. "all"
  7096. ],
  7097. "type": "string",
  7098. "description": "State of pull request: open or closed (optional)",
  7099. "name": "state",
  7100. "in": "query"
  7101. },
  7102. {
  7103. "enum": [
  7104. "oldest",
  7105. "recentupdate",
  7106. "leastupdate",
  7107. "mostcomment",
  7108. "leastcomment",
  7109. "priority"
  7110. ],
  7111. "type": "string",
  7112. "description": "Type of sort",
  7113. "name": "sort",
  7114. "in": "query"
  7115. },
  7116. {
  7117. "type": "integer",
  7118. "format": "int64",
  7119. "description": "ID of the milestone",
  7120. "name": "milestone",
  7121. "in": "query"
  7122. },
  7123. {
  7124. "type": "array",
  7125. "items": {
  7126. "type": "integer",
  7127. "format": "int64"
  7128. },
  7129. "collectionFormat": "multi",
  7130. "description": "Label IDs",
  7131. "name": "labels",
  7132. "in": "query"
  7133. },
  7134. {
  7135. "type": "integer",
  7136. "description": "page number of results to return (1-based)",
  7137. "name": "page",
  7138. "in": "query"
  7139. },
  7140. {
  7141. "type": "integer",
  7142. "description": "page size of results",
  7143. "name": "limit",
  7144. "in": "query"
  7145. }
  7146. ],
  7147. "responses": {
  7148. "200": {
  7149. "$ref": "#/responses/PullRequestList"
  7150. }
  7151. }
  7152. },
  7153. "post": {
  7154. "consumes": [
  7155. "application/json"
  7156. ],
  7157. "produces": [
  7158. "application/json"
  7159. ],
  7160. "tags": [
  7161. "repository"
  7162. ],
  7163. "summary": "Create a pull request",
  7164. "operationId": "repoCreatePullRequest",
  7165. "parameters": [
  7166. {
  7167. "type": "string",
  7168. "description": "owner of the repo",
  7169. "name": "owner",
  7170. "in": "path",
  7171. "required": true
  7172. },
  7173. {
  7174. "type": "string",
  7175. "description": "name of the repo",
  7176. "name": "repo",
  7177. "in": "path",
  7178. "required": true
  7179. },
  7180. {
  7181. "name": "body",
  7182. "in": "body",
  7183. "schema": {
  7184. "$ref": "#/definitions/CreatePullRequestOption"
  7185. }
  7186. }
  7187. ],
  7188. "responses": {
  7189. "201": {
  7190. "$ref": "#/responses/PullRequest"
  7191. },
  7192. "409": {
  7193. "$ref": "#/responses/error"
  7194. },
  7195. "422": {
  7196. "$ref": "#/responses/validationError"
  7197. }
  7198. }
  7199. }
  7200. },
  7201. "/repos/{owner}/{repo}/pulls/{index}": {
  7202. "get": {
  7203. "produces": [
  7204. "application/json"
  7205. ],
  7206. "tags": [
  7207. "repository"
  7208. ],
  7209. "summary": "Get a pull request",
  7210. "operationId": "repoGetPullRequest",
  7211. "parameters": [
  7212. {
  7213. "type": "string",
  7214. "description": "owner of the repo",
  7215. "name": "owner",
  7216. "in": "path",
  7217. "required": true
  7218. },
  7219. {
  7220. "type": "string",
  7221. "description": "name of the repo",
  7222. "name": "repo",
  7223. "in": "path",
  7224. "required": true
  7225. },
  7226. {
  7227. "type": "integer",
  7228. "format": "int64",
  7229. "description": "index of the pull request to get",
  7230. "name": "index",
  7231. "in": "path",
  7232. "required": true
  7233. }
  7234. ],
  7235. "responses": {
  7236. "200": {
  7237. "$ref": "#/responses/PullRequest"
  7238. },
  7239. "404": {
  7240. "$ref": "#/responses/notFound"
  7241. }
  7242. }
  7243. },
  7244. "patch": {
  7245. "consumes": [
  7246. "application/json"
  7247. ],
  7248. "produces": [
  7249. "application/json"
  7250. ],
  7251. "tags": [
  7252. "repository"
  7253. ],
  7254. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  7255. "operationId": "repoEditPullRequest",
  7256. "parameters": [
  7257. {
  7258. "type": "string",
  7259. "description": "owner of the repo",
  7260. "name": "owner",
  7261. "in": "path",
  7262. "required": true
  7263. },
  7264. {
  7265. "type": "string",
  7266. "description": "name of the repo",
  7267. "name": "repo",
  7268. "in": "path",
  7269. "required": true
  7270. },
  7271. {
  7272. "type": "integer",
  7273. "format": "int64",
  7274. "description": "index of the pull request to edit",
  7275. "name": "index",
  7276. "in": "path",
  7277. "required": true
  7278. },
  7279. {
  7280. "name": "body",
  7281. "in": "body",
  7282. "schema": {
  7283. "$ref": "#/definitions/EditPullRequestOption"
  7284. }
  7285. }
  7286. ],
  7287. "responses": {
  7288. "201": {
  7289. "$ref": "#/responses/PullRequest"
  7290. },
  7291. "403": {
  7292. "$ref": "#/responses/forbidden"
  7293. },
  7294. "409": {
  7295. "$ref": "#/responses/error"
  7296. },
  7297. "412": {
  7298. "$ref": "#/responses/error"
  7299. },
  7300. "422": {
  7301. "$ref": "#/responses/validationError"
  7302. }
  7303. }
  7304. }
  7305. },
  7306. "/repos/{owner}/{repo}/pulls/{index}.diff": {
  7307. "get": {
  7308. "produces": [
  7309. "text/plain"
  7310. ],
  7311. "tags": [
  7312. "repository"
  7313. ],
  7314. "summary": "Get a pull request diff",
  7315. "operationId": "repoDownloadPullDiff",
  7316. "parameters": [
  7317. {
  7318. "type": "string",
  7319. "description": "owner of the repo",
  7320. "name": "owner",
  7321. "in": "path",
  7322. "required": true
  7323. },
  7324. {
  7325. "type": "string",
  7326. "description": "name of the repo",
  7327. "name": "repo",
  7328. "in": "path",
  7329. "required": true
  7330. },
  7331. {
  7332. "type": "integer",
  7333. "format": "int64",
  7334. "description": "index of the pull request to get",
  7335. "name": "index",
  7336. "in": "path",
  7337. "required": true
  7338. }
  7339. ],
  7340. "responses": {
  7341. "200": {
  7342. "$ref": "#/responses/string"
  7343. },
  7344. "404": {
  7345. "$ref": "#/responses/notFound"
  7346. }
  7347. }
  7348. }
  7349. },
  7350. "/repos/{owner}/{repo}/pulls/{index}.patch": {
  7351. "get": {
  7352. "produces": [
  7353. "text/plain"
  7354. ],
  7355. "tags": [
  7356. "repository"
  7357. ],
  7358. "summary": "Get a pull request patch file",
  7359. "operationId": "repoDownloadPullPatch",
  7360. "parameters": [
  7361. {
  7362. "type": "string",
  7363. "description": "owner of the repo",
  7364. "name": "owner",
  7365. "in": "path",
  7366. "required": true
  7367. },
  7368. {
  7369. "type": "string",
  7370. "description": "name of the repo",
  7371. "name": "repo",
  7372. "in": "path",
  7373. "required": true
  7374. },
  7375. {
  7376. "type": "integer",
  7377. "format": "int64",
  7378. "description": "index of the pull request to get",
  7379. "name": "index",
  7380. "in": "path",
  7381. "required": true
  7382. }
  7383. ],
  7384. "responses": {
  7385. "200": {
  7386. "$ref": "#/responses/string"
  7387. },
  7388. "404": {
  7389. "$ref": "#/responses/notFound"
  7390. }
  7391. }
  7392. }
  7393. },
  7394. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  7395. "get": {
  7396. "produces": [
  7397. "application/json"
  7398. ],
  7399. "tags": [
  7400. "repository"
  7401. ],
  7402. "summary": "Get commits for a pull request",
  7403. "operationId": "repoGetPullRequestCommits",
  7404. "parameters": [
  7405. {
  7406. "type": "string",
  7407. "description": "owner of the repo",
  7408. "name": "owner",
  7409. "in": "path",
  7410. "required": true
  7411. },
  7412. {
  7413. "type": "string",
  7414. "description": "name of the repo",
  7415. "name": "repo",
  7416. "in": "path",
  7417. "required": true
  7418. },
  7419. {
  7420. "type": "integer",
  7421. "format": "int64",
  7422. "description": "index of the pull request to get",
  7423. "name": "index",
  7424. "in": "path",
  7425. "required": true
  7426. },
  7427. {
  7428. "type": "integer",
  7429. "description": "page number of results to return (1-based)",
  7430. "name": "page",
  7431. "in": "query"
  7432. },
  7433. {
  7434. "type": "integer",
  7435. "description": "page size of results",
  7436. "name": "limit",
  7437. "in": "query"
  7438. }
  7439. ],
  7440. "responses": {
  7441. "200": {
  7442. "$ref": "#/responses/CommitList"
  7443. },
  7444. "404": {
  7445. "$ref": "#/responses/notFound"
  7446. }
  7447. }
  7448. }
  7449. },
  7450. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  7451. "get": {
  7452. "produces": [
  7453. "application/json"
  7454. ],
  7455. "tags": [
  7456. "repository"
  7457. ],
  7458. "summary": "Check if a pull request has been merged",
  7459. "operationId": "repoPullRequestIsMerged",
  7460. "parameters": [
  7461. {
  7462. "type": "string",
  7463. "description": "owner of the repo",
  7464. "name": "owner",
  7465. "in": "path",
  7466. "required": true
  7467. },
  7468. {
  7469. "type": "string",
  7470. "description": "name of the repo",
  7471. "name": "repo",
  7472. "in": "path",
  7473. "required": true
  7474. },
  7475. {
  7476. "type": "integer",
  7477. "format": "int64",
  7478. "description": "index of the pull request",
  7479. "name": "index",
  7480. "in": "path",
  7481. "required": true
  7482. }
  7483. ],
  7484. "responses": {
  7485. "204": {
  7486. "description": "pull request has been merged"
  7487. },
  7488. "404": {
  7489. "description": "pull request has not been merged"
  7490. }
  7491. }
  7492. },
  7493. "post": {
  7494. "produces": [
  7495. "application/json"
  7496. ],
  7497. "tags": [
  7498. "repository"
  7499. ],
  7500. "summary": "Merge a pull request",
  7501. "operationId": "repoMergePullRequest",
  7502. "parameters": [
  7503. {
  7504. "type": "string",
  7505. "description": "owner of the repo",
  7506. "name": "owner",
  7507. "in": "path",
  7508. "required": true
  7509. },
  7510. {
  7511. "type": "string",
  7512. "description": "name of the repo",
  7513. "name": "repo",
  7514. "in": "path",
  7515. "required": true
  7516. },
  7517. {
  7518. "type": "integer",
  7519. "format": "int64",
  7520. "description": "index of the pull request to merge",
  7521. "name": "index",
  7522. "in": "path",
  7523. "required": true
  7524. },
  7525. {
  7526. "name": "body",
  7527. "in": "body",
  7528. "schema": {
  7529. "$ref": "#/definitions/MergePullRequestOption"
  7530. }
  7531. }
  7532. ],
  7533. "responses": {
  7534. "200": {
  7535. "$ref": "#/responses/empty"
  7536. },
  7537. "405": {
  7538. "$ref": "#/responses/empty"
  7539. },
  7540. "409": {
  7541. "$ref": "#/responses/error"
  7542. }
  7543. }
  7544. }
  7545. },
  7546. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  7547. "post": {
  7548. "produces": [
  7549. "application/json"
  7550. ],
  7551. "tags": [
  7552. "repository"
  7553. ],
  7554. "summary": "create review requests for a pull request",
  7555. "operationId": "repoCreatePullReviewRequests",
  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. "name": "body",
  7581. "in": "body",
  7582. "required": true,
  7583. "schema": {
  7584. "$ref": "#/definitions/PullReviewRequestOptions"
  7585. }
  7586. }
  7587. ],
  7588. "responses": {
  7589. "201": {
  7590. "$ref": "#/responses/PullReviewList"
  7591. },
  7592. "404": {
  7593. "$ref": "#/responses/notFound"
  7594. },
  7595. "422": {
  7596. "$ref": "#/responses/validationError"
  7597. }
  7598. }
  7599. },
  7600. "delete": {
  7601. "produces": [
  7602. "application/json"
  7603. ],
  7604. "tags": [
  7605. "repository"
  7606. ],
  7607. "summary": "cancel review requests for a pull request",
  7608. "operationId": "repoDeletePullReviewRequests",
  7609. "parameters": [
  7610. {
  7611. "type": "string",
  7612. "description": "owner of the repo",
  7613. "name": "owner",
  7614. "in": "path",
  7615. "required": true
  7616. },
  7617. {
  7618. "type": "string",
  7619. "description": "name of the repo",
  7620. "name": "repo",
  7621. "in": "path",
  7622. "required": true
  7623. },
  7624. {
  7625. "type": "integer",
  7626. "format": "int64",
  7627. "description": "index of the pull request",
  7628. "name": "index",
  7629. "in": "path",
  7630. "required": true
  7631. },
  7632. {
  7633. "name": "body",
  7634. "in": "body",
  7635. "required": true,
  7636. "schema": {
  7637. "$ref": "#/definitions/PullReviewRequestOptions"
  7638. }
  7639. }
  7640. ],
  7641. "responses": {
  7642. "204": {
  7643. "$ref": "#/responses/empty"
  7644. },
  7645. "404": {
  7646. "$ref": "#/responses/notFound"
  7647. },
  7648. "422": {
  7649. "$ref": "#/responses/validationError"
  7650. }
  7651. }
  7652. }
  7653. },
  7654. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  7655. "get": {
  7656. "produces": [
  7657. "application/json"
  7658. ],
  7659. "tags": [
  7660. "repository"
  7661. ],
  7662. "summary": "List all reviews for a pull request",
  7663. "operationId": "repoListPullReviews",
  7664. "parameters": [
  7665. {
  7666. "type": "string",
  7667. "description": "owner of the repo",
  7668. "name": "owner",
  7669. "in": "path",
  7670. "required": true
  7671. },
  7672. {
  7673. "type": "string",
  7674. "description": "name of the repo",
  7675. "name": "repo",
  7676. "in": "path",
  7677. "required": true
  7678. },
  7679. {
  7680. "type": "integer",
  7681. "format": "int64",
  7682. "description": "index of the pull request",
  7683. "name": "index",
  7684. "in": "path",
  7685. "required": true
  7686. },
  7687. {
  7688. "type": "integer",
  7689. "description": "page number of results to return (1-based)",
  7690. "name": "page",
  7691. "in": "query"
  7692. },
  7693. {
  7694. "type": "integer",
  7695. "description": "page size of results",
  7696. "name": "limit",
  7697. "in": "query"
  7698. }
  7699. ],
  7700. "responses": {
  7701. "200": {
  7702. "$ref": "#/responses/PullReviewList"
  7703. },
  7704. "404": {
  7705. "$ref": "#/responses/notFound"
  7706. }
  7707. }
  7708. },
  7709. "post": {
  7710. "produces": [
  7711. "application/json"
  7712. ],
  7713. "tags": [
  7714. "repository"
  7715. ],
  7716. "summary": "Create a review to an pull request",
  7717. "operationId": "repoCreatePullReview",
  7718. "parameters": [
  7719. {
  7720. "type": "string",
  7721. "description": "owner of the repo",
  7722. "name": "owner",
  7723. "in": "path",
  7724. "required": true
  7725. },
  7726. {
  7727. "type": "string",
  7728. "description": "name of the repo",
  7729. "name": "repo",
  7730. "in": "path",
  7731. "required": true
  7732. },
  7733. {
  7734. "type": "integer",
  7735. "format": "int64",
  7736. "description": "index of the pull request",
  7737. "name": "index",
  7738. "in": "path",
  7739. "required": true
  7740. },
  7741. {
  7742. "name": "body",
  7743. "in": "body",
  7744. "required": true,
  7745. "schema": {
  7746. "$ref": "#/definitions/CreatePullReviewOptions"
  7747. }
  7748. }
  7749. ],
  7750. "responses": {
  7751. "200": {
  7752. "$ref": "#/responses/PullReview"
  7753. },
  7754. "404": {
  7755. "$ref": "#/responses/notFound"
  7756. },
  7757. "422": {
  7758. "$ref": "#/responses/validationError"
  7759. }
  7760. }
  7761. }
  7762. },
  7763. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  7764. "get": {
  7765. "produces": [
  7766. "application/json"
  7767. ],
  7768. "tags": [
  7769. "repository"
  7770. ],
  7771. "summary": "Get a specific review for a pull request",
  7772. "operationId": "repoGetPullReview",
  7773. "parameters": [
  7774. {
  7775. "type": "string",
  7776. "description": "owner of the repo",
  7777. "name": "owner",
  7778. "in": "path",
  7779. "required": true
  7780. },
  7781. {
  7782. "type": "string",
  7783. "description": "name of the repo",
  7784. "name": "repo",
  7785. "in": "path",
  7786. "required": true
  7787. },
  7788. {
  7789. "type": "integer",
  7790. "format": "int64",
  7791. "description": "index of the pull request",
  7792. "name": "index",
  7793. "in": "path",
  7794. "required": true
  7795. },
  7796. {
  7797. "type": "integer",
  7798. "format": "int64",
  7799. "description": "id of the review",
  7800. "name": "id",
  7801. "in": "path",
  7802. "required": true
  7803. }
  7804. ],
  7805. "responses": {
  7806. "200": {
  7807. "$ref": "#/responses/PullReview"
  7808. },
  7809. "404": {
  7810. "$ref": "#/responses/notFound"
  7811. }
  7812. }
  7813. },
  7814. "post": {
  7815. "produces": [
  7816. "application/json"
  7817. ],
  7818. "tags": [
  7819. "repository"
  7820. ],
  7821. "summary": "Submit a pending review to an pull request",
  7822. "operationId": "repoSubmitPullReview",
  7823. "parameters": [
  7824. {
  7825. "type": "string",
  7826. "description": "owner of the repo",
  7827. "name": "owner",
  7828. "in": "path",
  7829. "required": true
  7830. },
  7831. {
  7832. "type": "string",
  7833. "description": "name of the repo",
  7834. "name": "repo",
  7835. "in": "path",
  7836. "required": true
  7837. },
  7838. {
  7839. "type": "integer",
  7840. "format": "int64",
  7841. "description": "index of the pull request",
  7842. "name": "index",
  7843. "in": "path",
  7844. "required": true
  7845. },
  7846. {
  7847. "type": "integer",
  7848. "format": "int64",
  7849. "description": "id of the review",
  7850. "name": "id",
  7851. "in": "path",
  7852. "required": true
  7853. },
  7854. {
  7855. "name": "body",
  7856. "in": "body",
  7857. "required": true,
  7858. "schema": {
  7859. "$ref": "#/definitions/SubmitPullReviewOptions"
  7860. }
  7861. }
  7862. ],
  7863. "responses": {
  7864. "200": {
  7865. "$ref": "#/responses/PullReview"
  7866. },
  7867. "404": {
  7868. "$ref": "#/responses/notFound"
  7869. },
  7870. "422": {
  7871. "$ref": "#/responses/validationError"
  7872. }
  7873. }
  7874. },
  7875. "delete": {
  7876. "produces": [
  7877. "application/json"
  7878. ],
  7879. "tags": [
  7880. "repository"
  7881. ],
  7882. "summary": "Delete a specific review from a pull request",
  7883. "operationId": "repoDeletePullReview",
  7884. "parameters": [
  7885. {
  7886. "type": "string",
  7887. "description": "owner of the repo",
  7888. "name": "owner",
  7889. "in": "path",
  7890. "required": true
  7891. },
  7892. {
  7893. "type": "string",
  7894. "description": "name of the repo",
  7895. "name": "repo",
  7896. "in": "path",
  7897. "required": true
  7898. },
  7899. {
  7900. "type": "integer",
  7901. "format": "int64",
  7902. "description": "index of the pull request",
  7903. "name": "index",
  7904. "in": "path",
  7905. "required": true
  7906. },
  7907. {
  7908. "type": "integer",
  7909. "format": "int64",
  7910. "description": "id of the review",
  7911. "name": "id",
  7912. "in": "path",
  7913. "required": true
  7914. }
  7915. ],
  7916. "responses": {
  7917. "204": {
  7918. "$ref": "#/responses/empty"
  7919. },
  7920. "403": {
  7921. "$ref": "#/responses/forbidden"
  7922. },
  7923. "404": {
  7924. "$ref": "#/responses/notFound"
  7925. }
  7926. }
  7927. }
  7928. },
  7929. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  7930. "get": {
  7931. "produces": [
  7932. "application/json"
  7933. ],
  7934. "tags": [
  7935. "repository"
  7936. ],
  7937. "summary": "Get a specific review for a pull request",
  7938. "operationId": "repoGetPullReviewComments",
  7939. "parameters": [
  7940. {
  7941. "type": "string",
  7942. "description": "owner of the repo",
  7943. "name": "owner",
  7944. "in": "path",
  7945. "required": true
  7946. },
  7947. {
  7948. "type": "string",
  7949. "description": "name of the repo",
  7950. "name": "repo",
  7951. "in": "path",
  7952. "required": true
  7953. },
  7954. {
  7955. "type": "integer",
  7956. "format": "int64",
  7957. "description": "index of the pull request",
  7958. "name": "index",
  7959. "in": "path",
  7960. "required": true
  7961. },
  7962. {
  7963. "type": "integer",
  7964. "format": "int64",
  7965. "description": "id of the review",
  7966. "name": "id",
  7967. "in": "path",
  7968. "required": true
  7969. }
  7970. ],
  7971. "responses": {
  7972. "200": {
  7973. "$ref": "#/responses/PullReviewCommentList"
  7974. },
  7975. "404": {
  7976. "$ref": "#/responses/notFound"
  7977. }
  7978. }
  7979. }
  7980. },
  7981. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  7982. "post": {
  7983. "produces": [
  7984. "application/json"
  7985. ],
  7986. "tags": [
  7987. "repository"
  7988. ],
  7989. "summary": "Dismiss a review for a pull request",
  7990. "operationId": "repoDismissPullReview",
  7991. "parameters": [
  7992. {
  7993. "type": "string",
  7994. "description": "owner of the repo",
  7995. "name": "owner",
  7996. "in": "path",
  7997. "required": true
  7998. },
  7999. {
  8000. "type": "string",
  8001. "description": "name of the repo",
  8002. "name": "repo",
  8003. "in": "path",
  8004. "required": true
  8005. },
  8006. {
  8007. "type": "integer",
  8008. "format": "int64",
  8009. "description": "index of the pull request",
  8010. "name": "index",
  8011. "in": "path",
  8012. "required": true
  8013. },
  8014. {
  8015. "type": "integer",
  8016. "format": "int64",
  8017. "description": "id of the review",
  8018. "name": "id",
  8019. "in": "path",
  8020. "required": true
  8021. },
  8022. {
  8023. "name": "body",
  8024. "in": "body",
  8025. "required": true,
  8026. "schema": {
  8027. "$ref": "#/definitions/DismissPullReviewOptions"
  8028. }
  8029. }
  8030. ],
  8031. "responses": {
  8032. "200": {
  8033. "$ref": "#/responses/PullReview"
  8034. },
  8035. "403": {
  8036. "$ref": "#/responses/forbidden"
  8037. },
  8038. "422": {
  8039. "$ref": "#/responses/validationError"
  8040. }
  8041. }
  8042. }
  8043. },
  8044. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  8045. "post": {
  8046. "produces": [
  8047. "application/json"
  8048. ],
  8049. "tags": [
  8050. "repository"
  8051. ],
  8052. "summary": "Cancel to dismiss a review for a pull request",
  8053. "operationId": "repoUnDismissPullReview",
  8054. "parameters": [
  8055. {
  8056. "type": "string",
  8057. "description": "owner of the repo",
  8058. "name": "owner",
  8059. "in": "path",
  8060. "required": true
  8061. },
  8062. {
  8063. "type": "string",
  8064. "description": "name of the repo",
  8065. "name": "repo",
  8066. "in": "path",
  8067. "required": true
  8068. },
  8069. {
  8070. "type": "integer",
  8071. "format": "int64",
  8072. "description": "index of the pull request",
  8073. "name": "index",
  8074. "in": "path",
  8075. "required": true
  8076. },
  8077. {
  8078. "type": "integer",
  8079. "format": "int64",
  8080. "description": "id of the review",
  8081. "name": "id",
  8082. "in": "path",
  8083. "required": true
  8084. }
  8085. ],
  8086. "responses": {
  8087. "200": {
  8088. "$ref": "#/responses/PullReview"
  8089. },
  8090. "403": {
  8091. "$ref": "#/responses/forbidden"
  8092. },
  8093. "422": {
  8094. "$ref": "#/responses/validationError"
  8095. }
  8096. }
  8097. }
  8098. },
  8099. "/repos/{owner}/{repo}/pulls/{index}/update": {
  8100. "post": {
  8101. "produces": [
  8102. "application/json"
  8103. ],
  8104. "tags": [
  8105. "repository"
  8106. ],
  8107. "summary": "Merge PR's baseBranch into headBranch",
  8108. "operationId": "repoUpdatePullRequest",
  8109. "parameters": [
  8110. {
  8111. "type": "string",
  8112. "description": "owner of the repo",
  8113. "name": "owner",
  8114. "in": "path",
  8115. "required": true
  8116. },
  8117. {
  8118. "type": "string",
  8119. "description": "name of the repo",
  8120. "name": "repo",
  8121. "in": "path",
  8122. "required": true
  8123. },
  8124. {
  8125. "type": "integer",
  8126. "format": "int64",
  8127. "description": "index of the pull request to get",
  8128. "name": "index",
  8129. "in": "path",
  8130. "required": true
  8131. },
  8132. {
  8133. "enum": [
  8134. "merge",
  8135. "rebase"
  8136. ],
  8137. "type": "string",
  8138. "description": "how to update pull request",
  8139. "name": "style",
  8140. "in": "query"
  8141. }
  8142. ],
  8143. "responses": {
  8144. "200": {
  8145. "$ref": "#/responses/empty"
  8146. },
  8147. "403": {
  8148. "$ref": "#/responses/forbidden"
  8149. },
  8150. "404": {
  8151. "$ref": "#/responses/notFound"
  8152. },
  8153. "409": {
  8154. "$ref": "#/responses/error"
  8155. },
  8156. "422": {
  8157. "$ref": "#/responses/validationError"
  8158. }
  8159. }
  8160. }
  8161. },
  8162. "/repos/{owner}/{repo}/raw/{filepath}": {
  8163. "get": {
  8164. "produces": [
  8165. "application/json"
  8166. ],
  8167. "tags": [
  8168. "repository"
  8169. ],
  8170. "summary": "Get a file from a repository",
  8171. "operationId": "repoGetRawFile",
  8172. "parameters": [
  8173. {
  8174. "type": "string",
  8175. "description": "owner of the repo",
  8176. "name": "owner",
  8177. "in": "path",
  8178. "required": true
  8179. },
  8180. {
  8181. "type": "string",
  8182. "description": "name of the repo",
  8183. "name": "repo",
  8184. "in": "path",
  8185. "required": true
  8186. },
  8187. {
  8188. "type": "string",
  8189. "description": "filepath of the file to get",
  8190. "name": "filepath",
  8191. "in": "path",
  8192. "required": true
  8193. },
  8194. {
  8195. "type": "string",
  8196. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  8197. "name": "ref",
  8198. "in": "query"
  8199. }
  8200. ],
  8201. "responses": {
  8202. "200": {
  8203. "description": "success"
  8204. },
  8205. "404": {
  8206. "$ref": "#/responses/notFound"
  8207. }
  8208. }
  8209. }
  8210. },
  8211. "/repos/{owner}/{repo}/releases": {
  8212. "get": {
  8213. "produces": [
  8214. "application/json"
  8215. ],
  8216. "tags": [
  8217. "repository"
  8218. ],
  8219. "summary": "List a repo's releases",
  8220. "operationId": "repoListReleases",
  8221. "parameters": [
  8222. {
  8223. "type": "string",
  8224. "description": "owner of the repo",
  8225. "name": "owner",
  8226. "in": "path",
  8227. "required": true
  8228. },
  8229. {
  8230. "type": "string",
  8231. "description": "name of the repo",
  8232. "name": "repo",
  8233. "in": "path",
  8234. "required": true
  8235. },
  8236. {
  8237. "type": "boolean",
  8238. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  8239. "name": "draft",
  8240. "in": "query"
  8241. },
  8242. {
  8243. "type": "boolean",
  8244. "description": "filter (exclude / include) pre-releases",
  8245. "name": "pre-release",
  8246. "in": "query"
  8247. },
  8248. {
  8249. "type": "integer",
  8250. "description": "page size of results, deprecated - use limit",
  8251. "name": "per_page",
  8252. "in": "query"
  8253. },
  8254. {
  8255. "type": "integer",
  8256. "description": "page number of results to return (1-based)",
  8257. "name": "page",
  8258. "in": "query"
  8259. },
  8260. {
  8261. "type": "integer",
  8262. "description": "page size of results",
  8263. "name": "limit",
  8264. "in": "query"
  8265. }
  8266. ],
  8267. "responses": {
  8268. "200": {
  8269. "$ref": "#/responses/ReleaseList"
  8270. }
  8271. }
  8272. },
  8273. "post": {
  8274. "consumes": [
  8275. "application/json"
  8276. ],
  8277. "produces": [
  8278. "application/json"
  8279. ],
  8280. "tags": [
  8281. "repository"
  8282. ],
  8283. "summary": "Create a release",
  8284. "operationId": "repoCreateRelease",
  8285. "parameters": [
  8286. {
  8287. "type": "string",
  8288. "description": "owner of the repo",
  8289. "name": "owner",
  8290. "in": "path",
  8291. "required": true
  8292. },
  8293. {
  8294. "type": "string",
  8295. "description": "name of the repo",
  8296. "name": "repo",
  8297. "in": "path",
  8298. "required": true
  8299. },
  8300. {
  8301. "name": "body",
  8302. "in": "body",
  8303. "schema": {
  8304. "$ref": "#/definitions/CreateReleaseOption"
  8305. }
  8306. }
  8307. ],
  8308. "responses": {
  8309. "201": {
  8310. "$ref": "#/responses/Release"
  8311. },
  8312. "404": {
  8313. "$ref": "#/responses/notFound"
  8314. },
  8315. "409": {
  8316. "$ref": "#/responses/error"
  8317. }
  8318. }
  8319. }
  8320. },
  8321. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  8322. "get": {
  8323. "produces": [
  8324. "application/json"
  8325. ],
  8326. "tags": [
  8327. "repository"
  8328. ],
  8329. "summary": "Get a release by tag name",
  8330. "operationId": "repoGetReleaseByTag",
  8331. "parameters": [
  8332. {
  8333. "type": "string",
  8334. "description": "owner of the repo",
  8335. "name": "owner",
  8336. "in": "path",
  8337. "required": true
  8338. },
  8339. {
  8340. "type": "string",
  8341. "description": "name of the repo",
  8342. "name": "repo",
  8343. "in": "path",
  8344. "required": true
  8345. },
  8346. {
  8347. "type": "string",
  8348. "description": "tag name of the release to get",
  8349. "name": "tag",
  8350. "in": "path",
  8351. "required": true
  8352. }
  8353. ],
  8354. "responses": {
  8355. "200": {
  8356. "$ref": "#/responses/Release"
  8357. },
  8358. "404": {
  8359. "$ref": "#/responses/notFound"
  8360. }
  8361. }
  8362. },
  8363. "delete": {
  8364. "tags": [
  8365. "repository"
  8366. ],
  8367. "summary": "Delete a release by tag name",
  8368. "operationId": "repoDeleteReleaseByTag",
  8369. "parameters": [
  8370. {
  8371. "type": "string",
  8372. "description": "owner of the repo",
  8373. "name": "owner",
  8374. "in": "path",
  8375. "required": true
  8376. },
  8377. {
  8378. "type": "string",
  8379. "description": "name of the repo",
  8380. "name": "repo",
  8381. "in": "path",
  8382. "required": true
  8383. },
  8384. {
  8385. "type": "string",
  8386. "description": "tag name of the release to delete",
  8387. "name": "tag",
  8388. "in": "path",
  8389. "required": true
  8390. }
  8391. ],
  8392. "responses": {
  8393. "204": {
  8394. "$ref": "#/responses/empty"
  8395. },
  8396. "404": {
  8397. "$ref": "#/responses/notFound"
  8398. }
  8399. }
  8400. }
  8401. },
  8402. "/repos/{owner}/{repo}/releases/{id}": {
  8403. "get": {
  8404. "produces": [
  8405. "application/json"
  8406. ],
  8407. "tags": [
  8408. "repository"
  8409. ],
  8410. "summary": "Get a release",
  8411. "operationId": "repoGetRelease",
  8412. "parameters": [
  8413. {
  8414. "type": "string",
  8415. "description": "owner of the repo",
  8416. "name": "owner",
  8417. "in": "path",
  8418. "required": true
  8419. },
  8420. {
  8421. "type": "string",
  8422. "description": "name of the repo",
  8423. "name": "repo",
  8424. "in": "path",
  8425. "required": true
  8426. },
  8427. {
  8428. "type": "integer",
  8429. "format": "int64",
  8430. "description": "id of the release to get",
  8431. "name": "id",
  8432. "in": "path",
  8433. "required": true
  8434. }
  8435. ],
  8436. "responses": {
  8437. "200": {
  8438. "$ref": "#/responses/Release"
  8439. },
  8440. "404": {
  8441. "$ref": "#/responses/notFound"
  8442. }
  8443. }
  8444. },
  8445. "delete": {
  8446. "tags": [
  8447. "repository"
  8448. ],
  8449. "summary": "Delete a release",
  8450. "operationId": "repoDeleteRelease",
  8451. "parameters": [
  8452. {
  8453. "type": "string",
  8454. "description": "owner of the repo",
  8455. "name": "owner",
  8456. "in": "path",
  8457. "required": true
  8458. },
  8459. {
  8460. "type": "string",
  8461. "description": "name of the repo",
  8462. "name": "repo",
  8463. "in": "path",
  8464. "required": true
  8465. },
  8466. {
  8467. "type": "integer",
  8468. "format": "int64",
  8469. "description": "id of the release to delete",
  8470. "name": "id",
  8471. "in": "path",
  8472. "required": true
  8473. }
  8474. ],
  8475. "responses": {
  8476. "204": {
  8477. "$ref": "#/responses/empty"
  8478. },
  8479. "404": {
  8480. "$ref": "#/responses/notFound"
  8481. }
  8482. }
  8483. },
  8484. "patch": {
  8485. "consumes": [
  8486. "application/json"
  8487. ],
  8488. "produces": [
  8489. "application/json"
  8490. ],
  8491. "tags": [
  8492. "repository"
  8493. ],
  8494. "summary": "Update a release",
  8495. "operationId": "repoEditRelease",
  8496. "parameters": [
  8497. {
  8498. "type": "string",
  8499. "description": "owner of the repo",
  8500. "name": "owner",
  8501. "in": "path",
  8502. "required": true
  8503. },
  8504. {
  8505. "type": "string",
  8506. "description": "name of the repo",
  8507. "name": "repo",
  8508. "in": "path",
  8509. "required": true
  8510. },
  8511. {
  8512. "type": "integer",
  8513. "format": "int64",
  8514. "description": "id of the release to edit",
  8515. "name": "id",
  8516. "in": "path",
  8517. "required": true
  8518. },
  8519. {
  8520. "name": "body",
  8521. "in": "body",
  8522. "schema": {
  8523. "$ref": "#/definitions/EditReleaseOption"
  8524. }
  8525. }
  8526. ],
  8527. "responses": {
  8528. "200": {
  8529. "$ref": "#/responses/Release"
  8530. },
  8531. "404": {
  8532. "$ref": "#/responses/notFound"
  8533. }
  8534. }
  8535. }
  8536. },
  8537. "/repos/{owner}/{repo}/releases/{id}/assets": {
  8538. "get": {
  8539. "produces": [
  8540. "application/json"
  8541. ],
  8542. "tags": [
  8543. "repository"
  8544. ],
  8545. "summary": "List release's attachments",
  8546. "operationId": "repoListReleaseAttachments",
  8547. "parameters": [
  8548. {
  8549. "type": "string",
  8550. "description": "owner of the repo",
  8551. "name": "owner",
  8552. "in": "path",
  8553. "required": true
  8554. },
  8555. {
  8556. "type": "string",
  8557. "description": "name of the repo",
  8558. "name": "repo",
  8559. "in": "path",
  8560. "required": true
  8561. },
  8562. {
  8563. "type": "integer",
  8564. "format": "int64",
  8565. "description": "id of the release",
  8566. "name": "id",
  8567. "in": "path",
  8568. "required": true
  8569. }
  8570. ],
  8571. "responses": {
  8572. "200": {
  8573. "$ref": "#/responses/AttachmentList"
  8574. }
  8575. }
  8576. },
  8577. "post": {
  8578. "consumes": [
  8579. "multipart/form-data"
  8580. ],
  8581. "produces": [
  8582. "application/json"
  8583. ],
  8584. "tags": [
  8585. "repository"
  8586. ],
  8587. "summary": "Create a release attachment",
  8588. "operationId": "repoCreateReleaseAttachment",
  8589. "parameters": [
  8590. {
  8591. "type": "string",
  8592. "description": "owner of the repo",
  8593. "name": "owner",
  8594. "in": "path",
  8595. "required": true
  8596. },
  8597. {
  8598. "type": "string",
  8599. "description": "name of the repo",
  8600. "name": "repo",
  8601. "in": "path",
  8602. "required": true
  8603. },
  8604. {
  8605. "type": "integer",
  8606. "format": "int64",
  8607. "description": "id of the release",
  8608. "name": "id",
  8609. "in": "path",
  8610. "required": true
  8611. },
  8612. {
  8613. "type": "string",
  8614. "description": "name of the attachment",
  8615. "name": "name",
  8616. "in": "query"
  8617. },
  8618. {
  8619. "type": "file",
  8620. "description": "attachment to upload",
  8621. "name": "attachment",
  8622. "in": "formData",
  8623. "required": true
  8624. }
  8625. ],
  8626. "responses": {
  8627. "201": {
  8628. "$ref": "#/responses/Attachment"
  8629. },
  8630. "400": {
  8631. "$ref": "#/responses/error"
  8632. }
  8633. }
  8634. }
  8635. },
  8636. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  8637. "get": {
  8638. "produces": [
  8639. "application/json"
  8640. ],
  8641. "tags": [
  8642. "repository"
  8643. ],
  8644. "summary": "Get a release attachment",
  8645. "operationId": "repoGetReleaseAttachment",
  8646. "parameters": [
  8647. {
  8648. "type": "string",
  8649. "description": "owner of the repo",
  8650. "name": "owner",
  8651. "in": "path",
  8652. "required": true
  8653. },
  8654. {
  8655. "type": "string",
  8656. "description": "name of the repo",
  8657. "name": "repo",
  8658. "in": "path",
  8659. "required": true
  8660. },
  8661. {
  8662. "type": "integer",
  8663. "format": "int64",
  8664. "description": "id of the release",
  8665. "name": "id",
  8666. "in": "path",
  8667. "required": true
  8668. },
  8669. {
  8670. "type": "integer",
  8671. "format": "int64",
  8672. "description": "id of the attachment to get",
  8673. "name": "attachment_id",
  8674. "in": "path",
  8675. "required": true
  8676. }
  8677. ],
  8678. "responses": {
  8679. "200": {
  8680. "$ref": "#/responses/Attachment"
  8681. }
  8682. }
  8683. },
  8684. "delete": {
  8685. "produces": [
  8686. "application/json"
  8687. ],
  8688. "tags": [
  8689. "repository"
  8690. ],
  8691. "summary": "Delete a release attachment",
  8692. "operationId": "repoDeleteReleaseAttachment",
  8693. "parameters": [
  8694. {
  8695. "type": "string",
  8696. "description": "owner of the repo",
  8697. "name": "owner",
  8698. "in": "path",
  8699. "required": true
  8700. },
  8701. {
  8702. "type": "string",
  8703. "description": "name of the repo",
  8704. "name": "repo",
  8705. "in": "path",
  8706. "required": true
  8707. },
  8708. {
  8709. "type": "integer",
  8710. "format": "int64",
  8711. "description": "id of the release",
  8712. "name": "id",
  8713. "in": "path",
  8714. "required": true
  8715. },
  8716. {
  8717. "type": "integer",
  8718. "format": "int64",
  8719. "description": "id of the attachment to delete",
  8720. "name": "attachment_id",
  8721. "in": "path",
  8722. "required": true
  8723. }
  8724. ],
  8725. "responses": {
  8726. "204": {
  8727. "$ref": "#/responses/empty"
  8728. }
  8729. }
  8730. },
  8731. "patch": {
  8732. "consumes": [
  8733. "application/json"
  8734. ],
  8735. "produces": [
  8736. "application/json"
  8737. ],
  8738. "tags": [
  8739. "repository"
  8740. ],
  8741. "summary": "Edit a release attachment",
  8742. "operationId": "repoEditReleaseAttachment",
  8743. "parameters": [
  8744. {
  8745. "type": "string",
  8746. "description": "owner of the repo",
  8747. "name": "owner",
  8748. "in": "path",
  8749. "required": true
  8750. },
  8751. {
  8752. "type": "string",
  8753. "description": "name of the repo",
  8754. "name": "repo",
  8755. "in": "path",
  8756. "required": true
  8757. },
  8758. {
  8759. "type": "integer",
  8760. "format": "int64",
  8761. "description": "id of the release",
  8762. "name": "id",
  8763. "in": "path",
  8764. "required": true
  8765. },
  8766. {
  8767. "type": "integer",
  8768. "format": "int64",
  8769. "description": "id of the attachment to edit",
  8770. "name": "attachment_id",
  8771. "in": "path",
  8772. "required": true
  8773. },
  8774. {
  8775. "name": "body",
  8776. "in": "body",
  8777. "schema": {
  8778. "$ref": "#/definitions/EditAttachmentOptions"
  8779. }
  8780. }
  8781. ],
  8782. "responses": {
  8783. "201": {
  8784. "$ref": "#/responses/Attachment"
  8785. }
  8786. }
  8787. }
  8788. },
  8789. "/repos/{owner}/{repo}/reviewers": {
  8790. "get": {
  8791. "produces": [
  8792. "application/json"
  8793. ],
  8794. "tags": [
  8795. "repository"
  8796. ],
  8797. "summary": "Return all users that can be requested to review in this repo",
  8798. "operationId": "repoGetReviewers",
  8799. "parameters": [
  8800. {
  8801. "type": "string",
  8802. "description": "owner of the repo",
  8803. "name": "owner",
  8804. "in": "path",
  8805. "required": true
  8806. },
  8807. {
  8808. "type": "string",
  8809. "description": "name of the repo",
  8810. "name": "repo",
  8811. "in": "path",
  8812. "required": true
  8813. }
  8814. ],
  8815. "responses": {
  8816. "200": {
  8817. "$ref": "#/responses/UserList"
  8818. }
  8819. }
  8820. }
  8821. },
  8822. "/repos/{owner}/{repo}/signing-key.gpg": {
  8823. "get": {
  8824. "produces": [
  8825. "text/plain"
  8826. ],
  8827. "tags": [
  8828. "repository"
  8829. ],
  8830. "summary": "Get signing-key.gpg for given repository",
  8831. "operationId": "repoSigningKey",
  8832. "parameters": [
  8833. {
  8834. "type": "string",
  8835. "description": "owner of the repo",
  8836. "name": "owner",
  8837. "in": "path",
  8838. "required": true
  8839. },
  8840. {
  8841. "type": "string",
  8842. "description": "name of the repo",
  8843. "name": "repo",
  8844. "in": "path",
  8845. "required": true
  8846. }
  8847. ],
  8848. "responses": {
  8849. "200": {
  8850. "description": "GPG armored public key",
  8851. "schema": {
  8852. "type": "string"
  8853. }
  8854. }
  8855. }
  8856. }
  8857. },
  8858. "/repos/{owner}/{repo}/stargazers": {
  8859. "get": {
  8860. "produces": [
  8861. "application/json"
  8862. ],
  8863. "tags": [
  8864. "repository"
  8865. ],
  8866. "summary": "List a repo's stargazers",
  8867. "operationId": "repoListStargazers",
  8868. "parameters": [
  8869. {
  8870. "type": "string",
  8871. "description": "owner of the repo",
  8872. "name": "owner",
  8873. "in": "path",
  8874. "required": true
  8875. },
  8876. {
  8877. "type": "string",
  8878. "description": "name of the repo",
  8879. "name": "repo",
  8880. "in": "path",
  8881. "required": true
  8882. },
  8883. {
  8884. "type": "integer",
  8885. "description": "page number of results to return (1-based)",
  8886. "name": "page",
  8887. "in": "query"
  8888. },
  8889. {
  8890. "type": "integer",
  8891. "description": "page size of results",
  8892. "name": "limit",
  8893. "in": "query"
  8894. }
  8895. ],
  8896. "responses": {
  8897. "200": {
  8898. "$ref": "#/responses/UserList"
  8899. }
  8900. }
  8901. }
  8902. },
  8903. "/repos/{owner}/{repo}/statuses/{sha}": {
  8904. "get": {
  8905. "produces": [
  8906. "application/json"
  8907. ],
  8908. "tags": [
  8909. "repository"
  8910. ],
  8911. "summary": "Get a commit's statuses",
  8912. "operationId": "repoListStatuses",
  8913. "parameters": [
  8914. {
  8915. "type": "string",
  8916. "description": "owner of the repo",
  8917. "name": "owner",
  8918. "in": "path",
  8919. "required": true
  8920. },
  8921. {
  8922. "type": "string",
  8923. "description": "name of the repo",
  8924. "name": "repo",
  8925. "in": "path",
  8926. "required": true
  8927. },
  8928. {
  8929. "type": "string",
  8930. "description": "sha of the commit",
  8931. "name": "sha",
  8932. "in": "path",
  8933. "required": true
  8934. },
  8935. {
  8936. "enum": [
  8937. "oldest",
  8938. "recentupdate",
  8939. "leastupdate",
  8940. "leastindex",
  8941. "highestindex"
  8942. ],
  8943. "type": "string",
  8944. "description": "type of sort",
  8945. "name": "sort",
  8946. "in": "query"
  8947. },
  8948. {
  8949. "enum": [
  8950. "pending",
  8951. "success",
  8952. "error",
  8953. "failure",
  8954. "warning"
  8955. ],
  8956. "type": "string",
  8957. "description": "type of state",
  8958. "name": "state",
  8959. "in": "query"
  8960. },
  8961. {
  8962. "type": "integer",
  8963. "description": "page number of results to return (1-based)",
  8964. "name": "page",
  8965. "in": "query"
  8966. },
  8967. {
  8968. "type": "integer",
  8969. "description": "page size of results",
  8970. "name": "limit",
  8971. "in": "query"
  8972. }
  8973. ],
  8974. "responses": {
  8975. "200": {
  8976. "$ref": "#/responses/CommitStatusList"
  8977. },
  8978. "400": {
  8979. "$ref": "#/responses/error"
  8980. }
  8981. }
  8982. },
  8983. "post": {
  8984. "produces": [
  8985. "application/json"
  8986. ],
  8987. "tags": [
  8988. "repository"
  8989. ],
  8990. "summary": "Create a commit status",
  8991. "operationId": "repoCreateStatus",
  8992. "parameters": [
  8993. {
  8994. "type": "string",
  8995. "description": "owner of the repo",
  8996. "name": "owner",
  8997. "in": "path",
  8998. "required": true
  8999. },
  9000. {
  9001. "type": "string",
  9002. "description": "name of the repo",
  9003. "name": "repo",
  9004. "in": "path",
  9005. "required": true
  9006. },
  9007. {
  9008. "type": "string",
  9009. "description": "sha of the commit",
  9010. "name": "sha",
  9011. "in": "path",
  9012. "required": true
  9013. },
  9014. {
  9015. "name": "body",
  9016. "in": "body",
  9017. "schema": {
  9018. "$ref": "#/definitions/CreateStatusOption"
  9019. }
  9020. }
  9021. ],
  9022. "responses": {
  9023. "201": {
  9024. "$ref": "#/responses/CommitStatus"
  9025. },
  9026. "400": {
  9027. "$ref": "#/responses/error"
  9028. }
  9029. }
  9030. }
  9031. },
  9032. "/repos/{owner}/{repo}/subscribers": {
  9033. "get": {
  9034. "produces": [
  9035. "application/json"
  9036. ],
  9037. "tags": [
  9038. "repository"
  9039. ],
  9040. "summary": "List a repo's watchers",
  9041. "operationId": "repoListSubscribers",
  9042. "parameters": [
  9043. {
  9044. "type": "string",
  9045. "description": "owner of the repo",
  9046. "name": "owner",
  9047. "in": "path",
  9048. "required": true
  9049. },
  9050. {
  9051. "type": "string",
  9052. "description": "name of the repo",
  9053. "name": "repo",
  9054. "in": "path",
  9055. "required": true
  9056. },
  9057. {
  9058. "type": "integer",
  9059. "description": "page number of results to return (1-based)",
  9060. "name": "page",
  9061. "in": "query"
  9062. },
  9063. {
  9064. "type": "integer",
  9065. "description": "page size of results",
  9066. "name": "limit",
  9067. "in": "query"
  9068. }
  9069. ],
  9070. "responses": {
  9071. "200": {
  9072. "$ref": "#/responses/UserList"
  9073. }
  9074. }
  9075. }
  9076. },
  9077. "/repos/{owner}/{repo}/subscription": {
  9078. "get": {
  9079. "tags": [
  9080. "repository"
  9081. ],
  9082. "summary": "Check if the current user is watching a repo",
  9083. "operationId": "userCurrentCheckSubscription",
  9084. "parameters": [
  9085. {
  9086. "type": "string",
  9087. "description": "owner of the repo",
  9088. "name": "owner",
  9089. "in": "path",
  9090. "required": true
  9091. },
  9092. {
  9093. "type": "string",
  9094. "description": "name of the repo",
  9095. "name": "repo",
  9096. "in": "path",
  9097. "required": true
  9098. }
  9099. ],
  9100. "responses": {
  9101. "200": {
  9102. "$ref": "#/responses/WatchInfo"
  9103. },
  9104. "404": {
  9105. "description": "User is not watching this repo or repo do not exist"
  9106. }
  9107. }
  9108. },
  9109. "put": {
  9110. "tags": [
  9111. "repository"
  9112. ],
  9113. "summary": "Watch a repo",
  9114. "operationId": "userCurrentPutSubscription",
  9115. "parameters": [
  9116. {
  9117. "type": "string",
  9118. "description": "owner of the repo",
  9119. "name": "owner",
  9120. "in": "path",
  9121. "required": true
  9122. },
  9123. {
  9124. "type": "string",
  9125. "description": "name of the repo",
  9126. "name": "repo",
  9127. "in": "path",
  9128. "required": true
  9129. }
  9130. ],
  9131. "responses": {
  9132. "200": {
  9133. "$ref": "#/responses/WatchInfo"
  9134. }
  9135. }
  9136. },
  9137. "delete": {
  9138. "tags": [
  9139. "repository"
  9140. ],
  9141. "summary": "Unwatch a repo",
  9142. "operationId": "userCurrentDeleteSubscription",
  9143. "parameters": [
  9144. {
  9145. "type": "string",
  9146. "description": "owner of the repo",
  9147. "name": "owner",
  9148. "in": "path",
  9149. "required": true
  9150. },
  9151. {
  9152. "type": "string",
  9153. "description": "name of the repo",
  9154. "name": "repo",
  9155. "in": "path",
  9156. "required": true
  9157. }
  9158. ],
  9159. "responses": {
  9160. "204": {
  9161. "$ref": "#/responses/empty"
  9162. }
  9163. }
  9164. }
  9165. },
  9166. "/repos/{owner}/{repo}/tags": {
  9167. "get": {
  9168. "produces": [
  9169. "application/json"
  9170. ],
  9171. "tags": [
  9172. "repository"
  9173. ],
  9174. "summary": "List a repository's tags",
  9175. "operationId": "repoListTags",
  9176. "parameters": [
  9177. {
  9178. "type": "string",
  9179. "description": "owner of the repo",
  9180. "name": "owner",
  9181. "in": "path",
  9182. "required": true
  9183. },
  9184. {
  9185. "type": "string",
  9186. "description": "name of the repo",
  9187. "name": "repo",
  9188. "in": "path",
  9189. "required": true
  9190. },
  9191. {
  9192. "type": "integer",
  9193. "description": "page number of results to return (1-based)",
  9194. "name": "page",
  9195. "in": "query"
  9196. },
  9197. {
  9198. "type": "integer",
  9199. "description": "page size of results, default maximum page size is 50",
  9200. "name": "limit",
  9201. "in": "query"
  9202. }
  9203. ],
  9204. "responses": {
  9205. "200": {
  9206. "$ref": "#/responses/TagList"
  9207. }
  9208. }
  9209. },
  9210. "post": {
  9211. "produces": [
  9212. "application/json"
  9213. ],
  9214. "tags": [
  9215. "repository"
  9216. ],
  9217. "summary": "Create a new git tag in a repository",
  9218. "operationId": "repoCreateTag",
  9219. "parameters": [
  9220. {
  9221. "type": "string",
  9222. "description": "owner of the repo",
  9223. "name": "owner",
  9224. "in": "path",
  9225. "required": true
  9226. },
  9227. {
  9228. "type": "string",
  9229. "description": "name of the repo",
  9230. "name": "repo",
  9231. "in": "path",
  9232. "required": true
  9233. },
  9234. {
  9235. "name": "body",
  9236. "in": "body",
  9237. "schema": {
  9238. "$ref": "#/definitions/CreateTagOption"
  9239. }
  9240. }
  9241. ],
  9242. "responses": {
  9243. "200": {
  9244. "$ref": "#/responses/Tag"
  9245. },
  9246. "404": {
  9247. "$ref": "#/responses/notFound"
  9248. },
  9249. "409": {
  9250. "$ref": "#/responses/conflict"
  9251. }
  9252. }
  9253. }
  9254. },
  9255. "/repos/{owner}/{repo}/tags/{tag}": {
  9256. "get": {
  9257. "produces": [
  9258. "application/json"
  9259. ],
  9260. "tags": [
  9261. "repository"
  9262. ],
  9263. "summary": "Get the tag of a repository by tag name",
  9264. "operationId": "repoGetTag",
  9265. "parameters": [
  9266. {
  9267. "type": "string",
  9268. "description": "owner of the repo",
  9269. "name": "owner",
  9270. "in": "path",
  9271. "required": true
  9272. },
  9273. {
  9274. "type": "string",
  9275. "description": "name of the repo",
  9276. "name": "repo",
  9277. "in": "path",
  9278. "required": true
  9279. },
  9280. {
  9281. "type": "string",
  9282. "description": "name of tag",
  9283. "name": "tag",
  9284. "in": "path",
  9285. "required": true
  9286. }
  9287. ],
  9288. "responses": {
  9289. "200": {
  9290. "$ref": "#/responses/Tag"
  9291. },
  9292. "404": {
  9293. "$ref": "#/responses/notFound"
  9294. }
  9295. }
  9296. },
  9297. "delete": {
  9298. "produces": [
  9299. "application/json"
  9300. ],
  9301. "tags": [
  9302. "repository"
  9303. ],
  9304. "summary": "Delete a repository's tag by name",
  9305. "operationId": "repoDeleteTag",
  9306. "parameters": [
  9307. {
  9308. "type": "string",
  9309. "description": "owner of the repo",
  9310. "name": "owner",
  9311. "in": "path",
  9312. "required": true
  9313. },
  9314. {
  9315. "type": "string",
  9316. "description": "name of the repo",
  9317. "name": "repo",
  9318. "in": "path",
  9319. "required": true
  9320. },
  9321. {
  9322. "type": "string",
  9323. "description": "name of tag to delete",
  9324. "name": "tag",
  9325. "in": "path",
  9326. "required": true
  9327. }
  9328. ],
  9329. "responses": {
  9330. "204": {
  9331. "$ref": "#/responses/empty"
  9332. },
  9333. "404": {
  9334. "$ref": "#/responses/notFound"
  9335. },
  9336. "409": {
  9337. "$ref": "#/responses/conflict"
  9338. }
  9339. }
  9340. }
  9341. },
  9342. "/repos/{owner}/{repo}/teams": {
  9343. "get": {
  9344. "produces": [
  9345. "application/json"
  9346. ],
  9347. "tags": [
  9348. "repository"
  9349. ],
  9350. "summary": "List a repository's teams",
  9351. "operationId": "repoListTeams",
  9352. "parameters": [
  9353. {
  9354. "type": "string",
  9355. "description": "owner of the repo",
  9356. "name": "owner",
  9357. "in": "path",
  9358. "required": true
  9359. },
  9360. {
  9361. "type": "string",
  9362. "description": "name of the repo",
  9363. "name": "repo",
  9364. "in": "path",
  9365. "required": true
  9366. }
  9367. ],
  9368. "responses": {
  9369. "200": {
  9370. "$ref": "#/responses/TeamList"
  9371. }
  9372. }
  9373. }
  9374. },
  9375. "/repos/{owner}/{repo}/teams/{team}": {
  9376. "get": {
  9377. "produces": [
  9378. "application/json"
  9379. ],
  9380. "tags": [
  9381. "repository"
  9382. ],
  9383. "summary": "Check if a team is assigned to a repository",
  9384. "operationId": "repoCheckTeam",
  9385. "parameters": [
  9386. {
  9387. "type": "string",
  9388. "description": "owner of the repo",
  9389. "name": "owner",
  9390. "in": "path",
  9391. "required": true
  9392. },
  9393. {
  9394. "type": "string",
  9395. "description": "name of the repo",
  9396. "name": "repo",
  9397. "in": "path",
  9398. "required": true
  9399. },
  9400. {
  9401. "type": "string",
  9402. "description": "team name",
  9403. "name": "team",
  9404. "in": "path",
  9405. "required": true
  9406. }
  9407. ],
  9408. "responses": {
  9409. "200": {
  9410. "$ref": "#/responses/Team"
  9411. },
  9412. "404": {
  9413. "$ref": "#/responses/notFound"
  9414. },
  9415. "405": {
  9416. "$ref": "#/responses/error"
  9417. }
  9418. }
  9419. },
  9420. "put": {
  9421. "produces": [
  9422. "application/json"
  9423. ],
  9424. "tags": [
  9425. "repository"
  9426. ],
  9427. "summary": "Add a team to a repository",
  9428. "operationId": "repoAddTeam",
  9429. "parameters": [
  9430. {
  9431. "type": "string",
  9432. "description": "owner of the repo",
  9433. "name": "owner",
  9434. "in": "path",
  9435. "required": true
  9436. },
  9437. {
  9438. "type": "string",
  9439. "description": "name of the repo",
  9440. "name": "repo",
  9441. "in": "path",
  9442. "required": true
  9443. },
  9444. {
  9445. "type": "string",
  9446. "description": "team name",
  9447. "name": "team",
  9448. "in": "path",
  9449. "required": true
  9450. }
  9451. ],
  9452. "responses": {
  9453. "204": {
  9454. "$ref": "#/responses/empty"
  9455. },
  9456. "405": {
  9457. "$ref": "#/responses/error"
  9458. },
  9459. "422": {
  9460. "$ref": "#/responses/validationError"
  9461. }
  9462. }
  9463. },
  9464. "delete": {
  9465. "produces": [
  9466. "application/json"
  9467. ],
  9468. "tags": [
  9469. "repository"
  9470. ],
  9471. "summary": "Delete a team from a repository",
  9472. "operationId": "repoDeleteTeam",
  9473. "parameters": [
  9474. {
  9475. "type": "string",
  9476. "description": "owner of the repo",
  9477. "name": "owner",
  9478. "in": "path",
  9479. "required": true
  9480. },
  9481. {
  9482. "type": "string",
  9483. "description": "name of the repo",
  9484. "name": "repo",
  9485. "in": "path",
  9486. "required": true
  9487. },
  9488. {
  9489. "type": "string",
  9490. "description": "team name",
  9491. "name": "team",
  9492. "in": "path",
  9493. "required": true
  9494. }
  9495. ],
  9496. "responses": {
  9497. "204": {
  9498. "$ref": "#/responses/empty"
  9499. },
  9500. "405": {
  9501. "$ref": "#/responses/error"
  9502. },
  9503. "422": {
  9504. "$ref": "#/responses/validationError"
  9505. }
  9506. }
  9507. }
  9508. },
  9509. "/repos/{owner}/{repo}/times": {
  9510. "get": {
  9511. "produces": [
  9512. "application/json"
  9513. ],
  9514. "tags": [
  9515. "repository"
  9516. ],
  9517. "summary": "List a repo's tracked times",
  9518. "operationId": "repoTrackedTimes",
  9519. "parameters": [
  9520. {
  9521. "type": "string",
  9522. "description": "owner of the repo",
  9523. "name": "owner",
  9524. "in": "path",
  9525. "required": true
  9526. },
  9527. {
  9528. "type": "string",
  9529. "description": "name of the repo",
  9530. "name": "repo",
  9531. "in": "path",
  9532. "required": true
  9533. },
  9534. {
  9535. "type": "string",
  9536. "description": "optional filter by user (available for issue managers)",
  9537. "name": "user",
  9538. "in": "query"
  9539. },
  9540. {
  9541. "type": "string",
  9542. "format": "date-time",
  9543. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9544. "name": "since",
  9545. "in": "query"
  9546. },
  9547. {
  9548. "type": "string",
  9549. "format": "date-time",
  9550. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9551. "name": "before",
  9552. "in": "query"
  9553. },
  9554. {
  9555. "type": "integer",
  9556. "description": "page number of results to return (1-based)",
  9557. "name": "page",
  9558. "in": "query"
  9559. },
  9560. {
  9561. "type": "integer",
  9562. "description": "page size of results",
  9563. "name": "limit",
  9564. "in": "query"
  9565. }
  9566. ],
  9567. "responses": {
  9568. "200": {
  9569. "$ref": "#/responses/TrackedTimeList"
  9570. },
  9571. "400": {
  9572. "$ref": "#/responses/error"
  9573. },
  9574. "403": {
  9575. "$ref": "#/responses/forbidden"
  9576. }
  9577. }
  9578. }
  9579. },
  9580. "/repos/{owner}/{repo}/times/{user}": {
  9581. "get": {
  9582. "produces": [
  9583. "application/json"
  9584. ],
  9585. "tags": [
  9586. "repository"
  9587. ],
  9588. "summary": "List a user's tracked times in a repo",
  9589. "operationId": "userTrackedTimes",
  9590. "deprecated": true,
  9591. "parameters": [
  9592. {
  9593. "type": "string",
  9594. "description": "owner of the repo",
  9595. "name": "owner",
  9596. "in": "path",
  9597. "required": true
  9598. },
  9599. {
  9600. "type": "string",
  9601. "description": "name of the repo",
  9602. "name": "repo",
  9603. "in": "path",
  9604. "required": true
  9605. },
  9606. {
  9607. "type": "string",
  9608. "description": "username of user",
  9609. "name": "user",
  9610. "in": "path",
  9611. "required": true
  9612. }
  9613. ],
  9614. "responses": {
  9615. "200": {
  9616. "$ref": "#/responses/TrackedTimeList"
  9617. },
  9618. "400": {
  9619. "$ref": "#/responses/error"
  9620. },
  9621. "403": {
  9622. "$ref": "#/responses/forbidden"
  9623. }
  9624. }
  9625. }
  9626. },
  9627. "/repos/{owner}/{repo}/topics": {
  9628. "get": {
  9629. "produces": [
  9630. "application/json"
  9631. ],
  9632. "tags": [
  9633. "repository"
  9634. ],
  9635. "summary": "Get list of topics that a repository has",
  9636. "operationId": "repoListTopics",
  9637. "parameters": [
  9638. {
  9639. "type": "string",
  9640. "description": "owner of the repo",
  9641. "name": "owner",
  9642. "in": "path",
  9643. "required": true
  9644. },
  9645. {
  9646. "type": "string",
  9647. "description": "name of the repo",
  9648. "name": "repo",
  9649. "in": "path",
  9650. "required": true
  9651. },
  9652. {
  9653. "type": "integer",
  9654. "description": "page number of results to return (1-based)",
  9655. "name": "page",
  9656. "in": "query"
  9657. },
  9658. {
  9659. "type": "integer",
  9660. "description": "page size of results",
  9661. "name": "limit",
  9662. "in": "query"
  9663. }
  9664. ],
  9665. "responses": {
  9666. "200": {
  9667. "$ref": "#/responses/TopicNames"
  9668. }
  9669. }
  9670. },
  9671. "put": {
  9672. "produces": [
  9673. "application/json"
  9674. ],
  9675. "tags": [
  9676. "repository"
  9677. ],
  9678. "summary": "Replace list of topics for a repository",
  9679. "operationId": "repoUpdateTopics",
  9680. "parameters": [
  9681. {
  9682. "type": "string",
  9683. "description": "owner of the repo",
  9684. "name": "owner",
  9685. "in": "path",
  9686. "required": true
  9687. },
  9688. {
  9689. "type": "string",
  9690. "description": "name of the repo",
  9691. "name": "repo",
  9692. "in": "path",
  9693. "required": true
  9694. },
  9695. {
  9696. "name": "body",
  9697. "in": "body",
  9698. "schema": {
  9699. "$ref": "#/definitions/RepoTopicOptions"
  9700. }
  9701. }
  9702. ],
  9703. "responses": {
  9704. "204": {
  9705. "$ref": "#/responses/empty"
  9706. },
  9707. "422": {
  9708. "$ref": "#/responses/invalidTopicsError"
  9709. }
  9710. }
  9711. }
  9712. },
  9713. "/repos/{owner}/{repo}/topics/{topic}": {
  9714. "put": {
  9715. "produces": [
  9716. "application/json"
  9717. ],
  9718. "tags": [
  9719. "repository"
  9720. ],
  9721. "summary": "Add a topic to a repository",
  9722. "operationId": "repoAddTopic",
  9723. "parameters": [
  9724. {
  9725. "type": "string",
  9726. "description": "owner of the repo",
  9727. "name": "owner",
  9728. "in": "path",
  9729. "required": true
  9730. },
  9731. {
  9732. "type": "string",
  9733. "description": "name of the repo",
  9734. "name": "repo",
  9735. "in": "path",
  9736. "required": true
  9737. },
  9738. {
  9739. "type": "string",
  9740. "description": "name of the topic to add",
  9741. "name": "topic",
  9742. "in": "path",
  9743. "required": true
  9744. }
  9745. ],
  9746. "responses": {
  9747. "204": {
  9748. "$ref": "#/responses/empty"
  9749. },
  9750. "422": {
  9751. "$ref": "#/responses/invalidTopicsError"
  9752. }
  9753. }
  9754. },
  9755. "delete": {
  9756. "produces": [
  9757. "application/json"
  9758. ],
  9759. "tags": [
  9760. "repository"
  9761. ],
  9762. "summary": "Delete a topic from a repository",
  9763. "operationId": "repoDeleteTopic",
  9764. "parameters": [
  9765. {
  9766. "type": "string",
  9767. "description": "owner of the repo",
  9768. "name": "owner",
  9769. "in": "path",
  9770. "required": true
  9771. },
  9772. {
  9773. "type": "string",
  9774. "description": "name of the repo",
  9775. "name": "repo",
  9776. "in": "path",
  9777. "required": true
  9778. },
  9779. {
  9780. "type": "string",
  9781. "description": "name of the topic to delete",
  9782. "name": "topic",
  9783. "in": "path",
  9784. "required": true
  9785. }
  9786. ],
  9787. "responses": {
  9788. "204": {
  9789. "$ref": "#/responses/empty"
  9790. },
  9791. "422": {
  9792. "$ref": "#/responses/invalidTopicsError"
  9793. }
  9794. }
  9795. }
  9796. },
  9797. "/repos/{owner}/{repo}/transfer": {
  9798. "post": {
  9799. "produces": [
  9800. "application/json"
  9801. ],
  9802. "tags": [
  9803. "repository"
  9804. ],
  9805. "summary": "Transfer a repo ownership",
  9806. "operationId": "repoTransfer",
  9807. "parameters": [
  9808. {
  9809. "type": "string",
  9810. "description": "owner of the repo to transfer",
  9811. "name": "owner",
  9812. "in": "path",
  9813. "required": true
  9814. },
  9815. {
  9816. "type": "string",
  9817. "description": "name of the repo to transfer",
  9818. "name": "repo",
  9819. "in": "path",
  9820. "required": true
  9821. },
  9822. {
  9823. "description": "Transfer Options",
  9824. "name": "body",
  9825. "in": "body",
  9826. "required": true,
  9827. "schema": {
  9828. "$ref": "#/definitions/TransferRepoOption"
  9829. }
  9830. }
  9831. ],
  9832. "responses": {
  9833. "202": {
  9834. "$ref": "#/responses/Repository"
  9835. },
  9836. "403": {
  9837. "$ref": "#/responses/forbidden"
  9838. },
  9839. "404": {
  9840. "$ref": "#/responses/notFound"
  9841. },
  9842. "422": {
  9843. "$ref": "#/responses/validationError"
  9844. }
  9845. }
  9846. }
  9847. },
  9848. "/repos/{template_owner}/{template_repo}/generate": {
  9849. "post": {
  9850. "consumes": [
  9851. "application/json"
  9852. ],
  9853. "produces": [
  9854. "application/json"
  9855. ],
  9856. "tags": [
  9857. "repository"
  9858. ],
  9859. "summary": "Create a repository using a template",
  9860. "operationId": "generateRepo",
  9861. "parameters": [
  9862. {
  9863. "type": "string",
  9864. "description": "name of the template repository owner",
  9865. "name": "template_owner",
  9866. "in": "path",
  9867. "required": true
  9868. },
  9869. {
  9870. "type": "string",
  9871. "description": "name of the template repository",
  9872. "name": "template_repo",
  9873. "in": "path",
  9874. "required": true
  9875. },
  9876. {
  9877. "name": "body",
  9878. "in": "body",
  9879. "schema": {
  9880. "$ref": "#/definitions/GenerateRepoOption"
  9881. }
  9882. }
  9883. ],
  9884. "responses": {
  9885. "201": {
  9886. "$ref": "#/responses/Repository"
  9887. },
  9888. "403": {
  9889. "$ref": "#/responses/forbidden"
  9890. },
  9891. "404": {
  9892. "$ref": "#/responses/notFound"
  9893. },
  9894. "409": {
  9895. "description": "The repository with the same name already exists."
  9896. },
  9897. "422": {
  9898. "$ref": "#/responses/validationError"
  9899. }
  9900. }
  9901. }
  9902. },
  9903. "/repositories/{id}": {
  9904. "get": {
  9905. "produces": [
  9906. "application/json"
  9907. ],
  9908. "tags": [
  9909. "repository"
  9910. ],
  9911. "summary": "Get a repository by id",
  9912. "operationId": "repoGetByID",
  9913. "parameters": [
  9914. {
  9915. "type": "integer",
  9916. "format": "int64",
  9917. "description": "id of the repo to get",
  9918. "name": "id",
  9919. "in": "path",
  9920. "required": true
  9921. }
  9922. ],
  9923. "responses": {
  9924. "200": {
  9925. "$ref": "#/responses/Repository"
  9926. }
  9927. }
  9928. }
  9929. },
  9930. "/settings/api": {
  9931. "get": {
  9932. "produces": [
  9933. "application/json"
  9934. ],
  9935. "tags": [
  9936. "settings"
  9937. ],
  9938. "summary": "Get instance's global settings for api",
  9939. "operationId": "getGeneralAPISettings",
  9940. "responses": {
  9941. "200": {
  9942. "$ref": "#/responses/GeneralAPISettings"
  9943. }
  9944. }
  9945. }
  9946. },
  9947. "/settings/attachment": {
  9948. "get": {
  9949. "produces": [
  9950. "application/json"
  9951. ],
  9952. "tags": [
  9953. "settings"
  9954. ],
  9955. "summary": "Get instance's global settings for Attachment",
  9956. "operationId": "getGeneralAttachmentSettings",
  9957. "responses": {
  9958. "200": {
  9959. "$ref": "#/responses/GeneralAttachmentSettings"
  9960. }
  9961. }
  9962. }
  9963. },
  9964. "/settings/repository": {
  9965. "get": {
  9966. "produces": [
  9967. "application/json"
  9968. ],
  9969. "tags": [
  9970. "settings"
  9971. ],
  9972. "summary": "Get instance's global settings for repositories",
  9973. "operationId": "getGeneralRepositorySettings",
  9974. "responses": {
  9975. "200": {
  9976. "$ref": "#/responses/GeneralRepoSettings"
  9977. }
  9978. }
  9979. }
  9980. },
  9981. "/settings/ui": {
  9982. "get": {
  9983. "produces": [
  9984. "application/json"
  9985. ],
  9986. "tags": [
  9987. "settings"
  9988. ],
  9989. "summary": "Get instance's global settings for ui",
  9990. "operationId": "getGeneralUISettings",
  9991. "responses": {
  9992. "200": {
  9993. "$ref": "#/responses/GeneralUISettings"
  9994. }
  9995. }
  9996. }
  9997. },
  9998. "/signing-key.gpg": {
  9999. "get": {
  10000. "produces": [
  10001. "text/plain"
  10002. ],
  10003. "tags": [
  10004. "miscellaneous"
  10005. ],
  10006. "summary": "Get default signing-key.gpg",
  10007. "operationId": "getSigningKey",
  10008. "responses": {
  10009. "200": {
  10010. "description": "GPG armored public key",
  10011. "schema": {
  10012. "type": "string"
  10013. }
  10014. }
  10015. }
  10016. }
  10017. },
  10018. "/teams/{id}": {
  10019. "get": {
  10020. "produces": [
  10021. "application/json"
  10022. ],
  10023. "tags": [
  10024. "organization"
  10025. ],
  10026. "summary": "Get a team",
  10027. "operationId": "orgGetTeam",
  10028. "parameters": [
  10029. {
  10030. "type": "integer",
  10031. "format": "int64",
  10032. "description": "id of the team to get",
  10033. "name": "id",
  10034. "in": "path",
  10035. "required": true
  10036. }
  10037. ],
  10038. "responses": {
  10039. "200": {
  10040. "$ref": "#/responses/Team"
  10041. }
  10042. }
  10043. },
  10044. "delete": {
  10045. "tags": [
  10046. "organization"
  10047. ],
  10048. "summary": "Delete a team",
  10049. "operationId": "orgDeleteTeam",
  10050. "parameters": [
  10051. {
  10052. "type": "integer",
  10053. "format": "int64",
  10054. "description": "id of the team to delete",
  10055. "name": "id",
  10056. "in": "path",
  10057. "required": true
  10058. }
  10059. ],
  10060. "responses": {
  10061. "204": {
  10062. "description": "team deleted"
  10063. }
  10064. }
  10065. },
  10066. "patch": {
  10067. "consumes": [
  10068. "application/json"
  10069. ],
  10070. "produces": [
  10071. "application/json"
  10072. ],
  10073. "tags": [
  10074. "organization"
  10075. ],
  10076. "summary": "Edit a team",
  10077. "operationId": "orgEditTeam",
  10078. "parameters": [
  10079. {
  10080. "type": "integer",
  10081. "description": "id of the team to edit",
  10082. "name": "id",
  10083. "in": "path",
  10084. "required": true
  10085. },
  10086. {
  10087. "name": "body",
  10088. "in": "body",
  10089. "schema": {
  10090. "$ref": "#/definitions/EditTeamOption"
  10091. }
  10092. }
  10093. ],
  10094. "responses": {
  10095. "200": {
  10096. "$ref": "#/responses/Team"
  10097. }
  10098. }
  10099. }
  10100. },
  10101. "/teams/{id}/members": {
  10102. "get": {
  10103. "produces": [
  10104. "application/json"
  10105. ],
  10106. "tags": [
  10107. "organization"
  10108. ],
  10109. "summary": "List a team's members",
  10110. "operationId": "orgListTeamMembers",
  10111. "parameters": [
  10112. {
  10113. "type": "integer",
  10114. "format": "int64",
  10115. "description": "id of the team",
  10116. "name": "id",
  10117. "in": "path",
  10118. "required": true
  10119. },
  10120. {
  10121. "type": "integer",
  10122. "description": "page number of results to return (1-based)",
  10123. "name": "page",
  10124. "in": "query"
  10125. },
  10126. {
  10127. "type": "integer",
  10128. "description": "page size of results",
  10129. "name": "limit",
  10130. "in": "query"
  10131. }
  10132. ],
  10133. "responses": {
  10134. "200": {
  10135. "$ref": "#/responses/UserList"
  10136. }
  10137. }
  10138. }
  10139. },
  10140. "/teams/{id}/members/{username}": {
  10141. "get": {
  10142. "produces": [
  10143. "application/json"
  10144. ],
  10145. "tags": [
  10146. "organization"
  10147. ],
  10148. "summary": "List a particular member of team",
  10149. "operationId": "orgListTeamMember",
  10150. "parameters": [
  10151. {
  10152. "type": "integer",
  10153. "format": "int64",
  10154. "description": "id of the team",
  10155. "name": "id",
  10156. "in": "path",
  10157. "required": true
  10158. },
  10159. {
  10160. "type": "string",
  10161. "description": "username of the member to list",
  10162. "name": "username",
  10163. "in": "path",
  10164. "required": true
  10165. }
  10166. ],
  10167. "responses": {
  10168. "200": {
  10169. "$ref": "#/responses/User"
  10170. },
  10171. "404": {
  10172. "$ref": "#/responses/notFound"
  10173. }
  10174. }
  10175. },
  10176. "put": {
  10177. "produces": [
  10178. "application/json"
  10179. ],
  10180. "tags": [
  10181. "organization"
  10182. ],
  10183. "summary": "Add a team member",
  10184. "operationId": "orgAddTeamMember",
  10185. "parameters": [
  10186. {
  10187. "type": "integer",
  10188. "format": "int64",
  10189. "description": "id of the team",
  10190. "name": "id",
  10191. "in": "path",
  10192. "required": true
  10193. },
  10194. {
  10195. "type": "string",
  10196. "description": "username of the user to add",
  10197. "name": "username",
  10198. "in": "path",
  10199. "required": true
  10200. }
  10201. ],
  10202. "responses": {
  10203. "204": {
  10204. "$ref": "#/responses/empty"
  10205. },
  10206. "404": {
  10207. "$ref": "#/responses/notFound"
  10208. }
  10209. }
  10210. },
  10211. "delete": {
  10212. "produces": [
  10213. "application/json"
  10214. ],
  10215. "tags": [
  10216. "organization"
  10217. ],
  10218. "summary": "Remove a team member",
  10219. "operationId": "orgRemoveTeamMember",
  10220. "parameters": [
  10221. {
  10222. "type": "integer",
  10223. "format": "int64",
  10224. "description": "id of the team",
  10225. "name": "id",
  10226. "in": "path",
  10227. "required": true
  10228. },
  10229. {
  10230. "type": "string",
  10231. "description": "username of the user to remove",
  10232. "name": "username",
  10233. "in": "path",
  10234. "required": true
  10235. }
  10236. ],
  10237. "responses": {
  10238. "204": {
  10239. "$ref": "#/responses/empty"
  10240. },
  10241. "404": {
  10242. "$ref": "#/responses/notFound"
  10243. }
  10244. }
  10245. }
  10246. },
  10247. "/teams/{id}/repos": {
  10248. "get": {
  10249. "produces": [
  10250. "application/json"
  10251. ],
  10252. "tags": [
  10253. "organization"
  10254. ],
  10255. "summary": "List a team's repos",
  10256. "operationId": "orgListTeamRepos",
  10257. "parameters": [
  10258. {
  10259. "type": "integer",
  10260. "format": "int64",
  10261. "description": "id of the team",
  10262. "name": "id",
  10263. "in": "path",
  10264. "required": true
  10265. },
  10266. {
  10267. "type": "integer",
  10268. "description": "page number of results to return (1-based)",
  10269. "name": "page",
  10270. "in": "query"
  10271. },
  10272. {
  10273. "type": "integer",
  10274. "description": "page size of results",
  10275. "name": "limit",
  10276. "in": "query"
  10277. }
  10278. ],
  10279. "responses": {
  10280. "200": {
  10281. "$ref": "#/responses/RepositoryList"
  10282. }
  10283. }
  10284. }
  10285. },
  10286. "/teams/{id}/repos/{org}/{repo}": {
  10287. "put": {
  10288. "produces": [
  10289. "application/json"
  10290. ],
  10291. "tags": [
  10292. "organization"
  10293. ],
  10294. "summary": "Add a repository to a team",
  10295. "operationId": "orgAddTeamRepository",
  10296. "parameters": [
  10297. {
  10298. "type": "integer",
  10299. "format": "int64",
  10300. "description": "id of the team",
  10301. "name": "id",
  10302. "in": "path",
  10303. "required": true
  10304. },
  10305. {
  10306. "type": "string",
  10307. "description": "organization that owns the repo to add",
  10308. "name": "org",
  10309. "in": "path",
  10310. "required": true
  10311. },
  10312. {
  10313. "type": "string",
  10314. "description": "name of the repo to add",
  10315. "name": "repo",
  10316. "in": "path",
  10317. "required": true
  10318. }
  10319. ],
  10320. "responses": {
  10321. "204": {
  10322. "$ref": "#/responses/empty"
  10323. },
  10324. "403": {
  10325. "$ref": "#/responses/forbidden"
  10326. }
  10327. }
  10328. },
  10329. "delete": {
  10330. "description": "This does not delete the repository, it only removes the repository from the team.",
  10331. "produces": [
  10332. "application/json"
  10333. ],
  10334. "tags": [
  10335. "organization"
  10336. ],
  10337. "summary": "Remove a repository from a team",
  10338. "operationId": "orgRemoveTeamRepository",
  10339. "parameters": [
  10340. {
  10341. "type": "integer",
  10342. "format": "int64",
  10343. "description": "id of the team",
  10344. "name": "id",
  10345. "in": "path",
  10346. "required": true
  10347. },
  10348. {
  10349. "type": "string",
  10350. "description": "organization that owns the repo to remove",
  10351. "name": "org",
  10352. "in": "path",
  10353. "required": true
  10354. },
  10355. {
  10356. "type": "string",
  10357. "description": "name of the repo to remove",
  10358. "name": "repo",
  10359. "in": "path",
  10360. "required": true
  10361. }
  10362. ],
  10363. "responses": {
  10364. "204": {
  10365. "$ref": "#/responses/empty"
  10366. },
  10367. "403": {
  10368. "$ref": "#/responses/forbidden"
  10369. }
  10370. }
  10371. }
  10372. },
  10373. "/topics/search": {
  10374. "get": {
  10375. "produces": [
  10376. "application/json"
  10377. ],
  10378. "tags": [
  10379. "repository"
  10380. ],
  10381. "summary": "search topics via keyword",
  10382. "operationId": "topicSearch",
  10383. "parameters": [
  10384. {
  10385. "type": "string",
  10386. "description": "keywords to search",
  10387. "name": "q",
  10388. "in": "query",
  10389. "required": true
  10390. },
  10391. {
  10392. "type": "integer",
  10393. "description": "page number of results to return (1-based)",
  10394. "name": "page",
  10395. "in": "query"
  10396. },
  10397. {
  10398. "type": "integer",
  10399. "description": "page size of results",
  10400. "name": "limit",
  10401. "in": "query"
  10402. }
  10403. ],
  10404. "responses": {
  10405. "200": {
  10406. "$ref": "#/responses/TopicListResponse"
  10407. },
  10408. "403": {
  10409. "$ref": "#/responses/forbidden"
  10410. }
  10411. }
  10412. }
  10413. },
  10414. "/user": {
  10415. "get": {
  10416. "produces": [
  10417. "application/json"
  10418. ],
  10419. "tags": [
  10420. "user"
  10421. ],
  10422. "summary": "Get the authenticated user",
  10423. "operationId": "userGetCurrent",
  10424. "responses": {
  10425. "200": {
  10426. "$ref": "#/responses/User"
  10427. }
  10428. }
  10429. }
  10430. },
  10431. "/user/applications/oauth2": {
  10432. "get": {
  10433. "produces": [
  10434. "application/json"
  10435. ],
  10436. "tags": [
  10437. "user"
  10438. ],
  10439. "summary": "List the authenticated user's oauth2 applications",
  10440. "operationId": "userGetOauth2Application",
  10441. "parameters": [
  10442. {
  10443. "type": "integer",
  10444. "description": "page number of results to return (1-based)",
  10445. "name": "page",
  10446. "in": "query"
  10447. },
  10448. {
  10449. "type": "integer",
  10450. "description": "page size of results",
  10451. "name": "limit",
  10452. "in": "query"
  10453. }
  10454. ],
  10455. "responses": {
  10456. "200": {
  10457. "$ref": "#/responses/OAuth2ApplicationList"
  10458. }
  10459. }
  10460. },
  10461. "post": {
  10462. "produces": [
  10463. "application/json"
  10464. ],
  10465. "tags": [
  10466. "user"
  10467. ],
  10468. "summary": "creates a new OAuth2 application",
  10469. "operationId": "userCreateOAuth2Application",
  10470. "parameters": [
  10471. {
  10472. "name": "body",
  10473. "in": "body",
  10474. "required": true,
  10475. "schema": {
  10476. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  10477. }
  10478. }
  10479. ],
  10480. "responses": {
  10481. "201": {
  10482. "$ref": "#/responses/OAuth2Application"
  10483. },
  10484. "400": {
  10485. "$ref": "#/responses/error"
  10486. }
  10487. }
  10488. }
  10489. },
  10490. "/user/applications/oauth2/{id}": {
  10491. "get": {
  10492. "produces": [
  10493. "application/json"
  10494. ],
  10495. "tags": [
  10496. "user"
  10497. ],
  10498. "summary": "get an OAuth2 Application",
  10499. "operationId": "userGetOAuth2Application",
  10500. "parameters": [
  10501. {
  10502. "type": "integer",
  10503. "format": "int64",
  10504. "description": "Application ID to be found",
  10505. "name": "id",
  10506. "in": "path",
  10507. "required": true
  10508. }
  10509. ],
  10510. "responses": {
  10511. "200": {
  10512. "$ref": "#/responses/OAuth2Application"
  10513. },
  10514. "404": {
  10515. "$ref": "#/responses/notFound"
  10516. }
  10517. }
  10518. },
  10519. "delete": {
  10520. "produces": [
  10521. "application/json"
  10522. ],
  10523. "tags": [
  10524. "user"
  10525. ],
  10526. "summary": "delete an OAuth2 Application",
  10527. "operationId": "userDeleteOAuth2Application",
  10528. "parameters": [
  10529. {
  10530. "type": "integer",
  10531. "format": "int64",
  10532. "description": "token to be deleted",
  10533. "name": "id",
  10534. "in": "path",
  10535. "required": true
  10536. }
  10537. ],
  10538. "responses": {
  10539. "204": {
  10540. "$ref": "#/responses/empty"
  10541. },
  10542. "404": {
  10543. "$ref": "#/responses/notFound"
  10544. }
  10545. }
  10546. },
  10547. "patch": {
  10548. "produces": [
  10549. "application/json"
  10550. ],
  10551. "tags": [
  10552. "user"
  10553. ],
  10554. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  10555. "operationId": "userUpdateOAuth2Application",
  10556. "parameters": [
  10557. {
  10558. "type": "integer",
  10559. "format": "int64",
  10560. "description": "application to be updated",
  10561. "name": "id",
  10562. "in": "path",
  10563. "required": true
  10564. },
  10565. {
  10566. "name": "body",
  10567. "in": "body",
  10568. "required": true,
  10569. "schema": {
  10570. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  10571. }
  10572. }
  10573. ],
  10574. "responses": {
  10575. "200": {
  10576. "$ref": "#/responses/OAuth2Application"
  10577. },
  10578. "404": {
  10579. "$ref": "#/responses/notFound"
  10580. }
  10581. }
  10582. }
  10583. },
  10584. "/user/emails": {
  10585. "get": {
  10586. "produces": [
  10587. "application/json"
  10588. ],
  10589. "tags": [
  10590. "user"
  10591. ],
  10592. "summary": "List the authenticated user's email addresses",
  10593. "operationId": "userListEmails",
  10594. "responses": {
  10595. "200": {
  10596. "$ref": "#/responses/EmailList"
  10597. }
  10598. }
  10599. },
  10600. "post": {
  10601. "produces": [
  10602. "application/json"
  10603. ],
  10604. "tags": [
  10605. "user"
  10606. ],
  10607. "summary": "Add email addresses",
  10608. "operationId": "userAddEmail",
  10609. "parameters": [
  10610. {
  10611. "name": "body",
  10612. "in": "body",
  10613. "schema": {
  10614. "$ref": "#/definitions/CreateEmailOption"
  10615. }
  10616. }
  10617. ],
  10618. "responses": {
  10619. "201": {
  10620. "$ref": "#/responses/EmailList"
  10621. },
  10622. "422": {
  10623. "$ref": "#/responses/validationError"
  10624. }
  10625. }
  10626. },
  10627. "delete": {
  10628. "produces": [
  10629. "application/json"
  10630. ],
  10631. "tags": [
  10632. "user"
  10633. ],
  10634. "summary": "Delete email addresses",
  10635. "operationId": "userDeleteEmail",
  10636. "parameters": [
  10637. {
  10638. "name": "body",
  10639. "in": "body",
  10640. "schema": {
  10641. "$ref": "#/definitions/DeleteEmailOption"
  10642. }
  10643. }
  10644. ],
  10645. "responses": {
  10646. "204": {
  10647. "$ref": "#/responses/empty"
  10648. },
  10649. "404": {
  10650. "$ref": "#/responses/notFound"
  10651. }
  10652. }
  10653. }
  10654. },
  10655. "/user/followers": {
  10656. "get": {
  10657. "produces": [
  10658. "application/json"
  10659. ],
  10660. "tags": [
  10661. "user"
  10662. ],
  10663. "summary": "List the authenticated user's followers",
  10664. "operationId": "userCurrentListFollowers",
  10665. "parameters": [
  10666. {
  10667. "type": "integer",
  10668. "description": "page number of results to return (1-based)",
  10669. "name": "page",
  10670. "in": "query"
  10671. },
  10672. {
  10673. "type": "integer",
  10674. "description": "page size of results",
  10675. "name": "limit",
  10676. "in": "query"
  10677. }
  10678. ],
  10679. "responses": {
  10680. "200": {
  10681. "$ref": "#/responses/UserList"
  10682. }
  10683. }
  10684. }
  10685. },
  10686. "/user/following": {
  10687. "get": {
  10688. "produces": [
  10689. "application/json"
  10690. ],
  10691. "tags": [
  10692. "user"
  10693. ],
  10694. "summary": "List the users that the authenticated user is following",
  10695. "operationId": "userCurrentListFollowing",
  10696. "parameters": [
  10697. {
  10698. "type": "integer",
  10699. "description": "page number of results to return (1-based)",
  10700. "name": "page",
  10701. "in": "query"
  10702. },
  10703. {
  10704. "type": "integer",
  10705. "description": "page size of results",
  10706. "name": "limit",
  10707. "in": "query"
  10708. }
  10709. ],
  10710. "responses": {
  10711. "200": {
  10712. "$ref": "#/responses/UserList"
  10713. }
  10714. }
  10715. }
  10716. },
  10717. "/user/following/{username}": {
  10718. "get": {
  10719. "tags": [
  10720. "user"
  10721. ],
  10722. "summary": "Check whether a user is followed by the authenticated user",
  10723. "operationId": "userCurrentCheckFollowing",
  10724. "parameters": [
  10725. {
  10726. "type": "string",
  10727. "description": "username of followed user",
  10728. "name": "username",
  10729. "in": "path",
  10730. "required": true
  10731. }
  10732. ],
  10733. "responses": {
  10734. "204": {
  10735. "$ref": "#/responses/empty"
  10736. },
  10737. "404": {
  10738. "$ref": "#/responses/notFound"
  10739. }
  10740. }
  10741. },
  10742. "put": {
  10743. "tags": [
  10744. "user"
  10745. ],
  10746. "summary": "Follow a user",
  10747. "operationId": "userCurrentPutFollow",
  10748. "parameters": [
  10749. {
  10750. "type": "string",
  10751. "description": "username of user to follow",
  10752. "name": "username",
  10753. "in": "path",
  10754. "required": true
  10755. }
  10756. ],
  10757. "responses": {
  10758. "204": {
  10759. "$ref": "#/responses/empty"
  10760. }
  10761. }
  10762. },
  10763. "delete": {
  10764. "tags": [
  10765. "user"
  10766. ],
  10767. "summary": "Unfollow a user",
  10768. "operationId": "userCurrentDeleteFollow",
  10769. "parameters": [
  10770. {
  10771. "type": "string",
  10772. "description": "username of user to unfollow",
  10773. "name": "username",
  10774. "in": "path",
  10775. "required": true
  10776. }
  10777. ],
  10778. "responses": {
  10779. "204": {
  10780. "$ref": "#/responses/empty"
  10781. }
  10782. }
  10783. }
  10784. },
  10785. "/user/gpg_key_token": {
  10786. "get": {
  10787. "produces": [
  10788. "text/plain"
  10789. ],
  10790. "tags": [
  10791. "user"
  10792. ],
  10793. "summary": "Get a Token to verify",
  10794. "operationId": "getVerificationToken",
  10795. "responses": {
  10796. "200": {
  10797. "$ref": "#/responses/string"
  10798. },
  10799. "404": {
  10800. "$ref": "#/responses/notFound"
  10801. }
  10802. }
  10803. }
  10804. },
  10805. "/user/gpg_key_verify": {
  10806. "post": {
  10807. "consumes": [
  10808. "application/json"
  10809. ],
  10810. "produces": [
  10811. "application/json"
  10812. ],
  10813. "tags": [
  10814. "user"
  10815. ],
  10816. "summary": "Verify a GPG key",
  10817. "operationId": "userVerifyGPGKey",
  10818. "responses": {
  10819. "201": {
  10820. "$ref": "#/responses/GPGKey"
  10821. },
  10822. "404": {
  10823. "$ref": "#/responses/notFound"
  10824. },
  10825. "422": {
  10826. "$ref": "#/responses/validationError"
  10827. }
  10828. }
  10829. }
  10830. },
  10831. "/user/gpg_keys": {
  10832. "get": {
  10833. "produces": [
  10834. "application/json"
  10835. ],
  10836. "tags": [
  10837. "user"
  10838. ],
  10839. "summary": "List the authenticated user's GPG keys",
  10840. "operationId": "userCurrentListGPGKeys",
  10841. "parameters": [
  10842. {
  10843. "type": "integer",
  10844. "description": "page number of results to return (1-based)",
  10845. "name": "page",
  10846. "in": "query"
  10847. },
  10848. {
  10849. "type": "integer",
  10850. "description": "page size of results",
  10851. "name": "limit",
  10852. "in": "query"
  10853. }
  10854. ],
  10855. "responses": {
  10856. "200": {
  10857. "$ref": "#/responses/GPGKeyList"
  10858. }
  10859. }
  10860. },
  10861. "post": {
  10862. "consumes": [
  10863. "application/json"
  10864. ],
  10865. "produces": [
  10866. "application/json"
  10867. ],
  10868. "tags": [
  10869. "user"
  10870. ],
  10871. "summary": "Create a GPG key",
  10872. "operationId": "userCurrentPostGPGKey",
  10873. "parameters": [
  10874. {
  10875. "name": "Form",
  10876. "in": "body",
  10877. "schema": {
  10878. "$ref": "#/definitions/CreateGPGKeyOption"
  10879. }
  10880. }
  10881. ],
  10882. "responses": {
  10883. "201": {
  10884. "$ref": "#/responses/GPGKey"
  10885. },
  10886. "404": {
  10887. "$ref": "#/responses/notFound"
  10888. },
  10889. "422": {
  10890. "$ref": "#/responses/validationError"
  10891. }
  10892. }
  10893. }
  10894. },
  10895. "/user/gpg_keys/{id}": {
  10896. "get": {
  10897. "produces": [
  10898. "application/json"
  10899. ],
  10900. "tags": [
  10901. "user"
  10902. ],
  10903. "summary": "Get a GPG key",
  10904. "operationId": "userCurrentGetGPGKey",
  10905. "parameters": [
  10906. {
  10907. "type": "integer",
  10908. "format": "int64",
  10909. "description": "id of key to get",
  10910. "name": "id",
  10911. "in": "path",
  10912. "required": true
  10913. }
  10914. ],
  10915. "responses": {
  10916. "200": {
  10917. "$ref": "#/responses/GPGKey"
  10918. },
  10919. "404": {
  10920. "$ref": "#/responses/notFound"
  10921. }
  10922. }
  10923. },
  10924. "delete": {
  10925. "produces": [
  10926. "application/json"
  10927. ],
  10928. "tags": [
  10929. "user"
  10930. ],
  10931. "summary": "Remove a GPG key",
  10932. "operationId": "userCurrentDeleteGPGKey",
  10933. "parameters": [
  10934. {
  10935. "type": "integer",
  10936. "format": "int64",
  10937. "description": "id of key to delete",
  10938. "name": "id",
  10939. "in": "path",
  10940. "required": true
  10941. }
  10942. ],
  10943. "responses": {
  10944. "204": {
  10945. "$ref": "#/responses/empty"
  10946. },
  10947. "403": {
  10948. "$ref": "#/responses/forbidden"
  10949. },
  10950. "404": {
  10951. "$ref": "#/responses/notFound"
  10952. }
  10953. }
  10954. }
  10955. },
  10956. "/user/keys": {
  10957. "get": {
  10958. "produces": [
  10959. "application/json"
  10960. ],
  10961. "tags": [
  10962. "user"
  10963. ],
  10964. "summary": "List the authenticated user's public keys",
  10965. "operationId": "userCurrentListKeys",
  10966. "parameters": [
  10967. {
  10968. "type": "string",
  10969. "description": "fingerprint of the key",
  10970. "name": "fingerprint",
  10971. "in": "query"
  10972. },
  10973. {
  10974. "type": "integer",
  10975. "description": "page number of results to return (1-based)",
  10976. "name": "page",
  10977. "in": "query"
  10978. },
  10979. {
  10980. "type": "integer",
  10981. "description": "page size of results",
  10982. "name": "limit",
  10983. "in": "query"
  10984. }
  10985. ],
  10986. "responses": {
  10987. "200": {
  10988. "$ref": "#/responses/PublicKeyList"
  10989. }
  10990. }
  10991. },
  10992. "post": {
  10993. "consumes": [
  10994. "application/json"
  10995. ],
  10996. "produces": [
  10997. "application/json"
  10998. ],
  10999. "tags": [
  11000. "user"
  11001. ],
  11002. "summary": "Create a public key",
  11003. "operationId": "userCurrentPostKey",
  11004. "parameters": [
  11005. {
  11006. "name": "body",
  11007. "in": "body",
  11008. "schema": {
  11009. "$ref": "#/definitions/CreateKeyOption"
  11010. }
  11011. }
  11012. ],
  11013. "responses": {
  11014. "201": {
  11015. "$ref": "#/responses/PublicKey"
  11016. },
  11017. "422": {
  11018. "$ref": "#/responses/validationError"
  11019. }
  11020. }
  11021. }
  11022. },
  11023. "/user/keys/{id}": {
  11024. "get": {
  11025. "produces": [
  11026. "application/json"
  11027. ],
  11028. "tags": [
  11029. "user"
  11030. ],
  11031. "summary": "Get a public key",
  11032. "operationId": "userCurrentGetKey",
  11033. "parameters": [
  11034. {
  11035. "type": "integer",
  11036. "format": "int64",
  11037. "description": "id of key to get",
  11038. "name": "id",
  11039. "in": "path",
  11040. "required": true
  11041. }
  11042. ],
  11043. "responses": {
  11044. "200": {
  11045. "$ref": "#/responses/PublicKey"
  11046. },
  11047. "404": {
  11048. "$ref": "#/responses/notFound"
  11049. }
  11050. }
  11051. },
  11052. "delete": {
  11053. "produces": [
  11054. "application/json"
  11055. ],
  11056. "tags": [
  11057. "user"
  11058. ],
  11059. "summary": "Delete a public key",
  11060. "operationId": "userCurrentDeleteKey",
  11061. "parameters": [
  11062. {
  11063. "type": "integer",
  11064. "format": "int64",
  11065. "description": "id of key to delete",
  11066. "name": "id",
  11067. "in": "path",
  11068. "required": true
  11069. }
  11070. ],
  11071. "responses": {
  11072. "204": {
  11073. "$ref": "#/responses/empty"
  11074. },
  11075. "403": {
  11076. "$ref": "#/responses/forbidden"
  11077. },
  11078. "404": {
  11079. "$ref": "#/responses/notFound"
  11080. }
  11081. }
  11082. }
  11083. },
  11084. "/user/orgs": {
  11085. "get": {
  11086. "produces": [
  11087. "application/json"
  11088. ],
  11089. "tags": [
  11090. "organization"
  11091. ],
  11092. "summary": "List the current user's organizations",
  11093. "operationId": "orgListCurrentUserOrgs",
  11094. "parameters": [
  11095. {
  11096. "type": "integer",
  11097. "description": "page number of results to return (1-based)",
  11098. "name": "page",
  11099. "in": "query"
  11100. },
  11101. {
  11102. "type": "integer",
  11103. "description": "page size of results",
  11104. "name": "limit",
  11105. "in": "query"
  11106. }
  11107. ],
  11108. "responses": {
  11109. "200": {
  11110. "$ref": "#/responses/OrganizationList"
  11111. }
  11112. }
  11113. }
  11114. },
  11115. "/user/repos": {
  11116. "get": {
  11117. "produces": [
  11118. "application/json"
  11119. ],
  11120. "tags": [
  11121. "user"
  11122. ],
  11123. "summary": "List the repos that the authenticated user owns",
  11124. "operationId": "userCurrentListRepos",
  11125. "parameters": [
  11126. {
  11127. "type": "integer",
  11128. "description": "page number of results to return (1-based)",
  11129. "name": "page",
  11130. "in": "query"
  11131. },
  11132. {
  11133. "type": "integer",
  11134. "description": "page size of results",
  11135. "name": "limit",
  11136. "in": "query"
  11137. }
  11138. ],
  11139. "responses": {
  11140. "200": {
  11141. "$ref": "#/responses/RepositoryList"
  11142. }
  11143. }
  11144. },
  11145. "post": {
  11146. "consumes": [
  11147. "application/json"
  11148. ],
  11149. "produces": [
  11150. "application/json"
  11151. ],
  11152. "tags": [
  11153. "repository",
  11154. "user"
  11155. ],
  11156. "summary": "Create a repository",
  11157. "operationId": "createCurrentUserRepo",
  11158. "parameters": [
  11159. {
  11160. "name": "body",
  11161. "in": "body",
  11162. "schema": {
  11163. "$ref": "#/definitions/CreateRepoOption"
  11164. }
  11165. }
  11166. ],
  11167. "responses": {
  11168. "201": {
  11169. "$ref": "#/responses/Repository"
  11170. },
  11171. "409": {
  11172. "description": "The repository with the same name already exists."
  11173. },
  11174. "422": {
  11175. "$ref": "#/responses/validationError"
  11176. }
  11177. }
  11178. }
  11179. },
  11180. "/user/settings": {
  11181. "get": {
  11182. "produces": [
  11183. "application/json"
  11184. ],
  11185. "tags": [
  11186. "user"
  11187. ],
  11188. "summary": "Get user settings",
  11189. "operationId": "getUserSettings",
  11190. "responses": {
  11191. "200": {
  11192. "$ref": "#/responses/UserSettings"
  11193. }
  11194. }
  11195. },
  11196. "patch": {
  11197. "produces": [
  11198. "application/json"
  11199. ],
  11200. "tags": [
  11201. "user"
  11202. ],
  11203. "summary": "Update user settings",
  11204. "operationId": "updateUserSettings",
  11205. "parameters": [
  11206. {
  11207. "name": "body",
  11208. "in": "body",
  11209. "schema": {
  11210. "$ref": "#/definitions/UserSettingsOptions"
  11211. }
  11212. }
  11213. ],
  11214. "responses": {
  11215. "200": {
  11216. "$ref": "#/responses/UserSettings"
  11217. }
  11218. }
  11219. }
  11220. },
  11221. "/user/starred": {
  11222. "get": {
  11223. "produces": [
  11224. "application/json"
  11225. ],
  11226. "tags": [
  11227. "user"
  11228. ],
  11229. "summary": "The repos that the authenticated user has starred",
  11230. "operationId": "userCurrentListStarred",
  11231. "parameters": [
  11232. {
  11233. "type": "integer",
  11234. "description": "page number of results to return (1-based)",
  11235. "name": "page",
  11236. "in": "query"
  11237. },
  11238. {
  11239. "type": "integer",
  11240. "description": "page size of results",
  11241. "name": "limit",
  11242. "in": "query"
  11243. }
  11244. ],
  11245. "responses": {
  11246. "200": {
  11247. "$ref": "#/responses/RepositoryList"
  11248. }
  11249. }
  11250. }
  11251. },
  11252. "/user/starred/{owner}/{repo}": {
  11253. "get": {
  11254. "tags": [
  11255. "user"
  11256. ],
  11257. "summary": "Whether the authenticated is starring the repo",
  11258. "operationId": "userCurrentCheckStarring",
  11259. "parameters": [
  11260. {
  11261. "type": "string",
  11262. "description": "owner of the repo",
  11263. "name": "owner",
  11264. "in": "path",
  11265. "required": true
  11266. },
  11267. {
  11268. "type": "string",
  11269. "description": "name of the repo",
  11270. "name": "repo",
  11271. "in": "path",
  11272. "required": true
  11273. }
  11274. ],
  11275. "responses": {
  11276. "204": {
  11277. "$ref": "#/responses/empty"
  11278. },
  11279. "404": {
  11280. "$ref": "#/responses/notFound"
  11281. }
  11282. }
  11283. },
  11284. "put": {
  11285. "tags": [
  11286. "user"
  11287. ],
  11288. "summary": "Star the given repo",
  11289. "operationId": "userCurrentPutStar",
  11290. "parameters": [
  11291. {
  11292. "type": "string",
  11293. "description": "owner of the repo to star",
  11294. "name": "owner",
  11295. "in": "path",
  11296. "required": true
  11297. },
  11298. {
  11299. "type": "string",
  11300. "description": "name of the repo to star",
  11301. "name": "repo",
  11302. "in": "path",
  11303. "required": true
  11304. }
  11305. ],
  11306. "responses": {
  11307. "204": {
  11308. "$ref": "#/responses/empty"
  11309. }
  11310. }
  11311. },
  11312. "delete": {
  11313. "tags": [
  11314. "user"
  11315. ],
  11316. "summary": "Unstar the given repo",
  11317. "operationId": "userCurrentDeleteStar",
  11318. "parameters": [
  11319. {
  11320. "type": "string",
  11321. "description": "owner of the repo to unstar",
  11322. "name": "owner",
  11323. "in": "path",
  11324. "required": true
  11325. },
  11326. {
  11327. "type": "string",
  11328. "description": "name of the repo to unstar",
  11329. "name": "repo",
  11330. "in": "path",
  11331. "required": true
  11332. }
  11333. ],
  11334. "responses": {
  11335. "204": {
  11336. "$ref": "#/responses/empty"
  11337. }
  11338. }
  11339. }
  11340. },
  11341. "/user/stopwatches": {
  11342. "get": {
  11343. "consumes": [
  11344. "application/json"
  11345. ],
  11346. "produces": [
  11347. "application/json"
  11348. ],
  11349. "tags": [
  11350. "user"
  11351. ],
  11352. "summary": "Get list of all existing stopwatches",
  11353. "operationId": "userGetStopWatches",
  11354. "parameters": [
  11355. {
  11356. "type": "integer",
  11357. "description": "page number of results to return (1-based)",
  11358. "name": "page",
  11359. "in": "query"
  11360. },
  11361. {
  11362. "type": "integer",
  11363. "description": "page size of results",
  11364. "name": "limit",
  11365. "in": "query"
  11366. }
  11367. ],
  11368. "responses": {
  11369. "200": {
  11370. "$ref": "#/responses/StopWatchList"
  11371. }
  11372. }
  11373. }
  11374. },
  11375. "/user/subscriptions": {
  11376. "get": {
  11377. "produces": [
  11378. "application/json"
  11379. ],
  11380. "tags": [
  11381. "user"
  11382. ],
  11383. "summary": "List repositories watched by the authenticated user",
  11384. "operationId": "userCurrentListSubscriptions",
  11385. "parameters": [
  11386. {
  11387. "type": "integer",
  11388. "description": "page number of results to return (1-based)",
  11389. "name": "page",
  11390. "in": "query"
  11391. },
  11392. {
  11393. "type": "integer",
  11394. "description": "page size of results",
  11395. "name": "limit",
  11396. "in": "query"
  11397. }
  11398. ],
  11399. "responses": {
  11400. "200": {
  11401. "$ref": "#/responses/RepositoryList"
  11402. }
  11403. }
  11404. }
  11405. },
  11406. "/user/teams": {
  11407. "get": {
  11408. "produces": [
  11409. "application/json"
  11410. ],
  11411. "tags": [
  11412. "user"
  11413. ],
  11414. "summary": "List all the teams a user belongs to",
  11415. "operationId": "userListTeams",
  11416. "parameters": [
  11417. {
  11418. "type": "integer",
  11419. "description": "page number of results to return (1-based)",
  11420. "name": "page",
  11421. "in": "query"
  11422. },
  11423. {
  11424. "type": "integer",
  11425. "description": "page size of results",
  11426. "name": "limit",
  11427. "in": "query"
  11428. }
  11429. ],
  11430. "responses": {
  11431. "200": {
  11432. "$ref": "#/responses/TeamList"
  11433. }
  11434. }
  11435. }
  11436. },
  11437. "/user/times": {
  11438. "get": {
  11439. "produces": [
  11440. "application/json"
  11441. ],
  11442. "tags": [
  11443. "user"
  11444. ],
  11445. "summary": "List the current user's tracked times",
  11446. "operationId": "userCurrentTrackedTimes",
  11447. "parameters": [
  11448. {
  11449. "type": "string",
  11450. "format": "date-time",
  11451. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  11452. "name": "since",
  11453. "in": "query"
  11454. },
  11455. {
  11456. "type": "string",
  11457. "format": "date-time",
  11458. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  11459. "name": "before",
  11460. "in": "query"
  11461. }
  11462. ],
  11463. "responses": {
  11464. "200": {
  11465. "$ref": "#/responses/TrackedTimeList"
  11466. }
  11467. }
  11468. }
  11469. },
  11470. "/users/search": {
  11471. "get": {
  11472. "produces": [
  11473. "application/json"
  11474. ],
  11475. "tags": [
  11476. "user"
  11477. ],
  11478. "summary": "Search for users",
  11479. "operationId": "userSearch",
  11480. "parameters": [
  11481. {
  11482. "type": "string",
  11483. "description": "keyword",
  11484. "name": "q",
  11485. "in": "query"
  11486. },
  11487. {
  11488. "type": "integer",
  11489. "format": "int64",
  11490. "description": "ID of the user to search for",
  11491. "name": "uid",
  11492. "in": "query"
  11493. },
  11494. {
  11495. "type": "integer",
  11496. "description": "page number of results to return (1-based)",
  11497. "name": "page",
  11498. "in": "query"
  11499. },
  11500. {
  11501. "type": "integer",
  11502. "description": "page size of results",
  11503. "name": "limit",
  11504. "in": "query"
  11505. }
  11506. ],
  11507. "responses": {
  11508. "200": {
  11509. "description": "SearchResults of a successful search",
  11510. "schema": {
  11511. "type": "object",
  11512. "properties": {
  11513. "data": {
  11514. "type": "array",
  11515. "items": {
  11516. "$ref": "#/definitions/User"
  11517. }
  11518. },
  11519. "ok": {
  11520. "type": "boolean"
  11521. }
  11522. }
  11523. }
  11524. }
  11525. }
  11526. }
  11527. },
  11528. "/users/{follower}/following/{followee}": {
  11529. "get": {
  11530. "tags": [
  11531. "user"
  11532. ],
  11533. "summary": "Check if one user is following another user",
  11534. "operationId": "userCheckFollowing",
  11535. "parameters": [
  11536. {
  11537. "type": "string",
  11538. "description": "username of following user",
  11539. "name": "follower",
  11540. "in": "path",
  11541. "required": true
  11542. },
  11543. {
  11544. "type": "string",
  11545. "description": "username of followed user",
  11546. "name": "followee",
  11547. "in": "path",
  11548. "required": true
  11549. }
  11550. ],
  11551. "responses": {
  11552. "204": {
  11553. "$ref": "#/responses/empty"
  11554. },
  11555. "404": {
  11556. "$ref": "#/responses/notFound"
  11557. }
  11558. }
  11559. }
  11560. },
  11561. "/users/{username}": {
  11562. "get": {
  11563. "produces": [
  11564. "application/json"
  11565. ],
  11566. "tags": [
  11567. "user"
  11568. ],
  11569. "summary": "Get a user",
  11570. "operationId": "userGet",
  11571. "parameters": [
  11572. {
  11573. "type": "string",
  11574. "description": "username of user to get",
  11575. "name": "username",
  11576. "in": "path",
  11577. "required": true
  11578. }
  11579. ],
  11580. "responses": {
  11581. "200": {
  11582. "$ref": "#/responses/User"
  11583. },
  11584. "404": {
  11585. "$ref": "#/responses/notFound"
  11586. }
  11587. }
  11588. }
  11589. },
  11590. "/users/{username}/followers": {
  11591. "get": {
  11592. "produces": [
  11593. "application/json"
  11594. ],
  11595. "tags": [
  11596. "user"
  11597. ],
  11598. "summary": "List the given user's followers",
  11599. "operationId": "userListFollowers",
  11600. "parameters": [
  11601. {
  11602. "type": "string",
  11603. "description": "username of user",
  11604. "name": "username",
  11605. "in": "path",
  11606. "required": true
  11607. },
  11608. {
  11609. "type": "integer",
  11610. "description": "page number of results to return (1-based)",
  11611. "name": "page",
  11612. "in": "query"
  11613. },
  11614. {
  11615. "type": "integer",
  11616. "description": "page size of results",
  11617. "name": "limit",
  11618. "in": "query"
  11619. }
  11620. ],
  11621. "responses": {
  11622. "200": {
  11623. "$ref": "#/responses/UserList"
  11624. }
  11625. }
  11626. }
  11627. },
  11628. "/users/{username}/following": {
  11629. "get": {
  11630. "produces": [
  11631. "application/json"
  11632. ],
  11633. "tags": [
  11634. "user"
  11635. ],
  11636. "summary": "List the users that the given user is following",
  11637. "operationId": "userListFollowing",
  11638. "parameters": [
  11639. {
  11640. "type": "string",
  11641. "description": "username of user",
  11642. "name": "username",
  11643. "in": "path",
  11644. "required": true
  11645. },
  11646. {
  11647. "type": "integer",
  11648. "description": "page number of results to return (1-based)",
  11649. "name": "page",
  11650. "in": "query"
  11651. },
  11652. {
  11653. "type": "integer",
  11654. "description": "page size of results",
  11655. "name": "limit",
  11656. "in": "query"
  11657. }
  11658. ],
  11659. "responses": {
  11660. "200": {
  11661. "$ref": "#/responses/UserList"
  11662. }
  11663. }
  11664. }
  11665. },
  11666. "/users/{username}/gpg_keys": {
  11667. "get": {
  11668. "produces": [
  11669. "application/json"
  11670. ],
  11671. "tags": [
  11672. "user"
  11673. ],
  11674. "summary": "List the given user's GPG keys",
  11675. "operationId": "userListGPGKeys",
  11676. "parameters": [
  11677. {
  11678. "type": "string",
  11679. "description": "username of user",
  11680. "name": "username",
  11681. "in": "path",
  11682. "required": true
  11683. },
  11684. {
  11685. "type": "integer",
  11686. "description": "page number of results to return (1-based)",
  11687. "name": "page",
  11688. "in": "query"
  11689. },
  11690. {
  11691. "type": "integer",
  11692. "description": "page size of results",
  11693. "name": "limit",
  11694. "in": "query"
  11695. }
  11696. ],
  11697. "responses": {
  11698. "200": {
  11699. "$ref": "#/responses/GPGKeyList"
  11700. }
  11701. }
  11702. }
  11703. },
  11704. "/users/{username}/heatmap": {
  11705. "get": {
  11706. "produces": [
  11707. "application/json"
  11708. ],
  11709. "tags": [
  11710. "user"
  11711. ],
  11712. "summary": "Get a user's heatmap",
  11713. "operationId": "userGetHeatmapData",
  11714. "parameters": [
  11715. {
  11716. "type": "string",
  11717. "description": "username of user to get",
  11718. "name": "username",
  11719. "in": "path",
  11720. "required": true
  11721. }
  11722. ],
  11723. "responses": {
  11724. "200": {
  11725. "$ref": "#/responses/UserHeatmapData"
  11726. },
  11727. "404": {
  11728. "$ref": "#/responses/notFound"
  11729. }
  11730. }
  11731. }
  11732. },
  11733. "/users/{username}/keys": {
  11734. "get": {
  11735. "produces": [
  11736. "application/json"
  11737. ],
  11738. "tags": [
  11739. "user"
  11740. ],
  11741. "summary": "List the given user's public keys",
  11742. "operationId": "userListKeys",
  11743. "parameters": [
  11744. {
  11745. "type": "string",
  11746. "description": "username of user",
  11747. "name": "username",
  11748. "in": "path",
  11749. "required": true
  11750. },
  11751. {
  11752. "type": "string",
  11753. "description": "fingerprint of the key",
  11754. "name": "fingerprint",
  11755. "in": "query"
  11756. },
  11757. {
  11758. "type": "integer",
  11759. "description": "page number of results to return (1-based)",
  11760. "name": "page",
  11761. "in": "query"
  11762. },
  11763. {
  11764. "type": "integer",
  11765. "description": "page size of results",
  11766. "name": "limit",
  11767. "in": "query"
  11768. }
  11769. ],
  11770. "responses": {
  11771. "200": {
  11772. "$ref": "#/responses/PublicKeyList"
  11773. }
  11774. }
  11775. }
  11776. },
  11777. "/users/{username}/orgs": {
  11778. "get": {
  11779. "produces": [
  11780. "application/json"
  11781. ],
  11782. "tags": [
  11783. "organization"
  11784. ],
  11785. "summary": "List a user's organizations",
  11786. "operationId": "orgListUserOrgs",
  11787. "parameters": [
  11788. {
  11789. "type": "string",
  11790. "description": "username of user",
  11791. "name": "username",
  11792. "in": "path",
  11793. "required": true
  11794. },
  11795. {
  11796. "type": "integer",
  11797. "description": "page number of results to return (1-based)",
  11798. "name": "page",
  11799. "in": "query"
  11800. },
  11801. {
  11802. "type": "integer",
  11803. "description": "page size of results",
  11804. "name": "limit",
  11805. "in": "query"
  11806. }
  11807. ],
  11808. "responses": {
  11809. "200": {
  11810. "$ref": "#/responses/OrganizationList"
  11811. }
  11812. }
  11813. }
  11814. },
  11815. "/users/{username}/repos": {
  11816. "get": {
  11817. "produces": [
  11818. "application/json"
  11819. ],
  11820. "tags": [
  11821. "user"
  11822. ],
  11823. "summary": "List the repos owned by the given user",
  11824. "operationId": "userListRepos",
  11825. "parameters": [
  11826. {
  11827. "type": "string",
  11828. "description": "username of user",
  11829. "name": "username",
  11830. "in": "path",
  11831. "required": true
  11832. },
  11833. {
  11834. "type": "integer",
  11835. "description": "page number of results to return (1-based)",
  11836. "name": "page",
  11837. "in": "query"
  11838. },
  11839. {
  11840. "type": "integer",
  11841. "description": "page size of results",
  11842. "name": "limit",
  11843. "in": "query"
  11844. }
  11845. ],
  11846. "responses": {
  11847. "200": {
  11848. "$ref": "#/responses/RepositoryList"
  11849. }
  11850. }
  11851. }
  11852. },
  11853. "/users/{username}/starred": {
  11854. "get": {
  11855. "produces": [
  11856. "application/json"
  11857. ],
  11858. "tags": [
  11859. "user"
  11860. ],
  11861. "summary": "The repos that the given user has starred",
  11862. "operationId": "userListStarred",
  11863. "parameters": [
  11864. {
  11865. "type": "string",
  11866. "description": "username of user",
  11867. "name": "username",
  11868. "in": "path",
  11869. "required": true
  11870. },
  11871. {
  11872. "type": "integer",
  11873. "description": "page number of results to return (1-based)",
  11874. "name": "page",
  11875. "in": "query"
  11876. },
  11877. {
  11878. "type": "integer",
  11879. "description": "page size of results",
  11880. "name": "limit",
  11881. "in": "query"
  11882. }
  11883. ],
  11884. "responses": {
  11885. "200": {
  11886. "$ref": "#/responses/RepositoryList"
  11887. }
  11888. }
  11889. }
  11890. },
  11891. "/users/{username}/subscriptions": {
  11892. "get": {
  11893. "produces": [
  11894. "application/json"
  11895. ],
  11896. "tags": [
  11897. "user"
  11898. ],
  11899. "summary": "List the repositories watched by a user",
  11900. "operationId": "userListSubscriptions",
  11901. "parameters": [
  11902. {
  11903. "type": "string",
  11904. "description": "username of the user",
  11905. "name": "username",
  11906. "in": "path",
  11907. "required": true
  11908. },
  11909. {
  11910. "type": "integer",
  11911. "description": "page number of results to return (1-based)",
  11912. "name": "page",
  11913. "in": "query"
  11914. },
  11915. {
  11916. "type": "integer",
  11917. "description": "page size of results",
  11918. "name": "limit",
  11919. "in": "query"
  11920. }
  11921. ],
  11922. "responses": {
  11923. "200": {
  11924. "$ref": "#/responses/RepositoryList"
  11925. }
  11926. }
  11927. }
  11928. },
  11929. "/users/{username}/tokens": {
  11930. "get": {
  11931. "produces": [
  11932. "application/json"
  11933. ],
  11934. "tags": [
  11935. "user"
  11936. ],
  11937. "summary": "List the authenticated user's access tokens",
  11938. "operationId": "userGetTokens",
  11939. "parameters": [
  11940. {
  11941. "type": "string",
  11942. "description": "username of user",
  11943. "name": "username",
  11944. "in": "path",
  11945. "required": true
  11946. },
  11947. {
  11948. "type": "integer",
  11949. "description": "page number of results to return (1-based)",
  11950. "name": "page",
  11951. "in": "query"
  11952. },
  11953. {
  11954. "type": "integer",
  11955. "description": "page size of results",
  11956. "name": "limit",
  11957. "in": "query"
  11958. }
  11959. ],
  11960. "responses": {
  11961. "200": {
  11962. "$ref": "#/responses/AccessTokenList"
  11963. }
  11964. }
  11965. },
  11966. "post": {
  11967. "consumes": [
  11968. "application/json"
  11969. ],
  11970. "produces": [
  11971. "application/json"
  11972. ],
  11973. "tags": [
  11974. "user"
  11975. ],
  11976. "summary": "Create an access token",
  11977. "operationId": "userCreateToken",
  11978. "parameters": [
  11979. {
  11980. "type": "string",
  11981. "x-go-name": "Name",
  11982. "description": "username of user",
  11983. "name": "username",
  11984. "in": "path",
  11985. "required": true
  11986. },
  11987. {
  11988. "name": "userCreateToken",
  11989. "in": "body",
  11990. "schema": {
  11991. "$ref": "#/definitions/CreateAccessTokenOption"
  11992. }
  11993. }
  11994. ],
  11995. "responses": {
  11996. "201": {
  11997. "$ref": "#/responses/AccessToken"
  11998. },
  11999. "400": {
  12000. "$ref": "#/responses/error"
  12001. }
  12002. }
  12003. }
  12004. },
  12005. "/users/{username}/tokens/{token}": {
  12006. "delete": {
  12007. "produces": [
  12008. "application/json"
  12009. ],
  12010. "tags": [
  12011. "user"
  12012. ],
  12013. "summary": "delete an access token",
  12014. "operationId": "userDeleteAccessToken",
  12015. "parameters": [
  12016. {
  12017. "type": "string",
  12018. "description": "username of user",
  12019. "name": "username",
  12020. "in": "path",
  12021. "required": true
  12022. },
  12023. {
  12024. "type": "string",
  12025. "description": "token to be deleted, identified by ID and if not available by name",
  12026. "name": "token",
  12027. "in": "path",
  12028. "required": true
  12029. }
  12030. ],
  12031. "responses": {
  12032. "204": {
  12033. "$ref": "#/responses/empty"
  12034. },
  12035. "404": {
  12036. "$ref": "#/responses/notFound"
  12037. },
  12038. "422": {
  12039. "$ref": "#/responses/error"
  12040. }
  12041. }
  12042. }
  12043. },
  12044. "/version": {
  12045. "get": {
  12046. "produces": [
  12047. "application/json"
  12048. ],
  12049. "tags": [
  12050. "miscellaneous"
  12051. ],
  12052. "summary": "Returns the version of the Gitea application",
  12053. "operationId": "getVersion",
  12054. "responses": {
  12055. "200": {
  12056. "$ref": "#/responses/ServerVersion"
  12057. }
  12058. }
  12059. }
  12060. }
  12061. },
  12062. "definitions": {
  12063. "APIError": {
  12064. "description": "APIError is an api error with a message",
  12065. "type": "object",
  12066. "properties": {
  12067. "message": {
  12068. "type": "string",
  12069. "x-go-name": "Message"
  12070. },
  12071. "url": {
  12072. "type": "string",
  12073. "x-go-name": "URL"
  12074. }
  12075. },
  12076. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12077. },
  12078. "AccessToken": {
  12079. "type": "object",
  12080. "title": "AccessToken represents an API access token.",
  12081. "properties": {
  12082. "id": {
  12083. "type": "integer",
  12084. "format": "int64",
  12085. "x-go-name": "ID"
  12086. },
  12087. "name": {
  12088. "type": "string",
  12089. "x-go-name": "Name"
  12090. },
  12091. "sha1": {
  12092. "type": "string",
  12093. "x-go-name": "Token"
  12094. },
  12095. "token_last_eight": {
  12096. "type": "string",
  12097. "x-go-name": "TokenLastEight"
  12098. }
  12099. },
  12100. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12101. },
  12102. "AddCollaboratorOption": {
  12103. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  12104. "type": "object",
  12105. "properties": {
  12106. "permission": {
  12107. "type": "string",
  12108. "x-go-name": "Permission"
  12109. }
  12110. },
  12111. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12112. },
  12113. "AddTimeOption": {
  12114. "description": "AddTimeOption options for adding time to an issue",
  12115. "type": "object",
  12116. "required": [
  12117. "time"
  12118. ],
  12119. "properties": {
  12120. "created": {
  12121. "type": "string",
  12122. "format": "date-time",
  12123. "x-go-name": "Created"
  12124. },
  12125. "time": {
  12126. "description": "time in seconds",
  12127. "type": "integer",
  12128. "format": "int64",
  12129. "x-go-name": "Time"
  12130. },
  12131. "user_name": {
  12132. "description": "User who spent the time (optional)",
  12133. "type": "string",
  12134. "x-go-name": "User"
  12135. }
  12136. },
  12137. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12138. },
  12139. "AnnotatedTag": {
  12140. "description": "AnnotatedTag represents an annotated tag",
  12141. "type": "object",
  12142. "properties": {
  12143. "message": {
  12144. "type": "string",
  12145. "x-go-name": "Message"
  12146. },
  12147. "object": {
  12148. "$ref": "#/definitions/AnnotatedTagObject"
  12149. },
  12150. "sha": {
  12151. "type": "string",
  12152. "x-go-name": "SHA"
  12153. },
  12154. "tag": {
  12155. "type": "string",
  12156. "x-go-name": "Tag"
  12157. },
  12158. "tagger": {
  12159. "$ref": "#/definitions/CommitUser"
  12160. },
  12161. "url": {
  12162. "type": "string",
  12163. "x-go-name": "URL"
  12164. },
  12165. "verification": {
  12166. "$ref": "#/definitions/PayloadCommitVerification"
  12167. }
  12168. },
  12169. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12170. },
  12171. "AnnotatedTagObject": {
  12172. "description": "AnnotatedTagObject contains meta information of the tag object",
  12173. "type": "object",
  12174. "properties": {
  12175. "sha": {
  12176. "type": "string",
  12177. "x-go-name": "SHA"
  12178. },
  12179. "type": {
  12180. "type": "string",
  12181. "x-go-name": "Type"
  12182. },
  12183. "url": {
  12184. "type": "string",
  12185. "x-go-name": "URL"
  12186. }
  12187. },
  12188. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12189. },
  12190. "Attachment": {
  12191. "description": "Attachment a generic attachment",
  12192. "type": "object",
  12193. "properties": {
  12194. "browser_download_url": {
  12195. "type": "string",
  12196. "x-go-name": "DownloadURL"
  12197. },
  12198. "created_at": {
  12199. "type": "string",
  12200. "format": "date-time",
  12201. "x-go-name": "Created"
  12202. },
  12203. "download_count": {
  12204. "type": "integer",
  12205. "format": "int64",
  12206. "x-go-name": "DownloadCount"
  12207. },
  12208. "id": {
  12209. "type": "integer",
  12210. "format": "int64",
  12211. "x-go-name": "ID"
  12212. },
  12213. "name": {
  12214. "type": "string",
  12215. "x-go-name": "Name"
  12216. },
  12217. "size": {
  12218. "type": "integer",
  12219. "format": "int64",
  12220. "x-go-name": "Size"
  12221. },
  12222. "uuid": {
  12223. "type": "string",
  12224. "x-go-name": "UUID"
  12225. }
  12226. },
  12227. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12228. },
  12229. "Branch": {
  12230. "description": "Branch represents a repository branch",
  12231. "type": "object",
  12232. "properties": {
  12233. "commit": {
  12234. "$ref": "#/definitions/PayloadCommit"
  12235. },
  12236. "effective_branch_protection_name": {
  12237. "type": "string",
  12238. "x-go-name": "EffectiveBranchProtectionName"
  12239. },
  12240. "enable_status_check": {
  12241. "type": "boolean",
  12242. "x-go-name": "EnableStatusCheck"
  12243. },
  12244. "name": {
  12245. "type": "string",
  12246. "x-go-name": "Name"
  12247. },
  12248. "protected": {
  12249. "type": "boolean",
  12250. "x-go-name": "Protected"
  12251. },
  12252. "required_approvals": {
  12253. "type": "integer",
  12254. "format": "int64",
  12255. "x-go-name": "RequiredApprovals"
  12256. },
  12257. "status_check_contexts": {
  12258. "type": "array",
  12259. "items": {
  12260. "type": "string"
  12261. },
  12262. "x-go-name": "StatusCheckContexts"
  12263. },
  12264. "user_can_merge": {
  12265. "type": "boolean",
  12266. "x-go-name": "UserCanMerge"
  12267. },
  12268. "user_can_push": {
  12269. "type": "boolean",
  12270. "x-go-name": "UserCanPush"
  12271. }
  12272. },
  12273. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12274. },
  12275. "BranchProtection": {
  12276. "description": "BranchProtection represents a branch protection for a repository",
  12277. "type": "object",
  12278. "properties": {
  12279. "approvals_whitelist_teams": {
  12280. "type": "array",
  12281. "items": {
  12282. "type": "string"
  12283. },
  12284. "x-go-name": "ApprovalsWhitelistTeams"
  12285. },
  12286. "approvals_whitelist_username": {
  12287. "type": "array",
  12288. "items": {
  12289. "type": "string"
  12290. },
  12291. "x-go-name": "ApprovalsWhitelistUsernames"
  12292. },
  12293. "block_on_official_review_requests": {
  12294. "type": "boolean",
  12295. "x-go-name": "BlockOnOfficialReviewRequests"
  12296. },
  12297. "block_on_outdated_branch": {
  12298. "type": "boolean",
  12299. "x-go-name": "BlockOnOutdatedBranch"
  12300. },
  12301. "block_on_rejected_reviews": {
  12302. "type": "boolean",
  12303. "x-go-name": "BlockOnRejectedReviews"
  12304. },
  12305. "branch_name": {
  12306. "type": "string",
  12307. "x-go-name": "BranchName"
  12308. },
  12309. "created_at": {
  12310. "type": "string",
  12311. "format": "date-time",
  12312. "x-go-name": "Created"
  12313. },
  12314. "dismiss_stale_approvals": {
  12315. "type": "boolean",
  12316. "x-go-name": "DismissStaleApprovals"
  12317. },
  12318. "enable_approvals_whitelist": {
  12319. "type": "boolean",
  12320. "x-go-name": "EnableApprovalsWhitelist"
  12321. },
  12322. "enable_merge_whitelist": {
  12323. "type": "boolean",
  12324. "x-go-name": "EnableMergeWhitelist"
  12325. },
  12326. "enable_push": {
  12327. "type": "boolean",
  12328. "x-go-name": "EnablePush"
  12329. },
  12330. "enable_push_whitelist": {
  12331. "type": "boolean",
  12332. "x-go-name": "EnablePushWhitelist"
  12333. },
  12334. "enable_status_check": {
  12335. "type": "boolean",
  12336. "x-go-name": "EnableStatusCheck"
  12337. },
  12338. "merge_whitelist_teams": {
  12339. "type": "array",
  12340. "items": {
  12341. "type": "string"
  12342. },
  12343. "x-go-name": "MergeWhitelistTeams"
  12344. },
  12345. "merge_whitelist_usernames": {
  12346. "type": "array",
  12347. "items": {
  12348. "type": "string"
  12349. },
  12350. "x-go-name": "MergeWhitelistUsernames"
  12351. },
  12352. "protected_file_patterns": {
  12353. "type": "string",
  12354. "x-go-name": "ProtectedFilePatterns"
  12355. },
  12356. "push_whitelist_deploy_keys": {
  12357. "type": "boolean",
  12358. "x-go-name": "PushWhitelistDeployKeys"
  12359. },
  12360. "push_whitelist_teams": {
  12361. "type": "array",
  12362. "items": {
  12363. "type": "string"
  12364. },
  12365. "x-go-name": "PushWhitelistTeams"
  12366. },
  12367. "push_whitelist_usernames": {
  12368. "type": "array",
  12369. "items": {
  12370. "type": "string"
  12371. },
  12372. "x-go-name": "PushWhitelistUsernames"
  12373. },
  12374. "require_signed_commits": {
  12375. "type": "boolean",
  12376. "x-go-name": "RequireSignedCommits"
  12377. },
  12378. "required_approvals": {
  12379. "type": "integer",
  12380. "format": "int64",
  12381. "x-go-name": "RequiredApprovals"
  12382. },
  12383. "status_check_contexts": {
  12384. "type": "array",
  12385. "items": {
  12386. "type": "string"
  12387. },
  12388. "x-go-name": "StatusCheckContexts"
  12389. },
  12390. "unprotected_file_patterns": {
  12391. "type": "string",
  12392. "x-go-name": "UnprotectedFilePatterns"
  12393. },
  12394. "updated_at": {
  12395. "type": "string",
  12396. "format": "date-time",
  12397. "x-go-name": "Updated"
  12398. }
  12399. },
  12400. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12401. },
  12402. "CombinedStatus": {
  12403. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  12404. "type": "object",
  12405. "properties": {
  12406. "commit_url": {
  12407. "type": "string",
  12408. "x-go-name": "CommitURL"
  12409. },
  12410. "repository": {
  12411. "$ref": "#/definitions/Repository"
  12412. },
  12413. "sha": {
  12414. "type": "string",
  12415. "x-go-name": "SHA"
  12416. },
  12417. "state": {
  12418. "$ref": "#/definitions/CommitStatusState"
  12419. },
  12420. "statuses": {
  12421. "type": "array",
  12422. "items": {
  12423. "$ref": "#/definitions/CommitStatus"
  12424. },
  12425. "x-go-name": "Statuses"
  12426. },
  12427. "total_count": {
  12428. "type": "integer",
  12429. "format": "int64",
  12430. "x-go-name": "TotalCount"
  12431. },
  12432. "url": {
  12433. "type": "string",
  12434. "x-go-name": "URL"
  12435. }
  12436. },
  12437. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12438. },
  12439. "Comment": {
  12440. "description": "Comment represents a comment on a commit or issue",
  12441. "type": "object",
  12442. "properties": {
  12443. "body": {
  12444. "type": "string",
  12445. "x-go-name": "Body"
  12446. },
  12447. "created_at": {
  12448. "type": "string",
  12449. "format": "date-time",
  12450. "x-go-name": "Created"
  12451. },
  12452. "html_url": {
  12453. "type": "string",
  12454. "x-go-name": "HTMLURL"
  12455. },
  12456. "id": {
  12457. "type": "integer",
  12458. "format": "int64",
  12459. "x-go-name": "ID"
  12460. },
  12461. "issue_url": {
  12462. "type": "string",
  12463. "x-go-name": "IssueURL"
  12464. },
  12465. "original_author": {
  12466. "type": "string",
  12467. "x-go-name": "OriginalAuthor"
  12468. },
  12469. "original_author_id": {
  12470. "type": "integer",
  12471. "format": "int64",
  12472. "x-go-name": "OriginalAuthorID"
  12473. },
  12474. "pull_request_url": {
  12475. "type": "string",
  12476. "x-go-name": "PRURL"
  12477. },
  12478. "updated_at": {
  12479. "type": "string",
  12480. "format": "date-time",
  12481. "x-go-name": "Updated"
  12482. },
  12483. "user": {
  12484. "$ref": "#/definitions/User"
  12485. }
  12486. },
  12487. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12488. },
  12489. "Commit": {
  12490. "type": "object",
  12491. "title": "Commit contains information generated from a Git commit.",
  12492. "properties": {
  12493. "author": {
  12494. "$ref": "#/definitions/User"
  12495. },
  12496. "commit": {
  12497. "$ref": "#/definitions/RepoCommit"
  12498. },
  12499. "committer": {
  12500. "$ref": "#/definitions/User"
  12501. },
  12502. "created": {
  12503. "type": "string",
  12504. "format": "date-time",
  12505. "x-go-name": "Created"
  12506. },
  12507. "files": {
  12508. "type": "array",
  12509. "items": {
  12510. "$ref": "#/definitions/CommitAffectedFiles"
  12511. },
  12512. "x-go-name": "Files"
  12513. },
  12514. "html_url": {
  12515. "type": "string",
  12516. "x-go-name": "HTMLURL"
  12517. },
  12518. "parents": {
  12519. "type": "array",
  12520. "items": {
  12521. "$ref": "#/definitions/CommitMeta"
  12522. },
  12523. "x-go-name": "Parents"
  12524. },
  12525. "sha": {
  12526. "type": "string",
  12527. "x-go-name": "SHA"
  12528. },
  12529. "url": {
  12530. "type": "string",
  12531. "x-go-name": "URL"
  12532. }
  12533. },
  12534. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12535. },
  12536. "CommitAffectedFiles": {
  12537. "description": "CommitAffectedFiles store information about files affected by the commit",
  12538. "type": "object",
  12539. "properties": {
  12540. "filename": {
  12541. "type": "string",
  12542. "x-go-name": "Filename"
  12543. }
  12544. },
  12545. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12546. },
  12547. "CommitDateOptions": {
  12548. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  12549. "type": "object",
  12550. "properties": {
  12551. "author": {
  12552. "type": "string",
  12553. "format": "date-time",
  12554. "x-go-name": "Author"
  12555. },
  12556. "committer": {
  12557. "type": "string",
  12558. "format": "date-time",
  12559. "x-go-name": "Committer"
  12560. }
  12561. },
  12562. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12563. },
  12564. "CommitMeta": {
  12565. "type": "object",
  12566. "title": "CommitMeta contains meta information of a commit in terms of API.",
  12567. "properties": {
  12568. "created": {
  12569. "type": "string",
  12570. "format": "date-time",
  12571. "x-go-name": "Created"
  12572. },
  12573. "sha": {
  12574. "type": "string",
  12575. "x-go-name": "SHA"
  12576. },
  12577. "url": {
  12578. "type": "string",
  12579. "x-go-name": "URL"
  12580. }
  12581. },
  12582. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12583. },
  12584. "CommitStatus": {
  12585. "description": "CommitStatus holds a single status of a single Commit",
  12586. "type": "object",
  12587. "properties": {
  12588. "context": {
  12589. "type": "string",
  12590. "x-go-name": "Context"
  12591. },
  12592. "created_at": {
  12593. "type": "string",
  12594. "format": "date-time",
  12595. "x-go-name": "Created"
  12596. },
  12597. "creator": {
  12598. "$ref": "#/definitions/User"
  12599. },
  12600. "description": {
  12601. "type": "string",
  12602. "x-go-name": "Description"
  12603. },
  12604. "id": {
  12605. "type": "integer",
  12606. "format": "int64",
  12607. "x-go-name": "ID"
  12608. },
  12609. "status": {
  12610. "$ref": "#/definitions/CommitStatusState"
  12611. },
  12612. "target_url": {
  12613. "type": "string",
  12614. "x-go-name": "TargetURL"
  12615. },
  12616. "updated_at": {
  12617. "type": "string",
  12618. "format": "date-time",
  12619. "x-go-name": "Updated"
  12620. },
  12621. "url": {
  12622. "type": "string",
  12623. "x-go-name": "URL"
  12624. }
  12625. },
  12626. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12627. },
  12628. "CommitStatusState": {
  12629. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  12630. "type": "string",
  12631. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12632. },
  12633. "CommitUser": {
  12634. "type": "object",
  12635. "title": "CommitUser contains information of a user in the context of a commit.",
  12636. "properties": {
  12637. "date": {
  12638. "type": "string",
  12639. "x-go-name": "Date"
  12640. },
  12641. "email": {
  12642. "type": "string",
  12643. "format": "email",
  12644. "x-go-name": "Email"
  12645. },
  12646. "name": {
  12647. "type": "string",
  12648. "x-go-name": "Name"
  12649. }
  12650. },
  12651. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12652. },
  12653. "ContentsResponse": {
  12654. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  12655. "type": "object",
  12656. "properties": {
  12657. "_links": {
  12658. "$ref": "#/definitions/FileLinksResponse"
  12659. },
  12660. "content": {
  12661. "description": "`content` is populated when `type` is `file`, otherwise null",
  12662. "type": "string",
  12663. "x-go-name": "Content"
  12664. },
  12665. "download_url": {
  12666. "type": "string",
  12667. "x-go-name": "DownloadURL"
  12668. },
  12669. "encoding": {
  12670. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  12671. "type": "string",
  12672. "x-go-name": "Encoding"
  12673. },
  12674. "git_url": {
  12675. "type": "string",
  12676. "x-go-name": "GitURL"
  12677. },
  12678. "html_url": {
  12679. "type": "string",
  12680. "x-go-name": "HTMLURL"
  12681. },
  12682. "name": {
  12683. "type": "string",
  12684. "x-go-name": "Name"
  12685. },
  12686. "path": {
  12687. "type": "string",
  12688. "x-go-name": "Path"
  12689. },
  12690. "sha": {
  12691. "type": "string",
  12692. "x-go-name": "SHA"
  12693. },
  12694. "size": {
  12695. "type": "integer",
  12696. "format": "int64",
  12697. "x-go-name": "Size"
  12698. },
  12699. "submodule_git_url": {
  12700. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  12701. "type": "string",
  12702. "x-go-name": "SubmoduleGitURL"
  12703. },
  12704. "target": {
  12705. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  12706. "type": "string",
  12707. "x-go-name": "Target"
  12708. },
  12709. "type": {
  12710. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  12711. "type": "string",
  12712. "x-go-name": "Type"
  12713. },
  12714. "url": {
  12715. "type": "string",
  12716. "x-go-name": "URL"
  12717. }
  12718. },
  12719. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12720. },
  12721. "CreateAccessTokenOption": {
  12722. "description": "CreateAccessTokenOption options when create access token",
  12723. "type": "object",
  12724. "properties": {
  12725. "name": {
  12726. "type": "string",
  12727. "x-go-name": "Name"
  12728. }
  12729. },
  12730. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12731. },
  12732. "CreateBranchProtectionOption": {
  12733. "description": "CreateBranchProtectionOption options for creating a branch protection",
  12734. "type": "object",
  12735. "properties": {
  12736. "approvals_whitelist_teams": {
  12737. "type": "array",
  12738. "items": {
  12739. "type": "string"
  12740. },
  12741. "x-go-name": "ApprovalsWhitelistTeams"
  12742. },
  12743. "approvals_whitelist_username": {
  12744. "type": "array",
  12745. "items": {
  12746. "type": "string"
  12747. },
  12748. "x-go-name": "ApprovalsWhitelistUsernames"
  12749. },
  12750. "block_on_official_review_requests": {
  12751. "type": "boolean",
  12752. "x-go-name": "BlockOnOfficialReviewRequests"
  12753. },
  12754. "block_on_outdated_branch": {
  12755. "type": "boolean",
  12756. "x-go-name": "BlockOnOutdatedBranch"
  12757. },
  12758. "block_on_rejected_reviews": {
  12759. "type": "boolean",
  12760. "x-go-name": "BlockOnRejectedReviews"
  12761. },
  12762. "branch_name": {
  12763. "type": "string",
  12764. "x-go-name": "BranchName"
  12765. },
  12766. "dismiss_stale_approvals": {
  12767. "type": "boolean",
  12768. "x-go-name": "DismissStaleApprovals"
  12769. },
  12770. "enable_approvals_whitelist": {
  12771. "type": "boolean",
  12772. "x-go-name": "EnableApprovalsWhitelist"
  12773. },
  12774. "enable_merge_whitelist": {
  12775. "type": "boolean",
  12776. "x-go-name": "EnableMergeWhitelist"
  12777. },
  12778. "enable_push": {
  12779. "type": "boolean",
  12780. "x-go-name": "EnablePush"
  12781. },
  12782. "enable_push_whitelist": {
  12783. "type": "boolean",
  12784. "x-go-name": "EnablePushWhitelist"
  12785. },
  12786. "enable_status_check": {
  12787. "type": "boolean",
  12788. "x-go-name": "EnableStatusCheck"
  12789. },
  12790. "merge_whitelist_teams": {
  12791. "type": "array",
  12792. "items": {
  12793. "type": "string"
  12794. },
  12795. "x-go-name": "MergeWhitelistTeams"
  12796. },
  12797. "merge_whitelist_usernames": {
  12798. "type": "array",
  12799. "items": {
  12800. "type": "string"
  12801. },
  12802. "x-go-name": "MergeWhitelistUsernames"
  12803. },
  12804. "protected_file_patterns": {
  12805. "type": "string",
  12806. "x-go-name": "ProtectedFilePatterns"
  12807. },
  12808. "push_whitelist_deploy_keys": {
  12809. "type": "boolean",
  12810. "x-go-name": "PushWhitelistDeployKeys"
  12811. },
  12812. "push_whitelist_teams": {
  12813. "type": "array",
  12814. "items": {
  12815. "type": "string"
  12816. },
  12817. "x-go-name": "PushWhitelistTeams"
  12818. },
  12819. "push_whitelist_usernames": {
  12820. "type": "array",
  12821. "items": {
  12822. "type": "string"
  12823. },
  12824. "x-go-name": "PushWhitelistUsernames"
  12825. },
  12826. "require_signed_commits": {
  12827. "type": "boolean",
  12828. "x-go-name": "RequireSignedCommits"
  12829. },
  12830. "required_approvals": {
  12831. "type": "integer",
  12832. "format": "int64",
  12833. "x-go-name": "RequiredApprovals"
  12834. },
  12835. "status_check_contexts": {
  12836. "type": "array",
  12837. "items": {
  12838. "type": "string"
  12839. },
  12840. "x-go-name": "StatusCheckContexts"
  12841. },
  12842. "unprotected_file_patterns": {
  12843. "type": "string",
  12844. "x-go-name": "UnprotectedFilePatterns"
  12845. }
  12846. },
  12847. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12848. },
  12849. "CreateBranchRepoOption": {
  12850. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  12851. "type": "object",
  12852. "required": [
  12853. "new_branch_name"
  12854. ],
  12855. "properties": {
  12856. "new_branch_name": {
  12857. "description": "Name of the branch to create",
  12858. "type": "string",
  12859. "uniqueItems": true,
  12860. "x-go-name": "BranchName"
  12861. },
  12862. "old_branch_name": {
  12863. "description": "Name of the old branch to create from",
  12864. "type": "string",
  12865. "uniqueItems": true,
  12866. "x-go-name": "OldBranchName"
  12867. }
  12868. },
  12869. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12870. },
  12871. "CreateEmailOption": {
  12872. "description": "CreateEmailOption options when creating email addresses",
  12873. "type": "object",
  12874. "properties": {
  12875. "emails": {
  12876. "description": "email addresses to add",
  12877. "type": "array",
  12878. "items": {
  12879. "type": "string"
  12880. },
  12881. "x-go-name": "Emails"
  12882. }
  12883. },
  12884. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12885. },
  12886. "CreateFileOptions": {
  12887. "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)",
  12888. "type": "object",
  12889. "required": [
  12890. "content"
  12891. ],
  12892. "properties": {
  12893. "author": {
  12894. "$ref": "#/definitions/Identity"
  12895. },
  12896. "branch": {
  12897. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  12898. "type": "string",
  12899. "x-go-name": "BranchName"
  12900. },
  12901. "committer": {
  12902. "$ref": "#/definitions/Identity"
  12903. },
  12904. "content": {
  12905. "description": "content must be base64 encoded",
  12906. "type": "string",
  12907. "x-go-name": "Content"
  12908. },
  12909. "dates": {
  12910. "$ref": "#/definitions/CommitDateOptions"
  12911. },
  12912. "message": {
  12913. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  12914. "type": "string",
  12915. "x-go-name": "Message"
  12916. },
  12917. "new_branch": {
  12918. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  12919. "type": "string",
  12920. "x-go-name": "NewBranchName"
  12921. },
  12922. "signoff": {
  12923. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  12924. "type": "boolean",
  12925. "x-go-name": "Signoff"
  12926. }
  12927. },
  12928. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12929. },
  12930. "CreateForkOption": {
  12931. "description": "CreateForkOption options for creating a fork",
  12932. "type": "object",
  12933. "properties": {
  12934. "organization": {
  12935. "description": "organization name, if forking into an organization",
  12936. "type": "string",
  12937. "x-go-name": "Organization"
  12938. }
  12939. },
  12940. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12941. },
  12942. "CreateGPGKeyOption": {
  12943. "description": "CreateGPGKeyOption options create user GPG key",
  12944. "type": "object",
  12945. "required": [
  12946. "armored_public_key"
  12947. ],
  12948. "properties": {
  12949. "armored_public_key": {
  12950. "description": "An armored GPG key to add",
  12951. "type": "string",
  12952. "uniqueItems": true,
  12953. "x-go-name": "ArmoredKey"
  12954. },
  12955. "armored_signature": {
  12956. "type": "string",
  12957. "x-go-name": "Signature"
  12958. }
  12959. },
  12960. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12961. },
  12962. "CreateHookOption": {
  12963. "description": "CreateHookOption options when create a hook",
  12964. "type": "object",
  12965. "required": [
  12966. "type",
  12967. "config"
  12968. ],
  12969. "properties": {
  12970. "active": {
  12971. "type": "boolean",
  12972. "default": false,
  12973. "x-go-name": "Active"
  12974. },
  12975. "branch_filter": {
  12976. "type": "string",
  12977. "x-go-name": "BranchFilter"
  12978. },
  12979. "config": {
  12980. "$ref": "#/definitions/CreateHookOptionConfig"
  12981. },
  12982. "events": {
  12983. "type": "array",
  12984. "items": {
  12985. "type": "string"
  12986. },
  12987. "x-go-name": "Events"
  12988. },
  12989. "type": {
  12990. "type": "string",
  12991. "enum": [
  12992. "dingtalk",
  12993. "discord",
  12994. "gitea",
  12995. "gogs",
  12996. "msteams",
  12997. "slack",
  12998. "telegram",
  12999. "feishu",
  13000. "wechatwork"
  13001. ],
  13002. "x-go-name": "Type"
  13003. }
  13004. },
  13005. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13006. },
  13007. "CreateHookOptionConfig": {
  13008. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  13009. "type": "object",
  13010. "additionalProperties": {
  13011. "type": "string"
  13012. },
  13013. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13014. },
  13015. "CreateIssueCommentOption": {
  13016. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  13017. "type": "object",
  13018. "required": [
  13019. "body"
  13020. ],
  13021. "properties": {
  13022. "body": {
  13023. "type": "string",
  13024. "x-go-name": "Body"
  13025. }
  13026. },
  13027. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13028. },
  13029. "CreateIssueOption": {
  13030. "description": "CreateIssueOption options to create one issue",
  13031. "type": "object",
  13032. "required": [
  13033. "title"
  13034. ],
  13035. "properties": {
  13036. "assignee": {
  13037. "description": "deprecated",
  13038. "type": "string",
  13039. "x-go-name": "Assignee"
  13040. },
  13041. "assignees": {
  13042. "type": "array",
  13043. "items": {
  13044. "type": "string"
  13045. },
  13046. "x-go-name": "Assignees"
  13047. },
  13048. "body": {
  13049. "type": "string",
  13050. "x-go-name": "Body"
  13051. },
  13052. "closed": {
  13053. "type": "boolean",
  13054. "x-go-name": "Closed"
  13055. },
  13056. "due_date": {
  13057. "type": "string",
  13058. "format": "date-time",
  13059. "x-go-name": "Deadline"
  13060. },
  13061. "labels": {
  13062. "description": "list of label ids",
  13063. "type": "array",
  13064. "items": {
  13065. "type": "integer",
  13066. "format": "int64"
  13067. },
  13068. "x-go-name": "Labels"
  13069. },
  13070. "milestone": {
  13071. "description": "milestone id",
  13072. "type": "integer",
  13073. "format": "int64",
  13074. "x-go-name": "Milestone"
  13075. },
  13076. "ref": {
  13077. "type": "string",
  13078. "x-go-name": "Ref"
  13079. },
  13080. "title": {
  13081. "type": "string",
  13082. "x-go-name": "Title"
  13083. }
  13084. },
  13085. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13086. },
  13087. "CreateKeyOption": {
  13088. "description": "CreateKeyOption options when creating a key",
  13089. "type": "object",
  13090. "required": [
  13091. "title",
  13092. "key"
  13093. ],
  13094. "properties": {
  13095. "key": {
  13096. "description": "An armored SSH key to add",
  13097. "type": "string",
  13098. "uniqueItems": true,
  13099. "x-go-name": "Key"
  13100. },
  13101. "read_only": {
  13102. "description": "Describe if the key has only read access or read/write",
  13103. "type": "boolean",
  13104. "x-go-name": "ReadOnly"
  13105. },
  13106. "title": {
  13107. "description": "Title of the key to add",
  13108. "type": "string",
  13109. "uniqueItems": true,
  13110. "x-go-name": "Title"
  13111. }
  13112. },
  13113. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13114. },
  13115. "CreateLabelOption": {
  13116. "description": "CreateLabelOption options for creating a label",
  13117. "type": "object",
  13118. "required": [
  13119. "name",
  13120. "color"
  13121. ],
  13122. "properties": {
  13123. "color": {
  13124. "type": "string",
  13125. "x-go-name": "Color",
  13126. "example": "#00aabb"
  13127. },
  13128. "description": {
  13129. "type": "string",
  13130. "x-go-name": "Description"
  13131. },
  13132. "name": {
  13133. "type": "string",
  13134. "x-go-name": "Name"
  13135. }
  13136. },
  13137. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13138. },
  13139. "CreateMilestoneOption": {
  13140. "description": "CreateMilestoneOption options for creating a milestone",
  13141. "type": "object",
  13142. "properties": {
  13143. "description": {
  13144. "type": "string",
  13145. "x-go-name": "Description"
  13146. },
  13147. "due_on": {
  13148. "type": "string",
  13149. "format": "date-time",
  13150. "x-go-name": "Deadline"
  13151. },
  13152. "state": {
  13153. "type": "string",
  13154. "enum": [
  13155. "open",
  13156. "closed"
  13157. ],
  13158. "x-go-name": "State"
  13159. },
  13160. "title": {
  13161. "type": "string",
  13162. "x-go-name": "Title"
  13163. }
  13164. },
  13165. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13166. },
  13167. "CreateOAuth2ApplicationOptions": {
  13168. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  13169. "type": "object",
  13170. "properties": {
  13171. "name": {
  13172. "type": "string",
  13173. "x-go-name": "Name"
  13174. },
  13175. "redirect_uris": {
  13176. "type": "array",
  13177. "items": {
  13178. "type": "string"
  13179. },
  13180. "x-go-name": "RedirectURIs"
  13181. }
  13182. },
  13183. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13184. },
  13185. "CreateOrgOption": {
  13186. "description": "CreateOrgOption options for creating an organization",
  13187. "type": "object",
  13188. "required": [
  13189. "username"
  13190. ],
  13191. "properties": {
  13192. "description": {
  13193. "type": "string",
  13194. "x-go-name": "Description"
  13195. },
  13196. "full_name": {
  13197. "type": "string",
  13198. "x-go-name": "FullName"
  13199. },
  13200. "location": {
  13201. "type": "string",
  13202. "x-go-name": "Location"
  13203. },
  13204. "repo_admin_change_team_access": {
  13205. "type": "boolean",
  13206. "x-go-name": "RepoAdminChangeTeamAccess"
  13207. },
  13208. "username": {
  13209. "type": "string",
  13210. "x-go-name": "UserName"
  13211. },
  13212. "visibility": {
  13213. "description": "possible values are `public` (default), `limited` or `private`",
  13214. "type": "string",
  13215. "enum": [
  13216. "public",
  13217. "limited",
  13218. "private"
  13219. ],
  13220. "x-go-name": "Visibility"
  13221. },
  13222. "website": {
  13223. "type": "string",
  13224. "x-go-name": "Website"
  13225. }
  13226. },
  13227. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13228. },
  13229. "CreatePullRequestOption": {
  13230. "description": "CreatePullRequestOption options when creating a pull request",
  13231. "type": "object",
  13232. "properties": {
  13233. "assignee": {
  13234. "type": "string",
  13235. "x-go-name": "Assignee"
  13236. },
  13237. "assignees": {
  13238. "type": "array",
  13239. "items": {
  13240. "type": "string"
  13241. },
  13242. "x-go-name": "Assignees"
  13243. },
  13244. "base": {
  13245. "type": "string",
  13246. "x-go-name": "Base"
  13247. },
  13248. "body": {
  13249. "type": "string",
  13250. "x-go-name": "Body"
  13251. },
  13252. "due_date": {
  13253. "type": "string",
  13254. "format": "date-time",
  13255. "x-go-name": "Deadline"
  13256. },
  13257. "head": {
  13258. "type": "string",
  13259. "x-go-name": "Head"
  13260. },
  13261. "labels": {
  13262. "type": "array",
  13263. "items": {
  13264. "type": "integer",
  13265. "format": "int64"
  13266. },
  13267. "x-go-name": "Labels"
  13268. },
  13269. "milestone": {
  13270. "type": "integer",
  13271. "format": "int64",
  13272. "x-go-name": "Milestone"
  13273. },
  13274. "title": {
  13275. "type": "string",
  13276. "x-go-name": "Title"
  13277. }
  13278. },
  13279. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13280. },
  13281. "CreatePullReviewComment": {
  13282. "description": "CreatePullReviewComment represent a review comment for creation api",
  13283. "type": "object",
  13284. "properties": {
  13285. "body": {
  13286. "type": "string",
  13287. "x-go-name": "Body"
  13288. },
  13289. "new_position": {
  13290. "description": "if comment to new file line or 0",
  13291. "type": "integer",
  13292. "format": "int64",
  13293. "x-go-name": "NewLineNum"
  13294. },
  13295. "old_position": {
  13296. "description": "if comment to old file line or 0",
  13297. "type": "integer",
  13298. "format": "int64",
  13299. "x-go-name": "OldLineNum"
  13300. },
  13301. "path": {
  13302. "description": "the tree path",
  13303. "type": "string",
  13304. "x-go-name": "Path"
  13305. }
  13306. },
  13307. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13308. },
  13309. "CreatePullReviewOptions": {
  13310. "description": "CreatePullReviewOptions are options to create a pull review",
  13311. "type": "object",
  13312. "properties": {
  13313. "body": {
  13314. "type": "string",
  13315. "x-go-name": "Body"
  13316. },
  13317. "comments": {
  13318. "type": "array",
  13319. "items": {
  13320. "$ref": "#/definitions/CreatePullReviewComment"
  13321. },
  13322. "x-go-name": "Comments"
  13323. },
  13324. "commit_id": {
  13325. "type": "string",
  13326. "x-go-name": "CommitID"
  13327. },
  13328. "event": {
  13329. "$ref": "#/definitions/ReviewStateType"
  13330. }
  13331. },
  13332. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13333. },
  13334. "CreateReleaseOption": {
  13335. "description": "CreateReleaseOption options when creating a release",
  13336. "type": "object",
  13337. "required": [
  13338. "tag_name"
  13339. ],
  13340. "properties": {
  13341. "body": {
  13342. "type": "string",
  13343. "x-go-name": "Note"
  13344. },
  13345. "draft": {
  13346. "type": "boolean",
  13347. "x-go-name": "IsDraft"
  13348. },
  13349. "name": {
  13350. "type": "string",
  13351. "x-go-name": "Title"
  13352. },
  13353. "prerelease": {
  13354. "type": "boolean",
  13355. "x-go-name": "IsPrerelease"
  13356. },
  13357. "tag_name": {
  13358. "type": "string",
  13359. "x-go-name": "TagName"
  13360. },
  13361. "target_commitish": {
  13362. "type": "string",
  13363. "x-go-name": "Target"
  13364. }
  13365. },
  13366. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13367. },
  13368. "CreateRepoOption": {
  13369. "description": "CreateRepoOption options when creating repository",
  13370. "type": "object",
  13371. "required": [
  13372. "name"
  13373. ],
  13374. "properties": {
  13375. "auto_init": {
  13376. "description": "Whether the repository should be auto-intialized?",
  13377. "type": "boolean",
  13378. "x-go-name": "AutoInit"
  13379. },
  13380. "default_branch": {
  13381. "description": "DefaultBranch of the repository (used when initializes and in template)",
  13382. "type": "string",
  13383. "x-go-name": "DefaultBranch"
  13384. },
  13385. "description": {
  13386. "description": "Description of the repository to create",
  13387. "type": "string",
  13388. "x-go-name": "Description"
  13389. },
  13390. "gitignores": {
  13391. "description": "Gitignores to use",
  13392. "type": "string",
  13393. "x-go-name": "Gitignores"
  13394. },
  13395. "issue_labels": {
  13396. "description": "Label-Set to use",
  13397. "type": "string",
  13398. "x-go-name": "IssueLabels"
  13399. },
  13400. "license": {
  13401. "description": "License to use",
  13402. "type": "string",
  13403. "x-go-name": "License"
  13404. },
  13405. "name": {
  13406. "description": "Name of the repository to create",
  13407. "type": "string",
  13408. "uniqueItems": true,
  13409. "x-go-name": "Name"
  13410. },
  13411. "private": {
  13412. "description": "Whether the repository is private",
  13413. "type": "boolean",
  13414. "x-go-name": "Private"
  13415. },
  13416. "readme": {
  13417. "description": "Readme of the repository to create",
  13418. "type": "string",
  13419. "x-go-name": "Readme"
  13420. },
  13421. "template": {
  13422. "description": "Whether the repository is template",
  13423. "type": "boolean",
  13424. "x-go-name": "Template"
  13425. },
  13426. "trust_model": {
  13427. "description": "TrustModel of the repository",
  13428. "type": "string",
  13429. "enum": [
  13430. "default",
  13431. "collaborator",
  13432. "committer",
  13433. "collaboratorcommitter"
  13434. ],
  13435. "x-go-name": "TrustModel"
  13436. }
  13437. },
  13438. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13439. },
  13440. "CreateStatusOption": {
  13441. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  13442. "type": "object",
  13443. "properties": {
  13444. "context": {
  13445. "type": "string",
  13446. "x-go-name": "Context"
  13447. },
  13448. "description": {
  13449. "type": "string",
  13450. "x-go-name": "Description"
  13451. },
  13452. "state": {
  13453. "$ref": "#/definitions/CommitStatusState"
  13454. },
  13455. "target_url": {
  13456. "type": "string",
  13457. "x-go-name": "TargetURL"
  13458. }
  13459. },
  13460. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13461. },
  13462. "CreateTagOption": {
  13463. "description": "CreateTagOption options when creating a tag",
  13464. "type": "object",
  13465. "required": [
  13466. "tag_name"
  13467. ],
  13468. "properties": {
  13469. "message": {
  13470. "type": "string",
  13471. "x-go-name": "Message"
  13472. },
  13473. "tag_name": {
  13474. "type": "string",
  13475. "x-go-name": "TagName"
  13476. },
  13477. "target": {
  13478. "type": "string",
  13479. "x-go-name": "Target"
  13480. }
  13481. },
  13482. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13483. },
  13484. "CreateTeamOption": {
  13485. "description": "CreateTeamOption options for creating a team",
  13486. "type": "object",
  13487. "required": [
  13488. "name"
  13489. ],
  13490. "properties": {
  13491. "can_create_org_repo": {
  13492. "type": "boolean",
  13493. "x-go-name": "CanCreateOrgRepo"
  13494. },
  13495. "description": {
  13496. "type": "string",
  13497. "x-go-name": "Description"
  13498. },
  13499. "includes_all_repositories": {
  13500. "type": "boolean",
  13501. "x-go-name": "IncludesAllRepositories"
  13502. },
  13503. "name": {
  13504. "type": "string",
  13505. "x-go-name": "Name"
  13506. },
  13507. "permission": {
  13508. "type": "string",
  13509. "enum": [
  13510. "read",
  13511. "write",
  13512. "admin"
  13513. ],
  13514. "x-go-name": "Permission"
  13515. },
  13516. "units": {
  13517. "type": "array",
  13518. "items": {
  13519. "type": "string"
  13520. },
  13521. "x-go-name": "Units",
  13522. "example": [
  13523. "repo.code",
  13524. "repo.issues",
  13525. "repo.ext_issues",
  13526. "repo.wiki",
  13527. "repo.pulls",
  13528. "repo.releases",
  13529. "repo.projects",
  13530. "repo.ext_wiki"
  13531. ]
  13532. }
  13533. },
  13534. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13535. },
  13536. "CreateUserOption": {
  13537. "description": "CreateUserOption create user options",
  13538. "type": "object",
  13539. "required": [
  13540. "username",
  13541. "email",
  13542. "password"
  13543. ],
  13544. "properties": {
  13545. "email": {
  13546. "type": "string",
  13547. "format": "email",
  13548. "x-go-name": "Email"
  13549. },
  13550. "full_name": {
  13551. "type": "string",
  13552. "x-go-name": "FullName"
  13553. },
  13554. "login_name": {
  13555. "type": "string",
  13556. "x-go-name": "LoginName"
  13557. },
  13558. "must_change_password": {
  13559. "type": "boolean",
  13560. "x-go-name": "MustChangePassword"
  13561. },
  13562. "password": {
  13563. "type": "string",
  13564. "x-go-name": "Password"
  13565. },
  13566. "send_notify": {
  13567. "type": "boolean",
  13568. "x-go-name": "SendNotify"
  13569. },
  13570. "source_id": {
  13571. "type": "integer",
  13572. "format": "int64",
  13573. "x-go-name": "SourceID"
  13574. },
  13575. "username": {
  13576. "type": "string",
  13577. "x-go-name": "Username"
  13578. },
  13579. "visibility": {
  13580. "type": "string",
  13581. "x-go-name": "Visibility"
  13582. }
  13583. },
  13584. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13585. },
  13586. "Cron": {
  13587. "description": "Cron represents a Cron task",
  13588. "type": "object",
  13589. "properties": {
  13590. "exec_times": {
  13591. "type": "integer",
  13592. "format": "int64",
  13593. "x-go-name": "ExecTimes"
  13594. },
  13595. "name": {
  13596. "type": "string",
  13597. "x-go-name": "Name"
  13598. },
  13599. "next": {
  13600. "type": "string",
  13601. "format": "date-time",
  13602. "x-go-name": "Next"
  13603. },
  13604. "prev": {
  13605. "type": "string",
  13606. "format": "date-time",
  13607. "x-go-name": "Prev"
  13608. },
  13609. "schedule": {
  13610. "type": "string",
  13611. "x-go-name": "Schedule"
  13612. }
  13613. },
  13614. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13615. },
  13616. "DeleteEmailOption": {
  13617. "description": "DeleteEmailOption options when deleting email addresses",
  13618. "type": "object",
  13619. "properties": {
  13620. "emails": {
  13621. "description": "email addresses to delete",
  13622. "type": "array",
  13623. "items": {
  13624. "type": "string"
  13625. },
  13626. "x-go-name": "Emails"
  13627. }
  13628. },
  13629. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13630. },
  13631. "DeleteFileOptions": {
  13632. "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)",
  13633. "type": "object",
  13634. "required": [
  13635. "sha"
  13636. ],
  13637. "properties": {
  13638. "author": {
  13639. "$ref": "#/definitions/Identity"
  13640. },
  13641. "branch": {
  13642. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  13643. "type": "string",
  13644. "x-go-name": "BranchName"
  13645. },
  13646. "committer": {
  13647. "$ref": "#/definitions/Identity"
  13648. },
  13649. "dates": {
  13650. "$ref": "#/definitions/CommitDateOptions"
  13651. },
  13652. "message": {
  13653. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  13654. "type": "string",
  13655. "x-go-name": "Message"
  13656. },
  13657. "new_branch": {
  13658. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  13659. "type": "string",
  13660. "x-go-name": "NewBranchName"
  13661. },
  13662. "sha": {
  13663. "description": "sha is the SHA for the file that already exists",
  13664. "type": "string",
  13665. "x-go-name": "SHA"
  13666. },
  13667. "signoff": {
  13668. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  13669. "type": "boolean",
  13670. "x-go-name": "Signoff"
  13671. }
  13672. },
  13673. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13674. },
  13675. "DeployKey": {
  13676. "description": "DeployKey a deploy key",
  13677. "type": "object",
  13678. "properties": {
  13679. "created_at": {
  13680. "type": "string",
  13681. "format": "date-time",
  13682. "x-go-name": "Created"
  13683. },
  13684. "fingerprint": {
  13685. "type": "string",
  13686. "x-go-name": "Fingerprint"
  13687. },
  13688. "id": {
  13689. "type": "integer",
  13690. "format": "int64",
  13691. "x-go-name": "ID"
  13692. },
  13693. "key": {
  13694. "type": "string",
  13695. "x-go-name": "Key"
  13696. },
  13697. "key_id": {
  13698. "type": "integer",
  13699. "format": "int64",
  13700. "x-go-name": "KeyID"
  13701. },
  13702. "read_only": {
  13703. "type": "boolean",
  13704. "x-go-name": "ReadOnly"
  13705. },
  13706. "repository": {
  13707. "$ref": "#/definitions/Repository"
  13708. },
  13709. "title": {
  13710. "type": "string",
  13711. "x-go-name": "Title"
  13712. },
  13713. "url": {
  13714. "type": "string",
  13715. "x-go-name": "URL"
  13716. }
  13717. },
  13718. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13719. },
  13720. "DismissPullReviewOptions": {
  13721. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  13722. "type": "object",
  13723. "properties": {
  13724. "message": {
  13725. "type": "string",
  13726. "x-go-name": "Message"
  13727. }
  13728. },
  13729. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13730. },
  13731. "EditAttachmentOptions": {
  13732. "description": "EditAttachmentOptions options for editing attachments",
  13733. "type": "object",
  13734. "properties": {
  13735. "name": {
  13736. "type": "string",
  13737. "x-go-name": "Name"
  13738. }
  13739. },
  13740. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13741. },
  13742. "EditBranchProtectionOption": {
  13743. "description": "EditBranchProtectionOption options for editing a branch protection",
  13744. "type": "object",
  13745. "properties": {
  13746. "approvals_whitelist_teams": {
  13747. "type": "array",
  13748. "items": {
  13749. "type": "string"
  13750. },
  13751. "x-go-name": "ApprovalsWhitelistTeams"
  13752. },
  13753. "approvals_whitelist_username": {
  13754. "type": "array",
  13755. "items": {
  13756. "type": "string"
  13757. },
  13758. "x-go-name": "ApprovalsWhitelistUsernames"
  13759. },
  13760. "block_on_official_review_requests": {
  13761. "type": "boolean",
  13762. "x-go-name": "BlockOnOfficialReviewRequests"
  13763. },
  13764. "block_on_outdated_branch": {
  13765. "type": "boolean",
  13766. "x-go-name": "BlockOnOutdatedBranch"
  13767. },
  13768. "block_on_rejected_reviews": {
  13769. "type": "boolean",
  13770. "x-go-name": "BlockOnRejectedReviews"
  13771. },
  13772. "dismiss_stale_approvals": {
  13773. "type": "boolean",
  13774. "x-go-name": "DismissStaleApprovals"
  13775. },
  13776. "enable_approvals_whitelist": {
  13777. "type": "boolean",
  13778. "x-go-name": "EnableApprovalsWhitelist"
  13779. },
  13780. "enable_merge_whitelist": {
  13781. "type": "boolean",
  13782. "x-go-name": "EnableMergeWhitelist"
  13783. },
  13784. "enable_push": {
  13785. "type": "boolean",
  13786. "x-go-name": "EnablePush"
  13787. },
  13788. "enable_push_whitelist": {
  13789. "type": "boolean",
  13790. "x-go-name": "EnablePushWhitelist"
  13791. },
  13792. "enable_status_check": {
  13793. "type": "boolean",
  13794. "x-go-name": "EnableStatusCheck"
  13795. },
  13796. "merge_whitelist_teams": {
  13797. "type": "array",
  13798. "items": {
  13799. "type": "string"
  13800. },
  13801. "x-go-name": "MergeWhitelistTeams"
  13802. },
  13803. "merge_whitelist_usernames": {
  13804. "type": "array",
  13805. "items": {
  13806. "type": "string"
  13807. },
  13808. "x-go-name": "MergeWhitelistUsernames"
  13809. },
  13810. "protected_file_patterns": {
  13811. "type": "string",
  13812. "x-go-name": "ProtectedFilePatterns"
  13813. },
  13814. "push_whitelist_deploy_keys": {
  13815. "type": "boolean",
  13816. "x-go-name": "PushWhitelistDeployKeys"
  13817. },
  13818. "push_whitelist_teams": {
  13819. "type": "array",
  13820. "items": {
  13821. "type": "string"
  13822. },
  13823. "x-go-name": "PushWhitelistTeams"
  13824. },
  13825. "push_whitelist_usernames": {
  13826. "type": "array",
  13827. "items": {
  13828. "type": "string"
  13829. },
  13830. "x-go-name": "PushWhitelistUsernames"
  13831. },
  13832. "require_signed_commits": {
  13833. "type": "boolean",
  13834. "x-go-name": "RequireSignedCommits"
  13835. },
  13836. "required_approvals": {
  13837. "type": "integer",
  13838. "format": "int64",
  13839. "x-go-name": "RequiredApprovals"
  13840. },
  13841. "status_check_contexts": {
  13842. "type": "array",
  13843. "items": {
  13844. "type": "string"
  13845. },
  13846. "x-go-name": "StatusCheckContexts"
  13847. },
  13848. "unprotected_file_patterns": {
  13849. "type": "string",
  13850. "x-go-name": "UnprotectedFilePatterns"
  13851. }
  13852. },
  13853. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13854. },
  13855. "EditDeadlineOption": {
  13856. "description": "EditDeadlineOption options for creating a deadline",
  13857. "type": "object",
  13858. "required": [
  13859. "due_date"
  13860. ],
  13861. "properties": {
  13862. "due_date": {
  13863. "type": "string",
  13864. "format": "date-time",
  13865. "x-go-name": "Deadline"
  13866. }
  13867. },
  13868. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13869. },
  13870. "EditGitHookOption": {
  13871. "description": "EditGitHookOption options when modifying one Git hook",
  13872. "type": "object",
  13873. "properties": {
  13874. "content": {
  13875. "type": "string",
  13876. "x-go-name": "Content"
  13877. }
  13878. },
  13879. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13880. },
  13881. "EditHookOption": {
  13882. "description": "EditHookOption options when modify one hook",
  13883. "type": "object",
  13884. "properties": {
  13885. "active": {
  13886. "type": "boolean",
  13887. "x-go-name": "Active"
  13888. },
  13889. "branch_filter": {
  13890. "type": "string",
  13891. "x-go-name": "BranchFilter"
  13892. },
  13893. "config": {
  13894. "type": "object",
  13895. "additionalProperties": {
  13896. "type": "string"
  13897. },
  13898. "x-go-name": "Config"
  13899. },
  13900. "events": {
  13901. "type": "array",
  13902. "items": {
  13903. "type": "string"
  13904. },
  13905. "x-go-name": "Events"
  13906. }
  13907. },
  13908. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13909. },
  13910. "EditIssueCommentOption": {
  13911. "description": "EditIssueCommentOption options for editing a comment",
  13912. "type": "object",
  13913. "required": [
  13914. "body"
  13915. ],
  13916. "properties": {
  13917. "body": {
  13918. "type": "string",
  13919. "x-go-name": "Body"
  13920. }
  13921. },
  13922. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13923. },
  13924. "EditIssueOption": {
  13925. "description": "EditIssueOption options for editing an issue",
  13926. "type": "object",
  13927. "properties": {
  13928. "assignee": {
  13929. "description": "deprecated",
  13930. "type": "string",
  13931. "x-go-name": "Assignee"
  13932. },
  13933. "assignees": {
  13934. "type": "array",
  13935. "items": {
  13936. "type": "string"
  13937. },
  13938. "x-go-name": "Assignees"
  13939. },
  13940. "body": {
  13941. "type": "string",
  13942. "x-go-name": "Body"
  13943. },
  13944. "due_date": {
  13945. "type": "string",
  13946. "format": "date-time",
  13947. "x-go-name": "Deadline"
  13948. },
  13949. "milestone": {
  13950. "type": "integer",
  13951. "format": "int64",
  13952. "x-go-name": "Milestone"
  13953. },
  13954. "ref": {
  13955. "type": "string",
  13956. "x-go-name": "Ref"
  13957. },
  13958. "state": {
  13959. "type": "string",
  13960. "x-go-name": "State"
  13961. },
  13962. "title": {
  13963. "type": "string",
  13964. "x-go-name": "Title"
  13965. },
  13966. "unset_due_date": {
  13967. "type": "boolean",
  13968. "x-go-name": "RemoveDeadline"
  13969. }
  13970. },
  13971. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13972. },
  13973. "EditLabelOption": {
  13974. "description": "EditLabelOption options for editing a label",
  13975. "type": "object",
  13976. "properties": {
  13977. "color": {
  13978. "type": "string",
  13979. "x-go-name": "Color"
  13980. },
  13981. "description": {
  13982. "type": "string",
  13983. "x-go-name": "Description"
  13984. },
  13985. "name": {
  13986. "type": "string",
  13987. "x-go-name": "Name"
  13988. }
  13989. },
  13990. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13991. },
  13992. "EditMilestoneOption": {
  13993. "description": "EditMilestoneOption options for editing a milestone",
  13994. "type": "object",
  13995. "properties": {
  13996. "description": {
  13997. "type": "string",
  13998. "x-go-name": "Description"
  13999. },
  14000. "due_on": {
  14001. "type": "string",
  14002. "format": "date-time",
  14003. "x-go-name": "Deadline"
  14004. },
  14005. "state": {
  14006. "type": "string",
  14007. "x-go-name": "State"
  14008. },
  14009. "title": {
  14010. "type": "string",
  14011. "x-go-name": "Title"
  14012. }
  14013. },
  14014. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14015. },
  14016. "EditOrgOption": {
  14017. "description": "EditOrgOption options for editing an organization",
  14018. "type": "object",
  14019. "properties": {
  14020. "description": {
  14021. "type": "string",
  14022. "x-go-name": "Description"
  14023. },
  14024. "full_name": {
  14025. "type": "string",
  14026. "x-go-name": "FullName"
  14027. },
  14028. "location": {
  14029. "type": "string",
  14030. "x-go-name": "Location"
  14031. },
  14032. "repo_admin_change_team_access": {
  14033. "type": "boolean",
  14034. "x-go-name": "RepoAdminChangeTeamAccess"
  14035. },
  14036. "visibility": {
  14037. "description": "possible values are `public`, `limited` or `private`",
  14038. "type": "string",
  14039. "enum": [
  14040. "public",
  14041. "limited",
  14042. "private"
  14043. ],
  14044. "x-go-name": "Visibility"
  14045. },
  14046. "website": {
  14047. "type": "string",
  14048. "x-go-name": "Website"
  14049. }
  14050. },
  14051. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14052. },
  14053. "EditPullRequestOption": {
  14054. "description": "EditPullRequestOption options when modify pull request",
  14055. "type": "object",
  14056. "properties": {
  14057. "assignee": {
  14058. "type": "string",
  14059. "x-go-name": "Assignee"
  14060. },
  14061. "assignees": {
  14062. "type": "array",
  14063. "items": {
  14064. "type": "string"
  14065. },
  14066. "x-go-name": "Assignees"
  14067. },
  14068. "base": {
  14069. "type": "string",
  14070. "x-go-name": "Base"
  14071. },
  14072. "body": {
  14073. "type": "string",
  14074. "x-go-name": "Body"
  14075. },
  14076. "due_date": {
  14077. "type": "string",
  14078. "format": "date-time",
  14079. "x-go-name": "Deadline"
  14080. },
  14081. "labels": {
  14082. "type": "array",
  14083. "items": {
  14084. "type": "integer",
  14085. "format": "int64"
  14086. },
  14087. "x-go-name": "Labels"
  14088. },
  14089. "milestone": {
  14090. "type": "integer",
  14091. "format": "int64",
  14092. "x-go-name": "Milestone"
  14093. },
  14094. "state": {
  14095. "type": "string",
  14096. "x-go-name": "State"
  14097. },
  14098. "title": {
  14099. "type": "string",
  14100. "x-go-name": "Title"
  14101. },
  14102. "unset_due_date": {
  14103. "type": "boolean",
  14104. "x-go-name": "RemoveDeadline"
  14105. }
  14106. },
  14107. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14108. },
  14109. "EditReactionOption": {
  14110. "description": "EditReactionOption contain the reaction type",
  14111. "type": "object",
  14112. "properties": {
  14113. "content": {
  14114. "type": "string",
  14115. "x-go-name": "Reaction"
  14116. }
  14117. },
  14118. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14119. },
  14120. "EditReleaseOption": {
  14121. "description": "EditReleaseOption options when editing a release",
  14122. "type": "object",
  14123. "properties": {
  14124. "body": {
  14125. "type": "string",
  14126. "x-go-name": "Note"
  14127. },
  14128. "draft": {
  14129. "type": "boolean",
  14130. "x-go-name": "IsDraft"
  14131. },
  14132. "name": {
  14133. "type": "string",
  14134. "x-go-name": "Title"
  14135. },
  14136. "prerelease": {
  14137. "type": "boolean",
  14138. "x-go-name": "IsPrerelease"
  14139. },
  14140. "tag_name": {
  14141. "type": "string",
  14142. "x-go-name": "TagName"
  14143. },
  14144. "target_commitish": {
  14145. "type": "string",
  14146. "x-go-name": "Target"
  14147. }
  14148. },
  14149. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14150. },
  14151. "EditRepoOption": {
  14152. "description": "EditRepoOption options when editing a repository's properties",
  14153. "type": "object",
  14154. "properties": {
  14155. "allow_manual_merge": {
  14156. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it. `has_pull_requests` must be `true`.",
  14157. "type": "boolean",
  14158. "x-go-name": "AllowManualMerge"
  14159. },
  14160. "allow_merge_commits": {
  14161. "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`.",
  14162. "type": "boolean",
  14163. "x-go-name": "AllowMerge"
  14164. },
  14165. "allow_rebase": {
  14166. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  14167. "type": "boolean",
  14168. "x-go-name": "AllowRebase"
  14169. },
  14170. "allow_rebase_explicit": {
  14171. "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`.",
  14172. "type": "boolean",
  14173. "x-go-name": "AllowRebaseMerge"
  14174. },
  14175. "allow_squash_merge": {
  14176. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  14177. "type": "boolean",
  14178. "x-go-name": "AllowSquash"
  14179. },
  14180. "archived": {
  14181. "description": "set to `true` to archive this repository.",
  14182. "type": "boolean",
  14183. "x-go-name": "Archived"
  14184. },
  14185. "autodetect_manual_merge": {
  14186. "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.",
  14187. "type": "boolean",
  14188. "x-go-name": "AutodetectManualMerge"
  14189. },
  14190. "default_branch": {
  14191. "description": "sets the default branch for this repository.",
  14192. "type": "string",
  14193. "x-go-name": "DefaultBranch"
  14194. },
  14195. "default_delete_branch_after_merge": {
  14196. "description": "set to `true` to delete pr branch after merge by default",
  14197. "type": "boolean",
  14198. "x-go-name": "DefaultDeleteBranchAfterMerge"
  14199. },
  14200. "default_merge_style": {
  14201. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", or \"squash\". `has_pull_requests` must be `true`.",
  14202. "type": "string",
  14203. "x-go-name": "DefaultMergeStyle"
  14204. },
  14205. "description": {
  14206. "description": "a short description of the repository.",
  14207. "type": "string",
  14208. "x-go-name": "Description"
  14209. },
  14210. "external_tracker": {
  14211. "$ref": "#/definitions/ExternalTracker"
  14212. },
  14213. "external_wiki": {
  14214. "$ref": "#/definitions/ExternalWiki"
  14215. },
  14216. "has_issues": {
  14217. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  14218. "type": "boolean",
  14219. "x-go-name": "HasIssues"
  14220. },
  14221. "has_projects": {
  14222. "description": "either `true` to enable project unit, or `false` to disable them.",
  14223. "type": "boolean",
  14224. "x-go-name": "HasProjects"
  14225. },
  14226. "has_pull_requests": {
  14227. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  14228. "type": "boolean",
  14229. "x-go-name": "HasPullRequests"
  14230. },
  14231. "has_wiki": {
  14232. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  14233. "type": "boolean",
  14234. "x-go-name": "HasWiki"
  14235. },
  14236. "ignore_whitespace_conflicts": {
  14237. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  14238. "type": "boolean",
  14239. "x-go-name": "IgnoreWhitespaceConflicts"
  14240. },
  14241. "internal_tracker": {
  14242. "$ref": "#/definitions/InternalTracker"
  14243. },
  14244. "mirror_interval": {
  14245. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  14246. "type": "string",
  14247. "x-go-name": "MirrorInterval"
  14248. },
  14249. "name": {
  14250. "description": "name of the repository",
  14251. "type": "string",
  14252. "uniqueItems": true,
  14253. "x-go-name": "Name"
  14254. },
  14255. "private": {
  14256. "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.",
  14257. "type": "boolean",
  14258. "x-go-name": "Private"
  14259. },
  14260. "template": {
  14261. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  14262. "type": "boolean",
  14263. "x-go-name": "Template"
  14264. },
  14265. "website": {
  14266. "description": "a URL with more information about the repository.",
  14267. "type": "string",
  14268. "x-go-name": "Website"
  14269. }
  14270. },
  14271. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14272. },
  14273. "EditTeamOption": {
  14274. "description": "EditTeamOption options for editing a team",
  14275. "type": "object",
  14276. "required": [
  14277. "name"
  14278. ],
  14279. "properties": {
  14280. "can_create_org_repo": {
  14281. "type": "boolean",
  14282. "x-go-name": "CanCreateOrgRepo"
  14283. },
  14284. "description": {
  14285. "type": "string",
  14286. "x-go-name": "Description"
  14287. },
  14288. "includes_all_repositories": {
  14289. "type": "boolean",
  14290. "x-go-name": "IncludesAllRepositories"
  14291. },
  14292. "name": {
  14293. "type": "string",
  14294. "x-go-name": "Name"
  14295. },
  14296. "permission": {
  14297. "type": "string",
  14298. "enum": [
  14299. "read",
  14300. "write",
  14301. "admin"
  14302. ],
  14303. "x-go-name": "Permission"
  14304. },
  14305. "units": {
  14306. "type": "array",
  14307. "items": {
  14308. "type": "string"
  14309. },
  14310. "x-go-name": "Units",
  14311. "example": [
  14312. "repo.code",
  14313. "repo.issues",
  14314. "repo.ext_issues",
  14315. "repo.wiki",
  14316. "repo.pulls",
  14317. "repo.releases",
  14318. "repo.projects",
  14319. "repo.ext_wiki"
  14320. ]
  14321. }
  14322. },
  14323. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14324. },
  14325. "EditUserOption": {
  14326. "description": "EditUserOption edit user options",
  14327. "type": "object",
  14328. "required": [
  14329. "source_id",
  14330. "login_name"
  14331. ],
  14332. "properties": {
  14333. "active": {
  14334. "type": "boolean",
  14335. "x-go-name": "Active"
  14336. },
  14337. "admin": {
  14338. "type": "boolean",
  14339. "x-go-name": "Admin"
  14340. },
  14341. "allow_create_organization": {
  14342. "type": "boolean",
  14343. "x-go-name": "AllowCreateOrganization"
  14344. },
  14345. "allow_git_hook": {
  14346. "type": "boolean",
  14347. "x-go-name": "AllowGitHook"
  14348. },
  14349. "allow_import_local": {
  14350. "type": "boolean",
  14351. "x-go-name": "AllowImportLocal"
  14352. },
  14353. "description": {
  14354. "type": "string",
  14355. "x-go-name": "Description"
  14356. },
  14357. "email": {
  14358. "type": "string",
  14359. "format": "email",
  14360. "x-go-name": "Email"
  14361. },
  14362. "full_name": {
  14363. "type": "string",
  14364. "x-go-name": "FullName"
  14365. },
  14366. "location": {
  14367. "type": "string",
  14368. "x-go-name": "Location"
  14369. },
  14370. "login_name": {
  14371. "type": "string",
  14372. "x-go-name": "LoginName"
  14373. },
  14374. "max_repo_creation": {
  14375. "type": "integer",
  14376. "format": "int64",
  14377. "x-go-name": "MaxRepoCreation"
  14378. },
  14379. "must_change_password": {
  14380. "type": "boolean",
  14381. "x-go-name": "MustChangePassword"
  14382. },
  14383. "password": {
  14384. "type": "string",
  14385. "x-go-name": "Password"
  14386. },
  14387. "prohibit_login": {
  14388. "type": "boolean",
  14389. "x-go-name": "ProhibitLogin"
  14390. },
  14391. "restricted": {
  14392. "type": "boolean",
  14393. "x-go-name": "Restricted"
  14394. },
  14395. "source_id": {
  14396. "type": "integer",
  14397. "format": "int64",
  14398. "x-go-name": "SourceID"
  14399. },
  14400. "visibility": {
  14401. "type": "string",
  14402. "x-go-name": "Visibility"
  14403. },
  14404. "website": {
  14405. "type": "string",
  14406. "x-go-name": "Website"
  14407. }
  14408. },
  14409. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14410. },
  14411. "Email": {
  14412. "description": "Email an email address belonging to a user",
  14413. "type": "object",
  14414. "properties": {
  14415. "email": {
  14416. "type": "string",
  14417. "format": "email",
  14418. "x-go-name": "Email"
  14419. },
  14420. "primary": {
  14421. "type": "boolean",
  14422. "x-go-name": "Primary"
  14423. },
  14424. "verified": {
  14425. "type": "boolean",
  14426. "x-go-name": "Verified"
  14427. }
  14428. },
  14429. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14430. },
  14431. "ExternalTracker": {
  14432. "description": "ExternalTracker represents settings for external tracker",
  14433. "type": "object",
  14434. "properties": {
  14435. "external_tracker_format": {
  14436. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  14437. "type": "string",
  14438. "x-go-name": "ExternalTrackerFormat"
  14439. },
  14440. "external_tracker_style": {
  14441. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  14442. "type": "string",
  14443. "x-go-name": "ExternalTrackerStyle"
  14444. },
  14445. "external_tracker_url": {
  14446. "description": "URL of external issue tracker.",
  14447. "type": "string",
  14448. "x-go-name": "ExternalTrackerURL"
  14449. }
  14450. },
  14451. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14452. },
  14453. "ExternalWiki": {
  14454. "description": "ExternalWiki represents setting for external wiki",
  14455. "type": "object",
  14456. "properties": {
  14457. "external_wiki_url": {
  14458. "description": "URL of external wiki.",
  14459. "type": "string",
  14460. "x-go-name": "ExternalWikiURL"
  14461. }
  14462. },
  14463. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14464. },
  14465. "FileCommitResponse": {
  14466. "type": "object",
  14467. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  14468. "properties": {
  14469. "author": {
  14470. "$ref": "#/definitions/CommitUser"
  14471. },
  14472. "committer": {
  14473. "$ref": "#/definitions/CommitUser"
  14474. },
  14475. "created": {
  14476. "type": "string",
  14477. "format": "date-time",
  14478. "x-go-name": "Created"
  14479. },
  14480. "html_url": {
  14481. "type": "string",
  14482. "x-go-name": "HTMLURL"
  14483. },
  14484. "message": {
  14485. "type": "string",
  14486. "x-go-name": "Message"
  14487. },
  14488. "parents": {
  14489. "type": "array",
  14490. "items": {
  14491. "$ref": "#/definitions/CommitMeta"
  14492. },
  14493. "x-go-name": "Parents"
  14494. },
  14495. "sha": {
  14496. "type": "string",
  14497. "x-go-name": "SHA"
  14498. },
  14499. "tree": {
  14500. "$ref": "#/definitions/CommitMeta"
  14501. },
  14502. "url": {
  14503. "type": "string",
  14504. "x-go-name": "URL"
  14505. }
  14506. },
  14507. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14508. },
  14509. "FileDeleteResponse": {
  14510. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  14511. "type": "object",
  14512. "properties": {
  14513. "commit": {
  14514. "$ref": "#/definitions/FileCommitResponse"
  14515. },
  14516. "content": {
  14517. "type": "object",
  14518. "x-go-name": "Content"
  14519. },
  14520. "verification": {
  14521. "$ref": "#/definitions/PayloadCommitVerification"
  14522. }
  14523. },
  14524. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14525. },
  14526. "FileLinksResponse": {
  14527. "description": "FileLinksResponse contains the links for a repo's file",
  14528. "type": "object",
  14529. "properties": {
  14530. "git": {
  14531. "type": "string",
  14532. "x-go-name": "GitURL"
  14533. },
  14534. "html": {
  14535. "type": "string",
  14536. "x-go-name": "HTMLURL"
  14537. },
  14538. "self": {
  14539. "type": "string",
  14540. "x-go-name": "Self"
  14541. }
  14542. },
  14543. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14544. },
  14545. "FileResponse": {
  14546. "description": "FileResponse contains information about a repo's file",
  14547. "type": "object",
  14548. "properties": {
  14549. "commit": {
  14550. "$ref": "#/definitions/FileCommitResponse"
  14551. },
  14552. "content": {
  14553. "$ref": "#/definitions/ContentsResponse"
  14554. },
  14555. "verification": {
  14556. "$ref": "#/definitions/PayloadCommitVerification"
  14557. }
  14558. },
  14559. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14560. },
  14561. "GPGKey": {
  14562. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  14563. "type": "object",
  14564. "properties": {
  14565. "can_certify": {
  14566. "type": "boolean",
  14567. "x-go-name": "CanCertify"
  14568. },
  14569. "can_encrypt_comms": {
  14570. "type": "boolean",
  14571. "x-go-name": "CanEncryptComms"
  14572. },
  14573. "can_encrypt_storage": {
  14574. "type": "boolean",
  14575. "x-go-name": "CanEncryptStorage"
  14576. },
  14577. "can_sign": {
  14578. "type": "boolean",
  14579. "x-go-name": "CanSign"
  14580. },
  14581. "created_at": {
  14582. "type": "string",
  14583. "format": "date-time",
  14584. "x-go-name": "Created"
  14585. },
  14586. "emails": {
  14587. "type": "array",
  14588. "items": {
  14589. "$ref": "#/definitions/GPGKeyEmail"
  14590. },
  14591. "x-go-name": "Emails"
  14592. },
  14593. "expires_at": {
  14594. "type": "string",
  14595. "format": "date-time",
  14596. "x-go-name": "Expires"
  14597. },
  14598. "id": {
  14599. "type": "integer",
  14600. "format": "int64",
  14601. "x-go-name": "ID"
  14602. },
  14603. "key_id": {
  14604. "type": "string",
  14605. "x-go-name": "KeyID"
  14606. },
  14607. "primary_key_id": {
  14608. "type": "string",
  14609. "x-go-name": "PrimaryKeyID"
  14610. },
  14611. "public_key": {
  14612. "type": "string",
  14613. "x-go-name": "PublicKey"
  14614. },
  14615. "subkeys": {
  14616. "type": "array",
  14617. "items": {
  14618. "$ref": "#/definitions/GPGKey"
  14619. },
  14620. "x-go-name": "SubsKey"
  14621. },
  14622. "verified": {
  14623. "type": "boolean",
  14624. "x-go-name": "Verified"
  14625. }
  14626. },
  14627. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14628. },
  14629. "GPGKeyEmail": {
  14630. "description": "GPGKeyEmail an email attached to a GPGKey",
  14631. "type": "object",
  14632. "properties": {
  14633. "email": {
  14634. "type": "string",
  14635. "x-go-name": "Email"
  14636. },
  14637. "verified": {
  14638. "type": "boolean",
  14639. "x-go-name": "Verified"
  14640. }
  14641. },
  14642. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14643. },
  14644. "GeneralAPISettings": {
  14645. "description": "GeneralAPISettings contains global api settings exposed by it",
  14646. "type": "object",
  14647. "properties": {
  14648. "default_git_trees_per_page": {
  14649. "type": "integer",
  14650. "format": "int64",
  14651. "x-go-name": "DefaultGitTreesPerPage"
  14652. },
  14653. "default_max_blob_size": {
  14654. "type": "integer",
  14655. "format": "int64",
  14656. "x-go-name": "DefaultMaxBlobSize"
  14657. },
  14658. "default_paging_num": {
  14659. "type": "integer",
  14660. "format": "int64",
  14661. "x-go-name": "DefaultPagingNum"
  14662. },
  14663. "max_response_items": {
  14664. "type": "integer",
  14665. "format": "int64",
  14666. "x-go-name": "MaxResponseItems"
  14667. }
  14668. },
  14669. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14670. },
  14671. "GeneralAttachmentSettings": {
  14672. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  14673. "type": "object",
  14674. "properties": {
  14675. "allowed_types": {
  14676. "type": "string",
  14677. "x-go-name": "AllowedTypes"
  14678. },
  14679. "enabled": {
  14680. "type": "boolean",
  14681. "x-go-name": "Enabled"
  14682. },
  14683. "max_files": {
  14684. "type": "integer",
  14685. "format": "int64",
  14686. "x-go-name": "MaxFiles"
  14687. },
  14688. "max_size": {
  14689. "type": "integer",
  14690. "format": "int64",
  14691. "x-go-name": "MaxSize"
  14692. }
  14693. },
  14694. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14695. },
  14696. "GeneralRepoSettings": {
  14697. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  14698. "type": "object",
  14699. "properties": {
  14700. "http_git_disabled": {
  14701. "type": "boolean",
  14702. "x-go-name": "HTTPGitDisabled"
  14703. },
  14704. "lfs_disabled": {
  14705. "type": "boolean",
  14706. "x-go-name": "LFSDisabled"
  14707. },
  14708. "migrations_disabled": {
  14709. "type": "boolean",
  14710. "x-go-name": "MigrationsDisabled"
  14711. },
  14712. "mirrors_disabled": {
  14713. "type": "boolean",
  14714. "x-go-name": "MirrorsDisabled"
  14715. },
  14716. "stars_disabled": {
  14717. "type": "boolean",
  14718. "x-go-name": "StarsDisabled"
  14719. },
  14720. "time_tracking_disabled": {
  14721. "type": "boolean",
  14722. "x-go-name": "TimeTrackingDisabled"
  14723. }
  14724. },
  14725. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14726. },
  14727. "GeneralUISettings": {
  14728. "description": "GeneralUISettings contains global ui settings exposed by API",
  14729. "type": "object",
  14730. "properties": {
  14731. "allowed_reactions": {
  14732. "type": "array",
  14733. "items": {
  14734. "type": "string"
  14735. },
  14736. "x-go-name": "AllowedReactions"
  14737. },
  14738. "custom_emojis": {
  14739. "type": "array",
  14740. "items": {
  14741. "type": "string"
  14742. },
  14743. "x-go-name": "CustomEmojis"
  14744. },
  14745. "default_theme": {
  14746. "type": "string",
  14747. "x-go-name": "DefaultTheme"
  14748. }
  14749. },
  14750. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14751. },
  14752. "GenerateRepoOption": {
  14753. "description": "GenerateRepoOption options when creating repository using a template",
  14754. "type": "object",
  14755. "required": [
  14756. "owner",
  14757. "name"
  14758. ],
  14759. "properties": {
  14760. "avatar": {
  14761. "description": "include avatar of the template repo",
  14762. "type": "boolean",
  14763. "x-go-name": "Avatar"
  14764. },
  14765. "description": {
  14766. "description": "Description of the repository to create",
  14767. "type": "string",
  14768. "x-go-name": "Description"
  14769. },
  14770. "git_content": {
  14771. "description": "include git content of default branch in template repo",
  14772. "type": "boolean",
  14773. "x-go-name": "GitContent"
  14774. },
  14775. "git_hooks": {
  14776. "description": "include git hooks in template repo",
  14777. "type": "boolean",
  14778. "x-go-name": "GitHooks"
  14779. },
  14780. "labels": {
  14781. "description": "include labels in template repo",
  14782. "type": "boolean",
  14783. "x-go-name": "Labels"
  14784. },
  14785. "name": {
  14786. "description": "Name of the repository to create",
  14787. "type": "string",
  14788. "uniqueItems": true,
  14789. "x-go-name": "Name"
  14790. },
  14791. "owner": {
  14792. "description": "The organization or person who will own the new repository",
  14793. "type": "string",
  14794. "x-go-name": "Owner"
  14795. },
  14796. "private": {
  14797. "description": "Whether the repository is private",
  14798. "type": "boolean",
  14799. "x-go-name": "Private"
  14800. },
  14801. "topics": {
  14802. "description": "include topics in template repo",
  14803. "type": "boolean",
  14804. "x-go-name": "Topics"
  14805. },
  14806. "webhooks": {
  14807. "description": "include webhooks in template repo",
  14808. "type": "boolean",
  14809. "x-go-name": "Webhooks"
  14810. }
  14811. },
  14812. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14813. },
  14814. "GitBlobResponse": {
  14815. "description": "GitBlobResponse represents a git blob",
  14816. "type": "object",
  14817. "properties": {
  14818. "content": {
  14819. "type": "string",
  14820. "x-go-name": "Content"
  14821. },
  14822. "encoding": {
  14823. "type": "string",
  14824. "x-go-name": "Encoding"
  14825. },
  14826. "sha": {
  14827. "type": "string",
  14828. "x-go-name": "SHA"
  14829. },
  14830. "size": {
  14831. "type": "integer",
  14832. "format": "int64",
  14833. "x-go-name": "Size"
  14834. },
  14835. "url": {
  14836. "type": "string",
  14837. "x-go-name": "URL"
  14838. }
  14839. },
  14840. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14841. },
  14842. "GitEntry": {
  14843. "description": "GitEntry represents a git tree",
  14844. "type": "object",
  14845. "properties": {
  14846. "mode": {
  14847. "type": "string",
  14848. "x-go-name": "Mode"
  14849. },
  14850. "path": {
  14851. "type": "string",
  14852. "x-go-name": "Path"
  14853. },
  14854. "sha": {
  14855. "type": "string",
  14856. "x-go-name": "SHA"
  14857. },
  14858. "size": {
  14859. "type": "integer",
  14860. "format": "int64",
  14861. "x-go-name": "Size"
  14862. },
  14863. "type": {
  14864. "type": "string",
  14865. "x-go-name": "Type"
  14866. },
  14867. "url": {
  14868. "type": "string",
  14869. "x-go-name": "URL"
  14870. }
  14871. },
  14872. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14873. },
  14874. "GitHook": {
  14875. "description": "GitHook represents a Git repository hook",
  14876. "type": "object",
  14877. "properties": {
  14878. "content": {
  14879. "type": "string",
  14880. "x-go-name": "Content"
  14881. },
  14882. "is_active": {
  14883. "type": "boolean",
  14884. "x-go-name": "IsActive"
  14885. },
  14886. "name": {
  14887. "type": "string",
  14888. "x-go-name": "Name"
  14889. }
  14890. },
  14891. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14892. },
  14893. "GitObject": {
  14894. "type": "object",
  14895. "title": "GitObject represents a Git object.",
  14896. "properties": {
  14897. "sha": {
  14898. "type": "string",
  14899. "x-go-name": "SHA"
  14900. },
  14901. "type": {
  14902. "type": "string",
  14903. "x-go-name": "Type"
  14904. },
  14905. "url": {
  14906. "type": "string",
  14907. "x-go-name": "URL"
  14908. }
  14909. },
  14910. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14911. },
  14912. "GitServiceType": {
  14913. "description": "GitServiceType represents a git service",
  14914. "type": "integer",
  14915. "format": "int64",
  14916. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14917. },
  14918. "GitTreeResponse": {
  14919. "description": "GitTreeResponse returns a git tree",
  14920. "type": "object",
  14921. "properties": {
  14922. "page": {
  14923. "type": "integer",
  14924. "format": "int64",
  14925. "x-go-name": "Page"
  14926. },
  14927. "sha": {
  14928. "type": "string",
  14929. "x-go-name": "SHA"
  14930. },
  14931. "total_count": {
  14932. "type": "integer",
  14933. "format": "int64",
  14934. "x-go-name": "TotalCount"
  14935. },
  14936. "tree": {
  14937. "type": "array",
  14938. "items": {
  14939. "$ref": "#/definitions/GitEntry"
  14940. },
  14941. "x-go-name": "Entries"
  14942. },
  14943. "truncated": {
  14944. "type": "boolean",
  14945. "x-go-name": "Truncated"
  14946. },
  14947. "url": {
  14948. "type": "string",
  14949. "x-go-name": "URL"
  14950. }
  14951. },
  14952. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14953. },
  14954. "Hook": {
  14955. "description": "Hook a hook is a web hook when one repository changed",
  14956. "type": "object",
  14957. "properties": {
  14958. "active": {
  14959. "type": "boolean",
  14960. "x-go-name": "Active"
  14961. },
  14962. "config": {
  14963. "type": "object",
  14964. "additionalProperties": {
  14965. "type": "string"
  14966. },
  14967. "x-go-name": "Config"
  14968. },
  14969. "created_at": {
  14970. "type": "string",
  14971. "format": "date-time",
  14972. "x-go-name": "Created"
  14973. },
  14974. "events": {
  14975. "type": "array",
  14976. "items": {
  14977. "type": "string"
  14978. },
  14979. "x-go-name": "Events"
  14980. },
  14981. "id": {
  14982. "type": "integer",
  14983. "format": "int64",
  14984. "x-go-name": "ID"
  14985. },
  14986. "type": {
  14987. "type": "string",
  14988. "x-go-name": "Type"
  14989. },
  14990. "updated_at": {
  14991. "type": "string",
  14992. "format": "date-time",
  14993. "x-go-name": "Updated"
  14994. }
  14995. },
  14996. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14997. },
  14998. "Identity": {
  14999. "description": "Identity for a person's identity like an author or committer",
  15000. "type": "object",
  15001. "properties": {
  15002. "email": {
  15003. "type": "string",
  15004. "format": "email",
  15005. "x-go-name": "Email"
  15006. },
  15007. "name": {
  15008. "type": "string",
  15009. "x-go-name": "Name"
  15010. }
  15011. },
  15012. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15013. },
  15014. "InternalTracker": {
  15015. "description": "InternalTracker represents settings for internal tracker",
  15016. "type": "object",
  15017. "properties": {
  15018. "allow_only_contributors_to_track_time": {
  15019. "description": "Let only contributors track time (Built-in issue tracker)",
  15020. "type": "boolean",
  15021. "x-go-name": "AllowOnlyContributorsToTrackTime"
  15022. },
  15023. "enable_issue_dependencies": {
  15024. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  15025. "type": "boolean",
  15026. "x-go-name": "EnableIssueDependencies"
  15027. },
  15028. "enable_time_tracker": {
  15029. "description": "Enable time tracking (Built-in issue tracker)",
  15030. "type": "boolean",
  15031. "x-go-name": "EnableTimeTracker"
  15032. }
  15033. },
  15034. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15035. },
  15036. "Issue": {
  15037. "description": "Issue represents an issue in a repository",
  15038. "type": "object",
  15039. "properties": {
  15040. "assignee": {
  15041. "$ref": "#/definitions/User"
  15042. },
  15043. "assignees": {
  15044. "type": "array",
  15045. "items": {
  15046. "$ref": "#/definitions/User"
  15047. },
  15048. "x-go-name": "Assignees"
  15049. },
  15050. "body": {
  15051. "type": "string",
  15052. "x-go-name": "Body"
  15053. },
  15054. "closed_at": {
  15055. "type": "string",
  15056. "format": "date-time",
  15057. "x-go-name": "Closed"
  15058. },
  15059. "comments": {
  15060. "type": "integer",
  15061. "format": "int64",
  15062. "x-go-name": "Comments"
  15063. },
  15064. "created_at": {
  15065. "type": "string",
  15066. "format": "date-time",
  15067. "x-go-name": "Created"
  15068. },
  15069. "due_date": {
  15070. "type": "string",
  15071. "format": "date-time",
  15072. "x-go-name": "Deadline"
  15073. },
  15074. "html_url": {
  15075. "type": "string",
  15076. "x-go-name": "HTMLURL"
  15077. },
  15078. "id": {
  15079. "type": "integer",
  15080. "format": "int64",
  15081. "x-go-name": "ID"
  15082. },
  15083. "is_locked": {
  15084. "type": "boolean",
  15085. "x-go-name": "IsLocked"
  15086. },
  15087. "labels": {
  15088. "type": "array",
  15089. "items": {
  15090. "$ref": "#/definitions/Label"
  15091. },
  15092. "x-go-name": "Labels"
  15093. },
  15094. "milestone": {
  15095. "$ref": "#/definitions/Milestone"
  15096. },
  15097. "number": {
  15098. "type": "integer",
  15099. "format": "int64",
  15100. "x-go-name": "Index"
  15101. },
  15102. "original_author": {
  15103. "type": "string",
  15104. "x-go-name": "OriginalAuthor"
  15105. },
  15106. "original_author_id": {
  15107. "type": "integer",
  15108. "format": "int64",
  15109. "x-go-name": "OriginalAuthorID"
  15110. },
  15111. "pull_request": {
  15112. "$ref": "#/definitions/PullRequestMeta"
  15113. },
  15114. "ref": {
  15115. "type": "string",
  15116. "x-go-name": "Ref"
  15117. },
  15118. "repository": {
  15119. "$ref": "#/definitions/RepositoryMeta"
  15120. },
  15121. "state": {
  15122. "$ref": "#/definitions/StateType"
  15123. },
  15124. "title": {
  15125. "type": "string",
  15126. "x-go-name": "Title"
  15127. },
  15128. "updated_at": {
  15129. "type": "string",
  15130. "format": "date-time",
  15131. "x-go-name": "Updated"
  15132. },
  15133. "url": {
  15134. "type": "string",
  15135. "x-go-name": "URL"
  15136. },
  15137. "user": {
  15138. "$ref": "#/definitions/User"
  15139. }
  15140. },
  15141. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15142. },
  15143. "IssueDeadline": {
  15144. "description": "IssueDeadline represents an issue deadline",
  15145. "type": "object",
  15146. "properties": {
  15147. "due_date": {
  15148. "type": "string",
  15149. "format": "date-time",
  15150. "x-go-name": "Deadline"
  15151. }
  15152. },
  15153. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15154. },
  15155. "IssueLabelsOption": {
  15156. "description": "IssueLabelsOption a collection of labels",
  15157. "type": "object",
  15158. "properties": {
  15159. "labels": {
  15160. "description": "list of label IDs",
  15161. "type": "array",
  15162. "items": {
  15163. "type": "integer",
  15164. "format": "int64"
  15165. },
  15166. "x-go-name": "Labels"
  15167. }
  15168. },
  15169. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15170. },
  15171. "IssueTemplate": {
  15172. "description": "IssueTemplate represents an issue template for a repository",
  15173. "type": "object",
  15174. "properties": {
  15175. "about": {
  15176. "type": "string",
  15177. "x-go-name": "About"
  15178. },
  15179. "content": {
  15180. "type": "string",
  15181. "x-go-name": "Content"
  15182. },
  15183. "file_name": {
  15184. "type": "string",
  15185. "x-go-name": "FileName"
  15186. },
  15187. "labels": {
  15188. "type": "array",
  15189. "items": {
  15190. "type": "string"
  15191. },
  15192. "x-go-name": "Labels"
  15193. },
  15194. "name": {
  15195. "type": "string",
  15196. "x-go-name": "Name"
  15197. },
  15198. "title": {
  15199. "type": "string",
  15200. "x-go-name": "Title"
  15201. }
  15202. },
  15203. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15204. },
  15205. "Label": {
  15206. "description": "Label a label to an issue or a pr",
  15207. "type": "object",
  15208. "properties": {
  15209. "color": {
  15210. "type": "string",
  15211. "x-go-name": "Color",
  15212. "example": "00aabb"
  15213. },
  15214. "description": {
  15215. "type": "string",
  15216. "x-go-name": "Description"
  15217. },
  15218. "id": {
  15219. "type": "integer",
  15220. "format": "int64",
  15221. "x-go-name": "ID"
  15222. },
  15223. "name": {
  15224. "type": "string",
  15225. "x-go-name": "Name"
  15226. },
  15227. "url": {
  15228. "type": "string",
  15229. "x-go-name": "URL"
  15230. }
  15231. },
  15232. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15233. },
  15234. "MarkdownOption": {
  15235. "description": "MarkdownOption markdown options",
  15236. "type": "object",
  15237. "properties": {
  15238. "Context": {
  15239. "description": "Context to render\n\nin: body",
  15240. "type": "string"
  15241. },
  15242. "Mode": {
  15243. "description": "Mode to render\n\nin: body",
  15244. "type": "string"
  15245. },
  15246. "Text": {
  15247. "description": "Text markdown to render\n\nin: body",
  15248. "type": "string"
  15249. },
  15250. "Wiki": {
  15251. "description": "Is it a wiki page ?\n\nin: body",
  15252. "type": "boolean"
  15253. }
  15254. },
  15255. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15256. },
  15257. "MergePullRequestOption": {
  15258. "description": "MergePullRequestForm form for merging Pull Request",
  15259. "type": "object",
  15260. "required": [
  15261. "Do"
  15262. ],
  15263. "properties": {
  15264. "Do": {
  15265. "type": "string",
  15266. "enum": [
  15267. "merge",
  15268. "rebase",
  15269. "rebase-merge",
  15270. "squash",
  15271. "manually-merged"
  15272. ]
  15273. },
  15274. "MergeCommitID": {
  15275. "type": "string"
  15276. },
  15277. "MergeMessageField": {
  15278. "type": "string"
  15279. },
  15280. "MergeTitleField": {
  15281. "type": "string"
  15282. },
  15283. "delete_branch_after_merge": {
  15284. "type": "boolean",
  15285. "x-go-name": "DeleteBranchAfterMerge"
  15286. },
  15287. "force_merge": {
  15288. "type": "boolean",
  15289. "x-go-name": "ForceMerge"
  15290. }
  15291. },
  15292. "x-go-name": "MergePullRequestForm",
  15293. "x-go-package": "code.gitea.io/gitea/services/forms"
  15294. },
  15295. "MigrateRepoForm": {
  15296. "description": "MigrateRepoForm form for migrating repository\nthis is used to interact with web ui",
  15297. "type": "object",
  15298. "required": [
  15299. "clone_addr",
  15300. "uid",
  15301. "repo_name"
  15302. ],
  15303. "properties": {
  15304. "auth_password": {
  15305. "type": "string",
  15306. "x-go-name": "AuthPassword"
  15307. },
  15308. "auth_token": {
  15309. "type": "string",
  15310. "x-go-name": "AuthToken"
  15311. },
  15312. "auth_username": {
  15313. "type": "string",
  15314. "x-go-name": "AuthUsername"
  15315. },
  15316. "clone_addr": {
  15317. "type": "string",
  15318. "x-go-name": "CloneAddr"
  15319. },
  15320. "description": {
  15321. "type": "string",
  15322. "x-go-name": "Description"
  15323. },
  15324. "issues": {
  15325. "type": "boolean",
  15326. "x-go-name": "Issues"
  15327. },
  15328. "labels": {
  15329. "type": "boolean",
  15330. "x-go-name": "Labels"
  15331. },
  15332. "lfs": {
  15333. "type": "boolean",
  15334. "x-go-name": "LFS"
  15335. },
  15336. "lfs_endpoint": {
  15337. "type": "string",
  15338. "x-go-name": "LFSEndpoint"
  15339. },
  15340. "milestones": {
  15341. "type": "boolean",
  15342. "x-go-name": "Milestones"
  15343. },
  15344. "mirror": {
  15345. "type": "boolean",
  15346. "x-go-name": "Mirror"
  15347. },
  15348. "mirror_interval": {
  15349. "type": "string",
  15350. "x-go-name": "MirrorInterval"
  15351. },
  15352. "private": {
  15353. "type": "boolean",
  15354. "x-go-name": "Private"
  15355. },
  15356. "pull_requests": {
  15357. "type": "boolean",
  15358. "x-go-name": "PullRequests"
  15359. },
  15360. "releases": {
  15361. "type": "boolean",
  15362. "x-go-name": "Releases"
  15363. },
  15364. "repo_name": {
  15365. "type": "string",
  15366. "x-go-name": "RepoName"
  15367. },
  15368. "service": {
  15369. "$ref": "#/definitions/GitServiceType"
  15370. },
  15371. "uid": {
  15372. "type": "integer",
  15373. "format": "int64",
  15374. "x-go-name": "UID"
  15375. },
  15376. "wiki": {
  15377. "type": "boolean",
  15378. "x-go-name": "Wiki"
  15379. }
  15380. },
  15381. "x-go-package": "code.gitea.io/gitea/services/forms"
  15382. },
  15383. "MigrateRepoOptions": {
  15384. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  15385. "type": "object",
  15386. "required": [
  15387. "clone_addr",
  15388. "repo_name"
  15389. ],
  15390. "properties": {
  15391. "auth_password": {
  15392. "type": "string",
  15393. "x-go-name": "AuthPassword"
  15394. },
  15395. "auth_token": {
  15396. "type": "string",
  15397. "x-go-name": "AuthToken"
  15398. },
  15399. "auth_username": {
  15400. "type": "string",
  15401. "x-go-name": "AuthUsername"
  15402. },
  15403. "clone_addr": {
  15404. "type": "string",
  15405. "x-go-name": "CloneAddr"
  15406. },
  15407. "description": {
  15408. "type": "string",
  15409. "x-go-name": "Description"
  15410. },
  15411. "issues": {
  15412. "type": "boolean",
  15413. "x-go-name": "Issues"
  15414. },
  15415. "labels": {
  15416. "type": "boolean",
  15417. "x-go-name": "Labels"
  15418. },
  15419. "lfs": {
  15420. "type": "boolean",
  15421. "x-go-name": "LFS"
  15422. },
  15423. "lfs_endpoint": {
  15424. "type": "string",
  15425. "x-go-name": "LFSEndpoint"
  15426. },
  15427. "milestones": {
  15428. "type": "boolean",
  15429. "x-go-name": "Milestones"
  15430. },
  15431. "mirror": {
  15432. "type": "boolean",
  15433. "x-go-name": "Mirror"
  15434. },
  15435. "mirror_interval": {
  15436. "type": "string",
  15437. "x-go-name": "MirrorInterval"
  15438. },
  15439. "private": {
  15440. "type": "boolean",
  15441. "x-go-name": "Private"
  15442. },
  15443. "pull_requests": {
  15444. "type": "boolean",
  15445. "x-go-name": "PullRequests"
  15446. },
  15447. "releases": {
  15448. "type": "boolean",
  15449. "x-go-name": "Releases"
  15450. },
  15451. "repo_name": {
  15452. "type": "string",
  15453. "x-go-name": "RepoName"
  15454. },
  15455. "repo_owner": {
  15456. "description": "Name of User or Organisation who will own Repo after migration",
  15457. "type": "string",
  15458. "x-go-name": "RepoOwner"
  15459. },
  15460. "service": {
  15461. "type": "string",
  15462. "enum": [
  15463. "git",
  15464. "github",
  15465. "gitea",
  15466. "gitlab"
  15467. ],
  15468. "x-go-name": "Service"
  15469. },
  15470. "uid": {
  15471. "description": "deprecated (only for backwards compatibility)",
  15472. "type": "integer",
  15473. "format": "int64",
  15474. "x-go-name": "RepoOwnerID"
  15475. },
  15476. "wiki": {
  15477. "type": "boolean",
  15478. "x-go-name": "Wiki"
  15479. }
  15480. },
  15481. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15482. },
  15483. "Milestone": {
  15484. "description": "Milestone milestone is a collection of issues on one repository",
  15485. "type": "object",
  15486. "properties": {
  15487. "closed_at": {
  15488. "type": "string",
  15489. "format": "date-time",
  15490. "x-go-name": "Closed"
  15491. },
  15492. "closed_issues": {
  15493. "type": "integer",
  15494. "format": "int64",
  15495. "x-go-name": "ClosedIssues"
  15496. },
  15497. "created_at": {
  15498. "type": "string",
  15499. "format": "date-time",
  15500. "x-go-name": "Created"
  15501. },
  15502. "description": {
  15503. "type": "string",
  15504. "x-go-name": "Description"
  15505. },
  15506. "due_on": {
  15507. "type": "string",
  15508. "format": "date-time",
  15509. "x-go-name": "Deadline"
  15510. },
  15511. "id": {
  15512. "type": "integer",
  15513. "format": "int64",
  15514. "x-go-name": "ID"
  15515. },
  15516. "open_issues": {
  15517. "type": "integer",
  15518. "format": "int64",
  15519. "x-go-name": "OpenIssues"
  15520. },
  15521. "state": {
  15522. "$ref": "#/definitions/StateType"
  15523. },
  15524. "title": {
  15525. "type": "string",
  15526. "x-go-name": "Title"
  15527. },
  15528. "updated_at": {
  15529. "type": "string",
  15530. "format": "date-time",
  15531. "x-go-name": "Updated"
  15532. }
  15533. },
  15534. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15535. },
  15536. "Note": {
  15537. "description": "Note contains information related to a git note",
  15538. "type": "object",
  15539. "properties": {
  15540. "commit": {
  15541. "$ref": "#/definitions/Commit"
  15542. },
  15543. "message": {
  15544. "type": "string",
  15545. "x-go-name": "Message"
  15546. }
  15547. },
  15548. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15549. },
  15550. "NotificationCount": {
  15551. "description": "NotificationCount number of unread notifications",
  15552. "type": "object",
  15553. "properties": {
  15554. "new": {
  15555. "type": "integer",
  15556. "format": "int64",
  15557. "x-go-name": "New"
  15558. }
  15559. },
  15560. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15561. },
  15562. "NotificationSubject": {
  15563. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  15564. "type": "object",
  15565. "properties": {
  15566. "latest_comment_url": {
  15567. "type": "string",
  15568. "x-go-name": "LatestCommentURL"
  15569. },
  15570. "state": {
  15571. "$ref": "#/definitions/StateType"
  15572. },
  15573. "title": {
  15574. "type": "string",
  15575. "x-go-name": "Title"
  15576. },
  15577. "type": {
  15578. "$ref": "#/definitions/NotifySubjectType"
  15579. },
  15580. "url": {
  15581. "type": "string",
  15582. "x-go-name": "URL"
  15583. }
  15584. },
  15585. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15586. },
  15587. "NotificationThread": {
  15588. "description": "NotificationThread expose Notification on API",
  15589. "type": "object",
  15590. "properties": {
  15591. "id": {
  15592. "type": "integer",
  15593. "format": "int64",
  15594. "x-go-name": "ID"
  15595. },
  15596. "pinned": {
  15597. "type": "boolean",
  15598. "x-go-name": "Pinned"
  15599. },
  15600. "repository": {
  15601. "$ref": "#/definitions/Repository"
  15602. },
  15603. "subject": {
  15604. "$ref": "#/definitions/NotificationSubject"
  15605. },
  15606. "unread": {
  15607. "type": "boolean",
  15608. "x-go-name": "Unread"
  15609. },
  15610. "updated_at": {
  15611. "type": "string",
  15612. "format": "date-time",
  15613. "x-go-name": "UpdatedAt"
  15614. },
  15615. "url": {
  15616. "type": "string",
  15617. "x-go-name": "URL"
  15618. }
  15619. },
  15620. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15621. },
  15622. "NotifySubjectType": {
  15623. "description": "NotifySubjectType represent type of notification subject",
  15624. "type": "string",
  15625. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15626. },
  15627. "OAuth2Application": {
  15628. "type": "object",
  15629. "title": "OAuth2Application represents an OAuth2 application.",
  15630. "properties": {
  15631. "client_id": {
  15632. "type": "string",
  15633. "x-go-name": "ClientID"
  15634. },
  15635. "client_secret": {
  15636. "type": "string",
  15637. "x-go-name": "ClientSecret"
  15638. },
  15639. "created": {
  15640. "type": "string",
  15641. "format": "date-time",
  15642. "x-go-name": "Created"
  15643. },
  15644. "id": {
  15645. "type": "integer",
  15646. "format": "int64",
  15647. "x-go-name": "ID"
  15648. },
  15649. "name": {
  15650. "type": "string",
  15651. "x-go-name": "Name"
  15652. },
  15653. "redirect_uris": {
  15654. "type": "array",
  15655. "items": {
  15656. "type": "string"
  15657. },
  15658. "x-go-name": "RedirectURIs"
  15659. }
  15660. },
  15661. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15662. },
  15663. "Organization": {
  15664. "description": "Organization represents an organization",
  15665. "type": "object",
  15666. "properties": {
  15667. "avatar_url": {
  15668. "type": "string",
  15669. "x-go-name": "AvatarURL"
  15670. },
  15671. "description": {
  15672. "type": "string",
  15673. "x-go-name": "Description"
  15674. },
  15675. "full_name": {
  15676. "type": "string",
  15677. "x-go-name": "FullName"
  15678. },
  15679. "id": {
  15680. "type": "integer",
  15681. "format": "int64",
  15682. "x-go-name": "ID"
  15683. },
  15684. "location": {
  15685. "type": "string",
  15686. "x-go-name": "Location"
  15687. },
  15688. "repo_admin_change_team_access": {
  15689. "type": "boolean",
  15690. "x-go-name": "RepoAdminChangeTeamAccess"
  15691. },
  15692. "username": {
  15693. "type": "string",
  15694. "x-go-name": "UserName"
  15695. },
  15696. "visibility": {
  15697. "type": "string",
  15698. "x-go-name": "Visibility"
  15699. },
  15700. "website": {
  15701. "type": "string",
  15702. "x-go-name": "Website"
  15703. }
  15704. },
  15705. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15706. },
  15707. "PRBranchInfo": {
  15708. "description": "PRBranchInfo information about a branch",
  15709. "type": "object",
  15710. "properties": {
  15711. "label": {
  15712. "type": "string",
  15713. "x-go-name": "Name"
  15714. },
  15715. "ref": {
  15716. "type": "string",
  15717. "x-go-name": "Ref"
  15718. },
  15719. "repo": {
  15720. "$ref": "#/definitions/Repository"
  15721. },
  15722. "repo_id": {
  15723. "type": "integer",
  15724. "format": "int64",
  15725. "x-go-name": "RepoID"
  15726. },
  15727. "sha": {
  15728. "type": "string",
  15729. "x-go-name": "Sha"
  15730. }
  15731. },
  15732. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15733. },
  15734. "PayloadCommit": {
  15735. "description": "PayloadCommit represents a commit",
  15736. "type": "object",
  15737. "properties": {
  15738. "added": {
  15739. "type": "array",
  15740. "items": {
  15741. "type": "string"
  15742. },
  15743. "x-go-name": "Added"
  15744. },
  15745. "author": {
  15746. "$ref": "#/definitions/PayloadUser"
  15747. },
  15748. "committer": {
  15749. "$ref": "#/definitions/PayloadUser"
  15750. },
  15751. "id": {
  15752. "description": "sha1 hash of the commit",
  15753. "type": "string",
  15754. "x-go-name": "ID"
  15755. },
  15756. "message": {
  15757. "type": "string",
  15758. "x-go-name": "Message"
  15759. },
  15760. "modified": {
  15761. "type": "array",
  15762. "items": {
  15763. "type": "string"
  15764. },
  15765. "x-go-name": "Modified"
  15766. },
  15767. "removed": {
  15768. "type": "array",
  15769. "items": {
  15770. "type": "string"
  15771. },
  15772. "x-go-name": "Removed"
  15773. },
  15774. "timestamp": {
  15775. "type": "string",
  15776. "format": "date-time",
  15777. "x-go-name": "Timestamp"
  15778. },
  15779. "url": {
  15780. "type": "string",
  15781. "x-go-name": "URL"
  15782. },
  15783. "verification": {
  15784. "$ref": "#/definitions/PayloadCommitVerification"
  15785. }
  15786. },
  15787. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15788. },
  15789. "PayloadCommitVerification": {
  15790. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  15791. "type": "object",
  15792. "properties": {
  15793. "payload": {
  15794. "type": "string",
  15795. "x-go-name": "Payload"
  15796. },
  15797. "reason": {
  15798. "type": "string",
  15799. "x-go-name": "Reason"
  15800. },
  15801. "signature": {
  15802. "type": "string",
  15803. "x-go-name": "Signature"
  15804. },
  15805. "signer": {
  15806. "$ref": "#/definitions/PayloadUser"
  15807. },
  15808. "verified": {
  15809. "type": "boolean",
  15810. "x-go-name": "Verified"
  15811. }
  15812. },
  15813. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15814. },
  15815. "PayloadUser": {
  15816. "description": "PayloadUser represents the author or committer of a commit",
  15817. "type": "object",
  15818. "properties": {
  15819. "email": {
  15820. "type": "string",
  15821. "format": "email",
  15822. "x-go-name": "Email"
  15823. },
  15824. "name": {
  15825. "description": "Full name of the commit author",
  15826. "type": "string",
  15827. "x-go-name": "Name"
  15828. },
  15829. "username": {
  15830. "type": "string",
  15831. "x-go-name": "UserName"
  15832. }
  15833. },
  15834. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15835. },
  15836. "Permission": {
  15837. "description": "Permission represents a set of permissions",
  15838. "type": "object",
  15839. "properties": {
  15840. "admin": {
  15841. "type": "boolean",
  15842. "x-go-name": "Admin"
  15843. },
  15844. "pull": {
  15845. "type": "boolean",
  15846. "x-go-name": "Pull"
  15847. },
  15848. "push": {
  15849. "type": "boolean",
  15850. "x-go-name": "Push"
  15851. }
  15852. },
  15853. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15854. },
  15855. "PublicKey": {
  15856. "description": "PublicKey publickey is a user key to push code to repository",
  15857. "type": "object",
  15858. "properties": {
  15859. "created_at": {
  15860. "type": "string",
  15861. "format": "date-time",
  15862. "x-go-name": "Created"
  15863. },
  15864. "fingerprint": {
  15865. "type": "string",
  15866. "x-go-name": "Fingerprint"
  15867. },
  15868. "id": {
  15869. "type": "integer",
  15870. "format": "int64",
  15871. "x-go-name": "ID"
  15872. },
  15873. "key": {
  15874. "type": "string",
  15875. "x-go-name": "Key"
  15876. },
  15877. "key_type": {
  15878. "type": "string",
  15879. "x-go-name": "KeyType"
  15880. },
  15881. "read_only": {
  15882. "type": "boolean",
  15883. "x-go-name": "ReadOnly"
  15884. },
  15885. "title": {
  15886. "type": "string",
  15887. "x-go-name": "Title"
  15888. },
  15889. "url": {
  15890. "type": "string",
  15891. "x-go-name": "URL"
  15892. },
  15893. "user": {
  15894. "$ref": "#/definitions/User"
  15895. }
  15896. },
  15897. "x-go-package": "code.gitea.io/gitea/modules/structs"
  15898. },
  15899. "PullRequest": {
  15900. "description": "PullRequest represents a pull request",
  15901. "type": "object",
  15902. "properties": {
  15903. "assignee": {
  15904. "$ref": "#/definitions/User"
  15905. },
  15906. "assignees": {
  15907. "type": "array",
  15908. "items": {
  15909. "$ref": "#/definitions/User"
  15910. },
  15911. "x-go-name": "Assignees"
  15912. },
  15913. "base": {
  15914. "$ref": "#/definitions/PRBranchInfo"
  15915. },
  15916. "body": {
  15917. "type": "string",
  15918. "x-go-name": "Body"
  15919. },
  15920. "closed_at": {
  15921. "type": "string",
  15922. "format": "date-time",
  15923. "x-go-name": "Closed"
  15924. },
  15925. "comments": {
  15926. "type": "integer",
  15927. "format": "int64",
  15928. "x-go-name": "Comments"
  15929. },
  15930. "created_at": {
  15931. "type": "string",
  15932. "format": "date-time",
  15933. "x-go-name": "Created"
  15934. },
  15935. "diff_url": {
  15936. "type": "string",
  15937. "x-go-name": "DiffURL"
  15938. },
  15939. "due_date": {
  15940. "type": "string",
  15941. "format": "date-time",
  15942. "x-go-name": "Deadline"
  15943. },
  15944. "head": {
  15945. "$ref": "#/definitions/PRBranchInfo"
  15946. },
  15947. "html_url": {
  15948. "type": "string",
  15949. "x-go-name": "HTMLURL"
  15950. },
  15951. "id": {
  15952. "type": "integer",
  15953. "format": "int64",
  15954. "x-go-name": "ID"
  15955. },
  15956. "is_locked": {
  15957. "type": "boolean",
  15958. "x-go-name": "IsLocked"
  15959. },
  15960. "labels": {
  15961. "type": "array",
  15962. "items": {
  15963. "$ref": "#/definitions/Label"
  15964. },
  15965. "x-go-name": "Labels"
  15966. },
  15967. "merge_base": {
  15968. "type": "string",
  15969. "x-go-name": "MergeBase"
  15970. },
  15971. "merge_commit_sha": {
  15972. "type": "string",
  15973. "x-go-name": "MergedCommitID"
  15974. },
  15975. "mergeable": {
  15976. "type": "boolean",
  15977. "x-go-name": "Mergeable"
  15978. },
  15979. "merged": {
  15980. "type": "boolean",
  15981. "x-go-name": "HasMerged"
  15982. },
  15983. "merged_at": {
  15984. "type": "string",
  15985. "format": "date-time",
  15986. "x-go-name": "Merged"
  15987. },
  15988. "merged_by": {
  15989. "$ref": "#/definitions/User"
  15990. },
  15991. "milestone": {
  15992. "$ref": "#/definitions/Milestone"
  15993. },
  15994. "number": {
  15995. "type": "integer",
  15996. "format": "int64",
  15997. "x-go-name": "Index"
  15998. },
  15999. "patch_url": {
  16000. "type": "string",
  16001. "x-go-name": "PatchURL"
  16002. },
  16003. "state": {
  16004. "$ref": "#/definitions/StateType"
  16005. },
  16006. "title": {
  16007. "type": "string",
  16008. "x-go-name": "Title"
  16009. },
  16010. "updated_at": {
  16011. "type": "string",
  16012. "format": "date-time",
  16013. "x-go-name": "Updated"
  16014. },
  16015. "url": {
  16016. "type": "string",
  16017. "x-go-name": "URL"
  16018. },
  16019. "user": {
  16020. "$ref": "#/definitions/User"
  16021. }
  16022. },
  16023. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16024. },
  16025. "PullRequestMeta": {
  16026. "description": "PullRequestMeta PR info if an issue is a PR",
  16027. "type": "object",
  16028. "properties": {
  16029. "merged": {
  16030. "type": "boolean",
  16031. "x-go-name": "HasMerged"
  16032. },
  16033. "merged_at": {
  16034. "type": "string",
  16035. "format": "date-time",
  16036. "x-go-name": "Merged"
  16037. }
  16038. },
  16039. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16040. },
  16041. "PullReview": {
  16042. "description": "PullReview represents a pull request review",
  16043. "type": "object",
  16044. "properties": {
  16045. "body": {
  16046. "type": "string",
  16047. "x-go-name": "Body"
  16048. },
  16049. "comments_count": {
  16050. "type": "integer",
  16051. "format": "int64",
  16052. "x-go-name": "CodeCommentsCount"
  16053. },
  16054. "commit_id": {
  16055. "type": "string",
  16056. "x-go-name": "CommitID"
  16057. },
  16058. "dismissed": {
  16059. "type": "boolean",
  16060. "x-go-name": "Dismissed"
  16061. },
  16062. "html_url": {
  16063. "type": "string",
  16064. "x-go-name": "HTMLURL"
  16065. },
  16066. "id": {
  16067. "type": "integer",
  16068. "format": "int64",
  16069. "x-go-name": "ID"
  16070. },
  16071. "official": {
  16072. "type": "boolean",
  16073. "x-go-name": "Official"
  16074. },
  16075. "pull_request_url": {
  16076. "type": "string",
  16077. "x-go-name": "HTMLPullURL"
  16078. },
  16079. "stale": {
  16080. "type": "boolean",
  16081. "x-go-name": "Stale"
  16082. },
  16083. "state": {
  16084. "$ref": "#/definitions/ReviewStateType"
  16085. },
  16086. "submitted_at": {
  16087. "type": "string",
  16088. "format": "date-time",
  16089. "x-go-name": "Submitted"
  16090. },
  16091. "team": {
  16092. "$ref": "#/definitions/Team"
  16093. },
  16094. "user": {
  16095. "$ref": "#/definitions/User"
  16096. }
  16097. },
  16098. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16099. },
  16100. "PullReviewComment": {
  16101. "description": "PullReviewComment represents a comment on a pull request review",
  16102. "type": "object",
  16103. "properties": {
  16104. "body": {
  16105. "type": "string",
  16106. "x-go-name": "Body"
  16107. },
  16108. "commit_id": {
  16109. "type": "string",
  16110. "x-go-name": "CommitID"
  16111. },
  16112. "created_at": {
  16113. "type": "string",
  16114. "format": "date-time",
  16115. "x-go-name": "Created"
  16116. },
  16117. "diff_hunk": {
  16118. "type": "string",
  16119. "x-go-name": "DiffHunk"
  16120. },
  16121. "html_url": {
  16122. "type": "string",
  16123. "x-go-name": "HTMLURL"
  16124. },
  16125. "id": {
  16126. "type": "integer",
  16127. "format": "int64",
  16128. "x-go-name": "ID"
  16129. },
  16130. "original_commit_id": {
  16131. "type": "string",
  16132. "x-go-name": "OrigCommitID"
  16133. },
  16134. "original_position": {
  16135. "type": "integer",
  16136. "format": "uint64",
  16137. "x-go-name": "OldLineNum"
  16138. },
  16139. "path": {
  16140. "type": "string",
  16141. "x-go-name": "Path"
  16142. },
  16143. "position": {
  16144. "type": "integer",
  16145. "format": "uint64",
  16146. "x-go-name": "LineNum"
  16147. },
  16148. "pull_request_review_id": {
  16149. "type": "integer",
  16150. "format": "int64",
  16151. "x-go-name": "ReviewID"
  16152. },
  16153. "pull_request_url": {
  16154. "type": "string",
  16155. "x-go-name": "HTMLPullURL"
  16156. },
  16157. "resolver": {
  16158. "$ref": "#/definitions/User"
  16159. },
  16160. "updated_at": {
  16161. "type": "string",
  16162. "format": "date-time",
  16163. "x-go-name": "Updated"
  16164. },
  16165. "user": {
  16166. "$ref": "#/definitions/User"
  16167. }
  16168. },
  16169. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16170. },
  16171. "PullReviewRequestOptions": {
  16172. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  16173. "type": "object",
  16174. "properties": {
  16175. "reviewers": {
  16176. "type": "array",
  16177. "items": {
  16178. "type": "string"
  16179. },
  16180. "x-go-name": "Reviewers"
  16181. },
  16182. "team_reviewers": {
  16183. "type": "array",
  16184. "items": {
  16185. "type": "string"
  16186. },
  16187. "x-go-name": "TeamReviewers"
  16188. }
  16189. },
  16190. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16191. },
  16192. "Reaction": {
  16193. "description": "Reaction contain one reaction",
  16194. "type": "object",
  16195. "properties": {
  16196. "content": {
  16197. "type": "string",
  16198. "x-go-name": "Reaction"
  16199. },
  16200. "created_at": {
  16201. "type": "string",
  16202. "format": "date-time",
  16203. "x-go-name": "Created"
  16204. },
  16205. "user": {
  16206. "$ref": "#/definitions/User"
  16207. }
  16208. },
  16209. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16210. },
  16211. "Reference": {
  16212. "type": "object",
  16213. "title": "Reference represents a Git reference.",
  16214. "properties": {
  16215. "object": {
  16216. "$ref": "#/definitions/GitObject"
  16217. },
  16218. "ref": {
  16219. "type": "string",
  16220. "x-go-name": "Ref"
  16221. },
  16222. "url": {
  16223. "type": "string",
  16224. "x-go-name": "URL"
  16225. }
  16226. },
  16227. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16228. },
  16229. "Release": {
  16230. "description": "Release represents a repository release",
  16231. "type": "object",
  16232. "properties": {
  16233. "assets": {
  16234. "type": "array",
  16235. "items": {
  16236. "$ref": "#/definitions/Attachment"
  16237. },
  16238. "x-go-name": "Attachments"
  16239. },
  16240. "author": {
  16241. "$ref": "#/definitions/User"
  16242. },
  16243. "body": {
  16244. "type": "string",
  16245. "x-go-name": "Note"
  16246. },
  16247. "created_at": {
  16248. "type": "string",
  16249. "format": "date-time",
  16250. "x-go-name": "CreatedAt"
  16251. },
  16252. "draft": {
  16253. "type": "boolean",
  16254. "x-go-name": "IsDraft"
  16255. },
  16256. "html_url": {
  16257. "type": "string",
  16258. "x-go-name": "HTMLURL"
  16259. },
  16260. "id": {
  16261. "type": "integer",
  16262. "format": "int64",
  16263. "x-go-name": "ID"
  16264. },
  16265. "name": {
  16266. "type": "string",
  16267. "x-go-name": "Title"
  16268. },
  16269. "prerelease": {
  16270. "type": "boolean",
  16271. "x-go-name": "IsPrerelease"
  16272. },
  16273. "published_at": {
  16274. "type": "string",
  16275. "format": "date-time",
  16276. "x-go-name": "PublishedAt"
  16277. },
  16278. "tag_name": {
  16279. "type": "string",
  16280. "x-go-name": "TagName"
  16281. },
  16282. "tarball_url": {
  16283. "type": "string",
  16284. "x-go-name": "TarURL"
  16285. },
  16286. "target_commitish": {
  16287. "type": "string",
  16288. "x-go-name": "Target"
  16289. },
  16290. "url": {
  16291. "type": "string",
  16292. "x-go-name": "URL"
  16293. },
  16294. "zipball_url": {
  16295. "type": "string",
  16296. "x-go-name": "ZipURL"
  16297. }
  16298. },
  16299. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16300. },
  16301. "RepoCommit": {
  16302. "type": "object",
  16303. "title": "RepoCommit contains information of a commit in the context of a repository.",
  16304. "properties": {
  16305. "author": {
  16306. "$ref": "#/definitions/CommitUser"
  16307. },
  16308. "committer": {
  16309. "$ref": "#/definitions/CommitUser"
  16310. },
  16311. "message": {
  16312. "type": "string",
  16313. "x-go-name": "Message"
  16314. },
  16315. "tree": {
  16316. "$ref": "#/definitions/CommitMeta"
  16317. },
  16318. "url": {
  16319. "type": "string",
  16320. "x-go-name": "URL"
  16321. }
  16322. },
  16323. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16324. },
  16325. "RepoTopicOptions": {
  16326. "description": "RepoTopicOptions a collection of repo topic names",
  16327. "type": "object",
  16328. "properties": {
  16329. "topics": {
  16330. "description": "list of topic names",
  16331. "type": "array",
  16332. "items": {
  16333. "type": "string"
  16334. },
  16335. "x-go-name": "Topics"
  16336. }
  16337. },
  16338. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16339. },
  16340. "Repository": {
  16341. "description": "Repository represents a repository",
  16342. "type": "object",
  16343. "properties": {
  16344. "allow_merge_commits": {
  16345. "type": "boolean",
  16346. "x-go-name": "AllowMerge"
  16347. },
  16348. "allow_rebase": {
  16349. "type": "boolean",
  16350. "x-go-name": "AllowRebase"
  16351. },
  16352. "allow_rebase_explicit": {
  16353. "type": "boolean",
  16354. "x-go-name": "AllowRebaseMerge"
  16355. },
  16356. "allow_squash_merge": {
  16357. "type": "boolean",
  16358. "x-go-name": "AllowSquash"
  16359. },
  16360. "archived": {
  16361. "type": "boolean",
  16362. "x-go-name": "Archived"
  16363. },
  16364. "avatar_url": {
  16365. "type": "string",
  16366. "x-go-name": "AvatarURL"
  16367. },
  16368. "clone_url": {
  16369. "type": "string",
  16370. "x-go-name": "CloneURL"
  16371. },
  16372. "created_at": {
  16373. "type": "string",
  16374. "format": "date-time",
  16375. "x-go-name": "Created"
  16376. },
  16377. "default_branch": {
  16378. "type": "string",
  16379. "x-go-name": "DefaultBranch"
  16380. },
  16381. "default_merge_style": {
  16382. "type": "string",
  16383. "x-go-name": "DefaultMergeStyle"
  16384. },
  16385. "description": {
  16386. "type": "string",
  16387. "x-go-name": "Description"
  16388. },
  16389. "empty": {
  16390. "type": "boolean",
  16391. "x-go-name": "Empty"
  16392. },
  16393. "external_tracker": {
  16394. "$ref": "#/definitions/ExternalTracker"
  16395. },
  16396. "external_wiki": {
  16397. "$ref": "#/definitions/ExternalWiki"
  16398. },
  16399. "fork": {
  16400. "type": "boolean",
  16401. "x-go-name": "Fork"
  16402. },
  16403. "forks_count": {
  16404. "type": "integer",
  16405. "format": "int64",
  16406. "x-go-name": "Forks"
  16407. },
  16408. "full_name": {
  16409. "type": "string",
  16410. "x-go-name": "FullName"
  16411. },
  16412. "has_issues": {
  16413. "type": "boolean",
  16414. "x-go-name": "HasIssues"
  16415. },
  16416. "has_projects": {
  16417. "type": "boolean",
  16418. "x-go-name": "HasProjects"
  16419. },
  16420. "has_pull_requests": {
  16421. "type": "boolean",
  16422. "x-go-name": "HasPullRequests"
  16423. },
  16424. "has_wiki": {
  16425. "type": "boolean",
  16426. "x-go-name": "HasWiki"
  16427. },
  16428. "html_url": {
  16429. "type": "string",
  16430. "x-go-name": "HTMLURL"
  16431. },
  16432. "id": {
  16433. "type": "integer",
  16434. "format": "int64",
  16435. "x-go-name": "ID"
  16436. },
  16437. "ignore_whitespace_conflicts": {
  16438. "type": "boolean",
  16439. "x-go-name": "IgnoreWhitespaceConflicts"
  16440. },
  16441. "internal": {
  16442. "type": "boolean",
  16443. "x-go-name": "Internal"
  16444. },
  16445. "internal_tracker": {
  16446. "$ref": "#/definitions/InternalTracker"
  16447. },
  16448. "mirror": {
  16449. "type": "boolean",
  16450. "x-go-name": "Mirror"
  16451. },
  16452. "mirror_interval": {
  16453. "type": "string",
  16454. "x-go-name": "MirrorInterval"
  16455. },
  16456. "name": {
  16457. "type": "string",
  16458. "x-go-name": "Name"
  16459. },
  16460. "open_issues_count": {
  16461. "type": "integer",
  16462. "format": "int64",
  16463. "x-go-name": "OpenIssues"
  16464. },
  16465. "open_pr_counter": {
  16466. "type": "integer",
  16467. "format": "int64",
  16468. "x-go-name": "OpenPulls"
  16469. },
  16470. "original_url": {
  16471. "type": "string",
  16472. "x-go-name": "OriginalURL"
  16473. },
  16474. "owner": {
  16475. "$ref": "#/definitions/User"
  16476. },
  16477. "parent": {
  16478. "$ref": "#/definitions/Repository"
  16479. },
  16480. "permissions": {
  16481. "$ref": "#/definitions/Permission"
  16482. },
  16483. "private": {
  16484. "type": "boolean",
  16485. "x-go-name": "Private"
  16486. },
  16487. "release_counter": {
  16488. "type": "integer",
  16489. "format": "int64",
  16490. "x-go-name": "Releases"
  16491. },
  16492. "size": {
  16493. "type": "integer",
  16494. "format": "int64",
  16495. "x-go-name": "Size"
  16496. },
  16497. "ssh_url": {
  16498. "type": "string",
  16499. "x-go-name": "SSHURL"
  16500. },
  16501. "stars_count": {
  16502. "type": "integer",
  16503. "format": "int64",
  16504. "x-go-name": "Stars"
  16505. },
  16506. "template": {
  16507. "type": "boolean",
  16508. "x-go-name": "Template"
  16509. },
  16510. "updated_at": {
  16511. "type": "string",
  16512. "format": "date-time",
  16513. "x-go-name": "Updated"
  16514. },
  16515. "watchers_count": {
  16516. "type": "integer",
  16517. "format": "int64",
  16518. "x-go-name": "Watchers"
  16519. },
  16520. "website": {
  16521. "type": "string",
  16522. "x-go-name": "Website"
  16523. }
  16524. },
  16525. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16526. },
  16527. "RepositoryMeta": {
  16528. "description": "RepositoryMeta basic repository information",
  16529. "type": "object",
  16530. "properties": {
  16531. "full_name": {
  16532. "type": "string",
  16533. "x-go-name": "FullName"
  16534. },
  16535. "id": {
  16536. "type": "integer",
  16537. "format": "int64",
  16538. "x-go-name": "ID"
  16539. },
  16540. "name": {
  16541. "type": "string",
  16542. "x-go-name": "Name"
  16543. },
  16544. "owner": {
  16545. "type": "string",
  16546. "x-go-name": "Owner"
  16547. }
  16548. },
  16549. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16550. },
  16551. "ReviewStateType": {
  16552. "description": "ReviewStateType review state type",
  16553. "type": "string",
  16554. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16555. },
  16556. "SearchResults": {
  16557. "description": "SearchResults results of a successful search",
  16558. "type": "object",
  16559. "properties": {
  16560. "data": {
  16561. "type": "array",
  16562. "items": {
  16563. "$ref": "#/definitions/Repository"
  16564. },
  16565. "x-go-name": "Data"
  16566. },
  16567. "ok": {
  16568. "type": "boolean",
  16569. "x-go-name": "OK"
  16570. }
  16571. },
  16572. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16573. },
  16574. "ServerVersion": {
  16575. "description": "ServerVersion wraps the version of the server",
  16576. "type": "object",
  16577. "properties": {
  16578. "version": {
  16579. "type": "string",
  16580. "x-go-name": "Version"
  16581. }
  16582. },
  16583. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16584. },
  16585. "StateType": {
  16586. "description": "StateType issue state type",
  16587. "type": "string",
  16588. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16589. },
  16590. "StopWatch": {
  16591. "description": "StopWatch represent a running stopwatch",
  16592. "type": "object",
  16593. "properties": {
  16594. "created": {
  16595. "type": "string",
  16596. "format": "date-time",
  16597. "x-go-name": "Created"
  16598. },
  16599. "duration": {
  16600. "type": "string",
  16601. "x-go-name": "Duration"
  16602. },
  16603. "issue_index": {
  16604. "type": "integer",
  16605. "format": "int64",
  16606. "x-go-name": "IssueIndex"
  16607. },
  16608. "issue_title": {
  16609. "type": "string",
  16610. "x-go-name": "IssueTitle"
  16611. },
  16612. "repo_name": {
  16613. "type": "string",
  16614. "x-go-name": "RepoName"
  16615. },
  16616. "repo_owner_name": {
  16617. "type": "string",
  16618. "x-go-name": "RepoOwnerName"
  16619. },
  16620. "seconds": {
  16621. "type": "integer",
  16622. "format": "int64",
  16623. "x-go-name": "Seconds"
  16624. }
  16625. },
  16626. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16627. },
  16628. "SubmitPullReviewOptions": {
  16629. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  16630. "type": "object",
  16631. "properties": {
  16632. "body": {
  16633. "type": "string",
  16634. "x-go-name": "Body"
  16635. },
  16636. "event": {
  16637. "$ref": "#/definitions/ReviewStateType"
  16638. }
  16639. },
  16640. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16641. },
  16642. "Tag": {
  16643. "description": "Tag represents a repository tag",
  16644. "type": "object",
  16645. "properties": {
  16646. "commit": {
  16647. "$ref": "#/definitions/CommitMeta"
  16648. },
  16649. "id": {
  16650. "type": "string",
  16651. "x-go-name": "ID"
  16652. },
  16653. "message": {
  16654. "type": "string",
  16655. "x-go-name": "Message"
  16656. },
  16657. "name": {
  16658. "type": "string",
  16659. "x-go-name": "Name"
  16660. },
  16661. "tarball_url": {
  16662. "type": "string",
  16663. "x-go-name": "TarballURL"
  16664. },
  16665. "zipball_url": {
  16666. "type": "string",
  16667. "x-go-name": "ZipballURL"
  16668. }
  16669. },
  16670. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16671. },
  16672. "Team": {
  16673. "description": "Team represents a team in an organization",
  16674. "type": "object",
  16675. "properties": {
  16676. "can_create_org_repo": {
  16677. "type": "boolean",
  16678. "x-go-name": "CanCreateOrgRepo"
  16679. },
  16680. "description": {
  16681. "type": "string",
  16682. "x-go-name": "Description"
  16683. },
  16684. "id": {
  16685. "type": "integer",
  16686. "format": "int64",
  16687. "x-go-name": "ID"
  16688. },
  16689. "includes_all_repositories": {
  16690. "type": "boolean",
  16691. "x-go-name": "IncludesAllRepositories"
  16692. },
  16693. "name": {
  16694. "type": "string",
  16695. "x-go-name": "Name"
  16696. },
  16697. "organization": {
  16698. "$ref": "#/definitions/Organization"
  16699. },
  16700. "permission": {
  16701. "type": "string",
  16702. "enum": [
  16703. "none",
  16704. "read",
  16705. "write",
  16706. "admin",
  16707. "owner"
  16708. ],
  16709. "x-go-name": "Permission"
  16710. },
  16711. "units": {
  16712. "type": "array",
  16713. "items": {
  16714. "type": "string"
  16715. },
  16716. "x-go-name": "Units",
  16717. "example": [
  16718. "repo.code",
  16719. "repo.issues",
  16720. "repo.ext_issues",
  16721. "repo.wiki",
  16722. "repo.pulls",
  16723. "repo.releases",
  16724. "repo.projects",
  16725. "repo.ext_wiki"
  16726. ]
  16727. }
  16728. },
  16729. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16730. },
  16731. "TimeStamp": {
  16732. "description": "TimeStamp defines a timestamp",
  16733. "type": "integer",
  16734. "format": "int64",
  16735. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  16736. },
  16737. "TopicName": {
  16738. "description": "TopicName a list of repo topic names",
  16739. "type": "object",
  16740. "properties": {
  16741. "topics": {
  16742. "type": "array",
  16743. "items": {
  16744. "type": "string"
  16745. },
  16746. "x-go-name": "TopicNames"
  16747. }
  16748. },
  16749. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16750. },
  16751. "TopicResponse": {
  16752. "description": "TopicResponse for returning topics",
  16753. "type": "object",
  16754. "properties": {
  16755. "created": {
  16756. "type": "string",
  16757. "format": "date-time",
  16758. "x-go-name": "Created"
  16759. },
  16760. "id": {
  16761. "type": "integer",
  16762. "format": "int64",
  16763. "x-go-name": "ID"
  16764. },
  16765. "repo_count": {
  16766. "type": "integer",
  16767. "format": "int64",
  16768. "x-go-name": "RepoCount"
  16769. },
  16770. "topic_name": {
  16771. "type": "string",
  16772. "x-go-name": "Name"
  16773. },
  16774. "updated": {
  16775. "type": "string",
  16776. "format": "date-time",
  16777. "x-go-name": "Updated"
  16778. }
  16779. },
  16780. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16781. },
  16782. "TrackedTime": {
  16783. "description": "TrackedTime worked time for an issue / pr",
  16784. "type": "object",
  16785. "properties": {
  16786. "created": {
  16787. "type": "string",
  16788. "format": "date-time",
  16789. "x-go-name": "Created"
  16790. },
  16791. "id": {
  16792. "type": "integer",
  16793. "format": "int64",
  16794. "x-go-name": "ID"
  16795. },
  16796. "issue": {
  16797. "$ref": "#/definitions/Issue"
  16798. },
  16799. "issue_id": {
  16800. "description": "deprecated (only for backwards compatibility)",
  16801. "type": "integer",
  16802. "format": "int64",
  16803. "x-go-name": "IssueID"
  16804. },
  16805. "time": {
  16806. "description": "Time in seconds",
  16807. "type": "integer",
  16808. "format": "int64",
  16809. "x-go-name": "Time"
  16810. },
  16811. "user_id": {
  16812. "description": "deprecated (only for backwards compatibility)",
  16813. "type": "integer",
  16814. "format": "int64",
  16815. "x-go-name": "UserID"
  16816. },
  16817. "user_name": {
  16818. "type": "string",
  16819. "x-go-name": "UserName"
  16820. }
  16821. },
  16822. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16823. },
  16824. "TransferRepoOption": {
  16825. "description": "TransferRepoOption options when transfer a repository's ownership",
  16826. "type": "object",
  16827. "required": [
  16828. "new_owner"
  16829. ],
  16830. "properties": {
  16831. "new_owner": {
  16832. "type": "string",
  16833. "x-go-name": "NewOwner"
  16834. },
  16835. "team_ids": {
  16836. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  16837. "type": "array",
  16838. "items": {
  16839. "type": "integer",
  16840. "format": "int64"
  16841. },
  16842. "x-go-name": "TeamIDs"
  16843. }
  16844. },
  16845. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16846. },
  16847. "UpdateFileOptions": {
  16848. "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)",
  16849. "type": "object",
  16850. "required": [
  16851. "sha",
  16852. "content"
  16853. ],
  16854. "properties": {
  16855. "author": {
  16856. "$ref": "#/definitions/Identity"
  16857. },
  16858. "branch": {
  16859. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  16860. "type": "string",
  16861. "x-go-name": "BranchName"
  16862. },
  16863. "committer": {
  16864. "$ref": "#/definitions/Identity"
  16865. },
  16866. "content": {
  16867. "description": "content must be base64 encoded",
  16868. "type": "string",
  16869. "x-go-name": "Content"
  16870. },
  16871. "dates": {
  16872. "$ref": "#/definitions/CommitDateOptions"
  16873. },
  16874. "from_path": {
  16875. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  16876. "type": "string",
  16877. "x-go-name": "FromPath"
  16878. },
  16879. "message": {
  16880. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  16881. "type": "string",
  16882. "x-go-name": "Message"
  16883. },
  16884. "new_branch": {
  16885. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  16886. "type": "string",
  16887. "x-go-name": "NewBranchName"
  16888. },
  16889. "sha": {
  16890. "description": "sha is the SHA for the file that already exists",
  16891. "type": "string",
  16892. "x-go-name": "SHA"
  16893. },
  16894. "signoff": {
  16895. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  16896. "type": "boolean",
  16897. "x-go-name": "Signoff"
  16898. }
  16899. },
  16900. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16901. },
  16902. "User": {
  16903. "description": "User represents a user",
  16904. "type": "object",
  16905. "properties": {
  16906. "active": {
  16907. "description": "Is user active",
  16908. "type": "boolean",
  16909. "x-go-name": "IsActive"
  16910. },
  16911. "avatar_url": {
  16912. "description": "URL to the user's avatar",
  16913. "type": "string",
  16914. "x-go-name": "AvatarURL"
  16915. },
  16916. "created": {
  16917. "type": "string",
  16918. "format": "date-time",
  16919. "x-go-name": "Created"
  16920. },
  16921. "description": {
  16922. "description": "the user's description",
  16923. "type": "string",
  16924. "x-go-name": "Description"
  16925. },
  16926. "email": {
  16927. "type": "string",
  16928. "format": "email",
  16929. "x-go-name": "Email"
  16930. },
  16931. "followers_count": {
  16932. "description": "user counts",
  16933. "type": "integer",
  16934. "format": "int64",
  16935. "x-go-name": "Followers"
  16936. },
  16937. "following_count": {
  16938. "type": "integer",
  16939. "format": "int64",
  16940. "x-go-name": "Following"
  16941. },
  16942. "full_name": {
  16943. "description": "the user's full name",
  16944. "type": "string",
  16945. "x-go-name": "FullName"
  16946. },
  16947. "id": {
  16948. "description": "the user's id",
  16949. "type": "integer",
  16950. "format": "int64",
  16951. "x-go-name": "ID"
  16952. },
  16953. "is_admin": {
  16954. "description": "Is the user an administrator",
  16955. "type": "boolean",
  16956. "x-go-name": "IsAdmin"
  16957. },
  16958. "language": {
  16959. "description": "User locale",
  16960. "type": "string",
  16961. "x-go-name": "Language"
  16962. },
  16963. "last_login": {
  16964. "type": "string",
  16965. "format": "date-time",
  16966. "x-go-name": "LastLogin"
  16967. },
  16968. "location": {
  16969. "description": "the user's location",
  16970. "type": "string",
  16971. "x-go-name": "Location"
  16972. },
  16973. "login": {
  16974. "description": "the user's username",
  16975. "type": "string",
  16976. "x-go-name": "UserName"
  16977. },
  16978. "prohibit_login": {
  16979. "description": "Is user login prohibited",
  16980. "type": "boolean",
  16981. "x-go-name": "ProhibitLogin"
  16982. },
  16983. "restricted": {
  16984. "description": "Is user restricted",
  16985. "type": "boolean",
  16986. "x-go-name": "Restricted"
  16987. },
  16988. "starred_repos_count": {
  16989. "type": "integer",
  16990. "format": "int64",
  16991. "x-go-name": "StarredRepos"
  16992. },
  16993. "visibility": {
  16994. "description": "User visibility level option: public, limited, private",
  16995. "type": "string",
  16996. "x-go-name": "Visibility"
  16997. },
  16998. "website": {
  16999. "description": "the user's website",
  17000. "type": "string",
  17001. "x-go-name": "Website"
  17002. }
  17003. },
  17004. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17005. },
  17006. "UserHeatmapData": {
  17007. "description": "UserHeatmapData represents the data needed to create a heatmap",
  17008. "type": "object",
  17009. "properties": {
  17010. "contributions": {
  17011. "type": "integer",
  17012. "format": "int64",
  17013. "x-go-name": "Contributions"
  17014. },
  17015. "timestamp": {
  17016. "$ref": "#/definitions/TimeStamp"
  17017. }
  17018. },
  17019. "x-go-package": "code.gitea.io/gitea/models"
  17020. },
  17021. "UserSettings": {
  17022. "description": "UserSettings represents user settings",
  17023. "type": "object",
  17024. "properties": {
  17025. "description": {
  17026. "type": "string",
  17027. "x-go-name": "Description"
  17028. },
  17029. "diff_view_style": {
  17030. "type": "string",
  17031. "x-go-name": "DiffViewStyle"
  17032. },
  17033. "full_name": {
  17034. "type": "string",
  17035. "x-go-name": "FullName"
  17036. },
  17037. "hide_activity": {
  17038. "type": "boolean",
  17039. "x-go-name": "HideActivity"
  17040. },
  17041. "hide_email": {
  17042. "description": "Privacy",
  17043. "type": "boolean",
  17044. "x-go-name": "HideEmail"
  17045. },
  17046. "language": {
  17047. "type": "string",
  17048. "x-go-name": "Language"
  17049. },
  17050. "location": {
  17051. "type": "string",
  17052. "x-go-name": "Location"
  17053. },
  17054. "theme": {
  17055. "type": "string",
  17056. "x-go-name": "Theme"
  17057. },
  17058. "website": {
  17059. "type": "string",
  17060. "x-go-name": "Website"
  17061. }
  17062. },
  17063. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17064. },
  17065. "UserSettingsOptions": {
  17066. "description": "UserSettingsOptions represents options to change user settings",
  17067. "type": "object",
  17068. "properties": {
  17069. "description": {
  17070. "type": "string",
  17071. "x-go-name": "Description"
  17072. },
  17073. "diff_view_style": {
  17074. "type": "string",
  17075. "x-go-name": "DiffViewStyle"
  17076. },
  17077. "full_name": {
  17078. "type": "string",
  17079. "x-go-name": "FullName"
  17080. },
  17081. "hide_activity": {
  17082. "type": "boolean",
  17083. "x-go-name": "HideActivity"
  17084. },
  17085. "hide_email": {
  17086. "description": "Privacy",
  17087. "type": "boolean",
  17088. "x-go-name": "HideEmail"
  17089. },
  17090. "language": {
  17091. "type": "string",
  17092. "x-go-name": "Language"
  17093. },
  17094. "location": {
  17095. "type": "string",
  17096. "x-go-name": "Location"
  17097. },
  17098. "theme": {
  17099. "type": "string",
  17100. "x-go-name": "Theme"
  17101. },
  17102. "website": {
  17103. "type": "string",
  17104. "x-go-name": "Website"
  17105. }
  17106. },
  17107. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17108. },
  17109. "WatchInfo": {
  17110. "description": "WatchInfo represents an API watch status of one repository",
  17111. "type": "object",
  17112. "properties": {
  17113. "created_at": {
  17114. "type": "string",
  17115. "format": "date-time",
  17116. "x-go-name": "CreatedAt"
  17117. },
  17118. "ignored": {
  17119. "type": "boolean",
  17120. "x-go-name": "Ignored"
  17121. },
  17122. "reason": {
  17123. "type": "object",
  17124. "x-go-name": "Reason"
  17125. },
  17126. "repository_url": {
  17127. "type": "string",
  17128. "x-go-name": "RepositoryURL"
  17129. },
  17130. "subscribed": {
  17131. "type": "boolean",
  17132. "x-go-name": "Subscribed"
  17133. },
  17134. "url": {
  17135. "type": "string",
  17136. "x-go-name": "URL"
  17137. }
  17138. },
  17139. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17140. }
  17141. },
  17142. "responses": {
  17143. "AccessToken": {
  17144. "description": "AccessToken represents an API access token.",
  17145. "schema": {
  17146. "$ref": "#/definitions/AccessToken"
  17147. }
  17148. },
  17149. "AccessTokenList": {
  17150. "description": "AccessTokenList represents a list of API access token.",
  17151. "schema": {
  17152. "type": "array",
  17153. "items": {
  17154. "$ref": "#/definitions/AccessToken"
  17155. }
  17156. }
  17157. },
  17158. "AnnotatedTag": {
  17159. "description": "AnnotatedTag",
  17160. "schema": {
  17161. "$ref": "#/definitions/AnnotatedTag"
  17162. }
  17163. },
  17164. "Attachment": {
  17165. "description": "Attachment",
  17166. "schema": {
  17167. "$ref": "#/definitions/Attachment"
  17168. }
  17169. },
  17170. "AttachmentList": {
  17171. "description": "AttachmentList",
  17172. "schema": {
  17173. "type": "array",
  17174. "items": {
  17175. "$ref": "#/definitions/Attachment"
  17176. }
  17177. }
  17178. },
  17179. "Branch": {
  17180. "description": "Branch",
  17181. "schema": {
  17182. "$ref": "#/definitions/Branch"
  17183. }
  17184. },
  17185. "BranchList": {
  17186. "description": "BranchList",
  17187. "schema": {
  17188. "type": "array",
  17189. "items": {
  17190. "$ref": "#/definitions/Branch"
  17191. }
  17192. }
  17193. },
  17194. "BranchProtection": {
  17195. "description": "BranchProtection",
  17196. "schema": {
  17197. "$ref": "#/definitions/BranchProtection"
  17198. }
  17199. },
  17200. "BranchProtectionList": {
  17201. "description": "BranchProtectionList",
  17202. "schema": {
  17203. "type": "array",
  17204. "items": {
  17205. "$ref": "#/definitions/BranchProtection"
  17206. }
  17207. }
  17208. },
  17209. "CombinedStatus": {
  17210. "description": "CombinedStatus",
  17211. "schema": {
  17212. "$ref": "#/definitions/CombinedStatus"
  17213. }
  17214. },
  17215. "Comment": {
  17216. "description": "Comment",
  17217. "schema": {
  17218. "$ref": "#/definitions/Comment"
  17219. }
  17220. },
  17221. "CommentList": {
  17222. "description": "CommentList",
  17223. "schema": {
  17224. "type": "array",
  17225. "items": {
  17226. "$ref": "#/definitions/Comment"
  17227. }
  17228. }
  17229. },
  17230. "Commit": {
  17231. "description": "Commit",
  17232. "schema": {
  17233. "$ref": "#/definitions/Commit"
  17234. }
  17235. },
  17236. "CommitList": {
  17237. "description": "CommitList",
  17238. "schema": {
  17239. "type": "array",
  17240. "items": {
  17241. "$ref": "#/definitions/Commit"
  17242. }
  17243. },
  17244. "headers": {
  17245. "X-HasMore": {
  17246. "type": "boolean",
  17247. "description": "True if there is another page"
  17248. },
  17249. "X-Page": {
  17250. "type": "integer",
  17251. "format": "int64",
  17252. "description": "The current page"
  17253. },
  17254. "X-PageCount": {
  17255. "type": "integer",
  17256. "format": "int64",
  17257. "description": "Total number of pages"
  17258. },
  17259. "X-PerPage": {
  17260. "type": "integer",
  17261. "format": "int64",
  17262. "description": "Commits per page"
  17263. },
  17264. "X-Total": {
  17265. "type": "integer",
  17266. "format": "int64",
  17267. "description": "Total commit count"
  17268. }
  17269. }
  17270. },
  17271. "CommitStatus": {
  17272. "description": "CommitStatus",
  17273. "schema": {
  17274. "$ref": "#/definitions/CommitStatus"
  17275. }
  17276. },
  17277. "CommitStatusList": {
  17278. "description": "CommitStatusList",
  17279. "schema": {
  17280. "type": "array",
  17281. "items": {
  17282. "$ref": "#/definitions/CommitStatus"
  17283. }
  17284. }
  17285. },
  17286. "ContentsListResponse": {
  17287. "description": "ContentsListResponse",
  17288. "schema": {
  17289. "type": "array",
  17290. "items": {
  17291. "$ref": "#/definitions/ContentsResponse"
  17292. }
  17293. }
  17294. },
  17295. "ContentsResponse": {
  17296. "description": "ContentsResponse",
  17297. "schema": {
  17298. "$ref": "#/definitions/ContentsResponse"
  17299. }
  17300. },
  17301. "CronList": {
  17302. "description": "CronList",
  17303. "schema": {
  17304. "type": "array",
  17305. "items": {
  17306. "$ref": "#/definitions/Cron"
  17307. }
  17308. }
  17309. },
  17310. "DeployKey": {
  17311. "description": "DeployKey",
  17312. "schema": {
  17313. "$ref": "#/definitions/DeployKey"
  17314. }
  17315. },
  17316. "DeployKeyList": {
  17317. "description": "DeployKeyList",
  17318. "schema": {
  17319. "type": "array",
  17320. "items": {
  17321. "$ref": "#/definitions/DeployKey"
  17322. }
  17323. }
  17324. },
  17325. "EmailList": {
  17326. "description": "EmailList",
  17327. "schema": {
  17328. "type": "array",
  17329. "items": {
  17330. "$ref": "#/definitions/Email"
  17331. }
  17332. }
  17333. },
  17334. "EmptyRepository": {
  17335. "description": "EmptyRepository",
  17336. "schema": {
  17337. "$ref": "#/definitions/APIError"
  17338. }
  17339. },
  17340. "FileDeleteResponse": {
  17341. "description": "FileDeleteResponse",
  17342. "schema": {
  17343. "$ref": "#/definitions/FileDeleteResponse"
  17344. }
  17345. },
  17346. "FileResponse": {
  17347. "description": "FileResponse",
  17348. "schema": {
  17349. "$ref": "#/definitions/FileResponse"
  17350. }
  17351. },
  17352. "GPGKey": {
  17353. "description": "GPGKey",
  17354. "schema": {
  17355. "$ref": "#/definitions/GPGKey"
  17356. }
  17357. },
  17358. "GPGKeyList": {
  17359. "description": "GPGKeyList",
  17360. "schema": {
  17361. "type": "array",
  17362. "items": {
  17363. "$ref": "#/definitions/GPGKey"
  17364. }
  17365. }
  17366. },
  17367. "GeneralAPISettings": {
  17368. "description": "GeneralAPISettings",
  17369. "schema": {
  17370. "$ref": "#/definitions/GeneralAPISettings"
  17371. }
  17372. },
  17373. "GeneralAttachmentSettings": {
  17374. "description": "GeneralAttachmentSettings",
  17375. "schema": {
  17376. "$ref": "#/definitions/GeneralAttachmentSettings"
  17377. }
  17378. },
  17379. "GeneralRepoSettings": {
  17380. "description": "GeneralRepoSettings",
  17381. "schema": {
  17382. "$ref": "#/definitions/GeneralRepoSettings"
  17383. }
  17384. },
  17385. "GeneralUISettings": {
  17386. "description": "GeneralUISettings",
  17387. "schema": {
  17388. "$ref": "#/definitions/GeneralUISettings"
  17389. }
  17390. },
  17391. "GitBlobResponse": {
  17392. "description": "GitBlobResponse",
  17393. "schema": {
  17394. "$ref": "#/definitions/GitBlobResponse"
  17395. }
  17396. },
  17397. "GitHook": {
  17398. "description": "GitHook",
  17399. "schema": {
  17400. "$ref": "#/definitions/GitHook"
  17401. }
  17402. },
  17403. "GitHookList": {
  17404. "description": "GitHookList",
  17405. "schema": {
  17406. "type": "array",
  17407. "items": {
  17408. "$ref": "#/definitions/GitHook"
  17409. }
  17410. }
  17411. },
  17412. "GitTreeResponse": {
  17413. "description": "GitTreeResponse",
  17414. "schema": {
  17415. "$ref": "#/definitions/GitTreeResponse"
  17416. }
  17417. },
  17418. "Hook": {
  17419. "description": "Hook",
  17420. "schema": {
  17421. "$ref": "#/definitions/Hook"
  17422. }
  17423. },
  17424. "HookList": {
  17425. "description": "HookList",
  17426. "schema": {
  17427. "type": "array",
  17428. "items": {
  17429. "$ref": "#/definitions/Hook"
  17430. }
  17431. }
  17432. },
  17433. "Issue": {
  17434. "description": "Issue",
  17435. "schema": {
  17436. "$ref": "#/definitions/Issue"
  17437. }
  17438. },
  17439. "IssueDeadline": {
  17440. "description": "IssueDeadline",
  17441. "schema": {
  17442. "$ref": "#/definitions/IssueDeadline"
  17443. }
  17444. },
  17445. "IssueList": {
  17446. "description": "IssueList",
  17447. "schema": {
  17448. "type": "array",
  17449. "items": {
  17450. "$ref": "#/definitions/Issue"
  17451. }
  17452. }
  17453. },
  17454. "IssueTemplates": {
  17455. "description": "IssueTemplates",
  17456. "schema": {
  17457. "type": "array",
  17458. "items": {
  17459. "$ref": "#/definitions/IssueTemplate"
  17460. }
  17461. }
  17462. },
  17463. "Label": {
  17464. "description": "Label",
  17465. "schema": {
  17466. "$ref": "#/definitions/Label"
  17467. }
  17468. },
  17469. "LabelList": {
  17470. "description": "LabelList",
  17471. "schema": {
  17472. "type": "array",
  17473. "items": {
  17474. "$ref": "#/definitions/Label"
  17475. }
  17476. }
  17477. },
  17478. "LanguageStatistics": {
  17479. "description": "LanguageStatistics",
  17480. "schema": {
  17481. "type": "object",
  17482. "additionalProperties": {
  17483. "type": "integer",
  17484. "format": "int64"
  17485. }
  17486. }
  17487. },
  17488. "MarkdownRender": {
  17489. "description": "MarkdownRender is a rendered markdown document",
  17490. "schema": {
  17491. "type": "string"
  17492. }
  17493. },
  17494. "Milestone": {
  17495. "description": "Milestone",
  17496. "schema": {
  17497. "$ref": "#/definitions/Milestone"
  17498. }
  17499. },
  17500. "MilestoneList": {
  17501. "description": "MilestoneList",
  17502. "schema": {
  17503. "type": "array",
  17504. "items": {
  17505. "$ref": "#/definitions/Milestone"
  17506. }
  17507. }
  17508. },
  17509. "Note": {
  17510. "description": "Note",
  17511. "schema": {
  17512. "$ref": "#/definitions/Note"
  17513. }
  17514. },
  17515. "NotificationCount": {
  17516. "description": "Number of unread notifications",
  17517. "schema": {
  17518. "$ref": "#/definitions/NotificationCount"
  17519. }
  17520. },
  17521. "NotificationThread": {
  17522. "description": "NotificationThread",
  17523. "schema": {
  17524. "$ref": "#/definitions/NotificationThread"
  17525. }
  17526. },
  17527. "NotificationThreadList": {
  17528. "description": "NotificationThreadList",
  17529. "schema": {
  17530. "type": "array",
  17531. "items": {
  17532. "$ref": "#/definitions/NotificationThread"
  17533. }
  17534. }
  17535. },
  17536. "OAuth2Application": {
  17537. "description": "OAuth2Application",
  17538. "schema": {
  17539. "$ref": "#/definitions/OAuth2Application"
  17540. }
  17541. },
  17542. "OAuth2ApplicationList": {
  17543. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  17544. "schema": {
  17545. "type": "array",
  17546. "items": {
  17547. "$ref": "#/definitions/OAuth2Application"
  17548. }
  17549. }
  17550. },
  17551. "Organization": {
  17552. "description": "Organization",
  17553. "schema": {
  17554. "$ref": "#/definitions/Organization"
  17555. }
  17556. },
  17557. "OrganizationList": {
  17558. "description": "OrganizationList",
  17559. "schema": {
  17560. "type": "array",
  17561. "items": {
  17562. "$ref": "#/definitions/Organization"
  17563. }
  17564. }
  17565. },
  17566. "PublicKey": {
  17567. "description": "PublicKey",
  17568. "schema": {
  17569. "$ref": "#/definitions/PublicKey"
  17570. }
  17571. },
  17572. "PublicKeyList": {
  17573. "description": "PublicKeyList",
  17574. "schema": {
  17575. "type": "array",
  17576. "items": {
  17577. "$ref": "#/definitions/PublicKey"
  17578. }
  17579. }
  17580. },
  17581. "PullRequest": {
  17582. "description": "PullRequest",
  17583. "schema": {
  17584. "$ref": "#/definitions/PullRequest"
  17585. }
  17586. },
  17587. "PullRequestList": {
  17588. "description": "PullRequestList",
  17589. "schema": {
  17590. "type": "array",
  17591. "items": {
  17592. "$ref": "#/definitions/PullRequest"
  17593. }
  17594. }
  17595. },
  17596. "PullReview": {
  17597. "description": "PullReview",
  17598. "schema": {
  17599. "$ref": "#/definitions/PullReview"
  17600. }
  17601. },
  17602. "PullReviewComment": {
  17603. "description": "PullComment",
  17604. "schema": {
  17605. "$ref": "#/definitions/PullReviewComment"
  17606. }
  17607. },
  17608. "PullReviewCommentList": {
  17609. "description": "PullCommentList",
  17610. "schema": {
  17611. "type": "array",
  17612. "items": {
  17613. "$ref": "#/definitions/PullReviewComment"
  17614. }
  17615. }
  17616. },
  17617. "PullReviewList": {
  17618. "description": "PullReviewList",
  17619. "schema": {
  17620. "type": "array",
  17621. "items": {
  17622. "$ref": "#/definitions/PullReview"
  17623. }
  17624. }
  17625. },
  17626. "Reaction": {
  17627. "description": "Reaction",
  17628. "schema": {
  17629. "$ref": "#/definitions/Reaction"
  17630. }
  17631. },
  17632. "ReactionList": {
  17633. "description": "ReactionList",
  17634. "schema": {
  17635. "type": "array",
  17636. "items": {
  17637. "$ref": "#/definitions/Reaction"
  17638. }
  17639. }
  17640. },
  17641. "Reference": {
  17642. "description": "Reference",
  17643. "schema": {
  17644. "$ref": "#/definitions/Reference"
  17645. }
  17646. },
  17647. "ReferenceList": {
  17648. "description": "ReferenceList",
  17649. "schema": {
  17650. "type": "array",
  17651. "items": {
  17652. "$ref": "#/definitions/Reference"
  17653. }
  17654. }
  17655. },
  17656. "Release": {
  17657. "description": "Release",
  17658. "schema": {
  17659. "$ref": "#/definitions/Release"
  17660. }
  17661. },
  17662. "ReleaseList": {
  17663. "description": "ReleaseList",
  17664. "schema": {
  17665. "type": "array",
  17666. "items": {
  17667. "$ref": "#/definitions/Release"
  17668. }
  17669. }
  17670. },
  17671. "Repository": {
  17672. "description": "Repository",
  17673. "schema": {
  17674. "$ref": "#/definitions/Repository"
  17675. }
  17676. },
  17677. "RepositoryList": {
  17678. "description": "RepositoryList",
  17679. "schema": {
  17680. "type": "array",
  17681. "items": {
  17682. "$ref": "#/definitions/Repository"
  17683. }
  17684. }
  17685. },
  17686. "SearchResults": {
  17687. "description": "SearchResults",
  17688. "schema": {
  17689. "$ref": "#/definitions/SearchResults"
  17690. }
  17691. },
  17692. "ServerVersion": {
  17693. "description": "ServerVersion",
  17694. "schema": {
  17695. "$ref": "#/definitions/ServerVersion"
  17696. }
  17697. },
  17698. "StopWatch": {
  17699. "description": "StopWatch",
  17700. "schema": {
  17701. "$ref": "#/definitions/StopWatch"
  17702. }
  17703. },
  17704. "StopWatchList": {
  17705. "description": "StopWatchList",
  17706. "schema": {
  17707. "type": "array",
  17708. "items": {
  17709. "$ref": "#/definitions/StopWatch"
  17710. }
  17711. }
  17712. },
  17713. "StringSlice": {
  17714. "description": "StringSlice",
  17715. "schema": {
  17716. "type": "array",
  17717. "items": {
  17718. "type": "string"
  17719. }
  17720. }
  17721. },
  17722. "Tag": {
  17723. "description": "Tag",
  17724. "schema": {
  17725. "$ref": "#/definitions/Tag"
  17726. }
  17727. },
  17728. "TagList": {
  17729. "description": "TagList",
  17730. "schema": {
  17731. "type": "array",
  17732. "items": {
  17733. "$ref": "#/definitions/Tag"
  17734. }
  17735. }
  17736. },
  17737. "Team": {
  17738. "description": "Team",
  17739. "schema": {
  17740. "$ref": "#/definitions/Team"
  17741. }
  17742. },
  17743. "TeamList": {
  17744. "description": "TeamList",
  17745. "schema": {
  17746. "type": "array",
  17747. "items": {
  17748. "$ref": "#/definitions/Team"
  17749. }
  17750. }
  17751. },
  17752. "TopicListResponse": {
  17753. "description": "TopicListResponse",
  17754. "schema": {
  17755. "type": "array",
  17756. "items": {
  17757. "$ref": "#/definitions/TopicResponse"
  17758. }
  17759. }
  17760. },
  17761. "TopicNames": {
  17762. "description": "TopicNames",
  17763. "schema": {
  17764. "$ref": "#/definitions/TopicName"
  17765. }
  17766. },
  17767. "TrackedTime": {
  17768. "description": "TrackedTime",
  17769. "schema": {
  17770. "$ref": "#/definitions/TrackedTime"
  17771. }
  17772. },
  17773. "TrackedTimeList": {
  17774. "description": "TrackedTimeList",
  17775. "schema": {
  17776. "type": "array",
  17777. "items": {
  17778. "$ref": "#/definitions/TrackedTime"
  17779. }
  17780. }
  17781. },
  17782. "User": {
  17783. "description": "User",
  17784. "schema": {
  17785. "$ref": "#/definitions/User"
  17786. }
  17787. },
  17788. "UserHeatmapData": {
  17789. "description": "UserHeatmapData",
  17790. "schema": {
  17791. "type": "array",
  17792. "items": {
  17793. "$ref": "#/definitions/UserHeatmapData"
  17794. }
  17795. }
  17796. },
  17797. "UserList": {
  17798. "description": "UserList",
  17799. "schema": {
  17800. "type": "array",
  17801. "items": {
  17802. "$ref": "#/definitions/User"
  17803. }
  17804. }
  17805. },
  17806. "UserSettings": {
  17807. "description": "UserSettings",
  17808. "schema": {
  17809. "type": "array",
  17810. "items": {
  17811. "$ref": "#/definitions/UserSettings"
  17812. }
  17813. }
  17814. },
  17815. "WatchInfo": {
  17816. "description": "WatchInfo",
  17817. "schema": {
  17818. "$ref": "#/definitions/WatchInfo"
  17819. }
  17820. },
  17821. "conflict": {
  17822. "description": "APIConflict is a conflict empty response"
  17823. },
  17824. "empty": {
  17825. "description": "APIEmpty is an empty response"
  17826. },
  17827. "error": {
  17828. "description": "APIError is error format response",
  17829. "headers": {
  17830. "message": {
  17831. "type": "string"
  17832. },
  17833. "url": {
  17834. "type": "string"
  17835. }
  17836. }
  17837. },
  17838. "forbidden": {
  17839. "description": "APIForbiddenError is a forbidden error response",
  17840. "headers": {
  17841. "message": {
  17842. "type": "string"
  17843. },
  17844. "url": {
  17845. "type": "string"
  17846. }
  17847. }
  17848. },
  17849. "invalidTopicsError": {
  17850. "description": "APIInvalidTopicsError is error format response to invalid topics",
  17851. "headers": {
  17852. "invalidTopics": {
  17853. "type": "array",
  17854. "items": {
  17855. "type": "string"
  17856. }
  17857. },
  17858. "message": {
  17859. "type": "string"
  17860. }
  17861. }
  17862. },
  17863. "notFound": {
  17864. "description": "APINotFound is a not found empty response"
  17865. },
  17866. "parameterBodies": {
  17867. "description": "parameterBodies",
  17868. "schema": {
  17869. "$ref": "#/definitions/UserSettingsOptions"
  17870. }
  17871. },
  17872. "redirect": {
  17873. "description": "APIRedirect is a redirect response"
  17874. },
  17875. "string": {
  17876. "description": "APIString is a string response",
  17877. "schema": {
  17878. "type": "string"
  17879. }
  17880. },
  17881. "validationError": {
  17882. "description": "APIValidationError is error format response related to input validation",
  17883. "headers": {
  17884. "message": {
  17885. "type": "string"
  17886. },
  17887. "url": {
  17888. "type": "string"
  17889. }
  17890. }
  17891. }
  17892. },
  17893. "securityDefinitions": {
  17894. "AccessToken": {
  17895. "type": "apiKey",
  17896. "name": "access_token",
  17897. "in": "query"
  17898. },
  17899. "AuthorizationHeaderToken": {
  17900. "description": "API tokens must be prepended with \"token\" followed by a space.",
  17901. "type": "apiKey",
  17902. "name": "Authorization",
  17903. "in": "header"
  17904. },
  17905. "BasicAuth": {
  17906. "type": "basic"
  17907. },
  17908. "SudoHeader": {
  17909. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  17910. "type": "apiKey",
  17911. "name": "Sudo",
  17912. "in": "header"
  17913. },
  17914. "SudoParam": {
  17915. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  17916. "type": "apiKey",
  17917. "name": "sudo",
  17918. "in": "query"
  17919. },
  17920. "TOTPHeader": {
  17921. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  17922. "type": "apiKey",
  17923. "name": "X-GITEA-OTP",
  17924. "in": "header"
  17925. },
  17926. "Token": {
  17927. "type": "apiKey",
  17928. "name": "token",
  17929. "in": "query"
  17930. }
  17931. },
  17932. "security": [
  17933. {
  17934. "BasicAuth": []
  17935. },
  17936. {
  17937. "Token": []
  17938. },
  17939. {
  17940. "AccessToken": []
  17941. },
  17942. {
  17943. "AuthorizationHeaderToken": []
  17944. },
  17945. {
  17946. "SudoParam": []
  17947. },
  17948. {
  17949. "SudoHeader": []
  17950. },
  17951. {
  17952. "TOTPHeader": []
  17953. }
  17954. ]
  17955. }