You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

v1_json.tmpl 605KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "{{AppVer | JSEscape | Safe}}"
  23. },
  24. "basePath": "{{AppSubUrl | JSEscape | Safe}}/api/v1",
  25. "paths": {
  26. "/activitypub/user-id/{user-id}": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "activitypub"
  33. ],
  34. "summary": "Returns the Person actor for a user",
  35. "operationId": "activitypubPerson",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "user ID of the user",
  40. "name": "user-id",
  41. "in": "path",
  42. "required": true
  43. }
  44. ],
  45. "responses": {
  46. "200": {
  47. "$ref": "#/responses/ActivityPub"
  48. }
  49. }
  50. }
  51. },
  52. "/activitypub/user-id/{user-id}/inbox": {
  53. "post": {
  54. "produces": [
  55. "application/json"
  56. ],
  57. "tags": [
  58. "activitypub"
  59. ],
  60. "summary": "Send to the inbox",
  61. "operationId": "activitypubPersonInbox",
  62. "parameters": [
  63. {
  64. "type": "integer",
  65. "description": "user ID of the user",
  66. "name": "user-id",
  67. "in": "path",
  68. "required": true
  69. }
  70. ],
  71. "responses": {
  72. "204": {
  73. "$ref": "#/responses/empty"
  74. }
  75. }
  76. }
  77. },
  78. "/admin/cron": {
  79. "get": {
  80. "produces": [
  81. "application/json"
  82. ],
  83. "tags": [
  84. "admin"
  85. ],
  86. "summary": "List cron tasks",
  87. "operationId": "adminCronList",
  88. "parameters": [
  89. {
  90. "type": "integer",
  91. "description": "page number of results to return (1-based)",
  92. "name": "page",
  93. "in": "query"
  94. },
  95. {
  96. "type": "integer",
  97. "description": "page size of results",
  98. "name": "limit",
  99. "in": "query"
  100. }
  101. ],
  102. "responses": {
  103. "200": {
  104. "$ref": "#/responses/CronList"
  105. },
  106. "403": {
  107. "$ref": "#/responses/forbidden"
  108. }
  109. }
  110. }
  111. },
  112. "/admin/cron/{task}": {
  113. "post": {
  114. "produces": [
  115. "application/json"
  116. ],
  117. "tags": [
  118. "admin"
  119. ],
  120. "summary": "Run cron task",
  121. "operationId": "adminCronRun",
  122. "parameters": [
  123. {
  124. "type": "string",
  125. "description": "task to run",
  126. "name": "task",
  127. "in": "path",
  128. "required": true
  129. }
  130. ],
  131. "responses": {
  132. "204": {
  133. "$ref": "#/responses/empty"
  134. },
  135. "404": {
  136. "$ref": "#/responses/notFound"
  137. }
  138. }
  139. }
  140. },
  141. "/admin/emails": {
  142. "get": {
  143. "produces": [
  144. "application/json"
  145. ],
  146. "tags": [
  147. "admin"
  148. ],
  149. "summary": "List all emails",
  150. "operationId": "adminGetAllEmails",
  151. "parameters": [
  152. {
  153. "type": "integer",
  154. "description": "page number of results to return (1-based)",
  155. "name": "page",
  156. "in": "query"
  157. },
  158. {
  159. "type": "integer",
  160. "description": "page size of results",
  161. "name": "limit",
  162. "in": "query"
  163. }
  164. ],
  165. "responses": {
  166. "200": {
  167. "$ref": "#/responses/EmailList"
  168. },
  169. "403": {
  170. "$ref": "#/responses/forbidden"
  171. }
  172. }
  173. }
  174. },
  175. "/admin/emails/search": {
  176. "get": {
  177. "produces": [
  178. "application/json"
  179. ],
  180. "tags": [
  181. "admin"
  182. ],
  183. "summary": "Search all emails",
  184. "operationId": "adminSearchEmails",
  185. "parameters": [
  186. {
  187. "type": "string",
  188. "description": "keyword",
  189. "name": "q",
  190. "in": "query"
  191. },
  192. {
  193. "type": "integer",
  194. "description": "page number of results to return (1-based)",
  195. "name": "page",
  196. "in": "query"
  197. },
  198. {
  199. "type": "integer",
  200. "description": "page size of results",
  201. "name": "limit",
  202. "in": "query"
  203. }
  204. ],
  205. "responses": {
  206. "200": {
  207. "$ref": "#/responses/EmailList"
  208. },
  209. "403": {
  210. "$ref": "#/responses/forbidden"
  211. }
  212. }
  213. }
  214. },
  215. "/admin/hooks": {
  216. "get": {
  217. "produces": [
  218. "application/json"
  219. ],
  220. "tags": [
  221. "admin"
  222. ],
  223. "summary": "List system's webhooks",
  224. "operationId": "adminListHooks",
  225. "parameters": [
  226. {
  227. "type": "integer",
  228. "description": "page number of results to return (1-based)",
  229. "name": "page",
  230. "in": "query"
  231. },
  232. {
  233. "type": "integer",
  234. "description": "page size of results",
  235. "name": "limit",
  236. "in": "query"
  237. }
  238. ],
  239. "responses": {
  240. "200": {
  241. "$ref": "#/responses/HookList"
  242. }
  243. }
  244. },
  245. "post": {
  246. "consumes": [
  247. "application/json"
  248. ],
  249. "produces": [
  250. "application/json"
  251. ],
  252. "tags": [
  253. "admin"
  254. ],
  255. "summary": "Create a hook",
  256. "operationId": "adminCreateHook",
  257. "parameters": [
  258. {
  259. "name": "body",
  260. "in": "body",
  261. "required": true,
  262. "schema": {
  263. "$ref": "#/definitions/CreateHookOption"
  264. }
  265. }
  266. ],
  267. "responses": {
  268. "201": {
  269. "$ref": "#/responses/Hook"
  270. }
  271. }
  272. }
  273. },
  274. "/admin/hooks/{id}": {
  275. "get": {
  276. "produces": [
  277. "application/json"
  278. ],
  279. "tags": [
  280. "admin"
  281. ],
  282. "summary": "Get a hook",
  283. "operationId": "adminGetHook",
  284. "parameters": [
  285. {
  286. "type": "integer",
  287. "format": "int64",
  288. "description": "id of the hook to get",
  289. "name": "id",
  290. "in": "path",
  291. "required": true
  292. }
  293. ],
  294. "responses": {
  295. "200": {
  296. "$ref": "#/responses/Hook"
  297. }
  298. }
  299. },
  300. "delete": {
  301. "produces": [
  302. "application/json"
  303. ],
  304. "tags": [
  305. "admin"
  306. ],
  307. "summary": "Delete a hook",
  308. "operationId": "adminDeleteHook",
  309. "parameters": [
  310. {
  311. "type": "integer",
  312. "format": "int64",
  313. "description": "id of the hook to delete",
  314. "name": "id",
  315. "in": "path",
  316. "required": true
  317. }
  318. ],
  319. "responses": {
  320. "204": {
  321. "$ref": "#/responses/empty"
  322. }
  323. }
  324. },
  325. "patch": {
  326. "consumes": [
  327. "application/json"
  328. ],
  329. "produces": [
  330. "application/json"
  331. ],
  332. "tags": [
  333. "admin"
  334. ],
  335. "summary": "Update a hook",
  336. "operationId": "adminEditHook",
  337. "parameters": [
  338. {
  339. "type": "integer",
  340. "format": "int64",
  341. "description": "id of the hook to update",
  342. "name": "id",
  343. "in": "path",
  344. "required": true
  345. },
  346. {
  347. "name": "body",
  348. "in": "body",
  349. "schema": {
  350. "$ref": "#/definitions/EditHookOption"
  351. }
  352. }
  353. ],
  354. "responses": {
  355. "200": {
  356. "$ref": "#/responses/Hook"
  357. }
  358. }
  359. }
  360. },
  361. "/admin/orgs": {
  362. "get": {
  363. "produces": [
  364. "application/json"
  365. ],
  366. "tags": [
  367. "admin"
  368. ],
  369. "summary": "List all organizations",
  370. "operationId": "adminGetAllOrgs",
  371. "parameters": [
  372. {
  373. "type": "integer",
  374. "description": "page number of results to return (1-based)",
  375. "name": "page",
  376. "in": "query"
  377. },
  378. {
  379. "type": "integer",
  380. "description": "page size of results",
  381. "name": "limit",
  382. "in": "query"
  383. }
  384. ],
  385. "responses": {
  386. "200": {
  387. "$ref": "#/responses/OrganizationList"
  388. },
  389. "403": {
  390. "$ref": "#/responses/forbidden"
  391. }
  392. }
  393. }
  394. },
  395. "/admin/unadopted": {
  396. "get": {
  397. "produces": [
  398. "application/json"
  399. ],
  400. "tags": [
  401. "admin"
  402. ],
  403. "summary": "List unadopted repositories",
  404. "operationId": "adminUnadoptedList",
  405. "parameters": [
  406. {
  407. "type": "integer",
  408. "description": "page number of results to return (1-based)",
  409. "name": "page",
  410. "in": "query"
  411. },
  412. {
  413. "type": "integer",
  414. "description": "page size of results",
  415. "name": "limit",
  416. "in": "query"
  417. },
  418. {
  419. "type": "string",
  420. "description": "pattern of repositories to search for",
  421. "name": "pattern",
  422. "in": "query"
  423. }
  424. ],
  425. "responses": {
  426. "200": {
  427. "$ref": "#/responses/StringSlice"
  428. },
  429. "403": {
  430. "$ref": "#/responses/forbidden"
  431. }
  432. }
  433. }
  434. },
  435. "/admin/unadopted/{owner}/{repo}": {
  436. "post": {
  437. "produces": [
  438. "application/json"
  439. ],
  440. "tags": [
  441. "admin"
  442. ],
  443. "summary": "Adopt unadopted files as a repository",
  444. "operationId": "adminAdoptRepository",
  445. "parameters": [
  446. {
  447. "type": "string",
  448. "description": "owner of the repo",
  449. "name": "owner",
  450. "in": "path",
  451. "required": true
  452. },
  453. {
  454. "type": "string",
  455. "description": "name of the repo",
  456. "name": "repo",
  457. "in": "path",
  458. "required": true
  459. }
  460. ],
  461. "responses": {
  462. "204": {
  463. "$ref": "#/responses/empty"
  464. },
  465. "403": {
  466. "$ref": "#/responses/forbidden"
  467. },
  468. "404": {
  469. "$ref": "#/responses/notFound"
  470. }
  471. }
  472. },
  473. "delete": {
  474. "produces": [
  475. "application/json"
  476. ],
  477. "tags": [
  478. "admin"
  479. ],
  480. "summary": "Delete unadopted files",
  481. "operationId": "adminDeleteUnadoptedRepository",
  482. "parameters": [
  483. {
  484. "type": "string",
  485. "description": "owner of the repo",
  486. "name": "owner",
  487. "in": "path",
  488. "required": true
  489. },
  490. {
  491. "type": "string",
  492. "description": "name of the repo",
  493. "name": "repo",
  494. "in": "path",
  495. "required": true
  496. }
  497. ],
  498. "responses": {
  499. "204": {
  500. "$ref": "#/responses/empty"
  501. },
  502. "403": {
  503. "$ref": "#/responses/forbidden"
  504. }
  505. }
  506. }
  507. },
  508. "/admin/users": {
  509. "get": {
  510. "produces": [
  511. "application/json"
  512. ],
  513. "tags": [
  514. "admin"
  515. ],
  516. "summary": "Search users according filter conditions",
  517. "operationId": "adminSearchUsers",
  518. "parameters": [
  519. {
  520. "type": "integer",
  521. "format": "int64",
  522. "description": "ID of the user's login source to search for",
  523. "name": "source_id",
  524. "in": "query"
  525. },
  526. {
  527. "type": "string",
  528. "description": "user's login name to search for",
  529. "name": "login_name",
  530. "in": "query"
  531. },
  532. {
  533. "type": "integer",
  534. "description": "page number of results to return (1-based)",
  535. "name": "page",
  536. "in": "query"
  537. },
  538. {
  539. "type": "integer",
  540. "description": "page size of results",
  541. "name": "limit",
  542. "in": "query"
  543. }
  544. ],
  545. "responses": {
  546. "200": {
  547. "$ref": "#/responses/UserList"
  548. },
  549. "403": {
  550. "$ref": "#/responses/forbidden"
  551. }
  552. }
  553. },
  554. "post": {
  555. "consumes": [
  556. "application/json"
  557. ],
  558. "produces": [
  559. "application/json"
  560. ],
  561. "tags": [
  562. "admin"
  563. ],
  564. "summary": "Create a user",
  565. "operationId": "adminCreateUser",
  566. "parameters": [
  567. {
  568. "name": "body",
  569. "in": "body",
  570. "schema": {
  571. "$ref": "#/definitions/CreateUserOption"
  572. }
  573. }
  574. ],
  575. "responses": {
  576. "201": {
  577. "$ref": "#/responses/User"
  578. },
  579. "400": {
  580. "$ref": "#/responses/error"
  581. },
  582. "403": {
  583. "$ref": "#/responses/forbidden"
  584. },
  585. "422": {
  586. "$ref": "#/responses/validationError"
  587. }
  588. }
  589. }
  590. },
  591. "/admin/users/{username}": {
  592. "delete": {
  593. "produces": [
  594. "application/json"
  595. ],
  596. "tags": [
  597. "admin"
  598. ],
  599. "summary": "Delete a user",
  600. "operationId": "adminDeleteUser",
  601. "parameters": [
  602. {
  603. "type": "string",
  604. "description": "username of user to delete",
  605. "name": "username",
  606. "in": "path",
  607. "required": true
  608. },
  609. {
  610. "type": "boolean",
  611. "description": "purge the user from the system completely",
  612. "name": "purge",
  613. "in": "query"
  614. }
  615. ],
  616. "responses": {
  617. "204": {
  618. "$ref": "#/responses/empty"
  619. },
  620. "403": {
  621. "$ref": "#/responses/forbidden"
  622. },
  623. "404": {
  624. "$ref": "#/responses/notFound"
  625. },
  626. "422": {
  627. "$ref": "#/responses/validationError"
  628. }
  629. }
  630. },
  631. "patch": {
  632. "consumes": [
  633. "application/json"
  634. ],
  635. "produces": [
  636. "application/json"
  637. ],
  638. "tags": [
  639. "admin"
  640. ],
  641. "summary": "Edit an existing user",
  642. "operationId": "adminEditUser",
  643. "parameters": [
  644. {
  645. "type": "string",
  646. "description": "username of user to edit",
  647. "name": "username",
  648. "in": "path",
  649. "required": true
  650. },
  651. {
  652. "name": "body",
  653. "in": "body",
  654. "schema": {
  655. "$ref": "#/definitions/EditUserOption"
  656. }
  657. }
  658. ],
  659. "responses": {
  660. "200": {
  661. "$ref": "#/responses/User"
  662. },
  663. "403": {
  664. "$ref": "#/responses/forbidden"
  665. },
  666. "422": {
  667. "$ref": "#/responses/validationError"
  668. }
  669. }
  670. }
  671. },
  672. "/admin/users/{username}/keys": {
  673. "post": {
  674. "consumes": [
  675. "application/json"
  676. ],
  677. "produces": [
  678. "application/json"
  679. ],
  680. "tags": [
  681. "admin"
  682. ],
  683. "summary": "Add a public key on behalf of a user",
  684. "operationId": "adminCreatePublicKey",
  685. "parameters": [
  686. {
  687. "type": "string",
  688. "description": "username of the user",
  689. "name": "username",
  690. "in": "path",
  691. "required": true
  692. },
  693. {
  694. "name": "key",
  695. "in": "body",
  696. "schema": {
  697. "$ref": "#/definitions/CreateKeyOption"
  698. }
  699. }
  700. ],
  701. "responses": {
  702. "201": {
  703. "$ref": "#/responses/PublicKey"
  704. },
  705. "403": {
  706. "$ref": "#/responses/forbidden"
  707. },
  708. "422": {
  709. "$ref": "#/responses/validationError"
  710. }
  711. }
  712. }
  713. },
  714. "/admin/users/{username}/keys/{id}": {
  715. "delete": {
  716. "produces": [
  717. "application/json"
  718. ],
  719. "tags": [
  720. "admin"
  721. ],
  722. "summary": "Delete a user's public key",
  723. "operationId": "adminDeleteUserPublicKey",
  724. "parameters": [
  725. {
  726. "type": "string",
  727. "description": "username of user",
  728. "name": "username",
  729. "in": "path",
  730. "required": true
  731. },
  732. {
  733. "type": "integer",
  734. "format": "int64",
  735. "description": "id of the key to delete",
  736. "name": "id",
  737. "in": "path",
  738. "required": true
  739. }
  740. ],
  741. "responses": {
  742. "204": {
  743. "$ref": "#/responses/empty"
  744. },
  745. "403": {
  746. "$ref": "#/responses/forbidden"
  747. },
  748. "404": {
  749. "$ref": "#/responses/notFound"
  750. }
  751. }
  752. }
  753. },
  754. "/admin/users/{username}/orgs": {
  755. "post": {
  756. "consumes": [
  757. "application/json"
  758. ],
  759. "produces": [
  760. "application/json"
  761. ],
  762. "tags": [
  763. "admin"
  764. ],
  765. "summary": "Create an organization",
  766. "operationId": "adminCreateOrg",
  767. "parameters": [
  768. {
  769. "type": "string",
  770. "description": "username of the user that will own the created organization",
  771. "name": "username",
  772. "in": "path",
  773. "required": true
  774. },
  775. {
  776. "name": "organization",
  777. "in": "body",
  778. "required": true,
  779. "schema": {
  780. "$ref": "#/definitions/CreateOrgOption"
  781. }
  782. }
  783. ],
  784. "responses": {
  785. "201": {
  786. "$ref": "#/responses/Organization"
  787. },
  788. "403": {
  789. "$ref": "#/responses/forbidden"
  790. },
  791. "422": {
  792. "$ref": "#/responses/validationError"
  793. }
  794. }
  795. }
  796. },
  797. "/admin/users/{username}/rename": {
  798. "post": {
  799. "produces": [
  800. "application/json"
  801. ],
  802. "tags": [
  803. "admin"
  804. ],
  805. "summary": "Rename a user",
  806. "operationId": "adminRenameUser",
  807. "parameters": [
  808. {
  809. "type": "string",
  810. "description": "existing username of user",
  811. "name": "username",
  812. "in": "path",
  813. "required": true
  814. },
  815. {
  816. "name": "body",
  817. "in": "body",
  818. "required": true,
  819. "schema": {
  820. "$ref": "#/definitions/RenameUserOption"
  821. }
  822. }
  823. ],
  824. "responses": {
  825. "204": {
  826. "$ref": "#/responses/empty"
  827. },
  828. "403": {
  829. "$ref": "#/responses/forbidden"
  830. },
  831. "422": {
  832. "$ref": "#/responses/validationError"
  833. }
  834. }
  835. }
  836. },
  837. "/admin/users/{username}/repos": {
  838. "post": {
  839. "consumes": [
  840. "application/json"
  841. ],
  842. "produces": [
  843. "application/json"
  844. ],
  845. "tags": [
  846. "admin"
  847. ],
  848. "summary": "Create a repository on behalf of a user",
  849. "operationId": "adminCreateRepo",
  850. "parameters": [
  851. {
  852. "type": "string",
  853. "description": "username of the user. This user will own the created repository",
  854. "name": "username",
  855. "in": "path",
  856. "required": true
  857. },
  858. {
  859. "name": "repository",
  860. "in": "body",
  861. "required": true,
  862. "schema": {
  863. "$ref": "#/definitions/CreateRepoOption"
  864. }
  865. }
  866. ],
  867. "responses": {
  868. "201": {
  869. "$ref": "#/responses/Repository"
  870. },
  871. "400": {
  872. "$ref": "#/responses/error"
  873. },
  874. "403": {
  875. "$ref": "#/responses/forbidden"
  876. },
  877. "404": {
  878. "$ref": "#/responses/notFound"
  879. },
  880. "409": {
  881. "$ref": "#/responses/error"
  882. },
  883. "422": {
  884. "$ref": "#/responses/validationError"
  885. }
  886. }
  887. }
  888. },
  889. "/gitignore/templates": {
  890. "get": {
  891. "produces": [
  892. "application/json"
  893. ],
  894. "tags": [
  895. "miscellaneous"
  896. ],
  897. "summary": "Returns a list of all gitignore templates",
  898. "operationId": "listGitignoresTemplates",
  899. "responses": {
  900. "200": {
  901. "$ref": "#/responses/GitignoreTemplateList"
  902. }
  903. }
  904. }
  905. },
  906. "/gitignore/templates/{name}": {
  907. "get": {
  908. "produces": [
  909. "application/json"
  910. ],
  911. "tags": [
  912. "miscellaneous"
  913. ],
  914. "summary": "Returns information about a gitignore template",
  915. "operationId": "getGitignoreTemplateInfo",
  916. "parameters": [
  917. {
  918. "type": "string",
  919. "description": "name of the template",
  920. "name": "name",
  921. "in": "path",
  922. "required": true
  923. }
  924. ],
  925. "responses": {
  926. "200": {
  927. "$ref": "#/responses/GitignoreTemplateInfo"
  928. },
  929. "404": {
  930. "$ref": "#/responses/notFound"
  931. }
  932. }
  933. }
  934. },
  935. "/label/templates": {
  936. "get": {
  937. "produces": [
  938. "application/json"
  939. ],
  940. "tags": [
  941. "miscellaneous"
  942. ],
  943. "summary": "Returns a list of all label templates",
  944. "operationId": "listLabelTemplates",
  945. "responses": {
  946. "200": {
  947. "$ref": "#/responses/LabelTemplateList"
  948. }
  949. }
  950. }
  951. },
  952. "/label/templates/{name}": {
  953. "get": {
  954. "produces": [
  955. "application/json"
  956. ],
  957. "tags": [
  958. "miscellaneous"
  959. ],
  960. "summary": "Returns all labels in a template",
  961. "operationId": "getLabelTemplateInfo",
  962. "parameters": [
  963. {
  964. "type": "string",
  965. "description": "name of the template",
  966. "name": "name",
  967. "in": "path",
  968. "required": true
  969. }
  970. ],
  971. "responses": {
  972. "200": {
  973. "$ref": "#/responses/LabelTemplateInfo"
  974. },
  975. "404": {
  976. "$ref": "#/responses/notFound"
  977. }
  978. }
  979. }
  980. },
  981. "/licenses": {
  982. "get": {
  983. "produces": [
  984. "application/json"
  985. ],
  986. "tags": [
  987. "miscellaneous"
  988. ],
  989. "summary": "Returns a list of all license templates",
  990. "operationId": "listLicenseTemplates",
  991. "responses": {
  992. "200": {
  993. "$ref": "#/responses/LicenseTemplateList"
  994. }
  995. }
  996. }
  997. },
  998. "/licenses/{name}": {
  999. "get": {
  1000. "produces": [
  1001. "application/json"
  1002. ],
  1003. "tags": [
  1004. "miscellaneous"
  1005. ],
  1006. "summary": "Returns information about a license template",
  1007. "operationId": "getLicenseTemplateInfo",
  1008. "parameters": [
  1009. {
  1010. "type": "string",
  1011. "description": "name of the license",
  1012. "name": "name",
  1013. "in": "path",
  1014. "required": true
  1015. }
  1016. ],
  1017. "responses": {
  1018. "200": {
  1019. "$ref": "#/responses/LicenseTemplateInfo"
  1020. },
  1021. "404": {
  1022. "$ref": "#/responses/notFound"
  1023. }
  1024. }
  1025. }
  1026. },
  1027. "/markdown": {
  1028. "post": {
  1029. "consumes": [
  1030. "application/json"
  1031. ],
  1032. "produces": [
  1033. "text/html"
  1034. ],
  1035. "tags": [
  1036. "miscellaneous"
  1037. ],
  1038. "summary": "Render a markdown document as HTML",
  1039. "operationId": "renderMarkdown",
  1040. "parameters": [
  1041. {
  1042. "name": "body",
  1043. "in": "body",
  1044. "schema": {
  1045. "$ref": "#/definitions/MarkdownOption"
  1046. }
  1047. }
  1048. ],
  1049. "responses": {
  1050. "200": {
  1051. "$ref": "#/responses/MarkdownRender"
  1052. },
  1053. "422": {
  1054. "$ref": "#/responses/validationError"
  1055. }
  1056. }
  1057. }
  1058. },
  1059. "/markdown/raw": {
  1060. "post": {
  1061. "consumes": [
  1062. "text/plain"
  1063. ],
  1064. "produces": [
  1065. "text/html"
  1066. ],
  1067. "tags": [
  1068. "miscellaneous"
  1069. ],
  1070. "summary": "Render raw markdown as HTML",
  1071. "operationId": "renderMarkdownRaw",
  1072. "parameters": [
  1073. {
  1074. "description": "Request body to render",
  1075. "name": "body",
  1076. "in": "body",
  1077. "required": true,
  1078. "schema": {
  1079. "type": "string"
  1080. }
  1081. }
  1082. ],
  1083. "responses": {
  1084. "200": {
  1085. "$ref": "#/responses/MarkdownRender"
  1086. },
  1087. "422": {
  1088. "$ref": "#/responses/validationError"
  1089. }
  1090. }
  1091. }
  1092. },
  1093. "/markup": {
  1094. "post": {
  1095. "consumes": [
  1096. "application/json"
  1097. ],
  1098. "produces": [
  1099. "text/html"
  1100. ],
  1101. "tags": [
  1102. "miscellaneous"
  1103. ],
  1104. "summary": "Render a markup document as HTML",
  1105. "operationId": "renderMarkup",
  1106. "parameters": [
  1107. {
  1108. "name": "body",
  1109. "in": "body",
  1110. "schema": {
  1111. "$ref": "#/definitions/MarkupOption"
  1112. }
  1113. }
  1114. ],
  1115. "responses": {
  1116. "200": {
  1117. "$ref": "#/responses/MarkupRender"
  1118. },
  1119. "422": {
  1120. "$ref": "#/responses/validationError"
  1121. }
  1122. }
  1123. }
  1124. },
  1125. "/nodeinfo": {
  1126. "get": {
  1127. "produces": [
  1128. "application/json"
  1129. ],
  1130. "tags": [
  1131. "miscellaneous"
  1132. ],
  1133. "summary": "Returns the nodeinfo of the Gitea application",
  1134. "operationId": "getNodeInfo",
  1135. "responses": {
  1136. "200": {
  1137. "$ref": "#/responses/NodeInfo"
  1138. }
  1139. }
  1140. }
  1141. },
  1142. "/notifications": {
  1143. "get": {
  1144. "consumes": [
  1145. "application/json"
  1146. ],
  1147. "produces": [
  1148. "application/json"
  1149. ],
  1150. "tags": [
  1151. "notification"
  1152. ],
  1153. "summary": "List users's notification threads",
  1154. "operationId": "notifyGetList",
  1155. "parameters": [
  1156. {
  1157. "type": "boolean",
  1158. "description": "If true, show notifications marked as read. Default value is false",
  1159. "name": "all",
  1160. "in": "query"
  1161. },
  1162. {
  1163. "type": "array",
  1164. "items": {
  1165. "type": "string"
  1166. },
  1167. "collectionFormat": "multi",
  1168. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
  1169. "name": "status-types",
  1170. "in": "query"
  1171. },
  1172. {
  1173. "type": "array",
  1174. "items": {
  1175. "enum": [
  1176. "issue",
  1177. "pull",
  1178. "commit",
  1179. "repository"
  1180. ],
  1181. "type": "string"
  1182. },
  1183. "collectionFormat": "multi",
  1184. "description": "filter notifications by subject type",
  1185. "name": "subject-type",
  1186. "in": "query"
  1187. },
  1188. {
  1189. "type": "string",
  1190. "format": "date-time",
  1191. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  1192. "name": "since",
  1193. "in": "query"
  1194. },
  1195. {
  1196. "type": "string",
  1197. "format": "date-time",
  1198. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  1199. "name": "before",
  1200. "in": "query"
  1201. },
  1202. {
  1203. "type": "integer",
  1204. "description": "page number of results to return (1-based)",
  1205. "name": "page",
  1206. "in": "query"
  1207. },
  1208. {
  1209. "type": "integer",
  1210. "description": "page size of results",
  1211. "name": "limit",
  1212. "in": "query"
  1213. }
  1214. ],
  1215. "responses": {
  1216. "200": {
  1217. "$ref": "#/responses/NotificationThreadList"
  1218. }
  1219. }
  1220. },
  1221. "put": {
  1222. "consumes": [
  1223. "application/json"
  1224. ],
  1225. "produces": [
  1226. "application/json"
  1227. ],
  1228. "tags": [
  1229. "notification"
  1230. ],
  1231. "summary": "Mark notification threads as read, pinned or unread",
  1232. "operationId": "notifyReadList",
  1233. "parameters": [
  1234. {
  1235. "type": "string",
  1236. "format": "date-time",
  1237. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  1238. "name": "last_read_at",
  1239. "in": "query"
  1240. },
  1241. {
  1242. "type": "string",
  1243. "description": "If true, mark all notifications on this repo. Default value is false",
  1244. "name": "all",
  1245. "in": "query"
  1246. },
  1247. {
  1248. "type": "array",
  1249. "items": {
  1250. "type": "string"
  1251. },
  1252. "collectionFormat": "multi",
  1253. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  1254. "name": "status-types",
  1255. "in": "query"
  1256. },
  1257. {
  1258. "type": "string",
  1259. "description": "Status to mark notifications as, Defaults to read.",
  1260. "name": "to-status",
  1261. "in": "query"
  1262. }
  1263. ],
  1264. "responses": {
  1265. "205": {
  1266. "$ref": "#/responses/NotificationThreadList"
  1267. }
  1268. }
  1269. }
  1270. },
  1271. "/notifications/new": {
  1272. "get": {
  1273. "tags": [
  1274. "notification"
  1275. ],
  1276. "summary": "Check if unread notifications exist",
  1277. "operationId": "notifyNewAvailable",
  1278. "responses": {
  1279. "200": {
  1280. "$ref": "#/responses/NotificationCount"
  1281. }
  1282. }
  1283. }
  1284. },
  1285. "/notifications/threads/{id}": {
  1286. "get": {
  1287. "consumes": [
  1288. "application/json"
  1289. ],
  1290. "produces": [
  1291. "application/json"
  1292. ],
  1293. "tags": [
  1294. "notification"
  1295. ],
  1296. "summary": "Get notification thread by ID",
  1297. "operationId": "notifyGetThread",
  1298. "parameters": [
  1299. {
  1300. "type": "string",
  1301. "description": "id of notification thread",
  1302. "name": "id",
  1303. "in": "path",
  1304. "required": true
  1305. }
  1306. ],
  1307. "responses": {
  1308. "200": {
  1309. "$ref": "#/responses/NotificationThread"
  1310. },
  1311. "403": {
  1312. "$ref": "#/responses/forbidden"
  1313. },
  1314. "404": {
  1315. "$ref": "#/responses/notFound"
  1316. }
  1317. }
  1318. },
  1319. "patch": {
  1320. "consumes": [
  1321. "application/json"
  1322. ],
  1323. "produces": [
  1324. "application/json"
  1325. ],
  1326. "tags": [
  1327. "notification"
  1328. ],
  1329. "summary": "Mark notification thread as read by ID",
  1330. "operationId": "notifyReadThread",
  1331. "parameters": [
  1332. {
  1333. "type": "string",
  1334. "description": "id of notification thread",
  1335. "name": "id",
  1336. "in": "path",
  1337. "required": true
  1338. },
  1339. {
  1340. "type": "string",
  1341. "default": "read",
  1342. "description": "Status to mark notifications as",
  1343. "name": "to-status",
  1344. "in": "query"
  1345. }
  1346. ],
  1347. "responses": {
  1348. "205": {
  1349. "$ref": "#/responses/NotificationThread"
  1350. },
  1351. "403": {
  1352. "$ref": "#/responses/forbidden"
  1353. },
  1354. "404": {
  1355. "$ref": "#/responses/notFound"
  1356. }
  1357. }
  1358. }
  1359. },
  1360. "/org/{org}/repos": {
  1361. "post": {
  1362. "consumes": [
  1363. "application/json"
  1364. ],
  1365. "produces": [
  1366. "application/json"
  1367. ],
  1368. "tags": [
  1369. "organization"
  1370. ],
  1371. "summary": "Create a repository in an organization",
  1372. "operationId": "createOrgRepoDeprecated",
  1373. "deprecated": true,
  1374. "parameters": [
  1375. {
  1376. "type": "string",
  1377. "description": "name of organization",
  1378. "name": "org",
  1379. "in": "path",
  1380. "required": true
  1381. },
  1382. {
  1383. "name": "body",
  1384. "in": "body",
  1385. "schema": {
  1386. "$ref": "#/definitions/CreateRepoOption"
  1387. }
  1388. }
  1389. ],
  1390. "responses": {
  1391. "201": {
  1392. "$ref": "#/responses/Repository"
  1393. },
  1394. "403": {
  1395. "$ref": "#/responses/forbidden"
  1396. },
  1397. "404": {
  1398. "$ref": "#/responses/notFound"
  1399. },
  1400. "422": {
  1401. "$ref": "#/responses/validationError"
  1402. }
  1403. }
  1404. }
  1405. },
  1406. "/orgs": {
  1407. "get": {
  1408. "produces": [
  1409. "application/json"
  1410. ],
  1411. "tags": [
  1412. "organization"
  1413. ],
  1414. "summary": "Get list of organizations",
  1415. "operationId": "orgGetAll",
  1416. "parameters": [
  1417. {
  1418. "type": "integer",
  1419. "description": "page number of results to return (1-based)",
  1420. "name": "page",
  1421. "in": "query"
  1422. },
  1423. {
  1424. "type": "integer",
  1425. "description": "page size of results",
  1426. "name": "limit",
  1427. "in": "query"
  1428. }
  1429. ],
  1430. "responses": {
  1431. "200": {
  1432. "$ref": "#/responses/OrganizationList"
  1433. }
  1434. }
  1435. },
  1436. "post": {
  1437. "consumes": [
  1438. "application/json"
  1439. ],
  1440. "produces": [
  1441. "application/json"
  1442. ],
  1443. "tags": [
  1444. "organization"
  1445. ],
  1446. "summary": "Create an organization",
  1447. "operationId": "orgCreate",
  1448. "parameters": [
  1449. {
  1450. "name": "organization",
  1451. "in": "body",
  1452. "required": true,
  1453. "schema": {
  1454. "$ref": "#/definitions/CreateOrgOption"
  1455. }
  1456. }
  1457. ],
  1458. "responses": {
  1459. "201": {
  1460. "$ref": "#/responses/Organization"
  1461. },
  1462. "403": {
  1463. "$ref": "#/responses/forbidden"
  1464. },
  1465. "422": {
  1466. "$ref": "#/responses/validationError"
  1467. }
  1468. }
  1469. }
  1470. },
  1471. "/orgs/{org}": {
  1472. "get": {
  1473. "produces": [
  1474. "application/json"
  1475. ],
  1476. "tags": [
  1477. "organization"
  1478. ],
  1479. "summary": "Get an organization",
  1480. "operationId": "orgGet",
  1481. "parameters": [
  1482. {
  1483. "type": "string",
  1484. "description": "name of the organization to get",
  1485. "name": "org",
  1486. "in": "path",
  1487. "required": true
  1488. }
  1489. ],
  1490. "responses": {
  1491. "200": {
  1492. "$ref": "#/responses/Organization"
  1493. },
  1494. "404": {
  1495. "$ref": "#/responses/notFound"
  1496. }
  1497. }
  1498. },
  1499. "delete": {
  1500. "produces": [
  1501. "application/json"
  1502. ],
  1503. "tags": [
  1504. "organization"
  1505. ],
  1506. "summary": "Delete an organization",
  1507. "operationId": "orgDelete",
  1508. "parameters": [
  1509. {
  1510. "type": "string",
  1511. "description": "organization that is to be deleted",
  1512. "name": "org",
  1513. "in": "path",
  1514. "required": true
  1515. }
  1516. ],
  1517. "responses": {
  1518. "204": {
  1519. "$ref": "#/responses/empty"
  1520. },
  1521. "404": {
  1522. "$ref": "#/responses/notFound"
  1523. }
  1524. }
  1525. },
  1526. "patch": {
  1527. "consumes": [
  1528. "application/json"
  1529. ],
  1530. "produces": [
  1531. "application/json"
  1532. ],
  1533. "tags": [
  1534. "organization"
  1535. ],
  1536. "summary": "Edit an organization",
  1537. "operationId": "orgEdit",
  1538. "parameters": [
  1539. {
  1540. "type": "string",
  1541. "description": "name of the organization to edit",
  1542. "name": "org",
  1543. "in": "path",
  1544. "required": true
  1545. },
  1546. {
  1547. "name": "body",
  1548. "in": "body",
  1549. "required": true,
  1550. "schema": {
  1551. "$ref": "#/definitions/EditOrgOption"
  1552. }
  1553. }
  1554. ],
  1555. "responses": {
  1556. "200": {
  1557. "$ref": "#/responses/Organization"
  1558. },
  1559. "404": {
  1560. "$ref": "#/responses/notFound"
  1561. }
  1562. }
  1563. }
  1564. },
  1565. "/orgs/{org}/actions/secrets": {
  1566. "get": {
  1567. "produces": [
  1568. "application/json"
  1569. ],
  1570. "tags": [
  1571. "organization"
  1572. ],
  1573. "summary": "List an organization's actions secrets",
  1574. "operationId": "orgListActionsSecrets",
  1575. "parameters": [
  1576. {
  1577. "type": "string",
  1578. "description": "name of the organization",
  1579. "name": "org",
  1580. "in": "path",
  1581. "required": true
  1582. },
  1583. {
  1584. "type": "integer",
  1585. "description": "page number of results to return (1-based)",
  1586. "name": "page",
  1587. "in": "query"
  1588. },
  1589. {
  1590. "type": "integer",
  1591. "description": "page size of results",
  1592. "name": "limit",
  1593. "in": "query"
  1594. }
  1595. ],
  1596. "responses": {
  1597. "200": {
  1598. "$ref": "#/responses/SecretList"
  1599. },
  1600. "404": {
  1601. "$ref": "#/responses/notFound"
  1602. }
  1603. }
  1604. }
  1605. },
  1606. "/orgs/{org}/actions/secrets/{secretname}": {
  1607. "put": {
  1608. "consumes": [
  1609. "application/json"
  1610. ],
  1611. "produces": [
  1612. "application/json"
  1613. ],
  1614. "tags": [
  1615. "organization"
  1616. ],
  1617. "summary": "Create or Update a secret value in an organization",
  1618. "operationId": "updateOrgSecret",
  1619. "parameters": [
  1620. {
  1621. "type": "string",
  1622. "description": "name of organization",
  1623. "name": "org",
  1624. "in": "path",
  1625. "required": true
  1626. },
  1627. {
  1628. "type": "string",
  1629. "description": "name of the secret",
  1630. "name": "secretname",
  1631. "in": "path",
  1632. "required": true
  1633. },
  1634. {
  1635. "name": "body",
  1636. "in": "body",
  1637. "schema": {
  1638. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  1639. }
  1640. }
  1641. ],
  1642. "responses": {
  1643. "201": {
  1644. "description": "response when creating a secret"
  1645. },
  1646. "204": {
  1647. "description": "response when updating a secret"
  1648. },
  1649. "400": {
  1650. "$ref": "#/responses/error"
  1651. },
  1652. "404": {
  1653. "$ref": "#/responses/notFound"
  1654. }
  1655. }
  1656. },
  1657. "delete": {
  1658. "consumes": [
  1659. "application/json"
  1660. ],
  1661. "produces": [
  1662. "application/json"
  1663. ],
  1664. "tags": [
  1665. "organization"
  1666. ],
  1667. "summary": "Delete a secret in an organization",
  1668. "operationId": "deleteOrgSecret",
  1669. "parameters": [
  1670. {
  1671. "type": "string",
  1672. "description": "name of organization",
  1673. "name": "org",
  1674. "in": "path",
  1675. "required": true
  1676. },
  1677. {
  1678. "type": "string",
  1679. "description": "name of the secret",
  1680. "name": "secretname",
  1681. "in": "path",
  1682. "required": true
  1683. }
  1684. ],
  1685. "responses": {
  1686. "204": {
  1687. "description": "delete one secret of the organization"
  1688. },
  1689. "400": {
  1690. "$ref": "#/responses/error"
  1691. },
  1692. "404": {
  1693. "$ref": "#/responses/notFound"
  1694. }
  1695. }
  1696. }
  1697. },
  1698. "/orgs/{org}/activities/feeds": {
  1699. "get": {
  1700. "produces": [
  1701. "application/json"
  1702. ],
  1703. "tags": [
  1704. "organization"
  1705. ],
  1706. "summary": "List an organization's activity feeds",
  1707. "operationId": "orgListActivityFeeds",
  1708. "parameters": [
  1709. {
  1710. "type": "string",
  1711. "description": "name of the org",
  1712. "name": "org",
  1713. "in": "path",
  1714. "required": true
  1715. },
  1716. {
  1717. "type": "string",
  1718. "format": "date",
  1719. "description": "the date of the activities to be found",
  1720. "name": "date",
  1721. "in": "query"
  1722. },
  1723. {
  1724. "type": "integer",
  1725. "description": "page number of results to return (1-based)",
  1726. "name": "page",
  1727. "in": "query"
  1728. },
  1729. {
  1730. "type": "integer",
  1731. "description": "page size of results",
  1732. "name": "limit",
  1733. "in": "query"
  1734. }
  1735. ],
  1736. "responses": {
  1737. "200": {
  1738. "$ref": "#/responses/ActivityFeedsList"
  1739. },
  1740. "404": {
  1741. "$ref": "#/responses/notFound"
  1742. }
  1743. }
  1744. }
  1745. },
  1746. "/orgs/{org}/avatar": {
  1747. "post": {
  1748. "produces": [
  1749. "application/json"
  1750. ],
  1751. "tags": [
  1752. "organization"
  1753. ],
  1754. "summary": "Update Avatar",
  1755. "operationId": "orgUpdateAvatar",
  1756. "parameters": [
  1757. {
  1758. "type": "string",
  1759. "description": "name of the organization",
  1760. "name": "org",
  1761. "in": "path",
  1762. "required": true
  1763. },
  1764. {
  1765. "name": "body",
  1766. "in": "body",
  1767. "schema": {
  1768. "$ref": "#/definitions/UpdateUserAvatarOption"
  1769. }
  1770. }
  1771. ],
  1772. "responses": {
  1773. "204": {
  1774. "$ref": "#/responses/empty"
  1775. },
  1776. "404": {
  1777. "$ref": "#/responses/notFound"
  1778. }
  1779. }
  1780. },
  1781. "delete": {
  1782. "produces": [
  1783. "application/json"
  1784. ],
  1785. "tags": [
  1786. "organization"
  1787. ],
  1788. "summary": "Delete Avatar",
  1789. "operationId": "orgDeleteAvatar",
  1790. "parameters": [
  1791. {
  1792. "type": "string",
  1793. "description": "name of the organization",
  1794. "name": "org",
  1795. "in": "path",
  1796. "required": true
  1797. }
  1798. ],
  1799. "responses": {
  1800. "204": {
  1801. "$ref": "#/responses/empty"
  1802. },
  1803. "404": {
  1804. "$ref": "#/responses/notFound"
  1805. }
  1806. }
  1807. }
  1808. },
  1809. "/orgs/{org}/hooks": {
  1810. "get": {
  1811. "produces": [
  1812. "application/json"
  1813. ],
  1814. "tags": [
  1815. "organization"
  1816. ],
  1817. "summary": "List an organization's webhooks",
  1818. "operationId": "orgListHooks",
  1819. "parameters": [
  1820. {
  1821. "type": "string",
  1822. "description": "name of the organization",
  1823. "name": "org",
  1824. "in": "path",
  1825. "required": true
  1826. },
  1827. {
  1828. "type": "integer",
  1829. "description": "page number of results to return (1-based)",
  1830. "name": "page",
  1831. "in": "query"
  1832. },
  1833. {
  1834. "type": "integer",
  1835. "description": "page size of results",
  1836. "name": "limit",
  1837. "in": "query"
  1838. }
  1839. ],
  1840. "responses": {
  1841. "200": {
  1842. "$ref": "#/responses/HookList"
  1843. },
  1844. "404": {
  1845. "$ref": "#/responses/notFound"
  1846. }
  1847. }
  1848. },
  1849. "post": {
  1850. "consumes": [
  1851. "application/json"
  1852. ],
  1853. "produces": [
  1854. "application/json"
  1855. ],
  1856. "tags": [
  1857. "organization"
  1858. ],
  1859. "summary": "Create a hook",
  1860. "operationId": "orgCreateHook",
  1861. "parameters": [
  1862. {
  1863. "type": "string",
  1864. "description": "name of the organization",
  1865. "name": "org",
  1866. "in": "path",
  1867. "required": true
  1868. },
  1869. {
  1870. "name": "body",
  1871. "in": "body",
  1872. "required": true,
  1873. "schema": {
  1874. "$ref": "#/definitions/CreateHookOption"
  1875. }
  1876. }
  1877. ],
  1878. "responses": {
  1879. "201": {
  1880. "$ref": "#/responses/Hook"
  1881. },
  1882. "404": {
  1883. "$ref": "#/responses/notFound"
  1884. }
  1885. }
  1886. }
  1887. },
  1888. "/orgs/{org}/hooks/{id}": {
  1889. "get": {
  1890. "produces": [
  1891. "application/json"
  1892. ],
  1893. "tags": [
  1894. "organization"
  1895. ],
  1896. "summary": "Get a hook",
  1897. "operationId": "orgGetHook",
  1898. "parameters": [
  1899. {
  1900. "type": "string",
  1901. "description": "name of the organization",
  1902. "name": "org",
  1903. "in": "path",
  1904. "required": true
  1905. },
  1906. {
  1907. "type": "integer",
  1908. "format": "int64",
  1909. "description": "id of the hook to get",
  1910. "name": "id",
  1911. "in": "path",
  1912. "required": true
  1913. }
  1914. ],
  1915. "responses": {
  1916. "200": {
  1917. "$ref": "#/responses/Hook"
  1918. },
  1919. "404": {
  1920. "$ref": "#/responses/notFound"
  1921. }
  1922. }
  1923. },
  1924. "delete": {
  1925. "produces": [
  1926. "application/json"
  1927. ],
  1928. "tags": [
  1929. "organization"
  1930. ],
  1931. "summary": "Delete a hook",
  1932. "operationId": "orgDeleteHook",
  1933. "parameters": [
  1934. {
  1935. "type": "string",
  1936. "description": "name of the organization",
  1937. "name": "org",
  1938. "in": "path",
  1939. "required": true
  1940. },
  1941. {
  1942. "type": "integer",
  1943. "format": "int64",
  1944. "description": "id of the hook to delete",
  1945. "name": "id",
  1946. "in": "path",
  1947. "required": true
  1948. }
  1949. ],
  1950. "responses": {
  1951. "204": {
  1952. "$ref": "#/responses/empty"
  1953. },
  1954. "404": {
  1955. "$ref": "#/responses/notFound"
  1956. }
  1957. }
  1958. },
  1959. "patch": {
  1960. "consumes": [
  1961. "application/json"
  1962. ],
  1963. "produces": [
  1964. "application/json"
  1965. ],
  1966. "tags": [
  1967. "organization"
  1968. ],
  1969. "summary": "Update a hook",
  1970. "operationId": "orgEditHook",
  1971. "parameters": [
  1972. {
  1973. "type": "string",
  1974. "description": "name of the organization",
  1975. "name": "org",
  1976. "in": "path",
  1977. "required": true
  1978. },
  1979. {
  1980. "type": "integer",
  1981. "format": "int64",
  1982. "description": "id of the hook to update",
  1983. "name": "id",
  1984. "in": "path",
  1985. "required": true
  1986. },
  1987. {
  1988. "name": "body",
  1989. "in": "body",
  1990. "schema": {
  1991. "$ref": "#/definitions/EditHookOption"
  1992. }
  1993. }
  1994. ],
  1995. "responses": {
  1996. "200": {
  1997. "$ref": "#/responses/Hook"
  1998. },
  1999. "404": {
  2000. "$ref": "#/responses/notFound"
  2001. }
  2002. }
  2003. }
  2004. },
  2005. "/orgs/{org}/labels": {
  2006. "get": {
  2007. "produces": [
  2008. "application/json"
  2009. ],
  2010. "tags": [
  2011. "organization"
  2012. ],
  2013. "summary": "List an organization's labels",
  2014. "operationId": "orgListLabels",
  2015. "parameters": [
  2016. {
  2017. "type": "string",
  2018. "description": "name of the organization",
  2019. "name": "org",
  2020. "in": "path",
  2021. "required": true
  2022. },
  2023. {
  2024. "type": "integer",
  2025. "description": "page number of results to return (1-based)",
  2026. "name": "page",
  2027. "in": "query"
  2028. },
  2029. {
  2030. "type": "integer",
  2031. "description": "page size of results",
  2032. "name": "limit",
  2033. "in": "query"
  2034. }
  2035. ],
  2036. "responses": {
  2037. "200": {
  2038. "$ref": "#/responses/LabelList"
  2039. },
  2040. "404": {
  2041. "$ref": "#/responses/notFound"
  2042. }
  2043. }
  2044. },
  2045. "post": {
  2046. "consumes": [
  2047. "application/json"
  2048. ],
  2049. "produces": [
  2050. "application/json"
  2051. ],
  2052. "tags": [
  2053. "organization"
  2054. ],
  2055. "summary": "Create a label for an organization",
  2056. "operationId": "orgCreateLabel",
  2057. "parameters": [
  2058. {
  2059. "type": "string",
  2060. "description": "name of the organization",
  2061. "name": "org",
  2062. "in": "path",
  2063. "required": true
  2064. },
  2065. {
  2066. "name": "body",
  2067. "in": "body",
  2068. "schema": {
  2069. "$ref": "#/definitions/CreateLabelOption"
  2070. }
  2071. }
  2072. ],
  2073. "responses": {
  2074. "201": {
  2075. "$ref": "#/responses/Label"
  2076. },
  2077. "404": {
  2078. "$ref": "#/responses/notFound"
  2079. },
  2080. "422": {
  2081. "$ref": "#/responses/validationError"
  2082. }
  2083. }
  2084. }
  2085. },
  2086. "/orgs/{org}/labels/{id}": {
  2087. "get": {
  2088. "produces": [
  2089. "application/json"
  2090. ],
  2091. "tags": [
  2092. "organization"
  2093. ],
  2094. "summary": "Get a single label",
  2095. "operationId": "orgGetLabel",
  2096. "parameters": [
  2097. {
  2098. "type": "string",
  2099. "description": "name of the organization",
  2100. "name": "org",
  2101. "in": "path",
  2102. "required": true
  2103. },
  2104. {
  2105. "type": "integer",
  2106. "format": "int64",
  2107. "description": "id of the label to get",
  2108. "name": "id",
  2109. "in": "path",
  2110. "required": true
  2111. }
  2112. ],
  2113. "responses": {
  2114. "200": {
  2115. "$ref": "#/responses/Label"
  2116. },
  2117. "404": {
  2118. "$ref": "#/responses/notFound"
  2119. }
  2120. }
  2121. },
  2122. "delete": {
  2123. "tags": [
  2124. "organization"
  2125. ],
  2126. "summary": "Delete a label",
  2127. "operationId": "orgDeleteLabel",
  2128. "parameters": [
  2129. {
  2130. "type": "string",
  2131. "description": "name of the organization",
  2132. "name": "org",
  2133. "in": "path",
  2134. "required": true
  2135. },
  2136. {
  2137. "type": "integer",
  2138. "format": "int64",
  2139. "description": "id of the label to delete",
  2140. "name": "id",
  2141. "in": "path",
  2142. "required": true
  2143. }
  2144. ],
  2145. "responses": {
  2146. "204": {
  2147. "$ref": "#/responses/empty"
  2148. },
  2149. "404": {
  2150. "$ref": "#/responses/notFound"
  2151. }
  2152. }
  2153. },
  2154. "patch": {
  2155. "consumes": [
  2156. "application/json"
  2157. ],
  2158. "produces": [
  2159. "application/json"
  2160. ],
  2161. "tags": [
  2162. "organization"
  2163. ],
  2164. "summary": "Update a label",
  2165. "operationId": "orgEditLabel",
  2166. "parameters": [
  2167. {
  2168. "type": "string",
  2169. "description": "name of the organization",
  2170. "name": "org",
  2171. "in": "path",
  2172. "required": true
  2173. },
  2174. {
  2175. "type": "integer",
  2176. "format": "int64",
  2177. "description": "id of the label to edit",
  2178. "name": "id",
  2179. "in": "path",
  2180. "required": true
  2181. },
  2182. {
  2183. "name": "body",
  2184. "in": "body",
  2185. "schema": {
  2186. "$ref": "#/definitions/EditLabelOption"
  2187. }
  2188. }
  2189. ],
  2190. "responses": {
  2191. "200": {
  2192. "$ref": "#/responses/Label"
  2193. },
  2194. "404": {
  2195. "$ref": "#/responses/notFound"
  2196. },
  2197. "422": {
  2198. "$ref": "#/responses/validationError"
  2199. }
  2200. }
  2201. }
  2202. },
  2203. "/orgs/{org}/members": {
  2204. "get": {
  2205. "produces": [
  2206. "application/json"
  2207. ],
  2208. "tags": [
  2209. "organization"
  2210. ],
  2211. "summary": "List an organization's members",
  2212. "operationId": "orgListMembers",
  2213. "parameters": [
  2214. {
  2215. "type": "string",
  2216. "description": "name of the organization",
  2217. "name": "org",
  2218. "in": "path",
  2219. "required": true
  2220. },
  2221. {
  2222. "type": "integer",
  2223. "description": "page number of results to return (1-based)",
  2224. "name": "page",
  2225. "in": "query"
  2226. },
  2227. {
  2228. "type": "integer",
  2229. "description": "page size of results",
  2230. "name": "limit",
  2231. "in": "query"
  2232. }
  2233. ],
  2234. "responses": {
  2235. "200": {
  2236. "$ref": "#/responses/UserList"
  2237. },
  2238. "404": {
  2239. "$ref": "#/responses/notFound"
  2240. }
  2241. }
  2242. }
  2243. },
  2244. "/orgs/{org}/members/{username}": {
  2245. "get": {
  2246. "tags": [
  2247. "organization"
  2248. ],
  2249. "summary": "Check if a user is a member of an organization",
  2250. "operationId": "orgIsMember",
  2251. "parameters": [
  2252. {
  2253. "type": "string",
  2254. "description": "name of the organization",
  2255. "name": "org",
  2256. "in": "path",
  2257. "required": true
  2258. },
  2259. {
  2260. "type": "string",
  2261. "description": "username of the user",
  2262. "name": "username",
  2263. "in": "path",
  2264. "required": true
  2265. }
  2266. ],
  2267. "responses": {
  2268. "204": {
  2269. "description": "user is a member"
  2270. },
  2271. "303": {
  2272. "description": "redirection to /orgs/{org}/public_members/{username}"
  2273. },
  2274. "404": {
  2275. "description": "user is not a member"
  2276. }
  2277. }
  2278. },
  2279. "delete": {
  2280. "produces": [
  2281. "application/json"
  2282. ],
  2283. "tags": [
  2284. "organization"
  2285. ],
  2286. "summary": "Remove a member from an organization",
  2287. "operationId": "orgDeleteMember",
  2288. "parameters": [
  2289. {
  2290. "type": "string",
  2291. "description": "name of the organization",
  2292. "name": "org",
  2293. "in": "path",
  2294. "required": true
  2295. },
  2296. {
  2297. "type": "string",
  2298. "description": "username of the user",
  2299. "name": "username",
  2300. "in": "path",
  2301. "required": true
  2302. }
  2303. ],
  2304. "responses": {
  2305. "204": {
  2306. "description": "member removed"
  2307. },
  2308. "404": {
  2309. "$ref": "#/responses/notFound"
  2310. }
  2311. }
  2312. }
  2313. },
  2314. "/orgs/{org}/public_members": {
  2315. "get": {
  2316. "produces": [
  2317. "application/json"
  2318. ],
  2319. "tags": [
  2320. "organization"
  2321. ],
  2322. "summary": "List an organization's public members",
  2323. "operationId": "orgListPublicMembers",
  2324. "parameters": [
  2325. {
  2326. "type": "string",
  2327. "description": "name of the organization",
  2328. "name": "org",
  2329. "in": "path",
  2330. "required": true
  2331. },
  2332. {
  2333. "type": "integer",
  2334. "description": "page number of results to return (1-based)",
  2335. "name": "page",
  2336. "in": "query"
  2337. },
  2338. {
  2339. "type": "integer",
  2340. "description": "page size of results",
  2341. "name": "limit",
  2342. "in": "query"
  2343. }
  2344. ],
  2345. "responses": {
  2346. "200": {
  2347. "$ref": "#/responses/UserList"
  2348. },
  2349. "404": {
  2350. "$ref": "#/responses/notFound"
  2351. }
  2352. }
  2353. }
  2354. },
  2355. "/orgs/{org}/public_members/{username}": {
  2356. "get": {
  2357. "tags": [
  2358. "organization"
  2359. ],
  2360. "summary": "Check if a user is a public member of an organization",
  2361. "operationId": "orgIsPublicMember",
  2362. "parameters": [
  2363. {
  2364. "type": "string",
  2365. "description": "name of the organization",
  2366. "name": "org",
  2367. "in": "path",
  2368. "required": true
  2369. },
  2370. {
  2371. "type": "string",
  2372. "description": "username of the user",
  2373. "name": "username",
  2374. "in": "path",
  2375. "required": true
  2376. }
  2377. ],
  2378. "responses": {
  2379. "204": {
  2380. "description": "user is a public member"
  2381. },
  2382. "404": {
  2383. "description": "user is not a public member"
  2384. }
  2385. }
  2386. },
  2387. "put": {
  2388. "produces": [
  2389. "application/json"
  2390. ],
  2391. "tags": [
  2392. "organization"
  2393. ],
  2394. "summary": "Publicize a user's membership",
  2395. "operationId": "orgPublicizeMember",
  2396. "parameters": [
  2397. {
  2398. "type": "string",
  2399. "description": "name of the organization",
  2400. "name": "org",
  2401. "in": "path",
  2402. "required": true
  2403. },
  2404. {
  2405. "type": "string",
  2406. "description": "username of the user",
  2407. "name": "username",
  2408. "in": "path",
  2409. "required": true
  2410. }
  2411. ],
  2412. "responses": {
  2413. "204": {
  2414. "description": "membership publicized"
  2415. },
  2416. "403": {
  2417. "$ref": "#/responses/forbidden"
  2418. },
  2419. "404": {
  2420. "$ref": "#/responses/notFound"
  2421. }
  2422. }
  2423. },
  2424. "delete": {
  2425. "produces": [
  2426. "application/json"
  2427. ],
  2428. "tags": [
  2429. "organization"
  2430. ],
  2431. "summary": "Conceal a user's membership",
  2432. "operationId": "orgConcealMember",
  2433. "parameters": [
  2434. {
  2435. "type": "string",
  2436. "description": "name of the organization",
  2437. "name": "org",
  2438. "in": "path",
  2439. "required": true
  2440. },
  2441. {
  2442. "type": "string",
  2443. "description": "username of the user",
  2444. "name": "username",
  2445. "in": "path",
  2446. "required": true
  2447. }
  2448. ],
  2449. "responses": {
  2450. "204": {
  2451. "$ref": "#/responses/empty"
  2452. },
  2453. "403": {
  2454. "$ref": "#/responses/forbidden"
  2455. },
  2456. "404": {
  2457. "$ref": "#/responses/notFound"
  2458. }
  2459. }
  2460. }
  2461. },
  2462. "/orgs/{org}/repos": {
  2463. "get": {
  2464. "produces": [
  2465. "application/json"
  2466. ],
  2467. "tags": [
  2468. "organization"
  2469. ],
  2470. "summary": "List an organization's repos",
  2471. "operationId": "orgListRepos",
  2472. "parameters": [
  2473. {
  2474. "type": "string",
  2475. "description": "name of the organization",
  2476. "name": "org",
  2477. "in": "path",
  2478. "required": true
  2479. },
  2480. {
  2481. "type": "integer",
  2482. "description": "page number of results to return (1-based)",
  2483. "name": "page",
  2484. "in": "query"
  2485. },
  2486. {
  2487. "type": "integer",
  2488. "description": "page size of results",
  2489. "name": "limit",
  2490. "in": "query"
  2491. }
  2492. ],
  2493. "responses": {
  2494. "200": {
  2495. "$ref": "#/responses/RepositoryList"
  2496. },
  2497. "404": {
  2498. "$ref": "#/responses/notFound"
  2499. }
  2500. }
  2501. },
  2502. "post": {
  2503. "consumes": [
  2504. "application/json"
  2505. ],
  2506. "produces": [
  2507. "application/json"
  2508. ],
  2509. "tags": [
  2510. "organization"
  2511. ],
  2512. "summary": "Create a repository in an organization",
  2513. "operationId": "createOrgRepo",
  2514. "parameters": [
  2515. {
  2516. "type": "string",
  2517. "description": "name of organization",
  2518. "name": "org",
  2519. "in": "path",
  2520. "required": true
  2521. },
  2522. {
  2523. "name": "body",
  2524. "in": "body",
  2525. "schema": {
  2526. "$ref": "#/definitions/CreateRepoOption"
  2527. }
  2528. }
  2529. ],
  2530. "responses": {
  2531. "201": {
  2532. "$ref": "#/responses/Repository"
  2533. },
  2534. "400": {
  2535. "$ref": "#/responses/error"
  2536. },
  2537. "403": {
  2538. "$ref": "#/responses/forbidden"
  2539. },
  2540. "404": {
  2541. "$ref": "#/responses/notFound"
  2542. }
  2543. }
  2544. }
  2545. },
  2546. "/orgs/{org}/teams": {
  2547. "get": {
  2548. "produces": [
  2549. "application/json"
  2550. ],
  2551. "tags": [
  2552. "organization"
  2553. ],
  2554. "summary": "List an organization's teams",
  2555. "operationId": "orgListTeams",
  2556. "parameters": [
  2557. {
  2558. "type": "string",
  2559. "description": "name of the organization",
  2560. "name": "org",
  2561. "in": "path",
  2562. "required": true
  2563. },
  2564. {
  2565. "type": "integer",
  2566. "description": "page number of results to return (1-based)",
  2567. "name": "page",
  2568. "in": "query"
  2569. },
  2570. {
  2571. "type": "integer",
  2572. "description": "page size of results",
  2573. "name": "limit",
  2574. "in": "query"
  2575. }
  2576. ],
  2577. "responses": {
  2578. "200": {
  2579. "$ref": "#/responses/TeamList"
  2580. },
  2581. "404": {
  2582. "$ref": "#/responses/notFound"
  2583. }
  2584. }
  2585. },
  2586. "post": {
  2587. "consumes": [
  2588. "application/json"
  2589. ],
  2590. "produces": [
  2591. "application/json"
  2592. ],
  2593. "tags": [
  2594. "organization"
  2595. ],
  2596. "summary": "Create a team",
  2597. "operationId": "orgCreateTeam",
  2598. "parameters": [
  2599. {
  2600. "type": "string",
  2601. "description": "name of the organization",
  2602. "name": "org",
  2603. "in": "path",
  2604. "required": true
  2605. },
  2606. {
  2607. "name": "body",
  2608. "in": "body",
  2609. "schema": {
  2610. "$ref": "#/definitions/CreateTeamOption"
  2611. }
  2612. }
  2613. ],
  2614. "responses": {
  2615. "201": {
  2616. "$ref": "#/responses/Team"
  2617. },
  2618. "404": {
  2619. "$ref": "#/responses/notFound"
  2620. },
  2621. "422": {
  2622. "$ref": "#/responses/validationError"
  2623. }
  2624. }
  2625. }
  2626. },
  2627. "/orgs/{org}/teams/search": {
  2628. "get": {
  2629. "produces": [
  2630. "application/json"
  2631. ],
  2632. "tags": [
  2633. "organization"
  2634. ],
  2635. "summary": "Search for teams within an organization",
  2636. "operationId": "teamSearch",
  2637. "parameters": [
  2638. {
  2639. "type": "string",
  2640. "description": "name of the organization",
  2641. "name": "org",
  2642. "in": "path",
  2643. "required": true
  2644. },
  2645. {
  2646. "type": "string",
  2647. "description": "keywords to search",
  2648. "name": "q",
  2649. "in": "query"
  2650. },
  2651. {
  2652. "type": "boolean",
  2653. "description": "include search within team description (defaults to true)",
  2654. "name": "include_desc",
  2655. "in": "query"
  2656. },
  2657. {
  2658. "type": "integer",
  2659. "description": "page number of results to return (1-based)",
  2660. "name": "page",
  2661. "in": "query"
  2662. },
  2663. {
  2664. "type": "integer",
  2665. "description": "page size of results",
  2666. "name": "limit",
  2667. "in": "query"
  2668. }
  2669. ],
  2670. "responses": {
  2671. "200": {
  2672. "description": "SearchResults of a successful search",
  2673. "schema": {
  2674. "type": "object",
  2675. "properties": {
  2676. "data": {
  2677. "type": "array",
  2678. "items": {
  2679. "$ref": "#/definitions/Team"
  2680. }
  2681. },
  2682. "ok": {
  2683. "type": "boolean"
  2684. }
  2685. }
  2686. }
  2687. },
  2688. "404": {
  2689. "$ref": "#/responses/notFound"
  2690. }
  2691. }
  2692. }
  2693. },
  2694. "/packages/{owner}": {
  2695. "get": {
  2696. "produces": [
  2697. "application/json"
  2698. ],
  2699. "tags": [
  2700. "package"
  2701. ],
  2702. "summary": "Gets all packages of an owner",
  2703. "operationId": "listPackages",
  2704. "parameters": [
  2705. {
  2706. "type": "string",
  2707. "description": "owner of the packages",
  2708. "name": "owner",
  2709. "in": "path",
  2710. "required": true
  2711. },
  2712. {
  2713. "type": "integer",
  2714. "description": "page number of results to return (1-based)",
  2715. "name": "page",
  2716. "in": "query"
  2717. },
  2718. {
  2719. "type": "integer",
  2720. "description": "page size of results",
  2721. "name": "limit",
  2722. "in": "query"
  2723. },
  2724. {
  2725. "enum": [
  2726. "alpine",
  2727. "cargo",
  2728. "chef",
  2729. "composer",
  2730. "conan",
  2731. "conda",
  2732. "container",
  2733. "cran",
  2734. "debian",
  2735. "generic",
  2736. "go",
  2737. "helm",
  2738. "maven",
  2739. "npm",
  2740. "nuget",
  2741. "pub",
  2742. "pypi",
  2743. "rpm",
  2744. "rubygems",
  2745. "swift",
  2746. "vagrant"
  2747. ],
  2748. "type": "string",
  2749. "description": "package type filter",
  2750. "name": "type",
  2751. "in": "query"
  2752. },
  2753. {
  2754. "type": "string",
  2755. "description": "name filter",
  2756. "name": "q",
  2757. "in": "query"
  2758. }
  2759. ],
  2760. "responses": {
  2761. "200": {
  2762. "$ref": "#/responses/PackageList"
  2763. },
  2764. "404": {
  2765. "$ref": "#/responses/notFound"
  2766. }
  2767. }
  2768. }
  2769. },
  2770. "/packages/{owner}/{type}/{name}/{version}": {
  2771. "get": {
  2772. "produces": [
  2773. "application/json"
  2774. ],
  2775. "tags": [
  2776. "package"
  2777. ],
  2778. "summary": "Gets a package",
  2779. "operationId": "getPackage",
  2780. "parameters": [
  2781. {
  2782. "type": "string",
  2783. "description": "owner of the package",
  2784. "name": "owner",
  2785. "in": "path",
  2786. "required": true
  2787. },
  2788. {
  2789. "type": "string",
  2790. "description": "type of the package",
  2791. "name": "type",
  2792. "in": "path",
  2793. "required": true
  2794. },
  2795. {
  2796. "type": "string",
  2797. "description": "name of the package",
  2798. "name": "name",
  2799. "in": "path",
  2800. "required": true
  2801. },
  2802. {
  2803. "type": "string",
  2804. "description": "version of the package",
  2805. "name": "version",
  2806. "in": "path",
  2807. "required": true
  2808. }
  2809. ],
  2810. "responses": {
  2811. "200": {
  2812. "$ref": "#/responses/Package"
  2813. },
  2814. "404": {
  2815. "$ref": "#/responses/notFound"
  2816. }
  2817. }
  2818. },
  2819. "delete": {
  2820. "tags": [
  2821. "package"
  2822. ],
  2823. "summary": "Delete a package",
  2824. "operationId": "deletePackage",
  2825. "parameters": [
  2826. {
  2827. "type": "string",
  2828. "description": "owner of the package",
  2829. "name": "owner",
  2830. "in": "path",
  2831. "required": true
  2832. },
  2833. {
  2834. "type": "string",
  2835. "description": "type of the package",
  2836. "name": "type",
  2837. "in": "path",
  2838. "required": true
  2839. },
  2840. {
  2841. "type": "string",
  2842. "description": "name of the package",
  2843. "name": "name",
  2844. "in": "path",
  2845. "required": true
  2846. },
  2847. {
  2848. "type": "string",
  2849. "description": "version of the package",
  2850. "name": "version",
  2851. "in": "path",
  2852. "required": true
  2853. }
  2854. ],
  2855. "responses": {
  2856. "204": {
  2857. "$ref": "#/responses/empty"
  2858. },
  2859. "404": {
  2860. "$ref": "#/responses/notFound"
  2861. }
  2862. }
  2863. }
  2864. },
  2865. "/packages/{owner}/{type}/{name}/{version}/files": {
  2866. "get": {
  2867. "produces": [
  2868. "application/json"
  2869. ],
  2870. "tags": [
  2871. "package"
  2872. ],
  2873. "summary": "Gets all files of a package",
  2874. "operationId": "listPackageFiles",
  2875. "parameters": [
  2876. {
  2877. "type": "string",
  2878. "description": "owner of the package",
  2879. "name": "owner",
  2880. "in": "path",
  2881. "required": true
  2882. },
  2883. {
  2884. "type": "string",
  2885. "description": "type of the package",
  2886. "name": "type",
  2887. "in": "path",
  2888. "required": true
  2889. },
  2890. {
  2891. "type": "string",
  2892. "description": "name of the package",
  2893. "name": "name",
  2894. "in": "path",
  2895. "required": true
  2896. },
  2897. {
  2898. "type": "string",
  2899. "description": "version of the package",
  2900. "name": "version",
  2901. "in": "path",
  2902. "required": true
  2903. }
  2904. ],
  2905. "responses": {
  2906. "200": {
  2907. "$ref": "#/responses/PackageFileList"
  2908. },
  2909. "404": {
  2910. "$ref": "#/responses/notFound"
  2911. }
  2912. }
  2913. }
  2914. },
  2915. "/repos/issues/search": {
  2916. "get": {
  2917. "produces": [
  2918. "application/json"
  2919. ],
  2920. "tags": [
  2921. "issue"
  2922. ],
  2923. "summary": "Search for issues across the repositories that the user has access to",
  2924. "operationId": "issueSearchIssues",
  2925. "parameters": [
  2926. {
  2927. "type": "string",
  2928. "description": "whether issue is open or closed",
  2929. "name": "state",
  2930. "in": "query"
  2931. },
  2932. {
  2933. "type": "string",
  2934. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  2935. "name": "labels",
  2936. "in": "query"
  2937. },
  2938. {
  2939. "type": "string",
  2940. "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
  2941. "name": "milestones",
  2942. "in": "query"
  2943. },
  2944. {
  2945. "type": "string",
  2946. "description": "search string",
  2947. "name": "q",
  2948. "in": "query"
  2949. },
  2950. {
  2951. "type": "integer",
  2952. "format": "int64",
  2953. "description": "repository to prioritize in the results",
  2954. "name": "priority_repo_id",
  2955. "in": "query"
  2956. },
  2957. {
  2958. "type": "string",
  2959. "description": "filter by type (issues / pulls) if set",
  2960. "name": "type",
  2961. "in": "query"
  2962. },
  2963. {
  2964. "type": "string",
  2965. "format": "date-time",
  2966. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  2967. "name": "since",
  2968. "in": "query"
  2969. },
  2970. {
  2971. "type": "string",
  2972. "format": "date-time",
  2973. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  2974. "name": "before",
  2975. "in": "query"
  2976. },
  2977. {
  2978. "type": "boolean",
  2979. "description": "filter (issues / pulls) assigned to you, default is false",
  2980. "name": "assigned",
  2981. "in": "query"
  2982. },
  2983. {
  2984. "type": "boolean",
  2985. "description": "filter (issues / pulls) created by you, default is false",
  2986. "name": "created",
  2987. "in": "query"
  2988. },
  2989. {
  2990. "type": "boolean",
  2991. "description": "filter (issues / pulls) mentioning you, default is false",
  2992. "name": "mentioned",
  2993. "in": "query"
  2994. },
  2995. {
  2996. "type": "boolean",
  2997. "description": "filter pulls requesting your review, default is false",
  2998. "name": "review_requested",
  2999. "in": "query"
  3000. },
  3001. {
  3002. "type": "boolean",
  3003. "description": "filter pulls reviewed by you, default is false",
  3004. "name": "reviewed",
  3005. "in": "query"
  3006. },
  3007. {
  3008. "type": "string",
  3009. "description": "filter by owner",
  3010. "name": "owner",
  3011. "in": "query"
  3012. },
  3013. {
  3014. "type": "string",
  3015. "description": "filter by team (requires organization owner parameter to be provided)",
  3016. "name": "team",
  3017. "in": "query"
  3018. },
  3019. {
  3020. "type": "integer",
  3021. "description": "page number of results to return (1-based)",
  3022. "name": "page",
  3023. "in": "query"
  3024. },
  3025. {
  3026. "type": "integer",
  3027. "description": "page size of results",
  3028. "name": "limit",
  3029. "in": "query"
  3030. }
  3031. ],
  3032. "responses": {
  3033. "200": {
  3034. "$ref": "#/responses/IssueList"
  3035. }
  3036. }
  3037. }
  3038. },
  3039. "/repos/migrate": {
  3040. "post": {
  3041. "consumes": [
  3042. "application/json"
  3043. ],
  3044. "produces": [
  3045. "application/json"
  3046. ],
  3047. "tags": [
  3048. "repository"
  3049. ],
  3050. "summary": "Migrate a remote git repository",
  3051. "operationId": "repoMigrate",
  3052. "parameters": [
  3053. {
  3054. "name": "body",
  3055. "in": "body",
  3056. "schema": {
  3057. "$ref": "#/definitions/MigrateRepoOptions"
  3058. }
  3059. }
  3060. ],
  3061. "responses": {
  3062. "201": {
  3063. "$ref": "#/responses/Repository"
  3064. },
  3065. "403": {
  3066. "$ref": "#/responses/forbidden"
  3067. },
  3068. "409": {
  3069. "description": "The repository with the same name already exists."
  3070. },
  3071. "422": {
  3072. "$ref": "#/responses/validationError"
  3073. }
  3074. }
  3075. }
  3076. },
  3077. "/repos/search": {
  3078. "get": {
  3079. "produces": [
  3080. "application/json"
  3081. ],
  3082. "tags": [
  3083. "repository"
  3084. ],
  3085. "summary": "Search for repositories",
  3086. "operationId": "repoSearch",
  3087. "parameters": [
  3088. {
  3089. "type": "string",
  3090. "description": "keyword",
  3091. "name": "q",
  3092. "in": "query"
  3093. },
  3094. {
  3095. "type": "boolean",
  3096. "description": "Limit search to repositories with keyword as topic",
  3097. "name": "topic",
  3098. "in": "query"
  3099. },
  3100. {
  3101. "type": "boolean",
  3102. "description": "include search of keyword within repository description",
  3103. "name": "includeDesc",
  3104. "in": "query"
  3105. },
  3106. {
  3107. "type": "integer",
  3108. "format": "int64",
  3109. "description": "search only for repos that the user with the given id owns or contributes to",
  3110. "name": "uid",
  3111. "in": "query"
  3112. },
  3113. {
  3114. "type": "integer",
  3115. "format": "int64",
  3116. "description": "repo owner to prioritize in the results",
  3117. "name": "priority_owner_id",
  3118. "in": "query"
  3119. },
  3120. {
  3121. "type": "integer",
  3122. "format": "int64",
  3123. "description": "search only for repos that belong to the given team id",
  3124. "name": "team_id",
  3125. "in": "query"
  3126. },
  3127. {
  3128. "type": "integer",
  3129. "format": "int64",
  3130. "description": "search only for repos that the user with the given id has starred",
  3131. "name": "starredBy",
  3132. "in": "query"
  3133. },
  3134. {
  3135. "type": "boolean",
  3136. "description": "include private repositories this user has access to (defaults to true)",
  3137. "name": "private",
  3138. "in": "query"
  3139. },
  3140. {
  3141. "type": "boolean",
  3142. "description": "show only pubic, private or all repositories (defaults to all)",
  3143. "name": "is_private",
  3144. "in": "query"
  3145. },
  3146. {
  3147. "type": "boolean",
  3148. "description": "include template repositories this user has access to (defaults to true)",
  3149. "name": "template",
  3150. "in": "query"
  3151. },
  3152. {
  3153. "type": "boolean",
  3154. "description": "show only archived, non-archived or all repositories (defaults to all)",
  3155. "name": "archived",
  3156. "in": "query"
  3157. },
  3158. {
  3159. "type": "string",
  3160. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  3161. "name": "mode",
  3162. "in": "query"
  3163. },
  3164. {
  3165. "type": "boolean",
  3166. "description": "if `uid` is given, search only for repos that the user owns",
  3167. "name": "exclusive",
  3168. "in": "query"
  3169. },
  3170. {
  3171. "type": "string",
  3172. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  3173. "name": "sort",
  3174. "in": "query"
  3175. },
  3176. {
  3177. "type": "string",
  3178. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  3179. "name": "order",
  3180. "in": "query"
  3181. },
  3182. {
  3183. "type": "integer",
  3184. "description": "page number of results to return (1-based)",
  3185. "name": "page",
  3186. "in": "query"
  3187. },
  3188. {
  3189. "type": "integer",
  3190. "description": "page size of results",
  3191. "name": "limit",
  3192. "in": "query"
  3193. }
  3194. ],
  3195. "responses": {
  3196. "200": {
  3197. "$ref": "#/responses/SearchResults"
  3198. },
  3199. "422": {
  3200. "$ref": "#/responses/validationError"
  3201. }
  3202. }
  3203. }
  3204. },
  3205. "/repos/{owner}/{repo}": {
  3206. "get": {
  3207. "produces": [
  3208. "application/json"
  3209. ],
  3210. "tags": [
  3211. "repository"
  3212. ],
  3213. "summary": "Get a repository",
  3214. "operationId": "repoGet",
  3215. "parameters": [
  3216. {
  3217. "type": "string",
  3218. "description": "owner of the repo",
  3219. "name": "owner",
  3220. "in": "path",
  3221. "required": true
  3222. },
  3223. {
  3224. "type": "string",
  3225. "description": "name of the repo",
  3226. "name": "repo",
  3227. "in": "path",
  3228. "required": true
  3229. }
  3230. ],
  3231. "responses": {
  3232. "200": {
  3233. "$ref": "#/responses/Repository"
  3234. },
  3235. "404": {
  3236. "$ref": "#/responses/notFound"
  3237. }
  3238. }
  3239. },
  3240. "delete": {
  3241. "produces": [
  3242. "application/json"
  3243. ],
  3244. "tags": [
  3245. "repository"
  3246. ],
  3247. "summary": "Delete a repository",
  3248. "operationId": "repoDelete",
  3249. "parameters": [
  3250. {
  3251. "type": "string",
  3252. "description": "owner of the repo to delete",
  3253. "name": "owner",
  3254. "in": "path",
  3255. "required": true
  3256. },
  3257. {
  3258. "type": "string",
  3259. "description": "name of the repo to delete",
  3260. "name": "repo",
  3261. "in": "path",
  3262. "required": true
  3263. }
  3264. ],
  3265. "responses": {
  3266. "204": {
  3267. "$ref": "#/responses/empty"
  3268. },
  3269. "403": {
  3270. "$ref": "#/responses/forbidden"
  3271. },
  3272. "404": {
  3273. "$ref": "#/responses/notFound"
  3274. }
  3275. }
  3276. },
  3277. "patch": {
  3278. "produces": [
  3279. "application/json"
  3280. ],
  3281. "tags": [
  3282. "repository"
  3283. ],
  3284. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  3285. "operationId": "repoEdit",
  3286. "parameters": [
  3287. {
  3288. "type": "string",
  3289. "description": "owner of the repo to edit",
  3290. "name": "owner",
  3291. "in": "path",
  3292. "required": true
  3293. },
  3294. {
  3295. "type": "string",
  3296. "description": "name of the repo to edit",
  3297. "name": "repo",
  3298. "in": "path",
  3299. "required": true
  3300. },
  3301. {
  3302. "description": "Properties of a repo that you can edit",
  3303. "name": "body",
  3304. "in": "body",
  3305. "schema": {
  3306. "$ref": "#/definitions/EditRepoOption"
  3307. }
  3308. }
  3309. ],
  3310. "responses": {
  3311. "200": {
  3312. "$ref": "#/responses/Repository"
  3313. },
  3314. "403": {
  3315. "$ref": "#/responses/forbidden"
  3316. },
  3317. "404": {
  3318. "$ref": "#/responses/notFound"
  3319. },
  3320. "422": {
  3321. "$ref": "#/responses/validationError"
  3322. }
  3323. }
  3324. }
  3325. },
  3326. "/repos/{owner}/{repo}/actions/secrets/{secretname}": {
  3327. "put": {
  3328. "consumes": [
  3329. "application/json"
  3330. ],
  3331. "produces": [
  3332. "application/json"
  3333. ],
  3334. "tags": [
  3335. "repository"
  3336. ],
  3337. "summary": "Create or Update a secret value in a repository",
  3338. "operationId": "updateRepoSecret",
  3339. "parameters": [
  3340. {
  3341. "type": "string",
  3342. "description": "owner of the repository",
  3343. "name": "owner",
  3344. "in": "path",
  3345. "required": true
  3346. },
  3347. {
  3348. "type": "string",
  3349. "description": "name of the repository",
  3350. "name": "repo",
  3351. "in": "path",
  3352. "required": true
  3353. },
  3354. {
  3355. "type": "string",
  3356. "description": "name of the secret",
  3357. "name": "secretname",
  3358. "in": "path",
  3359. "required": true
  3360. },
  3361. {
  3362. "name": "body",
  3363. "in": "body",
  3364. "schema": {
  3365. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  3366. }
  3367. }
  3368. ],
  3369. "responses": {
  3370. "201": {
  3371. "description": "response when creating a secret"
  3372. },
  3373. "204": {
  3374. "description": "response when updating a secret"
  3375. },
  3376. "400": {
  3377. "$ref": "#/responses/error"
  3378. },
  3379. "404": {
  3380. "$ref": "#/responses/notFound"
  3381. }
  3382. }
  3383. },
  3384. "delete": {
  3385. "consumes": [
  3386. "application/json"
  3387. ],
  3388. "produces": [
  3389. "application/json"
  3390. ],
  3391. "tags": [
  3392. "repository"
  3393. ],
  3394. "summary": "Delete a secret in a repository",
  3395. "operationId": "deleteRepoSecret",
  3396. "parameters": [
  3397. {
  3398. "type": "string",
  3399. "description": "owner of the repository",
  3400. "name": "owner",
  3401. "in": "path",
  3402. "required": true
  3403. },
  3404. {
  3405. "type": "string",
  3406. "description": "name of the repository",
  3407. "name": "repo",
  3408. "in": "path",
  3409. "required": true
  3410. },
  3411. {
  3412. "type": "string",
  3413. "description": "name of the secret",
  3414. "name": "secretname",
  3415. "in": "path",
  3416. "required": true
  3417. }
  3418. ],
  3419. "responses": {
  3420. "204": {
  3421. "description": "delete one secret of the organization"
  3422. },
  3423. "400": {
  3424. "$ref": "#/responses/error"
  3425. },
  3426. "404": {
  3427. "$ref": "#/responses/notFound"
  3428. }
  3429. }
  3430. }
  3431. },
  3432. "/repos/{owner}/{repo}/activities/feeds": {
  3433. "get": {
  3434. "produces": [
  3435. "application/json"
  3436. ],
  3437. "tags": [
  3438. "repository"
  3439. ],
  3440. "summary": "List a repository's activity feeds",
  3441. "operationId": "repoListActivityFeeds",
  3442. "parameters": [
  3443. {
  3444. "type": "string",
  3445. "description": "owner of the repo",
  3446. "name": "owner",
  3447. "in": "path",
  3448. "required": true
  3449. },
  3450. {
  3451. "type": "string",
  3452. "description": "name of the repo",
  3453. "name": "repo",
  3454. "in": "path",
  3455. "required": true
  3456. },
  3457. {
  3458. "type": "string",
  3459. "format": "date",
  3460. "description": "the date of the activities to be found",
  3461. "name": "date",
  3462. "in": "query"
  3463. },
  3464. {
  3465. "type": "integer",
  3466. "description": "page number of results to return (1-based)",
  3467. "name": "page",
  3468. "in": "query"
  3469. },
  3470. {
  3471. "type": "integer",
  3472. "description": "page size of results",
  3473. "name": "limit",
  3474. "in": "query"
  3475. }
  3476. ],
  3477. "responses": {
  3478. "200": {
  3479. "$ref": "#/responses/ActivityFeedsList"
  3480. },
  3481. "404": {
  3482. "$ref": "#/responses/notFound"
  3483. }
  3484. }
  3485. }
  3486. },
  3487. "/repos/{owner}/{repo}/archive/{archive}": {
  3488. "get": {
  3489. "produces": [
  3490. "application/json"
  3491. ],
  3492. "tags": [
  3493. "repository"
  3494. ],
  3495. "summary": "Get an archive of a repository",
  3496. "operationId": "repoGetArchive",
  3497. "parameters": [
  3498. {
  3499. "type": "string",
  3500. "description": "owner of the repo",
  3501. "name": "owner",
  3502. "in": "path",
  3503. "required": true
  3504. },
  3505. {
  3506. "type": "string",
  3507. "description": "name of the repo",
  3508. "name": "repo",
  3509. "in": "path",
  3510. "required": true
  3511. },
  3512. {
  3513. "type": "string",
  3514. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  3515. "name": "archive",
  3516. "in": "path",
  3517. "required": true
  3518. }
  3519. ],
  3520. "responses": {
  3521. "200": {
  3522. "description": "success"
  3523. },
  3524. "404": {
  3525. "$ref": "#/responses/notFound"
  3526. }
  3527. }
  3528. }
  3529. },
  3530. "/repos/{owner}/{repo}/assignees": {
  3531. "get": {
  3532. "produces": [
  3533. "application/json"
  3534. ],
  3535. "tags": [
  3536. "repository"
  3537. ],
  3538. "summary": "Return all users that have write access and can be assigned to issues",
  3539. "operationId": "repoGetAssignees",
  3540. "parameters": [
  3541. {
  3542. "type": "string",
  3543. "description": "owner of the repo",
  3544. "name": "owner",
  3545. "in": "path",
  3546. "required": true
  3547. },
  3548. {
  3549. "type": "string",
  3550. "description": "name of the repo",
  3551. "name": "repo",
  3552. "in": "path",
  3553. "required": true
  3554. }
  3555. ],
  3556. "responses": {
  3557. "200": {
  3558. "$ref": "#/responses/UserList"
  3559. },
  3560. "404": {
  3561. "$ref": "#/responses/notFound"
  3562. }
  3563. }
  3564. }
  3565. },
  3566. "/repos/{owner}/{repo}/avatar": {
  3567. "post": {
  3568. "produces": [
  3569. "application/json"
  3570. ],
  3571. "tags": [
  3572. "repository"
  3573. ],
  3574. "summary": "Update avatar",
  3575. "operationId": "repoUpdateAvatar",
  3576. "parameters": [
  3577. {
  3578. "type": "string",
  3579. "description": "owner of the repo",
  3580. "name": "owner",
  3581. "in": "path",
  3582. "required": true
  3583. },
  3584. {
  3585. "type": "string",
  3586. "description": "name of the repo",
  3587. "name": "repo",
  3588. "in": "path",
  3589. "required": true
  3590. },
  3591. {
  3592. "name": "body",
  3593. "in": "body",
  3594. "schema": {
  3595. "$ref": "#/definitions/UpdateRepoAvatarOption"
  3596. }
  3597. }
  3598. ],
  3599. "responses": {
  3600. "204": {
  3601. "$ref": "#/responses/empty"
  3602. },
  3603. "404": {
  3604. "$ref": "#/responses/notFound"
  3605. }
  3606. }
  3607. },
  3608. "delete": {
  3609. "produces": [
  3610. "application/json"
  3611. ],
  3612. "tags": [
  3613. "repository"
  3614. ],
  3615. "summary": "Delete avatar",
  3616. "operationId": "repoDeleteAvatar",
  3617. "parameters": [
  3618. {
  3619. "type": "string",
  3620. "description": "owner of the repo",
  3621. "name": "owner",
  3622. "in": "path",
  3623. "required": true
  3624. },
  3625. {
  3626. "type": "string",
  3627. "description": "name of the repo",
  3628. "name": "repo",
  3629. "in": "path",
  3630. "required": true
  3631. }
  3632. ],
  3633. "responses": {
  3634. "204": {
  3635. "$ref": "#/responses/empty"
  3636. },
  3637. "404": {
  3638. "$ref": "#/responses/notFound"
  3639. }
  3640. }
  3641. }
  3642. },
  3643. "/repos/{owner}/{repo}/branch_protections": {
  3644. "get": {
  3645. "produces": [
  3646. "application/json"
  3647. ],
  3648. "tags": [
  3649. "repository"
  3650. ],
  3651. "summary": "List branch protections for a repository",
  3652. "operationId": "repoListBranchProtection",
  3653. "parameters": [
  3654. {
  3655. "type": "string",
  3656. "description": "owner of the repo",
  3657. "name": "owner",
  3658. "in": "path",
  3659. "required": true
  3660. },
  3661. {
  3662. "type": "string",
  3663. "description": "name of the repo",
  3664. "name": "repo",
  3665. "in": "path",
  3666. "required": true
  3667. }
  3668. ],
  3669. "responses": {
  3670. "200": {
  3671. "$ref": "#/responses/BranchProtectionList"
  3672. }
  3673. }
  3674. },
  3675. "post": {
  3676. "consumes": [
  3677. "application/json"
  3678. ],
  3679. "produces": [
  3680. "application/json"
  3681. ],
  3682. "tags": [
  3683. "repository"
  3684. ],
  3685. "summary": "Create a branch protections for a repository",
  3686. "operationId": "repoCreateBranchProtection",
  3687. "parameters": [
  3688. {
  3689. "type": "string",
  3690. "description": "owner of the repo",
  3691. "name": "owner",
  3692. "in": "path",
  3693. "required": true
  3694. },
  3695. {
  3696. "type": "string",
  3697. "description": "name of the repo",
  3698. "name": "repo",
  3699. "in": "path",
  3700. "required": true
  3701. },
  3702. {
  3703. "name": "body",
  3704. "in": "body",
  3705. "schema": {
  3706. "$ref": "#/definitions/CreateBranchProtectionOption"
  3707. }
  3708. }
  3709. ],
  3710. "responses": {
  3711. "201": {
  3712. "$ref": "#/responses/BranchProtection"
  3713. },
  3714. "403": {
  3715. "$ref": "#/responses/forbidden"
  3716. },
  3717. "404": {
  3718. "$ref": "#/responses/notFound"
  3719. },
  3720. "422": {
  3721. "$ref": "#/responses/validationError"
  3722. }
  3723. }
  3724. }
  3725. },
  3726. "/repos/{owner}/{repo}/branch_protections/{name}": {
  3727. "get": {
  3728. "produces": [
  3729. "application/json"
  3730. ],
  3731. "tags": [
  3732. "repository"
  3733. ],
  3734. "summary": "Get a specific branch protection for the repository",
  3735. "operationId": "repoGetBranchProtection",
  3736. "parameters": [
  3737. {
  3738. "type": "string",
  3739. "description": "owner of the repo",
  3740. "name": "owner",
  3741. "in": "path",
  3742. "required": true
  3743. },
  3744. {
  3745. "type": "string",
  3746. "description": "name of the repo",
  3747. "name": "repo",
  3748. "in": "path",
  3749. "required": true
  3750. },
  3751. {
  3752. "type": "string",
  3753. "description": "name of protected branch",
  3754. "name": "name",
  3755. "in": "path",
  3756. "required": true
  3757. }
  3758. ],
  3759. "responses": {
  3760. "200": {
  3761. "$ref": "#/responses/BranchProtection"
  3762. },
  3763. "404": {
  3764. "$ref": "#/responses/notFound"
  3765. }
  3766. }
  3767. },
  3768. "delete": {
  3769. "produces": [
  3770. "application/json"
  3771. ],
  3772. "tags": [
  3773. "repository"
  3774. ],
  3775. "summary": "Delete a specific branch protection for the repository",
  3776. "operationId": "repoDeleteBranchProtection",
  3777. "parameters": [
  3778. {
  3779. "type": "string",
  3780. "description": "owner of the repo",
  3781. "name": "owner",
  3782. "in": "path",
  3783. "required": true
  3784. },
  3785. {
  3786. "type": "string",
  3787. "description": "name of the repo",
  3788. "name": "repo",
  3789. "in": "path",
  3790. "required": true
  3791. },
  3792. {
  3793. "type": "string",
  3794. "description": "name of protected branch",
  3795. "name": "name",
  3796. "in": "path",
  3797. "required": true
  3798. }
  3799. ],
  3800. "responses": {
  3801. "204": {
  3802. "$ref": "#/responses/empty"
  3803. },
  3804. "404": {
  3805. "$ref": "#/responses/notFound"
  3806. }
  3807. }
  3808. },
  3809. "patch": {
  3810. "consumes": [
  3811. "application/json"
  3812. ],
  3813. "produces": [
  3814. "application/json"
  3815. ],
  3816. "tags": [
  3817. "repository"
  3818. ],
  3819. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  3820. "operationId": "repoEditBranchProtection",
  3821. "parameters": [
  3822. {
  3823. "type": "string",
  3824. "description": "owner of the repo",
  3825. "name": "owner",
  3826. "in": "path",
  3827. "required": true
  3828. },
  3829. {
  3830. "type": "string",
  3831. "description": "name of the repo",
  3832. "name": "repo",
  3833. "in": "path",
  3834. "required": true
  3835. },
  3836. {
  3837. "type": "string",
  3838. "description": "name of protected branch",
  3839. "name": "name",
  3840. "in": "path",
  3841. "required": true
  3842. },
  3843. {
  3844. "name": "body",
  3845. "in": "body",
  3846. "schema": {
  3847. "$ref": "#/definitions/EditBranchProtectionOption"
  3848. }
  3849. }
  3850. ],
  3851. "responses": {
  3852. "200": {
  3853. "$ref": "#/responses/BranchProtection"
  3854. },
  3855. "404": {
  3856. "$ref": "#/responses/notFound"
  3857. },
  3858. "422": {
  3859. "$ref": "#/responses/validationError"
  3860. }
  3861. }
  3862. }
  3863. },
  3864. "/repos/{owner}/{repo}/branches": {
  3865. "get": {
  3866. "produces": [
  3867. "application/json"
  3868. ],
  3869. "tags": [
  3870. "repository"
  3871. ],
  3872. "summary": "List a repository's branches",
  3873. "operationId": "repoListBranches",
  3874. "parameters": [
  3875. {
  3876. "type": "string",
  3877. "description": "owner of the repo",
  3878. "name": "owner",
  3879. "in": "path",
  3880. "required": true
  3881. },
  3882. {
  3883. "type": "string",
  3884. "description": "name of the repo",
  3885. "name": "repo",
  3886. "in": "path",
  3887. "required": true
  3888. },
  3889. {
  3890. "type": "integer",
  3891. "description": "page number of results to return (1-based)",
  3892. "name": "page",
  3893. "in": "query"
  3894. },
  3895. {
  3896. "type": "integer",
  3897. "description": "page size of results",
  3898. "name": "limit",
  3899. "in": "query"
  3900. }
  3901. ],
  3902. "responses": {
  3903. "200": {
  3904. "$ref": "#/responses/BranchList"
  3905. }
  3906. }
  3907. },
  3908. "post": {
  3909. "consumes": [
  3910. "application/json"
  3911. ],
  3912. "produces": [
  3913. "application/json"
  3914. ],
  3915. "tags": [
  3916. "repository"
  3917. ],
  3918. "summary": "Create a branch",
  3919. "operationId": "repoCreateBranch",
  3920. "parameters": [
  3921. {
  3922. "type": "string",
  3923. "description": "owner of the repo",
  3924. "name": "owner",
  3925. "in": "path",
  3926. "required": true
  3927. },
  3928. {
  3929. "type": "string",
  3930. "description": "name of the repo",
  3931. "name": "repo",
  3932. "in": "path",
  3933. "required": true
  3934. },
  3935. {
  3936. "name": "body",
  3937. "in": "body",
  3938. "schema": {
  3939. "$ref": "#/definitions/CreateBranchRepoOption"
  3940. }
  3941. }
  3942. ],
  3943. "responses": {
  3944. "201": {
  3945. "$ref": "#/responses/Branch"
  3946. },
  3947. "403": {
  3948. "description": "The branch is archived or a mirror."
  3949. },
  3950. "404": {
  3951. "description": "The old branch does not exist."
  3952. },
  3953. "409": {
  3954. "description": "The branch with the same name already exists."
  3955. }
  3956. }
  3957. }
  3958. },
  3959. "/repos/{owner}/{repo}/branches/{branch}": {
  3960. "get": {
  3961. "produces": [
  3962. "application/json"
  3963. ],
  3964. "tags": [
  3965. "repository"
  3966. ],
  3967. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  3968. "operationId": "repoGetBranch",
  3969. "parameters": [
  3970. {
  3971. "type": "string",
  3972. "description": "owner of the repo",
  3973. "name": "owner",
  3974. "in": "path",
  3975. "required": true
  3976. },
  3977. {
  3978. "type": "string",
  3979. "description": "name of the repo",
  3980. "name": "repo",
  3981. "in": "path",
  3982. "required": true
  3983. },
  3984. {
  3985. "type": "string",
  3986. "description": "branch to get",
  3987. "name": "branch",
  3988. "in": "path",
  3989. "required": true
  3990. }
  3991. ],
  3992. "responses": {
  3993. "200": {
  3994. "$ref": "#/responses/Branch"
  3995. },
  3996. "404": {
  3997. "$ref": "#/responses/notFound"
  3998. }
  3999. }
  4000. },
  4001. "delete": {
  4002. "produces": [
  4003. "application/json"
  4004. ],
  4005. "tags": [
  4006. "repository"
  4007. ],
  4008. "summary": "Delete a specific branch from a repository",
  4009. "operationId": "repoDeleteBranch",
  4010. "parameters": [
  4011. {
  4012. "type": "string",
  4013. "description": "owner of the repo",
  4014. "name": "owner",
  4015. "in": "path",
  4016. "required": true
  4017. },
  4018. {
  4019. "type": "string",
  4020. "description": "name of the repo",
  4021. "name": "repo",
  4022. "in": "path",
  4023. "required": true
  4024. },
  4025. {
  4026. "type": "string",
  4027. "description": "branch to delete",
  4028. "name": "branch",
  4029. "in": "path",
  4030. "required": true
  4031. }
  4032. ],
  4033. "responses": {
  4034. "204": {
  4035. "$ref": "#/responses/empty"
  4036. },
  4037. "403": {
  4038. "$ref": "#/responses/error"
  4039. },
  4040. "404": {
  4041. "$ref": "#/responses/notFound"
  4042. }
  4043. }
  4044. }
  4045. },
  4046. "/repos/{owner}/{repo}/collaborators": {
  4047. "get": {
  4048. "produces": [
  4049. "application/json"
  4050. ],
  4051. "tags": [
  4052. "repository"
  4053. ],
  4054. "summary": "List a repository's collaborators",
  4055. "operationId": "repoListCollaborators",
  4056. "parameters": [
  4057. {
  4058. "type": "string",
  4059. "description": "owner of the repo",
  4060. "name": "owner",
  4061. "in": "path",
  4062. "required": true
  4063. },
  4064. {
  4065. "type": "string",
  4066. "description": "name of the repo",
  4067. "name": "repo",
  4068. "in": "path",
  4069. "required": true
  4070. },
  4071. {
  4072. "type": "integer",
  4073. "description": "page number of results to return (1-based)",
  4074. "name": "page",
  4075. "in": "query"
  4076. },
  4077. {
  4078. "type": "integer",
  4079. "description": "page size of results",
  4080. "name": "limit",
  4081. "in": "query"
  4082. }
  4083. ],
  4084. "responses": {
  4085. "200": {
  4086. "$ref": "#/responses/UserList"
  4087. },
  4088. "404": {
  4089. "$ref": "#/responses/notFound"
  4090. }
  4091. }
  4092. }
  4093. },
  4094. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  4095. "get": {
  4096. "produces": [
  4097. "application/json"
  4098. ],
  4099. "tags": [
  4100. "repository"
  4101. ],
  4102. "summary": "Check if a user is a collaborator of a repository",
  4103. "operationId": "repoCheckCollaborator",
  4104. "parameters": [
  4105. {
  4106. "type": "string",
  4107. "description": "owner of the repo",
  4108. "name": "owner",
  4109. "in": "path",
  4110. "required": true
  4111. },
  4112. {
  4113. "type": "string",
  4114. "description": "name of the repo",
  4115. "name": "repo",
  4116. "in": "path",
  4117. "required": true
  4118. },
  4119. {
  4120. "type": "string",
  4121. "description": "username of the collaborator",
  4122. "name": "collaborator",
  4123. "in": "path",
  4124. "required": true
  4125. }
  4126. ],
  4127. "responses": {
  4128. "204": {
  4129. "$ref": "#/responses/empty"
  4130. },
  4131. "404": {
  4132. "$ref": "#/responses/notFound"
  4133. },
  4134. "422": {
  4135. "$ref": "#/responses/validationError"
  4136. }
  4137. }
  4138. },
  4139. "put": {
  4140. "produces": [
  4141. "application/json"
  4142. ],
  4143. "tags": [
  4144. "repository"
  4145. ],
  4146. "summary": "Add a collaborator to a repository",
  4147. "operationId": "repoAddCollaborator",
  4148. "parameters": [
  4149. {
  4150. "type": "string",
  4151. "description": "owner of the repo",
  4152. "name": "owner",
  4153. "in": "path",
  4154. "required": true
  4155. },
  4156. {
  4157. "type": "string",
  4158. "description": "name of the repo",
  4159. "name": "repo",
  4160. "in": "path",
  4161. "required": true
  4162. },
  4163. {
  4164. "type": "string",
  4165. "description": "username of the collaborator to add",
  4166. "name": "collaborator",
  4167. "in": "path",
  4168. "required": true
  4169. },
  4170. {
  4171. "name": "body",
  4172. "in": "body",
  4173. "schema": {
  4174. "$ref": "#/definitions/AddCollaboratorOption"
  4175. }
  4176. }
  4177. ],
  4178. "responses": {
  4179. "204": {
  4180. "$ref": "#/responses/empty"
  4181. },
  4182. "404": {
  4183. "$ref": "#/responses/notFound"
  4184. },
  4185. "422": {
  4186. "$ref": "#/responses/validationError"
  4187. }
  4188. }
  4189. },
  4190. "delete": {
  4191. "produces": [
  4192. "application/json"
  4193. ],
  4194. "tags": [
  4195. "repository"
  4196. ],
  4197. "summary": "Delete a collaborator from a repository",
  4198. "operationId": "repoDeleteCollaborator",
  4199. "parameters": [
  4200. {
  4201. "type": "string",
  4202. "description": "owner of the repo",
  4203. "name": "owner",
  4204. "in": "path",
  4205. "required": true
  4206. },
  4207. {
  4208. "type": "string",
  4209. "description": "name of the repo",
  4210. "name": "repo",
  4211. "in": "path",
  4212. "required": true
  4213. },
  4214. {
  4215. "type": "string",
  4216. "description": "username of the collaborator to delete",
  4217. "name": "collaborator",
  4218. "in": "path",
  4219. "required": true
  4220. }
  4221. ],
  4222. "responses": {
  4223. "204": {
  4224. "$ref": "#/responses/empty"
  4225. },
  4226. "404": {
  4227. "$ref": "#/responses/notFound"
  4228. },
  4229. "422": {
  4230. "$ref": "#/responses/validationError"
  4231. }
  4232. }
  4233. }
  4234. },
  4235. "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
  4236. "get": {
  4237. "produces": [
  4238. "application/json"
  4239. ],
  4240. "tags": [
  4241. "repository"
  4242. ],
  4243. "summary": "Get repository permissions for a user",
  4244. "operationId": "repoGetRepoPermissions",
  4245. "parameters": [
  4246. {
  4247. "type": "string",
  4248. "description": "owner of the repo",
  4249. "name": "owner",
  4250. "in": "path",
  4251. "required": true
  4252. },
  4253. {
  4254. "type": "string",
  4255. "description": "name of the repo",
  4256. "name": "repo",
  4257. "in": "path",
  4258. "required": true
  4259. },
  4260. {
  4261. "type": "string",
  4262. "description": "username of the collaborator",
  4263. "name": "collaborator",
  4264. "in": "path",
  4265. "required": true
  4266. }
  4267. ],
  4268. "responses": {
  4269. "200": {
  4270. "$ref": "#/responses/RepoCollaboratorPermission"
  4271. },
  4272. "403": {
  4273. "$ref": "#/responses/forbidden"
  4274. },
  4275. "404": {
  4276. "$ref": "#/responses/notFound"
  4277. }
  4278. }
  4279. }
  4280. },
  4281. "/repos/{owner}/{repo}/commits": {
  4282. "get": {
  4283. "produces": [
  4284. "application/json"
  4285. ],
  4286. "tags": [
  4287. "repository"
  4288. ],
  4289. "summary": "Get a list of all commits from a repository",
  4290. "operationId": "repoGetAllCommits",
  4291. "parameters": [
  4292. {
  4293. "type": "string",
  4294. "description": "owner of the repo",
  4295. "name": "owner",
  4296. "in": "path",
  4297. "required": true
  4298. },
  4299. {
  4300. "type": "string",
  4301. "description": "name of the repo",
  4302. "name": "repo",
  4303. "in": "path",
  4304. "required": true
  4305. },
  4306. {
  4307. "type": "string",
  4308. "description": "SHA or branch to start listing commits from (usually 'master')",
  4309. "name": "sha",
  4310. "in": "query"
  4311. },
  4312. {
  4313. "type": "string",
  4314. "description": "filepath of a file/dir",
  4315. "name": "path",
  4316. "in": "query"
  4317. },
  4318. {
  4319. "type": "boolean",
  4320. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  4321. "name": "stat",
  4322. "in": "query"
  4323. },
  4324. {
  4325. "type": "boolean",
  4326. "description": "include verification for every commit (disable for speedup, default 'true')",
  4327. "name": "verification",
  4328. "in": "query"
  4329. },
  4330. {
  4331. "type": "boolean",
  4332. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  4333. "name": "files",
  4334. "in": "query"
  4335. },
  4336. {
  4337. "type": "integer",
  4338. "description": "page number of results to return (1-based)",
  4339. "name": "page",
  4340. "in": "query"
  4341. },
  4342. {
  4343. "type": "integer",
  4344. "description": "page size of results (ignored if used with 'path')",
  4345. "name": "limit",
  4346. "in": "query"
  4347. },
  4348. {
  4349. "type": "string",
  4350. "description": "commits that match the given specifier will not be listed.",
  4351. "name": "not",
  4352. "in": "query"
  4353. }
  4354. ],
  4355. "responses": {
  4356. "200": {
  4357. "$ref": "#/responses/CommitList"
  4358. },
  4359. "404": {
  4360. "$ref": "#/responses/notFound"
  4361. },
  4362. "409": {
  4363. "$ref": "#/responses/EmptyRepository"
  4364. }
  4365. }
  4366. }
  4367. },
  4368. "/repos/{owner}/{repo}/commits/{ref}/status": {
  4369. "get": {
  4370. "produces": [
  4371. "application/json"
  4372. ],
  4373. "tags": [
  4374. "repository"
  4375. ],
  4376. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  4377. "operationId": "repoGetCombinedStatusByRef",
  4378. "parameters": [
  4379. {
  4380. "type": "string",
  4381. "description": "owner of the repo",
  4382. "name": "owner",
  4383. "in": "path",
  4384. "required": true
  4385. },
  4386. {
  4387. "type": "string",
  4388. "description": "name of the repo",
  4389. "name": "repo",
  4390. "in": "path",
  4391. "required": true
  4392. },
  4393. {
  4394. "type": "string",
  4395. "description": "name of branch/tag/commit",
  4396. "name": "ref",
  4397. "in": "path",
  4398. "required": true
  4399. },
  4400. {
  4401. "type": "integer",
  4402. "description": "page number of results to return (1-based)",
  4403. "name": "page",
  4404. "in": "query"
  4405. },
  4406. {
  4407. "type": "integer",
  4408. "description": "page size of results",
  4409. "name": "limit",
  4410. "in": "query"
  4411. }
  4412. ],
  4413. "responses": {
  4414. "200": {
  4415. "$ref": "#/responses/CombinedStatus"
  4416. },
  4417. "400": {
  4418. "$ref": "#/responses/error"
  4419. },
  4420. "404": {
  4421. "$ref": "#/responses/notFound"
  4422. }
  4423. }
  4424. }
  4425. },
  4426. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  4427. "get": {
  4428. "produces": [
  4429. "application/json"
  4430. ],
  4431. "tags": [
  4432. "repository"
  4433. ],
  4434. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  4435. "operationId": "repoListStatusesByRef",
  4436. "parameters": [
  4437. {
  4438. "type": "string",
  4439. "description": "owner of the repo",
  4440. "name": "owner",
  4441. "in": "path",
  4442. "required": true
  4443. },
  4444. {
  4445. "type": "string",
  4446. "description": "name of the repo",
  4447. "name": "repo",
  4448. "in": "path",
  4449. "required": true
  4450. },
  4451. {
  4452. "type": "string",
  4453. "description": "name of branch/tag/commit",
  4454. "name": "ref",
  4455. "in": "path",
  4456. "required": true
  4457. },
  4458. {
  4459. "enum": [
  4460. "oldest",
  4461. "recentupdate",
  4462. "leastupdate",
  4463. "leastindex",
  4464. "highestindex"
  4465. ],
  4466. "type": "string",
  4467. "description": "type of sort",
  4468. "name": "sort",
  4469. "in": "query"
  4470. },
  4471. {
  4472. "enum": [
  4473. "pending",
  4474. "success",
  4475. "error",
  4476. "failure",
  4477. "warning"
  4478. ],
  4479. "type": "string",
  4480. "description": "type of state",
  4481. "name": "state",
  4482. "in": "query"
  4483. },
  4484. {
  4485. "type": "integer",
  4486. "description": "page number of results to return (1-based)",
  4487. "name": "page",
  4488. "in": "query"
  4489. },
  4490. {
  4491. "type": "integer",
  4492. "description": "page size of results",
  4493. "name": "limit",
  4494. "in": "query"
  4495. }
  4496. ],
  4497. "responses": {
  4498. "200": {
  4499. "$ref": "#/responses/CommitStatusList"
  4500. },
  4501. "400": {
  4502. "$ref": "#/responses/error"
  4503. },
  4504. "404": {
  4505. "$ref": "#/responses/notFound"
  4506. }
  4507. }
  4508. }
  4509. },
  4510. "/repos/{owner}/{repo}/contents": {
  4511. "get": {
  4512. "produces": [
  4513. "application/json"
  4514. ],
  4515. "tags": [
  4516. "repository"
  4517. ],
  4518. "summary": "Gets the metadata of all the entries of the root dir",
  4519. "operationId": "repoGetContentsList",
  4520. "parameters": [
  4521. {
  4522. "type": "string",
  4523. "description": "owner of the repo",
  4524. "name": "owner",
  4525. "in": "path",
  4526. "required": true
  4527. },
  4528. {
  4529. "type": "string",
  4530. "description": "name of the repo",
  4531. "name": "repo",
  4532. "in": "path",
  4533. "required": true
  4534. },
  4535. {
  4536. "type": "string",
  4537. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4538. "name": "ref",
  4539. "in": "query"
  4540. }
  4541. ],
  4542. "responses": {
  4543. "200": {
  4544. "$ref": "#/responses/ContentsListResponse"
  4545. },
  4546. "404": {
  4547. "$ref": "#/responses/notFound"
  4548. }
  4549. }
  4550. },
  4551. "post": {
  4552. "consumes": [
  4553. "application/json"
  4554. ],
  4555. "produces": [
  4556. "application/json"
  4557. ],
  4558. "tags": [
  4559. "repository"
  4560. ],
  4561. "summary": "Modify multiple files in a repository",
  4562. "operationId": "repoChangeFiles",
  4563. "parameters": [
  4564. {
  4565. "type": "string",
  4566. "description": "owner of the repo",
  4567. "name": "owner",
  4568. "in": "path",
  4569. "required": true
  4570. },
  4571. {
  4572. "type": "string",
  4573. "description": "name of the repo",
  4574. "name": "repo",
  4575. "in": "path",
  4576. "required": true
  4577. },
  4578. {
  4579. "name": "body",
  4580. "in": "body",
  4581. "required": true,
  4582. "schema": {
  4583. "$ref": "#/definitions/ChangeFilesOptions"
  4584. }
  4585. }
  4586. ],
  4587. "responses": {
  4588. "201": {
  4589. "$ref": "#/responses/FilesResponse"
  4590. },
  4591. "403": {
  4592. "$ref": "#/responses/error"
  4593. },
  4594. "404": {
  4595. "$ref": "#/responses/notFound"
  4596. },
  4597. "422": {
  4598. "$ref": "#/responses/error"
  4599. }
  4600. }
  4601. }
  4602. },
  4603. "/repos/{owner}/{repo}/contents/{filepath}": {
  4604. "get": {
  4605. "produces": [
  4606. "application/json"
  4607. ],
  4608. "tags": [
  4609. "repository"
  4610. ],
  4611. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  4612. "operationId": "repoGetContents",
  4613. "parameters": [
  4614. {
  4615. "type": "string",
  4616. "description": "owner of the repo",
  4617. "name": "owner",
  4618. "in": "path",
  4619. "required": true
  4620. },
  4621. {
  4622. "type": "string",
  4623. "description": "name of the repo",
  4624. "name": "repo",
  4625. "in": "path",
  4626. "required": true
  4627. },
  4628. {
  4629. "type": "string",
  4630. "description": "path of the dir, file, symlink or submodule in the repo",
  4631. "name": "filepath",
  4632. "in": "path",
  4633. "required": true
  4634. },
  4635. {
  4636. "type": "string",
  4637. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4638. "name": "ref",
  4639. "in": "query"
  4640. }
  4641. ],
  4642. "responses": {
  4643. "200": {
  4644. "$ref": "#/responses/ContentsResponse"
  4645. },
  4646. "404": {
  4647. "$ref": "#/responses/notFound"
  4648. }
  4649. }
  4650. },
  4651. "put": {
  4652. "consumes": [
  4653. "application/json"
  4654. ],
  4655. "produces": [
  4656. "application/json"
  4657. ],
  4658. "tags": [
  4659. "repository"
  4660. ],
  4661. "summary": "Update a file in a repository",
  4662. "operationId": "repoUpdateFile",
  4663. "parameters": [
  4664. {
  4665. "type": "string",
  4666. "description": "owner of the repo",
  4667. "name": "owner",
  4668. "in": "path",
  4669. "required": true
  4670. },
  4671. {
  4672. "type": "string",
  4673. "description": "name of the repo",
  4674. "name": "repo",
  4675. "in": "path",
  4676. "required": true
  4677. },
  4678. {
  4679. "type": "string",
  4680. "description": "path of the file to update",
  4681. "name": "filepath",
  4682. "in": "path",
  4683. "required": true
  4684. },
  4685. {
  4686. "name": "body",
  4687. "in": "body",
  4688. "required": true,
  4689. "schema": {
  4690. "$ref": "#/definitions/UpdateFileOptions"
  4691. }
  4692. }
  4693. ],
  4694. "responses": {
  4695. "200": {
  4696. "$ref": "#/responses/FileResponse"
  4697. },
  4698. "403": {
  4699. "$ref": "#/responses/error"
  4700. },
  4701. "404": {
  4702. "$ref": "#/responses/notFound"
  4703. },
  4704. "422": {
  4705. "$ref": "#/responses/error"
  4706. }
  4707. }
  4708. },
  4709. "post": {
  4710. "consumes": [
  4711. "application/json"
  4712. ],
  4713. "produces": [
  4714. "application/json"
  4715. ],
  4716. "tags": [
  4717. "repository"
  4718. ],
  4719. "summary": "Create a file in a repository",
  4720. "operationId": "repoCreateFile",
  4721. "parameters": [
  4722. {
  4723. "type": "string",
  4724. "description": "owner of the repo",
  4725. "name": "owner",
  4726. "in": "path",
  4727. "required": true
  4728. },
  4729. {
  4730. "type": "string",
  4731. "description": "name of the repo",
  4732. "name": "repo",
  4733. "in": "path",
  4734. "required": true
  4735. },
  4736. {
  4737. "type": "string",
  4738. "description": "path of the file to create",
  4739. "name": "filepath",
  4740. "in": "path",
  4741. "required": true
  4742. },
  4743. {
  4744. "name": "body",
  4745. "in": "body",
  4746. "required": true,
  4747. "schema": {
  4748. "$ref": "#/definitions/CreateFileOptions"
  4749. }
  4750. }
  4751. ],
  4752. "responses": {
  4753. "201": {
  4754. "$ref": "#/responses/FileResponse"
  4755. },
  4756. "403": {
  4757. "$ref": "#/responses/error"
  4758. },
  4759. "404": {
  4760. "$ref": "#/responses/notFound"
  4761. },
  4762. "422": {
  4763. "$ref": "#/responses/error"
  4764. }
  4765. }
  4766. },
  4767. "delete": {
  4768. "consumes": [
  4769. "application/json"
  4770. ],
  4771. "produces": [
  4772. "application/json"
  4773. ],
  4774. "tags": [
  4775. "repository"
  4776. ],
  4777. "summary": "Delete a file in a repository",
  4778. "operationId": "repoDeleteFile",
  4779. "parameters": [
  4780. {
  4781. "type": "string",
  4782. "description": "owner of the repo",
  4783. "name": "owner",
  4784. "in": "path",
  4785. "required": true
  4786. },
  4787. {
  4788. "type": "string",
  4789. "description": "name of the repo",
  4790. "name": "repo",
  4791. "in": "path",
  4792. "required": true
  4793. },
  4794. {
  4795. "type": "string",
  4796. "description": "path of the file to delete",
  4797. "name": "filepath",
  4798. "in": "path",
  4799. "required": true
  4800. },
  4801. {
  4802. "name": "body",
  4803. "in": "body",
  4804. "required": true,
  4805. "schema": {
  4806. "$ref": "#/definitions/DeleteFileOptions"
  4807. }
  4808. }
  4809. ],
  4810. "responses": {
  4811. "200": {
  4812. "$ref": "#/responses/FileDeleteResponse"
  4813. },
  4814. "400": {
  4815. "$ref": "#/responses/error"
  4816. },
  4817. "403": {
  4818. "$ref": "#/responses/error"
  4819. },
  4820. "404": {
  4821. "$ref": "#/responses/error"
  4822. }
  4823. }
  4824. }
  4825. },
  4826. "/repos/{owner}/{repo}/diffpatch": {
  4827. "post": {
  4828. "consumes": [
  4829. "application/json"
  4830. ],
  4831. "produces": [
  4832. "application/json"
  4833. ],
  4834. "tags": [
  4835. "repository"
  4836. ],
  4837. "summary": "Apply diff patch to repository",
  4838. "operationId": "repoApplyDiffPatch",
  4839. "parameters": [
  4840. {
  4841. "type": "string",
  4842. "description": "owner of the repo",
  4843. "name": "owner",
  4844. "in": "path",
  4845. "required": true
  4846. },
  4847. {
  4848. "type": "string",
  4849. "description": "name of the repo",
  4850. "name": "repo",
  4851. "in": "path",
  4852. "required": true
  4853. },
  4854. {
  4855. "name": "body",
  4856. "in": "body",
  4857. "required": true,
  4858. "schema": {
  4859. "$ref": "#/definitions/UpdateFileOptions"
  4860. }
  4861. }
  4862. ],
  4863. "responses": {
  4864. "200": {
  4865. "$ref": "#/responses/FileResponse"
  4866. },
  4867. "404": {
  4868. "$ref": "#/responses/notFound"
  4869. }
  4870. }
  4871. }
  4872. },
  4873. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  4874. "get": {
  4875. "produces": [
  4876. "application/json"
  4877. ],
  4878. "tags": [
  4879. "repository"
  4880. ],
  4881. "summary": "Get the EditorConfig definitions of a file in a repository",
  4882. "operationId": "repoGetEditorConfig",
  4883. "parameters": [
  4884. {
  4885. "type": "string",
  4886. "description": "owner of the repo",
  4887. "name": "owner",
  4888. "in": "path",
  4889. "required": true
  4890. },
  4891. {
  4892. "type": "string",
  4893. "description": "name of the repo",
  4894. "name": "repo",
  4895. "in": "path",
  4896. "required": true
  4897. },
  4898. {
  4899. "type": "string",
  4900. "description": "filepath of file to get",
  4901. "name": "filepath",
  4902. "in": "path",
  4903. "required": true
  4904. },
  4905. {
  4906. "type": "string",
  4907. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4908. "name": "ref",
  4909. "in": "query"
  4910. }
  4911. ],
  4912. "responses": {
  4913. "200": {
  4914. "description": "success"
  4915. },
  4916. "404": {
  4917. "$ref": "#/responses/notFound"
  4918. }
  4919. }
  4920. }
  4921. },
  4922. "/repos/{owner}/{repo}/forks": {
  4923. "get": {
  4924. "produces": [
  4925. "application/json"
  4926. ],
  4927. "tags": [
  4928. "repository"
  4929. ],
  4930. "summary": "List a repository's forks",
  4931. "operationId": "listForks",
  4932. "parameters": [
  4933. {
  4934. "type": "string",
  4935. "description": "owner of the repo",
  4936. "name": "owner",
  4937. "in": "path",
  4938. "required": true
  4939. },
  4940. {
  4941. "type": "string",
  4942. "description": "name of the repo",
  4943. "name": "repo",
  4944. "in": "path",
  4945. "required": true
  4946. },
  4947. {
  4948. "type": "integer",
  4949. "description": "page number of results to return (1-based)",
  4950. "name": "page",
  4951. "in": "query"
  4952. },
  4953. {
  4954. "type": "integer",
  4955. "description": "page size of results",
  4956. "name": "limit",
  4957. "in": "query"
  4958. }
  4959. ],
  4960. "responses": {
  4961. "200": {
  4962. "$ref": "#/responses/RepositoryList"
  4963. },
  4964. "404": {
  4965. "$ref": "#/responses/notFound"
  4966. }
  4967. }
  4968. },
  4969. "post": {
  4970. "produces": [
  4971. "application/json"
  4972. ],
  4973. "tags": [
  4974. "repository"
  4975. ],
  4976. "summary": "Fork a repository",
  4977. "operationId": "createFork",
  4978. "parameters": [
  4979. {
  4980. "type": "string",
  4981. "description": "owner of the repo to fork",
  4982. "name": "owner",
  4983. "in": "path",
  4984. "required": true
  4985. },
  4986. {
  4987. "type": "string",
  4988. "description": "name of the repo to fork",
  4989. "name": "repo",
  4990. "in": "path",
  4991. "required": true
  4992. },
  4993. {
  4994. "name": "body",
  4995. "in": "body",
  4996. "schema": {
  4997. "$ref": "#/definitions/CreateForkOption"
  4998. }
  4999. }
  5000. ],
  5001. "responses": {
  5002. "202": {
  5003. "$ref": "#/responses/Repository"
  5004. },
  5005. "403": {
  5006. "$ref": "#/responses/forbidden"
  5007. },
  5008. "404": {
  5009. "$ref": "#/responses/notFound"
  5010. },
  5011. "409": {
  5012. "description": "The repository with the same name already exists."
  5013. },
  5014. "422": {
  5015. "$ref": "#/responses/validationError"
  5016. }
  5017. }
  5018. }
  5019. },
  5020. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  5021. "get": {
  5022. "produces": [
  5023. "application/json"
  5024. ],
  5025. "tags": [
  5026. "repository"
  5027. ],
  5028. "summary": "Gets the blob of a repository.",
  5029. "operationId": "GetBlob",
  5030. "parameters": [
  5031. {
  5032. "type": "string",
  5033. "description": "owner of the repo",
  5034. "name": "owner",
  5035. "in": "path",
  5036. "required": true
  5037. },
  5038. {
  5039. "type": "string",
  5040. "description": "name of the repo",
  5041. "name": "repo",
  5042. "in": "path",
  5043. "required": true
  5044. },
  5045. {
  5046. "type": "string",
  5047. "description": "sha of the commit",
  5048. "name": "sha",
  5049. "in": "path",
  5050. "required": true
  5051. }
  5052. ],
  5053. "responses": {
  5054. "200": {
  5055. "$ref": "#/responses/GitBlobResponse"
  5056. },
  5057. "400": {
  5058. "$ref": "#/responses/error"
  5059. },
  5060. "404": {
  5061. "$ref": "#/responses/notFound"
  5062. }
  5063. }
  5064. }
  5065. },
  5066. "/repos/{owner}/{repo}/git/commits/{sha}": {
  5067. "get": {
  5068. "produces": [
  5069. "application/json"
  5070. ],
  5071. "tags": [
  5072. "repository"
  5073. ],
  5074. "summary": "Get a single commit from a repository",
  5075. "operationId": "repoGetSingleCommit",
  5076. "parameters": [
  5077. {
  5078. "type": "string",
  5079. "description": "owner of the repo",
  5080. "name": "owner",
  5081. "in": "path",
  5082. "required": true
  5083. },
  5084. {
  5085. "type": "string",
  5086. "description": "name of the repo",
  5087. "name": "repo",
  5088. "in": "path",
  5089. "required": true
  5090. },
  5091. {
  5092. "type": "string",
  5093. "description": "a git ref or commit sha",
  5094. "name": "sha",
  5095. "in": "path",
  5096. "required": true
  5097. },
  5098. {
  5099. "type": "boolean",
  5100. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  5101. "name": "stat",
  5102. "in": "query"
  5103. },
  5104. {
  5105. "type": "boolean",
  5106. "description": "include verification for every commit (disable for speedup, default 'true')",
  5107. "name": "verification",
  5108. "in": "query"
  5109. },
  5110. {
  5111. "type": "boolean",
  5112. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5113. "name": "files",
  5114. "in": "query"
  5115. }
  5116. ],
  5117. "responses": {
  5118. "200": {
  5119. "$ref": "#/responses/Commit"
  5120. },
  5121. "404": {
  5122. "$ref": "#/responses/notFound"
  5123. },
  5124. "422": {
  5125. "$ref": "#/responses/validationError"
  5126. }
  5127. }
  5128. }
  5129. },
  5130. "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
  5131. "get": {
  5132. "produces": [
  5133. "text/plain"
  5134. ],
  5135. "tags": [
  5136. "repository"
  5137. ],
  5138. "summary": "Get a commit's diff or patch",
  5139. "operationId": "repoDownloadCommitDiffOrPatch",
  5140. "parameters": [
  5141. {
  5142. "type": "string",
  5143. "description": "owner of the repo",
  5144. "name": "owner",
  5145. "in": "path",
  5146. "required": true
  5147. },
  5148. {
  5149. "type": "string",
  5150. "description": "name of the repo",
  5151. "name": "repo",
  5152. "in": "path",
  5153. "required": true
  5154. },
  5155. {
  5156. "type": "string",
  5157. "description": "SHA of the commit to get",
  5158. "name": "sha",
  5159. "in": "path",
  5160. "required": true
  5161. },
  5162. {
  5163. "enum": [
  5164. "diff",
  5165. "patch"
  5166. ],
  5167. "type": "string",
  5168. "description": "whether the output is diff or patch",
  5169. "name": "diffType",
  5170. "in": "path",
  5171. "required": true
  5172. }
  5173. ],
  5174. "responses": {
  5175. "200": {
  5176. "$ref": "#/responses/string"
  5177. },
  5178. "404": {
  5179. "$ref": "#/responses/notFound"
  5180. }
  5181. }
  5182. }
  5183. },
  5184. "/repos/{owner}/{repo}/git/notes/{sha}": {
  5185. "get": {
  5186. "produces": [
  5187. "application/json"
  5188. ],
  5189. "tags": [
  5190. "repository"
  5191. ],
  5192. "summary": "Get a note corresponding to a single commit from a repository",
  5193. "operationId": "repoGetNote",
  5194. "parameters": [
  5195. {
  5196. "type": "string",
  5197. "description": "owner of the repo",
  5198. "name": "owner",
  5199. "in": "path",
  5200. "required": true
  5201. },
  5202. {
  5203. "type": "string",
  5204. "description": "name of the repo",
  5205. "name": "repo",
  5206. "in": "path",
  5207. "required": true
  5208. },
  5209. {
  5210. "type": "string",
  5211. "description": "a git ref or commit sha",
  5212. "name": "sha",
  5213. "in": "path",
  5214. "required": true
  5215. },
  5216. {
  5217. "type": "boolean",
  5218. "description": "include verification for every commit (disable for speedup, default 'true')",
  5219. "name": "verification",
  5220. "in": "query"
  5221. },
  5222. {
  5223. "type": "boolean",
  5224. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5225. "name": "files",
  5226. "in": "query"
  5227. }
  5228. ],
  5229. "responses": {
  5230. "200": {
  5231. "$ref": "#/responses/Note"
  5232. },
  5233. "404": {
  5234. "$ref": "#/responses/notFound"
  5235. },
  5236. "422": {
  5237. "$ref": "#/responses/validationError"
  5238. }
  5239. }
  5240. }
  5241. },
  5242. "/repos/{owner}/{repo}/git/refs": {
  5243. "get": {
  5244. "produces": [
  5245. "application/json"
  5246. ],
  5247. "tags": [
  5248. "repository"
  5249. ],
  5250. "summary": "Get specified ref or filtered repository's refs",
  5251. "operationId": "repoListAllGitRefs",
  5252. "parameters": [
  5253. {
  5254. "type": "string",
  5255. "description": "owner of the repo",
  5256. "name": "owner",
  5257. "in": "path",
  5258. "required": true
  5259. },
  5260. {
  5261. "type": "string",
  5262. "description": "name of the repo",
  5263. "name": "repo",
  5264. "in": "path",
  5265. "required": true
  5266. }
  5267. ],
  5268. "responses": {
  5269. "200": {
  5270. "$ref": "#/responses/ReferenceList"
  5271. },
  5272. "404": {
  5273. "$ref": "#/responses/notFound"
  5274. }
  5275. }
  5276. }
  5277. },
  5278. "/repos/{owner}/{repo}/git/refs/{ref}": {
  5279. "get": {
  5280. "produces": [
  5281. "application/json"
  5282. ],
  5283. "tags": [
  5284. "repository"
  5285. ],
  5286. "summary": "Get specified ref or filtered repository's refs",
  5287. "operationId": "repoListGitRefs",
  5288. "parameters": [
  5289. {
  5290. "type": "string",
  5291. "description": "owner of the repo",
  5292. "name": "owner",
  5293. "in": "path",
  5294. "required": true
  5295. },
  5296. {
  5297. "type": "string",
  5298. "description": "name of the repo",
  5299. "name": "repo",
  5300. "in": "path",
  5301. "required": true
  5302. },
  5303. {
  5304. "type": "string",
  5305. "description": "part or full name of the ref",
  5306. "name": "ref",
  5307. "in": "path",
  5308. "required": true
  5309. }
  5310. ],
  5311. "responses": {
  5312. "200": {
  5313. "$ref": "#/responses/ReferenceList"
  5314. },
  5315. "404": {
  5316. "$ref": "#/responses/notFound"
  5317. }
  5318. }
  5319. }
  5320. },
  5321. "/repos/{owner}/{repo}/git/tags/{sha}": {
  5322. "get": {
  5323. "produces": [
  5324. "application/json"
  5325. ],
  5326. "tags": [
  5327. "repository"
  5328. ],
  5329. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  5330. "operationId": "GetAnnotatedTag",
  5331. "parameters": [
  5332. {
  5333. "type": "string",
  5334. "description": "owner of the repo",
  5335. "name": "owner",
  5336. "in": "path",
  5337. "required": true
  5338. },
  5339. {
  5340. "type": "string",
  5341. "description": "name of the repo",
  5342. "name": "repo",
  5343. "in": "path",
  5344. "required": true
  5345. },
  5346. {
  5347. "type": "string",
  5348. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  5349. "name": "sha",
  5350. "in": "path",
  5351. "required": true
  5352. }
  5353. ],
  5354. "responses": {
  5355. "200": {
  5356. "$ref": "#/responses/AnnotatedTag"
  5357. },
  5358. "400": {
  5359. "$ref": "#/responses/error"
  5360. },
  5361. "404": {
  5362. "$ref": "#/responses/notFound"
  5363. }
  5364. }
  5365. }
  5366. },
  5367. "/repos/{owner}/{repo}/git/trees/{sha}": {
  5368. "get": {
  5369. "produces": [
  5370. "application/json"
  5371. ],
  5372. "tags": [
  5373. "repository"
  5374. ],
  5375. "summary": "Gets the tree of a repository.",
  5376. "operationId": "GetTree",
  5377. "parameters": [
  5378. {
  5379. "type": "string",
  5380. "description": "owner of the repo",
  5381. "name": "owner",
  5382. "in": "path",
  5383. "required": true
  5384. },
  5385. {
  5386. "type": "string",
  5387. "description": "name of the repo",
  5388. "name": "repo",
  5389. "in": "path",
  5390. "required": true
  5391. },
  5392. {
  5393. "type": "string",
  5394. "description": "sha of the commit",
  5395. "name": "sha",
  5396. "in": "path",
  5397. "required": true
  5398. },
  5399. {
  5400. "type": "boolean",
  5401. "description": "show all directories and files",
  5402. "name": "recursive",
  5403. "in": "query"
  5404. },
  5405. {
  5406. "type": "integer",
  5407. "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page",
  5408. "name": "page",
  5409. "in": "query"
  5410. },
  5411. {
  5412. "type": "integer",
  5413. "description": "number of items per page",
  5414. "name": "per_page",
  5415. "in": "query"
  5416. }
  5417. ],
  5418. "responses": {
  5419. "200": {
  5420. "$ref": "#/responses/GitTreeResponse"
  5421. },
  5422. "400": {
  5423. "$ref": "#/responses/error"
  5424. },
  5425. "404": {
  5426. "$ref": "#/responses/notFound"
  5427. }
  5428. }
  5429. }
  5430. },
  5431. "/repos/{owner}/{repo}/hooks": {
  5432. "get": {
  5433. "produces": [
  5434. "application/json"
  5435. ],
  5436. "tags": [
  5437. "repository"
  5438. ],
  5439. "summary": "List the hooks in a repository",
  5440. "operationId": "repoListHooks",
  5441. "parameters": [
  5442. {
  5443. "type": "string",
  5444. "description": "owner of the repo",
  5445. "name": "owner",
  5446. "in": "path",
  5447. "required": true
  5448. },
  5449. {
  5450. "type": "string",
  5451. "description": "name of the repo",
  5452. "name": "repo",
  5453. "in": "path",
  5454. "required": true
  5455. },
  5456. {
  5457. "type": "integer",
  5458. "description": "page number of results to return (1-based)",
  5459. "name": "page",
  5460. "in": "query"
  5461. },
  5462. {
  5463. "type": "integer",
  5464. "description": "page size of results",
  5465. "name": "limit",
  5466. "in": "query"
  5467. }
  5468. ],
  5469. "responses": {
  5470. "200": {
  5471. "$ref": "#/responses/HookList"
  5472. },
  5473. "404": {
  5474. "$ref": "#/responses/notFound"
  5475. }
  5476. }
  5477. },
  5478. "post": {
  5479. "consumes": [
  5480. "application/json"
  5481. ],
  5482. "produces": [
  5483. "application/json"
  5484. ],
  5485. "tags": [
  5486. "repository"
  5487. ],
  5488. "summary": "Create a hook",
  5489. "operationId": "repoCreateHook",
  5490. "parameters": [
  5491. {
  5492. "type": "string",
  5493. "description": "owner of the repo",
  5494. "name": "owner",
  5495. "in": "path",
  5496. "required": true
  5497. },
  5498. {
  5499. "type": "string",
  5500. "description": "name of the repo",
  5501. "name": "repo",
  5502. "in": "path",
  5503. "required": true
  5504. },
  5505. {
  5506. "name": "body",
  5507. "in": "body",
  5508. "schema": {
  5509. "$ref": "#/definitions/CreateHookOption"
  5510. }
  5511. }
  5512. ],
  5513. "responses": {
  5514. "201": {
  5515. "$ref": "#/responses/Hook"
  5516. },
  5517. "404": {
  5518. "$ref": "#/responses/notFound"
  5519. }
  5520. }
  5521. }
  5522. },
  5523. "/repos/{owner}/{repo}/hooks/git": {
  5524. "get": {
  5525. "produces": [
  5526. "application/json"
  5527. ],
  5528. "tags": [
  5529. "repository"
  5530. ],
  5531. "summary": "List the Git hooks in a repository",
  5532. "operationId": "repoListGitHooks",
  5533. "parameters": [
  5534. {
  5535. "type": "string",
  5536. "description": "owner of the repo",
  5537. "name": "owner",
  5538. "in": "path",
  5539. "required": true
  5540. },
  5541. {
  5542. "type": "string",
  5543. "description": "name of the repo",
  5544. "name": "repo",
  5545. "in": "path",
  5546. "required": true
  5547. }
  5548. ],
  5549. "responses": {
  5550. "200": {
  5551. "$ref": "#/responses/GitHookList"
  5552. },
  5553. "404": {
  5554. "$ref": "#/responses/notFound"
  5555. }
  5556. }
  5557. }
  5558. },
  5559. "/repos/{owner}/{repo}/hooks/git/{id}": {
  5560. "get": {
  5561. "produces": [
  5562. "application/json"
  5563. ],
  5564. "tags": [
  5565. "repository"
  5566. ],
  5567. "summary": "Get a Git hook",
  5568. "operationId": "repoGetGitHook",
  5569. "parameters": [
  5570. {
  5571. "type": "string",
  5572. "description": "owner of the repo",
  5573. "name": "owner",
  5574. "in": "path",
  5575. "required": true
  5576. },
  5577. {
  5578. "type": "string",
  5579. "description": "name of the repo",
  5580. "name": "repo",
  5581. "in": "path",
  5582. "required": true
  5583. },
  5584. {
  5585. "type": "string",
  5586. "description": "id of the hook to get",
  5587. "name": "id",
  5588. "in": "path",
  5589. "required": true
  5590. }
  5591. ],
  5592. "responses": {
  5593. "200": {
  5594. "$ref": "#/responses/GitHook"
  5595. },
  5596. "404": {
  5597. "$ref": "#/responses/notFound"
  5598. }
  5599. }
  5600. },
  5601. "delete": {
  5602. "produces": [
  5603. "application/json"
  5604. ],
  5605. "tags": [
  5606. "repository"
  5607. ],
  5608. "summary": "Delete a Git hook in a repository",
  5609. "operationId": "repoDeleteGitHook",
  5610. "parameters": [
  5611. {
  5612. "type": "string",
  5613. "description": "owner of the repo",
  5614. "name": "owner",
  5615. "in": "path",
  5616. "required": true
  5617. },
  5618. {
  5619. "type": "string",
  5620. "description": "name of the repo",
  5621. "name": "repo",
  5622. "in": "path",
  5623. "required": true
  5624. },
  5625. {
  5626. "type": "string",
  5627. "description": "id of the hook to get",
  5628. "name": "id",
  5629. "in": "path",
  5630. "required": true
  5631. }
  5632. ],
  5633. "responses": {
  5634. "204": {
  5635. "$ref": "#/responses/empty"
  5636. },
  5637. "404": {
  5638. "$ref": "#/responses/notFound"
  5639. }
  5640. }
  5641. },
  5642. "patch": {
  5643. "produces": [
  5644. "application/json"
  5645. ],
  5646. "tags": [
  5647. "repository"
  5648. ],
  5649. "summary": "Edit a Git hook in a repository",
  5650. "operationId": "repoEditGitHook",
  5651. "parameters": [
  5652. {
  5653. "type": "string",
  5654. "description": "owner of the repo",
  5655. "name": "owner",
  5656. "in": "path",
  5657. "required": true
  5658. },
  5659. {
  5660. "type": "string",
  5661. "description": "name of the repo",
  5662. "name": "repo",
  5663. "in": "path",
  5664. "required": true
  5665. },
  5666. {
  5667. "type": "string",
  5668. "description": "id of the hook to get",
  5669. "name": "id",
  5670. "in": "path",
  5671. "required": true
  5672. },
  5673. {
  5674. "name": "body",
  5675. "in": "body",
  5676. "schema": {
  5677. "$ref": "#/definitions/EditGitHookOption"
  5678. }
  5679. }
  5680. ],
  5681. "responses": {
  5682. "200": {
  5683. "$ref": "#/responses/GitHook"
  5684. },
  5685. "404": {
  5686. "$ref": "#/responses/notFound"
  5687. }
  5688. }
  5689. }
  5690. },
  5691. "/repos/{owner}/{repo}/hooks/{id}": {
  5692. "get": {
  5693. "produces": [
  5694. "application/json"
  5695. ],
  5696. "tags": [
  5697. "repository"
  5698. ],
  5699. "summary": "Get a hook",
  5700. "operationId": "repoGetHook",
  5701. "parameters": [
  5702. {
  5703. "type": "string",
  5704. "description": "owner of the repo",
  5705. "name": "owner",
  5706. "in": "path",
  5707. "required": true
  5708. },
  5709. {
  5710. "type": "string",
  5711. "description": "name of the repo",
  5712. "name": "repo",
  5713. "in": "path",
  5714. "required": true
  5715. },
  5716. {
  5717. "type": "integer",
  5718. "format": "int64",
  5719. "description": "id of the hook to get",
  5720. "name": "id",
  5721. "in": "path",
  5722. "required": true
  5723. }
  5724. ],
  5725. "responses": {
  5726. "200": {
  5727. "$ref": "#/responses/Hook"
  5728. },
  5729. "404": {
  5730. "$ref": "#/responses/notFound"
  5731. }
  5732. }
  5733. },
  5734. "delete": {
  5735. "produces": [
  5736. "application/json"
  5737. ],
  5738. "tags": [
  5739. "repository"
  5740. ],
  5741. "summary": "Delete a hook in a repository",
  5742. "operationId": "repoDeleteHook",
  5743. "parameters": [
  5744. {
  5745. "type": "string",
  5746. "description": "owner of the repo",
  5747. "name": "owner",
  5748. "in": "path",
  5749. "required": true
  5750. },
  5751. {
  5752. "type": "string",
  5753. "description": "name of the repo",
  5754. "name": "repo",
  5755. "in": "path",
  5756. "required": true
  5757. },
  5758. {
  5759. "type": "integer",
  5760. "format": "int64",
  5761. "description": "id of the hook to delete",
  5762. "name": "id",
  5763. "in": "path",
  5764. "required": true
  5765. }
  5766. ],
  5767. "responses": {
  5768. "204": {
  5769. "$ref": "#/responses/empty"
  5770. },
  5771. "404": {
  5772. "$ref": "#/responses/notFound"
  5773. }
  5774. }
  5775. },
  5776. "patch": {
  5777. "produces": [
  5778. "application/json"
  5779. ],
  5780. "tags": [
  5781. "repository"
  5782. ],
  5783. "summary": "Edit a hook in a repository",
  5784. "operationId": "repoEditHook",
  5785. "parameters": [
  5786. {
  5787. "type": "string",
  5788. "description": "owner of the repo",
  5789. "name": "owner",
  5790. "in": "path",
  5791. "required": true
  5792. },
  5793. {
  5794. "type": "string",
  5795. "description": "name of the repo",
  5796. "name": "repo",
  5797. "in": "path",
  5798. "required": true
  5799. },
  5800. {
  5801. "type": "integer",
  5802. "format": "int64",
  5803. "description": "index of the hook",
  5804. "name": "id",
  5805. "in": "path",
  5806. "required": true
  5807. },
  5808. {
  5809. "name": "body",
  5810. "in": "body",
  5811. "schema": {
  5812. "$ref": "#/definitions/EditHookOption"
  5813. }
  5814. }
  5815. ],
  5816. "responses": {
  5817. "200": {
  5818. "$ref": "#/responses/Hook"
  5819. },
  5820. "404": {
  5821. "$ref": "#/responses/notFound"
  5822. }
  5823. }
  5824. }
  5825. },
  5826. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  5827. "post": {
  5828. "produces": [
  5829. "application/json"
  5830. ],
  5831. "tags": [
  5832. "repository"
  5833. ],
  5834. "summary": "Test a push webhook",
  5835. "operationId": "repoTestHook",
  5836. "parameters": [
  5837. {
  5838. "type": "string",
  5839. "description": "owner of the repo",
  5840. "name": "owner",
  5841. "in": "path",
  5842. "required": true
  5843. },
  5844. {
  5845. "type": "string",
  5846. "description": "name of the repo",
  5847. "name": "repo",
  5848. "in": "path",
  5849. "required": true
  5850. },
  5851. {
  5852. "type": "integer",
  5853. "format": "int64",
  5854. "description": "id of the hook to test",
  5855. "name": "id",
  5856. "in": "path",
  5857. "required": true
  5858. },
  5859. {
  5860. "type": "string",
  5861. "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
  5862. "name": "ref",
  5863. "in": "query"
  5864. }
  5865. ],
  5866. "responses": {
  5867. "204": {
  5868. "$ref": "#/responses/empty"
  5869. },
  5870. "404": {
  5871. "$ref": "#/responses/notFound"
  5872. }
  5873. }
  5874. }
  5875. },
  5876. "/repos/{owner}/{repo}/issue_config": {
  5877. "get": {
  5878. "produces": [
  5879. "application/json"
  5880. ],
  5881. "tags": [
  5882. "repository"
  5883. ],
  5884. "summary": "Returns the issue config for a repo",
  5885. "operationId": "repoGetIssueConfig",
  5886. "parameters": [
  5887. {
  5888. "type": "string",
  5889. "description": "owner of the repo",
  5890. "name": "owner",
  5891. "in": "path",
  5892. "required": true
  5893. },
  5894. {
  5895. "type": "string",
  5896. "description": "name of the repo",
  5897. "name": "repo",
  5898. "in": "path",
  5899. "required": true
  5900. }
  5901. ],
  5902. "responses": {
  5903. "200": {
  5904. "$ref": "#/responses/RepoIssueConfig"
  5905. },
  5906. "404": {
  5907. "$ref": "#/responses/notFound"
  5908. }
  5909. }
  5910. }
  5911. },
  5912. "/repos/{owner}/{repo}/issue_config/validate": {
  5913. "get": {
  5914. "produces": [
  5915. "application/json"
  5916. ],
  5917. "tags": [
  5918. "repository"
  5919. ],
  5920. "summary": "Returns the validation information for a issue config",
  5921. "operationId": "repoValidateIssueConfig",
  5922. "parameters": [
  5923. {
  5924. "type": "string",
  5925. "description": "owner of the repo",
  5926. "name": "owner",
  5927. "in": "path",
  5928. "required": true
  5929. },
  5930. {
  5931. "type": "string",
  5932. "description": "name of the repo",
  5933. "name": "repo",
  5934. "in": "path",
  5935. "required": true
  5936. }
  5937. ],
  5938. "responses": {
  5939. "200": {
  5940. "$ref": "#/responses/RepoIssueConfigValidation"
  5941. },
  5942. "404": {
  5943. "$ref": "#/responses/notFound"
  5944. }
  5945. }
  5946. }
  5947. },
  5948. "/repos/{owner}/{repo}/issue_templates": {
  5949. "get": {
  5950. "produces": [
  5951. "application/json"
  5952. ],
  5953. "tags": [
  5954. "repository"
  5955. ],
  5956. "summary": "Get available issue templates for a repository",
  5957. "operationId": "repoGetIssueTemplates",
  5958. "parameters": [
  5959. {
  5960. "type": "string",
  5961. "description": "owner of the repo",
  5962. "name": "owner",
  5963. "in": "path",
  5964. "required": true
  5965. },
  5966. {
  5967. "type": "string",
  5968. "description": "name of the repo",
  5969. "name": "repo",
  5970. "in": "path",
  5971. "required": true
  5972. }
  5973. ],
  5974. "responses": {
  5975. "200": {
  5976. "$ref": "#/responses/IssueTemplates"
  5977. },
  5978. "404": {
  5979. "$ref": "#/responses/notFound"
  5980. }
  5981. }
  5982. }
  5983. },
  5984. "/repos/{owner}/{repo}/issues": {
  5985. "get": {
  5986. "produces": [
  5987. "application/json"
  5988. ],
  5989. "tags": [
  5990. "issue"
  5991. ],
  5992. "summary": "List a repository's issues",
  5993. "operationId": "issueListIssues",
  5994. "parameters": [
  5995. {
  5996. "type": "string",
  5997. "description": "owner of the repo",
  5998. "name": "owner",
  5999. "in": "path",
  6000. "required": true
  6001. },
  6002. {
  6003. "type": "string",
  6004. "description": "name of the repo",
  6005. "name": "repo",
  6006. "in": "path",
  6007. "required": true
  6008. },
  6009. {
  6010. "enum": [
  6011. "closed",
  6012. "open",
  6013. "all"
  6014. ],
  6015. "type": "string",
  6016. "description": "whether issue is open or closed",
  6017. "name": "state",
  6018. "in": "query"
  6019. },
  6020. {
  6021. "type": "string",
  6022. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  6023. "name": "labels",
  6024. "in": "query"
  6025. },
  6026. {
  6027. "type": "string",
  6028. "description": "search string",
  6029. "name": "q",
  6030. "in": "query"
  6031. },
  6032. {
  6033. "enum": [
  6034. "issues",
  6035. "pulls"
  6036. ],
  6037. "type": "string",
  6038. "description": "filter by type (issues / pulls) if set",
  6039. "name": "type",
  6040. "in": "query"
  6041. },
  6042. {
  6043. "type": "string",
  6044. "description": "comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded",
  6045. "name": "milestones",
  6046. "in": "query"
  6047. },
  6048. {
  6049. "type": "string",
  6050. "format": "date-time",
  6051. "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
  6052. "name": "since",
  6053. "in": "query"
  6054. },
  6055. {
  6056. "type": "string",
  6057. "format": "date-time",
  6058. "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
  6059. "name": "before",
  6060. "in": "query"
  6061. },
  6062. {
  6063. "type": "string",
  6064. "description": "Only show items which were created by the the given user",
  6065. "name": "created_by",
  6066. "in": "query"
  6067. },
  6068. {
  6069. "type": "string",
  6070. "description": "Only show items for which the given user is assigned",
  6071. "name": "assigned_by",
  6072. "in": "query"
  6073. },
  6074. {
  6075. "type": "string",
  6076. "description": "Only show items in which the given user was mentioned",
  6077. "name": "mentioned_by",
  6078. "in": "query"
  6079. },
  6080. {
  6081. "type": "integer",
  6082. "description": "page number of results to return (1-based)",
  6083. "name": "page",
  6084. "in": "query"
  6085. },
  6086. {
  6087. "type": "integer",
  6088. "description": "page size of results",
  6089. "name": "limit",
  6090. "in": "query"
  6091. }
  6092. ],
  6093. "responses": {
  6094. "200": {
  6095. "$ref": "#/responses/IssueList"
  6096. },
  6097. "404": {
  6098. "$ref": "#/responses/notFound"
  6099. }
  6100. }
  6101. },
  6102. "post": {
  6103. "consumes": [
  6104. "application/json"
  6105. ],
  6106. "produces": [
  6107. "application/json"
  6108. ],
  6109. "tags": [
  6110. "issue"
  6111. ],
  6112. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6113. "operationId": "issueCreateIssue",
  6114. "parameters": [
  6115. {
  6116. "type": "string",
  6117. "description": "owner of the repo",
  6118. "name": "owner",
  6119. "in": "path",
  6120. "required": true
  6121. },
  6122. {
  6123. "type": "string",
  6124. "description": "name of the repo",
  6125. "name": "repo",
  6126. "in": "path",
  6127. "required": true
  6128. },
  6129. {
  6130. "name": "body",
  6131. "in": "body",
  6132. "schema": {
  6133. "$ref": "#/definitions/CreateIssueOption"
  6134. }
  6135. }
  6136. ],
  6137. "responses": {
  6138. "201": {
  6139. "$ref": "#/responses/Issue"
  6140. },
  6141. "403": {
  6142. "$ref": "#/responses/forbidden"
  6143. },
  6144. "404": {
  6145. "$ref": "#/responses/notFound"
  6146. },
  6147. "412": {
  6148. "$ref": "#/responses/error"
  6149. },
  6150. "422": {
  6151. "$ref": "#/responses/validationError"
  6152. }
  6153. }
  6154. }
  6155. },
  6156. "/repos/{owner}/{repo}/issues/comments": {
  6157. "get": {
  6158. "produces": [
  6159. "application/json"
  6160. ],
  6161. "tags": [
  6162. "issue"
  6163. ],
  6164. "summary": "List all comments in a repository",
  6165. "operationId": "issueGetRepoComments",
  6166. "parameters": [
  6167. {
  6168. "type": "string",
  6169. "description": "owner of the repo",
  6170. "name": "owner",
  6171. "in": "path",
  6172. "required": true
  6173. },
  6174. {
  6175. "type": "string",
  6176. "description": "name of the repo",
  6177. "name": "repo",
  6178. "in": "path",
  6179. "required": true
  6180. },
  6181. {
  6182. "type": "string",
  6183. "format": "date-time",
  6184. "description": "if provided, only comments updated since the provided time are returned.",
  6185. "name": "since",
  6186. "in": "query"
  6187. },
  6188. {
  6189. "type": "string",
  6190. "format": "date-time",
  6191. "description": "if provided, only comments updated before the provided time are returned.",
  6192. "name": "before",
  6193. "in": "query"
  6194. },
  6195. {
  6196. "type": "integer",
  6197. "description": "page number of results to return (1-based)",
  6198. "name": "page",
  6199. "in": "query"
  6200. },
  6201. {
  6202. "type": "integer",
  6203. "description": "page size of results",
  6204. "name": "limit",
  6205. "in": "query"
  6206. }
  6207. ],
  6208. "responses": {
  6209. "200": {
  6210. "$ref": "#/responses/CommentList"
  6211. },
  6212. "404": {
  6213. "$ref": "#/responses/notFound"
  6214. }
  6215. }
  6216. }
  6217. },
  6218. "/repos/{owner}/{repo}/issues/comments/{id}": {
  6219. "get": {
  6220. "consumes": [
  6221. "application/json"
  6222. ],
  6223. "produces": [
  6224. "application/json"
  6225. ],
  6226. "tags": [
  6227. "issue"
  6228. ],
  6229. "summary": "Get a comment",
  6230. "operationId": "issueGetComment",
  6231. "parameters": [
  6232. {
  6233. "type": "string",
  6234. "description": "owner of the repo",
  6235. "name": "owner",
  6236. "in": "path",
  6237. "required": true
  6238. },
  6239. {
  6240. "type": "string",
  6241. "description": "name of the repo",
  6242. "name": "repo",
  6243. "in": "path",
  6244. "required": true
  6245. },
  6246. {
  6247. "type": "integer",
  6248. "format": "int64",
  6249. "description": "id of the comment",
  6250. "name": "id",
  6251. "in": "path",
  6252. "required": true
  6253. }
  6254. ],
  6255. "responses": {
  6256. "200": {
  6257. "$ref": "#/responses/Comment"
  6258. },
  6259. "204": {
  6260. "$ref": "#/responses/empty"
  6261. },
  6262. "403": {
  6263. "$ref": "#/responses/forbidden"
  6264. },
  6265. "404": {
  6266. "$ref": "#/responses/notFound"
  6267. }
  6268. }
  6269. },
  6270. "delete": {
  6271. "tags": [
  6272. "issue"
  6273. ],
  6274. "summary": "Delete a comment",
  6275. "operationId": "issueDeleteComment",
  6276. "parameters": [
  6277. {
  6278. "type": "string",
  6279. "description": "owner of the repo",
  6280. "name": "owner",
  6281. "in": "path",
  6282. "required": true
  6283. },
  6284. {
  6285. "type": "string",
  6286. "description": "name of the repo",
  6287. "name": "repo",
  6288. "in": "path",
  6289. "required": true
  6290. },
  6291. {
  6292. "type": "integer",
  6293. "format": "int64",
  6294. "description": "id of comment to delete",
  6295. "name": "id",
  6296. "in": "path",
  6297. "required": true
  6298. }
  6299. ],
  6300. "responses": {
  6301. "204": {
  6302. "$ref": "#/responses/empty"
  6303. },
  6304. "403": {
  6305. "$ref": "#/responses/forbidden"
  6306. },
  6307. "404": {
  6308. "$ref": "#/responses/notFound"
  6309. }
  6310. }
  6311. },
  6312. "patch": {
  6313. "consumes": [
  6314. "application/json"
  6315. ],
  6316. "produces": [
  6317. "application/json"
  6318. ],
  6319. "tags": [
  6320. "issue"
  6321. ],
  6322. "summary": "Edit a comment",
  6323. "operationId": "issueEditComment",
  6324. "parameters": [
  6325. {
  6326. "type": "string",
  6327. "description": "owner of the repo",
  6328. "name": "owner",
  6329. "in": "path",
  6330. "required": true
  6331. },
  6332. {
  6333. "type": "string",
  6334. "description": "name of the repo",
  6335. "name": "repo",
  6336. "in": "path",
  6337. "required": true
  6338. },
  6339. {
  6340. "type": "integer",
  6341. "format": "int64",
  6342. "description": "id of the comment to edit",
  6343. "name": "id",
  6344. "in": "path",
  6345. "required": true
  6346. },
  6347. {
  6348. "name": "body",
  6349. "in": "body",
  6350. "schema": {
  6351. "$ref": "#/definitions/EditIssueCommentOption"
  6352. }
  6353. }
  6354. ],
  6355. "responses": {
  6356. "200": {
  6357. "$ref": "#/responses/Comment"
  6358. },
  6359. "204": {
  6360. "$ref": "#/responses/empty"
  6361. },
  6362. "403": {
  6363. "$ref": "#/responses/forbidden"
  6364. },
  6365. "404": {
  6366. "$ref": "#/responses/notFound"
  6367. }
  6368. }
  6369. }
  6370. },
  6371. "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
  6372. "get": {
  6373. "produces": [
  6374. "application/json"
  6375. ],
  6376. "tags": [
  6377. "issue"
  6378. ],
  6379. "summary": "List comment's attachments",
  6380. "operationId": "issueListIssueCommentAttachments",
  6381. "parameters": [
  6382. {
  6383. "type": "string",
  6384. "description": "owner of the repo",
  6385. "name": "owner",
  6386. "in": "path",
  6387. "required": true
  6388. },
  6389. {
  6390. "type": "string",
  6391. "description": "name of the repo",
  6392. "name": "repo",
  6393. "in": "path",
  6394. "required": true
  6395. },
  6396. {
  6397. "type": "integer",
  6398. "format": "int64",
  6399. "description": "id of the comment",
  6400. "name": "id",
  6401. "in": "path",
  6402. "required": true
  6403. }
  6404. ],
  6405. "responses": {
  6406. "200": {
  6407. "$ref": "#/responses/AttachmentList"
  6408. },
  6409. "404": {
  6410. "$ref": "#/responses/error"
  6411. }
  6412. }
  6413. },
  6414. "post": {
  6415. "consumes": [
  6416. "multipart/form-data"
  6417. ],
  6418. "produces": [
  6419. "application/json"
  6420. ],
  6421. "tags": [
  6422. "issue"
  6423. ],
  6424. "summary": "Create a comment attachment",
  6425. "operationId": "issueCreateIssueCommentAttachment",
  6426. "parameters": [
  6427. {
  6428. "type": "string",
  6429. "description": "owner of the repo",
  6430. "name": "owner",
  6431. "in": "path",
  6432. "required": true
  6433. },
  6434. {
  6435. "type": "string",
  6436. "description": "name of the repo",
  6437. "name": "repo",
  6438. "in": "path",
  6439. "required": true
  6440. },
  6441. {
  6442. "type": "integer",
  6443. "format": "int64",
  6444. "description": "id of the comment",
  6445. "name": "id",
  6446. "in": "path",
  6447. "required": true
  6448. },
  6449. {
  6450. "type": "string",
  6451. "description": "name of the attachment",
  6452. "name": "name",
  6453. "in": "query"
  6454. },
  6455. {
  6456. "type": "file",
  6457. "description": "attachment to upload",
  6458. "name": "attachment",
  6459. "in": "formData",
  6460. "required": true
  6461. }
  6462. ],
  6463. "responses": {
  6464. "201": {
  6465. "$ref": "#/responses/Attachment"
  6466. },
  6467. "400": {
  6468. "$ref": "#/responses/error"
  6469. },
  6470. "404": {
  6471. "$ref": "#/responses/error"
  6472. }
  6473. }
  6474. }
  6475. },
  6476. "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
  6477. "get": {
  6478. "produces": [
  6479. "application/json"
  6480. ],
  6481. "tags": [
  6482. "issue"
  6483. ],
  6484. "summary": "Get a comment attachment",
  6485. "operationId": "issueGetIssueCommentAttachment",
  6486. "parameters": [
  6487. {
  6488. "type": "string",
  6489. "description": "owner of the repo",
  6490. "name": "owner",
  6491. "in": "path",
  6492. "required": true
  6493. },
  6494. {
  6495. "type": "string",
  6496. "description": "name of the repo",
  6497. "name": "repo",
  6498. "in": "path",
  6499. "required": true
  6500. },
  6501. {
  6502. "type": "integer",
  6503. "format": "int64",
  6504. "description": "id of the comment",
  6505. "name": "id",
  6506. "in": "path",
  6507. "required": true
  6508. },
  6509. {
  6510. "type": "integer",
  6511. "format": "int64",
  6512. "description": "id of the attachment to get",
  6513. "name": "attachment_id",
  6514. "in": "path",
  6515. "required": true
  6516. }
  6517. ],
  6518. "responses": {
  6519. "200": {
  6520. "$ref": "#/responses/Attachment"
  6521. },
  6522. "404": {
  6523. "$ref": "#/responses/error"
  6524. }
  6525. }
  6526. },
  6527. "delete": {
  6528. "produces": [
  6529. "application/json"
  6530. ],
  6531. "tags": [
  6532. "issue"
  6533. ],
  6534. "summary": "Delete a comment attachment",
  6535. "operationId": "issueDeleteIssueCommentAttachment",
  6536. "parameters": [
  6537. {
  6538. "type": "string",
  6539. "description": "owner of the repo",
  6540. "name": "owner",
  6541. "in": "path",
  6542. "required": true
  6543. },
  6544. {
  6545. "type": "string",
  6546. "description": "name of the repo",
  6547. "name": "repo",
  6548. "in": "path",
  6549. "required": true
  6550. },
  6551. {
  6552. "type": "integer",
  6553. "format": "int64",
  6554. "description": "id of the comment",
  6555. "name": "id",
  6556. "in": "path",
  6557. "required": true
  6558. },
  6559. {
  6560. "type": "integer",
  6561. "format": "int64",
  6562. "description": "id of the attachment to delete",
  6563. "name": "attachment_id",
  6564. "in": "path",
  6565. "required": true
  6566. }
  6567. ],
  6568. "responses": {
  6569. "204": {
  6570. "$ref": "#/responses/empty"
  6571. },
  6572. "404": {
  6573. "$ref": "#/responses/error"
  6574. }
  6575. }
  6576. },
  6577. "patch": {
  6578. "consumes": [
  6579. "application/json"
  6580. ],
  6581. "produces": [
  6582. "application/json"
  6583. ],
  6584. "tags": [
  6585. "issue"
  6586. ],
  6587. "summary": "Edit a comment attachment",
  6588. "operationId": "issueEditIssueCommentAttachment",
  6589. "parameters": [
  6590. {
  6591. "type": "string",
  6592. "description": "owner of the repo",
  6593. "name": "owner",
  6594. "in": "path",
  6595. "required": true
  6596. },
  6597. {
  6598. "type": "string",
  6599. "description": "name of the repo",
  6600. "name": "repo",
  6601. "in": "path",
  6602. "required": true
  6603. },
  6604. {
  6605. "type": "integer",
  6606. "format": "int64",
  6607. "description": "id of the comment",
  6608. "name": "id",
  6609. "in": "path",
  6610. "required": true
  6611. },
  6612. {
  6613. "type": "integer",
  6614. "format": "int64",
  6615. "description": "id of the attachment to edit",
  6616. "name": "attachment_id",
  6617. "in": "path",
  6618. "required": true
  6619. },
  6620. {
  6621. "name": "body",
  6622. "in": "body",
  6623. "schema": {
  6624. "$ref": "#/definitions/EditAttachmentOptions"
  6625. }
  6626. }
  6627. ],
  6628. "responses": {
  6629. "201": {
  6630. "$ref": "#/responses/Attachment"
  6631. },
  6632. "404": {
  6633. "$ref": "#/responses/error"
  6634. }
  6635. }
  6636. }
  6637. },
  6638. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  6639. "get": {
  6640. "consumes": [
  6641. "application/json"
  6642. ],
  6643. "produces": [
  6644. "application/json"
  6645. ],
  6646. "tags": [
  6647. "issue"
  6648. ],
  6649. "summary": "Get a list of reactions from a comment of an issue",
  6650. "operationId": "issueGetCommentReactions",
  6651. "parameters": [
  6652. {
  6653. "type": "string",
  6654. "description": "owner of the repo",
  6655. "name": "owner",
  6656. "in": "path",
  6657. "required": true
  6658. },
  6659. {
  6660. "type": "string",
  6661. "description": "name of the repo",
  6662. "name": "repo",
  6663. "in": "path",
  6664. "required": true
  6665. },
  6666. {
  6667. "type": "integer",
  6668. "format": "int64",
  6669. "description": "id of the comment to edit",
  6670. "name": "id",
  6671. "in": "path",
  6672. "required": true
  6673. }
  6674. ],
  6675. "responses": {
  6676. "200": {
  6677. "$ref": "#/responses/ReactionList"
  6678. },
  6679. "403": {
  6680. "$ref": "#/responses/forbidden"
  6681. },
  6682. "404": {
  6683. "$ref": "#/responses/notFound"
  6684. }
  6685. }
  6686. },
  6687. "post": {
  6688. "consumes": [
  6689. "application/json"
  6690. ],
  6691. "produces": [
  6692. "application/json"
  6693. ],
  6694. "tags": [
  6695. "issue"
  6696. ],
  6697. "summary": "Add a reaction to a comment of an issue",
  6698. "operationId": "issuePostCommentReaction",
  6699. "parameters": [
  6700. {
  6701. "type": "string",
  6702. "description": "owner of the repo",
  6703. "name": "owner",
  6704. "in": "path",
  6705. "required": true
  6706. },
  6707. {
  6708. "type": "string",
  6709. "description": "name of the repo",
  6710. "name": "repo",
  6711. "in": "path",
  6712. "required": true
  6713. },
  6714. {
  6715. "type": "integer",
  6716. "format": "int64",
  6717. "description": "id of the comment to edit",
  6718. "name": "id",
  6719. "in": "path",
  6720. "required": true
  6721. },
  6722. {
  6723. "name": "content",
  6724. "in": "body",
  6725. "schema": {
  6726. "$ref": "#/definitions/EditReactionOption"
  6727. }
  6728. }
  6729. ],
  6730. "responses": {
  6731. "200": {
  6732. "$ref": "#/responses/Reaction"
  6733. },
  6734. "201": {
  6735. "$ref": "#/responses/Reaction"
  6736. },
  6737. "403": {
  6738. "$ref": "#/responses/forbidden"
  6739. },
  6740. "404": {
  6741. "$ref": "#/responses/notFound"
  6742. }
  6743. }
  6744. },
  6745. "delete": {
  6746. "consumes": [
  6747. "application/json"
  6748. ],
  6749. "produces": [
  6750. "application/json"
  6751. ],
  6752. "tags": [
  6753. "issue"
  6754. ],
  6755. "summary": "Remove a reaction from a comment of an issue",
  6756. "operationId": "issueDeleteCommentReaction",
  6757. "parameters": [
  6758. {
  6759. "type": "string",
  6760. "description": "owner of the repo",
  6761. "name": "owner",
  6762. "in": "path",
  6763. "required": true
  6764. },
  6765. {
  6766. "type": "string",
  6767. "description": "name of the repo",
  6768. "name": "repo",
  6769. "in": "path",
  6770. "required": true
  6771. },
  6772. {
  6773. "type": "integer",
  6774. "format": "int64",
  6775. "description": "id of the comment to edit",
  6776. "name": "id",
  6777. "in": "path",
  6778. "required": true
  6779. },
  6780. {
  6781. "name": "content",
  6782. "in": "body",
  6783. "schema": {
  6784. "$ref": "#/definitions/EditReactionOption"
  6785. }
  6786. }
  6787. ],
  6788. "responses": {
  6789. "200": {
  6790. "$ref": "#/responses/empty"
  6791. },
  6792. "403": {
  6793. "$ref": "#/responses/forbidden"
  6794. },
  6795. "404": {
  6796. "$ref": "#/responses/notFound"
  6797. }
  6798. }
  6799. }
  6800. },
  6801. "/repos/{owner}/{repo}/issues/pinned": {
  6802. "get": {
  6803. "produces": [
  6804. "application/json"
  6805. ],
  6806. "tags": [
  6807. "repository"
  6808. ],
  6809. "summary": "List a repo's pinned issues",
  6810. "operationId": "repoListPinnedIssues",
  6811. "parameters": [
  6812. {
  6813. "type": "string",
  6814. "description": "owner of the repo",
  6815. "name": "owner",
  6816. "in": "path",
  6817. "required": true
  6818. },
  6819. {
  6820. "type": "string",
  6821. "description": "name of the repo",
  6822. "name": "repo",
  6823. "in": "path",
  6824. "required": true
  6825. }
  6826. ],
  6827. "responses": {
  6828. "200": {
  6829. "$ref": "#/responses/IssueList"
  6830. },
  6831. "404": {
  6832. "$ref": "#/responses/notFound"
  6833. }
  6834. }
  6835. }
  6836. },
  6837. "/repos/{owner}/{repo}/issues/{index}": {
  6838. "get": {
  6839. "produces": [
  6840. "application/json"
  6841. ],
  6842. "tags": [
  6843. "issue"
  6844. ],
  6845. "summary": "Get an issue",
  6846. "operationId": "issueGetIssue",
  6847. "parameters": [
  6848. {
  6849. "type": "string",
  6850. "description": "owner of the repo",
  6851. "name": "owner",
  6852. "in": "path",
  6853. "required": true
  6854. },
  6855. {
  6856. "type": "string",
  6857. "description": "name of the repo",
  6858. "name": "repo",
  6859. "in": "path",
  6860. "required": true
  6861. },
  6862. {
  6863. "type": "integer",
  6864. "format": "int64",
  6865. "description": "index of the issue to get",
  6866. "name": "index",
  6867. "in": "path",
  6868. "required": true
  6869. }
  6870. ],
  6871. "responses": {
  6872. "200": {
  6873. "$ref": "#/responses/Issue"
  6874. },
  6875. "404": {
  6876. "$ref": "#/responses/notFound"
  6877. }
  6878. }
  6879. },
  6880. "delete": {
  6881. "tags": [
  6882. "issue"
  6883. ],
  6884. "summary": "Delete an issue",
  6885. "operationId": "issueDelete",
  6886. "parameters": [
  6887. {
  6888. "type": "string",
  6889. "description": "owner of the repo",
  6890. "name": "owner",
  6891. "in": "path",
  6892. "required": true
  6893. },
  6894. {
  6895. "type": "string",
  6896. "description": "name of the repo",
  6897. "name": "repo",
  6898. "in": "path",
  6899. "required": true
  6900. },
  6901. {
  6902. "type": "integer",
  6903. "format": "int64",
  6904. "description": "index of issue to delete",
  6905. "name": "index",
  6906. "in": "path",
  6907. "required": true
  6908. }
  6909. ],
  6910. "responses": {
  6911. "204": {
  6912. "$ref": "#/responses/empty"
  6913. },
  6914. "403": {
  6915. "$ref": "#/responses/forbidden"
  6916. },
  6917. "404": {
  6918. "$ref": "#/responses/notFound"
  6919. }
  6920. }
  6921. },
  6922. "patch": {
  6923. "consumes": [
  6924. "application/json"
  6925. ],
  6926. "produces": [
  6927. "application/json"
  6928. ],
  6929. "tags": [
  6930. "issue"
  6931. ],
  6932. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6933. "operationId": "issueEditIssue",
  6934. "parameters": [
  6935. {
  6936. "type": "string",
  6937. "description": "owner of the repo",
  6938. "name": "owner",
  6939. "in": "path",
  6940. "required": true
  6941. },
  6942. {
  6943. "type": "string",
  6944. "description": "name of the repo",
  6945. "name": "repo",
  6946. "in": "path",
  6947. "required": true
  6948. },
  6949. {
  6950. "type": "integer",
  6951. "format": "int64",
  6952. "description": "index of the issue to edit",
  6953. "name": "index",
  6954. "in": "path",
  6955. "required": true
  6956. },
  6957. {
  6958. "name": "body",
  6959. "in": "body",
  6960. "schema": {
  6961. "$ref": "#/definitions/EditIssueOption"
  6962. }
  6963. }
  6964. ],
  6965. "responses": {
  6966. "201": {
  6967. "$ref": "#/responses/Issue"
  6968. },
  6969. "403": {
  6970. "$ref": "#/responses/forbidden"
  6971. },
  6972. "404": {
  6973. "$ref": "#/responses/notFound"
  6974. },
  6975. "412": {
  6976. "$ref": "#/responses/error"
  6977. }
  6978. }
  6979. }
  6980. },
  6981. "/repos/{owner}/{repo}/issues/{index}/assets": {
  6982. "get": {
  6983. "produces": [
  6984. "application/json"
  6985. ],
  6986. "tags": [
  6987. "issue"
  6988. ],
  6989. "summary": "List issue's attachments",
  6990. "operationId": "issueListIssueAttachments",
  6991. "parameters": [
  6992. {
  6993. "type": "string",
  6994. "description": "owner of the repo",
  6995. "name": "owner",
  6996. "in": "path",
  6997. "required": true
  6998. },
  6999. {
  7000. "type": "string",
  7001. "description": "name of the repo",
  7002. "name": "repo",
  7003. "in": "path",
  7004. "required": true
  7005. },
  7006. {
  7007. "type": "integer",
  7008. "format": "int64",
  7009. "description": "index of the issue",
  7010. "name": "index",
  7011. "in": "path",
  7012. "required": true
  7013. }
  7014. ],
  7015. "responses": {
  7016. "200": {
  7017. "$ref": "#/responses/AttachmentList"
  7018. },
  7019. "404": {
  7020. "$ref": "#/responses/error"
  7021. }
  7022. }
  7023. },
  7024. "post": {
  7025. "consumes": [
  7026. "multipart/form-data"
  7027. ],
  7028. "produces": [
  7029. "application/json"
  7030. ],
  7031. "tags": [
  7032. "issue"
  7033. ],
  7034. "summary": "Create an issue attachment",
  7035. "operationId": "issueCreateIssueAttachment",
  7036. "parameters": [
  7037. {
  7038. "type": "string",
  7039. "description": "owner of the repo",
  7040. "name": "owner",
  7041. "in": "path",
  7042. "required": true
  7043. },
  7044. {
  7045. "type": "string",
  7046. "description": "name of the repo",
  7047. "name": "repo",
  7048. "in": "path",
  7049. "required": true
  7050. },
  7051. {
  7052. "type": "integer",
  7053. "format": "int64",
  7054. "description": "index of the issue",
  7055. "name": "index",
  7056. "in": "path",
  7057. "required": true
  7058. },
  7059. {
  7060. "type": "string",
  7061. "description": "name of the attachment",
  7062. "name": "name",
  7063. "in": "query"
  7064. },
  7065. {
  7066. "type": "file",
  7067. "description": "attachment to upload",
  7068. "name": "attachment",
  7069. "in": "formData",
  7070. "required": true
  7071. }
  7072. ],
  7073. "responses": {
  7074. "201": {
  7075. "$ref": "#/responses/Attachment"
  7076. },
  7077. "400": {
  7078. "$ref": "#/responses/error"
  7079. },
  7080. "404": {
  7081. "$ref": "#/responses/error"
  7082. }
  7083. }
  7084. }
  7085. },
  7086. "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
  7087. "get": {
  7088. "produces": [
  7089. "application/json"
  7090. ],
  7091. "tags": [
  7092. "issue"
  7093. ],
  7094. "summary": "Get an issue attachment",
  7095. "operationId": "issueGetIssueAttachment",
  7096. "parameters": [
  7097. {
  7098. "type": "string",
  7099. "description": "owner of the repo",
  7100. "name": "owner",
  7101. "in": "path",
  7102. "required": true
  7103. },
  7104. {
  7105. "type": "string",
  7106. "description": "name of the repo",
  7107. "name": "repo",
  7108. "in": "path",
  7109. "required": true
  7110. },
  7111. {
  7112. "type": "integer",
  7113. "format": "int64",
  7114. "description": "index of the issue",
  7115. "name": "index",
  7116. "in": "path",
  7117. "required": true
  7118. },
  7119. {
  7120. "type": "integer",
  7121. "format": "int64",
  7122. "description": "id of the attachment to get",
  7123. "name": "attachment_id",
  7124. "in": "path",
  7125. "required": true
  7126. }
  7127. ],
  7128. "responses": {
  7129. "200": {
  7130. "$ref": "#/responses/Attachment"
  7131. },
  7132. "404": {
  7133. "$ref": "#/responses/error"
  7134. }
  7135. }
  7136. },
  7137. "delete": {
  7138. "produces": [
  7139. "application/json"
  7140. ],
  7141. "tags": [
  7142. "issue"
  7143. ],
  7144. "summary": "Delete an issue attachment",
  7145. "operationId": "issueDeleteIssueAttachment",
  7146. "parameters": [
  7147. {
  7148. "type": "string",
  7149. "description": "owner of the repo",
  7150. "name": "owner",
  7151. "in": "path",
  7152. "required": true
  7153. },
  7154. {
  7155. "type": "string",
  7156. "description": "name of the repo",
  7157. "name": "repo",
  7158. "in": "path",
  7159. "required": true
  7160. },
  7161. {
  7162. "type": "integer",
  7163. "format": "int64",
  7164. "description": "index of the issue",
  7165. "name": "index",
  7166. "in": "path",
  7167. "required": true
  7168. },
  7169. {
  7170. "type": "integer",
  7171. "format": "int64",
  7172. "description": "id of the attachment to delete",
  7173. "name": "attachment_id",
  7174. "in": "path",
  7175. "required": true
  7176. }
  7177. ],
  7178. "responses": {
  7179. "204": {
  7180. "$ref": "#/responses/empty"
  7181. },
  7182. "404": {
  7183. "$ref": "#/responses/error"
  7184. }
  7185. }
  7186. },
  7187. "patch": {
  7188. "consumes": [
  7189. "application/json"
  7190. ],
  7191. "produces": [
  7192. "application/json"
  7193. ],
  7194. "tags": [
  7195. "issue"
  7196. ],
  7197. "summary": "Edit an issue attachment",
  7198. "operationId": "issueEditIssueAttachment",
  7199. "parameters": [
  7200. {
  7201. "type": "string",
  7202. "description": "owner of the repo",
  7203. "name": "owner",
  7204. "in": "path",
  7205. "required": true
  7206. },
  7207. {
  7208. "type": "string",
  7209. "description": "name of the repo",
  7210. "name": "repo",
  7211. "in": "path",
  7212. "required": true
  7213. },
  7214. {
  7215. "type": "integer",
  7216. "format": "int64",
  7217. "description": "index of the issue",
  7218. "name": "index",
  7219. "in": "path",
  7220. "required": true
  7221. },
  7222. {
  7223. "type": "integer",
  7224. "format": "int64",
  7225. "description": "id of the attachment to edit",
  7226. "name": "attachment_id",
  7227. "in": "path",
  7228. "required": true
  7229. },
  7230. {
  7231. "name": "body",
  7232. "in": "body",
  7233. "schema": {
  7234. "$ref": "#/definitions/EditAttachmentOptions"
  7235. }
  7236. }
  7237. ],
  7238. "responses": {
  7239. "201": {
  7240. "$ref": "#/responses/Attachment"
  7241. },
  7242. "404": {
  7243. "$ref": "#/responses/error"
  7244. }
  7245. }
  7246. }
  7247. },
  7248. "/repos/{owner}/{repo}/issues/{index}/blocks": {
  7249. "get": {
  7250. "produces": [
  7251. "application/json"
  7252. ],
  7253. "tags": [
  7254. "issue"
  7255. ],
  7256. "summary": "List issues that are blocked by this issue",
  7257. "operationId": "issueListBlocks",
  7258. "parameters": [
  7259. {
  7260. "type": "string",
  7261. "description": "owner of the repo",
  7262. "name": "owner",
  7263. "in": "path",
  7264. "required": true
  7265. },
  7266. {
  7267. "type": "string",
  7268. "description": "name of the repo",
  7269. "name": "repo",
  7270. "in": "path",
  7271. "required": true
  7272. },
  7273. {
  7274. "type": "string",
  7275. "description": "index of the issue",
  7276. "name": "index",
  7277. "in": "path",
  7278. "required": true
  7279. },
  7280. {
  7281. "type": "integer",
  7282. "description": "page number of results to return (1-based)",
  7283. "name": "page",
  7284. "in": "query"
  7285. },
  7286. {
  7287. "type": "integer",
  7288. "description": "page size of results",
  7289. "name": "limit",
  7290. "in": "query"
  7291. }
  7292. ],
  7293. "responses": {
  7294. "200": {
  7295. "$ref": "#/responses/IssueList"
  7296. },
  7297. "404": {
  7298. "$ref": "#/responses/notFound"
  7299. }
  7300. }
  7301. },
  7302. "post": {
  7303. "produces": [
  7304. "application/json"
  7305. ],
  7306. "tags": [
  7307. "issue"
  7308. ],
  7309. "summary": "Block the issue given in the body by the issue in path",
  7310. "operationId": "issueCreateIssueBlocking",
  7311. "parameters": [
  7312. {
  7313. "type": "string",
  7314. "description": "owner of the repo",
  7315. "name": "owner",
  7316. "in": "path",
  7317. "required": true
  7318. },
  7319. {
  7320. "type": "string",
  7321. "description": "name of the repo",
  7322. "name": "repo",
  7323. "in": "path",
  7324. "required": true
  7325. },
  7326. {
  7327. "type": "string",
  7328. "description": "index of the issue",
  7329. "name": "index",
  7330. "in": "path",
  7331. "required": true
  7332. },
  7333. {
  7334. "name": "body",
  7335. "in": "body",
  7336. "schema": {
  7337. "$ref": "#/definitions/IssueMeta"
  7338. }
  7339. }
  7340. ],
  7341. "responses": {
  7342. "201": {
  7343. "$ref": "#/responses/Issue"
  7344. },
  7345. "404": {
  7346. "description": "the issue does not exist"
  7347. }
  7348. }
  7349. },
  7350. "delete": {
  7351. "produces": [
  7352. "application/json"
  7353. ],
  7354. "tags": [
  7355. "issue"
  7356. ],
  7357. "summary": "Unblock the issue given in the body by the issue in path",
  7358. "operationId": "issueRemoveIssueBlocking",
  7359. "parameters": [
  7360. {
  7361. "type": "string",
  7362. "description": "owner of the repo",
  7363. "name": "owner",
  7364. "in": "path",
  7365. "required": true
  7366. },
  7367. {
  7368. "type": "string",
  7369. "description": "name of the repo",
  7370. "name": "repo",
  7371. "in": "path",
  7372. "required": true
  7373. },
  7374. {
  7375. "type": "string",
  7376. "description": "index of the issue",
  7377. "name": "index",
  7378. "in": "path",
  7379. "required": true
  7380. },
  7381. {
  7382. "name": "body",
  7383. "in": "body",
  7384. "schema": {
  7385. "$ref": "#/definitions/IssueMeta"
  7386. }
  7387. }
  7388. ],
  7389. "responses": {
  7390. "200": {
  7391. "$ref": "#/responses/Issue"
  7392. },
  7393. "404": {
  7394. "$ref": "#/responses/notFound"
  7395. }
  7396. }
  7397. }
  7398. },
  7399. "/repos/{owner}/{repo}/issues/{index}/comments": {
  7400. "get": {
  7401. "produces": [
  7402. "application/json"
  7403. ],
  7404. "tags": [
  7405. "issue"
  7406. ],
  7407. "summary": "List all comments on an issue",
  7408. "operationId": "issueGetComments",
  7409. "parameters": [
  7410. {
  7411. "type": "string",
  7412. "description": "owner of the repo",
  7413. "name": "owner",
  7414. "in": "path",
  7415. "required": true
  7416. },
  7417. {
  7418. "type": "string",
  7419. "description": "name of the repo",
  7420. "name": "repo",
  7421. "in": "path",
  7422. "required": true
  7423. },
  7424. {
  7425. "type": "integer",
  7426. "format": "int64",
  7427. "description": "index of the issue",
  7428. "name": "index",
  7429. "in": "path",
  7430. "required": true
  7431. },
  7432. {
  7433. "type": "string",
  7434. "format": "date-time",
  7435. "description": "if provided, only comments updated since the specified time are returned.",
  7436. "name": "since",
  7437. "in": "query"
  7438. },
  7439. {
  7440. "type": "string",
  7441. "format": "date-time",
  7442. "description": "if provided, only comments updated before the provided time are returned.",
  7443. "name": "before",
  7444. "in": "query"
  7445. }
  7446. ],
  7447. "responses": {
  7448. "200": {
  7449. "$ref": "#/responses/CommentList"
  7450. },
  7451. "404": {
  7452. "$ref": "#/responses/notFound"
  7453. }
  7454. }
  7455. },
  7456. "post": {
  7457. "consumes": [
  7458. "application/json"
  7459. ],
  7460. "produces": [
  7461. "application/json"
  7462. ],
  7463. "tags": [
  7464. "issue"
  7465. ],
  7466. "summary": "Add a comment to an issue",
  7467. "operationId": "issueCreateComment",
  7468. "parameters": [
  7469. {
  7470. "type": "string",
  7471. "description": "owner of the repo",
  7472. "name": "owner",
  7473. "in": "path",
  7474. "required": true
  7475. },
  7476. {
  7477. "type": "string",
  7478. "description": "name of the repo",
  7479. "name": "repo",
  7480. "in": "path",
  7481. "required": true
  7482. },
  7483. {
  7484. "type": "integer",
  7485. "format": "int64",
  7486. "description": "index of the issue",
  7487. "name": "index",
  7488. "in": "path",
  7489. "required": true
  7490. },
  7491. {
  7492. "name": "body",
  7493. "in": "body",
  7494. "schema": {
  7495. "$ref": "#/definitions/CreateIssueCommentOption"
  7496. }
  7497. }
  7498. ],
  7499. "responses": {
  7500. "201": {
  7501. "$ref": "#/responses/Comment"
  7502. },
  7503. "403": {
  7504. "$ref": "#/responses/forbidden"
  7505. },
  7506. "404": {
  7507. "$ref": "#/responses/notFound"
  7508. }
  7509. }
  7510. }
  7511. },
  7512. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  7513. "delete": {
  7514. "tags": [
  7515. "issue"
  7516. ],
  7517. "summary": "Delete a comment",
  7518. "operationId": "issueDeleteCommentDeprecated",
  7519. "deprecated": true,
  7520. "parameters": [
  7521. {
  7522. "type": "string",
  7523. "description": "owner of the repo",
  7524. "name": "owner",
  7525. "in": "path",
  7526. "required": true
  7527. },
  7528. {
  7529. "type": "string",
  7530. "description": "name of the repo",
  7531. "name": "repo",
  7532. "in": "path",
  7533. "required": true
  7534. },
  7535. {
  7536. "type": "integer",
  7537. "description": "this parameter is ignored",
  7538. "name": "index",
  7539. "in": "path",
  7540. "required": true
  7541. },
  7542. {
  7543. "type": "integer",
  7544. "format": "int64",
  7545. "description": "id of comment to delete",
  7546. "name": "id",
  7547. "in": "path",
  7548. "required": true
  7549. }
  7550. ],
  7551. "responses": {
  7552. "204": {
  7553. "$ref": "#/responses/empty"
  7554. },
  7555. "403": {
  7556. "$ref": "#/responses/forbidden"
  7557. },
  7558. "404": {
  7559. "$ref": "#/responses/notFound"
  7560. }
  7561. }
  7562. },
  7563. "patch": {
  7564. "consumes": [
  7565. "application/json"
  7566. ],
  7567. "produces": [
  7568. "application/json"
  7569. ],
  7570. "tags": [
  7571. "issue"
  7572. ],
  7573. "summary": "Edit a comment",
  7574. "operationId": "issueEditCommentDeprecated",
  7575. "deprecated": true,
  7576. "parameters": [
  7577. {
  7578. "type": "string",
  7579. "description": "owner of the repo",
  7580. "name": "owner",
  7581. "in": "path",
  7582. "required": true
  7583. },
  7584. {
  7585. "type": "string",
  7586. "description": "name of the repo",
  7587. "name": "repo",
  7588. "in": "path",
  7589. "required": true
  7590. },
  7591. {
  7592. "type": "integer",
  7593. "description": "this parameter is ignored",
  7594. "name": "index",
  7595. "in": "path",
  7596. "required": true
  7597. },
  7598. {
  7599. "type": "integer",
  7600. "format": "int64",
  7601. "description": "id of the comment to edit",
  7602. "name": "id",
  7603. "in": "path",
  7604. "required": true
  7605. },
  7606. {
  7607. "name": "body",
  7608. "in": "body",
  7609. "schema": {
  7610. "$ref": "#/definitions/EditIssueCommentOption"
  7611. }
  7612. }
  7613. ],
  7614. "responses": {
  7615. "200": {
  7616. "$ref": "#/responses/Comment"
  7617. },
  7618. "204": {
  7619. "$ref": "#/responses/empty"
  7620. },
  7621. "403": {
  7622. "$ref": "#/responses/forbidden"
  7623. },
  7624. "404": {
  7625. "$ref": "#/responses/notFound"
  7626. }
  7627. }
  7628. }
  7629. },
  7630. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  7631. "post": {
  7632. "consumes": [
  7633. "application/json"
  7634. ],
  7635. "produces": [
  7636. "application/json"
  7637. ],
  7638. "tags": [
  7639. "issue"
  7640. ],
  7641. "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.",
  7642. "operationId": "issueEditIssueDeadline",
  7643. "parameters": [
  7644. {
  7645. "type": "string",
  7646. "description": "owner of the repo",
  7647. "name": "owner",
  7648. "in": "path",
  7649. "required": true
  7650. },
  7651. {
  7652. "type": "string",
  7653. "description": "name of the repo",
  7654. "name": "repo",
  7655. "in": "path",
  7656. "required": true
  7657. },
  7658. {
  7659. "type": "integer",
  7660. "format": "int64",
  7661. "description": "index of the issue to create or update a deadline on",
  7662. "name": "index",
  7663. "in": "path",
  7664. "required": true
  7665. },
  7666. {
  7667. "name": "body",
  7668. "in": "body",
  7669. "schema": {
  7670. "$ref": "#/definitions/EditDeadlineOption"
  7671. }
  7672. }
  7673. ],
  7674. "responses": {
  7675. "201": {
  7676. "$ref": "#/responses/IssueDeadline"
  7677. },
  7678. "403": {
  7679. "$ref": "#/responses/forbidden"
  7680. },
  7681. "404": {
  7682. "$ref": "#/responses/notFound"
  7683. }
  7684. }
  7685. }
  7686. },
  7687. "/repos/{owner}/{repo}/issues/{index}/dependencies": {
  7688. "get": {
  7689. "produces": [
  7690. "application/json"
  7691. ],
  7692. "tags": [
  7693. "issue"
  7694. ],
  7695. "summary": "List an issue's dependencies, i.e all issues that block this issue.",
  7696. "operationId": "issueListIssueDependencies",
  7697. "parameters": [
  7698. {
  7699. "type": "string",
  7700. "description": "owner of the repo",
  7701. "name": "owner",
  7702. "in": "path",
  7703. "required": true
  7704. },
  7705. {
  7706. "type": "string",
  7707. "description": "name of the repo",
  7708. "name": "repo",
  7709. "in": "path",
  7710. "required": true
  7711. },
  7712. {
  7713. "type": "string",
  7714. "description": "index of the issue",
  7715. "name": "index",
  7716. "in": "path",
  7717. "required": true
  7718. },
  7719. {
  7720. "type": "integer",
  7721. "description": "page number of results to return (1-based)",
  7722. "name": "page",
  7723. "in": "query"
  7724. },
  7725. {
  7726. "type": "integer",
  7727. "description": "page size of results",
  7728. "name": "limit",
  7729. "in": "query"
  7730. }
  7731. ],
  7732. "responses": {
  7733. "200": {
  7734. "$ref": "#/responses/IssueList"
  7735. },
  7736. "404": {
  7737. "$ref": "#/responses/notFound"
  7738. }
  7739. }
  7740. },
  7741. "post": {
  7742. "produces": [
  7743. "application/json"
  7744. ],
  7745. "tags": [
  7746. "issue"
  7747. ],
  7748. "summary": "Make the issue in the url depend on the issue in the form.",
  7749. "operationId": "issueCreateIssueDependencies",
  7750. "parameters": [
  7751. {
  7752. "type": "string",
  7753. "description": "owner of the repo",
  7754. "name": "owner",
  7755. "in": "path",
  7756. "required": true
  7757. },
  7758. {
  7759. "type": "string",
  7760. "description": "name of the repo",
  7761. "name": "repo",
  7762. "in": "path",
  7763. "required": true
  7764. },
  7765. {
  7766. "type": "string",
  7767. "description": "index of the issue",
  7768. "name": "index",
  7769. "in": "path",
  7770. "required": true
  7771. },
  7772. {
  7773. "name": "body",
  7774. "in": "body",
  7775. "schema": {
  7776. "$ref": "#/definitions/IssueMeta"
  7777. }
  7778. }
  7779. ],
  7780. "responses": {
  7781. "201": {
  7782. "$ref": "#/responses/Issue"
  7783. },
  7784. "404": {
  7785. "description": "the issue does not exist"
  7786. }
  7787. }
  7788. },
  7789. "delete": {
  7790. "produces": [
  7791. "application/json"
  7792. ],
  7793. "tags": [
  7794. "issue"
  7795. ],
  7796. "summary": "Remove an issue dependency",
  7797. "operationId": "issueRemoveIssueDependencies",
  7798. "parameters": [
  7799. {
  7800. "type": "string",
  7801. "description": "owner of the repo",
  7802. "name": "owner",
  7803. "in": "path",
  7804. "required": true
  7805. },
  7806. {
  7807. "type": "string",
  7808. "description": "name of the repo",
  7809. "name": "repo",
  7810. "in": "path",
  7811. "required": true
  7812. },
  7813. {
  7814. "type": "string",
  7815. "description": "index of the issue",
  7816. "name": "index",
  7817. "in": "path",
  7818. "required": true
  7819. },
  7820. {
  7821. "name": "body",
  7822. "in": "body",
  7823. "schema": {
  7824. "$ref": "#/definitions/IssueMeta"
  7825. }
  7826. }
  7827. ],
  7828. "responses": {
  7829. "200": {
  7830. "$ref": "#/responses/Issue"
  7831. },
  7832. "404": {
  7833. "$ref": "#/responses/notFound"
  7834. }
  7835. }
  7836. }
  7837. },
  7838. "/repos/{owner}/{repo}/issues/{index}/labels": {
  7839. "get": {
  7840. "produces": [
  7841. "application/json"
  7842. ],
  7843. "tags": [
  7844. "issue"
  7845. ],
  7846. "summary": "Get an issue's labels",
  7847. "operationId": "issueGetLabels",
  7848. "parameters": [
  7849. {
  7850. "type": "string",
  7851. "description": "owner of the repo",
  7852. "name": "owner",
  7853. "in": "path",
  7854. "required": true
  7855. },
  7856. {
  7857. "type": "string",
  7858. "description": "name of the repo",
  7859. "name": "repo",
  7860. "in": "path",
  7861. "required": true
  7862. },
  7863. {
  7864. "type": "integer",
  7865. "format": "int64",
  7866. "description": "index of the issue",
  7867. "name": "index",
  7868. "in": "path",
  7869. "required": true
  7870. }
  7871. ],
  7872. "responses": {
  7873. "200": {
  7874. "$ref": "#/responses/LabelList"
  7875. },
  7876. "404": {
  7877. "$ref": "#/responses/notFound"
  7878. }
  7879. }
  7880. },
  7881. "put": {
  7882. "consumes": [
  7883. "application/json"
  7884. ],
  7885. "produces": [
  7886. "application/json"
  7887. ],
  7888. "tags": [
  7889. "issue"
  7890. ],
  7891. "summary": "Replace an issue's labels",
  7892. "operationId": "issueReplaceLabels",
  7893. "parameters": [
  7894. {
  7895. "type": "string",
  7896. "description": "owner of the repo",
  7897. "name": "owner",
  7898. "in": "path",
  7899. "required": true
  7900. },
  7901. {
  7902. "type": "string",
  7903. "description": "name of the repo",
  7904. "name": "repo",
  7905. "in": "path",
  7906. "required": true
  7907. },
  7908. {
  7909. "type": "integer",
  7910. "format": "int64",
  7911. "description": "index of the issue",
  7912. "name": "index",
  7913. "in": "path",
  7914. "required": true
  7915. },
  7916. {
  7917. "name": "body",
  7918. "in": "body",
  7919. "schema": {
  7920. "$ref": "#/definitions/IssueLabelsOption"
  7921. }
  7922. }
  7923. ],
  7924. "responses": {
  7925. "200": {
  7926. "$ref": "#/responses/LabelList"
  7927. },
  7928. "403": {
  7929. "$ref": "#/responses/forbidden"
  7930. },
  7931. "404": {
  7932. "$ref": "#/responses/notFound"
  7933. }
  7934. }
  7935. },
  7936. "post": {
  7937. "consumes": [
  7938. "application/json"
  7939. ],
  7940. "produces": [
  7941. "application/json"
  7942. ],
  7943. "tags": [
  7944. "issue"
  7945. ],
  7946. "summary": "Add a label to an issue",
  7947. "operationId": "issueAddLabel",
  7948. "parameters": [
  7949. {
  7950. "type": "string",
  7951. "description": "owner of the repo",
  7952. "name": "owner",
  7953. "in": "path",
  7954. "required": true
  7955. },
  7956. {
  7957. "type": "string",
  7958. "description": "name of the repo",
  7959. "name": "repo",
  7960. "in": "path",
  7961. "required": true
  7962. },
  7963. {
  7964. "type": "integer",
  7965. "format": "int64",
  7966. "description": "index of the issue",
  7967. "name": "index",
  7968. "in": "path",
  7969. "required": true
  7970. },
  7971. {
  7972. "name": "body",
  7973. "in": "body",
  7974. "schema": {
  7975. "$ref": "#/definitions/IssueLabelsOption"
  7976. }
  7977. }
  7978. ],
  7979. "responses": {
  7980. "200": {
  7981. "$ref": "#/responses/LabelList"
  7982. },
  7983. "403": {
  7984. "$ref": "#/responses/forbidden"
  7985. },
  7986. "404": {
  7987. "$ref": "#/responses/notFound"
  7988. }
  7989. }
  7990. },
  7991. "delete": {
  7992. "produces": [
  7993. "application/json"
  7994. ],
  7995. "tags": [
  7996. "issue"
  7997. ],
  7998. "summary": "Remove all labels from an issue",
  7999. "operationId": "issueClearLabels",
  8000. "parameters": [
  8001. {
  8002. "type": "string",
  8003. "description": "owner of the repo",
  8004. "name": "owner",
  8005. "in": "path",
  8006. "required": true
  8007. },
  8008. {
  8009. "type": "string",
  8010. "description": "name of the repo",
  8011. "name": "repo",
  8012. "in": "path",
  8013. "required": true
  8014. },
  8015. {
  8016. "type": "integer",
  8017. "format": "int64",
  8018. "description": "index of the issue",
  8019. "name": "index",
  8020. "in": "path",
  8021. "required": true
  8022. }
  8023. ],
  8024. "responses": {
  8025. "204": {
  8026. "$ref": "#/responses/empty"
  8027. },
  8028. "403": {
  8029. "$ref": "#/responses/forbidden"
  8030. },
  8031. "404": {
  8032. "$ref": "#/responses/notFound"
  8033. }
  8034. }
  8035. }
  8036. },
  8037. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  8038. "delete": {
  8039. "produces": [
  8040. "application/json"
  8041. ],
  8042. "tags": [
  8043. "issue"
  8044. ],
  8045. "summary": "Remove a label from an issue",
  8046. "operationId": "issueRemoveLabel",
  8047. "parameters": [
  8048. {
  8049. "type": "string",
  8050. "description": "owner of the repo",
  8051. "name": "owner",
  8052. "in": "path",
  8053. "required": true
  8054. },
  8055. {
  8056. "type": "string",
  8057. "description": "name of the repo",
  8058. "name": "repo",
  8059. "in": "path",
  8060. "required": true
  8061. },
  8062. {
  8063. "type": "integer",
  8064. "format": "int64",
  8065. "description": "index of the issue",
  8066. "name": "index",
  8067. "in": "path",
  8068. "required": true
  8069. },
  8070. {
  8071. "type": "integer",
  8072. "format": "int64",
  8073. "description": "id of the label to remove",
  8074. "name": "id",
  8075. "in": "path",
  8076. "required": true
  8077. }
  8078. ],
  8079. "responses": {
  8080. "204": {
  8081. "$ref": "#/responses/empty"
  8082. },
  8083. "403": {
  8084. "$ref": "#/responses/forbidden"
  8085. },
  8086. "404": {
  8087. "$ref": "#/responses/notFound"
  8088. },
  8089. "422": {
  8090. "$ref": "#/responses/validationError"
  8091. }
  8092. }
  8093. }
  8094. },
  8095. "/repos/{owner}/{repo}/issues/{index}/pin": {
  8096. "post": {
  8097. "tags": [
  8098. "issue"
  8099. ],
  8100. "summary": "Pin an Issue",
  8101. "operationId": "pinIssue",
  8102. "parameters": [
  8103. {
  8104. "type": "string",
  8105. "description": "owner of the repo",
  8106. "name": "owner",
  8107. "in": "path",
  8108. "required": true
  8109. },
  8110. {
  8111. "type": "string",
  8112. "description": "name of the repo",
  8113. "name": "repo",
  8114. "in": "path",
  8115. "required": true
  8116. },
  8117. {
  8118. "type": "integer",
  8119. "format": "int64",
  8120. "description": "index of issue to pin",
  8121. "name": "index",
  8122. "in": "path",
  8123. "required": true
  8124. }
  8125. ],
  8126. "responses": {
  8127. "204": {
  8128. "$ref": "#/responses/empty"
  8129. },
  8130. "403": {
  8131. "$ref": "#/responses/forbidden"
  8132. },
  8133. "404": {
  8134. "$ref": "#/responses/notFound"
  8135. }
  8136. }
  8137. },
  8138. "delete": {
  8139. "tags": [
  8140. "issue"
  8141. ],
  8142. "summary": "Unpin an Issue",
  8143. "operationId": "unpinIssue",
  8144. "parameters": [
  8145. {
  8146. "type": "string",
  8147. "description": "owner of the repo",
  8148. "name": "owner",
  8149. "in": "path",
  8150. "required": true
  8151. },
  8152. {
  8153. "type": "string",
  8154. "description": "name of the repo",
  8155. "name": "repo",
  8156. "in": "path",
  8157. "required": true
  8158. },
  8159. {
  8160. "type": "integer",
  8161. "format": "int64",
  8162. "description": "index of issue to unpin",
  8163. "name": "index",
  8164. "in": "path",
  8165. "required": true
  8166. }
  8167. ],
  8168. "responses": {
  8169. "204": {
  8170. "$ref": "#/responses/empty"
  8171. },
  8172. "403": {
  8173. "$ref": "#/responses/forbidden"
  8174. },
  8175. "404": {
  8176. "$ref": "#/responses/notFound"
  8177. }
  8178. }
  8179. }
  8180. },
  8181. "/repos/{owner}/{repo}/issues/{index}/pin/{position}": {
  8182. "patch": {
  8183. "tags": [
  8184. "issue"
  8185. ],
  8186. "summary": "Moves the Pin to the given Position",
  8187. "operationId": "moveIssuePin",
  8188. "parameters": [
  8189. {
  8190. "type": "string",
  8191. "description": "owner of the repo",
  8192. "name": "owner",
  8193. "in": "path",
  8194. "required": true
  8195. },
  8196. {
  8197. "type": "string",
  8198. "description": "name of the repo",
  8199. "name": "repo",
  8200. "in": "path",
  8201. "required": true
  8202. },
  8203. {
  8204. "type": "integer",
  8205. "format": "int64",
  8206. "description": "index of issue",
  8207. "name": "index",
  8208. "in": "path",
  8209. "required": true
  8210. },
  8211. {
  8212. "type": "integer",
  8213. "format": "int64",
  8214. "description": "the new position",
  8215. "name": "position",
  8216. "in": "path",
  8217. "required": true
  8218. }
  8219. ],
  8220. "responses": {
  8221. "204": {
  8222. "$ref": "#/responses/empty"
  8223. },
  8224. "403": {
  8225. "$ref": "#/responses/forbidden"
  8226. },
  8227. "404": {
  8228. "$ref": "#/responses/notFound"
  8229. }
  8230. }
  8231. }
  8232. },
  8233. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  8234. "get": {
  8235. "consumes": [
  8236. "application/json"
  8237. ],
  8238. "produces": [
  8239. "application/json"
  8240. ],
  8241. "tags": [
  8242. "issue"
  8243. ],
  8244. "summary": "Get a list reactions of an issue",
  8245. "operationId": "issueGetIssueReactions",
  8246. "parameters": [
  8247. {
  8248. "type": "string",
  8249. "description": "owner of the repo",
  8250. "name": "owner",
  8251. "in": "path",
  8252. "required": true
  8253. },
  8254. {
  8255. "type": "string",
  8256. "description": "name of the repo",
  8257. "name": "repo",
  8258. "in": "path",
  8259. "required": true
  8260. },
  8261. {
  8262. "type": "integer",
  8263. "format": "int64",
  8264. "description": "index of the issue",
  8265. "name": "index",
  8266. "in": "path",
  8267. "required": true
  8268. },
  8269. {
  8270. "type": "integer",
  8271. "description": "page number of results to return (1-based)",
  8272. "name": "page",
  8273. "in": "query"
  8274. },
  8275. {
  8276. "type": "integer",
  8277. "description": "page size of results",
  8278. "name": "limit",
  8279. "in": "query"
  8280. }
  8281. ],
  8282. "responses": {
  8283. "200": {
  8284. "$ref": "#/responses/ReactionList"
  8285. },
  8286. "403": {
  8287. "$ref": "#/responses/forbidden"
  8288. },
  8289. "404": {
  8290. "$ref": "#/responses/notFound"
  8291. }
  8292. }
  8293. },
  8294. "post": {
  8295. "consumes": [
  8296. "application/json"
  8297. ],
  8298. "produces": [
  8299. "application/json"
  8300. ],
  8301. "tags": [
  8302. "issue"
  8303. ],
  8304. "summary": "Add a reaction to an issue",
  8305. "operationId": "issuePostIssueReaction",
  8306. "parameters": [
  8307. {
  8308. "type": "string",
  8309. "description": "owner of the repo",
  8310. "name": "owner",
  8311. "in": "path",
  8312. "required": true
  8313. },
  8314. {
  8315. "type": "string",
  8316. "description": "name of the repo",
  8317. "name": "repo",
  8318. "in": "path",
  8319. "required": true
  8320. },
  8321. {
  8322. "type": "integer",
  8323. "format": "int64",
  8324. "description": "index of the issue",
  8325. "name": "index",
  8326. "in": "path",
  8327. "required": true
  8328. },
  8329. {
  8330. "name": "content",
  8331. "in": "body",
  8332. "schema": {
  8333. "$ref": "#/definitions/EditReactionOption"
  8334. }
  8335. }
  8336. ],
  8337. "responses": {
  8338. "200": {
  8339. "$ref": "#/responses/Reaction"
  8340. },
  8341. "201": {
  8342. "$ref": "#/responses/Reaction"
  8343. },
  8344. "403": {
  8345. "$ref": "#/responses/forbidden"
  8346. },
  8347. "404": {
  8348. "$ref": "#/responses/notFound"
  8349. }
  8350. }
  8351. },
  8352. "delete": {
  8353. "consumes": [
  8354. "application/json"
  8355. ],
  8356. "produces": [
  8357. "application/json"
  8358. ],
  8359. "tags": [
  8360. "issue"
  8361. ],
  8362. "summary": "Remove a reaction from an issue",
  8363. "operationId": "issueDeleteIssueReaction",
  8364. "parameters": [
  8365. {
  8366. "type": "string",
  8367. "description": "owner of the repo",
  8368. "name": "owner",
  8369. "in": "path",
  8370. "required": true
  8371. },
  8372. {
  8373. "type": "string",
  8374. "description": "name of the repo",
  8375. "name": "repo",
  8376. "in": "path",
  8377. "required": true
  8378. },
  8379. {
  8380. "type": "integer",
  8381. "format": "int64",
  8382. "description": "index of the issue",
  8383. "name": "index",
  8384. "in": "path",
  8385. "required": true
  8386. },
  8387. {
  8388. "name": "content",
  8389. "in": "body",
  8390. "schema": {
  8391. "$ref": "#/definitions/EditReactionOption"
  8392. }
  8393. }
  8394. ],
  8395. "responses": {
  8396. "200": {
  8397. "$ref": "#/responses/empty"
  8398. },
  8399. "403": {
  8400. "$ref": "#/responses/forbidden"
  8401. },
  8402. "404": {
  8403. "$ref": "#/responses/notFound"
  8404. }
  8405. }
  8406. }
  8407. },
  8408. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  8409. "delete": {
  8410. "consumes": [
  8411. "application/json"
  8412. ],
  8413. "produces": [
  8414. "application/json"
  8415. ],
  8416. "tags": [
  8417. "issue"
  8418. ],
  8419. "summary": "Delete an issue's existing stopwatch.",
  8420. "operationId": "issueDeleteStopWatch",
  8421. "parameters": [
  8422. {
  8423. "type": "string",
  8424. "description": "owner of the repo",
  8425. "name": "owner",
  8426. "in": "path",
  8427. "required": true
  8428. },
  8429. {
  8430. "type": "string",
  8431. "description": "name of the repo",
  8432. "name": "repo",
  8433. "in": "path",
  8434. "required": true
  8435. },
  8436. {
  8437. "type": "integer",
  8438. "format": "int64",
  8439. "description": "index of the issue to stop the stopwatch on",
  8440. "name": "index",
  8441. "in": "path",
  8442. "required": true
  8443. }
  8444. ],
  8445. "responses": {
  8446. "204": {
  8447. "$ref": "#/responses/empty"
  8448. },
  8449. "403": {
  8450. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8451. },
  8452. "404": {
  8453. "$ref": "#/responses/notFound"
  8454. },
  8455. "409": {
  8456. "description": "Cannot cancel a non existent stopwatch"
  8457. }
  8458. }
  8459. }
  8460. },
  8461. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  8462. "post": {
  8463. "consumes": [
  8464. "application/json"
  8465. ],
  8466. "produces": [
  8467. "application/json"
  8468. ],
  8469. "tags": [
  8470. "issue"
  8471. ],
  8472. "summary": "Start stopwatch on an issue.",
  8473. "operationId": "issueStartStopWatch",
  8474. "parameters": [
  8475. {
  8476. "type": "string",
  8477. "description": "owner of the repo",
  8478. "name": "owner",
  8479. "in": "path",
  8480. "required": true
  8481. },
  8482. {
  8483. "type": "string",
  8484. "description": "name of the repo",
  8485. "name": "repo",
  8486. "in": "path",
  8487. "required": true
  8488. },
  8489. {
  8490. "type": "integer",
  8491. "format": "int64",
  8492. "description": "index of the issue to create the stopwatch on",
  8493. "name": "index",
  8494. "in": "path",
  8495. "required": true
  8496. }
  8497. ],
  8498. "responses": {
  8499. "201": {
  8500. "$ref": "#/responses/empty"
  8501. },
  8502. "403": {
  8503. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8504. },
  8505. "404": {
  8506. "$ref": "#/responses/notFound"
  8507. },
  8508. "409": {
  8509. "description": "Cannot start a stopwatch again if it already exists"
  8510. }
  8511. }
  8512. }
  8513. },
  8514. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  8515. "post": {
  8516. "consumes": [
  8517. "application/json"
  8518. ],
  8519. "produces": [
  8520. "application/json"
  8521. ],
  8522. "tags": [
  8523. "issue"
  8524. ],
  8525. "summary": "Stop an issue's existing stopwatch.",
  8526. "operationId": "issueStopStopWatch",
  8527. "parameters": [
  8528. {
  8529. "type": "string",
  8530. "description": "owner of the repo",
  8531. "name": "owner",
  8532. "in": "path",
  8533. "required": true
  8534. },
  8535. {
  8536. "type": "string",
  8537. "description": "name of the repo",
  8538. "name": "repo",
  8539. "in": "path",
  8540. "required": true
  8541. },
  8542. {
  8543. "type": "integer",
  8544. "format": "int64",
  8545. "description": "index of the issue to stop the stopwatch on",
  8546. "name": "index",
  8547. "in": "path",
  8548. "required": true
  8549. }
  8550. ],
  8551. "responses": {
  8552. "201": {
  8553. "$ref": "#/responses/empty"
  8554. },
  8555. "403": {
  8556. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8557. },
  8558. "404": {
  8559. "$ref": "#/responses/notFound"
  8560. },
  8561. "409": {
  8562. "description": "Cannot stop a non existent stopwatch"
  8563. }
  8564. }
  8565. }
  8566. },
  8567. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  8568. "get": {
  8569. "consumes": [
  8570. "application/json"
  8571. ],
  8572. "produces": [
  8573. "application/json"
  8574. ],
  8575. "tags": [
  8576. "issue"
  8577. ],
  8578. "summary": "Get users who subscribed on an issue.",
  8579. "operationId": "issueSubscriptions",
  8580. "parameters": [
  8581. {
  8582. "type": "string",
  8583. "description": "owner of the repo",
  8584. "name": "owner",
  8585. "in": "path",
  8586. "required": true
  8587. },
  8588. {
  8589. "type": "string",
  8590. "description": "name of the repo",
  8591. "name": "repo",
  8592. "in": "path",
  8593. "required": true
  8594. },
  8595. {
  8596. "type": "integer",
  8597. "format": "int64",
  8598. "description": "index of the issue",
  8599. "name": "index",
  8600. "in": "path",
  8601. "required": true
  8602. },
  8603. {
  8604. "type": "integer",
  8605. "description": "page number of results to return (1-based)",
  8606. "name": "page",
  8607. "in": "query"
  8608. },
  8609. {
  8610. "type": "integer",
  8611. "description": "page size of results",
  8612. "name": "limit",
  8613. "in": "query"
  8614. }
  8615. ],
  8616. "responses": {
  8617. "200": {
  8618. "$ref": "#/responses/UserList"
  8619. },
  8620. "404": {
  8621. "$ref": "#/responses/notFound"
  8622. }
  8623. }
  8624. }
  8625. },
  8626. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  8627. "get": {
  8628. "consumes": [
  8629. "application/json"
  8630. ],
  8631. "produces": [
  8632. "application/json"
  8633. ],
  8634. "tags": [
  8635. "issue"
  8636. ],
  8637. "summary": "Check if user is subscribed to an issue",
  8638. "operationId": "issueCheckSubscription",
  8639. "parameters": [
  8640. {
  8641. "type": "string",
  8642. "description": "owner of the repo",
  8643. "name": "owner",
  8644. "in": "path",
  8645. "required": true
  8646. },
  8647. {
  8648. "type": "string",
  8649. "description": "name of the repo",
  8650. "name": "repo",
  8651. "in": "path",
  8652. "required": true
  8653. },
  8654. {
  8655. "type": "integer",
  8656. "format": "int64",
  8657. "description": "index of the issue",
  8658. "name": "index",
  8659. "in": "path",
  8660. "required": true
  8661. }
  8662. ],
  8663. "responses": {
  8664. "200": {
  8665. "$ref": "#/responses/WatchInfo"
  8666. },
  8667. "404": {
  8668. "$ref": "#/responses/notFound"
  8669. }
  8670. }
  8671. }
  8672. },
  8673. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  8674. "put": {
  8675. "consumes": [
  8676. "application/json"
  8677. ],
  8678. "produces": [
  8679. "application/json"
  8680. ],
  8681. "tags": [
  8682. "issue"
  8683. ],
  8684. "summary": "Subscribe user to issue",
  8685. "operationId": "issueAddSubscription",
  8686. "parameters": [
  8687. {
  8688. "type": "string",
  8689. "description": "owner of the repo",
  8690. "name": "owner",
  8691. "in": "path",
  8692. "required": true
  8693. },
  8694. {
  8695. "type": "string",
  8696. "description": "name of the repo",
  8697. "name": "repo",
  8698. "in": "path",
  8699. "required": true
  8700. },
  8701. {
  8702. "type": "integer",
  8703. "format": "int64",
  8704. "description": "index of the issue",
  8705. "name": "index",
  8706. "in": "path",
  8707. "required": true
  8708. },
  8709. {
  8710. "type": "string",
  8711. "description": "user to subscribe",
  8712. "name": "user",
  8713. "in": "path",
  8714. "required": true
  8715. }
  8716. ],
  8717. "responses": {
  8718. "200": {
  8719. "description": "Already subscribed"
  8720. },
  8721. "201": {
  8722. "description": "Successfully Subscribed"
  8723. },
  8724. "304": {
  8725. "description": "User can only subscribe itself if he is no admin"
  8726. },
  8727. "404": {
  8728. "$ref": "#/responses/notFound"
  8729. }
  8730. }
  8731. },
  8732. "delete": {
  8733. "consumes": [
  8734. "application/json"
  8735. ],
  8736. "produces": [
  8737. "application/json"
  8738. ],
  8739. "tags": [
  8740. "issue"
  8741. ],
  8742. "summary": "Unsubscribe user from issue",
  8743. "operationId": "issueDeleteSubscription",
  8744. "parameters": [
  8745. {
  8746. "type": "string",
  8747. "description": "owner of the repo",
  8748. "name": "owner",
  8749. "in": "path",
  8750. "required": true
  8751. },
  8752. {
  8753. "type": "string",
  8754. "description": "name of the repo",
  8755. "name": "repo",
  8756. "in": "path",
  8757. "required": true
  8758. },
  8759. {
  8760. "type": "integer",
  8761. "format": "int64",
  8762. "description": "index of the issue",
  8763. "name": "index",
  8764. "in": "path",
  8765. "required": true
  8766. },
  8767. {
  8768. "type": "string",
  8769. "description": "user witch unsubscribe",
  8770. "name": "user",
  8771. "in": "path",
  8772. "required": true
  8773. }
  8774. ],
  8775. "responses": {
  8776. "200": {
  8777. "description": "Already unsubscribed"
  8778. },
  8779. "201": {
  8780. "description": "Successfully Unsubscribed"
  8781. },
  8782. "304": {
  8783. "description": "User can only subscribe itself if he is no admin"
  8784. },
  8785. "404": {
  8786. "$ref": "#/responses/notFound"
  8787. }
  8788. }
  8789. }
  8790. },
  8791. "/repos/{owner}/{repo}/issues/{index}/timeline": {
  8792. "get": {
  8793. "produces": [
  8794. "application/json"
  8795. ],
  8796. "tags": [
  8797. "issue"
  8798. ],
  8799. "summary": "List all comments and events on an issue",
  8800. "operationId": "issueGetCommentsAndTimeline",
  8801. "parameters": [
  8802. {
  8803. "type": "string",
  8804. "description": "owner of the repo",
  8805. "name": "owner",
  8806. "in": "path",
  8807. "required": true
  8808. },
  8809. {
  8810. "type": "string",
  8811. "description": "name of the repo",
  8812. "name": "repo",
  8813. "in": "path",
  8814. "required": true
  8815. },
  8816. {
  8817. "type": "integer",
  8818. "format": "int64",
  8819. "description": "index of the issue",
  8820. "name": "index",
  8821. "in": "path",
  8822. "required": true
  8823. },
  8824. {
  8825. "type": "string",
  8826. "format": "date-time",
  8827. "description": "if provided, only comments updated since the specified time are returned.",
  8828. "name": "since",
  8829. "in": "query"
  8830. },
  8831. {
  8832. "type": "integer",
  8833. "description": "page number of results to return (1-based)",
  8834. "name": "page",
  8835. "in": "query"
  8836. },
  8837. {
  8838. "type": "integer",
  8839. "description": "page size of results",
  8840. "name": "limit",
  8841. "in": "query"
  8842. },
  8843. {
  8844. "type": "string",
  8845. "format": "date-time",
  8846. "description": "if provided, only comments updated before the provided time are returned.",
  8847. "name": "before",
  8848. "in": "query"
  8849. }
  8850. ],
  8851. "responses": {
  8852. "200": {
  8853. "$ref": "#/responses/TimelineList"
  8854. },
  8855. "404": {
  8856. "$ref": "#/responses/notFound"
  8857. }
  8858. }
  8859. }
  8860. },
  8861. "/repos/{owner}/{repo}/issues/{index}/times": {
  8862. "get": {
  8863. "produces": [
  8864. "application/json"
  8865. ],
  8866. "tags": [
  8867. "issue"
  8868. ],
  8869. "summary": "List an issue's tracked times",
  8870. "operationId": "issueTrackedTimes",
  8871. "parameters": [
  8872. {
  8873. "type": "string",
  8874. "description": "owner of the repo",
  8875. "name": "owner",
  8876. "in": "path",
  8877. "required": true
  8878. },
  8879. {
  8880. "type": "string",
  8881. "description": "name of the repo",
  8882. "name": "repo",
  8883. "in": "path",
  8884. "required": true
  8885. },
  8886. {
  8887. "type": "integer",
  8888. "format": "int64",
  8889. "description": "index of the issue",
  8890. "name": "index",
  8891. "in": "path",
  8892. "required": true
  8893. },
  8894. {
  8895. "type": "string",
  8896. "description": "optional filter by user (available for issue managers)",
  8897. "name": "user",
  8898. "in": "query"
  8899. },
  8900. {
  8901. "type": "string",
  8902. "format": "date-time",
  8903. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8904. "name": "since",
  8905. "in": "query"
  8906. },
  8907. {
  8908. "type": "string",
  8909. "format": "date-time",
  8910. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8911. "name": "before",
  8912. "in": "query"
  8913. },
  8914. {
  8915. "type": "integer",
  8916. "description": "page number of results to return (1-based)",
  8917. "name": "page",
  8918. "in": "query"
  8919. },
  8920. {
  8921. "type": "integer",
  8922. "description": "page size of results",
  8923. "name": "limit",
  8924. "in": "query"
  8925. }
  8926. ],
  8927. "responses": {
  8928. "200": {
  8929. "$ref": "#/responses/TrackedTimeList"
  8930. },
  8931. "404": {
  8932. "$ref": "#/responses/notFound"
  8933. }
  8934. }
  8935. },
  8936. "post": {
  8937. "consumes": [
  8938. "application/json"
  8939. ],
  8940. "produces": [
  8941. "application/json"
  8942. ],
  8943. "tags": [
  8944. "issue"
  8945. ],
  8946. "summary": "Add tracked time to a issue",
  8947. "operationId": "issueAddTime",
  8948. "parameters": [
  8949. {
  8950. "type": "string",
  8951. "description": "owner of the repo",
  8952. "name": "owner",
  8953. "in": "path",
  8954. "required": true
  8955. },
  8956. {
  8957. "type": "string",
  8958. "description": "name of the repo",
  8959. "name": "repo",
  8960. "in": "path",
  8961. "required": true
  8962. },
  8963. {
  8964. "type": "integer",
  8965. "format": "int64",
  8966. "description": "index of the issue",
  8967. "name": "index",
  8968. "in": "path",
  8969. "required": true
  8970. },
  8971. {
  8972. "name": "body",
  8973. "in": "body",
  8974. "schema": {
  8975. "$ref": "#/definitions/AddTimeOption"
  8976. }
  8977. }
  8978. ],
  8979. "responses": {
  8980. "200": {
  8981. "$ref": "#/responses/TrackedTime"
  8982. },
  8983. "400": {
  8984. "$ref": "#/responses/error"
  8985. },
  8986. "403": {
  8987. "$ref": "#/responses/forbidden"
  8988. },
  8989. "404": {
  8990. "$ref": "#/responses/notFound"
  8991. }
  8992. }
  8993. },
  8994. "delete": {
  8995. "consumes": [
  8996. "application/json"
  8997. ],
  8998. "produces": [
  8999. "application/json"
  9000. ],
  9001. "tags": [
  9002. "issue"
  9003. ],
  9004. "summary": "Reset a tracked time of an issue",
  9005. "operationId": "issueResetTime",
  9006. "parameters": [
  9007. {
  9008. "type": "string",
  9009. "description": "owner of the repo",
  9010. "name": "owner",
  9011. "in": "path",
  9012. "required": true
  9013. },
  9014. {
  9015. "type": "string",
  9016. "description": "name of the repo",
  9017. "name": "repo",
  9018. "in": "path",
  9019. "required": true
  9020. },
  9021. {
  9022. "type": "integer",
  9023. "format": "int64",
  9024. "description": "index of the issue to add tracked time to",
  9025. "name": "index",
  9026. "in": "path",
  9027. "required": true
  9028. }
  9029. ],
  9030. "responses": {
  9031. "204": {
  9032. "$ref": "#/responses/empty"
  9033. },
  9034. "400": {
  9035. "$ref": "#/responses/error"
  9036. },
  9037. "403": {
  9038. "$ref": "#/responses/forbidden"
  9039. },
  9040. "404": {
  9041. "$ref": "#/responses/notFound"
  9042. }
  9043. }
  9044. }
  9045. },
  9046. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  9047. "delete": {
  9048. "consumes": [
  9049. "application/json"
  9050. ],
  9051. "produces": [
  9052. "application/json"
  9053. ],
  9054. "tags": [
  9055. "issue"
  9056. ],
  9057. "summary": "Delete specific tracked time",
  9058. "operationId": "issueDeleteTime",
  9059. "parameters": [
  9060. {
  9061. "type": "string",
  9062. "description": "owner of the repo",
  9063. "name": "owner",
  9064. "in": "path",
  9065. "required": true
  9066. },
  9067. {
  9068. "type": "string",
  9069. "description": "name of the repo",
  9070. "name": "repo",
  9071. "in": "path",
  9072. "required": true
  9073. },
  9074. {
  9075. "type": "integer",
  9076. "format": "int64",
  9077. "description": "index of the issue",
  9078. "name": "index",
  9079. "in": "path",
  9080. "required": true
  9081. },
  9082. {
  9083. "type": "integer",
  9084. "format": "int64",
  9085. "description": "id of time to delete",
  9086. "name": "id",
  9087. "in": "path",
  9088. "required": true
  9089. }
  9090. ],
  9091. "responses": {
  9092. "204": {
  9093. "$ref": "#/responses/empty"
  9094. },
  9095. "400": {
  9096. "$ref": "#/responses/error"
  9097. },
  9098. "403": {
  9099. "$ref": "#/responses/forbidden"
  9100. },
  9101. "404": {
  9102. "$ref": "#/responses/notFound"
  9103. }
  9104. }
  9105. }
  9106. },
  9107. "/repos/{owner}/{repo}/keys": {
  9108. "get": {
  9109. "produces": [
  9110. "application/json"
  9111. ],
  9112. "tags": [
  9113. "repository"
  9114. ],
  9115. "summary": "List a repository's keys",
  9116. "operationId": "repoListKeys",
  9117. "parameters": [
  9118. {
  9119. "type": "string",
  9120. "description": "owner of the repo",
  9121. "name": "owner",
  9122. "in": "path",
  9123. "required": true
  9124. },
  9125. {
  9126. "type": "string",
  9127. "description": "name of the repo",
  9128. "name": "repo",
  9129. "in": "path",
  9130. "required": true
  9131. },
  9132. {
  9133. "type": "integer",
  9134. "description": "the key_id to search for",
  9135. "name": "key_id",
  9136. "in": "query"
  9137. },
  9138. {
  9139. "type": "string",
  9140. "description": "fingerprint of the key",
  9141. "name": "fingerprint",
  9142. "in": "query"
  9143. },
  9144. {
  9145. "type": "integer",
  9146. "description": "page number of results to return (1-based)",
  9147. "name": "page",
  9148. "in": "query"
  9149. },
  9150. {
  9151. "type": "integer",
  9152. "description": "page size of results",
  9153. "name": "limit",
  9154. "in": "query"
  9155. }
  9156. ],
  9157. "responses": {
  9158. "200": {
  9159. "$ref": "#/responses/DeployKeyList"
  9160. },
  9161. "404": {
  9162. "$ref": "#/responses/notFound"
  9163. }
  9164. }
  9165. },
  9166. "post": {
  9167. "consumes": [
  9168. "application/json"
  9169. ],
  9170. "produces": [
  9171. "application/json"
  9172. ],
  9173. "tags": [
  9174. "repository"
  9175. ],
  9176. "summary": "Add a key to a repository",
  9177. "operationId": "repoCreateKey",
  9178. "parameters": [
  9179. {
  9180. "type": "string",
  9181. "description": "owner of the repo",
  9182. "name": "owner",
  9183. "in": "path",
  9184. "required": true
  9185. },
  9186. {
  9187. "type": "string",
  9188. "description": "name of the repo",
  9189. "name": "repo",
  9190. "in": "path",
  9191. "required": true
  9192. },
  9193. {
  9194. "name": "body",
  9195. "in": "body",
  9196. "schema": {
  9197. "$ref": "#/definitions/CreateKeyOption"
  9198. }
  9199. }
  9200. ],
  9201. "responses": {
  9202. "201": {
  9203. "$ref": "#/responses/DeployKey"
  9204. },
  9205. "404": {
  9206. "$ref": "#/responses/notFound"
  9207. },
  9208. "422": {
  9209. "$ref": "#/responses/validationError"
  9210. }
  9211. }
  9212. }
  9213. },
  9214. "/repos/{owner}/{repo}/keys/{id}": {
  9215. "get": {
  9216. "produces": [
  9217. "application/json"
  9218. ],
  9219. "tags": [
  9220. "repository"
  9221. ],
  9222. "summary": "Get a repository's key by id",
  9223. "operationId": "repoGetKey",
  9224. "parameters": [
  9225. {
  9226. "type": "string",
  9227. "description": "owner of the repo",
  9228. "name": "owner",
  9229. "in": "path",
  9230. "required": true
  9231. },
  9232. {
  9233. "type": "string",
  9234. "description": "name of the repo",
  9235. "name": "repo",
  9236. "in": "path",
  9237. "required": true
  9238. },
  9239. {
  9240. "type": "integer",
  9241. "format": "int64",
  9242. "description": "id of the key to get",
  9243. "name": "id",
  9244. "in": "path",
  9245. "required": true
  9246. }
  9247. ],
  9248. "responses": {
  9249. "200": {
  9250. "$ref": "#/responses/DeployKey"
  9251. },
  9252. "404": {
  9253. "$ref": "#/responses/notFound"
  9254. }
  9255. }
  9256. },
  9257. "delete": {
  9258. "tags": [
  9259. "repository"
  9260. ],
  9261. "summary": "Delete a key from a repository",
  9262. "operationId": "repoDeleteKey",
  9263. "parameters": [
  9264. {
  9265. "type": "string",
  9266. "description": "owner of the repo",
  9267. "name": "owner",
  9268. "in": "path",
  9269. "required": true
  9270. },
  9271. {
  9272. "type": "string",
  9273. "description": "name of the repo",
  9274. "name": "repo",
  9275. "in": "path",
  9276. "required": true
  9277. },
  9278. {
  9279. "type": "integer",
  9280. "format": "int64",
  9281. "description": "id of the key to delete",
  9282. "name": "id",
  9283. "in": "path",
  9284. "required": true
  9285. }
  9286. ],
  9287. "responses": {
  9288. "204": {
  9289. "$ref": "#/responses/empty"
  9290. },
  9291. "403": {
  9292. "$ref": "#/responses/forbidden"
  9293. },
  9294. "404": {
  9295. "$ref": "#/responses/notFound"
  9296. }
  9297. }
  9298. }
  9299. },
  9300. "/repos/{owner}/{repo}/labels": {
  9301. "get": {
  9302. "produces": [
  9303. "application/json"
  9304. ],
  9305. "tags": [
  9306. "issue"
  9307. ],
  9308. "summary": "Get all of a repository's labels",
  9309. "operationId": "issueListLabels",
  9310. "parameters": [
  9311. {
  9312. "type": "string",
  9313. "description": "owner of the repo",
  9314. "name": "owner",
  9315. "in": "path",
  9316. "required": true
  9317. },
  9318. {
  9319. "type": "string",
  9320. "description": "name of the repo",
  9321. "name": "repo",
  9322. "in": "path",
  9323. "required": true
  9324. },
  9325. {
  9326. "type": "integer",
  9327. "description": "page number of results to return (1-based)",
  9328. "name": "page",
  9329. "in": "query"
  9330. },
  9331. {
  9332. "type": "integer",
  9333. "description": "page size of results",
  9334. "name": "limit",
  9335. "in": "query"
  9336. }
  9337. ],
  9338. "responses": {
  9339. "200": {
  9340. "$ref": "#/responses/LabelList"
  9341. },
  9342. "404": {
  9343. "$ref": "#/responses/notFound"
  9344. }
  9345. }
  9346. },
  9347. "post": {
  9348. "consumes": [
  9349. "application/json"
  9350. ],
  9351. "produces": [
  9352. "application/json"
  9353. ],
  9354. "tags": [
  9355. "issue"
  9356. ],
  9357. "summary": "Create a label",
  9358. "operationId": "issueCreateLabel",
  9359. "parameters": [
  9360. {
  9361. "type": "string",
  9362. "description": "owner of the repo",
  9363. "name": "owner",
  9364. "in": "path",
  9365. "required": true
  9366. },
  9367. {
  9368. "type": "string",
  9369. "description": "name of the repo",
  9370. "name": "repo",
  9371. "in": "path",
  9372. "required": true
  9373. },
  9374. {
  9375. "name": "body",
  9376. "in": "body",
  9377. "schema": {
  9378. "$ref": "#/definitions/CreateLabelOption"
  9379. }
  9380. }
  9381. ],
  9382. "responses": {
  9383. "201": {
  9384. "$ref": "#/responses/Label"
  9385. },
  9386. "404": {
  9387. "$ref": "#/responses/notFound"
  9388. },
  9389. "422": {
  9390. "$ref": "#/responses/validationError"
  9391. }
  9392. }
  9393. }
  9394. },
  9395. "/repos/{owner}/{repo}/labels/{id}": {
  9396. "get": {
  9397. "produces": [
  9398. "application/json"
  9399. ],
  9400. "tags": [
  9401. "issue"
  9402. ],
  9403. "summary": "Get a single label",
  9404. "operationId": "issueGetLabel",
  9405. "parameters": [
  9406. {
  9407. "type": "string",
  9408. "description": "owner of the repo",
  9409. "name": "owner",
  9410. "in": "path",
  9411. "required": true
  9412. },
  9413. {
  9414. "type": "string",
  9415. "description": "name of the repo",
  9416. "name": "repo",
  9417. "in": "path",
  9418. "required": true
  9419. },
  9420. {
  9421. "type": "integer",
  9422. "format": "int64",
  9423. "description": "id of the label to get",
  9424. "name": "id",
  9425. "in": "path",
  9426. "required": true
  9427. }
  9428. ],
  9429. "responses": {
  9430. "200": {
  9431. "$ref": "#/responses/Label"
  9432. },
  9433. "404": {
  9434. "$ref": "#/responses/notFound"
  9435. }
  9436. }
  9437. },
  9438. "delete": {
  9439. "tags": [
  9440. "issue"
  9441. ],
  9442. "summary": "Delete a label",
  9443. "operationId": "issueDeleteLabel",
  9444. "parameters": [
  9445. {
  9446. "type": "string",
  9447. "description": "owner of the repo",
  9448. "name": "owner",
  9449. "in": "path",
  9450. "required": true
  9451. },
  9452. {
  9453. "type": "string",
  9454. "description": "name of the repo",
  9455. "name": "repo",
  9456. "in": "path",
  9457. "required": true
  9458. },
  9459. {
  9460. "type": "integer",
  9461. "format": "int64",
  9462. "description": "id of the label to delete",
  9463. "name": "id",
  9464. "in": "path",
  9465. "required": true
  9466. }
  9467. ],
  9468. "responses": {
  9469. "204": {
  9470. "$ref": "#/responses/empty"
  9471. },
  9472. "404": {
  9473. "$ref": "#/responses/notFound"
  9474. }
  9475. }
  9476. },
  9477. "patch": {
  9478. "consumes": [
  9479. "application/json"
  9480. ],
  9481. "produces": [
  9482. "application/json"
  9483. ],
  9484. "tags": [
  9485. "issue"
  9486. ],
  9487. "summary": "Update a label",
  9488. "operationId": "issueEditLabel",
  9489. "parameters": [
  9490. {
  9491. "type": "string",
  9492. "description": "owner of the repo",
  9493. "name": "owner",
  9494. "in": "path",
  9495. "required": true
  9496. },
  9497. {
  9498. "type": "string",
  9499. "description": "name of the repo",
  9500. "name": "repo",
  9501. "in": "path",
  9502. "required": true
  9503. },
  9504. {
  9505. "type": "integer",
  9506. "format": "int64",
  9507. "description": "id of the label to edit",
  9508. "name": "id",
  9509. "in": "path",
  9510. "required": true
  9511. },
  9512. {
  9513. "name": "body",
  9514. "in": "body",
  9515. "schema": {
  9516. "$ref": "#/definitions/EditLabelOption"
  9517. }
  9518. }
  9519. ],
  9520. "responses": {
  9521. "200": {
  9522. "$ref": "#/responses/Label"
  9523. },
  9524. "404": {
  9525. "$ref": "#/responses/notFound"
  9526. },
  9527. "422": {
  9528. "$ref": "#/responses/validationError"
  9529. }
  9530. }
  9531. }
  9532. },
  9533. "/repos/{owner}/{repo}/languages": {
  9534. "get": {
  9535. "produces": [
  9536. "application/json"
  9537. ],
  9538. "tags": [
  9539. "repository"
  9540. ],
  9541. "summary": "Get languages and number of bytes of code written",
  9542. "operationId": "repoGetLanguages",
  9543. "parameters": [
  9544. {
  9545. "type": "string",
  9546. "description": "owner of the repo",
  9547. "name": "owner",
  9548. "in": "path",
  9549. "required": true
  9550. },
  9551. {
  9552. "type": "string",
  9553. "description": "name of the repo",
  9554. "name": "repo",
  9555. "in": "path",
  9556. "required": true
  9557. }
  9558. ],
  9559. "responses": {
  9560. "200": {
  9561. "$ref": "#/responses/LanguageStatistics"
  9562. },
  9563. "404": {
  9564. "$ref": "#/responses/notFound"
  9565. }
  9566. }
  9567. }
  9568. },
  9569. "/repos/{owner}/{repo}/media/{filepath}": {
  9570. "get": {
  9571. "tags": [
  9572. "repository"
  9573. ],
  9574. "summary": "Get a file or it's LFS object from a repository",
  9575. "operationId": "repoGetRawFileOrLFS",
  9576. "parameters": [
  9577. {
  9578. "type": "string",
  9579. "description": "owner of the repo",
  9580. "name": "owner",
  9581. "in": "path",
  9582. "required": true
  9583. },
  9584. {
  9585. "type": "string",
  9586. "description": "name of the repo",
  9587. "name": "repo",
  9588. "in": "path",
  9589. "required": true
  9590. },
  9591. {
  9592. "type": "string",
  9593. "description": "filepath of the file to get",
  9594. "name": "filepath",
  9595. "in": "path",
  9596. "required": true
  9597. },
  9598. {
  9599. "type": "string",
  9600. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  9601. "name": "ref",
  9602. "in": "query"
  9603. }
  9604. ],
  9605. "responses": {
  9606. "200": {
  9607. "description": "Returns raw file content."
  9608. },
  9609. "404": {
  9610. "$ref": "#/responses/notFound"
  9611. }
  9612. }
  9613. }
  9614. },
  9615. "/repos/{owner}/{repo}/milestones": {
  9616. "get": {
  9617. "produces": [
  9618. "application/json"
  9619. ],
  9620. "tags": [
  9621. "issue"
  9622. ],
  9623. "summary": "Get all of a repository's opened milestones",
  9624. "operationId": "issueGetMilestonesList",
  9625. "parameters": [
  9626. {
  9627. "type": "string",
  9628. "description": "owner of the repo",
  9629. "name": "owner",
  9630. "in": "path",
  9631. "required": true
  9632. },
  9633. {
  9634. "type": "string",
  9635. "description": "name of the repo",
  9636. "name": "repo",
  9637. "in": "path",
  9638. "required": true
  9639. },
  9640. {
  9641. "type": "string",
  9642. "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
  9643. "name": "state",
  9644. "in": "query"
  9645. },
  9646. {
  9647. "type": "string",
  9648. "description": "filter by milestone name",
  9649. "name": "name",
  9650. "in": "query"
  9651. },
  9652. {
  9653. "type": "integer",
  9654. "description": "page number of results to return (1-based)",
  9655. "name": "page",
  9656. "in": "query"
  9657. },
  9658. {
  9659. "type": "integer",
  9660. "description": "page size of results",
  9661. "name": "limit",
  9662. "in": "query"
  9663. }
  9664. ],
  9665. "responses": {
  9666. "200": {
  9667. "$ref": "#/responses/MilestoneList"
  9668. },
  9669. "404": {
  9670. "$ref": "#/responses/notFound"
  9671. }
  9672. }
  9673. },
  9674. "post": {
  9675. "consumes": [
  9676. "application/json"
  9677. ],
  9678. "produces": [
  9679. "application/json"
  9680. ],
  9681. "tags": [
  9682. "issue"
  9683. ],
  9684. "summary": "Create a milestone",
  9685. "operationId": "issueCreateMilestone",
  9686. "parameters": [
  9687. {
  9688. "type": "string",
  9689. "description": "owner of the repo",
  9690. "name": "owner",
  9691. "in": "path",
  9692. "required": true
  9693. },
  9694. {
  9695. "type": "string",
  9696. "description": "name of the repo",
  9697. "name": "repo",
  9698. "in": "path",
  9699. "required": true
  9700. },
  9701. {
  9702. "name": "body",
  9703. "in": "body",
  9704. "schema": {
  9705. "$ref": "#/definitions/CreateMilestoneOption"
  9706. }
  9707. }
  9708. ],
  9709. "responses": {
  9710. "201": {
  9711. "$ref": "#/responses/Milestone"
  9712. },
  9713. "404": {
  9714. "$ref": "#/responses/notFound"
  9715. }
  9716. }
  9717. }
  9718. },
  9719. "/repos/{owner}/{repo}/milestones/{id}": {
  9720. "get": {
  9721. "produces": [
  9722. "application/json"
  9723. ],
  9724. "tags": [
  9725. "issue"
  9726. ],
  9727. "summary": "Get a milestone",
  9728. "operationId": "issueGetMilestone",
  9729. "parameters": [
  9730. {
  9731. "type": "string",
  9732. "description": "owner of the repo",
  9733. "name": "owner",
  9734. "in": "path",
  9735. "required": true
  9736. },
  9737. {
  9738. "type": "string",
  9739. "description": "name of the repo",
  9740. "name": "repo",
  9741. "in": "path",
  9742. "required": true
  9743. },
  9744. {
  9745. "type": "string",
  9746. "description": "the milestone to get, identified by ID and if not available by name",
  9747. "name": "id",
  9748. "in": "path",
  9749. "required": true
  9750. }
  9751. ],
  9752. "responses": {
  9753. "200": {
  9754. "$ref": "#/responses/Milestone"
  9755. },
  9756. "404": {
  9757. "$ref": "#/responses/notFound"
  9758. }
  9759. }
  9760. },
  9761. "delete": {
  9762. "tags": [
  9763. "issue"
  9764. ],
  9765. "summary": "Delete a milestone",
  9766. "operationId": "issueDeleteMilestone",
  9767. "parameters": [
  9768. {
  9769. "type": "string",
  9770. "description": "owner of the repo",
  9771. "name": "owner",
  9772. "in": "path",
  9773. "required": true
  9774. },
  9775. {
  9776. "type": "string",
  9777. "description": "name of the repo",
  9778. "name": "repo",
  9779. "in": "path",
  9780. "required": true
  9781. },
  9782. {
  9783. "type": "string",
  9784. "description": "the milestone to delete, identified by ID and if not available by name",
  9785. "name": "id",
  9786. "in": "path",
  9787. "required": true
  9788. }
  9789. ],
  9790. "responses": {
  9791. "204": {
  9792. "$ref": "#/responses/empty"
  9793. },
  9794. "404": {
  9795. "$ref": "#/responses/notFound"
  9796. }
  9797. }
  9798. },
  9799. "patch": {
  9800. "consumes": [
  9801. "application/json"
  9802. ],
  9803. "produces": [
  9804. "application/json"
  9805. ],
  9806. "tags": [
  9807. "issue"
  9808. ],
  9809. "summary": "Update a milestone",
  9810. "operationId": "issueEditMilestone",
  9811. "parameters": [
  9812. {
  9813. "type": "string",
  9814. "description": "owner of the repo",
  9815. "name": "owner",
  9816. "in": "path",
  9817. "required": true
  9818. },
  9819. {
  9820. "type": "string",
  9821. "description": "name of the repo",
  9822. "name": "repo",
  9823. "in": "path",
  9824. "required": true
  9825. },
  9826. {
  9827. "type": "string",
  9828. "description": "the milestone to edit, identified by ID and if not available by name",
  9829. "name": "id",
  9830. "in": "path",
  9831. "required": true
  9832. },
  9833. {
  9834. "name": "body",
  9835. "in": "body",
  9836. "schema": {
  9837. "$ref": "#/definitions/EditMilestoneOption"
  9838. }
  9839. }
  9840. ],
  9841. "responses": {
  9842. "200": {
  9843. "$ref": "#/responses/Milestone"
  9844. },
  9845. "404": {
  9846. "$ref": "#/responses/notFound"
  9847. }
  9848. }
  9849. }
  9850. },
  9851. "/repos/{owner}/{repo}/mirror-sync": {
  9852. "post": {
  9853. "produces": [
  9854. "application/json"
  9855. ],
  9856. "tags": [
  9857. "repository"
  9858. ],
  9859. "summary": "Sync a mirrored repository",
  9860. "operationId": "repoMirrorSync",
  9861. "parameters": [
  9862. {
  9863. "type": "string",
  9864. "description": "owner of the repo to sync",
  9865. "name": "owner",
  9866. "in": "path",
  9867. "required": true
  9868. },
  9869. {
  9870. "type": "string",
  9871. "description": "name of the repo to sync",
  9872. "name": "repo",
  9873. "in": "path",
  9874. "required": true
  9875. }
  9876. ],
  9877. "responses": {
  9878. "200": {
  9879. "$ref": "#/responses/empty"
  9880. },
  9881. "403": {
  9882. "$ref": "#/responses/forbidden"
  9883. },
  9884. "404": {
  9885. "$ref": "#/responses/notFound"
  9886. }
  9887. }
  9888. }
  9889. },
  9890. "/repos/{owner}/{repo}/new_pin_allowed": {
  9891. "get": {
  9892. "produces": [
  9893. "application/json"
  9894. ],
  9895. "tags": [
  9896. "repository"
  9897. ],
  9898. "summary": "Returns if new Issue Pins are allowed",
  9899. "operationId": "repoNewPinAllowed",
  9900. "parameters": [
  9901. {
  9902. "type": "string",
  9903. "description": "owner of the repo",
  9904. "name": "owner",
  9905. "in": "path",
  9906. "required": true
  9907. },
  9908. {
  9909. "type": "string",
  9910. "description": "name of the repo",
  9911. "name": "repo",
  9912. "in": "path",
  9913. "required": true
  9914. }
  9915. ],
  9916. "responses": {
  9917. "200": {
  9918. "$ref": "#/responses/RepoNewIssuePinsAllowed"
  9919. },
  9920. "404": {
  9921. "$ref": "#/responses/notFound"
  9922. }
  9923. }
  9924. }
  9925. },
  9926. "/repos/{owner}/{repo}/notifications": {
  9927. "get": {
  9928. "consumes": [
  9929. "application/json"
  9930. ],
  9931. "produces": [
  9932. "application/json"
  9933. ],
  9934. "tags": [
  9935. "notification"
  9936. ],
  9937. "summary": "List users's notification threads on a specific repo",
  9938. "operationId": "notifyGetRepoList",
  9939. "parameters": [
  9940. {
  9941. "type": "string",
  9942. "description": "owner of the repo",
  9943. "name": "owner",
  9944. "in": "path",
  9945. "required": true
  9946. },
  9947. {
  9948. "type": "string",
  9949. "description": "name of the repo",
  9950. "name": "repo",
  9951. "in": "path",
  9952. "required": true
  9953. },
  9954. {
  9955. "type": "boolean",
  9956. "description": "If true, show notifications marked as read. Default value is false",
  9957. "name": "all",
  9958. "in": "query"
  9959. },
  9960. {
  9961. "type": "array",
  9962. "items": {
  9963. "type": "string"
  9964. },
  9965. "collectionFormat": "multi",
  9966. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  9967. "name": "status-types",
  9968. "in": "query"
  9969. },
  9970. {
  9971. "type": "array",
  9972. "items": {
  9973. "enum": [
  9974. "issue",
  9975. "pull",
  9976. "commit",
  9977. "repository"
  9978. ],
  9979. "type": "string"
  9980. },
  9981. "collectionFormat": "multi",
  9982. "description": "filter notifications by subject type",
  9983. "name": "subject-type",
  9984. "in": "query"
  9985. },
  9986. {
  9987. "type": "string",
  9988. "format": "date-time",
  9989. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  9990. "name": "since",
  9991. "in": "query"
  9992. },
  9993. {
  9994. "type": "string",
  9995. "format": "date-time",
  9996. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  9997. "name": "before",
  9998. "in": "query"
  9999. },
  10000. {
  10001. "type": "integer",
  10002. "description": "page number of results to return (1-based)",
  10003. "name": "page",
  10004. "in": "query"
  10005. },
  10006. {
  10007. "type": "integer",
  10008. "description": "page size of results",
  10009. "name": "limit",
  10010. "in": "query"
  10011. }
  10012. ],
  10013. "responses": {
  10014. "200": {
  10015. "$ref": "#/responses/NotificationThreadList"
  10016. }
  10017. }
  10018. },
  10019. "put": {
  10020. "consumes": [
  10021. "application/json"
  10022. ],
  10023. "produces": [
  10024. "application/json"
  10025. ],
  10026. "tags": [
  10027. "notification"
  10028. ],
  10029. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  10030. "operationId": "notifyReadRepoList",
  10031. "parameters": [
  10032. {
  10033. "type": "string",
  10034. "description": "owner of the repo",
  10035. "name": "owner",
  10036. "in": "path",
  10037. "required": true
  10038. },
  10039. {
  10040. "type": "string",
  10041. "description": "name of the repo",
  10042. "name": "repo",
  10043. "in": "path",
  10044. "required": true
  10045. },
  10046. {
  10047. "type": "string",
  10048. "description": "If true, mark all notifications on this repo. Default value is false",
  10049. "name": "all",
  10050. "in": "query"
  10051. },
  10052. {
  10053. "type": "array",
  10054. "items": {
  10055. "type": "string"
  10056. },
  10057. "collectionFormat": "multi",
  10058. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  10059. "name": "status-types",
  10060. "in": "query"
  10061. },
  10062. {
  10063. "type": "string",
  10064. "description": "Status to mark notifications as. Defaults to read.",
  10065. "name": "to-status",
  10066. "in": "query"
  10067. },
  10068. {
  10069. "type": "string",
  10070. "format": "date-time",
  10071. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  10072. "name": "last_read_at",
  10073. "in": "query"
  10074. }
  10075. ],
  10076. "responses": {
  10077. "205": {
  10078. "$ref": "#/responses/NotificationThreadList"
  10079. }
  10080. }
  10081. }
  10082. },
  10083. "/repos/{owner}/{repo}/pulls": {
  10084. "get": {
  10085. "produces": [
  10086. "application/json"
  10087. ],
  10088. "tags": [
  10089. "repository"
  10090. ],
  10091. "summary": "List a repo's pull requests",
  10092. "operationId": "repoListPullRequests",
  10093. "parameters": [
  10094. {
  10095. "type": "string",
  10096. "description": "owner of the repo",
  10097. "name": "owner",
  10098. "in": "path",
  10099. "required": true
  10100. },
  10101. {
  10102. "type": "string",
  10103. "description": "name of the repo",
  10104. "name": "repo",
  10105. "in": "path",
  10106. "required": true
  10107. },
  10108. {
  10109. "enum": [
  10110. "closed",
  10111. "open",
  10112. "all"
  10113. ],
  10114. "type": "string",
  10115. "description": "State of pull request: open or closed (optional)",
  10116. "name": "state",
  10117. "in": "query"
  10118. },
  10119. {
  10120. "enum": [
  10121. "oldest",
  10122. "recentupdate",
  10123. "leastupdate",
  10124. "mostcomment",
  10125. "leastcomment",
  10126. "priority"
  10127. ],
  10128. "type": "string",
  10129. "description": "Type of sort",
  10130. "name": "sort",
  10131. "in": "query"
  10132. },
  10133. {
  10134. "type": "integer",
  10135. "format": "int64",
  10136. "description": "ID of the milestone",
  10137. "name": "milestone",
  10138. "in": "query"
  10139. },
  10140. {
  10141. "type": "array",
  10142. "items": {
  10143. "type": "integer",
  10144. "format": "int64"
  10145. },
  10146. "collectionFormat": "multi",
  10147. "description": "Label IDs",
  10148. "name": "labels",
  10149. "in": "query"
  10150. },
  10151. {
  10152. "type": "integer",
  10153. "description": "page number of results to return (1-based)",
  10154. "name": "page",
  10155. "in": "query"
  10156. },
  10157. {
  10158. "type": "integer",
  10159. "description": "page size of results",
  10160. "name": "limit",
  10161. "in": "query"
  10162. }
  10163. ],
  10164. "responses": {
  10165. "200": {
  10166. "$ref": "#/responses/PullRequestList"
  10167. },
  10168. "404": {
  10169. "$ref": "#/responses/notFound"
  10170. }
  10171. }
  10172. },
  10173. "post": {
  10174. "consumes": [
  10175. "application/json"
  10176. ],
  10177. "produces": [
  10178. "application/json"
  10179. ],
  10180. "tags": [
  10181. "repository"
  10182. ],
  10183. "summary": "Create a pull request",
  10184. "operationId": "repoCreatePullRequest",
  10185. "parameters": [
  10186. {
  10187. "type": "string",
  10188. "description": "owner of the repo",
  10189. "name": "owner",
  10190. "in": "path",
  10191. "required": true
  10192. },
  10193. {
  10194. "type": "string",
  10195. "description": "name of the repo",
  10196. "name": "repo",
  10197. "in": "path",
  10198. "required": true
  10199. },
  10200. {
  10201. "name": "body",
  10202. "in": "body",
  10203. "schema": {
  10204. "$ref": "#/definitions/CreatePullRequestOption"
  10205. }
  10206. }
  10207. ],
  10208. "responses": {
  10209. "201": {
  10210. "$ref": "#/responses/PullRequest"
  10211. },
  10212. "404": {
  10213. "$ref": "#/responses/notFound"
  10214. },
  10215. "409": {
  10216. "$ref": "#/responses/error"
  10217. },
  10218. "422": {
  10219. "$ref": "#/responses/validationError"
  10220. }
  10221. }
  10222. }
  10223. },
  10224. "/repos/{owner}/{repo}/pulls/pinned": {
  10225. "get": {
  10226. "produces": [
  10227. "application/json"
  10228. ],
  10229. "tags": [
  10230. "repository"
  10231. ],
  10232. "summary": "List a repo's pinned pull requests",
  10233. "operationId": "repoListPinnedPullRequests",
  10234. "parameters": [
  10235. {
  10236. "type": "string",
  10237. "description": "owner of the repo",
  10238. "name": "owner",
  10239. "in": "path",
  10240. "required": true
  10241. },
  10242. {
  10243. "type": "string",
  10244. "description": "name of the repo",
  10245. "name": "repo",
  10246. "in": "path",
  10247. "required": true
  10248. }
  10249. ],
  10250. "responses": {
  10251. "200": {
  10252. "$ref": "#/responses/PullRequestList"
  10253. },
  10254. "404": {
  10255. "$ref": "#/responses/notFound"
  10256. }
  10257. }
  10258. }
  10259. },
  10260. "/repos/{owner}/{repo}/pulls/{index}": {
  10261. "get": {
  10262. "produces": [
  10263. "application/json"
  10264. ],
  10265. "tags": [
  10266. "repository"
  10267. ],
  10268. "summary": "Get a pull request",
  10269. "operationId": "repoGetPullRequest",
  10270. "parameters": [
  10271. {
  10272. "type": "string",
  10273. "description": "owner of the repo",
  10274. "name": "owner",
  10275. "in": "path",
  10276. "required": true
  10277. },
  10278. {
  10279. "type": "string",
  10280. "description": "name of the repo",
  10281. "name": "repo",
  10282. "in": "path",
  10283. "required": true
  10284. },
  10285. {
  10286. "type": "integer",
  10287. "format": "int64",
  10288. "description": "index of the pull request to get",
  10289. "name": "index",
  10290. "in": "path",
  10291. "required": true
  10292. }
  10293. ],
  10294. "responses": {
  10295. "200": {
  10296. "$ref": "#/responses/PullRequest"
  10297. },
  10298. "404": {
  10299. "$ref": "#/responses/notFound"
  10300. }
  10301. }
  10302. },
  10303. "patch": {
  10304. "consumes": [
  10305. "application/json"
  10306. ],
  10307. "produces": [
  10308. "application/json"
  10309. ],
  10310. "tags": [
  10311. "repository"
  10312. ],
  10313. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  10314. "operationId": "repoEditPullRequest",
  10315. "parameters": [
  10316. {
  10317. "type": "string",
  10318. "description": "owner of the repo",
  10319. "name": "owner",
  10320. "in": "path",
  10321. "required": true
  10322. },
  10323. {
  10324. "type": "string",
  10325. "description": "name of the repo",
  10326. "name": "repo",
  10327. "in": "path",
  10328. "required": true
  10329. },
  10330. {
  10331. "type": "integer",
  10332. "format": "int64",
  10333. "description": "index of the pull request to edit",
  10334. "name": "index",
  10335. "in": "path",
  10336. "required": true
  10337. },
  10338. {
  10339. "name": "body",
  10340. "in": "body",
  10341. "schema": {
  10342. "$ref": "#/definitions/EditPullRequestOption"
  10343. }
  10344. }
  10345. ],
  10346. "responses": {
  10347. "201": {
  10348. "$ref": "#/responses/PullRequest"
  10349. },
  10350. "403": {
  10351. "$ref": "#/responses/forbidden"
  10352. },
  10353. "404": {
  10354. "$ref": "#/responses/notFound"
  10355. },
  10356. "409": {
  10357. "$ref": "#/responses/error"
  10358. },
  10359. "412": {
  10360. "$ref": "#/responses/error"
  10361. },
  10362. "422": {
  10363. "$ref": "#/responses/validationError"
  10364. }
  10365. }
  10366. }
  10367. },
  10368. "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
  10369. "get": {
  10370. "produces": [
  10371. "text/plain"
  10372. ],
  10373. "tags": [
  10374. "repository"
  10375. ],
  10376. "summary": "Get a pull request diff or patch",
  10377. "operationId": "repoDownloadPullDiffOrPatch",
  10378. "parameters": [
  10379. {
  10380. "type": "string",
  10381. "description": "owner of the repo",
  10382. "name": "owner",
  10383. "in": "path",
  10384. "required": true
  10385. },
  10386. {
  10387. "type": "string",
  10388. "description": "name of the repo",
  10389. "name": "repo",
  10390. "in": "path",
  10391. "required": true
  10392. },
  10393. {
  10394. "type": "integer",
  10395. "format": "int64",
  10396. "description": "index of the pull request to get",
  10397. "name": "index",
  10398. "in": "path",
  10399. "required": true
  10400. },
  10401. {
  10402. "enum": [
  10403. "diff",
  10404. "patch"
  10405. ],
  10406. "type": "string",
  10407. "description": "whether the output is diff or patch",
  10408. "name": "diffType",
  10409. "in": "path",
  10410. "required": true
  10411. },
  10412. {
  10413. "type": "boolean",
  10414. "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
  10415. "name": "binary",
  10416. "in": "query"
  10417. }
  10418. ],
  10419. "responses": {
  10420. "200": {
  10421. "$ref": "#/responses/string"
  10422. },
  10423. "404": {
  10424. "$ref": "#/responses/notFound"
  10425. }
  10426. }
  10427. }
  10428. },
  10429. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  10430. "get": {
  10431. "produces": [
  10432. "application/json"
  10433. ],
  10434. "tags": [
  10435. "repository"
  10436. ],
  10437. "summary": "Get commits for a pull request",
  10438. "operationId": "repoGetPullRequestCommits",
  10439. "parameters": [
  10440. {
  10441. "type": "string",
  10442. "description": "owner of the repo",
  10443. "name": "owner",
  10444. "in": "path",
  10445. "required": true
  10446. },
  10447. {
  10448. "type": "string",
  10449. "description": "name of the repo",
  10450. "name": "repo",
  10451. "in": "path",
  10452. "required": true
  10453. },
  10454. {
  10455. "type": "integer",
  10456. "format": "int64",
  10457. "description": "index of the pull request to get",
  10458. "name": "index",
  10459. "in": "path",
  10460. "required": true
  10461. },
  10462. {
  10463. "type": "integer",
  10464. "description": "page number of results to return (1-based)",
  10465. "name": "page",
  10466. "in": "query"
  10467. },
  10468. {
  10469. "type": "integer",
  10470. "description": "page size of results",
  10471. "name": "limit",
  10472. "in": "query"
  10473. },
  10474. {
  10475. "type": "boolean",
  10476. "description": "include verification for every commit (disable for speedup, default 'true')",
  10477. "name": "verification",
  10478. "in": "query"
  10479. },
  10480. {
  10481. "type": "boolean",
  10482. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  10483. "name": "files",
  10484. "in": "query"
  10485. }
  10486. ],
  10487. "responses": {
  10488. "200": {
  10489. "$ref": "#/responses/CommitList"
  10490. },
  10491. "404": {
  10492. "$ref": "#/responses/notFound"
  10493. }
  10494. }
  10495. }
  10496. },
  10497. "/repos/{owner}/{repo}/pulls/{index}/files": {
  10498. "get": {
  10499. "produces": [
  10500. "application/json"
  10501. ],
  10502. "tags": [
  10503. "repository"
  10504. ],
  10505. "summary": "Get changed files for a pull request",
  10506. "operationId": "repoGetPullRequestFiles",
  10507. "parameters": [
  10508. {
  10509. "type": "string",
  10510. "description": "owner of the repo",
  10511. "name": "owner",
  10512. "in": "path",
  10513. "required": true
  10514. },
  10515. {
  10516. "type": "string",
  10517. "description": "name of the repo",
  10518. "name": "repo",
  10519. "in": "path",
  10520. "required": true
  10521. },
  10522. {
  10523. "type": "integer",
  10524. "format": "int64",
  10525. "description": "index of the pull request to get",
  10526. "name": "index",
  10527. "in": "path",
  10528. "required": true
  10529. },
  10530. {
  10531. "type": "string",
  10532. "description": "skip to given file",
  10533. "name": "skip-to",
  10534. "in": "query"
  10535. },
  10536. {
  10537. "enum": [
  10538. "ignore-all",
  10539. "ignore-change",
  10540. "ignore-eol",
  10541. "show-all"
  10542. ],
  10543. "type": "string",
  10544. "description": "whitespace behavior",
  10545. "name": "whitespace",
  10546. "in": "query"
  10547. },
  10548. {
  10549. "type": "integer",
  10550. "description": "page number of results to return (1-based)",
  10551. "name": "page",
  10552. "in": "query"
  10553. },
  10554. {
  10555. "type": "integer",
  10556. "description": "page size of results",
  10557. "name": "limit",
  10558. "in": "query"
  10559. }
  10560. ],
  10561. "responses": {
  10562. "200": {
  10563. "$ref": "#/responses/ChangedFileList"
  10564. },
  10565. "404": {
  10566. "$ref": "#/responses/notFound"
  10567. }
  10568. }
  10569. }
  10570. },
  10571. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  10572. "get": {
  10573. "produces": [
  10574. "application/json"
  10575. ],
  10576. "tags": [
  10577. "repository"
  10578. ],
  10579. "summary": "Check if a pull request has been merged",
  10580. "operationId": "repoPullRequestIsMerged",
  10581. "parameters": [
  10582. {
  10583. "type": "string",
  10584. "description": "owner of the repo",
  10585. "name": "owner",
  10586. "in": "path",
  10587. "required": true
  10588. },
  10589. {
  10590. "type": "string",
  10591. "description": "name of the repo",
  10592. "name": "repo",
  10593. "in": "path",
  10594. "required": true
  10595. },
  10596. {
  10597. "type": "integer",
  10598. "format": "int64",
  10599. "description": "index of the pull request",
  10600. "name": "index",
  10601. "in": "path",
  10602. "required": true
  10603. }
  10604. ],
  10605. "responses": {
  10606. "204": {
  10607. "description": "pull request has been merged"
  10608. },
  10609. "404": {
  10610. "description": "pull request has not been merged"
  10611. }
  10612. }
  10613. },
  10614. "post": {
  10615. "produces": [
  10616. "application/json"
  10617. ],
  10618. "tags": [
  10619. "repository"
  10620. ],
  10621. "summary": "Merge a pull request",
  10622. "operationId": "repoMergePullRequest",
  10623. "parameters": [
  10624. {
  10625. "type": "string",
  10626. "description": "owner of the repo",
  10627. "name": "owner",
  10628. "in": "path",
  10629. "required": true
  10630. },
  10631. {
  10632. "type": "string",
  10633. "description": "name of the repo",
  10634. "name": "repo",
  10635. "in": "path",
  10636. "required": true
  10637. },
  10638. {
  10639. "type": "integer",
  10640. "format": "int64",
  10641. "description": "index of the pull request to merge",
  10642. "name": "index",
  10643. "in": "path",
  10644. "required": true
  10645. },
  10646. {
  10647. "name": "body",
  10648. "in": "body",
  10649. "schema": {
  10650. "$ref": "#/definitions/MergePullRequestOption"
  10651. }
  10652. }
  10653. ],
  10654. "responses": {
  10655. "200": {
  10656. "$ref": "#/responses/empty"
  10657. },
  10658. "404": {
  10659. "$ref": "#/responses/notFound"
  10660. },
  10661. "405": {
  10662. "$ref": "#/responses/empty"
  10663. },
  10664. "409": {
  10665. "$ref": "#/responses/error"
  10666. }
  10667. }
  10668. },
  10669. "delete": {
  10670. "produces": [
  10671. "application/json"
  10672. ],
  10673. "tags": [
  10674. "repository"
  10675. ],
  10676. "summary": "Cancel the scheduled auto merge for the given pull request",
  10677. "operationId": "repoCancelScheduledAutoMerge",
  10678. "parameters": [
  10679. {
  10680. "type": "string",
  10681. "description": "owner of the repo",
  10682. "name": "owner",
  10683. "in": "path",
  10684. "required": true
  10685. },
  10686. {
  10687. "type": "string",
  10688. "description": "name of the repo",
  10689. "name": "repo",
  10690. "in": "path",
  10691. "required": true
  10692. },
  10693. {
  10694. "type": "integer",
  10695. "format": "int64",
  10696. "description": "index of the pull request to merge",
  10697. "name": "index",
  10698. "in": "path",
  10699. "required": true
  10700. }
  10701. ],
  10702. "responses": {
  10703. "204": {
  10704. "$ref": "#/responses/empty"
  10705. },
  10706. "403": {
  10707. "$ref": "#/responses/forbidden"
  10708. },
  10709. "404": {
  10710. "$ref": "#/responses/notFound"
  10711. }
  10712. }
  10713. }
  10714. },
  10715. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  10716. "post": {
  10717. "produces": [
  10718. "application/json"
  10719. ],
  10720. "tags": [
  10721. "repository"
  10722. ],
  10723. "summary": "create review requests for a pull request",
  10724. "operationId": "repoCreatePullReviewRequests",
  10725. "parameters": [
  10726. {
  10727. "type": "string",
  10728. "description": "owner of the repo",
  10729. "name": "owner",
  10730. "in": "path",
  10731. "required": true
  10732. },
  10733. {
  10734. "type": "string",
  10735. "description": "name of the repo",
  10736. "name": "repo",
  10737. "in": "path",
  10738. "required": true
  10739. },
  10740. {
  10741. "type": "integer",
  10742. "format": "int64",
  10743. "description": "index of the pull request",
  10744. "name": "index",
  10745. "in": "path",
  10746. "required": true
  10747. },
  10748. {
  10749. "name": "body",
  10750. "in": "body",
  10751. "required": true,
  10752. "schema": {
  10753. "$ref": "#/definitions/PullReviewRequestOptions"
  10754. }
  10755. }
  10756. ],
  10757. "responses": {
  10758. "201": {
  10759. "$ref": "#/responses/PullReviewList"
  10760. },
  10761. "404": {
  10762. "$ref": "#/responses/notFound"
  10763. },
  10764. "422": {
  10765. "$ref": "#/responses/validationError"
  10766. }
  10767. }
  10768. },
  10769. "delete": {
  10770. "produces": [
  10771. "application/json"
  10772. ],
  10773. "tags": [
  10774. "repository"
  10775. ],
  10776. "summary": "cancel review requests for a pull request",
  10777. "operationId": "repoDeletePullReviewRequests",
  10778. "parameters": [
  10779. {
  10780. "type": "string",
  10781. "description": "owner of the repo",
  10782. "name": "owner",
  10783. "in": "path",
  10784. "required": true
  10785. },
  10786. {
  10787. "type": "string",
  10788. "description": "name of the repo",
  10789. "name": "repo",
  10790. "in": "path",
  10791. "required": true
  10792. },
  10793. {
  10794. "type": "integer",
  10795. "format": "int64",
  10796. "description": "index of the pull request",
  10797. "name": "index",
  10798. "in": "path",
  10799. "required": true
  10800. },
  10801. {
  10802. "name": "body",
  10803. "in": "body",
  10804. "required": true,
  10805. "schema": {
  10806. "$ref": "#/definitions/PullReviewRequestOptions"
  10807. }
  10808. }
  10809. ],
  10810. "responses": {
  10811. "204": {
  10812. "$ref": "#/responses/empty"
  10813. },
  10814. "404": {
  10815. "$ref": "#/responses/notFound"
  10816. },
  10817. "422": {
  10818. "$ref": "#/responses/validationError"
  10819. }
  10820. }
  10821. }
  10822. },
  10823. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  10824. "get": {
  10825. "produces": [
  10826. "application/json"
  10827. ],
  10828. "tags": [
  10829. "repository"
  10830. ],
  10831. "summary": "List all reviews for a pull request",
  10832. "operationId": "repoListPullReviews",
  10833. "parameters": [
  10834. {
  10835. "type": "string",
  10836. "description": "owner of the repo",
  10837. "name": "owner",
  10838. "in": "path",
  10839. "required": true
  10840. },
  10841. {
  10842. "type": "string",
  10843. "description": "name of the repo",
  10844. "name": "repo",
  10845. "in": "path",
  10846. "required": true
  10847. },
  10848. {
  10849. "type": "integer",
  10850. "format": "int64",
  10851. "description": "index of the pull request",
  10852. "name": "index",
  10853. "in": "path",
  10854. "required": true
  10855. },
  10856. {
  10857. "type": "integer",
  10858. "description": "page number of results to return (1-based)",
  10859. "name": "page",
  10860. "in": "query"
  10861. },
  10862. {
  10863. "type": "integer",
  10864. "description": "page size of results",
  10865. "name": "limit",
  10866. "in": "query"
  10867. }
  10868. ],
  10869. "responses": {
  10870. "200": {
  10871. "$ref": "#/responses/PullReviewList"
  10872. },
  10873. "404": {
  10874. "$ref": "#/responses/notFound"
  10875. }
  10876. }
  10877. },
  10878. "post": {
  10879. "produces": [
  10880. "application/json"
  10881. ],
  10882. "tags": [
  10883. "repository"
  10884. ],
  10885. "summary": "Create a review to an pull request",
  10886. "operationId": "repoCreatePullReview",
  10887. "parameters": [
  10888. {
  10889. "type": "string",
  10890. "description": "owner of the repo",
  10891. "name": "owner",
  10892. "in": "path",
  10893. "required": true
  10894. },
  10895. {
  10896. "type": "string",
  10897. "description": "name of the repo",
  10898. "name": "repo",
  10899. "in": "path",
  10900. "required": true
  10901. },
  10902. {
  10903. "type": "integer",
  10904. "format": "int64",
  10905. "description": "index of the pull request",
  10906. "name": "index",
  10907. "in": "path",
  10908. "required": true
  10909. },
  10910. {
  10911. "name": "body",
  10912. "in": "body",
  10913. "required": true,
  10914. "schema": {
  10915. "$ref": "#/definitions/CreatePullReviewOptions"
  10916. }
  10917. }
  10918. ],
  10919. "responses": {
  10920. "200": {
  10921. "$ref": "#/responses/PullReview"
  10922. },
  10923. "404": {
  10924. "$ref": "#/responses/notFound"
  10925. },
  10926. "422": {
  10927. "$ref": "#/responses/validationError"
  10928. }
  10929. }
  10930. }
  10931. },
  10932. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  10933. "get": {
  10934. "produces": [
  10935. "application/json"
  10936. ],
  10937. "tags": [
  10938. "repository"
  10939. ],
  10940. "summary": "Get a specific review for a pull request",
  10941. "operationId": "repoGetPullReview",
  10942. "parameters": [
  10943. {
  10944. "type": "string",
  10945. "description": "owner of the repo",
  10946. "name": "owner",
  10947. "in": "path",
  10948. "required": true
  10949. },
  10950. {
  10951. "type": "string",
  10952. "description": "name of the repo",
  10953. "name": "repo",
  10954. "in": "path",
  10955. "required": true
  10956. },
  10957. {
  10958. "type": "integer",
  10959. "format": "int64",
  10960. "description": "index of the pull request",
  10961. "name": "index",
  10962. "in": "path",
  10963. "required": true
  10964. },
  10965. {
  10966. "type": "integer",
  10967. "format": "int64",
  10968. "description": "id of the review",
  10969. "name": "id",
  10970. "in": "path",
  10971. "required": true
  10972. }
  10973. ],
  10974. "responses": {
  10975. "200": {
  10976. "$ref": "#/responses/PullReview"
  10977. },
  10978. "404": {
  10979. "$ref": "#/responses/notFound"
  10980. }
  10981. }
  10982. },
  10983. "post": {
  10984. "produces": [
  10985. "application/json"
  10986. ],
  10987. "tags": [
  10988. "repository"
  10989. ],
  10990. "summary": "Submit a pending review to an pull request",
  10991. "operationId": "repoSubmitPullReview",
  10992. "parameters": [
  10993. {
  10994. "type": "string",
  10995. "description": "owner of the repo",
  10996. "name": "owner",
  10997. "in": "path",
  10998. "required": true
  10999. },
  11000. {
  11001. "type": "string",
  11002. "description": "name of the repo",
  11003. "name": "repo",
  11004. "in": "path",
  11005. "required": true
  11006. },
  11007. {
  11008. "type": "integer",
  11009. "format": "int64",
  11010. "description": "index of the pull request",
  11011. "name": "index",
  11012. "in": "path",
  11013. "required": true
  11014. },
  11015. {
  11016. "type": "integer",
  11017. "format": "int64",
  11018. "description": "id of the review",
  11019. "name": "id",
  11020. "in": "path",
  11021. "required": true
  11022. },
  11023. {
  11024. "name": "body",
  11025. "in": "body",
  11026. "required": true,
  11027. "schema": {
  11028. "$ref": "#/definitions/SubmitPullReviewOptions"
  11029. }
  11030. }
  11031. ],
  11032. "responses": {
  11033. "200": {
  11034. "$ref": "#/responses/PullReview"
  11035. },
  11036. "404": {
  11037. "$ref": "#/responses/notFound"
  11038. },
  11039. "422": {
  11040. "$ref": "#/responses/validationError"
  11041. }
  11042. }
  11043. },
  11044. "delete": {
  11045. "produces": [
  11046. "application/json"
  11047. ],
  11048. "tags": [
  11049. "repository"
  11050. ],
  11051. "summary": "Delete a specific review from a pull request",
  11052. "operationId": "repoDeletePullReview",
  11053. "parameters": [
  11054. {
  11055. "type": "string",
  11056. "description": "owner of the repo",
  11057. "name": "owner",
  11058. "in": "path",
  11059. "required": true
  11060. },
  11061. {
  11062. "type": "string",
  11063. "description": "name of the repo",
  11064. "name": "repo",
  11065. "in": "path",
  11066. "required": true
  11067. },
  11068. {
  11069. "type": "integer",
  11070. "format": "int64",
  11071. "description": "index of the pull request",
  11072. "name": "index",
  11073. "in": "path",
  11074. "required": true
  11075. },
  11076. {
  11077. "type": "integer",
  11078. "format": "int64",
  11079. "description": "id of the review",
  11080. "name": "id",
  11081. "in": "path",
  11082. "required": true
  11083. }
  11084. ],
  11085. "responses": {
  11086. "204": {
  11087. "$ref": "#/responses/empty"
  11088. },
  11089. "403": {
  11090. "$ref": "#/responses/forbidden"
  11091. },
  11092. "404": {
  11093. "$ref": "#/responses/notFound"
  11094. }
  11095. }
  11096. }
  11097. },
  11098. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  11099. "get": {
  11100. "produces": [
  11101. "application/json"
  11102. ],
  11103. "tags": [
  11104. "repository"
  11105. ],
  11106. "summary": "Get a specific review for a pull request",
  11107. "operationId": "repoGetPullReviewComments",
  11108. "parameters": [
  11109. {
  11110. "type": "string",
  11111. "description": "owner of the repo",
  11112. "name": "owner",
  11113. "in": "path",
  11114. "required": true
  11115. },
  11116. {
  11117. "type": "string",
  11118. "description": "name of the repo",
  11119. "name": "repo",
  11120. "in": "path",
  11121. "required": true
  11122. },
  11123. {
  11124. "type": "integer",
  11125. "format": "int64",
  11126. "description": "index of the pull request",
  11127. "name": "index",
  11128. "in": "path",
  11129. "required": true
  11130. },
  11131. {
  11132. "type": "integer",
  11133. "format": "int64",
  11134. "description": "id of the review",
  11135. "name": "id",
  11136. "in": "path",
  11137. "required": true
  11138. }
  11139. ],
  11140. "responses": {
  11141. "200": {
  11142. "$ref": "#/responses/PullReviewCommentList"
  11143. },
  11144. "404": {
  11145. "$ref": "#/responses/notFound"
  11146. }
  11147. }
  11148. }
  11149. },
  11150. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  11151. "post": {
  11152. "produces": [
  11153. "application/json"
  11154. ],
  11155. "tags": [
  11156. "repository"
  11157. ],
  11158. "summary": "Dismiss a review for a pull request",
  11159. "operationId": "repoDismissPullReview",
  11160. "parameters": [
  11161. {
  11162. "type": "string",
  11163. "description": "owner of the repo",
  11164. "name": "owner",
  11165. "in": "path",
  11166. "required": true
  11167. },
  11168. {
  11169. "type": "string",
  11170. "description": "name of the repo",
  11171. "name": "repo",
  11172. "in": "path",
  11173. "required": true
  11174. },
  11175. {
  11176. "type": "integer",
  11177. "format": "int64",
  11178. "description": "index of the pull request",
  11179. "name": "index",
  11180. "in": "path",
  11181. "required": true
  11182. },
  11183. {
  11184. "type": "integer",
  11185. "format": "int64",
  11186. "description": "id of the review",
  11187. "name": "id",
  11188. "in": "path",
  11189. "required": true
  11190. },
  11191. {
  11192. "name": "body",
  11193. "in": "body",
  11194. "required": true,
  11195. "schema": {
  11196. "$ref": "#/definitions/DismissPullReviewOptions"
  11197. }
  11198. }
  11199. ],
  11200. "responses": {
  11201. "200": {
  11202. "$ref": "#/responses/PullReview"
  11203. },
  11204. "403": {
  11205. "$ref": "#/responses/forbidden"
  11206. },
  11207. "404": {
  11208. "$ref": "#/responses/notFound"
  11209. },
  11210. "422": {
  11211. "$ref": "#/responses/validationError"
  11212. }
  11213. }
  11214. }
  11215. },
  11216. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  11217. "post": {
  11218. "produces": [
  11219. "application/json"
  11220. ],
  11221. "tags": [
  11222. "repository"
  11223. ],
  11224. "summary": "Cancel to dismiss a review for a pull request",
  11225. "operationId": "repoUnDismissPullReview",
  11226. "parameters": [
  11227. {
  11228. "type": "string",
  11229. "description": "owner of the repo",
  11230. "name": "owner",
  11231. "in": "path",
  11232. "required": true
  11233. },
  11234. {
  11235. "type": "string",
  11236. "description": "name of the repo",
  11237. "name": "repo",
  11238. "in": "path",
  11239. "required": true
  11240. },
  11241. {
  11242. "type": "integer",
  11243. "format": "int64",
  11244. "description": "index of the pull request",
  11245. "name": "index",
  11246. "in": "path",
  11247. "required": true
  11248. },
  11249. {
  11250. "type": "integer",
  11251. "format": "int64",
  11252. "description": "id of the review",
  11253. "name": "id",
  11254. "in": "path",
  11255. "required": true
  11256. }
  11257. ],
  11258. "responses": {
  11259. "200": {
  11260. "$ref": "#/responses/PullReview"
  11261. },
  11262. "403": {
  11263. "$ref": "#/responses/forbidden"
  11264. },
  11265. "404": {
  11266. "$ref": "#/responses/notFound"
  11267. },
  11268. "422": {
  11269. "$ref": "#/responses/validationError"
  11270. }
  11271. }
  11272. }
  11273. },
  11274. "/repos/{owner}/{repo}/pulls/{index}/update": {
  11275. "post": {
  11276. "produces": [
  11277. "application/json"
  11278. ],
  11279. "tags": [
  11280. "repository"
  11281. ],
  11282. "summary": "Merge PR's baseBranch into headBranch",
  11283. "operationId": "repoUpdatePullRequest",
  11284. "parameters": [
  11285. {
  11286. "type": "string",
  11287. "description": "owner of the repo",
  11288. "name": "owner",
  11289. "in": "path",
  11290. "required": true
  11291. },
  11292. {
  11293. "type": "string",
  11294. "description": "name of the repo",
  11295. "name": "repo",
  11296. "in": "path",
  11297. "required": true
  11298. },
  11299. {
  11300. "type": "integer",
  11301. "format": "int64",
  11302. "description": "index of the pull request to get",
  11303. "name": "index",
  11304. "in": "path",
  11305. "required": true
  11306. },
  11307. {
  11308. "enum": [
  11309. "merge",
  11310. "rebase"
  11311. ],
  11312. "type": "string",
  11313. "description": "how to update pull request",
  11314. "name": "style",
  11315. "in": "query"
  11316. }
  11317. ],
  11318. "responses": {
  11319. "200": {
  11320. "$ref": "#/responses/empty"
  11321. },
  11322. "403": {
  11323. "$ref": "#/responses/forbidden"
  11324. },
  11325. "404": {
  11326. "$ref": "#/responses/notFound"
  11327. },
  11328. "409": {
  11329. "$ref": "#/responses/error"
  11330. },
  11331. "422": {
  11332. "$ref": "#/responses/validationError"
  11333. }
  11334. }
  11335. }
  11336. },
  11337. "/repos/{owner}/{repo}/push_mirrors": {
  11338. "get": {
  11339. "produces": [
  11340. "application/json"
  11341. ],
  11342. "tags": [
  11343. "repository"
  11344. ],
  11345. "summary": "Get all push mirrors of the repository",
  11346. "operationId": "repoListPushMirrors",
  11347. "parameters": [
  11348. {
  11349. "type": "string",
  11350. "description": "owner of the repo",
  11351. "name": "owner",
  11352. "in": "path",
  11353. "required": true
  11354. },
  11355. {
  11356. "type": "string",
  11357. "description": "name of the repo",
  11358. "name": "repo",
  11359. "in": "path",
  11360. "required": true
  11361. },
  11362. {
  11363. "type": "integer",
  11364. "description": "page number of results to return (1-based)",
  11365. "name": "page",
  11366. "in": "query"
  11367. },
  11368. {
  11369. "type": "integer",
  11370. "description": "page size of results",
  11371. "name": "limit",
  11372. "in": "query"
  11373. }
  11374. ],
  11375. "responses": {
  11376. "200": {
  11377. "$ref": "#/responses/PushMirrorList"
  11378. },
  11379. "400": {
  11380. "$ref": "#/responses/error"
  11381. },
  11382. "403": {
  11383. "$ref": "#/responses/forbidden"
  11384. },
  11385. "404": {
  11386. "$ref": "#/responses/notFound"
  11387. }
  11388. }
  11389. },
  11390. "post": {
  11391. "consumes": [
  11392. "application/json"
  11393. ],
  11394. "produces": [
  11395. "application/json"
  11396. ],
  11397. "tags": [
  11398. "repository"
  11399. ],
  11400. "summary": "add a push mirror to the repository",
  11401. "operationId": "repoAddPushMirror",
  11402. "parameters": [
  11403. {
  11404. "type": "string",
  11405. "description": "owner of the repo",
  11406. "name": "owner",
  11407. "in": "path",
  11408. "required": true
  11409. },
  11410. {
  11411. "type": "string",
  11412. "description": "name of the repo",
  11413. "name": "repo",
  11414. "in": "path",
  11415. "required": true
  11416. },
  11417. {
  11418. "name": "body",
  11419. "in": "body",
  11420. "schema": {
  11421. "$ref": "#/definitions/CreatePushMirrorOption"
  11422. }
  11423. }
  11424. ],
  11425. "responses": {
  11426. "200": {
  11427. "$ref": "#/responses/PushMirror"
  11428. },
  11429. "400": {
  11430. "$ref": "#/responses/error"
  11431. },
  11432. "403": {
  11433. "$ref": "#/responses/forbidden"
  11434. },
  11435. "404": {
  11436. "$ref": "#/responses/notFound"
  11437. }
  11438. }
  11439. }
  11440. },
  11441. "/repos/{owner}/{repo}/push_mirrors-sync": {
  11442. "post": {
  11443. "produces": [
  11444. "application/json"
  11445. ],
  11446. "tags": [
  11447. "repository"
  11448. ],
  11449. "summary": "Sync all push mirrored repository",
  11450. "operationId": "repoPushMirrorSync",
  11451. "parameters": [
  11452. {
  11453. "type": "string",
  11454. "description": "owner of the repo to sync",
  11455. "name": "owner",
  11456. "in": "path",
  11457. "required": true
  11458. },
  11459. {
  11460. "type": "string",
  11461. "description": "name of the repo to sync",
  11462. "name": "repo",
  11463. "in": "path",
  11464. "required": true
  11465. }
  11466. ],
  11467. "responses": {
  11468. "200": {
  11469. "$ref": "#/responses/empty"
  11470. },
  11471. "400": {
  11472. "$ref": "#/responses/error"
  11473. },
  11474. "403": {
  11475. "$ref": "#/responses/forbidden"
  11476. },
  11477. "404": {
  11478. "$ref": "#/responses/notFound"
  11479. }
  11480. }
  11481. }
  11482. },
  11483. "/repos/{owner}/{repo}/push_mirrors/{name}": {
  11484. "get": {
  11485. "produces": [
  11486. "application/json"
  11487. ],
  11488. "tags": [
  11489. "repository"
  11490. ],
  11491. "summary": "Get push mirror of the repository by remoteName",
  11492. "operationId": "repoGetPushMirrorByRemoteName",
  11493. "parameters": [
  11494. {
  11495. "type": "string",
  11496. "description": "owner of the repo",
  11497. "name": "owner",
  11498. "in": "path",
  11499. "required": true
  11500. },
  11501. {
  11502. "type": "string",
  11503. "description": "name of the repo",
  11504. "name": "repo",
  11505. "in": "path",
  11506. "required": true
  11507. },
  11508. {
  11509. "type": "string",
  11510. "description": "remote name of push mirror",
  11511. "name": "name",
  11512. "in": "path",
  11513. "required": true
  11514. }
  11515. ],
  11516. "responses": {
  11517. "200": {
  11518. "$ref": "#/responses/PushMirror"
  11519. },
  11520. "400": {
  11521. "$ref": "#/responses/error"
  11522. },
  11523. "403": {
  11524. "$ref": "#/responses/forbidden"
  11525. },
  11526. "404": {
  11527. "$ref": "#/responses/notFound"
  11528. }
  11529. }
  11530. },
  11531. "delete": {
  11532. "produces": [
  11533. "application/json"
  11534. ],
  11535. "tags": [
  11536. "repository"
  11537. ],
  11538. "summary": "deletes a push mirror from a repository by remoteName",
  11539. "operationId": "repoDeletePushMirror",
  11540. "parameters": [
  11541. {
  11542. "type": "string",
  11543. "description": "owner of the repo",
  11544. "name": "owner",
  11545. "in": "path",
  11546. "required": true
  11547. },
  11548. {
  11549. "type": "string",
  11550. "description": "name of the repo",
  11551. "name": "repo",
  11552. "in": "path",
  11553. "required": true
  11554. },
  11555. {
  11556. "type": "string",
  11557. "description": "remote name of the pushMirror",
  11558. "name": "name",
  11559. "in": "path",
  11560. "required": true
  11561. }
  11562. ],
  11563. "responses": {
  11564. "204": {
  11565. "$ref": "#/responses/empty"
  11566. },
  11567. "400": {
  11568. "$ref": "#/responses/error"
  11569. },
  11570. "404": {
  11571. "$ref": "#/responses/notFound"
  11572. }
  11573. }
  11574. }
  11575. },
  11576. "/repos/{owner}/{repo}/raw/{filepath}": {
  11577. "get": {
  11578. "produces": [
  11579. "application/json"
  11580. ],
  11581. "tags": [
  11582. "repository"
  11583. ],
  11584. "summary": "Get a file from a repository",
  11585. "operationId": "repoGetRawFile",
  11586. "parameters": [
  11587. {
  11588. "type": "string",
  11589. "description": "owner of the repo",
  11590. "name": "owner",
  11591. "in": "path",
  11592. "required": true
  11593. },
  11594. {
  11595. "type": "string",
  11596. "description": "name of the repo",
  11597. "name": "repo",
  11598. "in": "path",
  11599. "required": true
  11600. },
  11601. {
  11602. "type": "string",
  11603. "description": "filepath of the file to get",
  11604. "name": "filepath",
  11605. "in": "path",
  11606. "required": true
  11607. },
  11608. {
  11609. "type": "string",
  11610. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  11611. "name": "ref",
  11612. "in": "query"
  11613. }
  11614. ],
  11615. "responses": {
  11616. "200": {
  11617. "description": "Returns raw file content."
  11618. },
  11619. "404": {
  11620. "$ref": "#/responses/notFound"
  11621. }
  11622. }
  11623. }
  11624. },
  11625. "/repos/{owner}/{repo}/releases": {
  11626. "get": {
  11627. "produces": [
  11628. "application/json"
  11629. ],
  11630. "tags": [
  11631. "repository"
  11632. ],
  11633. "summary": "List a repo's releases",
  11634. "operationId": "repoListReleases",
  11635. "parameters": [
  11636. {
  11637. "type": "string",
  11638. "description": "owner of the repo",
  11639. "name": "owner",
  11640. "in": "path",
  11641. "required": true
  11642. },
  11643. {
  11644. "type": "string",
  11645. "description": "name of the repo",
  11646. "name": "repo",
  11647. "in": "path",
  11648. "required": true
  11649. },
  11650. {
  11651. "type": "boolean",
  11652. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  11653. "name": "draft",
  11654. "in": "query"
  11655. },
  11656. {
  11657. "type": "boolean",
  11658. "description": "filter (exclude / include) pre-releases",
  11659. "name": "pre-release",
  11660. "in": "query"
  11661. },
  11662. {
  11663. "type": "integer",
  11664. "description": "page size of results, deprecated - use limit",
  11665. "name": "per_page",
  11666. "in": "query"
  11667. },
  11668. {
  11669. "type": "integer",
  11670. "description": "page number of results to return (1-based)",
  11671. "name": "page",
  11672. "in": "query"
  11673. },
  11674. {
  11675. "type": "integer",
  11676. "description": "page size of results",
  11677. "name": "limit",
  11678. "in": "query"
  11679. }
  11680. ],
  11681. "responses": {
  11682. "200": {
  11683. "$ref": "#/responses/ReleaseList"
  11684. },
  11685. "404": {
  11686. "$ref": "#/responses/notFound"
  11687. }
  11688. }
  11689. },
  11690. "post": {
  11691. "consumes": [
  11692. "application/json"
  11693. ],
  11694. "produces": [
  11695. "application/json"
  11696. ],
  11697. "tags": [
  11698. "repository"
  11699. ],
  11700. "summary": "Create a release",
  11701. "operationId": "repoCreateRelease",
  11702. "parameters": [
  11703. {
  11704. "type": "string",
  11705. "description": "owner of the repo",
  11706. "name": "owner",
  11707. "in": "path",
  11708. "required": true
  11709. },
  11710. {
  11711. "type": "string",
  11712. "description": "name of the repo",
  11713. "name": "repo",
  11714. "in": "path",
  11715. "required": true
  11716. },
  11717. {
  11718. "name": "body",
  11719. "in": "body",
  11720. "schema": {
  11721. "$ref": "#/definitions/CreateReleaseOption"
  11722. }
  11723. }
  11724. ],
  11725. "responses": {
  11726. "201": {
  11727. "$ref": "#/responses/Release"
  11728. },
  11729. "404": {
  11730. "$ref": "#/responses/notFound"
  11731. },
  11732. "409": {
  11733. "$ref": "#/responses/error"
  11734. }
  11735. }
  11736. }
  11737. },
  11738. "/repos/{owner}/{repo}/releases/latest": {
  11739. "get": {
  11740. "produces": [
  11741. "application/json"
  11742. ],
  11743. "tags": [
  11744. "repository"
  11745. ],
  11746. "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
  11747. "operationId": "repoGetLatestRelease",
  11748. "parameters": [
  11749. {
  11750. "type": "string",
  11751. "description": "owner of the repo",
  11752. "name": "owner",
  11753. "in": "path",
  11754. "required": true
  11755. },
  11756. {
  11757. "type": "string",
  11758. "description": "name of the repo",
  11759. "name": "repo",
  11760. "in": "path",
  11761. "required": true
  11762. }
  11763. ],
  11764. "responses": {
  11765. "200": {
  11766. "$ref": "#/responses/Release"
  11767. },
  11768. "404": {
  11769. "$ref": "#/responses/notFound"
  11770. }
  11771. }
  11772. }
  11773. },
  11774. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  11775. "get": {
  11776. "produces": [
  11777. "application/json"
  11778. ],
  11779. "tags": [
  11780. "repository"
  11781. ],
  11782. "summary": "Get a release by tag name",
  11783. "operationId": "repoGetReleaseByTag",
  11784. "parameters": [
  11785. {
  11786. "type": "string",
  11787. "description": "owner of the repo",
  11788. "name": "owner",
  11789. "in": "path",
  11790. "required": true
  11791. },
  11792. {
  11793. "type": "string",
  11794. "description": "name of the repo",
  11795. "name": "repo",
  11796. "in": "path",
  11797. "required": true
  11798. },
  11799. {
  11800. "type": "string",
  11801. "description": "tag name of the release to get",
  11802. "name": "tag",
  11803. "in": "path",
  11804. "required": true
  11805. }
  11806. ],
  11807. "responses": {
  11808. "200": {
  11809. "$ref": "#/responses/Release"
  11810. },
  11811. "404": {
  11812. "$ref": "#/responses/notFound"
  11813. }
  11814. }
  11815. },
  11816. "delete": {
  11817. "tags": [
  11818. "repository"
  11819. ],
  11820. "summary": "Delete a release by tag name",
  11821. "operationId": "repoDeleteReleaseByTag",
  11822. "parameters": [
  11823. {
  11824. "type": "string",
  11825. "description": "owner of the repo",
  11826. "name": "owner",
  11827. "in": "path",
  11828. "required": true
  11829. },
  11830. {
  11831. "type": "string",
  11832. "description": "name of the repo",
  11833. "name": "repo",
  11834. "in": "path",
  11835. "required": true
  11836. },
  11837. {
  11838. "type": "string",
  11839. "description": "tag name of the release to delete",
  11840. "name": "tag",
  11841. "in": "path",
  11842. "required": true
  11843. }
  11844. ],
  11845. "responses": {
  11846. "204": {
  11847. "$ref": "#/responses/empty"
  11848. },
  11849. "404": {
  11850. "$ref": "#/responses/notFound"
  11851. },
  11852. "405": {
  11853. "$ref": "#/responses/empty"
  11854. }
  11855. }
  11856. }
  11857. },
  11858. "/repos/{owner}/{repo}/releases/{id}": {
  11859. "get": {
  11860. "produces": [
  11861. "application/json"
  11862. ],
  11863. "tags": [
  11864. "repository"
  11865. ],
  11866. "summary": "Get a release",
  11867. "operationId": "repoGetRelease",
  11868. "parameters": [
  11869. {
  11870. "type": "string",
  11871. "description": "owner of the repo",
  11872. "name": "owner",
  11873. "in": "path",
  11874. "required": true
  11875. },
  11876. {
  11877. "type": "string",
  11878. "description": "name of the repo",
  11879. "name": "repo",
  11880. "in": "path",
  11881. "required": true
  11882. },
  11883. {
  11884. "type": "integer",
  11885. "format": "int64",
  11886. "description": "id of the release to get",
  11887. "name": "id",
  11888. "in": "path",
  11889. "required": true
  11890. }
  11891. ],
  11892. "responses": {
  11893. "200": {
  11894. "$ref": "#/responses/Release"
  11895. },
  11896. "404": {
  11897. "$ref": "#/responses/notFound"
  11898. }
  11899. }
  11900. },
  11901. "delete": {
  11902. "tags": [
  11903. "repository"
  11904. ],
  11905. "summary": "Delete a release",
  11906. "operationId": "repoDeleteRelease",
  11907. "parameters": [
  11908. {
  11909. "type": "string",
  11910. "description": "owner of the repo",
  11911. "name": "owner",
  11912. "in": "path",
  11913. "required": true
  11914. },
  11915. {
  11916. "type": "string",
  11917. "description": "name of the repo",
  11918. "name": "repo",
  11919. "in": "path",
  11920. "required": true
  11921. },
  11922. {
  11923. "type": "integer",
  11924. "format": "int64",
  11925. "description": "id of the release to delete",
  11926. "name": "id",
  11927. "in": "path",
  11928. "required": true
  11929. }
  11930. ],
  11931. "responses": {
  11932. "204": {
  11933. "$ref": "#/responses/empty"
  11934. },
  11935. "404": {
  11936. "$ref": "#/responses/notFound"
  11937. },
  11938. "405": {
  11939. "$ref": "#/responses/empty"
  11940. }
  11941. }
  11942. },
  11943. "patch": {
  11944. "consumes": [
  11945. "application/json"
  11946. ],
  11947. "produces": [
  11948. "application/json"
  11949. ],
  11950. "tags": [
  11951. "repository"
  11952. ],
  11953. "summary": "Update a release",
  11954. "operationId": "repoEditRelease",
  11955. "parameters": [
  11956. {
  11957. "type": "string",
  11958. "description": "owner of the repo",
  11959. "name": "owner",
  11960. "in": "path",
  11961. "required": true
  11962. },
  11963. {
  11964. "type": "string",
  11965. "description": "name of the repo",
  11966. "name": "repo",
  11967. "in": "path",
  11968. "required": true
  11969. },
  11970. {
  11971. "type": "integer",
  11972. "format": "int64",
  11973. "description": "id of the release to edit",
  11974. "name": "id",
  11975. "in": "path",
  11976. "required": true
  11977. },
  11978. {
  11979. "name": "body",
  11980. "in": "body",
  11981. "schema": {
  11982. "$ref": "#/definitions/EditReleaseOption"
  11983. }
  11984. }
  11985. ],
  11986. "responses": {
  11987. "200": {
  11988. "$ref": "#/responses/Release"
  11989. },
  11990. "404": {
  11991. "$ref": "#/responses/notFound"
  11992. }
  11993. }
  11994. }
  11995. },
  11996. "/repos/{owner}/{repo}/releases/{id}/assets": {
  11997. "get": {
  11998. "produces": [
  11999. "application/json"
  12000. ],
  12001. "tags": [
  12002. "repository"
  12003. ],
  12004. "summary": "List release's attachments",
  12005. "operationId": "repoListReleaseAttachments",
  12006. "parameters": [
  12007. {
  12008. "type": "string",
  12009. "description": "owner of the repo",
  12010. "name": "owner",
  12011. "in": "path",
  12012. "required": true
  12013. },
  12014. {
  12015. "type": "string",
  12016. "description": "name of the repo",
  12017. "name": "repo",
  12018. "in": "path",
  12019. "required": true
  12020. },
  12021. {
  12022. "type": "integer",
  12023. "format": "int64",
  12024. "description": "id of the release",
  12025. "name": "id",
  12026. "in": "path",
  12027. "required": true
  12028. }
  12029. ],
  12030. "responses": {
  12031. "200": {
  12032. "$ref": "#/responses/AttachmentList"
  12033. },
  12034. "404": {
  12035. "$ref": "#/responses/notFound"
  12036. }
  12037. }
  12038. },
  12039. "post": {
  12040. "consumes": [
  12041. "multipart/form-data"
  12042. ],
  12043. "produces": [
  12044. "application/json"
  12045. ],
  12046. "tags": [
  12047. "repository"
  12048. ],
  12049. "summary": "Create a release attachment",
  12050. "operationId": "repoCreateReleaseAttachment",
  12051. "parameters": [
  12052. {
  12053. "type": "string",
  12054. "description": "owner of the repo",
  12055. "name": "owner",
  12056. "in": "path",
  12057. "required": true
  12058. },
  12059. {
  12060. "type": "string",
  12061. "description": "name of the repo",
  12062. "name": "repo",
  12063. "in": "path",
  12064. "required": true
  12065. },
  12066. {
  12067. "type": "integer",
  12068. "format": "int64",
  12069. "description": "id of the release",
  12070. "name": "id",
  12071. "in": "path",
  12072. "required": true
  12073. },
  12074. {
  12075. "type": "string",
  12076. "description": "name of the attachment",
  12077. "name": "name",
  12078. "in": "query"
  12079. },
  12080. {
  12081. "type": "file",
  12082. "description": "attachment to upload",
  12083. "name": "attachment",
  12084. "in": "formData",
  12085. "required": true
  12086. }
  12087. ],
  12088. "responses": {
  12089. "201": {
  12090. "$ref": "#/responses/Attachment"
  12091. },
  12092. "400": {
  12093. "$ref": "#/responses/error"
  12094. },
  12095. "404": {
  12096. "$ref": "#/responses/notFound"
  12097. }
  12098. }
  12099. }
  12100. },
  12101. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  12102. "get": {
  12103. "produces": [
  12104. "application/json"
  12105. ],
  12106. "tags": [
  12107. "repository"
  12108. ],
  12109. "summary": "Get a release attachment",
  12110. "operationId": "repoGetReleaseAttachment",
  12111. "parameters": [
  12112. {
  12113. "type": "string",
  12114. "description": "owner of the repo",
  12115. "name": "owner",
  12116. "in": "path",
  12117. "required": true
  12118. },
  12119. {
  12120. "type": "string",
  12121. "description": "name of the repo",
  12122. "name": "repo",
  12123. "in": "path",
  12124. "required": true
  12125. },
  12126. {
  12127. "type": "integer",
  12128. "format": "int64",
  12129. "description": "id of the release",
  12130. "name": "id",
  12131. "in": "path",
  12132. "required": true
  12133. },
  12134. {
  12135. "type": "integer",
  12136. "format": "int64",
  12137. "description": "id of the attachment to get",
  12138. "name": "attachment_id",
  12139. "in": "path",
  12140. "required": true
  12141. }
  12142. ],
  12143. "responses": {
  12144. "200": {
  12145. "$ref": "#/responses/Attachment"
  12146. },
  12147. "404": {
  12148. "$ref": "#/responses/notFound"
  12149. }
  12150. }
  12151. },
  12152. "delete": {
  12153. "produces": [
  12154. "application/json"
  12155. ],
  12156. "tags": [
  12157. "repository"
  12158. ],
  12159. "summary": "Delete a release attachment",
  12160. "operationId": "repoDeleteReleaseAttachment",
  12161. "parameters": [
  12162. {
  12163. "type": "string",
  12164. "description": "owner of the repo",
  12165. "name": "owner",
  12166. "in": "path",
  12167. "required": true
  12168. },
  12169. {
  12170. "type": "string",
  12171. "description": "name of the repo",
  12172. "name": "repo",
  12173. "in": "path",
  12174. "required": true
  12175. },
  12176. {
  12177. "type": "integer",
  12178. "format": "int64",
  12179. "description": "id of the release",
  12180. "name": "id",
  12181. "in": "path",
  12182. "required": true
  12183. },
  12184. {
  12185. "type": "integer",
  12186. "format": "int64",
  12187. "description": "id of the attachment to delete",
  12188. "name": "attachment_id",
  12189. "in": "path",
  12190. "required": true
  12191. }
  12192. ],
  12193. "responses": {
  12194. "204": {
  12195. "$ref": "#/responses/empty"
  12196. },
  12197. "404": {
  12198. "$ref": "#/responses/notFound"
  12199. }
  12200. }
  12201. },
  12202. "patch": {
  12203. "consumes": [
  12204. "application/json"
  12205. ],
  12206. "produces": [
  12207. "application/json"
  12208. ],
  12209. "tags": [
  12210. "repository"
  12211. ],
  12212. "summary": "Edit a release attachment",
  12213. "operationId": "repoEditReleaseAttachment",
  12214. "parameters": [
  12215. {
  12216. "type": "string",
  12217. "description": "owner of the repo",
  12218. "name": "owner",
  12219. "in": "path",
  12220. "required": true
  12221. },
  12222. {
  12223. "type": "string",
  12224. "description": "name of the repo",
  12225. "name": "repo",
  12226. "in": "path",
  12227. "required": true
  12228. },
  12229. {
  12230. "type": "integer",
  12231. "format": "int64",
  12232. "description": "id of the release",
  12233. "name": "id",
  12234. "in": "path",
  12235. "required": true
  12236. },
  12237. {
  12238. "type": "integer",
  12239. "format": "int64",
  12240. "description": "id of the attachment to edit",
  12241. "name": "attachment_id",
  12242. "in": "path",
  12243. "required": true
  12244. },
  12245. {
  12246. "name": "body",
  12247. "in": "body",
  12248. "schema": {
  12249. "$ref": "#/definitions/EditAttachmentOptions"
  12250. }
  12251. }
  12252. ],
  12253. "responses": {
  12254. "201": {
  12255. "$ref": "#/responses/Attachment"
  12256. },
  12257. "404": {
  12258. "$ref": "#/responses/notFound"
  12259. }
  12260. }
  12261. }
  12262. },
  12263. "/repos/{owner}/{repo}/reviewers": {
  12264. "get": {
  12265. "produces": [
  12266. "application/json"
  12267. ],
  12268. "tags": [
  12269. "repository"
  12270. ],
  12271. "summary": "Return all users that can be requested to review in this repo",
  12272. "operationId": "repoGetReviewers",
  12273. "parameters": [
  12274. {
  12275. "type": "string",
  12276. "description": "owner of the repo",
  12277. "name": "owner",
  12278. "in": "path",
  12279. "required": true
  12280. },
  12281. {
  12282. "type": "string",
  12283. "description": "name of the repo",
  12284. "name": "repo",
  12285. "in": "path",
  12286. "required": true
  12287. }
  12288. ],
  12289. "responses": {
  12290. "200": {
  12291. "$ref": "#/responses/UserList"
  12292. },
  12293. "404": {
  12294. "$ref": "#/responses/notFound"
  12295. }
  12296. }
  12297. }
  12298. },
  12299. "/repos/{owner}/{repo}/signing-key.gpg": {
  12300. "get": {
  12301. "produces": [
  12302. "text/plain"
  12303. ],
  12304. "tags": [
  12305. "repository"
  12306. ],
  12307. "summary": "Get signing-key.gpg for given repository",
  12308. "operationId": "repoSigningKey",
  12309. "parameters": [
  12310. {
  12311. "type": "string",
  12312. "description": "owner of the repo",
  12313. "name": "owner",
  12314. "in": "path",
  12315. "required": true
  12316. },
  12317. {
  12318. "type": "string",
  12319. "description": "name of the repo",
  12320. "name": "repo",
  12321. "in": "path",
  12322. "required": true
  12323. }
  12324. ],
  12325. "responses": {
  12326. "200": {
  12327. "description": "GPG armored public key",
  12328. "schema": {
  12329. "type": "string"
  12330. }
  12331. }
  12332. }
  12333. }
  12334. },
  12335. "/repos/{owner}/{repo}/stargazers": {
  12336. "get": {
  12337. "produces": [
  12338. "application/json"
  12339. ],
  12340. "tags": [
  12341. "repository"
  12342. ],
  12343. "summary": "List a repo's stargazers",
  12344. "operationId": "repoListStargazers",
  12345. "parameters": [
  12346. {
  12347. "type": "string",
  12348. "description": "owner of the repo",
  12349. "name": "owner",
  12350. "in": "path",
  12351. "required": true
  12352. },
  12353. {
  12354. "type": "string",
  12355. "description": "name of the repo",
  12356. "name": "repo",
  12357. "in": "path",
  12358. "required": true
  12359. },
  12360. {
  12361. "type": "integer",
  12362. "description": "page number of results to return (1-based)",
  12363. "name": "page",
  12364. "in": "query"
  12365. },
  12366. {
  12367. "type": "integer",
  12368. "description": "page size of results",
  12369. "name": "limit",
  12370. "in": "query"
  12371. }
  12372. ],
  12373. "responses": {
  12374. "200": {
  12375. "$ref": "#/responses/UserList"
  12376. },
  12377. "404": {
  12378. "$ref": "#/responses/notFound"
  12379. }
  12380. }
  12381. }
  12382. },
  12383. "/repos/{owner}/{repo}/statuses/{sha}": {
  12384. "get": {
  12385. "produces": [
  12386. "application/json"
  12387. ],
  12388. "tags": [
  12389. "repository"
  12390. ],
  12391. "summary": "Get a commit's statuses",
  12392. "operationId": "repoListStatuses",
  12393. "parameters": [
  12394. {
  12395. "type": "string",
  12396. "description": "owner of the repo",
  12397. "name": "owner",
  12398. "in": "path",
  12399. "required": true
  12400. },
  12401. {
  12402. "type": "string",
  12403. "description": "name of the repo",
  12404. "name": "repo",
  12405. "in": "path",
  12406. "required": true
  12407. },
  12408. {
  12409. "type": "string",
  12410. "description": "sha of the commit",
  12411. "name": "sha",
  12412. "in": "path",
  12413. "required": true
  12414. },
  12415. {
  12416. "enum": [
  12417. "oldest",
  12418. "recentupdate",
  12419. "leastupdate",
  12420. "leastindex",
  12421. "highestindex"
  12422. ],
  12423. "type": "string",
  12424. "description": "type of sort",
  12425. "name": "sort",
  12426. "in": "query"
  12427. },
  12428. {
  12429. "enum": [
  12430. "pending",
  12431. "success",
  12432. "error",
  12433. "failure",
  12434. "warning"
  12435. ],
  12436. "type": "string",
  12437. "description": "type of state",
  12438. "name": "state",
  12439. "in": "query"
  12440. },
  12441. {
  12442. "type": "integer",
  12443. "description": "page number of results to return (1-based)",
  12444. "name": "page",
  12445. "in": "query"
  12446. },
  12447. {
  12448. "type": "integer",
  12449. "description": "page size of results",
  12450. "name": "limit",
  12451. "in": "query"
  12452. }
  12453. ],
  12454. "responses": {
  12455. "200": {
  12456. "$ref": "#/responses/CommitStatusList"
  12457. },
  12458. "400": {
  12459. "$ref": "#/responses/error"
  12460. },
  12461. "404": {
  12462. "$ref": "#/responses/notFound"
  12463. }
  12464. }
  12465. },
  12466. "post": {
  12467. "produces": [
  12468. "application/json"
  12469. ],
  12470. "tags": [
  12471. "repository"
  12472. ],
  12473. "summary": "Create a commit status",
  12474. "operationId": "repoCreateStatus",
  12475. "parameters": [
  12476. {
  12477. "type": "string",
  12478. "description": "owner of the repo",
  12479. "name": "owner",
  12480. "in": "path",
  12481. "required": true
  12482. },
  12483. {
  12484. "type": "string",
  12485. "description": "name of the repo",
  12486. "name": "repo",
  12487. "in": "path",
  12488. "required": true
  12489. },
  12490. {
  12491. "type": "string",
  12492. "description": "sha of the commit",
  12493. "name": "sha",
  12494. "in": "path",
  12495. "required": true
  12496. },
  12497. {
  12498. "name": "body",
  12499. "in": "body",
  12500. "schema": {
  12501. "$ref": "#/definitions/CreateStatusOption"
  12502. }
  12503. }
  12504. ],
  12505. "responses": {
  12506. "201": {
  12507. "$ref": "#/responses/CommitStatus"
  12508. },
  12509. "400": {
  12510. "$ref": "#/responses/error"
  12511. },
  12512. "404": {
  12513. "$ref": "#/responses/notFound"
  12514. }
  12515. }
  12516. }
  12517. },
  12518. "/repos/{owner}/{repo}/subscribers": {
  12519. "get": {
  12520. "produces": [
  12521. "application/json"
  12522. ],
  12523. "tags": [
  12524. "repository"
  12525. ],
  12526. "summary": "List a repo's watchers",
  12527. "operationId": "repoListSubscribers",
  12528. "parameters": [
  12529. {
  12530. "type": "string",
  12531. "description": "owner of the repo",
  12532. "name": "owner",
  12533. "in": "path",
  12534. "required": true
  12535. },
  12536. {
  12537. "type": "string",
  12538. "description": "name of the repo",
  12539. "name": "repo",
  12540. "in": "path",
  12541. "required": true
  12542. },
  12543. {
  12544. "type": "integer",
  12545. "description": "page number of results to return (1-based)",
  12546. "name": "page",
  12547. "in": "query"
  12548. },
  12549. {
  12550. "type": "integer",
  12551. "description": "page size of results",
  12552. "name": "limit",
  12553. "in": "query"
  12554. }
  12555. ],
  12556. "responses": {
  12557. "200": {
  12558. "$ref": "#/responses/UserList"
  12559. },
  12560. "404": {
  12561. "$ref": "#/responses/notFound"
  12562. }
  12563. }
  12564. }
  12565. },
  12566. "/repos/{owner}/{repo}/subscription": {
  12567. "get": {
  12568. "tags": [
  12569. "repository"
  12570. ],
  12571. "summary": "Check if the current user is watching a repo",
  12572. "operationId": "userCurrentCheckSubscription",
  12573. "parameters": [
  12574. {
  12575. "type": "string",
  12576. "description": "owner of the repo",
  12577. "name": "owner",
  12578. "in": "path",
  12579. "required": true
  12580. },
  12581. {
  12582. "type": "string",
  12583. "description": "name of the repo",
  12584. "name": "repo",
  12585. "in": "path",
  12586. "required": true
  12587. }
  12588. ],
  12589. "responses": {
  12590. "200": {
  12591. "$ref": "#/responses/WatchInfo"
  12592. },
  12593. "404": {
  12594. "description": "User is not watching this repo or repo do not exist"
  12595. }
  12596. }
  12597. },
  12598. "put": {
  12599. "tags": [
  12600. "repository"
  12601. ],
  12602. "summary": "Watch a repo",
  12603. "operationId": "userCurrentPutSubscription",
  12604. "parameters": [
  12605. {
  12606. "type": "string",
  12607. "description": "owner of the repo",
  12608. "name": "owner",
  12609. "in": "path",
  12610. "required": true
  12611. },
  12612. {
  12613. "type": "string",
  12614. "description": "name of the repo",
  12615. "name": "repo",
  12616. "in": "path",
  12617. "required": true
  12618. }
  12619. ],
  12620. "responses": {
  12621. "200": {
  12622. "$ref": "#/responses/WatchInfo"
  12623. },
  12624. "404": {
  12625. "$ref": "#/responses/notFound"
  12626. }
  12627. }
  12628. },
  12629. "delete": {
  12630. "tags": [
  12631. "repository"
  12632. ],
  12633. "summary": "Unwatch a repo",
  12634. "operationId": "userCurrentDeleteSubscription",
  12635. "parameters": [
  12636. {
  12637. "type": "string",
  12638. "description": "owner of the repo",
  12639. "name": "owner",
  12640. "in": "path",
  12641. "required": true
  12642. },
  12643. {
  12644. "type": "string",
  12645. "description": "name of the repo",
  12646. "name": "repo",
  12647. "in": "path",
  12648. "required": true
  12649. }
  12650. ],
  12651. "responses": {
  12652. "204": {
  12653. "$ref": "#/responses/empty"
  12654. },
  12655. "404": {
  12656. "$ref": "#/responses/notFound"
  12657. }
  12658. }
  12659. }
  12660. },
  12661. "/repos/{owner}/{repo}/tags": {
  12662. "get": {
  12663. "produces": [
  12664. "application/json"
  12665. ],
  12666. "tags": [
  12667. "repository"
  12668. ],
  12669. "summary": "List a repository's tags",
  12670. "operationId": "repoListTags",
  12671. "parameters": [
  12672. {
  12673. "type": "string",
  12674. "description": "owner of the repo",
  12675. "name": "owner",
  12676. "in": "path",
  12677. "required": true
  12678. },
  12679. {
  12680. "type": "string",
  12681. "description": "name of the repo",
  12682. "name": "repo",
  12683. "in": "path",
  12684. "required": true
  12685. },
  12686. {
  12687. "type": "integer",
  12688. "description": "page number of results to return (1-based)",
  12689. "name": "page",
  12690. "in": "query"
  12691. },
  12692. {
  12693. "type": "integer",
  12694. "description": "page size of results, default maximum page size is 50",
  12695. "name": "limit",
  12696. "in": "query"
  12697. }
  12698. ],
  12699. "responses": {
  12700. "200": {
  12701. "$ref": "#/responses/TagList"
  12702. },
  12703. "404": {
  12704. "$ref": "#/responses/notFound"
  12705. }
  12706. }
  12707. },
  12708. "post": {
  12709. "produces": [
  12710. "application/json"
  12711. ],
  12712. "tags": [
  12713. "repository"
  12714. ],
  12715. "summary": "Create a new git tag in a repository",
  12716. "operationId": "repoCreateTag",
  12717. "parameters": [
  12718. {
  12719. "type": "string",
  12720. "description": "owner of the repo",
  12721. "name": "owner",
  12722. "in": "path",
  12723. "required": true
  12724. },
  12725. {
  12726. "type": "string",
  12727. "description": "name of the repo",
  12728. "name": "repo",
  12729. "in": "path",
  12730. "required": true
  12731. },
  12732. {
  12733. "name": "body",
  12734. "in": "body",
  12735. "schema": {
  12736. "$ref": "#/definitions/CreateTagOption"
  12737. }
  12738. }
  12739. ],
  12740. "responses": {
  12741. "200": {
  12742. "$ref": "#/responses/Tag"
  12743. },
  12744. "404": {
  12745. "$ref": "#/responses/notFound"
  12746. },
  12747. "405": {
  12748. "$ref": "#/responses/empty"
  12749. },
  12750. "409": {
  12751. "$ref": "#/responses/conflict"
  12752. }
  12753. }
  12754. }
  12755. },
  12756. "/repos/{owner}/{repo}/tags/{tag}": {
  12757. "get": {
  12758. "produces": [
  12759. "application/json"
  12760. ],
  12761. "tags": [
  12762. "repository"
  12763. ],
  12764. "summary": "Get the tag of a repository by tag name",
  12765. "operationId": "repoGetTag",
  12766. "parameters": [
  12767. {
  12768. "type": "string",
  12769. "description": "owner of the repo",
  12770. "name": "owner",
  12771. "in": "path",
  12772. "required": true
  12773. },
  12774. {
  12775. "type": "string",
  12776. "description": "name of the repo",
  12777. "name": "repo",
  12778. "in": "path",
  12779. "required": true
  12780. },
  12781. {
  12782. "type": "string",
  12783. "description": "name of tag",
  12784. "name": "tag",
  12785. "in": "path",
  12786. "required": true
  12787. }
  12788. ],
  12789. "responses": {
  12790. "200": {
  12791. "$ref": "#/responses/Tag"
  12792. },
  12793. "404": {
  12794. "$ref": "#/responses/notFound"
  12795. }
  12796. }
  12797. },
  12798. "delete": {
  12799. "produces": [
  12800. "application/json"
  12801. ],
  12802. "tags": [
  12803. "repository"
  12804. ],
  12805. "summary": "Delete a repository's tag by name",
  12806. "operationId": "repoDeleteTag",
  12807. "parameters": [
  12808. {
  12809. "type": "string",
  12810. "description": "owner of the repo",
  12811. "name": "owner",
  12812. "in": "path",
  12813. "required": true
  12814. },
  12815. {
  12816. "type": "string",
  12817. "description": "name of the repo",
  12818. "name": "repo",
  12819. "in": "path",
  12820. "required": true
  12821. },
  12822. {
  12823. "type": "string",
  12824. "description": "name of tag to delete",
  12825. "name": "tag",
  12826. "in": "path",
  12827. "required": true
  12828. }
  12829. ],
  12830. "responses": {
  12831. "204": {
  12832. "$ref": "#/responses/empty"
  12833. },
  12834. "404": {
  12835. "$ref": "#/responses/notFound"
  12836. },
  12837. "405": {
  12838. "$ref": "#/responses/empty"
  12839. },
  12840. "409": {
  12841. "$ref": "#/responses/conflict"
  12842. }
  12843. }
  12844. }
  12845. },
  12846. "/repos/{owner}/{repo}/teams": {
  12847. "get": {
  12848. "produces": [
  12849. "application/json"
  12850. ],
  12851. "tags": [
  12852. "repository"
  12853. ],
  12854. "summary": "List a repository's teams",
  12855. "operationId": "repoListTeams",
  12856. "parameters": [
  12857. {
  12858. "type": "string",
  12859. "description": "owner of the repo",
  12860. "name": "owner",
  12861. "in": "path",
  12862. "required": true
  12863. },
  12864. {
  12865. "type": "string",
  12866. "description": "name of the repo",
  12867. "name": "repo",
  12868. "in": "path",
  12869. "required": true
  12870. }
  12871. ],
  12872. "responses": {
  12873. "200": {
  12874. "$ref": "#/responses/TeamList"
  12875. },
  12876. "404": {
  12877. "$ref": "#/responses/notFound"
  12878. }
  12879. }
  12880. }
  12881. },
  12882. "/repos/{owner}/{repo}/teams/{team}": {
  12883. "get": {
  12884. "produces": [
  12885. "application/json"
  12886. ],
  12887. "tags": [
  12888. "repository"
  12889. ],
  12890. "summary": "Check if a team is assigned to a repository",
  12891. "operationId": "repoCheckTeam",
  12892. "parameters": [
  12893. {
  12894. "type": "string",
  12895. "description": "owner of the repo",
  12896. "name": "owner",
  12897. "in": "path",
  12898. "required": true
  12899. },
  12900. {
  12901. "type": "string",
  12902. "description": "name of the repo",
  12903. "name": "repo",
  12904. "in": "path",
  12905. "required": true
  12906. },
  12907. {
  12908. "type": "string",
  12909. "description": "team name",
  12910. "name": "team",
  12911. "in": "path",
  12912. "required": true
  12913. }
  12914. ],
  12915. "responses": {
  12916. "200": {
  12917. "$ref": "#/responses/Team"
  12918. },
  12919. "404": {
  12920. "$ref": "#/responses/notFound"
  12921. },
  12922. "405": {
  12923. "$ref": "#/responses/error"
  12924. }
  12925. }
  12926. },
  12927. "put": {
  12928. "produces": [
  12929. "application/json"
  12930. ],
  12931. "tags": [
  12932. "repository"
  12933. ],
  12934. "summary": "Add a team to a repository",
  12935. "operationId": "repoAddTeam",
  12936. "parameters": [
  12937. {
  12938. "type": "string",
  12939. "description": "owner of the repo",
  12940. "name": "owner",
  12941. "in": "path",
  12942. "required": true
  12943. },
  12944. {
  12945. "type": "string",
  12946. "description": "name of the repo",
  12947. "name": "repo",
  12948. "in": "path",
  12949. "required": true
  12950. },
  12951. {
  12952. "type": "string",
  12953. "description": "team name",
  12954. "name": "team",
  12955. "in": "path",
  12956. "required": true
  12957. }
  12958. ],
  12959. "responses": {
  12960. "204": {
  12961. "$ref": "#/responses/empty"
  12962. },
  12963. "404": {
  12964. "$ref": "#/responses/notFound"
  12965. },
  12966. "405": {
  12967. "$ref": "#/responses/error"
  12968. },
  12969. "422": {
  12970. "$ref": "#/responses/validationError"
  12971. }
  12972. }
  12973. },
  12974. "delete": {
  12975. "produces": [
  12976. "application/json"
  12977. ],
  12978. "tags": [
  12979. "repository"
  12980. ],
  12981. "summary": "Delete a team from a repository",
  12982. "operationId": "repoDeleteTeam",
  12983. "parameters": [
  12984. {
  12985. "type": "string",
  12986. "description": "owner of the repo",
  12987. "name": "owner",
  12988. "in": "path",
  12989. "required": true
  12990. },
  12991. {
  12992. "type": "string",
  12993. "description": "name of the repo",
  12994. "name": "repo",
  12995. "in": "path",
  12996. "required": true
  12997. },
  12998. {
  12999. "type": "string",
  13000. "description": "team name",
  13001. "name": "team",
  13002. "in": "path",
  13003. "required": true
  13004. }
  13005. ],
  13006. "responses": {
  13007. "204": {
  13008. "$ref": "#/responses/empty"
  13009. },
  13010. "404": {
  13011. "$ref": "#/responses/notFound"
  13012. },
  13013. "405": {
  13014. "$ref": "#/responses/error"
  13015. },
  13016. "422": {
  13017. "$ref": "#/responses/validationError"
  13018. }
  13019. }
  13020. }
  13021. },
  13022. "/repos/{owner}/{repo}/times": {
  13023. "get": {
  13024. "produces": [
  13025. "application/json"
  13026. ],
  13027. "tags": [
  13028. "repository"
  13029. ],
  13030. "summary": "List a repo's tracked times",
  13031. "operationId": "repoTrackedTimes",
  13032. "parameters": [
  13033. {
  13034. "type": "string",
  13035. "description": "owner of the repo",
  13036. "name": "owner",
  13037. "in": "path",
  13038. "required": true
  13039. },
  13040. {
  13041. "type": "string",
  13042. "description": "name of the repo",
  13043. "name": "repo",
  13044. "in": "path",
  13045. "required": true
  13046. },
  13047. {
  13048. "type": "string",
  13049. "description": "optional filter by user (available for issue managers)",
  13050. "name": "user",
  13051. "in": "query"
  13052. },
  13053. {
  13054. "type": "string",
  13055. "format": "date-time",
  13056. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  13057. "name": "since",
  13058. "in": "query"
  13059. },
  13060. {
  13061. "type": "string",
  13062. "format": "date-time",
  13063. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  13064. "name": "before",
  13065. "in": "query"
  13066. },
  13067. {
  13068. "type": "integer",
  13069. "description": "page number of results to return (1-based)",
  13070. "name": "page",
  13071. "in": "query"
  13072. },
  13073. {
  13074. "type": "integer",
  13075. "description": "page size of results",
  13076. "name": "limit",
  13077. "in": "query"
  13078. }
  13079. ],
  13080. "responses": {
  13081. "200": {
  13082. "$ref": "#/responses/TrackedTimeList"
  13083. },
  13084. "400": {
  13085. "$ref": "#/responses/error"
  13086. },
  13087. "403": {
  13088. "$ref": "#/responses/forbidden"
  13089. },
  13090. "404": {
  13091. "$ref": "#/responses/notFound"
  13092. }
  13093. }
  13094. }
  13095. },
  13096. "/repos/{owner}/{repo}/times/{user}": {
  13097. "get": {
  13098. "produces": [
  13099. "application/json"
  13100. ],
  13101. "tags": [
  13102. "repository"
  13103. ],
  13104. "summary": "List a user's tracked times in a repo",
  13105. "operationId": "userTrackedTimes",
  13106. "deprecated": true,
  13107. "parameters": [
  13108. {
  13109. "type": "string",
  13110. "description": "owner of the repo",
  13111. "name": "owner",
  13112. "in": "path",
  13113. "required": true
  13114. },
  13115. {
  13116. "type": "string",
  13117. "description": "name of the repo",
  13118. "name": "repo",
  13119. "in": "path",
  13120. "required": true
  13121. },
  13122. {
  13123. "type": "string",
  13124. "description": "username of user",
  13125. "name": "user",
  13126. "in": "path",
  13127. "required": true
  13128. }
  13129. ],
  13130. "responses": {
  13131. "200": {
  13132. "$ref": "#/responses/TrackedTimeList"
  13133. },
  13134. "400": {
  13135. "$ref": "#/responses/error"
  13136. },
  13137. "403": {
  13138. "$ref": "#/responses/forbidden"
  13139. },
  13140. "404": {
  13141. "$ref": "#/responses/notFound"
  13142. }
  13143. }
  13144. }
  13145. },
  13146. "/repos/{owner}/{repo}/topics": {
  13147. "get": {
  13148. "produces": [
  13149. "application/json"
  13150. ],
  13151. "tags": [
  13152. "repository"
  13153. ],
  13154. "summary": "Get list of topics that a repository has",
  13155. "operationId": "repoListTopics",
  13156. "parameters": [
  13157. {
  13158. "type": "string",
  13159. "description": "owner of the repo",
  13160. "name": "owner",
  13161. "in": "path",
  13162. "required": true
  13163. },
  13164. {
  13165. "type": "string",
  13166. "description": "name of the repo",
  13167. "name": "repo",
  13168. "in": "path",
  13169. "required": true
  13170. },
  13171. {
  13172. "type": "integer",
  13173. "description": "page number of results to return (1-based)",
  13174. "name": "page",
  13175. "in": "query"
  13176. },
  13177. {
  13178. "type": "integer",
  13179. "description": "page size of results",
  13180. "name": "limit",
  13181. "in": "query"
  13182. }
  13183. ],
  13184. "responses": {
  13185. "200": {
  13186. "$ref": "#/responses/TopicNames"
  13187. },
  13188. "404": {
  13189. "$ref": "#/responses/notFound"
  13190. }
  13191. }
  13192. },
  13193. "put": {
  13194. "produces": [
  13195. "application/json"
  13196. ],
  13197. "tags": [
  13198. "repository"
  13199. ],
  13200. "summary": "Replace list of topics for a repository",
  13201. "operationId": "repoUpdateTopics",
  13202. "parameters": [
  13203. {
  13204. "type": "string",
  13205. "description": "owner of the repo",
  13206. "name": "owner",
  13207. "in": "path",
  13208. "required": true
  13209. },
  13210. {
  13211. "type": "string",
  13212. "description": "name of the repo",
  13213. "name": "repo",
  13214. "in": "path",
  13215. "required": true
  13216. },
  13217. {
  13218. "name": "body",
  13219. "in": "body",
  13220. "schema": {
  13221. "$ref": "#/definitions/RepoTopicOptions"
  13222. }
  13223. }
  13224. ],
  13225. "responses": {
  13226. "204": {
  13227. "$ref": "#/responses/empty"
  13228. },
  13229. "404": {
  13230. "$ref": "#/responses/notFound"
  13231. },
  13232. "422": {
  13233. "$ref": "#/responses/invalidTopicsError"
  13234. }
  13235. }
  13236. }
  13237. },
  13238. "/repos/{owner}/{repo}/topics/{topic}": {
  13239. "put": {
  13240. "produces": [
  13241. "application/json"
  13242. ],
  13243. "tags": [
  13244. "repository"
  13245. ],
  13246. "summary": "Add a topic to a repository",
  13247. "operationId": "repoAddTopic",
  13248. "parameters": [
  13249. {
  13250. "type": "string",
  13251. "description": "owner of the repo",
  13252. "name": "owner",
  13253. "in": "path",
  13254. "required": true
  13255. },
  13256. {
  13257. "type": "string",
  13258. "description": "name of the repo",
  13259. "name": "repo",
  13260. "in": "path",
  13261. "required": true
  13262. },
  13263. {
  13264. "type": "string",
  13265. "description": "name of the topic to add",
  13266. "name": "topic",
  13267. "in": "path",
  13268. "required": true
  13269. }
  13270. ],
  13271. "responses": {
  13272. "204": {
  13273. "$ref": "#/responses/empty"
  13274. },
  13275. "404": {
  13276. "$ref": "#/responses/notFound"
  13277. },
  13278. "422": {
  13279. "$ref": "#/responses/invalidTopicsError"
  13280. }
  13281. }
  13282. },
  13283. "delete": {
  13284. "produces": [
  13285. "application/json"
  13286. ],
  13287. "tags": [
  13288. "repository"
  13289. ],
  13290. "summary": "Delete a topic from a repository",
  13291. "operationId": "repoDeleteTopic",
  13292. "parameters": [
  13293. {
  13294. "type": "string",
  13295. "description": "owner of the repo",
  13296. "name": "owner",
  13297. "in": "path",
  13298. "required": true
  13299. },
  13300. {
  13301. "type": "string",
  13302. "description": "name of the repo",
  13303. "name": "repo",
  13304. "in": "path",
  13305. "required": true
  13306. },
  13307. {
  13308. "type": "string",
  13309. "description": "name of the topic to delete",
  13310. "name": "topic",
  13311. "in": "path",
  13312. "required": true
  13313. }
  13314. ],
  13315. "responses": {
  13316. "204": {
  13317. "$ref": "#/responses/empty"
  13318. },
  13319. "404": {
  13320. "$ref": "#/responses/notFound"
  13321. },
  13322. "422": {
  13323. "$ref": "#/responses/invalidTopicsError"
  13324. }
  13325. }
  13326. }
  13327. },
  13328. "/repos/{owner}/{repo}/transfer": {
  13329. "post": {
  13330. "produces": [
  13331. "application/json"
  13332. ],
  13333. "tags": [
  13334. "repository"
  13335. ],
  13336. "summary": "Transfer a repo ownership",
  13337. "operationId": "repoTransfer",
  13338. "parameters": [
  13339. {
  13340. "type": "string",
  13341. "description": "owner of the repo to transfer",
  13342. "name": "owner",
  13343. "in": "path",
  13344. "required": true
  13345. },
  13346. {
  13347. "type": "string",
  13348. "description": "name of the repo to transfer",
  13349. "name": "repo",
  13350. "in": "path",
  13351. "required": true
  13352. },
  13353. {
  13354. "description": "Transfer Options",
  13355. "name": "body",
  13356. "in": "body",
  13357. "required": true,
  13358. "schema": {
  13359. "$ref": "#/definitions/TransferRepoOption"
  13360. }
  13361. }
  13362. ],
  13363. "responses": {
  13364. "202": {
  13365. "$ref": "#/responses/Repository"
  13366. },
  13367. "403": {
  13368. "$ref": "#/responses/forbidden"
  13369. },
  13370. "404": {
  13371. "$ref": "#/responses/notFound"
  13372. },
  13373. "422": {
  13374. "$ref": "#/responses/validationError"
  13375. }
  13376. }
  13377. }
  13378. },
  13379. "/repos/{owner}/{repo}/transfer/accept": {
  13380. "post": {
  13381. "produces": [
  13382. "application/json"
  13383. ],
  13384. "tags": [
  13385. "repository"
  13386. ],
  13387. "summary": "Accept a repo transfer",
  13388. "operationId": "acceptRepoTransfer",
  13389. "parameters": [
  13390. {
  13391. "type": "string",
  13392. "description": "owner of the repo to transfer",
  13393. "name": "owner",
  13394. "in": "path",
  13395. "required": true
  13396. },
  13397. {
  13398. "type": "string",
  13399. "description": "name of the repo to transfer",
  13400. "name": "repo",
  13401. "in": "path",
  13402. "required": true
  13403. }
  13404. ],
  13405. "responses": {
  13406. "202": {
  13407. "$ref": "#/responses/Repository"
  13408. },
  13409. "403": {
  13410. "$ref": "#/responses/forbidden"
  13411. },
  13412. "404": {
  13413. "$ref": "#/responses/notFound"
  13414. }
  13415. }
  13416. }
  13417. },
  13418. "/repos/{owner}/{repo}/transfer/reject": {
  13419. "post": {
  13420. "produces": [
  13421. "application/json"
  13422. ],
  13423. "tags": [
  13424. "repository"
  13425. ],
  13426. "summary": "Reject a repo transfer",
  13427. "operationId": "rejectRepoTransfer",
  13428. "parameters": [
  13429. {
  13430. "type": "string",
  13431. "description": "owner of the repo to transfer",
  13432. "name": "owner",
  13433. "in": "path",
  13434. "required": true
  13435. },
  13436. {
  13437. "type": "string",
  13438. "description": "name of the repo to transfer",
  13439. "name": "repo",
  13440. "in": "path",
  13441. "required": true
  13442. }
  13443. ],
  13444. "responses": {
  13445. "200": {
  13446. "$ref": "#/responses/Repository"
  13447. },
  13448. "403": {
  13449. "$ref": "#/responses/forbidden"
  13450. },
  13451. "404": {
  13452. "$ref": "#/responses/notFound"
  13453. }
  13454. }
  13455. }
  13456. },
  13457. "/repos/{owner}/{repo}/wiki/new": {
  13458. "post": {
  13459. "consumes": [
  13460. "application/json"
  13461. ],
  13462. "tags": [
  13463. "repository"
  13464. ],
  13465. "summary": "Create a wiki page",
  13466. "operationId": "repoCreateWikiPage",
  13467. "parameters": [
  13468. {
  13469. "type": "string",
  13470. "description": "owner of the repo",
  13471. "name": "owner",
  13472. "in": "path",
  13473. "required": true
  13474. },
  13475. {
  13476. "type": "string",
  13477. "description": "name of the repo",
  13478. "name": "repo",
  13479. "in": "path",
  13480. "required": true
  13481. },
  13482. {
  13483. "name": "body",
  13484. "in": "body",
  13485. "schema": {
  13486. "$ref": "#/definitions/CreateWikiPageOptions"
  13487. }
  13488. }
  13489. ],
  13490. "responses": {
  13491. "201": {
  13492. "$ref": "#/responses/WikiPage"
  13493. },
  13494. "400": {
  13495. "$ref": "#/responses/error"
  13496. },
  13497. "403": {
  13498. "$ref": "#/responses/forbidden"
  13499. },
  13500. "404": {
  13501. "$ref": "#/responses/notFound"
  13502. }
  13503. }
  13504. }
  13505. },
  13506. "/repos/{owner}/{repo}/wiki/page/{pageName}": {
  13507. "get": {
  13508. "produces": [
  13509. "application/json"
  13510. ],
  13511. "tags": [
  13512. "repository"
  13513. ],
  13514. "summary": "Get a wiki page",
  13515. "operationId": "repoGetWikiPage",
  13516. "parameters": [
  13517. {
  13518. "type": "string",
  13519. "description": "owner of the repo",
  13520. "name": "owner",
  13521. "in": "path",
  13522. "required": true
  13523. },
  13524. {
  13525. "type": "string",
  13526. "description": "name of the repo",
  13527. "name": "repo",
  13528. "in": "path",
  13529. "required": true
  13530. },
  13531. {
  13532. "type": "string",
  13533. "description": "name of the page",
  13534. "name": "pageName",
  13535. "in": "path",
  13536. "required": true
  13537. }
  13538. ],
  13539. "responses": {
  13540. "200": {
  13541. "$ref": "#/responses/WikiPage"
  13542. },
  13543. "404": {
  13544. "$ref": "#/responses/notFound"
  13545. }
  13546. }
  13547. },
  13548. "delete": {
  13549. "tags": [
  13550. "repository"
  13551. ],
  13552. "summary": "Delete a wiki page",
  13553. "operationId": "repoDeleteWikiPage",
  13554. "parameters": [
  13555. {
  13556. "type": "string",
  13557. "description": "owner of the repo",
  13558. "name": "owner",
  13559. "in": "path",
  13560. "required": true
  13561. },
  13562. {
  13563. "type": "string",
  13564. "description": "name of the repo",
  13565. "name": "repo",
  13566. "in": "path",
  13567. "required": true
  13568. },
  13569. {
  13570. "type": "string",
  13571. "description": "name of the page",
  13572. "name": "pageName",
  13573. "in": "path",
  13574. "required": true
  13575. }
  13576. ],
  13577. "responses": {
  13578. "204": {
  13579. "$ref": "#/responses/empty"
  13580. },
  13581. "403": {
  13582. "$ref": "#/responses/forbidden"
  13583. },
  13584. "404": {
  13585. "$ref": "#/responses/notFound"
  13586. }
  13587. }
  13588. },
  13589. "patch": {
  13590. "consumes": [
  13591. "application/json"
  13592. ],
  13593. "tags": [
  13594. "repository"
  13595. ],
  13596. "summary": "Edit a wiki page",
  13597. "operationId": "repoEditWikiPage",
  13598. "parameters": [
  13599. {
  13600. "type": "string",
  13601. "description": "owner of the repo",
  13602. "name": "owner",
  13603. "in": "path",
  13604. "required": true
  13605. },
  13606. {
  13607. "type": "string",
  13608. "description": "name of the repo",
  13609. "name": "repo",
  13610. "in": "path",
  13611. "required": true
  13612. },
  13613. {
  13614. "type": "string",
  13615. "description": "name of the page",
  13616. "name": "pageName",
  13617. "in": "path",
  13618. "required": true
  13619. },
  13620. {
  13621. "name": "body",
  13622. "in": "body",
  13623. "schema": {
  13624. "$ref": "#/definitions/CreateWikiPageOptions"
  13625. }
  13626. }
  13627. ],
  13628. "responses": {
  13629. "200": {
  13630. "$ref": "#/responses/WikiPage"
  13631. },
  13632. "400": {
  13633. "$ref": "#/responses/error"
  13634. },
  13635. "403": {
  13636. "$ref": "#/responses/forbidden"
  13637. },
  13638. "404": {
  13639. "$ref": "#/responses/notFound"
  13640. }
  13641. }
  13642. }
  13643. },
  13644. "/repos/{owner}/{repo}/wiki/pages": {
  13645. "get": {
  13646. "produces": [
  13647. "application/json"
  13648. ],
  13649. "tags": [
  13650. "repository"
  13651. ],
  13652. "summary": "Get all wiki pages",
  13653. "operationId": "repoGetWikiPages",
  13654. "parameters": [
  13655. {
  13656. "type": "string",
  13657. "description": "owner of the repo",
  13658. "name": "owner",
  13659. "in": "path",
  13660. "required": true
  13661. },
  13662. {
  13663. "type": "string",
  13664. "description": "name of the repo",
  13665. "name": "repo",
  13666. "in": "path",
  13667. "required": true
  13668. },
  13669. {
  13670. "type": "integer",
  13671. "description": "page number of results to return (1-based)",
  13672. "name": "page",
  13673. "in": "query"
  13674. },
  13675. {
  13676. "type": "integer",
  13677. "description": "page size of results",
  13678. "name": "limit",
  13679. "in": "query"
  13680. }
  13681. ],
  13682. "responses": {
  13683. "200": {
  13684. "$ref": "#/responses/WikiPageList"
  13685. },
  13686. "404": {
  13687. "$ref": "#/responses/notFound"
  13688. }
  13689. }
  13690. }
  13691. },
  13692. "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
  13693. "get": {
  13694. "produces": [
  13695. "application/json"
  13696. ],
  13697. "tags": [
  13698. "repository"
  13699. ],
  13700. "summary": "Get revisions of a wiki page",
  13701. "operationId": "repoGetWikiPageRevisions",
  13702. "parameters": [
  13703. {
  13704. "type": "string",
  13705. "description": "owner of the repo",
  13706. "name": "owner",
  13707. "in": "path",
  13708. "required": true
  13709. },
  13710. {
  13711. "type": "string",
  13712. "description": "name of the repo",
  13713. "name": "repo",
  13714. "in": "path",
  13715. "required": true
  13716. },
  13717. {
  13718. "type": "string",
  13719. "description": "name of the page",
  13720. "name": "pageName",
  13721. "in": "path",
  13722. "required": true
  13723. },
  13724. {
  13725. "type": "integer",
  13726. "description": "page number of results to return (1-based)",
  13727. "name": "page",
  13728. "in": "query"
  13729. }
  13730. ],
  13731. "responses": {
  13732. "200": {
  13733. "$ref": "#/responses/WikiCommitList"
  13734. },
  13735. "404": {
  13736. "$ref": "#/responses/notFound"
  13737. }
  13738. }
  13739. }
  13740. },
  13741. "/repos/{template_owner}/{template_repo}/generate": {
  13742. "post": {
  13743. "consumes": [
  13744. "application/json"
  13745. ],
  13746. "produces": [
  13747. "application/json"
  13748. ],
  13749. "tags": [
  13750. "repository"
  13751. ],
  13752. "summary": "Create a repository using a template",
  13753. "operationId": "generateRepo",
  13754. "parameters": [
  13755. {
  13756. "type": "string",
  13757. "description": "name of the template repository owner",
  13758. "name": "template_owner",
  13759. "in": "path",
  13760. "required": true
  13761. },
  13762. {
  13763. "type": "string",
  13764. "description": "name of the template repository",
  13765. "name": "template_repo",
  13766. "in": "path",
  13767. "required": true
  13768. },
  13769. {
  13770. "name": "body",
  13771. "in": "body",
  13772. "schema": {
  13773. "$ref": "#/definitions/GenerateRepoOption"
  13774. }
  13775. }
  13776. ],
  13777. "responses": {
  13778. "201": {
  13779. "$ref": "#/responses/Repository"
  13780. },
  13781. "403": {
  13782. "$ref": "#/responses/forbidden"
  13783. },
  13784. "404": {
  13785. "$ref": "#/responses/notFound"
  13786. },
  13787. "409": {
  13788. "description": "The repository with the same name already exists."
  13789. },
  13790. "422": {
  13791. "$ref": "#/responses/validationError"
  13792. }
  13793. }
  13794. }
  13795. },
  13796. "/repositories/{id}": {
  13797. "get": {
  13798. "produces": [
  13799. "application/json"
  13800. ],
  13801. "tags": [
  13802. "repository"
  13803. ],
  13804. "summary": "Get a repository by id",
  13805. "operationId": "repoGetByID",
  13806. "parameters": [
  13807. {
  13808. "type": "integer",
  13809. "format": "int64",
  13810. "description": "id of the repo to get",
  13811. "name": "id",
  13812. "in": "path",
  13813. "required": true
  13814. }
  13815. ],
  13816. "responses": {
  13817. "200": {
  13818. "$ref": "#/responses/Repository"
  13819. },
  13820. "404": {
  13821. "$ref": "#/responses/notFound"
  13822. }
  13823. }
  13824. }
  13825. },
  13826. "/settings/api": {
  13827. "get": {
  13828. "produces": [
  13829. "application/json"
  13830. ],
  13831. "tags": [
  13832. "settings"
  13833. ],
  13834. "summary": "Get instance's global settings for api",
  13835. "operationId": "getGeneralAPISettings",
  13836. "responses": {
  13837. "200": {
  13838. "$ref": "#/responses/GeneralAPISettings"
  13839. }
  13840. }
  13841. }
  13842. },
  13843. "/settings/attachment": {
  13844. "get": {
  13845. "produces": [
  13846. "application/json"
  13847. ],
  13848. "tags": [
  13849. "settings"
  13850. ],
  13851. "summary": "Get instance's global settings for Attachment",
  13852. "operationId": "getGeneralAttachmentSettings",
  13853. "responses": {
  13854. "200": {
  13855. "$ref": "#/responses/GeneralAttachmentSettings"
  13856. }
  13857. }
  13858. }
  13859. },
  13860. "/settings/repository": {
  13861. "get": {
  13862. "produces": [
  13863. "application/json"
  13864. ],
  13865. "tags": [
  13866. "settings"
  13867. ],
  13868. "summary": "Get instance's global settings for repositories",
  13869. "operationId": "getGeneralRepositorySettings",
  13870. "responses": {
  13871. "200": {
  13872. "$ref": "#/responses/GeneralRepoSettings"
  13873. }
  13874. }
  13875. }
  13876. },
  13877. "/settings/ui": {
  13878. "get": {
  13879. "produces": [
  13880. "application/json"
  13881. ],
  13882. "tags": [
  13883. "settings"
  13884. ],
  13885. "summary": "Get instance's global settings for ui",
  13886. "operationId": "getGeneralUISettings",
  13887. "responses": {
  13888. "200": {
  13889. "$ref": "#/responses/GeneralUISettings"
  13890. }
  13891. }
  13892. }
  13893. },
  13894. "/signing-key.gpg": {
  13895. "get": {
  13896. "produces": [
  13897. "text/plain"
  13898. ],
  13899. "tags": [
  13900. "miscellaneous"
  13901. ],
  13902. "summary": "Get default signing-key.gpg",
  13903. "operationId": "getSigningKey",
  13904. "responses": {
  13905. "200": {
  13906. "description": "GPG armored public key",
  13907. "schema": {
  13908. "type": "string"
  13909. }
  13910. }
  13911. }
  13912. }
  13913. },
  13914. "/teams/{id}": {
  13915. "get": {
  13916. "produces": [
  13917. "application/json"
  13918. ],
  13919. "tags": [
  13920. "organization"
  13921. ],
  13922. "summary": "Get a team",
  13923. "operationId": "orgGetTeam",
  13924. "parameters": [
  13925. {
  13926. "type": "integer",
  13927. "format": "int64",
  13928. "description": "id of the team to get",
  13929. "name": "id",
  13930. "in": "path",
  13931. "required": true
  13932. }
  13933. ],
  13934. "responses": {
  13935. "200": {
  13936. "$ref": "#/responses/Team"
  13937. },
  13938. "404": {
  13939. "$ref": "#/responses/notFound"
  13940. }
  13941. }
  13942. },
  13943. "delete": {
  13944. "tags": [
  13945. "organization"
  13946. ],
  13947. "summary": "Delete a team",
  13948. "operationId": "orgDeleteTeam",
  13949. "parameters": [
  13950. {
  13951. "type": "integer",
  13952. "format": "int64",
  13953. "description": "id of the team to delete",
  13954. "name": "id",
  13955. "in": "path",
  13956. "required": true
  13957. }
  13958. ],
  13959. "responses": {
  13960. "204": {
  13961. "description": "team deleted"
  13962. },
  13963. "404": {
  13964. "$ref": "#/responses/notFound"
  13965. }
  13966. }
  13967. },
  13968. "patch": {
  13969. "consumes": [
  13970. "application/json"
  13971. ],
  13972. "produces": [
  13973. "application/json"
  13974. ],
  13975. "tags": [
  13976. "organization"
  13977. ],
  13978. "summary": "Edit a team",
  13979. "operationId": "orgEditTeam",
  13980. "parameters": [
  13981. {
  13982. "type": "integer",
  13983. "description": "id of the team to edit",
  13984. "name": "id",
  13985. "in": "path",
  13986. "required": true
  13987. },
  13988. {
  13989. "name": "body",
  13990. "in": "body",
  13991. "schema": {
  13992. "$ref": "#/definitions/EditTeamOption"
  13993. }
  13994. }
  13995. ],
  13996. "responses": {
  13997. "200": {
  13998. "$ref": "#/responses/Team"
  13999. },
  14000. "404": {
  14001. "$ref": "#/responses/notFound"
  14002. }
  14003. }
  14004. }
  14005. },
  14006. "/teams/{id}/activities/feeds": {
  14007. "get": {
  14008. "produces": [
  14009. "application/json"
  14010. ],
  14011. "tags": [
  14012. "organization"
  14013. ],
  14014. "summary": "List a team's activity feeds",
  14015. "operationId": "orgListTeamActivityFeeds",
  14016. "parameters": [
  14017. {
  14018. "type": "integer",
  14019. "format": "int64",
  14020. "description": "id of the team",
  14021. "name": "id",
  14022. "in": "path",
  14023. "required": true
  14024. },
  14025. {
  14026. "type": "string",
  14027. "format": "date",
  14028. "description": "the date of the activities to be found",
  14029. "name": "date",
  14030. "in": "query"
  14031. },
  14032. {
  14033. "type": "integer",
  14034. "description": "page number of results to return (1-based)",
  14035. "name": "page",
  14036. "in": "query"
  14037. },
  14038. {
  14039. "type": "integer",
  14040. "description": "page size of results",
  14041. "name": "limit",
  14042. "in": "query"
  14043. }
  14044. ],
  14045. "responses": {
  14046. "200": {
  14047. "$ref": "#/responses/ActivityFeedsList"
  14048. },
  14049. "404": {
  14050. "$ref": "#/responses/notFound"
  14051. }
  14052. }
  14053. }
  14054. },
  14055. "/teams/{id}/members": {
  14056. "get": {
  14057. "produces": [
  14058. "application/json"
  14059. ],
  14060. "tags": [
  14061. "organization"
  14062. ],
  14063. "summary": "List a team's members",
  14064. "operationId": "orgListTeamMembers",
  14065. "parameters": [
  14066. {
  14067. "type": "integer",
  14068. "format": "int64",
  14069. "description": "id of the team",
  14070. "name": "id",
  14071. "in": "path",
  14072. "required": true
  14073. },
  14074. {
  14075. "type": "integer",
  14076. "description": "page number of results to return (1-based)",
  14077. "name": "page",
  14078. "in": "query"
  14079. },
  14080. {
  14081. "type": "integer",
  14082. "description": "page size of results",
  14083. "name": "limit",
  14084. "in": "query"
  14085. }
  14086. ],
  14087. "responses": {
  14088. "200": {
  14089. "$ref": "#/responses/UserList"
  14090. },
  14091. "404": {
  14092. "$ref": "#/responses/notFound"
  14093. }
  14094. }
  14095. }
  14096. },
  14097. "/teams/{id}/members/{username}": {
  14098. "get": {
  14099. "produces": [
  14100. "application/json"
  14101. ],
  14102. "tags": [
  14103. "organization"
  14104. ],
  14105. "summary": "List a particular member of team",
  14106. "operationId": "orgListTeamMember",
  14107. "parameters": [
  14108. {
  14109. "type": "integer",
  14110. "format": "int64",
  14111. "description": "id of the team",
  14112. "name": "id",
  14113. "in": "path",
  14114. "required": true
  14115. },
  14116. {
  14117. "type": "string",
  14118. "description": "username of the member to list",
  14119. "name": "username",
  14120. "in": "path",
  14121. "required": true
  14122. }
  14123. ],
  14124. "responses": {
  14125. "200": {
  14126. "$ref": "#/responses/User"
  14127. },
  14128. "404": {
  14129. "$ref": "#/responses/notFound"
  14130. }
  14131. }
  14132. },
  14133. "put": {
  14134. "produces": [
  14135. "application/json"
  14136. ],
  14137. "tags": [
  14138. "organization"
  14139. ],
  14140. "summary": "Add a team member",
  14141. "operationId": "orgAddTeamMember",
  14142. "parameters": [
  14143. {
  14144. "type": "integer",
  14145. "format": "int64",
  14146. "description": "id of the team",
  14147. "name": "id",
  14148. "in": "path",
  14149. "required": true
  14150. },
  14151. {
  14152. "type": "string",
  14153. "description": "username of the user to add",
  14154. "name": "username",
  14155. "in": "path",
  14156. "required": true
  14157. }
  14158. ],
  14159. "responses": {
  14160. "204": {
  14161. "$ref": "#/responses/empty"
  14162. },
  14163. "404": {
  14164. "$ref": "#/responses/notFound"
  14165. }
  14166. }
  14167. },
  14168. "delete": {
  14169. "produces": [
  14170. "application/json"
  14171. ],
  14172. "tags": [
  14173. "organization"
  14174. ],
  14175. "summary": "Remove a team member",
  14176. "operationId": "orgRemoveTeamMember",
  14177. "parameters": [
  14178. {
  14179. "type": "integer",
  14180. "format": "int64",
  14181. "description": "id of the team",
  14182. "name": "id",
  14183. "in": "path",
  14184. "required": true
  14185. },
  14186. {
  14187. "type": "string",
  14188. "description": "username of the user to remove",
  14189. "name": "username",
  14190. "in": "path",
  14191. "required": true
  14192. }
  14193. ],
  14194. "responses": {
  14195. "204": {
  14196. "$ref": "#/responses/empty"
  14197. },
  14198. "404": {
  14199. "$ref": "#/responses/notFound"
  14200. }
  14201. }
  14202. }
  14203. },
  14204. "/teams/{id}/repos": {
  14205. "get": {
  14206. "produces": [
  14207. "application/json"
  14208. ],
  14209. "tags": [
  14210. "organization"
  14211. ],
  14212. "summary": "List a team's repos",
  14213. "operationId": "orgListTeamRepos",
  14214. "parameters": [
  14215. {
  14216. "type": "integer",
  14217. "format": "int64",
  14218. "description": "id of the team",
  14219. "name": "id",
  14220. "in": "path",
  14221. "required": true
  14222. },
  14223. {
  14224. "type": "integer",
  14225. "description": "page number of results to return (1-based)",
  14226. "name": "page",
  14227. "in": "query"
  14228. },
  14229. {
  14230. "type": "integer",
  14231. "description": "page size of results",
  14232. "name": "limit",
  14233. "in": "query"
  14234. }
  14235. ],
  14236. "responses": {
  14237. "200": {
  14238. "$ref": "#/responses/RepositoryList"
  14239. },
  14240. "404": {
  14241. "$ref": "#/responses/notFound"
  14242. }
  14243. }
  14244. }
  14245. },
  14246. "/teams/{id}/repos/{org}/{repo}": {
  14247. "get": {
  14248. "produces": [
  14249. "application/json"
  14250. ],
  14251. "tags": [
  14252. "organization"
  14253. ],
  14254. "summary": "List a particular repo of team",
  14255. "operationId": "orgListTeamRepo",
  14256. "parameters": [
  14257. {
  14258. "type": "integer",
  14259. "format": "int64",
  14260. "description": "id of the team",
  14261. "name": "id",
  14262. "in": "path",
  14263. "required": true
  14264. },
  14265. {
  14266. "type": "string",
  14267. "description": "organization that owns the repo to list",
  14268. "name": "org",
  14269. "in": "path",
  14270. "required": true
  14271. },
  14272. {
  14273. "type": "string",
  14274. "description": "name of the repo to list",
  14275. "name": "repo",
  14276. "in": "path",
  14277. "required": true
  14278. }
  14279. ],
  14280. "responses": {
  14281. "200": {
  14282. "$ref": "#/responses/Repository"
  14283. },
  14284. "404": {
  14285. "$ref": "#/responses/notFound"
  14286. }
  14287. }
  14288. },
  14289. "put": {
  14290. "produces": [
  14291. "application/json"
  14292. ],
  14293. "tags": [
  14294. "organization"
  14295. ],
  14296. "summary": "Add a repository to a team",
  14297. "operationId": "orgAddTeamRepository",
  14298. "parameters": [
  14299. {
  14300. "type": "integer",
  14301. "format": "int64",
  14302. "description": "id of the team",
  14303. "name": "id",
  14304. "in": "path",
  14305. "required": true
  14306. },
  14307. {
  14308. "type": "string",
  14309. "description": "organization that owns the repo to add",
  14310. "name": "org",
  14311. "in": "path",
  14312. "required": true
  14313. },
  14314. {
  14315. "type": "string",
  14316. "description": "name of the repo to add",
  14317. "name": "repo",
  14318. "in": "path",
  14319. "required": true
  14320. }
  14321. ],
  14322. "responses": {
  14323. "204": {
  14324. "$ref": "#/responses/empty"
  14325. },
  14326. "403": {
  14327. "$ref": "#/responses/forbidden"
  14328. },
  14329. "404": {
  14330. "$ref": "#/responses/notFound"
  14331. }
  14332. }
  14333. },
  14334. "delete": {
  14335. "description": "This does not delete the repository, it only removes the repository from the team.",
  14336. "produces": [
  14337. "application/json"
  14338. ],
  14339. "tags": [
  14340. "organization"
  14341. ],
  14342. "summary": "Remove a repository from a team",
  14343. "operationId": "orgRemoveTeamRepository",
  14344. "parameters": [
  14345. {
  14346. "type": "integer",
  14347. "format": "int64",
  14348. "description": "id of the team",
  14349. "name": "id",
  14350. "in": "path",
  14351. "required": true
  14352. },
  14353. {
  14354. "type": "string",
  14355. "description": "organization that owns the repo to remove",
  14356. "name": "org",
  14357. "in": "path",
  14358. "required": true
  14359. },
  14360. {
  14361. "type": "string",
  14362. "description": "name of the repo to remove",
  14363. "name": "repo",
  14364. "in": "path",
  14365. "required": true
  14366. }
  14367. ],
  14368. "responses": {
  14369. "204": {
  14370. "$ref": "#/responses/empty"
  14371. },
  14372. "403": {
  14373. "$ref": "#/responses/forbidden"
  14374. },
  14375. "404": {
  14376. "$ref": "#/responses/notFound"
  14377. }
  14378. }
  14379. }
  14380. },
  14381. "/topics/search": {
  14382. "get": {
  14383. "produces": [
  14384. "application/json"
  14385. ],
  14386. "tags": [
  14387. "repository"
  14388. ],
  14389. "summary": "search topics via keyword",
  14390. "operationId": "topicSearch",
  14391. "parameters": [
  14392. {
  14393. "type": "string",
  14394. "description": "keywords to search",
  14395. "name": "q",
  14396. "in": "query",
  14397. "required": true
  14398. },
  14399. {
  14400. "type": "integer",
  14401. "description": "page number of results to return (1-based)",
  14402. "name": "page",
  14403. "in": "query"
  14404. },
  14405. {
  14406. "type": "integer",
  14407. "description": "page size of results",
  14408. "name": "limit",
  14409. "in": "query"
  14410. }
  14411. ],
  14412. "responses": {
  14413. "200": {
  14414. "$ref": "#/responses/TopicListResponse"
  14415. },
  14416. "403": {
  14417. "$ref": "#/responses/forbidden"
  14418. },
  14419. "404": {
  14420. "$ref": "#/responses/notFound"
  14421. }
  14422. }
  14423. }
  14424. },
  14425. "/user": {
  14426. "get": {
  14427. "produces": [
  14428. "application/json"
  14429. ],
  14430. "tags": [
  14431. "user"
  14432. ],
  14433. "summary": "Get the authenticated user",
  14434. "operationId": "userGetCurrent",
  14435. "responses": {
  14436. "200": {
  14437. "$ref": "#/responses/User"
  14438. }
  14439. }
  14440. }
  14441. },
  14442. "/user/actions/secrets/{secretname}": {
  14443. "put": {
  14444. "consumes": [
  14445. "application/json"
  14446. ],
  14447. "produces": [
  14448. "application/json"
  14449. ],
  14450. "tags": [
  14451. "user"
  14452. ],
  14453. "summary": "Create or Update a secret value in a user scope",
  14454. "operationId": "updateUserSecret",
  14455. "parameters": [
  14456. {
  14457. "type": "string",
  14458. "description": "name of the secret",
  14459. "name": "secretname",
  14460. "in": "path",
  14461. "required": true
  14462. },
  14463. {
  14464. "name": "body",
  14465. "in": "body",
  14466. "schema": {
  14467. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  14468. }
  14469. }
  14470. ],
  14471. "responses": {
  14472. "201": {
  14473. "description": "response when creating a secret"
  14474. },
  14475. "204": {
  14476. "description": "response when updating a secret"
  14477. },
  14478. "400": {
  14479. "$ref": "#/responses/error"
  14480. },
  14481. "404": {
  14482. "$ref": "#/responses/notFound"
  14483. }
  14484. }
  14485. },
  14486. "delete": {
  14487. "consumes": [
  14488. "application/json"
  14489. ],
  14490. "produces": [
  14491. "application/json"
  14492. ],
  14493. "tags": [
  14494. "user"
  14495. ],
  14496. "summary": "Delete a secret in a user scope",
  14497. "operationId": "deleteUserSecret",
  14498. "parameters": [
  14499. {
  14500. "type": "string",
  14501. "description": "name of the secret",
  14502. "name": "secretname",
  14503. "in": "path",
  14504. "required": true
  14505. }
  14506. ],
  14507. "responses": {
  14508. "204": {
  14509. "description": "delete one secret of the user"
  14510. },
  14511. "400": {
  14512. "$ref": "#/responses/error"
  14513. },
  14514. "404": {
  14515. "$ref": "#/responses/notFound"
  14516. }
  14517. }
  14518. }
  14519. },
  14520. "/user/applications/oauth2": {
  14521. "get": {
  14522. "produces": [
  14523. "application/json"
  14524. ],
  14525. "tags": [
  14526. "user"
  14527. ],
  14528. "summary": "List the authenticated user's oauth2 applications",
  14529. "operationId": "userGetOauth2Application",
  14530. "parameters": [
  14531. {
  14532. "type": "integer",
  14533. "description": "page number of results to return (1-based)",
  14534. "name": "page",
  14535. "in": "query"
  14536. },
  14537. {
  14538. "type": "integer",
  14539. "description": "page size of results",
  14540. "name": "limit",
  14541. "in": "query"
  14542. }
  14543. ],
  14544. "responses": {
  14545. "200": {
  14546. "$ref": "#/responses/OAuth2ApplicationList"
  14547. }
  14548. }
  14549. },
  14550. "post": {
  14551. "produces": [
  14552. "application/json"
  14553. ],
  14554. "tags": [
  14555. "user"
  14556. ],
  14557. "summary": "creates a new OAuth2 application",
  14558. "operationId": "userCreateOAuth2Application",
  14559. "parameters": [
  14560. {
  14561. "name": "body",
  14562. "in": "body",
  14563. "required": true,
  14564. "schema": {
  14565. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14566. }
  14567. }
  14568. ],
  14569. "responses": {
  14570. "201": {
  14571. "$ref": "#/responses/OAuth2Application"
  14572. },
  14573. "400": {
  14574. "$ref": "#/responses/error"
  14575. }
  14576. }
  14577. }
  14578. },
  14579. "/user/applications/oauth2/{id}": {
  14580. "get": {
  14581. "produces": [
  14582. "application/json"
  14583. ],
  14584. "tags": [
  14585. "user"
  14586. ],
  14587. "summary": "get an OAuth2 Application",
  14588. "operationId": "userGetOAuth2Application",
  14589. "parameters": [
  14590. {
  14591. "type": "integer",
  14592. "format": "int64",
  14593. "description": "Application ID to be found",
  14594. "name": "id",
  14595. "in": "path",
  14596. "required": true
  14597. }
  14598. ],
  14599. "responses": {
  14600. "200": {
  14601. "$ref": "#/responses/OAuth2Application"
  14602. },
  14603. "404": {
  14604. "$ref": "#/responses/notFound"
  14605. }
  14606. }
  14607. },
  14608. "delete": {
  14609. "produces": [
  14610. "application/json"
  14611. ],
  14612. "tags": [
  14613. "user"
  14614. ],
  14615. "summary": "delete an OAuth2 Application",
  14616. "operationId": "userDeleteOAuth2Application",
  14617. "parameters": [
  14618. {
  14619. "type": "integer",
  14620. "format": "int64",
  14621. "description": "token to be deleted",
  14622. "name": "id",
  14623. "in": "path",
  14624. "required": true
  14625. }
  14626. ],
  14627. "responses": {
  14628. "204": {
  14629. "$ref": "#/responses/empty"
  14630. },
  14631. "404": {
  14632. "$ref": "#/responses/notFound"
  14633. }
  14634. }
  14635. },
  14636. "patch": {
  14637. "produces": [
  14638. "application/json"
  14639. ],
  14640. "tags": [
  14641. "user"
  14642. ],
  14643. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  14644. "operationId": "userUpdateOAuth2Application",
  14645. "parameters": [
  14646. {
  14647. "type": "integer",
  14648. "format": "int64",
  14649. "description": "application to be updated",
  14650. "name": "id",
  14651. "in": "path",
  14652. "required": true
  14653. },
  14654. {
  14655. "name": "body",
  14656. "in": "body",
  14657. "required": true,
  14658. "schema": {
  14659. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14660. }
  14661. }
  14662. ],
  14663. "responses": {
  14664. "200": {
  14665. "$ref": "#/responses/OAuth2Application"
  14666. },
  14667. "404": {
  14668. "$ref": "#/responses/notFound"
  14669. }
  14670. }
  14671. }
  14672. },
  14673. "/user/avatar": {
  14674. "post": {
  14675. "produces": [
  14676. "application/json"
  14677. ],
  14678. "tags": [
  14679. "user"
  14680. ],
  14681. "summary": "Update Avatar",
  14682. "operationId": "userUpdateAvatar",
  14683. "parameters": [
  14684. {
  14685. "name": "body",
  14686. "in": "body",
  14687. "schema": {
  14688. "$ref": "#/definitions/UpdateUserAvatarOption"
  14689. }
  14690. }
  14691. ],
  14692. "responses": {
  14693. "204": {
  14694. "$ref": "#/responses/empty"
  14695. }
  14696. }
  14697. },
  14698. "delete": {
  14699. "produces": [
  14700. "application/json"
  14701. ],
  14702. "tags": [
  14703. "user"
  14704. ],
  14705. "summary": "Delete Avatar",
  14706. "operationId": "userDeleteAvatar",
  14707. "responses": {
  14708. "204": {
  14709. "$ref": "#/responses/empty"
  14710. }
  14711. }
  14712. }
  14713. },
  14714. "/user/emails": {
  14715. "get": {
  14716. "produces": [
  14717. "application/json"
  14718. ],
  14719. "tags": [
  14720. "user"
  14721. ],
  14722. "summary": "List the authenticated user's email addresses",
  14723. "operationId": "userListEmails",
  14724. "responses": {
  14725. "200": {
  14726. "$ref": "#/responses/EmailList"
  14727. }
  14728. }
  14729. },
  14730. "post": {
  14731. "produces": [
  14732. "application/json"
  14733. ],
  14734. "tags": [
  14735. "user"
  14736. ],
  14737. "summary": "Add email addresses",
  14738. "operationId": "userAddEmail",
  14739. "parameters": [
  14740. {
  14741. "name": "body",
  14742. "in": "body",
  14743. "schema": {
  14744. "$ref": "#/definitions/CreateEmailOption"
  14745. }
  14746. }
  14747. ],
  14748. "responses": {
  14749. "201": {
  14750. "$ref": "#/responses/EmailList"
  14751. },
  14752. "422": {
  14753. "$ref": "#/responses/validationError"
  14754. }
  14755. }
  14756. },
  14757. "delete": {
  14758. "produces": [
  14759. "application/json"
  14760. ],
  14761. "tags": [
  14762. "user"
  14763. ],
  14764. "summary": "Delete email addresses",
  14765. "operationId": "userDeleteEmail",
  14766. "parameters": [
  14767. {
  14768. "name": "body",
  14769. "in": "body",
  14770. "schema": {
  14771. "$ref": "#/definitions/DeleteEmailOption"
  14772. }
  14773. }
  14774. ],
  14775. "responses": {
  14776. "204": {
  14777. "$ref": "#/responses/empty"
  14778. },
  14779. "404": {
  14780. "$ref": "#/responses/notFound"
  14781. }
  14782. }
  14783. }
  14784. },
  14785. "/user/followers": {
  14786. "get": {
  14787. "produces": [
  14788. "application/json"
  14789. ],
  14790. "tags": [
  14791. "user"
  14792. ],
  14793. "summary": "List the authenticated user's followers",
  14794. "operationId": "userCurrentListFollowers",
  14795. "parameters": [
  14796. {
  14797. "type": "integer",
  14798. "description": "page number of results to return (1-based)",
  14799. "name": "page",
  14800. "in": "query"
  14801. },
  14802. {
  14803. "type": "integer",
  14804. "description": "page size of results",
  14805. "name": "limit",
  14806. "in": "query"
  14807. }
  14808. ],
  14809. "responses": {
  14810. "200": {
  14811. "$ref": "#/responses/UserList"
  14812. }
  14813. }
  14814. }
  14815. },
  14816. "/user/following": {
  14817. "get": {
  14818. "produces": [
  14819. "application/json"
  14820. ],
  14821. "tags": [
  14822. "user"
  14823. ],
  14824. "summary": "List the users that the authenticated user is following",
  14825. "operationId": "userCurrentListFollowing",
  14826. "parameters": [
  14827. {
  14828. "type": "integer",
  14829. "description": "page number of results to return (1-based)",
  14830. "name": "page",
  14831. "in": "query"
  14832. },
  14833. {
  14834. "type": "integer",
  14835. "description": "page size of results",
  14836. "name": "limit",
  14837. "in": "query"
  14838. }
  14839. ],
  14840. "responses": {
  14841. "200": {
  14842. "$ref": "#/responses/UserList"
  14843. }
  14844. }
  14845. }
  14846. },
  14847. "/user/following/{username}": {
  14848. "get": {
  14849. "tags": [
  14850. "user"
  14851. ],
  14852. "summary": "Check whether a user is followed by the authenticated user",
  14853. "operationId": "userCurrentCheckFollowing",
  14854. "parameters": [
  14855. {
  14856. "type": "string",
  14857. "description": "username of followed user",
  14858. "name": "username",
  14859. "in": "path",
  14860. "required": true
  14861. }
  14862. ],
  14863. "responses": {
  14864. "204": {
  14865. "$ref": "#/responses/empty"
  14866. },
  14867. "404": {
  14868. "$ref": "#/responses/notFound"
  14869. }
  14870. }
  14871. },
  14872. "put": {
  14873. "tags": [
  14874. "user"
  14875. ],
  14876. "summary": "Follow a user",
  14877. "operationId": "userCurrentPutFollow",
  14878. "parameters": [
  14879. {
  14880. "type": "string",
  14881. "description": "username of user to follow",
  14882. "name": "username",
  14883. "in": "path",
  14884. "required": true
  14885. }
  14886. ],
  14887. "responses": {
  14888. "204": {
  14889. "$ref": "#/responses/empty"
  14890. },
  14891. "404": {
  14892. "$ref": "#/responses/notFound"
  14893. }
  14894. }
  14895. },
  14896. "delete": {
  14897. "tags": [
  14898. "user"
  14899. ],
  14900. "summary": "Unfollow a user",
  14901. "operationId": "userCurrentDeleteFollow",
  14902. "parameters": [
  14903. {
  14904. "type": "string",
  14905. "description": "username of user to unfollow",
  14906. "name": "username",
  14907. "in": "path",
  14908. "required": true
  14909. }
  14910. ],
  14911. "responses": {
  14912. "204": {
  14913. "$ref": "#/responses/empty"
  14914. },
  14915. "404": {
  14916. "$ref": "#/responses/notFound"
  14917. }
  14918. }
  14919. }
  14920. },
  14921. "/user/gpg_key_token": {
  14922. "get": {
  14923. "produces": [
  14924. "text/plain"
  14925. ],
  14926. "tags": [
  14927. "user"
  14928. ],
  14929. "summary": "Get a Token to verify",
  14930. "operationId": "getVerificationToken",
  14931. "responses": {
  14932. "200": {
  14933. "$ref": "#/responses/string"
  14934. },
  14935. "404": {
  14936. "$ref": "#/responses/notFound"
  14937. }
  14938. }
  14939. }
  14940. },
  14941. "/user/gpg_key_verify": {
  14942. "post": {
  14943. "consumes": [
  14944. "application/json"
  14945. ],
  14946. "produces": [
  14947. "application/json"
  14948. ],
  14949. "tags": [
  14950. "user"
  14951. ],
  14952. "summary": "Verify a GPG key",
  14953. "operationId": "userVerifyGPGKey",
  14954. "responses": {
  14955. "201": {
  14956. "$ref": "#/responses/GPGKey"
  14957. },
  14958. "404": {
  14959. "$ref": "#/responses/notFound"
  14960. },
  14961. "422": {
  14962. "$ref": "#/responses/validationError"
  14963. }
  14964. }
  14965. }
  14966. },
  14967. "/user/gpg_keys": {
  14968. "get": {
  14969. "produces": [
  14970. "application/json"
  14971. ],
  14972. "tags": [
  14973. "user"
  14974. ],
  14975. "summary": "List the authenticated user's GPG keys",
  14976. "operationId": "userCurrentListGPGKeys",
  14977. "parameters": [
  14978. {
  14979. "type": "integer",
  14980. "description": "page number of results to return (1-based)",
  14981. "name": "page",
  14982. "in": "query"
  14983. },
  14984. {
  14985. "type": "integer",
  14986. "description": "page size of results",
  14987. "name": "limit",
  14988. "in": "query"
  14989. }
  14990. ],
  14991. "responses": {
  14992. "200": {
  14993. "$ref": "#/responses/GPGKeyList"
  14994. }
  14995. }
  14996. },
  14997. "post": {
  14998. "consumes": [
  14999. "application/json"
  15000. ],
  15001. "produces": [
  15002. "application/json"
  15003. ],
  15004. "tags": [
  15005. "user"
  15006. ],
  15007. "summary": "Create a GPG key",
  15008. "operationId": "userCurrentPostGPGKey",
  15009. "parameters": [
  15010. {
  15011. "name": "Form",
  15012. "in": "body",
  15013. "schema": {
  15014. "$ref": "#/definitions/CreateGPGKeyOption"
  15015. }
  15016. }
  15017. ],
  15018. "responses": {
  15019. "201": {
  15020. "$ref": "#/responses/GPGKey"
  15021. },
  15022. "404": {
  15023. "$ref": "#/responses/notFound"
  15024. },
  15025. "422": {
  15026. "$ref": "#/responses/validationError"
  15027. }
  15028. }
  15029. }
  15030. },
  15031. "/user/gpg_keys/{id}": {
  15032. "get": {
  15033. "produces": [
  15034. "application/json"
  15035. ],
  15036. "tags": [
  15037. "user"
  15038. ],
  15039. "summary": "Get a GPG key",
  15040. "operationId": "userCurrentGetGPGKey",
  15041. "parameters": [
  15042. {
  15043. "type": "integer",
  15044. "format": "int64",
  15045. "description": "id of key to get",
  15046. "name": "id",
  15047. "in": "path",
  15048. "required": true
  15049. }
  15050. ],
  15051. "responses": {
  15052. "200": {
  15053. "$ref": "#/responses/GPGKey"
  15054. },
  15055. "404": {
  15056. "$ref": "#/responses/notFound"
  15057. }
  15058. }
  15059. },
  15060. "delete": {
  15061. "produces": [
  15062. "application/json"
  15063. ],
  15064. "tags": [
  15065. "user"
  15066. ],
  15067. "summary": "Remove a GPG key",
  15068. "operationId": "userCurrentDeleteGPGKey",
  15069. "parameters": [
  15070. {
  15071. "type": "integer",
  15072. "format": "int64",
  15073. "description": "id of key to delete",
  15074. "name": "id",
  15075. "in": "path",
  15076. "required": true
  15077. }
  15078. ],
  15079. "responses": {
  15080. "204": {
  15081. "$ref": "#/responses/empty"
  15082. },
  15083. "403": {
  15084. "$ref": "#/responses/forbidden"
  15085. },
  15086. "404": {
  15087. "$ref": "#/responses/notFound"
  15088. }
  15089. }
  15090. }
  15091. },
  15092. "/user/hooks": {
  15093. "get": {
  15094. "produces": [
  15095. "application/json"
  15096. ],
  15097. "tags": [
  15098. "user"
  15099. ],
  15100. "summary": "List the authenticated user's webhooks",
  15101. "operationId": "userListHooks",
  15102. "parameters": [
  15103. {
  15104. "type": "integer",
  15105. "description": "page number of results to return (1-based)",
  15106. "name": "page",
  15107. "in": "query"
  15108. },
  15109. {
  15110. "type": "integer",
  15111. "description": "page size of results",
  15112. "name": "limit",
  15113. "in": "query"
  15114. }
  15115. ],
  15116. "responses": {
  15117. "200": {
  15118. "$ref": "#/responses/HookList"
  15119. }
  15120. }
  15121. },
  15122. "post": {
  15123. "consumes": [
  15124. "application/json"
  15125. ],
  15126. "produces": [
  15127. "application/json"
  15128. ],
  15129. "tags": [
  15130. "user"
  15131. ],
  15132. "summary": "Create a hook",
  15133. "operationId": "userCreateHook",
  15134. "parameters": [
  15135. {
  15136. "name": "body",
  15137. "in": "body",
  15138. "required": true,
  15139. "schema": {
  15140. "$ref": "#/definitions/CreateHookOption"
  15141. }
  15142. }
  15143. ],
  15144. "responses": {
  15145. "201": {
  15146. "$ref": "#/responses/Hook"
  15147. }
  15148. }
  15149. }
  15150. },
  15151. "/user/hooks/{id}": {
  15152. "get": {
  15153. "produces": [
  15154. "application/json"
  15155. ],
  15156. "tags": [
  15157. "user"
  15158. ],
  15159. "summary": "Get a hook",
  15160. "operationId": "userGetHook",
  15161. "parameters": [
  15162. {
  15163. "type": "integer",
  15164. "format": "int64",
  15165. "description": "id of the hook to get",
  15166. "name": "id",
  15167. "in": "path",
  15168. "required": true
  15169. }
  15170. ],
  15171. "responses": {
  15172. "200": {
  15173. "$ref": "#/responses/Hook"
  15174. }
  15175. }
  15176. },
  15177. "delete": {
  15178. "produces": [
  15179. "application/json"
  15180. ],
  15181. "tags": [
  15182. "user"
  15183. ],
  15184. "summary": "Delete a hook",
  15185. "operationId": "userDeleteHook",
  15186. "parameters": [
  15187. {
  15188. "type": "integer",
  15189. "format": "int64",
  15190. "description": "id of the hook to delete",
  15191. "name": "id",
  15192. "in": "path",
  15193. "required": true
  15194. }
  15195. ],
  15196. "responses": {
  15197. "204": {
  15198. "$ref": "#/responses/empty"
  15199. }
  15200. }
  15201. },
  15202. "patch": {
  15203. "consumes": [
  15204. "application/json"
  15205. ],
  15206. "produces": [
  15207. "application/json"
  15208. ],
  15209. "tags": [
  15210. "user"
  15211. ],
  15212. "summary": "Update a hook",
  15213. "operationId": "userEditHook",
  15214. "parameters": [
  15215. {
  15216. "type": "integer",
  15217. "format": "int64",
  15218. "description": "id of the hook to update",
  15219. "name": "id",
  15220. "in": "path",
  15221. "required": true
  15222. },
  15223. {
  15224. "name": "body",
  15225. "in": "body",
  15226. "schema": {
  15227. "$ref": "#/definitions/EditHookOption"
  15228. }
  15229. }
  15230. ],
  15231. "responses": {
  15232. "200": {
  15233. "$ref": "#/responses/Hook"
  15234. }
  15235. }
  15236. }
  15237. },
  15238. "/user/keys": {
  15239. "get": {
  15240. "produces": [
  15241. "application/json"
  15242. ],
  15243. "tags": [
  15244. "user"
  15245. ],
  15246. "summary": "List the authenticated user's public keys",
  15247. "operationId": "userCurrentListKeys",
  15248. "parameters": [
  15249. {
  15250. "type": "string",
  15251. "description": "fingerprint of the key",
  15252. "name": "fingerprint",
  15253. "in": "query"
  15254. },
  15255. {
  15256. "type": "integer",
  15257. "description": "page number of results to return (1-based)",
  15258. "name": "page",
  15259. "in": "query"
  15260. },
  15261. {
  15262. "type": "integer",
  15263. "description": "page size of results",
  15264. "name": "limit",
  15265. "in": "query"
  15266. }
  15267. ],
  15268. "responses": {
  15269. "200": {
  15270. "$ref": "#/responses/PublicKeyList"
  15271. }
  15272. }
  15273. },
  15274. "post": {
  15275. "consumes": [
  15276. "application/json"
  15277. ],
  15278. "produces": [
  15279. "application/json"
  15280. ],
  15281. "tags": [
  15282. "user"
  15283. ],
  15284. "summary": "Create a public key",
  15285. "operationId": "userCurrentPostKey",
  15286. "parameters": [
  15287. {
  15288. "name": "body",
  15289. "in": "body",
  15290. "schema": {
  15291. "$ref": "#/definitions/CreateKeyOption"
  15292. }
  15293. }
  15294. ],
  15295. "responses": {
  15296. "201": {
  15297. "$ref": "#/responses/PublicKey"
  15298. },
  15299. "422": {
  15300. "$ref": "#/responses/validationError"
  15301. }
  15302. }
  15303. }
  15304. },
  15305. "/user/keys/{id}": {
  15306. "get": {
  15307. "produces": [
  15308. "application/json"
  15309. ],
  15310. "tags": [
  15311. "user"
  15312. ],
  15313. "summary": "Get a public key",
  15314. "operationId": "userCurrentGetKey",
  15315. "parameters": [
  15316. {
  15317. "type": "integer",
  15318. "format": "int64",
  15319. "description": "id of key to get",
  15320. "name": "id",
  15321. "in": "path",
  15322. "required": true
  15323. }
  15324. ],
  15325. "responses": {
  15326. "200": {
  15327. "$ref": "#/responses/PublicKey"
  15328. },
  15329. "404": {
  15330. "$ref": "#/responses/notFound"
  15331. }
  15332. }
  15333. },
  15334. "delete": {
  15335. "produces": [
  15336. "application/json"
  15337. ],
  15338. "tags": [
  15339. "user"
  15340. ],
  15341. "summary": "Delete a public key",
  15342. "operationId": "userCurrentDeleteKey",
  15343. "parameters": [
  15344. {
  15345. "type": "integer",
  15346. "format": "int64",
  15347. "description": "id of key to delete",
  15348. "name": "id",
  15349. "in": "path",
  15350. "required": true
  15351. }
  15352. ],
  15353. "responses": {
  15354. "204": {
  15355. "$ref": "#/responses/empty"
  15356. },
  15357. "403": {
  15358. "$ref": "#/responses/forbidden"
  15359. },
  15360. "404": {
  15361. "$ref": "#/responses/notFound"
  15362. }
  15363. }
  15364. }
  15365. },
  15366. "/user/orgs": {
  15367. "get": {
  15368. "produces": [
  15369. "application/json"
  15370. ],
  15371. "tags": [
  15372. "organization"
  15373. ],
  15374. "summary": "List the current user's organizations",
  15375. "operationId": "orgListCurrentUserOrgs",
  15376. "parameters": [
  15377. {
  15378. "type": "integer",
  15379. "description": "page number of results to return (1-based)",
  15380. "name": "page",
  15381. "in": "query"
  15382. },
  15383. {
  15384. "type": "integer",
  15385. "description": "page size of results",
  15386. "name": "limit",
  15387. "in": "query"
  15388. }
  15389. ],
  15390. "responses": {
  15391. "200": {
  15392. "$ref": "#/responses/OrganizationList"
  15393. },
  15394. "404": {
  15395. "$ref": "#/responses/notFound"
  15396. }
  15397. }
  15398. }
  15399. },
  15400. "/user/repos": {
  15401. "get": {
  15402. "produces": [
  15403. "application/json"
  15404. ],
  15405. "tags": [
  15406. "user"
  15407. ],
  15408. "summary": "List the repos that the authenticated user owns",
  15409. "operationId": "userCurrentListRepos",
  15410. "parameters": [
  15411. {
  15412. "type": "integer",
  15413. "description": "page number of results to return (1-based)",
  15414. "name": "page",
  15415. "in": "query"
  15416. },
  15417. {
  15418. "type": "integer",
  15419. "description": "page size of results",
  15420. "name": "limit",
  15421. "in": "query"
  15422. }
  15423. ],
  15424. "responses": {
  15425. "200": {
  15426. "$ref": "#/responses/RepositoryList"
  15427. }
  15428. }
  15429. },
  15430. "post": {
  15431. "consumes": [
  15432. "application/json"
  15433. ],
  15434. "produces": [
  15435. "application/json"
  15436. ],
  15437. "tags": [
  15438. "repository",
  15439. "user"
  15440. ],
  15441. "summary": "Create a repository",
  15442. "operationId": "createCurrentUserRepo",
  15443. "parameters": [
  15444. {
  15445. "name": "body",
  15446. "in": "body",
  15447. "schema": {
  15448. "$ref": "#/definitions/CreateRepoOption"
  15449. }
  15450. }
  15451. ],
  15452. "responses": {
  15453. "201": {
  15454. "$ref": "#/responses/Repository"
  15455. },
  15456. "400": {
  15457. "$ref": "#/responses/error"
  15458. },
  15459. "409": {
  15460. "description": "The repository with the same name already exists."
  15461. },
  15462. "422": {
  15463. "$ref": "#/responses/validationError"
  15464. }
  15465. }
  15466. }
  15467. },
  15468. "/user/settings": {
  15469. "get": {
  15470. "produces": [
  15471. "application/json"
  15472. ],
  15473. "tags": [
  15474. "user"
  15475. ],
  15476. "summary": "Get user settings",
  15477. "operationId": "getUserSettings",
  15478. "responses": {
  15479. "200": {
  15480. "$ref": "#/responses/UserSettings"
  15481. }
  15482. }
  15483. },
  15484. "patch": {
  15485. "produces": [
  15486. "application/json"
  15487. ],
  15488. "tags": [
  15489. "user"
  15490. ],
  15491. "summary": "Update user settings",
  15492. "operationId": "updateUserSettings",
  15493. "parameters": [
  15494. {
  15495. "name": "body",
  15496. "in": "body",
  15497. "schema": {
  15498. "$ref": "#/definitions/UserSettingsOptions"
  15499. }
  15500. }
  15501. ],
  15502. "responses": {
  15503. "200": {
  15504. "$ref": "#/responses/UserSettings"
  15505. }
  15506. }
  15507. }
  15508. },
  15509. "/user/starred": {
  15510. "get": {
  15511. "produces": [
  15512. "application/json"
  15513. ],
  15514. "tags": [
  15515. "user"
  15516. ],
  15517. "summary": "The repos that the authenticated user has starred",
  15518. "operationId": "userCurrentListStarred",
  15519. "parameters": [
  15520. {
  15521. "type": "integer",
  15522. "description": "page number of results to return (1-based)",
  15523. "name": "page",
  15524. "in": "query"
  15525. },
  15526. {
  15527. "type": "integer",
  15528. "description": "page size of results",
  15529. "name": "limit",
  15530. "in": "query"
  15531. }
  15532. ],
  15533. "responses": {
  15534. "200": {
  15535. "$ref": "#/responses/RepositoryList"
  15536. }
  15537. }
  15538. }
  15539. },
  15540. "/user/starred/{owner}/{repo}": {
  15541. "get": {
  15542. "tags": [
  15543. "user"
  15544. ],
  15545. "summary": "Whether the authenticated is starring the repo",
  15546. "operationId": "userCurrentCheckStarring",
  15547. "parameters": [
  15548. {
  15549. "type": "string",
  15550. "description": "owner of the repo",
  15551. "name": "owner",
  15552. "in": "path",
  15553. "required": true
  15554. },
  15555. {
  15556. "type": "string",
  15557. "description": "name of the repo",
  15558. "name": "repo",
  15559. "in": "path",
  15560. "required": true
  15561. }
  15562. ],
  15563. "responses": {
  15564. "204": {
  15565. "$ref": "#/responses/empty"
  15566. },
  15567. "404": {
  15568. "$ref": "#/responses/notFound"
  15569. }
  15570. }
  15571. },
  15572. "put": {
  15573. "tags": [
  15574. "user"
  15575. ],
  15576. "summary": "Star the given repo",
  15577. "operationId": "userCurrentPutStar",
  15578. "parameters": [
  15579. {
  15580. "type": "string",
  15581. "description": "owner of the repo to star",
  15582. "name": "owner",
  15583. "in": "path",
  15584. "required": true
  15585. },
  15586. {
  15587. "type": "string",
  15588. "description": "name of the repo to star",
  15589. "name": "repo",
  15590. "in": "path",
  15591. "required": true
  15592. }
  15593. ],
  15594. "responses": {
  15595. "204": {
  15596. "$ref": "#/responses/empty"
  15597. },
  15598. "404": {
  15599. "$ref": "#/responses/notFound"
  15600. }
  15601. }
  15602. },
  15603. "delete": {
  15604. "tags": [
  15605. "user"
  15606. ],
  15607. "summary": "Unstar the given repo",
  15608. "operationId": "userCurrentDeleteStar",
  15609. "parameters": [
  15610. {
  15611. "type": "string",
  15612. "description": "owner of the repo to unstar",
  15613. "name": "owner",
  15614. "in": "path",
  15615. "required": true
  15616. },
  15617. {
  15618. "type": "string",
  15619. "description": "name of the repo to unstar",
  15620. "name": "repo",
  15621. "in": "path",
  15622. "required": true
  15623. }
  15624. ],
  15625. "responses": {
  15626. "204": {
  15627. "$ref": "#/responses/empty"
  15628. },
  15629. "404": {
  15630. "$ref": "#/responses/notFound"
  15631. }
  15632. }
  15633. }
  15634. },
  15635. "/user/stopwatches": {
  15636. "get": {
  15637. "consumes": [
  15638. "application/json"
  15639. ],
  15640. "produces": [
  15641. "application/json"
  15642. ],
  15643. "tags": [
  15644. "user"
  15645. ],
  15646. "summary": "Get list of all existing stopwatches",
  15647. "operationId": "userGetStopWatches",
  15648. "parameters": [
  15649. {
  15650. "type": "integer",
  15651. "description": "page number of results to return (1-based)",
  15652. "name": "page",
  15653. "in": "query"
  15654. },
  15655. {
  15656. "type": "integer",
  15657. "description": "page size of results",
  15658. "name": "limit",
  15659. "in": "query"
  15660. }
  15661. ],
  15662. "responses": {
  15663. "200": {
  15664. "$ref": "#/responses/StopWatchList"
  15665. }
  15666. }
  15667. }
  15668. },
  15669. "/user/subscriptions": {
  15670. "get": {
  15671. "produces": [
  15672. "application/json"
  15673. ],
  15674. "tags": [
  15675. "user"
  15676. ],
  15677. "summary": "List repositories watched by the authenticated user",
  15678. "operationId": "userCurrentListSubscriptions",
  15679. "parameters": [
  15680. {
  15681. "type": "integer",
  15682. "description": "page number of results to return (1-based)",
  15683. "name": "page",
  15684. "in": "query"
  15685. },
  15686. {
  15687. "type": "integer",
  15688. "description": "page size of results",
  15689. "name": "limit",
  15690. "in": "query"
  15691. }
  15692. ],
  15693. "responses": {
  15694. "200": {
  15695. "$ref": "#/responses/RepositoryList"
  15696. }
  15697. }
  15698. }
  15699. },
  15700. "/user/teams": {
  15701. "get": {
  15702. "produces": [
  15703. "application/json"
  15704. ],
  15705. "tags": [
  15706. "user"
  15707. ],
  15708. "summary": "List all the teams a user belongs to",
  15709. "operationId": "userListTeams",
  15710. "parameters": [
  15711. {
  15712. "type": "integer",
  15713. "description": "page number of results to return (1-based)",
  15714. "name": "page",
  15715. "in": "query"
  15716. },
  15717. {
  15718. "type": "integer",
  15719. "description": "page size of results",
  15720. "name": "limit",
  15721. "in": "query"
  15722. }
  15723. ],
  15724. "responses": {
  15725. "200": {
  15726. "$ref": "#/responses/TeamList"
  15727. }
  15728. }
  15729. }
  15730. },
  15731. "/user/times": {
  15732. "get": {
  15733. "produces": [
  15734. "application/json"
  15735. ],
  15736. "tags": [
  15737. "user"
  15738. ],
  15739. "summary": "List the current user's tracked times",
  15740. "operationId": "userCurrentTrackedTimes",
  15741. "parameters": [
  15742. {
  15743. "type": "integer",
  15744. "description": "page number of results to return (1-based)",
  15745. "name": "page",
  15746. "in": "query"
  15747. },
  15748. {
  15749. "type": "integer",
  15750. "description": "page size of results",
  15751. "name": "limit",
  15752. "in": "query"
  15753. },
  15754. {
  15755. "type": "string",
  15756. "format": "date-time",
  15757. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  15758. "name": "since",
  15759. "in": "query"
  15760. },
  15761. {
  15762. "type": "string",
  15763. "format": "date-time",
  15764. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  15765. "name": "before",
  15766. "in": "query"
  15767. }
  15768. ],
  15769. "responses": {
  15770. "200": {
  15771. "$ref": "#/responses/TrackedTimeList"
  15772. }
  15773. }
  15774. }
  15775. },
  15776. "/users/search": {
  15777. "get": {
  15778. "produces": [
  15779. "application/json"
  15780. ],
  15781. "tags": [
  15782. "user"
  15783. ],
  15784. "summary": "Search for users",
  15785. "operationId": "userSearch",
  15786. "parameters": [
  15787. {
  15788. "type": "string",
  15789. "description": "keyword",
  15790. "name": "q",
  15791. "in": "query"
  15792. },
  15793. {
  15794. "type": "integer",
  15795. "format": "int64",
  15796. "description": "ID of the user to search for",
  15797. "name": "uid",
  15798. "in": "query"
  15799. },
  15800. {
  15801. "type": "integer",
  15802. "description": "page number of results to return (1-based)",
  15803. "name": "page",
  15804. "in": "query"
  15805. },
  15806. {
  15807. "type": "integer",
  15808. "description": "page size of results",
  15809. "name": "limit",
  15810. "in": "query"
  15811. }
  15812. ],
  15813. "responses": {
  15814. "200": {
  15815. "description": "SearchResults of a successful search",
  15816. "schema": {
  15817. "type": "object",
  15818. "properties": {
  15819. "data": {
  15820. "type": "array",
  15821. "items": {
  15822. "$ref": "#/definitions/User"
  15823. }
  15824. },
  15825. "ok": {
  15826. "type": "boolean"
  15827. }
  15828. }
  15829. }
  15830. }
  15831. }
  15832. }
  15833. },
  15834. "/users/{username}": {
  15835. "get": {
  15836. "produces": [
  15837. "application/json"
  15838. ],
  15839. "tags": [
  15840. "user"
  15841. ],
  15842. "summary": "Get a user",
  15843. "operationId": "userGet",
  15844. "parameters": [
  15845. {
  15846. "type": "string",
  15847. "description": "username of user to get",
  15848. "name": "username",
  15849. "in": "path",
  15850. "required": true
  15851. }
  15852. ],
  15853. "responses": {
  15854. "200": {
  15855. "$ref": "#/responses/User"
  15856. },
  15857. "404": {
  15858. "$ref": "#/responses/notFound"
  15859. }
  15860. }
  15861. }
  15862. },
  15863. "/users/{username}/activities/feeds": {
  15864. "get": {
  15865. "produces": [
  15866. "application/json"
  15867. ],
  15868. "tags": [
  15869. "user"
  15870. ],
  15871. "summary": "List a user's activity feeds",
  15872. "operationId": "userListActivityFeeds",
  15873. "parameters": [
  15874. {
  15875. "type": "string",
  15876. "description": "username of user",
  15877. "name": "username",
  15878. "in": "path",
  15879. "required": true
  15880. },
  15881. {
  15882. "type": "boolean",
  15883. "description": "if true, only show actions performed by the requested user",
  15884. "name": "only-performed-by",
  15885. "in": "query"
  15886. },
  15887. {
  15888. "type": "string",
  15889. "format": "date",
  15890. "description": "the date of the activities to be found",
  15891. "name": "date",
  15892. "in": "query"
  15893. },
  15894. {
  15895. "type": "integer",
  15896. "description": "page number of results to return (1-based)",
  15897. "name": "page",
  15898. "in": "query"
  15899. },
  15900. {
  15901. "type": "integer",
  15902. "description": "page size of results",
  15903. "name": "limit",
  15904. "in": "query"
  15905. }
  15906. ],
  15907. "responses": {
  15908. "200": {
  15909. "$ref": "#/responses/ActivityFeedsList"
  15910. },
  15911. "404": {
  15912. "$ref": "#/responses/notFound"
  15913. }
  15914. }
  15915. }
  15916. },
  15917. "/users/{username}/followers": {
  15918. "get": {
  15919. "produces": [
  15920. "application/json"
  15921. ],
  15922. "tags": [
  15923. "user"
  15924. ],
  15925. "summary": "List the given user's followers",
  15926. "operationId": "userListFollowers",
  15927. "parameters": [
  15928. {
  15929. "type": "string",
  15930. "description": "username of user",
  15931. "name": "username",
  15932. "in": "path",
  15933. "required": true
  15934. },
  15935. {
  15936. "type": "integer",
  15937. "description": "page number of results to return (1-based)",
  15938. "name": "page",
  15939. "in": "query"
  15940. },
  15941. {
  15942. "type": "integer",
  15943. "description": "page size of results",
  15944. "name": "limit",
  15945. "in": "query"
  15946. }
  15947. ],
  15948. "responses": {
  15949. "200": {
  15950. "$ref": "#/responses/UserList"
  15951. },
  15952. "404": {
  15953. "$ref": "#/responses/notFound"
  15954. }
  15955. }
  15956. }
  15957. },
  15958. "/users/{username}/following": {
  15959. "get": {
  15960. "produces": [
  15961. "application/json"
  15962. ],
  15963. "tags": [
  15964. "user"
  15965. ],
  15966. "summary": "List the users that the given user is following",
  15967. "operationId": "userListFollowing",
  15968. "parameters": [
  15969. {
  15970. "type": "string",
  15971. "description": "username of user",
  15972. "name": "username",
  15973. "in": "path",
  15974. "required": true
  15975. },
  15976. {
  15977. "type": "integer",
  15978. "description": "page number of results to return (1-based)",
  15979. "name": "page",
  15980. "in": "query"
  15981. },
  15982. {
  15983. "type": "integer",
  15984. "description": "page size of results",
  15985. "name": "limit",
  15986. "in": "query"
  15987. }
  15988. ],
  15989. "responses": {
  15990. "200": {
  15991. "$ref": "#/responses/UserList"
  15992. },
  15993. "404": {
  15994. "$ref": "#/responses/notFound"
  15995. }
  15996. }
  15997. }
  15998. },
  15999. "/users/{username}/following/{target}": {
  16000. "get": {
  16001. "tags": [
  16002. "user"
  16003. ],
  16004. "summary": "Check if one user is following another user",
  16005. "operationId": "userCheckFollowing",
  16006. "parameters": [
  16007. {
  16008. "type": "string",
  16009. "description": "username of following user",
  16010. "name": "username",
  16011. "in": "path",
  16012. "required": true
  16013. },
  16014. {
  16015. "type": "string",
  16016. "description": "username of followed user",
  16017. "name": "target",
  16018. "in": "path",
  16019. "required": true
  16020. }
  16021. ],
  16022. "responses": {
  16023. "204": {
  16024. "$ref": "#/responses/empty"
  16025. },
  16026. "404": {
  16027. "$ref": "#/responses/notFound"
  16028. }
  16029. }
  16030. }
  16031. },
  16032. "/users/{username}/gpg_keys": {
  16033. "get": {
  16034. "produces": [
  16035. "application/json"
  16036. ],
  16037. "tags": [
  16038. "user"
  16039. ],
  16040. "summary": "List the given user's GPG keys",
  16041. "operationId": "userListGPGKeys",
  16042. "parameters": [
  16043. {
  16044. "type": "string",
  16045. "description": "username of user",
  16046. "name": "username",
  16047. "in": "path",
  16048. "required": true
  16049. },
  16050. {
  16051. "type": "integer",
  16052. "description": "page number of results to return (1-based)",
  16053. "name": "page",
  16054. "in": "query"
  16055. },
  16056. {
  16057. "type": "integer",
  16058. "description": "page size of results",
  16059. "name": "limit",
  16060. "in": "query"
  16061. }
  16062. ],
  16063. "responses": {
  16064. "200": {
  16065. "$ref": "#/responses/GPGKeyList"
  16066. },
  16067. "404": {
  16068. "$ref": "#/responses/notFound"
  16069. }
  16070. }
  16071. }
  16072. },
  16073. "/users/{username}/heatmap": {
  16074. "get": {
  16075. "produces": [
  16076. "application/json"
  16077. ],
  16078. "tags": [
  16079. "user"
  16080. ],
  16081. "summary": "Get a user's heatmap",
  16082. "operationId": "userGetHeatmapData",
  16083. "parameters": [
  16084. {
  16085. "type": "string",
  16086. "description": "username of user to get",
  16087. "name": "username",
  16088. "in": "path",
  16089. "required": true
  16090. }
  16091. ],
  16092. "responses": {
  16093. "200": {
  16094. "$ref": "#/responses/UserHeatmapData"
  16095. },
  16096. "404": {
  16097. "$ref": "#/responses/notFound"
  16098. }
  16099. }
  16100. }
  16101. },
  16102. "/users/{username}/keys": {
  16103. "get": {
  16104. "produces": [
  16105. "application/json"
  16106. ],
  16107. "tags": [
  16108. "user"
  16109. ],
  16110. "summary": "List the given user's public keys",
  16111. "operationId": "userListKeys",
  16112. "parameters": [
  16113. {
  16114. "type": "string",
  16115. "description": "username of user",
  16116. "name": "username",
  16117. "in": "path",
  16118. "required": true
  16119. },
  16120. {
  16121. "type": "string",
  16122. "description": "fingerprint of the key",
  16123. "name": "fingerprint",
  16124. "in": "query"
  16125. },
  16126. {
  16127. "type": "integer",
  16128. "description": "page number of results to return (1-based)",
  16129. "name": "page",
  16130. "in": "query"
  16131. },
  16132. {
  16133. "type": "integer",
  16134. "description": "page size of results",
  16135. "name": "limit",
  16136. "in": "query"
  16137. }
  16138. ],
  16139. "responses": {
  16140. "200": {
  16141. "$ref": "#/responses/PublicKeyList"
  16142. },
  16143. "404": {
  16144. "$ref": "#/responses/notFound"
  16145. }
  16146. }
  16147. }
  16148. },
  16149. "/users/{username}/orgs": {
  16150. "get": {
  16151. "produces": [
  16152. "application/json"
  16153. ],
  16154. "tags": [
  16155. "organization"
  16156. ],
  16157. "summary": "List a user's organizations",
  16158. "operationId": "orgListUserOrgs",
  16159. "parameters": [
  16160. {
  16161. "type": "string",
  16162. "description": "username of user",
  16163. "name": "username",
  16164. "in": "path",
  16165. "required": true
  16166. },
  16167. {
  16168. "type": "integer",
  16169. "description": "page number of results to return (1-based)",
  16170. "name": "page",
  16171. "in": "query"
  16172. },
  16173. {
  16174. "type": "integer",
  16175. "description": "page size of results",
  16176. "name": "limit",
  16177. "in": "query"
  16178. }
  16179. ],
  16180. "responses": {
  16181. "200": {
  16182. "$ref": "#/responses/OrganizationList"
  16183. },
  16184. "404": {
  16185. "$ref": "#/responses/notFound"
  16186. }
  16187. }
  16188. }
  16189. },
  16190. "/users/{username}/orgs/{org}/permissions": {
  16191. "get": {
  16192. "produces": [
  16193. "application/json"
  16194. ],
  16195. "tags": [
  16196. "organization"
  16197. ],
  16198. "summary": "Get user permissions in organization",
  16199. "operationId": "orgGetUserPermissions",
  16200. "parameters": [
  16201. {
  16202. "type": "string",
  16203. "description": "username of user",
  16204. "name": "username",
  16205. "in": "path",
  16206. "required": true
  16207. },
  16208. {
  16209. "type": "string",
  16210. "description": "name of the organization",
  16211. "name": "org",
  16212. "in": "path",
  16213. "required": true
  16214. }
  16215. ],
  16216. "responses": {
  16217. "200": {
  16218. "$ref": "#/responses/OrganizationPermissions"
  16219. },
  16220. "403": {
  16221. "$ref": "#/responses/forbidden"
  16222. },
  16223. "404": {
  16224. "$ref": "#/responses/notFound"
  16225. }
  16226. }
  16227. }
  16228. },
  16229. "/users/{username}/repos": {
  16230. "get": {
  16231. "produces": [
  16232. "application/json"
  16233. ],
  16234. "tags": [
  16235. "user"
  16236. ],
  16237. "summary": "List the repos owned by the given user",
  16238. "operationId": "userListRepos",
  16239. "parameters": [
  16240. {
  16241. "type": "string",
  16242. "description": "username of user",
  16243. "name": "username",
  16244. "in": "path",
  16245. "required": true
  16246. },
  16247. {
  16248. "type": "integer",
  16249. "description": "page number of results to return (1-based)",
  16250. "name": "page",
  16251. "in": "query"
  16252. },
  16253. {
  16254. "type": "integer",
  16255. "description": "page size of results",
  16256. "name": "limit",
  16257. "in": "query"
  16258. }
  16259. ],
  16260. "responses": {
  16261. "200": {
  16262. "$ref": "#/responses/RepositoryList"
  16263. },
  16264. "404": {
  16265. "$ref": "#/responses/notFound"
  16266. }
  16267. }
  16268. }
  16269. },
  16270. "/users/{username}/starred": {
  16271. "get": {
  16272. "produces": [
  16273. "application/json"
  16274. ],
  16275. "tags": [
  16276. "user"
  16277. ],
  16278. "summary": "The repos that the given user has starred",
  16279. "operationId": "userListStarred",
  16280. "parameters": [
  16281. {
  16282. "type": "string",
  16283. "description": "username of user",
  16284. "name": "username",
  16285. "in": "path",
  16286. "required": true
  16287. },
  16288. {
  16289. "type": "integer",
  16290. "description": "page number of results to return (1-based)",
  16291. "name": "page",
  16292. "in": "query"
  16293. },
  16294. {
  16295. "type": "integer",
  16296. "description": "page size of results",
  16297. "name": "limit",
  16298. "in": "query"
  16299. }
  16300. ],
  16301. "responses": {
  16302. "200": {
  16303. "$ref": "#/responses/RepositoryList"
  16304. },
  16305. "404": {
  16306. "$ref": "#/responses/notFound"
  16307. }
  16308. }
  16309. }
  16310. },
  16311. "/users/{username}/subscriptions": {
  16312. "get": {
  16313. "produces": [
  16314. "application/json"
  16315. ],
  16316. "tags": [
  16317. "user"
  16318. ],
  16319. "summary": "List the repositories watched by a user",
  16320. "operationId": "userListSubscriptions",
  16321. "parameters": [
  16322. {
  16323. "type": "string",
  16324. "description": "username of the user",
  16325. "name": "username",
  16326. "in": "path",
  16327. "required": true
  16328. },
  16329. {
  16330. "type": "integer",
  16331. "description": "page number of results to return (1-based)",
  16332. "name": "page",
  16333. "in": "query"
  16334. },
  16335. {
  16336. "type": "integer",
  16337. "description": "page size of results",
  16338. "name": "limit",
  16339. "in": "query"
  16340. }
  16341. ],
  16342. "responses": {
  16343. "200": {
  16344. "$ref": "#/responses/RepositoryList"
  16345. },
  16346. "404": {
  16347. "$ref": "#/responses/notFound"
  16348. }
  16349. }
  16350. }
  16351. },
  16352. "/users/{username}/tokens": {
  16353. "get": {
  16354. "produces": [
  16355. "application/json"
  16356. ],
  16357. "tags": [
  16358. "user"
  16359. ],
  16360. "summary": "List the authenticated user's access tokens",
  16361. "operationId": "userGetTokens",
  16362. "parameters": [
  16363. {
  16364. "type": "string",
  16365. "description": "username of user",
  16366. "name": "username",
  16367. "in": "path",
  16368. "required": true
  16369. },
  16370. {
  16371. "type": "integer",
  16372. "description": "page number of results to return (1-based)",
  16373. "name": "page",
  16374. "in": "query"
  16375. },
  16376. {
  16377. "type": "integer",
  16378. "description": "page size of results",
  16379. "name": "limit",
  16380. "in": "query"
  16381. }
  16382. ],
  16383. "responses": {
  16384. "200": {
  16385. "$ref": "#/responses/AccessTokenList"
  16386. },
  16387. "403": {
  16388. "$ref": "#/responses/forbidden"
  16389. }
  16390. }
  16391. },
  16392. "post": {
  16393. "consumes": [
  16394. "application/json"
  16395. ],
  16396. "produces": [
  16397. "application/json"
  16398. ],
  16399. "tags": [
  16400. "user"
  16401. ],
  16402. "summary": "Create an access token",
  16403. "operationId": "userCreateToken",
  16404. "parameters": [
  16405. {
  16406. "type": "string",
  16407. "description": "username of user",
  16408. "name": "username",
  16409. "in": "path",
  16410. "required": true
  16411. },
  16412. {
  16413. "name": "body",
  16414. "in": "body",
  16415. "schema": {
  16416. "$ref": "#/definitions/CreateAccessTokenOption"
  16417. }
  16418. }
  16419. ],
  16420. "responses": {
  16421. "201": {
  16422. "$ref": "#/responses/AccessToken"
  16423. },
  16424. "400": {
  16425. "$ref": "#/responses/error"
  16426. },
  16427. "403": {
  16428. "$ref": "#/responses/forbidden"
  16429. }
  16430. }
  16431. }
  16432. },
  16433. "/users/{username}/tokens/{token}": {
  16434. "delete": {
  16435. "produces": [
  16436. "application/json"
  16437. ],
  16438. "tags": [
  16439. "user"
  16440. ],
  16441. "summary": "delete an access token",
  16442. "operationId": "userDeleteAccessToken",
  16443. "parameters": [
  16444. {
  16445. "type": "string",
  16446. "description": "username of user",
  16447. "name": "username",
  16448. "in": "path",
  16449. "required": true
  16450. },
  16451. {
  16452. "type": "string",
  16453. "description": "token to be deleted, identified by ID and if not available by name",
  16454. "name": "token",
  16455. "in": "path",
  16456. "required": true
  16457. }
  16458. ],
  16459. "responses": {
  16460. "204": {
  16461. "$ref": "#/responses/empty"
  16462. },
  16463. "403": {
  16464. "$ref": "#/responses/forbidden"
  16465. },
  16466. "404": {
  16467. "$ref": "#/responses/notFound"
  16468. },
  16469. "422": {
  16470. "$ref": "#/responses/error"
  16471. }
  16472. }
  16473. }
  16474. },
  16475. "/version": {
  16476. "get": {
  16477. "produces": [
  16478. "application/json"
  16479. ],
  16480. "tags": [
  16481. "miscellaneous"
  16482. ],
  16483. "summary": "Returns the version of the Gitea application",
  16484. "operationId": "getVersion",
  16485. "responses": {
  16486. "200": {
  16487. "$ref": "#/responses/ServerVersion"
  16488. }
  16489. }
  16490. }
  16491. }
  16492. },
  16493. "definitions": {
  16494. "APIError": {
  16495. "description": "APIError is an api error with a message",
  16496. "type": "object",
  16497. "properties": {
  16498. "message": {
  16499. "type": "string",
  16500. "x-go-name": "Message"
  16501. },
  16502. "url": {
  16503. "type": "string",
  16504. "x-go-name": "URL"
  16505. }
  16506. },
  16507. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16508. },
  16509. "AccessToken": {
  16510. "type": "object",
  16511. "title": "AccessToken represents an API access token.",
  16512. "properties": {
  16513. "id": {
  16514. "type": "integer",
  16515. "format": "int64",
  16516. "x-go-name": "ID"
  16517. },
  16518. "name": {
  16519. "type": "string",
  16520. "x-go-name": "Name"
  16521. },
  16522. "scopes": {
  16523. "type": "array",
  16524. "items": {
  16525. "type": "string"
  16526. },
  16527. "x-go-name": "Scopes"
  16528. },
  16529. "sha1": {
  16530. "type": "string",
  16531. "x-go-name": "Token"
  16532. },
  16533. "token_last_eight": {
  16534. "type": "string",
  16535. "x-go-name": "TokenLastEight"
  16536. }
  16537. },
  16538. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16539. },
  16540. "Activity": {
  16541. "type": "object",
  16542. "properties": {
  16543. "act_user": {
  16544. "$ref": "#/definitions/User"
  16545. },
  16546. "act_user_id": {
  16547. "type": "integer",
  16548. "format": "int64",
  16549. "x-go-name": "ActUserID"
  16550. },
  16551. "comment": {
  16552. "$ref": "#/definitions/Comment"
  16553. },
  16554. "comment_id": {
  16555. "type": "integer",
  16556. "format": "int64",
  16557. "x-go-name": "CommentID"
  16558. },
  16559. "content": {
  16560. "type": "string",
  16561. "x-go-name": "Content"
  16562. },
  16563. "created": {
  16564. "type": "string",
  16565. "format": "date-time",
  16566. "x-go-name": "Created"
  16567. },
  16568. "id": {
  16569. "type": "integer",
  16570. "format": "int64",
  16571. "x-go-name": "ID"
  16572. },
  16573. "is_private": {
  16574. "type": "boolean",
  16575. "x-go-name": "IsPrivate"
  16576. },
  16577. "op_type": {
  16578. "type": "string",
  16579. "x-go-name": "OpType"
  16580. },
  16581. "ref_name": {
  16582. "type": "string",
  16583. "x-go-name": "RefName"
  16584. },
  16585. "repo": {
  16586. "$ref": "#/definitions/Repository"
  16587. },
  16588. "repo_id": {
  16589. "type": "integer",
  16590. "format": "int64",
  16591. "x-go-name": "RepoID"
  16592. },
  16593. "user_id": {
  16594. "type": "integer",
  16595. "format": "int64",
  16596. "x-go-name": "UserID"
  16597. }
  16598. },
  16599. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16600. },
  16601. "ActivityPub": {
  16602. "description": "ActivityPub type",
  16603. "type": "object",
  16604. "properties": {
  16605. "@context": {
  16606. "type": "string",
  16607. "x-go-name": "Context"
  16608. }
  16609. },
  16610. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16611. },
  16612. "AddCollaboratorOption": {
  16613. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  16614. "type": "object",
  16615. "properties": {
  16616. "permission": {
  16617. "type": "string",
  16618. "x-go-name": "Permission"
  16619. }
  16620. },
  16621. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16622. },
  16623. "AddTimeOption": {
  16624. "description": "AddTimeOption options for adding time to an issue",
  16625. "type": "object",
  16626. "required": [
  16627. "time"
  16628. ],
  16629. "properties": {
  16630. "created": {
  16631. "type": "string",
  16632. "format": "date-time",
  16633. "x-go-name": "Created"
  16634. },
  16635. "time": {
  16636. "description": "time in seconds",
  16637. "type": "integer",
  16638. "format": "int64",
  16639. "x-go-name": "Time"
  16640. },
  16641. "user_name": {
  16642. "description": "User who spent the time (optional)",
  16643. "type": "string",
  16644. "x-go-name": "User"
  16645. }
  16646. },
  16647. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16648. },
  16649. "AnnotatedTag": {
  16650. "description": "AnnotatedTag represents an annotated tag",
  16651. "type": "object",
  16652. "properties": {
  16653. "message": {
  16654. "type": "string",
  16655. "x-go-name": "Message"
  16656. },
  16657. "object": {
  16658. "$ref": "#/definitions/AnnotatedTagObject"
  16659. },
  16660. "sha": {
  16661. "type": "string",
  16662. "x-go-name": "SHA"
  16663. },
  16664. "tag": {
  16665. "type": "string",
  16666. "x-go-name": "Tag"
  16667. },
  16668. "tagger": {
  16669. "$ref": "#/definitions/CommitUser"
  16670. },
  16671. "url": {
  16672. "type": "string",
  16673. "x-go-name": "URL"
  16674. },
  16675. "verification": {
  16676. "$ref": "#/definitions/PayloadCommitVerification"
  16677. }
  16678. },
  16679. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16680. },
  16681. "AnnotatedTagObject": {
  16682. "description": "AnnotatedTagObject contains meta information of the tag object",
  16683. "type": "object",
  16684. "properties": {
  16685. "sha": {
  16686. "type": "string",
  16687. "x-go-name": "SHA"
  16688. },
  16689. "type": {
  16690. "type": "string",
  16691. "x-go-name": "Type"
  16692. },
  16693. "url": {
  16694. "type": "string",
  16695. "x-go-name": "URL"
  16696. }
  16697. },
  16698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16699. },
  16700. "Attachment": {
  16701. "description": "Attachment a generic attachment",
  16702. "type": "object",
  16703. "properties": {
  16704. "browser_download_url": {
  16705. "type": "string",
  16706. "x-go-name": "DownloadURL"
  16707. },
  16708. "created_at": {
  16709. "type": "string",
  16710. "format": "date-time",
  16711. "x-go-name": "Created"
  16712. },
  16713. "download_count": {
  16714. "type": "integer",
  16715. "format": "int64",
  16716. "x-go-name": "DownloadCount"
  16717. },
  16718. "id": {
  16719. "type": "integer",
  16720. "format": "int64",
  16721. "x-go-name": "ID"
  16722. },
  16723. "name": {
  16724. "type": "string",
  16725. "x-go-name": "Name"
  16726. },
  16727. "size": {
  16728. "type": "integer",
  16729. "format": "int64",
  16730. "x-go-name": "Size"
  16731. },
  16732. "uuid": {
  16733. "type": "string",
  16734. "x-go-name": "UUID"
  16735. }
  16736. },
  16737. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16738. },
  16739. "Branch": {
  16740. "description": "Branch represents a repository branch",
  16741. "type": "object",
  16742. "properties": {
  16743. "commit": {
  16744. "$ref": "#/definitions/PayloadCommit"
  16745. },
  16746. "effective_branch_protection_name": {
  16747. "type": "string",
  16748. "x-go-name": "EffectiveBranchProtectionName"
  16749. },
  16750. "enable_status_check": {
  16751. "type": "boolean",
  16752. "x-go-name": "EnableStatusCheck"
  16753. },
  16754. "name": {
  16755. "type": "string",
  16756. "x-go-name": "Name"
  16757. },
  16758. "protected": {
  16759. "type": "boolean",
  16760. "x-go-name": "Protected"
  16761. },
  16762. "required_approvals": {
  16763. "type": "integer",
  16764. "format": "int64",
  16765. "x-go-name": "RequiredApprovals"
  16766. },
  16767. "status_check_contexts": {
  16768. "type": "array",
  16769. "items": {
  16770. "type": "string"
  16771. },
  16772. "x-go-name": "StatusCheckContexts"
  16773. },
  16774. "user_can_merge": {
  16775. "type": "boolean",
  16776. "x-go-name": "UserCanMerge"
  16777. },
  16778. "user_can_push": {
  16779. "type": "boolean",
  16780. "x-go-name": "UserCanPush"
  16781. }
  16782. },
  16783. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16784. },
  16785. "BranchProtection": {
  16786. "description": "BranchProtection represents a branch protection for a repository",
  16787. "type": "object",
  16788. "properties": {
  16789. "approvals_whitelist_teams": {
  16790. "type": "array",
  16791. "items": {
  16792. "type": "string"
  16793. },
  16794. "x-go-name": "ApprovalsWhitelistTeams"
  16795. },
  16796. "approvals_whitelist_username": {
  16797. "type": "array",
  16798. "items": {
  16799. "type": "string"
  16800. },
  16801. "x-go-name": "ApprovalsWhitelistUsernames"
  16802. },
  16803. "block_on_official_review_requests": {
  16804. "type": "boolean",
  16805. "x-go-name": "BlockOnOfficialReviewRequests"
  16806. },
  16807. "block_on_outdated_branch": {
  16808. "type": "boolean",
  16809. "x-go-name": "BlockOnOutdatedBranch"
  16810. },
  16811. "block_on_rejected_reviews": {
  16812. "type": "boolean",
  16813. "x-go-name": "BlockOnRejectedReviews"
  16814. },
  16815. "branch_name": {
  16816. "description": "Deprecated: true",
  16817. "type": "string",
  16818. "x-go-name": "BranchName"
  16819. },
  16820. "created_at": {
  16821. "type": "string",
  16822. "format": "date-time",
  16823. "x-go-name": "Created"
  16824. },
  16825. "dismiss_stale_approvals": {
  16826. "type": "boolean",
  16827. "x-go-name": "DismissStaleApprovals"
  16828. },
  16829. "enable_approvals_whitelist": {
  16830. "type": "boolean",
  16831. "x-go-name": "EnableApprovalsWhitelist"
  16832. },
  16833. "enable_merge_whitelist": {
  16834. "type": "boolean",
  16835. "x-go-name": "EnableMergeWhitelist"
  16836. },
  16837. "enable_push": {
  16838. "type": "boolean",
  16839. "x-go-name": "EnablePush"
  16840. },
  16841. "enable_push_whitelist": {
  16842. "type": "boolean",
  16843. "x-go-name": "EnablePushWhitelist"
  16844. },
  16845. "enable_status_check": {
  16846. "type": "boolean",
  16847. "x-go-name": "EnableStatusCheck"
  16848. },
  16849. "merge_whitelist_teams": {
  16850. "type": "array",
  16851. "items": {
  16852. "type": "string"
  16853. },
  16854. "x-go-name": "MergeWhitelistTeams"
  16855. },
  16856. "merge_whitelist_usernames": {
  16857. "type": "array",
  16858. "items": {
  16859. "type": "string"
  16860. },
  16861. "x-go-name": "MergeWhitelistUsernames"
  16862. },
  16863. "protected_file_patterns": {
  16864. "type": "string",
  16865. "x-go-name": "ProtectedFilePatterns"
  16866. },
  16867. "push_whitelist_deploy_keys": {
  16868. "type": "boolean",
  16869. "x-go-name": "PushWhitelistDeployKeys"
  16870. },
  16871. "push_whitelist_teams": {
  16872. "type": "array",
  16873. "items": {
  16874. "type": "string"
  16875. },
  16876. "x-go-name": "PushWhitelistTeams"
  16877. },
  16878. "push_whitelist_usernames": {
  16879. "type": "array",
  16880. "items": {
  16881. "type": "string"
  16882. },
  16883. "x-go-name": "PushWhitelistUsernames"
  16884. },
  16885. "require_signed_commits": {
  16886. "type": "boolean",
  16887. "x-go-name": "RequireSignedCommits"
  16888. },
  16889. "required_approvals": {
  16890. "type": "integer",
  16891. "format": "int64",
  16892. "x-go-name": "RequiredApprovals"
  16893. },
  16894. "rule_name": {
  16895. "type": "string",
  16896. "x-go-name": "RuleName"
  16897. },
  16898. "status_check_contexts": {
  16899. "type": "array",
  16900. "items": {
  16901. "type": "string"
  16902. },
  16903. "x-go-name": "StatusCheckContexts"
  16904. },
  16905. "unprotected_file_patterns": {
  16906. "type": "string",
  16907. "x-go-name": "UnprotectedFilePatterns"
  16908. },
  16909. "updated_at": {
  16910. "type": "string",
  16911. "format": "date-time",
  16912. "x-go-name": "Updated"
  16913. }
  16914. },
  16915. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16916. },
  16917. "ChangeFileOperation": {
  16918. "description": "ChangeFileOperation for creating, updating or deleting a file",
  16919. "type": "object",
  16920. "required": [
  16921. "operation",
  16922. "path"
  16923. ],
  16924. "properties": {
  16925. "content": {
  16926. "description": "new or updated file content, must be base64 encoded",
  16927. "type": "string",
  16928. "x-go-name": "ContentBase64"
  16929. },
  16930. "from_path": {
  16931. "description": "old path of the file to move",
  16932. "type": "string",
  16933. "x-go-name": "FromPath"
  16934. },
  16935. "operation": {
  16936. "description": "indicates what to do with the file",
  16937. "type": "string",
  16938. "enum": [
  16939. "create",
  16940. "update",
  16941. "delete"
  16942. ],
  16943. "x-go-name": "Operation"
  16944. },
  16945. "path": {
  16946. "description": "path to the existing or new file",
  16947. "type": "string",
  16948. "x-go-name": "Path"
  16949. },
  16950. "sha": {
  16951. "description": "sha is the SHA for the file that already exists, required for update or delete",
  16952. "type": "string",
  16953. "x-go-name": "SHA"
  16954. }
  16955. },
  16956. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16957. },
  16958. "ChangeFilesOptions": {
  16959. "description": "ChangeFilesOptions options for creating, updating or deleting multiple files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  16960. "type": "object",
  16961. "required": [
  16962. "files"
  16963. ],
  16964. "properties": {
  16965. "author": {
  16966. "$ref": "#/definitions/Identity"
  16967. },
  16968. "branch": {
  16969. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  16970. "type": "string",
  16971. "x-go-name": "BranchName"
  16972. },
  16973. "committer": {
  16974. "$ref": "#/definitions/Identity"
  16975. },
  16976. "dates": {
  16977. "$ref": "#/definitions/CommitDateOptions"
  16978. },
  16979. "files": {
  16980. "description": "list of file operations",
  16981. "type": "array",
  16982. "items": {
  16983. "$ref": "#/definitions/ChangeFileOperation"
  16984. },
  16985. "x-go-name": "Files"
  16986. },
  16987. "message": {
  16988. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  16989. "type": "string",
  16990. "x-go-name": "Message"
  16991. },
  16992. "new_branch": {
  16993. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  16994. "type": "string",
  16995. "x-go-name": "NewBranchName"
  16996. },
  16997. "signoff": {
  16998. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  16999. "type": "boolean",
  17000. "x-go-name": "Signoff"
  17001. }
  17002. },
  17003. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17004. },
  17005. "ChangedFile": {
  17006. "description": "ChangedFile store information about files affected by the pull request",
  17007. "type": "object",
  17008. "properties": {
  17009. "additions": {
  17010. "type": "integer",
  17011. "format": "int64",
  17012. "x-go-name": "Additions"
  17013. },
  17014. "changes": {
  17015. "type": "integer",
  17016. "format": "int64",
  17017. "x-go-name": "Changes"
  17018. },
  17019. "contents_url": {
  17020. "type": "string",
  17021. "x-go-name": "ContentsURL"
  17022. },
  17023. "deletions": {
  17024. "type": "integer",
  17025. "format": "int64",
  17026. "x-go-name": "Deletions"
  17027. },
  17028. "filename": {
  17029. "type": "string",
  17030. "x-go-name": "Filename"
  17031. },
  17032. "html_url": {
  17033. "type": "string",
  17034. "x-go-name": "HTMLURL"
  17035. },
  17036. "previous_filename": {
  17037. "type": "string",
  17038. "x-go-name": "PreviousFilename"
  17039. },
  17040. "raw_url": {
  17041. "type": "string",
  17042. "x-go-name": "RawURL"
  17043. },
  17044. "status": {
  17045. "type": "string",
  17046. "x-go-name": "Status"
  17047. }
  17048. },
  17049. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17050. },
  17051. "CombinedStatus": {
  17052. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  17053. "type": "object",
  17054. "properties": {
  17055. "commit_url": {
  17056. "type": "string",
  17057. "x-go-name": "CommitURL"
  17058. },
  17059. "repository": {
  17060. "$ref": "#/definitions/Repository"
  17061. },
  17062. "sha": {
  17063. "type": "string",
  17064. "x-go-name": "SHA"
  17065. },
  17066. "state": {
  17067. "$ref": "#/definitions/CommitStatusState"
  17068. },
  17069. "statuses": {
  17070. "type": "array",
  17071. "items": {
  17072. "$ref": "#/definitions/CommitStatus"
  17073. },
  17074. "x-go-name": "Statuses"
  17075. },
  17076. "total_count": {
  17077. "type": "integer",
  17078. "format": "int64",
  17079. "x-go-name": "TotalCount"
  17080. },
  17081. "url": {
  17082. "type": "string",
  17083. "x-go-name": "URL"
  17084. }
  17085. },
  17086. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17087. },
  17088. "Comment": {
  17089. "description": "Comment represents a comment on a commit or issue",
  17090. "type": "object",
  17091. "properties": {
  17092. "assets": {
  17093. "type": "array",
  17094. "items": {
  17095. "$ref": "#/definitions/Attachment"
  17096. },
  17097. "x-go-name": "Attachments"
  17098. },
  17099. "body": {
  17100. "type": "string",
  17101. "x-go-name": "Body"
  17102. },
  17103. "created_at": {
  17104. "type": "string",
  17105. "format": "date-time",
  17106. "x-go-name": "Created"
  17107. },
  17108. "html_url": {
  17109. "type": "string",
  17110. "x-go-name": "HTMLURL"
  17111. },
  17112. "id": {
  17113. "type": "integer",
  17114. "format": "int64",
  17115. "x-go-name": "ID"
  17116. },
  17117. "issue_url": {
  17118. "type": "string",
  17119. "x-go-name": "IssueURL"
  17120. },
  17121. "original_author": {
  17122. "type": "string",
  17123. "x-go-name": "OriginalAuthor"
  17124. },
  17125. "original_author_id": {
  17126. "type": "integer",
  17127. "format": "int64",
  17128. "x-go-name": "OriginalAuthorID"
  17129. },
  17130. "pull_request_url": {
  17131. "type": "string",
  17132. "x-go-name": "PRURL"
  17133. },
  17134. "updated_at": {
  17135. "type": "string",
  17136. "format": "date-time",
  17137. "x-go-name": "Updated"
  17138. },
  17139. "user": {
  17140. "$ref": "#/definitions/User"
  17141. }
  17142. },
  17143. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17144. },
  17145. "Commit": {
  17146. "type": "object",
  17147. "title": "Commit contains information generated from a Git commit.",
  17148. "properties": {
  17149. "author": {
  17150. "$ref": "#/definitions/User"
  17151. },
  17152. "commit": {
  17153. "$ref": "#/definitions/RepoCommit"
  17154. },
  17155. "committer": {
  17156. "$ref": "#/definitions/User"
  17157. },
  17158. "created": {
  17159. "type": "string",
  17160. "format": "date-time",
  17161. "x-go-name": "Created"
  17162. },
  17163. "files": {
  17164. "type": "array",
  17165. "items": {
  17166. "$ref": "#/definitions/CommitAffectedFiles"
  17167. },
  17168. "x-go-name": "Files"
  17169. },
  17170. "html_url": {
  17171. "type": "string",
  17172. "x-go-name": "HTMLURL"
  17173. },
  17174. "parents": {
  17175. "type": "array",
  17176. "items": {
  17177. "$ref": "#/definitions/CommitMeta"
  17178. },
  17179. "x-go-name": "Parents"
  17180. },
  17181. "sha": {
  17182. "type": "string",
  17183. "x-go-name": "SHA"
  17184. },
  17185. "stats": {
  17186. "$ref": "#/definitions/CommitStats"
  17187. },
  17188. "url": {
  17189. "type": "string",
  17190. "x-go-name": "URL"
  17191. }
  17192. },
  17193. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17194. },
  17195. "CommitAffectedFiles": {
  17196. "description": "CommitAffectedFiles store information about files affected by the commit",
  17197. "type": "object",
  17198. "properties": {
  17199. "filename": {
  17200. "type": "string",
  17201. "x-go-name": "Filename"
  17202. },
  17203. "status": {
  17204. "type": "string",
  17205. "x-go-name": "Status"
  17206. }
  17207. },
  17208. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17209. },
  17210. "CommitDateOptions": {
  17211. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  17212. "type": "object",
  17213. "properties": {
  17214. "author": {
  17215. "type": "string",
  17216. "format": "date-time",
  17217. "x-go-name": "Author"
  17218. },
  17219. "committer": {
  17220. "type": "string",
  17221. "format": "date-time",
  17222. "x-go-name": "Committer"
  17223. }
  17224. },
  17225. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17226. },
  17227. "CommitMeta": {
  17228. "type": "object",
  17229. "title": "CommitMeta contains meta information of a commit in terms of API.",
  17230. "properties": {
  17231. "created": {
  17232. "type": "string",
  17233. "format": "date-time",
  17234. "x-go-name": "Created"
  17235. },
  17236. "sha": {
  17237. "type": "string",
  17238. "x-go-name": "SHA"
  17239. },
  17240. "url": {
  17241. "type": "string",
  17242. "x-go-name": "URL"
  17243. }
  17244. },
  17245. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17246. },
  17247. "CommitStats": {
  17248. "description": "CommitStats is statistics for a RepoCommit",
  17249. "type": "object",
  17250. "properties": {
  17251. "additions": {
  17252. "type": "integer",
  17253. "format": "int64",
  17254. "x-go-name": "Additions"
  17255. },
  17256. "deletions": {
  17257. "type": "integer",
  17258. "format": "int64",
  17259. "x-go-name": "Deletions"
  17260. },
  17261. "total": {
  17262. "type": "integer",
  17263. "format": "int64",
  17264. "x-go-name": "Total"
  17265. }
  17266. },
  17267. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17268. },
  17269. "CommitStatus": {
  17270. "description": "CommitStatus holds a single status of a single Commit",
  17271. "type": "object",
  17272. "properties": {
  17273. "context": {
  17274. "type": "string",
  17275. "x-go-name": "Context"
  17276. },
  17277. "created_at": {
  17278. "type": "string",
  17279. "format": "date-time",
  17280. "x-go-name": "Created"
  17281. },
  17282. "creator": {
  17283. "$ref": "#/definitions/User"
  17284. },
  17285. "description": {
  17286. "type": "string",
  17287. "x-go-name": "Description"
  17288. },
  17289. "id": {
  17290. "type": "integer",
  17291. "format": "int64",
  17292. "x-go-name": "ID"
  17293. },
  17294. "status": {
  17295. "$ref": "#/definitions/CommitStatusState"
  17296. },
  17297. "target_url": {
  17298. "type": "string",
  17299. "x-go-name": "TargetURL"
  17300. },
  17301. "updated_at": {
  17302. "type": "string",
  17303. "format": "date-time",
  17304. "x-go-name": "Updated"
  17305. },
  17306. "url": {
  17307. "type": "string",
  17308. "x-go-name": "URL"
  17309. }
  17310. },
  17311. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17312. },
  17313. "CommitStatusState": {
  17314. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"",
  17315. "type": "string",
  17316. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17317. },
  17318. "CommitUser": {
  17319. "type": "object",
  17320. "title": "CommitUser contains information of a user in the context of a commit.",
  17321. "properties": {
  17322. "date": {
  17323. "type": "string",
  17324. "x-go-name": "Date"
  17325. },
  17326. "email": {
  17327. "type": "string",
  17328. "format": "email",
  17329. "x-go-name": "Email"
  17330. },
  17331. "name": {
  17332. "type": "string",
  17333. "x-go-name": "Name"
  17334. }
  17335. },
  17336. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17337. },
  17338. "ContentsResponse": {
  17339. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  17340. "type": "object",
  17341. "properties": {
  17342. "_links": {
  17343. "$ref": "#/definitions/FileLinksResponse"
  17344. },
  17345. "content": {
  17346. "description": "`content` is populated when `type` is `file`, otherwise null",
  17347. "type": "string",
  17348. "x-go-name": "Content"
  17349. },
  17350. "download_url": {
  17351. "type": "string",
  17352. "x-go-name": "DownloadURL"
  17353. },
  17354. "encoding": {
  17355. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  17356. "type": "string",
  17357. "x-go-name": "Encoding"
  17358. },
  17359. "git_url": {
  17360. "type": "string",
  17361. "x-go-name": "GitURL"
  17362. },
  17363. "html_url": {
  17364. "type": "string",
  17365. "x-go-name": "HTMLURL"
  17366. },
  17367. "last_commit_sha": {
  17368. "type": "string",
  17369. "x-go-name": "LastCommitSHA"
  17370. },
  17371. "name": {
  17372. "type": "string",
  17373. "x-go-name": "Name"
  17374. },
  17375. "path": {
  17376. "type": "string",
  17377. "x-go-name": "Path"
  17378. },
  17379. "sha": {
  17380. "type": "string",
  17381. "x-go-name": "SHA"
  17382. },
  17383. "size": {
  17384. "type": "integer",
  17385. "format": "int64",
  17386. "x-go-name": "Size"
  17387. },
  17388. "submodule_git_url": {
  17389. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  17390. "type": "string",
  17391. "x-go-name": "SubmoduleGitURL"
  17392. },
  17393. "target": {
  17394. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  17395. "type": "string",
  17396. "x-go-name": "Target"
  17397. },
  17398. "type": {
  17399. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  17400. "type": "string",
  17401. "x-go-name": "Type"
  17402. },
  17403. "url": {
  17404. "type": "string",
  17405. "x-go-name": "URL"
  17406. }
  17407. },
  17408. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17409. },
  17410. "CreateAccessTokenOption": {
  17411. "description": "CreateAccessTokenOption options when create access token",
  17412. "type": "object",
  17413. "required": [
  17414. "name"
  17415. ],
  17416. "properties": {
  17417. "name": {
  17418. "type": "string",
  17419. "x-go-name": "Name"
  17420. },
  17421. "scopes": {
  17422. "type": "array",
  17423. "items": {
  17424. "type": "string"
  17425. },
  17426. "x-go-name": "Scopes"
  17427. }
  17428. },
  17429. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17430. },
  17431. "CreateBranchProtectionOption": {
  17432. "description": "CreateBranchProtectionOption options for creating a branch protection",
  17433. "type": "object",
  17434. "properties": {
  17435. "approvals_whitelist_teams": {
  17436. "type": "array",
  17437. "items": {
  17438. "type": "string"
  17439. },
  17440. "x-go-name": "ApprovalsWhitelistTeams"
  17441. },
  17442. "approvals_whitelist_username": {
  17443. "type": "array",
  17444. "items": {
  17445. "type": "string"
  17446. },
  17447. "x-go-name": "ApprovalsWhitelistUsernames"
  17448. },
  17449. "block_on_official_review_requests": {
  17450. "type": "boolean",
  17451. "x-go-name": "BlockOnOfficialReviewRequests"
  17452. },
  17453. "block_on_outdated_branch": {
  17454. "type": "boolean",
  17455. "x-go-name": "BlockOnOutdatedBranch"
  17456. },
  17457. "block_on_rejected_reviews": {
  17458. "type": "boolean",
  17459. "x-go-name": "BlockOnRejectedReviews"
  17460. },
  17461. "branch_name": {
  17462. "description": "Deprecated: true",
  17463. "type": "string",
  17464. "x-go-name": "BranchName"
  17465. },
  17466. "dismiss_stale_approvals": {
  17467. "type": "boolean",
  17468. "x-go-name": "DismissStaleApprovals"
  17469. },
  17470. "enable_approvals_whitelist": {
  17471. "type": "boolean",
  17472. "x-go-name": "EnableApprovalsWhitelist"
  17473. },
  17474. "enable_merge_whitelist": {
  17475. "type": "boolean",
  17476. "x-go-name": "EnableMergeWhitelist"
  17477. },
  17478. "enable_push": {
  17479. "type": "boolean",
  17480. "x-go-name": "EnablePush"
  17481. },
  17482. "enable_push_whitelist": {
  17483. "type": "boolean",
  17484. "x-go-name": "EnablePushWhitelist"
  17485. },
  17486. "enable_status_check": {
  17487. "type": "boolean",
  17488. "x-go-name": "EnableStatusCheck"
  17489. },
  17490. "merge_whitelist_teams": {
  17491. "type": "array",
  17492. "items": {
  17493. "type": "string"
  17494. },
  17495. "x-go-name": "MergeWhitelistTeams"
  17496. },
  17497. "merge_whitelist_usernames": {
  17498. "type": "array",
  17499. "items": {
  17500. "type": "string"
  17501. },
  17502. "x-go-name": "MergeWhitelistUsernames"
  17503. },
  17504. "protected_file_patterns": {
  17505. "type": "string",
  17506. "x-go-name": "ProtectedFilePatterns"
  17507. },
  17508. "push_whitelist_deploy_keys": {
  17509. "type": "boolean",
  17510. "x-go-name": "PushWhitelistDeployKeys"
  17511. },
  17512. "push_whitelist_teams": {
  17513. "type": "array",
  17514. "items": {
  17515. "type": "string"
  17516. },
  17517. "x-go-name": "PushWhitelistTeams"
  17518. },
  17519. "push_whitelist_usernames": {
  17520. "type": "array",
  17521. "items": {
  17522. "type": "string"
  17523. },
  17524. "x-go-name": "PushWhitelistUsernames"
  17525. },
  17526. "require_signed_commits": {
  17527. "type": "boolean",
  17528. "x-go-name": "RequireSignedCommits"
  17529. },
  17530. "required_approvals": {
  17531. "type": "integer",
  17532. "format": "int64",
  17533. "x-go-name": "RequiredApprovals"
  17534. },
  17535. "rule_name": {
  17536. "type": "string",
  17537. "x-go-name": "RuleName"
  17538. },
  17539. "status_check_contexts": {
  17540. "type": "array",
  17541. "items": {
  17542. "type": "string"
  17543. },
  17544. "x-go-name": "StatusCheckContexts"
  17545. },
  17546. "unprotected_file_patterns": {
  17547. "type": "string",
  17548. "x-go-name": "UnprotectedFilePatterns"
  17549. }
  17550. },
  17551. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17552. },
  17553. "CreateBranchRepoOption": {
  17554. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  17555. "type": "object",
  17556. "required": [
  17557. "new_branch_name"
  17558. ],
  17559. "properties": {
  17560. "new_branch_name": {
  17561. "description": "Name of the branch to create",
  17562. "type": "string",
  17563. "uniqueItems": true,
  17564. "x-go-name": "BranchName"
  17565. },
  17566. "old_branch_name": {
  17567. "description": "Deprecated: true\nName of the old branch to create from",
  17568. "type": "string",
  17569. "uniqueItems": true,
  17570. "x-go-name": "OldBranchName"
  17571. },
  17572. "old_ref_name": {
  17573. "description": "Name of the old branch/tag/commit to create from",
  17574. "type": "string",
  17575. "uniqueItems": true,
  17576. "x-go-name": "OldRefName"
  17577. }
  17578. },
  17579. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17580. },
  17581. "CreateEmailOption": {
  17582. "description": "CreateEmailOption options when creating email addresses",
  17583. "type": "object",
  17584. "properties": {
  17585. "emails": {
  17586. "description": "email addresses to add",
  17587. "type": "array",
  17588. "items": {
  17589. "type": "string"
  17590. },
  17591. "x-go-name": "Emails"
  17592. }
  17593. },
  17594. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17595. },
  17596. "CreateFileOptions": {
  17597. "description": "CreateFileOptions options for creating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  17598. "type": "object",
  17599. "required": [
  17600. "content"
  17601. ],
  17602. "properties": {
  17603. "author": {
  17604. "$ref": "#/definitions/Identity"
  17605. },
  17606. "branch": {
  17607. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  17608. "type": "string",
  17609. "x-go-name": "BranchName"
  17610. },
  17611. "committer": {
  17612. "$ref": "#/definitions/Identity"
  17613. },
  17614. "content": {
  17615. "description": "content must be base64 encoded",
  17616. "type": "string",
  17617. "x-go-name": "ContentBase64"
  17618. },
  17619. "dates": {
  17620. "$ref": "#/definitions/CommitDateOptions"
  17621. },
  17622. "message": {
  17623. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  17624. "type": "string",
  17625. "x-go-name": "Message"
  17626. },
  17627. "new_branch": {
  17628. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  17629. "type": "string",
  17630. "x-go-name": "NewBranchName"
  17631. },
  17632. "signoff": {
  17633. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  17634. "type": "boolean",
  17635. "x-go-name": "Signoff"
  17636. }
  17637. },
  17638. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17639. },
  17640. "CreateForkOption": {
  17641. "description": "CreateForkOption options for creating a fork",
  17642. "type": "object",
  17643. "properties": {
  17644. "name": {
  17645. "description": "name of the forked repository",
  17646. "type": "string",
  17647. "x-go-name": "Name"
  17648. },
  17649. "organization": {
  17650. "description": "organization name, if forking into an organization",
  17651. "type": "string",
  17652. "x-go-name": "Organization"
  17653. }
  17654. },
  17655. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17656. },
  17657. "CreateGPGKeyOption": {
  17658. "description": "CreateGPGKeyOption options create user GPG key",
  17659. "type": "object",
  17660. "required": [
  17661. "armored_public_key"
  17662. ],
  17663. "properties": {
  17664. "armored_public_key": {
  17665. "description": "An armored GPG key to add",
  17666. "type": "string",
  17667. "uniqueItems": true,
  17668. "x-go-name": "ArmoredKey"
  17669. },
  17670. "armored_signature": {
  17671. "type": "string",
  17672. "x-go-name": "Signature"
  17673. }
  17674. },
  17675. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17676. },
  17677. "CreateHookOption": {
  17678. "description": "CreateHookOption options when create a hook",
  17679. "type": "object",
  17680. "required": [
  17681. "type",
  17682. "config"
  17683. ],
  17684. "properties": {
  17685. "active": {
  17686. "type": "boolean",
  17687. "default": false,
  17688. "x-go-name": "Active"
  17689. },
  17690. "authorization_header": {
  17691. "type": "string",
  17692. "x-go-name": "AuthorizationHeader"
  17693. },
  17694. "branch_filter": {
  17695. "type": "string",
  17696. "x-go-name": "BranchFilter"
  17697. },
  17698. "config": {
  17699. "$ref": "#/definitions/CreateHookOptionConfig"
  17700. },
  17701. "events": {
  17702. "type": "array",
  17703. "items": {
  17704. "type": "string"
  17705. },
  17706. "x-go-name": "Events"
  17707. },
  17708. "type": {
  17709. "type": "string",
  17710. "enum": [
  17711. "dingtalk",
  17712. "discord",
  17713. "gitea",
  17714. "gogs",
  17715. "msteams",
  17716. "slack",
  17717. "telegram",
  17718. "feishu",
  17719. "wechatwork",
  17720. "packagist"
  17721. ],
  17722. "x-go-name": "Type"
  17723. }
  17724. },
  17725. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17726. },
  17727. "CreateHookOptionConfig": {
  17728. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  17729. "type": "object",
  17730. "additionalProperties": {
  17731. "type": "string"
  17732. },
  17733. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17734. },
  17735. "CreateIssueCommentOption": {
  17736. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  17737. "type": "object",
  17738. "required": [
  17739. "body"
  17740. ],
  17741. "properties": {
  17742. "body": {
  17743. "type": "string",
  17744. "x-go-name": "Body"
  17745. }
  17746. },
  17747. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17748. },
  17749. "CreateIssueOption": {
  17750. "description": "CreateIssueOption options to create one issue",
  17751. "type": "object",
  17752. "required": [
  17753. "title"
  17754. ],
  17755. "properties": {
  17756. "assignee": {
  17757. "description": "deprecated",
  17758. "type": "string",
  17759. "x-go-name": "Assignee"
  17760. },
  17761. "assignees": {
  17762. "type": "array",
  17763. "items": {
  17764. "type": "string"
  17765. },
  17766. "x-go-name": "Assignees"
  17767. },
  17768. "body": {
  17769. "type": "string",
  17770. "x-go-name": "Body"
  17771. },
  17772. "closed": {
  17773. "type": "boolean",
  17774. "x-go-name": "Closed"
  17775. },
  17776. "due_date": {
  17777. "type": "string",
  17778. "format": "date-time",
  17779. "x-go-name": "Deadline"
  17780. },
  17781. "labels": {
  17782. "description": "list of label ids",
  17783. "type": "array",
  17784. "items": {
  17785. "type": "integer",
  17786. "format": "int64"
  17787. },
  17788. "x-go-name": "Labels"
  17789. },
  17790. "milestone": {
  17791. "description": "milestone id",
  17792. "type": "integer",
  17793. "format": "int64",
  17794. "x-go-name": "Milestone"
  17795. },
  17796. "ref": {
  17797. "type": "string",
  17798. "x-go-name": "Ref"
  17799. },
  17800. "title": {
  17801. "type": "string",
  17802. "x-go-name": "Title"
  17803. }
  17804. },
  17805. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17806. },
  17807. "CreateKeyOption": {
  17808. "description": "CreateKeyOption options when creating a key",
  17809. "type": "object",
  17810. "required": [
  17811. "title",
  17812. "key"
  17813. ],
  17814. "properties": {
  17815. "key": {
  17816. "description": "An armored SSH key to add",
  17817. "type": "string",
  17818. "uniqueItems": true,
  17819. "x-go-name": "Key"
  17820. },
  17821. "read_only": {
  17822. "description": "Describe if the key has only read access or read/write",
  17823. "type": "boolean",
  17824. "x-go-name": "ReadOnly"
  17825. },
  17826. "title": {
  17827. "description": "Title of the key to add",
  17828. "type": "string",
  17829. "uniqueItems": true,
  17830. "x-go-name": "Title"
  17831. }
  17832. },
  17833. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17834. },
  17835. "CreateLabelOption": {
  17836. "description": "CreateLabelOption options for creating a label",
  17837. "type": "object",
  17838. "required": [
  17839. "name",
  17840. "color"
  17841. ],
  17842. "properties": {
  17843. "color": {
  17844. "type": "string",
  17845. "x-go-name": "Color",
  17846. "example": "#00aabb"
  17847. },
  17848. "description": {
  17849. "type": "string",
  17850. "x-go-name": "Description"
  17851. },
  17852. "exclusive": {
  17853. "type": "boolean",
  17854. "x-go-name": "Exclusive",
  17855. "example": false
  17856. },
  17857. "is_archived": {
  17858. "type": "boolean",
  17859. "x-go-name": "IsArchived",
  17860. "example": false
  17861. },
  17862. "name": {
  17863. "type": "string",
  17864. "x-go-name": "Name"
  17865. }
  17866. },
  17867. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17868. },
  17869. "CreateMilestoneOption": {
  17870. "description": "CreateMilestoneOption options for creating a milestone",
  17871. "type": "object",
  17872. "properties": {
  17873. "description": {
  17874. "type": "string",
  17875. "x-go-name": "Description"
  17876. },
  17877. "due_on": {
  17878. "type": "string",
  17879. "format": "date-time",
  17880. "x-go-name": "Deadline"
  17881. },
  17882. "state": {
  17883. "type": "string",
  17884. "enum": [
  17885. "open",
  17886. "closed"
  17887. ],
  17888. "x-go-name": "State"
  17889. },
  17890. "title": {
  17891. "type": "string",
  17892. "x-go-name": "Title"
  17893. }
  17894. },
  17895. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17896. },
  17897. "CreateOAuth2ApplicationOptions": {
  17898. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  17899. "type": "object",
  17900. "properties": {
  17901. "confidential_client": {
  17902. "type": "boolean",
  17903. "x-go-name": "ConfidentialClient"
  17904. },
  17905. "name": {
  17906. "type": "string",
  17907. "x-go-name": "Name"
  17908. },
  17909. "redirect_uris": {
  17910. "type": "array",
  17911. "items": {
  17912. "type": "string"
  17913. },
  17914. "x-go-name": "RedirectURIs"
  17915. }
  17916. },
  17917. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17918. },
  17919. "CreateOrUpdateSecretOption": {
  17920. "description": "CreateOrUpdateSecretOption options when creating or updating secret",
  17921. "type": "object",
  17922. "required": [
  17923. "data"
  17924. ],
  17925. "properties": {
  17926. "data": {
  17927. "description": "Data of the secret to update",
  17928. "type": "string",
  17929. "x-go-name": "Data"
  17930. }
  17931. },
  17932. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17933. },
  17934. "CreateOrgOption": {
  17935. "description": "CreateOrgOption options for creating an organization",
  17936. "type": "object",
  17937. "required": [
  17938. "username"
  17939. ],
  17940. "properties": {
  17941. "description": {
  17942. "type": "string",
  17943. "x-go-name": "Description"
  17944. },
  17945. "email": {
  17946. "type": "string",
  17947. "x-go-name": "Email"
  17948. },
  17949. "full_name": {
  17950. "type": "string",
  17951. "x-go-name": "FullName"
  17952. },
  17953. "location": {
  17954. "type": "string",
  17955. "x-go-name": "Location"
  17956. },
  17957. "repo_admin_change_team_access": {
  17958. "type": "boolean",
  17959. "x-go-name": "RepoAdminChangeTeamAccess"
  17960. },
  17961. "username": {
  17962. "type": "string",
  17963. "x-go-name": "UserName"
  17964. },
  17965. "visibility": {
  17966. "description": "possible values are `public` (default), `limited` or `private`",
  17967. "type": "string",
  17968. "enum": [
  17969. "public",
  17970. "limited",
  17971. "private"
  17972. ],
  17973. "x-go-name": "Visibility"
  17974. },
  17975. "website": {
  17976. "type": "string",
  17977. "x-go-name": "Website"
  17978. }
  17979. },
  17980. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17981. },
  17982. "CreatePullRequestOption": {
  17983. "description": "CreatePullRequestOption options when creating a pull request",
  17984. "type": "object",
  17985. "properties": {
  17986. "assignee": {
  17987. "type": "string",
  17988. "x-go-name": "Assignee"
  17989. },
  17990. "assignees": {
  17991. "type": "array",
  17992. "items": {
  17993. "type": "string"
  17994. },
  17995. "x-go-name": "Assignees"
  17996. },
  17997. "base": {
  17998. "type": "string",
  17999. "x-go-name": "Base"
  18000. },
  18001. "body": {
  18002. "type": "string",
  18003. "x-go-name": "Body"
  18004. },
  18005. "due_date": {
  18006. "type": "string",
  18007. "format": "date-time",
  18008. "x-go-name": "Deadline"
  18009. },
  18010. "head": {
  18011. "type": "string",
  18012. "x-go-name": "Head"
  18013. },
  18014. "labels": {
  18015. "type": "array",
  18016. "items": {
  18017. "type": "integer",
  18018. "format": "int64"
  18019. },
  18020. "x-go-name": "Labels"
  18021. },
  18022. "milestone": {
  18023. "type": "integer",
  18024. "format": "int64",
  18025. "x-go-name": "Milestone"
  18026. },
  18027. "title": {
  18028. "type": "string",
  18029. "x-go-name": "Title"
  18030. }
  18031. },
  18032. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18033. },
  18034. "CreatePullReviewComment": {
  18035. "description": "CreatePullReviewComment represent a review comment for creation api",
  18036. "type": "object",
  18037. "properties": {
  18038. "body": {
  18039. "type": "string",
  18040. "x-go-name": "Body"
  18041. },
  18042. "new_position": {
  18043. "description": "if comment to new file line or 0",
  18044. "type": "integer",
  18045. "format": "int64",
  18046. "x-go-name": "NewLineNum"
  18047. },
  18048. "old_position": {
  18049. "description": "if comment to old file line or 0",
  18050. "type": "integer",
  18051. "format": "int64",
  18052. "x-go-name": "OldLineNum"
  18053. },
  18054. "path": {
  18055. "description": "the tree path",
  18056. "type": "string",
  18057. "x-go-name": "Path"
  18058. }
  18059. },
  18060. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18061. },
  18062. "CreatePullReviewOptions": {
  18063. "description": "CreatePullReviewOptions are options to create a pull review",
  18064. "type": "object",
  18065. "properties": {
  18066. "body": {
  18067. "type": "string",
  18068. "x-go-name": "Body"
  18069. },
  18070. "comments": {
  18071. "type": "array",
  18072. "items": {
  18073. "$ref": "#/definitions/CreatePullReviewComment"
  18074. },
  18075. "x-go-name": "Comments"
  18076. },
  18077. "commit_id": {
  18078. "type": "string",
  18079. "x-go-name": "CommitID"
  18080. },
  18081. "event": {
  18082. "$ref": "#/definitions/ReviewStateType"
  18083. }
  18084. },
  18085. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18086. },
  18087. "CreatePushMirrorOption": {
  18088. "type": "object",
  18089. "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
  18090. "properties": {
  18091. "interval": {
  18092. "type": "string",
  18093. "x-go-name": "Interval"
  18094. },
  18095. "remote_address": {
  18096. "type": "string",
  18097. "x-go-name": "RemoteAddress"
  18098. },
  18099. "remote_password": {
  18100. "type": "string",
  18101. "x-go-name": "RemotePassword"
  18102. },
  18103. "remote_username": {
  18104. "type": "string",
  18105. "x-go-name": "RemoteUsername"
  18106. },
  18107. "sync_on_commit": {
  18108. "type": "boolean",
  18109. "x-go-name": "SyncOnCommit"
  18110. }
  18111. },
  18112. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18113. },
  18114. "CreateReleaseOption": {
  18115. "description": "CreateReleaseOption options when creating a release",
  18116. "type": "object",
  18117. "required": [
  18118. "tag_name"
  18119. ],
  18120. "properties": {
  18121. "body": {
  18122. "type": "string",
  18123. "x-go-name": "Note"
  18124. },
  18125. "draft": {
  18126. "type": "boolean",
  18127. "x-go-name": "IsDraft"
  18128. },
  18129. "name": {
  18130. "type": "string",
  18131. "x-go-name": "Title"
  18132. },
  18133. "prerelease": {
  18134. "type": "boolean",
  18135. "x-go-name": "IsPrerelease"
  18136. },
  18137. "tag_name": {
  18138. "type": "string",
  18139. "x-go-name": "TagName"
  18140. },
  18141. "target_commitish": {
  18142. "type": "string",
  18143. "x-go-name": "Target"
  18144. }
  18145. },
  18146. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18147. },
  18148. "CreateRepoOption": {
  18149. "description": "CreateRepoOption options when creating repository",
  18150. "type": "object",
  18151. "required": [
  18152. "name"
  18153. ],
  18154. "properties": {
  18155. "auto_init": {
  18156. "description": "Whether the repository should be auto-initialized?",
  18157. "type": "boolean",
  18158. "x-go-name": "AutoInit"
  18159. },
  18160. "default_branch": {
  18161. "description": "DefaultBranch of the repository (used when initializes and in template)",
  18162. "type": "string",
  18163. "x-go-name": "DefaultBranch"
  18164. },
  18165. "description": {
  18166. "description": "Description of the repository to create",
  18167. "type": "string",
  18168. "x-go-name": "Description"
  18169. },
  18170. "gitignores": {
  18171. "description": "Gitignores to use",
  18172. "type": "string",
  18173. "x-go-name": "Gitignores"
  18174. },
  18175. "issue_labels": {
  18176. "description": "Label-Set to use",
  18177. "type": "string",
  18178. "x-go-name": "IssueLabels"
  18179. },
  18180. "license": {
  18181. "description": "License to use",
  18182. "type": "string",
  18183. "x-go-name": "License"
  18184. },
  18185. "name": {
  18186. "description": "Name of the repository to create",
  18187. "type": "string",
  18188. "uniqueItems": true,
  18189. "x-go-name": "Name"
  18190. },
  18191. "private": {
  18192. "description": "Whether the repository is private",
  18193. "type": "boolean",
  18194. "x-go-name": "Private"
  18195. },
  18196. "readme": {
  18197. "description": "Readme of the repository to create",
  18198. "type": "string",
  18199. "x-go-name": "Readme"
  18200. },
  18201. "template": {
  18202. "description": "Whether the repository is template",
  18203. "type": "boolean",
  18204. "x-go-name": "Template"
  18205. },
  18206. "trust_model": {
  18207. "description": "TrustModel of the repository",
  18208. "type": "string",
  18209. "enum": [
  18210. "default",
  18211. "collaborator",
  18212. "committer",
  18213. "collaboratorcommitter"
  18214. ],
  18215. "x-go-name": "TrustModel"
  18216. }
  18217. },
  18218. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18219. },
  18220. "CreateStatusOption": {
  18221. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  18222. "type": "object",
  18223. "properties": {
  18224. "context": {
  18225. "type": "string",
  18226. "x-go-name": "Context"
  18227. },
  18228. "description": {
  18229. "type": "string",
  18230. "x-go-name": "Description"
  18231. },
  18232. "state": {
  18233. "$ref": "#/definitions/CommitStatusState"
  18234. },
  18235. "target_url": {
  18236. "type": "string",
  18237. "x-go-name": "TargetURL"
  18238. }
  18239. },
  18240. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18241. },
  18242. "CreateTagOption": {
  18243. "description": "CreateTagOption options when creating a tag",
  18244. "type": "object",
  18245. "required": [
  18246. "tag_name"
  18247. ],
  18248. "properties": {
  18249. "message": {
  18250. "type": "string",
  18251. "x-go-name": "Message"
  18252. },
  18253. "tag_name": {
  18254. "type": "string",
  18255. "x-go-name": "TagName"
  18256. },
  18257. "target": {
  18258. "type": "string",
  18259. "x-go-name": "Target"
  18260. }
  18261. },
  18262. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18263. },
  18264. "CreateTeamOption": {
  18265. "description": "CreateTeamOption options for creating a team",
  18266. "type": "object",
  18267. "required": [
  18268. "name"
  18269. ],
  18270. "properties": {
  18271. "can_create_org_repo": {
  18272. "type": "boolean",
  18273. "x-go-name": "CanCreateOrgRepo"
  18274. },
  18275. "description": {
  18276. "type": "string",
  18277. "x-go-name": "Description"
  18278. },
  18279. "includes_all_repositories": {
  18280. "type": "boolean",
  18281. "x-go-name": "IncludesAllRepositories"
  18282. },
  18283. "name": {
  18284. "type": "string",
  18285. "x-go-name": "Name"
  18286. },
  18287. "permission": {
  18288. "type": "string",
  18289. "enum": [
  18290. "read",
  18291. "write",
  18292. "admin"
  18293. ],
  18294. "x-go-name": "Permission"
  18295. },
  18296. "units": {
  18297. "type": "array",
  18298. "items": {
  18299. "type": "string"
  18300. },
  18301. "x-go-name": "Units",
  18302. "example": [
  18303. "repo.actions",
  18304. "repo.code",
  18305. "repo.issues",
  18306. "repo.ext_issues",
  18307. "repo.wiki",
  18308. "repo.ext_wiki",
  18309. "repo.pulls",
  18310. "repo.releases",
  18311. "repo.projects",
  18312. "repo.ext_wiki"
  18313. ]
  18314. },
  18315. "units_map": {
  18316. "type": "object",
  18317. "additionalProperties": {
  18318. "type": "string"
  18319. },
  18320. "x-go-name": "UnitsMap",
  18321. "example": "{\"repo.actions\",\"repo.packages\",\"repo.code\":\"read\",\"repo.issues\":\"write\",\"repo.ext_issues\":\"none\",\"repo.wiki\":\"admin\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.projects\":\"none\",\"repo.ext_wiki\":\"none\"}"
  18322. }
  18323. },
  18324. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18325. },
  18326. "CreateUserOption": {
  18327. "description": "CreateUserOption create user options",
  18328. "type": "object",
  18329. "required": [
  18330. "username",
  18331. "email",
  18332. "password"
  18333. ],
  18334. "properties": {
  18335. "created_at": {
  18336. "description": "For explicitly setting the user creation timestamp. Useful when users are\nmigrated from other systems. When omitted, the user's creation timestamp\nwill be set to \"now\".",
  18337. "type": "string",
  18338. "format": "date-time",
  18339. "x-go-name": "Created"
  18340. },
  18341. "email": {
  18342. "type": "string",
  18343. "format": "email",
  18344. "x-go-name": "Email"
  18345. },
  18346. "full_name": {
  18347. "type": "string",
  18348. "x-go-name": "FullName"
  18349. },
  18350. "login_name": {
  18351. "type": "string",
  18352. "x-go-name": "LoginName"
  18353. },
  18354. "must_change_password": {
  18355. "type": "boolean",
  18356. "x-go-name": "MustChangePassword"
  18357. },
  18358. "password": {
  18359. "type": "string",
  18360. "x-go-name": "Password"
  18361. },
  18362. "restricted": {
  18363. "type": "boolean",
  18364. "x-go-name": "Restricted"
  18365. },
  18366. "send_notify": {
  18367. "type": "boolean",
  18368. "x-go-name": "SendNotify"
  18369. },
  18370. "source_id": {
  18371. "type": "integer",
  18372. "format": "int64",
  18373. "x-go-name": "SourceID"
  18374. },
  18375. "username": {
  18376. "type": "string",
  18377. "x-go-name": "Username"
  18378. },
  18379. "visibility": {
  18380. "type": "string",
  18381. "x-go-name": "Visibility"
  18382. }
  18383. },
  18384. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18385. },
  18386. "CreateWikiPageOptions": {
  18387. "description": "CreateWikiPageOptions form for creating wiki",
  18388. "type": "object",
  18389. "properties": {
  18390. "content_base64": {
  18391. "description": "content must be base64 encoded",
  18392. "type": "string",
  18393. "x-go-name": "ContentBase64"
  18394. },
  18395. "message": {
  18396. "description": "optional commit message summarizing the change",
  18397. "type": "string",
  18398. "x-go-name": "Message"
  18399. },
  18400. "title": {
  18401. "description": "page title. leave empty to keep unchanged",
  18402. "type": "string",
  18403. "x-go-name": "Title"
  18404. }
  18405. },
  18406. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18407. },
  18408. "Cron": {
  18409. "description": "Cron represents a Cron task",
  18410. "type": "object",
  18411. "properties": {
  18412. "exec_times": {
  18413. "type": "integer",
  18414. "format": "int64",
  18415. "x-go-name": "ExecTimes"
  18416. },
  18417. "name": {
  18418. "type": "string",
  18419. "x-go-name": "Name"
  18420. },
  18421. "next": {
  18422. "type": "string",
  18423. "format": "date-time",
  18424. "x-go-name": "Next"
  18425. },
  18426. "prev": {
  18427. "type": "string",
  18428. "format": "date-time",
  18429. "x-go-name": "Prev"
  18430. },
  18431. "schedule": {
  18432. "type": "string",
  18433. "x-go-name": "Schedule"
  18434. }
  18435. },
  18436. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18437. },
  18438. "DeleteEmailOption": {
  18439. "description": "DeleteEmailOption options when deleting email addresses",
  18440. "type": "object",
  18441. "properties": {
  18442. "emails": {
  18443. "description": "email addresses to delete",
  18444. "type": "array",
  18445. "items": {
  18446. "type": "string"
  18447. },
  18448. "x-go-name": "Emails"
  18449. }
  18450. },
  18451. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18452. },
  18453. "DeleteFileOptions": {
  18454. "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)",
  18455. "type": "object",
  18456. "required": [
  18457. "sha"
  18458. ],
  18459. "properties": {
  18460. "author": {
  18461. "$ref": "#/definitions/Identity"
  18462. },
  18463. "branch": {
  18464. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  18465. "type": "string",
  18466. "x-go-name": "BranchName"
  18467. },
  18468. "committer": {
  18469. "$ref": "#/definitions/Identity"
  18470. },
  18471. "dates": {
  18472. "$ref": "#/definitions/CommitDateOptions"
  18473. },
  18474. "message": {
  18475. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  18476. "type": "string",
  18477. "x-go-name": "Message"
  18478. },
  18479. "new_branch": {
  18480. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  18481. "type": "string",
  18482. "x-go-name": "NewBranchName"
  18483. },
  18484. "sha": {
  18485. "description": "sha is the SHA for the file that already exists",
  18486. "type": "string",
  18487. "x-go-name": "SHA"
  18488. },
  18489. "signoff": {
  18490. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  18491. "type": "boolean",
  18492. "x-go-name": "Signoff"
  18493. }
  18494. },
  18495. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18496. },
  18497. "DeployKey": {
  18498. "description": "DeployKey a deploy key",
  18499. "type": "object",
  18500. "properties": {
  18501. "created_at": {
  18502. "type": "string",
  18503. "format": "date-time",
  18504. "x-go-name": "Created"
  18505. },
  18506. "fingerprint": {
  18507. "type": "string",
  18508. "x-go-name": "Fingerprint"
  18509. },
  18510. "id": {
  18511. "type": "integer",
  18512. "format": "int64",
  18513. "x-go-name": "ID"
  18514. },
  18515. "key": {
  18516. "type": "string",
  18517. "x-go-name": "Key"
  18518. },
  18519. "key_id": {
  18520. "type": "integer",
  18521. "format": "int64",
  18522. "x-go-name": "KeyID"
  18523. },
  18524. "read_only": {
  18525. "type": "boolean",
  18526. "x-go-name": "ReadOnly"
  18527. },
  18528. "repository": {
  18529. "$ref": "#/definitions/Repository"
  18530. },
  18531. "title": {
  18532. "type": "string",
  18533. "x-go-name": "Title"
  18534. },
  18535. "url": {
  18536. "type": "string",
  18537. "x-go-name": "URL"
  18538. }
  18539. },
  18540. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18541. },
  18542. "DismissPullReviewOptions": {
  18543. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  18544. "type": "object",
  18545. "properties": {
  18546. "message": {
  18547. "type": "string",
  18548. "x-go-name": "Message"
  18549. },
  18550. "priors": {
  18551. "type": "boolean",
  18552. "x-go-name": "Priors"
  18553. }
  18554. },
  18555. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18556. },
  18557. "EditAttachmentOptions": {
  18558. "description": "EditAttachmentOptions options for editing attachments",
  18559. "type": "object",
  18560. "properties": {
  18561. "name": {
  18562. "type": "string",
  18563. "x-go-name": "Name"
  18564. }
  18565. },
  18566. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18567. },
  18568. "EditBranchProtectionOption": {
  18569. "description": "EditBranchProtectionOption options for editing a branch protection",
  18570. "type": "object",
  18571. "properties": {
  18572. "approvals_whitelist_teams": {
  18573. "type": "array",
  18574. "items": {
  18575. "type": "string"
  18576. },
  18577. "x-go-name": "ApprovalsWhitelistTeams"
  18578. },
  18579. "approvals_whitelist_username": {
  18580. "type": "array",
  18581. "items": {
  18582. "type": "string"
  18583. },
  18584. "x-go-name": "ApprovalsWhitelistUsernames"
  18585. },
  18586. "block_on_official_review_requests": {
  18587. "type": "boolean",
  18588. "x-go-name": "BlockOnOfficialReviewRequests"
  18589. },
  18590. "block_on_outdated_branch": {
  18591. "type": "boolean",
  18592. "x-go-name": "BlockOnOutdatedBranch"
  18593. },
  18594. "block_on_rejected_reviews": {
  18595. "type": "boolean",
  18596. "x-go-name": "BlockOnRejectedReviews"
  18597. },
  18598. "dismiss_stale_approvals": {
  18599. "type": "boolean",
  18600. "x-go-name": "DismissStaleApprovals"
  18601. },
  18602. "enable_approvals_whitelist": {
  18603. "type": "boolean",
  18604. "x-go-name": "EnableApprovalsWhitelist"
  18605. },
  18606. "enable_merge_whitelist": {
  18607. "type": "boolean",
  18608. "x-go-name": "EnableMergeWhitelist"
  18609. },
  18610. "enable_push": {
  18611. "type": "boolean",
  18612. "x-go-name": "EnablePush"
  18613. },
  18614. "enable_push_whitelist": {
  18615. "type": "boolean",
  18616. "x-go-name": "EnablePushWhitelist"
  18617. },
  18618. "enable_status_check": {
  18619. "type": "boolean",
  18620. "x-go-name": "EnableStatusCheck"
  18621. },
  18622. "merge_whitelist_teams": {
  18623. "type": "array",
  18624. "items": {
  18625. "type": "string"
  18626. },
  18627. "x-go-name": "MergeWhitelistTeams"
  18628. },
  18629. "merge_whitelist_usernames": {
  18630. "type": "array",
  18631. "items": {
  18632. "type": "string"
  18633. },
  18634. "x-go-name": "MergeWhitelistUsernames"
  18635. },
  18636. "protected_file_patterns": {
  18637. "type": "string",
  18638. "x-go-name": "ProtectedFilePatterns"
  18639. },
  18640. "push_whitelist_deploy_keys": {
  18641. "type": "boolean",
  18642. "x-go-name": "PushWhitelistDeployKeys"
  18643. },
  18644. "push_whitelist_teams": {
  18645. "type": "array",
  18646. "items": {
  18647. "type": "string"
  18648. },
  18649. "x-go-name": "PushWhitelistTeams"
  18650. },
  18651. "push_whitelist_usernames": {
  18652. "type": "array",
  18653. "items": {
  18654. "type": "string"
  18655. },
  18656. "x-go-name": "PushWhitelistUsernames"
  18657. },
  18658. "require_signed_commits": {
  18659. "type": "boolean",
  18660. "x-go-name": "RequireSignedCommits"
  18661. },
  18662. "required_approvals": {
  18663. "type": "integer",
  18664. "format": "int64",
  18665. "x-go-name": "RequiredApprovals"
  18666. },
  18667. "status_check_contexts": {
  18668. "type": "array",
  18669. "items": {
  18670. "type": "string"
  18671. },
  18672. "x-go-name": "StatusCheckContexts"
  18673. },
  18674. "unprotected_file_patterns": {
  18675. "type": "string",
  18676. "x-go-name": "UnprotectedFilePatterns"
  18677. }
  18678. },
  18679. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18680. },
  18681. "EditDeadlineOption": {
  18682. "description": "EditDeadlineOption options for creating a deadline",
  18683. "type": "object",
  18684. "required": [
  18685. "due_date"
  18686. ],
  18687. "properties": {
  18688. "due_date": {
  18689. "type": "string",
  18690. "format": "date-time",
  18691. "x-go-name": "Deadline"
  18692. }
  18693. },
  18694. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18695. },
  18696. "EditGitHookOption": {
  18697. "description": "EditGitHookOption options when modifying one Git hook",
  18698. "type": "object",
  18699. "properties": {
  18700. "content": {
  18701. "type": "string",
  18702. "x-go-name": "Content"
  18703. }
  18704. },
  18705. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18706. },
  18707. "EditHookOption": {
  18708. "description": "EditHookOption options when modify one hook",
  18709. "type": "object",
  18710. "properties": {
  18711. "active": {
  18712. "type": "boolean",
  18713. "x-go-name": "Active"
  18714. },
  18715. "authorization_header": {
  18716. "type": "string",
  18717. "x-go-name": "AuthorizationHeader"
  18718. },
  18719. "branch_filter": {
  18720. "type": "string",
  18721. "x-go-name": "BranchFilter"
  18722. },
  18723. "config": {
  18724. "type": "object",
  18725. "additionalProperties": {
  18726. "type": "string"
  18727. },
  18728. "x-go-name": "Config"
  18729. },
  18730. "events": {
  18731. "type": "array",
  18732. "items": {
  18733. "type": "string"
  18734. },
  18735. "x-go-name": "Events"
  18736. }
  18737. },
  18738. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18739. },
  18740. "EditIssueCommentOption": {
  18741. "description": "EditIssueCommentOption options for editing a comment",
  18742. "type": "object",
  18743. "required": [
  18744. "body"
  18745. ],
  18746. "properties": {
  18747. "body": {
  18748. "type": "string",
  18749. "x-go-name": "Body"
  18750. }
  18751. },
  18752. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18753. },
  18754. "EditIssueOption": {
  18755. "description": "EditIssueOption options for editing an issue",
  18756. "type": "object",
  18757. "properties": {
  18758. "assignee": {
  18759. "description": "deprecated",
  18760. "type": "string",
  18761. "x-go-name": "Assignee"
  18762. },
  18763. "assignees": {
  18764. "type": "array",
  18765. "items": {
  18766. "type": "string"
  18767. },
  18768. "x-go-name": "Assignees"
  18769. },
  18770. "body": {
  18771. "type": "string",
  18772. "x-go-name": "Body"
  18773. },
  18774. "due_date": {
  18775. "type": "string",
  18776. "format": "date-time",
  18777. "x-go-name": "Deadline"
  18778. },
  18779. "milestone": {
  18780. "type": "integer",
  18781. "format": "int64",
  18782. "x-go-name": "Milestone"
  18783. },
  18784. "ref": {
  18785. "type": "string",
  18786. "x-go-name": "Ref"
  18787. },
  18788. "state": {
  18789. "type": "string",
  18790. "x-go-name": "State"
  18791. },
  18792. "title": {
  18793. "type": "string",
  18794. "x-go-name": "Title"
  18795. },
  18796. "unset_due_date": {
  18797. "type": "boolean",
  18798. "x-go-name": "RemoveDeadline"
  18799. }
  18800. },
  18801. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18802. },
  18803. "EditLabelOption": {
  18804. "description": "EditLabelOption options for editing a label",
  18805. "type": "object",
  18806. "properties": {
  18807. "color": {
  18808. "type": "string",
  18809. "x-go-name": "Color",
  18810. "example": "#00aabb"
  18811. },
  18812. "description": {
  18813. "type": "string",
  18814. "x-go-name": "Description"
  18815. },
  18816. "exclusive": {
  18817. "type": "boolean",
  18818. "x-go-name": "Exclusive",
  18819. "example": false
  18820. },
  18821. "is_archived": {
  18822. "type": "boolean",
  18823. "x-go-name": "IsArchived",
  18824. "example": false
  18825. },
  18826. "name": {
  18827. "type": "string",
  18828. "x-go-name": "Name"
  18829. }
  18830. },
  18831. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18832. },
  18833. "EditMilestoneOption": {
  18834. "description": "EditMilestoneOption options for editing a milestone",
  18835. "type": "object",
  18836. "properties": {
  18837. "description": {
  18838. "type": "string",
  18839. "x-go-name": "Description"
  18840. },
  18841. "due_on": {
  18842. "type": "string",
  18843. "format": "date-time",
  18844. "x-go-name": "Deadline"
  18845. },
  18846. "state": {
  18847. "type": "string",
  18848. "x-go-name": "State"
  18849. },
  18850. "title": {
  18851. "type": "string",
  18852. "x-go-name": "Title"
  18853. }
  18854. },
  18855. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18856. },
  18857. "EditOrgOption": {
  18858. "description": "EditOrgOption options for editing an organization",
  18859. "type": "object",
  18860. "properties": {
  18861. "description": {
  18862. "type": "string",
  18863. "x-go-name": "Description"
  18864. },
  18865. "email": {
  18866. "type": "string",
  18867. "x-go-name": "Email"
  18868. },
  18869. "full_name": {
  18870. "type": "string",
  18871. "x-go-name": "FullName"
  18872. },
  18873. "location": {
  18874. "type": "string",
  18875. "x-go-name": "Location"
  18876. },
  18877. "repo_admin_change_team_access": {
  18878. "type": "boolean",
  18879. "x-go-name": "RepoAdminChangeTeamAccess"
  18880. },
  18881. "visibility": {
  18882. "description": "possible values are `public`, `limited` or `private`",
  18883. "type": "string",
  18884. "enum": [
  18885. "public",
  18886. "limited",
  18887. "private"
  18888. ],
  18889. "x-go-name": "Visibility"
  18890. },
  18891. "website": {
  18892. "type": "string",
  18893. "x-go-name": "Website"
  18894. }
  18895. },
  18896. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18897. },
  18898. "EditPullRequestOption": {
  18899. "description": "EditPullRequestOption options when modify pull request",
  18900. "type": "object",
  18901. "properties": {
  18902. "allow_maintainer_edit": {
  18903. "type": "boolean",
  18904. "x-go-name": "AllowMaintainerEdit"
  18905. },
  18906. "assignee": {
  18907. "type": "string",
  18908. "x-go-name": "Assignee"
  18909. },
  18910. "assignees": {
  18911. "type": "array",
  18912. "items": {
  18913. "type": "string"
  18914. },
  18915. "x-go-name": "Assignees"
  18916. },
  18917. "base": {
  18918. "type": "string",
  18919. "x-go-name": "Base"
  18920. },
  18921. "body": {
  18922. "type": "string",
  18923. "x-go-name": "Body"
  18924. },
  18925. "due_date": {
  18926. "type": "string",
  18927. "format": "date-time",
  18928. "x-go-name": "Deadline"
  18929. },
  18930. "labels": {
  18931. "type": "array",
  18932. "items": {
  18933. "type": "integer",
  18934. "format": "int64"
  18935. },
  18936. "x-go-name": "Labels"
  18937. },
  18938. "milestone": {
  18939. "type": "integer",
  18940. "format": "int64",
  18941. "x-go-name": "Milestone"
  18942. },
  18943. "state": {
  18944. "type": "string",
  18945. "x-go-name": "State"
  18946. },
  18947. "title": {
  18948. "type": "string",
  18949. "x-go-name": "Title"
  18950. },
  18951. "unset_due_date": {
  18952. "type": "boolean",
  18953. "x-go-name": "RemoveDeadline"
  18954. }
  18955. },
  18956. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18957. },
  18958. "EditReactionOption": {
  18959. "description": "EditReactionOption contain the reaction type",
  18960. "type": "object",
  18961. "properties": {
  18962. "content": {
  18963. "type": "string",
  18964. "x-go-name": "Reaction"
  18965. }
  18966. },
  18967. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18968. },
  18969. "EditReleaseOption": {
  18970. "description": "EditReleaseOption options when editing a release",
  18971. "type": "object",
  18972. "properties": {
  18973. "body": {
  18974. "type": "string",
  18975. "x-go-name": "Note"
  18976. },
  18977. "draft": {
  18978. "type": "boolean",
  18979. "x-go-name": "IsDraft"
  18980. },
  18981. "name": {
  18982. "type": "string",
  18983. "x-go-name": "Title"
  18984. },
  18985. "prerelease": {
  18986. "type": "boolean",
  18987. "x-go-name": "IsPrerelease"
  18988. },
  18989. "tag_name": {
  18990. "type": "string",
  18991. "x-go-name": "TagName"
  18992. },
  18993. "target_commitish": {
  18994. "type": "string",
  18995. "x-go-name": "Target"
  18996. }
  18997. },
  18998. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18999. },
  19000. "EditRepoOption": {
  19001. "description": "EditRepoOption options when editing a repository's properties",
  19002. "type": "object",
  19003. "properties": {
  19004. "allow_manual_merge": {
  19005. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
  19006. "type": "boolean",
  19007. "x-go-name": "AllowManualMerge"
  19008. },
  19009. "allow_merge_commits": {
  19010. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  19011. "type": "boolean",
  19012. "x-go-name": "AllowMerge"
  19013. },
  19014. "allow_rebase": {
  19015. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  19016. "type": "boolean",
  19017. "x-go-name": "AllowRebase"
  19018. },
  19019. "allow_rebase_explicit": {
  19020. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
  19021. "type": "boolean",
  19022. "x-go-name": "AllowRebaseMerge"
  19023. },
  19024. "allow_rebase_update": {
  19025. "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
  19026. "type": "boolean",
  19027. "x-go-name": "AllowRebaseUpdate"
  19028. },
  19029. "allow_squash_merge": {
  19030. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  19031. "type": "boolean",
  19032. "x-go-name": "AllowSquash"
  19033. },
  19034. "archived": {
  19035. "description": "set to `true` to archive this repository.",
  19036. "type": "boolean",
  19037. "x-go-name": "Archived"
  19038. },
  19039. "autodetect_manual_merge": {
  19040. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
  19041. "type": "boolean",
  19042. "x-go-name": "AutodetectManualMerge"
  19043. },
  19044. "default_allow_maintainer_edit": {
  19045. "description": "set to `true` to allow edits from maintainers by default",
  19046. "type": "boolean",
  19047. "x-go-name": "DefaultAllowMaintainerEdit"
  19048. },
  19049. "default_branch": {
  19050. "description": "sets the default branch for this repository.",
  19051. "type": "string",
  19052. "x-go-name": "DefaultBranch"
  19053. },
  19054. "default_delete_branch_after_merge": {
  19055. "description": "set to `true` to delete pr branch after merge by default",
  19056. "type": "boolean",
  19057. "x-go-name": "DefaultDeleteBranchAfterMerge"
  19058. },
  19059. "default_merge_style": {
  19060. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", or \"squash\".",
  19061. "type": "string",
  19062. "x-go-name": "DefaultMergeStyle"
  19063. },
  19064. "description": {
  19065. "description": "a short description of the repository.",
  19066. "type": "string",
  19067. "x-go-name": "Description"
  19068. },
  19069. "enable_prune": {
  19070. "description": "enable prune - remove obsolete remote-tracking references",
  19071. "type": "boolean",
  19072. "x-go-name": "EnablePrune"
  19073. },
  19074. "external_tracker": {
  19075. "$ref": "#/definitions/ExternalTracker"
  19076. },
  19077. "external_wiki": {
  19078. "$ref": "#/definitions/ExternalWiki"
  19079. },
  19080. "has_actions": {
  19081. "description": "either `true` to enable actions unit, or `false` to disable them.",
  19082. "type": "boolean",
  19083. "x-go-name": "HasActions"
  19084. },
  19085. "has_issues": {
  19086. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  19087. "type": "boolean",
  19088. "x-go-name": "HasIssues"
  19089. },
  19090. "has_packages": {
  19091. "description": "either `true` to enable packages unit, or `false` to disable them.",
  19092. "type": "boolean",
  19093. "x-go-name": "HasPackages"
  19094. },
  19095. "has_projects": {
  19096. "description": "either `true` to enable project unit, or `false` to disable them.",
  19097. "type": "boolean",
  19098. "x-go-name": "HasProjects"
  19099. },
  19100. "has_pull_requests": {
  19101. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  19102. "type": "boolean",
  19103. "x-go-name": "HasPullRequests"
  19104. },
  19105. "has_releases": {
  19106. "description": "either `true` to enable releases unit, or `false` to disable them.",
  19107. "type": "boolean",
  19108. "x-go-name": "HasReleases"
  19109. },
  19110. "has_wiki": {
  19111. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  19112. "type": "boolean",
  19113. "x-go-name": "HasWiki"
  19114. },
  19115. "ignore_whitespace_conflicts": {
  19116. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
  19117. "type": "boolean",
  19118. "x-go-name": "IgnoreWhitespaceConflicts"
  19119. },
  19120. "internal_tracker": {
  19121. "$ref": "#/definitions/InternalTracker"
  19122. },
  19123. "mirror_interval": {
  19124. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  19125. "type": "string",
  19126. "x-go-name": "MirrorInterval"
  19127. },
  19128. "name": {
  19129. "description": "name of the repository",
  19130. "type": "string",
  19131. "uniqueItems": true,
  19132. "x-go-name": "Name"
  19133. },
  19134. "private": {
  19135. "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.",
  19136. "type": "boolean",
  19137. "x-go-name": "Private"
  19138. },
  19139. "template": {
  19140. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  19141. "type": "boolean",
  19142. "x-go-name": "Template"
  19143. },
  19144. "website": {
  19145. "description": "a URL with more information about the repository.",
  19146. "type": "string",
  19147. "x-go-name": "Website"
  19148. }
  19149. },
  19150. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19151. },
  19152. "EditTeamOption": {
  19153. "description": "EditTeamOption options for editing a team",
  19154. "type": "object",
  19155. "required": [
  19156. "name"
  19157. ],
  19158. "properties": {
  19159. "can_create_org_repo": {
  19160. "type": "boolean",
  19161. "x-go-name": "CanCreateOrgRepo"
  19162. },
  19163. "description": {
  19164. "type": "string",
  19165. "x-go-name": "Description"
  19166. },
  19167. "includes_all_repositories": {
  19168. "type": "boolean",
  19169. "x-go-name": "IncludesAllRepositories"
  19170. },
  19171. "name": {
  19172. "type": "string",
  19173. "x-go-name": "Name"
  19174. },
  19175. "permission": {
  19176. "type": "string",
  19177. "enum": [
  19178. "read",
  19179. "write",
  19180. "admin"
  19181. ],
  19182. "x-go-name": "Permission"
  19183. },
  19184. "units": {
  19185. "type": "array",
  19186. "items": {
  19187. "type": "string"
  19188. },
  19189. "x-go-name": "Units",
  19190. "example": [
  19191. "repo.code",
  19192. "repo.issues",
  19193. "repo.ext_issues",
  19194. "repo.wiki",
  19195. "repo.pulls",
  19196. "repo.releases",
  19197. "repo.projects",
  19198. "repo.ext_wiki"
  19199. ]
  19200. },
  19201. "units_map": {
  19202. "type": "object",
  19203. "additionalProperties": {
  19204. "type": "string"
  19205. },
  19206. "x-go-name": "UnitsMap",
  19207. "example": {
  19208. "repo.code": "read",
  19209. "repo.ext_issues": "none",
  19210. "repo.ext_wiki": "none",
  19211. "repo.issues": "write",
  19212. "repo.projects": "none",
  19213. "repo.pulls": "owner",
  19214. "repo.releases": "none",
  19215. "repo.wiki": "admin"
  19216. }
  19217. }
  19218. },
  19219. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19220. },
  19221. "EditUserOption": {
  19222. "description": "EditUserOption edit user options",
  19223. "type": "object",
  19224. "required": [
  19225. "source_id",
  19226. "login_name"
  19227. ],
  19228. "properties": {
  19229. "active": {
  19230. "type": "boolean",
  19231. "x-go-name": "Active"
  19232. },
  19233. "admin": {
  19234. "type": "boolean",
  19235. "x-go-name": "Admin"
  19236. },
  19237. "allow_create_organization": {
  19238. "type": "boolean",
  19239. "x-go-name": "AllowCreateOrganization"
  19240. },
  19241. "allow_git_hook": {
  19242. "type": "boolean",
  19243. "x-go-name": "AllowGitHook"
  19244. },
  19245. "allow_import_local": {
  19246. "type": "boolean",
  19247. "x-go-name": "AllowImportLocal"
  19248. },
  19249. "description": {
  19250. "type": "string",
  19251. "x-go-name": "Description"
  19252. },
  19253. "email": {
  19254. "type": "string",
  19255. "format": "email",
  19256. "x-go-name": "Email"
  19257. },
  19258. "full_name": {
  19259. "type": "string",
  19260. "x-go-name": "FullName"
  19261. },
  19262. "location": {
  19263. "type": "string",
  19264. "x-go-name": "Location"
  19265. },
  19266. "login_name": {
  19267. "type": "string",
  19268. "x-go-name": "LoginName"
  19269. },
  19270. "max_repo_creation": {
  19271. "type": "integer",
  19272. "format": "int64",
  19273. "x-go-name": "MaxRepoCreation"
  19274. },
  19275. "must_change_password": {
  19276. "type": "boolean",
  19277. "x-go-name": "MustChangePassword"
  19278. },
  19279. "password": {
  19280. "type": "string",
  19281. "x-go-name": "Password"
  19282. },
  19283. "prohibit_login": {
  19284. "type": "boolean",
  19285. "x-go-name": "ProhibitLogin"
  19286. },
  19287. "restricted": {
  19288. "type": "boolean",
  19289. "x-go-name": "Restricted"
  19290. },
  19291. "source_id": {
  19292. "type": "integer",
  19293. "format": "int64",
  19294. "x-go-name": "SourceID"
  19295. },
  19296. "visibility": {
  19297. "type": "string",
  19298. "x-go-name": "Visibility"
  19299. },
  19300. "website": {
  19301. "type": "string",
  19302. "x-go-name": "Website"
  19303. }
  19304. },
  19305. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19306. },
  19307. "Email": {
  19308. "description": "Email an email address belonging to a user",
  19309. "type": "object",
  19310. "properties": {
  19311. "email": {
  19312. "type": "string",
  19313. "format": "email",
  19314. "x-go-name": "Email"
  19315. },
  19316. "primary": {
  19317. "type": "boolean",
  19318. "x-go-name": "Primary"
  19319. },
  19320. "user_id": {
  19321. "type": "integer",
  19322. "format": "int64",
  19323. "x-go-name": "UserID"
  19324. },
  19325. "username": {
  19326. "type": "string",
  19327. "x-go-name": "UserName"
  19328. },
  19329. "verified": {
  19330. "type": "boolean",
  19331. "x-go-name": "Verified"
  19332. }
  19333. },
  19334. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19335. },
  19336. "ExternalTracker": {
  19337. "description": "ExternalTracker represents settings for external tracker",
  19338. "type": "object",
  19339. "properties": {
  19340. "external_tracker_format": {
  19341. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  19342. "type": "string",
  19343. "x-go-name": "ExternalTrackerFormat"
  19344. },
  19345. "external_tracker_regexp_pattern": {
  19346. "description": "External Issue Tracker issue regular expression",
  19347. "type": "string",
  19348. "x-go-name": "ExternalTrackerRegexpPattern"
  19349. },
  19350. "external_tracker_style": {
  19351. "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
  19352. "type": "string",
  19353. "x-go-name": "ExternalTrackerStyle"
  19354. },
  19355. "external_tracker_url": {
  19356. "description": "URL of external issue tracker.",
  19357. "type": "string",
  19358. "x-go-name": "ExternalTrackerURL"
  19359. }
  19360. },
  19361. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19362. },
  19363. "ExternalWiki": {
  19364. "description": "ExternalWiki represents setting for external wiki",
  19365. "type": "object",
  19366. "properties": {
  19367. "external_wiki_url": {
  19368. "description": "URL of external wiki.",
  19369. "type": "string",
  19370. "x-go-name": "ExternalWikiURL"
  19371. }
  19372. },
  19373. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19374. },
  19375. "FileCommitResponse": {
  19376. "type": "object",
  19377. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  19378. "properties": {
  19379. "author": {
  19380. "$ref": "#/definitions/CommitUser"
  19381. },
  19382. "committer": {
  19383. "$ref": "#/definitions/CommitUser"
  19384. },
  19385. "created": {
  19386. "type": "string",
  19387. "format": "date-time",
  19388. "x-go-name": "Created"
  19389. },
  19390. "html_url": {
  19391. "type": "string",
  19392. "x-go-name": "HTMLURL"
  19393. },
  19394. "message": {
  19395. "type": "string",
  19396. "x-go-name": "Message"
  19397. },
  19398. "parents": {
  19399. "type": "array",
  19400. "items": {
  19401. "$ref": "#/definitions/CommitMeta"
  19402. },
  19403. "x-go-name": "Parents"
  19404. },
  19405. "sha": {
  19406. "type": "string",
  19407. "x-go-name": "SHA"
  19408. },
  19409. "tree": {
  19410. "$ref": "#/definitions/CommitMeta"
  19411. },
  19412. "url": {
  19413. "type": "string",
  19414. "x-go-name": "URL"
  19415. }
  19416. },
  19417. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19418. },
  19419. "FileDeleteResponse": {
  19420. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  19421. "type": "object",
  19422. "properties": {
  19423. "commit": {
  19424. "$ref": "#/definitions/FileCommitResponse"
  19425. },
  19426. "content": {
  19427. "x-go-name": "Content"
  19428. },
  19429. "verification": {
  19430. "$ref": "#/definitions/PayloadCommitVerification"
  19431. }
  19432. },
  19433. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19434. },
  19435. "FileLinksResponse": {
  19436. "description": "FileLinksResponse contains the links for a repo's file",
  19437. "type": "object",
  19438. "properties": {
  19439. "git": {
  19440. "type": "string",
  19441. "x-go-name": "GitURL"
  19442. },
  19443. "html": {
  19444. "type": "string",
  19445. "x-go-name": "HTMLURL"
  19446. },
  19447. "self": {
  19448. "type": "string",
  19449. "x-go-name": "Self"
  19450. }
  19451. },
  19452. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19453. },
  19454. "FileResponse": {
  19455. "description": "FileResponse contains information about a repo's file",
  19456. "type": "object",
  19457. "properties": {
  19458. "commit": {
  19459. "$ref": "#/definitions/FileCommitResponse"
  19460. },
  19461. "content": {
  19462. "$ref": "#/definitions/ContentsResponse"
  19463. },
  19464. "verification": {
  19465. "$ref": "#/definitions/PayloadCommitVerification"
  19466. }
  19467. },
  19468. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19469. },
  19470. "FilesResponse": {
  19471. "description": "FilesResponse contains information about multiple files from a repo",
  19472. "type": "object",
  19473. "properties": {
  19474. "commit": {
  19475. "$ref": "#/definitions/FileCommitResponse"
  19476. },
  19477. "files": {
  19478. "type": "array",
  19479. "items": {
  19480. "$ref": "#/definitions/ContentsResponse"
  19481. },
  19482. "x-go-name": "Files"
  19483. },
  19484. "verification": {
  19485. "$ref": "#/definitions/PayloadCommitVerification"
  19486. }
  19487. },
  19488. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19489. },
  19490. "GPGKey": {
  19491. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  19492. "type": "object",
  19493. "properties": {
  19494. "can_certify": {
  19495. "type": "boolean",
  19496. "x-go-name": "CanCertify"
  19497. },
  19498. "can_encrypt_comms": {
  19499. "type": "boolean",
  19500. "x-go-name": "CanEncryptComms"
  19501. },
  19502. "can_encrypt_storage": {
  19503. "type": "boolean",
  19504. "x-go-name": "CanEncryptStorage"
  19505. },
  19506. "can_sign": {
  19507. "type": "boolean",
  19508. "x-go-name": "CanSign"
  19509. },
  19510. "created_at": {
  19511. "type": "string",
  19512. "format": "date-time",
  19513. "x-go-name": "Created"
  19514. },
  19515. "emails": {
  19516. "type": "array",
  19517. "items": {
  19518. "$ref": "#/definitions/GPGKeyEmail"
  19519. },
  19520. "x-go-name": "Emails"
  19521. },
  19522. "expires_at": {
  19523. "type": "string",
  19524. "format": "date-time",
  19525. "x-go-name": "Expires"
  19526. },
  19527. "id": {
  19528. "type": "integer",
  19529. "format": "int64",
  19530. "x-go-name": "ID"
  19531. },
  19532. "key_id": {
  19533. "type": "string",
  19534. "x-go-name": "KeyID"
  19535. },
  19536. "primary_key_id": {
  19537. "type": "string",
  19538. "x-go-name": "PrimaryKeyID"
  19539. },
  19540. "public_key": {
  19541. "type": "string",
  19542. "x-go-name": "PublicKey"
  19543. },
  19544. "subkeys": {
  19545. "type": "array",
  19546. "items": {
  19547. "$ref": "#/definitions/GPGKey"
  19548. },
  19549. "x-go-name": "SubsKey"
  19550. },
  19551. "verified": {
  19552. "type": "boolean",
  19553. "x-go-name": "Verified"
  19554. }
  19555. },
  19556. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19557. },
  19558. "GPGKeyEmail": {
  19559. "description": "GPGKeyEmail an email attached to a GPGKey",
  19560. "type": "object",
  19561. "properties": {
  19562. "email": {
  19563. "type": "string",
  19564. "x-go-name": "Email"
  19565. },
  19566. "verified": {
  19567. "type": "boolean",
  19568. "x-go-name": "Verified"
  19569. }
  19570. },
  19571. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19572. },
  19573. "GeneralAPISettings": {
  19574. "description": "GeneralAPISettings contains global api settings exposed by it",
  19575. "type": "object",
  19576. "properties": {
  19577. "default_git_trees_per_page": {
  19578. "type": "integer",
  19579. "format": "int64",
  19580. "x-go-name": "DefaultGitTreesPerPage"
  19581. },
  19582. "default_max_blob_size": {
  19583. "type": "integer",
  19584. "format": "int64",
  19585. "x-go-name": "DefaultMaxBlobSize"
  19586. },
  19587. "default_paging_num": {
  19588. "type": "integer",
  19589. "format": "int64",
  19590. "x-go-name": "DefaultPagingNum"
  19591. },
  19592. "max_response_items": {
  19593. "type": "integer",
  19594. "format": "int64",
  19595. "x-go-name": "MaxResponseItems"
  19596. }
  19597. },
  19598. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19599. },
  19600. "GeneralAttachmentSettings": {
  19601. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  19602. "type": "object",
  19603. "properties": {
  19604. "allowed_types": {
  19605. "type": "string",
  19606. "x-go-name": "AllowedTypes"
  19607. },
  19608. "enabled": {
  19609. "type": "boolean",
  19610. "x-go-name": "Enabled"
  19611. },
  19612. "max_files": {
  19613. "type": "integer",
  19614. "format": "int64",
  19615. "x-go-name": "MaxFiles"
  19616. },
  19617. "max_size": {
  19618. "type": "integer",
  19619. "format": "int64",
  19620. "x-go-name": "MaxSize"
  19621. }
  19622. },
  19623. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19624. },
  19625. "GeneralRepoSettings": {
  19626. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  19627. "type": "object",
  19628. "properties": {
  19629. "http_git_disabled": {
  19630. "type": "boolean",
  19631. "x-go-name": "HTTPGitDisabled"
  19632. },
  19633. "lfs_disabled": {
  19634. "type": "boolean",
  19635. "x-go-name": "LFSDisabled"
  19636. },
  19637. "migrations_disabled": {
  19638. "type": "boolean",
  19639. "x-go-name": "MigrationsDisabled"
  19640. },
  19641. "mirrors_disabled": {
  19642. "type": "boolean",
  19643. "x-go-name": "MirrorsDisabled"
  19644. },
  19645. "stars_disabled": {
  19646. "type": "boolean",
  19647. "x-go-name": "StarsDisabled"
  19648. },
  19649. "time_tracking_disabled": {
  19650. "type": "boolean",
  19651. "x-go-name": "TimeTrackingDisabled"
  19652. }
  19653. },
  19654. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19655. },
  19656. "GeneralUISettings": {
  19657. "description": "GeneralUISettings contains global ui settings exposed by API",
  19658. "type": "object",
  19659. "properties": {
  19660. "allowed_reactions": {
  19661. "type": "array",
  19662. "items": {
  19663. "type": "string"
  19664. },
  19665. "x-go-name": "AllowedReactions"
  19666. },
  19667. "custom_emojis": {
  19668. "type": "array",
  19669. "items": {
  19670. "type": "string"
  19671. },
  19672. "x-go-name": "CustomEmojis"
  19673. },
  19674. "default_theme": {
  19675. "type": "string",
  19676. "x-go-name": "DefaultTheme"
  19677. }
  19678. },
  19679. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19680. },
  19681. "GenerateRepoOption": {
  19682. "description": "GenerateRepoOption options when creating repository using a template",
  19683. "type": "object",
  19684. "required": [
  19685. "owner",
  19686. "name"
  19687. ],
  19688. "properties": {
  19689. "avatar": {
  19690. "description": "include avatar of the template repo",
  19691. "type": "boolean",
  19692. "x-go-name": "Avatar"
  19693. },
  19694. "default_branch": {
  19695. "description": "Default branch of the new repository",
  19696. "type": "string",
  19697. "x-go-name": "DefaultBranch"
  19698. },
  19699. "description": {
  19700. "description": "Description of the repository to create",
  19701. "type": "string",
  19702. "x-go-name": "Description"
  19703. },
  19704. "git_content": {
  19705. "description": "include git content of default branch in template repo",
  19706. "type": "boolean",
  19707. "x-go-name": "GitContent"
  19708. },
  19709. "git_hooks": {
  19710. "description": "include git hooks in template repo",
  19711. "type": "boolean",
  19712. "x-go-name": "GitHooks"
  19713. },
  19714. "labels": {
  19715. "description": "include labels in template repo",
  19716. "type": "boolean",
  19717. "x-go-name": "Labels"
  19718. },
  19719. "name": {
  19720. "description": "Name of the repository to create",
  19721. "type": "string",
  19722. "uniqueItems": true,
  19723. "x-go-name": "Name"
  19724. },
  19725. "owner": {
  19726. "description": "The organization or person who will own the new repository",
  19727. "type": "string",
  19728. "x-go-name": "Owner"
  19729. },
  19730. "private": {
  19731. "description": "Whether the repository is private",
  19732. "type": "boolean",
  19733. "x-go-name": "Private"
  19734. },
  19735. "protected_branch": {
  19736. "description": "include protected branches in template repo",
  19737. "type": "boolean",
  19738. "x-go-name": "ProtectedBranch"
  19739. },
  19740. "topics": {
  19741. "description": "include topics in template repo",
  19742. "type": "boolean",
  19743. "x-go-name": "Topics"
  19744. },
  19745. "webhooks": {
  19746. "description": "include webhooks in template repo",
  19747. "type": "boolean",
  19748. "x-go-name": "Webhooks"
  19749. }
  19750. },
  19751. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19752. },
  19753. "GitBlobResponse": {
  19754. "description": "GitBlobResponse represents a git blob",
  19755. "type": "object",
  19756. "properties": {
  19757. "content": {
  19758. "type": "string",
  19759. "x-go-name": "Content"
  19760. },
  19761. "encoding": {
  19762. "type": "string",
  19763. "x-go-name": "Encoding"
  19764. },
  19765. "sha": {
  19766. "type": "string",
  19767. "x-go-name": "SHA"
  19768. },
  19769. "size": {
  19770. "type": "integer",
  19771. "format": "int64",
  19772. "x-go-name": "Size"
  19773. },
  19774. "url": {
  19775. "type": "string",
  19776. "x-go-name": "URL"
  19777. }
  19778. },
  19779. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19780. },
  19781. "GitEntry": {
  19782. "description": "GitEntry represents a git tree",
  19783. "type": "object",
  19784. "properties": {
  19785. "mode": {
  19786. "type": "string",
  19787. "x-go-name": "Mode"
  19788. },
  19789. "path": {
  19790. "type": "string",
  19791. "x-go-name": "Path"
  19792. },
  19793. "sha": {
  19794. "type": "string",
  19795. "x-go-name": "SHA"
  19796. },
  19797. "size": {
  19798. "type": "integer",
  19799. "format": "int64",
  19800. "x-go-name": "Size"
  19801. },
  19802. "type": {
  19803. "type": "string",
  19804. "x-go-name": "Type"
  19805. },
  19806. "url": {
  19807. "type": "string",
  19808. "x-go-name": "URL"
  19809. }
  19810. },
  19811. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19812. },
  19813. "GitHook": {
  19814. "description": "GitHook represents a Git repository hook",
  19815. "type": "object",
  19816. "properties": {
  19817. "content": {
  19818. "type": "string",
  19819. "x-go-name": "Content"
  19820. },
  19821. "is_active": {
  19822. "type": "boolean",
  19823. "x-go-name": "IsActive"
  19824. },
  19825. "name": {
  19826. "type": "string",
  19827. "x-go-name": "Name"
  19828. }
  19829. },
  19830. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19831. },
  19832. "GitObject": {
  19833. "type": "object",
  19834. "title": "GitObject represents a Git object.",
  19835. "properties": {
  19836. "sha": {
  19837. "type": "string",
  19838. "x-go-name": "SHA"
  19839. },
  19840. "type": {
  19841. "type": "string",
  19842. "x-go-name": "Type"
  19843. },
  19844. "url": {
  19845. "type": "string",
  19846. "x-go-name": "URL"
  19847. }
  19848. },
  19849. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19850. },
  19851. "GitTreeResponse": {
  19852. "description": "GitTreeResponse returns a git tree",
  19853. "type": "object",
  19854. "properties": {
  19855. "page": {
  19856. "type": "integer",
  19857. "format": "int64",
  19858. "x-go-name": "Page"
  19859. },
  19860. "sha": {
  19861. "type": "string",
  19862. "x-go-name": "SHA"
  19863. },
  19864. "total_count": {
  19865. "type": "integer",
  19866. "format": "int64",
  19867. "x-go-name": "TotalCount"
  19868. },
  19869. "tree": {
  19870. "type": "array",
  19871. "items": {
  19872. "$ref": "#/definitions/GitEntry"
  19873. },
  19874. "x-go-name": "Entries"
  19875. },
  19876. "truncated": {
  19877. "type": "boolean",
  19878. "x-go-name": "Truncated"
  19879. },
  19880. "url": {
  19881. "type": "string",
  19882. "x-go-name": "URL"
  19883. }
  19884. },
  19885. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19886. },
  19887. "GitignoreTemplateInfo": {
  19888. "description": "GitignoreTemplateInfo name and text of a gitignore template",
  19889. "type": "object",
  19890. "properties": {
  19891. "name": {
  19892. "type": "string",
  19893. "x-go-name": "Name"
  19894. },
  19895. "source": {
  19896. "type": "string",
  19897. "x-go-name": "Source"
  19898. }
  19899. },
  19900. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19901. },
  19902. "Hook": {
  19903. "description": "Hook a hook is a web hook when one repository changed",
  19904. "type": "object",
  19905. "properties": {
  19906. "active": {
  19907. "type": "boolean",
  19908. "x-go-name": "Active"
  19909. },
  19910. "authorization_header": {
  19911. "type": "string",
  19912. "x-go-name": "AuthorizationHeader"
  19913. },
  19914. "branch_filter": {
  19915. "type": "string",
  19916. "x-go-name": "BranchFilter"
  19917. },
  19918. "config": {
  19919. "type": "object",
  19920. "additionalProperties": {
  19921. "type": "string"
  19922. },
  19923. "x-go-name": "Config"
  19924. },
  19925. "created_at": {
  19926. "type": "string",
  19927. "format": "date-time",
  19928. "x-go-name": "Created"
  19929. },
  19930. "events": {
  19931. "type": "array",
  19932. "items": {
  19933. "type": "string"
  19934. },
  19935. "x-go-name": "Events"
  19936. },
  19937. "id": {
  19938. "type": "integer",
  19939. "format": "int64",
  19940. "x-go-name": "ID"
  19941. },
  19942. "type": {
  19943. "type": "string",
  19944. "x-go-name": "Type"
  19945. },
  19946. "updated_at": {
  19947. "type": "string",
  19948. "format": "date-time",
  19949. "x-go-name": "Updated"
  19950. }
  19951. },
  19952. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19953. },
  19954. "Identity": {
  19955. "description": "Identity for a person's identity like an author or committer",
  19956. "type": "object",
  19957. "properties": {
  19958. "email": {
  19959. "type": "string",
  19960. "format": "email",
  19961. "x-go-name": "Email"
  19962. },
  19963. "name": {
  19964. "type": "string",
  19965. "x-go-name": "Name"
  19966. }
  19967. },
  19968. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19969. },
  19970. "InternalTracker": {
  19971. "description": "InternalTracker represents settings for internal tracker",
  19972. "type": "object",
  19973. "properties": {
  19974. "allow_only_contributors_to_track_time": {
  19975. "description": "Let only contributors track time (Built-in issue tracker)",
  19976. "type": "boolean",
  19977. "x-go-name": "AllowOnlyContributorsToTrackTime"
  19978. },
  19979. "enable_issue_dependencies": {
  19980. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  19981. "type": "boolean",
  19982. "x-go-name": "EnableIssueDependencies"
  19983. },
  19984. "enable_time_tracker": {
  19985. "description": "Enable time tracking (Built-in issue tracker)",
  19986. "type": "boolean",
  19987. "x-go-name": "EnableTimeTracker"
  19988. }
  19989. },
  19990. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19991. },
  19992. "Issue": {
  19993. "description": "Issue represents an issue in a repository",
  19994. "type": "object",
  19995. "properties": {
  19996. "assets": {
  19997. "type": "array",
  19998. "items": {
  19999. "$ref": "#/definitions/Attachment"
  20000. },
  20001. "x-go-name": "Attachments"
  20002. },
  20003. "assignee": {
  20004. "$ref": "#/definitions/User"
  20005. },
  20006. "assignees": {
  20007. "type": "array",
  20008. "items": {
  20009. "$ref": "#/definitions/User"
  20010. },
  20011. "x-go-name": "Assignees"
  20012. },
  20013. "body": {
  20014. "type": "string",
  20015. "x-go-name": "Body"
  20016. },
  20017. "closed_at": {
  20018. "type": "string",
  20019. "format": "date-time",
  20020. "x-go-name": "Closed"
  20021. },
  20022. "comments": {
  20023. "type": "integer",
  20024. "format": "int64",
  20025. "x-go-name": "Comments"
  20026. },
  20027. "created_at": {
  20028. "type": "string",
  20029. "format": "date-time",
  20030. "x-go-name": "Created"
  20031. },
  20032. "due_date": {
  20033. "type": "string",
  20034. "format": "date-time",
  20035. "x-go-name": "Deadline"
  20036. },
  20037. "html_url": {
  20038. "type": "string",
  20039. "x-go-name": "HTMLURL"
  20040. },
  20041. "id": {
  20042. "type": "integer",
  20043. "format": "int64",
  20044. "x-go-name": "ID"
  20045. },
  20046. "is_locked": {
  20047. "type": "boolean",
  20048. "x-go-name": "IsLocked"
  20049. },
  20050. "labels": {
  20051. "type": "array",
  20052. "items": {
  20053. "$ref": "#/definitions/Label"
  20054. },
  20055. "x-go-name": "Labels"
  20056. },
  20057. "milestone": {
  20058. "$ref": "#/definitions/Milestone"
  20059. },
  20060. "number": {
  20061. "type": "integer",
  20062. "format": "int64",
  20063. "x-go-name": "Index"
  20064. },
  20065. "original_author": {
  20066. "type": "string",
  20067. "x-go-name": "OriginalAuthor"
  20068. },
  20069. "original_author_id": {
  20070. "type": "integer",
  20071. "format": "int64",
  20072. "x-go-name": "OriginalAuthorID"
  20073. },
  20074. "pin_order": {
  20075. "type": "integer",
  20076. "format": "int64",
  20077. "x-go-name": "PinOrder"
  20078. },
  20079. "pull_request": {
  20080. "$ref": "#/definitions/PullRequestMeta"
  20081. },
  20082. "ref": {
  20083. "type": "string",
  20084. "x-go-name": "Ref"
  20085. },
  20086. "repository": {
  20087. "$ref": "#/definitions/RepositoryMeta"
  20088. },
  20089. "state": {
  20090. "$ref": "#/definitions/StateType"
  20091. },
  20092. "title": {
  20093. "type": "string",
  20094. "x-go-name": "Title"
  20095. },
  20096. "updated_at": {
  20097. "type": "string",
  20098. "format": "date-time",
  20099. "x-go-name": "Updated"
  20100. },
  20101. "url": {
  20102. "type": "string",
  20103. "x-go-name": "URL"
  20104. },
  20105. "user": {
  20106. "$ref": "#/definitions/User"
  20107. }
  20108. },
  20109. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20110. },
  20111. "IssueConfig": {
  20112. "type": "object",
  20113. "properties": {
  20114. "blank_issues_enabled": {
  20115. "type": "boolean",
  20116. "x-go-name": "BlankIssuesEnabled"
  20117. },
  20118. "contact_links": {
  20119. "type": "array",
  20120. "items": {
  20121. "$ref": "#/definitions/IssueConfigContactLink"
  20122. },
  20123. "x-go-name": "ContactLinks"
  20124. }
  20125. },
  20126. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20127. },
  20128. "IssueConfigContactLink": {
  20129. "type": "object",
  20130. "properties": {
  20131. "about": {
  20132. "type": "string",
  20133. "x-go-name": "About"
  20134. },
  20135. "name": {
  20136. "type": "string",
  20137. "x-go-name": "Name"
  20138. },
  20139. "url": {
  20140. "type": "string",
  20141. "x-go-name": "URL"
  20142. }
  20143. },
  20144. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20145. },
  20146. "IssueConfigValidation": {
  20147. "type": "object",
  20148. "properties": {
  20149. "message": {
  20150. "type": "string",
  20151. "x-go-name": "Message"
  20152. },
  20153. "valid": {
  20154. "type": "boolean",
  20155. "x-go-name": "Valid"
  20156. }
  20157. },
  20158. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20159. },
  20160. "IssueDeadline": {
  20161. "description": "IssueDeadline represents an issue deadline",
  20162. "type": "object",
  20163. "properties": {
  20164. "due_date": {
  20165. "type": "string",
  20166. "format": "date-time",
  20167. "x-go-name": "Deadline"
  20168. }
  20169. },
  20170. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20171. },
  20172. "IssueFormField": {
  20173. "description": "IssueFormField represents a form field",
  20174. "type": "object",
  20175. "properties": {
  20176. "attributes": {
  20177. "type": "object",
  20178. "additionalProperties": {},
  20179. "x-go-name": "Attributes"
  20180. },
  20181. "id": {
  20182. "type": "string",
  20183. "x-go-name": "ID"
  20184. },
  20185. "type": {
  20186. "$ref": "#/definitions/IssueFormFieldType"
  20187. },
  20188. "validations": {
  20189. "type": "object",
  20190. "additionalProperties": {},
  20191. "x-go-name": "Validations"
  20192. }
  20193. },
  20194. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20195. },
  20196. "IssueFormFieldType": {
  20197. "type": "string",
  20198. "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
  20199. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20200. },
  20201. "IssueLabelsOption": {
  20202. "description": "IssueLabelsOption a collection of labels",
  20203. "type": "object",
  20204. "properties": {
  20205. "labels": {
  20206. "description": "list of label IDs",
  20207. "type": "array",
  20208. "items": {
  20209. "type": "integer",
  20210. "format": "int64"
  20211. },
  20212. "x-go-name": "Labels"
  20213. }
  20214. },
  20215. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20216. },
  20217. "IssueMeta": {
  20218. "description": "IssueMeta basic issue information",
  20219. "type": "object",
  20220. "properties": {
  20221. "index": {
  20222. "type": "integer",
  20223. "format": "int64",
  20224. "x-go-name": "Index"
  20225. },
  20226. "owner": {
  20227. "type": "string",
  20228. "x-go-name": "Owner"
  20229. },
  20230. "repo": {
  20231. "type": "string",
  20232. "x-go-name": "Name"
  20233. }
  20234. },
  20235. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20236. },
  20237. "IssueTemplate": {
  20238. "description": "IssueTemplate represents an issue template for a repository",
  20239. "type": "object",
  20240. "properties": {
  20241. "about": {
  20242. "type": "string",
  20243. "x-go-name": "About"
  20244. },
  20245. "body": {
  20246. "type": "array",
  20247. "items": {
  20248. "$ref": "#/definitions/IssueFormField"
  20249. },
  20250. "x-go-name": "Fields"
  20251. },
  20252. "content": {
  20253. "type": "string",
  20254. "x-go-name": "Content"
  20255. },
  20256. "file_name": {
  20257. "type": "string",
  20258. "x-go-name": "FileName"
  20259. },
  20260. "labels": {
  20261. "$ref": "#/definitions/IssueTemplateLabels"
  20262. },
  20263. "name": {
  20264. "type": "string",
  20265. "x-go-name": "Name"
  20266. },
  20267. "ref": {
  20268. "type": "string",
  20269. "x-go-name": "Ref"
  20270. },
  20271. "title": {
  20272. "type": "string",
  20273. "x-go-name": "Title"
  20274. }
  20275. },
  20276. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20277. },
  20278. "IssueTemplateLabels": {
  20279. "type": "array",
  20280. "items": {
  20281. "type": "string"
  20282. },
  20283. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20284. },
  20285. "Label": {
  20286. "description": "Label a label to an issue or a pr",
  20287. "type": "object",
  20288. "properties": {
  20289. "color": {
  20290. "type": "string",
  20291. "x-go-name": "Color",
  20292. "example": "00aabb"
  20293. },
  20294. "description": {
  20295. "type": "string",
  20296. "x-go-name": "Description"
  20297. },
  20298. "exclusive": {
  20299. "type": "boolean",
  20300. "x-go-name": "Exclusive",
  20301. "example": false
  20302. },
  20303. "id": {
  20304. "type": "integer",
  20305. "format": "int64",
  20306. "x-go-name": "ID"
  20307. },
  20308. "is_archived": {
  20309. "type": "boolean",
  20310. "x-go-name": "IsArchived",
  20311. "example": false
  20312. },
  20313. "name": {
  20314. "type": "string",
  20315. "x-go-name": "Name"
  20316. },
  20317. "url": {
  20318. "type": "string",
  20319. "x-go-name": "URL"
  20320. }
  20321. },
  20322. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20323. },
  20324. "LabelTemplate": {
  20325. "description": "LabelTemplate info of a Label template",
  20326. "type": "object",
  20327. "properties": {
  20328. "color": {
  20329. "type": "string",
  20330. "x-go-name": "Color",
  20331. "example": "00aabb"
  20332. },
  20333. "description": {
  20334. "type": "string",
  20335. "x-go-name": "Description"
  20336. },
  20337. "exclusive": {
  20338. "type": "boolean",
  20339. "x-go-name": "Exclusive",
  20340. "example": false
  20341. },
  20342. "name": {
  20343. "type": "string",
  20344. "x-go-name": "Name"
  20345. }
  20346. },
  20347. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20348. },
  20349. "LicenseTemplateInfo": {
  20350. "description": "LicensesInfo contains information about a License",
  20351. "type": "object",
  20352. "properties": {
  20353. "body": {
  20354. "type": "string",
  20355. "x-go-name": "Body"
  20356. },
  20357. "implementation": {
  20358. "type": "string",
  20359. "x-go-name": "Implementation"
  20360. },
  20361. "key": {
  20362. "type": "string",
  20363. "x-go-name": "Key"
  20364. },
  20365. "name": {
  20366. "type": "string",
  20367. "x-go-name": "Name"
  20368. },
  20369. "url": {
  20370. "type": "string",
  20371. "x-go-name": "URL"
  20372. }
  20373. },
  20374. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20375. },
  20376. "LicensesTemplateListEntry": {
  20377. "description": "LicensesListEntry is used for the API",
  20378. "type": "object",
  20379. "properties": {
  20380. "key": {
  20381. "type": "string",
  20382. "x-go-name": "Key"
  20383. },
  20384. "name": {
  20385. "type": "string",
  20386. "x-go-name": "Name"
  20387. },
  20388. "url": {
  20389. "type": "string",
  20390. "x-go-name": "URL"
  20391. }
  20392. },
  20393. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20394. },
  20395. "MarkdownOption": {
  20396. "description": "MarkdownOption markdown options",
  20397. "type": "object",
  20398. "properties": {
  20399. "Context": {
  20400. "description": "Context to render\n\nin: body",
  20401. "type": "string"
  20402. },
  20403. "Mode": {
  20404. "description": "Mode to render (comment, gfm, markdown)\n\nin: body",
  20405. "type": "string"
  20406. },
  20407. "Text": {
  20408. "description": "Text markdown to render\n\nin: body",
  20409. "type": "string"
  20410. },
  20411. "Wiki": {
  20412. "description": "Is it a wiki page ?\n\nin: body",
  20413. "type": "boolean"
  20414. }
  20415. },
  20416. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20417. },
  20418. "MarkupOption": {
  20419. "description": "MarkupOption markup options",
  20420. "type": "object",
  20421. "properties": {
  20422. "Context": {
  20423. "description": "Context to render\n\nin: body",
  20424. "type": "string"
  20425. },
  20426. "FilePath": {
  20427. "description": "File path for detecting extension in file mode\n\nin: body",
  20428. "type": "string"
  20429. },
  20430. "Mode": {
  20431. "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body",
  20432. "type": "string"
  20433. },
  20434. "Text": {
  20435. "description": "Text markup to render\n\nin: body",
  20436. "type": "string"
  20437. },
  20438. "Wiki": {
  20439. "description": "Is it a wiki page ?\n\nin: body",
  20440. "type": "boolean"
  20441. }
  20442. },
  20443. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20444. },
  20445. "MergePullRequestOption": {
  20446. "description": "MergePullRequestForm form for merging Pull Request",
  20447. "type": "object",
  20448. "required": [
  20449. "Do"
  20450. ],
  20451. "properties": {
  20452. "Do": {
  20453. "type": "string",
  20454. "enum": [
  20455. "merge",
  20456. "rebase",
  20457. "rebase-merge",
  20458. "squash",
  20459. "manually-merged"
  20460. ]
  20461. },
  20462. "MergeCommitID": {
  20463. "type": "string"
  20464. },
  20465. "MergeMessageField": {
  20466. "type": "string"
  20467. },
  20468. "MergeTitleField": {
  20469. "type": "string"
  20470. },
  20471. "delete_branch_after_merge": {
  20472. "type": "boolean",
  20473. "x-go-name": "DeleteBranchAfterMerge"
  20474. },
  20475. "force_merge": {
  20476. "type": "boolean",
  20477. "x-go-name": "ForceMerge"
  20478. },
  20479. "head_commit_id": {
  20480. "type": "string",
  20481. "x-go-name": "HeadCommitID"
  20482. },
  20483. "merge_when_checks_succeed": {
  20484. "type": "boolean",
  20485. "x-go-name": "MergeWhenChecksSucceed"
  20486. }
  20487. },
  20488. "x-go-name": "MergePullRequestForm",
  20489. "x-go-package": "code.gitea.io/gitea/services/forms"
  20490. },
  20491. "MigrateRepoOptions": {
  20492. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  20493. "type": "object",
  20494. "required": [
  20495. "clone_addr",
  20496. "repo_name"
  20497. ],
  20498. "properties": {
  20499. "auth_password": {
  20500. "type": "string",
  20501. "x-go-name": "AuthPassword"
  20502. },
  20503. "auth_token": {
  20504. "type": "string",
  20505. "x-go-name": "AuthToken"
  20506. },
  20507. "auth_username": {
  20508. "type": "string",
  20509. "x-go-name": "AuthUsername"
  20510. },
  20511. "clone_addr": {
  20512. "type": "string",
  20513. "x-go-name": "CloneAddr"
  20514. },
  20515. "description": {
  20516. "type": "string",
  20517. "x-go-name": "Description"
  20518. },
  20519. "issues": {
  20520. "type": "boolean",
  20521. "x-go-name": "Issues"
  20522. },
  20523. "labels": {
  20524. "type": "boolean",
  20525. "x-go-name": "Labels"
  20526. },
  20527. "lfs": {
  20528. "type": "boolean",
  20529. "x-go-name": "LFS"
  20530. },
  20531. "lfs_endpoint": {
  20532. "type": "string",
  20533. "x-go-name": "LFSEndpoint"
  20534. },
  20535. "milestones": {
  20536. "type": "boolean",
  20537. "x-go-name": "Milestones"
  20538. },
  20539. "mirror": {
  20540. "type": "boolean",
  20541. "x-go-name": "Mirror"
  20542. },
  20543. "mirror_interval": {
  20544. "type": "string",
  20545. "x-go-name": "MirrorInterval"
  20546. },
  20547. "private": {
  20548. "type": "boolean",
  20549. "x-go-name": "Private"
  20550. },
  20551. "pull_requests": {
  20552. "type": "boolean",
  20553. "x-go-name": "PullRequests"
  20554. },
  20555. "releases": {
  20556. "type": "boolean",
  20557. "x-go-name": "Releases"
  20558. },
  20559. "repo_name": {
  20560. "type": "string",
  20561. "x-go-name": "RepoName"
  20562. },
  20563. "repo_owner": {
  20564. "description": "Name of User or Organisation who will own Repo after migration",
  20565. "type": "string",
  20566. "x-go-name": "RepoOwner"
  20567. },
  20568. "service": {
  20569. "type": "string",
  20570. "enum": [
  20571. "git",
  20572. "github",
  20573. "gitea",
  20574. "gitlab",
  20575. "gogs",
  20576. "onedev",
  20577. "gitbucket",
  20578. "codebase"
  20579. ],
  20580. "x-go-name": "Service"
  20581. },
  20582. "uid": {
  20583. "description": "deprecated (only for backwards compatibility)",
  20584. "type": "integer",
  20585. "format": "int64",
  20586. "x-go-name": "RepoOwnerID"
  20587. },
  20588. "wiki": {
  20589. "type": "boolean",
  20590. "x-go-name": "Wiki"
  20591. }
  20592. },
  20593. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20594. },
  20595. "Milestone": {
  20596. "description": "Milestone milestone is a collection of issues on one repository",
  20597. "type": "object",
  20598. "properties": {
  20599. "closed_at": {
  20600. "type": "string",
  20601. "format": "date-time",
  20602. "x-go-name": "Closed"
  20603. },
  20604. "closed_issues": {
  20605. "type": "integer",
  20606. "format": "int64",
  20607. "x-go-name": "ClosedIssues"
  20608. },
  20609. "created_at": {
  20610. "type": "string",
  20611. "format": "date-time",
  20612. "x-go-name": "Created"
  20613. },
  20614. "description": {
  20615. "type": "string",
  20616. "x-go-name": "Description"
  20617. },
  20618. "due_on": {
  20619. "type": "string",
  20620. "format": "date-time",
  20621. "x-go-name": "Deadline"
  20622. },
  20623. "id": {
  20624. "type": "integer",
  20625. "format": "int64",
  20626. "x-go-name": "ID"
  20627. },
  20628. "open_issues": {
  20629. "type": "integer",
  20630. "format": "int64",
  20631. "x-go-name": "OpenIssues"
  20632. },
  20633. "state": {
  20634. "$ref": "#/definitions/StateType"
  20635. },
  20636. "title": {
  20637. "type": "string",
  20638. "x-go-name": "Title"
  20639. },
  20640. "updated_at": {
  20641. "type": "string",
  20642. "format": "date-time",
  20643. "x-go-name": "Updated"
  20644. }
  20645. },
  20646. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20647. },
  20648. "NewIssuePinsAllowed": {
  20649. "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed",
  20650. "type": "object",
  20651. "properties": {
  20652. "issues": {
  20653. "type": "boolean",
  20654. "x-go-name": "Issues"
  20655. },
  20656. "pull_requests": {
  20657. "type": "boolean",
  20658. "x-go-name": "PullRequests"
  20659. }
  20660. },
  20661. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20662. },
  20663. "NodeInfo": {
  20664. "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
  20665. "type": "object",
  20666. "properties": {
  20667. "metadata": {
  20668. "type": "object",
  20669. "x-go-name": "Metadata"
  20670. },
  20671. "openRegistrations": {
  20672. "type": "boolean",
  20673. "x-go-name": "OpenRegistrations"
  20674. },
  20675. "protocols": {
  20676. "type": "array",
  20677. "items": {
  20678. "type": "string"
  20679. },
  20680. "x-go-name": "Protocols"
  20681. },
  20682. "services": {
  20683. "$ref": "#/definitions/NodeInfoServices"
  20684. },
  20685. "software": {
  20686. "$ref": "#/definitions/NodeInfoSoftware"
  20687. },
  20688. "usage": {
  20689. "$ref": "#/definitions/NodeInfoUsage"
  20690. },
  20691. "version": {
  20692. "type": "string",
  20693. "x-go-name": "Version"
  20694. }
  20695. },
  20696. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20697. },
  20698. "NodeInfoServices": {
  20699. "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
  20700. "type": "object",
  20701. "properties": {
  20702. "inbound": {
  20703. "type": "array",
  20704. "items": {
  20705. "type": "string"
  20706. },
  20707. "x-go-name": "Inbound"
  20708. },
  20709. "outbound": {
  20710. "type": "array",
  20711. "items": {
  20712. "type": "string"
  20713. },
  20714. "x-go-name": "Outbound"
  20715. }
  20716. },
  20717. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20718. },
  20719. "NodeInfoSoftware": {
  20720. "description": "NodeInfoSoftware contains Metadata about server software in use",
  20721. "type": "object",
  20722. "properties": {
  20723. "homepage": {
  20724. "type": "string",
  20725. "x-go-name": "Homepage"
  20726. },
  20727. "name": {
  20728. "type": "string",
  20729. "x-go-name": "Name"
  20730. },
  20731. "repository": {
  20732. "type": "string",
  20733. "x-go-name": "Repository"
  20734. },
  20735. "version": {
  20736. "type": "string",
  20737. "x-go-name": "Version"
  20738. }
  20739. },
  20740. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20741. },
  20742. "NodeInfoUsage": {
  20743. "description": "NodeInfoUsage contains usage statistics for this server",
  20744. "type": "object",
  20745. "properties": {
  20746. "localComments": {
  20747. "type": "integer",
  20748. "format": "int64",
  20749. "x-go-name": "LocalComments"
  20750. },
  20751. "localPosts": {
  20752. "type": "integer",
  20753. "format": "int64",
  20754. "x-go-name": "LocalPosts"
  20755. },
  20756. "users": {
  20757. "$ref": "#/definitions/NodeInfoUsageUsers"
  20758. }
  20759. },
  20760. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20761. },
  20762. "NodeInfoUsageUsers": {
  20763. "description": "NodeInfoUsageUsers contains statistics about the users of this server",
  20764. "type": "object",
  20765. "properties": {
  20766. "activeHalfyear": {
  20767. "type": "integer",
  20768. "format": "int64",
  20769. "x-go-name": "ActiveHalfyear"
  20770. },
  20771. "activeMonth": {
  20772. "type": "integer",
  20773. "format": "int64",
  20774. "x-go-name": "ActiveMonth"
  20775. },
  20776. "total": {
  20777. "type": "integer",
  20778. "format": "int64",
  20779. "x-go-name": "Total"
  20780. }
  20781. },
  20782. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20783. },
  20784. "Note": {
  20785. "description": "Note contains information related to a git note",
  20786. "type": "object",
  20787. "properties": {
  20788. "commit": {
  20789. "$ref": "#/definitions/Commit"
  20790. },
  20791. "message": {
  20792. "type": "string",
  20793. "x-go-name": "Message"
  20794. }
  20795. },
  20796. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20797. },
  20798. "NotificationCount": {
  20799. "description": "NotificationCount number of unread notifications",
  20800. "type": "object",
  20801. "properties": {
  20802. "new": {
  20803. "type": "integer",
  20804. "format": "int64",
  20805. "x-go-name": "New"
  20806. }
  20807. },
  20808. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20809. },
  20810. "NotificationSubject": {
  20811. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  20812. "type": "object",
  20813. "properties": {
  20814. "html_url": {
  20815. "type": "string",
  20816. "x-go-name": "HTMLURL"
  20817. },
  20818. "latest_comment_html_url": {
  20819. "type": "string",
  20820. "x-go-name": "LatestCommentHTMLURL"
  20821. },
  20822. "latest_comment_url": {
  20823. "type": "string",
  20824. "x-go-name": "LatestCommentURL"
  20825. },
  20826. "state": {
  20827. "$ref": "#/definitions/StateType"
  20828. },
  20829. "title": {
  20830. "type": "string",
  20831. "x-go-name": "Title"
  20832. },
  20833. "type": {
  20834. "$ref": "#/definitions/NotifySubjectType"
  20835. },
  20836. "url": {
  20837. "type": "string",
  20838. "x-go-name": "URL"
  20839. }
  20840. },
  20841. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20842. },
  20843. "NotificationThread": {
  20844. "description": "NotificationThread expose Notification on API",
  20845. "type": "object",
  20846. "properties": {
  20847. "id": {
  20848. "type": "integer",
  20849. "format": "int64",
  20850. "x-go-name": "ID"
  20851. },
  20852. "pinned": {
  20853. "type": "boolean",
  20854. "x-go-name": "Pinned"
  20855. },
  20856. "repository": {
  20857. "$ref": "#/definitions/Repository"
  20858. },
  20859. "subject": {
  20860. "$ref": "#/definitions/NotificationSubject"
  20861. },
  20862. "unread": {
  20863. "type": "boolean",
  20864. "x-go-name": "Unread"
  20865. },
  20866. "updated_at": {
  20867. "type": "string",
  20868. "format": "date-time",
  20869. "x-go-name": "UpdatedAt"
  20870. },
  20871. "url": {
  20872. "type": "string",
  20873. "x-go-name": "URL"
  20874. }
  20875. },
  20876. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20877. },
  20878. "NotifySubjectType": {
  20879. "description": "NotifySubjectType represent type of notification subject",
  20880. "type": "string",
  20881. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20882. },
  20883. "OAuth2Application": {
  20884. "type": "object",
  20885. "title": "OAuth2Application represents an OAuth2 application.",
  20886. "properties": {
  20887. "client_id": {
  20888. "type": "string",
  20889. "x-go-name": "ClientID"
  20890. },
  20891. "client_secret": {
  20892. "type": "string",
  20893. "x-go-name": "ClientSecret"
  20894. },
  20895. "confidential_client": {
  20896. "type": "boolean",
  20897. "x-go-name": "ConfidentialClient"
  20898. },
  20899. "created": {
  20900. "type": "string",
  20901. "format": "date-time",
  20902. "x-go-name": "Created"
  20903. },
  20904. "id": {
  20905. "type": "integer",
  20906. "format": "int64",
  20907. "x-go-name": "ID"
  20908. },
  20909. "name": {
  20910. "type": "string",
  20911. "x-go-name": "Name"
  20912. },
  20913. "redirect_uris": {
  20914. "type": "array",
  20915. "items": {
  20916. "type": "string"
  20917. },
  20918. "x-go-name": "RedirectURIs"
  20919. }
  20920. },
  20921. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20922. },
  20923. "Organization": {
  20924. "description": "Organization represents an organization",
  20925. "type": "object",
  20926. "properties": {
  20927. "avatar_url": {
  20928. "type": "string",
  20929. "x-go-name": "AvatarURL"
  20930. },
  20931. "description": {
  20932. "type": "string",
  20933. "x-go-name": "Description"
  20934. },
  20935. "email": {
  20936. "type": "string",
  20937. "x-go-name": "Email"
  20938. },
  20939. "full_name": {
  20940. "type": "string",
  20941. "x-go-name": "FullName"
  20942. },
  20943. "id": {
  20944. "type": "integer",
  20945. "format": "int64",
  20946. "x-go-name": "ID"
  20947. },
  20948. "location": {
  20949. "type": "string",
  20950. "x-go-name": "Location"
  20951. },
  20952. "name": {
  20953. "type": "string",
  20954. "x-go-name": "Name"
  20955. },
  20956. "repo_admin_change_team_access": {
  20957. "type": "boolean",
  20958. "x-go-name": "RepoAdminChangeTeamAccess"
  20959. },
  20960. "username": {
  20961. "description": "deprecated",
  20962. "type": "string",
  20963. "x-go-name": "UserName"
  20964. },
  20965. "visibility": {
  20966. "type": "string",
  20967. "x-go-name": "Visibility"
  20968. },
  20969. "website": {
  20970. "type": "string",
  20971. "x-go-name": "Website"
  20972. }
  20973. },
  20974. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20975. },
  20976. "OrganizationPermissions": {
  20977. "description": "OrganizationPermissions list different users permissions on an organization",
  20978. "type": "object",
  20979. "properties": {
  20980. "can_create_repository": {
  20981. "type": "boolean",
  20982. "x-go-name": "CanCreateRepository"
  20983. },
  20984. "can_read": {
  20985. "type": "boolean",
  20986. "x-go-name": "CanRead"
  20987. },
  20988. "can_write": {
  20989. "type": "boolean",
  20990. "x-go-name": "CanWrite"
  20991. },
  20992. "is_admin": {
  20993. "type": "boolean",
  20994. "x-go-name": "IsAdmin"
  20995. },
  20996. "is_owner": {
  20997. "type": "boolean",
  20998. "x-go-name": "IsOwner"
  20999. }
  21000. },
  21001. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21002. },
  21003. "PRBranchInfo": {
  21004. "description": "PRBranchInfo information about a branch",
  21005. "type": "object",
  21006. "properties": {
  21007. "label": {
  21008. "type": "string",
  21009. "x-go-name": "Name"
  21010. },
  21011. "ref": {
  21012. "type": "string",
  21013. "x-go-name": "Ref"
  21014. },
  21015. "repo": {
  21016. "$ref": "#/definitions/Repository"
  21017. },
  21018. "repo_id": {
  21019. "type": "integer",
  21020. "format": "int64",
  21021. "x-go-name": "RepoID"
  21022. },
  21023. "sha": {
  21024. "type": "string",
  21025. "x-go-name": "Sha"
  21026. }
  21027. },
  21028. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21029. },
  21030. "Package": {
  21031. "description": "Package represents a package",
  21032. "type": "object",
  21033. "properties": {
  21034. "created_at": {
  21035. "type": "string",
  21036. "format": "date-time",
  21037. "x-go-name": "CreatedAt"
  21038. },
  21039. "creator": {
  21040. "$ref": "#/definitions/User"
  21041. },
  21042. "html_url": {
  21043. "type": "string",
  21044. "x-go-name": "HTMLURL"
  21045. },
  21046. "id": {
  21047. "type": "integer",
  21048. "format": "int64",
  21049. "x-go-name": "ID"
  21050. },
  21051. "name": {
  21052. "type": "string",
  21053. "x-go-name": "Name"
  21054. },
  21055. "owner": {
  21056. "$ref": "#/definitions/User"
  21057. },
  21058. "repository": {
  21059. "$ref": "#/definitions/Repository"
  21060. },
  21061. "type": {
  21062. "type": "string",
  21063. "x-go-name": "Type"
  21064. },
  21065. "version": {
  21066. "type": "string",
  21067. "x-go-name": "Version"
  21068. }
  21069. },
  21070. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21071. },
  21072. "PackageFile": {
  21073. "description": "PackageFile represents a package file",
  21074. "type": "object",
  21075. "properties": {
  21076. "Size": {
  21077. "type": "integer",
  21078. "format": "int64"
  21079. },
  21080. "id": {
  21081. "type": "integer",
  21082. "format": "int64",
  21083. "x-go-name": "ID"
  21084. },
  21085. "md5": {
  21086. "type": "string",
  21087. "x-go-name": "HashMD5"
  21088. },
  21089. "name": {
  21090. "type": "string",
  21091. "x-go-name": "Name"
  21092. },
  21093. "sha1": {
  21094. "type": "string",
  21095. "x-go-name": "HashSHA1"
  21096. },
  21097. "sha256": {
  21098. "type": "string",
  21099. "x-go-name": "HashSHA256"
  21100. },
  21101. "sha512": {
  21102. "type": "string",
  21103. "x-go-name": "HashSHA512"
  21104. }
  21105. },
  21106. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21107. },
  21108. "PayloadCommit": {
  21109. "description": "PayloadCommit represents a commit",
  21110. "type": "object",
  21111. "properties": {
  21112. "added": {
  21113. "type": "array",
  21114. "items": {
  21115. "type": "string"
  21116. },
  21117. "x-go-name": "Added"
  21118. },
  21119. "author": {
  21120. "$ref": "#/definitions/PayloadUser"
  21121. },
  21122. "committer": {
  21123. "$ref": "#/definitions/PayloadUser"
  21124. },
  21125. "id": {
  21126. "description": "sha1 hash of the commit",
  21127. "type": "string",
  21128. "x-go-name": "ID"
  21129. },
  21130. "message": {
  21131. "type": "string",
  21132. "x-go-name": "Message"
  21133. },
  21134. "modified": {
  21135. "type": "array",
  21136. "items": {
  21137. "type": "string"
  21138. },
  21139. "x-go-name": "Modified"
  21140. },
  21141. "removed": {
  21142. "type": "array",
  21143. "items": {
  21144. "type": "string"
  21145. },
  21146. "x-go-name": "Removed"
  21147. },
  21148. "timestamp": {
  21149. "type": "string",
  21150. "format": "date-time",
  21151. "x-go-name": "Timestamp"
  21152. },
  21153. "url": {
  21154. "type": "string",
  21155. "x-go-name": "URL"
  21156. },
  21157. "verification": {
  21158. "$ref": "#/definitions/PayloadCommitVerification"
  21159. }
  21160. },
  21161. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21162. },
  21163. "PayloadCommitVerification": {
  21164. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  21165. "type": "object",
  21166. "properties": {
  21167. "payload": {
  21168. "type": "string",
  21169. "x-go-name": "Payload"
  21170. },
  21171. "reason": {
  21172. "type": "string",
  21173. "x-go-name": "Reason"
  21174. },
  21175. "signature": {
  21176. "type": "string",
  21177. "x-go-name": "Signature"
  21178. },
  21179. "signer": {
  21180. "$ref": "#/definitions/PayloadUser"
  21181. },
  21182. "verified": {
  21183. "type": "boolean",
  21184. "x-go-name": "Verified"
  21185. }
  21186. },
  21187. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21188. },
  21189. "PayloadUser": {
  21190. "description": "PayloadUser represents the author or committer of a commit",
  21191. "type": "object",
  21192. "properties": {
  21193. "email": {
  21194. "type": "string",
  21195. "format": "email",
  21196. "x-go-name": "Email"
  21197. },
  21198. "name": {
  21199. "description": "Full name of the commit author",
  21200. "type": "string",
  21201. "x-go-name": "Name"
  21202. },
  21203. "username": {
  21204. "type": "string",
  21205. "x-go-name": "UserName"
  21206. }
  21207. },
  21208. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21209. },
  21210. "Permission": {
  21211. "description": "Permission represents a set of permissions",
  21212. "type": "object",
  21213. "properties": {
  21214. "admin": {
  21215. "type": "boolean",
  21216. "x-go-name": "Admin"
  21217. },
  21218. "pull": {
  21219. "type": "boolean",
  21220. "x-go-name": "Pull"
  21221. },
  21222. "push": {
  21223. "type": "boolean",
  21224. "x-go-name": "Push"
  21225. }
  21226. },
  21227. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21228. },
  21229. "PublicKey": {
  21230. "description": "PublicKey publickey is a user key to push code to repository",
  21231. "type": "object",
  21232. "properties": {
  21233. "created_at": {
  21234. "type": "string",
  21235. "format": "date-time",
  21236. "x-go-name": "Created"
  21237. },
  21238. "fingerprint": {
  21239. "type": "string",
  21240. "x-go-name": "Fingerprint"
  21241. },
  21242. "id": {
  21243. "type": "integer",
  21244. "format": "int64",
  21245. "x-go-name": "ID"
  21246. },
  21247. "key": {
  21248. "type": "string",
  21249. "x-go-name": "Key"
  21250. },
  21251. "key_type": {
  21252. "type": "string",
  21253. "x-go-name": "KeyType"
  21254. },
  21255. "read_only": {
  21256. "type": "boolean",
  21257. "x-go-name": "ReadOnly"
  21258. },
  21259. "title": {
  21260. "type": "string",
  21261. "x-go-name": "Title"
  21262. },
  21263. "url": {
  21264. "type": "string",
  21265. "x-go-name": "URL"
  21266. },
  21267. "user": {
  21268. "$ref": "#/definitions/User"
  21269. }
  21270. },
  21271. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21272. },
  21273. "PullRequest": {
  21274. "description": "PullRequest represents a pull request",
  21275. "type": "object",
  21276. "properties": {
  21277. "allow_maintainer_edit": {
  21278. "type": "boolean",
  21279. "x-go-name": "AllowMaintainerEdit"
  21280. },
  21281. "assignee": {
  21282. "$ref": "#/definitions/User"
  21283. },
  21284. "assignees": {
  21285. "type": "array",
  21286. "items": {
  21287. "$ref": "#/definitions/User"
  21288. },
  21289. "x-go-name": "Assignees"
  21290. },
  21291. "base": {
  21292. "$ref": "#/definitions/PRBranchInfo"
  21293. },
  21294. "body": {
  21295. "type": "string",
  21296. "x-go-name": "Body"
  21297. },
  21298. "closed_at": {
  21299. "type": "string",
  21300. "format": "date-time",
  21301. "x-go-name": "Closed"
  21302. },
  21303. "comments": {
  21304. "type": "integer",
  21305. "format": "int64",
  21306. "x-go-name": "Comments"
  21307. },
  21308. "created_at": {
  21309. "type": "string",
  21310. "format": "date-time",
  21311. "x-go-name": "Created"
  21312. },
  21313. "diff_url": {
  21314. "type": "string",
  21315. "x-go-name": "DiffURL"
  21316. },
  21317. "due_date": {
  21318. "type": "string",
  21319. "format": "date-time",
  21320. "x-go-name": "Deadline"
  21321. },
  21322. "head": {
  21323. "$ref": "#/definitions/PRBranchInfo"
  21324. },
  21325. "html_url": {
  21326. "type": "string",
  21327. "x-go-name": "HTMLURL"
  21328. },
  21329. "id": {
  21330. "type": "integer",
  21331. "format": "int64",
  21332. "x-go-name": "ID"
  21333. },
  21334. "is_locked": {
  21335. "type": "boolean",
  21336. "x-go-name": "IsLocked"
  21337. },
  21338. "labels": {
  21339. "type": "array",
  21340. "items": {
  21341. "$ref": "#/definitions/Label"
  21342. },
  21343. "x-go-name": "Labels"
  21344. },
  21345. "merge_base": {
  21346. "type": "string",
  21347. "x-go-name": "MergeBase"
  21348. },
  21349. "merge_commit_sha": {
  21350. "type": "string",
  21351. "x-go-name": "MergedCommitID"
  21352. },
  21353. "mergeable": {
  21354. "type": "boolean",
  21355. "x-go-name": "Mergeable"
  21356. },
  21357. "merged": {
  21358. "type": "boolean",
  21359. "x-go-name": "HasMerged"
  21360. },
  21361. "merged_at": {
  21362. "type": "string",
  21363. "format": "date-time",
  21364. "x-go-name": "Merged"
  21365. },
  21366. "merged_by": {
  21367. "$ref": "#/definitions/User"
  21368. },
  21369. "milestone": {
  21370. "$ref": "#/definitions/Milestone"
  21371. },
  21372. "number": {
  21373. "type": "integer",
  21374. "format": "int64",
  21375. "x-go-name": "Index"
  21376. },
  21377. "patch_url": {
  21378. "type": "string",
  21379. "x-go-name": "PatchURL"
  21380. },
  21381. "pin_order": {
  21382. "type": "integer",
  21383. "format": "int64",
  21384. "x-go-name": "PinOrder"
  21385. },
  21386. "requested_reviewers": {
  21387. "type": "array",
  21388. "items": {
  21389. "$ref": "#/definitions/User"
  21390. },
  21391. "x-go-name": "RequestedReviewers"
  21392. },
  21393. "state": {
  21394. "$ref": "#/definitions/StateType"
  21395. },
  21396. "title": {
  21397. "type": "string",
  21398. "x-go-name": "Title"
  21399. },
  21400. "updated_at": {
  21401. "type": "string",
  21402. "format": "date-time",
  21403. "x-go-name": "Updated"
  21404. },
  21405. "url": {
  21406. "type": "string",
  21407. "x-go-name": "URL"
  21408. },
  21409. "user": {
  21410. "$ref": "#/definitions/User"
  21411. }
  21412. },
  21413. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21414. },
  21415. "PullRequestMeta": {
  21416. "description": "PullRequestMeta PR info if an issue is a PR",
  21417. "type": "object",
  21418. "properties": {
  21419. "merged": {
  21420. "type": "boolean",
  21421. "x-go-name": "HasMerged"
  21422. },
  21423. "merged_at": {
  21424. "type": "string",
  21425. "format": "date-time",
  21426. "x-go-name": "Merged"
  21427. }
  21428. },
  21429. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21430. },
  21431. "PullReview": {
  21432. "description": "PullReview represents a pull request review",
  21433. "type": "object",
  21434. "properties": {
  21435. "body": {
  21436. "type": "string",
  21437. "x-go-name": "Body"
  21438. },
  21439. "comments_count": {
  21440. "type": "integer",
  21441. "format": "int64",
  21442. "x-go-name": "CodeCommentsCount"
  21443. },
  21444. "commit_id": {
  21445. "type": "string",
  21446. "x-go-name": "CommitID"
  21447. },
  21448. "dismissed": {
  21449. "type": "boolean",
  21450. "x-go-name": "Dismissed"
  21451. },
  21452. "html_url": {
  21453. "type": "string",
  21454. "x-go-name": "HTMLURL"
  21455. },
  21456. "id": {
  21457. "type": "integer",
  21458. "format": "int64",
  21459. "x-go-name": "ID"
  21460. },
  21461. "official": {
  21462. "type": "boolean",
  21463. "x-go-name": "Official"
  21464. },
  21465. "pull_request_url": {
  21466. "type": "string",
  21467. "x-go-name": "HTMLPullURL"
  21468. },
  21469. "stale": {
  21470. "type": "boolean",
  21471. "x-go-name": "Stale"
  21472. },
  21473. "state": {
  21474. "$ref": "#/definitions/ReviewStateType"
  21475. },
  21476. "submitted_at": {
  21477. "type": "string",
  21478. "format": "date-time",
  21479. "x-go-name": "Submitted"
  21480. },
  21481. "team": {
  21482. "$ref": "#/definitions/Team"
  21483. },
  21484. "updated_at": {
  21485. "type": "string",
  21486. "format": "date-time",
  21487. "x-go-name": "Updated"
  21488. },
  21489. "user": {
  21490. "$ref": "#/definitions/User"
  21491. }
  21492. },
  21493. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21494. },
  21495. "PullReviewComment": {
  21496. "description": "PullReviewComment represents a comment on a pull request review",
  21497. "type": "object",
  21498. "properties": {
  21499. "body": {
  21500. "type": "string",
  21501. "x-go-name": "Body"
  21502. },
  21503. "commit_id": {
  21504. "type": "string",
  21505. "x-go-name": "CommitID"
  21506. },
  21507. "created_at": {
  21508. "type": "string",
  21509. "format": "date-time",
  21510. "x-go-name": "Created"
  21511. },
  21512. "diff_hunk": {
  21513. "type": "string",
  21514. "x-go-name": "DiffHunk"
  21515. },
  21516. "html_url": {
  21517. "type": "string",
  21518. "x-go-name": "HTMLURL"
  21519. },
  21520. "id": {
  21521. "type": "integer",
  21522. "format": "int64",
  21523. "x-go-name": "ID"
  21524. },
  21525. "original_commit_id": {
  21526. "type": "string",
  21527. "x-go-name": "OrigCommitID"
  21528. },
  21529. "original_position": {
  21530. "type": "integer",
  21531. "format": "uint64",
  21532. "x-go-name": "OldLineNum"
  21533. },
  21534. "path": {
  21535. "type": "string",
  21536. "x-go-name": "Path"
  21537. },
  21538. "position": {
  21539. "type": "integer",
  21540. "format": "uint64",
  21541. "x-go-name": "LineNum"
  21542. },
  21543. "pull_request_review_id": {
  21544. "type": "integer",
  21545. "format": "int64",
  21546. "x-go-name": "ReviewID"
  21547. },
  21548. "pull_request_url": {
  21549. "type": "string",
  21550. "x-go-name": "HTMLPullURL"
  21551. },
  21552. "resolver": {
  21553. "$ref": "#/definitions/User"
  21554. },
  21555. "updated_at": {
  21556. "type": "string",
  21557. "format": "date-time",
  21558. "x-go-name": "Updated"
  21559. },
  21560. "user": {
  21561. "$ref": "#/definitions/User"
  21562. }
  21563. },
  21564. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21565. },
  21566. "PullReviewRequestOptions": {
  21567. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  21568. "type": "object",
  21569. "properties": {
  21570. "reviewers": {
  21571. "type": "array",
  21572. "items": {
  21573. "type": "string"
  21574. },
  21575. "x-go-name": "Reviewers"
  21576. },
  21577. "team_reviewers": {
  21578. "type": "array",
  21579. "items": {
  21580. "type": "string"
  21581. },
  21582. "x-go-name": "TeamReviewers"
  21583. }
  21584. },
  21585. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21586. },
  21587. "PushMirror": {
  21588. "description": "PushMirror represents information of a push mirror",
  21589. "type": "object",
  21590. "properties": {
  21591. "created": {
  21592. "type": "string",
  21593. "x-go-name": "CreatedUnix"
  21594. },
  21595. "interval": {
  21596. "type": "string",
  21597. "x-go-name": "Interval"
  21598. },
  21599. "last_error": {
  21600. "type": "string",
  21601. "x-go-name": "LastError"
  21602. },
  21603. "last_update": {
  21604. "type": "string",
  21605. "x-go-name": "LastUpdateUnix"
  21606. },
  21607. "remote_address": {
  21608. "type": "string",
  21609. "x-go-name": "RemoteAddress"
  21610. },
  21611. "remote_name": {
  21612. "type": "string",
  21613. "x-go-name": "RemoteName"
  21614. },
  21615. "repo_name": {
  21616. "type": "string",
  21617. "x-go-name": "RepoName"
  21618. },
  21619. "sync_on_commit": {
  21620. "type": "boolean",
  21621. "x-go-name": "SyncOnCommit"
  21622. }
  21623. },
  21624. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21625. },
  21626. "Reaction": {
  21627. "description": "Reaction contain one reaction",
  21628. "type": "object",
  21629. "properties": {
  21630. "content": {
  21631. "type": "string",
  21632. "x-go-name": "Reaction"
  21633. },
  21634. "created_at": {
  21635. "type": "string",
  21636. "format": "date-time",
  21637. "x-go-name": "Created"
  21638. },
  21639. "user": {
  21640. "$ref": "#/definitions/User"
  21641. }
  21642. },
  21643. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21644. },
  21645. "Reference": {
  21646. "type": "object",
  21647. "title": "Reference represents a Git reference.",
  21648. "properties": {
  21649. "object": {
  21650. "$ref": "#/definitions/GitObject"
  21651. },
  21652. "ref": {
  21653. "type": "string",
  21654. "x-go-name": "Ref"
  21655. },
  21656. "url": {
  21657. "type": "string",
  21658. "x-go-name": "URL"
  21659. }
  21660. },
  21661. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21662. },
  21663. "Release": {
  21664. "description": "Release represents a repository release",
  21665. "type": "object",
  21666. "properties": {
  21667. "assets": {
  21668. "type": "array",
  21669. "items": {
  21670. "$ref": "#/definitions/Attachment"
  21671. },
  21672. "x-go-name": "Attachments"
  21673. },
  21674. "author": {
  21675. "$ref": "#/definitions/User"
  21676. },
  21677. "body": {
  21678. "type": "string",
  21679. "x-go-name": "Note"
  21680. },
  21681. "created_at": {
  21682. "type": "string",
  21683. "format": "date-time",
  21684. "x-go-name": "CreatedAt"
  21685. },
  21686. "draft": {
  21687. "type": "boolean",
  21688. "x-go-name": "IsDraft"
  21689. },
  21690. "html_url": {
  21691. "type": "string",
  21692. "x-go-name": "HTMLURL"
  21693. },
  21694. "id": {
  21695. "type": "integer",
  21696. "format": "int64",
  21697. "x-go-name": "ID"
  21698. },
  21699. "name": {
  21700. "type": "string",
  21701. "x-go-name": "Title"
  21702. },
  21703. "prerelease": {
  21704. "type": "boolean",
  21705. "x-go-name": "IsPrerelease"
  21706. },
  21707. "published_at": {
  21708. "type": "string",
  21709. "format": "date-time",
  21710. "x-go-name": "PublishedAt"
  21711. },
  21712. "tag_name": {
  21713. "type": "string",
  21714. "x-go-name": "TagName"
  21715. },
  21716. "tarball_url": {
  21717. "type": "string",
  21718. "x-go-name": "TarURL"
  21719. },
  21720. "target_commitish": {
  21721. "type": "string",
  21722. "x-go-name": "Target"
  21723. },
  21724. "upload_url": {
  21725. "type": "string",
  21726. "x-go-name": "UploadURL"
  21727. },
  21728. "url": {
  21729. "type": "string",
  21730. "x-go-name": "URL"
  21731. },
  21732. "zipball_url": {
  21733. "type": "string",
  21734. "x-go-name": "ZipURL"
  21735. }
  21736. },
  21737. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21738. },
  21739. "RenameUserOption": {
  21740. "description": "RenameUserOption options when renaming a user",
  21741. "type": "object",
  21742. "required": [
  21743. "new_username"
  21744. ],
  21745. "properties": {
  21746. "new_username": {
  21747. "description": "New username for this user. This name cannot be in use yet by any other user.",
  21748. "type": "string",
  21749. "uniqueItems": true,
  21750. "x-go-name": "NewName"
  21751. }
  21752. },
  21753. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21754. },
  21755. "RepoCollaboratorPermission": {
  21756. "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
  21757. "type": "object",
  21758. "properties": {
  21759. "permission": {
  21760. "type": "string",
  21761. "x-go-name": "Permission"
  21762. },
  21763. "role_name": {
  21764. "type": "string",
  21765. "x-go-name": "RoleName"
  21766. },
  21767. "user": {
  21768. "$ref": "#/definitions/User"
  21769. }
  21770. },
  21771. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21772. },
  21773. "RepoCommit": {
  21774. "type": "object",
  21775. "title": "RepoCommit contains information of a commit in the context of a repository.",
  21776. "properties": {
  21777. "author": {
  21778. "$ref": "#/definitions/CommitUser"
  21779. },
  21780. "committer": {
  21781. "$ref": "#/definitions/CommitUser"
  21782. },
  21783. "message": {
  21784. "type": "string",
  21785. "x-go-name": "Message"
  21786. },
  21787. "tree": {
  21788. "$ref": "#/definitions/CommitMeta"
  21789. },
  21790. "url": {
  21791. "type": "string",
  21792. "x-go-name": "URL"
  21793. },
  21794. "verification": {
  21795. "$ref": "#/definitions/PayloadCommitVerification"
  21796. }
  21797. },
  21798. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21799. },
  21800. "RepoTopicOptions": {
  21801. "description": "RepoTopicOptions a collection of repo topic names",
  21802. "type": "object",
  21803. "properties": {
  21804. "topics": {
  21805. "description": "list of topic names",
  21806. "type": "array",
  21807. "items": {
  21808. "type": "string"
  21809. },
  21810. "x-go-name": "Topics"
  21811. }
  21812. },
  21813. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21814. },
  21815. "RepoTransfer": {
  21816. "description": "RepoTransfer represents a pending repo transfer",
  21817. "type": "object",
  21818. "properties": {
  21819. "doer": {
  21820. "$ref": "#/definitions/User"
  21821. },
  21822. "recipient": {
  21823. "$ref": "#/definitions/User"
  21824. },
  21825. "teams": {
  21826. "type": "array",
  21827. "items": {
  21828. "$ref": "#/definitions/Team"
  21829. },
  21830. "x-go-name": "Teams"
  21831. }
  21832. },
  21833. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21834. },
  21835. "Repository": {
  21836. "description": "Repository represents a repository",
  21837. "type": "object",
  21838. "properties": {
  21839. "allow_merge_commits": {
  21840. "type": "boolean",
  21841. "x-go-name": "AllowMerge"
  21842. },
  21843. "allow_rebase": {
  21844. "type": "boolean",
  21845. "x-go-name": "AllowRebase"
  21846. },
  21847. "allow_rebase_explicit": {
  21848. "type": "boolean",
  21849. "x-go-name": "AllowRebaseMerge"
  21850. },
  21851. "allow_rebase_update": {
  21852. "type": "boolean",
  21853. "x-go-name": "AllowRebaseUpdate"
  21854. },
  21855. "allow_squash_merge": {
  21856. "type": "boolean",
  21857. "x-go-name": "AllowSquash"
  21858. },
  21859. "archived": {
  21860. "type": "boolean",
  21861. "x-go-name": "Archived"
  21862. },
  21863. "archived_at": {
  21864. "type": "string",
  21865. "format": "date-time",
  21866. "x-go-name": "ArchivedAt"
  21867. },
  21868. "avatar_url": {
  21869. "type": "string",
  21870. "x-go-name": "AvatarURL"
  21871. },
  21872. "clone_url": {
  21873. "type": "string",
  21874. "x-go-name": "CloneURL"
  21875. },
  21876. "created_at": {
  21877. "type": "string",
  21878. "format": "date-time",
  21879. "x-go-name": "Created"
  21880. },
  21881. "default_allow_maintainer_edit": {
  21882. "type": "boolean",
  21883. "x-go-name": "DefaultAllowMaintainerEdit"
  21884. },
  21885. "default_branch": {
  21886. "type": "string",
  21887. "x-go-name": "DefaultBranch"
  21888. },
  21889. "default_delete_branch_after_merge": {
  21890. "type": "boolean",
  21891. "x-go-name": "DefaultDeleteBranchAfterMerge"
  21892. },
  21893. "default_merge_style": {
  21894. "type": "string",
  21895. "x-go-name": "DefaultMergeStyle"
  21896. },
  21897. "description": {
  21898. "type": "string",
  21899. "x-go-name": "Description"
  21900. },
  21901. "empty": {
  21902. "type": "boolean",
  21903. "x-go-name": "Empty"
  21904. },
  21905. "external_tracker": {
  21906. "$ref": "#/definitions/ExternalTracker"
  21907. },
  21908. "external_wiki": {
  21909. "$ref": "#/definitions/ExternalWiki"
  21910. },
  21911. "fork": {
  21912. "type": "boolean",
  21913. "x-go-name": "Fork"
  21914. },
  21915. "forks_count": {
  21916. "type": "integer",
  21917. "format": "int64",
  21918. "x-go-name": "Forks"
  21919. },
  21920. "full_name": {
  21921. "type": "string",
  21922. "x-go-name": "FullName"
  21923. },
  21924. "has_actions": {
  21925. "type": "boolean",
  21926. "x-go-name": "HasActions"
  21927. },
  21928. "has_issues": {
  21929. "type": "boolean",
  21930. "x-go-name": "HasIssues"
  21931. },
  21932. "has_packages": {
  21933. "type": "boolean",
  21934. "x-go-name": "HasPackages"
  21935. },
  21936. "has_projects": {
  21937. "type": "boolean",
  21938. "x-go-name": "HasProjects"
  21939. },
  21940. "has_pull_requests": {
  21941. "type": "boolean",
  21942. "x-go-name": "HasPullRequests"
  21943. },
  21944. "has_releases": {
  21945. "type": "boolean",
  21946. "x-go-name": "HasReleases"
  21947. },
  21948. "has_wiki": {
  21949. "type": "boolean",
  21950. "x-go-name": "HasWiki"
  21951. },
  21952. "html_url": {
  21953. "type": "string",
  21954. "x-go-name": "HTMLURL"
  21955. },
  21956. "id": {
  21957. "type": "integer",
  21958. "format": "int64",
  21959. "x-go-name": "ID"
  21960. },
  21961. "ignore_whitespace_conflicts": {
  21962. "type": "boolean",
  21963. "x-go-name": "IgnoreWhitespaceConflicts"
  21964. },
  21965. "internal": {
  21966. "type": "boolean",
  21967. "x-go-name": "Internal"
  21968. },
  21969. "internal_tracker": {
  21970. "$ref": "#/definitions/InternalTracker"
  21971. },
  21972. "language": {
  21973. "type": "string",
  21974. "x-go-name": "Language"
  21975. },
  21976. "languages_url": {
  21977. "type": "string",
  21978. "x-go-name": "LanguagesURL"
  21979. },
  21980. "link": {
  21981. "type": "string",
  21982. "x-go-name": "Link"
  21983. },
  21984. "mirror": {
  21985. "type": "boolean",
  21986. "x-go-name": "Mirror"
  21987. },
  21988. "mirror_interval": {
  21989. "type": "string",
  21990. "x-go-name": "MirrorInterval"
  21991. },
  21992. "mirror_updated": {
  21993. "type": "string",
  21994. "format": "date-time",
  21995. "x-go-name": "MirrorUpdated"
  21996. },
  21997. "name": {
  21998. "type": "string",
  21999. "x-go-name": "Name"
  22000. },
  22001. "open_issues_count": {
  22002. "type": "integer",
  22003. "format": "int64",
  22004. "x-go-name": "OpenIssues"
  22005. },
  22006. "open_pr_counter": {
  22007. "type": "integer",
  22008. "format": "int64",
  22009. "x-go-name": "OpenPulls"
  22010. },
  22011. "original_url": {
  22012. "type": "string",
  22013. "x-go-name": "OriginalURL"
  22014. },
  22015. "owner": {
  22016. "$ref": "#/definitions/User"
  22017. },
  22018. "parent": {
  22019. "$ref": "#/definitions/Repository"
  22020. },
  22021. "permissions": {
  22022. "$ref": "#/definitions/Permission"
  22023. },
  22024. "private": {
  22025. "type": "boolean",
  22026. "x-go-name": "Private"
  22027. },
  22028. "release_counter": {
  22029. "type": "integer",
  22030. "format": "int64",
  22031. "x-go-name": "Releases"
  22032. },
  22033. "repo_transfer": {
  22034. "$ref": "#/definitions/RepoTransfer"
  22035. },
  22036. "size": {
  22037. "type": "integer",
  22038. "format": "int64",
  22039. "x-go-name": "Size"
  22040. },
  22041. "ssh_url": {
  22042. "type": "string",
  22043. "x-go-name": "SSHURL"
  22044. },
  22045. "stars_count": {
  22046. "type": "integer",
  22047. "format": "int64",
  22048. "x-go-name": "Stars"
  22049. },
  22050. "template": {
  22051. "type": "boolean",
  22052. "x-go-name": "Template"
  22053. },
  22054. "updated_at": {
  22055. "type": "string",
  22056. "format": "date-time",
  22057. "x-go-name": "Updated"
  22058. },
  22059. "url": {
  22060. "type": "string",
  22061. "x-go-name": "URL"
  22062. },
  22063. "watchers_count": {
  22064. "type": "integer",
  22065. "format": "int64",
  22066. "x-go-name": "Watchers"
  22067. },
  22068. "website": {
  22069. "type": "string",
  22070. "x-go-name": "Website"
  22071. }
  22072. },
  22073. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22074. },
  22075. "RepositoryMeta": {
  22076. "description": "RepositoryMeta basic repository information",
  22077. "type": "object",
  22078. "properties": {
  22079. "full_name": {
  22080. "type": "string",
  22081. "x-go-name": "FullName"
  22082. },
  22083. "id": {
  22084. "type": "integer",
  22085. "format": "int64",
  22086. "x-go-name": "ID"
  22087. },
  22088. "name": {
  22089. "type": "string",
  22090. "x-go-name": "Name"
  22091. },
  22092. "owner": {
  22093. "type": "string",
  22094. "x-go-name": "Owner"
  22095. }
  22096. },
  22097. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22098. },
  22099. "ReviewStateType": {
  22100. "description": "ReviewStateType review state type",
  22101. "type": "string",
  22102. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22103. },
  22104. "SearchResults": {
  22105. "description": "SearchResults results of a successful search",
  22106. "type": "object",
  22107. "properties": {
  22108. "data": {
  22109. "type": "array",
  22110. "items": {
  22111. "$ref": "#/definitions/Repository"
  22112. },
  22113. "x-go-name": "Data"
  22114. },
  22115. "ok": {
  22116. "type": "boolean",
  22117. "x-go-name": "OK"
  22118. }
  22119. },
  22120. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22121. },
  22122. "Secret": {
  22123. "description": "Secret represents a secret",
  22124. "type": "object",
  22125. "properties": {
  22126. "created_at": {
  22127. "type": "string",
  22128. "format": "date-time",
  22129. "x-go-name": "Created"
  22130. },
  22131. "name": {
  22132. "description": "the secret's name",
  22133. "type": "string",
  22134. "x-go-name": "Name"
  22135. }
  22136. },
  22137. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22138. },
  22139. "ServerVersion": {
  22140. "description": "ServerVersion wraps the version of the server",
  22141. "type": "object",
  22142. "properties": {
  22143. "version": {
  22144. "type": "string",
  22145. "x-go-name": "Version"
  22146. }
  22147. },
  22148. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22149. },
  22150. "StateType": {
  22151. "description": "StateType issue state type",
  22152. "type": "string",
  22153. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22154. },
  22155. "StopWatch": {
  22156. "description": "StopWatch represent a running stopwatch",
  22157. "type": "object",
  22158. "properties": {
  22159. "created": {
  22160. "type": "string",
  22161. "format": "date-time",
  22162. "x-go-name": "Created"
  22163. },
  22164. "duration": {
  22165. "type": "string",
  22166. "x-go-name": "Duration"
  22167. },
  22168. "issue_index": {
  22169. "type": "integer",
  22170. "format": "int64",
  22171. "x-go-name": "IssueIndex"
  22172. },
  22173. "issue_title": {
  22174. "type": "string",
  22175. "x-go-name": "IssueTitle"
  22176. },
  22177. "repo_name": {
  22178. "type": "string",
  22179. "x-go-name": "RepoName"
  22180. },
  22181. "repo_owner_name": {
  22182. "type": "string",
  22183. "x-go-name": "RepoOwnerName"
  22184. },
  22185. "seconds": {
  22186. "type": "integer",
  22187. "format": "int64",
  22188. "x-go-name": "Seconds"
  22189. }
  22190. },
  22191. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22192. },
  22193. "SubmitPullReviewOptions": {
  22194. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  22195. "type": "object",
  22196. "properties": {
  22197. "body": {
  22198. "type": "string",
  22199. "x-go-name": "Body"
  22200. },
  22201. "event": {
  22202. "$ref": "#/definitions/ReviewStateType"
  22203. }
  22204. },
  22205. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22206. },
  22207. "Tag": {
  22208. "description": "Tag represents a repository tag",
  22209. "type": "object",
  22210. "properties": {
  22211. "commit": {
  22212. "$ref": "#/definitions/CommitMeta"
  22213. },
  22214. "id": {
  22215. "type": "string",
  22216. "x-go-name": "ID"
  22217. },
  22218. "message": {
  22219. "type": "string",
  22220. "x-go-name": "Message"
  22221. },
  22222. "name": {
  22223. "type": "string",
  22224. "x-go-name": "Name"
  22225. },
  22226. "tarball_url": {
  22227. "type": "string",
  22228. "x-go-name": "TarballURL"
  22229. },
  22230. "zipball_url": {
  22231. "type": "string",
  22232. "x-go-name": "ZipballURL"
  22233. }
  22234. },
  22235. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22236. },
  22237. "Team": {
  22238. "description": "Team represents a team in an organization",
  22239. "type": "object",
  22240. "properties": {
  22241. "can_create_org_repo": {
  22242. "type": "boolean",
  22243. "x-go-name": "CanCreateOrgRepo"
  22244. },
  22245. "description": {
  22246. "type": "string",
  22247. "x-go-name": "Description"
  22248. },
  22249. "id": {
  22250. "type": "integer",
  22251. "format": "int64",
  22252. "x-go-name": "ID"
  22253. },
  22254. "includes_all_repositories": {
  22255. "type": "boolean",
  22256. "x-go-name": "IncludesAllRepositories"
  22257. },
  22258. "name": {
  22259. "type": "string",
  22260. "x-go-name": "Name"
  22261. },
  22262. "organization": {
  22263. "$ref": "#/definitions/Organization"
  22264. },
  22265. "permission": {
  22266. "type": "string",
  22267. "enum": [
  22268. "none",
  22269. "read",
  22270. "write",
  22271. "admin",
  22272. "owner"
  22273. ],
  22274. "x-go-name": "Permission"
  22275. },
  22276. "units": {
  22277. "type": "array",
  22278. "items": {
  22279. "type": "string"
  22280. },
  22281. "x-go-name": "Units",
  22282. "example": [
  22283. "repo.code",
  22284. "repo.issues",
  22285. "repo.ext_issues",
  22286. "repo.wiki",
  22287. "repo.pulls",
  22288. "repo.releases",
  22289. "repo.projects",
  22290. "repo.ext_wiki"
  22291. ]
  22292. },
  22293. "units_map": {
  22294. "type": "object",
  22295. "additionalProperties": {
  22296. "type": "string"
  22297. },
  22298. "x-go-name": "UnitsMap",
  22299. "example": {
  22300. "repo.code": "read",
  22301. "repo.ext_issues": "none",
  22302. "repo.ext_wiki": "none",
  22303. "repo.issues": "write",
  22304. "repo.projects": "none",
  22305. "repo.pulls": "owner",
  22306. "repo.releases": "none",
  22307. "repo.wiki": "admin"
  22308. }
  22309. }
  22310. },
  22311. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22312. },
  22313. "TimeStamp": {
  22314. "description": "TimeStamp defines a timestamp",
  22315. "type": "integer",
  22316. "format": "int64",
  22317. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  22318. },
  22319. "TimelineComment": {
  22320. "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
  22321. "type": "object",
  22322. "properties": {
  22323. "assignee": {
  22324. "$ref": "#/definitions/User"
  22325. },
  22326. "assignee_team": {
  22327. "$ref": "#/definitions/Team"
  22328. },
  22329. "body": {
  22330. "type": "string",
  22331. "x-go-name": "Body"
  22332. },
  22333. "created_at": {
  22334. "type": "string",
  22335. "format": "date-time",
  22336. "x-go-name": "Created"
  22337. },
  22338. "dependent_issue": {
  22339. "$ref": "#/definitions/Issue"
  22340. },
  22341. "html_url": {
  22342. "type": "string",
  22343. "x-go-name": "HTMLURL"
  22344. },
  22345. "id": {
  22346. "type": "integer",
  22347. "format": "int64",
  22348. "x-go-name": "ID"
  22349. },
  22350. "issue_url": {
  22351. "type": "string",
  22352. "x-go-name": "IssueURL"
  22353. },
  22354. "label": {
  22355. "$ref": "#/definitions/Label"
  22356. },
  22357. "milestone": {
  22358. "$ref": "#/definitions/Milestone"
  22359. },
  22360. "new_ref": {
  22361. "type": "string",
  22362. "x-go-name": "NewRef"
  22363. },
  22364. "new_title": {
  22365. "type": "string",
  22366. "x-go-name": "NewTitle"
  22367. },
  22368. "old_milestone": {
  22369. "$ref": "#/definitions/Milestone"
  22370. },
  22371. "old_project_id": {
  22372. "type": "integer",
  22373. "format": "int64",
  22374. "x-go-name": "OldProjectID"
  22375. },
  22376. "old_ref": {
  22377. "type": "string",
  22378. "x-go-name": "OldRef"
  22379. },
  22380. "old_title": {
  22381. "type": "string",
  22382. "x-go-name": "OldTitle"
  22383. },
  22384. "project_id": {
  22385. "type": "integer",
  22386. "format": "int64",
  22387. "x-go-name": "ProjectID"
  22388. },
  22389. "pull_request_url": {
  22390. "type": "string",
  22391. "x-go-name": "PRURL"
  22392. },
  22393. "ref_action": {
  22394. "type": "string",
  22395. "x-go-name": "RefAction"
  22396. },
  22397. "ref_comment": {
  22398. "$ref": "#/definitions/Comment"
  22399. },
  22400. "ref_commit_sha": {
  22401. "description": "commit SHA where issue/PR was referenced",
  22402. "type": "string",
  22403. "x-go-name": "RefCommitSHA"
  22404. },
  22405. "ref_issue": {
  22406. "$ref": "#/definitions/Issue"
  22407. },
  22408. "removed_assignee": {
  22409. "description": "whether the assignees were removed or added",
  22410. "type": "boolean",
  22411. "x-go-name": "RemovedAssignee"
  22412. },
  22413. "resolve_doer": {
  22414. "$ref": "#/definitions/User"
  22415. },
  22416. "review_id": {
  22417. "type": "integer",
  22418. "format": "int64",
  22419. "x-go-name": "ReviewID"
  22420. },
  22421. "tracked_time": {
  22422. "$ref": "#/definitions/TrackedTime"
  22423. },
  22424. "type": {
  22425. "type": "string",
  22426. "x-go-name": "Type"
  22427. },
  22428. "updated_at": {
  22429. "type": "string",
  22430. "format": "date-time",
  22431. "x-go-name": "Updated"
  22432. },
  22433. "user": {
  22434. "$ref": "#/definitions/User"
  22435. }
  22436. },
  22437. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22438. },
  22439. "TopicName": {
  22440. "description": "TopicName a list of repo topic names",
  22441. "type": "object",
  22442. "properties": {
  22443. "topics": {
  22444. "type": "array",
  22445. "items": {
  22446. "type": "string"
  22447. },
  22448. "x-go-name": "TopicNames"
  22449. }
  22450. },
  22451. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22452. },
  22453. "TopicResponse": {
  22454. "description": "TopicResponse for returning topics",
  22455. "type": "object",
  22456. "properties": {
  22457. "created": {
  22458. "type": "string",
  22459. "format": "date-time",
  22460. "x-go-name": "Created"
  22461. },
  22462. "id": {
  22463. "type": "integer",
  22464. "format": "int64",
  22465. "x-go-name": "ID"
  22466. },
  22467. "repo_count": {
  22468. "type": "integer",
  22469. "format": "int64",
  22470. "x-go-name": "RepoCount"
  22471. },
  22472. "topic_name": {
  22473. "type": "string",
  22474. "x-go-name": "Name"
  22475. },
  22476. "updated": {
  22477. "type": "string",
  22478. "format": "date-time",
  22479. "x-go-name": "Updated"
  22480. }
  22481. },
  22482. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22483. },
  22484. "TrackedTime": {
  22485. "description": "TrackedTime worked time for an issue / pr",
  22486. "type": "object",
  22487. "properties": {
  22488. "created": {
  22489. "type": "string",
  22490. "format": "date-time",
  22491. "x-go-name": "Created"
  22492. },
  22493. "id": {
  22494. "type": "integer",
  22495. "format": "int64",
  22496. "x-go-name": "ID"
  22497. },
  22498. "issue": {
  22499. "$ref": "#/definitions/Issue"
  22500. },
  22501. "issue_id": {
  22502. "description": "deprecated (only for backwards compatibility)",
  22503. "type": "integer",
  22504. "format": "int64",
  22505. "x-go-name": "IssueID"
  22506. },
  22507. "time": {
  22508. "description": "Time in seconds",
  22509. "type": "integer",
  22510. "format": "int64",
  22511. "x-go-name": "Time"
  22512. },
  22513. "user_id": {
  22514. "description": "deprecated (only for backwards compatibility)",
  22515. "type": "integer",
  22516. "format": "int64",
  22517. "x-go-name": "UserID"
  22518. },
  22519. "user_name": {
  22520. "type": "string",
  22521. "x-go-name": "UserName"
  22522. }
  22523. },
  22524. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22525. },
  22526. "TransferRepoOption": {
  22527. "description": "TransferRepoOption options when transfer a repository's ownership",
  22528. "type": "object",
  22529. "required": [
  22530. "new_owner"
  22531. ],
  22532. "properties": {
  22533. "new_owner": {
  22534. "type": "string",
  22535. "x-go-name": "NewOwner"
  22536. },
  22537. "team_ids": {
  22538. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  22539. "type": "array",
  22540. "items": {
  22541. "type": "integer",
  22542. "format": "int64"
  22543. },
  22544. "x-go-name": "TeamIDs"
  22545. }
  22546. },
  22547. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22548. },
  22549. "UpdateFileOptions": {
  22550. "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)",
  22551. "type": "object",
  22552. "required": [
  22553. "sha",
  22554. "content"
  22555. ],
  22556. "properties": {
  22557. "author": {
  22558. "$ref": "#/definitions/Identity"
  22559. },
  22560. "branch": {
  22561. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  22562. "type": "string",
  22563. "x-go-name": "BranchName"
  22564. },
  22565. "committer": {
  22566. "$ref": "#/definitions/Identity"
  22567. },
  22568. "content": {
  22569. "description": "content must be base64 encoded",
  22570. "type": "string",
  22571. "x-go-name": "ContentBase64"
  22572. },
  22573. "dates": {
  22574. "$ref": "#/definitions/CommitDateOptions"
  22575. },
  22576. "from_path": {
  22577. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  22578. "type": "string",
  22579. "x-go-name": "FromPath"
  22580. },
  22581. "message": {
  22582. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  22583. "type": "string",
  22584. "x-go-name": "Message"
  22585. },
  22586. "new_branch": {
  22587. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  22588. "type": "string",
  22589. "x-go-name": "NewBranchName"
  22590. },
  22591. "sha": {
  22592. "description": "sha is the SHA for the file that already exists",
  22593. "type": "string",
  22594. "x-go-name": "SHA"
  22595. },
  22596. "signoff": {
  22597. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  22598. "type": "boolean",
  22599. "x-go-name": "Signoff"
  22600. }
  22601. },
  22602. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22603. },
  22604. "UpdateRepoAvatarOption": {
  22605. "description": "UpdateRepoAvatarUserOption options when updating the repo avatar",
  22606. "type": "object",
  22607. "properties": {
  22608. "image": {
  22609. "description": "image must be base64 encoded",
  22610. "type": "string",
  22611. "x-go-name": "Image"
  22612. }
  22613. },
  22614. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22615. },
  22616. "UpdateUserAvatarOption": {
  22617. "description": "UpdateUserAvatarUserOption options when updating the user avatar",
  22618. "type": "object",
  22619. "properties": {
  22620. "image": {
  22621. "description": "image must be base64 encoded",
  22622. "type": "string",
  22623. "x-go-name": "Image"
  22624. }
  22625. },
  22626. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22627. },
  22628. "User": {
  22629. "description": "User represents a user",
  22630. "type": "object",
  22631. "properties": {
  22632. "active": {
  22633. "description": "Is user active",
  22634. "type": "boolean",
  22635. "x-go-name": "IsActive"
  22636. },
  22637. "avatar_url": {
  22638. "description": "URL to the user's avatar",
  22639. "type": "string",
  22640. "x-go-name": "AvatarURL"
  22641. },
  22642. "created": {
  22643. "type": "string",
  22644. "format": "date-time",
  22645. "x-go-name": "Created"
  22646. },
  22647. "description": {
  22648. "description": "the user's description",
  22649. "type": "string",
  22650. "x-go-name": "Description"
  22651. },
  22652. "email": {
  22653. "type": "string",
  22654. "format": "email",
  22655. "x-go-name": "Email"
  22656. },
  22657. "followers_count": {
  22658. "description": "user counts",
  22659. "type": "integer",
  22660. "format": "int64",
  22661. "x-go-name": "Followers"
  22662. },
  22663. "following_count": {
  22664. "type": "integer",
  22665. "format": "int64",
  22666. "x-go-name": "Following"
  22667. },
  22668. "full_name": {
  22669. "description": "the user's full name",
  22670. "type": "string",
  22671. "x-go-name": "FullName"
  22672. },
  22673. "id": {
  22674. "description": "the user's id",
  22675. "type": "integer",
  22676. "format": "int64",
  22677. "x-go-name": "ID"
  22678. },
  22679. "is_admin": {
  22680. "description": "Is the user an administrator",
  22681. "type": "boolean",
  22682. "x-go-name": "IsAdmin"
  22683. },
  22684. "language": {
  22685. "description": "User locale",
  22686. "type": "string",
  22687. "x-go-name": "Language"
  22688. },
  22689. "last_login": {
  22690. "type": "string",
  22691. "format": "date-time",
  22692. "x-go-name": "LastLogin"
  22693. },
  22694. "location": {
  22695. "description": "the user's location",
  22696. "type": "string",
  22697. "x-go-name": "Location"
  22698. },
  22699. "login": {
  22700. "description": "the user's username",
  22701. "type": "string",
  22702. "x-go-name": "UserName"
  22703. },
  22704. "login_name": {
  22705. "description": "the user's authentication sign-in name.",
  22706. "type": "string",
  22707. "default": "empty",
  22708. "x-go-name": "LoginName"
  22709. },
  22710. "prohibit_login": {
  22711. "description": "Is user login prohibited",
  22712. "type": "boolean",
  22713. "x-go-name": "ProhibitLogin"
  22714. },
  22715. "restricted": {
  22716. "description": "Is user restricted",
  22717. "type": "boolean",
  22718. "x-go-name": "Restricted"
  22719. },
  22720. "starred_repos_count": {
  22721. "type": "integer",
  22722. "format": "int64",
  22723. "x-go-name": "StarredRepos"
  22724. },
  22725. "visibility": {
  22726. "description": "User visibility level option: public, limited, private",
  22727. "type": "string",
  22728. "x-go-name": "Visibility"
  22729. },
  22730. "website": {
  22731. "description": "the user's website",
  22732. "type": "string",
  22733. "x-go-name": "Website"
  22734. }
  22735. },
  22736. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22737. },
  22738. "UserHeatmapData": {
  22739. "description": "UserHeatmapData represents the data needed to create a heatmap",
  22740. "type": "object",
  22741. "properties": {
  22742. "contributions": {
  22743. "type": "integer",
  22744. "format": "int64",
  22745. "x-go-name": "Contributions"
  22746. },
  22747. "timestamp": {
  22748. "$ref": "#/definitions/TimeStamp"
  22749. }
  22750. },
  22751. "x-go-package": "code.gitea.io/gitea/models/activities"
  22752. },
  22753. "UserSettings": {
  22754. "description": "UserSettings represents user settings",
  22755. "type": "object",
  22756. "properties": {
  22757. "description": {
  22758. "type": "string",
  22759. "x-go-name": "Description"
  22760. },
  22761. "diff_view_style": {
  22762. "type": "string",
  22763. "x-go-name": "DiffViewStyle"
  22764. },
  22765. "full_name": {
  22766. "type": "string",
  22767. "x-go-name": "FullName"
  22768. },
  22769. "hide_activity": {
  22770. "type": "boolean",
  22771. "x-go-name": "HideActivity"
  22772. },
  22773. "hide_email": {
  22774. "description": "Privacy",
  22775. "type": "boolean",
  22776. "x-go-name": "HideEmail"
  22777. },
  22778. "language": {
  22779. "type": "string",
  22780. "x-go-name": "Language"
  22781. },
  22782. "location": {
  22783. "type": "string",
  22784. "x-go-name": "Location"
  22785. },
  22786. "theme": {
  22787. "type": "string",
  22788. "x-go-name": "Theme"
  22789. },
  22790. "website": {
  22791. "type": "string",
  22792. "x-go-name": "Website"
  22793. }
  22794. },
  22795. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22796. },
  22797. "UserSettingsOptions": {
  22798. "description": "UserSettingsOptions represents options to change user settings",
  22799. "type": "object",
  22800. "properties": {
  22801. "description": {
  22802. "type": "string",
  22803. "x-go-name": "Description"
  22804. },
  22805. "diff_view_style": {
  22806. "type": "string",
  22807. "x-go-name": "DiffViewStyle"
  22808. },
  22809. "full_name": {
  22810. "type": "string",
  22811. "x-go-name": "FullName"
  22812. },
  22813. "hide_activity": {
  22814. "type": "boolean",
  22815. "x-go-name": "HideActivity"
  22816. },
  22817. "hide_email": {
  22818. "description": "Privacy",
  22819. "type": "boolean",
  22820. "x-go-name": "HideEmail"
  22821. },
  22822. "language": {
  22823. "type": "string",
  22824. "x-go-name": "Language"
  22825. },
  22826. "location": {
  22827. "type": "string",
  22828. "x-go-name": "Location"
  22829. },
  22830. "theme": {
  22831. "type": "string",
  22832. "x-go-name": "Theme"
  22833. },
  22834. "website": {
  22835. "type": "string",
  22836. "x-go-name": "Website"
  22837. }
  22838. },
  22839. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22840. },
  22841. "WatchInfo": {
  22842. "description": "WatchInfo represents an API watch status of one repository",
  22843. "type": "object",
  22844. "properties": {
  22845. "created_at": {
  22846. "type": "string",
  22847. "format": "date-time",
  22848. "x-go-name": "CreatedAt"
  22849. },
  22850. "ignored": {
  22851. "type": "boolean",
  22852. "x-go-name": "Ignored"
  22853. },
  22854. "reason": {
  22855. "x-go-name": "Reason"
  22856. },
  22857. "repository_url": {
  22858. "type": "string",
  22859. "x-go-name": "RepositoryURL"
  22860. },
  22861. "subscribed": {
  22862. "type": "boolean",
  22863. "x-go-name": "Subscribed"
  22864. },
  22865. "url": {
  22866. "type": "string",
  22867. "x-go-name": "URL"
  22868. }
  22869. },
  22870. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22871. },
  22872. "WikiCommit": {
  22873. "description": "WikiCommit page commit/revision",
  22874. "type": "object",
  22875. "properties": {
  22876. "author": {
  22877. "$ref": "#/definitions/CommitUser"
  22878. },
  22879. "commiter": {
  22880. "$ref": "#/definitions/CommitUser"
  22881. },
  22882. "message": {
  22883. "type": "string",
  22884. "x-go-name": "Message"
  22885. },
  22886. "sha": {
  22887. "type": "string",
  22888. "x-go-name": "ID"
  22889. }
  22890. },
  22891. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22892. },
  22893. "WikiCommitList": {
  22894. "description": "WikiCommitList commit/revision list",
  22895. "type": "object",
  22896. "properties": {
  22897. "commits": {
  22898. "type": "array",
  22899. "items": {
  22900. "$ref": "#/definitions/WikiCommit"
  22901. },
  22902. "x-go-name": "WikiCommits"
  22903. },
  22904. "count": {
  22905. "type": "integer",
  22906. "format": "int64",
  22907. "x-go-name": "Count"
  22908. }
  22909. },
  22910. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22911. },
  22912. "WikiPage": {
  22913. "description": "WikiPage a wiki page",
  22914. "type": "object",
  22915. "properties": {
  22916. "commit_count": {
  22917. "type": "integer",
  22918. "format": "int64",
  22919. "x-go-name": "CommitCount"
  22920. },
  22921. "content_base64": {
  22922. "description": "Page content, base64 encoded",
  22923. "type": "string",
  22924. "x-go-name": "ContentBase64"
  22925. },
  22926. "footer": {
  22927. "type": "string",
  22928. "x-go-name": "Footer"
  22929. },
  22930. "html_url": {
  22931. "type": "string",
  22932. "x-go-name": "HTMLURL"
  22933. },
  22934. "last_commit": {
  22935. "$ref": "#/definitions/WikiCommit"
  22936. },
  22937. "sidebar": {
  22938. "type": "string",
  22939. "x-go-name": "Sidebar"
  22940. },
  22941. "sub_url": {
  22942. "type": "string",
  22943. "x-go-name": "SubURL"
  22944. },
  22945. "title": {
  22946. "type": "string",
  22947. "x-go-name": "Title"
  22948. }
  22949. },
  22950. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22951. },
  22952. "WikiPageMetaData": {
  22953. "description": "WikiPageMetaData wiki page meta information",
  22954. "type": "object",
  22955. "properties": {
  22956. "html_url": {
  22957. "type": "string",
  22958. "x-go-name": "HTMLURL"
  22959. },
  22960. "last_commit": {
  22961. "$ref": "#/definitions/WikiCommit"
  22962. },
  22963. "sub_url": {
  22964. "type": "string",
  22965. "x-go-name": "SubURL"
  22966. },
  22967. "title": {
  22968. "type": "string",
  22969. "x-go-name": "Title"
  22970. }
  22971. },
  22972. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22973. }
  22974. },
  22975. "responses": {
  22976. "AccessToken": {
  22977. "description": "AccessToken represents an API access token.",
  22978. "schema": {
  22979. "$ref": "#/definitions/AccessToken"
  22980. }
  22981. },
  22982. "AccessTokenList": {
  22983. "description": "AccessTokenList represents a list of API access token.",
  22984. "schema": {
  22985. "type": "array",
  22986. "items": {
  22987. "$ref": "#/definitions/AccessToken"
  22988. }
  22989. }
  22990. },
  22991. "ActivityFeedsList": {
  22992. "description": "ActivityFeedsList",
  22993. "schema": {
  22994. "type": "array",
  22995. "items": {
  22996. "$ref": "#/definitions/Activity"
  22997. }
  22998. }
  22999. },
  23000. "ActivityPub": {
  23001. "description": "ActivityPub",
  23002. "schema": {
  23003. "$ref": "#/definitions/ActivityPub"
  23004. }
  23005. },
  23006. "AnnotatedTag": {
  23007. "description": "AnnotatedTag",
  23008. "schema": {
  23009. "$ref": "#/definitions/AnnotatedTag"
  23010. }
  23011. },
  23012. "Attachment": {
  23013. "description": "Attachment",
  23014. "schema": {
  23015. "$ref": "#/definitions/Attachment"
  23016. }
  23017. },
  23018. "AttachmentList": {
  23019. "description": "AttachmentList",
  23020. "schema": {
  23021. "type": "array",
  23022. "items": {
  23023. "$ref": "#/definitions/Attachment"
  23024. }
  23025. }
  23026. },
  23027. "Branch": {
  23028. "description": "Branch",
  23029. "schema": {
  23030. "$ref": "#/definitions/Branch"
  23031. }
  23032. },
  23033. "BranchList": {
  23034. "description": "BranchList",
  23035. "schema": {
  23036. "type": "array",
  23037. "items": {
  23038. "$ref": "#/definitions/Branch"
  23039. }
  23040. }
  23041. },
  23042. "BranchProtection": {
  23043. "description": "BranchProtection",
  23044. "schema": {
  23045. "$ref": "#/definitions/BranchProtection"
  23046. }
  23047. },
  23048. "BranchProtectionList": {
  23049. "description": "BranchProtectionList",
  23050. "schema": {
  23051. "type": "array",
  23052. "items": {
  23053. "$ref": "#/definitions/BranchProtection"
  23054. }
  23055. }
  23056. },
  23057. "ChangedFileList": {
  23058. "description": "ChangedFileList",
  23059. "schema": {
  23060. "type": "array",
  23061. "items": {
  23062. "$ref": "#/definitions/ChangedFile"
  23063. }
  23064. },
  23065. "headers": {
  23066. "X-HasMore": {
  23067. "type": "boolean",
  23068. "description": "True if there is another page"
  23069. },
  23070. "X-Page": {
  23071. "type": "integer",
  23072. "format": "int64",
  23073. "description": "The current page"
  23074. },
  23075. "X-PageCount": {
  23076. "type": "integer",
  23077. "format": "int64",
  23078. "description": "Total number of pages"
  23079. },
  23080. "X-PerPage": {
  23081. "type": "integer",
  23082. "format": "int64",
  23083. "description": "Commits per page"
  23084. },
  23085. "X-Total": {
  23086. "type": "integer",
  23087. "format": "int64",
  23088. "description": "Total commit count"
  23089. }
  23090. }
  23091. },
  23092. "CombinedStatus": {
  23093. "description": "CombinedStatus",
  23094. "schema": {
  23095. "$ref": "#/definitions/CombinedStatus"
  23096. }
  23097. },
  23098. "Comment": {
  23099. "description": "Comment",
  23100. "schema": {
  23101. "$ref": "#/definitions/Comment"
  23102. }
  23103. },
  23104. "CommentList": {
  23105. "description": "CommentList",
  23106. "schema": {
  23107. "type": "array",
  23108. "items": {
  23109. "$ref": "#/definitions/Comment"
  23110. }
  23111. }
  23112. },
  23113. "Commit": {
  23114. "description": "Commit",
  23115. "schema": {
  23116. "$ref": "#/definitions/Commit"
  23117. }
  23118. },
  23119. "CommitList": {
  23120. "description": "CommitList",
  23121. "schema": {
  23122. "type": "array",
  23123. "items": {
  23124. "$ref": "#/definitions/Commit"
  23125. }
  23126. },
  23127. "headers": {
  23128. "X-HasMore": {
  23129. "type": "boolean",
  23130. "description": "True if there is another page"
  23131. },
  23132. "X-Page": {
  23133. "type": "integer",
  23134. "format": "int64",
  23135. "description": "The current page"
  23136. },
  23137. "X-PageCount": {
  23138. "type": "integer",
  23139. "format": "int64",
  23140. "description": "Total number of pages"
  23141. },
  23142. "X-PerPage": {
  23143. "type": "integer",
  23144. "format": "int64",
  23145. "description": "Commits per page"
  23146. },
  23147. "X-Total": {
  23148. "type": "integer",
  23149. "format": "int64",
  23150. "description": "Total commit count"
  23151. }
  23152. }
  23153. },
  23154. "CommitStatus": {
  23155. "description": "CommitStatus",
  23156. "schema": {
  23157. "$ref": "#/definitions/CommitStatus"
  23158. }
  23159. },
  23160. "CommitStatusList": {
  23161. "description": "CommitStatusList",
  23162. "schema": {
  23163. "type": "array",
  23164. "items": {
  23165. "$ref": "#/definitions/CommitStatus"
  23166. }
  23167. }
  23168. },
  23169. "ContentsListResponse": {
  23170. "description": "ContentsListResponse",
  23171. "schema": {
  23172. "type": "array",
  23173. "items": {
  23174. "$ref": "#/definitions/ContentsResponse"
  23175. }
  23176. }
  23177. },
  23178. "ContentsResponse": {
  23179. "description": "ContentsResponse",
  23180. "schema": {
  23181. "$ref": "#/definitions/ContentsResponse"
  23182. }
  23183. },
  23184. "CronList": {
  23185. "description": "CronList",
  23186. "schema": {
  23187. "type": "array",
  23188. "items": {
  23189. "$ref": "#/definitions/Cron"
  23190. }
  23191. }
  23192. },
  23193. "DeployKey": {
  23194. "description": "DeployKey",
  23195. "schema": {
  23196. "$ref": "#/definitions/DeployKey"
  23197. }
  23198. },
  23199. "DeployKeyList": {
  23200. "description": "DeployKeyList",
  23201. "schema": {
  23202. "type": "array",
  23203. "items": {
  23204. "$ref": "#/definitions/DeployKey"
  23205. }
  23206. }
  23207. },
  23208. "EmailList": {
  23209. "description": "EmailList",
  23210. "schema": {
  23211. "type": "array",
  23212. "items": {
  23213. "$ref": "#/definitions/Email"
  23214. }
  23215. }
  23216. },
  23217. "EmptyRepository": {
  23218. "description": "EmptyRepository",
  23219. "schema": {
  23220. "$ref": "#/definitions/APIError"
  23221. }
  23222. },
  23223. "FileDeleteResponse": {
  23224. "description": "FileDeleteResponse",
  23225. "schema": {
  23226. "$ref": "#/definitions/FileDeleteResponse"
  23227. }
  23228. },
  23229. "FileResponse": {
  23230. "description": "FileResponse",
  23231. "schema": {
  23232. "$ref": "#/definitions/FileResponse"
  23233. }
  23234. },
  23235. "FilesResponse": {
  23236. "description": "FilesResponse",
  23237. "schema": {
  23238. "$ref": "#/definitions/FilesResponse"
  23239. }
  23240. },
  23241. "GPGKey": {
  23242. "description": "GPGKey",
  23243. "schema": {
  23244. "$ref": "#/definitions/GPGKey"
  23245. }
  23246. },
  23247. "GPGKeyList": {
  23248. "description": "GPGKeyList",
  23249. "schema": {
  23250. "type": "array",
  23251. "items": {
  23252. "$ref": "#/definitions/GPGKey"
  23253. }
  23254. }
  23255. },
  23256. "GeneralAPISettings": {
  23257. "description": "GeneralAPISettings",
  23258. "schema": {
  23259. "$ref": "#/definitions/GeneralAPISettings"
  23260. }
  23261. },
  23262. "GeneralAttachmentSettings": {
  23263. "description": "GeneralAttachmentSettings",
  23264. "schema": {
  23265. "$ref": "#/definitions/GeneralAttachmentSettings"
  23266. }
  23267. },
  23268. "GeneralRepoSettings": {
  23269. "description": "GeneralRepoSettings",
  23270. "schema": {
  23271. "$ref": "#/definitions/GeneralRepoSettings"
  23272. }
  23273. },
  23274. "GeneralUISettings": {
  23275. "description": "GeneralUISettings",
  23276. "schema": {
  23277. "$ref": "#/definitions/GeneralUISettings"
  23278. }
  23279. },
  23280. "GitBlobResponse": {
  23281. "description": "GitBlobResponse",
  23282. "schema": {
  23283. "$ref": "#/definitions/GitBlobResponse"
  23284. }
  23285. },
  23286. "GitHook": {
  23287. "description": "GitHook",
  23288. "schema": {
  23289. "$ref": "#/definitions/GitHook"
  23290. }
  23291. },
  23292. "GitHookList": {
  23293. "description": "GitHookList",
  23294. "schema": {
  23295. "type": "array",
  23296. "items": {
  23297. "$ref": "#/definitions/GitHook"
  23298. }
  23299. }
  23300. },
  23301. "GitTreeResponse": {
  23302. "description": "GitTreeResponse",
  23303. "schema": {
  23304. "$ref": "#/definitions/GitTreeResponse"
  23305. }
  23306. },
  23307. "GitignoreTemplateInfo": {
  23308. "description": "GitignoreTemplateInfo",
  23309. "schema": {
  23310. "$ref": "#/definitions/GitignoreTemplateInfo"
  23311. }
  23312. },
  23313. "GitignoreTemplateList": {
  23314. "description": "GitignoreTemplateList",
  23315. "schema": {
  23316. "type": "array",
  23317. "items": {
  23318. "type": "string"
  23319. }
  23320. }
  23321. },
  23322. "Hook": {
  23323. "description": "Hook",
  23324. "schema": {
  23325. "$ref": "#/definitions/Hook"
  23326. }
  23327. },
  23328. "HookList": {
  23329. "description": "HookList",
  23330. "schema": {
  23331. "type": "array",
  23332. "items": {
  23333. "$ref": "#/definitions/Hook"
  23334. }
  23335. }
  23336. },
  23337. "Issue": {
  23338. "description": "Issue",
  23339. "schema": {
  23340. "$ref": "#/definitions/Issue"
  23341. }
  23342. },
  23343. "IssueDeadline": {
  23344. "description": "IssueDeadline",
  23345. "schema": {
  23346. "$ref": "#/definitions/IssueDeadline"
  23347. }
  23348. },
  23349. "IssueList": {
  23350. "description": "IssueList",
  23351. "schema": {
  23352. "type": "array",
  23353. "items": {
  23354. "$ref": "#/definitions/Issue"
  23355. }
  23356. }
  23357. },
  23358. "IssueTemplates": {
  23359. "description": "IssueTemplates",
  23360. "schema": {
  23361. "type": "array",
  23362. "items": {
  23363. "$ref": "#/definitions/IssueTemplate"
  23364. }
  23365. }
  23366. },
  23367. "Label": {
  23368. "description": "Label",
  23369. "schema": {
  23370. "$ref": "#/definitions/Label"
  23371. }
  23372. },
  23373. "LabelList": {
  23374. "description": "LabelList",
  23375. "schema": {
  23376. "type": "array",
  23377. "items": {
  23378. "$ref": "#/definitions/Label"
  23379. }
  23380. }
  23381. },
  23382. "LabelTemplateInfo": {
  23383. "description": "LabelTemplateInfo",
  23384. "schema": {
  23385. "type": "array",
  23386. "items": {
  23387. "$ref": "#/definitions/LabelTemplate"
  23388. }
  23389. }
  23390. },
  23391. "LabelTemplateList": {
  23392. "description": "LabelTemplateList",
  23393. "schema": {
  23394. "type": "array",
  23395. "items": {
  23396. "type": "string"
  23397. }
  23398. }
  23399. },
  23400. "LanguageStatistics": {
  23401. "description": "LanguageStatistics",
  23402. "schema": {
  23403. "type": "object",
  23404. "additionalProperties": {
  23405. "type": "integer",
  23406. "format": "int64"
  23407. }
  23408. }
  23409. },
  23410. "LicenseTemplateInfo": {
  23411. "description": "LicenseTemplateInfo",
  23412. "schema": {
  23413. "$ref": "#/definitions/LicenseTemplateInfo"
  23414. }
  23415. },
  23416. "LicenseTemplateList": {
  23417. "description": "LicenseTemplateList",
  23418. "schema": {
  23419. "type": "array",
  23420. "items": {
  23421. "$ref": "#/definitions/LicensesTemplateListEntry"
  23422. }
  23423. }
  23424. },
  23425. "MarkdownRender": {
  23426. "description": "MarkdownRender is a rendered markdown document",
  23427. "schema": {
  23428. "type": "string"
  23429. }
  23430. },
  23431. "MarkupRender": {
  23432. "description": "MarkupRender is a rendered markup document",
  23433. "schema": {
  23434. "type": "string"
  23435. }
  23436. },
  23437. "Milestone": {
  23438. "description": "Milestone",
  23439. "schema": {
  23440. "$ref": "#/definitions/Milestone"
  23441. }
  23442. },
  23443. "MilestoneList": {
  23444. "description": "MilestoneList",
  23445. "schema": {
  23446. "type": "array",
  23447. "items": {
  23448. "$ref": "#/definitions/Milestone"
  23449. }
  23450. }
  23451. },
  23452. "NodeInfo": {
  23453. "description": "NodeInfo",
  23454. "schema": {
  23455. "$ref": "#/definitions/NodeInfo"
  23456. }
  23457. },
  23458. "Note": {
  23459. "description": "Note",
  23460. "schema": {
  23461. "$ref": "#/definitions/Note"
  23462. }
  23463. },
  23464. "NotificationCount": {
  23465. "description": "Number of unread notifications",
  23466. "schema": {
  23467. "$ref": "#/definitions/NotificationCount"
  23468. }
  23469. },
  23470. "NotificationThread": {
  23471. "description": "NotificationThread",
  23472. "schema": {
  23473. "$ref": "#/definitions/NotificationThread"
  23474. }
  23475. },
  23476. "NotificationThreadList": {
  23477. "description": "NotificationThreadList",
  23478. "schema": {
  23479. "type": "array",
  23480. "items": {
  23481. "$ref": "#/definitions/NotificationThread"
  23482. }
  23483. }
  23484. },
  23485. "OAuth2Application": {
  23486. "description": "OAuth2Application",
  23487. "schema": {
  23488. "$ref": "#/definitions/OAuth2Application"
  23489. }
  23490. },
  23491. "OAuth2ApplicationList": {
  23492. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  23493. "schema": {
  23494. "type": "array",
  23495. "items": {
  23496. "$ref": "#/definitions/OAuth2Application"
  23497. }
  23498. }
  23499. },
  23500. "Organization": {
  23501. "description": "Organization",
  23502. "schema": {
  23503. "$ref": "#/definitions/Organization"
  23504. }
  23505. },
  23506. "OrganizationList": {
  23507. "description": "OrganizationList",
  23508. "schema": {
  23509. "type": "array",
  23510. "items": {
  23511. "$ref": "#/definitions/Organization"
  23512. }
  23513. }
  23514. },
  23515. "OrganizationPermissions": {
  23516. "description": "OrganizationPermissions",
  23517. "schema": {
  23518. "$ref": "#/definitions/OrganizationPermissions"
  23519. }
  23520. },
  23521. "Package": {
  23522. "description": "Package",
  23523. "schema": {
  23524. "$ref": "#/definitions/Package"
  23525. }
  23526. },
  23527. "PackageFileList": {
  23528. "description": "PackageFileList",
  23529. "schema": {
  23530. "type": "array",
  23531. "items": {
  23532. "$ref": "#/definitions/PackageFile"
  23533. }
  23534. }
  23535. },
  23536. "PackageList": {
  23537. "description": "PackageList",
  23538. "schema": {
  23539. "type": "array",
  23540. "items": {
  23541. "$ref": "#/definitions/Package"
  23542. }
  23543. }
  23544. },
  23545. "PublicKey": {
  23546. "description": "PublicKey",
  23547. "schema": {
  23548. "$ref": "#/definitions/PublicKey"
  23549. }
  23550. },
  23551. "PublicKeyList": {
  23552. "description": "PublicKeyList",
  23553. "schema": {
  23554. "type": "array",
  23555. "items": {
  23556. "$ref": "#/definitions/PublicKey"
  23557. }
  23558. }
  23559. },
  23560. "PullRequest": {
  23561. "description": "PullRequest",
  23562. "schema": {
  23563. "$ref": "#/definitions/PullRequest"
  23564. }
  23565. },
  23566. "PullRequestList": {
  23567. "description": "PullRequestList",
  23568. "schema": {
  23569. "type": "array",
  23570. "items": {
  23571. "$ref": "#/definitions/PullRequest"
  23572. }
  23573. }
  23574. },
  23575. "PullReview": {
  23576. "description": "PullReview",
  23577. "schema": {
  23578. "$ref": "#/definitions/PullReview"
  23579. }
  23580. },
  23581. "PullReviewComment": {
  23582. "description": "PullComment",
  23583. "schema": {
  23584. "$ref": "#/definitions/PullReviewComment"
  23585. }
  23586. },
  23587. "PullReviewCommentList": {
  23588. "description": "PullCommentList",
  23589. "schema": {
  23590. "type": "array",
  23591. "items": {
  23592. "$ref": "#/definitions/PullReviewComment"
  23593. }
  23594. }
  23595. },
  23596. "PullReviewList": {
  23597. "description": "PullReviewList",
  23598. "schema": {
  23599. "type": "array",
  23600. "items": {
  23601. "$ref": "#/definitions/PullReview"
  23602. }
  23603. }
  23604. },
  23605. "PushMirror": {
  23606. "description": "PushMirror",
  23607. "schema": {
  23608. "$ref": "#/definitions/PushMirror"
  23609. }
  23610. },
  23611. "PushMirrorList": {
  23612. "description": "PushMirrorList",
  23613. "schema": {
  23614. "type": "array",
  23615. "items": {
  23616. "$ref": "#/definitions/PushMirror"
  23617. }
  23618. }
  23619. },
  23620. "Reaction": {
  23621. "description": "Reaction",
  23622. "schema": {
  23623. "$ref": "#/definitions/Reaction"
  23624. }
  23625. },
  23626. "ReactionList": {
  23627. "description": "ReactionList",
  23628. "schema": {
  23629. "type": "array",
  23630. "items": {
  23631. "$ref": "#/definitions/Reaction"
  23632. }
  23633. }
  23634. },
  23635. "Reference": {
  23636. "description": "Reference",
  23637. "schema": {
  23638. "$ref": "#/definitions/Reference"
  23639. }
  23640. },
  23641. "ReferenceList": {
  23642. "description": "ReferenceList",
  23643. "schema": {
  23644. "type": "array",
  23645. "items": {
  23646. "$ref": "#/definitions/Reference"
  23647. }
  23648. }
  23649. },
  23650. "Release": {
  23651. "description": "Release",
  23652. "schema": {
  23653. "$ref": "#/definitions/Release"
  23654. }
  23655. },
  23656. "ReleaseList": {
  23657. "description": "ReleaseList",
  23658. "schema": {
  23659. "type": "array",
  23660. "items": {
  23661. "$ref": "#/definitions/Release"
  23662. }
  23663. }
  23664. },
  23665. "RepoCollaboratorPermission": {
  23666. "description": "RepoCollaboratorPermission",
  23667. "schema": {
  23668. "$ref": "#/definitions/RepoCollaboratorPermission"
  23669. }
  23670. },
  23671. "RepoIssueConfig": {
  23672. "description": "RepoIssueConfig",
  23673. "schema": {
  23674. "$ref": "#/definitions/IssueConfig"
  23675. }
  23676. },
  23677. "RepoIssueConfigValidation": {
  23678. "description": "RepoIssueConfigValidation",
  23679. "schema": {
  23680. "$ref": "#/definitions/IssueConfigValidation"
  23681. }
  23682. },
  23683. "RepoNewIssuePinsAllowed": {
  23684. "description": "RepoNewIssuePinsAllowed",
  23685. "schema": {
  23686. "$ref": "#/definitions/NewIssuePinsAllowed"
  23687. }
  23688. },
  23689. "Repository": {
  23690. "description": "Repository",
  23691. "schema": {
  23692. "$ref": "#/definitions/Repository"
  23693. }
  23694. },
  23695. "RepositoryList": {
  23696. "description": "RepositoryList",
  23697. "schema": {
  23698. "type": "array",
  23699. "items": {
  23700. "$ref": "#/definitions/Repository"
  23701. }
  23702. }
  23703. },
  23704. "SearchResults": {
  23705. "description": "SearchResults",
  23706. "schema": {
  23707. "$ref": "#/definitions/SearchResults"
  23708. }
  23709. },
  23710. "Secret": {
  23711. "description": "Secret",
  23712. "schema": {
  23713. "$ref": "#/definitions/Secret"
  23714. }
  23715. },
  23716. "SecretList": {
  23717. "description": "SecretList",
  23718. "schema": {
  23719. "type": "array",
  23720. "items": {
  23721. "$ref": "#/definitions/Secret"
  23722. }
  23723. }
  23724. },
  23725. "ServerVersion": {
  23726. "description": "ServerVersion",
  23727. "schema": {
  23728. "$ref": "#/definitions/ServerVersion"
  23729. }
  23730. },
  23731. "StopWatch": {
  23732. "description": "StopWatch",
  23733. "schema": {
  23734. "$ref": "#/definitions/StopWatch"
  23735. }
  23736. },
  23737. "StopWatchList": {
  23738. "description": "StopWatchList",
  23739. "schema": {
  23740. "type": "array",
  23741. "items": {
  23742. "$ref": "#/definitions/StopWatch"
  23743. }
  23744. }
  23745. },
  23746. "StringSlice": {
  23747. "description": "StringSlice",
  23748. "schema": {
  23749. "type": "array",
  23750. "items": {
  23751. "type": "string"
  23752. }
  23753. }
  23754. },
  23755. "Tag": {
  23756. "description": "Tag",
  23757. "schema": {
  23758. "$ref": "#/definitions/Tag"
  23759. }
  23760. },
  23761. "TagList": {
  23762. "description": "TagList",
  23763. "schema": {
  23764. "type": "array",
  23765. "items": {
  23766. "$ref": "#/definitions/Tag"
  23767. }
  23768. }
  23769. },
  23770. "Team": {
  23771. "description": "Team",
  23772. "schema": {
  23773. "$ref": "#/definitions/Team"
  23774. }
  23775. },
  23776. "TeamList": {
  23777. "description": "TeamList",
  23778. "schema": {
  23779. "type": "array",
  23780. "items": {
  23781. "$ref": "#/definitions/Team"
  23782. }
  23783. }
  23784. },
  23785. "TimelineList": {
  23786. "description": "TimelineList",
  23787. "schema": {
  23788. "type": "array",
  23789. "items": {
  23790. "$ref": "#/definitions/TimelineComment"
  23791. }
  23792. }
  23793. },
  23794. "TopicListResponse": {
  23795. "description": "TopicListResponse",
  23796. "schema": {
  23797. "type": "array",
  23798. "items": {
  23799. "$ref": "#/definitions/TopicResponse"
  23800. }
  23801. }
  23802. },
  23803. "TopicNames": {
  23804. "description": "TopicNames",
  23805. "schema": {
  23806. "$ref": "#/definitions/TopicName"
  23807. }
  23808. },
  23809. "TrackedTime": {
  23810. "description": "TrackedTime",
  23811. "schema": {
  23812. "$ref": "#/definitions/TrackedTime"
  23813. }
  23814. },
  23815. "TrackedTimeList": {
  23816. "description": "TrackedTimeList",
  23817. "schema": {
  23818. "type": "array",
  23819. "items": {
  23820. "$ref": "#/definitions/TrackedTime"
  23821. }
  23822. }
  23823. },
  23824. "User": {
  23825. "description": "User",
  23826. "schema": {
  23827. "$ref": "#/definitions/User"
  23828. }
  23829. },
  23830. "UserHeatmapData": {
  23831. "description": "UserHeatmapData",
  23832. "schema": {
  23833. "type": "array",
  23834. "items": {
  23835. "$ref": "#/definitions/UserHeatmapData"
  23836. }
  23837. }
  23838. },
  23839. "UserList": {
  23840. "description": "UserList",
  23841. "schema": {
  23842. "type": "array",
  23843. "items": {
  23844. "$ref": "#/definitions/User"
  23845. }
  23846. }
  23847. },
  23848. "UserSettings": {
  23849. "description": "UserSettings",
  23850. "schema": {
  23851. "type": "array",
  23852. "items": {
  23853. "$ref": "#/definitions/UserSettings"
  23854. }
  23855. }
  23856. },
  23857. "WatchInfo": {
  23858. "description": "WatchInfo",
  23859. "schema": {
  23860. "$ref": "#/definitions/WatchInfo"
  23861. }
  23862. },
  23863. "WikiCommitList": {
  23864. "description": "WikiCommitList",
  23865. "schema": {
  23866. "$ref": "#/definitions/WikiCommitList"
  23867. }
  23868. },
  23869. "WikiPage": {
  23870. "description": "WikiPage",
  23871. "schema": {
  23872. "$ref": "#/definitions/WikiPage"
  23873. }
  23874. },
  23875. "WikiPageList": {
  23876. "description": "WikiPageList",
  23877. "schema": {
  23878. "type": "array",
  23879. "items": {
  23880. "$ref": "#/definitions/WikiPageMetaData"
  23881. }
  23882. }
  23883. },
  23884. "conflict": {
  23885. "description": "APIConflict is a conflict empty response"
  23886. },
  23887. "empty": {
  23888. "description": "APIEmpty is an empty response"
  23889. },
  23890. "error": {
  23891. "description": "APIError is error format response",
  23892. "headers": {
  23893. "message": {
  23894. "type": "string"
  23895. },
  23896. "url": {
  23897. "type": "string"
  23898. }
  23899. }
  23900. },
  23901. "forbidden": {
  23902. "description": "APIForbiddenError is a forbidden error response",
  23903. "headers": {
  23904. "message": {
  23905. "type": "string"
  23906. },
  23907. "url": {
  23908. "type": "string"
  23909. }
  23910. }
  23911. },
  23912. "invalidTopicsError": {
  23913. "description": "APIInvalidTopicsError is error format response to invalid topics",
  23914. "headers": {
  23915. "invalidTopics": {
  23916. "type": "array",
  23917. "items": {
  23918. "type": "string"
  23919. }
  23920. },
  23921. "message": {
  23922. "type": "string"
  23923. }
  23924. }
  23925. },
  23926. "notFound": {
  23927. "description": "APINotFound is a not found empty response"
  23928. },
  23929. "parameterBodies": {
  23930. "description": "parameterBodies",
  23931. "schema": {
  23932. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  23933. }
  23934. },
  23935. "redirect": {
  23936. "description": "APIRedirect is a redirect response"
  23937. },
  23938. "string": {
  23939. "description": "APIString is a string response",
  23940. "schema": {
  23941. "type": "string"
  23942. }
  23943. },
  23944. "validationError": {
  23945. "description": "APIValidationError is error format response related to input validation",
  23946. "headers": {
  23947. "message": {
  23948. "type": "string"
  23949. },
  23950. "url": {
  23951. "type": "string"
  23952. }
  23953. }
  23954. }
  23955. },
  23956. "securityDefinitions": {
  23957. "AccessToken": {
  23958. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  23959. "type": "apiKey",
  23960. "name": "access_token",
  23961. "in": "query"
  23962. },
  23963. "AuthorizationHeaderToken": {
  23964. "description": "API tokens must be prepended with \"token\" followed by a space.",
  23965. "type": "apiKey",
  23966. "name": "Authorization",
  23967. "in": "header"
  23968. },
  23969. "BasicAuth": {
  23970. "type": "basic"
  23971. },
  23972. "SudoHeader": {
  23973. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  23974. "type": "apiKey",
  23975. "name": "Sudo",
  23976. "in": "header"
  23977. },
  23978. "SudoParam": {
  23979. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  23980. "type": "apiKey",
  23981. "name": "sudo",
  23982. "in": "query"
  23983. },
  23984. "TOTPHeader": {
  23985. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  23986. "type": "apiKey",
  23987. "name": "X-GITEA-OTP",
  23988. "in": "header"
  23989. },
  23990. "Token": {
  23991. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  23992. "type": "apiKey",
  23993. "name": "token",
  23994. "in": "query"
  23995. }
  23996. },
  23997. "security": [
  23998. {
  23999. "BasicAuth": []
  24000. },
  24001. {
  24002. "Token": []
  24003. },
  24004. {
  24005. "AccessToken": []
  24006. },
  24007. {
  24008. "AuthorizationHeaderToken": []
  24009. },
  24010. {
  24011. "SudoParam": []
  24012. },
  24013. {
  24014. "SudoHeader": []
  24015. },
  24016. {
  24017. "TOTPHeader": []
  24018. }
  24019. ]
  24020. }