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

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022
  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. "400": {
  664. "$ref": "#/responses/error"
  665. },
  666. "403": {
  667. "$ref": "#/responses/forbidden"
  668. },
  669. "422": {
  670. "$ref": "#/responses/validationError"
  671. }
  672. }
  673. }
  674. },
  675. "/admin/users/{username}/keys": {
  676. "post": {
  677. "consumes": [
  678. "application/json"
  679. ],
  680. "produces": [
  681. "application/json"
  682. ],
  683. "tags": [
  684. "admin"
  685. ],
  686. "summary": "Add a public key on behalf of a user",
  687. "operationId": "adminCreatePublicKey",
  688. "parameters": [
  689. {
  690. "type": "string",
  691. "description": "username of the user",
  692. "name": "username",
  693. "in": "path",
  694. "required": true
  695. },
  696. {
  697. "name": "key",
  698. "in": "body",
  699. "schema": {
  700. "$ref": "#/definitions/CreateKeyOption"
  701. }
  702. }
  703. ],
  704. "responses": {
  705. "201": {
  706. "$ref": "#/responses/PublicKey"
  707. },
  708. "403": {
  709. "$ref": "#/responses/forbidden"
  710. },
  711. "422": {
  712. "$ref": "#/responses/validationError"
  713. }
  714. }
  715. }
  716. },
  717. "/admin/users/{username}/keys/{id}": {
  718. "delete": {
  719. "produces": [
  720. "application/json"
  721. ],
  722. "tags": [
  723. "admin"
  724. ],
  725. "summary": "Delete a user's public key",
  726. "operationId": "adminDeleteUserPublicKey",
  727. "parameters": [
  728. {
  729. "type": "string",
  730. "description": "username of user",
  731. "name": "username",
  732. "in": "path",
  733. "required": true
  734. },
  735. {
  736. "type": "integer",
  737. "format": "int64",
  738. "description": "id of the key to delete",
  739. "name": "id",
  740. "in": "path",
  741. "required": true
  742. }
  743. ],
  744. "responses": {
  745. "204": {
  746. "$ref": "#/responses/empty"
  747. },
  748. "403": {
  749. "$ref": "#/responses/forbidden"
  750. },
  751. "404": {
  752. "$ref": "#/responses/notFound"
  753. }
  754. }
  755. }
  756. },
  757. "/admin/users/{username}/orgs": {
  758. "post": {
  759. "consumes": [
  760. "application/json"
  761. ],
  762. "produces": [
  763. "application/json"
  764. ],
  765. "tags": [
  766. "admin"
  767. ],
  768. "summary": "Create an organization",
  769. "operationId": "adminCreateOrg",
  770. "parameters": [
  771. {
  772. "type": "string",
  773. "description": "username of the user that will own the created organization",
  774. "name": "username",
  775. "in": "path",
  776. "required": true
  777. },
  778. {
  779. "name": "organization",
  780. "in": "body",
  781. "required": true,
  782. "schema": {
  783. "$ref": "#/definitions/CreateOrgOption"
  784. }
  785. }
  786. ],
  787. "responses": {
  788. "201": {
  789. "$ref": "#/responses/Organization"
  790. },
  791. "403": {
  792. "$ref": "#/responses/forbidden"
  793. },
  794. "422": {
  795. "$ref": "#/responses/validationError"
  796. }
  797. }
  798. }
  799. },
  800. "/admin/users/{username}/rename": {
  801. "post": {
  802. "produces": [
  803. "application/json"
  804. ],
  805. "tags": [
  806. "admin"
  807. ],
  808. "summary": "Rename a user",
  809. "operationId": "adminRenameUser",
  810. "parameters": [
  811. {
  812. "type": "string",
  813. "description": "existing username of user",
  814. "name": "username",
  815. "in": "path",
  816. "required": true
  817. },
  818. {
  819. "name": "body",
  820. "in": "body",
  821. "required": true,
  822. "schema": {
  823. "$ref": "#/definitions/RenameUserOption"
  824. }
  825. }
  826. ],
  827. "responses": {
  828. "204": {
  829. "$ref": "#/responses/empty"
  830. },
  831. "403": {
  832. "$ref": "#/responses/forbidden"
  833. },
  834. "422": {
  835. "$ref": "#/responses/validationError"
  836. }
  837. }
  838. }
  839. },
  840. "/admin/users/{username}/repos": {
  841. "post": {
  842. "consumes": [
  843. "application/json"
  844. ],
  845. "produces": [
  846. "application/json"
  847. ],
  848. "tags": [
  849. "admin"
  850. ],
  851. "summary": "Create a repository on behalf of a user",
  852. "operationId": "adminCreateRepo",
  853. "parameters": [
  854. {
  855. "type": "string",
  856. "description": "username of the user. This user will own the created repository",
  857. "name": "username",
  858. "in": "path",
  859. "required": true
  860. },
  861. {
  862. "name": "repository",
  863. "in": "body",
  864. "required": true,
  865. "schema": {
  866. "$ref": "#/definitions/CreateRepoOption"
  867. }
  868. }
  869. ],
  870. "responses": {
  871. "201": {
  872. "$ref": "#/responses/Repository"
  873. },
  874. "400": {
  875. "$ref": "#/responses/error"
  876. },
  877. "403": {
  878. "$ref": "#/responses/forbidden"
  879. },
  880. "404": {
  881. "$ref": "#/responses/notFound"
  882. },
  883. "409": {
  884. "$ref": "#/responses/error"
  885. },
  886. "422": {
  887. "$ref": "#/responses/validationError"
  888. }
  889. }
  890. }
  891. },
  892. "/gitignore/templates": {
  893. "get": {
  894. "produces": [
  895. "application/json"
  896. ],
  897. "tags": [
  898. "miscellaneous"
  899. ],
  900. "summary": "Returns a list of all gitignore templates",
  901. "operationId": "listGitignoresTemplates",
  902. "responses": {
  903. "200": {
  904. "$ref": "#/responses/GitignoreTemplateList"
  905. }
  906. }
  907. }
  908. },
  909. "/gitignore/templates/{name}": {
  910. "get": {
  911. "produces": [
  912. "application/json"
  913. ],
  914. "tags": [
  915. "miscellaneous"
  916. ],
  917. "summary": "Returns information about a gitignore template",
  918. "operationId": "getGitignoreTemplateInfo",
  919. "parameters": [
  920. {
  921. "type": "string",
  922. "description": "name of the template",
  923. "name": "name",
  924. "in": "path",
  925. "required": true
  926. }
  927. ],
  928. "responses": {
  929. "200": {
  930. "$ref": "#/responses/GitignoreTemplateInfo"
  931. },
  932. "404": {
  933. "$ref": "#/responses/notFound"
  934. }
  935. }
  936. }
  937. },
  938. "/label/templates": {
  939. "get": {
  940. "produces": [
  941. "application/json"
  942. ],
  943. "tags": [
  944. "miscellaneous"
  945. ],
  946. "summary": "Returns a list of all label templates",
  947. "operationId": "listLabelTemplates",
  948. "responses": {
  949. "200": {
  950. "$ref": "#/responses/LabelTemplateList"
  951. }
  952. }
  953. }
  954. },
  955. "/label/templates/{name}": {
  956. "get": {
  957. "produces": [
  958. "application/json"
  959. ],
  960. "tags": [
  961. "miscellaneous"
  962. ],
  963. "summary": "Returns all labels in a template",
  964. "operationId": "getLabelTemplateInfo",
  965. "parameters": [
  966. {
  967. "type": "string",
  968. "description": "name of the template",
  969. "name": "name",
  970. "in": "path",
  971. "required": true
  972. }
  973. ],
  974. "responses": {
  975. "200": {
  976. "$ref": "#/responses/LabelTemplateInfo"
  977. },
  978. "404": {
  979. "$ref": "#/responses/notFound"
  980. }
  981. }
  982. }
  983. },
  984. "/licenses": {
  985. "get": {
  986. "produces": [
  987. "application/json"
  988. ],
  989. "tags": [
  990. "miscellaneous"
  991. ],
  992. "summary": "Returns a list of all license templates",
  993. "operationId": "listLicenseTemplates",
  994. "responses": {
  995. "200": {
  996. "$ref": "#/responses/LicenseTemplateList"
  997. }
  998. }
  999. }
  1000. },
  1001. "/licenses/{name}": {
  1002. "get": {
  1003. "produces": [
  1004. "application/json"
  1005. ],
  1006. "tags": [
  1007. "miscellaneous"
  1008. ],
  1009. "summary": "Returns information about a license template",
  1010. "operationId": "getLicenseTemplateInfo",
  1011. "parameters": [
  1012. {
  1013. "type": "string",
  1014. "description": "name of the license",
  1015. "name": "name",
  1016. "in": "path",
  1017. "required": true
  1018. }
  1019. ],
  1020. "responses": {
  1021. "200": {
  1022. "$ref": "#/responses/LicenseTemplateInfo"
  1023. },
  1024. "404": {
  1025. "$ref": "#/responses/notFound"
  1026. }
  1027. }
  1028. }
  1029. },
  1030. "/markdown": {
  1031. "post": {
  1032. "consumes": [
  1033. "application/json"
  1034. ],
  1035. "produces": [
  1036. "text/html"
  1037. ],
  1038. "tags": [
  1039. "miscellaneous"
  1040. ],
  1041. "summary": "Render a markdown document as HTML",
  1042. "operationId": "renderMarkdown",
  1043. "parameters": [
  1044. {
  1045. "name": "body",
  1046. "in": "body",
  1047. "schema": {
  1048. "$ref": "#/definitions/MarkdownOption"
  1049. }
  1050. }
  1051. ],
  1052. "responses": {
  1053. "200": {
  1054. "$ref": "#/responses/MarkdownRender"
  1055. },
  1056. "422": {
  1057. "$ref": "#/responses/validationError"
  1058. }
  1059. }
  1060. }
  1061. },
  1062. "/markdown/raw": {
  1063. "post": {
  1064. "consumes": [
  1065. "text/plain"
  1066. ],
  1067. "produces": [
  1068. "text/html"
  1069. ],
  1070. "tags": [
  1071. "miscellaneous"
  1072. ],
  1073. "summary": "Render raw markdown as HTML",
  1074. "operationId": "renderMarkdownRaw",
  1075. "parameters": [
  1076. {
  1077. "description": "Request body to render",
  1078. "name": "body",
  1079. "in": "body",
  1080. "required": true,
  1081. "schema": {
  1082. "type": "string"
  1083. }
  1084. }
  1085. ],
  1086. "responses": {
  1087. "200": {
  1088. "$ref": "#/responses/MarkdownRender"
  1089. },
  1090. "422": {
  1091. "$ref": "#/responses/validationError"
  1092. }
  1093. }
  1094. }
  1095. },
  1096. "/markup": {
  1097. "post": {
  1098. "consumes": [
  1099. "application/json"
  1100. ],
  1101. "produces": [
  1102. "text/html"
  1103. ],
  1104. "tags": [
  1105. "miscellaneous"
  1106. ],
  1107. "summary": "Render a markup document as HTML",
  1108. "operationId": "renderMarkup",
  1109. "parameters": [
  1110. {
  1111. "name": "body",
  1112. "in": "body",
  1113. "schema": {
  1114. "$ref": "#/definitions/MarkupOption"
  1115. }
  1116. }
  1117. ],
  1118. "responses": {
  1119. "200": {
  1120. "$ref": "#/responses/MarkupRender"
  1121. },
  1122. "422": {
  1123. "$ref": "#/responses/validationError"
  1124. }
  1125. }
  1126. }
  1127. },
  1128. "/nodeinfo": {
  1129. "get": {
  1130. "produces": [
  1131. "application/json"
  1132. ],
  1133. "tags": [
  1134. "miscellaneous"
  1135. ],
  1136. "summary": "Returns the nodeinfo of the Gitea application",
  1137. "operationId": "getNodeInfo",
  1138. "responses": {
  1139. "200": {
  1140. "$ref": "#/responses/NodeInfo"
  1141. }
  1142. }
  1143. }
  1144. },
  1145. "/notifications": {
  1146. "get": {
  1147. "consumes": [
  1148. "application/json"
  1149. ],
  1150. "produces": [
  1151. "application/json"
  1152. ],
  1153. "tags": [
  1154. "notification"
  1155. ],
  1156. "summary": "List users's notification threads",
  1157. "operationId": "notifyGetList",
  1158. "parameters": [
  1159. {
  1160. "type": "boolean",
  1161. "description": "If true, show notifications marked as read. Default value is false",
  1162. "name": "all",
  1163. "in": "query"
  1164. },
  1165. {
  1166. "type": "array",
  1167. "items": {
  1168. "type": "string"
  1169. },
  1170. "collectionFormat": "multi",
  1171. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
  1172. "name": "status-types",
  1173. "in": "query"
  1174. },
  1175. {
  1176. "type": "array",
  1177. "items": {
  1178. "enum": [
  1179. "issue",
  1180. "pull",
  1181. "commit",
  1182. "repository"
  1183. ],
  1184. "type": "string"
  1185. },
  1186. "collectionFormat": "multi",
  1187. "description": "filter notifications by subject type",
  1188. "name": "subject-type",
  1189. "in": "query"
  1190. },
  1191. {
  1192. "type": "string",
  1193. "format": "date-time",
  1194. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  1195. "name": "since",
  1196. "in": "query"
  1197. },
  1198. {
  1199. "type": "string",
  1200. "format": "date-time",
  1201. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  1202. "name": "before",
  1203. "in": "query"
  1204. },
  1205. {
  1206. "type": "integer",
  1207. "description": "page number of results to return (1-based)",
  1208. "name": "page",
  1209. "in": "query"
  1210. },
  1211. {
  1212. "type": "integer",
  1213. "description": "page size of results",
  1214. "name": "limit",
  1215. "in": "query"
  1216. }
  1217. ],
  1218. "responses": {
  1219. "200": {
  1220. "$ref": "#/responses/NotificationThreadList"
  1221. }
  1222. }
  1223. },
  1224. "put": {
  1225. "consumes": [
  1226. "application/json"
  1227. ],
  1228. "produces": [
  1229. "application/json"
  1230. ],
  1231. "tags": [
  1232. "notification"
  1233. ],
  1234. "summary": "Mark notification threads as read, pinned or unread",
  1235. "operationId": "notifyReadList",
  1236. "parameters": [
  1237. {
  1238. "type": "string",
  1239. "format": "date-time",
  1240. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  1241. "name": "last_read_at",
  1242. "in": "query"
  1243. },
  1244. {
  1245. "type": "string",
  1246. "description": "If true, mark all notifications on this repo. Default value is false",
  1247. "name": "all",
  1248. "in": "query"
  1249. },
  1250. {
  1251. "type": "array",
  1252. "items": {
  1253. "type": "string"
  1254. },
  1255. "collectionFormat": "multi",
  1256. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  1257. "name": "status-types",
  1258. "in": "query"
  1259. },
  1260. {
  1261. "type": "string",
  1262. "description": "Status to mark notifications as, Defaults to read.",
  1263. "name": "to-status",
  1264. "in": "query"
  1265. }
  1266. ],
  1267. "responses": {
  1268. "205": {
  1269. "$ref": "#/responses/NotificationThreadList"
  1270. }
  1271. }
  1272. }
  1273. },
  1274. "/notifications/new": {
  1275. "get": {
  1276. "tags": [
  1277. "notification"
  1278. ],
  1279. "summary": "Check if unread notifications exist",
  1280. "operationId": "notifyNewAvailable",
  1281. "responses": {
  1282. "200": {
  1283. "$ref": "#/responses/NotificationCount"
  1284. }
  1285. }
  1286. }
  1287. },
  1288. "/notifications/threads/{id}": {
  1289. "get": {
  1290. "consumes": [
  1291. "application/json"
  1292. ],
  1293. "produces": [
  1294. "application/json"
  1295. ],
  1296. "tags": [
  1297. "notification"
  1298. ],
  1299. "summary": "Get notification thread by ID",
  1300. "operationId": "notifyGetThread",
  1301. "parameters": [
  1302. {
  1303. "type": "string",
  1304. "description": "id of notification thread",
  1305. "name": "id",
  1306. "in": "path",
  1307. "required": true
  1308. }
  1309. ],
  1310. "responses": {
  1311. "200": {
  1312. "$ref": "#/responses/NotificationThread"
  1313. },
  1314. "403": {
  1315. "$ref": "#/responses/forbidden"
  1316. },
  1317. "404": {
  1318. "$ref": "#/responses/notFound"
  1319. }
  1320. }
  1321. },
  1322. "patch": {
  1323. "consumes": [
  1324. "application/json"
  1325. ],
  1326. "produces": [
  1327. "application/json"
  1328. ],
  1329. "tags": [
  1330. "notification"
  1331. ],
  1332. "summary": "Mark notification thread as read by ID",
  1333. "operationId": "notifyReadThread",
  1334. "parameters": [
  1335. {
  1336. "type": "string",
  1337. "description": "id of notification thread",
  1338. "name": "id",
  1339. "in": "path",
  1340. "required": true
  1341. },
  1342. {
  1343. "type": "string",
  1344. "default": "read",
  1345. "description": "Status to mark notifications as",
  1346. "name": "to-status",
  1347. "in": "query"
  1348. }
  1349. ],
  1350. "responses": {
  1351. "205": {
  1352. "$ref": "#/responses/NotificationThread"
  1353. },
  1354. "403": {
  1355. "$ref": "#/responses/forbidden"
  1356. },
  1357. "404": {
  1358. "$ref": "#/responses/notFound"
  1359. }
  1360. }
  1361. }
  1362. },
  1363. "/org/{org}/repos": {
  1364. "post": {
  1365. "consumes": [
  1366. "application/json"
  1367. ],
  1368. "produces": [
  1369. "application/json"
  1370. ],
  1371. "tags": [
  1372. "organization"
  1373. ],
  1374. "summary": "Create a repository in an organization",
  1375. "operationId": "createOrgRepoDeprecated",
  1376. "deprecated": true,
  1377. "parameters": [
  1378. {
  1379. "type": "string",
  1380. "description": "name of organization",
  1381. "name": "org",
  1382. "in": "path",
  1383. "required": true
  1384. },
  1385. {
  1386. "name": "body",
  1387. "in": "body",
  1388. "schema": {
  1389. "$ref": "#/definitions/CreateRepoOption"
  1390. }
  1391. }
  1392. ],
  1393. "responses": {
  1394. "201": {
  1395. "$ref": "#/responses/Repository"
  1396. },
  1397. "403": {
  1398. "$ref": "#/responses/forbidden"
  1399. },
  1400. "404": {
  1401. "$ref": "#/responses/notFound"
  1402. },
  1403. "422": {
  1404. "$ref": "#/responses/validationError"
  1405. }
  1406. }
  1407. }
  1408. },
  1409. "/orgs": {
  1410. "get": {
  1411. "produces": [
  1412. "application/json"
  1413. ],
  1414. "tags": [
  1415. "organization"
  1416. ],
  1417. "summary": "Get list of organizations",
  1418. "operationId": "orgGetAll",
  1419. "parameters": [
  1420. {
  1421. "type": "integer",
  1422. "description": "page number of results to return (1-based)",
  1423. "name": "page",
  1424. "in": "query"
  1425. },
  1426. {
  1427. "type": "integer",
  1428. "description": "page size of results",
  1429. "name": "limit",
  1430. "in": "query"
  1431. }
  1432. ],
  1433. "responses": {
  1434. "200": {
  1435. "$ref": "#/responses/OrganizationList"
  1436. }
  1437. }
  1438. },
  1439. "post": {
  1440. "consumes": [
  1441. "application/json"
  1442. ],
  1443. "produces": [
  1444. "application/json"
  1445. ],
  1446. "tags": [
  1447. "organization"
  1448. ],
  1449. "summary": "Create an organization",
  1450. "operationId": "orgCreate",
  1451. "parameters": [
  1452. {
  1453. "name": "organization",
  1454. "in": "body",
  1455. "required": true,
  1456. "schema": {
  1457. "$ref": "#/definitions/CreateOrgOption"
  1458. }
  1459. }
  1460. ],
  1461. "responses": {
  1462. "201": {
  1463. "$ref": "#/responses/Organization"
  1464. },
  1465. "403": {
  1466. "$ref": "#/responses/forbidden"
  1467. },
  1468. "422": {
  1469. "$ref": "#/responses/validationError"
  1470. }
  1471. }
  1472. }
  1473. },
  1474. "/orgs/{org}": {
  1475. "get": {
  1476. "produces": [
  1477. "application/json"
  1478. ],
  1479. "tags": [
  1480. "organization"
  1481. ],
  1482. "summary": "Get an organization",
  1483. "operationId": "orgGet",
  1484. "parameters": [
  1485. {
  1486. "type": "string",
  1487. "description": "name of the organization to get",
  1488. "name": "org",
  1489. "in": "path",
  1490. "required": true
  1491. }
  1492. ],
  1493. "responses": {
  1494. "200": {
  1495. "$ref": "#/responses/Organization"
  1496. },
  1497. "404": {
  1498. "$ref": "#/responses/notFound"
  1499. }
  1500. }
  1501. },
  1502. "delete": {
  1503. "produces": [
  1504. "application/json"
  1505. ],
  1506. "tags": [
  1507. "organization"
  1508. ],
  1509. "summary": "Delete an organization",
  1510. "operationId": "orgDelete",
  1511. "parameters": [
  1512. {
  1513. "type": "string",
  1514. "description": "organization that is to be deleted",
  1515. "name": "org",
  1516. "in": "path",
  1517. "required": true
  1518. }
  1519. ],
  1520. "responses": {
  1521. "204": {
  1522. "$ref": "#/responses/empty"
  1523. },
  1524. "404": {
  1525. "$ref": "#/responses/notFound"
  1526. }
  1527. }
  1528. },
  1529. "patch": {
  1530. "consumes": [
  1531. "application/json"
  1532. ],
  1533. "produces": [
  1534. "application/json"
  1535. ],
  1536. "tags": [
  1537. "organization"
  1538. ],
  1539. "summary": "Edit an organization",
  1540. "operationId": "orgEdit",
  1541. "parameters": [
  1542. {
  1543. "type": "string",
  1544. "description": "name of the organization to edit",
  1545. "name": "org",
  1546. "in": "path",
  1547. "required": true
  1548. },
  1549. {
  1550. "name": "body",
  1551. "in": "body",
  1552. "required": true,
  1553. "schema": {
  1554. "$ref": "#/definitions/EditOrgOption"
  1555. }
  1556. }
  1557. ],
  1558. "responses": {
  1559. "200": {
  1560. "$ref": "#/responses/Organization"
  1561. },
  1562. "404": {
  1563. "$ref": "#/responses/notFound"
  1564. }
  1565. }
  1566. }
  1567. },
  1568. "/orgs/{org}/actions/secrets": {
  1569. "get": {
  1570. "produces": [
  1571. "application/json"
  1572. ],
  1573. "tags": [
  1574. "organization"
  1575. ],
  1576. "summary": "List an organization's actions secrets",
  1577. "operationId": "orgListActionsSecrets",
  1578. "parameters": [
  1579. {
  1580. "type": "string",
  1581. "description": "name of the organization",
  1582. "name": "org",
  1583. "in": "path",
  1584. "required": true
  1585. },
  1586. {
  1587. "type": "integer",
  1588. "description": "page number of results to return (1-based)",
  1589. "name": "page",
  1590. "in": "query"
  1591. },
  1592. {
  1593. "type": "integer",
  1594. "description": "page size of results",
  1595. "name": "limit",
  1596. "in": "query"
  1597. }
  1598. ],
  1599. "responses": {
  1600. "200": {
  1601. "$ref": "#/responses/SecretList"
  1602. },
  1603. "404": {
  1604. "$ref": "#/responses/notFound"
  1605. }
  1606. }
  1607. }
  1608. },
  1609. "/orgs/{org}/actions/secrets/{secretname}": {
  1610. "put": {
  1611. "consumes": [
  1612. "application/json"
  1613. ],
  1614. "produces": [
  1615. "application/json"
  1616. ],
  1617. "tags": [
  1618. "organization"
  1619. ],
  1620. "summary": "Create or Update a secret value in an organization",
  1621. "operationId": "updateOrgSecret",
  1622. "parameters": [
  1623. {
  1624. "type": "string",
  1625. "description": "name of organization",
  1626. "name": "org",
  1627. "in": "path",
  1628. "required": true
  1629. },
  1630. {
  1631. "type": "string",
  1632. "description": "name of the secret",
  1633. "name": "secretname",
  1634. "in": "path",
  1635. "required": true
  1636. },
  1637. {
  1638. "name": "body",
  1639. "in": "body",
  1640. "schema": {
  1641. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  1642. }
  1643. }
  1644. ],
  1645. "responses": {
  1646. "201": {
  1647. "description": "response when creating a secret"
  1648. },
  1649. "204": {
  1650. "description": "response when updating a secret"
  1651. },
  1652. "400": {
  1653. "$ref": "#/responses/error"
  1654. },
  1655. "404": {
  1656. "$ref": "#/responses/notFound"
  1657. }
  1658. }
  1659. },
  1660. "delete": {
  1661. "consumes": [
  1662. "application/json"
  1663. ],
  1664. "produces": [
  1665. "application/json"
  1666. ],
  1667. "tags": [
  1668. "organization"
  1669. ],
  1670. "summary": "Delete a secret in an organization",
  1671. "operationId": "deleteOrgSecret",
  1672. "parameters": [
  1673. {
  1674. "type": "string",
  1675. "description": "name of organization",
  1676. "name": "org",
  1677. "in": "path",
  1678. "required": true
  1679. },
  1680. {
  1681. "type": "string",
  1682. "description": "name of the secret",
  1683. "name": "secretname",
  1684. "in": "path",
  1685. "required": true
  1686. }
  1687. ],
  1688. "responses": {
  1689. "204": {
  1690. "description": "delete one secret of the organization"
  1691. },
  1692. "400": {
  1693. "$ref": "#/responses/error"
  1694. },
  1695. "404": {
  1696. "$ref": "#/responses/notFound"
  1697. }
  1698. }
  1699. }
  1700. },
  1701. "/orgs/{org}/activities/feeds": {
  1702. "get": {
  1703. "produces": [
  1704. "application/json"
  1705. ],
  1706. "tags": [
  1707. "organization"
  1708. ],
  1709. "summary": "List an organization's activity feeds",
  1710. "operationId": "orgListActivityFeeds",
  1711. "parameters": [
  1712. {
  1713. "type": "string",
  1714. "description": "name of the org",
  1715. "name": "org",
  1716. "in": "path",
  1717. "required": true
  1718. },
  1719. {
  1720. "type": "string",
  1721. "format": "date",
  1722. "description": "the date of the activities to be found",
  1723. "name": "date",
  1724. "in": "query"
  1725. },
  1726. {
  1727. "type": "integer",
  1728. "description": "page number of results to return (1-based)",
  1729. "name": "page",
  1730. "in": "query"
  1731. },
  1732. {
  1733. "type": "integer",
  1734. "description": "page size of results",
  1735. "name": "limit",
  1736. "in": "query"
  1737. }
  1738. ],
  1739. "responses": {
  1740. "200": {
  1741. "$ref": "#/responses/ActivityFeedsList"
  1742. },
  1743. "404": {
  1744. "$ref": "#/responses/notFound"
  1745. }
  1746. }
  1747. }
  1748. },
  1749. "/orgs/{org}/avatar": {
  1750. "post": {
  1751. "produces": [
  1752. "application/json"
  1753. ],
  1754. "tags": [
  1755. "organization"
  1756. ],
  1757. "summary": "Update Avatar",
  1758. "operationId": "orgUpdateAvatar",
  1759. "parameters": [
  1760. {
  1761. "type": "string",
  1762. "description": "name of the organization",
  1763. "name": "org",
  1764. "in": "path",
  1765. "required": true
  1766. },
  1767. {
  1768. "name": "body",
  1769. "in": "body",
  1770. "schema": {
  1771. "$ref": "#/definitions/UpdateUserAvatarOption"
  1772. }
  1773. }
  1774. ],
  1775. "responses": {
  1776. "204": {
  1777. "$ref": "#/responses/empty"
  1778. },
  1779. "404": {
  1780. "$ref": "#/responses/notFound"
  1781. }
  1782. }
  1783. },
  1784. "delete": {
  1785. "produces": [
  1786. "application/json"
  1787. ],
  1788. "tags": [
  1789. "organization"
  1790. ],
  1791. "summary": "Delete Avatar",
  1792. "operationId": "orgDeleteAvatar",
  1793. "parameters": [
  1794. {
  1795. "type": "string",
  1796. "description": "name of the organization",
  1797. "name": "org",
  1798. "in": "path",
  1799. "required": true
  1800. }
  1801. ],
  1802. "responses": {
  1803. "204": {
  1804. "$ref": "#/responses/empty"
  1805. },
  1806. "404": {
  1807. "$ref": "#/responses/notFound"
  1808. }
  1809. }
  1810. }
  1811. },
  1812. "/orgs/{org}/hooks": {
  1813. "get": {
  1814. "produces": [
  1815. "application/json"
  1816. ],
  1817. "tags": [
  1818. "organization"
  1819. ],
  1820. "summary": "List an organization's webhooks",
  1821. "operationId": "orgListHooks",
  1822. "parameters": [
  1823. {
  1824. "type": "string",
  1825. "description": "name of the organization",
  1826. "name": "org",
  1827. "in": "path",
  1828. "required": true
  1829. },
  1830. {
  1831. "type": "integer",
  1832. "description": "page number of results to return (1-based)",
  1833. "name": "page",
  1834. "in": "query"
  1835. },
  1836. {
  1837. "type": "integer",
  1838. "description": "page size of results",
  1839. "name": "limit",
  1840. "in": "query"
  1841. }
  1842. ],
  1843. "responses": {
  1844. "200": {
  1845. "$ref": "#/responses/HookList"
  1846. },
  1847. "404": {
  1848. "$ref": "#/responses/notFound"
  1849. }
  1850. }
  1851. },
  1852. "post": {
  1853. "consumes": [
  1854. "application/json"
  1855. ],
  1856. "produces": [
  1857. "application/json"
  1858. ],
  1859. "tags": [
  1860. "organization"
  1861. ],
  1862. "summary": "Create a hook",
  1863. "operationId": "orgCreateHook",
  1864. "parameters": [
  1865. {
  1866. "type": "string",
  1867. "description": "name of the organization",
  1868. "name": "org",
  1869. "in": "path",
  1870. "required": true
  1871. },
  1872. {
  1873. "name": "body",
  1874. "in": "body",
  1875. "required": true,
  1876. "schema": {
  1877. "$ref": "#/definitions/CreateHookOption"
  1878. }
  1879. }
  1880. ],
  1881. "responses": {
  1882. "201": {
  1883. "$ref": "#/responses/Hook"
  1884. },
  1885. "404": {
  1886. "$ref": "#/responses/notFound"
  1887. }
  1888. }
  1889. }
  1890. },
  1891. "/orgs/{org}/hooks/{id}": {
  1892. "get": {
  1893. "produces": [
  1894. "application/json"
  1895. ],
  1896. "tags": [
  1897. "organization"
  1898. ],
  1899. "summary": "Get a hook",
  1900. "operationId": "orgGetHook",
  1901. "parameters": [
  1902. {
  1903. "type": "string",
  1904. "description": "name of the organization",
  1905. "name": "org",
  1906. "in": "path",
  1907. "required": true
  1908. },
  1909. {
  1910. "type": "integer",
  1911. "format": "int64",
  1912. "description": "id of the hook to get",
  1913. "name": "id",
  1914. "in": "path",
  1915. "required": true
  1916. }
  1917. ],
  1918. "responses": {
  1919. "200": {
  1920. "$ref": "#/responses/Hook"
  1921. },
  1922. "404": {
  1923. "$ref": "#/responses/notFound"
  1924. }
  1925. }
  1926. },
  1927. "delete": {
  1928. "produces": [
  1929. "application/json"
  1930. ],
  1931. "tags": [
  1932. "organization"
  1933. ],
  1934. "summary": "Delete a hook",
  1935. "operationId": "orgDeleteHook",
  1936. "parameters": [
  1937. {
  1938. "type": "string",
  1939. "description": "name of the organization",
  1940. "name": "org",
  1941. "in": "path",
  1942. "required": true
  1943. },
  1944. {
  1945. "type": "integer",
  1946. "format": "int64",
  1947. "description": "id of the hook to delete",
  1948. "name": "id",
  1949. "in": "path",
  1950. "required": true
  1951. }
  1952. ],
  1953. "responses": {
  1954. "204": {
  1955. "$ref": "#/responses/empty"
  1956. },
  1957. "404": {
  1958. "$ref": "#/responses/notFound"
  1959. }
  1960. }
  1961. },
  1962. "patch": {
  1963. "consumes": [
  1964. "application/json"
  1965. ],
  1966. "produces": [
  1967. "application/json"
  1968. ],
  1969. "tags": [
  1970. "organization"
  1971. ],
  1972. "summary": "Update a hook",
  1973. "operationId": "orgEditHook",
  1974. "parameters": [
  1975. {
  1976. "type": "string",
  1977. "description": "name of the organization",
  1978. "name": "org",
  1979. "in": "path",
  1980. "required": true
  1981. },
  1982. {
  1983. "type": "integer",
  1984. "format": "int64",
  1985. "description": "id of the hook to update",
  1986. "name": "id",
  1987. "in": "path",
  1988. "required": true
  1989. },
  1990. {
  1991. "name": "body",
  1992. "in": "body",
  1993. "schema": {
  1994. "$ref": "#/definitions/EditHookOption"
  1995. }
  1996. }
  1997. ],
  1998. "responses": {
  1999. "200": {
  2000. "$ref": "#/responses/Hook"
  2001. },
  2002. "404": {
  2003. "$ref": "#/responses/notFound"
  2004. }
  2005. }
  2006. }
  2007. },
  2008. "/orgs/{org}/labels": {
  2009. "get": {
  2010. "produces": [
  2011. "application/json"
  2012. ],
  2013. "tags": [
  2014. "organization"
  2015. ],
  2016. "summary": "List an organization's labels",
  2017. "operationId": "orgListLabels",
  2018. "parameters": [
  2019. {
  2020. "type": "string",
  2021. "description": "name of the organization",
  2022. "name": "org",
  2023. "in": "path",
  2024. "required": true
  2025. },
  2026. {
  2027. "type": "integer",
  2028. "description": "page number of results to return (1-based)",
  2029. "name": "page",
  2030. "in": "query"
  2031. },
  2032. {
  2033. "type": "integer",
  2034. "description": "page size of results",
  2035. "name": "limit",
  2036. "in": "query"
  2037. }
  2038. ],
  2039. "responses": {
  2040. "200": {
  2041. "$ref": "#/responses/LabelList"
  2042. },
  2043. "404": {
  2044. "$ref": "#/responses/notFound"
  2045. }
  2046. }
  2047. },
  2048. "post": {
  2049. "consumes": [
  2050. "application/json"
  2051. ],
  2052. "produces": [
  2053. "application/json"
  2054. ],
  2055. "tags": [
  2056. "organization"
  2057. ],
  2058. "summary": "Create a label for an organization",
  2059. "operationId": "orgCreateLabel",
  2060. "parameters": [
  2061. {
  2062. "type": "string",
  2063. "description": "name of the organization",
  2064. "name": "org",
  2065. "in": "path",
  2066. "required": true
  2067. },
  2068. {
  2069. "name": "body",
  2070. "in": "body",
  2071. "schema": {
  2072. "$ref": "#/definitions/CreateLabelOption"
  2073. }
  2074. }
  2075. ],
  2076. "responses": {
  2077. "201": {
  2078. "$ref": "#/responses/Label"
  2079. },
  2080. "404": {
  2081. "$ref": "#/responses/notFound"
  2082. },
  2083. "422": {
  2084. "$ref": "#/responses/validationError"
  2085. }
  2086. }
  2087. }
  2088. },
  2089. "/orgs/{org}/labels/{id}": {
  2090. "get": {
  2091. "produces": [
  2092. "application/json"
  2093. ],
  2094. "tags": [
  2095. "organization"
  2096. ],
  2097. "summary": "Get a single label",
  2098. "operationId": "orgGetLabel",
  2099. "parameters": [
  2100. {
  2101. "type": "string",
  2102. "description": "name of the organization",
  2103. "name": "org",
  2104. "in": "path",
  2105. "required": true
  2106. },
  2107. {
  2108. "type": "integer",
  2109. "format": "int64",
  2110. "description": "id of the label to get",
  2111. "name": "id",
  2112. "in": "path",
  2113. "required": true
  2114. }
  2115. ],
  2116. "responses": {
  2117. "200": {
  2118. "$ref": "#/responses/Label"
  2119. },
  2120. "404": {
  2121. "$ref": "#/responses/notFound"
  2122. }
  2123. }
  2124. },
  2125. "delete": {
  2126. "tags": [
  2127. "organization"
  2128. ],
  2129. "summary": "Delete a label",
  2130. "operationId": "orgDeleteLabel",
  2131. "parameters": [
  2132. {
  2133. "type": "string",
  2134. "description": "name of the organization",
  2135. "name": "org",
  2136. "in": "path",
  2137. "required": true
  2138. },
  2139. {
  2140. "type": "integer",
  2141. "format": "int64",
  2142. "description": "id of the label to delete",
  2143. "name": "id",
  2144. "in": "path",
  2145. "required": true
  2146. }
  2147. ],
  2148. "responses": {
  2149. "204": {
  2150. "$ref": "#/responses/empty"
  2151. },
  2152. "404": {
  2153. "$ref": "#/responses/notFound"
  2154. }
  2155. }
  2156. },
  2157. "patch": {
  2158. "consumes": [
  2159. "application/json"
  2160. ],
  2161. "produces": [
  2162. "application/json"
  2163. ],
  2164. "tags": [
  2165. "organization"
  2166. ],
  2167. "summary": "Update a label",
  2168. "operationId": "orgEditLabel",
  2169. "parameters": [
  2170. {
  2171. "type": "string",
  2172. "description": "name of the organization",
  2173. "name": "org",
  2174. "in": "path",
  2175. "required": true
  2176. },
  2177. {
  2178. "type": "integer",
  2179. "format": "int64",
  2180. "description": "id of the label to edit",
  2181. "name": "id",
  2182. "in": "path",
  2183. "required": true
  2184. },
  2185. {
  2186. "name": "body",
  2187. "in": "body",
  2188. "schema": {
  2189. "$ref": "#/definitions/EditLabelOption"
  2190. }
  2191. }
  2192. ],
  2193. "responses": {
  2194. "200": {
  2195. "$ref": "#/responses/Label"
  2196. },
  2197. "404": {
  2198. "$ref": "#/responses/notFound"
  2199. },
  2200. "422": {
  2201. "$ref": "#/responses/validationError"
  2202. }
  2203. }
  2204. }
  2205. },
  2206. "/orgs/{org}/members": {
  2207. "get": {
  2208. "produces": [
  2209. "application/json"
  2210. ],
  2211. "tags": [
  2212. "organization"
  2213. ],
  2214. "summary": "List an organization's members",
  2215. "operationId": "orgListMembers",
  2216. "parameters": [
  2217. {
  2218. "type": "string",
  2219. "description": "name of the organization",
  2220. "name": "org",
  2221. "in": "path",
  2222. "required": true
  2223. },
  2224. {
  2225. "type": "integer",
  2226. "description": "page number of results to return (1-based)",
  2227. "name": "page",
  2228. "in": "query"
  2229. },
  2230. {
  2231. "type": "integer",
  2232. "description": "page size of results",
  2233. "name": "limit",
  2234. "in": "query"
  2235. }
  2236. ],
  2237. "responses": {
  2238. "200": {
  2239. "$ref": "#/responses/UserList"
  2240. },
  2241. "404": {
  2242. "$ref": "#/responses/notFound"
  2243. }
  2244. }
  2245. }
  2246. },
  2247. "/orgs/{org}/members/{username}": {
  2248. "get": {
  2249. "tags": [
  2250. "organization"
  2251. ],
  2252. "summary": "Check if a user is a member of an organization",
  2253. "operationId": "orgIsMember",
  2254. "parameters": [
  2255. {
  2256. "type": "string",
  2257. "description": "name of the organization",
  2258. "name": "org",
  2259. "in": "path",
  2260. "required": true
  2261. },
  2262. {
  2263. "type": "string",
  2264. "description": "username of the user",
  2265. "name": "username",
  2266. "in": "path",
  2267. "required": true
  2268. }
  2269. ],
  2270. "responses": {
  2271. "204": {
  2272. "description": "user is a member"
  2273. },
  2274. "303": {
  2275. "description": "redirection to /orgs/{org}/public_members/{username}"
  2276. },
  2277. "404": {
  2278. "description": "user is not a member"
  2279. }
  2280. }
  2281. },
  2282. "delete": {
  2283. "produces": [
  2284. "application/json"
  2285. ],
  2286. "tags": [
  2287. "organization"
  2288. ],
  2289. "summary": "Remove a member from an organization",
  2290. "operationId": "orgDeleteMember",
  2291. "parameters": [
  2292. {
  2293. "type": "string",
  2294. "description": "name of the organization",
  2295. "name": "org",
  2296. "in": "path",
  2297. "required": true
  2298. },
  2299. {
  2300. "type": "string",
  2301. "description": "username of the user",
  2302. "name": "username",
  2303. "in": "path",
  2304. "required": true
  2305. }
  2306. ],
  2307. "responses": {
  2308. "204": {
  2309. "description": "member removed"
  2310. },
  2311. "404": {
  2312. "$ref": "#/responses/notFound"
  2313. }
  2314. }
  2315. }
  2316. },
  2317. "/orgs/{org}/public_members": {
  2318. "get": {
  2319. "produces": [
  2320. "application/json"
  2321. ],
  2322. "tags": [
  2323. "organization"
  2324. ],
  2325. "summary": "List an organization's public members",
  2326. "operationId": "orgListPublicMembers",
  2327. "parameters": [
  2328. {
  2329. "type": "string",
  2330. "description": "name of the organization",
  2331. "name": "org",
  2332. "in": "path",
  2333. "required": true
  2334. },
  2335. {
  2336. "type": "integer",
  2337. "description": "page number of results to return (1-based)",
  2338. "name": "page",
  2339. "in": "query"
  2340. },
  2341. {
  2342. "type": "integer",
  2343. "description": "page size of results",
  2344. "name": "limit",
  2345. "in": "query"
  2346. }
  2347. ],
  2348. "responses": {
  2349. "200": {
  2350. "$ref": "#/responses/UserList"
  2351. },
  2352. "404": {
  2353. "$ref": "#/responses/notFound"
  2354. }
  2355. }
  2356. }
  2357. },
  2358. "/orgs/{org}/public_members/{username}": {
  2359. "get": {
  2360. "tags": [
  2361. "organization"
  2362. ],
  2363. "summary": "Check if a user is a public member of an organization",
  2364. "operationId": "orgIsPublicMember",
  2365. "parameters": [
  2366. {
  2367. "type": "string",
  2368. "description": "name of the organization",
  2369. "name": "org",
  2370. "in": "path",
  2371. "required": true
  2372. },
  2373. {
  2374. "type": "string",
  2375. "description": "username of the user",
  2376. "name": "username",
  2377. "in": "path",
  2378. "required": true
  2379. }
  2380. ],
  2381. "responses": {
  2382. "204": {
  2383. "description": "user is a public member"
  2384. },
  2385. "404": {
  2386. "description": "user is not a public member"
  2387. }
  2388. }
  2389. },
  2390. "put": {
  2391. "produces": [
  2392. "application/json"
  2393. ],
  2394. "tags": [
  2395. "organization"
  2396. ],
  2397. "summary": "Publicize a user's membership",
  2398. "operationId": "orgPublicizeMember",
  2399. "parameters": [
  2400. {
  2401. "type": "string",
  2402. "description": "name of the organization",
  2403. "name": "org",
  2404. "in": "path",
  2405. "required": true
  2406. },
  2407. {
  2408. "type": "string",
  2409. "description": "username of the user",
  2410. "name": "username",
  2411. "in": "path",
  2412. "required": true
  2413. }
  2414. ],
  2415. "responses": {
  2416. "204": {
  2417. "description": "membership publicized"
  2418. },
  2419. "403": {
  2420. "$ref": "#/responses/forbidden"
  2421. },
  2422. "404": {
  2423. "$ref": "#/responses/notFound"
  2424. }
  2425. }
  2426. },
  2427. "delete": {
  2428. "produces": [
  2429. "application/json"
  2430. ],
  2431. "tags": [
  2432. "organization"
  2433. ],
  2434. "summary": "Conceal a user's membership",
  2435. "operationId": "orgConcealMember",
  2436. "parameters": [
  2437. {
  2438. "type": "string",
  2439. "description": "name of the organization",
  2440. "name": "org",
  2441. "in": "path",
  2442. "required": true
  2443. },
  2444. {
  2445. "type": "string",
  2446. "description": "username of the user",
  2447. "name": "username",
  2448. "in": "path",
  2449. "required": true
  2450. }
  2451. ],
  2452. "responses": {
  2453. "204": {
  2454. "$ref": "#/responses/empty"
  2455. },
  2456. "403": {
  2457. "$ref": "#/responses/forbidden"
  2458. },
  2459. "404": {
  2460. "$ref": "#/responses/notFound"
  2461. }
  2462. }
  2463. }
  2464. },
  2465. "/orgs/{org}/repos": {
  2466. "get": {
  2467. "produces": [
  2468. "application/json"
  2469. ],
  2470. "tags": [
  2471. "organization"
  2472. ],
  2473. "summary": "List an organization's repos",
  2474. "operationId": "orgListRepos",
  2475. "parameters": [
  2476. {
  2477. "type": "string",
  2478. "description": "name of the organization",
  2479. "name": "org",
  2480. "in": "path",
  2481. "required": true
  2482. },
  2483. {
  2484. "type": "integer",
  2485. "description": "page number of results to return (1-based)",
  2486. "name": "page",
  2487. "in": "query"
  2488. },
  2489. {
  2490. "type": "integer",
  2491. "description": "page size of results",
  2492. "name": "limit",
  2493. "in": "query"
  2494. }
  2495. ],
  2496. "responses": {
  2497. "200": {
  2498. "$ref": "#/responses/RepositoryList"
  2499. },
  2500. "404": {
  2501. "$ref": "#/responses/notFound"
  2502. }
  2503. }
  2504. },
  2505. "post": {
  2506. "consumes": [
  2507. "application/json"
  2508. ],
  2509. "produces": [
  2510. "application/json"
  2511. ],
  2512. "tags": [
  2513. "organization"
  2514. ],
  2515. "summary": "Create a repository in an organization",
  2516. "operationId": "createOrgRepo",
  2517. "parameters": [
  2518. {
  2519. "type": "string",
  2520. "description": "name of organization",
  2521. "name": "org",
  2522. "in": "path",
  2523. "required": true
  2524. },
  2525. {
  2526. "name": "body",
  2527. "in": "body",
  2528. "schema": {
  2529. "$ref": "#/definitions/CreateRepoOption"
  2530. }
  2531. }
  2532. ],
  2533. "responses": {
  2534. "201": {
  2535. "$ref": "#/responses/Repository"
  2536. },
  2537. "400": {
  2538. "$ref": "#/responses/error"
  2539. },
  2540. "403": {
  2541. "$ref": "#/responses/forbidden"
  2542. },
  2543. "404": {
  2544. "$ref": "#/responses/notFound"
  2545. }
  2546. }
  2547. }
  2548. },
  2549. "/orgs/{org}/teams": {
  2550. "get": {
  2551. "produces": [
  2552. "application/json"
  2553. ],
  2554. "tags": [
  2555. "organization"
  2556. ],
  2557. "summary": "List an organization's teams",
  2558. "operationId": "orgListTeams",
  2559. "parameters": [
  2560. {
  2561. "type": "string",
  2562. "description": "name of the organization",
  2563. "name": "org",
  2564. "in": "path",
  2565. "required": true
  2566. },
  2567. {
  2568. "type": "integer",
  2569. "description": "page number of results to return (1-based)",
  2570. "name": "page",
  2571. "in": "query"
  2572. },
  2573. {
  2574. "type": "integer",
  2575. "description": "page size of results",
  2576. "name": "limit",
  2577. "in": "query"
  2578. }
  2579. ],
  2580. "responses": {
  2581. "200": {
  2582. "$ref": "#/responses/TeamList"
  2583. },
  2584. "404": {
  2585. "$ref": "#/responses/notFound"
  2586. }
  2587. }
  2588. },
  2589. "post": {
  2590. "consumes": [
  2591. "application/json"
  2592. ],
  2593. "produces": [
  2594. "application/json"
  2595. ],
  2596. "tags": [
  2597. "organization"
  2598. ],
  2599. "summary": "Create a team",
  2600. "operationId": "orgCreateTeam",
  2601. "parameters": [
  2602. {
  2603. "type": "string",
  2604. "description": "name of the organization",
  2605. "name": "org",
  2606. "in": "path",
  2607. "required": true
  2608. },
  2609. {
  2610. "name": "body",
  2611. "in": "body",
  2612. "schema": {
  2613. "$ref": "#/definitions/CreateTeamOption"
  2614. }
  2615. }
  2616. ],
  2617. "responses": {
  2618. "201": {
  2619. "$ref": "#/responses/Team"
  2620. },
  2621. "404": {
  2622. "$ref": "#/responses/notFound"
  2623. },
  2624. "422": {
  2625. "$ref": "#/responses/validationError"
  2626. }
  2627. }
  2628. }
  2629. },
  2630. "/orgs/{org}/teams/search": {
  2631. "get": {
  2632. "produces": [
  2633. "application/json"
  2634. ],
  2635. "tags": [
  2636. "organization"
  2637. ],
  2638. "summary": "Search for teams within an organization",
  2639. "operationId": "teamSearch",
  2640. "parameters": [
  2641. {
  2642. "type": "string",
  2643. "description": "name of the organization",
  2644. "name": "org",
  2645. "in": "path",
  2646. "required": true
  2647. },
  2648. {
  2649. "type": "string",
  2650. "description": "keywords to search",
  2651. "name": "q",
  2652. "in": "query"
  2653. },
  2654. {
  2655. "type": "boolean",
  2656. "description": "include search within team description (defaults to true)",
  2657. "name": "include_desc",
  2658. "in": "query"
  2659. },
  2660. {
  2661. "type": "integer",
  2662. "description": "page number of results to return (1-based)",
  2663. "name": "page",
  2664. "in": "query"
  2665. },
  2666. {
  2667. "type": "integer",
  2668. "description": "page size of results",
  2669. "name": "limit",
  2670. "in": "query"
  2671. }
  2672. ],
  2673. "responses": {
  2674. "200": {
  2675. "description": "SearchResults of a successful search",
  2676. "schema": {
  2677. "type": "object",
  2678. "properties": {
  2679. "data": {
  2680. "type": "array",
  2681. "items": {
  2682. "$ref": "#/definitions/Team"
  2683. }
  2684. },
  2685. "ok": {
  2686. "type": "boolean"
  2687. }
  2688. }
  2689. }
  2690. },
  2691. "404": {
  2692. "$ref": "#/responses/notFound"
  2693. }
  2694. }
  2695. }
  2696. },
  2697. "/packages/{owner}": {
  2698. "get": {
  2699. "produces": [
  2700. "application/json"
  2701. ],
  2702. "tags": [
  2703. "package"
  2704. ],
  2705. "summary": "Gets all packages of an owner",
  2706. "operationId": "listPackages",
  2707. "parameters": [
  2708. {
  2709. "type": "string",
  2710. "description": "owner of the packages",
  2711. "name": "owner",
  2712. "in": "path",
  2713. "required": true
  2714. },
  2715. {
  2716. "type": "integer",
  2717. "description": "page number of results to return (1-based)",
  2718. "name": "page",
  2719. "in": "query"
  2720. },
  2721. {
  2722. "type": "integer",
  2723. "description": "page size of results",
  2724. "name": "limit",
  2725. "in": "query"
  2726. },
  2727. {
  2728. "enum": [
  2729. "alpine",
  2730. "cargo",
  2731. "chef",
  2732. "composer",
  2733. "conan",
  2734. "conda",
  2735. "container",
  2736. "cran",
  2737. "debian",
  2738. "generic",
  2739. "go",
  2740. "helm",
  2741. "maven",
  2742. "npm",
  2743. "nuget",
  2744. "pub",
  2745. "pypi",
  2746. "rpm",
  2747. "rubygems",
  2748. "swift",
  2749. "vagrant"
  2750. ],
  2751. "type": "string",
  2752. "description": "package type filter",
  2753. "name": "type",
  2754. "in": "query"
  2755. },
  2756. {
  2757. "type": "string",
  2758. "description": "name filter",
  2759. "name": "q",
  2760. "in": "query"
  2761. }
  2762. ],
  2763. "responses": {
  2764. "200": {
  2765. "$ref": "#/responses/PackageList"
  2766. },
  2767. "404": {
  2768. "$ref": "#/responses/notFound"
  2769. }
  2770. }
  2771. }
  2772. },
  2773. "/packages/{owner}/{type}/{name}/{version}": {
  2774. "get": {
  2775. "produces": [
  2776. "application/json"
  2777. ],
  2778. "tags": [
  2779. "package"
  2780. ],
  2781. "summary": "Gets a package",
  2782. "operationId": "getPackage",
  2783. "parameters": [
  2784. {
  2785. "type": "string",
  2786. "description": "owner of the package",
  2787. "name": "owner",
  2788. "in": "path",
  2789. "required": true
  2790. },
  2791. {
  2792. "type": "string",
  2793. "description": "type of the package",
  2794. "name": "type",
  2795. "in": "path",
  2796. "required": true
  2797. },
  2798. {
  2799. "type": "string",
  2800. "description": "name of the package",
  2801. "name": "name",
  2802. "in": "path",
  2803. "required": true
  2804. },
  2805. {
  2806. "type": "string",
  2807. "description": "version of the package",
  2808. "name": "version",
  2809. "in": "path",
  2810. "required": true
  2811. }
  2812. ],
  2813. "responses": {
  2814. "200": {
  2815. "$ref": "#/responses/Package"
  2816. },
  2817. "404": {
  2818. "$ref": "#/responses/notFound"
  2819. }
  2820. }
  2821. },
  2822. "delete": {
  2823. "tags": [
  2824. "package"
  2825. ],
  2826. "summary": "Delete a package",
  2827. "operationId": "deletePackage",
  2828. "parameters": [
  2829. {
  2830. "type": "string",
  2831. "description": "owner of the package",
  2832. "name": "owner",
  2833. "in": "path",
  2834. "required": true
  2835. },
  2836. {
  2837. "type": "string",
  2838. "description": "type of the package",
  2839. "name": "type",
  2840. "in": "path",
  2841. "required": true
  2842. },
  2843. {
  2844. "type": "string",
  2845. "description": "name of the package",
  2846. "name": "name",
  2847. "in": "path",
  2848. "required": true
  2849. },
  2850. {
  2851. "type": "string",
  2852. "description": "version of the package",
  2853. "name": "version",
  2854. "in": "path",
  2855. "required": true
  2856. }
  2857. ],
  2858. "responses": {
  2859. "204": {
  2860. "$ref": "#/responses/empty"
  2861. },
  2862. "404": {
  2863. "$ref": "#/responses/notFound"
  2864. }
  2865. }
  2866. }
  2867. },
  2868. "/packages/{owner}/{type}/{name}/{version}/files": {
  2869. "get": {
  2870. "produces": [
  2871. "application/json"
  2872. ],
  2873. "tags": [
  2874. "package"
  2875. ],
  2876. "summary": "Gets all files of a package",
  2877. "operationId": "listPackageFiles",
  2878. "parameters": [
  2879. {
  2880. "type": "string",
  2881. "description": "owner of the package",
  2882. "name": "owner",
  2883. "in": "path",
  2884. "required": true
  2885. },
  2886. {
  2887. "type": "string",
  2888. "description": "type of the package",
  2889. "name": "type",
  2890. "in": "path",
  2891. "required": true
  2892. },
  2893. {
  2894. "type": "string",
  2895. "description": "name of the package",
  2896. "name": "name",
  2897. "in": "path",
  2898. "required": true
  2899. },
  2900. {
  2901. "type": "string",
  2902. "description": "version of the package",
  2903. "name": "version",
  2904. "in": "path",
  2905. "required": true
  2906. }
  2907. ],
  2908. "responses": {
  2909. "200": {
  2910. "$ref": "#/responses/PackageFileList"
  2911. },
  2912. "404": {
  2913. "$ref": "#/responses/notFound"
  2914. }
  2915. }
  2916. }
  2917. },
  2918. "/repos/issues/search": {
  2919. "get": {
  2920. "produces": [
  2921. "application/json"
  2922. ],
  2923. "tags": [
  2924. "issue"
  2925. ],
  2926. "summary": "Search for issues across the repositories that the user has access to",
  2927. "operationId": "issueSearchIssues",
  2928. "parameters": [
  2929. {
  2930. "type": "string",
  2931. "description": "whether issue is open or closed",
  2932. "name": "state",
  2933. "in": "query"
  2934. },
  2935. {
  2936. "type": "string",
  2937. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  2938. "name": "labels",
  2939. "in": "query"
  2940. },
  2941. {
  2942. "type": "string",
  2943. "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
  2944. "name": "milestones",
  2945. "in": "query"
  2946. },
  2947. {
  2948. "type": "string",
  2949. "description": "search string",
  2950. "name": "q",
  2951. "in": "query"
  2952. },
  2953. {
  2954. "type": "integer",
  2955. "format": "int64",
  2956. "description": "repository to prioritize in the results",
  2957. "name": "priority_repo_id",
  2958. "in": "query"
  2959. },
  2960. {
  2961. "type": "string",
  2962. "description": "filter by type (issues / pulls) if set",
  2963. "name": "type",
  2964. "in": "query"
  2965. },
  2966. {
  2967. "type": "string",
  2968. "format": "date-time",
  2969. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  2970. "name": "since",
  2971. "in": "query"
  2972. },
  2973. {
  2974. "type": "string",
  2975. "format": "date-time",
  2976. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  2977. "name": "before",
  2978. "in": "query"
  2979. },
  2980. {
  2981. "type": "boolean",
  2982. "description": "filter (issues / pulls) assigned to you, default is false",
  2983. "name": "assigned",
  2984. "in": "query"
  2985. },
  2986. {
  2987. "type": "boolean",
  2988. "description": "filter (issues / pulls) created by you, default is false",
  2989. "name": "created",
  2990. "in": "query"
  2991. },
  2992. {
  2993. "type": "boolean",
  2994. "description": "filter (issues / pulls) mentioning you, default is false",
  2995. "name": "mentioned",
  2996. "in": "query"
  2997. },
  2998. {
  2999. "type": "boolean",
  3000. "description": "filter pulls requesting your review, default is false",
  3001. "name": "review_requested",
  3002. "in": "query"
  3003. },
  3004. {
  3005. "type": "boolean",
  3006. "description": "filter pulls reviewed by you, default is false",
  3007. "name": "reviewed",
  3008. "in": "query"
  3009. },
  3010. {
  3011. "type": "string",
  3012. "description": "filter by owner",
  3013. "name": "owner",
  3014. "in": "query"
  3015. },
  3016. {
  3017. "type": "string",
  3018. "description": "filter by team (requires organization owner parameter to be provided)",
  3019. "name": "team",
  3020. "in": "query"
  3021. },
  3022. {
  3023. "type": "integer",
  3024. "description": "page number of results to return (1-based)",
  3025. "name": "page",
  3026. "in": "query"
  3027. },
  3028. {
  3029. "type": "integer",
  3030. "description": "page size of results",
  3031. "name": "limit",
  3032. "in": "query"
  3033. }
  3034. ],
  3035. "responses": {
  3036. "200": {
  3037. "$ref": "#/responses/IssueList"
  3038. }
  3039. }
  3040. }
  3041. },
  3042. "/repos/migrate": {
  3043. "post": {
  3044. "consumes": [
  3045. "application/json"
  3046. ],
  3047. "produces": [
  3048. "application/json"
  3049. ],
  3050. "tags": [
  3051. "repository"
  3052. ],
  3053. "summary": "Migrate a remote git repository",
  3054. "operationId": "repoMigrate",
  3055. "parameters": [
  3056. {
  3057. "name": "body",
  3058. "in": "body",
  3059. "schema": {
  3060. "$ref": "#/definitions/MigrateRepoOptions"
  3061. }
  3062. }
  3063. ],
  3064. "responses": {
  3065. "201": {
  3066. "$ref": "#/responses/Repository"
  3067. },
  3068. "403": {
  3069. "$ref": "#/responses/forbidden"
  3070. },
  3071. "409": {
  3072. "description": "The repository with the same name already exists."
  3073. },
  3074. "422": {
  3075. "$ref": "#/responses/validationError"
  3076. }
  3077. }
  3078. }
  3079. },
  3080. "/repos/search": {
  3081. "get": {
  3082. "produces": [
  3083. "application/json"
  3084. ],
  3085. "tags": [
  3086. "repository"
  3087. ],
  3088. "summary": "Search for repositories",
  3089. "operationId": "repoSearch",
  3090. "parameters": [
  3091. {
  3092. "type": "string",
  3093. "description": "keyword",
  3094. "name": "q",
  3095. "in": "query"
  3096. },
  3097. {
  3098. "type": "boolean",
  3099. "description": "Limit search to repositories with keyword as topic",
  3100. "name": "topic",
  3101. "in": "query"
  3102. },
  3103. {
  3104. "type": "boolean",
  3105. "description": "include search of keyword within repository description",
  3106. "name": "includeDesc",
  3107. "in": "query"
  3108. },
  3109. {
  3110. "type": "integer",
  3111. "format": "int64",
  3112. "description": "search only for repos that the user with the given id owns or contributes to",
  3113. "name": "uid",
  3114. "in": "query"
  3115. },
  3116. {
  3117. "type": "integer",
  3118. "format": "int64",
  3119. "description": "repo owner to prioritize in the results",
  3120. "name": "priority_owner_id",
  3121. "in": "query"
  3122. },
  3123. {
  3124. "type": "integer",
  3125. "format": "int64",
  3126. "description": "search only for repos that belong to the given team id",
  3127. "name": "team_id",
  3128. "in": "query"
  3129. },
  3130. {
  3131. "type": "integer",
  3132. "format": "int64",
  3133. "description": "search only for repos that the user with the given id has starred",
  3134. "name": "starredBy",
  3135. "in": "query"
  3136. },
  3137. {
  3138. "type": "boolean",
  3139. "description": "include private repositories this user has access to (defaults to true)",
  3140. "name": "private",
  3141. "in": "query"
  3142. },
  3143. {
  3144. "type": "boolean",
  3145. "description": "show only pubic, private or all repositories (defaults to all)",
  3146. "name": "is_private",
  3147. "in": "query"
  3148. },
  3149. {
  3150. "type": "boolean",
  3151. "description": "include template repositories this user has access to (defaults to true)",
  3152. "name": "template",
  3153. "in": "query"
  3154. },
  3155. {
  3156. "type": "boolean",
  3157. "description": "show only archived, non-archived or all repositories (defaults to all)",
  3158. "name": "archived",
  3159. "in": "query"
  3160. },
  3161. {
  3162. "type": "string",
  3163. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  3164. "name": "mode",
  3165. "in": "query"
  3166. },
  3167. {
  3168. "type": "boolean",
  3169. "description": "if `uid` is given, search only for repos that the user owns",
  3170. "name": "exclusive",
  3171. "in": "query"
  3172. },
  3173. {
  3174. "type": "string",
  3175. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  3176. "name": "sort",
  3177. "in": "query"
  3178. },
  3179. {
  3180. "type": "string",
  3181. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  3182. "name": "order",
  3183. "in": "query"
  3184. },
  3185. {
  3186. "type": "integer",
  3187. "description": "page number of results to return (1-based)",
  3188. "name": "page",
  3189. "in": "query"
  3190. },
  3191. {
  3192. "type": "integer",
  3193. "description": "page size of results",
  3194. "name": "limit",
  3195. "in": "query"
  3196. }
  3197. ],
  3198. "responses": {
  3199. "200": {
  3200. "$ref": "#/responses/SearchResults"
  3201. },
  3202. "422": {
  3203. "$ref": "#/responses/validationError"
  3204. }
  3205. }
  3206. }
  3207. },
  3208. "/repos/{owner}/{repo}": {
  3209. "get": {
  3210. "produces": [
  3211. "application/json"
  3212. ],
  3213. "tags": [
  3214. "repository"
  3215. ],
  3216. "summary": "Get a repository",
  3217. "operationId": "repoGet",
  3218. "parameters": [
  3219. {
  3220. "type": "string",
  3221. "description": "owner of the repo",
  3222. "name": "owner",
  3223. "in": "path",
  3224. "required": true
  3225. },
  3226. {
  3227. "type": "string",
  3228. "description": "name of the repo",
  3229. "name": "repo",
  3230. "in": "path",
  3231. "required": true
  3232. }
  3233. ],
  3234. "responses": {
  3235. "200": {
  3236. "$ref": "#/responses/Repository"
  3237. },
  3238. "404": {
  3239. "$ref": "#/responses/notFound"
  3240. }
  3241. }
  3242. },
  3243. "delete": {
  3244. "produces": [
  3245. "application/json"
  3246. ],
  3247. "tags": [
  3248. "repository"
  3249. ],
  3250. "summary": "Delete a repository",
  3251. "operationId": "repoDelete",
  3252. "parameters": [
  3253. {
  3254. "type": "string",
  3255. "description": "owner of the repo to delete",
  3256. "name": "owner",
  3257. "in": "path",
  3258. "required": true
  3259. },
  3260. {
  3261. "type": "string",
  3262. "description": "name of the repo to delete",
  3263. "name": "repo",
  3264. "in": "path",
  3265. "required": true
  3266. }
  3267. ],
  3268. "responses": {
  3269. "204": {
  3270. "$ref": "#/responses/empty"
  3271. },
  3272. "403": {
  3273. "$ref": "#/responses/forbidden"
  3274. },
  3275. "404": {
  3276. "$ref": "#/responses/notFound"
  3277. }
  3278. }
  3279. },
  3280. "patch": {
  3281. "produces": [
  3282. "application/json"
  3283. ],
  3284. "tags": [
  3285. "repository"
  3286. ],
  3287. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  3288. "operationId": "repoEdit",
  3289. "parameters": [
  3290. {
  3291. "type": "string",
  3292. "description": "owner of the repo to edit",
  3293. "name": "owner",
  3294. "in": "path",
  3295. "required": true
  3296. },
  3297. {
  3298. "type": "string",
  3299. "description": "name of the repo to edit",
  3300. "name": "repo",
  3301. "in": "path",
  3302. "required": true
  3303. },
  3304. {
  3305. "description": "Properties of a repo that you can edit",
  3306. "name": "body",
  3307. "in": "body",
  3308. "schema": {
  3309. "$ref": "#/definitions/EditRepoOption"
  3310. }
  3311. }
  3312. ],
  3313. "responses": {
  3314. "200": {
  3315. "$ref": "#/responses/Repository"
  3316. },
  3317. "403": {
  3318. "$ref": "#/responses/forbidden"
  3319. },
  3320. "404": {
  3321. "$ref": "#/responses/notFound"
  3322. },
  3323. "422": {
  3324. "$ref": "#/responses/validationError"
  3325. }
  3326. }
  3327. }
  3328. },
  3329. "/repos/{owner}/{repo}/actions/secrets/{secretname}": {
  3330. "put": {
  3331. "consumes": [
  3332. "application/json"
  3333. ],
  3334. "produces": [
  3335. "application/json"
  3336. ],
  3337. "tags": [
  3338. "repository"
  3339. ],
  3340. "summary": "Create or Update a secret value in a repository",
  3341. "operationId": "updateRepoSecret",
  3342. "parameters": [
  3343. {
  3344. "type": "string",
  3345. "description": "owner of the repository",
  3346. "name": "owner",
  3347. "in": "path",
  3348. "required": true
  3349. },
  3350. {
  3351. "type": "string",
  3352. "description": "name of the repository",
  3353. "name": "repo",
  3354. "in": "path",
  3355. "required": true
  3356. },
  3357. {
  3358. "type": "string",
  3359. "description": "name of the secret",
  3360. "name": "secretname",
  3361. "in": "path",
  3362. "required": true
  3363. },
  3364. {
  3365. "name": "body",
  3366. "in": "body",
  3367. "schema": {
  3368. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  3369. }
  3370. }
  3371. ],
  3372. "responses": {
  3373. "201": {
  3374. "description": "response when creating a secret"
  3375. },
  3376. "204": {
  3377. "description": "response when updating a secret"
  3378. },
  3379. "400": {
  3380. "$ref": "#/responses/error"
  3381. },
  3382. "404": {
  3383. "$ref": "#/responses/notFound"
  3384. }
  3385. }
  3386. },
  3387. "delete": {
  3388. "consumes": [
  3389. "application/json"
  3390. ],
  3391. "produces": [
  3392. "application/json"
  3393. ],
  3394. "tags": [
  3395. "repository"
  3396. ],
  3397. "summary": "Delete a secret in a repository",
  3398. "operationId": "deleteRepoSecret",
  3399. "parameters": [
  3400. {
  3401. "type": "string",
  3402. "description": "owner of the repository",
  3403. "name": "owner",
  3404. "in": "path",
  3405. "required": true
  3406. },
  3407. {
  3408. "type": "string",
  3409. "description": "name of the repository",
  3410. "name": "repo",
  3411. "in": "path",
  3412. "required": true
  3413. },
  3414. {
  3415. "type": "string",
  3416. "description": "name of the secret",
  3417. "name": "secretname",
  3418. "in": "path",
  3419. "required": true
  3420. }
  3421. ],
  3422. "responses": {
  3423. "204": {
  3424. "description": "delete one secret of the organization"
  3425. },
  3426. "400": {
  3427. "$ref": "#/responses/error"
  3428. },
  3429. "404": {
  3430. "$ref": "#/responses/notFound"
  3431. }
  3432. }
  3433. }
  3434. },
  3435. "/repos/{owner}/{repo}/activities/feeds": {
  3436. "get": {
  3437. "produces": [
  3438. "application/json"
  3439. ],
  3440. "tags": [
  3441. "repository"
  3442. ],
  3443. "summary": "List a repository's activity feeds",
  3444. "operationId": "repoListActivityFeeds",
  3445. "parameters": [
  3446. {
  3447. "type": "string",
  3448. "description": "owner of the repo",
  3449. "name": "owner",
  3450. "in": "path",
  3451. "required": true
  3452. },
  3453. {
  3454. "type": "string",
  3455. "description": "name of the repo",
  3456. "name": "repo",
  3457. "in": "path",
  3458. "required": true
  3459. },
  3460. {
  3461. "type": "string",
  3462. "format": "date",
  3463. "description": "the date of the activities to be found",
  3464. "name": "date",
  3465. "in": "query"
  3466. },
  3467. {
  3468. "type": "integer",
  3469. "description": "page number of results to return (1-based)",
  3470. "name": "page",
  3471. "in": "query"
  3472. },
  3473. {
  3474. "type": "integer",
  3475. "description": "page size of results",
  3476. "name": "limit",
  3477. "in": "query"
  3478. }
  3479. ],
  3480. "responses": {
  3481. "200": {
  3482. "$ref": "#/responses/ActivityFeedsList"
  3483. },
  3484. "404": {
  3485. "$ref": "#/responses/notFound"
  3486. }
  3487. }
  3488. }
  3489. },
  3490. "/repos/{owner}/{repo}/archive/{archive}": {
  3491. "get": {
  3492. "produces": [
  3493. "application/json"
  3494. ],
  3495. "tags": [
  3496. "repository"
  3497. ],
  3498. "summary": "Get an archive of a repository",
  3499. "operationId": "repoGetArchive",
  3500. "parameters": [
  3501. {
  3502. "type": "string",
  3503. "description": "owner of the repo",
  3504. "name": "owner",
  3505. "in": "path",
  3506. "required": true
  3507. },
  3508. {
  3509. "type": "string",
  3510. "description": "name of the repo",
  3511. "name": "repo",
  3512. "in": "path",
  3513. "required": true
  3514. },
  3515. {
  3516. "type": "string",
  3517. "description": "the git reference for download with attached archive format (e.g. master.zip)",
  3518. "name": "archive",
  3519. "in": "path",
  3520. "required": true
  3521. }
  3522. ],
  3523. "responses": {
  3524. "200": {
  3525. "description": "success"
  3526. },
  3527. "404": {
  3528. "$ref": "#/responses/notFound"
  3529. }
  3530. }
  3531. }
  3532. },
  3533. "/repos/{owner}/{repo}/assignees": {
  3534. "get": {
  3535. "produces": [
  3536. "application/json"
  3537. ],
  3538. "tags": [
  3539. "repository"
  3540. ],
  3541. "summary": "Return all users that have write access and can be assigned to issues",
  3542. "operationId": "repoGetAssignees",
  3543. "parameters": [
  3544. {
  3545. "type": "string",
  3546. "description": "owner of the repo",
  3547. "name": "owner",
  3548. "in": "path",
  3549. "required": true
  3550. },
  3551. {
  3552. "type": "string",
  3553. "description": "name of the repo",
  3554. "name": "repo",
  3555. "in": "path",
  3556. "required": true
  3557. }
  3558. ],
  3559. "responses": {
  3560. "200": {
  3561. "$ref": "#/responses/UserList"
  3562. },
  3563. "404": {
  3564. "$ref": "#/responses/notFound"
  3565. }
  3566. }
  3567. }
  3568. },
  3569. "/repos/{owner}/{repo}/avatar": {
  3570. "post": {
  3571. "produces": [
  3572. "application/json"
  3573. ],
  3574. "tags": [
  3575. "repository"
  3576. ],
  3577. "summary": "Update avatar",
  3578. "operationId": "repoUpdateAvatar",
  3579. "parameters": [
  3580. {
  3581. "type": "string",
  3582. "description": "owner of the repo",
  3583. "name": "owner",
  3584. "in": "path",
  3585. "required": true
  3586. },
  3587. {
  3588. "type": "string",
  3589. "description": "name of the repo",
  3590. "name": "repo",
  3591. "in": "path",
  3592. "required": true
  3593. },
  3594. {
  3595. "name": "body",
  3596. "in": "body",
  3597. "schema": {
  3598. "$ref": "#/definitions/UpdateRepoAvatarOption"
  3599. }
  3600. }
  3601. ],
  3602. "responses": {
  3603. "204": {
  3604. "$ref": "#/responses/empty"
  3605. },
  3606. "404": {
  3607. "$ref": "#/responses/notFound"
  3608. }
  3609. }
  3610. },
  3611. "delete": {
  3612. "produces": [
  3613. "application/json"
  3614. ],
  3615. "tags": [
  3616. "repository"
  3617. ],
  3618. "summary": "Delete avatar",
  3619. "operationId": "repoDeleteAvatar",
  3620. "parameters": [
  3621. {
  3622. "type": "string",
  3623. "description": "owner of the repo",
  3624. "name": "owner",
  3625. "in": "path",
  3626. "required": true
  3627. },
  3628. {
  3629. "type": "string",
  3630. "description": "name of the repo",
  3631. "name": "repo",
  3632. "in": "path",
  3633. "required": true
  3634. }
  3635. ],
  3636. "responses": {
  3637. "204": {
  3638. "$ref": "#/responses/empty"
  3639. },
  3640. "404": {
  3641. "$ref": "#/responses/notFound"
  3642. }
  3643. }
  3644. }
  3645. },
  3646. "/repos/{owner}/{repo}/branch_protections": {
  3647. "get": {
  3648. "produces": [
  3649. "application/json"
  3650. ],
  3651. "tags": [
  3652. "repository"
  3653. ],
  3654. "summary": "List branch protections for a repository",
  3655. "operationId": "repoListBranchProtection",
  3656. "parameters": [
  3657. {
  3658. "type": "string",
  3659. "description": "owner of the repo",
  3660. "name": "owner",
  3661. "in": "path",
  3662. "required": true
  3663. },
  3664. {
  3665. "type": "string",
  3666. "description": "name of the repo",
  3667. "name": "repo",
  3668. "in": "path",
  3669. "required": true
  3670. }
  3671. ],
  3672. "responses": {
  3673. "200": {
  3674. "$ref": "#/responses/BranchProtectionList"
  3675. }
  3676. }
  3677. },
  3678. "post": {
  3679. "consumes": [
  3680. "application/json"
  3681. ],
  3682. "produces": [
  3683. "application/json"
  3684. ],
  3685. "tags": [
  3686. "repository"
  3687. ],
  3688. "summary": "Create a branch protections for a repository",
  3689. "operationId": "repoCreateBranchProtection",
  3690. "parameters": [
  3691. {
  3692. "type": "string",
  3693. "description": "owner of the repo",
  3694. "name": "owner",
  3695. "in": "path",
  3696. "required": true
  3697. },
  3698. {
  3699. "type": "string",
  3700. "description": "name of the repo",
  3701. "name": "repo",
  3702. "in": "path",
  3703. "required": true
  3704. },
  3705. {
  3706. "name": "body",
  3707. "in": "body",
  3708. "schema": {
  3709. "$ref": "#/definitions/CreateBranchProtectionOption"
  3710. }
  3711. }
  3712. ],
  3713. "responses": {
  3714. "201": {
  3715. "$ref": "#/responses/BranchProtection"
  3716. },
  3717. "403": {
  3718. "$ref": "#/responses/forbidden"
  3719. },
  3720. "404": {
  3721. "$ref": "#/responses/notFound"
  3722. },
  3723. "422": {
  3724. "$ref": "#/responses/validationError"
  3725. }
  3726. }
  3727. }
  3728. },
  3729. "/repos/{owner}/{repo}/branch_protections/{name}": {
  3730. "get": {
  3731. "produces": [
  3732. "application/json"
  3733. ],
  3734. "tags": [
  3735. "repository"
  3736. ],
  3737. "summary": "Get a specific branch protection for the repository",
  3738. "operationId": "repoGetBranchProtection",
  3739. "parameters": [
  3740. {
  3741. "type": "string",
  3742. "description": "owner of the repo",
  3743. "name": "owner",
  3744. "in": "path",
  3745. "required": true
  3746. },
  3747. {
  3748. "type": "string",
  3749. "description": "name of the repo",
  3750. "name": "repo",
  3751. "in": "path",
  3752. "required": true
  3753. },
  3754. {
  3755. "type": "string",
  3756. "description": "name of protected branch",
  3757. "name": "name",
  3758. "in": "path",
  3759. "required": true
  3760. }
  3761. ],
  3762. "responses": {
  3763. "200": {
  3764. "$ref": "#/responses/BranchProtection"
  3765. },
  3766. "404": {
  3767. "$ref": "#/responses/notFound"
  3768. }
  3769. }
  3770. },
  3771. "delete": {
  3772. "produces": [
  3773. "application/json"
  3774. ],
  3775. "tags": [
  3776. "repository"
  3777. ],
  3778. "summary": "Delete a specific branch protection for the repository",
  3779. "operationId": "repoDeleteBranchProtection",
  3780. "parameters": [
  3781. {
  3782. "type": "string",
  3783. "description": "owner of the repo",
  3784. "name": "owner",
  3785. "in": "path",
  3786. "required": true
  3787. },
  3788. {
  3789. "type": "string",
  3790. "description": "name of the repo",
  3791. "name": "repo",
  3792. "in": "path",
  3793. "required": true
  3794. },
  3795. {
  3796. "type": "string",
  3797. "description": "name of protected branch",
  3798. "name": "name",
  3799. "in": "path",
  3800. "required": true
  3801. }
  3802. ],
  3803. "responses": {
  3804. "204": {
  3805. "$ref": "#/responses/empty"
  3806. },
  3807. "404": {
  3808. "$ref": "#/responses/notFound"
  3809. }
  3810. }
  3811. },
  3812. "patch": {
  3813. "consumes": [
  3814. "application/json"
  3815. ],
  3816. "produces": [
  3817. "application/json"
  3818. ],
  3819. "tags": [
  3820. "repository"
  3821. ],
  3822. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  3823. "operationId": "repoEditBranchProtection",
  3824. "parameters": [
  3825. {
  3826. "type": "string",
  3827. "description": "owner of the repo",
  3828. "name": "owner",
  3829. "in": "path",
  3830. "required": true
  3831. },
  3832. {
  3833. "type": "string",
  3834. "description": "name of the repo",
  3835. "name": "repo",
  3836. "in": "path",
  3837. "required": true
  3838. },
  3839. {
  3840. "type": "string",
  3841. "description": "name of protected branch",
  3842. "name": "name",
  3843. "in": "path",
  3844. "required": true
  3845. },
  3846. {
  3847. "name": "body",
  3848. "in": "body",
  3849. "schema": {
  3850. "$ref": "#/definitions/EditBranchProtectionOption"
  3851. }
  3852. }
  3853. ],
  3854. "responses": {
  3855. "200": {
  3856. "$ref": "#/responses/BranchProtection"
  3857. },
  3858. "404": {
  3859. "$ref": "#/responses/notFound"
  3860. },
  3861. "422": {
  3862. "$ref": "#/responses/validationError"
  3863. }
  3864. }
  3865. }
  3866. },
  3867. "/repos/{owner}/{repo}/branches": {
  3868. "get": {
  3869. "produces": [
  3870. "application/json"
  3871. ],
  3872. "tags": [
  3873. "repository"
  3874. ],
  3875. "summary": "List a repository's branches",
  3876. "operationId": "repoListBranches",
  3877. "parameters": [
  3878. {
  3879. "type": "string",
  3880. "description": "owner of the repo",
  3881. "name": "owner",
  3882. "in": "path",
  3883. "required": true
  3884. },
  3885. {
  3886. "type": "string",
  3887. "description": "name of the repo",
  3888. "name": "repo",
  3889. "in": "path",
  3890. "required": true
  3891. },
  3892. {
  3893. "type": "integer",
  3894. "description": "page number of results to return (1-based)",
  3895. "name": "page",
  3896. "in": "query"
  3897. },
  3898. {
  3899. "type": "integer",
  3900. "description": "page size of results",
  3901. "name": "limit",
  3902. "in": "query"
  3903. }
  3904. ],
  3905. "responses": {
  3906. "200": {
  3907. "$ref": "#/responses/BranchList"
  3908. }
  3909. }
  3910. },
  3911. "post": {
  3912. "consumes": [
  3913. "application/json"
  3914. ],
  3915. "produces": [
  3916. "application/json"
  3917. ],
  3918. "tags": [
  3919. "repository"
  3920. ],
  3921. "summary": "Create a branch",
  3922. "operationId": "repoCreateBranch",
  3923. "parameters": [
  3924. {
  3925. "type": "string",
  3926. "description": "owner of the repo",
  3927. "name": "owner",
  3928. "in": "path",
  3929. "required": true
  3930. },
  3931. {
  3932. "type": "string",
  3933. "description": "name of the repo",
  3934. "name": "repo",
  3935. "in": "path",
  3936. "required": true
  3937. },
  3938. {
  3939. "name": "body",
  3940. "in": "body",
  3941. "schema": {
  3942. "$ref": "#/definitions/CreateBranchRepoOption"
  3943. }
  3944. }
  3945. ],
  3946. "responses": {
  3947. "201": {
  3948. "$ref": "#/responses/Branch"
  3949. },
  3950. "403": {
  3951. "description": "The branch is archived or a mirror."
  3952. },
  3953. "404": {
  3954. "description": "The old branch does not exist."
  3955. },
  3956. "409": {
  3957. "description": "The branch with the same name already exists."
  3958. }
  3959. }
  3960. }
  3961. },
  3962. "/repos/{owner}/{repo}/branches/{branch}": {
  3963. "get": {
  3964. "produces": [
  3965. "application/json"
  3966. ],
  3967. "tags": [
  3968. "repository"
  3969. ],
  3970. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  3971. "operationId": "repoGetBranch",
  3972. "parameters": [
  3973. {
  3974. "type": "string",
  3975. "description": "owner of the repo",
  3976. "name": "owner",
  3977. "in": "path",
  3978. "required": true
  3979. },
  3980. {
  3981. "type": "string",
  3982. "description": "name of the repo",
  3983. "name": "repo",
  3984. "in": "path",
  3985. "required": true
  3986. },
  3987. {
  3988. "type": "string",
  3989. "description": "branch to get",
  3990. "name": "branch",
  3991. "in": "path",
  3992. "required": true
  3993. }
  3994. ],
  3995. "responses": {
  3996. "200": {
  3997. "$ref": "#/responses/Branch"
  3998. },
  3999. "404": {
  4000. "$ref": "#/responses/notFound"
  4001. }
  4002. }
  4003. },
  4004. "delete": {
  4005. "produces": [
  4006. "application/json"
  4007. ],
  4008. "tags": [
  4009. "repository"
  4010. ],
  4011. "summary": "Delete a specific branch from a repository",
  4012. "operationId": "repoDeleteBranch",
  4013. "parameters": [
  4014. {
  4015. "type": "string",
  4016. "description": "owner of the repo",
  4017. "name": "owner",
  4018. "in": "path",
  4019. "required": true
  4020. },
  4021. {
  4022. "type": "string",
  4023. "description": "name of the repo",
  4024. "name": "repo",
  4025. "in": "path",
  4026. "required": true
  4027. },
  4028. {
  4029. "type": "string",
  4030. "description": "branch to delete",
  4031. "name": "branch",
  4032. "in": "path",
  4033. "required": true
  4034. }
  4035. ],
  4036. "responses": {
  4037. "204": {
  4038. "$ref": "#/responses/empty"
  4039. },
  4040. "403": {
  4041. "$ref": "#/responses/error"
  4042. },
  4043. "404": {
  4044. "$ref": "#/responses/notFound"
  4045. }
  4046. }
  4047. }
  4048. },
  4049. "/repos/{owner}/{repo}/collaborators": {
  4050. "get": {
  4051. "produces": [
  4052. "application/json"
  4053. ],
  4054. "tags": [
  4055. "repository"
  4056. ],
  4057. "summary": "List a repository's collaborators",
  4058. "operationId": "repoListCollaborators",
  4059. "parameters": [
  4060. {
  4061. "type": "string",
  4062. "description": "owner of the repo",
  4063. "name": "owner",
  4064. "in": "path",
  4065. "required": true
  4066. },
  4067. {
  4068. "type": "string",
  4069. "description": "name of the repo",
  4070. "name": "repo",
  4071. "in": "path",
  4072. "required": true
  4073. },
  4074. {
  4075. "type": "integer",
  4076. "description": "page number of results to return (1-based)",
  4077. "name": "page",
  4078. "in": "query"
  4079. },
  4080. {
  4081. "type": "integer",
  4082. "description": "page size of results",
  4083. "name": "limit",
  4084. "in": "query"
  4085. }
  4086. ],
  4087. "responses": {
  4088. "200": {
  4089. "$ref": "#/responses/UserList"
  4090. },
  4091. "404": {
  4092. "$ref": "#/responses/notFound"
  4093. }
  4094. }
  4095. }
  4096. },
  4097. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  4098. "get": {
  4099. "produces": [
  4100. "application/json"
  4101. ],
  4102. "tags": [
  4103. "repository"
  4104. ],
  4105. "summary": "Check if a user is a collaborator of a repository",
  4106. "operationId": "repoCheckCollaborator",
  4107. "parameters": [
  4108. {
  4109. "type": "string",
  4110. "description": "owner of the repo",
  4111. "name": "owner",
  4112. "in": "path",
  4113. "required": true
  4114. },
  4115. {
  4116. "type": "string",
  4117. "description": "name of the repo",
  4118. "name": "repo",
  4119. "in": "path",
  4120. "required": true
  4121. },
  4122. {
  4123. "type": "string",
  4124. "description": "username of the collaborator",
  4125. "name": "collaborator",
  4126. "in": "path",
  4127. "required": true
  4128. }
  4129. ],
  4130. "responses": {
  4131. "204": {
  4132. "$ref": "#/responses/empty"
  4133. },
  4134. "404": {
  4135. "$ref": "#/responses/notFound"
  4136. },
  4137. "422": {
  4138. "$ref": "#/responses/validationError"
  4139. }
  4140. }
  4141. },
  4142. "put": {
  4143. "produces": [
  4144. "application/json"
  4145. ],
  4146. "tags": [
  4147. "repository"
  4148. ],
  4149. "summary": "Add a collaborator to a repository",
  4150. "operationId": "repoAddCollaborator",
  4151. "parameters": [
  4152. {
  4153. "type": "string",
  4154. "description": "owner of the repo",
  4155. "name": "owner",
  4156. "in": "path",
  4157. "required": true
  4158. },
  4159. {
  4160. "type": "string",
  4161. "description": "name of the repo",
  4162. "name": "repo",
  4163. "in": "path",
  4164. "required": true
  4165. },
  4166. {
  4167. "type": "string",
  4168. "description": "username of the collaborator to add",
  4169. "name": "collaborator",
  4170. "in": "path",
  4171. "required": true
  4172. },
  4173. {
  4174. "name": "body",
  4175. "in": "body",
  4176. "schema": {
  4177. "$ref": "#/definitions/AddCollaboratorOption"
  4178. }
  4179. }
  4180. ],
  4181. "responses": {
  4182. "204": {
  4183. "$ref": "#/responses/empty"
  4184. },
  4185. "404": {
  4186. "$ref": "#/responses/notFound"
  4187. },
  4188. "422": {
  4189. "$ref": "#/responses/validationError"
  4190. }
  4191. }
  4192. },
  4193. "delete": {
  4194. "produces": [
  4195. "application/json"
  4196. ],
  4197. "tags": [
  4198. "repository"
  4199. ],
  4200. "summary": "Delete a collaborator from a repository",
  4201. "operationId": "repoDeleteCollaborator",
  4202. "parameters": [
  4203. {
  4204. "type": "string",
  4205. "description": "owner of the repo",
  4206. "name": "owner",
  4207. "in": "path",
  4208. "required": true
  4209. },
  4210. {
  4211. "type": "string",
  4212. "description": "name of the repo",
  4213. "name": "repo",
  4214. "in": "path",
  4215. "required": true
  4216. },
  4217. {
  4218. "type": "string",
  4219. "description": "username of the collaborator to delete",
  4220. "name": "collaborator",
  4221. "in": "path",
  4222. "required": true
  4223. }
  4224. ],
  4225. "responses": {
  4226. "204": {
  4227. "$ref": "#/responses/empty"
  4228. },
  4229. "404": {
  4230. "$ref": "#/responses/notFound"
  4231. },
  4232. "422": {
  4233. "$ref": "#/responses/validationError"
  4234. }
  4235. }
  4236. }
  4237. },
  4238. "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
  4239. "get": {
  4240. "produces": [
  4241. "application/json"
  4242. ],
  4243. "tags": [
  4244. "repository"
  4245. ],
  4246. "summary": "Get repository permissions for a user",
  4247. "operationId": "repoGetRepoPermissions",
  4248. "parameters": [
  4249. {
  4250. "type": "string",
  4251. "description": "owner of the repo",
  4252. "name": "owner",
  4253. "in": "path",
  4254. "required": true
  4255. },
  4256. {
  4257. "type": "string",
  4258. "description": "name of the repo",
  4259. "name": "repo",
  4260. "in": "path",
  4261. "required": true
  4262. },
  4263. {
  4264. "type": "string",
  4265. "description": "username of the collaborator",
  4266. "name": "collaborator",
  4267. "in": "path",
  4268. "required": true
  4269. }
  4270. ],
  4271. "responses": {
  4272. "200": {
  4273. "$ref": "#/responses/RepoCollaboratorPermission"
  4274. },
  4275. "403": {
  4276. "$ref": "#/responses/forbidden"
  4277. },
  4278. "404": {
  4279. "$ref": "#/responses/notFound"
  4280. }
  4281. }
  4282. }
  4283. },
  4284. "/repos/{owner}/{repo}/commits": {
  4285. "get": {
  4286. "produces": [
  4287. "application/json"
  4288. ],
  4289. "tags": [
  4290. "repository"
  4291. ],
  4292. "summary": "Get a list of all commits from a repository",
  4293. "operationId": "repoGetAllCommits",
  4294. "parameters": [
  4295. {
  4296. "type": "string",
  4297. "description": "owner of the repo",
  4298. "name": "owner",
  4299. "in": "path",
  4300. "required": true
  4301. },
  4302. {
  4303. "type": "string",
  4304. "description": "name of the repo",
  4305. "name": "repo",
  4306. "in": "path",
  4307. "required": true
  4308. },
  4309. {
  4310. "type": "string",
  4311. "description": "SHA or branch to start listing commits from (usually 'master')",
  4312. "name": "sha",
  4313. "in": "query"
  4314. },
  4315. {
  4316. "type": "string",
  4317. "description": "filepath of a file/dir",
  4318. "name": "path",
  4319. "in": "query"
  4320. },
  4321. {
  4322. "type": "boolean",
  4323. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  4324. "name": "stat",
  4325. "in": "query"
  4326. },
  4327. {
  4328. "type": "boolean",
  4329. "description": "include verification for every commit (disable for speedup, default 'true')",
  4330. "name": "verification",
  4331. "in": "query"
  4332. },
  4333. {
  4334. "type": "boolean",
  4335. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  4336. "name": "files",
  4337. "in": "query"
  4338. },
  4339. {
  4340. "type": "integer",
  4341. "description": "page number of results to return (1-based)",
  4342. "name": "page",
  4343. "in": "query"
  4344. },
  4345. {
  4346. "type": "integer",
  4347. "description": "page size of results (ignored if used with 'path')",
  4348. "name": "limit",
  4349. "in": "query"
  4350. },
  4351. {
  4352. "type": "string",
  4353. "description": "commits that match the given specifier will not be listed.",
  4354. "name": "not",
  4355. "in": "query"
  4356. }
  4357. ],
  4358. "responses": {
  4359. "200": {
  4360. "$ref": "#/responses/CommitList"
  4361. },
  4362. "404": {
  4363. "$ref": "#/responses/notFound"
  4364. },
  4365. "409": {
  4366. "$ref": "#/responses/EmptyRepository"
  4367. }
  4368. }
  4369. }
  4370. },
  4371. "/repos/{owner}/{repo}/commits/{ref}/status": {
  4372. "get": {
  4373. "produces": [
  4374. "application/json"
  4375. ],
  4376. "tags": [
  4377. "repository"
  4378. ],
  4379. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  4380. "operationId": "repoGetCombinedStatusByRef",
  4381. "parameters": [
  4382. {
  4383. "type": "string",
  4384. "description": "owner of the repo",
  4385. "name": "owner",
  4386. "in": "path",
  4387. "required": true
  4388. },
  4389. {
  4390. "type": "string",
  4391. "description": "name of the repo",
  4392. "name": "repo",
  4393. "in": "path",
  4394. "required": true
  4395. },
  4396. {
  4397. "type": "string",
  4398. "description": "name of branch/tag/commit",
  4399. "name": "ref",
  4400. "in": "path",
  4401. "required": true
  4402. },
  4403. {
  4404. "type": "integer",
  4405. "description": "page number of results to return (1-based)",
  4406. "name": "page",
  4407. "in": "query"
  4408. },
  4409. {
  4410. "type": "integer",
  4411. "description": "page size of results",
  4412. "name": "limit",
  4413. "in": "query"
  4414. }
  4415. ],
  4416. "responses": {
  4417. "200": {
  4418. "$ref": "#/responses/CombinedStatus"
  4419. },
  4420. "400": {
  4421. "$ref": "#/responses/error"
  4422. },
  4423. "404": {
  4424. "$ref": "#/responses/notFound"
  4425. }
  4426. }
  4427. }
  4428. },
  4429. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  4430. "get": {
  4431. "produces": [
  4432. "application/json"
  4433. ],
  4434. "tags": [
  4435. "repository"
  4436. ],
  4437. "summary": "Get a commit's statuses, by branch/tag/commit reference",
  4438. "operationId": "repoListStatusesByRef",
  4439. "parameters": [
  4440. {
  4441. "type": "string",
  4442. "description": "owner of the repo",
  4443. "name": "owner",
  4444. "in": "path",
  4445. "required": true
  4446. },
  4447. {
  4448. "type": "string",
  4449. "description": "name of the repo",
  4450. "name": "repo",
  4451. "in": "path",
  4452. "required": true
  4453. },
  4454. {
  4455. "type": "string",
  4456. "description": "name of branch/tag/commit",
  4457. "name": "ref",
  4458. "in": "path",
  4459. "required": true
  4460. },
  4461. {
  4462. "enum": [
  4463. "oldest",
  4464. "recentupdate",
  4465. "leastupdate",
  4466. "leastindex",
  4467. "highestindex"
  4468. ],
  4469. "type": "string",
  4470. "description": "type of sort",
  4471. "name": "sort",
  4472. "in": "query"
  4473. },
  4474. {
  4475. "enum": [
  4476. "pending",
  4477. "success",
  4478. "error",
  4479. "failure",
  4480. "warning"
  4481. ],
  4482. "type": "string",
  4483. "description": "type of state",
  4484. "name": "state",
  4485. "in": "query"
  4486. },
  4487. {
  4488. "type": "integer",
  4489. "description": "page number of results to return (1-based)",
  4490. "name": "page",
  4491. "in": "query"
  4492. },
  4493. {
  4494. "type": "integer",
  4495. "description": "page size of results",
  4496. "name": "limit",
  4497. "in": "query"
  4498. }
  4499. ],
  4500. "responses": {
  4501. "200": {
  4502. "$ref": "#/responses/CommitStatusList"
  4503. },
  4504. "400": {
  4505. "$ref": "#/responses/error"
  4506. },
  4507. "404": {
  4508. "$ref": "#/responses/notFound"
  4509. }
  4510. }
  4511. }
  4512. },
  4513. "/repos/{owner}/{repo}/contents": {
  4514. "get": {
  4515. "produces": [
  4516. "application/json"
  4517. ],
  4518. "tags": [
  4519. "repository"
  4520. ],
  4521. "summary": "Gets the metadata of all the entries of the root dir",
  4522. "operationId": "repoGetContentsList",
  4523. "parameters": [
  4524. {
  4525. "type": "string",
  4526. "description": "owner of the repo",
  4527. "name": "owner",
  4528. "in": "path",
  4529. "required": true
  4530. },
  4531. {
  4532. "type": "string",
  4533. "description": "name of the repo",
  4534. "name": "repo",
  4535. "in": "path",
  4536. "required": true
  4537. },
  4538. {
  4539. "type": "string",
  4540. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4541. "name": "ref",
  4542. "in": "query"
  4543. }
  4544. ],
  4545. "responses": {
  4546. "200": {
  4547. "$ref": "#/responses/ContentsListResponse"
  4548. },
  4549. "404": {
  4550. "$ref": "#/responses/notFound"
  4551. }
  4552. }
  4553. },
  4554. "post": {
  4555. "consumes": [
  4556. "application/json"
  4557. ],
  4558. "produces": [
  4559. "application/json"
  4560. ],
  4561. "tags": [
  4562. "repository"
  4563. ],
  4564. "summary": "Modify multiple files in a repository",
  4565. "operationId": "repoChangeFiles",
  4566. "parameters": [
  4567. {
  4568. "type": "string",
  4569. "description": "owner of the repo",
  4570. "name": "owner",
  4571. "in": "path",
  4572. "required": true
  4573. },
  4574. {
  4575. "type": "string",
  4576. "description": "name of the repo",
  4577. "name": "repo",
  4578. "in": "path",
  4579. "required": true
  4580. },
  4581. {
  4582. "name": "body",
  4583. "in": "body",
  4584. "required": true,
  4585. "schema": {
  4586. "$ref": "#/definitions/ChangeFilesOptions"
  4587. }
  4588. }
  4589. ],
  4590. "responses": {
  4591. "201": {
  4592. "$ref": "#/responses/FilesResponse"
  4593. },
  4594. "403": {
  4595. "$ref": "#/responses/error"
  4596. },
  4597. "404": {
  4598. "$ref": "#/responses/notFound"
  4599. },
  4600. "422": {
  4601. "$ref": "#/responses/error"
  4602. }
  4603. }
  4604. }
  4605. },
  4606. "/repos/{owner}/{repo}/contents/{filepath}": {
  4607. "get": {
  4608. "produces": [
  4609. "application/json"
  4610. ],
  4611. "tags": [
  4612. "repository"
  4613. ],
  4614. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  4615. "operationId": "repoGetContents",
  4616. "parameters": [
  4617. {
  4618. "type": "string",
  4619. "description": "owner of the repo",
  4620. "name": "owner",
  4621. "in": "path",
  4622. "required": true
  4623. },
  4624. {
  4625. "type": "string",
  4626. "description": "name of the repo",
  4627. "name": "repo",
  4628. "in": "path",
  4629. "required": true
  4630. },
  4631. {
  4632. "type": "string",
  4633. "description": "path of the dir, file, symlink or submodule in the repo",
  4634. "name": "filepath",
  4635. "in": "path",
  4636. "required": true
  4637. },
  4638. {
  4639. "type": "string",
  4640. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4641. "name": "ref",
  4642. "in": "query"
  4643. }
  4644. ],
  4645. "responses": {
  4646. "200": {
  4647. "$ref": "#/responses/ContentsResponse"
  4648. },
  4649. "404": {
  4650. "$ref": "#/responses/notFound"
  4651. }
  4652. }
  4653. },
  4654. "put": {
  4655. "consumes": [
  4656. "application/json"
  4657. ],
  4658. "produces": [
  4659. "application/json"
  4660. ],
  4661. "tags": [
  4662. "repository"
  4663. ],
  4664. "summary": "Update a file in a repository",
  4665. "operationId": "repoUpdateFile",
  4666. "parameters": [
  4667. {
  4668. "type": "string",
  4669. "description": "owner of the repo",
  4670. "name": "owner",
  4671. "in": "path",
  4672. "required": true
  4673. },
  4674. {
  4675. "type": "string",
  4676. "description": "name of the repo",
  4677. "name": "repo",
  4678. "in": "path",
  4679. "required": true
  4680. },
  4681. {
  4682. "type": "string",
  4683. "description": "path of the file to update",
  4684. "name": "filepath",
  4685. "in": "path",
  4686. "required": true
  4687. },
  4688. {
  4689. "name": "body",
  4690. "in": "body",
  4691. "required": true,
  4692. "schema": {
  4693. "$ref": "#/definitions/UpdateFileOptions"
  4694. }
  4695. }
  4696. ],
  4697. "responses": {
  4698. "200": {
  4699. "$ref": "#/responses/FileResponse"
  4700. },
  4701. "403": {
  4702. "$ref": "#/responses/error"
  4703. },
  4704. "404": {
  4705. "$ref": "#/responses/notFound"
  4706. },
  4707. "422": {
  4708. "$ref": "#/responses/error"
  4709. }
  4710. }
  4711. },
  4712. "post": {
  4713. "consumes": [
  4714. "application/json"
  4715. ],
  4716. "produces": [
  4717. "application/json"
  4718. ],
  4719. "tags": [
  4720. "repository"
  4721. ],
  4722. "summary": "Create a file in a repository",
  4723. "operationId": "repoCreateFile",
  4724. "parameters": [
  4725. {
  4726. "type": "string",
  4727. "description": "owner of the repo",
  4728. "name": "owner",
  4729. "in": "path",
  4730. "required": true
  4731. },
  4732. {
  4733. "type": "string",
  4734. "description": "name of the repo",
  4735. "name": "repo",
  4736. "in": "path",
  4737. "required": true
  4738. },
  4739. {
  4740. "type": "string",
  4741. "description": "path of the file to create",
  4742. "name": "filepath",
  4743. "in": "path",
  4744. "required": true
  4745. },
  4746. {
  4747. "name": "body",
  4748. "in": "body",
  4749. "required": true,
  4750. "schema": {
  4751. "$ref": "#/definitions/CreateFileOptions"
  4752. }
  4753. }
  4754. ],
  4755. "responses": {
  4756. "201": {
  4757. "$ref": "#/responses/FileResponse"
  4758. },
  4759. "403": {
  4760. "$ref": "#/responses/error"
  4761. },
  4762. "404": {
  4763. "$ref": "#/responses/notFound"
  4764. },
  4765. "422": {
  4766. "$ref": "#/responses/error"
  4767. }
  4768. }
  4769. },
  4770. "delete": {
  4771. "consumes": [
  4772. "application/json"
  4773. ],
  4774. "produces": [
  4775. "application/json"
  4776. ],
  4777. "tags": [
  4778. "repository"
  4779. ],
  4780. "summary": "Delete a file in a repository",
  4781. "operationId": "repoDeleteFile",
  4782. "parameters": [
  4783. {
  4784. "type": "string",
  4785. "description": "owner of the repo",
  4786. "name": "owner",
  4787. "in": "path",
  4788. "required": true
  4789. },
  4790. {
  4791. "type": "string",
  4792. "description": "name of the repo",
  4793. "name": "repo",
  4794. "in": "path",
  4795. "required": true
  4796. },
  4797. {
  4798. "type": "string",
  4799. "description": "path of the file to delete",
  4800. "name": "filepath",
  4801. "in": "path",
  4802. "required": true
  4803. },
  4804. {
  4805. "name": "body",
  4806. "in": "body",
  4807. "required": true,
  4808. "schema": {
  4809. "$ref": "#/definitions/DeleteFileOptions"
  4810. }
  4811. }
  4812. ],
  4813. "responses": {
  4814. "200": {
  4815. "$ref": "#/responses/FileDeleteResponse"
  4816. },
  4817. "400": {
  4818. "$ref": "#/responses/error"
  4819. },
  4820. "403": {
  4821. "$ref": "#/responses/error"
  4822. },
  4823. "404": {
  4824. "$ref": "#/responses/error"
  4825. }
  4826. }
  4827. }
  4828. },
  4829. "/repos/{owner}/{repo}/diffpatch": {
  4830. "post": {
  4831. "consumes": [
  4832. "application/json"
  4833. ],
  4834. "produces": [
  4835. "application/json"
  4836. ],
  4837. "tags": [
  4838. "repository"
  4839. ],
  4840. "summary": "Apply diff patch to repository",
  4841. "operationId": "repoApplyDiffPatch",
  4842. "parameters": [
  4843. {
  4844. "type": "string",
  4845. "description": "owner of the repo",
  4846. "name": "owner",
  4847. "in": "path",
  4848. "required": true
  4849. },
  4850. {
  4851. "type": "string",
  4852. "description": "name of the repo",
  4853. "name": "repo",
  4854. "in": "path",
  4855. "required": true
  4856. },
  4857. {
  4858. "name": "body",
  4859. "in": "body",
  4860. "required": true,
  4861. "schema": {
  4862. "$ref": "#/definitions/UpdateFileOptions"
  4863. }
  4864. }
  4865. ],
  4866. "responses": {
  4867. "200": {
  4868. "$ref": "#/responses/FileResponse"
  4869. },
  4870. "404": {
  4871. "$ref": "#/responses/notFound"
  4872. }
  4873. }
  4874. }
  4875. },
  4876. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  4877. "get": {
  4878. "produces": [
  4879. "application/json"
  4880. ],
  4881. "tags": [
  4882. "repository"
  4883. ],
  4884. "summary": "Get the EditorConfig definitions of a file in a repository",
  4885. "operationId": "repoGetEditorConfig",
  4886. "parameters": [
  4887. {
  4888. "type": "string",
  4889. "description": "owner of the repo",
  4890. "name": "owner",
  4891. "in": "path",
  4892. "required": true
  4893. },
  4894. {
  4895. "type": "string",
  4896. "description": "name of the repo",
  4897. "name": "repo",
  4898. "in": "path",
  4899. "required": true
  4900. },
  4901. {
  4902. "type": "string",
  4903. "description": "filepath of file to get",
  4904. "name": "filepath",
  4905. "in": "path",
  4906. "required": true
  4907. },
  4908. {
  4909. "type": "string",
  4910. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  4911. "name": "ref",
  4912. "in": "query"
  4913. }
  4914. ],
  4915. "responses": {
  4916. "200": {
  4917. "description": "success"
  4918. },
  4919. "404": {
  4920. "$ref": "#/responses/notFound"
  4921. }
  4922. }
  4923. }
  4924. },
  4925. "/repos/{owner}/{repo}/forks": {
  4926. "get": {
  4927. "produces": [
  4928. "application/json"
  4929. ],
  4930. "tags": [
  4931. "repository"
  4932. ],
  4933. "summary": "List a repository's forks",
  4934. "operationId": "listForks",
  4935. "parameters": [
  4936. {
  4937. "type": "string",
  4938. "description": "owner of the repo",
  4939. "name": "owner",
  4940. "in": "path",
  4941. "required": true
  4942. },
  4943. {
  4944. "type": "string",
  4945. "description": "name of the repo",
  4946. "name": "repo",
  4947. "in": "path",
  4948. "required": true
  4949. },
  4950. {
  4951. "type": "integer",
  4952. "description": "page number of results to return (1-based)",
  4953. "name": "page",
  4954. "in": "query"
  4955. },
  4956. {
  4957. "type": "integer",
  4958. "description": "page size of results",
  4959. "name": "limit",
  4960. "in": "query"
  4961. }
  4962. ],
  4963. "responses": {
  4964. "200": {
  4965. "$ref": "#/responses/RepositoryList"
  4966. },
  4967. "404": {
  4968. "$ref": "#/responses/notFound"
  4969. }
  4970. }
  4971. },
  4972. "post": {
  4973. "produces": [
  4974. "application/json"
  4975. ],
  4976. "tags": [
  4977. "repository"
  4978. ],
  4979. "summary": "Fork a repository",
  4980. "operationId": "createFork",
  4981. "parameters": [
  4982. {
  4983. "type": "string",
  4984. "description": "owner of the repo to fork",
  4985. "name": "owner",
  4986. "in": "path",
  4987. "required": true
  4988. },
  4989. {
  4990. "type": "string",
  4991. "description": "name of the repo to fork",
  4992. "name": "repo",
  4993. "in": "path",
  4994. "required": true
  4995. },
  4996. {
  4997. "name": "body",
  4998. "in": "body",
  4999. "schema": {
  5000. "$ref": "#/definitions/CreateForkOption"
  5001. }
  5002. }
  5003. ],
  5004. "responses": {
  5005. "202": {
  5006. "$ref": "#/responses/Repository"
  5007. },
  5008. "403": {
  5009. "$ref": "#/responses/forbidden"
  5010. },
  5011. "404": {
  5012. "$ref": "#/responses/notFound"
  5013. },
  5014. "409": {
  5015. "description": "The repository with the same name already exists."
  5016. },
  5017. "422": {
  5018. "$ref": "#/responses/validationError"
  5019. }
  5020. }
  5021. }
  5022. },
  5023. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  5024. "get": {
  5025. "produces": [
  5026. "application/json"
  5027. ],
  5028. "tags": [
  5029. "repository"
  5030. ],
  5031. "summary": "Gets the blob of a repository.",
  5032. "operationId": "GetBlob",
  5033. "parameters": [
  5034. {
  5035. "type": "string",
  5036. "description": "owner of the repo",
  5037. "name": "owner",
  5038. "in": "path",
  5039. "required": true
  5040. },
  5041. {
  5042. "type": "string",
  5043. "description": "name of the repo",
  5044. "name": "repo",
  5045. "in": "path",
  5046. "required": true
  5047. },
  5048. {
  5049. "type": "string",
  5050. "description": "sha of the commit",
  5051. "name": "sha",
  5052. "in": "path",
  5053. "required": true
  5054. }
  5055. ],
  5056. "responses": {
  5057. "200": {
  5058. "$ref": "#/responses/GitBlobResponse"
  5059. },
  5060. "400": {
  5061. "$ref": "#/responses/error"
  5062. },
  5063. "404": {
  5064. "$ref": "#/responses/notFound"
  5065. }
  5066. }
  5067. }
  5068. },
  5069. "/repos/{owner}/{repo}/git/commits/{sha}": {
  5070. "get": {
  5071. "produces": [
  5072. "application/json"
  5073. ],
  5074. "tags": [
  5075. "repository"
  5076. ],
  5077. "summary": "Get a single commit from a repository",
  5078. "operationId": "repoGetSingleCommit",
  5079. "parameters": [
  5080. {
  5081. "type": "string",
  5082. "description": "owner of the repo",
  5083. "name": "owner",
  5084. "in": "path",
  5085. "required": true
  5086. },
  5087. {
  5088. "type": "string",
  5089. "description": "name of the repo",
  5090. "name": "repo",
  5091. "in": "path",
  5092. "required": true
  5093. },
  5094. {
  5095. "type": "string",
  5096. "description": "a git ref or commit sha",
  5097. "name": "sha",
  5098. "in": "path",
  5099. "required": true
  5100. },
  5101. {
  5102. "type": "boolean",
  5103. "description": "include diff stats for every commit (disable for speedup, default 'true')",
  5104. "name": "stat",
  5105. "in": "query"
  5106. },
  5107. {
  5108. "type": "boolean",
  5109. "description": "include verification for every commit (disable for speedup, default 'true')",
  5110. "name": "verification",
  5111. "in": "query"
  5112. },
  5113. {
  5114. "type": "boolean",
  5115. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5116. "name": "files",
  5117. "in": "query"
  5118. }
  5119. ],
  5120. "responses": {
  5121. "200": {
  5122. "$ref": "#/responses/Commit"
  5123. },
  5124. "404": {
  5125. "$ref": "#/responses/notFound"
  5126. },
  5127. "422": {
  5128. "$ref": "#/responses/validationError"
  5129. }
  5130. }
  5131. }
  5132. },
  5133. "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
  5134. "get": {
  5135. "produces": [
  5136. "text/plain"
  5137. ],
  5138. "tags": [
  5139. "repository"
  5140. ],
  5141. "summary": "Get a commit's diff or patch",
  5142. "operationId": "repoDownloadCommitDiffOrPatch",
  5143. "parameters": [
  5144. {
  5145. "type": "string",
  5146. "description": "owner of the repo",
  5147. "name": "owner",
  5148. "in": "path",
  5149. "required": true
  5150. },
  5151. {
  5152. "type": "string",
  5153. "description": "name of the repo",
  5154. "name": "repo",
  5155. "in": "path",
  5156. "required": true
  5157. },
  5158. {
  5159. "type": "string",
  5160. "description": "SHA of the commit to get",
  5161. "name": "sha",
  5162. "in": "path",
  5163. "required": true
  5164. },
  5165. {
  5166. "enum": [
  5167. "diff",
  5168. "patch"
  5169. ],
  5170. "type": "string",
  5171. "description": "whether the output is diff or patch",
  5172. "name": "diffType",
  5173. "in": "path",
  5174. "required": true
  5175. }
  5176. ],
  5177. "responses": {
  5178. "200": {
  5179. "$ref": "#/responses/string"
  5180. },
  5181. "404": {
  5182. "$ref": "#/responses/notFound"
  5183. }
  5184. }
  5185. }
  5186. },
  5187. "/repos/{owner}/{repo}/git/notes/{sha}": {
  5188. "get": {
  5189. "produces": [
  5190. "application/json"
  5191. ],
  5192. "tags": [
  5193. "repository"
  5194. ],
  5195. "summary": "Get a note corresponding to a single commit from a repository",
  5196. "operationId": "repoGetNote",
  5197. "parameters": [
  5198. {
  5199. "type": "string",
  5200. "description": "owner of the repo",
  5201. "name": "owner",
  5202. "in": "path",
  5203. "required": true
  5204. },
  5205. {
  5206. "type": "string",
  5207. "description": "name of the repo",
  5208. "name": "repo",
  5209. "in": "path",
  5210. "required": true
  5211. },
  5212. {
  5213. "type": "string",
  5214. "description": "a git ref or commit sha",
  5215. "name": "sha",
  5216. "in": "path",
  5217. "required": true
  5218. },
  5219. {
  5220. "type": "boolean",
  5221. "description": "include verification for every commit (disable for speedup, default 'true')",
  5222. "name": "verification",
  5223. "in": "query"
  5224. },
  5225. {
  5226. "type": "boolean",
  5227. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  5228. "name": "files",
  5229. "in": "query"
  5230. }
  5231. ],
  5232. "responses": {
  5233. "200": {
  5234. "$ref": "#/responses/Note"
  5235. },
  5236. "404": {
  5237. "$ref": "#/responses/notFound"
  5238. },
  5239. "422": {
  5240. "$ref": "#/responses/validationError"
  5241. }
  5242. }
  5243. }
  5244. },
  5245. "/repos/{owner}/{repo}/git/refs": {
  5246. "get": {
  5247. "produces": [
  5248. "application/json"
  5249. ],
  5250. "tags": [
  5251. "repository"
  5252. ],
  5253. "summary": "Get specified ref or filtered repository's refs",
  5254. "operationId": "repoListAllGitRefs",
  5255. "parameters": [
  5256. {
  5257. "type": "string",
  5258. "description": "owner of the repo",
  5259. "name": "owner",
  5260. "in": "path",
  5261. "required": true
  5262. },
  5263. {
  5264. "type": "string",
  5265. "description": "name of the repo",
  5266. "name": "repo",
  5267. "in": "path",
  5268. "required": true
  5269. }
  5270. ],
  5271. "responses": {
  5272. "200": {
  5273. "$ref": "#/responses/ReferenceList"
  5274. },
  5275. "404": {
  5276. "$ref": "#/responses/notFound"
  5277. }
  5278. }
  5279. }
  5280. },
  5281. "/repos/{owner}/{repo}/git/refs/{ref}": {
  5282. "get": {
  5283. "produces": [
  5284. "application/json"
  5285. ],
  5286. "tags": [
  5287. "repository"
  5288. ],
  5289. "summary": "Get specified ref or filtered repository's refs",
  5290. "operationId": "repoListGitRefs",
  5291. "parameters": [
  5292. {
  5293. "type": "string",
  5294. "description": "owner of the repo",
  5295. "name": "owner",
  5296. "in": "path",
  5297. "required": true
  5298. },
  5299. {
  5300. "type": "string",
  5301. "description": "name of the repo",
  5302. "name": "repo",
  5303. "in": "path",
  5304. "required": true
  5305. },
  5306. {
  5307. "type": "string",
  5308. "description": "part or full name of the ref",
  5309. "name": "ref",
  5310. "in": "path",
  5311. "required": true
  5312. }
  5313. ],
  5314. "responses": {
  5315. "200": {
  5316. "$ref": "#/responses/ReferenceList"
  5317. },
  5318. "404": {
  5319. "$ref": "#/responses/notFound"
  5320. }
  5321. }
  5322. }
  5323. },
  5324. "/repos/{owner}/{repo}/git/tags/{sha}": {
  5325. "get": {
  5326. "produces": [
  5327. "application/json"
  5328. ],
  5329. "tags": [
  5330. "repository"
  5331. ],
  5332. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  5333. "operationId": "GetAnnotatedTag",
  5334. "parameters": [
  5335. {
  5336. "type": "string",
  5337. "description": "owner of the repo",
  5338. "name": "owner",
  5339. "in": "path",
  5340. "required": true
  5341. },
  5342. {
  5343. "type": "string",
  5344. "description": "name of the repo",
  5345. "name": "repo",
  5346. "in": "path",
  5347. "required": true
  5348. },
  5349. {
  5350. "type": "string",
  5351. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  5352. "name": "sha",
  5353. "in": "path",
  5354. "required": true
  5355. }
  5356. ],
  5357. "responses": {
  5358. "200": {
  5359. "$ref": "#/responses/AnnotatedTag"
  5360. },
  5361. "400": {
  5362. "$ref": "#/responses/error"
  5363. },
  5364. "404": {
  5365. "$ref": "#/responses/notFound"
  5366. }
  5367. }
  5368. }
  5369. },
  5370. "/repos/{owner}/{repo}/git/trees/{sha}": {
  5371. "get": {
  5372. "produces": [
  5373. "application/json"
  5374. ],
  5375. "tags": [
  5376. "repository"
  5377. ],
  5378. "summary": "Gets the tree of a repository.",
  5379. "operationId": "GetTree",
  5380. "parameters": [
  5381. {
  5382. "type": "string",
  5383. "description": "owner of the repo",
  5384. "name": "owner",
  5385. "in": "path",
  5386. "required": true
  5387. },
  5388. {
  5389. "type": "string",
  5390. "description": "name of the repo",
  5391. "name": "repo",
  5392. "in": "path",
  5393. "required": true
  5394. },
  5395. {
  5396. "type": "string",
  5397. "description": "sha of the commit",
  5398. "name": "sha",
  5399. "in": "path",
  5400. "required": true
  5401. },
  5402. {
  5403. "type": "boolean",
  5404. "description": "show all directories and files",
  5405. "name": "recursive",
  5406. "in": "query"
  5407. },
  5408. {
  5409. "type": "integer",
  5410. "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",
  5411. "name": "page",
  5412. "in": "query"
  5413. },
  5414. {
  5415. "type": "integer",
  5416. "description": "number of items per page",
  5417. "name": "per_page",
  5418. "in": "query"
  5419. }
  5420. ],
  5421. "responses": {
  5422. "200": {
  5423. "$ref": "#/responses/GitTreeResponse"
  5424. },
  5425. "400": {
  5426. "$ref": "#/responses/error"
  5427. },
  5428. "404": {
  5429. "$ref": "#/responses/notFound"
  5430. }
  5431. }
  5432. }
  5433. },
  5434. "/repos/{owner}/{repo}/hooks": {
  5435. "get": {
  5436. "produces": [
  5437. "application/json"
  5438. ],
  5439. "tags": [
  5440. "repository"
  5441. ],
  5442. "summary": "List the hooks in a repository",
  5443. "operationId": "repoListHooks",
  5444. "parameters": [
  5445. {
  5446. "type": "string",
  5447. "description": "owner of the repo",
  5448. "name": "owner",
  5449. "in": "path",
  5450. "required": true
  5451. },
  5452. {
  5453. "type": "string",
  5454. "description": "name of the repo",
  5455. "name": "repo",
  5456. "in": "path",
  5457. "required": true
  5458. },
  5459. {
  5460. "type": "integer",
  5461. "description": "page number of results to return (1-based)",
  5462. "name": "page",
  5463. "in": "query"
  5464. },
  5465. {
  5466. "type": "integer",
  5467. "description": "page size of results",
  5468. "name": "limit",
  5469. "in": "query"
  5470. }
  5471. ],
  5472. "responses": {
  5473. "200": {
  5474. "$ref": "#/responses/HookList"
  5475. },
  5476. "404": {
  5477. "$ref": "#/responses/notFound"
  5478. }
  5479. }
  5480. },
  5481. "post": {
  5482. "consumes": [
  5483. "application/json"
  5484. ],
  5485. "produces": [
  5486. "application/json"
  5487. ],
  5488. "tags": [
  5489. "repository"
  5490. ],
  5491. "summary": "Create a hook",
  5492. "operationId": "repoCreateHook",
  5493. "parameters": [
  5494. {
  5495. "type": "string",
  5496. "description": "owner of the repo",
  5497. "name": "owner",
  5498. "in": "path",
  5499. "required": true
  5500. },
  5501. {
  5502. "type": "string",
  5503. "description": "name of the repo",
  5504. "name": "repo",
  5505. "in": "path",
  5506. "required": true
  5507. },
  5508. {
  5509. "name": "body",
  5510. "in": "body",
  5511. "schema": {
  5512. "$ref": "#/definitions/CreateHookOption"
  5513. }
  5514. }
  5515. ],
  5516. "responses": {
  5517. "201": {
  5518. "$ref": "#/responses/Hook"
  5519. },
  5520. "404": {
  5521. "$ref": "#/responses/notFound"
  5522. }
  5523. }
  5524. }
  5525. },
  5526. "/repos/{owner}/{repo}/hooks/git": {
  5527. "get": {
  5528. "produces": [
  5529. "application/json"
  5530. ],
  5531. "tags": [
  5532. "repository"
  5533. ],
  5534. "summary": "List the Git hooks in a repository",
  5535. "operationId": "repoListGitHooks",
  5536. "parameters": [
  5537. {
  5538. "type": "string",
  5539. "description": "owner of the repo",
  5540. "name": "owner",
  5541. "in": "path",
  5542. "required": true
  5543. },
  5544. {
  5545. "type": "string",
  5546. "description": "name of the repo",
  5547. "name": "repo",
  5548. "in": "path",
  5549. "required": true
  5550. }
  5551. ],
  5552. "responses": {
  5553. "200": {
  5554. "$ref": "#/responses/GitHookList"
  5555. },
  5556. "404": {
  5557. "$ref": "#/responses/notFound"
  5558. }
  5559. }
  5560. }
  5561. },
  5562. "/repos/{owner}/{repo}/hooks/git/{id}": {
  5563. "get": {
  5564. "produces": [
  5565. "application/json"
  5566. ],
  5567. "tags": [
  5568. "repository"
  5569. ],
  5570. "summary": "Get a Git hook",
  5571. "operationId": "repoGetGitHook",
  5572. "parameters": [
  5573. {
  5574. "type": "string",
  5575. "description": "owner of the repo",
  5576. "name": "owner",
  5577. "in": "path",
  5578. "required": true
  5579. },
  5580. {
  5581. "type": "string",
  5582. "description": "name of the repo",
  5583. "name": "repo",
  5584. "in": "path",
  5585. "required": true
  5586. },
  5587. {
  5588. "type": "string",
  5589. "description": "id of the hook to get",
  5590. "name": "id",
  5591. "in": "path",
  5592. "required": true
  5593. }
  5594. ],
  5595. "responses": {
  5596. "200": {
  5597. "$ref": "#/responses/GitHook"
  5598. },
  5599. "404": {
  5600. "$ref": "#/responses/notFound"
  5601. }
  5602. }
  5603. },
  5604. "delete": {
  5605. "produces": [
  5606. "application/json"
  5607. ],
  5608. "tags": [
  5609. "repository"
  5610. ],
  5611. "summary": "Delete a Git hook in a repository",
  5612. "operationId": "repoDeleteGitHook",
  5613. "parameters": [
  5614. {
  5615. "type": "string",
  5616. "description": "owner of the repo",
  5617. "name": "owner",
  5618. "in": "path",
  5619. "required": true
  5620. },
  5621. {
  5622. "type": "string",
  5623. "description": "name of the repo",
  5624. "name": "repo",
  5625. "in": "path",
  5626. "required": true
  5627. },
  5628. {
  5629. "type": "string",
  5630. "description": "id of the hook to get",
  5631. "name": "id",
  5632. "in": "path",
  5633. "required": true
  5634. }
  5635. ],
  5636. "responses": {
  5637. "204": {
  5638. "$ref": "#/responses/empty"
  5639. },
  5640. "404": {
  5641. "$ref": "#/responses/notFound"
  5642. }
  5643. }
  5644. },
  5645. "patch": {
  5646. "produces": [
  5647. "application/json"
  5648. ],
  5649. "tags": [
  5650. "repository"
  5651. ],
  5652. "summary": "Edit a Git hook in a repository",
  5653. "operationId": "repoEditGitHook",
  5654. "parameters": [
  5655. {
  5656. "type": "string",
  5657. "description": "owner of the repo",
  5658. "name": "owner",
  5659. "in": "path",
  5660. "required": true
  5661. },
  5662. {
  5663. "type": "string",
  5664. "description": "name of the repo",
  5665. "name": "repo",
  5666. "in": "path",
  5667. "required": true
  5668. },
  5669. {
  5670. "type": "string",
  5671. "description": "id of the hook to get",
  5672. "name": "id",
  5673. "in": "path",
  5674. "required": true
  5675. },
  5676. {
  5677. "name": "body",
  5678. "in": "body",
  5679. "schema": {
  5680. "$ref": "#/definitions/EditGitHookOption"
  5681. }
  5682. }
  5683. ],
  5684. "responses": {
  5685. "200": {
  5686. "$ref": "#/responses/GitHook"
  5687. },
  5688. "404": {
  5689. "$ref": "#/responses/notFound"
  5690. }
  5691. }
  5692. }
  5693. },
  5694. "/repos/{owner}/{repo}/hooks/{id}": {
  5695. "get": {
  5696. "produces": [
  5697. "application/json"
  5698. ],
  5699. "tags": [
  5700. "repository"
  5701. ],
  5702. "summary": "Get a hook",
  5703. "operationId": "repoGetHook",
  5704. "parameters": [
  5705. {
  5706. "type": "string",
  5707. "description": "owner of the repo",
  5708. "name": "owner",
  5709. "in": "path",
  5710. "required": true
  5711. },
  5712. {
  5713. "type": "string",
  5714. "description": "name of the repo",
  5715. "name": "repo",
  5716. "in": "path",
  5717. "required": true
  5718. },
  5719. {
  5720. "type": "integer",
  5721. "format": "int64",
  5722. "description": "id of the hook to get",
  5723. "name": "id",
  5724. "in": "path",
  5725. "required": true
  5726. }
  5727. ],
  5728. "responses": {
  5729. "200": {
  5730. "$ref": "#/responses/Hook"
  5731. },
  5732. "404": {
  5733. "$ref": "#/responses/notFound"
  5734. }
  5735. }
  5736. },
  5737. "delete": {
  5738. "produces": [
  5739. "application/json"
  5740. ],
  5741. "tags": [
  5742. "repository"
  5743. ],
  5744. "summary": "Delete a hook in a repository",
  5745. "operationId": "repoDeleteHook",
  5746. "parameters": [
  5747. {
  5748. "type": "string",
  5749. "description": "owner of the repo",
  5750. "name": "owner",
  5751. "in": "path",
  5752. "required": true
  5753. },
  5754. {
  5755. "type": "string",
  5756. "description": "name of the repo",
  5757. "name": "repo",
  5758. "in": "path",
  5759. "required": true
  5760. },
  5761. {
  5762. "type": "integer",
  5763. "format": "int64",
  5764. "description": "id of the hook to delete",
  5765. "name": "id",
  5766. "in": "path",
  5767. "required": true
  5768. }
  5769. ],
  5770. "responses": {
  5771. "204": {
  5772. "$ref": "#/responses/empty"
  5773. },
  5774. "404": {
  5775. "$ref": "#/responses/notFound"
  5776. }
  5777. }
  5778. },
  5779. "patch": {
  5780. "produces": [
  5781. "application/json"
  5782. ],
  5783. "tags": [
  5784. "repository"
  5785. ],
  5786. "summary": "Edit a hook in a repository",
  5787. "operationId": "repoEditHook",
  5788. "parameters": [
  5789. {
  5790. "type": "string",
  5791. "description": "owner of the repo",
  5792. "name": "owner",
  5793. "in": "path",
  5794. "required": true
  5795. },
  5796. {
  5797. "type": "string",
  5798. "description": "name of the repo",
  5799. "name": "repo",
  5800. "in": "path",
  5801. "required": true
  5802. },
  5803. {
  5804. "type": "integer",
  5805. "format": "int64",
  5806. "description": "index of the hook",
  5807. "name": "id",
  5808. "in": "path",
  5809. "required": true
  5810. },
  5811. {
  5812. "name": "body",
  5813. "in": "body",
  5814. "schema": {
  5815. "$ref": "#/definitions/EditHookOption"
  5816. }
  5817. }
  5818. ],
  5819. "responses": {
  5820. "200": {
  5821. "$ref": "#/responses/Hook"
  5822. },
  5823. "404": {
  5824. "$ref": "#/responses/notFound"
  5825. }
  5826. }
  5827. }
  5828. },
  5829. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  5830. "post": {
  5831. "produces": [
  5832. "application/json"
  5833. ],
  5834. "tags": [
  5835. "repository"
  5836. ],
  5837. "summary": "Test a push webhook",
  5838. "operationId": "repoTestHook",
  5839. "parameters": [
  5840. {
  5841. "type": "string",
  5842. "description": "owner of the repo",
  5843. "name": "owner",
  5844. "in": "path",
  5845. "required": true
  5846. },
  5847. {
  5848. "type": "string",
  5849. "description": "name of the repo",
  5850. "name": "repo",
  5851. "in": "path",
  5852. "required": true
  5853. },
  5854. {
  5855. "type": "integer",
  5856. "format": "int64",
  5857. "description": "id of the hook to test",
  5858. "name": "id",
  5859. "in": "path",
  5860. "required": true
  5861. },
  5862. {
  5863. "type": "string",
  5864. "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
  5865. "name": "ref",
  5866. "in": "query"
  5867. }
  5868. ],
  5869. "responses": {
  5870. "204": {
  5871. "$ref": "#/responses/empty"
  5872. },
  5873. "404": {
  5874. "$ref": "#/responses/notFound"
  5875. }
  5876. }
  5877. }
  5878. },
  5879. "/repos/{owner}/{repo}/issue_config": {
  5880. "get": {
  5881. "produces": [
  5882. "application/json"
  5883. ],
  5884. "tags": [
  5885. "repository"
  5886. ],
  5887. "summary": "Returns the issue config for a repo",
  5888. "operationId": "repoGetIssueConfig",
  5889. "parameters": [
  5890. {
  5891. "type": "string",
  5892. "description": "owner of the repo",
  5893. "name": "owner",
  5894. "in": "path",
  5895. "required": true
  5896. },
  5897. {
  5898. "type": "string",
  5899. "description": "name of the repo",
  5900. "name": "repo",
  5901. "in": "path",
  5902. "required": true
  5903. }
  5904. ],
  5905. "responses": {
  5906. "200": {
  5907. "$ref": "#/responses/RepoIssueConfig"
  5908. },
  5909. "404": {
  5910. "$ref": "#/responses/notFound"
  5911. }
  5912. }
  5913. }
  5914. },
  5915. "/repos/{owner}/{repo}/issue_config/validate": {
  5916. "get": {
  5917. "produces": [
  5918. "application/json"
  5919. ],
  5920. "tags": [
  5921. "repository"
  5922. ],
  5923. "summary": "Returns the validation information for a issue config",
  5924. "operationId": "repoValidateIssueConfig",
  5925. "parameters": [
  5926. {
  5927. "type": "string",
  5928. "description": "owner of the repo",
  5929. "name": "owner",
  5930. "in": "path",
  5931. "required": true
  5932. },
  5933. {
  5934. "type": "string",
  5935. "description": "name of the repo",
  5936. "name": "repo",
  5937. "in": "path",
  5938. "required": true
  5939. }
  5940. ],
  5941. "responses": {
  5942. "200": {
  5943. "$ref": "#/responses/RepoIssueConfigValidation"
  5944. },
  5945. "404": {
  5946. "$ref": "#/responses/notFound"
  5947. }
  5948. }
  5949. }
  5950. },
  5951. "/repos/{owner}/{repo}/issue_templates": {
  5952. "get": {
  5953. "produces": [
  5954. "application/json"
  5955. ],
  5956. "tags": [
  5957. "repository"
  5958. ],
  5959. "summary": "Get available issue templates for a repository",
  5960. "operationId": "repoGetIssueTemplates",
  5961. "parameters": [
  5962. {
  5963. "type": "string",
  5964. "description": "owner of the repo",
  5965. "name": "owner",
  5966. "in": "path",
  5967. "required": true
  5968. },
  5969. {
  5970. "type": "string",
  5971. "description": "name of the repo",
  5972. "name": "repo",
  5973. "in": "path",
  5974. "required": true
  5975. }
  5976. ],
  5977. "responses": {
  5978. "200": {
  5979. "$ref": "#/responses/IssueTemplates"
  5980. },
  5981. "404": {
  5982. "$ref": "#/responses/notFound"
  5983. }
  5984. }
  5985. }
  5986. },
  5987. "/repos/{owner}/{repo}/issues": {
  5988. "get": {
  5989. "produces": [
  5990. "application/json"
  5991. ],
  5992. "tags": [
  5993. "issue"
  5994. ],
  5995. "summary": "List a repository's issues",
  5996. "operationId": "issueListIssues",
  5997. "parameters": [
  5998. {
  5999. "type": "string",
  6000. "description": "owner of the repo",
  6001. "name": "owner",
  6002. "in": "path",
  6003. "required": true
  6004. },
  6005. {
  6006. "type": "string",
  6007. "description": "name of the repo",
  6008. "name": "repo",
  6009. "in": "path",
  6010. "required": true
  6011. },
  6012. {
  6013. "enum": [
  6014. "closed",
  6015. "open",
  6016. "all"
  6017. ],
  6018. "type": "string",
  6019. "description": "whether issue is open or closed",
  6020. "name": "state",
  6021. "in": "query"
  6022. },
  6023. {
  6024. "type": "string",
  6025. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  6026. "name": "labels",
  6027. "in": "query"
  6028. },
  6029. {
  6030. "type": "string",
  6031. "description": "search string",
  6032. "name": "q",
  6033. "in": "query"
  6034. },
  6035. {
  6036. "enum": [
  6037. "issues",
  6038. "pulls"
  6039. ],
  6040. "type": "string",
  6041. "description": "filter by type (issues / pulls) if set",
  6042. "name": "type",
  6043. "in": "query"
  6044. },
  6045. {
  6046. "type": "string",
  6047. "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",
  6048. "name": "milestones",
  6049. "in": "query"
  6050. },
  6051. {
  6052. "type": "string",
  6053. "format": "date-time",
  6054. "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
  6055. "name": "since",
  6056. "in": "query"
  6057. },
  6058. {
  6059. "type": "string",
  6060. "format": "date-time",
  6061. "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
  6062. "name": "before",
  6063. "in": "query"
  6064. },
  6065. {
  6066. "type": "string",
  6067. "description": "Only show items which were created by the the given user",
  6068. "name": "created_by",
  6069. "in": "query"
  6070. },
  6071. {
  6072. "type": "string",
  6073. "description": "Only show items for which the given user is assigned",
  6074. "name": "assigned_by",
  6075. "in": "query"
  6076. },
  6077. {
  6078. "type": "string",
  6079. "description": "Only show items in which the given user was mentioned",
  6080. "name": "mentioned_by",
  6081. "in": "query"
  6082. },
  6083. {
  6084. "type": "integer",
  6085. "description": "page number of results to return (1-based)",
  6086. "name": "page",
  6087. "in": "query"
  6088. },
  6089. {
  6090. "type": "integer",
  6091. "description": "page size of results",
  6092. "name": "limit",
  6093. "in": "query"
  6094. }
  6095. ],
  6096. "responses": {
  6097. "200": {
  6098. "$ref": "#/responses/IssueList"
  6099. },
  6100. "404": {
  6101. "$ref": "#/responses/notFound"
  6102. }
  6103. }
  6104. },
  6105. "post": {
  6106. "consumes": [
  6107. "application/json"
  6108. ],
  6109. "produces": [
  6110. "application/json"
  6111. ],
  6112. "tags": [
  6113. "issue"
  6114. ],
  6115. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6116. "operationId": "issueCreateIssue",
  6117. "parameters": [
  6118. {
  6119. "type": "string",
  6120. "description": "owner of the repo",
  6121. "name": "owner",
  6122. "in": "path",
  6123. "required": true
  6124. },
  6125. {
  6126. "type": "string",
  6127. "description": "name of the repo",
  6128. "name": "repo",
  6129. "in": "path",
  6130. "required": true
  6131. },
  6132. {
  6133. "name": "body",
  6134. "in": "body",
  6135. "schema": {
  6136. "$ref": "#/definitions/CreateIssueOption"
  6137. }
  6138. }
  6139. ],
  6140. "responses": {
  6141. "201": {
  6142. "$ref": "#/responses/Issue"
  6143. },
  6144. "403": {
  6145. "$ref": "#/responses/forbidden"
  6146. },
  6147. "404": {
  6148. "$ref": "#/responses/notFound"
  6149. },
  6150. "412": {
  6151. "$ref": "#/responses/error"
  6152. },
  6153. "422": {
  6154. "$ref": "#/responses/validationError"
  6155. }
  6156. }
  6157. }
  6158. },
  6159. "/repos/{owner}/{repo}/issues/comments": {
  6160. "get": {
  6161. "produces": [
  6162. "application/json"
  6163. ],
  6164. "tags": [
  6165. "issue"
  6166. ],
  6167. "summary": "List all comments in a repository",
  6168. "operationId": "issueGetRepoComments",
  6169. "parameters": [
  6170. {
  6171. "type": "string",
  6172. "description": "owner of the repo",
  6173. "name": "owner",
  6174. "in": "path",
  6175. "required": true
  6176. },
  6177. {
  6178. "type": "string",
  6179. "description": "name of the repo",
  6180. "name": "repo",
  6181. "in": "path",
  6182. "required": true
  6183. },
  6184. {
  6185. "type": "string",
  6186. "format": "date-time",
  6187. "description": "if provided, only comments updated since the provided time are returned.",
  6188. "name": "since",
  6189. "in": "query"
  6190. },
  6191. {
  6192. "type": "string",
  6193. "format": "date-time",
  6194. "description": "if provided, only comments updated before the provided time are returned.",
  6195. "name": "before",
  6196. "in": "query"
  6197. },
  6198. {
  6199. "type": "integer",
  6200. "description": "page number of results to return (1-based)",
  6201. "name": "page",
  6202. "in": "query"
  6203. },
  6204. {
  6205. "type": "integer",
  6206. "description": "page size of results",
  6207. "name": "limit",
  6208. "in": "query"
  6209. }
  6210. ],
  6211. "responses": {
  6212. "200": {
  6213. "$ref": "#/responses/CommentList"
  6214. },
  6215. "404": {
  6216. "$ref": "#/responses/notFound"
  6217. }
  6218. }
  6219. }
  6220. },
  6221. "/repos/{owner}/{repo}/issues/comments/{id}": {
  6222. "get": {
  6223. "consumes": [
  6224. "application/json"
  6225. ],
  6226. "produces": [
  6227. "application/json"
  6228. ],
  6229. "tags": [
  6230. "issue"
  6231. ],
  6232. "summary": "Get a comment",
  6233. "operationId": "issueGetComment",
  6234. "parameters": [
  6235. {
  6236. "type": "string",
  6237. "description": "owner of the repo",
  6238. "name": "owner",
  6239. "in": "path",
  6240. "required": true
  6241. },
  6242. {
  6243. "type": "string",
  6244. "description": "name of the repo",
  6245. "name": "repo",
  6246. "in": "path",
  6247. "required": true
  6248. },
  6249. {
  6250. "type": "integer",
  6251. "format": "int64",
  6252. "description": "id of the comment",
  6253. "name": "id",
  6254. "in": "path",
  6255. "required": true
  6256. }
  6257. ],
  6258. "responses": {
  6259. "200": {
  6260. "$ref": "#/responses/Comment"
  6261. },
  6262. "204": {
  6263. "$ref": "#/responses/empty"
  6264. },
  6265. "403": {
  6266. "$ref": "#/responses/forbidden"
  6267. },
  6268. "404": {
  6269. "$ref": "#/responses/notFound"
  6270. }
  6271. }
  6272. },
  6273. "delete": {
  6274. "tags": [
  6275. "issue"
  6276. ],
  6277. "summary": "Delete a comment",
  6278. "operationId": "issueDeleteComment",
  6279. "parameters": [
  6280. {
  6281. "type": "string",
  6282. "description": "owner of the repo",
  6283. "name": "owner",
  6284. "in": "path",
  6285. "required": true
  6286. },
  6287. {
  6288. "type": "string",
  6289. "description": "name of the repo",
  6290. "name": "repo",
  6291. "in": "path",
  6292. "required": true
  6293. },
  6294. {
  6295. "type": "integer",
  6296. "format": "int64",
  6297. "description": "id of comment to delete",
  6298. "name": "id",
  6299. "in": "path",
  6300. "required": true
  6301. }
  6302. ],
  6303. "responses": {
  6304. "204": {
  6305. "$ref": "#/responses/empty"
  6306. },
  6307. "403": {
  6308. "$ref": "#/responses/forbidden"
  6309. },
  6310. "404": {
  6311. "$ref": "#/responses/notFound"
  6312. }
  6313. }
  6314. },
  6315. "patch": {
  6316. "consumes": [
  6317. "application/json"
  6318. ],
  6319. "produces": [
  6320. "application/json"
  6321. ],
  6322. "tags": [
  6323. "issue"
  6324. ],
  6325. "summary": "Edit a comment",
  6326. "operationId": "issueEditComment",
  6327. "parameters": [
  6328. {
  6329. "type": "string",
  6330. "description": "owner of the repo",
  6331. "name": "owner",
  6332. "in": "path",
  6333. "required": true
  6334. },
  6335. {
  6336. "type": "string",
  6337. "description": "name of the repo",
  6338. "name": "repo",
  6339. "in": "path",
  6340. "required": true
  6341. },
  6342. {
  6343. "type": "integer",
  6344. "format": "int64",
  6345. "description": "id of the comment to edit",
  6346. "name": "id",
  6347. "in": "path",
  6348. "required": true
  6349. },
  6350. {
  6351. "name": "body",
  6352. "in": "body",
  6353. "schema": {
  6354. "$ref": "#/definitions/EditIssueCommentOption"
  6355. }
  6356. }
  6357. ],
  6358. "responses": {
  6359. "200": {
  6360. "$ref": "#/responses/Comment"
  6361. },
  6362. "204": {
  6363. "$ref": "#/responses/empty"
  6364. },
  6365. "403": {
  6366. "$ref": "#/responses/forbidden"
  6367. },
  6368. "404": {
  6369. "$ref": "#/responses/notFound"
  6370. }
  6371. }
  6372. }
  6373. },
  6374. "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
  6375. "get": {
  6376. "produces": [
  6377. "application/json"
  6378. ],
  6379. "tags": [
  6380. "issue"
  6381. ],
  6382. "summary": "List comment's attachments",
  6383. "operationId": "issueListIssueCommentAttachments",
  6384. "parameters": [
  6385. {
  6386. "type": "string",
  6387. "description": "owner of the repo",
  6388. "name": "owner",
  6389. "in": "path",
  6390. "required": true
  6391. },
  6392. {
  6393. "type": "string",
  6394. "description": "name of the repo",
  6395. "name": "repo",
  6396. "in": "path",
  6397. "required": true
  6398. },
  6399. {
  6400. "type": "integer",
  6401. "format": "int64",
  6402. "description": "id of the comment",
  6403. "name": "id",
  6404. "in": "path",
  6405. "required": true
  6406. }
  6407. ],
  6408. "responses": {
  6409. "200": {
  6410. "$ref": "#/responses/AttachmentList"
  6411. },
  6412. "404": {
  6413. "$ref": "#/responses/error"
  6414. }
  6415. }
  6416. },
  6417. "post": {
  6418. "consumes": [
  6419. "multipart/form-data"
  6420. ],
  6421. "produces": [
  6422. "application/json"
  6423. ],
  6424. "tags": [
  6425. "issue"
  6426. ],
  6427. "summary": "Create a comment attachment",
  6428. "operationId": "issueCreateIssueCommentAttachment",
  6429. "parameters": [
  6430. {
  6431. "type": "string",
  6432. "description": "owner of the repo",
  6433. "name": "owner",
  6434. "in": "path",
  6435. "required": true
  6436. },
  6437. {
  6438. "type": "string",
  6439. "description": "name of the repo",
  6440. "name": "repo",
  6441. "in": "path",
  6442. "required": true
  6443. },
  6444. {
  6445. "type": "integer",
  6446. "format": "int64",
  6447. "description": "id of the comment",
  6448. "name": "id",
  6449. "in": "path",
  6450. "required": true
  6451. },
  6452. {
  6453. "type": "string",
  6454. "description": "name of the attachment",
  6455. "name": "name",
  6456. "in": "query"
  6457. },
  6458. {
  6459. "type": "file",
  6460. "description": "attachment to upload",
  6461. "name": "attachment",
  6462. "in": "formData",
  6463. "required": true
  6464. }
  6465. ],
  6466. "responses": {
  6467. "201": {
  6468. "$ref": "#/responses/Attachment"
  6469. },
  6470. "400": {
  6471. "$ref": "#/responses/error"
  6472. },
  6473. "404": {
  6474. "$ref": "#/responses/error"
  6475. }
  6476. }
  6477. }
  6478. },
  6479. "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
  6480. "get": {
  6481. "produces": [
  6482. "application/json"
  6483. ],
  6484. "tags": [
  6485. "issue"
  6486. ],
  6487. "summary": "Get a comment attachment",
  6488. "operationId": "issueGetIssueCommentAttachment",
  6489. "parameters": [
  6490. {
  6491. "type": "string",
  6492. "description": "owner of the repo",
  6493. "name": "owner",
  6494. "in": "path",
  6495. "required": true
  6496. },
  6497. {
  6498. "type": "string",
  6499. "description": "name of the repo",
  6500. "name": "repo",
  6501. "in": "path",
  6502. "required": true
  6503. },
  6504. {
  6505. "type": "integer",
  6506. "format": "int64",
  6507. "description": "id of the comment",
  6508. "name": "id",
  6509. "in": "path",
  6510. "required": true
  6511. },
  6512. {
  6513. "type": "integer",
  6514. "format": "int64",
  6515. "description": "id of the attachment to get",
  6516. "name": "attachment_id",
  6517. "in": "path",
  6518. "required": true
  6519. }
  6520. ],
  6521. "responses": {
  6522. "200": {
  6523. "$ref": "#/responses/Attachment"
  6524. },
  6525. "404": {
  6526. "$ref": "#/responses/error"
  6527. }
  6528. }
  6529. },
  6530. "delete": {
  6531. "produces": [
  6532. "application/json"
  6533. ],
  6534. "tags": [
  6535. "issue"
  6536. ],
  6537. "summary": "Delete a comment attachment",
  6538. "operationId": "issueDeleteIssueCommentAttachment",
  6539. "parameters": [
  6540. {
  6541. "type": "string",
  6542. "description": "owner of the repo",
  6543. "name": "owner",
  6544. "in": "path",
  6545. "required": true
  6546. },
  6547. {
  6548. "type": "string",
  6549. "description": "name of the repo",
  6550. "name": "repo",
  6551. "in": "path",
  6552. "required": true
  6553. },
  6554. {
  6555. "type": "integer",
  6556. "format": "int64",
  6557. "description": "id of the comment",
  6558. "name": "id",
  6559. "in": "path",
  6560. "required": true
  6561. },
  6562. {
  6563. "type": "integer",
  6564. "format": "int64",
  6565. "description": "id of the attachment to delete",
  6566. "name": "attachment_id",
  6567. "in": "path",
  6568. "required": true
  6569. }
  6570. ],
  6571. "responses": {
  6572. "204": {
  6573. "$ref": "#/responses/empty"
  6574. },
  6575. "404": {
  6576. "$ref": "#/responses/error"
  6577. }
  6578. }
  6579. },
  6580. "patch": {
  6581. "consumes": [
  6582. "application/json"
  6583. ],
  6584. "produces": [
  6585. "application/json"
  6586. ],
  6587. "tags": [
  6588. "issue"
  6589. ],
  6590. "summary": "Edit a comment attachment",
  6591. "operationId": "issueEditIssueCommentAttachment",
  6592. "parameters": [
  6593. {
  6594. "type": "string",
  6595. "description": "owner of the repo",
  6596. "name": "owner",
  6597. "in": "path",
  6598. "required": true
  6599. },
  6600. {
  6601. "type": "string",
  6602. "description": "name of the repo",
  6603. "name": "repo",
  6604. "in": "path",
  6605. "required": true
  6606. },
  6607. {
  6608. "type": "integer",
  6609. "format": "int64",
  6610. "description": "id of the comment",
  6611. "name": "id",
  6612. "in": "path",
  6613. "required": true
  6614. },
  6615. {
  6616. "type": "integer",
  6617. "format": "int64",
  6618. "description": "id of the attachment to edit",
  6619. "name": "attachment_id",
  6620. "in": "path",
  6621. "required": true
  6622. },
  6623. {
  6624. "name": "body",
  6625. "in": "body",
  6626. "schema": {
  6627. "$ref": "#/definitions/EditAttachmentOptions"
  6628. }
  6629. }
  6630. ],
  6631. "responses": {
  6632. "201": {
  6633. "$ref": "#/responses/Attachment"
  6634. },
  6635. "404": {
  6636. "$ref": "#/responses/error"
  6637. }
  6638. }
  6639. }
  6640. },
  6641. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  6642. "get": {
  6643. "consumes": [
  6644. "application/json"
  6645. ],
  6646. "produces": [
  6647. "application/json"
  6648. ],
  6649. "tags": [
  6650. "issue"
  6651. ],
  6652. "summary": "Get a list of reactions from a comment of an issue",
  6653. "operationId": "issueGetCommentReactions",
  6654. "parameters": [
  6655. {
  6656. "type": "string",
  6657. "description": "owner of the repo",
  6658. "name": "owner",
  6659. "in": "path",
  6660. "required": true
  6661. },
  6662. {
  6663. "type": "string",
  6664. "description": "name of the repo",
  6665. "name": "repo",
  6666. "in": "path",
  6667. "required": true
  6668. },
  6669. {
  6670. "type": "integer",
  6671. "format": "int64",
  6672. "description": "id of the comment to edit",
  6673. "name": "id",
  6674. "in": "path",
  6675. "required": true
  6676. }
  6677. ],
  6678. "responses": {
  6679. "200": {
  6680. "$ref": "#/responses/ReactionList"
  6681. },
  6682. "403": {
  6683. "$ref": "#/responses/forbidden"
  6684. },
  6685. "404": {
  6686. "$ref": "#/responses/notFound"
  6687. }
  6688. }
  6689. },
  6690. "post": {
  6691. "consumes": [
  6692. "application/json"
  6693. ],
  6694. "produces": [
  6695. "application/json"
  6696. ],
  6697. "tags": [
  6698. "issue"
  6699. ],
  6700. "summary": "Add a reaction to a comment of an issue",
  6701. "operationId": "issuePostCommentReaction",
  6702. "parameters": [
  6703. {
  6704. "type": "string",
  6705. "description": "owner of the repo",
  6706. "name": "owner",
  6707. "in": "path",
  6708. "required": true
  6709. },
  6710. {
  6711. "type": "string",
  6712. "description": "name of the repo",
  6713. "name": "repo",
  6714. "in": "path",
  6715. "required": true
  6716. },
  6717. {
  6718. "type": "integer",
  6719. "format": "int64",
  6720. "description": "id of the comment to edit",
  6721. "name": "id",
  6722. "in": "path",
  6723. "required": true
  6724. },
  6725. {
  6726. "name": "content",
  6727. "in": "body",
  6728. "schema": {
  6729. "$ref": "#/definitions/EditReactionOption"
  6730. }
  6731. }
  6732. ],
  6733. "responses": {
  6734. "200": {
  6735. "$ref": "#/responses/Reaction"
  6736. },
  6737. "201": {
  6738. "$ref": "#/responses/Reaction"
  6739. },
  6740. "403": {
  6741. "$ref": "#/responses/forbidden"
  6742. },
  6743. "404": {
  6744. "$ref": "#/responses/notFound"
  6745. }
  6746. }
  6747. },
  6748. "delete": {
  6749. "consumes": [
  6750. "application/json"
  6751. ],
  6752. "produces": [
  6753. "application/json"
  6754. ],
  6755. "tags": [
  6756. "issue"
  6757. ],
  6758. "summary": "Remove a reaction from a comment of an issue",
  6759. "operationId": "issueDeleteCommentReaction",
  6760. "parameters": [
  6761. {
  6762. "type": "string",
  6763. "description": "owner of the repo",
  6764. "name": "owner",
  6765. "in": "path",
  6766. "required": true
  6767. },
  6768. {
  6769. "type": "string",
  6770. "description": "name of the repo",
  6771. "name": "repo",
  6772. "in": "path",
  6773. "required": true
  6774. },
  6775. {
  6776. "type": "integer",
  6777. "format": "int64",
  6778. "description": "id of the comment to edit",
  6779. "name": "id",
  6780. "in": "path",
  6781. "required": true
  6782. },
  6783. {
  6784. "name": "content",
  6785. "in": "body",
  6786. "schema": {
  6787. "$ref": "#/definitions/EditReactionOption"
  6788. }
  6789. }
  6790. ],
  6791. "responses": {
  6792. "200": {
  6793. "$ref": "#/responses/empty"
  6794. },
  6795. "403": {
  6796. "$ref": "#/responses/forbidden"
  6797. },
  6798. "404": {
  6799. "$ref": "#/responses/notFound"
  6800. }
  6801. }
  6802. }
  6803. },
  6804. "/repos/{owner}/{repo}/issues/pinned": {
  6805. "get": {
  6806. "produces": [
  6807. "application/json"
  6808. ],
  6809. "tags": [
  6810. "repository"
  6811. ],
  6812. "summary": "List a repo's pinned issues",
  6813. "operationId": "repoListPinnedIssues",
  6814. "parameters": [
  6815. {
  6816. "type": "string",
  6817. "description": "owner of the repo",
  6818. "name": "owner",
  6819. "in": "path",
  6820. "required": true
  6821. },
  6822. {
  6823. "type": "string",
  6824. "description": "name of the repo",
  6825. "name": "repo",
  6826. "in": "path",
  6827. "required": true
  6828. }
  6829. ],
  6830. "responses": {
  6831. "200": {
  6832. "$ref": "#/responses/IssueList"
  6833. },
  6834. "404": {
  6835. "$ref": "#/responses/notFound"
  6836. }
  6837. }
  6838. }
  6839. },
  6840. "/repos/{owner}/{repo}/issues/{index}": {
  6841. "get": {
  6842. "produces": [
  6843. "application/json"
  6844. ],
  6845. "tags": [
  6846. "issue"
  6847. ],
  6848. "summary": "Get an issue",
  6849. "operationId": "issueGetIssue",
  6850. "parameters": [
  6851. {
  6852. "type": "string",
  6853. "description": "owner of the repo",
  6854. "name": "owner",
  6855. "in": "path",
  6856. "required": true
  6857. },
  6858. {
  6859. "type": "string",
  6860. "description": "name of the repo",
  6861. "name": "repo",
  6862. "in": "path",
  6863. "required": true
  6864. },
  6865. {
  6866. "type": "integer",
  6867. "format": "int64",
  6868. "description": "index of the issue to get",
  6869. "name": "index",
  6870. "in": "path",
  6871. "required": true
  6872. }
  6873. ],
  6874. "responses": {
  6875. "200": {
  6876. "$ref": "#/responses/Issue"
  6877. },
  6878. "404": {
  6879. "$ref": "#/responses/notFound"
  6880. }
  6881. }
  6882. },
  6883. "delete": {
  6884. "tags": [
  6885. "issue"
  6886. ],
  6887. "summary": "Delete an issue",
  6888. "operationId": "issueDelete",
  6889. "parameters": [
  6890. {
  6891. "type": "string",
  6892. "description": "owner of the repo",
  6893. "name": "owner",
  6894. "in": "path",
  6895. "required": true
  6896. },
  6897. {
  6898. "type": "string",
  6899. "description": "name of the repo",
  6900. "name": "repo",
  6901. "in": "path",
  6902. "required": true
  6903. },
  6904. {
  6905. "type": "integer",
  6906. "format": "int64",
  6907. "description": "index of issue to delete",
  6908. "name": "index",
  6909. "in": "path",
  6910. "required": true
  6911. }
  6912. ],
  6913. "responses": {
  6914. "204": {
  6915. "$ref": "#/responses/empty"
  6916. },
  6917. "403": {
  6918. "$ref": "#/responses/forbidden"
  6919. },
  6920. "404": {
  6921. "$ref": "#/responses/notFound"
  6922. }
  6923. }
  6924. },
  6925. "patch": {
  6926. "consumes": [
  6927. "application/json"
  6928. ],
  6929. "produces": [
  6930. "application/json"
  6931. ],
  6932. "tags": [
  6933. "issue"
  6934. ],
  6935. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  6936. "operationId": "issueEditIssue",
  6937. "parameters": [
  6938. {
  6939. "type": "string",
  6940. "description": "owner of the repo",
  6941. "name": "owner",
  6942. "in": "path",
  6943. "required": true
  6944. },
  6945. {
  6946. "type": "string",
  6947. "description": "name of the repo",
  6948. "name": "repo",
  6949. "in": "path",
  6950. "required": true
  6951. },
  6952. {
  6953. "type": "integer",
  6954. "format": "int64",
  6955. "description": "index of the issue to edit",
  6956. "name": "index",
  6957. "in": "path",
  6958. "required": true
  6959. },
  6960. {
  6961. "name": "body",
  6962. "in": "body",
  6963. "schema": {
  6964. "$ref": "#/definitions/EditIssueOption"
  6965. }
  6966. }
  6967. ],
  6968. "responses": {
  6969. "201": {
  6970. "$ref": "#/responses/Issue"
  6971. },
  6972. "403": {
  6973. "$ref": "#/responses/forbidden"
  6974. },
  6975. "404": {
  6976. "$ref": "#/responses/notFound"
  6977. },
  6978. "412": {
  6979. "$ref": "#/responses/error"
  6980. }
  6981. }
  6982. }
  6983. },
  6984. "/repos/{owner}/{repo}/issues/{index}/assets": {
  6985. "get": {
  6986. "produces": [
  6987. "application/json"
  6988. ],
  6989. "tags": [
  6990. "issue"
  6991. ],
  6992. "summary": "List issue's attachments",
  6993. "operationId": "issueListIssueAttachments",
  6994. "parameters": [
  6995. {
  6996. "type": "string",
  6997. "description": "owner of the repo",
  6998. "name": "owner",
  6999. "in": "path",
  7000. "required": true
  7001. },
  7002. {
  7003. "type": "string",
  7004. "description": "name of the repo",
  7005. "name": "repo",
  7006. "in": "path",
  7007. "required": true
  7008. },
  7009. {
  7010. "type": "integer",
  7011. "format": "int64",
  7012. "description": "index of the issue",
  7013. "name": "index",
  7014. "in": "path",
  7015. "required": true
  7016. }
  7017. ],
  7018. "responses": {
  7019. "200": {
  7020. "$ref": "#/responses/AttachmentList"
  7021. },
  7022. "404": {
  7023. "$ref": "#/responses/error"
  7024. }
  7025. }
  7026. },
  7027. "post": {
  7028. "consumes": [
  7029. "multipart/form-data"
  7030. ],
  7031. "produces": [
  7032. "application/json"
  7033. ],
  7034. "tags": [
  7035. "issue"
  7036. ],
  7037. "summary": "Create an issue attachment",
  7038. "operationId": "issueCreateIssueAttachment",
  7039. "parameters": [
  7040. {
  7041. "type": "string",
  7042. "description": "owner of the repo",
  7043. "name": "owner",
  7044. "in": "path",
  7045. "required": true
  7046. },
  7047. {
  7048. "type": "string",
  7049. "description": "name of the repo",
  7050. "name": "repo",
  7051. "in": "path",
  7052. "required": true
  7053. },
  7054. {
  7055. "type": "integer",
  7056. "format": "int64",
  7057. "description": "index of the issue",
  7058. "name": "index",
  7059. "in": "path",
  7060. "required": true
  7061. },
  7062. {
  7063. "type": "string",
  7064. "description": "name of the attachment",
  7065. "name": "name",
  7066. "in": "query"
  7067. },
  7068. {
  7069. "type": "file",
  7070. "description": "attachment to upload",
  7071. "name": "attachment",
  7072. "in": "formData",
  7073. "required": true
  7074. }
  7075. ],
  7076. "responses": {
  7077. "201": {
  7078. "$ref": "#/responses/Attachment"
  7079. },
  7080. "400": {
  7081. "$ref": "#/responses/error"
  7082. },
  7083. "404": {
  7084. "$ref": "#/responses/error"
  7085. }
  7086. }
  7087. }
  7088. },
  7089. "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
  7090. "get": {
  7091. "produces": [
  7092. "application/json"
  7093. ],
  7094. "tags": [
  7095. "issue"
  7096. ],
  7097. "summary": "Get an issue attachment",
  7098. "operationId": "issueGetIssueAttachment",
  7099. "parameters": [
  7100. {
  7101. "type": "string",
  7102. "description": "owner of the repo",
  7103. "name": "owner",
  7104. "in": "path",
  7105. "required": true
  7106. },
  7107. {
  7108. "type": "string",
  7109. "description": "name of the repo",
  7110. "name": "repo",
  7111. "in": "path",
  7112. "required": true
  7113. },
  7114. {
  7115. "type": "integer",
  7116. "format": "int64",
  7117. "description": "index of the issue",
  7118. "name": "index",
  7119. "in": "path",
  7120. "required": true
  7121. },
  7122. {
  7123. "type": "integer",
  7124. "format": "int64",
  7125. "description": "id of the attachment to get",
  7126. "name": "attachment_id",
  7127. "in": "path",
  7128. "required": true
  7129. }
  7130. ],
  7131. "responses": {
  7132. "200": {
  7133. "$ref": "#/responses/Attachment"
  7134. },
  7135. "404": {
  7136. "$ref": "#/responses/error"
  7137. }
  7138. }
  7139. },
  7140. "delete": {
  7141. "produces": [
  7142. "application/json"
  7143. ],
  7144. "tags": [
  7145. "issue"
  7146. ],
  7147. "summary": "Delete an issue attachment",
  7148. "operationId": "issueDeleteIssueAttachment",
  7149. "parameters": [
  7150. {
  7151. "type": "string",
  7152. "description": "owner of the repo",
  7153. "name": "owner",
  7154. "in": "path",
  7155. "required": true
  7156. },
  7157. {
  7158. "type": "string",
  7159. "description": "name of the repo",
  7160. "name": "repo",
  7161. "in": "path",
  7162. "required": true
  7163. },
  7164. {
  7165. "type": "integer",
  7166. "format": "int64",
  7167. "description": "index of the issue",
  7168. "name": "index",
  7169. "in": "path",
  7170. "required": true
  7171. },
  7172. {
  7173. "type": "integer",
  7174. "format": "int64",
  7175. "description": "id of the attachment to delete",
  7176. "name": "attachment_id",
  7177. "in": "path",
  7178. "required": true
  7179. }
  7180. ],
  7181. "responses": {
  7182. "204": {
  7183. "$ref": "#/responses/empty"
  7184. },
  7185. "404": {
  7186. "$ref": "#/responses/error"
  7187. }
  7188. }
  7189. },
  7190. "patch": {
  7191. "consumes": [
  7192. "application/json"
  7193. ],
  7194. "produces": [
  7195. "application/json"
  7196. ],
  7197. "tags": [
  7198. "issue"
  7199. ],
  7200. "summary": "Edit an issue attachment",
  7201. "operationId": "issueEditIssueAttachment",
  7202. "parameters": [
  7203. {
  7204. "type": "string",
  7205. "description": "owner of the repo",
  7206. "name": "owner",
  7207. "in": "path",
  7208. "required": true
  7209. },
  7210. {
  7211. "type": "string",
  7212. "description": "name of the repo",
  7213. "name": "repo",
  7214. "in": "path",
  7215. "required": true
  7216. },
  7217. {
  7218. "type": "integer",
  7219. "format": "int64",
  7220. "description": "index of the issue",
  7221. "name": "index",
  7222. "in": "path",
  7223. "required": true
  7224. },
  7225. {
  7226. "type": "integer",
  7227. "format": "int64",
  7228. "description": "id of the attachment to edit",
  7229. "name": "attachment_id",
  7230. "in": "path",
  7231. "required": true
  7232. },
  7233. {
  7234. "name": "body",
  7235. "in": "body",
  7236. "schema": {
  7237. "$ref": "#/definitions/EditAttachmentOptions"
  7238. }
  7239. }
  7240. ],
  7241. "responses": {
  7242. "201": {
  7243. "$ref": "#/responses/Attachment"
  7244. },
  7245. "404": {
  7246. "$ref": "#/responses/error"
  7247. }
  7248. }
  7249. }
  7250. },
  7251. "/repos/{owner}/{repo}/issues/{index}/blocks": {
  7252. "get": {
  7253. "produces": [
  7254. "application/json"
  7255. ],
  7256. "tags": [
  7257. "issue"
  7258. ],
  7259. "summary": "List issues that are blocked by this issue",
  7260. "operationId": "issueListBlocks",
  7261. "parameters": [
  7262. {
  7263. "type": "string",
  7264. "description": "owner of the repo",
  7265. "name": "owner",
  7266. "in": "path",
  7267. "required": true
  7268. },
  7269. {
  7270. "type": "string",
  7271. "description": "name of the repo",
  7272. "name": "repo",
  7273. "in": "path",
  7274. "required": true
  7275. },
  7276. {
  7277. "type": "string",
  7278. "description": "index of the issue",
  7279. "name": "index",
  7280. "in": "path",
  7281. "required": true
  7282. },
  7283. {
  7284. "type": "integer",
  7285. "description": "page number of results to return (1-based)",
  7286. "name": "page",
  7287. "in": "query"
  7288. },
  7289. {
  7290. "type": "integer",
  7291. "description": "page size of results",
  7292. "name": "limit",
  7293. "in": "query"
  7294. }
  7295. ],
  7296. "responses": {
  7297. "200": {
  7298. "$ref": "#/responses/IssueList"
  7299. },
  7300. "404": {
  7301. "$ref": "#/responses/notFound"
  7302. }
  7303. }
  7304. },
  7305. "post": {
  7306. "produces": [
  7307. "application/json"
  7308. ],
  7309. "tags": [
  7310. "issue"
  7311. ],
  7312. "summary": "Block the issue given in the body by the issue in path",
  7313. "operationId": "issueCreateIssueBlocking",
  7314. "parameters": [
  7315. {
  7316. "type": "string",
  7317. "description": "owner of the repo",
  7318. "name": "owner",
  7319. "in": "path",
  7320. "required": true
  7321. },
  7322. {
  7323. "type": "string",
  7324. "description": "name of the repo",
  7325. "name": "repo",
  7326. "in": "path",
  7327. "required": true
  7328. },
  7329. {
  7330. "type": "string",
  7331. "description": "index of the issue",
  7332. "name": "index",
  7333. "in": "path",
  7334. "required": true
  7335. },
  7336. {
  7337. "name": "body",
  7338. "in": "body",
  7339. "schema": {
  7340. "$ref": "#/definitions/IssueMeta"
  7341. }
  7342. }
  7343. ],
  7344. "responses": {
  7345. "201": {
  7346. "$ref": "#/responses/Issue"
  7347. },
  7348. "404": {
  7349. "description": "the issue does not exist"
  7350. }
  7351. }
  7352. },
  7353. "delete": {
  7354. "produces": [
  7355. "application/json"
  7356. ],
  7357. "tags": [
  7358. "issue"
  7359. ],
  7360. "summary": "Unblock the issue given in the body by the issue in path",
  7361. "operationId": "issueRemoveIssueBlocking",
  7362. "parameters": [
  7363. {
  7364. "type": "string",
  7365. "description": "owner of the repo",
  7366. "name": "owner",
  7367. "in": "path",
  7368. "required": true
  7369. },
  7370. {
  7371. "type": "string",
  7372. "description": "name of the repo",
  7373. "name": "repo",
  7374. "in": "path",
  7375. "required": true
  7376. },
  7377. {
  7378. "type": "string",
  7379. "description": "index of the issue",
  7380. "name": "index",
  7381. "in": "path",
  7382. "required": true
  7383. },
  7384. {
  7385. "name": "body",
  7386. "in": "body",
  7387. "schema": {
  7388. "$ref": "#/definitions/IssueMeta"
  7389. }
  7390. }
  7391. ],
  7392. "responses": {
  7393. "200": {
  7394. "$ref": "#/responses/Issue"
  7395. },
  7396. "404": {
  7397. "$ref": "#/responses/notFound"
  7398. }
  7399. }
  7400. }
  7401. },
  7402. "/repos/{owner}/{repo}/issues/{index}/comments": {
  7403. "get": {
  7404. "produces": [
  7405. "application/json"
  7406. ],
  7407. "tags": [
  7408. "issue"
  7409. ],
  7410. "summary": "List all comments on an issue",
  7411. "operationId": "issueGetComments",
  7412. "parameters": [
  7413. {
  7414. "type": "string",
  7415. "description": "owner of the repo",
  7416. "name": "owner",
  7417. "in": "path",
  7418. "required": true
  7419. },
  7420. {
  7421. "type": "string",
  7422. "description": "name of the repo",
  7423. "name": "repo",
  7424. "in": "path",
  7425. "required": true
  7426. },
  7427. {
  7428. "type": "integer",
  7429. "format": "int64",
  7430. "description": "index of the issue",
  7431. "name": "index",
  7432. "in": "path",
  7433. "required": true
  7434. },
  7435. {
  7436. "type": "string",
  7437. "format": "date-time",
  7438. "description": "if provided, only comments updated since the specified time are returned.",
  7439. "name": "since",
  7440. "in": "query"
  7441. },
  7442. {
  7443. "type": "string",
  7444. "format": "date-time",
  7445. "description": "if provided, only comments updated before the provided time are returned.",
  7446. "name": "before",
  7447. "in": "query"
  7448. }
  7449. ],
  7450. "responses": {
  7451. "200": {
  7452. "$ref": "#/responses/CommentList"
  7453. },
  7454. "404": {
  7455. "$ref": "#/responses/notFound"
  7456. }
  7457. }
  7458. },
  7459. "post": {
  7460. "consumes": [
  7461. "application/json"
  7462. ],
  7463. "produces": [
  7464. "application/json"
  7465. ],
  7466. "tags": [
  7467. "issue"
  7468. ],
  7469. "summary": "Add a comment to an issue",
  7470. "operationId": "issueCreateComment",
  7471. "parameters": [
  7472. {
  7473. "type": "string",
  7474. "description": "owner of the repo",
  7475. "name": "owner",
  7476. "in": "path",
  7477. "required": true
  7478. },
  7479. {
  7480. "type": "string",
  7481. "description": "name of the repo",
  7482. "name": "repo",
  7483. "in": "path",
  7484. "required": true
  7485. },
  7486. {
  7487. "type": "integer",
  7488. "format": "int64",
  7489. "description": "index of the issue",
  7490. "name": "index",
  7491. "in": "path",
  7492. "required": true
  7493. },
  7494. {
  7495. "name": "body",
  7496. "in": "body",
  7497. "schema": {
  7498. "$ref": "#/definitions/CreateIssueCommentOption"
  7499. }
  7500. }
  7501. ],
  7502. "responses": {
  7503. "201": {
  7504. "$ref": "#/responses/Comment"
  7505. },
  7506. "403": {
  7507. "$ref": "#/responses/forbidden"
  7508. },
  7509. "404": {
  7510. "$ref": "#/responses/notFound"
  7511. }
  7512. }
  7513. }
  7514. },
  7515. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  7516. "delete": {
  7517. "tags": [
  7518. "issue"
  7519. ],
  7520. "summary": "Delete a comment",
  7521. "operationId": "issueDeleteCommentDeprecated",
  7522. "deprecated": true,
  7523. "parameters": [
  7524. {
  7525. "type": "string",
  7526. "description": "owner of the repo",
  7527. "name": "owner",
  7528. "in": "path",
  7529. "required": true
  7530. },
  7531. {
  7532. "type": "string",
  7533. "description": "name of the repo",
  7534. "name": "repo",
  7535. "in": "path",
  7536. "required": true
  7537. },
  7538. {
  7539. "type": "integer",
  7540. "description": "this parameter is ignored",
  7541. "name": "index",
  7542. "in": "path",
  7543. "required": true
  7544. },
  7545. {
  7546. "type": "integer",
  7547. "format": "int64",
  7548. "description": "id of comment to delete",
  7549. "name": "id",
  7550. "in": "path",
  7551. "required": true
  7552. }
  7553. ],
  7554. "responses": {
  7555. "204": {
  7556. "$ref": "#/responses/empty"
  7557. },
  7558. "403": {
  7559. "$ref": "#/responses/forbidden"
  7560. },
  7561. "404": {
  7562. "$ref": "#/responses/notFound"
  7563. }
  7564. }
  7565. },
  7566. "patch": {
  7567. "consumes": [
  7568. "application/json"
  7569. ],
  7570. "produces": [
  7571. "application/json"
  7572. ],
  7573. "tags": [
  7574. "issue"
  7575. ],
  7576. "summary": "Edit a comment",
  7577. "operationId": "issueEditCommentDeprecated",
  7578. "deprecated": true,
  7579. "parameters": [
  7580. {
  7581. "type": "string",
  7582. "description": "owner of the repo",
  7583. "name": "owner",
  7584. "in": "path",
  7585. "required": true
  7586. },
  7587. {
  7588. "type": "string",
  7589. "description": "name of the repo",
  7590. "name": "repo",
  7591. "in": "path",
  7592. "required": true
  7593. },
  7594. {
  7595. "type": "integer",
  7596. "description": "this parameter is ignored",
  7597. "name": "index",
  7598. "in": "path",
  7599. "required": true
  7600. },
  7601. {
  7602. "type": "integer",
  7603. "format": "int64",
  7604. "description": "id of the comment to edit",
  7605. "name": "id",
  7606. "in": "path",
  7607. "required": true
  7608. },
  7609. {
  7610. "name": "body",
  7611. "in": "body",
  7612. "schema": {
  7613. "$ref": "#/definitions/EditIssueCommentOption"
  7614. }
  7615. }
  7616. ],
  7617. "responses": {
  7618. "200": {
  7619. "$ref": "#/responses/Comment"
  7620. },
  7621. "204": {
  7622. "$ref": "#/responses/empty"
  7623. },
  7624. "403": {
  7625. "$ref": "#/responses/forbidden"
  7626. },
  7627. "404": {
  7628. "$ref": "#/responses/notFound"
  7629. }
  7630. }
  7631. }
  7632. },
  7633. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  7634. "post": {
  7635. "consumes": [
  7636. "application/json"
  7637. ],
  7638. "produces": [
  7639. "application/json"
  7640. ],
  7641. "tags": [
  7642. "issue"
  7643. ],
  7644. "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.",
  7645. "operationId": "issueEditIssueDeadline",
  7646. "parameters": [
  7647. {
  7648. "type": "string",
  7649. "description": "owner of the repo",
  7650. "name": "owner",
  7651. "in": "path",
  7652. "required": true
  7653. },
  7654. {
  7655. "type": "string",
  7656. "description": "name of the repo",
  7657. "name": "repo",
  7658. "in": "path",
  7659. "required": true
  7660. },
  7661. {
  7662. "type": "integer",
  7663. "format": "int64",
  7664. "description": "index of the issue to create or update a deadline on",
  7665. "name": "index",
  7666. "in": "path",
  7667. "required": true
  7668. },
  7669. {
  7670. "name": "body",
  7671. "in": "body",
  7672. "schema": {
  7673. "$ref": "#/definitions/EditDeadlineOption"
  7674. }
  7675. }
  7676. ],
  7677. "responses": {
  7678. "201": {
  7679. "$ref": "#/responses/IssueDeadline"
  7680. },
  7681. "403": {
  7682. "$ref": "#/responses/forbidden"
  7683. },
  7684. "404": {
  7685. "$ref": "#/responses/notFound"
  7686. }
  7687. }
  7688. }
  7689. },
  7690. "/repos/{owner}/{repo}/issues/{index}/dependencies": {
  7691. "get": {
  7692. "produces": [
  7693. "application/json"
  7694. ],
  7695. "tags": [
  7696. "issue"
  7697. ],
  7698. "summary": "List an issue's dependencies, i.e all issues that block this issue.",
  7699. "operationId": "issueListIssueDependencies",
  7700. "parameters": [
  7701. {
  7702. "type": "string",
  7703. "description": "owner of the repo",
  7704. "name": "owner",
  7705. "in": "path",
  7706. "required": true
  7707. },
  7708. {
  7709. "type": "string",
  7710. "description": "name of the repo",
  7711. "name": "repo",
  7712. "in": "path",
  7713. "required": true
  7714. },
  7715. {
  7716. "type": "string",
  7717. "description": "index of the issue",
  7718. "name": "index",
  7719. "in": "path",
  7720. "required": true
  7721. },
  7722. {
  7723. "type": "integer",
  7724. "description": "page number of results to return (1-based)",
  7725. "name": "page",
  7726. "in": "query"
  7727. },
  7728. {
  7729. "type": "integer",
  7730. "description": "page size of results",
  7731. "name": "limit",
  7732. "in": "query"
  7733. }
  7734. ],
  7735. "responses": {
  7736. "200": {
  7737. "$ref": "#/responses/IssueList"
  7738. },
  7739. "404": {
  7740. "$ref": "#/responses/notFound"
  7741. }
  7742. }
  7743. },
  7744. "post": {
  7745. "produces": [
  7746. "application/json"
  7747. ],
  7748. "tags": [
  7749. "issue"
  7750. ],
  7751. "summary": "Make the issue in the url depend on the issue in the form.",
  7752. "operationId": "issueCreateIssueDependencies",
  7753. "parameters": [
  7754. {
  7755. "type": "string",
  7756. "description": "owner of the repo",
  7757. "name": "owner",
  7758. "in": "path",
  7759. "required": true
  7760. },
  7761. {
  7762. "type": "string",
  7763. "description": "name of the repo",
  7764. "name": "repo",
  7765. "in": "path",
  7766. "required": true
  7767. },
  7768. {
  7769. "type": "string",
  7770. "description": "index of the issue",
  7771. "name": "index",
  7772. "in": "path",
  7773. "required": true
  7774. },
  7775. {
  7776. "name": "body",
  7777. "in": "body",
  7778. "schema": {
  7779. "$ref": "#/definitions/IssueMeta"
  7780. }
  7781. }
  7782. ],
  7783. "responses": {
  7784. "201": {
  7785. "$ref": "#/responses/Issue"
  7786. },
  7787. "404": {
  7788. "description": "the issue does not exist"
  7789. }
  7790. }
  7791. },
  7792. "delete": {
  7793. "produces": [
  7794. "application/json"
  7795. ],
  7796. "tags": [
  7797. "issue"
  7798. ],
  7799. "summary": "Remove an issue dependency",
  7800. "operationId": "issueRemoveIssueDependencies",
  7801. "parameters": [
  7802. {
  7803. "type": "string",
  7804. "description": "owner of the repo",
  7805. "name": "owner",
  7806. "in": "path",
  7807. "required": true
  7808. },
  7809. {
  7810. "type": "string",
  7811. "description": "name of the repo",
  7812. "name": "repo",
  7813. "in": "path",
  7814. "required": true
  7815. },
  7816. {
  7817. "type": "string",
  7818. "description": "index of the issue",
  7819. "name": "index",
  7820. "in": "path",
  7821. "required": true
  7822. },
  7823. {
  7824. "name": "body",
  7825. "in": "body",
  7826. "schema": {
  7827. "$ref": "#/definitions/IssueMeta"
  7828. }
  7829. }
  7830. ],
  7831. "responses": {
  7832. "200": {
  7833. "$ref": "#/responses/Issue"
  7834. },
  7835. "404": {
  7836. "$ref": "#/responses/notFound"
  7837. }
  7838. }
  7839. }
  7840. },
  7841. "/repos/{owner}/{repo}/issues/{index}/labels": {
  7842. "get": {
  7843. "produces": [
  7844. "application/json"
  7845. ],
  7846. "tags": [
  7847. "issue"
  7848. ],
  7849. "summary": "Get an issue's labels",
  7850. "operationId": "issueGetLabels",
  7851. "parameters": [
  7852. {
  7853. "type": "string",
  7854. "description": "owner of the repo",
  7855. "name": "owner",
  7856. "in": "path",
  7857. "required": true
  7858. },
  7859. {
  7860. "type": "string",
  7861. "description": "name of the repo",
  7862. "name": "repo",
  7863. "in": "path",
  7864. "required": true
  7865. },
  7866. {
  7867. "type": "integer",
  7868. "format": "int64",
  7869. "description": "index of the issue",
  7870. "name": "index",
  7871. "in": "path",
  7872. "required": true
  7873. }
  7874. ],
  7875. "responses": {
  7876. "200": {
  7877. "$ref": "#/responses/LabelList"
  7878. },
  7879. "404": {
  7880. "$ref": "#/responses/notFound"
  7881. }
  7882. }
  7883. },
  7884. "put": {
  7885. "consumes": [
  7886. "application/json"
  7887. ],
  7888. "produces": [
  7889. "application/json"
  7890. ],
  7891. "tags": [
  7892. "issue"
  7893. ],
  7894. "summary": "Replace an issue's labels",
  7895. "operationId": "issueReplaceLabels",
  7896. "parameters": [
  7897. {
  7898. "type": "string",
  7899. "description": "owner of the repo",
  7900. "name": "owner",
  7901. "in": "path",
  7902. "required": true
  7903. },
  7904. {
  7905. "type": "string",
  7906. "description": "name of the repo",
  7907. "name": "repo",
  7908. "in": "path",
  7909. "required": true
  7910. },
  7911. {
  7912. "type": "integer",
  7913. "format": "int64",
  7914. "description": "index of the issue",
  7915. "name": "index",
  7916. "in": "path",
  7917. "required": true
  7918. },
  7919. {
  7920. "name": "body",
  7921. "in": "body",
  7922. "schema": {
  7923. "$ref": "#/definitions/IssueLabelsOption"
  7924. }
  7925. }
  7926. ],
  7927. "responses": {
  7928. "200": {
  7929. "$ref": "#/responses/LabelList"
  7930. },
  7931. "403": {
  7932. "$ref": "#/responses/forbidden"
  7933. },
  7934. "404": {
  7935. "$ref": "#/responses/notFound"
  7936. }
  7937. }
  7938. },
  7939. "post": {
  7940. "consumes": [
  7941. "application/json"
  7942. ],
  7943. "produces": [
  7944. "application/json"
  7945. ],
  7946. "tags": [
  7947. "issue"
  7948. ],
  7949. "summary": "Add a label to an issue",
  7950. "operationId": "issueAddLabel",
  7951. "parameters": [
  7952. {
  7953. "type": "string",
  7954. "description": "owner of the repo",
  7955. "name": "owner",
  7956. "in": "path",
  7957. "required": true
  7958. },
  7959. {
  7960. "type": "string",
  7961. "description": "name of the repo",
  7962. "name": "repo",
  7963. "in": "path",
  7964. "required": true
  7965. },
  7966. {
  7967. "type": "integer",
  7968. "format": "int64",
  7969. "description": "index of the issue",
  7970. "name": "index",
  7971. "in": "path",
  7972. "required": true
  7973. },
  7974. {
  7975. "name": "body",
  7976. "in": "body",
  7977. "schema": {
  7978. "$ref": "#/definitions/IssueLabelsOption"
  7979. }
  7980. }
  7981. ],
  7982. "responses": {
  7983. "200": {
  7984. "$ref": "#/responses/LabelList"
  7985. },
  7986. "403": {
  7987. "$ref": "#/responses/forbidden"
  7988. },
  7989. "404": {
  7990. "$ref": "#/responses/notFound"
  7991. }
  7992. }
  7993. },
  7994. "delete": {
  7995. "produces": [
  7996. "application/json"
  7997. ],
  7998. "tags": [
  7999. "issue"
  8000. ],
  8001. "summary": "Remove all labels from an issue",
  8002. "operationId": "issueClearLabels",
  8003. "parameters": [
  8004. {
  8005. "type": "string",
  8006. "description": "owner of the repo",
  8007. "name": "owner",
  8008. "in": "path",
  8009. "required": true
  8010. },
  8011. {
  8012. "type": "string",
  8013. "description": "name of the repo",
  8014. "name": "repo",
  8015. "in": "path",
  8016. "required": true
  8017. },
  8018. {
  8019. "type": "integer",
  8020. "format": "int64",
  8021. "description": "index of the issue",
  8022. "name": "index",
  8023. "in": "path",
  8024. "required": true
  8025. }
  8026. ],
  8027. "responses": {
  8028. "204": {
  8029. "$ref": "#/responses/empty"
  8030. },
  8031. "403": {
  8032. "$ref": "#/responses/forbidden"
  8033. },
  8034. "404": {
  8035. "$ref": "#/responses/notFound"
  8036. }
  8037. }
  8038. }
  8039. },
  8040. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  8041. "delete": {
  8042. "produces": [
  8043. "application/json"
  8044. ],
  8045. "tags": [
  8046. "issue"
  8047. ],
  8048. "summary": "Remove a label from an issue",
  8049. "operationId": "issueRemoveLabel",
  8050. "parameters": [
  8051. {
  8052. "type": "string",
  8053. "description": "owner of the repo",
  8054. "name": "owner",
  8055. "in": "path",
  8056. "required": true
  8057. },
  8058. {
  8059. "type": "string",
  8060. "description": "name of the repo",
  8061. "name": "repo",
  8062. "in": "path",
  8063. "required": true
  8064. },
  8065. {
  8066. "type": "integer",
  8067. "format": "int64",
  8068. "description": "index of the issue",
  8069. "name": "index",
  8070. "in": "path",
  8071. "required": true
  8072. },
  8073. {
  8074. "type": "integer",
  8075. "format": "int64",
  8076. "description": "id of the label to remove",
  8077. "name": "id",
  8078. "in": "path",
  8079. "required": true
  8080. }
  8081. ],
  8082. "responses": {
  8083. "204": {
  8084. "$ref": "#/responses/empty"
  8085. },
  8086. "403": {
  8087. "$ref": "#/responses/forbidden"
  8088. },
  8089. "404": {
  8090. "$ref": "#/responses/notFound"
  8091. },
  8092. "422": {
  8093. "$ref": "#/responses/validationError"
  8094. }
  8095. }
  8096. }
  8097. },
  8098. "/repos/{owner}/{repo}/issues/{index}/pin": {
  8099. "post": {
  8100. "tags": [
  8101. "issue"
  8102. ],
  8103. "summary": "Pin an Issue",
  8104. "operationId": "pinIssue",
  8105. "parameters": [
  8106. {
  8107. "type": "string",
  8108. "description": "owner of the repo",
  8109. "name": "owner",
  8110. "in": "path",
  8111. "required": true
  8112. },
  8113. {
  8114. "type": "string",
  8115. "description": "name of the repo",
  8116. "name": "repo",
  8117. "in": "path",
  8118. "required": true
  8119. },
  8120. {
  8121. "type": "integer",
  8122. "format": "int64",
  8123. "description": "index of issue to pin",
  8124. "name": "index",
  8125. "in": "path",
  8126. "required": true
  8127. }
  8128. ],
  8129. "responses": {
  8130. "204": {
  8131. "$ref": "#/responses/empty"
  8132. },
  8133. "403": {
  8134. "$ref": "#/responses/forbidden"
  8135. },
  8136. "404": {
  8137. "$ref": "#/responses/notFound"
  8138. }
  8139. }
  8140. },
  8141. "delete": {
  8142. "tags": [
  8143. "issue"
  8144. ],
  8145. "summary": "Unpin an Issue",
  8146. "operationId": "unpinIssue",
  8147. "parameters": [
  8148. {
  8149. "type": "string",
  8150. "description": "owner of the repo",
  8151. "name": "owner",
  8152. "in": "path",
  8153. "required": true
  8154. },
  8155. {
  8156. "type": "string",
  8157. "description": "name of the repo",
  8158. "name": "repo",
  8159. "in": "path",
  8160. "required": true
  8161. },
  8162. {
  8163. "type": "integer",
  8164. "format": "int64",
  8165. "description": "index of issue to unpin",
  8166. "name": "index",
  8167. "in": "path",
  8168. "required": true
  8169. }
  8170. ],
  8171. "responses": {
  8172. "204": {
  8173. "$ref": "#/responses/empty"
  8174. },
  8175. "403": {
  8176. "$ref": "#/responses/forbidden"
  8177. },
  8178. "404": {
  8179. "$ref": "#/responses/notFound"
  8180. }
  8181. }
  8182. }
  8183. },
  8184. "/repos/{owner}/{repo}/issues/{index}/pin/{position}": {
  8185. "patch": {
  8186. "tags": [
  8187. "issue"
  8188. ],
  8189. "summary": "Moves the Pin to the given Position",
  8190. "operationId": "moveIssuePin",
  8191. "parameters": [
  8192. {
  8193. "type": "string",
  8194. "description": "owner of the repo",
  8195. "name": "owner",
  8196. "in": "path",
  8197. "required": true
  8198. },
  8199. {
  8200. "type": "string",
  8201. "description": "name of the repo",
  8202. "name": "repo",
  8203. "in": "path",
  8204. "required": true
  8205. },
  8206. {
  8207. "type": "integer",
  8208. "format": "int64",
  8209. "description": "index of issue",
  8210. "name": "index",
  8211. "in": "path",
  8212. "required": true
  8213. },
  8214. {
  8215. "type": "integer",
  8216. "format": "int64",
  8217. "description": "the new position",
  8218. "name": "position",
  8219. "in": "path",
  8220. "required": true
  8221. }
  8222. ],
  8223. "responses": {
  8224. "204": {
  8225. "$ref": "#/responses/empty"
  8226. },
  8227. "403": {
  8228. "$ref": "#/responses/forbidden"
  8229. },
  8230. "404": {
  8231. "$ref": "#/responses/notFound"
  8232. }
  8233. }
  8234. }
  8235. },
  8236. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  8237. "get": {
  8238. "consumes": [
  8239. "application/json"
  8240. ],
  8241. "produces": [
  8242. "application/json"
  8243. ],
  8244. "tags": [
  8245. "issue"
  8246. ],
  8247. "summary": "Get a list reactions of an issue",
  8248. "operationId": "issueGetIssueReactions",
  8249. "parameters": [
  8250. {
  8251. "type": "string",
  8252. "description": "owner of the repo",
  8253. "name": "owner",
  8254. "in": "path",
  8255. "required": true
  8256. },
  8257. {
  8258. "type": "string",
  8259. "description": "name of the repo",
  8260. "name": "repo",
  8261. "in": "path",
  8262. "required": true
  8263. },
  8264. {
  8265. "type": "integer",
  8266. "format": "int64",
  8267. "description": "index of the issue",
  8268. "name": "index",
  8269. "in": "path",
  8270. "required": true
  8271. },
  8272. {
  8273. "type": "integer",
  8274. "description": "page number of results to return (1-based)",
  8275. "name": "page",
  8276. "in": "query"
  8277. },
  8278. {
  8279. "type": "integer",
  8280. "description": "page size of results",
  8281. "name": "limit",
  8282. "in": "query"
  8283. }
  8284. ],
  8285. "responses": {
  8286. "200": {
  8287. "$ref": "#/responses/ReactionList"
  8288. },
  8289. "403": {
  8290. "$ref": "#/responses/forbidden"
  8291. },
  8292. "404": {
  8293. "$ref": "#/responses/notFound"
  8294. }
  8295. }
  8296. },
  8297. "post": {
  8298. "consumes": [
  8299. "application/json"
  8300. ],
  8301. "produces": [
  8302. "application/json"
  8303. ],
  8304. "tags": [
  8305. "issue"
  8306. ],
  8307. "summary": "Add a reaction to an issue",
  8308. "operationId": "issuePostIssueReaction",
  8309. "parameters": [
  8310. {
  8311. "type": "string",
  8312. "description": "owner of the repo",
  8313. "name": "owner",
  8314. "in": "path",
  8315. "required": true
  8316. },
  8317. {
  8318. "type": "string",
  8319. "description": "name of the repo",
  8320. "name": "repo",
  8321. "in": "path",
  8322. "required": true
  8323. },
  8324. {
  8325. "type": "integer",
  8326. "format": "int64",
  8327. "description": "index of the issue",
  8328. "name": "index",
  8329. "in": "path",
  8330. "required": true
  8331. },
  8332. {
  8333. "name": "content",
  8334. "in": "body",
  8335. "schema": {
  8336. "$ref": "#/definitions/EditReactionOption"
  8337. }
  8338. }
  8339. ],
  8340. "responses": {
  8341. "200": {
  8342. "$ref": "#/responses/Reaction"
  8343. },
  8344. "201": {
  8345. "$ref": "#/responses/Reaction"
  8346. },
  8347. "403": {
  8348. "$ref": "#/responses/forbidden"
  8349. },
  8350. "404": {
  8351. "$ref": "#/responses/notFound"
  8352. }
  8353. }
  8354. },
  8355. "delete": {
  8356. "consumes": [
  8357. "application/json"
  8358. ],
  8359. "produces": [
  8360. "application/json"
  8361. ],
  8362. "tags": [
  8363. "issue"
  8364. ],
  8365. "summary": "Remove a reaction from an issue",
  8366. "operationId": "issueDeleteIssueReaction",
  8367. "parameters": [
  8368. {
  8369. "type": "string",
  8370. "description": "owner of the repo",
  8371. "name": "owner",
  8372. "in": "path",
  8373. "required": true
  8374. },
  8375. {
  8376. "type": "string",
  8377. "description": "name of the repo",
  8378. "name": "repo",
  8379. "in": "path",
  8380. "required": true
  8381. },
  8382. {
  8383. "type": "integer",
  8384. "format": "int64",
  8385. "description": "index of the issue",
  8386. "name": "index",
  8387. "in": "path",
  8388. "required": true
  8389. },
  8390. {
  8391. "name": "content",
  8392. "in": "body",
  8393. "schema": {
  8394. "$ref": "#/definitions/EditReactionOption"
  8395. }
  8396. }
  8397. ],
  8398. "responses": {
  8399. "200": {
  8400. "$ref": "#/responses/empty"
  8401. },
  8402. "403": {
  8403. "$ref": "#/responses/forbidden"
  8404. },
  8405. "404": {
  8406. "$ref": "#/responses/notFound"
  8407. }
  8408. }
  8409. }
  8410. },
  8411. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  8412. "delete": {
  8413. "consumes": [
  8414. "application/json"
  8415. ],
  8416. "produces": [
  8417. "application/json"
  8418. ],
  8419. "tags": [
  8420. "issue"
  8421. ],
  8422. "summary": "Delete an issue's existing stopwatch.",
  8423. "operationId": "issueDeleteStopWatch",
  8424. "parameters": [
  8425. {
  8426. "type": "string",
  8427. "description": "owner of the repo",
  8428. "name": "owner",
  8429. "in": "path",
  8430. "required": true
  8431. },
  8432. {
  8433. "type": "string",
  8434. "description": "name of the repo",
  8435. "name": "repo",
  8436. "in": "path",
  8437. "required": true
  8438. },
  8439. {
  8440. "type": "integer",
  8441. "format": "int64",
  8442. "description": "index of the issue to stop the stopwatch on",
  8443. "name": "index",
  8444. "in": "path",
  8445. "required": true
  8446. }
  8447. ],
  8448. "responses": {
  8449. "204": {
  8450. "$ref": "#/responses/empty"
  8451. },
  8452. "403": {
  8453. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8454. },
  8455. "404": {
  8456. "$ref": "#/responses/notFound"
  8457. },
  8458. "409": {
  8459. "description": "Cannot cancel a non existent stopwatch"
  8460. }
  8461. }
  8462. }
  8463. },
  8464. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  8465. "post": {
  8466. "consumes": [
  8467. "application/json"
  8468. ],
  8469. "produces": [
  8470. "application/json"
  8471. ],
  8472. "tags": [
  8473. "issue"
  8474. ],
  8475. "summary": "Start stopwatch on an issue.",
  8476. "operationId": "issueStartStopWatch",
  8477. "parameters": [
  8478. {
  8479. "type": "string",
  8480. "description": "owner of the repo",
  8481. "name": "owner",
  8482. "in": "path",
  8483. "required": true
  8484. },
  8485. {
  8486. "type": "string",
  8487. "description": "name of the repo",
  8488. "name": "repo",
  8489. "in": "path",
  8490. "required": true
  8491. },
  8492. {
  8493. "type": "integer",
  8494. "format": "int64",
  8495. "description": "index of the issue to create the stopwatch on",
  8496. "name": "index",
  8497. "in": "path",
  8498. "required": true
  8499. }
  8500. ],
  8501. "responses": {
  8502. "201": {
  8503. "$ref": "#/responses/empty"
  8504. },
  8505. "403": {
  8506. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8507. },
  8508. "404": {
  8509. "$ref": "#/responses/notFound"
  8510. },
  8511. "409": {
  8512. "description": "Cannot start a stopwatch again if it already exists"
  8513. }
  8514. }
  8515. }
  8516. },
  8517. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  8518. "post": {
  8519. "consumes": [
  8520. "application/json"
  8521. ],
  8522. "produces": [
  8523. "application/json"
  8524. ],
  8525. "tags": [
  8526. "issue"
  8527. ],
  8528. "summary": "Stop an issue's existing stopwatch.",
  8529. "operationId": "issueStopStopWatch",
  8530. "parameters": [
  8531. {
  8532. "type": "string",
  8533. "description": "owner of the repo",
  8534. "name": "owner",
  8535. "in": "path",
  8536. "required": true
  8537. },
  8538. {
  8539. "type": "string",
  8540. "description": "name of the repo",
  8541. "name": "repo",
  8542. "in": "path",
  8543. "required": true
  8544. },
  8545. {
  8546. "type": "integer",
  8547. "format": "int64",
  8548. "description": "index of the issue to stop the stopwatch on",
  8549. "name": "index",
  8550. "in": "path",
  8551. "required": true
  8552. }
  8553. ],
  8554. "responses": {
  8555. "201": {
  8556. "$ref": "#/responses/empty"
  8557. },
  8558. "403": {
  8559. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  8560. },
  8561. "404": {
  8562. "$ref": "#/responses/notFound"
  8563. },
  8564. "409": {
  8565. "description": "Cannot stop a non existent stopwatch"
  8566. }
  8567. }
  8568. }
  8569. },
  8570. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  8571. "get": {
  8572. "consumes": [
  8573. "application/json"
  8574. ],
  8575. "produces": [
  8576. "application/json"
  8577. ],
  8578. "tags": [
  8579. "issue"
  8580. ],
  8581. "summary": "Get users who subscribed on an issue.",
  8582. "operationId": "issueSubscriptions",
  8583. "parameters": [
  8584. {
  8585. "type": "string",
  8586. "description": "owner of the repo",
  8587. "name": "owner",
  8588. "in": "path",
  8589. "required": true
  8590. },
  8591. {
  8592. "type": "string",
  8593. "description": "name of the repo",
  8594. "name": "repo",
  8595. "in": "path",
  8596. "required": true
  8597. },
  8598. {
  8599. "type": "integer",
  8600. "format": "int64",
  8601. "description": "index of the issue",
  8602. "name": "index",
  8603. "in": "path",
  8604. "required": true
  8605. },
  8606. {
  8607. "type": "integer",
  8608. "description": "page number of results to return (1-based)",
  8609. "name": "page",
  8610. "in": "query"
  8611. },
  8612. {
  8613. "type": "integer",
  8614. "description": "page size of results",
  8615. "name": "limit",
  8616. "in": "query"
  8617. }
  8618. ],
  8619. "responses": {
  8620. "200": {
  8621. "$ref": "#/responses/UserList"
  8622. },
  8623. "404": {
  8624. "$ref": "#/responses/notFound"
  8625. }
  8626. }
  8627. }
  8628. },
  8629. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  8630. "get": {
  8631. "consumes": [
  8632. "application/json"
  8633. ],
  8634. "produces": [
  8635. "application/json"
  8636. ],
  8637. "tags": [
  8638. "issue"
  8639. ],
  8640. "summary": "Check if user is subscribed to an issue",
  8641. "operationId": "issueCheckSubscription",
  8642. "parameters": [
  8643. {
  8644. "type": "string",
  8645. "description": "owner of the repo",
  8646. "name": "owner",
  8647. "in": "path",
  8648. "required": true
  8649. },
  8650. {
  8651. "type": "string",
  8652. "description": "name of the repo",
  8653. "name": "repo",
  8654. "in": "path",
  8655. "required": true
  8656. },
  8657. {
  8658. "type": "integer",
  8659. "format": "int64",
  8660. "description": "index of the issue",
  8661. "name": "index",
  8662. "in": "path",
  8663. "required": true
  8664. }
  8665. ],
  8666. "responses": {
  8667. "200": {
  8668. "$ref": "#/responses/WatchInfo"
  8669. },
  8670. "404": {
  8671. "$ref": "#/responses/notFound"
  8672. }
  8673. }
  8674. }
  8675. },
  8676. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  8677. "put": {
  8678. "consumes": [
  8679. "application/json"
  8680. ],
  8681. "produces": [
  8682. "application/json"
  8683. ],
  8684. "tags": [
  8685. "issue"
  8686. ],
  8687. "summary": "Subscribe user to issue",
  8688. "operationId": "issueAddSubscription",
  8689. "parameters": [
  8690. {
  8691. "type": "string",
  8692. "description": "owner of the repo",
  8693. "name": "owner",
  8694. "in": "path",
  8695. "required": true
  8696. },
  8697. {
  8698. "type": "string",
  8699. "description": "name of the repo",
  8700. "name": "repo",
  8701. "in": "path",
  8702. "required": true
  8703. },
  8704. {
  8705. "type": "integer",
  8706. "format": "int64",
  8707. "description": "index of the issue",
  8708. "name": "index",
  8709. "in": "path",
  8710. "required": true
  8711. },
  8712. {
  8713. "type": "string",
  8714. "description": "user to subscribe",
  8715. "name": "user",
  8716. "in": "path",
  8717. "required": true
  8718. }
  8719. ],
  8720. "responses": {
  8721. "200": {
  8722. "description": "Already subscribed"
  8723. },
  8724. "201": {
  8725. "description": "Successfully Subscribed"
  8726. },
  8727. "304": {
  8728. "description": "User can only subscribe itself if he is no admin"
  8729. },
  8730. "404": {
  8731. "$ref": "#/responses/notFound"
  8732. }
  8733. }
  8734. },
  8735. "delete": {
  8736. "consumes": [
  8737. "application/json"
  8738. ],
  8739. "produces": [
  8740. "application/json"
  8741. ],
  8742. "tags": [
  8743. "issue"
  8744. ],
  8745. "summary": "Unsubscribe user from issue",
  8746. "operationId": "issueDeleteSubscription",
  8747. "parameters": [
  8748. {
  8749. "type": "string",
  8750. "description": "owner of the repo",
  8751. "name": "owner",
  8752. "in": "path",
  8753. "required": true
  8754. },
  8755. {
  8756. "type": "string",
  8757. "description": "name of the repo",
  8758. "name": "repo",
  8759. "in": "path",
  8760. "required": true
  8761. },
  8762. {
  8763. "type": "integer",
  8764. "format": "int64",
  8765. "description": "index of the issue",
  8766. "name": "index",
  8767. "in": "path",
  8768. "required": true
  8769. },
  8770. {
  8771. "type": "string",
  8772. "description": "user witch unsubscribe",
  8773. "name": "user",
  8774. "in": "path",
  8775. "required": true
  8776. }
  8777. ],
  8778. "responses": {
  8779. "200": {
  8780. "description": "Already unsubscribed"
  8781. },
  8782. "201": {
  8783. "description": "Successfully Unsubscribed"
  8784. },
  8785. "304": {
  8786. "description": "User can only subscribe itself if he is no admin"
  8787. },
  8788. "404": {
  8789. "$ref": "#/responses/notFound"
  8790. }
  8791. }
  8792. }
  8793. },
  8794. "/repos/{owner}/{repo}/issues/{index}/timeline": {
  8795. "get": {
  8796. "produces": [
  8797. "application/json"
  8798. ],
  8799. "tags": [
  8800. "issue"
  8801. ],
  8802. "summary": "List all comments and events on an issue",
  8803. "operationId": "issueGetCommentsAndTimeline",
  8804. "parameters": [
  8805. {
  8806. "type": "string",
  8807. "description": "owner of the repo",
  8808. "name": "owner",
  8809. "in": "path",
  8810. "required": true
  8811. },
  8812. {
  8813. "type": "string",
  8814. "description": "name of the repo",
  8815. "name": "repo",
  8816. "in": "path",
  8817. "required": true
  8818. },
  8819. {
  8820. "type": "integer",
  8821. "format": "int64",
  8822. "description": "index of the issue",
  8823. "name": "index",
  8824. "in": "path",
  8825. "required": true
  8826. },
  8827. {
  8828. "type": "string",
  8829. "format": "date-time",
  8830. "description": "if provided, only comments updated since the specified time are returned.",
  8831. "name": "since",
  8832. "in": "query"
  8833. },
  8834. {
  8835. "type": "integer",
  8836. "description": "page number of results to return (1-based)",
  8837. "name": "page",
  8838. "in": "query"
  8839. },
  8840. {
  8841. "type": "integer",
  8842. "description": "page size of results",
  8843. "name": "limit",
  8844. "in": "query"
  8845. },
  8846. {
  8847. "type": "string",
  8848. "format": "date-time",
  8849. "description": "if provided, only comments updated before the provided time are returned.",
  8850. "name": "before",
  8851. "in": "query"
  8852. }
  8853. ],
  8854. "responses": {
  8855. "200": {
  8856. "$ref": "#/responses/TimelineList"
  8857. },
  8858. "404": {
  8859. "$ref": "#/responses/notFound"
  8860. }
  8861. }
  8862. }
  8863. },
  8864. "/repos/{owner}/{repo}/issues/{index}/times": {
  8865. "get": {
  8866. "produces": [
  8867. "application/json"
  8868. ],
  8869. "tags": [
  8870. "issue"
  8871. ],
  8872. "summary": "List an issue's tracked times",
  8873. "operationId": "issueTrackedTimes",
  8874. "parameters": [
  8875. {
  8876. "type": "string",
  8877. "description": "owner of the repo",
  8878. "name": "owner",
  8879. "in": "path",
  8880. "required": true
  8881. },
  8882. {
  8883. "type": "string",
  8884. "description": "name of the repo",
  8885. "name": "repo",
  8886. "in": "path",
  8887. "required": true
  8888. },
  8889. {
  8890. "type": "integer",
  8891. "format": "int64",
  8892. "description": "index of the issue",
  8893. "name": "index",
  8894. "in": "path",
  8895. "required": true
  8896. },
  8897. {
  8898. "type": "string",
  8899. "description": "optional filter by user (available for issue managers)",
  8900. "name": "user",
  8901. "in": "query"
  8902. },
  8903. {
  8904. "type": "string",
  8905. "format": "date-time",
  8906. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8907. "name": "since",
  8908. "in": "query"
  8909. },
  8910. {
  8911. "type": "string",
  8912. "format": "date-time",
  8913. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8914. "name": "before",
  8915. "in": "query"
  8916. },
  8917. {
  8918. "type": "integer",
  8919. "description": "page number of results to return (1-based)",
  8920. "name": "page",
  8921. "in": "query"
  8922. },
  8923. {
  8924. "type": "integer",
  8925. "description": "page size of results",
  8926. "name": "limit",
  8927. "in": "query"
  8928. }
  8929. ],
  8930. "responses": {
  8931. "200": {
  8932. "$ref": "#/responses/TrackedTimeList"
  8933. },
  8934. "404": {
  8935. "$ref": "#/responses/notFound"
  8936. }
  8937. }
  8938. },
  8939. "post": {
  8940. "consumes": [
  8941. "application/json"
  8942. ],
  8943. "produces": [
  8944. "application/json"
  8945. ],
  8946. "tags": [
  8947. "issue"
  8948. ],
  8949. "summary": "Add tracked time to a issue",
  8950. "operationId": "issueAddTime",
  8951. "parameters": [
  8952. {
  8953. "type": "string",
  8954. "description": "owner of the repo",
  8955. "name": "owner",
  8956. "in": "path",
  8957. "required": true
  8958. },
  8959. {
  8960. "type": "string",
  8961. "description": "name of the repo",
  8962. "name": "repo",
  8963. "in": "path",
  8964. "required": true
  8965. },
  8966. {
  8967. "type": "integer",
  8968. "format": "int64",
  8969. "description": "index of the issue",
  8970. "name": "index",
  8971. "in": "path",
  8972. "required": true
  8973. },
  8974. {
  8975. "name": "body",
  8976. "in": "body",
  8977. "schema": {
  8978. "$ref": "#/definitions/AddTimeOption"
  8979. }
  8980. }
  8981. ],
  8982. "responses": {
  8983. "200": {
  8984. "$ref": "#/responses/TrackedTime"
  8985. },
  8986. "400": {
  8987. "$ref": "#/responses/error"
  8988. },
  8989. "403": {
  8990. "$ref": "#/responses/forbidden"
  8991. },
  8992. "404": {
  8993. "$ref": "#/responses/notFound"
  8994. }
  8995. }
  8996. },
  8997. "delete": {
  8998. "consumes": [
  8999. "application/json"
  9000. ],
  9001. "produces": [
  9002. "application/json"
  9003. ],
  9004. "tags": [
  9005. "issue"
  9006. ],
  9007. "summary": "Reset a tracked time of an issue",
  9008. "operationId": "issueResetTime",
  9009. "parameters": [
  9010. {
  9011. "type": "string",
  9012. "description": "owner of the repo",
  9013. "name": "owner",
  9014. "in": "path",
  9015. "required": true
  9016. },
  9017. {
  9018. "type": "string",
  9019. "description": "name of the repo",
  9020. "name": "repo",
  9021. "in": "path",
  9022. "required": true
  9023. },
  9024. {
  9025. "type": "integer",
  9026. "format": "int64",
  9027. "description": "index of the issue to add tracked time to",
  9028. "name": "index",
  9029. "in": "path",
  9030. "required": true
  9031. }
  9032. ],
  9033. "responses": {
  9034. "204": {
  9035. "$ref": "#/responses/empty"
  9036. },
  9037. "400": {
  9038. "$ref": "#/responses/error"
  9039. },
  9040. "403": {
  9041. "$ref": "#/responses/forbidden"
  9042. },
  9043. "404": {
  9044. "$ref": "#/responses/notFound"
  9045. }
  9046. }
  9047. }
  9048. },
  9049. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  9050. "delete": {
  9051. "consumes": [
  9052. "application/json"
  9053. ],
  9054. "produces": [
  9055. "application/json"
  9056. ],
  9057. "tags": [
  9058. "issue"
  9059. ],
  9060. "summary": "Delete specific tracked time",
  9061. "operationId": "issueDeleteTime",
  9062. "parameters": [
  9063. {
  9064. "type": "string",
  9065. "description": "owner of the repo",
  9066. "name": "owner",
  9067. "in": "path",
  9068. "required": true
  9069. },
  9070. {
  9071. "type": "string",
  9072. "description": "name of the repo",
  9073. "name": "repo",
  9074. "in": "path",
  9075. "required": true
  9076. },
  9077. {
  9078. "type": "integer",
  9079. "format": "int64",
  9080. "description": "index of the issue",
  9081. "name": "index",
  9082. "in": "path",
  9083. "required": true
  9084. },
  9085. {
  9086. "type": "integer",
  9087. "format": "int64",
  9088. "description": "id of time to delete",
  9089. "name": "id",
  9090. "in": "path",
  9091. "required": true
  9092. }
  9093. ],
  9094. "responses": {
  9095. "204": {
  9096. "$ref": "#/responses/empty"
  9097. },
  9098. "400": {
  9099. "$ref": "#/responses/error"
  9100. },
  9101. "403": {
  9102. "$ref": "#/responses/forbidden"
  9103. },
  9104. "404": {
  9105. "$ref": "#/responses/notFound"
  9106. }
  9107. }
  9108. }
  9109. },
  9110. "/repos/{owner}/{repo}/keys": {
  9111. "get": {
  9112. "produces": [
  9113. "application/json"
  9114. ],
  9115. "tags": [
  9116. "repository"
  9117. ],
  9118. "summary": "List a repository's keys",
  9119. "operationId": "repoListKeys",
  9120. "parameters": [
  9121. {
  9122. "type": "string",
  9123. "description": "owner of the repo",
  9124. "name": "owner",
  9125. "in": "path",
  9126. "required": true
  9127. },
  9128. {
  9129. "type": "string",
  9130. "description": "name of the repo",
  9131. "name": "repo",
  9132. "in": "path",
  9133. "required": true
  9134. },
  9135. {
  9136. "type": "integer",
  9137. "description": "the key_id to search for",
  9138. "name": "key_id",
  9139. "in": "query"
  9140. },
  9141. {
  9142. "type": "string",
  9143. "description": "fingerprint of the key",
  9144. "name": "fingerprint",
  9145. "in": "query"
  9146. },
  9147. {
  9148. "type": "integer",
  9149. "description": "page number of results to return (1-based)",
  9150. "name": "page",
  9151. "in": "query"
  9152. },
  9153. {
  9154. "type": "integer",
  9155. "description": "page size of results",
  9156. "name": "limit",
  9157. "in": "query"
  9158. }
  9159. ],
  9160. "responses": {
  9161. "200": {
  9162. "$ref": "#/responses/DeployKeyList"
  9163. },
  9164. "404": {
  9165. "$ref": "#/responses/notFound"
  9166. }
  9167. }
  9168. },
  9169. "post": {
  9170. "consumes": [
  9171. "application/json"
  9172. ],
  9173. "produces": [
  9174. "application/json"
  9175. ],
  9176. "tags": [
  9177. "repository"
  9178. ],
  9179. "summary": "Add a key to a repository",
  9180. "operationId": "repoCreateKey",
  9181. "parameters": [
  9182. {
  9183. "type": "string",
  9184. "description": "owner of the repo",
  9185. "name": "owner",
  9186. "in": "path",
  9187. "required": true
  9188. },
  9189. {
  9190. "type": "string",
  9191. "description": "name of the repo",
  9192. "name": "repo",
  9193. "in": "path",
  9194. "required": true
  9195. },
  9196. {
  9197. "name": "body",
  9198. "in": "body",
  9199. "schema": {
  9200. "$ref": "#/definitions/CreateKeyOption"
  9201. }
  9202. }
  9203. ],
  9204. "responses": {
  9205. "201": {
  9206. "$ref": "#/responses/DeployKey"
  9207. },
  9208. "404": {
  9209. "$ref": "#/responses/notFound"
  9210. },
  9211. "422": {
  9212. "$ref": "#/responses/validationError"
  9213. }
  9214. }
  9215. }
  9216. },
  9217. "/repos/{owner}/{repo}/keys/{id}": {
  9218. "get": {
  9219. "produces": [
  9220. "application/json"
  9221. ],
  9222. "tags": [
  9223. "repository"
  9224. ],
  9225. "summary": "Get a repository's key by id",
  9226. "operationId": "repoGetKey",
  9227. "parameters": [
  9228. {
  9229. "type": "string",
  9230. "description": "owner of the repo",
  9231. "name": "owner",
  9232. "in": "path",
  9233. "required": true
  9234. },
  9235. {
  9236. "type": "string",
  9237. "description": "name of the repo",
  9238. "name": "repo",
  9239. "in": "path",
  9240. "required": true
  9241. },
  9242. {
  9243. "type": "integer",
  9244. "format": "int64",
  9245. "description": "id of the key to get",
  9246. "name": "id",
  9247. "in": "path",
  9248. "required": true
  9249. }
  9250. ],
  9251. "responses": {
  9252. "200": {
  9253. "$ref": "#/responses/DeployKey"
  9254. },
  9255. "404": {
  9256. "$ref": "#/responses/notFound"
  9257. }
  9258. }
  9259. },
  9260. "delete": {
  9261. "tags": [
  9262. "repository"
  9263. ],
  9264. "summary": "Delete a key from a repository",
  9265. "operationId": "repoDeleteKey",
  9266. "parameters": [
  9267. {
  9268. "type": "string",
  9269. "description": "owner of the repo",
  9270. "name": "owner",
  9271. "in": "path",
  9272. "required": true
  9273. },
  9274. {
  9275. "type": "string",
  9276. "description": "name of the repo",
  9277. "name": "repo",
  9278. "in": "path",
  9279. "required": true
  9280. },
  9281. {
  9282. "type": "integer",
  9283. "format": "int64",
  9284. "description": "id of the key to delete",
  9285. "name": "id",
  9286. "in": "path",
  9287. "required": true
  9288. }
  9289. ],
  9290. "responses": {
  9291. "204": {
  9292. "$ref": "#/responses/empty"
  9293. },
  9294. "403": {
  9295. "$ref": "#/responses/forbidden"
  9296. },
  9297. "404": {
  9298. "$ref": "#/responses/notFound"
  9299. }
  9300. }
  9301. }
  9302. },
  9303. "/repos/{owner}/{repo}/labels": {
  9304. "get": {
  9305. "produces": [
  9306. "application/json"
  9307. ],
  9308. "tags": [
  9309. "issue"
  9310. ],
  9311. "summary": "Get all of a repository's labels",
  9312. "operationId": "issueListLabels",
  9313. "parameters": [
  9314. {
  9315. "type": "string",
  9316. "description": "owner of the repo",
  9317. "name": "owner",
  9318. "in": "path",
  9319. "required": true
  9320. },
  9321. {
  9322. "type": "string",
  9323. "description": "name of the repo",
  9324. "name": "repo",
  9325. "in": "path",
  9326. "required": true
  9327. },
  9328. {
  9329. "type": "integer",
  9330. "description": "page number of results to return (1-based)",
  9331. "name": "page",
  9332. "in": "query"
  9333. },
  9334. {
  9335. "type": "integer",
  9336. "description": "page size of results",
  9337. "name": "limit",
  9338. "in": "query"
  9339. }
  9340. ],
  9341. "responses": {
  9342. "200": {
  9343. "$ref": "#/responses/LabelList"
  9344. },
  9345. "404": {
  9346. "$ref": "#/responses/notFound"
  9347. }
  9348. }
  9349. },
  9350. "post": {
  9351. "consumes": [
  9352. "application/json"
  9353. ],
  9354. "produces": [
  9355. "application/json"
  9356. ],
  9357. "tags": [
  9358. "issue"
  9359. ],
  9360. "summary": "Create a label",
  9361. "operationId": "issueCreateLabel",
  9362. "parameters": [
  9363. {
  9364. "type": "string",
  9365. "description": "owner of the repo",
  9366. "name": "owner",
  9367. "in": "path",
  9368. "required": true
  9369. },
  9370. {
  9371. "type": "string",
  9372. "description": "name of the repo",
  9373. "name": "repo",
  9374. "in": "path",
  9375. "required": true
  9376. },
  9377. {
  9378. "name": "body",
  9379. "in": "body",
  9380. "schema": {
  9381. "$ref": "#/definitions/CreateLabelOption"
  9382. }
  9383. }
  9384. ],
  9385. "responses": {
  9386. "201": {
  9387. "$ref": "#/responses/Label"
  9388. },
  9389. "404": {
  9390. "$ref": "#/responses/notFound"
  9391. },
  9392. "422": {
  9393. "$ref": "#/responses/validationError"
  9394. }
  9395. }
  9396. }
  9397. },
  9398. "/repos/{owner}/{repo}/labels/{id}": {
  9399. "get": {
  9400. "produces": [
  9401. "application/json"
  9402. ],
  9403. "tags": [
  9404. "issue"
  9405. ],
  9406. "summary": "Get a single label",
  9407. "operationId": "issueGetLabel",
  9408. "parameters": [
  9409. {
  9410. "type": "string",
  9411. "description": "owner of the repo",
  9412. "name": "owner",
  9413. "in": "path",
  9414. "required": true
  9415. },
  9416. {
  9417. "type": "string",
  9418. "description": "name of the repo",
  9419. "name": "repo",
  9420. "in": "path",
  9421. "required": true
  9422. },
  9423. {
  9424. "type": "integer",
  9425. "format": "int64",
  9426. "description": "id of the label to get",
  9427. "name": "id",
  9428. "in": "path",
  9429. "required": true
  9430. }
  9431. ],
  9432. "responses": {
  9433. "200": {
  9434. "$ref": "#/responses/Label"
  9435. },
  9436. "404": {
  9437. "$ref": "#/responses/notFound"
  9438. }
  9439. }
  9440. },
  9441. "delete": {
  9442. "tags": [
  9443. "issue"
  9444. ],
  9445. "summary": "Delete a label",
  9446. "operationId": "issueDeleteLabel",
  9447. "parameters": [
  9448. {
  9449. "type": "string",
  9450. "description": "owner of the repo",
  9451. "name": "owner",
  9452. "in": "path",
  9453. "required": true
  9454. },
  9455. {
  9456. "type": "string",
  9457. "description": "name of the repo",
  9458. "name": "repo",
  9459. "in": "path",
  9460. "required": true
  9461. },
  9462. {
  9463. "type": "integer",
  9464. "format": "int64",
  9465. "description": "id of the label to delete",
  9466. "name": "id",
  9467. "in": "path",
  9468. "required": true
  9469. }
  9470. ],
  9471. "responses": {
  9472. "204": {
  9473. "$ref": "#/responses/empty"
  9474. },
  9475. "404": {
  9476. "$ref": "#/responses/notFound"
  9477. }
  9478. }
  9479. },
  9480. "patch": {
  9481. "consumes": [
  9482. "application/json"
  9483. ],
  9484. "produces": [
  9485. "application/json"
  9486. ],
  9487. "tags": [
  9488. "issue"
  9489. ],
  9490. "summary": "Update a label",
  9491. "operationId": "issueEditLabel",
  9492. "parameters": [
  9493. {
  9494. "type": "string",
  9495. "description": "owner of the repo",
  9496. "name": "owner",
  9497. "in": "path",
  9498. "required": true
  9499. },
  9500. {
  9501. "type": "string",
  9502. "description": "name of the repo",
  9503. "name": "repo",
  9504. "in": "path",
  9505. "required": true
  9506. },
  9507. {
  9508. "type": "integer",
  9509. "format": "int64",
  9510. "description": "id of the label to edit",
  9511. "name": "id",
  9512. "in": "path",
  9513. "required": true
  9514. },
  9515. {
  9516. "name": "body",
  9517. "in": "body",
  9518. "schema": {
  9519. "$ref": "#/definitions/EditLabelOption"
  9520. }
  9521. }
  9522. ],
  9523. "responses": {
  9524. "200": {
  9525. "$ref": "#/responses/Label"
  9526. },
  9527. "404": {
  9528. "$ref": "#/responses/notFound"
  9529. },
  9530. "422": {
  9531. "$ref": "#/responses/validationError"
  9532. }
  9533. }
  9534. }
  9535. },
  9536. "/repos/{owner}/{repo}/languages": {
  9537. "get": {
  9538. "produces": [
  9539. "application/json"
  9540. ],
  9541. "tags": [
  9542. "repository"
  9543. ],
  9544. "summary": "Get languages and number of bytes of code written",
  9545. "operationId": "repoGetLanguages",
  9546. "parameters": [
  9547. {
  9548. "type": "string",
  9549. "description": "owner of the repo",
  9550. "name": "owner",
  9551. "in": "path",
  9552. "required": true
  9553. },
  9554. {
  9555. "type": "string",
  9556. "description": "name of the repo",
  9557. "name": "repo",
  9558. "in": "path",
  9559. "required": true
  9560. }
  9561. ],
  9562. "responses": {
  9563. "200": {
  9564. "$ref": "#/responses/LanguageStatistics"
  9565. },
  9566. "404": {
  9567. "$ref": "#/responses/notFound"
  9568. }
  9569. }
  9570. }
  9571. },
  9572. "/repos/{owner}/{repo}/media/{filepath}": {
  9573. "get": {
  9574. "tags": [
  9575. "repository"
  9576. ],
  9577. "summary": "Get a file or it's LFS object from a repository",
  9578. "operationId": "repoGetRawFileOrLFS",
  9579. "parameters": [
  9580. {
  9581. "type": "string",
  9582. "description": "owner of the repo",
  9583. "name": "owner",
  9584. "in": "path",
  9585. "required": true
  9586. },
  9587. {
  9588. "type": "string",
  9589. "description": "name of the repo",
  9590. "name": "repo",
  9591. "in": "path",
  9592. "required": true
  9593. },
  9594. {
  9595. "type": "string",
  9596. "description": "filepath of the file to get",
  9597. "name": "filepath",
  9598. "in": "path",
  9599. "required": true
  9600. },
  9601. {
  9602. "type": "string",
  9603. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  9604. "name": "ref",
  9605. "in": "query"
  9606. }
  9607. ],
  9608. "responses": {
  9609. "200": {
  9610. "description": "Returns raw file content."
  9611. },
  9612. "404": {
  9613. "$ref": "#/responses/notFound"
  9614. }
  9615. }
  9616. }
  9617. },
  9618. "/repos/{owner}/{repo}/milestones": {
  9619. "get": {
  9620. "produces": [
  9621. "application/json"
  9622. ],
  9623. "tags": [
  9624. "issue"
  9625. ],
  9626. "summary": "Get all of a repository's opened milestones",
  9627. "operationId": "issueGetMilestonesList",
  9628. "parameters": [
  9629. {
  9630. "type": "string",
  9631. "description": "owner of the repo",
  9632. "name": "owner",
  9633. "in": "path",
  9634. "required": true
  9635. },
  9636. {
  9637. "type": "string",
  9638. "description": "name of the repo",
  9639. "name": "repo",
  9640. "in": "path",
  9641. "required": true
  9642. },
  9643. {
  9644. "type": "string",
  9645. "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
  9646. "name": "state",
  9647. "in": "query"
  9648. },
  9649. {
  9650. "type": "string",
  9651. "description": "filter by milestone name",
  9652. "name": "name",
  9653. "in": "query"
  9654. },
  9655. {
  9656. "type": "integer",
  9657. "description": "page number of results to return (1-based)",
  9658. "name": "page",
  9659. "in": "query"
  9660. },
  9661. {
  9662. "type": "integer",
  9663. "description": "page size of results",
  9664. "name": "limit",
  9665. "in": "query"
  9666. }
  9667. ],
  9668. "responses": {
  9669. "200": {
  9670. "$ref": "#/responses/MilestoneList"
  9671. },
  9672. "404": {
  9673. "$ref": "#/responses/notFound"
  9674. }
  9675. }
  9676. },
  9677. "post": {
  9678. "consumes": [
  9679. "application/json"
  9680. ],
  9681. "produces": [
  9682. "application/json"
  9683. ],
  9684. "tags": [
  9685. "issue"
  9686. ],
  9687. "summary": "Create a milestone",
  9688. "operationId": "issueCreateMilestone",
  9689. "parameters": [
  9690. {
  9691. "type": "string",
  9692. "description": "owner of the repo",
  9693. "name": "owner",
  9694. "in": "path",
  9695. "required": true
  9696. },
  9697. {
  9698. "type": "string",
  9699. "description": "name of the repo",
  9700. "name": "repo",
  9701. "in": "path",
  9702. "required": true
  9703. },
  9704. {
  9705. "name": "body",
  9706. "in": "body",
  9707. "schema": {
  9708. "$ref": "#/definitions/CreateMilestoneOption"
  9709. }
  9710. }
  9711. ],
  9712. "responses": {
  9713. "201": {
  9714. "$ref": "#/responses/Milestone"
  9715. },
  9716. "404": {
  9717. "$ref": "#/responses/notFound"
  9718. }
  9719. }
  9720. }
  9721. },
  9722. "/repos/{owner}/{repo}/milestones/{id}": {
  9723. "get": {
  9724. "produces": [
  9725. "application/json"
  9726. ],
  9727. "tags": [
  9728. "issue"
  9729. ],
  9730. "summary": "Get a milestone",
  9731. "operationId": "issueGetMilestone",
  9732. "parameters": [
  9733. {
  9734. "type": "string",
  9735. "description": "owner of the repo",
  9736. "name": "owner",
  9737. "in": "path",
  9738. "required": true
  9739. },
  9740. {
  9741. "type": "string",
  9742. "description": "name of the repo",
  9743. "name": "repo",
  9744. "in": "path",
  9745. "required": true
  9746. },
  9747. {
  9748. "type": "string",
  9749. "description": "the milestone to get, identified by ID and if not available by name",
  9750. "name": "id",
  9751. "in": "path",
  9752. "required": true
  9753. }
  9754. ],
  9755. "responses": {
  9756. "200": {
  9757. "$ref": "#/responses/Milestone"
  9758. },
  9759. "404": {
  9760. "$ref": "#/responses/notFound"
  9761. }
  9762. }
  9763. },
  9764. "delete": {
  9765. "tags": [
  9766. "issue"
  9767. ],
  9768. "summary": "Delete a milestone",
  9769. "operationId": "issueDeleteMilestone",
  9770. "parameters": [
  9771. {
  9772. "type": "string",
  9773. "description": "owner of the repo",
  9774. "name": "owner",
  9775. "in": "path",
  9776. "required": true
  9777. },
  9778. {
  9779. "type": "string",
  9780. "description": "name of the repo",
  9781. "name": "repo",
  9782. "in": "path",
  9783. "required": true
  9784. },
  9785. {
  9786. "type": "string",
  9787. "description": "the milestone to delete, identified by ID and if not available by name",
  9788. "name": "id",
  9789. "in": "path",
  9790. "required": true
  9791. }
  9792. ],
  9793. "responses": {
  9794. "204": {
  9795. "$ref": "#/responses/empty"
  9796. },
  9797. "404": {
  9798. "$ref": "#/responses/notFound"
  9799. }
  9800. }
  9801. },
  9802. "patch": {
  9803. "consumes": [
  9804. "application/json"
  9805. ],
  9806. "produces": [
  9807. "application/json"
  9808. ],
  9809. "tags": [
  9810. "issue"
  9811. ],
  9812. "summary": "Update a milestone",
  9813. "operationId": "issueEditMilestone",
  9814. "parameters": [
  9815. {
  9816. "type": "string",
  9817. "description": "owner of the repo",
  9818. "name": "owner",
  9819. "in": "path",
  9820. "required": true
  9821. },
  9822. {
  9823. "type": "string",
  9824. "description": "name of the repo",
  9825. "name": "repo",
  9826. "in": "path",
  9827. "required": true
  9828. },
  9829. {
  9830. "type": "string",
  9831. "description": "the milestone to edit, identified by ID and if not available by name",
  9832. "name": "id",
  9833. "in": "path",
  9834. "required": true
  9835. },
  9836. {
  9837. "name": "body",
  9838. "in": "body",
  9839. "schema": {
  9840. "$ref": "#/definitions/EditMilestoneOption"
  9841. }
  9842. }
  9843. ],
  9844. "responses": {
  9845. "200": {
  9846. "$ref": "#/responses/Milestone"
  9847. },
  9848. "404": {
  9849. "$ref": "#/responses/notFound"
  9850. }
  9851. }
  9852. }
  9853. },
  9854. "/repos/{owner}/{repo}/mirror-sync": {
  9855. "post": {
  9856. "produces": [
  9857. "application/json"
  9858. ],
  9859. "tags": [
  9860. "repository"
  9861. ],
  9862. "summary": "Sync a mirrored repository",
  9863. "operationId": "repoMirrorSync",
  9864. "parameters": [
  9865. {
  9866. "type": "string",
  9867. "description": "owner of the repo to sync",
  9868. "name": "owner",
  9869. "in": "path",
  9870. "required": true
  9871. },
  9872. {
  9873. "type": "string",
  9874. "description": "name of the repo to sync",
  9875. "name": "repo",
  9876. "in": "path",
  9877. "required": true
  9878. }
  9879. ],
  9880. "responses": {
  9881. "200": {
  9882. "$ref": "#/responses/empty"
  9883. },
  9884. "403": {
  9885. "$ref": "#/responses/forbidden"
  9886. },
  9887. "404": {
  9888. "$ref": "#/responses/notFound"
  9889. }
  9890. }
  9891. }
  9892. },
  9893. "/repos/{owner}/{repo}/new_pin_allowed": {
  9894. "get": {
  9895. "produces": [
  9896. "application/json"
  9897. ],
  9898. "tags": [
  9899. "repository"
  9900. ],
  9901. "summary": "Returns if new Issue Pins are allowed",
  9902. "operationId": "repoNewPinAllowed",
  9903. "parameters": [
  9904. {
  9905. "type": "string",
  9906. "description": "owner of the repo",
  9907. "name": "owner",
  9908. "in": "path",
  9909. "required": true
  9910. },
  9911. {
  9912. "type": "string",
  9913. "description": "name of the repo",
  9914. "name": "repo",
  9915. "in": "path",
  9916. "required": true
  9917. }
  9918. ],
  9919. "responses": {
  9920. "200": {
  9921. "$ref": "#/responses/RepoNewIssuePinsAllowed"
  9922. },
  9923. "404": {
  9924. "$ref": "#/responses/notFound"
  9925. }
  9926. }
  9927. }
  9928. },
  9929. "/repos/{owner}/{repo}/notifications": {
  9930. "get": {
  9931. "consumes": [
  9932. "application/json"
  9933. ],
  9934. "produces": [
  9935. "application/json"
  9936. ],
  9937. "tags": [
  9938. "notification"
  9939. ],
  9940. "summary": "List users's notification threads on a specific repo",
  9941. "operationId": "notifyGetRepoList",
  9942. "parameters": [
  9943. {
  9944. "type": "string",
  9945. "description": "owner of the repo",
  9946. "name": "owner",
  9947. "in": "path",
  9948. "required": true
  9949. },
  9950. {
  9951. "type": "string",
  9952. "description": "name of the repo",
  9953. "name": "repo",
  9954. "in": "path",
  9955. "required": true
  9956. },
  9957. {
  9958. "type": "boolean",
  9959. "description": "If true, show notifications marked as read. Default value is false",
  9960. "name": "all",
  9961. "in": "query"
  9962. },
  9963. {
  9964. "type": "array",
  9965. "items": {
  9966. "type": "string"
  9967. },
  9968. "collectionFormat": "multi",
  9969. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  9970. "name": "status-types",
  9971. "in": "query"
  9972. },
  9973. {
  9974. "type": "array",
  9975. "items": {
  9976. "enum": [
  9977. "issue",
  9978. "pull",
  9979. "commit",
  9980. "repository"
  9981. ],
  9982. "type": "string"
  9983. },
  9984. "collectionFormat": "multi",
  9985. "description": "filter notifications by subject type",
  9986. "name": "subject-type",
  9987. "in": "query"
  9988. },
  9989. {
  9990. "type": "string",
  9991. "format": "date-time",
  9992. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  9993. "name": "since",
  9994. "in": "query"
  9995. },
  9996. {
  9997. "type": "string",
  9998. "format": "date-time",
  9999. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  10000. "name": "before",
  10001. "in": "query"
  10002. },
  10003. {
  10004. "type": "integer",
  10005. "description": "page number of results to return (1-based)",
  10006. "name": "page",
  10007. "in": "query"
  10008. },
  10009. {
  10010. "type": "integer",
  10011. "description": "page size of results",
  10012. "name": "limit",
  10013. "in": "query"
  10014. }
  10015. ],
  10016. "responses": {
  10017. "200": {
  10018. "$ref": "#/responses/NotificationThreadList"
  10019. }
  10020. }
  10021. },
  10022. "put": {
  10023. "consumes": [
  10024. "application/json"
  10025. ],
  10026. "produces": [
  10027. "application/json"
  10028. ],
  10029. "tags": [
  10030. "notification"
  10031. ],
  10032. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  10033. "operationId": "notifyReadRepoList",
  10034. "parameters": [
  10035. {
  10036. "type": "string",
  10037. "description": "owner of the repo",
  10038. "name": "owner",
  10039. "in": "path",
  10040. "required": true
  10041. },
  10042. {
  10043. "type": "string",
  10044. "description": "name of the repo",
  10045. "name": "repo",
  10046. "in": "path",
  10047. "required": true
  10048. },
  10049. {
  10050. "type": "string",
  10051. "description": "If true, mark all notifications on this repo. Default value is false",
  10052. "name": "all",
  10053. "in": "query"
  10054. },
  10055. {
  10056. "type": "array",
  10057. "items": {
  10058. "type": "string"
  10059. },
  10060. "collectionFormat": "multi",
  10061. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  10062. "name": "status-types",
  10063. "in": "query"
  10064. },
  10065. {
  10066. "type": "string",
  10067. "description": "Status to mark notifications as. Defaults to read.",
  10068. "name": "to-status",
  10069. "in": "query"
  10070. },
  10071. {
  10072. "type": "string",
  10073. "format": "date-time",
  10074. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  10075. "name": "last_read_at",
  10076. "in": "query"
  10077. }
  10078. ],
  10079. "responses": {
  10080. "205": {
  10081. "$ref": "#/responses/NotificationThreadList"
  10082. }
  10083. }
  10084. }
  10085. },
  10086. "/repos/{owner}/{repo}/pulls": {
  10087. "get": {
  10088. "produces": [
  10089. "application/json"
  10090. ],
  10091. "tags": [
  10092. "repository"
  10093. ],
  10094. "summary": "List a repo's pull requests",
  10095. "operationId": "repoListPullRequests",
  10096. "parameters": [
  10097. {
  10098. "type": "string",
  10099. "description": "owner of the repo",
  10100. "name": "owner",
  10101. "in": "path",
  10102. "required": true
  10103. },
  10104. {
  10105. "type": "string",
  10106. "description": "name of the repo",
  10107. "name": "repo",
  10108. "in": "path",
  10109. "required": true
  10110. },
  10111. {
  10112. "enum": [
  10113. "closed",
  10114. "open",
  10115. "all"
  10116. ],
  10117. "type": "string",
  10118. "description": "State of pull request: open or closed (optional)",
  10119. "name": "state",
  10120. "in": "query"
  10121. },
  10122. {
  10123. "enum": [
  10124. "oldest",
  10125. "recentupdate",
  10126. "leastupdate",
  10127. "mostcomment",
  10128. "leastcomment",
  10129. "priority"
  10130. ],
  10131. "type": "string",
  10132. "description": "Type of sort",
  10133. "name": "sort",
  10134. "in": "query"
  10135. },
  10136. {
  10137. "type": "integer",
  10138. "format": "int64",
  10139. "description": "ID of the milestone",
  10140. "name": "milestone",
  10141. "in": "query"
  10142. },
  10143. {
  10144. "type": "array",
  10145. "items": {
  10146. "type": "integer",
  10147. "format": "int64"
  10148. },
  10149. "collectionFormat": "multi",
  10150. "description": "Label IDs",
  10151. "name": "labels",
  10152. "in": "query"
  10153. },
  10154. {
  10155. "type": "integer",
  10156. "description": "page number of results to return (1-based)",
  10157. "name": "page",
  10158. "in": "query"
  10159. },
  10160. {
  10161. "type": "integer",
  10162. "description": "page size of results",
  10163. "name": "limit",
  10164. "in": "query"
  10165. }
  10166. ],
  10167. "responses": {
  10168. "200": {
  10169. "$ref": "#/responses/PullRequestList"
  10170. },
  10171. "404": {
  10172. "$ref": "#/responses/notFound"
  10173. }
  10174. }
  10175. },
  10176. "post": {
  10177. "consumes": [
  10178. "application/json"
  10179. ],
  10180. "produces": [
  10181. "application/json"
  10182. ],
  10183. "tags": [
  10184. "repository"
  10185. ],
  10186. "summary": "Create a pull request",
  10187. "operationId": "repoCreatePullRequest",
  10188. "parameters": [
  10189. {
  10190. "type": "string",
  10191. "description": "owner of the repo",
  10192. "name": "owner",
  10193. "in": "path",
  10194. "required": true
  10195. },
  10196. {
  10197. "type": "string",
  10198. "description": "name of the repo",
  10199. "name": "repo",
  10200. "in": "path",
  10201. "required": true
  10202. },
  10203. {
  10204. "name": "body",
  10205. "in": "body",
  10206. "schema": {
  10207. "$ref": "#/definitions/CreatePullRequestOption"
  10208. }
  10209. }
  10210. ],
  10211. "responses": {
  10212. "201": {
  10213. "$ref": "#/responses/PullRequest"
  10214. },
  10215. "404": {
  10216. "$ref": "#/responses/notFound"
  10217. },
  10218. "409": {
  10219. "$ref": "#/responses/error"
  10220. },
  10221. "422": {
  10222. "$ref": "#/responses/validationError"
  10223. }
  10224. }
  10225. }
  10226. },
  10227. "/repos/{owner}/{repo}/pulls/pinned": {
  10228. "get": {
  10229. "produces": [
  10230. "application/json"
  10231. ],
  10232. "tags": [
  10233. "repository"
  10234. ],
  10235. "summary": "List a repo's pinned pull requests",
  10236. "operationId": "repoListPinnedPullRequests",
  10237. "parameters": [
  10238. {
  10239. "type": "string",
  10240. "description": "owner of the repo",
  10241. "name": "owner",
  10242. "in": "path",
  10243. "required": true
  10244. },
  10245. {
  10246. "type": "string",
  10247. "description": "name of the repo",
  10248. "name": "repo",
  10249. "in": "path",
  10250. "required": true
  10251. }
  10252. ],
  10253. "responses": {
  10254. "200": {
  10255. "$ref": "#/responses/PullRequestList"
  10256. },
  10257. "404": {
  10258. "$ref": "#/responses/notFound"
  10259. }
  10260. }
  10261. }
  10262. },
  10263. "/repos/{owner}/{repo}/pulls/{index}": {
  10264. "get": {
  10265. "produces": [
  10266. "application/json"
  10267. ],
  10268. "tags": [
  10269. "repository"
  10270. ],
  10271. "summary": "Get a pull request",
  10272. "operationId": "repoGetPullRequest",
  10273. "parameters": [
  10274. {
  10275. "type": "string",
  10276. "description": "owner of the repo",
  10277. "name": "owner",
  10278. "in": "path",
  10279. "required": true
  10280. },
  10281. {
  10282. "type": "string",
  10283. "description": "name of the repo",
  10284. "name": "repo",
  10285. "in": "path",
  10286. "required": true
  10287. },
  10288. {
  10289. "type": "integer",
  10290. "format": "int64",
  10291. "description": "index of the pull request to get",
  10292. "name": "index",
  10293. "in": "path",
  10294. "required": true
  10295. }
  10296. ],
  10297. "responses": {
  10298. "200": {
  10299. "$ref": "#/responses/PullRequest"
  10300. },
  10301. "404": {
  10302. "$ref": "#/responses/notFound"
  10303. }
  10304. }
  10305. },
  10306. "patch": {
  10307. "consumes": [
  10308. "application/json"
  10309. ],
  10310. "produces": [
  10311. "application/json"
  10312. ],
  10313. "tags": [
  10314. "repository"
  10315. ],
  10316. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  10317. "operationId": "repoEditPullRequest",
  10318. "parameters": [
  10319. {
  10320. "type": "string",
  10321. "description": "owner of the repo",
  10322. "name": "owner",
  10323. "in": "path",
  10324. "required": true
  10325. },
  10326. {
  10327. "type": "string",
  10328. "description": "name of the repo",
  10329. "name": "repo",
  10330. "in": "path",
  10331. "required": true
  10332. },
  10333. {
  10334. "type": "integer",
  10335. "format": "int64",
  10336. "description": "index of the pull request to edit",
  10337. "name": "index",
  10338. "in": "path",
  10339. "required": true
  10340. },
  10341. {
  10342. "name": "body",
  10343. "in": "body",
  10344. "schema": {
  10345. "$ref": "#/definitions/EditPullRequestOption"
  10346. }
  10347. }
  10348. ],
  10349. "responses": {
  10350. "201": {
  10351. "$ref": "#/responses/PullRequest"
  10352. },
  10353. "403": {
  10354. "$ref": "#/responses/forbidden"
  10355. },
  10356. "404": {
  10357. "$ref": "#/responses/notFound"
  10358. },
  10359. "409": {
  10360. "$ref": "#/responses/error"
  10361. },
  10362. "412": {
  10363. "$ref": "#/responses/error"
  10364. },
  10365. "422": {
  10366. "$ref": "#/responses/validationError"
  10367. }
  10368. }
  10369. }
  10370. },
  10371. "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
  10372. "get": {
  10373. "produces": [
  10374. "text/plain"
  10375. ],
  10376. "tags": [
  10377. "repository"
  10378. ],
  10379. "summary": "Get a pull request diff or patch",
  10380. "operationId": "repoDownloadPullDiffOrPatch",
  10381. "parameters": [
  10382. {
  10383. "type": "string",
  10384. "description": "owner of the repo",
  10385. "name": "owner",
  10386. "in": "path",
  10387. "required": true
  10388. },
  10389. {
  10390. "type": "string",
  10391. "description": "name of the repo",
  10392. "name": "repo",
  10393. "in": "path",
  10394. "required": true
  10395. },
  10396. {
  10397. "type": "integer",
  10398. "format": "int64",
  10399. "description": "index of the pull request to get",
  10400. "name": "index",
  10401. "in": "path",
  10402. "required": true
  10403. },
  10404. {
  10405. "enum": [
  10406. "diff",
  10407. "patch"
  10408. ],
  10409. "type": "string",
  10410. "description": "whether the output is diff or patch",
  10411. "name": "diffType",
  10412. "in": "path",
  10413. "required": true
  10414. },
  10415. {
  10416. "type": "boolean",
  10417. "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
  10418. "name": "binary",
  10419. "in": "query"
  10420. }
  10421. ],
  10422. "responses": {
  10423. "200": {
  10424. "$ref": "#/responses/string"
  10425. },
  10426. "404": {
  10427. "$ref": "#/responses/notFound"
  10428. }
  10429. }
  10430. }
  10431. },
  10432. "/repos/{owner}/{repo}/pulls/{index}/commits": {
  10433. "get": {
  10434. "produces": [
  10435. "application/json"
  10436. ],
  10437. "tags": [
  10438. "repository"
  10439. ],
  10440. "summary": "Get commits for a pull request",
  10441. "operationId": "repoGetPullRequestCommits",
  10442. "parameters": [
  10443. {
  10444. "type": "string",
  10445. "description": "owner of the repo",
  10446. "name": "owner",
  10447. "in": "path",
  10448. "required": true
  10449. },
  10450. {
  10451. "type": "string",
  10452. "description": "name of the repo",
  10453. "name": "repo",
  10454. "in": "path",
  10455. "required": true
  10456. },
  10457. {
  10458. "type": "integer",
  10459. "format": "int64",
  10460. "description": "index of the pull request to get",
  10461. "name": "index",
  10462. "in": "path",
  10463. "required": true
  10464. },
  10465. {
  10466. "type": "integer",
  10467. "description": "page number of results to return (1-based)",
  10468. "name": "page",
  10469. "in": "query"
  10470. },
  10471. {
  10472. "type": "integer",
  10473. "description": "page size of results",
  10474. "name": "limit",
  10475. "in": "query"
  10476. },
  10477. {
  10478. "type": "boolean",
  10479. "description": "include verification for every commit (disable for speedup, default 'true')",
  10480. "name": "verification",
  10481. "in": "query"
  10482. },
  10483. {
  10484. "type": "boolean",
  10485. "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
  10486. "name": "files",
  10487. "in": "query"
  10488. }
  10489. ],
  10490. "responses": {
  10491. "200": {
  10492. "$ref": "#/responses/CommitList"
  10493. },
  10494. "404": {
  10495. "$ref": "#/responses/notFound"
  10496. }
  10497. }
  10498. }
  10499. },
  10500. "/repos/{owner}/{repo}/pulls/{index}/files": {
  10501. "get": {
  10502. "produces": [
  10503. "application/json"
  10504. ],
  10505. "tags": [
  10506. "repository"
  10507. ],
  10508. "summary": "Get changed files for a pull request",
  10509. "operationId": "repoGetPullRequestFiles",
  10510. "parameters": [
  10511. {
  10512. "type": "string",
  10513. "description": "owner of the repo",
  10514. "name": "owner",
  10515. "in": "path",
  10516. "required": true
  10517. },
  10518. {
  10519. "type": "string",
  10520. "description": "name of the repo",
  10521. "name": "repo",
  10522. "in": "path",
  10523. "required": true
  10524. },
  10525. {
  10526. "type": "integer",
  10527. "format": "int64",
  10528. "description": "index of the pull request to get",
  10529. "name": "index",
  10530. "in": "path",
  10531. "required": true
  10532. },
  10533. {
  10534. "type": "string",
  10535. "description": "skip to given file",
  10536. "name": "skip-to",
  10537. "in": "query"
  10538. },
  10539. {
  10540. "enum": [
  10541. "ignore-all",
  10542. "ignore-change",
  10543. "ignore-eol",
  10544. "show-all"
  10545. ],
  10546. "type": "string",
  10547. "description": "whitespace behavior",
  10548. "name": "whitespace",
  10549. "in": "query"
  10550. },
  10551. {
  10552. "type": "integer",
  10553. "description": "page number of results to return (1-based)",
  10554. "name": "page",
  10555. "in": "query"
  10556. },
  10557. {
  10558. "type": "integer",
  10559. "description": "page size of results",
  10560. "name": "limit",
  10561. "in": "query"
  10562. }
  10563. ],
  10564. "responses": {
  10565. "200": {
  10566. "$ref": "#/responses/ChangedFileList"
  10567. },
  10568. "404": {
  10569. "$ref": "#/responses/notFound"
  10570. }
  10571. }
  10572. }
  10573. },
  10574. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  10575. "get": {
  10576. "produces": [
  10577. "application/json"
  10578. ],
  10579. "tags": [
  10580. "repository"
  10581. ],
  10582. "summary": "Check if a pull request has been merged",
  10583. "operationId": "repoPullRequestIsMerged",
  10584. "parameters": [
  10585. {
  10586. "type": "string",
  10587. "description": "owner of the repo",
  10588. "name": "owner",
  10589. "in": "path",
  10590. "required": true
  10591. },
  10592. {
  10593. "type": "string",
  10594. "description": "name of the repo",
  10595. "name": "repo",
  10596. "in": "path",
  10597. "required": true
  10598. },
  10599. {
  10600. "type": "integer",
  10601. "format": "int64",
  10602. "description": "index of the pull request",
  10603. "name": "index",
  10604. "in": "path",
  10605. "required": true
  10606. }
  10607. ],
  10608. "responses": {
  10609. "204": {
  10610. "description": "pull request has been merged"
  10611. },
  10612. "404": {
  10613. "description": "pull request has not been merged"
  10614. }
  10615. }
  10616. },
  10617. "post": {
  10618. "produces": [
  10619. "application/json"
  10620. ],
  10621. "tags": [
  10622. "repository"
  10623. ],
  10624. "summary": "Merge a pull request",
  10625. "operationId": "repoMergePullRequest",
  10626. "parameters": [
  10627. {
  10628. "type": "string",
  10629. "description": "owner of the repo",
  10630. "name": "owner",
  10631. "in": "path",
  10632. "required": true
  10633. },
  10634. {
  10635. "type": "string",
  10636. "description": "name of the repo",
  10637. "name": "repo",
  10638. "in": "path",
  10639. "required": true
  10640. },
  10641. {
  10642. "type": "integer",
  10643. "format": "int64",
  10644. "description": "index of the pull request to merge",
  10645. "name": "index",
  10646. "in": "path",
  10647. "required": true
  10648. },
  10649. {
  10650. "name": "body",
  10651. "in": "body",
  10652. "schema": {
  10653. "$ref": "#/definitions/MergePullRequestOption"
  10654. }
  10655. }
  10656. ],
  10657. "responses": {
  10658. "200": {
  10659. "$ref": "#/responses/empty"
  10660. },
  10661. "404": {
  10662. "$ref": "#/responses/notFound"
  10663. },
  10664. "405": {
  10665. "$ref": "#/responses/empty"
  10666. },
  10667. "409": {
  10668. "$ref": "#/responses/error"
  10669. }
  10670. }
  10671. },
  10672. "delete": {
  10673. "produces": [
  10674. "application/json"
  10675. ],
  10676. "tags": [
  10677. "repository"
  10678. ],
  10679. "summary": "Cancel the scheduled auto merge for the given pull request",
  10680. "operationId": "repoCancelScheduledAutoMerge",
  10681. "parameters": [
  10682. {
  10683. "type": "string",
  10684. "description": "owner of the repo",
  10685. "name": "owner",
  10686. "in": "path",
  10687. "required": true
  10688. },
  10689. {
  10690. "type": "string",
  10691. "description": "name of the repo",
  10692. "name": "repo",
  10693. "in": "path",
  10694. "required": true
  10695. },
  10696. {
  10697. "type": "integer",
  10698. "format": "int64",
  10699. "description": "index of the pull request to merge",
  10700. "name": "index",
  10701. "in": "path",
  10702. "required": true
  10703. }
  10704. ],
  10705. "responses": {
  10706. "204": {
  10707. "$ref": "#/responses/empty"
  10708. },
  10709. "403": {
  10710. "$ref": "#/responses/forbidden"
  10711. },
  10712. "404": {
  10713. "$ref": "#/responses/notFound"
  10714. }
  10715. }
  10716. }
  10717. },
  10718. "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
  10719. "post": {
  10720. "produces": [
  10721. "application/json"
  10722. ],
  10723. "tags": [
  10724. "repository"
  10725. ],
  10726. "summary": "create review requests for a pull request",
  10727. "operationId": "repoCreatePullReviewRequests",
  10728. "parameters": [
  10729. {
  10730. "type": "string",
  10731. "description": "owner of the repo",
  10732. "name": "owner",
  10733. "in": "path",
  10734. "required": true
  10735. },
  10736. {
  10737. "type": "string",
  10738. "description": "name of the repo",
  10739. "name": "repo",
  10740. "in": "path",
  10741. "required": true
  10742. },
  10743. {
  10744. "type": "integer",
  10745. "format": "int64",
  10746. "description": "index of the pull request",
  10747. "name": "index",
  10748. "in": "path",
  10749. "required": true
  10750. },
  10751. {
  10752. "name": "body",
  10753. "in": "body",
  10754. "required": true,
  10755. "schema": {
  10756. "$ref": "#/definitions/PullReviewRequestOptions"
  10757. }
  10758. }
  10759. ],
  10760. "responses": {
  10761. "201": {
  10762. "$ref": "#/responses/PullReviewList"
  10763. },
  10764. "404": {
  10765. "$ref": "#/responses/notFound"
  10766. },
  10767. "422": {
  10768. "$ref": "#/responses/validationError"
  10769. }
  10770. }
  10771. },
  10772. "delete": {
  10773. "produces": [
  10774. "application/json"
  10775. ],
  10776. "tags": [
  10777. "repository"
  10778. ],
  10779. "summary": "cancel review requests for a pull request",
  10780. "operationId": "repoDeletePullReviewRequests",
  10781. "parameters": [
  10782. {
  10783. "type": "string",
  10784. "description": "owner of the repo",
  10785. "name": "owner",
  10786. "in": "path",
  10787. "required": true
  10788. },
  10789. {
  10790. "type": "string",
  10791. "description": "name of the repo",
  10792. "name": "repo",
  10793. "in": "path",
  10794. "required": true
  10795. },
  10796. {
  10797. "type": "integer",
  10798. "format": "int64",
  10799. "description": "index of the pull request",
  10800. "name": "index",
  10801. "in": "path",
  10802. "required": true
  10803. },
  10804. {
  10805. "name": "body",
  10806. "in": "body",
  10807. "required": true,
  10808. "schema": {
  10809. "$ref": "#/definitions/PullReviewRequestOptions"
  10810. }
  10811. }
  10812. ],
  10813. "responses": {
  10814. "204": {
  10815. "$ref": "#/responses/empty"
  10816. },
  10817. "404": {
  10818. "$ref": "#/responses/notFound"
  10819. },
  10820. "422": {
  10821. "$ref": "#/responses/validationError"
  10822. }
  10823. }
  10824. }
  10825. },
  10826. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  10827. "get": {
  10828. "produces": [
  10829. "application/json"
  10830. ],
  10831. "tags": [
  10832. "repository"
  10833. ],
  10834. "summary": "List all reviews for a pull request",
  10835. "operationId": "repoListPullReviews",
  10836. "parameters": [
  10837. {
  10838. "type": "string",
  10839. "description": "owner of the repo",
  10840. "name": "owner",
  10841. "in": "path",
  10842. "required": true
  10843. },
  10844. {
  10845. "type": "string",
  10846. "description": "name of the repo",
  10847. "name": "repo",
  10848. "in": "path",
  10849. "required": true
  10850. },
  10851. {
  10852. "type": "integer",
  10853. "format": "int64",
  10854. "description": "index of the pull request",
  10855. "name": "index",
  10856. "in": "path",
  10857. "required": true
  10858. },
  10859. {
  10860. "type": "integer",
  10861. "description": "page number of results to return (1-based)",
  10862. "name": "page",
  10863. "in": "query"
  10864. },
  10865. {
  10866. "type": "integer",
  10867. "description": "page size of results",
  10868. "name": "limit",
  10869. "in": "query"
  10870. }
  10871. ],
  10872. "responses": {
  10873. "200": {
  10874. "$ref": "#/responses/PullReviewList"
  10875. },
  10876. "404": {
  10877. "$ref": "#/responses/notFound"
  10878. }
  10879. }
  10880. },
  10881. "post": {
  10882. "produces": [
  10883. "application/json"
  10884. ],
  10885. "tags": [
  10886. "repository"
  10887. ],
  10888. "summary": "Create a review to an pull request",
  10889. "operationId": "repoCreatePullReview",
  10890. "parameters": [
  10891. {
  10892. "type": "string",
  10893. "description": "owner of the repo",
  10894. "name": "owner",
  10895. "in": "path",
  10896. "required": true
  10897. },
  10898. {
  10899. "type": "string",
  10900. "description": "name of the repo",
  10901. "name": "repo",
  10902. "in": "path",
  10903. "required": true
  10904. },
  10905. {
  10906. "type": "integer",
  10907. "format": "int64",
  10908. "description": "index of the pull request",
  10909. "name": "index",
  10910. "in": "path",
  10911. "required": true
  10912. },
  10913. {
  10914. "name": "body",
  10915. "in": "body",
  10916. "required": true,
  10917. "schema": {
  10918. "$ref": "#/definitions/CreatePullReviewOptions"
  10919. }
  10920. }
  10921. ],
  10922. "responses": {
  10923. "200": {
  10924. "$ref": "#/responses/PullReview"
  10925. },
  10926. "404": {
  10927. "$ref": "#/responses/notFound"
  10928. },
  10929. "422": {
  10930. "$ref": "#/responses/validationError"
  10931. }
  10932. }
  10933. }
  10934. },
  10935. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  10936. "get": {
  10937. "produces": [
  10938. "application/json"
  10939. ],
  10940. "tags": [
  10941. "repository"
  10942. ],
  10943. "summary": "Get a specific review for a pull request",
  10944. "operationId": "repoGetPullReview",
  10945. "parameters": [
  10946. {
  10947. "type": "string",
  10948. "description": "owner of the repo",
  10949. "name": "owner",
  10950. "in": "path",
  10951. "required": true
  10952. },
  10953. {
  10954. "type": "string",
  10955. "description": "name of the repo",
  10956. "name": "repo",
  10957. "in": "path",
  10958. "required": true
  10959. },
  10960. {
  10961. "type": "integer",
  10962. "format": "int64",
  10963. "description": "index of the pull request",
  10964. "name": "index",
  10965. "in": "path",
  10966. "required": true
  10967. },
  10968. {
  10969. "type": "integer",
  10970. "format": "int64",
  10971. "description": "id of the review",
  10972. "name": "id",
  10973. "in": "path",
  10974. "required": true
  10975. }
  10976. ],
  10977. "responses": {
  10978. "200": {
  10979. "$ref": "#/responses/PullReview"
  10980. },
  10981. "404": {
  10982. "$ref": "#/responses/notFound"
  10983. }
  10984. }
  10985. },
  10986. "post": {
  10987. "produces": [
  10988. "application/json"
  10989. ],
  10990. "tags": [
  10991. "repository"
  10992. ],
  10993. "summary": "Submit a pending review to an pull request",
  10994. "operationId": "repoSubmitPullReview",
  10995. "parameters": [
  10996. {
  10997. "type": "string",
  10998. "description": "owner of the repo",
  10999. "name": "owner",
  11000. "in": "path",
  11001. "required": true
  11002. },
  11003. {
  11004. "type": "string",
  11005. "description": "name of the repo",
  11006. "name": "repo",
  11007. "in": "path",
  11008. "required": true
  11009. },
  11010. {
  11011. "type": "integer",
  11012. "format": "int64",
  11013. "description": "index of the pull request",
  11014. "name": "index",
  11015. "in": "path",
  11016. "required": true
  11017. },
  11018. {
  11019. "type": "integer",
  11020. "format": "int64",
  11021. "description": "id of the review",
  11022. "name": "id",
  11023. "in": "path",
  11024. "required": true
  11025. },
  11026. {
  11027. "name": "body",
  11028. "in": "body",
  11029. "required": true,
  11030. "schema": {
  11031. "$ref": "#/definitions/SubmitPullReviewOptions"
  11032. }
  11033. }
  11034. ],
  11035. "responses": {
  11036. "200": {
  11037. "$ref": "#/responses/PullReview"
  11038. },
  11039. "404": {
  11040. "$ref": "#/responses/notFound"
  11041. },
  11042. "422": {
  11043. "$ref": "#/responses/validationError"
  11044. }
  11045. }
  11046. },
  11047. "delete": {
  11048. "produces": [
  11049. "application/json"
  11050. ],
  11051. "tags": [
  11052. "repository"
  11053. ],
  11054. "summary": "Delete a specific review from a pull request",
  11055. "operationId": "repoDeletePullReview",
  11056. "parameters": [
  11057. {
  11058. "type": "string",
  11059. "description": "owner of the repo",
  11060. "name": "owner",
  11061. "in": "path",
  11062. "required": true
  11063. },
  11064. {
  11065. "type": "string",
  11066. "description": "name of the repo",
  11067. "name": "repo",
  11068. "in": "path",
  11069. "required": true
  11070. },
  11071. {
  11072. "type": "integer",
  11073. "format": "int64",
  11074. "description": "index of the pull request",
  11075. "name": "index",
  11076. "in": "path",
  11077. "required": true
  11078. },
  11079. {
  11080. "type": "integer",
  11081. "format": "int64",
  11082. "description": "id of the review",
  11083. "name": "id",
  11084. "in": "path",
  11085. "required": true
  11086. }
  11087. ],
  11088. "responses": {
  11089. "204": {
  11090. "$ref": "#/responses/empty"
  11091. },
  11092. "403": {
  11093. "$ref": "#/responses/forbidden"
  11094. },
  11095. "404": {
  11096. "$ref": "#/responses/notFound"
  11097. }
  11098. }
  11099. }
  11100. },
  11101. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  11102. "get": {
  11103. "produces": [
  11104. "application/json"
  11105. ],
  11106. "tags": [
  11107. "repository"
  11108. ],
  11109. "summary": "Get a specific review for a pull request",
  11110. "operationId": "repoGetPullReviewComments",
  11111. "parameters": [
  11112. {
  11113. "type": "string",
  11114. "description": "owner of the repo",
  11115. "name": "owner",
  11116. "in": "path",
  11117. "required": true
  11118. },
  11119. {
  11120. "type": "string",
  11121. "description": "name of the repo",
  11122. "name": "repo",
  11123. "in": "path",
  11124. "required": true
  11125. },
  11126. {
  11127. "type": "integer",
  11128. "format": "int64",
  11129. "description": "index of the pull request",
  11130. "name": "index",
  11131. "in": "path",
  11132. "required": true
  11133. },
  11134. {
  11135. "type": "integer",
  11136. "format": "int64",
  11137. "description": "id of the review",
  11138. "name": "id",
  11139. "in": "path",
  11140. "required": true
  11141. }
  11142. ],
  11143. "responses": {
  11144. "200": {
  11145. "$ref": "#/responses/PullReviewCommentList"
  11146. },
  11147. "404": {
  11148. "$ref": "#/responses/notFound"
  11149. }
  11150. }
  11151. }
  11152. },
  11153. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
  11154. "post": {
  11155. "produces": [
  11156. "application/json"
  11157. ],
  11158. "tags": [
  11159. "repository"
  11160. ],
  11161. "summary": "Dismiss a review for a pull request",
  11162. "operationId": "repoDismissPullReview",
  11163. "parameters": [
  11164. {
  11165. "type": "string",
  11166. "description": "owner of the repo",
  11167. "name": "owner",
  11168. "in": "path",
  11169. "required": true
  11170. },
  11171. {
  11172. "type": "string",
  11173. "description": "name of the repo",
  11174. "name": "repo",
  11175. "in": "path",
  11176. "required": true
  11177. },
  11178. {
  11179. "type": "integer",
  11180. "format": "int64",
  11181. "description": "index of the pull request",
  11182. "name": "index",
  11183. "in": "path",
  11184. "required": true
  11185. },
  11186. {
  11187. "type": "integer",
  11188. "format": "int64",
  11189. "description": "id of the review",
  11190. "name": "id",
  11191. "in": "path",
  11192. "required": true
  11193. },
  11194. {
  11195. "name": "body",
  11196. "in": "body",
  11197. "required": true,
  11198. "schema": {
  11199. "$ref": "#/definitions/DismissPullReviewOptions"
  11200. }
  11201. }
  11202. ],
  11203. "responses": {
  11204. "200": {
  11205. "$ref": "#/responses/PullReview"
  11206. },
  11207. "403": {
  11208. "$ref": "#/responses/forbidden"
  11209. },
  11210. "404": {
  11211. "$ref": "#/responses/notFound"
  11212. },
  11213. "422": {
  11214. "$ref": "#/responses/validationError"
  11215. }
  11216. }
  11217. }
  11218. },
  11219. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
  11220. "post": {
  11221. "produces": [
  11222. "application/json"
  11223. ],
  11224. "tags": [
  11225. "repository"
  11226. ],
  11227. "summary": "Cancel to dismiss a review for a pull request",
  11228. "operationId": "repoUnDismissPullReview",
  11229. "parameters": [
  11230. {
  11231. "type": "string",
  11232. "description": "owner of the repo",
  11233. "name": "owner",
  11234. "in": "path",
  11235. "required": true
  11236. },
  11237. {
  11238. "type": "string",
  11239. "description": "name of the repo",
  11240. "name": "repo",
  11241. "in": "path",
  11242. "required": true
  11243. },
  11244. {
  11245. "type": "integer",
  11246. "format": "int64",
  11247. "description": "index of the pull request",
  11248. "name": "index",
  11249. "in": "path",
  11250. "required": true
  11251. },
  11252. {
  11253. "type": "integer",
  11254. "format": "int64",
  11255. "description": "id of the review",
  11256. "name": "id",
  11257. "in": "path",
  11258. "required": true
  11259. }
  11260. ],
  11261. "responses": {
  11262. "200": {
  11263. "$ref": "#/responses/PullReview"
  11264. },
  11265. "403": {
  11266. "$ref": "#/responses/forbidden"
  11267. },
  11268. "404": {
  11269. "$ref": "#/responses/notFound"
  11270. },
  11271. "422": {
  11272. "$ref": "#/responses/validationError"
  11273. }
  11274. }
  11275. }
  11276. },
  11277. "/repos/{owner}/{repo}/pulls/{index}/update": {
  11278. "post": {
  11279. "produces": [
  11280. "application/json"
  11281. ],
  11282. "tags": [
  11283. "repository"
  11284. ],
  11285. "summary": "Merge PR's baseBranch into headBranch",
  11286. "operationId": "repoUpdatePullRequest",
  11287. "parameters": [
  11288. {
  11289. "type": "string",
  11290. "description": "owner of the repo",
  11291. "name": "owner",
  11292. "in": "path",
  11293. "required": true
  11294. },
  11295. {
  11296. "type": "string",
  11297. "description": "name of the repo",
  11298. "name": "repo",
  11299. "in": "path",
  11300. "required": true
  11301. },
  11302. {
  11303. "type": "integer",
  11304. "format": "int64",
  11305. "description": "index of the pull request to get",
  11306. "name": "index",
  11307. "in": "path",
  11308. "required": true
  11309. },
  11310. {
  11311. "enum": [
  11312. "merge",
  11313. "rebase"
  11314. ],
  11315. "type": "string",
  11316. "description": "how to update pull request",
  11317. "name": "style",
  11318. "in": "query"
  11319. }
  11320. ],
  11321. "responses": {
  11322. "200": {
  11323. "$ref": "#/responses/empty"
  11324. },
  11325. "403": {
  11326. "$ref": "#/responses/forbidden"
  11327. },
  11328. "404": {
  11329. "$ref": "#/responses/notFound"
  11330. },
  11331. "409": {
  11332. "$ref": "#/responses/error"
  11333. },
  11334. "422": {
  11335. "$ref": "#/responses/validationError"
  11336. }
  11337. }
  11338. }
  11339. },
  11340. "/repos/{owner}/{repo}/push_mirrors": {
  11341. "get": {
  11342. "produces": [
  11343. "application/json"
  11344. ],
  11345. "tags": [
  11346. "repository"
  11347. ],
  11348. "summary": "Get all push mirrors of the repository",
  11349. "operationId": "repoListPushMirrors",
  11350. "parameters": [
  11351. {
  11352. "type": "string",
  11353. "description": "owner of the repo",
  11354. "name": "owner",
  11355. "in": "path",
  11356. "required": true
  11357. },
  11358. {
  11359. "type": "string",
  11360. "description": "name of the repo",
  11361. "name": "repo",
  11362. "in": "path",
  11363. "required": true
  11364. },
  11365. {
  11366. "type": "integer",
  11367. "description": "page number of results to return (1-based)",
  11368. "name": "page",
  11369. "in": "query"
  11370. },
  11371. {
  11372. "type": "integer",
  11373. "description": "page size of results",
  11374. "name": "limit",
  11375. "in": "query"
  11376. }
  11377. ],
  11378. "responses": {
  11379. "200": {
  11380. "$ref": "#/responses/PushMirrorList"
  11381. },
  11382. "400": {
  11383. "$ref": "#/responses/error"
  11384. },
  11385. "403": {
  11386. "$ref": "#/responses/forbidden"
  11387. },
  11388. "404": {
  11389. "$ref": "#/responses/notFound"
  11390. }
  11391. }
  11392. },
  11393. "post": {
  11394. "consumes": [
  11395. "application/json"
  11396. ],
  11397. "produces": [
  11398. "application/json"
  11399. ],
  11400. "tags": [
  11401. "repository"
  11402. ],
  11403. "summary": "add a push mirror to the repository",
  11404. "operationId": "repoAddPushMirror",
  11405. "parameters": [
  11406. {
  11407. "type": "string",
  11408. "description": "owner of the repo",
  11409. "name": "owner",
  11410. "in": "path",
  11411. "required": true
  11412. },
  11413. {
  11414. "type": "string",
  11415. "description": "name of the repo",
  11416. "name": "repo",
  11417. "in": "path",
  11418. "required": true
  11419. },
  11420. {
  11421. "name": "body",
  11422. "in": "body",
  11423. "schema": {
  11424. "$ref": "#/definitions/CreatePushMirrorOption"
  11425. }
  11426. }
  11427. ],
  11428. "responses": {
  11429. "200": {
  11430. "$ref": "#/responses/PushMirror"
  11431. },
  11432. "400": {
  11433. "$ref": "#/responses/error"
  11434. },
  11435. "403": {
  11436. "$ref": "#/responses/forbidden"
  11437. },
  11438. "404": {
  11439. "$ref": "#/responses/notFound"
  11440. }
  11441. }
  11442. }
  11443. },
  11444. "/repos/{owner}/{repo}/push_mirrors-sync": {
  11445. "post": {
  11446. "produces": [
  11447. "application/json"
  11448. ],
  11449. "tags": [
  11450. "repository"
  11451. ],
  11452. "summary": "Sync all push mirrored repository",
  11453. "operationId": "repoPushMirrorSync",
  11454. "parameters": [
  11455. {
  11456. "type": "string",
  11457. "description": "owner of the repo to sync",
  11458. "name": "owner",
  11459. "in": "path",
  11460. "required": true
  11461. },
  11462. {
  11463. "type": "string",
  11464. "description": "name of the repo to sync",
  11465. "name": "repo",
  11466. "in": "path",
  11467. "required": true
  11468. }
  11469. ],
  11470. "responses": {
  11471. "200": {
  11472. "$ref": "#/responses/empty"
  11473. },
  11474. "400": {
  11475. "$ref": "#/responses/error"
  11476. },
  11477. "403": {
  11478. "$ref": "#/responses/forbidden"
  11479. },
  11480. "404": {
  11481. "$ref": "#/responses/notFound"
  11482. }
  11483. }
  11484. }
  11485. },
  11486. "/repos/{owner}/{repo}/push_mirrors/{name}": {
  11487. "get": {
  11488. "produces": [
  11489. "application/json"
  11490. ],
  11491. "tags": [
  11492. "repository"
  11493. ],
  11494. "summary": "Get push mirror of the repository by remoteName",
  11495. "operationId": "repoGetPushMirrorByRemoteName",
  11496. "parameters": [
  11497. {
  11498. "type": "string",
  11499. "description": "owner of the repo",
  11500. "name": "owner",
  11501. "in": "path",
  11502. "required": true
  11503. },
  11504. {
  11505. "type": "string",
  11506. "description": "name of the repo",
  11507. "name": "repo",
  11508. "in": "path",
  11509. "required": true
  11510. },
  11511. {
  11512. "type": "string",
  11513. "description": "remote name of push mirror",
  11514. "name": "name",
  11515. "in": "path",
  11516. "required": true
  11517. }
  11518. ],
  11519. "responses": {
  11520. "200": {
  11521. "$ref": "#/responses/PushMirror"
  11522. },
  11523. "400": {
  11524. "$ref": "#/responses/error"
  11525. },
  11526. "403": {
  11527. "$ref": "#/responses/forbidden"
  11528. },
  11529. "404": {
  11530. "$ref": "#/responses/notFound"
  11531. }
  11532. }
  11533. },
  11534. "delete": {
  11535. "produces": [
  11536. "application/json"
  11537. ],
  11538. "tags": [
  11539. "repository"
  11540. ],
  11541. "summary": "deletes a push mirror from a repository by remoteName",
  11542. "operationId": "repoDeletePushMirror",
  11543. "parameters": [
  11544. {
  11545. "type": "string",
  11546. "description": "owner of the repo",
  11547. "name": "owner",
  11548. "in": "path",
  11549. "required": true
  11550. },
  11551. {
  11552. "type": "string",
  11553. "description": "name of the repo",
  11554. "name": "repo",
  11555. "in": "path",
  11556. "required": true
  11557. },
  11558. {
  11559. "type": "string",
  11560. "description": "remote name of the pushMirror",
  11561. "name": "name",
  11562. "in": "path",
  11563. "required": true
  11564. }
  11565. ],
  11566. "responses": {
  11567. "204": {
  11568. "$ref": "#/responses/empty"
  11569. },
  11570. "400": {
  11571. "$ref": "#/responses/error"
  11572. },
  11573. "404": {
  11574. "$ref": "#/responses/notFound"
  11575. }
  11576. }
  11577. }
  11578. },
  11579. "/repos/{owner}/{repo}/raw/{filepath}": {
  11580. "get": {
  11581. "produces": [
  11582. "application/json"
  11583. ],
  11584. "tags": [
  11585. "repository"
  11586. ],
  11587. "summary": "Get a file from a repository",
  11588. "operationId": "repoGetRawFile",
  11589. "parameters": [
  11590. {
  11591. "type": "string",
  11592. "description": "owner of the repo",
  11593. "name": "owner",
  11594. "in": "path",
  11595. "required": true
  11596. },
  11597. {
  11598. "type": "string",
  11599. "description": "name of the repo",
  11600. "name": "repo",
  11601. "in": "path",
  11602. "required": true
  11603. },
  11604. {
  11605. "type": "string",
  11606. "description": "filepath of the file to get",
  11607. "name": "filepath",
  11608. "in": "path",
  11609. "required": true
  11610. },
  11611. {
  11612. "type": "string",
  11613. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  11614. "name": "ref",
  11615. "in": "query"
  11616. }
  11617. ],
  11618. "responses": {
  11619. "200": {
  11620. "description": "Returns raw file content."
  11621. },
  11622. "404": {
  11623. "$ref": "#/responses/notFound"
  11624. }
  11625. }
  11626. }
  11627. },
  11628. "/repos/{owner}/{repo}/releases": {
  11629. "get": {
  11630. "produces": [
  11631. "application/json"
  11632. ],
  11633. "tags": [
  11634. "repository"
  11635. ],
  11636. "summary": "List a repo's releases",
  11637. "operationId": "repoListReleases",
  11638. "parameters": [
  11639. {
  11640. "type": "string",
  11641. "description": "owner of the repo",
  11642. "name": "owner",
  11643. "in": "path",
  11644. "required": true
  11645. },
  11646. {
  11647. "type": "string",
  11648. "description": "name of the repo",
  11649. "name": "repo",
  11650. "in": "path",
  11651. "required": true
  11652. },
  11653. {
  11654. "type": "boolean",
  11655. "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
  11656. "name": "draft",
  11657. "in": "query"
  11658. },
  11659. {
  11660. "type": "boolean",
  11661. "description": "filter (exclude / include) pre-releases",
  11662. "name": "pre-release",
  11663. "in": "query"
  11664. },
  11665. {
  11666. "type": "integer",
  11667. "description": "page size of results, deprecated - use limit",
  11668. "name": "per_page",
  11669. "in": "query"
  11670. },
  11671. {
  11672. "type": "integer",
  11673. "description": "page number of results to return (1-based)",
  11674. "name": "page",
  11675. "in": "query"
  11676. },
  11677. {
  11678. "type": "integer",
  11679. "description": "page size of results",
  11680. "name": "limit",
  11681. "in": "query"
  11682. }
  11683. ],
  11684. "responses": {
  11685. "200": {
  11686. "$ref": "#/responses/ReleaseList"
  11687. },
  11688. "404": {
  11689. "$ref": "#/responses/notFound"
  11690. }
  11691. }
  11692. },
  11693. "post": {
  11694. "consumes": [
  11695. "application/json"
  11696. ],
  11697. "produces": [
  11698. "application/json"
  11699. ],
  11700. "tags": [
  11701. "repository"
  11702. ],
  11703. "summary": "Create a release",
  11704. "operationId": "repoCreateRelease",
  11705. "parameters": [
  11706. {
  11707. "type": "string",
  11708. "description": "owner of the repo",
  11709. "name": "owner",
  11710. "in": "path",
  11711. "required": true
  11712. },
  11713. {
  11714. "type": "string",
  11715. "description": "name of the repo",
  11716. "name": "repo",
  11717. "in": "path",
  11718. "required": true
  11719. },
  11720. {
  11721. "name": "body",
  11722. "in": "body",
  11723. "schema": {
  11724. "$ref": "#/definitions/CreateReleaseOption"
  11725. }
  11726. }
  11727. ],
  11728. "responses": {
  11729. "201": {
  11730. "$ref": "#/responses/Release"
  11731. },
  11732. "404": {
  11733. "$ref": "#/responses/notFound"
  11734. },
  11735. "409": {
  11736. "$ref": "#/responses/error"
  11737. }
  11738. }
  11739. }
  11740. },
  11741. "/repos/{owner}/{repo}/releases/latest": {
  11742. "get": {
  11743. "produces": [
  11744. "application/json"
  11745. ],
  11746. "tags": [
  11747. "repository"
  11748. ],
  11749. "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
  11750. "operationId": "repoGetLatestRelease",
  11751. "parameters": [
  11752. {
  11753. "type": "string",
  11754. "description": "owner of the repo",
  11755. "name": "owner",
  11756. "in": "path",
  11757. "required": true
  11758. },
  11759. {
  11760. "type": "string",
  11761. "description": "name of the repo",
  11762. "name": "repo",
  11763. "in": "path",
  11764. "required": true
  11765. }
  11766. ],
  11767. "responses": {
  11768. "200": {
  11769. "$ref": "#/responses/Release"
  11770. },
  11771. "404": {
  11772. "$ref": "#/responses/notFound"
  11773. }
  11774. }
  11775. }
  11776. },
  11777. "/repos/{owner}/{repo}/releases/tags/{tag}": {
  11778. "get": {
  11779. "produces": [
  11780. "application/json"
  11781. ],
  11782. "tags": [
  11783. "repository"
  11784. ],
  11785. "summary": "Get a release by tag name",
  11786. "operationId": "repoGetReleaseByTag",
  11787. "parameters": [
  11788. {
  11789. "type": "string",
  11790. "description": "owner of the repo",
  11791. "name": "owner",
  11792. "in": "path",
  11793. "required": true
  11794. },
  11795. {
  11796. "type": "string",
  11797. "description": "name of the repo",
  11798. "name": "repo",
  11799. "in": "path",
  11800. "required": true
  11801. },
  11802. {
  11803. "type": "string",
  11804. "description": "tag name of the release to get",
  11805. "name": "tag",
  11806. "in": "path",
  11807. "required": true
  11808. }
  11809. ],
  11810. "responses": {
  11811. "200": {
  11812. "$ref": "#/responses/Release"
  11813. },
  11814. "404": {
  11815. "$ref": "#/responses/notFound"
  11816. }
  11817. }
  11818. },
  11819. "delete": {
  11820. "tags": [
  11821. "repository"
  11822. ],
  11823. "summary": "Delete a release by tag name",
  11824. "operationId": "repoDeleteReleaseByTag",
  11825. "parameters": [
  11826. {
  11827. "type": "string",
  11828. "description": "owner of the repo",
  11829. "name": "owner",
  11830. "in": "path",
  11831. "required": true
  11832. },
  11833. {
  11834. "type": "string",
  11835. "description": "name of the repo",
  11836. "name": "repo",
  11837. "in": "path",
  11838. "required": true
  11839. },
  11840. {
  11841. "type": "string",
  11842. "description": "tag name of the release to delete",
  11843. "name": "tag",
  11844. "in": "path",
  11845. "required": true
  11846. }
  11847. ],
  11848. "responses": {
  11849. "204": {
  11850. "$ref": "#/responses/empty"
  11851. },
  11852. "404": {
  11853. "$ref": "#/responses/notFound"
  11854. },
  11855. "405": {
  11856. "$ref": "#/responses/empty"
  11857. }
  11858. }
  11859. }
  11860. },
  11861. "/repos/{owner}/{repo}/releases/{id}": {
  11862. "get": {
  11863. "produces": [
  11864. "application/json"
  11865. ],
  11866. "tags": [
  11867. "repository"
  11868. ],
  11869. "summary": "Get a release",
  11870. "operationId": "repoGetRelease",
  11871. "parameters": [
  11872. {
  11873. "type": "string",
  11874. "description": "owner of the repo",
  11875. "name": "owner",
  11876. "in": "path",
  11877. "required": true
  11878. },
  11879. {
  11880. "type": "string",
  11881. "description": "name of the repo",
  11882. "name": "repo",
  11883. "in": "path",
  11884. "required": true
  11885. },
  11886. {
  11887. "type": "integer",
  11888. "format": "int64",
  11889. "description": "id of the release to get",
  11890. "name": "id",
  11891. "in": "path",
  11892. "required": true
  11893. }
  11894. ],
  11895. "responses": {
  11896. "200": {
  11897. "$ref": "#/responses/Release"
  11898. },
  11899. "404": {
  11900. "$ref": "#/responses/notFound"
  11901. }
  11902. }
  11903. },
  11904. "delete": {
  11905. "tags": [
  11906. "repository"
  11907. ],
  11908. "summary": "Delete a release",
  11909. "operationId": "repoDeleteRelease",
  11910. "parameters": [
  11911. {
  11912. "type": "string",
  11913. "description": "owner of the repo",
  11914. "name": "owner",
  11915. "in": "path",
  11916. "required": true
  11917. },
  11918. {
  11919. "type": "string",
  11920. "description": "name of the repo",
  11921. "name": "repo",
  11922. "in": "path",
  11923. "required": true
  11924. },
  11925. {
  11926. "type": "integer",
  11927. "format": "int64",
  11928. "description": "id of the release to delete",
  11929. "name": "id",
  11930. "in": "path",
  11931. "required": true
  11932. }
  11933. ],
  11934. "responses": {
  11935. "204": {
  11936. "$ref": "#/responses/empty"
  11937. },
  11938. "404": {
  11939. "$ref": "#/responses/notFound"
  11940. },
  11941. "405": {
  11942. "$ref": "#/responses/empty"
  11943. }
  11944. }
  11945. },
  11946. "patch": {
  11947. "consumes": [
  11948. "application/json"
  11949. ],
  11950. "produces": [
  11951. "application/json"
  11952. ],
  11953. "tags": [
  11954. "repository"
  11955. ],
  11956. "summary": "Update a release",
  11957. "operationId": "repoEditRelease",
  11958. "parameters": [
  11959. {
  11960. "type": "string",
  11961. "description": "owner of the repo",
  11962. "name": "owner",
  11963. "in": "path",
  11964. "required": true
  11965. },
  11966. {
  11967. "type": "string",
  11968. "description": "name of the repo",
  11969. "name": "repo",
  11970. "in": "path",
  11971. "required": true
  11972. },
  11973. {
  11974. "type": "integer",
  11975. "format": "int64",
  11976. "description": "id of the release to edit",
  11977. "name": "id",
  11978. "in": "path",
  11979. "required": true
  11980. },
  11981. {
  11982. "name": "body",
  11983. "in": "body",
  11984. "schema": {
  11985. "$ref": "#/definitions/EditReleaseOption"
  11986. }
  11987. }
  11988. ],
  11989. "responses": {
  11990. "200": {
  11991. "$ref": "#/responses/Release"
  11992. },
  11993. "404": {
  11994. "$ref": "#/responses/notFound"
  11995. }
  11996. }
  11997. }
  11998. },
  11999. "/repos/{owner}/{repo}/releases/{id}/assets": {
  12000. "get": {
  12001. "produces": [
  12002. "application/json"
  12003. ],
  12004. "tags": [
  12005. "repository"
  12006. ],
  12007. "summary": "List release's attachments",
  12008. "operationId": "repoListReleaseAttachments",
  12009. "parameters": [
  12010. {
  12011. "type": "string",
  12012. "description": "owner of the repo",
  12013. "name": "owner",
  12014. "in": "path",
  12015. "required": true
  12016. },
  12017. {
  12018. "type": "string",
  12019. "description": "name of the repo",
  12020. "name": "repo",
  12021. "in": "path",
  12022. "required": true
  12023. },
  12024. {
  12025. "type": "integer",
  12026. "format": "int64",
  12027. "description": "id of the release",
  12028. "name": "id",
  12029. "in": "path",
  12030. "required": true
  12031. }
  12032. ],
  12033. "responses": {
  12034. "200": {
  12035. "$ref": "#/responses/AttachmentList"
  12036. },
  12037. "404": {
  12038. "$ref": "#/responses/notFound"
  12039. }
  12040. }
  12041. },
  12042. "post": {
  12043. "consumes": [
  12044. "multipart/form-data"
  12045. ],
  12046. "produces": [
  12047. "application/json"
  12048. ],
  12049. "tags": [
  12050. "repository"
  12051. ],
  12052. "summary": "Create a release attachment",
  12053. "operationId": "repoCreateReleaseAttachment",
  12054. "parameters": [
  12055. {
  12056. "type": "string",
  12057. "description": "owner of the repo",
  12058. "name": "owner",
  12059. "in": "path",
  12060. "required": true
  12061. },
  12062. {
  12063. "type": "string",
  12064. "description": "name of the repo",
  12065. "name": "repo",
  12066. "in": "path",
  12067. "required": true
  12068. },
  12069. {
  12070. "type": "integer",
  12071. "format": "int64",
  12072. "description": "id of the release",
  12073. "name": "id",
  12074. "in": "path",
  12075. "required": true
  12076. },
  12077. {
  12078. "type": "string",
  12079. "description": "name of the attachment",
  12080. "name": "name",
  12081. "in": "query"
  12082. },
  12083. {
  12084. "type": "file",
  12085. "description": "attachment to upload",
  12086. "name": "attachment",
  12087. "in": "formData",
  12088. "required": true
  12089. }
  12090. ],
  12091. "responses": {
  12092. "201": {
  12093. "$ref": "#/responses/Attachment"
  12094. },
  12095. "400": {
  12096. "$ref": "#/responses/error"
  12097. },
  12098. "404": {
  12099. "$ref": "#/responses/notFound"
  12100. }
  12101. }
  12102. }
  12103. },
  12104. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  12105. "get": {
  12106. "produces": [
  12107. "application/json"
  12108. ],
  12109. "tags": [
  12110. "repository"
  12111. ],
  12112. "summary": "Get a release attachment",
  12113. "operationId": "repoGetReleaseAttachment",
  12114. "parameters": [
  12115. {
  12116. "type": "string",
  12117. "description": "owner of the repo",
  12118. "name": "owner",
  12119. "in": "path",
  12120. "required": true
  12121. },
  12122. {
  12123. "type": "string",
  12124. "description": "name of the repo",
  12125. "name": "repo",
  12126. "in": "path",
  12127. "required": true
  12128. },
  12129. {
  12130. "type": "integer",
  12131. "format": "int64",
  12132. "description": "id of the release",
  12133. "name": "id",
  12134. "in": "path",
  12135. "required": true
  12136. },
  12137. {
  12138. "type": "integer",
  12139. "format": "int64",
  12140. "description": "id of the attachment to get",
  12141. "name": "attachment_id",
  12142. "in": "path",
  12143. "required": true
  12144. }
  12145. ],
  12146. "responses": {
  12147. "200": {
  12148. "$ref": "#/responses/Attachment"
  12149. },
  12150. "404": {
  12151. "$ref": "#/responses/notFound"
  12152. }
  12153. }
  12154. },
  12155. "delete": {
  12156. "produces": [
  12157. "application/json"
  12158. ],
  12159. "tags": [
  12160. "repository"
  12161. ],
  12162. "summary": "Delete a release attachment",
  12163. "operationId": "repoDeleteReleaseAttachment",
  12164. "parameters": [
  12165. {
  12166. "type": "string",
  12167. "description": "owner of the repo",
  12168. "name": "owner",
  12169. "in": "path",
  12170. "required": true
  12171. },
  12172. {
  12173. "type": "string",
  12174. "description": "name of the repo",
  12175. "name": "repo",
  12176. "in": "path",
  12177. "required": true
  12178. },
  12179. {
  12180. "type": "integer",
  12181. "format": "int64",
  12182. "description": "id of the release",
  12183. "name": "id",
  12184. "in": "path",
  12185. "required": true
  12186. },
  12187. {
  12188. "type": "integer",
  12189. "format": "int64",
  12190. "description": "id of the attachment to delete",
  12191. "name": "attachment_id",
  12192. "in": "path",
  12193. "required": true
  12194. }
  12195. ],
  12196. "responses": {
  12197. "204": {
  12198. "$ref": "#/responses/empty"
  12199. },
  12200. "404": {
  12201. "$ref": "#/responses/notFound"
  12202. }
  12203. }
  12204. },
  12205. "patch": {
  12206. "consumes": [
  12207. "application/json"
  12208. ],
  12209. "produces": [
  12210. "application/json"
  12211. ],
  12212. "tags": [
  12213. "repository"
  12214. ],
  12215. "summary": "Edit a release attachment",
  12216. "operationId": "repoEditReleaseAttachment",
  12217. "parameters": [
  12218. {
  12219. "type": "string",
  12220. "description": "owner of the repo",
  12221. "name": "owner",
  12222. "in": "path",
  12223. "required": true
  12224. },
  12225. {
  12226. "type": "string",
  12227. "description": "name of the repo",
  12228. "name": "repo",
  12229. "in": "path",
  12230. "required": true
  12231. },
  12232. {
  12233. "type": "integer",
  12234. "format": "int64",
  12235. "description": "id of the release",
  12236. "name": "id",
  12237. "in": "path",
  12238. "required": true
  12239. },
  12240. {
  12241. "type": "integer",
  12242. "format": "int64",
  12243. "description": "id of the attachment to edit",
  12244. "name": "attachment_id",
  12245. "in": "path",
  12246. "required": true
  12247. },
  12248. {
  12249. "name": "body",
  12250. "in": "body",
  12251. "schema": {
  12252. "$ref": "#/definitions/EditAttachmentOptions"
  12253. }
  12254. }
  12255. ],
  12256. "responses": {
  12257. "201": {
  12258. "$ref": "#/responses/Attachment"
  12259. },
  12260. "404": {
  12261. "$ref": "#/responses/notFound"
  12262. }
  12263. }
  12264. }
  12265. },
  12266. "/repos/{owner}/{repo}/reviewers": {
  12267. "get": {
  12268. "produces": [
  12269. "application/json"
  12270. ],
  12271. "tags": [
  12272. "repository"
  12273. ],
  12274. "summary": "Return all users that can be requested to review in this repo",
  12275. "operationId": "repoGetReviewers",
  12276. "parameters": [
  12277. {
  12278. "type": "string",
  12279. "description": "owner of the repo",
  12280. "name": "owner",
  12281. "in": "path",
  12282. "required": true
  12283. },
  12284. {
  12285. "type": "string",
  12286. "description": "name of the repo",
  12287. "name": "repo",
  12288. "in": "path",
  12289. "required": true
  12290. }
  12291. ],
  12292. "responses": {
  12293. "200": {
  12294. "$ref": "#/responses/UserList"
  12295. },
  12296. "404": {
  12297. "$ref": "#/responses/notFound"
  12298. }
  12299. }
  12300. }
  12301. },
  12302. "/repos/{owner}/{repo}/signing-key.gpg": {
  12303. "get": {
  12304. "produces": [
  12305. "text/plain"
  12306. ],
  12307. "tags": [
  12308. "repository"
  12309. ],
  12310. "summary": "Get signing-key.gpg for given repository",
  12311. "operationId": "repoSigningKey",
  12312. "parameters": [
  12313. {
  12314. "type": "string",
  12315. "description": "owner of the repo",
  12316. "name": "owner",
  12317. "in": "path",
  12318. "required": true
  12319. },
  12320. {
  12321. "type": "string",
  12322. "description": "name of the repo",
  12323. "name": "repo",
  12324. "in": "path",
  12325. "required": true
  12326. }
  12327. ],
  12328. "responses": {
  12329. "200": {
  12330. "description": "GPG armored public key",
  12331. "schema": {
  12332. "type": "string"
  12333. }
  12334. }
  12335. }
  12336. }
  12337. },
  12338. "/repos/{owner}/{repo}/stargazers": {
  12339. "get": {
  12340. "produces": [
  12341. "application/json"
  12342. ],
  12343. "tags": [
  12344. "repository"
  12345. ],
  12346. "summary": "List a repo's stargazers",
  12347. "operationId": "repoListStargazers",
  12348. "parameters": [
  12349. {
  12350. "type": "string",
  12351. "description": "owner of the repo",
  12352. "name": "owner",
  12353. "in": "path",
  12354. "required": true
  12355. },
  12356. {
  12357. "type": "string",
  12358. "description": "name of the repo",
  12359. "name": "repo",
  12360. "in": "path",
  12361. "required": true
  12362. },
  12363. {
  12364. "type": "integer",
  12365. "description": "page number of results to return (1-based)",
  12366. "name": "page",
  12367. "in": "query"
  12368. },
  12369. {
  12370. "type": "integer",
  12371. "description": "page size of results",
  12372. "name": "limit",
  12373. "in": "query"
  12374. }
  12375. ],
  12376. "responses": {
  12377. "200": {
  12378. "$ref": "#/responses/UserList"
  12379. },
  12380. "404": {
  12381. "$ref": "#/responses/notFound"
  12382. }
  12383. }
  12384. }
  12385. },
  12386. "/repos/{owner}/{repo}/statuses/{sha}": {
  12387. "get": {
  12388. "produces": [
  12389. "application/json"
  12390. ],
  12391. "tags": [
  12392. "repository"
  12393. ],
  12394. "summary": "Get a commit's statuses",
  12395. "operationId": "repoListStatuses",
  12396. "parameters": [
  12397. {
  12398. "type": "string",
  12399. "description": "owner of the repo",
  12400. "name": "owner",
  12401. "in": "path",
  12402. "required": true
  12403. },
  12404. {
  12405. "type": "string",
  12406. "description": "name of the repo",
  12407. "name": "repo",
  12408. "in": "path",
  12409. "required": true
  12410. },
  12411. {
  12412. "type": "string",
  12413. "description": "sha of the commit",
  12414. "name": "sha",
  12415. "in": "path",
  12416. "required": true
  12417. },
  12418. {
  12419. "enum": [
  12420. "oldest",
  12421. "recentupdate",
  12422. "leastupdate",
  12423. "leastindex",
  12424. "highestindex"
  12425. ],
  12426. "type": "string",
  12427. "description": "type of sort",
  12428. "name": "sort",
  12429. "in": "query"
  12430. },
  12431. {
  12432. "enum": [
  12433. "pending",
  12434. "success",
  12435. "error",
  12436. "failure",
  12437. "warning"
  12438. ],
  12439. "type": "string",
  12440. "description": "type of state",
  12441. "name": "state",
  12442. "in": "query"
  12443. },
  12444. {
  12445. "type": "integer",
  12446. "description": "page number of results to return (1-based)",
  12447. "name": "page",
  12448. "in": "query"
  12449. },
  12450. {
  12451. "type": "integer",
  12452. "description": "page size of results",
  12453. "name": "limit",
  12454. "in": "query"
  12455. }
  12456. ],
  12457. "responses": {
  12458. "200": {
  12459. "$ref": "#/responses/CommitStatusList"
  12460. },
  12461. "400": {
  12462. "$ref": "#/responses/error"
  12463. },
  12464. "404": {
  12465. "$ref": "#/responses/notFound"
  12466. }
  12467. }
  12468. },
  12469. "post": {
  12470. "produces": [
  12471. "application/json"
  12472. ],
  12473. "tags": [
  12474. "repository"
  12475. ],
  12476. "summary": "Create a commit status",
  12477. "operationId": "repoCreateStatus",
  12478. "parameters": [
  12479. {
  12480. "type": "string",
  12481. "description": "owner of the repo",
  12482. "name": "owner",
  12483. "in": "path",
  12484. "required": true
  12485. },
  12486. {
  12487. "type": "string",
  12488. "description": "name of the repo",
  12489. "name": "repo",
  12490. "in": "path",
  12491. "required": true
  12492. },
  12493. {
  12494. "type": "string",
  12495. "description": "sha of the commit",
  12496. "name": "sha",
  12497. "in": "path",
  12498. "required": true
  12499. },
  12500. {
  12501. "name": "body",
  12502. "in": "body",
  12503. "schema": {
  12504. "$ref": "#/definitions/CreateStatusOption"
  12505. }
  12506. }
  12507. ],
  12508. "responses": {
  12509. "201": {
  12510. "$ref": "#/responses/CommitStatus"
  12511. },
  12512. "400": {
  12513. "$ref": "#/responses/error"
  12514. },
  12515. "404": {
  12516. "$ref": "#/responses/notFound"
  12517. }
  12518. }
  12519. }
  12520. },
  12521. "/repos/{owner}/{repo}/subscribers": {
  12522. "get": {
  12523. "produces": [
  12524. "application/json"
  12525. ],
  12526. "tags": [
  12527. "repository"
  12528. ],
  12529. "summary": "List a repo's watchers",
  12530. "operationId": "repoListSubscribers",
  12531. "parameters": [
  12532. {
  12533. "type": "string",
  12534. "description": "owner of the repo",
  12535. "name": "owner",
  12536. "in": "path",
  12537. "required": true
  12538. },
  12539. {
  12540. "type": "string",
  12541. "description": "name of the repo",
  12542. "name": "repo",
  12543. "in": "path",
  12544. "required": true
  12545. },
  12546. {
  12547. "type": "integer",
  12548. "description": "page number of results to return (1-based)",
  12549. "name": "page",
  12550. "in": "query"
  12551. },
  12552. {
  12553. "type": "integer",
  12554. "description": "page size of results",
  12555. "name": "limit",
  12556. "in": "query"
  12557. }
  12558. ],
  12559. "responses": {
  12560. "200": {
  12561. "$ref": "#/responses/UserList"
  12562. },
  12563. "404": {
  12564. "$ref": "#/responses/notFound"
  12565. }
  12566. }
  12567. }
  12568. },
  12569. "/repos/{owner}/{repo}/subscription": {
  12570. "get": {
  12571. "tags": [
  12572. "repository"
  12573. ],
  12574. "summary": "Check if the current user is watching a repo",
  12575. "operationId": "userCurrentCheckSubscription",
  12576. "parameters": [
  12577. {
  12578. "type": "string",
  12579. "description": "owner of the repo",
  12580. "name": "owner",
  12581. "in": "path",
  12582. "required": true
  12583. },
  12584. {
  12585. "type": "string",
  12586. "description": "name of the repo",
  12587. "name": "repo",
  12588. "in": "path",
  12589. "required": true
  12590. }
  12591. ],
  12592. "responses": {
  12593. "200": {
  12594. "$ref": "#/responses/WatchInfo"
  12595. },
  12596. "404": {
  12597. "description": "User is not watching this repo or repo do not exist"
  12598. }
  12599. }
  12600. },
  12601. "put": {
  12602. "tags": [
  12603. "repository"
  12604. ],
  12605. "summary": "Watch a repo",
  12606. "operationId": "userCurrentPutSubscription",
  12607. "parameters": [
  12608. {
  12609. "type": "string",
  12610. "description": "owner of the repo",
  12611. "name": "owner",
  12612. "in": "path",
  12613. "required": true
  12614. },
  12615. {
  12616. "type": "string",
  12617. "description": "name of the repo",
  12618. "name": "repo",
  12619. "in": "path",
  12620. "required": true
  12621. }
  12622. ],
  12623. "responses": {
  12624. "200": {
  12625. "$ref": "#/responses/WatchInfo"
  12626. },
  12627. "404": {
  12628. "$ref": "#/responses/notFound"
  12629. }
  12630. }
  12631. },
  12632. "delete": {
  12633. "tags": [
  12634. "repository"
  12635. ],
  12636. "summary": "Unwatch a repo",
  12637. "operationId": "userCurrentDeleteSubscription",
  12638. "parameters": [
  12639. {
  12640. "type": "string",
  12641. "description": "owner of the repo",
  12642. "name": "owner",
  12643. "in": "path",
  12644. "required": true
  12645. },
  12646. {
  12647. "type": "string",
  12648. "description": "name of the repo",
  12649. "name": "repo",
  12650. "in": "path",
  12651. "required": true
  12652. }
  12653. ],
  12654. "responses": {
  12655. "204": {
  12656. "$ref": "#/responses/empty"
  12657. },
  12658. "404": {
  12659. "$ref": "#/responses/notFound"
  12660. }
  12661. }
  12662. }
  12663. },
  12664. "/repos/{owner}/{repo}/tags": {
  12665. "get": {
  12666. "produces": [
  12667. "application/json"
  12668. ],
  12669. "tags": [
  12670. "repository"
  12671. ],
  12672. "summary": "List a repository's tags",
  12673. "operationId": "repoListTags",
  12674. "parameters": [
  12675. {
  12676. "type": "string",
  12677. "description": "owner of the repo",
  12678. "name": "owner",
  12679. "in": "path",
  12680. "required": true
  12681. },
  12682. {
  12683. "type": "string",
  12684. "description": "name of the repo",
  12685. "name": "repo",
  12686. "in": "path",
  12687. "required": true
  12688. },
  12689. {
  12690. "type": "integer",
  12691. "description": "page number of results to return (1-based)",
  12692. "name": "page",
  12693. "in": "query"
  12694. },
  12695. {
  12696. "type": "integer",
  12697. "description": "page size of results, default maximum page size is 50",
  12698. "name": "limit",
  12699. "in": "query"
  12700. }
  12701. ],
  12702. "responses": {
  12703. "200": {
  12704. "$ref": "#/responses/TagList"
  12705. },
  12706. "404": {
  12707. "$ref": "#/responses/notFound"
  12708. }
  12709. }
  12710. },
  12711. "post": {
  12712. "produces": [
  12713. "application/json"
  12714. ],
  12715. "tags": [
  12716. "repository"
  12717. ],
  12718. "summary": "Create a new git tag in a repository",
  12719. "operationId": "repoCreateTag",
  12720. "parameters": [
  12721. {
  12722. "type": "string",
  12723. "description": "owner of the repo",
  12724. "name": "owner",
  12725. "in": "path",
  12726. "required": true
  12727. },
  12728. {
  12729. "type": "string",
  12730. "description": "name of the repo",
  12731. "name": "repo",
  12732. "in": "path",
  12733. "required": true
  12734. },
  12735. {
  12736. "name": "body",
  12737. "in": "body",
  12738. "schema": {
  12739. "$ref": "#/definitions/CreateTagOption"
  12740. }
  12741. }
  12742. ],
  12743. "responses": {
  12744. "200": {
  12745. "$ref": "#/responses/Tag"
  12746. },
  12747. "404": {
  12748. "$ref": "#/responses/notFound"
  12749. },
  12750. "405": {
  12751. "$ref": "#/responses/empty"
  12752. },
  12753. "409": {
  12754. "$ref": "#/responses/conflict"
  12755. }
  12756. }
  12757. }
  12758. },
  12759. "/repos/{owner}/{repo}/tags/{tag}": {
  12760. "get": {
  12761. "produces": [
  12762. "application/json"
  12763. ],
  12764. "tags": [
  12765. "repository"
  12766. ],
  12767. "summary": "Get the tag of a repository by tag name",
  12768. "operationId": "repoGetTag",
  12769. "parameters": [
  12770. {
  12771. "type": "string",
  12772. "description": "owner of the repo",
  12773. "name": "owner",
  12774. "in": "path",
  12775. "required": true
  12776. },
  12777. {
  12778. "type": "string",
  12779. "description": "name of the repo",
  12780. "name": "repo",
  12781. "in": "path",
  12782. "required": true
  12783. },
  12784. {
  12785. "type": "string",
  12786. "description": "name of tag",
  12787. "name": "tag",
  12788. "in": "path",
  12789. "required": true
  12790. }
  12791. ],
  12792. "responses": {
  12793. "200": {
  12794. "$ref": "#/responses/Tag"
  12795. },
  12796. "404": {
  12797. "$ref": "#/responses/notFound"
  12798. }
  12799. }
  12800. },
  12801. "delete": {
  12802. "produces": [
  12803. "application/json"
  12804. ],
  12805. "tags": [
  12806. "repository"
  12807. ],
  12808. "summary": "Delete a repository's tag by name",
  12809. "operationId": "repoDeleteTag",
  12810. "parameters": [
  12811. {
  12812. "type": "string",
  12813. "description": "owner of the repo",
  12814. "name": "owner",
  12815. "in": "path",
  12816. "required": true
  12817. },
  12818. {
  12819. "type": "string",
  12820. "description": "name of the repo",
  12821. "name": "repo",
  12822. "in": "path",
  12823. "required": true
  12824. },
  12825. {
  12826. "type": "string",
  12827. "description": "name of tag to delete",
  12828. "name": "tag",
  12829. "in": "path",
  12830. "required": true
  12831. }
  12832. ],
  12833. "responses": {
  12834. "204": {
  12835. "$ref": "#/responses/empty"
  12836. },
  12837. "404": {
  12838. "$ref": "#/responses/notFound"
  12839. },
  12840. "405": {
  12841. "$ref": "#/responses/empty"
  12842. },
  12843. "409": {
  12844. "$ref": "#/responses/conflict"
  12845. }
  12846. }
  12847. }
  12848. },
  12849. "/repos/{owner}/{repo}/teams": {
  12850. "get": {
  12851. "produces": [
  12852. "application/json"
  12853. ],
  12854. "tags": [
  12855. "repository"
  12856. ],
  12857. "summary": "List a repository's teams",
  12858. "operationId": "repoListTeams",
  12859. "parameters": [
  12860. {
  12861. "type": "string",
  12862. "description": "owner of the repo",
  12863. "name": "owner",
  12864. "in": "path",
  12865. "required": true
  12866. },
  12867. {
  12868. "type": "string",
  12869. "description": "name of the repo",
  12870. "name": "repo",
  12871. "in": "path",
  12872. "required": true
  12873. }
  12874. ],
  12875. "responses": {
  12876. "200": {
  12877. "$ref": "#/responses/TeamList"
  12878. },
  12879. "404": {
  12880. "$ref": "#/responses/notFound"
  12881. }
  12882. }
  12883. }
  12884. },
  12885. "/repos/{owner}/{repo}/teams/{team}": {
  12886. "get": {
  12887. "produces": [
  12888. "application/json"
  12889. ],
  12890. "tags": [
  12891. "repository"
  12892. ],
  12893. "summary": "Check if a team is assigned to a repository",
  12894. "operationId": "repoCheckTeam",
  12895. "parameters": [
  12896. {
  12897. "type": "string",
  12898. "description": "owner of the repo",
  12899. "name": "owner",
  12900. "in": "path",
  12901. "required": true
  12902. },
  12903. {
  12904. "type": "string",
  12905. "description": "name of the repo",
  12906. "name": "repo",
  12907. "in": "path",
  12908. "required": true
  12909. },
  12910. {
  12911. "type": "string",
  12912. "description": "team name",
  12913. "name": "team",
  12914. "in": "path",
  12915. "required": true
  12916. }
  12917. ],
  12918. "responses": {
  12919. "200": {
  12920. "$ref": "#/responses/Team"
  12921. },
  12922. "404": {
  12923. "$ref": "#/responses/notFound"
  12924. },
  12925. "405": {
  12926. "$ref": "#/responses/error"
  12927. }
  12928. }
  12929. },
  12930. "put": {
  12931. "produces": [
  12932. "application/json"
  12933. ],
  12934. "tags": [
  12935. "repository"
  12936. ],
  12937. "summary": "Add a team to a repository",
  12938. "operationId": "repoAddTeam",
  12939. "parameters": [
  12940. {
  12941. "type": "string",
  12942. "description": "owner of the repo",
  12943. "name": "owner",
  12944. "in": "path",
  12945. "required": true
  12946. },
  12947. {
  12948. "type": "string",
  12949. "description": "name of the repo",
  12950. "name": "repo",
  12951. "in": "path",
  12952. "required": true
  12953. },
  12954. {
  12955. "type": "string",
  12956. "description": "team name",
  12957. "name": "team",
  12958. "in": "path",
  12959. "required": true
  12960. }
  12961. ],
  12962. "responses": {
  12963. "204": {
  12964. "$ref": "#/responses/empty"
  12965. },
  12966. "404": {
  12967. "$ref": "#/responses/notFound"
  12968. },
  12969. "405": {
  12970. "$ref": "#/responses/error"
  12971. },
  12972. "422": {
  12973. "$ref": "#/responses/validationError"
  12974. }
  12975. }
  12976. },
  12977. "delete": {
  12978. "produces": [
  12979. "application/json"
  12980. ],
  12981. "tags": [
  12982. "repository"
  12983. ],
  12984. "summary": "Delete a team from a repository",
  12985. "operationId": "repoDeleteTeam",
  12986. "parameters": [
  12987. {
  12988. "type": "string",
  12989. "description": "owner of the repo",
  12990. "name": "owner",
  12991. "in": "path",
  12992. "required": true
  12993. },
  12994. {
  12995. "type": "string",
  12996. "description": "name of the repo",
  12997. "name": "repo",
  12998. "in": "path",
  12999. "required": true
  13000. },
  13001. {
  13002. "type": "string",
  13003. "description": "team name",
  13004. "name": "team",
  13005. "in": "path",
  13006. "required": true
  13007. }
  13008. ],
  13009. "responses": {
  13010. "204": {
  13011. "$ref": "#/responses/empty"
  13012. },
  13013. "404": {
  13014. "$ref": "#/responses/notFound"
  13015. },
  13016. "405": {
  13017. "$ref": "#/responses/error"
  13018. },
  13019. "422": {
  13020. "$ref": "#/responses/validationError"
  13021. }
  13022. }
  13023. }
  13024. },
  13025. "/repos/{owner}/{repo}/times": {
  13026. "get": {
  13027. "produces": [
  13028. "application/json"
  13029. ],
  13030. "tags": [
  13031. "repository"
  13032. ],
  13033. "summary": "List a repo's tracked times",
  13034. "operationId": "repoTrackedTimes",
  13035. "parameters": [
  13036. {
  13037. "type": "string",
  13038. "description": "owner of the repo",
  13039. "name": "owner",
  13040. "in": "path",
  13041. "required": true
  13042. },
  13043. {
  13044. "type": "string",
  13045. "description": "name of the repo",
  13046. "name": "repo",
  13047. "in": "path",
  13048. "required": true
  13049. },
  13050. {
  13051. "type": "string",
  13052. "description": "optional filter by user (available for issue managers)",
  13053. "name": "user",
  13054. "in": "query"
  13055. },
  13056. {
  13057. "type": "string",
  13058. "format": "date-time",
  13059. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  13060. "name": "since",
  13061. "in": "query"
  13062. },
  13063. {
  13064. "type": "string",
  13065. "format": "date-time",
  13066. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  13067. "name": "before",
  13068. "in": "query"
  13069. },
  13070. {
  13071. "type": "integer",
  13072. "description": "page number of results to return (1-based)",
  13073. "name": "page",
  13074. "in": "query"
  13075. },
  13076. {
  13077. "type": "integer",
  13078. "description": "page size of results",
  13079. "name": "limit",
  13080. "in": "query"
  13081. }
  13082. ],
  13083. "responses": {
  13084. "200": {
  13085. "$ref": "#/responses/TrackedTimeList"
  13086. },
  13087. "400": {
  13088. "$ref": "#/responses/error"
  13089. },
  13090. "403": {
  13091. "$ref": "#/responses/forbidden"
  13092. },
  13093. "404": {
  13094. "$ref": "#/responses/notFound"
  13095. }
  13096. }
  13097. }
  13098. },
  13099. "/repos/{owner}/{repo}/times/{user}": {
  13100. "get": {
  13101. "produces": [
  13102. "application/json"
  13103. ],
  13104. "tags": [
  13105. "repository"
  13106. ],
  13107. "summary": "List a user's tracked times in a repo",
  13108. "operationId": "userTrackedTimes",
  13109. "deprecated": true,
  13110. "parameters": [
  13111. {
  13112. "type": "string",
  13113. "description": "owner of the repo",
  13114. "name": "owner",
  13115. "in": "path",
  13116. "required": true
  13117. },
  13118. {
  13119. "type": "string",
  13120. "description": "name of the repo",
  13121. "name": "repo",
  13122. "in": "path",
  13123. "required": true
  13124. },
  13125. {
  13126. "type": "string",
  13127. "description": "username of user",
  13128. "name": "user",
  13129. "in": "path",
  13130. "required": true
  13131. }
  13132. ],
  13133. "responses": {
  13134. "200": {
  13135. "$ref": "#/responses/TrackedTimeList"
  13136. },
  13137. "400": {
  13138. "$ref": "#/responses/error"
  13139. },
  13140. "403": {
  13141. "$ref": "#/responses/forbidden"
  13142. },
  13143. "404": {
  13144. "$ref": "#/responses/notFound"
  13145. }
  13146. }
  13147. }
  13148. },
  13149. "/repos/{owner}/{repo}/topics": {
  13150. "get": {
  13151. "produces": [
  13152. "application/json"
  13153. ],
  13154. "tags": [
  13155. "repository"
  13156. ],
  13157. "summary": "Get list of topics that a repository has",
  13158. "operationId": "repoListTopics",
  13159. "parameters": [
  13160. {
  13161. "type": "string",
  13162. "description": "owner of the repo",
  13163. "name": "owner",
  13164. "in": "path",
  13165. "required": true
  13166. },
  13167. {
  13168. "type": "string",
  13169. "description": "name of the repo",
  13170. "name": "repo",
  13171. "in": "path",
  13172. "required": true
  13173. },
  13174. {
  13175. "type": "integer",
  13176. "description": "page number of results to return (1-based)",
  13177. "name": "page",
  13178. "in": "query"
  13179. },
  13180. {
  13181. "type": "integer",
  13182. "description": "page size of results",
  13183. "name": "limit",
  13184. "in": "query"
  13185. }
  13186. ],
  13187. "responses": {
  13188. "200": {
  13189. "$ref": "#/responses/TopicNames"
  13190. },
  13191. "404": {
  13192. "$ref": "#/responses/notFound"
  13193. }
  13194. }
  13195. },
  13196. "put": {
  13197. "produces": [
  13198. "application/json"
  13199. ],
  13200. "tags": [
  13201. "repository"
  13202. ],
  13203. "summary": "Replace list of topics for a repository",
  13204. "operationId": "repoUpdateTopics",
  13205. "parameters": [
  13206. {
  13207. "type": "string",
  13208. "description": "owner of the repo",
  13209. "name": "owner",
  13210. "in": "path",
  13211. "required": true
  13212. },
  13213. {
  13214. "type": "string",
  13215. "description": "name of the repo",
  13216. "name": "repo",
  13217. "in": "path",
  13218. "required": true
  13219. },
  13220. {
  13221. "name": "body",
  13222. "in": "body",
  13223. "schema": {
  13224. "$ref": "#/definitions/RepoTopicOptions"
  13225. }
  13226. }
  13227. ],
  13228. "responses": {
  13229. "204": {
  13230. "$ref": "#/responses/empty"
  13231. },
  13232. "404": {
  13233. "$ref": "#/responses/notFound"
  13234. },
  13235. "422": {
  13236. "$ref": "#/responses/invalidTopicsError"
  13237. }
  13238. }
  13239. }
  13240. },
  13241. "/repos/{owner}/{repo}/topics/{topic}": {
  13242. "put": {
  13243. "produces": [
  13244. "application/json"
  13245. ],
  13246. "tags": [
  13247. "repository"
  13248. ],
  13249. "summary": "Add a topic to a repository",
  13250. "operationId": "repoAddTopic",
  13251. "parameters": [
  13252. {
  13253. "type": "string",
  13254. "description": "owner of the repo",
  13255. "name": "owner",
  13256. "in": "path",
  13257. "required": true
  13258. },
  13259. {
  13260. "type": "string",
  13261. "description": "name of the repo",
  13262. "name": "repo",
  13263. "in": "path",
  13264. "required": true
  13265. },
  13266. {
  13267. "type": "string",
  13268. "description": "name of the topic to add",
  13269. "name": "topic",
  13270. "in": "path",
  13271. "required": true
  13272. }
  13273. ],
  13274. "responses": {
  13275. "204": {
  13276. "$ref": "#/responses/empty"
  13277. },
  13278. "404": {
  13279. "$ref": "#/responses/notFound"
  13280. },
  13281. "422": {
  13282. "$ref": "#/responses/invalidTopicsError"
  13283. }
  13284. }
  13285. },
  13286. "delete": {
  13287. "produces": [
  13288. "application/json"
  13289. ],
  13290. "tags": [
  13291. "repository"
  13292. ],
  13293. "summary": "Delete a topic from a repository",
  13294. "operationId": "repoDeleteTopic",
  13295. "parameters": [
  13296. {
  13297. "type": "string",
  13298. "description": "owner of the repo",
  13299. "name": "owner",
  13300. "in": "path",
  13301. "required": true
  13302. },
  13303. {
  13304. "type": "string",
  13305. "description": "name of the repo",
  13306. "name": "repo",
  13307. "in": "path",
  13308. "required": true
  13309. },
  13310. {
  13311. "type": "string",
  13312. "description": "name of the topic to delete",
  13313. "name": "topic",
  13314. "in": "path",
  13315. "required": true
  13316. }
  13317. ],
  13318. "responses": {
  13319. "204": {
  13320. "$ref": "#/responses/empty"
  13321. },
  13322. "404": {
  13323. "$ref": "#/responses/notFound"
  13324. },
  13325. "422": {
  13326. "$ref": "#/responses/invalidTopicsError"
  13327. }
  13328. }
  13329. }
  13330. },
  13331. "/repos/{owner}/{repo}/transfer": {
  13332. "post": {
  13333. "produces": [
  13334. "application/json"
  13335. ],
  13336. "tags": [
  13337. "repository"
  13338. ],
  13339. "summary": "Transfer a repo ownership",
  13340. "operationId": "repoTransfer",
  13341. "parameters": [
  13342. {
  13343. "type": "string",
  13344. "description": "owner of the repo to transfer",
  13345. "name": "owner",
  13346. "in": "path",
  13347. "required": true
  13348. },
  13349. {
  13350. "type": "string",
  13351. "description": "name of the repo to transfer",
  13352. "name": "repo",
  13353. "in": "path",
  13354. "required": true
  13355. },
  13356. {
  13357. "description": "Transfer Options",
  13358. "name": "body",
  13359. "in": "body",
  13360. "required": true,
  13361. "schema": {
  13362. "$ref": "#/definitions/TransferRepoOption"
  13363. }
  13364. }
  13365. ],
  13366. "responses": {
  13367. "202": {
  13368. "$ref": "#/responses/Repository"
  13369. },
  13370. "403": {
  13371. "$ref": "#/responses/forbidden"
  13372. },
  13373. "404": {
  13374. "$ref": "#/responses/notFound"
  13375. },
  13376. "422": {
  13377. "$ref": "#/responses/validationError"
  13378. }
  13379. }
  13380. }
  13381. },
  13382. "/repos/{owner}/{repo}/transfer/accept": {
  13383. "post": {
  13384. "produces": [
  13385. "application/json"
  13386. ],
  13387. "tags": [
  13388. "repository"
  13389. ],
  13390. "summary": "Accept a repo transfer",
  13391. "operationId": "acceptRepoTransfer",
  13392. "parameters": [
  13393. {
  13394. "type": "string",
  13395. "description": "owner of the repo to transfer",
  13396. "name": "owner",
  13397. "in": "path",
  13398. "required": true
  13399. },
  13400. {
  13401. "type": "string",
  13402. "description": "name of the repo to transfer",
  13403. "name": "repo",
  13404. "in": "path",
  13405. "required": true
  13406. }
  13407. ],
  13408. "responses": {
  13409. "202": {
  13410. "$ref": "#/responses/Repository"
  13411. },
  13412. "403": {
  13413. "$ref": "#/responses/forbidden"
  13414. },
  13415. "404": {
  13416. "$ref": "#/responses/notFound"
  13417. }
  13418. }
  13419. }
  13420. },
  13421. "/repos/{owner}/{repo}/transfer/reject": {
  13422. "post": {
  13423. "produces": [
  13424. "application/json"
  13425. ],
  13426. "tags": [
  13427. "repository"
  13428. ],
  13429. "summary": "Reject a repo transfer",
  13430. "operationId": "rejectRepoTransfer",
  13431. "parameters": [
  13432. {
  13433. "type": "string",
  13434. "description": "owner of the repo to transfer",
  13435. "name": "owner",
  13436. "in": "path",
  13437. "required": true
  13438. },
  13439. {
  13440. "type": "string",
  13441. "description": "name of the repo to transfer",
  13442. "name": "repo",
  13443. "in": "path",
  13444. "required": true
  13445. }
  13446. ],
  13447. "responses": {
  13448. "200": {
  13449. "$ref": "#/responses/Repository"
  13450. },
  13451. "403": {
  13452. "$ref": "#/responses/forbidden"
  13453. },
  13454. "404": {
  13455. "$ref": "#/responses/notFound"
  13456. }
  13457. }
  13458. }
  13459. },
  13460. "/repos/{owner}/{repo}/wiki/new": {
  13461. "post": {
  13462. "consumes": [
  13463. "application/json"
  13464. ],
  13465. "tags": [
  13466. "repository"
  13467. ],
  13468. "summary": "Create a wiki page",
  13469. "operationId": "repoCreateWikiPage",
  13470. "parameters": [
  13471. {
  13472. "type": "string",
  13473. "description": "owner of the repo",
  13474. "name": "owner",
  13475. "in": "path",
  13476. "required": true
  13477. },
  13478. {
  13479. "type": "string",
  13480. "description": "name of the repo",
  13481. "name": "repo",
  13482. "in": "path",
  13483. "required": true
  13484. },
  13485. {
  13486. "name": "body",
  13487. "in": "body",
  13488. "schema": {
  13489. "$ref": "#/definitions/CreateWikiPageOptions"
  13490. }
  13491. }
  13492. ],
  13493. "responses": {
  13494. "201": {
  13495. "$ref": "#/responses/WikiPage"
  13496. },
  13497. "400": {
  13498. "$ref": "#/responses/error"
  13499. },
  13500. "403": {
  13501. "$ref": "#/responses/forbidden"
  13502. },
  13503. "404": {
  13504. "$ref": "#/responses/notFound"
  13505. }
  13506. }
  13507. }
  13508. },
  13509. "/repos/{owner}/{repo}/wiki/page/{pageName}": {
  13510. "get": {
  13511. "produces": [
  13512. "application/json"
  13513. ],
  13514. "tags": [
  13515. "repository"
  13516. ],
  13517. "summary": "Get a wiki page",
  13518. "operationId": "repoGetWikiPage",
  13519. "parameters": [
  13520. {
  13521. "type": "string",
  13522. "description": "owner of the repo",
  13523. "name": "owner",
  13524. "in": "path",
  13525. "required": true
  13526. },
  13527. {
  13528. "type": "string",
  13529. "description": "name of the repo",
  13530. "name": "repo",
  13531. "in": "path",
  13532. "required": true
  13533. },
  13534. {
  13535. "type": "string",
  13536. "description": "name of the page",
  13537. "name": "pageName",
  13538. "in": "path",
  13539. "required": true
  13540. }
  13541. ],
  13542. "responses": {
  13543. "200": {
  13544. "$ref": "#/responses/WikiPage"
  13545. },
  13546. "404": {
  13547. "$ref": "#/responses/notFound"
  13548. }
  13549. }
  13550. },
  13551. "delete": {
  13552. "tags": [
  13553. "repository"
  13554. ],
  13555. "summary": "Delete a wiki page",
  13556. "operationId": "repoDeleteWikiPage",
  13557. "parameters": [
  13558. {
  13559. "type": "string",
  13560. "description": "owner of the repo",
  13561. "name": "owner",
  13562. "in": "path",
  13563. "required": true
  13564. },
  13565. {
  13566. "type": "string",
  13567. "description": "name of the repo",
  13568. "name": "repo",
  13569. "in": "path",
  13570. "required": true
  13571. },
  13572. {
  13573. "type": "string",
  13574. "description": "name of the page",
  13575. "name": "pageName",
  13576. "in": "path",
  13577. "required": true
  13578. }
  13579. ],
  13580. "responses": {
  13581. "204": {
  13582. "$ref": "#/responses/empty"
  13583. },
  13584. "403": {
  13585. "$ref": "#/responses/forbidden"
  13586. },
  13587. "404": {
  13588. "$ref": "#/responses/notFound"
  13589. }
  13590. }
  13591. },
  13592. "patch": {
  13593. "consumes": [
  13594. "application/json"
  13595. ],
  13596. "tags": [
  13597. "repository"
  13598. ],
  13599. "summary": "Edit a wiki page",
  13600. "operationId": "repoEditWikiPage",
  13601. "parameters": [
  13602. {
  13603. "type": "string",
  13604. "description": "owner of the repo",
  13605. "name": "owner",
  13606. "in": "path",
  13607. "required": true
  13608. },
  13609. {
  13610. "type": "string",
  13611. "description": "name of the repo",
  13612. "name": "repo",
  13613. "in": "path",
  13614. "required": true
  13615. },
  13616. {
  13617. "type": "string",
  13618. "description": "name of the page",
  13619. "name": "pageName",
  13620. "in": "path",
  13621. "required": true
  13622. },
  13623. {
  13624. "name": "body",
  13625. "in": "body",
  13626. "schema": {
  13627. "$ref": "#/definitions/CreateWikiPageOptions"
  13628. }
  13629. }
  13630. ],
  13631. "responses": {
  13632. "200": {
  13633. "$ref": "#/responses/WikiPage"
  13634. },
  13635. "400": {
  13636. "$ref": "#/responses/error"
  13637. },
  13638. "403": {
  13639. "$ref": "#/responses/forbidden"
  13640. },
  13641. "404": {
  13642. "$ref": "#/responses/notFound"
  13643. }
  13644. }
  13645. }
  13646. },
  13647. "/repos/{owner}/{repo}/wiki/pages": {
  13648. "get": {
  13649. "produces": [
  13650. "application/json"
  13651. ],
  13652. "tags": [
  13653. "repository"
  13654. ],
  13655. "summary": "Get all wiki pages",
  13656. "operationId": "repoGetWikiPages",
  13657. "parameters": [
  13658. {
  13659. "type": "string",
  13660. "description": "owner of the repo",
  13661. "name": "owner",
  13662. "in": "path",
  13663. "required": true
  13664. },
  13665. {
  13666. "type": "string",
  13667. "description": "name of the repo",
  13668. "name": "repo",
  13669. "in": "path",
  13670. "required": true
  13671. },
  13672. {
  13673. "type": "integer",
  13674. "description": "page number of results to return (1-based)",
  13675. "name": "page",
  13676. "in": "query"
  13677. },
  13678. {
  13679. "type": "integer",
  13680. "description": "page size of results",
  13681. "name": "limit",
  13682. "in": "query"
  13683. }
  13684. ],
  13685. "responses": {
  13686. "200": {
  13687. "$ref": "#/responses/WikiPageList"
  13688. },
  13689. "404": {
  13690. "$ref": "#/responses/notFound"
  13691. }
  13692. }
  13693. }
  13694. },
  13695. "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
  13696. "get": {
  13697. "produces": [
  13698. "application/json"
  13699. ],
  13700. "tags": [
  13701. "repository"
  13702. ],
  13703. "summary": "Get revisions of a wiki page",
  13704. "operationId": "repoGetWikiPageRevisions",
  13705. "parameters": [
  13706. {
  13707. "type": "string",
  13708. "description": "owner of the repo",
  13709. "name": "owner",
  13710. "in": "path",
  13711. "required": true
  13712. },
  13713. {
  13714. "type": "string",
  13715. "description": "name of the repo",
  13716. "name": "repo",
  13717. "in": "path",
  13718. "required": true
  13719. },
  13720. {
  13721. "type": "string",
  13722. "description": "name of the page",
  13723. "name": "pageName",
  13724. "in": "path",
  13725. "required": true
  13726. },
  13727. {
  13728. "type": "integer",
  13729. "description": "page number of results to return (1-based)",
  13730. "name": "page",
  13731. "in": "query"
  13732. }
  13733. ],
  13734. "responses": {
  13735. "200": {
  13736. "$ref": "#/responses/WikiCommitList"
  13737. },
  13738. "404": {
  13739. "$ref": "#/responses/notFound"
  13740. }
  13741. }
  13742. }
  13743. },
  13744. "/repos/{template_owner}/{template_repo}/generate": {
  13745. "post": {
  13746. "consumes": [
  13747. "application/json"
  13748. ],
  13749. "produces": [
  13750. "application/json"
  13751. ],
  13752. "tags": [
  13753. "repository"
  13754. ],
  13755. "summary": "Create a repository using a template",
  13756. "operationId": "generateRepo",
  13757. "parameters": [
  13758. {
  13759. "type": "string",
  13760. "description": "name of the template repository owner",
  13761. "name": "template_owner",
  13762. "in": "path",
  13763. "required": true
  13764. },
  13765. {
  13766. "type": "string",
  13767. "description": "name of the template repository",
  13768. "name": "template_repo",
  13769. "in": "path",
  13770. "required": true
  13771. },
  13772. {
  13773. "name": "body",
  13774. "in": "body",
  13775. "schema": {
  13776. "$ref": "#/definitions/GenerateRepoOption"
  13777. }
  13778. }
  13779. ],
  13780. "responses": {
  13781. "201": {
  13782. "$ref": "#/responses/Repository"
  13783. },
  13784. "403": {
  13785. "$ref": "#/responses/forbidden"
  13786. },
  13787. "404": {
  13788. "$ref": "#/responses/notFound"
  13789. },
  13790. "409": {
  13791. "description": "The repository with the same name already exists."
  13792. },
  13793. "422": {
  13794. "$ref": "#/responses/validationError"
  13795. }
  13796. }
  13797. }
  13798. },
  13799. "/repositories/{id}": {
  13800. "get": {
  13801. "produces": [
  13802. "application/json"
  13803. ],
  13804. "tags": [
  13805. "repository"
  13806. ],
  13807. "summary": "Get a repository by id",
  13808. "operationId": "repoGetByID",
  13809. "parameters": [
  13810. {
  13811. "type": "integer",
  13812. "format": "int64",
  13813. "description": "id of the repo to get",
  13814. "name": "id",
  13815. "in": "path",
  13816. "required": true
  13817. }
  13818. ],
  13819. "responses": {
  13820. "200": {
  13821. "$ref": "#/responses/Repository"
  13822. },
  13823. "404": {
  13824. "$ref": "#/responses/notFound"
  13825. }
  13826. }
  13827. }
  13828. },
  13829. "/settings/api": {
  13830. "get": {
  13831. "produces": [
  13832. "application/json"
  13833. ],
  13834. "tags": [
  13835. "settings"
  13836. ],
  13837. "summary": "Get instance's global settings for api",
  13838. "operationId": "getGeneralAPISettings",
  13839. "responses": {
  13840. "200": {
  13841. "$ref": "#/responses/GeneralAPISettings"
  13842. }
  13843. }
  13844. }
  13845. },
  13846. "/settings/attachment": {
  13847. "get": {
  13848. "produces": [
  13849. "application/json"
  13850. ],
  13851. "tags": [
  13852. "settings"
  13853. ],
  13854. "summary": "Get instance's global settings for Attachment",
  13855. "operationId": "getGeneralAttachmentSettings",
  13856. "responses": {
  13857. "200": {
  13858. "$ref": "#/responses/GeneralAttachmentSettings"
  13859. }
  13860. }
  13861. }
  13862. },
  13863. "/settings/repository": {
  13864. "get": {
  13865. "produces": [
  13866. "application/json"
  13867. ],
  13868. "tags": [
  13869. "settings"
  13870. ],
  13871. "summary": "Get instance's global settings for repositories",
  13872. "operationId": "getGeneralRepositorySettings",
  13873. "responses": {
  13874. "200": {
  13875. "$ref": "#/responses/GeneralRepoSettings"
  13876. }
  13877. }
  13878. }
  13879. },
  13880. "/settings/ui": {
  13881. "get": {
  13882. "produces": [
  13883. "application/json"
  13884. ],
  13885. "tags": [
  13886. "settings"
  13887. ],
  13888. "summary": "Get instance's global settings for ui",
  13889. "operationId": "getGeneralUISettings",
  13890. "responses": {
  13891. "200": {
  13892. "$ref": "#/responses/GeneralUISettings"
  13893. }
  13894. }
  13895. }
  13896. },
  13897. "/signing-key.gpg": {
  13898. "get": {
  13899. "produces": [
  13900. "text/plain"
  13901. ],
  13902. "tags": [
  13903. "miscellaneous"
  13904. ],
  13905. "summary": "Get default signing-key.gpg",
  13906. "operationId": "getSigningKey",
  13907. "responses": {
  13908. "200": {
  13909. "description": "GPG armored public key",
  13910. "schema": {
  13911. "type": "string"
  13912. }
  13913. }
  13914. }
  13915. }
  13916. },
  13917. "/teams/{id}": {
  13918. "get": {
  13919. "produces": [
  13920. "application/json"
  13921. ],
  13922. "tags": [
  13923. "organization"
  13924. ],
  13925. "summary": "Get a team",
  13926. "operationId": "orgGetTeam",
  13927. "parameters": [
  13928. {
  13929. "type": "integer",
  13930. "format": "int64",
  13931. "description": "id of the team to get",
  13932. "name": "id",
  13933. "in": "path",
  13934. "required": true
  13935. }
  13936. ],
  13937. "responses": {
  13938. "200": {
  13939. "$ref": "#/responses/Team"
  13940. },
  13941. "404": {
  13942. "$ref": "#/responses/notFound"
  13943. }
  13944. }
  13945. },
  13946. "delete": {
  13947. "tags": [
  13948. "organization"
  13949. ],
  13950. "summary": "Delete a team",
  13951. "operationId": "orgDeleteTeam",
  13952. "parameters": [
  13953. {
  13954. "type": "integer",
  13955. "format": "int64",
  13956. "description": "id of the team to delete",
  13957. "name": "id",
  13958. "in": "path",
  13959. "required": true
  13960. }
  13961. ],
  13962. "responses": {
  13963. "204": {
  13964. "description": "team deleted"
  13965. },
  13966. "404": {
  13967. "$ref": "#/responses/notFound"
  13968. }
  13969. }
  13970. },
  13971. "patch": {
  13972. "consumes": [
  13973. "application/json"
  13974. ],
  13975. "produces": [
  13976. "application/json"
  13977. ],
  13978. "tags": [
  13979. "organization"
  13980. ],
  13981. "summary": "Edit a team",
  13982. "operationId": "orgEditTeam",
  13983. "parameters": [
  13984. {
  13985. "type": "integer",
  13986. "description": "id of the team to edit",
  13987. "name": "id",
  13988. "in": "path",
  13989. "required": true
  13990. },
  13991. {
  13992. "name": "body",
  13993. "in": "body",
  13994. "schema": {
  13995. "$ref": "#/definitions/EditTeamOption"
  13996. }
  13997. }
  13998. ],
  13999. "responses": {
  14000. "200": {
  14001. "$ref": "#/responses/Team"
  14002. },
  14003. "404": {
  14004. "$ref": "#/responses/notFound"
  14005. }
  14006. }
  14007. }
  14008. },
  14009. "/teams/{id}/activities/feeds": {
  14010. "get": {
  14011. "produces": [
  14012. "application/json"
  14013. ],
  14014. "tags": [
  14015. "organization"
  14016. ],
  14017. "summary": "List a team's activity feeds",
  14018. "operationId": "orgListTeamActivityFeeds",
  14019. "parameters": [
  14020. {
  14021. "type": "integer",
  14022. "format": "int64",
  14023. "description": "id of the team",
  14024. "name": "id",
  14025. "in": "path",
  14026. "required": true
  14027. },
  14028. {
  14029. "type": "string",
  14030. "format": "date",
  14031. "description": "the date of the activities to be found",
  14032. "name": "date",
  14033. "in": "query"
  14034. },
  14035. {
  14036. "type": "integer",
  14037. "description": "page number of results to return (1-based)",
  14038. "name": "page",
  14039. "in": "query"
  14040. },
  14041. {
  14042. "type": "integer",
  14043. "description": "page size of results",
  14044. "name": "limit",
  14045. "in": "query"
  14046. }
  14047. ],
  14048. "responses": {
  14049. "200": {
  14050. "$ref": "#/responses/ActivityFeedsList"
  14051. },
  14052. "404": {
  14053. "$ref": "#/responses/notFound"
  14054. }
  14055. }
  14056. }
  14057. },
  14058. "/teams/{id}/members": {
  14059. "get": {
  14060. "produces": [
  14061. "application/json"
  14062. ],
  14063. "tags": [
  14064. "organization"
  14065. ],
  14066. "summary": "List a team's members",
  14067. "operationId": "orgListTeamMembers",
  14068. "parameters": [
  14069. {
  14070. "type": "integer",
  14071. "format": "int64",
  14072. "description": "id of the team",
  14073. "name": "id",
  14074. "in": "path",
  14075. "required": true
  14076. },
  14077. {
  14078. "type": "integer",
  14079. "description": "page number of results to return (1-based)",
  14080. "name": "page",
  14081. "in": "query"
  14082. },
  14083. {
  14084. "type": "integer",
  14085. "description": "page size of results",
  14086. "name": "limit",
  14087. "in": "query"
  14088. }
  14089. ],
  14090. "responses": {
  14091. "200": {
  14092. "$ref": "#/responses/UserList"
  14093. },
  14094. "404": {
  14095. "$ref": "#/responses/notFound"
  14096. }
  14097. }
  14098. }
  14099. },
  14100. "/teams/{id}/members/{username}": {
  14101. "get": {
  14102. "produces": [
  14103. "application/json"
  14104. ],
  14105. "tags": [
  14106. "organization"
  14107. ],
  14108. "summary": "List a particular member of team",
  14109. "operationId": "orgListTeamMember",
  14110. "parameters": [
  14111. {
  14112. "type": "integer",
  14113. "format": "int64",
  14114. "description": "id of the team",
  14115. "name": "id",
  14116. "in": "path",
  14117. "required": true
  14118. },
  14119. {
  14120. "type": "string",
  14121. "description": "username of the member to list",
  14122. "name": "username",
  14123. "in": "path",
  14124. "required": true
  14125. }
  14126. ],
  14127. "responses": {
  14128. "200": {
  14129. "$ref": "#/responses/User"
  14130. },
  14131. "404": {
  14132. "$ref": "#/responses/notFound"
  14133. }
  14134. }
  14135. },
  14136. "put": {
  14137. "produces": [
  14138. "application/json"
  14139. ],
  14140. "tags": [
  14141. "organization"
  14142. ],
  14143. "summary": "Add a team member",
  14144. "operationId": "orgAddTeamMember",
  14145. "parameters": [
  14146. {
  14147. "type": "integer",
  14148. "format": "int64",
  14149. "description": "id of the team",
  14150. "name": "id",
  14151. "in": "path",
  14152. "required": true
  14153. },
  14154. {
  14155. "type": "string",
  14156. "description": "username of the user to add",
  14157. "name": "username",
  14158. "in": "path",
  14159. "required": true
  14160. }
  14161. ],
  14162. "responses": {
  14163. "204": {
  14164. "$ref": "#/responses/empty"
  14165. },
  14166. "404": {
  14167. "$ref": "#/responses/notFound"
  14168. }
  14169. }
  14170. },
  14171. "delete": {
  14172. "produces": [
  14173. "application/json"
  14174. ],
  14175. "tags": [
  14176. "organization"
  14177. ],
  14178. "summary": "Remove a team member",
  14179. "operationId": "orgRemoveTeamMember",
  14180. "parameters": [
  14181. {
  14182. "type": "integer",
  14183. "format": "int64",
  14184. "description": "id of the team",
  14185. "name": "id",
  14186. "in": "path",
  14187. "required": true
  14188. },
  14189. {
  14190. "type": "string",
  14191. "description": "username of the user to remove",
  14192. "name": "username",
  14193. "in": "path",
  14194. "required": true
  14195. }
  14196. ],
  14197. "responses": {
  14198. "204": {
  14199. "$ref": "#/responses/empty"
  14200. },
  14201. "404": {
  14202. "$ref": "#/responses/notFound"
  14203. }
  14204. }
  14205. }
  14206. },
  14207. "/teams/{id}/repos": {
  14208. "get": {
  14209. "produces": [
  14210. "application/json"
  14211. ],
  14212. "tags": [
  14213. "organization"
  14214. ],
  14215. "summary": "List a team's repos",
  14216. "operationId": "orgListTeamRepos",
  14217. "parameters": [
  14218. {
  14219. "type": "integer",
  14220. "format": "int64",
  14221. "description": "id of the team",
  14222. "name": "id",
  14223. "in": "path",
  14224. "required": true
  14225. },
  14226. {
  14227. "type": "integer",
  14228. "description": "page number of results to return (1-based)",
  14229. "name": "page",
  14230. "in": "query"
  14231. },
  14232. {
  14233. "type": "integer",
  14234. "description": "page size of results",
  14235. "name": "limit",
  14236. "in": "query"
  14237. }
  14238. ],
  14239. "responses": {
  14240. "200": {
  14241. "$ref": "#/responses/RepositoryList"
  14242. },
  14243. "404": {
  14244. "$ref": "#/responses/notFound"
  14245. }
  14246. }
  14247. }
  14248. },
  14249. "/teams/{id}/repos/{org}/{repo}": {
  14250. "get": {
  14251. "produces": [
  14252. "application/json"
  14253. ],
  14254. "tags": [
  14255. "organization"
  14256. ],
  14257. "summary": "List a particular repo of team",
  14258. "operationId": "orgListTeamRepo",
  14259. "parameters": [
  14260. {
  14261. "type": "integer",
  14262. "format": "int64",
  14263. "description": "id of the team",
  14264. "name": "id",
  14265. "in": "path",
  14266. "required": true
  14267. },
  14268. {
  14269. "type": "string",
  14270. "description": "organization that owns the repo to list",
  14271. "name": "org",
  14272. "in": "path",
  14273. "required": true
  14274. },
  14275. {
  14276. "type": "string",
  14277. "description": "name of the repo to list",
  14278. "name": "repo",
  14279. "in": "path",
  14280. "required": true
  14281. }
  14282. ],
  14283. "responses": {
  14284. "200": {
  14285. "$ref": "#/responses/Repository"
  14286. },
  14287. "404": {
  14288. "$ref": "#/responses/notFound"
  14289. }
  14290. }
  14291. },
  14292. "put": {
  14293. "produces": [
  14294. "application/json"
  14295. ],
  14296. "tags": [
  14297. "organization"
  14298. ],
  14299. "summary": "Add a repository to a team",
  14300. "operationId": "orgAddTeamRepository",
  14301. "parameters": [
  14302. {
  14303. "type": "integer",
  14304. "format": "int64",
  14305. "description": "id of the team",
  14306. "name": "id",
  14307. "in": "path",
  14308. "required": true
  14309. },
  14310. {
  14311. "type": "string",
  14312. "description": "organization that owns the repo to add",
  14313. "name": "org",
  14314. "in": "path",
  14315. "required": true
  14316. },
  14317. {
  14318. "type": "string",
  14319. "description": "name of the repo to add",
  14320. "name": "repo",
  14321. "in": "path",
  14322. "required": true
  14323. }
  14324. ],
  14325. "responses": {
  14326. "204": {
  14327. "$ref": "#/responses/empty"
  14328. },
  14329. "403": {
  14330. "$ref": "#/responses/forbidden"
  14331. },
  14332. "404": {
  14333. "$ref": "#/responses/notFound"
  14334. }
  14335. }
  14336. },
  14337. "delete": {
  14338. "description": "This does not delete the repository, it only removes the repository from the team.",
  14339. "produces": [
  14340. "application/json"
  14341. ],
  14342. "tags": [
  14343. "organization"
  14344. ],
  14345. "summary": "Remove a repository from a team",
  14346. "operationId": "orgRemoveTeamRepository",
  14347. "parameters": [
  14348. {
  14349. "type": "integer",
  14350. "format": "int64",
  14351. "description": "id of the team",
  14352. "name": "id",
  14353. "in": "path",
  14354. "required": true
  14355. },
  14356. {
  14357. "type": "string",
  14358. "description": "organization that owns the repo to remove",
  14359. "name": "org",
  14360. "in": "path",
  14361. "required": true
  14362. },
  14363. {
  14364. "type": "string",
  14365. "description": "name of the repo to remove",
  14366. "name": "repo",
  14367. "in": "path",
  14368. "required": true
  14369. }
  14370. ],
  14371. "responses": {
  14372. "204": {
  14373. "$ref": "#/responses/empty"
  14374. },
  14375. "403": {
  14376. "$ref": "#/responses/forbidden"
  14377. },
  14378. "404": {
  14379. "$ref": "#/responses/notFound"
  14380. }
  14381. }
  14382. }
  14383. },
  14384. "/topics/search": {
  14385. "get": {
  14386. "produces": [
  14387. "application/json"
  14388. ],
  14389. "tags": [
  14390. "repository"
  14391. ],
  14392. "summary": "search topics via keyword",
  14393. "operationId": "topicSearch",
  14394. "parameters": [
  14395. {
  14396. "type": "string",
  14397. "description": "keywords to search",
  14398. "name": "q",
  14399. "in": "query",
  14400. "required": true
  14401. },
  14402. {
  14403. "type": "integer",
  14404. "description": "page number of results to return (1-based)",
  14405. "name": "page",
  14406. "in": "query"
  14407. },
  14408. {
  14409. "type": "integer",
  14410. "description": "page size of results",
  14411. "name": "limit",
  14412. "in": "query"
  14413. }
  14414. ],
  14415. "responses": {
  14416. "200": {
  14417. "$ref": "#/responses/TopicListResponse"
  14418. },
  14419. "403": {
  14420. "$ref": "#/responses/forbidden"
  14421. },
  14422. "404": {
  14423. "$ref": "#/responses/notFound"
  14424. }
  14425. }
  14426. }
  14427. },
  14428. "/user": {
  14429. "get": {
  14430. "produces": [
  14431. "application/json"
  14432. ],
  14433. "tags": [
  14434. "user"
  14435. ],
  14436. "summary": "Get the authenticated user",
  14437. "operationId": "userGetCurrent",
  14438. "responses": {
  14439. "200": {
  14440. "$ref": "#/responses/User"
  14441. }
  14442. }
  14443. }
  14444. },
  14445. "/user/actions/secrets/{secretname}": {
  14446. "put": {
  14447. "consumes": [
  14448. "application/json"
  14449. ],
  14450. "produces": [
  14451. "application/json"
  14452. ],
  14453. "tags": [
  14454. "user"
  14455. ],
  14456. "summary": "Create or Update a secret value in a user scope",
  14457. "operationId": "updateUserSecret",
  14458. "parameters": [
  14459. {
  14460. "type": "string",
  14461. "description": "name of the secret",
  14462. "name": "secretname",
  14463. "in": "path",
  14464. "required": true
  14465. },
  14466. {
  14467. "name": "body",
  14468. "in": "body",
  14469. "schema": {
  14470. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  14471. }
  14472. }
  14473. ],
  14474. "responses": {
  14475. "201": {
  14476. "description": "response when creating a secret"
  14477. },
  14478. "204": {
  14479. "description": "response when updating a secret"
  14480. },
  14481. "400": {
  14482. "$ref": "#/responses/error"
  14483. },
  14484. "404": {
  14485. "$ref": "#/responses/notFound"
  14486. }
  14487. }
  14488. },
  14489. "delete": {
  14490. "consumes": [
  14491. "application/json"
  14492. ],
  14493. "produces": [
  14494. "application/json"
  14495. ],
  14496. "tags": [
  14497. "user"
  14498. ],
  14499. "summary": "Delete a secret in a user scope",
  14500. "operationId": "deleteUserSecret",
  14501. "parameters": [
  14502. {
  14503. "type": "string",
  14504. "description": "name of the secret",
  14505. "name": "secretname",
  14506. "in": "path",
  14507. "required": true
  14508. }
  14509. ],
  14510. "responses": {
  14511. "204": {
  14512. "description": "delete one secret of the user"
  14513. },
  14514. "400": {
  14515. "$ref": "#/responses/error"
  14516. },
  14517. "404": {
  14518. "$ref": "#/responses/notFound"
  14519. }
  14520. }
  14521. }
  14522. },
  14523. "/user/applications/oauth2": {
  14524. "get": {
  14525. "produces": [
  14526. "application/json"
  14527. ],
  14528. "tags": [
  14529. "user"
  14530. ],
  14531. "summary": "List the authenticated user's oauth2 applications",
  14532. "operationId": "userGetOauth2Application",
  14533. "parameters": [
  14534. {
  14535. "type": "integer",
  14536. "description": "page number of results to return (1-based)",
  14537. "name": "page",
  14538. "in": "query"
  14539. },
  14540. {
  14541. "type": "integer",
  14542. "description": "page size of results",
  14543. "name": "limit",
  14544. "in": "query"
  14545. }
  14546. ],
  14547. "responses": {
  14548. "200": {
  14549. "$ref": "#/responses/OAuth2ApplicationList"
  14550. }
  14551. }
  14552. },
  14553. "post": {
  14554. "produces": [
  14555. "application/json"
  14556. ],
  14557. "tags": [
  14558. "user"
  14559. ],
  14560. "summary": "creates a new OAuth2 application",
  14561. "operationId": "userCreateOAuth2Application",
  14562. "parameters": [
  14563. {
  14564. "name": "body",
  14565. "in": "body",
  14566. "required": true,
  14567. "schema": {
  14568. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14569. }
  14570. }
  14571. ],
  14572. "responses": {
  14573. "201": {
  14574. "$ref": "#/responses/OAuth2Application"
  14575. },
  14576. "400": {
  14577. "$ref": "#/responses/error"
  14578. }
  14579. }
  14580. }
  14581. },
  14582. "/user/applications/oauth2/{id}": {
  14583. "get": {
  14584. "produces": [
  14585. "application/json"
  14586. ],
  14587. "tags": [
  14588. "user"
  14589. ],
  14590. "summary": "get an OAuth2 Application",
  14591. "operationId": "userGetOAuth2Application",
  14592. "parameters": [
  14593. {
  14594. "type": "integer",
  14595. "format": "int64",
  14596. "description": "Application ID to be found",
  14597. "name": "id",
  14598. "in": "path",
  14599. "required": true
  14600. }
  14601. ],
  14602. "responses": {
  14603. "200": {
  14604. "$ref": "#/responses/OAuth2Application"
  14605. },
  14606. "404": {
  14607. "$ref": "#/responses/notFound"
  14608. }
  14609. }
  14610. },
  14611. "delete": {
  14612. "produces": [
  14613. "application/json"
  14614. ],
  14615. "tags": [
  14616. "user"
  14617. ],
  14618. "summary": "delete an OAuth2 Application",
  14619. "operationId": "userDeleteOAuth2Application",
  14620. "parameters": [
  14621. {
  14622. "type": "integer",
  14623. "format": "int64",
  14624. "description": "token to be deleted",
  14625. "name": "id",
  14626. "in": "path",
  14627. "required": true
  14628. }
  14629. ],
  14630. "responses": {
  14631. "204": {
  14632. "$ref": "#/responses/empty"
  14633. },
  14634. "404": {
  14635. "$ref": "#/responses/notFound"
  14636. }
  14637. }
  14638. },
  14639. "patch": {
  14640. "produces": [
  14641. "application/json"
  14642. ],
  14643. "tags": [
  14644. "user"
  14645. ],
  14646. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  14647. "operationId": "userUpdateOAuth2Application",
  14648. "parameters": [
  14649. {
  14650. "type": "integer",
  14651. "format": "int64",
  14652. "description": "application to be updated",
  14653. "name": "id",
  14654. "in": "path",
  14655. "required": true
  14656. },
  14657. {
  14658. "name": "body",
  14659. "in": "body",
  14660. "required": true,
  14661. "schema": {
  14662. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14663. }
  14664. }
  14665. ],
  14666. "responses": {
  14667. "200": {
  14668. "$ref": "#/responses/OAuth2Application"
  14669. },
  14670. "404": {
  14671. "$ref": "#/responses/notFound"
  14672. }
  14673. }
  14674. }
  14675. },
  14676. "/user/avatar": {
  14677. "post": {
  14678. "produces": [
  14679. "application/json"
  14680. ],
  14681. "tags": [
  14682. "user"
  14683. ],
  14684. "summary": "Update Avatar",
  14685. "operationId": "userUpdateAvatar",
  14686. "parameters": [
  14687. {
  14688. "name": "body",
  14689. "in": "body",
  14690. "schema": {
  14691. "$ref": "#/definitions/UpdateUserAvatarOption"
  14692. }
  14693. }
  14694. ],
  14695. "responses": {
  14696. "204": {
  14697. "$ref": "#/responses/empty"
  14698. }
  14699. }
  14700. },
  14701. "delete": {
  14702. "produces": [
  14703. "application/json"
  14704. ],
  14705. "tags": [
  14706. "user"
  14707. ],
  14708. "summary": "Delete Avatar",
  14709. "operationId": "userDeleteAvatar",
  14710. "responses": {
  14711. "204": {
  14712. "$ref": "#/responses/empty"
  14713. }
  14714. }
  14715. }
  14716. },
  14717. "/user/emails": {
  14718. "get": {
  14719. "produces": [
  14720. "application/json"
  14721. ],
  14722. "tags": [
  14723. "user"
  14724. ],
  14725. "summary": "List the authenticated user's email addresses",
  14726. "operationId": "userListEmails",
  14727. "responses": {
  14728. "200": {
  14729. "$ref": "#/responses/EmailList"
  14730. }
  14731. }
  14732. },
  14733. "post": {
  14734. "produces": [
  14735. "application/json"
  14736. ],
  14737. "tags": [
  14738. "user"
  14739. ],
  14740. "summary": "Add email addresses",
  14741. "operationId": "userAddEmail",
  14742. "parameters": [
  14743. {
  14744. "name": "body",
  14745. "in": "body",
  14746. "schema": {
  14747. "$ref": "#/definitions/CreateEmailOption"
  14748. }
  14749. }
  14750. ],
  14751. "responses": {
  14752. "201": {
  14753. "$ref": "#/responses/EmailList"
  14754. },
  14755. "422": {
  14756. "$ref": "#/responses/validationError"
  14757. }
  14758. }
  14759. },
  14760. "delete": {
  14761. "produces": [
  14762. "application/json"
  14763. ],
  14764. "tags": [
  14765. "user"
  14766. ],
  14767. "summary": "Delete email addresses",
  14768. "operationId": "userDeleteEmail",
  14769. "parameters": [
  14770. {
  14771. "name": "body",
  14772. "in": "body",
  14773. "schema": {
  14774. "$ref": "#/definitions/DeleteEmailOption"
  14775. }
  14776. }
  14777. ],
  14778. "responses": {
  14779. "204": {
  14780. "$ref": "#/responses/empty"
  14781. },
  14782. "404": {
  14783. "$ref": "#/responses/notFound"
  14784. }
  14785. }
  14786. }
  14787. },
  14788. "/user/followers": {
  14789. "get": {
  14790. "produces": [
  14791. "application/json"
  14792. ],
  14793. "tags": [
  14794. "user"
  14795. ],
  14796. "summary": "List the authenticated user's followers",
  14797. "operationId": "userCurrentListFollowers",
  14798. "parameters": [
  14799. {
  14800. "type": "integer",
  14801. "description": "page number of results to return (1-based)",
  14802. "name": "page",
  14803. "in": "query"
  14804. },
  14805. {
  14806. "type": "integer",
  14807. "description": "page size of results",
  14808. "name": "limit",
  14809. "in": "query"
  14810. }
  14811. ],
  14812. "responses": {
  14813. "200": {
  14814. "$ref": "#/responses/UserList"
  14815. }
  14816. }
  14817. }
  14818. },
  14819. "/user/following": {
  14820. "get": {
  14821. "produces": [
  14822. "application/json"
  14823. ],
  14824. "tags": [
  14825. "user"
  14826. ],
  14827. "summary": "List the users that the authenticated user is following",
  14828. "operationId": "userCurrentListFollowing",
  14829. "parameters": [
  14830. {
  14831. "type": "integer",
  14832. "description": "page number of results to return (1-based)",
  14833. "name": "page",
  14834. "in": "query"
  14835. },
  14836. {
  14837. "type": "integer",
  14838. "description": "page size of results",
  14839. "name": "limit",
  14840. "in": "query"
  14841. }
  14842. ],
  14843. "responses": {
  14844. "200": {
  14845. "$ref": "#/responses/UserList"
  14846. }
  14847. }
  14848. }
  14849. },
  14850. "/user/following/{username}": {
  14851. "get": {
  14852. "tags": [
  14853. "user"
  14854. ],
  14855. "summary": "Check whether a user is followed by the authenticated user",
  14856. "operationId": "userCurrentCheckFollowing",
  14857. "parameters": [
  14858. {
  14859. "type": "string",
  14860. "description": "username of followed user",
  14861. "name": "username",
  14862. "in": "path",
  14863. "required": true
  14864. }
  14865. ],
  14866. "responses": {
  14867. "204": {
  14868. "$ref": "#/responses/empty"
  14869. },
  14870. "404": {
  14871. "$ref": "#/responses/notFound"
  14872. }
  14873. }
  14874. },
  14875. "put": {
  14876. "tags": [
  14877. "user"
  14878. ],
  14879. "summary": "Follow a user",
  14880. "operationId": "userCurrentPutFollow",
  14881. "parameters": [
  14882. {
  14883. "type": "string",
  14884. "description": "username of user to follow",
  14885. "name": "username",
  14886. "in": "path",
  14887. "required": true
  14888. }
  14889. ],
  14890. "responses": {
  14891. "204": {
  14892. "$ref": "#/responses/empty"
  14893. },
  14894. "404": {
  14895. "$ref": "#/responses/notFound"
  14896. }
  14897. }
  14898. },
  14899. "delete": {
  14900. "tags": [
  14901. "user"
  14902. ],
  14903. "summary": "Unfollow a user",
  14904. "operationId": "userCurrentDeleteFollow",
  14905. "parameters": [
  14906. {
  14907. "type": "string",
  14908. "description": "username of user to unfollow",
  14909. "name": "username",
  14910. "in": "path",
  14911. "required": true
  14912. }
  14913. ],
  14914. "responses": {
  14915. "204": {
  14916. "$ref": "#/responses/empty"
  14917. },
  14918. "404": {
  14919. "$ref": "#/responses/notFound"
  14920. }
  14921. }
  14922. }
  14923. },
  14924. "/user/gpg_key_token": {
  14925. "get": {
  14926. "produces": [
  14927. "text/plain"
  14928. ],
  14929. "tags": [
  14930. "user"
  14931. ],
  14932. "summary": "Get a Token to verify",
  14933. "operationId": "getVerificationToken",
  14934. "responses": {
  14935. "200": {
  14936. "$ref": "#/responses/string"
  14937. },
  14938. "404": {
  14939. "$ref": "#/responses/notFound"
  14940. }
  14941. }
  14942. }
  14943. },
  14944. "/user/gpg_key_verify": {
  14945. "post": {
  14946. "consumes": [
  14947. "application/json"
  14948. ],
  14949. "produces": [
  14950. "application/json"
  14951. ],
  14952. "tags": [
  14953. "user"
  14954. ],
  14955. "summary": "Verify a GPG key",
  14956. "operationId": "userVerifyGPGKey",
  14957. "responses": {
  14958. "201": {
  14959. "$ref": "#/responses/GPGKey"
  14960. },
  14961. "404": {
  14962. "$ref": "#/responses/notFound"
  14963. },
  14964. "422": {
  14965. "$ref": "#/responses/validationError"
  14966. }
  14967. }
  14968. }
  14969. },
  14970. "/user/gpg_keys": {
  14971. "get": {
  14972. "produces": [
  14973. "application/json"
  14974. ],
  14975. "tags": [
  14976. "user"
  14977. ],
  14978. "summary": "List the authenticated user's GPG keys",
  14979. "operationId": "userCurrentListGPGKeys",
  14980. "parameters": [
  14981. {
  14982. "type": "integer",
  14983. "description": "page number of results to return (1-based)",
  14984. "name": "page",
  14985. "in": "query"
  14986. },
  14987. {
  14988. "type": "integer",
  14989. "description": "page size of results",
  14990. "name": "limit",
  14991. "in": "query"
  14992. }
  14993. ],
  14994. "responses": {
  14995. "200": {
  14996. "$ref": "#/responses/GPGKeyList"
  14997. }
  14998. }
  14999. },
  15000. "post": {
  15001. "consumes": [
  15002. "application/json"
  15003. ],
  15004. "produces": [
  15005. "application/json"
  15006. ],
  15007. "tags": [
  15008. "user"
  15009. ],
  15010. "summary": "Create a GPG key",
  15011. "operationId": "userCurrentPostGPGKey",
  15012. "parameters": [
  15013. {
  15014. "name": "Form",
  15015. "in": "body",
  15016. "schema": {
  15017. "$ref": "#/definitions/CreateGPGKeyOption"
  15018. }
  15019. }
  15020. ],
  15021. "responses": {
  15022. "201": {
  15023. "$ref": "#/responses/GPGKey"
  15024. },
  15025. "404": {
  15026. "$ref": "#/responses/notFound"
  15027. },
  15028. "422": {
  15029. "$ref": "#/responses/validationError"
  15030. }
  15031. }
  15032. }
  15033. },
  15034. "/user/gpg_keys/{id}": {
  15035. "get": {
  15036. "produces": [
  15037. "application/json"
  15038. ],
  15039. "tags": [
  15040. "user"
  15041. ],
  15042. "summary": "Get a GPG key",
  15043. "operationId": "userCurrentGetGPGKey",
  15044. "parameters": [
  15045. {
  15046. "type": "integer",
  15047. "format": "int64",
  15048. "description": "id of key to get",
  15049. "name": "id",
  15050. "in": "path",
  15051. "required": true
  15052. }
  15053. ],
  15054. "responses": {
  15055. "200": {
  15056. "$ref": "#/responses/GPGKey"
  15057. },
  15058. "404": {
  15059. "$ref": "#/responses/notFound"
  15060. }
  15061. }
  15062. },
  15063. "delete": {
  15064. "produces": [
  15065. "application/json"
  15066. ],
  15067. "tags": [
  15068. "user"
  15069. ],
  15070. "summary": "Remove a GPG key",
  15071. "operationId": "userCurrentDeleteGPGKey",
  15072. "parameters": [
  15073. {
  15074. "type": "integer",
  15075. "format": "int64",
  15076. "description": "id of key to delete",
  15077. "name": "id",
  15078. "in": "path",
  15079. "required": true
  15080. }
  15081. ],
  15082. "responses": {
  15083. "204": {
  15084. "$ref": "#/responses/empty"
  15085. },
  15086. "403": {
  15087. "$ref": "#/responses/forbidden"
  15088. },
  15089. "404": {
  15090. "$ref": "#/responses/notFound"
  15091. }
  15092. }
  15093. }
  15094. },
  15095. "/user/hooks": {
  15096. "get": {
  15097. "produces": [
  15098. "application/json"
  15099. ],
  15100. "tags": [
  15101. "user"
  15102. ],
  15103. "summary": "List the authenticated user's webhooks",
  15104. "operationId": "userListHooks",
  15105. "parameters": [
  15106. {
  15107. "type": "integer",
  15108. "description": "page number of results to return (1-based)",
  15109. "name": "page",
  15110. "in": "query"
  15111. },
  15112. {
  15113. "type": "integer",
  15114. "description": "page size of results",
  15115. "name": "limit",
  15116. "in": "query"
  15117. }
  15118. ],
  15119. "responses": {
  15120. "200": {
  15121. "$ref": "#/responses/HookList"
  15122. }
  15123. }
  15124. },
  15125. "post": {
  15126. "consumes": [
  15127. "application/json"
  15128. ],
  15129. "produces": [
  15130. "application/json"
  15131. ],
  15132. "tags": [
  15133. "user"
  15134. ],
  15135. "summary": "Create a hook",
  15136. "operationId": "userCreateHook",
  15137. "parameters": [
  15138. {
  15139. "name": "body",
  15140. "in": "body",
  15141. "required": true,
  15142. "schema": {
  15143. "$ref": "#/definitions/CreateHookOption"
  15144. }
  15145. }
  15146. ],
  15147. "responses": {
  15148. "201": {
  15149. "$ref": "#/responses/Hook"
  15150. }
  15151. }
  15152. }
  15153. },
  15154. "/user/hooks/{id}": {
  15155. "get": {
  15156. "produces": [
  15157. "application/json"
  15158. ],
  15159. "tags": [
  15160. "user"
  15161. ],
  15162. "summary": "Get a hook",
  15163. "operationId": "userGetHook",
  15164. "parameters": [
  15165. {
  15166. "type": "integer",
  15167. "format": "int64",
  15168. "description": "id of the hook to get",
  15169. "name": "id",
  15170. "in": "path",
  15171. "required": true
  15172. }
  15173. ],
  15174. "responses": {
  15175. "200": {
  15176. "$ref": "#/responses/Hook"
  15177. }
  15178. }
  15179. },
  15180. "delete": {
  15181. "produces": [
  15182. "application/json"
  15183. ],
  15184. "tags": [
  15185. "user"
  15186. ],
  15187. "summary": "Delete a hook",
  15188. "operationId": "userDeleteHook",
  15189. "parameters": [
  15190. {
  15191. "type": "integer",
  15192. "format": "int64",
  15193. "description": "id of the hook to delete",
  15194. "name": "id",
  15195. "in": "path",
  15196. "required": true
  15197. }
  15198. ],
  15199. "responses": {
  15200. "204": {
  15201. "$ref": "#/responses/empty"
  15202. }
  15203. }
  15204. },
  15205. "patch": {
  15206. "consumes": [
  15207. "application/json"
  15208. ],
  15209. "produces": [
  15210. "application/json"
  15211. ],
  15212. "tags": [
  15213. "user"
  15214. ],
  15215. "summary": "Update a hook",
  15216. "operationId": "userEditHook",
  15217. "parameters": [
  15218. {
  15219. "type": "integer",
  15220. "format": "int64",
  15221. "description": "id of the hook to update",
  15222. "name": "id",
  15223. "in": "path",
  15224. "required": true
  15225. },
  15226. {
  15227. "name": "body",
  15228. "in": "body",
  15229. "schema": {
  15230. "$ref": "#/definitions/EditHookOption"
  15231. }
  15232. }
  15233. ],
  15234. "responses": {
  15235. "200": {
  15236. "$ref": "#/responses/Hook"
  15237. }
  15238. }
  15239. }
  15240. },
  15241. "/user/keys": {
  15242. "get": {
  15243. "produces": [
  15244. "application/json"
  15245. ],
  15246. "tags": [
  15247. "user"
  15248. ],
  15249. "summary": "List the authenticated user's public keys",
  15250. "operationId": "userCurrentListKeys",
  15251. "parameters": [
  15252. {
  15253. "type": "string",
  15254. "description": "fingerprint of the key",
  15255. "name": "fingerprint",
  15256. "in": "query"
  15257. },
  15258. {
  15259. "type": "integer",
  15260. "description": "page number of results to return (1-based)",
  15261. "name": "page",
  15262. "in": "query"
  15263. },
  15264. {
  15265. "type": "integer",
  15266. "description": "page size of results",
  15267. "name": "limit",
  15268. "in": "query"
  15269. }
  15270. ],
  15271. "responses": {
  15272. "200": {
  15273. "$ref": "#/responses/PublicKeyList"
  15274. }
  15275. }
  15276. },
  15277. "post": {
  15278. "consumes": [
  15279. "application/json"
  15280. ],
  15281. "produces": [
  15282. "application/json"
  15283. ],
  15284. "tags": [
  15285. "user"
  15286. ],
  15287. "summary": "Create a public key",
  15288. "operationId": "userCurrentPostKey",
  15289. "parameters": [
  15290. {
  15291. "name": "body",
  15292. "in": "body",
  15293. "schema": {
  15294. "$ref": "#/definitions/CreateKeyOption"
  15295. }
  15296. }
  15297. ],
  15298. "responses": {
  15299. "201": {
  15300. "$ref": "#/responses/PublicKey"
  15301. },
  15302. "422": {
  15303. "$ref": "#/responses/validationError"
  15304. }
  15305. }
  15306. }
  15307. },
  15308. "/user/keys/{id}": {
  15309. "get": {
  15310. "produces": [
  15311. "application/json"
  15312. ],
  15313. "tags": [
  15314. "user"
  15315. ],
  15316. "summary": "Get a public key",
  15317. "operationId": "userCurrentGetKey",
  15318. "parameters": [
  15319. {
  15320. "type": "integer",
  15321. "format": "int64",
  15322. "description": "id of key to get",
  15323. "name": "id",
  15324. "in": "path",
  15325. "required": true
  15326. }
  15327. ],
  15328. "responses": {
  15329. "200": {
  15330. "$ref": "#/responses/PublicKey"
  15331. },
  15332. "404": {
  15333. "$ref": "#/responses/notFound"
  15334. }
  15335. }
  15336. },
  15337. "delete": {
  15338. "produces": [
  15339. "application/json"
  15340. ],
  15341. "tags": [
  15342. "user"
  15343. ],
  15344. "summary": "Delete a public key",
  15345. "operationId": "userCurrentDeleteKey",
  15346. "parameters": [
  15347. {
  15348. "type": "integer",
  15349. "format": "int64",
  15350. "description": "id of key to delete",
  15351. "name": "id",
  15352. "in": "path",
  15353. "required": true
  15354. }
  15355. ],
  15356. "responses": {
  15357. "204": {
  15358. "$ref": "#/responses/empty"
  15359. },
  15360. "403": {
  15361. "$ref": "#/responses/forbidden"
  15362. },
  15363. "404": {
  15364. "$ref": "#/responses/notFound"
  15365. }
  15366. }
  15367. }
  15368. },
  15369. "/user/orgs": {
  15370. "get": {
  15371. "produces": [
  15372. "application/json"
  15373. ],
  15374. "tags": [
  15375. "organization"
  15376. ],
  15377. "summary": "List the current user's organizations",
  15378. "operationId": "orgListCurrentUserOrgs",
  15379. "parameters": [
  15380. {
  15381. "type": "integer",
  15382. "description": "page number of results to return (1-based)",
  15383. "name": "page",
  15384. "in": "query"
  15385. },
  15386. {
  15387. "type": "integer",
  15388. "description": "page size of results",
  15389. "name": "limit",
  15390. "in": "query"
  15391. }
  15392. ],
  15393. "responses": {
  15394. "200": {
  15395. "$ref": "#/responses/OrganizationList"
  15396. },
  15397. "404": {
  15398. "$ref": "#/responses/notFound"
  15399. }
  15400. }
  15401. }
  15402. },
  15403. "/user/repos": {
  15404. "get": {
  15405. "produces": [
  15406. "application/json"
  15407. ],
  15408. "tags": [
  15409. "user"
  15410. ],
  15411. "summary": "List the repos that the authenticated user owns",
  15412. "operationId": "userCurrentListRepos",
  15413. "parameters": [
  15414. {
  15415. "type": "integer",
  15416. "description": "page number of results to return (1-based)",
  15417. "name": "page",
  15418. "in": "query"
  15419. },
  15420. {
  15421. "type": "integer",
  15422. "description": "page size of results",
  15423. "name": "limit",
  15424. "in": "query"
  15425. }
  15426. ],
  15427. "responses": {
  15428. "200": {
  15429. "$ref": "#/responses/RepositoryList"
  15430. }
  15431. }
  15432. },
  15433. "post": {
  15434. "consumes": [
  15435. "application/json"
  15436. ],
  15437. "produces": [
  15438. "application/json"
  15439. ],
  15440. "tags": [
  15441. "repository",
  15442. "user"
  15443. ],
  15444. "summary": "Create a repository",
  15445. "operationId": "createCurrentUserRepo",
  15446. "parameters": [
  15447. {
  15448. "name": "body",
  15449. "in": "body",
  15450. "schema": {
  15451. "$ref": "#/definitions/CreateRepoOption"
  15452. }
  15453. }
  15454. ],
  15455. "responses": {
  15456. "201": {
  15457. "$ref": "#/responses/Repository"
  15458. },
  15459. "400": {
  15460. "$ref": "#/responses/error"
  15461. },
  15462. "409": {
  15463. "description": "The repository with the same name already exists."
  15464. },
  15465. "422": {
  15466. "$ref": "#/responses/validationError"
  15467. }
  15468. }
  15469. }
  15470. },
  15471. "/user/settings": {
  15472. "get": {
  15473. "produces": [
  15474. "application/json"
  15475. ],
  15476. "tags": [
  15477. "user"
  15478. ],
  15479. "summary": "Get user settings",
  15480. "operationId": "getUserSettings",
  15481. "responses": {
  15482. "200": {
  15483. "$ref": "#/responses/UserSettings"
  15484. }
  15485. }
  15486. },
  15487. "patch": {
  15488. "produces": [
  15489. "application/json"
  15490. ],
  15491. "tags": [
  15492. "user"
  15493. ],
  15494. "summary": "Update user settings",
  15495. "operationId": "updateUserSettings",
  15496. "parameters": [
  15497. {
  15498. "name": "body",
  15499. "in": "body",
  15500. "schema": {
  15501. "$ref": "#/definitions/UserSettingsOptions"
  15502. }
  15503. }
  15504. ],
  15505. "responses": {
  15506. "200": {
  15507. "$ref": "#/responses/UserSettings"
  15508. }
  15509. }
  15510. }
  15511. },
  15512. "/user/starred": {
  15513. "get": {
  15514. "produces": [
  15515. "application/json"
  15516. ],
  15517. "tags": [
  15518. "user"
  15519. ],
  15520. "summary": "The repos that the authenticated user has starred",
  15521. "operationId": "userCurrentListStarred",
  15522. "parameters": [
  15523. {
  15524. "type": "integer",
  15525. "description": "page number of results to return (1-based)",
  15526. "name": "page",
  15527. "in": "query"
  15528. },
  15529. {
  15530. "type": "integer",
  15531. "description": "page size of results",
  15532. "name": "limit",
  15533. "in": "query"
  15534. }
  15535. ],
  15536. "responses": {
  15537. "200": {
  15538. "$ref": "#/responses/RepositoryList"
  15539. }
  15540. }
  15541. }
  15542. },
  15543. "/user/starred/{owner}/{repo}": {
  15544. "get": {
  15545. "tags": [
  15546. "user"
  15547. ],
  15548. "summary": "Whether the authenticated is starring the repo",
  15549. "operationId": "userCurrentCheckStarring",
  15550. "parameters": [
  15551. {
  15552. "type": "string",
  15553. "description": "owner of the repo",
  15554. "name": "owner",
  15555. "in": "path",
  15556. "required": true
  15557. },
  15558. {
  15559. "type": "string",
  15560. "description": "name of the repo",
  15561. "name": "repo",
  15562. "in": "path",
  15563. "required": true
  15564. }
  15565. ],
  15566. "responses": {
  15567. "204": {
  15568. "$ref": "#/responses/empty"
  15569. },
  15570. "404": {
  15571. "$ref": "#/responses/notFound"
  15572. }
  15573. }
  15574. },
  15575. "put": {
  15576. "tags": [
  15577. "user"
  15578. ],
  15579. "summary": "Star the given repo",
  15580. "operationId": "userCurrentPutStar",
  15581. "parameters": [
  15582. {
  15583. "type": "string",
  15584. "description": "owner of the repo to star",
  15585. "name": "owner",
  15586. "in": "path",
  15587. "required": true
  15588. },
  15589. {
  15590. "type": "string",
  15591. "description": "name of the repo to star",
  15592. "name": "repo",
  15593. "in": "path",
  15594. "required": true
  15595. }
  15596. ],
  15597. "responses": {
  15598. "204": {
  15599. "$ref": "#/responses/empty"
  15600. },
  15601. "404": {
  15602. "$ref": "#/responses/notFound"
  15603. }
  15604. }
  15605. },
  15606. "delete": {
  15607. "tags": [
  15608. "user"
  15609. ],
  15610. "summary": "Unstar the given repo",
  15611. "operationId": "userCurrentDeleteStar",
  15612. "parameters": [
  15613. {
  15614. "type": "string",
  15615. "description": "owner of the repo to unstar",
  15616. "name": "owner",
  15617. "in": "path",
  15618. "required": true
  15619. },
  15620. {
  15621. "type": "string",
  15622. "description": "name of the repo to unstar",
  15623. "name": "repo",
  15624. "in": "path",
  15625. "required": true
  15626. }
  15627. ],
  15628. "responses": {
  15629. "204": {
  15630. "$ref": "#/responses/empty"
  15631. },
  15632. "404": {
  15633. "$ref": "#/responses/notFound"
  15634. }
  15635. }
  15636. }
  15637. },
  15638. "/user/stopwatches": {
  15639. "get": {
  15640. "consumes": [
  15641. "application/json"
  15642. ],
  15643. "produces": [
  15644. "application/json"
  15645. ],
  15646. "tags": [
  15647. "user"
  15648. ],
  15649. "summary": "Get list of all existing stopwatches",
  15650. "operationId": "userGetStopWatches",
  15651. "parameters": [
  15652. {
  15653. "type": "integer",
  15654. "description": "page number of results to return (1-based)",
  15655. "name": "page",
  15656. "in": "query"
  15657. },
  15658. {
  15659. "type": "integer",
  15660. "description": "page size of results",
  15661. "name": "limit",
  15662. "in": "query"
  15663. }
  15664. ],
  15665. "responses": {
  15666. "200": {
  15667. "$ref": "#/responses/StopWatchList"
  15668. }
  15669. }
  15670. }
  15671. },
  15672. "/user/subscriptions": {
  15673. "get": {
  15674. "produces": [
  15675. "application/json"
  15676. ],
  15677. "tags": [
  15678. "user"
  15679. ],
  15680. "summary": "List repositories watched by the authenticated user",
  15681. "operationId": "userCurrentListSubscriptions",
  15682. "parameters": [
  15683. {
  15684. "type": "integer",
  15685. "description": "page number of results to return (1-based)",
  15686. "name": "page",
  15687. "in": "query"
  15688. },
  15689. {
  15690. "type": "integer",
  15691. "description": "page size of results",
  15692. "name": "limit",
  15693. "in": "query"
  15694. }
  15695. ],
  15696. "responses": {
  15697. "200": {
  15698. "$ref": "#/responses/RepositoryList"
  15699. }
  15700. }
  15701. }
  15702. },
  15703. "/user/teams": {
  15704. "get": {
  15705. "produces": [
  15706. "application/json"
  15707. ],
  15708. "tags": [
  15709. "user"
  15710. ],
  15711. "summary": "List all the teams a user belongs to",
  15712. "operationId": "userListTeams",
  15713. "parameters": [
  15714. {
  15715. "type": "integer",
  15716. "description": "page number of results to return (1-based)",
  15717. "name": "page",
  15718. "in": "query"
  15719. },
  15720. {
  15721. "type": "integer",
  15722. "description": "page size of results",
  15723. "name": "limit",
  15724. "in": "query"
  15725. }
  15726. ],
  15727. "responses": {
  15728. "200": {
  15729. "$ref": "#/responses/TeamList"
  15730. }
  15731. }
  15732. }
  15733. },
  15734. "/user/times": {
  15735. "get": {
  15736. "produces": [
  15737. "application/json"
  15738. ],
  15739. "tags": [
  15740. "user"
  15741. ],
  15742. "summary": "List the current user's tracked times",
  15743. "operationId": "userCurrentTrackedTimes",
  15744. "parameters": [
  15745. {
  15746. "type": "integer",
  15747. "description": "page number of results to return (1-based)",
  15748. "name": "page",
  15749. "in": "query"
  15750. },
  15751. {
  15752. "type": "integer",
  15753. "description": "page size of results",
  15754. "name": "limit",
  15755. "in": "query"
  15756. },
  15757. {
  15758. "type": "string",
  15759. "format": "date-time",
  15760. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  15761. "name": "since",
  15762. "in": "query"
  15763. },
  15764. {
  15765. "type": "string",
  15766. "format": "date-time",
  15767. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  15768. "name": "before",
  15769. "in": "query"
  15770. }
  15771. ],
  15772. "responses": {
  15773. "200": {
  15774. "$ref": "#/responses/TrackedTimeList"
  15775. }
  15776. }
  15777. }
  15778. },
  15779. "/users/search": {
  15780. "get": {
  15781. "produces": [
  15782. "application/json"
  15783. ],
  15784. "tags": [
  15785. "user"
  15786. ],
  15787. "summary": "Search for users",
  15788. "operationId": "userSearch",
  15789. "parameters": [
  15790. {
  15791. "type": "string",
  15792. "description": "keyword",
  15793. "name": "q",
  15794. "in": "query"
  15795. },
  15796. {
  15797. "type": "integer",
  15798. "format": "int64",
  15799. "description": "ID of the user to search for",
  15800. "name": "uid",
  15801. "in": "query"
  15802. },
  15803. {
  15804. "type": "integer",
  15805. "description": "page number of results to return (1-based)",
  15806. "name": "page",
  15807. "in": "query"
  15808. },
  15809. {
  15810. "type": "integer",
  15811. "description": "page size of results",
  15812. "name": "limit",
  15813. "in": "query"
  15814. }
  15815. ],
  15816. "responses": {
  15817. "200": {
  15818. "description": "SearchResults of a successful search",
  15819. "schema": {
  15820. "type": "object",
  15821. "properties": {
  15822. "data": {
  15823. "type": "array",
  15824. "items": {
  15825. "$ref": "#/definitions/User"
  15826. }
  15827. },
  15828. "ok": {
  15829. "type": "boolean"
  15830. }
  15831. }
  15832. }
  15833. }
  15834. }
  15835. }
  15836. },
  15837. "/users/{username}": {
  15838. "get": {
  15839. "produces": [
  15840. "application/json"
  15841. ],
  15842. "tags": [
  15843. "user"
  15844. ],
  15845. "summary": "Get a user",
  15846. "operationId": "userGet",
  15847. "parameters": [
  15848. {
  15849. "type": "string",
  15850. "description": "username of user to get",
  15851. "name": "username",
  15852. "in": "path",
  15853. "required": true
  15854. }
  15855. ],
  15856. "responses": {
  15857. "200": {
  15858. "$ref": "#/responses/User"
  15859. },
  15860. "404": {
  15861. "$ref": "#/responses/notFound"
  15862. }
  15863. }
  15864. }
  15865. },
  15866. "/users/{username}/activities/feeds": {
  15867. "get": {
  15868. "produces": [
  15869. "application/json"
  15870. ],
  15871. "tags": [
  15872. "user"
  15873. ],
  15874. "summary": "List a user's activity feeds",
  15875. "operationId": "userListActivityFeeds",
  15876. "parameters": [
  15877. {
  15878. "type": "string",
  15879. "description": "username of user",
  15880. "name": "username",
  15881. "in": "path",
  15882. "required": true
  15883. },
  15884. {
  15885. "type": "boolean",
  15886. "description": "if true, only show actions performed by the requested user",
  15887. "name": "only-performed-by",
  15888. "in": "query"
  15889. },
  15890. {
  15891. "type": "string",
  15892. "format": "date",
  15893. "description": "the date of the activities to be found",
  15894. "name": "date",
  15895. "in": "query"
  15896. },
  15897. {
  15898. "type": "integer",
  15899. "description": "page number of results to return (1-based)",
  15900. "name": "page",
  15901. "in": "query"
  15902. },
  15903. {
  15904. "type": "integer",
  15905. "description": "page size of results",
  15906. "name": "limit",
  15907. "in": "query"
  15908. }
  15909. ],
  15910. "responses": {
  15911. "200": {
  15912. "$ref": "#/responses/ActivityFeedsList"
  15913. },
  15914. "404": {
  15915. "$ref": "#/responses/notFound"
  15916. }
  15917. }
  15918. }
  15919. },
  15920. "/users/{username}/followers": {
  15921. "get": {
  15922. "produces": [
  15923. "application/json"
  15924. ],
  15925. "tags": [
  15926. "user"
  15927. ],
  15928. "summary": "List the given user's followers",
  15929. "operationId": "userListFollowers",
  15930. "parameters": [
  15931. {
  15932. "type": "string",
  15933. "description": "username of user",
  15934. "name": "username",
  15935. "in": "path",
  15936. "required": true
  15937. },
  15938. {
  15939. "type": "integer",
  15940. "description": "page number of results to return (1-based)",
  15941. "name": "page",
  15942. "in": "query"
  15943. },
  15944. {
  15945. "type": "integer",
  15946. "description": "page size of results",
  15947. "name": "limit",
  15948. "in": "query"
  15949. }
  15950. ],
  15951. "responses": {
  15952. "200": {
  15953. "$ref": "#/responses/UserList"
  15954. },
  15955. "404": {
  15956. "$ref": "#/responses/notFound"
  15957. }
  15958. }
  15959. }
  15960. },
  15961. "/users/{username}/following": {
  15962. "get": {
  15963. "produces": [
  15964. "application/json"
  15965. ],
  15966. "tags": [
  15967. "user"
  15968. ],
  15969. "summary": "List the users that the given user is following",
  15970. "operationId": "userListFollowing",
  15971. "parameters": [
  15972. {
  15973. "type": "string",
  15974. "description": "username of user",
  15975. "name": "username",
  15976. "in": "path",
  15977. "required": true
  15978. },
  15979. {
  15980. "type": "integer",
  15981. "description": "page number of results to return (1-based)",
  15982. "name": "page",
  15983. "in": "query"
  15984. },
  15985. {
  15986. "type": "integer",
  15987. "description": "page size of results",
  15988. "name": "limit",
  15989. "in": "query"
  15990. }
  15991. ],
  15992. "responses": {
  15993. "200": {
  15994. "$ref": "#/responses/UserList"
  15995. },
  15996. "404": {
  15997. "$ref": "#/responses/notFound"
  15998. }
  15999. }
  16000. }
  16001. },
  16002. "/users/{username}/following/{target}": {
  16003. "get": {
  16004. "tags": [
  16005. "user"
  16006. ],
  16007. "summary": "Check if one user is following another user",
  16008. "operationId": "userCheckFollowing",
  16009. "parameters": [
  16010. {
  16011. "type": "string",
  16012. "description": "username of following user",
  16013. "name": "username",
  16014. "in": "path",
  16015. "required": true
  16016. },
  16017. {
  16018. "type": "string",
  16019. "description": "username of followed user",
  16020. "name": "target",
  16021. "in": "path",
  16022. "required": true
  16023. }
  16024. ],
  16025. "responses": {
  16026. "204": {
  16027. "$ref": "#/responses/empty"
  16028. },
  16029. "404": {
  16030. "$ref": "#/responses/notFound"
  16031. }
  16032. }
  16033. }
  16034. },
  16035. "/users/{username}/gpg_keys": {
  16036. "get": {
  16037. "produces": [
  16038. "application/json"
  16039. ],
  16040. "tags": [
  16041. "user"
  16042. ],
  16043. "summary": "List the given user's GPG keys",
  16044. "operationId": "userListGPGKeys",
  16045. "parameters": [
  16046. {
  16047. "type": "string",
  16048. "description": "username of user",
  16049. "name": "username",
  16050. "in": "path",
  16051. "required": true
  16052. },
  16053. {
  16054. "type": "integer",
  16055. "description": "page number of results to return (1-based)",
  16056. "name": "page",
  16057. "in": "query"
  16058. },
  16059. {
  16060. "type": "integer",
  16061. "description": "page size of results",
  16062. "name": "limit",
  16063. "in": "query"
  16064. }
  16065. ],
  16066. "responses": {
  16067. "200": {
  16068. "$ref": "#/responses/GPGKeyList"
  16069. },
  16070. "404": {
  16071. "$ref": "#/responses/notFound"
  16072. }
  16073. }
  16074. }
  16075. },
  16076. "/users/{username}/heatmap": {
  16077. "get": {
  16078. "produces": [
  16079. "application/json"
  16080. ],
  16081. "tags": [
  16082. "user"
  16083. ],
  16084. "summary": "Get a user's heatmap",
  16085. "operationId": "userGetHeatmapData",
  16086. "parameters": [
  16087. {
  16088. "type": "string",
  16089. "description": "username of user to get",
  16090. "name": "username",
  16091. "in": "path",
  16092. "required": true
  16093. }
  16094. ],
  16095. "responses": {
  16096. "200": {
  16097. "$ref": "#/responses/UserHeatmapData"
  16098. },
  16099. "404": {
  16100. "$ref": "#/responses/notFound"
  16101. }
  16102. }
  16103. }
  16104. },
  16105. "/users/{username}/keys": {
  16106. "get": {
  16107. "produces": [
  16108. "application/json"
  16109. ],
  16110. "tags": [
  16111. "user"
  16112. ],
  16113. "summary": "List the given user's public keys",
  16114. "operationId": "userListKeys",
  16115. "parameters": [
  16116. {
  16117. "type": "string",
  16118. "description": "username of user",
  16119. "name": "username",
  16120. "in": "path",
  16121. "required": true
  16122. },
  16123. {
  16124. "type": "string",
  16125. "description": "fingerprint of the key",
  16126. "name": "fingerprint",
  16127. "in": "query"
  16128. },
  16129. {
  16130. "type": "integer",
  16131. "description": "page number of results to return (1-based)",
  16132. "name": "page",
  16133. "in": "query"
  16134. },
  16135. {
  16136. "type": "integer",
  16137. "description": "page size of results",
  16138. "name": "limit",
  16139. "in": "query"
  16140. }
  16141. ],
  16142. "responses": {
  16143. "200": {
  16144. "$ref": "#/responses/PublicKeyList"
  16145. },
  16146. "404": {
  16147. "$ref": "#/responses/notFound"
  16148. }
  16149. }
  16150. }
  16151. },
  16152. "/users/{username}/orgs": {
  16153. "get": {
  16154. "produces": [
  16155. "application/json"
  16156. ],
  16157. "tags": [
  16158. "organization"
  16159. ],
  16160. "summary": "List a user's organizations",
  16161. "operationId": "orgListUserOrgs",
  16162. "parameters": [
  16163. {
  16164. "type": "string",
  16165. "description": "username of user",
  16166. "name": "username",
  16167. "in": "path",
  16168. "required": true
  16169. },
  16170. {
  16171. "type": "integer",
  16172. "description": "page number of results to return (1-based)",
  16173. "name": "page",
  16174. "in": "query"
  16175. },
  16176. {
  16177. "type": "integer",
  16178. "description": "page size of results",
  16179. "name": "limit",
  16180. "in": "query"
  16181. }
  16182. ],
  16183. "responses": {
  16184. "200": {
  16185. "$ref": "#/responses/OrganizationList"
  16186. },
  16187. "404": {
  16188. "$ref": "#/responses/notFound"
  16189. }
  16190. }
  16191. }
  16192. },
  16193. "/users/{username}/orgs/{org}/permissions": {
  16194. "get": {
  16195. "produces": [
  16196. "application/json"
  16197. ],
  16198. "tags": [
  16199. "organization"
  16200. ],
  16201. "summary": "Get user permissions in organization",
  16202. "operationId": "orgGetUserPermissions",
  16203. "parameters": [
  16204. {
  16205. "type": "string",
  16206. "description": "username of user",
  16207. "name": "username",
  16208. "in": "path",
  16209. "required": true
  16210. },
  16211. {
  16212. "type": "string",
  16213. "description": "name of the organization",
  16214. "name": "org",
  16215. "in": "path",
  16216. "required": true
  16217. }
  16218. ],
  16219. "responses": {
  16220. "200": {
  16221. "$ref": "#/responses/OrganizationPermissions"
  16222. },
  16223. "403": {
  16224. "$ref": "#/responses/forbidden"
  16225. },
  16226. "404": {
  16227. "$ref": "#/responses/notFound"
  16228. }
  16229. }
  16230. }
  16231. },
  16232. "/users/{username}/repos": {
  16233. "get": {
  16234. "produces": [
  16235. "application/json"
  16236. ],
  16237. "tags": [
  16238. "user"
  16239. ],
  16240. "summary": "List the repos owned by the given user",
  16241. "operationId": "userListRepos",
  16242. "parameters": [
  16243. {
  16244. "type": "string",
  16245. "description": "username of user",
  16246. "name": "username",
  16247. "in": "path",
  16248. "required": true
  16249. },
  16250. {
  16251. "type": "integer",
  16252. "description": "page number of results to return (1-based)",
  16253. "name": "page",
  16254. "in": "query"
  16255. },
  16256. {
  16257. "type": "integer",
  16258. "description": "page size of results",
  16259. "name": "limit",
  16260. "in": "query"
  16261. }
  16262. ],
  16263. "responses": {
  16264. "200": {
  16265. "$ref": "#/responses/RepositoryList"
  16266. },
  16267. "404": {
  16268. "$ref": "#/responses/notFound"
  16269. }
  16270. }
  16271. }
  16272. },
  16273. "/users/{username}/starred": {
  16274. "get": {
  16275. "produces": [
  16276. "application/json"
  16277. ],
  16278. "tags": [
  16279. "user"
  16280. ],
  16281. "summary": "The repos that the given user has starred",
  16282. "operationId": "userListStarred",
  16283. "parameters": [
  16284. {
  16285. "type": "string",
  16286. "description": "username of user",
  16287. "name": "username",
  16288. "in": "path",
  16289. "required": true
  16290. },
  16291. {
  16292. "type": "integer",
  16293. "description": "page number of results to return (1-based)",
  16294. "name": "page",
  16295. "in": "query"
  16296. },
  16297. {
  16298. "type": "integer",
  16299. "description": "page size of results",
  16300. "name": "limit",
  16301. "in": "query"
  16302. }
  16303. ],
  16304. "responses": {
  16305. "200": {
  16306. "$ref": "#/responses/RepositoryList"
  16307. },
  16308. "404": {
  16309. "$ref": "#/responses/notFound"
  16310. }
  16311. }
  16312. }
  16313. },
  16314. "/users/{username}/subscriptions": {
  16315. "get": {
  16316. "produces": [
  16317. "application/json"
  16318. ],
  16319. "tags": [
  16320. "user"
  16321. ],
  16322. "summary": "List the repositories watched by a user",
  16323. "operationId": "userListSubscriptions",
  16324. "parameters": [
  16325. {
  16326. "type": "string",
  16327. "description": "username of the user",
  16328. "name": "username",
  16329. "in": "path",
  16330. "required": true
  16331. },
  16332. {
  16333. "type": "integer",
  16334. "description": "page number of results to return (1-based)",
  16335. "name": "page",
  16336. "in": "query"
  16337. },
  16338. {
  16339. "type": "integer",
  16340. "description": "page size of results",
  16341. "name": "limit",
  16342. "in": "query"
  16343. }
  16344. ],
  16345. "responses": {
  16346. "200": {
  16347. "$ref": "#/responses/RepositoryList"
  16348. },
  16349. "404": {
  16350. "$ref": "#/responses/notFound"
  16351. }
  16352. }
  16353. }
  16354. },
  16355. "/users/{username}/tokens": {
  16356. "get": {
  16357. "produces": [
  16358. "application/json"
  16359. ],
  16360. "tags": [
  16361. "user"
  16362. ],
  16363. "summary": "List the authenticated user's access tokens",
  16364. "operationId": "userGetTokens",
  16365. "parameters": [
  16366. {
  16367. "type": "string",
  16368. "description": "username of user",
  16369. "name": "username",
  16370. "in": "path",
  16371. "required": true
  16372. },
  16373. {
  16374. "type": "integer",
  16375. "description": "page number of results to return (1-based)",
  16376. "name": "page",
  16377. "in": "query"
  16378. },
  16379. {
  16380. "type": "integer",
  16381. "description": "page size of results",
  16382. "name": "limit",
  16383. "in": "query"
  16384. }
  16385. ],
  16386. "responses": {
  16387. "200": {
  16388. "$ref": "#/responses/AccessTokenList"
  16389. },
  16390. "403": {
  16391. "$ref": "#/responses/forbidden"
  16392. }
  16393. }
  16394. },
  16395. "post": {
  16396. "consumes": [
  16397. "application/json"
  16398. ],
  16399. "produces": [
  16400. "application/json"
  16401. ],
  16402. "tags": [
  16403. "user"
  16404. ],
  16405. "summary": "Create an access token",
  16406. "operationId": "userCreateToken",
  16407. "parameters": [
  16408. {
  16409. "type": "string",
  16410. "description": "username of user",
  16411. "name": "username",
  16412. "in": "path",
  16413. "required": true
  16414. },
  16415. {
  16416. "name": "body",
  16417. "in": "body",
  16418. "schema": {
  16419. "$ref": "#/definitions/CreateAccessTokenOption"
  16420. }
  16421. }
  16422. ],
  16423. "responses": {
  16424. "201": {
  16425. "$ref": "#/responses/AccessToken"
  16426. },
  16427. "400": {
  16428. "$ref": "#/responses/error"
  16429. },
  16430. "403": {
  16431. "$ref": "#/responses/forbidden"
  16432. }
  16433. }
  16434. }
  16435. },
  16436. "/users/{username}/tokens/{token}": {
  16437. "delete": {
  16438. "produces": [
  16439. "application/json"
  16440. ],
  16441. "tags": [
  16442. "user"
  16443. ],
  16444. "summary": "delete an access token",
  16445. "operationId": "userDeleteAccessToken",
  16446. "parameters": [
  16447. {
  16448. "type": "string",
  16449. "description": "username of user",
  16450. "name": "username",
  16451. "in": "path",
  16452. "required": true
  16453. },
  16454. {
  16455. "type": "string",
  16456. "description": "token to be deleted, identified by ID and if not available by name",
  16457. "name": "token",
  16458. "in": "path",
  16459. "required": true
  16460. }
  16461. ],
  16462. "responses": {
  16463. "204": {
  16464. "$ref": "#/responses/empty"
  16465. },
  16466. "403": {
  16467. "$ref": "#/responses/forbidden"
  16468. },
  16469. "404": {
  16470. "$ref": "#/responses/notFound"
  16471. },
  16472. "422": {
  16473. "$ref": "#/responses/error"
  16474. }
  16475. }
  16476. }
  16477. },
  16478. "/version": {
  16479. "get": {
  16480. "produces": [
  16481. "application/json"
  16482. ],
  16483. "tags": [
  16484. "miscellaneous"
  16485. ],
  16486. "summary": "Returns the version of the Gitea application",
  16487. "operationId": "getVersion",
  16488. "responses": {
  16489. "200": {
  16490. "$ref": "#/responses/ServerVersion"
  16491. }
  16492. }
  16493. }
  16494. }
  16495. },
  16496. "definitions": {
  16497. "APIError": {
  16498. "description": "APIError is an api error with a message",
  16499. "type": "object",
  16500. "properties": {
  16501. "message": {
  16502. "type": "string",
  16503. "x-go-name": "Message"
  16504. },
  16505. "url": {
  16506. "type": "string",
  16507. "x-go-name": "URL"
  16508. }
  16509. },
  16510. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16511. },
  16512. "AccessToken": {
  16513. "type": "object",
  16514. "title": "AccessToken represents an API access token.",
  16515. "properties": {
  16516. "id": {
  16517. "type": "integer",
  16518. "format": "int64",
  16519. "x-go-name": "ID"
  16520. },
  16521. "name": {
  16522. "type": "string",
  16523. "x-go-name": "Name"
  16524. },
  16525. "scopes": {
  16526. "type": "array",
  16527. "items": {
  16528. "type": "string"
  16529. },
  16530. "x-go-name": "Scopes"
  16531. },
  16532. "sha1": {
  16533. "type": "string",
  16534. "x-go-name": "Token"
  16535. },
  16536. "token_last_eight": {
  16537. "type": "string",
  16538. "x-go-name": "TokenLastEight"
  16539. }
  16540. },
  16541. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16542. },
  16543. "Activity": {
  16544. "type": "object",
  16545. "properties": {
  16546. "act_user": {
  16547. "$ref": "#/definitions/User"
  16548. },
  16549. "act_user_id": {
  16550. "type": "integer",
  16551. "format": "int64",
  16552. "x-go-name": "ActUserID"
  16553. },
  16554. "comment": {
  16555. "$ref": "#/definitions/Comment"
  16556. },
  16557. "comment_id": {
  16558. "type": "integer",
  16559. "format": "int64",
  16560. "x-go-name": "CommentID"
  16561. },
  16562. "content": {
  16563. "type": "string",
  16564. "x-go-name": "Content"
  16565. },
  16566. "created": {
  16567. "type": "string",
  16568. "format": "date-time",
  16569. "x-go-name": "Created"
  16570. },
  16571. "id": {
  16572. "type": "integer",
  16573. "format": "int64",
  16574. "x-go-name": "ID"
  16575. },
  16576. "is_private": {
  16577. "type": "boolean",
  16578. "x-go-name": "IsPrivate"
  16579. },
  16580. "op_type": {
  16581. "type": "string",
  16582. "x-go-name": "OpType"
  16583. },
  16584. "ref_name": {
  16585. "type": "string",
  16586. "x-go-name": "RefName"
  16587. },
  16588. "repo": {
  16589. "$ref": "#/definitions/Repository"
  16590. },
  16591. "repo_id": {
  16592. "type": "integer",
  16593. "format": "int64",
  16594. "x-go-name": "RepoID"
  16595. },
  16596. "user_id": {
  16597. "type": "integer",
  16598. "format": "int64",
  16599. "x-go-name": "UserID"
  16600. }
  16601. },
  16602. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16603. },
  16604. "ActivityPub": {
  16605. "description": "ActivityPub type",
  16606. "type": "object",
  16607. "properties": {
  16608. "@context": {
  16609. "type": "string",
  16610. "x-go-name": "Context"
  16611. }
  16612. },
  16613. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16614. },
  16615. "AddCollaboratorOption": {
  16616. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  16617. "type": "object",
  16618. "properties": {
  16619. "permission": {
  16620. "type": "string",
  16621. "x-go-name": "Permission"
  16622. }
  16623. },
  16624. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16625. },
  16626. "AddTimeOption": {
  16627. "description": "AddTimeOption options for adding time to an issue",
  16628. "type": "object",
  16629. "required": [
  16630. "time"
  16631. ],
  16632. "properties": {
  16633. "created": {
  16634. "type": "string",
  16635. "format": "date-time",
  16636. "x-go-name": "Created"
  16637. },
  16638. "time": {
  16639. "description": "time in seconds",
  16640. "type": "integer",
  16641. "format": "int64",
  16642. "x-go-name": "Time"
  16643. },
  16644. "user_name": {
  16645. "description": "User who spent the time (optional)",
  16646. "type": "string",
  16647. "x-go-name": "User"
  16648. }
  16649. },
  16650. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16651. },
  16652. "AnnotatedTag": {
  16653. "description": "AnnotatedTag represents an annotated tag",
  16654. "type": "object",
  16655. "properties": {
  16656. "message": {
  16657. "type": "string",
  16658. "x-go-name": "Message"
  16659. },
  16660. "object": {
  16661. "$ref": "#/definitions/AnnotatedTagObject"
  16662. },
  16663. "sha": {
  16664. "type": "string",
  16665. "x-go-name": "SHA"
  16666. },
  16667. "tag": {
  16668. "type": "string",
  16669. "x-go-name": "Tag"
  16670. },
  16671. "tagger": {
  16672. "$ref": "#/definitions/CommitUser"
  16673. },
  16674. "url": {
  16675. "type": "string",
  16676. "x-go-name": "URL"
  16677. },
  16678. "verification": {
  16679. "$ref": "#/definitions/PayloadCommitVerification"
  16680. }
  16681. },
  16682. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16683. },
  16684. "AnnotatedTagObject": {
  16685. "description": "AnnotatedTagObject contains meta information of the tag object",
  16686. "type": "object",
  16687. "properties": {
  16688. "sha": {
  16689. "type": "string",
  16690. "x-go-name": "SHA"
  16691. },
  16692. "type": {
  16693. "type": "string",
  16694. "x-go-name": "Type"
  16695. },
  16696. "url": {
  16697. "type": "string",
  16698. "x-go-name": "URL"
  16699. }
  16700. },
  16701. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16702. },
  16703. "Attachment": {
  16704. "description": "Attachment a generic attachment",
  16705. "type": "object",
  16706. "properties": {
  16707. "browser_download_url": {
  16708. "type": "string",
  16709. "x-go-name": "DownloadURL"
  16710. },
  16711. "created_at": {
  16712. "type": "string",
  16713. "format": "date-time",
  16714. "x-go-name": "Created"
  16715. },
  16716. "download_count": {
  16717. "type": "integer",
  16718. "format": "int64",
  16719. "x-go-name": "DownloadCount"
  16720. },
  16721. "id": {
  16722. "type": "integer",
  16723. "format": "int64",
  16724. "x-go-name": "ID"
  16725. },
  16726. "name": {
  16727. "type": "string",
  16728. "x-go-name": "Name"
  16729. },
  16730. "size": {
  16731. "type": "integer",
  16732. "format": "int64",
  16733. "x-go-name": "Size"
  16734. },
  16735. "uuid": {
  16736. "type": "string",
  16737. "x-go-name": "UUID"
  16738. }
  16739. },
  16740. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16741. },
  16742. "Branch": {
  16743. "description": "Branch represents a repository branch",
  16744. "type": "object",
  16745. "properties": {
  16746. "commit": {
  16747. "$ref": "#/definitions/PayloadCommit"
  16748. },
  16749. "effective_branch_protection_name": {
  16750. "type": "string",
  16751. "x-go-name": "EffectiveBranchProtectionName"
  16752. },
  16753. "enable_status_check": {
  16754. "type": "boolean",
  16755. "x-go-name": "EnableStatusCheck"
  16756. },
  16757. "name": {
  16758. "type": "string",
  16759. "x-go-name": "Name"
  16760. },
  16761. "protected": {
  16762. "type": "boolean",
  16763. "x-go-name": "Protected"
  16764. },
  16765. "required_approvals": {
  16766. "type": "integer",
  16767. "format": "int64",
  16768. "x-go-name": "RequiredApprovals"
  16769. },
  16770. "status_check_contexts": {
  16771. "type": "array",
  16772. "items": {
  16773. "type": "string"
  16774. },
  16775. "x-go-name": "StatusCheckContexts"
  16776. },
  16777. "user_can_merge": {
  16778. "type": "boolean",
  16779. "x-go-name": "UserCanMerge"
  16780. },
  16781. "user_can_push": {
  16782. "type": "boolean",
  16783. "x-go-name": "UserCanPush"
  16784. }
  16785. },
  16786. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16787. },
  16788. "BranchProtection": {
  16789. "description": "BranchProtection represents a branch protection for a repository",
  16790. "type": "object",
  16791. "properties": {
  16792. "approvals_whitelist_teams": {
  16793. "type": "array",
  16794. "items": {
  16795. "type": "string"
  16796. },
  16797. "x-go-name": "ApprovalsWhitelistTeams"
  16798. },
  16799. "approvals_whitelist_username": {
  16800. "type": "array",
  16801. "items": {
  16802. "type": "string"
  16803. },
  16804. "x-go-name": "ApprovalsWhitelistUsernames"
  16805. },
  16806. "block_on_official_review_requests": {
  16807. "type": "boolean",
  16808. "x-go-name": "BlockOnOfficialReviewRequests"
  16809. },
  16810. "block_on_outdated_branch": {
  16811. "type": "boolean",
  16812. "x-go-name": "BlockOnOutdatedBranch"
  16813. },
  16814. "block_on_rejected_reviews": {
  16815. "type": "boolean",
  16816. "x-go-name": "BlockOnRejectedReviews"
  16817. },
  16818. "branch_name": {
  16819. "description": "Deprecated: true",
  16820. "type": "string",
  16821. "x-go-name": "BranchName"
  16822. },
  16823. "created_at": {
  16824. "type": "string",
  16825. "format": "date-time",
  16826. "x-go-name": "Created"
  16827. },
  16828. "dismiss_stale_approvals": {
  16829. "type": "boolean",
  16830. "x-go-name": "DismissStaleApprovals"
  16831. },
  16832. "enable_approvals_whitelist": {
  16833. "type": "boolean",
  16834. "x-go-name": "EnableApprovalsWhitelist"
  16835. },
  16836. "enable_merge_whitelist": {
  16837. "type": "boolean",
  16838. "x-go-name": "EnableMergeWhitelist"
  16839. },
  16840. "enable_push": {
  16841. "type": "boolean",
  16842. "x-go-name": "EnablePush"
  16843. },
  16844. "enable_push_whitelist": {
  16845. "type": "boolean",
  16846. "x-go-name": "EnablePushWhitelist"
  16847. },
  16848. "enable_status_check": {
  16849. "type": "boolean",
  16850. "x-go-name": "EnableStatusCheck"
  16851. },
  16852. "merge_whitelist_teams": {
  16853. "type": "array",
  16854. "items": {
  16855. "type": "string"
  16856. },
  16857. "x-go-name": "MergeWhitelistTeams"
  16858. },
  16859. "merge_whitelist_usernames": {
  16860. "type": "array",
  16861. "items": {
  16862. "type": "string"
  16863. },
  16864. "x-go-name": "MergeWhitelistUsernames"
  16865. },
  16866. "protected_file_patterns": {
  16867. "type": "string",
  16868. "x-go-name": "ProtectedFilePatterns"
  16869. },
  16870. "push_whitelist_deploy_keys": {
  16871. "type": "boolean",
  16872. "x-go-name": "PushWhitelistDeployKeys"
  16873. },
  16874. "push_whitelist_teams": {
  16875. "type": "array",
  16876. "items": {
  16877. "type": "string"
  16878. },
  16879. "x-go-name": "PushWhitelistTeams"
  16880. },
  16881. "push_whitelist_usernames": {
  16882. "type": "array",
  16883. "items": {
  16884. "type": "string"
  16885. },
  16886. "x-go-name": "PushWhitelistUsernames"
  16887. },
  16888. "require_signed_commits": {
  16889. "type": "boolean",
  16890. "x-go-name": "RequireSignedCommits"
  16891. },
  16892. "required_approvals": {
  16893. "type": "integer",
  16894. "format": "int64",
  16895. "x-go-name": "RequiredApprovals"
  16896. },
  16897. "rule_name": {
  16898. "type": "string",
  16899. "x-go-name": "RuleName"
  16900. },
  16901. "status_check_contexts": {
  16902. "type": "array",
  16903. "items": {
  16904. "type": "string"
  16905. },
  16906. "x-go-name": "StatusCheckContexts"
  16907. },
  16908. "unprotected_file_patterns": {
  16909. "type": "string",
  16910. "x-go-name": "UnprotectedFilePatterns"
  16911. },
  16912. "updated_at": {
  16913. "type": "string",
  16914. "format": "date-time",
  16915. "x-go-name": "Updated"
  16916. }
  16917. },
  16918. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16919. },
  16920. "ChangeFileOperation": {
  16921. "description": "ChangeFileOperation for creating, updating or deleting a file",
  16922. "type": "object",
  16923. "required": [
  16924. "operation",
  16925. "path"
  16926. ],
  16927. "properties": {
  16928. "content": {
  16929. "description": "new or updated file content, must be base64 encoded",
  16930. "type": "string",
  16931. "x-go-name": "ContentBase64"
  16932. },
  16933. "from_path": {
  16934. "description": "old path of the file to move",
  16935. "type": "string",
  16936. "x-go-name": "FromPath"
  16937. },
  16938. "operation": {
  16939. "description": "indicates what to do with the file",
  16940. "type": "string",
  16941. "enum": [
  16942. "create",
  16943. "update",
  16944. "delete"
  16945. ],
  16946. "x-go-name": "Operation"
  16947. },
  16948. "path": {
  16949. "description": "path to the existing or new file",
  16950. "type": "string",
  16951. "x-go-name": "Path"
  16952. },
  16953. "sha": {
  16954. "description": "sha is the SHA for the file that already exists, required for update or delete",
  16955. "type": "string",
  16956. "x-go-name": "SHA"
  16957. }
  16958. },
  16959. "x-go-package": "code.gitea.io/gitea/modules/structs"
  16960. },
  16961. "ChangeFilesOptions": {
  16962. "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)",
  16963. "type": "object",
  16964. "required": [
  16965. "files"
  16966. ],
  16967. "properties": {
  16968. "author": {
  16969. "$ref": "#/definitions/Identity"
  16970. },
  16971. "branch": {
  16972. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  16973. "type": "string",
  16974. "x-go-name": "BranchName"
  16975. },
  16976. "committer": {
  16977. "$ref": "#/definitions/Identity"
  16978. },
  16979. "dates": {
  16980. "$ref": "#/definitions/CommitDateOptions"
  16981. },
  16982. "files": {
  16983. "description": "list of file operations",
  16984. "type": "array",
  16985. "items": {
  16986. "$ref": "#/definitions/ChangeFileOperation"
  16987. },
  16988. "x-go-name": "Files"
  16989. },
  16990. "message": {
  16991. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  16992. "type": "string",
  16993. "x-go-name": "Message"
  16994. },
  16995. "new_branch": {
  16996. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  16997. "type": "string",
  16998. "x-go-name": "NewBranchName"
  16999. },
  17000. "signoff": {
  17001. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  17002. "type": "boolean",
  17003. "x-go-name": "Signoff"
  17004. }
  17005. },
  17006. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17007. },
  17008. "ChangedFile": {
  17009. "description": "ChangedFile store information about files affected by the pull request",
  17010. "type": "object",
  17011. "properties": {
  17012. "additions": {
  17013. "type": "integer",
  17014. "format": "int64",
  17015. "x-go-name": "Additions"
  17016. },
  17017. "changes": {
  17018. "type": "integer",
  17019. "format": "int64",
  17020. "x-go-name": "Changes"
  17021. },
  17022. "contents_url": {
  17023. "type": "string",
  17024. "x-go-name": "ContentsURL"
  17025. },
  17026. "deletions": {
  17027. "type": "integer",
  17028. "format": "int64",
  17029. "x-go-name": "Deletions"
  17030. },
  17031. "filename": {
  17032. "type": "string",
  17033. "x-go-name": "Filename"
  17034. },
  17035. "html_url": {
  17036. "type": "string",
  17037. "x-go-name": "HTMLURL"
  17038. },
  17039. "previous_filename": {
  17040. "type": "string",
  17041. "x-go-name": "PreviousFilename"
  17042. },
  17043. "raw_url": {
  17044. "type": "string",
  17045. "x-go-name": "RawURL"
  17046. },
  17047. "status": {
  17048. "type": "string",
  17049. "x-go-name": "Status"
  17050. }
  17051. },
  17052. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17053. },
  17054. "CombinedStatus": {
  17055. "description": "CombinedStatus holds the combined state of several statuses for a single commit",
  17056. "type": "object",
  17057. "properties": {
  17058. "commit_url": {
  17059. "type": "string",
  17060. "x-go-name": "CommitURL"
  17061. },
  17062. "repository": {
  17063. "$ref": "#/definitions/Repository"
  17064. },
  17065. "sha": {
  17066. "type": "string",
  17067. "x-go-name": "SHA"
  17068. },
  17069. "state": {
  17070. "$ref": "#/definitions/CommitStatusState"
  17071. },
  17072. "statuses": {
  17073. "type": "array",
  17074. "items": {
  17075. "$ref": "#/definitions/CommitStatus"
  17076. },
  17077. "x-go-name": "Statuses"
  17078. },
  17079. "total_count": {
  17080. "type": "integer",
  17081. "format": "int64",
  17082. "x-go-name": "TotalCount"
  17083. },
  17084. "url": {
  17085. "type": "string",
  17086. "x-go-name": "URL"
  17087. }
  17088. },
  17089. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17090. },
  17091. "Comment": {
  17092. "description": "Comment represents a comment on a commit or issue",
  17093. "type": "object",
  17094. "properties": {
  17095. "assets": {
  17096. "type": "array",
  17097. "items": {
  17098. "$ref": "#/definitions/Attachment"
  17099. },
  17100. "x-go-name": "Attachments"
  17101. },
  17102. "body": {
  17103. "type": "string",
  17104. "x-go-name": "Body"
  17105. },
  17106. "created_at": {
  17107. "type": "string",
  17108. "format": "date-time",
  17109. "x-go-name": "Created"
  17110. },
  17111. "html_url": {
  17112. "type": "string",
  17113. "x-go-name": "HTMLURL"
  17114. },
  17115. "id": {
  17116. "type": "integer",
  17117. "format": "int64",
  17118. "x-go-name": "ID"
  17119. },
  17120. "issue_url": {
  17121. "type": "string",
  17122. "x-go-name": "IssueURL"
  17123. },
  17124. "original_author": {
  17125. "type": "string",
  17126. "x-go-name": "OriginalAuthor"
  17127. },
  17128. "original_author_id": {
  17129. "type": "integer",
  17130. "format": "int64",
  17131. "x-go-name": "OriginalAuthorID"
  17132. },
  17133. "pull_request_url": {
  17134. "type": "string",
  17135. "x-go-name": "PRURL"
  17136. },
  17137. "updated_at": {
  17138. "type": "string",
  17139. "format": "date-time",
  17140. "x-go-name": "Updated"
  17141. },
  17142. "user": {
  17143. "$ref": "#/definitions/User"
  17144. }
  17145. },
  17146. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17147. },
  17148. "Commit": {
  17149. "type": "object",
  17150. "title": "Commit contains information generated from a Git commit.",
  17151. "properties": {
  17152. "author": {
  17153. "$ref": "#/definitions/User"
  17154. },
  17155. "commit": {
  17156. "$ref": "#/definitions/RepoCommit"
  17157. },
  17158. "committer": {
  17159. "$ref": "#/definitions/User"
  17160. },
  17161. "created": {
  17162. "type": "string",
  17163. "format": "date-time",
  17164. "x-go-name": "Created"
  17165. },
  17166. "files": {
  17167. "type": "array",
  17168. "items": {
  17169. "$ref": "#/definitions/CommitAffectedFiles"
  17170. },
  17171. "x-go-name": "Files"
  17172. },
  17173. "html_url": {
  17174. "type": "string",
  17175. "x-go-name": "HTMLURL"
  17176. },
  17177. "parents": {
  17178. "type": "array",
  17179. "items": {
  17180. "$ref": "#/definitions/CommitMeta"
  17181. },
  17182. "x-go-name": "Parents"
  17183. },
  17184. "sha": {
  17185. "type": "string",
  17186. "x-go-name": "SHA"
  17187. },
  17188. "stats": {
  17189. "$ref": "#/definitions/CommitStats"
  17190. },
  17191. "url": {
  17192. "type": "string",
  17193. "x-go-name": "URL"
  17194. }
  17195. },
  17196. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17197. },
  17198. "CommitAffectedFiles": {
  17199. "description": "CommitAffectedFiles store information about files affected by the commit",
  17200. "type": "object",
  17201. "properties": {
  17202. "filename": {
  17203. "type": "string",
  17204. "x-go-name": "Filename"
  17205. },
  17206. "status": {
  17207. "type": "string",
  17208. "x-go-name": "Status"
  17209. }
  17210. },
  17211. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17212. },
  17213. "CommitDateOptions": {
  17214. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  17215. "type": "object",
  17216. "properties": {
  17217. "author": {
  17218. "type": "string",
  17219. "format": "date-time",
  17220. "x-go-name": "Author"
  17221. },
  17222. "committer": {
  17223. "type": "string",
  17224. "format": "date-time",
  17225. "x-go-name": "Committer"
  17226. }
  17227. },
  17228. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17229. },
  17230. "CommitMeta": {
  17231. "type": "object",
  17232. "title": "CommitMeta contains meta information of a commit in terms of API.",
  17233. "properties": {
  17234. "created": {
  17235. "type": "string",
  17236. "format": "date-time",
  17237. "x-go-name": "Created"
  17238. },
  17239. "sha": {
  17240. "type": "string",
  17241. "x-go-name": "SHA"
  17242. },
  17243. "url": {
  17244. "type": "string",
  17245. "x-go-name": "URL"
  17246. }
  17247. },
  17248. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17249. },
  17250. "CommitStats": {
  17251. "description": "CommitStats is statistics for a RepoCommit",
  17252. "type": "object",
  17253. "properties": {
  17254. "additions": {
  17255. "type": "integer",
  17256. "format": "int64",
  17257. "x-go-name": "Additions"
  17258. },
  17259. "deletions": {
  17260. "type": "integer",
  17261. "format": "int64",
  17262. "x-go-name": "Deletions"
  17263. },
  17264. "total": {
  17265. "type": "integer",
  17266. "format": "int64",
  17267. "x-go-name": "Total"
  17268. }
  17269. },
  17270. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17271. },
  17272. "CommitStatus": {
  17273. "description": "CommitStatus holds a single status of a single Commit",
  17274. "type": "object",
  17275. "properties": {
  17276. "context": {
  17277. "type": "string",
  17278. "x-go-name": "Context"
  17279. },
  17280. "created_at": {
  17281. "type": "string",
  17282. "format": "date-time",
  17283. "x-go-name": "Created"
  17284. },
  17285. "creator": {
  17286. "$ref": "#/definitions/User"
  17287. },
  17288. "description": {
  17289. "type": "string",
  17290. "x-go-name": "Description"
  17291. },
  17292. "id": {
  17293. "type": "integer",
  17294. "format": "int64",
  17295. "x-go-name": "ID"
  17296. },
  17297. "status": {
  17298. "$ref": "#/definitions/CommitStatusState"
  17299. },
  17300. "target_url": {
  17301. "type": "string",
  17302. "x-go-name": "TargetURL"
  17303. },
  17304. "updated_at": {
  17305. "type": "string",
  17306. "format": "date-time",
  17307. "x-go-name": "Updated"
  17308. },
  17309. "url": {
  17310. "type": "string",
  17311. "x-go-name": "URL"
  17312. }
  17313. },
  17314. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17315. },
  17316. "CommitStatusState": {
  17317. "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"",
  17318. "type": "string",
  17319. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17320. },
  17321. "CommitUser": {
  17322. "type": "object",
  17323. "title": "CommitUser contains information of a user in the context of a commit.",
  17324. "properties": {
  17325. "date": {
  17326. "type": "string",
  17327. "x-go-name": "Date"
  17328. },
  17329. "email": {
  17330. "type": "string",
  17331. "format": "email",
  17332. "x-go-name": "Email"
  17333. },
  17334. "name": {
  17335. "type": "string",
  17336. "x-go-name": "Name"
  17337. }
  17338. },
  17339. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17340. },
  17341. "ContentsResponse": {
  17342. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  17343. "type": "object",
  17344. "properties": {
  17345. "_links": {
  17346. "$ref": "#/definitions/FileLinksResponse"
  17347. },
  17348. "content": {
  17349. "description": "`content` is populated when `type` is `file`, otherwise null",
  17350. "type": "string",
  17351. "x-go-name": "Content"
  17352. },
  17353. "download_url": {
  17354. "type": "string",
  17355. "x-go-name": "DownloadURL"
  17356. },
  17357. "encoding": {
  17358. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  17359. "type": "string",
  17360. "x-go-name": "Encoding"
  17361. },
  17362. "git_url": {
  17363. "type": "string",
  17364. "x-go-name": "GitURL"
  17365. },
  17366. "html_url": {
  17367. "type": "string",
  17368. "x-go-name": "HTMLURL"
  17369. },
  17370. "last_commit_sha": {
  17371. "type": "string",
  17372. "x-go-name": "LastCommitSHA"
  17373. },
  17374. "name": {
  17375. "type": "string",
  17376. "x-go-name": "Name"
  17377. },
  17378. "path": {
  17379. "type": "string",
  17380. "x-go-name": "Path"
  17381. },
  17382. "sha": {
  17383. "type": "string",
  17384. "x-go-name": "SHA"
  17385. },
  17386. "size": {
  17387. "type": "integer",
  17388. "format": "int64",
  17389. "x-go-name": "Size"
  17390. },
  17391. "submodule_git_url": {
  17392. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  17393. "type": "string",
  17394. "x-go-name": "SubmoduleGitURL"
  17395. },
  17396. "target": {
  17397. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  17398. "type": "string",
  17399. "x-go-name": "Target"
  17400. },
  17401. "type": {
  17402. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  17403. "type": "string",
  17404. "x-go-name": "Type"
  17405. },
  17406. "url": {
  17407. "type": "string",
  17408. "x-go-name": "URL"
  17409. }
  17410. },
  17411. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17412. },
  17413. "CreateAccessTokenOption": {
  17414. "description": "CreateAccessTokenOption options when create access token",
  17415. "type": "object",
  17416. "required": [
  17417. "name"
  17418. ],
  17419. "properties": {
  17420. "name": {
  17421. "type": "string",
  17422. "x-go-name": "Name"
  17423. },
  17424. "scopes": {
  17425. "type": "array",
  17426. "items": {
  17427. "type": "string"
  17428. },
  17429. "x-go-name": "Scopes"
  17430. }
  17431. },
  17432. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17433. },
  17434. "CreateBranchProtectionOption": {
  17435. "description": "CreateBranchProtectionOption options for creating a branch protection",
  17436. "type": "object",
  17437. "properties": {
  17438. "approvals_whitelist_teams": {
  17439. "type": "array",
  17440. "items": {
  17441. "type": "string"
  17442. },
  17443. "x-go-name": "ApprovalsWhitelistTeams"
  17444. },
  17445. "approvals_whitelist_username": {
  17446. "type": "array",
  17447. "items": {
  17448. "type": "string"
  17449. },
  17450. "x-go-name": "ApprovalsWhitelistUsernames"
  17451. },
  17452. "block_on_official_review_requests": {
  17453. "type": "boolean",
  17454. "x-go-name": "BlockOnOfficialReviewRequests"
  17455. },
  17456. "block_on_outdated_branch": {
  17457. "type": "boolean",
  17458. "x-go-name": "BlockOnOutdatedBranch"
  17459. },
  17460. "block_on_rejected_reviews": {
  17461. "type": "boolean",
  17462. "x-go-name": "BlockOnRejectedReviews"
  17463. },
  17464. "branch_name": {
  17465. "description": "Deprecated: true",
  17466. "type": "string",
  17467. "x-go-name": "BranchName"
  17468. },
  17469. "dismiss_stale_approvals": {
  17470. "type": "boolean",
  17471. "x-go-name": "DismissStaleApprovals"
  17472. },
  17473. "enable_approvals_whitelist": {
  17474. "type": "boolean",
  17475. "x-go-name": "EnableApprovalsWhitelist"
  17476. },
  17477. "enable_merge_whitelist": {
  17478. "type": "boolean",
  17479. "x-go-name": "EnableMergeWhitelist"
  17480. },
  17481. "enable_push": {
  17482. "type": "boolean",
  17483. "x-go-name": "EnablePush"
  17484. },
  17485. "enable_push_whitelist": {
  17486. "type": "boolean",
  17487. "x-go-name": "EnablePushWhitelist"
  17488. },
  17489. "enable_status_check": {
  17490. "type": "boolean",
  17491. "x-go-name": "EnableStatusCheck"
  17492. },
  17493. "merge_whitelist_teams": {
  17494. "type": "array",
  17495. "items": {
  17496. "type": "string"
  17497. },
  17498. "x-go-name": "MergeWhitelistTeams"
  17499. },
  17500. "merge_whitelist_usernames": {
  17501. "type": "array",
  17502. "items": {
  17503. "type": "string"
  17504. },
  17505. "x-go-name": "MergeWhitelistUsernames"
  17506. },
  17507. "protected_file_patterns": {
  17508. "type": "string",
  17509. "x-go-name": "ProtectedFilePatterns"
  17510. },
  17511. "push_whitelist_deploy_keys": {
  17512. "type": "boolean",
  17513. "x-go-name": "PushWhitelistDeployKeys"
  17514. },
  17515. "push_whitelist_teams": {
  17516. "type": "array",
  17517. "items": {
  17518. "type": "string"
  17519. },
  17520. "x-go-name": "PushWhitelistTeams"
  17521. },
  17522. "push_whitelist_usernames": {
  17523. "type": "array",
  17524. "items": {
  17525. "type": "string"
  17526. },
  17527. "x-go-name": "PushWhitelistUsernames"
  17528. },
  17529. "require_signed_commits": {
  17530. "type": "boolean",
  17531. "x-go-name": "RequireSignedCommits"
  17532. },
  17533. "required_approvals": {
  17534. "type": "integer",
  17535. "format": "int64",
  17536. "x-go-name": "RequiredApprovals"
  17537. },
  17538. "rule_name": {
  17539. "type": "string",
  17540. "x-go-name": "RuleName"
  17541. },
  17542. "status_check_contexts": {
  17543. "type": "array",
  17544. "items": {
  17545. "type": "string"
  17546. },
  17547. "x-go-name": "StatusCheckContexts"
  17548. },
  17549. "unprotected_file_patterns": {
  17550. "type": "string",
  17551. "x-go-name": "UnprotectedFilePatterns"
  17552. }
  17553. },
  17554. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17555. },
  17556. "CreateBranchRepoOption": {
  17557. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  17558. "type": "object",
  17559. "required": [
  17560. "new_branch_name"
  17561. ],
  17562. "properties": {
  17563. "new_branch_name": {
  17564. "description": "Name of the branch to create",
  17565. "type": "string",
  17566. "uniqueItems": true,
  17567. "x-go-name": "BranchName"
  17568. },
  17569. "old_branch_name": {
  17570. "description": "Deprecated: true\nName of the old branch to create from",
  17571. "type": "string",
  17572. "uniqueItems": true,
  17573. "x-go-name": "OldBranchName"
  17574. },
  17575. "old_ref_name": {
  17576. "description": "Name of the old branch/tag/commit to create from",
  17577. "type": "string",
  17578. "uniqueItems": true,
  17579. "x-go-name": "OldRefName"
  17580. }
  17581. },
  17582. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17583. },
  17584. "CreateEmailOption": {
  17585. "description": "CreateEmailOption options when creating email addresses",
  17586. "type": "object",
  17587. "properties": {
  17588. "emails": {
  17589. "description": "email addresses to add",
  17590. "type": "array",
  17591. "items": {
  17592. "type": "string"
  17593. },
  17594. "x-go-name": "Emails"
  17595. }
  17596. },
  17597. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17598. },
  17599. "CreateFileOptions": {
  17600. "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)",
  17601. "type": "object",
  17602. "required": [
  17603. "content"
  17604. ],
  17605. "properties": {
  17606. "author": {
  17607. "$ref": "#/definitions/Identity"
  17608. },
  17609. "branch": {
  17610. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  17611. "type": "string",
  17612. "x-go-name": "BranchName"
  17613. },
  17614. "committer": {
  17615. "$ref": "#/definitions/Identity"
  17616. },
  17617. "content": {
  17618. "description": "content must be base64 encoded",
  17619. "type": "string",
  17620. "x-go-name": "ContentBase64"
  17621. },
  17622. "dates": {
  17623. "$ref": "#/definitions/CommitDateOptions"
  17624. },
  17625. "message": {
  17626. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  17627. "type": "string",
  17628. "x-go-name": "Message"
  17629. },
  17630. "new_branch": {
  17631. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  17632. "type": "string",
  17633. "x-go-name": "NewBranchName"
  17634. },
  17635. "signoff": {
  17636. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  17637. "type": "boolean",
  17638. "x-go-name": "Signoff"
  17639. }
  17640. },
  17641. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17642. },
  17643. "CreateForkOption": {
  17644. "description": "CreateForkOption options for creating a fork",
  17645. "type": "object",
  17646. "properties": {
  17647. "name": {
  17648. "description": "name of the forked repository",
  17649. "type": "string",
  17650. "x-go-name": "Name"
  17651. },
  17652. "organization": {
  17653. "description": "organization name, if forking into an organization",
  17654. "type": "string",
  17655. "x-go-name": "Organization"
  17656. }
  17657. },
  17658. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17659. },
  17660. "CreateGPGKeyOption": {
  17661. "description": "CreateGPGKeyOption options create user GPG key",
  17662. "type": "object",
  17663. "required": [
  17664. "armored_public_key"
  17665. ],
  17666. "properties": {
  17667. "armored_public_key": {
  17668. "description": "An armored GPG key to add",
  17669. "type": "string",
  17670. "uniqueItems": true,
  17671. "x-go-name": "ArmoredKey"
  17672. },
  17673. "armored_signature": {
  17674. "type": "string",
  17675. "x-go-name": "Signature"
  17676. }
  17677. },
  17678. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17679. },
  17680. "CreateHookOption": {
  17681. "description": "CreateHookOption options when create a hook",
  17682. "type": "object",
  17683. "required": [
  17684. "type",
  17685. "config"
  17686. ],
  17687. "properties": {
  17688. "active": {
  17689. "type": "boolean",
  17690. "default": false,
  17691. "x-go-name": "Active"
  17692. },
  17693. "authorization_header": {
  17694. "type": "string",
  17695. "x-go-name": "AuthorizationHeader"
  17696. },
  17697. "branch_filter": {
  17698. "type": "string",
  17699. "x-go-name": "BranchFilter"
  17700. },
  17701. "config": {
  17702. "$ref": "#/definitions/CreateHookOptionConfig"
  17703. },
  17704. "events": {
  17705. "type": "array",
  17706. "items": {
  17707. "type": "string"
  17708. },
  17709. "x-go-name": "Events"
  17710. },
  17711. "type": {
  17712. "type": "string",
  17713. "enum": [
  17714. "dingtalk",
  17715. "discord",
  17716. "gitea",
  17717. "gogs",
  17718. "msteams",
  17719. "slack",
  17720. "telegram",
  17721. "feishu",
  17722. "wechatwork",
  17723. "packagist"
  17724. ],
  17725. "x-go-name": "Type"
  17726. }
  17727. },
  17728. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17729. },
  17730. "CreateHookOptionConfig": {
  17731. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  17732. "type": "object",
  17733. "additionalProperties": {
  17734. "type": "string"
  17735. },
  17736. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17737. },
  17738. "CreateIssueCommentOption": {
  17739. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  17740. "type": "object",
  17741. "required": [
  17742. "body"
  17743. ],
  17744. "properties": {
  17745. "body": {
  17746. "type": "string",
  17747. "x-go-name": "Body"
  17748. }
  17749. },
  17750. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17751. },
  17752. "CreateIssueOption": {
  17753. "description": "CreateIssueOption options to create one issue",
  17754. "type": "object",
  17755. "required": [
  17756. "title"
  17757. ],
  17758. "properties": {
  17759. "assignee": {
  17760. "description": "deprecated",
  17761. "type": "string",
  17762. "x-go-name": "Assignee"
  17763. },
  17764. "assignees": {
  17765. "type": "array",
  17766. "items": {
  17767. "type": "string"
  17768. },
  17769. "x-go-name": "Assignees"
  17770. },
  17771. "body": {
  17772. "type": "string",
  17773. "x-go-name": "Body"
  17774. },
  17775. "closed": {
  17776. "type": "boolean",
  17777. "x-go-name": "Closed"
  17778. },
  17779. "due_date": {
  17780. "type": "string",
  17781. "format": "date-time",
  17782. "x-go-name": "Deadline"
  17783. },
  17784. "labels": {
  17785. "description": "list of label ids",
  17786. "type": "array",
  17787. "items": {
  17788. "type": "integer",
  17789. "format": "int64"
  17790. },
  17791. "x-go-name": "Labels"
  17792. },
  17793. "milestone": {
  17794. "description": "milestone id",
  17795. "type": "integer",
  17796. "format": "int64",
  17797. "x-go-name": "Milestone"
  17798. },
  17799. "ref": {
  17800. "type": "string",
  17801. "x-go-name": "Ref"
  17802. },
  17803. "title": {
  17804. "type": "string",
  17805. "x-go-name": "Title"
  17806. }
  17807. },
  17808. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17809. },
  17810. "CreateKeyOption": {
  17811. "description": "CreateKeyOption options when creating a key",
  17812. "type": "object",
  17813. "required": [
  17814. "title",
  17815. "key"
  17816. ],
  17817. "properties": {
  17818. "key": {
  17819. "description": "An armored SSH key to add",
  17820. "type": "string",
  17821. "uniqueItems": true,
  17822. "x-go-name": "Key"
  17823. },
  17824. "read_only": {
  17825. "description": "Describe if the key has only read access or read/write",
  17826. "type": "boolean",
  17827. "x-go-name": "ReadOnly"
  17828. },
  17829. "title": {
  17830. "description": "Title of the key to add",
  17831. "type": "string",
  17832. "uniqueItems": true,
  17833. "x-go-name": "Title"
  17834. }
  17835. },
  17836. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17837. },
  17838. "CreateLabelOption": {
  17839. "description": "CreateLabelOption options for creating a label",
  17840. "type": "object",
  17841. "required": [
  17842. "name",
  17843. "color"
  17844. ],
  17845. "properties": {
  17846. "color": {
  17847. "type": "string",
  17848. "x-go-name": "Color",
  17849. "example": "#00aabb"
  17850. },
  17851. "description": {
  17852. "type": "string",
  17853. "x-go-name": "Description"
  17854. },
  17855. "exclusive": {
  17856. "type": "boolean",
  17857. "x-go-name": "Exclusive",
  17858. "example": false
  17859. },
  17860. "is_archived": {
  17861. "type": "boolean",
  17862. "x-go-name": "IsArchived",
  17863. "example": false
  17864. },
  17865. "name": {
  17866. "type": "string",
  17867. "x-go-name": "Name"
  17868. }
  17869. },
  17870. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17871. },
  17872. "CreateMilestoneOption": {
  17873. "description": "CreateMilestoneOption options for creating a milestone",
  17874. "type": "object",
  17875. "properties": {
  17876. "description": {
  17877. "type": "string",
  17878. "x-go-name": "Description"
  17879. },
  17880. "due_on": {
  17881. "type": "string",
  17882. "format": "date-time",
  17883. "x-go-name": "Deadline"
  17884. },
  17885. "state": {
  17886. "type": "string",
  17887. "enum": [
  17888. "open",
  17889. "closed"
  17890. ],
  17891. "x-go-name": "State"
  17892. },
  17893. "title": {
  17894. "type": "string",
  17895. "x-go-name": "Title"
  17896. }
  17897. },
  17898. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17899. },
  17900. "CreateOAuth2ApplicationOptions": {
  17901. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  17902. "type": "object",
  17903. "properties": {
  17904. "confidential_client": {
  17905. "type": "boolean",
  17906. "x-go-name": "ConfidentialClient"
  17907. },
  17908. "name": {
  17909. "type": "string",
  17910. "x-go-name": "Name"
  17911. },
  17912. "redirect_uris": {
  17913. "type": "array",
  17914. "items": {
  17915. "type": "string"
  17916. },
  17917. "x-go-name": "RedirectURIs"
  17918. }
  17919. },
  17920. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17921. },
  17922. "CreateOrUpdateSecretOption": {
  17923. "description": "CreateOrUpdateSecretOption options when creating or updating secret",
  17924. "type": "object",
  17925. "required": [
  17926. "data"
  17927. ],
  17928. "properties": {
  17929. "data": {
  17930. "description": "Data of the secret to update",
  17931. "type": "string",
  17932. "x-go-name": "Data"
  17933. }
  17934. },
  17935. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17936. },
  17937. "CreateOrgOption": {
  17938. "description": "CreateOrgOption options for creating an organization",
  17939. "type": "object",
  17940. "required": [
  17941. "username"
  17942. ],
  17943. "properties": {
  17944. "description": {
  17945. "type": "string",
  17946. "x-go-name": "Description"
  17947. },
  17948. "email": {
  17949. "type": "string",
  17950. "x-go-name": "Email"
  17951. },
  17952. "full_name": {
  17953. "type": "string",
  17954. "x-go-name": "FullName"
  17955. },
  17956. "location": {
  17957. "type": "string",
  17958. "x-go-name": "Location"
  17959. },
  17960. "repo_admin_change_team_access": {
  17961. "type": "boolean",
  17962. "x-go-name": "RepoAdminChangeTeamAccess"
  17963. },
  17964. "username": {
  17965. "type": "string",
  17966. "x-go-name": "UserName"
  17967. },
  17968. "visibility": {
  17969. "description": "possible values are `public` (default), `limited` or `private`",
  17970. "type": "string",
  17971. "enum": [
  17972. "public",
  17973. "limited",
  17974. "private"
  17975. ],
  17976. "x-go-name": "Visibility"
  17977. },
  17978. "website": {
  17979. "type": "string",
  17980. "x-go-name": "Website"
  17981. }
  17982. },
  17983. "x-go-package": "code.gitea.io/gitea/modules/structs"
  17984. },
  17985. "CreatePullRequestOption": {
  17986. "description": "CreatePullRequestOption options when creating a pull request",
  17987. "type": "object",
  17988. "properties": {
  17989. "assignee": {
  17990. "type": "string",
  17991. "x-go-name": "Assignee"
  17992. },
  17993. "assignees": {
  17994. "type": "array",
  17995. "items": {
  17996. "type": "string"
  17997. },
  17998. "x-go-name": "Assignees"
  17999. },
  18000. "base": {
  18001. "type": "string",
  18002. "x-go-name": "Base"
  18003. },
  18004. "body": {
  18005. "type": "string",
  18006. "x-go-name": "Body"
  18007. },
  18008. "due_date": {
  18009. "type": "string",
  18010. "format": "date-time",
  18011. "x-go-name": "Deadline"
  18012. },
  18013. "head": {
  18014. "type": "string",
  18015. "x-go-name": "Head"
  18016. },
  18017. "labels": {
  18018. "type": "array",
  18019. "items": {
  18020. "type": "integer",
  18021. "format": "int64"
  18022. },
  18023. "x-go-name": "Labels"
  18024. },
  18025. "milestone": {
  18026. "type": "integer",
  18027. "format": "int64",
  18028. "x-go-name": "Milestone"
  18029. },
  18030. "title": {
  18031. "type": "string",
  18032. "x-go-name": "Title"
  18033. }
  18034. },
  18035. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18036. },
  18037. "CreatePullReviewComment": {
  18038. "description": "CreatePullReviewComment represent a review comment for creation api",
  18039. "type": "object",
  18040. "properties": {
  18041. "body": {
  18042. "type": "string",
  18043. "x-go-name": "Body"
  18044. },
  18045. "new_position": {
  18046. "description": "if comment to new file line or 0",
  18047. "type": "integer",
  18048. "format": "int64",
  18049. "x-go-name": "NewLineNum"
  18050. },
  18051. "old_position": {
  18052. "description": "if comment to old file line or 0",
  18053. "type": "integer",
  18054. "format": "int64",
  18055. "x-go-name": "OldLineNum"
  18056. },
  18057. "path": {
  18058. "description": "the tree path",
  18059. "type": "string",
  18060. "x-go-name": "Path"
  18061. }
  18062. },
  18063. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18064. },
  18065. "CreatePullReviewOptions": {
  18066. "description": "CreatePullReviewOptions are options to create a pull review",
  18067. "type": "object",
  18068. "properties": {
  18069. "body": {
  18070. "type": "string",
  18071. "x-go-name": "Body"
  18072. },
  18073. "comments": {
  18074. "type": "array",
  18075. "items": {
  18076. "$ref": "#/definitions/CreatePullReviewComment"
  18077. },
  18078. "x-go-name": "Comments"
  18079. },
  18080. "commit_id": {
  18081. "type": "string",
  18082. "x-go-name": "CommitID"
  18083. },
  18084. "event": {
  18085. "$ref": "#/definitions/ReviewStateType"
  18086. }
  18087. },
  18088. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18089. },
  18090. "CreatePushMirrorOption": {
  18091. "type": "object",
  18092. "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
  18093. "properties": {
  18094. "interval": {
  18095. "type": "string",
  18096. "x-go-name": "Interval"
  18097. },
  18098. "remote_address": {
  18099. "type": "string",
  18100. "x-go-name": "RemoteAddress"
  18101. },
  18102. "remote_password": {
  18103. "type": "string",
  18104. "x-go-name": "RemotePassword"
  18105. },
  18106. "remote_username": {
  18107. "type": "string",
  18108. "x-go-name": "RemoteUsername"
  18109. },
  18110. "sync_on_commit": {
  18111. "type": "boolean",
  18112. "x-go-name": "SyncOnCommit"
  18113. }
  18114. },
  18115. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18116. },
  18117. "CreateReleaseOption": {
  18118. "description": "CreateReleaseOption options when creating a release",
  18119. "type": "object",
  18120. "required": [
  18121. "tag_name"
  18122. ],
  18123. "properties": {
  18124. "body": {
  18125. "type": "string",
  18126. "x-go-name": "Note"
  18127. },
  18128. "draft": {
  18129. "type": "boolean",
  18130. "x-go-name": "IsDraft"
  18131. },
  18132. "name": {
  18133. "type": "string",
  18134. "x-go-name": "Title"
  18135. },
  18136. "prerelease": {
  18137. "type": "boolean",
  18138. "x-go-name": "IsPrerelease"
  18139. },
  18140. "tag_name": {
  18141. "type": "string",
  18142. "x-go-name": "TagName"
  18143. },
  18144. "target_commitish": {
  18145. "type": "string",
  18146. "x-go-name": "Target"
  18147. }
  18148. },
  18149. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18150. },
  18151. "CreateRepoOption": {
  18152. "description": "CreateRepoOption options when creating repository",
  18153. "type": "object",
  18154. "required": [
  18155. "name"
  18156. ],
  18157. "properties": {
  18158. "auto_init": {
  18159. "description": "Whether the repository should be auto-initialized?",
  18160. "type": "boolean",
  18161. "x-go-name": "AutoInit"
  18162. },
  18163. "default_branch": {
  18164. "description": "DefaultBranch of the repository (used when initializes and in template)",
  18165. "type": "string",
  18166. "x-go-name": "DefaultBranch"
  18167. },
  18168. "description": {
  18169. "description": "Description of the repository to create",
  18170. "type": "string",
  18171. "x-go-name": "Description"
  18172. },
  18173. "gitignores": {
  18174. "description": "Gitignores to use",
  18175. "type": "string",
  18176. "x-go-name": "Gitignores"
  18177. },
  18178. "issue_labels": {
  18179. "description": "Label-Set to use",
  18180. "type": "string",
  18181. "x-go-name": "IssueLabels"
  18182. },
  18183. "license": {
  18184. "description": "License to use",
  18185. "type": "string",
  18186. "x-go-name": "License"
  18187. },
  18188. "name": {
  18189. "description": "Name of the repository to create",
  18190. "type": "string",
  18191. "uniqueItems": true,
  18192. "x-go-name": "Name"
  18193. },
  18194. "private": {
  18195. "description": "Whether the repository is private",
  18196. "type": "boolean",
  18197. "x-go-name": "Private"
  18198. },
  18199. "readme": {
  18200. "description": "Readme of the repository to create",
  18201. "type": "string",
  18202. "x-go-name": "Readme"
  18203. },
  18204. "template": {
  18205. "description": "Whether the repository is template",
  18206. "type": "boolean",
  18207. "x-go-name": "Template"
  18208. },
  18209. "trust_model": {
  18210. "description": "TrustModel of the repository",
  18211. "type": "string",
  18212. "enum": [
  18213. "default",
  18214. "collaborator",
  18215. "committer",
  18216. "collaboratorcommitter"
  18217. ],
  18218. "x-go-name": "TrustModel"
  18219. }
  18220. },
  18221. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18222. },
  18223. "CreateStatusOption": {
  18224. "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
  18225. "type": "object",
  18226. "properties": {
  18227. "context": {
  18228. "type": "string",
  18229. "x-go-name": "Context"
  18230. },
  18231. "description": {
  18232. "type": "string",
  18233. "x-go-name": "Description"
  18234. },
  18235. "state": {
  18236. "$ref": "#/definitions/CommitStatusState"
  18237. },
  18238. "target_url": {
  18239. "type": "string",
  18240. "x-go-name": "TargetURL"
  18241. }
  18242. },
  18243. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18244. },
  18245. "CreateTagOption": {
  18246. "description": "CreateTagOption options when creating a tag",
  18247. "type": "object",
  18248. "required": [
  18249. "tag_name"
  18250. ],
  18251. "properties": {
  18252. "message": {
  18253. "type": "string",
  18254. "x-go-name": "Message"
  18255. },
  18256. "tag_name": {
  18257. "type": "string",
  18258. "x-go-name": "TagName"
  18259. },
  18260. "target": {
  18261. "type": "string",
  18262. "x-go-name": "Target"
  18263. }
  18264. },
  18265. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18266. },
  18267. "CreateTeamOption": {
  18268. "description": "CreateTeamOption options for creating a team",
  18269. "type": "object",
  18270. "required": [
  18271. "name"
  18272. ],
  18273. "properties": {
  18274. "can_create_org_repo": {
  18275. "type": "boolean",
  18276. "x-go-name": "CanCreateOrgRepo"
  18277. },
  18278. "description": {
  18279. "type": "string",
  18280. "x-go-name": "Description"
  18281. },
  18282. "includes_all_repositories": {
  18283. "type": "boolean",
  18284. "x-go-name": "IncludesAllRepositories"
  18285. },
  18286. "name": {
  18287. "type": "string",
  18288. "x-go-name": "Name"
  18289. },
  18290. "permission": {
  18291. "type": "string",
  18292. "enum": [
  18293. "read",
  18294. "write",
  18295. "admin"
  18296. ],
  18297. "x-go-name": "Permission"
  18298. },
  18299. "units": {
  18300. "type": "array",
  18301. "items": {
  18302. "type": "string"
  18303. },
  18304. "x-go-name": "Units",
  18305. "example": [
  18306. "repo.actions",
  18307. "repo.code",
  18308. "repo.issues",
  18309. "repo.ext_issues",
  18310. "repo.wiki",
  18311. "repo.ext_wiki",
  18312. "repo.pulls",
  18313. "repo.releases",
  18314. "repo.projects",
  18315. "repo.ext_wiki"
  18316. ]
  18317. },
  18318. "units_map": {
  18319. "type": "object",
  18320. "additionalProperties": {
  18321. "type": "string"
  18322. },
  18323. "x-go-name": "UnitsMap",
  18324. "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\"}"
  18325. }
  18326. },
  18327. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18328. },
  18329. "CreateUserOption": {
  18330. "description": "CreateUserOption create user options",
  18331. "type": "object",
  18332. "required": [
  18333. "username",
  18334. "email"
  18335. ],
  18336. "properties": {
  18337. "created_at": {
  18338. "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\".",
  18339. "type": "string",
  18340. "format": "date-time",
  18341. "x-go-name": "Created"
  18342. },
  18343. "email": {
  18344. "type": "string",
  18345. "format": "email",
  18346. "x-go-name": "Email"
  18347. },
  18348. "full_name": {
  18349. "type": "string",
  18350. "x-go-name": "FullName"
  18351. },
  18352. "login_name": {
  18353. "type": "string",
  18354. "x-go-name": "LoginName"
  18355. },
  18356. "must_change_password": {
  18357. "type": "boolean",
  18358. "x-go-name": "MustChangePassword"
  18359. },
  18360. "password": {
  18361. "type": "string",
  18362. "x-go-name": "Password"
  18363. },
  18364. "restricted": {
  18365. "type": "boolean",
  18366. "x-go-name": "Restricted"
  18367. },
  18368. "send_notify": {
  18369. "type": "boolean",
  18370. "x-go-name": "SendNotify"
  18371. },
  18372. "source_id": {
  18373. "type": "integer",
  18374. "format": "int64",
  18375. "x-go-name": "SourceID"
  18376. },
  18377. "username": {
  18378. "type": "string",
  18379. "x-go-name": "Username"
  18380. },
  18381. "visibility": {
  18382. "type": "string",
  18383. "x-go-name": "Visibility"
  18384. }
  18385. },
  18386. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18387. },
  18388. "CreateWikiPageOptions": {
  18389. "description": "CreateWikiPageOptions form for creating wiki",
  18390. "type": "object",
  18391. "properties": {
  18392. "content_base64": {
  18393. "description": "content must be base64 encoded",
  18394. "type": "string",
  18395. "x-go-name": "ContentBase64"
  18396. },
  18397. "message": {
  18398. "description": "optional commit message summarizing the change",
  18399. "type": "string",
  18400. "x-go-name": "Message"
  18401. },
  18402. "title": {
  18403. "description": "page title. leave empty to keep unchanged",
  18404. "type": "string",
  18405. "x-go-name": "Title"
  18406. }
  18407. },
  18408. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18409. },
  18410. "Cron": {
  18411. "description": "Cron represents a Cron task",
  18412. "type": "object",
  18413. "properties": {
  18414. "exec_times": {
  18415. "type": "integer",
  18416. "format": "int64",
  18417. "x-go-name": "ExecTimes"
  18418. },
  18419. "name": {
  18420. "type": "string",
  18421. "x-go-name": "Name"
  18422. },
  18423. "next": {
  18424. "type": "string",
  18425. "format": "date-time",
  18426. "x-go-name": "Next"
  18427. },
  18428. "prev": {
  18429. "type": "string",
  18430. "format": "date-time",
  18431. "x-go-name": "Prev"
  18432. },
  18433. "schedule": {
  18434. "type": "string",
  18435. "x-go-name": "Schedule"
  18436. }
  18437. },
  18438. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18439. },
  18440. "DeleteEmailOption": {
  18441. "description": "DeleteEmailOption options when deleting email addresses",
  18442. "type": "object",
  18443. "properties": {
  18444. "emails": {
  18445. "description": "email addresses to delete",
  18446. "type": "array",
  18447. "items": {
  18448. "type": "string"
  18449. },
  18450. "x-go-name": "Emails"
  18451. }
  18452. },
  18453. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18454. },
  18455. "DeleteFileOptions": {
  18456. "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)",
  18457. "type": "object",
  18458. "required": [
  18459. "sha"
  18460. ],
  18461. "properties": {
  18462. "author": {
  18463. "$ref": "#/definitions/Identity"
  18464. },
  18465. "branch": {
  18466. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  18467. "type": "string",
  18468. "x-go-name": "BranchName"
  18469. },
  18470. "committer": {
  18471. "$ref": "#/definitions/Identity"
  18472. },
  18473. "dates": {
  18474. "$ref": "#/definitions/CommitDateOptions"
  18475. },
  18476. "message": {
  18477. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  18478. "type": "string",
  18479. "x-go-name": "Message"
  18480. },
  18481. "new_branch": {
  18482. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  18483. "type": "string",
  18484. "x-go-name": "NewBranchName"
  18485. },
  18486. "sha": {
  18487. "description": "sha is the SHA for the file that already exists",
  18488. "type": "string",
  18489. "x-go-name": "SHA"
  18490. },
  18491. "signoff": {
  18492. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  18493. "type": "boolean",
  18494. "x-go-name": "Signoff"
  18495. }
  18496. },
  18497. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18498. },
  18499. "DeployKey": {
  18500. "description": "DeployKey a deploy key",
  18501. "type": "object",
  18502. "properties": {
  18503. "created_at": {
  18504. "type": "string",
  18505. "format": "date-time",
  18506. "x-go-name": "Created"
  18507. },
  18508. "fingerprint": {
  18509. "type": "string",
  18510. "x-go-name": "Fingerprint"
  18511. },
  18512. "id": {
  18513. "type": "integer",
  18514. "format": "int64",
  18515. "x-go-name": "ID"
  18516. },
  18517. "key": {
  18518. "type": "string",
  18519. "x-go-name": "Key"
  18520. },
  18521. "key_id": {
  18522. "type": "integer",
  18523. "format": "int64",
  18524. "x-go-name": "KeyID"
  18525. },
  18526. "read_only": {
  18527. "type": "boolean",
  18528. "x-go-name": "ReadOnly"
  18529. },
  18530. "repository": {
  18531. "$ref": "#/definitions/Repository"
  18532. },
  18533. "title": {
  18534. "type": "string",
  18535. "x-go-name": "Title"
  18536. },
  18537. "url": {
  18538. "type": "string",
  18539. "x-go-name": "URL"
  18540. }
  18541. },
  18542. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18543. },
  18544. "DismissPullReviewOptions": {
  18545. "description": "DismissPullReviewOptions are options to dismiss a pull review",
  18546. "type": "object",
  18547. "properties": {
  18548. "message": {
  18549. "type": "string",
  18550. "x-go-name": "Message"
  18551. },
  18552. "priors": {
  18553. "type": "boolean",
  18554. "x-go-name": "Priors"
  18555. }
  18556. },
  18557. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18558. },
  18559. "EditAttachmentOptions": {
  18560. "description": "EditAttachmentOptions options for editing attachments",
  18561. "type": "object",
  18562. "properties": {
  18563. "name": {
  18564. "type": "string",
  18565. "x-go-name": "Name"
  18566. }
  18567. },
  18568. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18569. },
  18570. "EditBranchProtectionOption": {
  18571. "description": "EditBranchProtectionOption options for editing a branch protection",
  18572. "type": "object",
  18573. "properties": {
  18574. "approvals_whitelist_teams": {
  18575. "type": "array",
  18576. "items": {
  18577. "type": "string"
  18578. },
  18579. "x-go-name": "ApprovalsWhitelistTeams"
  18580. },
  18581. "approvals_whitelist_username": {
  18582. "type": "array",
  18583. "items": {
  18584. "type": "string"
  18585. },
  18586. "x-go-name": "ApprovalsWhitelistUsernames"
  18587. },
  18588. "block_on_official_review_requests": {
  18589. "type": "boolean",
  18590. "x-go-name": "BlockOnOfficialReviewRequests"
  18591. },
  18592. "block_on_outdated_branch": {
  18593. "type": "boolean",
  18594. "x-go-name": "BlockOnOutdatedBranch"
  18595. },
  18596. "block_on_rejected_reviews": {
  18597. "type": "boolean",
  18598. "x-go-name": "BlockOnRejectedReviews"
  18599. },
  18600. "dismiss_stale_approvals": {
  18601. "type": "boolean",
  18602. "x-go-name": "DismissStaleApprovals"
  18603. },
  18604. "enable_approvals_whitelist": {
  18605. "type": "boolean",
  18606. "x-go-name": "EnableApprovalsWhitelist"
  18607. },
  18608. "enable_merge_whitelist": {
  18609. "type": "boolean",
  18610. "x-go-name": "EnableMergeWhitelist"
  18611. },
  18612. "enable_push": {
  18613. "type": "boolean",
  18614. "x-go-name": "EnablePush"
  18615. },
  18616. "enable_push_whitelist": {
  18617. "type": "boolean",
  18618. "x-go-name": "EnablePushWhitelist"
  18619. },
  18620. "enable_status_check": {
  18621. "type": "boolean",
  18622. "x-go-name": "EnableStatusCheck"
  18623. },
  18624. "merge_whitelist_teams": {
  18625. "type": "array",
  18626. "items": {
  18627. "type": "string"
  18628. },
  18629. "x-go-name": "MergeWhitelistTeams"
  18630. },
  18631. "merge_whitelist_usernames": {
  18632. "type": "array",
  18633. "items": {
  18634. "type": "string"
  18635. },
  18636. "x-go-name": "MergeWhitelistUsernames"
  18637. },
  18638. "protected_file_patterns": {
  18639. "type": "string",
  18640. "x-go-name": "ProtectedFilePatterns"
  18641. },
  18642. "push_whitelist_deploy_keys": {
  18643. "type": "boolean",
  18644. "x-go-name": "PushWhitelistDeployKeys"
  18645. },
  18646. "push_whitelist_teams": {
  18647. "type": "array",
  18648. "items": {
  18649. "type": "string"
  18650. },
  18651. "x-go-name": "PushWhitelistTeams"
  18652. },
  18653. "push_whitelist_usernames": {
  18654. "type": "array",
  18655. "items": {
  18656. "type": "string"
  18657. },
  18658. "x-go-name": "PushWhitelistUsernames"
  18659. },
  18660. "require_signed_commits": {
  18661. "type": "boolean",
  18662. "x-go-name": "RequireSignedCommits"
  18663. },
  18664. "required_approvals": {
  18665. "type": "integer",
  18666. "format": "int64",
  18667. "x-go-name": "RequiredApprovals"
  18668. },
  18669. "status_check_contexts": {
  18670. "type": "array",
  18671. "items": {
  18672. "type": "string"
  18673. },
  18674. "x-go-name": "StatusCheckContexts"
  18675. },
  18676. "unprotected_file_patterns": {
  18677. "type": "string",
  18678. "x-go-name": "UnprotectedFilePatterns"
  18679. }
  18680. },
  18681. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18682. },
  18683. "EditDeadlineOption": {
  18684. "description": "EditDeadlineOption options for creating a deadline",
  18685. "type": "object",
  18686. "required": [
  18687. "due_date"
  18688. ],
  18689. "properties": {
  18690. "due_date": {
  18691. "type": "string",
  18692. "format": "date-time",
  18693. "x-go-name": "Deadline"
  18694. }
  18695. },
  18696. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18697. },
  18698. "EditGitHookOption": {
  18699. "description": "EditGitHookOption options when modifying one Git hook",
  18700. "type": "object",
  18701. "properties": {
  18702. "content": {
  18703. "type": "string",
  18704. "x-go-name": "Content"
  18705. }
  18706. },
  18707. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18708. },
  18709. "EditHookOption": {
  18710. "description": "EditHookOption options when modify one hook",
  18711. "type": "object",
  18712. "properties": {
  18713. "active": {
  18714. "type": "boolean",
  18715. "x-go-name": "Active"
  18716. },
  18717. "authorization_header": {
  18718. "type": "string",
  18719. "x-go-name": "AuthorizationHeader"
  18720. },
  18721. "branch_filter": {
  18722. "type": "string",
  18723. "x-go-name": "BranchFilter"
  18724. },
  18725. "config": {
  18726. "type": "object",
  18727. "additionalProperties": {
  18728. "type": "string"
  18729. },
  18730. "x-go-name": "Config"
  18731. },
  18732. "events": {
  18733. "type": "array",
  18734. "items": {
  18735. "type": "string"
  18736. },
  18737. "x-go-name": "Events"
  18738. }
  18739. },
  18740. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18741. },
  18742. "EditIssueCommentOption": {
  18743. "description": "EditIssueCommentOption options for editing a comment",
  18744. "type": "object",
  18745. "required": [
  18746. "body"
  18747. ],
  18748. "properties": {
  18749. "body": {
  18750. "type": "string",
  18751. "x-go-name": "Body"
  18752. }
  18753. },
  18754. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18755. },
  18756. "EditIssueOption": {
  18757. "description": "EditIssueOption options for editing an issue",
  18758. "type": "object",
  18759. "properties": {
  18760. "assignee": {
  18761. "description": "deprecated",
  18762. "type": "string",
  18763. "x-go-name": "Assignee"
  18764. },
  18765. "assignees": {
  18766. "type": "array",
  18767. "items": {
  18768. "type": "string"
  18769. },
  18770. "x-go-name": "Assignees"
  18771. },
  18772. "body": {
  18773. "type": "string",
  18774. "x-go-name": "Body"
  18775. },
  18776. "due_date": {
  18777. "type": "string",
  18778. "format": "date-time",
  18779. "x-go-name": "Deadline"
  18780. },
  18781. "milestone": {
  18782. "type": "integer",
  18783. "format": "int64",
  18784. "x-go-name": "Milestone"
  18785. },
  18786. "ref": {
  18787. "type": "string",
  18788. "x-go-name": "Ref"
  18789. },
  18790. "state": {
  18791. "type": "string",
  18792. "x-go-name": "State"
  18793. },
  18794. "title": {
  18795. "type": "string",
  18796. "x-go-name": "Title"
  18797. },
  18798. "unset_due_date": {
  18799. "type": "boolean",
  18800. "x-go-name": "RemoveDeadline"
  18801. }
  18802. },
  18803. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18804. },
  18805. "EditLabelOption": {
  18806. "description": "EditLabelOption options for editing a label",
  18807. "type": "object",
  18808. "properties": {
  18809. "color": {
  18810. "type": "string",
  18811. "x-go-name": "Color",
  18812. "example": "#00aabb"
  18813. },
  18814. "description": {
  18815. "type": "string",
  18816. "x-go-name": "Description"
  18817. },
  18818. "exclusive": {
  18819. "type": "boolean",
  18820. "x-go-name": "Exclusive",
  18821. "example": false
  18822. },
  18823. "is_archived": {
  18824. "type": "boolean",
  18825. "x-go-name": "IsArchived",
  18826. "example": false
  18827. },
  18828. "name": {
  18829. "type": "string",
  18830. "x-go-name": "Name"
  18831. }
  18832. },
  18833. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18834. },
  18835. "EditMilestoneOption": {
  18836. "description": "EditMilestoneOption options for editing a milestone",
  18837. "type": "object",
  18838. "properties": {
  18839. "description": {
  18840. "type": "string",
  18841. "x-go-name": "Description"
  18842. },
  18843. "due_on": {
  18844. "type": "string",
  18845. "format": "date-time",
  18846. "x-go-name": "Deadline"
  18847. },
  18848. "state": {
  18849. "type": "string",
  18850. "x-go-name": "State"
  18851. },
  18852. "title": {
  18853. "type": "string",
  18854. "x-go-name": "Title"
  18855. }
  18856. },
  18857. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18858. },
  18859. "EditOrgOption": {
  18860. "description": "EditOrgOption options for editing an organization",
  18861. "type": "object",
  18862. "properties": {
  18863. "description": {
  18864. "type": "string",
  18865. "x-go-name": "Description"
  18866. },
  18867. "email": {
  18868. "type": "string",
  18869. "x-go-name": "Email"
  18870. },
  18871. "full_name": {
  18872. "type": "string",
  18873. "x-go-name": "FullName"
  18874. },
  18875. "location": {
  18876. "type": "string",
  18877. "x-go-name": "Location"
  18878. },
  18879. "repo_admin_change_team_access": {
  18880. "type": "boolean",
  18881. "x-go-name": "RepoAdminChangeTeamAccess"
  18882. },
  18883. "visibility": {
  18884. "description": "possible values are `public`, `limited` or `private`",
  18885. "type": "string",
  18886. "enum": [
  18887. "public",
  18888. "limited",
  18889. "private"
  18890. ],
  18891. "x-go-name": "Visibility"
  18892. },
  18893. "website": {
  18894. "type": "string",
  18895. "x-go-name": "Website"
  18896. }
  18897. },
  18898. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18899. },
  18900. "EditPullRequestOption": {
  18901. "description": "EditPullRequestOption options when modify pull request",
  18902. "type": "object",
  18903. "properties": {
  18904. "allow_maintainer_edit": {
  18905. "type": "boolean",
  18906. "x-go-name": "AllowMaintainerEdit"
  18907. },
  18908. "assignee": {
  18909. "type": "string",
  18910. "x-go-name": "Assignee"
  18911. },
  18912. "assignees": {
  18913. "type": "array",
  18914. "items": {
  18915. "type": "string"
  18916. },
  18917. "x-go-name": "Assignees"
  18918. },
  18919. "base": {
  18920. "type": "string",
  18921. "x-go-name": "Base"
  18922. },
  18923. "body": {
  18924. "type": "string",
  18925. "x-go-name": "Body"
  18926. },
  18927. "due_date": {
  18928. "type": "string",
  18929. "format": "date-time",
  18930. "x-go-name": "Deadline"
  18931. },
  18932. "labels": {
  18933. "type": "array",
  18934. "items": {
  18935. "type": "integer",
  18936. "format": "int64"
  18937. },
  18938. "x-go-name": "Labels"
  18939. },
  18940. "milestone": {
  18941. "type": "integer",
  18942. "format": "int64",
  18943. "x-go-name": "Milestone"
  18944. },
  18945. "state": {
  18946. "type": "string",
  18947. "x-go-name": "State"
  18948. },
  18949. "title": {
  18950. "type": "string",
  18951. "x-go-name": "Title"
  18952. },
  18953. "unset_due_date": {
  18954. "type": "boolean",
  18955. "x-go-name": "RemoveDeadline"
  18956. }
  18957. },
  18958. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18959. },
  18960. "EditReactionOption": {
  18961. "description": "EditReactionOption contain the reaction type",
  18962. "type": "object",
  18963. "properties": {
  18964. "content": {
  18965. "type": "string",
  18966. "x-go-name": "Reaction"
  18967. }
  18968. },
  18969. "x-go-package": "code.gitea.io/gitea/modules/structs"
  18970. },
  18971. "EditReleaseOption": {
  18972. "description": "EditReleaseOption options when editing a release",
  18973. "type": "object",
  18974. "properties": {
  18975. "body": {
  18976. "type": "string",
  18977. "x-go-name": "Note"
  18978. },
  18979. "draft": {
  18980. "type": "boolean",
  18981. "x-go-name": "IsDraft"
  18982. },
  18983. "name": {
  18984. "type": "string",
  18985. "x-go-name": "Title"
  18986. },
  18987. "prerelease": {
  18988. "type": "boolean",
  18989. "x-go-name": "IsPrerelease"
  18990. },
  18991. "tag_name": {
  18992. "type": "string",
  18993. "x-go-name": "TagName"
  18994. },
  18995. "target_commitish": {
  18996. "type": "string",
  18997. "x-go-name": "Target"
  18998. }
  18999. },
  19000. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19001. },
  19002. "EditRepoOption": {
  19003. "description": "EditRepoOption options when editing a repository's properties",
  19004. "type": "object",
  19005. "properties": {
  19006. "allow_manual_merge": {
  19007. "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
  19008. "type": "boolean",
  19009. "x-go-name": "AllowManualMerge"
  19010. },
  19011. "allow_merge_commits": {
  19012. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  19013. "type": "boolean",
  19014. "x-go-name": "AllowMerge"
  19015. },
  19016. "allow_rebase": {
  19017. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  19018. "type": "boolean",
  19019. "x-go-name": "AllowRebase"
  19020. },
  19021. "allow_rebase_explicit": {
  19022. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
  19023. "type": "boolean",
  19024. "x-go-name": "AllowRebaseMerge"
  19025. },
  19026. "allow_rebase_update": {
  19027. "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
  19028. "type": "boolean",
  19029. "x-go-name": "AllowRebaseUpdate"
  19030. },
  19031. "allow_squash_merge": {
  19032. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  19033. "type": "boolean",
  19034. "x-go-name": "AllowSquash"
  19035. },
  19036. "archived": {
  19037. "description": "set to `true` to archive this repository.",
  19038. "type": "boolean",
  19039. "x-go-name": "Archived"
  19040. },
  19041. "autodetect_manual_merge": {
  19042. "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
  19043. "type": "boolean",
  19044. "x-go-name": "AutodetectManualMerge"
  19045. },
  19046. "default_allow_maintainer_edit": {
  19047. "description": "set to `true` to allow edits from maintainers by default",
  19048. "type": "boolean",
  19049. "x-go-name": "DefaultAllowMaintainerEdit"
  19050. },
  19051. "default_branch": {
  19052. "description": "sets the default branch for this repository.",
  19053. "type": "string",
  19054. "x-go-name": "DefaultBranch"
  19055. },
  19056. "default_delete_branch_after_merge": {
  19057. "description": "set to `true` to delete pr branch after merge by default",
  19058. "type": "boolean",
  19059. "x-go-name": "DefaultDeleteBranchAfterMerge"
  19060. },
  19061. "default_merge_style": {
  19062. "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", or \"squash\".",
  19063. "type": "string",
  19064. "x-go-name": "DefaultMergeStyle"
  19065. },
  19066. "description": {
  19067. "description": "a short description of the repository.",
  19068. "type": "string",
  19069. "x-go-name": "Description"
  19070. },
  19071. "enable_prune": {
  19072. "description": "enable prune - remove obsolete remote-tracking references",
  19073. "type": "boolean",
  19074. "x-go-name": "EnablePrune"
  19075. },
  19076. "external_tracker": {
  19077. "$ref": "#/definitions/ExternalTracker"
  19078. },
  19079. "external_wiki": {
  19080. "$ref": "#/definitions/ExternalWiki"
  19081. },
  19082. "has_actions": {
  19083. "description": "either `true` to enable actions unit, or `false` to disable them.",
  19084. "type": "boolean",
  19085. "x-go-name": "HasActions"
  19086. },
  19087. "has_issues": {
  19088. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  19089. "type": "boolean",
  19090. "x-go-name": "HasIssues"
  19091. },
  19092. "has_packages": {
  19093. "description": "either `true` to enable packages unit, or `false` to disable them.",
  19094. "type": "boolean",
  19095. "x-go-name": "HasPackages"
  19096. },
  19097. "has_projects": {
  19098. "description": "either `true` to enable project unit, or `false` to disable them.",
  19099. "type": "boolean",
  19100. "x-go-name": "HasProjects"
  19101. },
  19102. "has_pull_requests": {
  19103. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  19104. "type": "boolean",
  19105. "x-go-name": "HasPullRequests"
  19106. },
  19107. "has_releases": {
  19108. "description": "either `true` to enable releases unit, or `false` to disable them.",
  19109. "type": "boolean",
  19110. "x-go-name": "HasReleases"
  19111. },
  19112. "has_wiki": {
  19113. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  19114. "type": "boolean",
  19115. "x-go-name": "HasWiki"
  19116. },
  19117. "ignore_whitespace_conflicts": {
  19118. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
  19119. "type": "boolean",
  19120. "x-go-name": "IgnoreWhitespaceConflicts"
  19121. },
  19122. "internal_tracker": {
  19123. "$ref": "#/definitions/InternalTracker"
  19124. },
  19125. "mirror_interval": {
  19126. "description": "set to a string like `8h30m0s` to set the mirror interval time",
  19127. "type": "string",
  19128. "x-go-name": "MirrorInterval"
  19129. },
  19130. "name": {
  19131. "description": "name of the repository",
  19132. "type": "string",
  19133. "uniqueItems": true,
  19134. "x-go-name": "Name"
  19135. },
  19136. "private": {
  19137. "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.",
  19138. "type": "boolean",
  19139. "x-go-name": "Private"
  19140. },
  19141. "template": {
  19142. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  19143. "type": "boolean",
  19144. "x-go-name": "Template"
  19145. },
  19146. "website": {
  19147. "description": "a URL with more information about the repository.",
  19148. "type": "string",
  19149. "x-go-name": "Website"
  19150. }
  19151. },
  19152. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19153. },
  19154. "EditTeamOption": {
  19155. "description": "EditTeamOption options for editing a team",
  19156. "type": "object",
  19157. "required": [
  19158. "name"
  19159. ],
  19160. "properties": {
  19161. "can_create_org_repo": {
  19162. "type": "boolean",
  19163. "x-go-name": "CanCreateOrgRepo"
  19164. },
  19165. "description": {
  19166. "type": "string",
  19167. "x-go-name": "Description"
  19168. },
  19169. "includes_all_repositories": {
  19170. "type": "boolean",
  19171. "x-go-name": "IncludesAllRepositories"
  19172. },
  19173. "name": {
  19174. "type": "string",
  19175. "x-go-name": "Name"
  19176. },
  19177. "permission": {
  19178. "type": "string",
  19179. "enum": [
  19180. "read",
  19181. "write",
  19182. "admin"
  19183. ],
  19184. "x-go-name": "Permission"
  19185. },
  19186. "units": {
  19187. "type": "array",
  19188. "items": {
  19189. "type": "string"
  19190. },
  19191. "x-go-name": "Units",
  19192. "example": [
  19193. "repo.code",
  19194. "repo.issues",
  19195. "repo.ext_issues",
  19196. "repo.wiki",
  19197. "repo.pulls",
  19198. "repo.releases",
  19199. "repo.projects",
  19200. "repo.ext_wiki"
  19201. ]
  19202. },
  19203. "units_map": {
  19204. "type": "object",
  19205. "additionalProperties": {
  19206. "type": "string"
  19207. },
  19208. "x-go-name": "UnitsMap",
  19209. "example": {
  19210. "repo.code": "read",
  19211. "repo.ext_issues": "none",
  19212. "repo.ext_wiki": "none",
  19213. "repo.issues": "write",
  19214. "repo.projects": "none",
  19215. "repo.pulls": "owner",
  19216. "repo.releases": "none",
  19217. "repo.wiki": "admin"
  19218. }
  19219. }
  19220. },
  19221. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19222. },
  19223. "EditUserOption": {
  19224. "description": "EditUserOption edit user options",
  19225. "type": "object",
  19226. "required": [
  19227. "source_id",
  19228. "login_name"
  19229. ],
  19230. "properties": {
  19231. "active": {
  19232. "type": "boolean",
  19233. "x-go-name": "Active"
  19234. },
  19235. "admin": {
  19236. "type": "boolean",
  19237. "x-go-name": "Admin"
  19238. },
  19239. "allow_create_organization": {
  19240. "type": "boolean",
  19241. "x-go-name": "AllowCreateOrganization"
  19242. },
  19243. "allow_git_hook": {
  19244. "type": "boolean",
  19245. "x-go-name": "AllowGitHook"
  19246. },
  19247. "allow_import_local": {
  19248. "type": "boolean",
  19249. "x-go-name": "AllowImportLocal"
  19250. },
  19251. "description": {
  19252. "type": "string",
  19253. "x-go-name": "Description"
  19254. },
  19255. "email": {
  19256. "type": "string",
  19257. "format": "email",
  19258. "x-go-name": "Email"
  19259. },
  19260. "full_name": {
  19261. "type": "string",
  19262. "x-go-name": "FullName"
  19263. },
  19264. "location": {
  19265. "type": "string",
  19266. "x-go-name": "Location"
  19267. },
  19268. "login_name": {
  19269. "type": "string",
  19270. "x-go-name": "LoginName"
  19271. },
  19272. "max_repo_creation": {
  19273. "type": "integer",
  19274. "format": "int64",
  19275. "x-go-name": "MaxRepoCreation"
  19276. },
  19277. "must_change_password": {
  19278. "type": "boolean",
  19279. "x-go-name": "MustChangePassword"
  19280. },
  19281. "password": {
  19282. "type": "string",
  19283. "x-go-name": "Password"
  19284. },
  19285. "prohibit_login": {
  19286. "type": "boolean",
  19287. "x-go-name": "ProhibitLogin"
  19288. },
  19289. "restricted": {
  19290. "type": "boolean",
  19291. "x-go-name": "Restricted"
  19292. },
  19293. "source_id": {
  19294. "type": "integer",
  19295. "format": "int64",
  19296. "x-go-name": "SourceID"
  19297. },
  19298. "visibility": {
  19299. "type": "string",
  19300. "x-go-name": "Visibility"
  19301. },
  19302. "website": {
  19303. "type": "string",
  19304. "x-go-name": "Website"
  19305. }
  19306. },
  19307. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19308. },
  19309. "Email": {
  19310. "description": "Email an email address belonging to a user",
  19311. "type": "object",
  19312. "properties": {
  19313. "email": {
  19314. "type": "string",
  19315. "format": "email",
  19316. "x-go-name": "Email"
  19317. },
  19318. "primary": {
  19319. "type": "boolean",
  19320. "x-go-name": "Primary"
  19321. },
  19322. "user_id": {
  19323. "type": "integer",
  19324. "format": "int64",
  19325. "x-go-name": "UserID"
  19326. },
  19327. "username": {
  19328. "type": "string",
  19329. "x-go-name": "UserName"
  19330. },
  19331. "verified": {
  19332. "type": "boolean",
  19333. "x-go-name": "Verified"
  19334. }
  19335. },
  19336. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19337. },
  19338. "ExternalTracker": {
  19339. "description": "ExternalTracker represents settings for external tracker",
  19340. "type": "object",
  19341. "properties": {
  19342. "external_tracker_format": {
  19343. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  19344. "type": "string",
  19345. "x-go-name": "ExternalTrackerFormat"
  19346. },
  19347. "external_tracker_regexp_pattern": {
  19348. "description": "External Issue Tracker issue regular expression",
  19349. "type": "string",
  19350. "x-go-name": "ExternalTrackerRegexpPattern"
  19351. },
  19352. "external_tracker_style": {
  19353. "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
  19354. "type": "string",
  19355. "x-go-name": "ExternalTrackerStyle"
  19356. },
  19357. "external_tracker_url": {
  19358. "description": "URL of external issue tracker.",
  19359. "type": "string",
  19360. "x-go-name": "ExternalTrackerURL"
  19361. }
  19362. },
  19363. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19364. },
  19365. "ExternalWiki": {
  19366. "description": "ExternalWiki represents setting for external wiki",
  19367. "type": "object",
  19368. "properties": {
  19369. "external_wiki_url": {
  19370. "description": "URL of external wiki.",
  19371. "type": "string",
  19372. "x-go-name": "ExternalWikiURL"
  19373. }
  19374. },
  19375. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19376. },
  19377. "FileCommitResponse": {
  19378. "type": "object",
  19379. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  19380. "properties": {
  19381. "author": {
  19382. "$ref": "#/definitions/CommitUser"
  19383. },
  19384. "committer": {
  19385. "$ref": "#/definitions/CommitUser"
  19386. },
  19387. "created": {
  19388. "type": "string",
  19389. "format": "date-time",
  19390. "x-go-name": "Created"
  19391. },
  19392. "html_url": {
  19393. "type": "string",
  19394. "x-go-name": "HTMLURL"
  19395. },
  19396. "message": {
  19397. "type": "string",
  19398. "x-go-name": "Message"
  19399. },
  19400. "parents": {
  19401. "type": "array",
  19402. "items": {
  19403. "$ref": "#/definitions/CommitMeta"
  19404. },
  19405. "x-go-name": "Parents"
  19406. },
  19407. "sha": {
  19408. "type": "string",
  19409. "x-go-name": "SHA"
  19410. },
  19411. "tree": {
  19412. "$ref": "#/definitions/CommitMeta"
  19413. },
  19414. "url": {
  19415. "type": "string",
  19416. "x-go-name": "URL"
  19417. }
  19418. },
  19419. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19420. },
  19421. "FileDeleteResponse": {
  19422. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  19423. "type": "object",
  19424. "properties": {
  19425. "commit": {
  19426. "$ref": "#/definitions/FileCommitResponse"
  19427. },
  19428. "content": {
  19429. "x-go-name": "Content"
  19430. },
  19431. "verification": {
  19432. "$ref": "#/definitions/PayloadCommitVerification"
  19433. }
  19434. },
  19435. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19436. },
  19437. "FileLinksResponse": {
  19438. "description": "FileLinksResponse contains the links for a repo's file",
  19439. "type": "object",
  19440. "properties": {
  19441. "git": {
  19442. "type": "string",
  19443. "x-go-name": "GitURL"
  19444. },
  19445. "html": {
  19446. "type": "string",
  19447. "x-go-name": "HTMLURL"
  19448. },
  19449. "self": {
  19450. "type": "string",
  19451. "x-go-name": "Self"
  19452. }
  19453. },
  19454. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19455. },
  19456. "FileResponse": {
  19457. "description": "FileResponse contains information about a repo's file",
  19458. "type": "object",
  19459. "properties": {
  19460. "commit": {
  19461. "$ref": "#/definitions/FileCommitResponse"
  19462. },
  19463. "content": {
  19464. "$ref": "#/definitions/ContentsResponse"
  19465. },
  19466. "verification": {
  19467. "$ref": "#/definitions/PayloadCommitVerification"
  19468. }
  19469. },
  19470. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19471. },
  19472. "FilesResponse": {
  19473. "description": "FilesResponse contains information about multiple files from a repo",
  19474. "type": "object",
  19475. "properties": {
  19476. "commit": {
  19477. "$ref": "#/definitions/FileCommitResponse"
  19478. },
  19479. "files": {
  19480. "type": "array",
  19481. "items": {
  19482. "$ref": "#/definitions/ContentsResponse"
  19483. },
  19484. "x-go-name": "Files"
  19485. },
  19486. "verification": {
  19487. "$ref": "#/definitions/PayloadCommitVerification"
  19488. }
  19489. },
  19490. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19491. },
  19492. "GPGKey": {
  19493. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  19494. "type": "object",
  19495. "properties": {
  19496. "can_certify": {
  19497. "type": "boolean",
  19498. "x-go-name": "CanCertify"
  19499. },
  19500. "can_encrypt_comms": {
  19501. "type": "boolean",
  19502. "x-go-name": "CanEncryptComms"
  19503. },
  19504. "can_encrypt_storage": {
  19505. "type": "boolean",
  19506. "x-go-name": "CanEncryptStorage"
  19507. },
  19508. "can_sign": {
  19509. "type": "boolean",
  19510. "x-go-name": "CanSign"
  19511. },
  19512. "created_at": {
  19513. "type": "string",
  19514. "format": "date-time",
  19515. "x-go-name": "Created"
  19516. },
  19517. "emails": {
  19518. "type": "array",
  19519. "items": {
  19520. "$ref": "#/definitions/GPGKeyEmail"
  19521. },
  19522. "x-go-name": "Emails"
  19523. },
  19524. "expires_at": {
  19525. "type": "string",
  19526. "format": "date-time",
  19527. "x-go-name": "Expires"
  19528. },
  19529. "id": {
  19530. "type": "integer",
  19531. "format": "int64",
  19532. "x-go-name": "ID"
  19533. },
  19534. "key_id": {
  19535. "type": "string",
  19536. "x-go-name": "KeyID"
  19537. },
  19538. "primary_key_id": {
  19539. "type": "string",
  19540. "x-go-name": "PrimaryKeyID"
  19541. },
  19542. "public_key": {
  19543. "type": "string",
  19544. "x-go-name": "PublicKey"
  19545. },
  19546. "subkeys": {
  19547. "type": "array",
  19548. "items": {
  19549. "$ref": "#/definitions/GPGKey"
  19550. },
  19551. "x-go-name": "SubsKey"
  19552. },
  19553. "verified": {
  19554. "type": "boolean",
  19555. "x-go-name": "Verified"
  19556. }
  19557. },
  19558. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19559. },
  19560. "GPGKeyEmail": {
  19561. "description": "GPGKeyEmail an email attached to a GPGKey",
  19562. "type": "object",
  19563. "properties": {
  19564. "email": {
  19565. "type": "string",
  19566. "x-go-name": "Email"
  19567. },
  19568. "verified": {
  19569. "type": "boolean",
  19570. "x-go-name": "Verified"
  19571. }
  19572. },
  19573. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19574. },
  19575. "GeneralAPISettings": {
  19576. "description": "GeneralAPISettings contains global api settings exposed by it",
  19577. "type": "object",
  19578. "properties": {
  19579. "default_git_trees_per_page": {
  19580. "type": "integer",
  19581. "format": "int64",
  19582. "x-go-name": "DefaultGitTreesPerPage"
  19583. },
  19584. "default_max_blob_size": {
  19585. "type": "integer",
  19586. "format": "int64",
  19587. "x-go-name": "DefaultMaxBlobSize"
  19588. },
  19589. "default_paging_num": {
  19590. "type": "integer",
  19591. "format": "int64",
  19592. "x-go-name": "DefaultPagingNum"
  19593. },
  19594. "max_response_items": {
  19595. "type": "integer",
  19596. "format": "int64",
  19597. "x-go-name": "MaxResponseItems"
  19598. }
  19599. },
  19600. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19601. },
  19602. "GeneralAttachmentSettings": {
  19603. "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
  19604. "type": "object",
  19605. "properties": {
  19606. "allowed_types": {
  19607. "type": "string",
  19608. "x-go-name": "AllowedTypes"
  19609. },
  19610. "enabled": {
  19611. "type": "boolean",
  19612. "x-go-name": "Enabled"
  19613. },
  19614. "max_files": {
  19615. "type": "integer",
  19616. "format": "int64",
  19617. "x-go-name": "MaxFiles"
  19618. },
  19619. "max_size": {
  19620. "type": "integer",
  19621. "format": "int64",
  19622. "x-go-name": "MaxSize"
  19623. }
  19624. },
  19625. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19626. },
  19627. "GeneralRepoSettings": {
  19628. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  19629. "type": "object",
  19630. "properties": {
  19631. "http_git_disabled": {
  19632. "type": "boolean",
  19633. "x-go-name": "HTTPGitDisabled"
  19634. },
  19635. "lfs_disabled": {
  19636. "type": "boolean",
  19637. "x-go-name": "LFSDisabled"
  19638. },
  19639. "migrations_disabled": {
  19640. "type": "boolean",
  19641. "x-go-name": "MigrationsDisabled"
  19642. },
  19643. "mirrors_disabled": {
  19644. "type": "boolean",
  19645. "x-go-name": "MirrorsDisabled"
  19646. },
  19647. "stars_disabled": {
  19648. "type": "boolean",
  19649. "x-go-name": "StarsDisabled"
  19650. },
  19651. "time_tracking_disabled": {
  19652. "type": "boolean",
  19653. "x-go-name": "TimeTrackingDisabled"
  19654. }
  19655. },
  19656. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19657. },
  19658. "GeneralUISettings": {
  19659. "description": "GeneralUISettings contains global ui settings exposed by API",
  19660. "type": "object",
  19661. "properties": {
  19662. "allowed_reactions": {
  19663. "type": "array",
  19664. "items": {
  19665. "type": "string"
  19666. },
  19667. "x-go-name": "AllowedReactions"
  19668. },
  19669. "custom_emojis": {
  19670. "type": "array",
  19671. "items": {
  19672. "type": "string"
  19673. },
  19674. "x-go-name": "CustomEmojis"
  19675. },
  19676. "default_theme": {
  19677. "type": "string",
  19678. "x-go-name": "DefaultTheme"
  19679. }
  19680. },
  19681. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19682. },
  19683. "GenerateRepoOption": {
  19684. "description": "GenerateRepoOption options when creating repository using a template",
  19685. "type": "object",
  19686. "required": [
  19687. "owner",
  19688. "name"
  19689. ],
  19690. "properties": {
  19691. "avatar": {
  19692. "description": "include avatar of the template repo",
  19693. "type": "boolean",
  19694. "x-go-name": "Avatar"
  19695. },
  19696. "default_branch": {
  19697. "description": "Default branch of the new repository",
  19698. "type": "string",
  19699. "x-go-name": "DefaultBranch"
  19700. },
  19701. "description": {
  19702. "description": "Description of the repository to create",
  19703. "type": "string",
  19704. "x-go-name": "Description"
  19705. },
  19706. "git_content": {
  19707. "description": "include git content of default branch in template repo",
  19708. "type": "boolean",
  19709. "x-go-name": "GitContent"
  19710. },
  19711. "git_hooks": {
  19712. "description": "include git hooks in template repo",
  19713. "type": "boolean",
  19714. "x-go-name": "GitHooks"
  19715. },
  19716. "labels": {
  19717. "description": "include labels in template repo",
  19718. "type": "boolean",
  19719. "x-go-name": "Labels"
  19720. },
  19721. "name": {
  19722. "description": "Name of the repository to create",
  19723. "type": "string",
  19724. "uniqueItems": true,
  19725. "x-go-name": "Name"
  19726. },
  19727. "owner": {
  19728. "description": "The organization or person who will own the new repository",
  19729. "type": "string",
  19730. "x-go-name": "Owner"
  19731. },
  19732. "private": {
  19733. "description": "Whether the repository is private",
  19734. "type": "boolean",
  19735. "x-go-name": "Private"
  19736. },
  19737. "protected_branch": {
  19738. "description": "include protected branches in template repo",
  19739. "type": "boolean",
  19740. "x-go-name": "ProtectedBranch"
  19741. },
  19742. "topics": {
  19743. "description": "include topics in template repo",
  19744. "type": "boolean",
  19745. "x-go-name": "Topics"
  19746. },
  19747. "webhooks": {
  19748. "description": "include webhooks in template repo",
  19749. "type": "boolean",
  19750. "x-go-name": "Webhooks"
  19751. }
  19752. },
  19753. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19754. },
  19755. "GitBlobResponse": {
  19756. "description": "GitBlobResponse represents a git blob",
  19757. "type": "object",
  19758. "properties": {
  19759. "content": {
  19760. "type": "string",
  19761. "x-go-name": "Content"
  19762. },
  19763. "encoding": {
  19764. "type": "string",
  19765. "x-go-name": "Encoding"
  19766. },
  19767. "sha": {
  19768. "type": "string",
  19769. "x-go-name": "SHA"
  19770. },
  19771. "size": {
  19772. "type": "integer",
  19773. "format": "int64",
  19774. "x-go-name": "Size"
  19775. },
  19776. "url": {
  19777. "type": "string",
  19778. "x-go-name": "URL"
  19779. }
  19780. },
  19781. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19782. },
  19783. "GitEntry": {
  19784. "description": "GitEntry represents a git tree",
  19785. "type": "object",
  19786. "properties": {
  19787. "mode": {
  19788. "type": "string",
  19789. "x-go-name": "Mode"
  19790. },
  19791. "path": {
  19792. "type": "string",
  19793. "x-go-name": "Path"
  19794. },
  19795. "sha": {
  19796. "type": "string",
  19797. "x-go-name": "SHA"
  19798. },
  19799. "size": {
  19800. "type": "integer",
  19801. "format": "int64",
  19802. "x-go-name": "Size"
  19803. },
  19804. "type": {
  19805. "type": "string",
  19806. "x-go-name": "Type"
  19807. },
  19808. "url": {
  19809. "type": "string",
  19810. "x-go-name": "URL"
  19811. }
  19812. },
  19813. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19814. },
  19815. "GitHook": {
  19816. "description": "GitHook represents a Git repository hook",
  19817. "type": "object",
  19818. "properties": {
  19819. "content": {
  19820. "type": "string",
  19821. "x-go-name": "Content"
  19822. },
  19823. "is_active": {
  19824. "type": "boolean",
  19825. "x-go-name": "IsActive"
  19826. },
  19827. "name": {
  19828. "type": "string",
  19829. "x-go-name": "Name"
  19830. }
  19831. },
  19832. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19833. },
  19834. "GitObject": {
  19835. "type": "object",
  19836. "title": "GitObject represents a Git object.",
  19837. "properties": {
  19838. "sha": {
  19839. "type": "string",
  19840. "x-go-name": "SHA"
  19841. },
  19842. "type": {
  19843. "type": "string",
  19844. "x-go-name": "Type"
  19845. },
  19846. "url": {
  19847. "type": "string",
  19848. "x-go-name": "URL"
  19849. }
  19850. },
  19851. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19852. },
  19853. "GitTreeResponse": {
  19854. "description": "GitTreeResponse returns a git tree",
  19855. "type": "object",
  19856. "properties": {
  19857. "page": {
  19858. "type": "integer",
  19859. "format": "int64",
  19860. "x-go-name": "Page"
  19861. },
  19862. "sha": {
  19863. "type": "string",
  19864. "x-go-name": "SHA"
  19865. },
  19866. "total_count": {
  19867. "type": "integer",
  19868. "format": "int64",
  19869. "x-go-name": "TotalCount"
  19870. },
  19871. "tree": {
  19872. "type": "array",
  19873. "items": {
  19874. "$ref": "#/definitions/GitEntry"
  19875. },
  19876. "x-go-name": "Entries"
  19877. },
  19878. "truncated": {
  19879. "type": "boolean",
  19880. "x-go-name": "Truncated"
  19881. },
  19882. "url": {
  19883. "type": "string",
  19884. "x-go-name": "URL"
  19885. }
  19886. },
  19887. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19888. },
  19889. "GitignoreTemplateInfo": {
  19890. "description": "GitignoreTemplateInfo name and text of a gitignore template",
  19891. "type": "object",
  19892. "properties": {
  19893. "name": {
  19894. "type": "string",
  19895. "x-go-name": "Name"
  19896. },
  19897. "source": {
  19898. "type": "string",
  19899. "x-go-name": "Source"
  19900. }
  19901. },
  19902. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19903. },
  19904. "Hook": {
  19905. "description": "Hook a hook is a web hook when one repository changed",
  19906. "type": "object",
  19907. "properties": {
  19908. "active": {
  19909. "type": "boolean",
  19910. "x-go-name": "Active"
  19911. },
  19912. "authorization_header": {
  19913. "type": "string",
  19914. "x-go-name": "AuthorizationHeader"
  19915. },
  19916. "branch_filter": {
  19917. "type": "string",
  19918. "x-go-name": "BranchFilter"
  19919. },
  19920. "config": {
  19921. "type": "object",
  19922. "additionalProperties": {
  19923. "type": "string"
  19924. },
  19925. "x-go-name": "Config"
  19926. },
  19927. "created_at": {
  19928. "type": "string",
  19929. "format": "date-time",
  19930. "x-go-name": "Created"
  19931. },
  19932. "events": {
  19933. "type": "array",
  19934. "items": {
  19935. "type": "string"
  19936. },
  19937. "x-go-name": "Events"
  19938. },
  19939. "id": {
  19940. "type": "integer",
  19941. "format": "int64",
  19942. "x-go-name": "ID"
  19943. },
  19944. "type": {
  19945. "type": "string",
  19946. "x-go-name": "Type"
  19947. },
  19948. "updated_at": {
  19949. "type": "string",
  19950. "format": "date-time",
  19951. "x-go-name": "Updated"
  19952. }
  19953. },
  19954. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19955. },
  19956. "Identity": {
  19957. "description": "Identity for a person's identity like an author or committer",
  19958. "type": "object",
  19959. "properties": {
  19960. "email": {
  19961. "type": "string",
  19962. "format": "email",
  19963. "x-go-name": "Email"
  19964. },
  19965. "name": {
  19966. "type": "string",
  19967. "x-go-name": "Name"
  19968. }
  19969. },
  19970. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19971. },
  19972. "InternalTracker": {
  19973. "description": "InternalTracker represents settings for internal tracker",
  19974. "type": "object",
  19975. "properties": {
  19976. "allow_only_contributors_to_track_time": {
  19977. "description": "Let only contributors track time (Built-in issue tracker)",
  19978. "type": "boolean",
  19979. "x-go-name": "AllowOnlyContributorsToTrackTime"
  19980. },
  19981. "enable_issue_dependencies": {
  19982. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  19983. "type": "boolean",
  19984. "x-go-name": "EnableIssueDependencies"
  19985. },
  19986. "enable_time_tracker": {
  19987. "description": "Enable time tracking (Built-in issue tracker)",
  19988. "type": "boolean",
  19989. "x-go-name": "EnableTimeTracker"
  19990. }
  19991. },
  19992. "x-go-package": "code.gitea.io/gitea/modules/structs"
  19993. },
  19994. "Issue": {
  19995. "description": "Issue represents an issue in a repository",
  19996. "type": "object",
  19997. "properties": {
  19998. "assets": {
  19999. "type": "array",
  20000. "items": {
  20001. "$ref": "#/definitions/Attachment"
  20002. },
  20003. "x-go-name": "Attachments"
  20004. },
  20005. "assignee": {
  20006. "$ref": "#/definitions/User"
  20007. },
  20008. "assignees": {
  20009. "type": "array",
  20010. "items": {
  20011. "$ref": "#/definitions/User"
  20012. },
  20013. "x-go-name": "Assignees"
  20014. },
  20015. "body": {
  20016. "type": "string",
  20017. "x-go-name": "Body"
  20018. },
  20019. "closed_at": {
  20020. "type": "string",
  20021. "format": "date-time",
  20022. "x-go-name": "Closed"
  20023. },
  20024. "comments": {
  20025. "type": "integer",
  20026. "format": "int64",
  20027. "x-go-name": "Comments"
  20028. },
  20029. "created_at": {
  20030. "type": "string",
  20031. "format": "date-time",
  20032. "x-go-name": "Created"
  20033. },
  20034. "due_date": {
  20035. "type": "string",
  20036. "format": "date-time",
  20037. "x-go-name": "Deadline"
  20038. },
  20039. "html_url": {
  20040. "type": "string",
  20041. "x-go-name": "HTMLURL"
  20042. },
  20043. "id": {
  20044. "type": "integer",
  20045. "format": "int64",
  20046. "x-go-name": "ID"
  20047. },
  20048. "is_locked": {
  20049. "type": "boolean",
  20050. "x-go-name": "IsLocked"
  20051. },
  20052. "labels": {
  20053. "type": "array",
  20054. "items": {
  20055. "$ref": "#/definitions/Label"
  20056. },
  20057. "x-go-name": "Labels"
  20058. },
  20059. "milestone": {
  20060. "$ref": "#/definitions/Milestone"
  20061. },
  20062. "number": {
  20063. "type": "integer",
  20064. "format": "int64",
  20065. "x-go-name": "Index"
  20066. },
  20067. "original_author": {
  20068. "type": "string",
  20069. "x-go-name": "OriginalAuthor"
  20070. },
  20071. "original_author_id": {
  20072. "type": "integer",
  20073. "format": "int64",
  20074. "x-go-name": "OriginalAuthorID"
  20075. },
  20076. "pin_order": {
  20077. "type": "integer",
  20078. "format": "int64",
  20079. "x-go-name": "PinOrder"
  20080. },
  20081. "pull_request": {
  20082. "$ref": "#/definitions/PullRequestMeta"
  20083. },
  20084. "ref": {
  20085. "type": "string",
  20086. "x-go-name": "Ref"
  20087. },
  20088. "repository": {
  20089. "$ref": "#/definitions/RepositoryMeta"
  20090. },
  20091. "state": {
  20092. "$ref": "#/definitions/StateType"
  20093. },
  20094. "title": {
  20095. "type": "string",
  20096. "x-go-name": "Title"
  20097. },
  20098. "updated_at": {
  20099. "type": "string",
  20100. "format": "date-time",
  20101. "x-go-name": "Updated"
  20102. },
  20103. "url": {
  20104. "type": "string",
  20105. "x-go-name": "URL"
  20106. },
  20107. "user": {
  20108. "$ref": "#/definitions/User"
  20109. }
  20110. },
  20111. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20112. },
  20113. "IssueConfig": {
  20114. "type": "object",
  20115. "properties": {
  20116. "blank_issues_enabled": {
  20117. "type": "boolean",
  20118. "x-go-name": "BlankIssuesEnabled"
  20119. },
  20120. "contact_links": {
  20121. "type": "array",
  20122. "items": {
  20123. "$ref": "#/definitions/IssueConfigContactLink"
  20124. },
  20125. "x-go-name": "ContactLinks"
  20126. }
  20127. },
  20128. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20129. },
  20130. "IssueConfigContactLink": {
  20131. "type": "object",
  20132. "properties": {
  20133. "about": {
  20134. "type": "string",
  20135. "x-go-name": "About"
  20136. },
  20137. "name": {
  20138. "type": "string",
  20139. "x-go-name": "Name"
  20140. },
  20141. "url": {
  20142. "type": "string",
  20143. "x-go-name": "URL"
  20144. }
  20145. },
  20146. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20147. },
  20148. "IssueConfigValidation": {
  20149. "type": "object",
  20150. "properties": {
  20151. "message": {
  20152. "type": "string",
  20153. "x-go-name": "Message"
  20154. },
  20155. "valid": {
  20156. "type": "boolean",
  20157. "x-go-name": "Valid"
  20158. }
  20159. },
  20160. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20161. },
  20162. "IssueDeadline": {
  20163. "description": "IssueDeadline represents an issue deadline",
  20164. "type": "object",
  20165. "properties": {
  20166. "due_date": {
  20167. "type": "string",
  20168. "format": "date-time",
  20169. "x-go-name": "Deadline"
  20170. }
  20171. },
  20172. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20173. },
  20174. "IssueFormField": {
  20175. "description": "IssueFormField represents a form field",
  20176. "type": "object",
  20177. "properties": {
  20178. "attributes": {
  20179. "type": "object",
  20180. "additionalProperties": {},
  20181. "x-go-name": "Attributes"
  20182. },
  20183. "id": {
  20184. "type": "string",
  20185. "x-go-name": "ID"
  20186. },
  20187. "type": {
  20188. "$ref": "#/definitions/IssueFormFieldType"
  20189. },
  20190. "validations": {
  20191. "type": "object",
  20192. "additionalProperties": {},
  20193. "x-go-name": "Validations"
  20194. }
  20195. },
  20196. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20197. },
  20198. "IssueFormFieldType": {
  20199. "type": "string",
  20200. "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
  20201. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20202. },
  20203. "IssueLabelsOption": {
  20204. "description": "IssueLabelsOption a collection of labels",
  20205. "type": "object",
  20206. "properties": {
  20207. "labels": {
  20208. "description": "list of label IDs",
  20209. "type": "array",
  20210. "items": {
  20211. "type": "integer",
  20212. "format": "int64"
  20213. },
  20214. "x-go-name": "Labels"
  20215. }
  20216. },
  20217. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20218. },
  20219. "IssueMeta": {
  20220. "description": "IssueMeta basic issue information",
  20221. "type": "object",
  20222. "properties": {
  20223. "index": {
  20224. "type": "integer",
  20225. "format": "int64",
  20226. "x-go-name": "Index"
  20227. },
  20228. "owner": {
  20229. "type": "string",
  20230. "x-go-name": "Owner"
  20231. },
  20232. "repo": {
  20233. "type": "string",
  20234. "x-go-name": "Name"
  20235. }
  20236. },
  20237. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20238. },
  20239. "IssueTemplate": {
  20240. "description": "IssueTemplate represents an issue template for a repository",
  20241. "type": "object",
  20242. "properties": {
  20243. "about": {
  20244. "type": "string",
  20245. "x-go-name": "About"
  20246. },
  20247. "body": {
  20248. "type": "array",
  20249. "items": {
  20250. "$ref": "#/definitions/IssueFormField"
  20251. },
  20252. "x-go-name": "Fields"
  20253. },
  20254. "content": {
  20255. "type": "string",
  20256. "x-go-name": "Content"
  20257. },
  20258. "file_name": {
  20259. "type": "string",
  20260. "x-go-name": "FileName"
  20261. },
  20262. "labels": {
  20263. "$ref": "#/definitions/IssueTemplateLabels"
  20264. },
  20265. "name": {
  20266. "type": "string",
  20267. "x-go-name": "Name"
  20268. },
  20269. "ref": {
  20270. "type": "string",
  20271. "x-go-name": "Ref"
  20272. },
  20273. "title": {
  20274. "type": "string",
  20275. "x-go-name": "Title"
  20276. }
  20277. },
  20278. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20279. },
  20280. "IssueTemplateLabels": {
  20281. "type": "array",
  20282. "items": {
  20283. "type": "string"
  20284. },
  20285. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20286. },
  20287. "Label": {
  20288. "description": "Label a label to an issue or a pr",
  20289. "type": "object",
  20290. "properties": {
  20291. "color": {
  20292. "type": "string",
  20293. "x-go-name": "Color",
  20294. "example": "00aabb"
  20295. },
  20296. "description": {
  20297. "type": "string",
  20298. "x-go-name": "Description"
  20299. },
  20300. "exclusive": {
  20301. "type": "boolean",
  20302. "x-go-name": "Exclusive",
  20303. "example": false
  20304. },
  20305. "id": {
  20306. "type": "integer",
  20307. "format": "int64",
  20308. "x-go-name": "ID"
  20309. },
  20310. "is_archived": {
  20311. "type": "boolean",
  20312. "x-go-name": "IsArchived",
  20313. "example": false
  20314. },
  20315. "name": {
  20316. "type": "string",
  20317. "x-go-name": "Name"
  20318. },
  20319. "url": {
  20320. "type": "string",
  20321. "x-go-name": "URL"
  20322. }
  20323. },
  20324. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20325. },
  20326. "LabelTemplate": {
  20327. "description": "LabelTemplate info of a Label template",
  20328. "type": "object",
  20329. "properties": {
  20330. "color": {
  20331. "type": "string",
  20332. "x-go-name": "Color",
  20333. "example": "00aabb"
  20334. },
  20335. "description": {
  20336. "type": "string",
  20337. "x-go-name": "Description"
  20338. },
  20339. "exclusive": {
  20340. "type": "boolean",
  20341. "x-go-name": "Exclusive",
  20342. "example": false
  20343. },
  20344. "name": {
  20345. "type": "string",
  20346. "x-go-name": "Name"
  20347. }
  20348. },
  20349. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20350. },
  20351. "LicenseTemplateInfo": {
  20352. "description": "LicensesInfo contains information about a License",
  20353. "type": "object",
  20354. "properties": {
  20355. "body": {
  20356. "type": "string",
  20357. "x-go-name": "Body"
  20358. },
  20359. "implementation": {
  20360. "type": "string",
  20361. "x-go-name": "Implementation"
  20362. },
  20363. "key": {
  20364. "type": "string",
  20365. "x-go-name": "Key"
  20366. },
  20367. "name": {
  20368. "type": "string",
  20369. "x-go-name": "Name"
  20370. },
  20371. "url": {
  20372. "type": "string",
  20373. "x-go-name": "URL"
  20374. }
  20375. },
  20376. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20377. },
  20378. "LicensesTemplateListEntry": {
  20379. "description": "LicensesListEntry is used for the API",
  20380. "type": "object",
  20381. "properties": {
  20382. "key": {
  20383. "type": "string",
  20384. "x-go-name": "Key"
  20385. },
  20386. "name": {
  20387. "type": "string",
  20388. "x-go-name": "Name"
  20389. },
  20390. "url": {
  20391. "type": "string",
  20392. "x-go-name": "URL"
  20393. }
  20394. },
  20395. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20396. },
  20397. "MarkdownOption": {
  20398. "description": "MarkdownOption markdown options",
  20399. "type": "object",
  20400. "properties": {
  20401. "Context": {
  20402. "description": "Context to render\n\nin: body",
  20403. "type": "string"
  20404. },
  20405. "Mode": {
  20406. "description": "Mode to render (comment, gfm, markdown)\n\nin: body",
  20407. "type": "string"
  20408. },
  20409. "Text": {
  20410. "description": "Text markdown to render\n\nin: body",
  20411. "type": "string"
  20412. },
  20413. "Wiki": {
  20414. "description": "Is it a wiki page ?\n\nin: body",
  20415. "type": "boolean"
  20416. }
  20417. },
  20418. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20419. },
  20420. "MarkupOption": {
  20421. "description": "MarkupOption markup options",
  20422. "type": "object",
  20423. "properties": {
  20424. "Context": {
  20425. "description": "Context to render\n\nin: body",
  20426. "type": "string"
  20427. },
  20428. "FilePath": {
  20429. "description": "File path for detecting extension in file mode\n\nin: body",
  20430. "type": "string"
  20431. },
  20432. "Mode": {
  20433. "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body",
  20434. "type": "string"
  20435. },
  20436. "Text": {
  20437. "description": "Text markup to render\n\nin: body",
  20438. "type": "string"
  20439. },
  20440. "Wiki": {
  20441. "description": "Is it a wiki page ?\n\nin: body",
  20442. "type": "boolean"
  20443. }
  20444. },
  20445. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20446. },
  20447. "MergePullRequestOption": {
  20448. "description": "MergePullRequestForm form for merging Pull Request",
  20449. "type": "object",
  20450. "required": [
  20451. "Do"
  20452. ],
  20453. "properties": {
  20454. "Do": {
  20455. "type": "string",
  20456. "enum": [
  20457. "merge",
  20458. "rebase",
  20459. "rebase-merge",
  20460. "squash",
  20461. "manually-merged"
  20462. ]
  20463. },
  20464. "MergeCommitID": {
  20465. "type": "string"
  20466. },
  20467. "MergeMessageField": {
  20468. "type": "string"
  20469. },
  20470. "MergeTitleField": {
  20471. "type": "string"
  20472. },
  20473. "delete_branch_after_merge": {
  20474. "type": "boolean",
  20475. "x-go-name": "DeleteBranchAfterMerge"
  20476. },
  20477. "force_merge": {
  20478. "type": "boolean",
  20479. "x-go-name": "ForceMerge"
  20480. },
  20481. "head_commit_id": {
  20482. "type": "string",
  20483. "x-go-name": "HeadCommitID"
  20484. },
  20485. "merge_when_checks_succeed": {
  20486. "type": "boolean",
  20487. "x-go-name": "MergeWhenChecksSucceed"
  20488. }
  20489. },
  20490. "x-go-name": "MergePullRequestForm",
  20491. "x-go-package": "code.gitea.io/gitea/services/forms"
  20492. },
  20493. "MigrateRepoOptions": {
  20494. "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
  20495. "type": "object",
  20496. "required": [
  20497. "clone_addr",
  20498. "repo_name"
  20499. ],
  20500. "properties": {
  20501. "auth_password": {
  20502. "type": "string",
  20503. "x-go-name": "AuthPassword"
  20504. },
  20505. "auth_token": {
  20506. "type": "string",
  20507. "x-go-name": "AuthToken"
  20508. },
  20509. "auth_username": {
  20510. "type": "string",
  20511. "x-go-name": "AuthUsername"
  20512. },
  20513. "clone_addr": {
  20514. "type": "string",
  20515. "x-go-name": "CloneAddr"
  20516. },
  20517. "description": {
  20518. "type": "string",
  20519. "x-go-name": "Description"
  20520. },
  20521. "issues": {
  20522. "type": "boolean",
  20523. "x-go-name": "Issues"
  20524. },
  20525. "labels": {
  20526. "type": "boolean",
  20527. "x-go-name": "Labels"
  20528. },
  20529. "lfs": {
  20530. "type": "boolean",
  20531. "x-go-name": "LFS"
  20532. },
  20533. "lfs_endpoint": {
  20534. "type": "string",
  20535. "x-go-name": "LFSEndpoint"
  20536. },
  20537. "milestones": {
  20538. "type": "boolean",
  20539. "x-go-name": "Milestones"
  20540. },
  20541. "mirror": {
  20542. "type": "boolean",
  20543. "x-go-name": "Mirror"
  20544. },
  20545. "mirror_interval": {
  20546. "type": "string",
  20547. "x-go-name": "MirrorInterval"
  20548. },
  20549. "private": {
  20550. "type": "boolean",
  20551. "x-go-name": "Private"
  20552. },
  20553. "pull_requests": {
  20554. "type": "boolean",
  20555. "x-go-name": "PullRequests"
  20556. },
  20557. "releases": {
  20558. "type": "boolean",
  20559. "x-go-name": "Releases"
  20560. },
  20561. "repo_name": {
  20562. "type": "string",
  20563. "x-go-name": "RepoName"
  20564. },
  20565. "repo_owner": {
  20566. "description": "Name of User or Organisation who will own Repo after migration",
  20567. "type": "string",
  20568. "x-go-name": "RepoOwner"
  20569. },
  20570. "service": {
  20571. "type": "string",
  20572. "enum": [
  20573. "git",
  20574. "github",
  20575. "gitea",
  20576. "gitlab",
  20577. "gogs",
  20578. "onedev",
  20579. "gitbucket",
  20580. "codebase"
  20581. ],
  20582. "x-go-name": "Service"
  20583. },
  20584. "uid": {
  20585. "description": "deprecated (only for backwards compatibility)",
  20586. "type": "integer",
  20587. "format": "int64",
  20588. "x-go-name": "RepoOwnerID"
  20589. },
  20590. "wiki": {
  20591. "type": "boolean",
  20592. "x-go-name": "Wiki"
  20593. }
  20594. },
  20595. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20596. },
  20597. "Milestone": {
  20598. "description": "Milestone milestone is a collection of issues on one repository",
  20599. "type": "object",
  20600. "properties": {
  20601. "closed_at": {
  20602. "type": "string",
  20603. "format": "date-time",
  20604. "x-go-name": "Closed"
  20605. },
  20606. "closed_issues": {
  20607. "type": "integer",
  20608. "format": "int64",
  20609. "x-go-name": "ClosedIssues"
  20610. },
  20611. "created_at": {
  20612. "type": "string",
  20613. "format": "date-time",
  20614. "x-go-name": "Created"
  20615. },
  20616. "description": {
  20617. "type": "string",
  20618. "x-go-name": "Description"
  20619. },
  20620. "due_on": {
  20621. "type": "string",
  20622. "format": "date-time",
  20623. "x-go-name": "Deadline"
  20624. },
  20625. "id": {
  20626. "type": "integer",
  20627. "format": "int64",
  20628. "x-go-name": "ID"
  20629. },
  20630. "open_issues": {
  20631. "type": "integer",
  20632. "format": "int64",
  20633. "x-go-name": "OpenIssues"
  20634. },
  20635. "state": {
  20636. "$ref": "#/definitions/StateType"
  20637. },
  20638. "title": {
  20639. "type": "string",
  20640. "x-go-name": "Title"
  20641. },
  20642. "updated_at": {
  20643. "type": "string",
  20644. "format": "date-time",
  20645. "x-go-name": "Updated"
  20646. }
  20647. },
  20648. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20649. },
  20650. "NewIssuePinsAllowed": {
  20651. "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed",
  20652. "type": "object",
  20653. "properties": {
  20654. "issues": {
  20655. "type": "boolean",
  20656. "x-go-name": "Issues"
  20657. },
  20658. "pull_requests": {
  20659. "type": "boolean",
  20660. "x-go-name": "PullRequests"
  20661. }
  20662. },
  20663. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20664. },
  20665. "NodeInfo": {
  20666. "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
  20667. "type": "object",
  20668. "properties": {
  20669. "metadata": {
  20670. "type": "object",
  20671. "x-go-name": "Metadata"
  20672. },
  20673. "openRegistrations": {
  20674. "type": "boolean",
  20675. "x-go-name": "OpenRegistrations"
  20676. },
  20677. "protocols": {
  20678. "type": "array",
  20679. "items": {
  20680. "type": "string"
  20681. },
  20682. "x-go-name": "Protocols"
  20683. },
  20684. "services": {
  20685. "$ref": "#/definitions/NodeInfoServices"
  20686. },
  20687. "software": {
  20688. "$ref": "#/definitions/NodeInfoSoftware"
  20689. },
  20690. "usage": {
  20691. "$ref": "#/definitions/NodeInfoUsage"
  20692. },
  20693. "version": {
  20694. "type": "string",
  20695. "x-go-name": "Version"
  20696. }
  20697. },
  20698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20699. },
  20700. "NodeInfoServices": {
  20701. "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
  20702. "type": "object",
  20703. "properties": {
  20704. "inbound": {
  20705. "type": "array",
  20706. "items": {
  20707. "type": "string"
  20708. },
  20709. "x-go-name": "Inbound"
  20710. },
  20711. "outbound": {
  20712. "type": "array",
  20713. "items": {
  20714. "type": "string"
  20715. },
  20716. "x-go-name": "Outbound"
  20717. }
  20718. },
  20719. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20720. },
  20721. "NodeInfoSoftware": {
  20722. "description": "NodeInfoSoftware contains Metadata about server software in use",
  20723. "type": "object",
  20724. "properties": {
  20725. "homepage": {
  20726. "type": "string",
  20727. "x-go-name": "Homepage"
  20728. },
  20729. "name": {
  20730. "type": "string",
  20731. "x-go-name": "Name"
  20732. },
  20733. "repository": {
  20734. "type": "string",
  20735. "x-go-name": "Repository"
  20736. },
  20737. "version": {
  20738. "type": "string",
  20739. "x-go-name": "Version"
  20740. }
  20741. },
  20742. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20743. },
  20744. "NodeInfoUsage": {
  20745. "description": "NodeInfoUsage contains usage statistics for this server",
  20746. "type": "object",
  20747. "properties": {
  20748. "localComments": {
  20749. "type": "integer",
  20750. "format": "int64",
  20751. "x-go-name": "LocalComments"
  20752. },
  20753. "localPosts": {
  20754. "type": "integer",
  20755. "format": "int64",
  20756. "x-go-name": "LocalPosts"
  20757. },
  20758. "users": {
  20759. "$ref": "#/definitions/NodeInfoUsageUsers"
  20760. }
  20761. },
  20762. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20763. },
  20764. "NodeInfoUsageUsers": {
  20765. "description": "NodeInfoUsageUsers contains statistics about the users of this server",
  20766. "type": "object",
  20767. "properties": {
  20768. "activeHalfyear": {
  20769. "type": "integer",
  20770. "format": "int64",
  20771. "x-go-name": "ActiveHalfyear"
  20772. },
  20773. "activeMonth": {
  20774. "type": "integer",
  20775. "format": "int64",
  20776. "x-go-name": "ActiveMonth"
  20777. },
  20778. "total": {
  20779. "type": "integer",
  20780. "format": "int64",
  20781. "x-go-name": "Total"
  20782. }
  20783. },
  20784. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20785. },
  20786. "Note": {
  20787. "description": "Note contains information related to a git note",
  20788. "type": "object",
  20789. "properties": {
  20790. "commit": {
  20791. "$ref": "#/definitions/Commit"
  20792. },
  20793. "message": {
  20794. "type": "string",
  20795. "x-go-name": "Message"
  20796. }
  20797. },
  20798. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20799. },
  20800. "NotificationCount": {
  20801. "description": "NotificationCount number of unread notifications",
  20802. "type": "object",
  20803. "properties": {
  20804. "new": {
  20805. "type": "integer",
  20806. "format": "int64",
  20807. "x-go-name": "New"
  20808. }
  20809. },
  20810. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20811. },
  20812. "NotificationSubject": {
  20813. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  20814. "type": "object",
  20815. "properties": {
  20816. "html_url": {
  20817. "type": "string",
  20818. "x-go-name": "HTMLURL"
  20819. },
  20820. "latest_comment_html_url": {
  20821. "type": "string",
  20822. "x-go-name": "LatestCommentHTMLURL"
  20823. },
  20824. "latest_comment_url": {
  20825. "type": "string",
  20826. "x-go-name": "LatestCommentURL"
  20827. },
  20828. "state": {
  20829. "$ref": "#/definitions/StateType"
  20830. },
  20831. "title": {
  20832. "type": "string",
  20833. "x-go-name": "Title"
  20834. },
  20835. "type": {
  20836. "$ref": "#/definitions/NotifySubjectType"
  20837. },
  20838. "url": {
  20839. "type": "string",
  20840. "x-go-name": "URL"
  20841. }
  20842. },
  20843. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20844. },
  20845. "NotificationThread": {
  20846. "description": "NotificationThread expose Notification on API",
  20847. "type": "object",
  20848. "properties": {
  20849. "id": {
  20850. "type": "integer",
  20851. "format": "int64",
  20852. "x-go-name": "ID"
  20853. },
  20854. "pinned": {
  20855. "type": "boolean",
  20856. "x-go-name": "Pinned"
  20857. },
  20858. "repository": {
  20859. "$ref": "#/definitions/Repository"
  20860. },
  20861. "subject": {
  20862. "$ref": "#/definitions/NotificationSubject"
  20863. },
  20864. "unread": {
  20865. "type": "boolean",
  20866. "x-go-name": "Unread"
  20867. },
  20868. "updated_at": {
  20869. "type": "string",
  20870. "format": "date-time",
  20871. "x-go-name": "UpdatedAt"
  20872. },
  20873. "url": {
  20874. "type": "string",
  20875. "x-go-name": "URL"
  20876. }
  20877. },
  20878. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20879. },
  20880. "NotifySubjectType": {
  20881. "description": "NotifySubjectType represent type of notification subject",
  20882. "type": "string",
  20883. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20884. },
  20885. "OAuth2Application": {
  20886. "type": "object",
  20887. "title": "OAuth2Application represents an OAuth2 application.",
  20888. "properties": {
  20889. "client_id": {
  20890. "type": "string",
  20891. "x-go-name": "ClientID"
  20892. },
  20893. "client_secret": {
  20894. "type": "string",
  20895. "x-go-name": "ClientSecret"
  20896. },
  20897. "confidential_client": {
  20898. "type": "boolean",
  20899. "x-go-name": "ConfidentialClient"
  20900. },
  20901. "created": {
  20902. "type": "string",
  20903. "format": "date-time",
  20904. "x-go-name": "Created"
  20905. },
  20906. "id": {
  20907. "type": "integer",
  20908. "format": "int64",
  20909. "x-go-name": "ID"
  20910. },
  20911. "name": {
  20912. "type": "string",
  20913. "x-go-name": "Name"
  20914. },
  20915. "redirect_uris": {
  20916. "type": "array",
  20917. "items": {
  20918. "type": "string"
  20919. },
  20920. "x-go-name": "RedirectURIs"
  20921. }
  20922. },
  20923. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20924. },
  20925. "Organization": {
  20926. "description": "Organization represents an organization",
  20927. "type": "object",
  20928. "properties": {
  20929. "avatar_url": {
  20930. "type": "string",
  20931. "x-go-name": "AvatarURL"
  20932. },
  20933. "description": {
  20934. "type": "string",
  20935. "x-go-name": "Description"
  20936. },
  20937. "email": {
  20938. "type": "string",
  20939. "x-go-name": "Email"
  20940. },
  20941. "full_name": {
  20942. "type": "string",
  20943. "x-go-name": "FullName"
  20944. },
  20945. "id": {
  20946. "type": "integer",
  20947. "format": "int64",
  20948. "x-go-name": "ID"
  20949. },
  20950. "location": {
  20951. "type": "string",
  20952. "x-go-name": "Location"
  20953. },
  20954. "name": {
  20955. "type": "string",
  20956. "x-go-name": "Name"
  20957. },
  20958. "repo_admin_change_team_access": {
  20959. "type": "boolean",
  20960. "x-go-name": "RepoAdminChangeTeamAccess"
  20961. },
  20962. "username": {
  20963. "description": "deprecated",
  20964. "type": "string",
  20965. "x-go-name": "UserName"
  20966. },
  20967. "visibility": {
  20968. "type": "string",
  20969. "x-go-name": "Visibility"
  20970. },
  20971. "website": {
  20972. "type": "string",
  20973. "x-go-name": "Website"
  20974. }
  20975. },
  20976. "x-go-package": "code.gitea.io/gitea/modules/structs"
  20977. },
  20978. "OrganizationPermissions": {
  20979. "description": "OrganizationPermissions list different users permissions on an organization",
  20980. "type": "object",
  20981. "properties": {
  20982. "can_create_repository": {
  20983. "type": "boolean",
  20984. "x-go-name": "CanCreateRepository"
  20985. },
  20986. "can_read": {
  20987. "type": "boolean",
  20988. "x-go-name": "CanRead"
  20989. },
  20990. "can_write": {
  20991. "type": "boolean",
  20992. "x-go-name": "CanWrite"
  20993. },
  20994. "is_admin": {
  20995. "type": "boolean",
  20996. "x-go-name": "IsAdmin"
  20997. },
  20998. "is_owner": {
  20999. "type": "boolean",
  21000. "x-go-name": "IsOwner"
  21001. }
  21002. },
  21003. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21004. },
  21005. "PRBranchInfo": {
  21006. "description": "PRBranchInfo information about a branch",
  21007. "type": "object",
  21008. "properties": {
  21009. "label": {
  21010. "type": "string",
  21011. "x-go-name": "Name"
  21012. },
  21013. "ref": {
  21014. "type": "string",
  21015. "x-go-name": "Ref"
  21016. },
  21017. "repo": {
  21018. "$ref": "#/definitions/Repository"
  21019. },
  21020. "repo_id": {
  21021. "type": "integer",
  21022. "format": "int64",
  21023. "x-go-name": "RepoID"
  21024. },
  21025. "sha": {
  21026. "type": "string",
  21027. "x-go-name": "Sha"
  21028. }
  21029. },
  21030. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21031. },
  21032. "Package": {
  21033. "description": "Package represents a package",
  21034. "type": "object",
  21035. "properties": {
  21036. "created_at": {
  21037. "type": "string",
  21038. "format": "date-time",
  21039. "x-go-name": "CreatedAt"
  21040. },
  21041. "creator": {
  21042. "$ref": "#/definitions/User"
  21043. },
  21044. "html_url": {
  21045. "type": "string",
  21046. "x-go-name": "HTMLURL"
  21047. },
  21048. "id": {
  21049. "type": "integer",
  21050. "format": "int64",
  21051. "x-go-name": "ID"
  21052. },
  21053. "name": {
  21054. "type": "string",
  21055. "x-go-name": "Name"
  21056. },
  21057. "owner": {
  21058. "$ref": "#/definitions/User"
  21059. },
  21060. "repository": {
  21061. "$ref": "#/definitions/Repository"
  21062. },
  21063. "type": {
  21064. "type": "string",
  21065. "x-go-name": "Type"
  21066. },
  21067. "version": {
  21068. "type": "string",
  21069. "x-go-name": "Version"
  21070. }
  21071. },
  21072. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21073. },
  21074. "PackageFile": {
  21075. "description": "PackageFile represents a package file",
  21076. "type": "object",
  21077. "properties": {
  21078. "Size": {
  21079. "type": "integer",
  21080. "format": "int64"
  21081. },
  21082. "id": {
  21083. "type": "integer",
  21084. "format": "int64",
  21085. "x-go-name": "ID"
  21086. },
  21087. "md5": {
  21088. "type": "string",
  21089. "x-go-name": "HashMD5"
  21090. },
  21091. "name": {
  21092. "type": "string",
  21093. "x-go-name": "Name"
  21094. },
  21095. "sha1": {
  21096. "type": "string",
  21097. "x-go-name": "HashSHA1"
  21098. },
  21099. "sha256": {
  21100. "type": "string",
  21101. "x-go-name": "HashSHA256"
  21102. },
  21103. "sha512": {
  21104. "type": "string",
  21105. "x-go-name": "HashSHA512"
  21106. }
  21107. },
  21108. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21109. },
  21110. "PayloadCommit": {
  21111. "description": "PayloadCommit represents a commit",
  21112. "type": "object",
  21113. "properties": {
  21114. "added": {
  21115. "type": "array",
  21116. "items": {
  21117. "type": "string"
  21118. },
  21119. "x-go-name": "Added"
  21120. },
  21121. "author": {
  21122. "$ref": "#/definitions/PayloadUser"
  21123. },
  21124. "committer": {
  21125. "$ref": "#/definitions/PayloadUser"
  21126. },
  21127. "id": {
  21128. "description": "sha1 hash of the commit",
  21129. "type": "string",
  21130. "x-go-name": "ID"
  21131. },
  21132. "message": {
  21133. "type": "string",
  21134. "x-go-name": "Message"
  21135. },
  21136. "modified": {
  21137. "type": "array",
  21138. "items": {
  21139. "type": "string"
  21140. },
  21141. "x-go-name": "Modified"
  21142. },
  21143. "removed": {
  21144. "type": "array",
  21145. "items": {
  21146. "type": "string"
  21147. },
  21148. "x-go-name": "Removed"
  21149. },
  21150. "timestamp": {
  21151. "type": "string",
  21152. "format": "date-time",
  21153. "x-go-name": "Timestamp"
  21154. },
  21155. "url": {
  21156. "type": "string",
  21157. "x-go-name": "URL"
  21158. },
  21159. "verification": {
  21160. "$ref": "#/definitions/PayloadCommitVerification"
  21161. }
  21162. },
  21163. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21164. },
  21165. "PayloadCommitVerification": {
  21166. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  21167. "type": "object",
  21168. "properties": {
  21169. "payload": {
  21170. "type": "string",
  21171. "x-go-name": "Payload"
  21172. },
  21173. "reason": {
  21174. "type": "string",
  21175. "x-go-name": "Reason"
  21176. },
  21177. "signature": {
  21178. "type": "string",
  21179. "x-go-name": "Signature"
  21180. },
  21181. "signer": {
  21182. "$ref": "#/definitions/PayloadUser"
  21183. },
  21184. "verified": {
  21185. "type": "boolean",
  21186. "x-go-name": "Verified"
  21187. }
  21188. },
  21189. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21190. },
  21191. "PayloadUser": {
  21192. "description": "PayloadUser represents the author or committer of a commit",
  21193. "type": "object",
  21194. "properties": {
  21195. "email": {
  21196. "type": "string",
  21197. "format": "email",
  21198. "x-go-name": "Email"
  21199. },
  21200. "name": {
  21201. "description": "Full name of the commit author",
  21202. "type": "string",
  21203. "x-go-name": "Name"
  21204. },
  21205. "username": {
  21206. "type": "string",
  21207. "x-go-name": "UserName"
  21208. }
  21209. },
  21210. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21211. },
  21212. "Permission": {
  21213. "description": "Permission represents a set of permissions",
  21214. "type": "object",
  21215. "properties": {
  21216. "admin": {
  21217. "type": "boolean",
  21218. "x-go-name": "Admin"
  21219. },
  21220. "pull": {
  21221. "type": "boolean",
  21222. "x-go-name": "Pull"
  21223. },
  21224. "push": {
  21225. "type": "boolean",
  21226. "x-go-name": "Push"
  21227. }
  21228. },
  21229. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21230. },
  21231. "PublicKey": {
  21232. "description": "PublicKey publickey is a user key to push code to repository",
  21233. "type": "object",
  21234. "properties": {
  21235. "created_at": {
  21236. "type": "string",
  21237. "format": "date-time",
  21238. "x-go-name": "Created"
  21239. },
  21240. "fingerprint": {
  21241. "type": "string",
  21242. "x-go-name": "Fingerprint"
  21243. },
  21244. "id": {
  21245. "type": "integer",
  21246. "format": "int64",
  21247. "x-go-name": "ID"
  21248. },
  21249. "key": {
  21250. "type": "string",
  21251. "x-go-name": "Key"
  21252. },
  21253. "key_type": {
  21254. "type": "string",
  21255. "x-go-name": "KeyType"
  21256. },
  21257. "read_only": {
  21258. "type": "boolean",
  21259. "x-go-name": "ReadOnly"
  21260. },
  21261. "title": {
  21262. "type": "string",
  21263. "x-go-name": "Title"
  21264. },
  21265. "url": {
  21266. "type": "string",
  21267. "x-go-name": "URL"
  21268. },
  21269. "user": {
  21270. "$ref": "#/definitions/User"
  21271. }
  21272. },
  21273. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21274. },
  21275. "PullRequest": {
  21276. "description": "PullRequest represents a pull request",
  21277. "type": "object",
  21278. "properties": {
  21279. "allow_maintainer_edit": {
  21280. "type": "boolean",
  21281. "x-go-name": "AllowMaintainerEdit"
  21282. },
  21283. "assignee": {
  21284. "$ref": "#/definitions/User"
  21285. },
  21286. "assignees": {
  21287. "type": "array",
  21288. "items": {
  21289. "$ref": "#/definitions/User"
  21290. },
  21291. "x-go-name": "Assignees"
  21292. },
  21293. "base": {
  21294. "$ref": "#/definitions/PRBranchInfo"
  21295. },
  21296. "body": {
  21297. "type": "string",
  21298. "x-go-name": "Body"
  21299. },
  21300. "closed_at": {
  21301. "type": "string",
  21302. "format": "date-time",
  21303. "x-go-name": "Closed"
  21304. },
  21305. "comments": {
  21306. "type": "integer",
  21307. "format": "int64",
  21308. "x-go-name": "Comments"
  21309. },
  21310. "created_at": {
  21311. "type": "string",
  21312. "format": "date-time",
  21313. "x-go-name": "Created"
  21314. },
  21315. "diff_url": {
  21316. "type": "string",
  21317. "x-go-name": "DiffURL"
  21318. },
  21319. "due_date": {
  21320. "type": "string",
  21321. "format": "date-time",
  21322. "x-go-name": "Deadline"
  21323. },
  21324. "head": {
  21325. "$ref": "#/definitions/PRBranchInfo"
  21326. },
  21327. "html_url": {
  21328. "type": "string",
  21329. "x-go-name": "HTMLURL"
  21330. },
  21331. "id": {
  21332. "type": "integer",
  21333. "format": "int64",
  21334. "x-go-name": "ID"
  21335. },
  21336. "is_locked": {
  21337. "type": "boolean",
  21338. "x-go-name": "IsLocked"
  21339. },
  21340. "labels": {
  21341. "type": "array",
  21342. "items": {
  21343. "$ref": "#/definitions/Label"
  21344. },
  21345. "x-go-name": "Labels"
  21346. },
  21347. "merge_base": {
  21348. "type": "string",
  21349. "x-go-name": "MergeBase"
  21350. },
  21351. "merge_commit_sha": {
  21352. "type": "string",
  21353. "x-go-name": "MergedCommitID"
  21354. },
  21355. "mergeable": {
  21356. "type": "boolean",
  21357. "x-go-name": "Mergeable"
  21358. },
  21359. "merged": {
  21360. "type": "boolean",
  21361. "x-go-name": "HasMerged"
  21362. },
  21363. "merged_at": {
  21364. "type": "string",
  21365. "format": "date-time",
  21366. "x-go-name": "Merged"
  21367. },
  21368. "merged_by": {
  21369. "$ref": "#/definitions/User"
  21370. },
  21371. "milestone": {
  21372. "$ref": "#/definitions/Milestone"
  21373. },
  21374. "number": {
  21375. "type": "integer",
  21376. "format": "int64",
  21377. "x-go-name": "Index"
  21378. },
  21379. "patch_url": {
  21380. "type": "string",
  21381. "x-go-name": "PatchURL"
  21382. },
  21383. "pin_order": {
  21384. "type": "integer",
  21385. "format": "int64",
  21386. "x-go-name": "PinOrder"
  21387. },
  21388. "requested_reviewers": {
  21389. "type": "array",
  21390. "items": {
  21391. "$ref": "#/definitions/User"
  21392. },
  21393. "x-go-name": "RequestedReviewers"
  21394. },
  21395. "state": {
  21396. "$ref": "#/definitions/StateType"
  21397. },
  21398. "title": {
  21399. "type": "string",
  21400. "x-go-name": "Title"
  21401. },
  21402. "updated_at": {
  21403. "type": "string",
  21404. "format": "date-time",
  21405. "x-go-name": "Updated"
  21406. },
  21407. "url": {
  21408. "type": "string",
  21409. "x-go-name": "URL"
  21410. },
  21411. "user": {
  21412. "$ref": "#/definitions/User"
  21413. }
  21414. },
  21415. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21416. },
  21417. "PullRequestMeta": {
  21418. "description": "PullRequestMeta PR info if an issue is a PR",
  21419. "type": "object",
  21420. "properties": {
  21421. "merged": {
  21422. "type": "boolean",
  21423. "x-go-name": "HasMerged"
  21424. },
  21425. "merged_at": {
  21426. "type": "string",
  21427. "format": "date-time",
  21428. "x-go-name": "Merged"
  21429. }
  21430. },
  21431. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21432. },
  21433. "PullReview": {
  21434. "description": "PullReview represents a pull request review",
  21435. "type": "object",
  21436. "properties": {
  21437. "body": {
  21438. "type": "string",
  21439. "x-go-name": "Body"
  21440. },
  21441. "comments_count": {
  21442. "type": "integer",
  21443. "format": "int64",
  21444. "x-go-name": "CodeCommentsCount"
  21445. },
  21446. "commit_id": {
  21447. "type": "string",
  21448. "x-go-name": "CommitID"
  21449. },
  21450. "dismissed": {
  21451. "type": "boolean",
  21452. "x-go-name": "Dismissed"
  21453. },
  21454. "html_url": {
  21455. "type": "string",
  21456. "x-go-name": "HTMLURL"
  21457. },
  21458. "id": {
  21459. "type": "integer",
  21460. "format": "int64",
  21461. "x-go-name": "ID"
  21462. },
  21463. "official": {
  21464. "type": "boolean",
  21465. "x-go-name": "Official"
  21466. },
  21467. "pull_request_url": {
  21468. "type": "string",
  21469. "x-go-name": "HTMLPullURL"
  21470. },
  21471. "stale": {
  21472. "type": "boolean",
  21473. "x-go-name": "Stale"
  21474. },
  21475. "state": {
  21476. "$ref": "#/definitions/ReviewStateType"
  21477. },
  21478. "submitted_at": {
  21479. "type": "string",
  21480. "format": "date-time",
  21481. "x-go-name": "Submitted"
  21482. },
  21483. "team": {
  21484. "$ref": "#/definitions/Team"
  21485. },
  21486. "updated_at": {
  21487. "type": "string",
  21488. "format": "date-time",
  21489. "x-go-name": "Updated"
  21490. },
  21491. "user": {
  21492. "$ref": "#/definitions/User"
  21493. }
  21494. },
  21495. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21496. },
  21497. "PullReviewComment": {
  21498. "description": "PullReviewComment represents a comment on a pull request review",
  21499. "type": "object",
  21500. "properties": {
  21501. "body": {
  21502. "type": "string",
  21503. "x-go-name": "Body"
  21504. },
  21505. "commit_id": {
  21506. "type": "string",
  21507. "x-go-name": "CommitID"
  21508. },
  21509. "created_at": {
  21510. "type": "string",
  21511. "format": "date-time",
  21512. "x-go-name": "Created"
  21513. },
  21514. "diff_hunk": {
  21515. "type": "string",
  21516. "x-go-name": "DiffHunk"
  21517. },
  21518. "html_url": {
  21519. "type": "string",
  21520. "x-go-name": "HTMLURL"
  21521. },
  21522. "id": {
  21523. "type": "integer",
  21524. "format": "int64",
  21525. "x-go-name": "ID"
  21526. },
  21527. "original_commit_id": {
  21528. "type": "string",
  21529. "x-go-name": "OrigCommitID"
  21530. },
  21531. "original_position": {
  21532. "type": "integer",
  21533. "format": "uint64",
  21534. "x-go-name": "OldLineNum"
  21535. },
  21536. "path": {
  21537. "type": "string",
  21538. "x-go-name": "Path"
  21539. },
  21540. "position": {
  21541. "type": "integer",
  21542. "format": "uint64",
  21543. "x-go-name": "LineNum"
  21544. },
  21545. "pull_request_review_id": {
  21546. "type": "integer",
  21547. "format": "int64",
  21548. "x-go-name": "ReviewID"
  21549. },
  21550. "pull_request_url": {
  21551. "type": "string",
  21552. "x-go-name": "HTMLPullURL"
  21553. },
  21554. "resolver": {
  21555. "$ref": "#/definitions/User"
  21556. },
  21557. "updated_at": {
  21558. "type": "string",
  21559. "format": "date-time",
  21560. "x-go-name": "Updated"
  21561. },
  21562. "user": {
  21563. "$ref": "#/definitions/User"
  21564. }
  21565. },
  21566. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21567. },
  21568. "PullReviewRequestOptions": {
  21569. "description": "PullReviewRequestOptions are options to add or remove pull review requests",
  21570. "type": "object",
  21571. "properties": {
  21572. "reviewers": {
  21573. "type": "array",
  21574. "items": {
  21575. "type": "string"
  21576. },
  21577. "x-go-name": "Reviewers"
  21578. },
  21579. "team_reviewers": {
  21580. "type": "array",
  21581. "items": {
  21582. "type": "string"
  21583. },
  21584. "x-go-name": "TeamReviewers"
  21585. }
  21586. },
  21587. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21588. },
  21589. "PushMirror": {
  21590. "description": "PushMirror represents information of a push mirror",
  21591. "type": "object",
  21592. "properties": {
  21593. "created": {
  21594. "type": "string",
  21595. "x-go-name": "CreatedUnix"
  21596. },
  21597. "interval": {
  21598. "type": "string",
  21599. "x-go-name": "Interval"
  21600. },
  21601. "last_error": {
  21602. "type": "string",
  21603. "x-go-name": "LastError"
  21604. },
  21605. "last_update": {
  21606. "type": "string",
  21607. "x-go-name": "LastUpdateUnix"
  21608. },
  21609. "remote_address": {
  21610. "type": "string",
  21611. "x-go-name": "RemoteAddress"
  21612. },
  21613. "remote_name": {
  21614. "type": "string",
  21615. "x-go-name": "RemoteName"
  21616. },
  21617. "repo_name": {
  21618. "type": "string",
  21619. "x-go-name": "RepoName"
  21620. },
  21621. "sync_on_commit": {
  21622. "type": "boolean",
  21623. "x-go-name": "SyncOnCommit"
  21624. }
  21625. },
  21626. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21627. },
  21628. "Reaction": {
  21629. "description": "Reaction contain one reaction",
  21630. "type": "object",
  21631. "properties": {
  21632. "content": {
  21633. "type": "string",
  21634. "x-go-name": "Reaction"
  21635. },
  21636. "created_at": {
  21637. "type": "string",
  21638. "format": "date-time",
  21639. "x-go-name": "Created"
  21640. },
  21641. "user": {
  21642. "$ref": "#/definitions/User"
  21643. }
  21644. },
  21645. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21646. },
  21647. "Reference": {
  21648. "type": "object",
  21649. "title": "Reference represents a Git reference.",
  21650. "properties": {
  21651. "object": {
  21652. "$ref": "#/definitions/GitObject"
  21653. },
  21654. "ref": {
  21655. "type": "string",
  21656. "x-go-name": "Ref"
  21657. },
  21658. "url": {
  21659. "type": "string",
  21660. "x-go-name": "URL"
  21661. }
  21662. },
  21663. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21664. },
  21665. "Release": {
  21666. "description": "Release represents a repository release",
  21667. "type": "object",
  21668. "properties": {
  21669. "assets": {
  21670. "type": "array",
  21671. "items": {
  21672. "$ref": "#/definitions/Attachment"
  21673. },
  21674. "x-go-name": "Attachments"
  21675. },
  21676. "author": {
  21677. "$ref": "#/definitions/User"
  21678. },
  21679. "body": {
  21680. "type": "string",
  21681. "x-go-name": "Note"
  21682. },
  21683. "created_at": {
  21684. "type": "string",
  21685. "format": "date-time",
  21686. "x-go-name": "CreatedAt"
  21687. },
  21688. "draft": {
  21689. "type": "boolean",
  21690. "x-go-name": "IsDraft"
  21691. },
  21692. "html_url": {
  21693. "type": "string",
  21694. "x-go-name": "HTMLURL"
  21695. },
  21696. "id": {
  21697. "type": "integer",
  21698. "format": "int64",
  21699. "x-go-name": "ID"
  21700. },
  21701. "name": {
  21702. "type": "string",
  21703. "x-go-name": "Title"
  21704. },
  21705. "prerelease": {
  21706. "type": "boolean",
  21707. "x-go-name": "IsPrerelease"
  21708. },
  21709. "published_at": {
  21710. "type": "string",
  21711. "format": "date-time",
  21712. "x-go-name": "PublishedAt"
  21713. },
  21714. "tag_name": {
  21715. "type": "string",
  21716. "x-go-name": "TagName"
  21717. },
  21718. "tarball_url": {
  21719. "type": "string",
  21720. "x-go-name": "TarURL"
  21721. },
  21722. "target_commitish": {
  21723. "type": "string",
  21724. "x-go-name": "Target"
  21725. },
  21726. "upload_url": {
  21727. "type": "string",
  21728. "x-go-name": "UploadURL"
  21729. },
  21730. "url": {
  21731. "type": "string",
  21732. "x-go-name": "URL"
  21733. },
  21734. "zipball_url": {
  21735. "type": "string",
  21736. "x-go-name": "ZipURL"
  21737. }
  21738. },
  21739. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21740. },
  21741. "RenameUserOption": {
  21742. "description": "RenameUserOption options when renaming a user",
  21743. "type": "object",
  21744. "required": [
  21745. "new_username"
  21746. ],
  21747. "properties": {
  21748. "new_username": {
  21749. "description": "New username for this user. This name cannot be in use yet by any other user.",
  21750. "type": "string",
  21751. "uniqueItems": true,
  21752. "x-go-name": "NewName"
  21753. }
  21754. },
  21755. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21756. },
  21757. "RepoCollaboratorPermission": {
  21758. "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
  21759. "type": "object",
  21760. "properties": {
  21761. "permission": {
  21762. "type": "string",
  21763. "x-go-name": "Permission"
  21764. },
  21765. "role_name": {
  21766. "type": "string",
  21767. "x-go-name": "RoleName"
  21768. },
  21769. "user": {
  21770. "$ref": "#/definitions/User"
  21771. }
  21772. },
  21773. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21774. },
  21775. "RepoCommit": {
  21776. "type": "object",
  21777. "title": "RepoCommit contains information of a commit in the context of a repository.",
  21778. "properties": {
  21779. "author": {
  21780. "$ref": "#/definitions/CommitUser"
  21781. },
  21782. "committer": {
  21783. "$ref": "#/definitions/CommitUser"
  21784. },
  21785. "message": {
  21786. "type": "string",
  21787. "x-go-name": "Message"
  21788. },
  21789. "tree": {
  21790. "$ref": "#/definitions/CommitMeta"
  21791. },
  21792. "url": {
  21793. "type": "string",
  21794. "x-go-name": "URL"
  21795. },
  21796. "verification": {
  21797. "$ref": "#/definitions/PayloadCommitVerification"
  21798. }
  21799. },
  21800. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21801. },
  21802. "RepoTopicOptions": {
  21803. "description": "RepoTopicOptions a collection of repo topic names",
  21804. "type": "object",
  21805. "properties": {
  21806. "topics": {
  21807. "description": "list of topic names",
  21808. "type": "array",
  21809. "items": {
  21810. "type": "string"
  21811. },
  21812. "x-go-name": "Topics"
  21813. }
  21814. },
  21815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21816. },
  21817. "RepoTransfer": {
  21818. "description": "RepoTransfer represents a pending repo transfer",
  21819. "type": "object",
  21820. "properties": {
  21821. "doer": {
  21822. "$ref": "#/definitions/User"
  21823. },
  21824. "recipient": {
  21825. "$ref": "#/definitions/User"
  21826. },
  21827. "teams": {
  21828. "type": "array",
  21829. "items": {
  21830. "$ref": "#/definitions/Team"
  21831. },
  21832. "x-go-name": "Teams"
  21833. }
  21834. },
  21835. "x-go-package": "code.gitea.io/gitea/modules/structs"
  21836. },
  21837. "Repository": {
  21838. "description": "Repository represents a repository",
  21839. "type": "object",
  21840. "properties": {
  21841. "allow_merge_commits": {
  21842. "type": "boolean",
  21843. "x-go-name": "AllowMerge"
  21844. },
  21845. "allow_rebase": {
  21846. "type": "boolean",
  21847. "x-go-name": "AllowRebase"
  21848. },
  21849. "allow_rebase_explicit": {
  21850. "type": "boolean",
  21851. "x-go-name": "AllowRebaseMerge"
  21852. },
  21853. "allow_rebase_update": {
  21854. "type": "boolean",
  21855. "x-go-name": "AllowRebaseUpdate"
  21856. },
  21857. "allow_squash_merge": {
  21858. "type": "boolean",
  21859. "x-go-name": "AllowSquash"
  21860. },
  21861. "archived": {
  21862. "type": "boolean",
  21863. "x-go-name": "Archived"
  21864. },
  21865. "archived_at": {
  21866. "type": "string",
  21867. "format": "date-time",
  21868. "x-go-name": "ArchivedAt"
  21869. },
  21870. "avatar_url": {
  21871. "type": "string",
  21872. "x-go-name": "AvatarURL"
  21873. },
  21874. "clone_url": {
  21875. "type": "string",
  21876. "x-go-name": "CloneURL"
  21877. },
  21878. "created_at": {
  21879. "type": "string",
  21880. "format": "date-time",
  21881. "x-go-name": "Created"
  21882. },
  21883. "default_allow_maintainer_edit": {
  21884. "type": "boolean",
  21885. "x-go-name": "DefaultAllowMaintainerEdit"
  21886. },
  21887. "default_branch": {
  21888. "type": "string",
  21889. "x-go-name": "DefaultBranch"
  21890. },
  21891. "default_delete_branch_after_merge": {
  21892. "type": "boolean",
  21893. "x-go-name": "DefaultDeleteBranchAfterMerge"
  21894. },
  21895. "default_merge_style": {
  21896. "type": "string",
  21897. "x-go-name": "DefaultMergeStyle"
  21898. },
  21899. "description": {
  21900. "type": "string",
  21901. "x-go-name": "Description"
  21902. },
  21903. "empty": {
  21904. "type": "boolean",
  21905. "x-go-name": "Empty"
  21906. },
  21907. "external_tracker": {
  21908. "$ref": "#/definitions/ExternalTracker"
  21909. },
  21910. "external_wiki": {
  21911. "$ref": "#/definitions/ExternalWiki"
  21912. },
  21913. "fork": {
  21914. "type": "boolean",
  21915. "x-go-name": "Fork"
  21916. },
  21917. "forks_count": {
  21918. "type": "integer",
  21919. "format": "int64",
  21920. "x-go-name": "Forks"
  21921. },
  21922. "full_name": {
  21923. "type": "string",
  21924. "x-go-name": "FullName"
  21925. },
  21926. "has_actions": {
  21927. "type": "boolean",
  21928. "x-go-name": "HasActions"
  21929. },
  21930. "has_issues": {
  21931. "type": "boolean",
  21932. "x-go-name": "HasIssues"
  21933. },
  21934. "has_packages": {
  21935. "type": "boolean",
  21936. "x-go-name": "HasPackages"
  21937. },
  21938. "has_projects": {
  21939. "type": "boolean",
  21940. "x-go-name": "HasProjects"
  21941. },
  21942. "has_pull_requests": {
  21943. "type": "boolean",
  21944. "x-go-name": "HasPullRequests"
  21945. },
  21946. "has_releases": {
  21947. "type": "boolean",
  21948. "x-go-name": "HasReleases"
  21949. },
  21950. "has_wiki": {
  21951. "type": "boolean",
  21952. "x-go-name": "HasWiki"
  21953. },
  21954. "html_url": {
  21955. "type": "string",
  21956. "x-go-name": "HTMLURL"
  21957. },
  21958. "id": {
  21959. "type": "integer",
  21960. "format": "int64",
  21961. "x-go-name": "ID"
  21962. },
  21963. "ignore_whitespace_conflicts": {
  21964. "type": "boolean",
  21965. "x-go-name": "IgnoreWhitespaceConflicts"
  21966. },
  21967. "internal": {
  21968. "type": "boolean",
  21969. "x-go-name": "Internal"
  21970. },
  21971. "internal_tracker": {
  21972. "$ref": "#/definitions/InternalTracker"
  21973. },
  21974. "language": {
  21975. "type": "string",
  21976. "x-go-name": "Language"
  21977. },
  21978. "languages_url": {
  21979. "type": "string",
  21980. "x-go-name": "LanguagesURL"
  21981. },
  21982. "link": {
  21983. "type": "string",
  21984. "x-go-name": "Link"
  21985. },
  21986. "mirror": {
  21987. "type": "boolean",
  21988. "x-go-name": "Mirror"
  21989. },
  21990. "mirror_interval": {
  21991. "type": "string",
  21992. "x-go-name": "MirrorInterval"
  21993. },
  21994. "mirror_updated": {
  21995. "type": "string",
  21996. "format": "date-time",
  21997. "x-go-name": "MirrorUpdated"
  21998. },
  21999. "name": {
  22000. "type": "string",
  22001. "x-go-name": "Name"
  22002. },
  22003. "open_issues_count": {
  22004. "type": "integer",
  22005. "format": "int64",
  22006. "x-go-name": "OpenIssues"
  22007. },
  22008. "open_pr_counter": {
  22009. "type": "integer",
  22010. "format": "int64",
  22011. "x-go-name": "OpenPulls"
  22012. },
  22013. "original_url": {
  22014. "type": "string",
  22015. "x-go-name": "OriginalURL"
  22016. },
  22017. "owner": {
  22018. "$ref": "#/definitions/User"
  22019. },
  22020. "parent": {
  22021. "$ref": "#/definitions/Repository"
  22022. },
  22023. "permissions": {
  22024. "$ref": "#/definitions/Permission"
  22025. },
  22026. "private": {
  22027. "type": "boolean",
  22028. "x-go-name": "Private"
  22029. },
  22030. "release_counter": {
  22031. "type": "integer",
  22032. "format": "int64",
  22033. "x-go-name": "Releases"
  22034. },
  22035. "repo_transfer": {
  22036. "$ref": "#/definitions/RepoTransfer"
  22037. },
  22038. "size": {
  22039. "type": "integer",
  22040. "format": "int64",
  22041. "x-go-name": "Size"
  22042. },
  22043. "ssh_url": {
  22044. "type": "string",
  22045. "x-go-name": "SSHURL"
  22046. },
  22047. "stars_count": {
  22048. "type": "integer",
  22049. "format": "int64",
  22050. "x-go-name": "Stars"
  22051. },
  22052. "template": {
  22053. "type": "boolean",
  22054. "x-go-name": "Template"
  22055. },
  22056. "updated_at": {
  22057. "type": "string",
  22058. "format": "date-time",
  22059. "x-go-name": "Updated"
  22060. },
  22061. "url": {
  22062. "type": "string",
  22063. "x-go-name": "URL"
  22064. },
  22065. "watchers_count": {
  22066. "type": "integer",
  22067. "format": "int64",
  22068. "x-go-name": "Watchers"
  22069. },
  22070. "website": {
  22071. "type": "string",
  22072. "x-go-name": "Website"
  22073. }
  22074. },
  22075. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22076. },
  22077. "RepositoryMeta": {
  22078. "description": "RepositoryMeta basic repository information",
  22079. "type": "object",
  22080. "properties": {
  22081. "full_name": {
  22082. "type": "string",
  22083. "x-go-name": "FullName"
  22084. },
  22085. "id": {
  22086. "type": "integer",
  22087. "format": "int64",
  22088. "x-go-name": "ID"
  22089. },
  22090. "name": {
  22091. "type": "string",
  22092. "x-go-name": "Name"
  22093. },
  22094. "owner": {
  22095. "type": "string",
  22096. "x-go-name": "Owner"
  22097. }
  22098. },
  22099. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22100. },
  22101. "ReviewStateType": {
  22102. "description": "ReviewStateType review state type",
  22103. "type": "string",
  22104. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22105. },
  22106. "SearchResults": {
  22107. "description": "SearchResults results of a successful search",
  22108. "type": "object",
  22109. "properties": {
  22110. "data": {
  22111. "type": "array",
  22112. "items": {
  22113. "$ref": "#/definitions/Repository"
  22114. },
  22115. "x-go-name": "Data"
  22116. },
  22117. "ok": {
  22118. "type": "boolean",
  22119. "x-go-name": "OK"
  22120. }
  22121. },
  22122. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22123. },
  22124. "Secret": {
  22125. "description": "Secret represents a secret",
  22126. "type": "object",
  22127. "properties": {
  22128. "created_at": {
  22129. "type": "string",
  22130. "format": "date-time",
  22131. "x-go-name": "Created"
  22132. },
  22133. "name": {
  22134. "description": "the secret's name",
  22135. "type": "string",
  22136. "x-go-name": "Name"
  22137. }
  22138. },
  22139. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22140. },
  22141. "ServerVersion": {
  22142. "description": "ServerVersion wraps the version of the server",
  22143. "type": "object",
  22144. "properties": {
  22145. "version": {
  22146. "type": "string",
  22147. "x-go-name": "Version"
  22148. }
  22149. },
  22150. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22151. },
  22152. "StateType": {
  22153. "description": "StateType issue state type",
  22154. "type": "string",
  22155. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22156. },
  22157. "StopWatch": {
  22158. "description": "StopWatch represent a running stopwatch",
  22159. "type": "object",
  22160. "properties": {
  22161. "created": {
  22162. "type": "string",
  22163. "format": "date-time",
  22164. "x-go-name": "Created"
  22165. },
  22166. "duration": {
  22167. "type": "string",
  22168. "x-go-name": "Duration"
  22169. },
  22170. "issue_index": {
  22171. "type": "integer",
  22172. "format": "int64",
  22173. "x-go-name": "IssueIndex"
  22174. },
  22175. "issue_title": {
  22176. "type": "string",
  22177. "x-go-name": "IssueTitle"
  22178. },
  22179. "repo_name": {
  22180. "type": "string",
  22181. "x-go-name": "RepoName"
  22182. },
  22183. "repo_owner_name": {
  22184. "type": "string",
  22185. "x-go-name": "RepoOwnerName"
  22186. },
  22187. "seconds": {
  22188. "type": "integer",
  22189. "format": "int64",
  22190. "x-go-name": "Seconds"
  22191. }
  22192. },
  22193. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22194. },
  22195. "SubmitPullReviewOptions": {
  22196. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  22197. "type": "object",
  22198. "properties": {
  22199. "body": {
  22200. "type": "string",
  22201. "x-go-name": "Body"
  22202. },
  22203. "event": {
  22204. "$ref": "#/definitions/ReviewStateType"
  22205. }
  22206. },
  22207. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22208. },
  22209. "Tag": {
  22210. "description": "Tag represents a repository tag",
  22211. "type": "object",
  22212. "properties": {
  22213. "commit": {
  22214. "$ref": "#/definitions/CommitMeta"
  22215. },
  22216. "id": {
  22217. "type": "string",
  22218. "x-go-name": "ID"
  22219. },
  22220. "message": {
  22221. "type": "string",
  22222. "x-go-name": "Message"
  22223. },
  22224. "name": {
  22225. "type": "string",
  22226. "x-go-name": "Name"
  22227. },
  22228. "tarball_url": {
  22229. "type": "string",
  22230. "x-go-name": "TarballURL"
  22231. },
  22232. "zipball_url": {
  22233. "type": "string",
  22234. "x-go-name": "ZipballURL"
  22235. }
  22236. },
  22237. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22238. },
  22239. "Team": {
  22240. "description": "Team represents a team in an organization",
  22241. "type": "object",
  22242. "properties": {
  22243. "can_create_org_repo": {
  22244. "type": "boolean",
  22245. "x-go-name": "CanCreateOrgRepo"
  22246. },
  22247. "description": {
  22248. "type": "string",
  22249. "x-go-name": "Description"
  22250. },
  22251. "id": {
  22252. "type": "integer",
  22253. "format": "int64",
  22254. "x-go-name": "ID"
  22255. },
  22256. "includes_all_repositories": {
  22257. "type": "boolean",
  22258. "x-go-name": "IncludesAllRepositories"
  22259. },
  22260. "name": {
  22261. "type": "string",
  22262. "x-go-name": "Name"
  22263. },
  22264. "organization": {
  22265. "$ref": "#/definitions/Organization"
  22266. },
  22267. "permission": {
  22268. "type": "string",
  22269. "enum": [
  22270. "none",
  22271. "read",
  22272. "write",
  22273. "admin",
  22274. "owner"
  22275. ],
  22276. "x-go-name": "Permission"
  22277. },
  22278. "units": {
  22279. "type": "array",
  22280. "items": {
  22281. "type": "string"
  22282. },
  22283. "x-go-name": "Units",
  22284. "example": [
  22285. "repo.code",
  22286. "repo.issues",
  22287. "repo.ext_issues",
  22288. "repo.wiki",
  22289. "repo.pulls",
  22290. "repo.releases",
  22291. "repo.projects",
  22292. "repo.ext_wiki"
  22293. ]
  22294. },
  22295. "units_map": {
  22296. "type": "object",
  22297. "additionalProperties": {
  22298. "type": "string"
  22299. },
  22300. "x-go-name": "UnitsMap",
  22301. "example": {
  22302. "repo.code": "read",
  22303. "repo.ext_issues": "none",
  22304. "repo.ext_wiki": "none",
  22305. "repo.issues": "write",
  22306. "repo.projects": "none",
  22307. "repo.pulls": "owner",
  22308. "repo.releases": "none",
  22309. "repo.wiki": "admin"
  22310. }
  22311. }
  22312. },
  22313. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22314. },
  22315. "TimeStamp": {
  22316. "description": "TimeStamp defines a timestamp",
  22317. "type": "integer",
  22318. "format": "int64",
  22319. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  22320. },
  22321. "TimelineComment": {
  22322. "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
  22323. "type": "object",
  22324. "properties": {
  22325. "assignee": {
  22326. "$ref": "#/definitions/User"
  22327. },
  22328. "assignee_team": {
  22329. "$ref": "#/definitions/Team"
  22330. },
  22331. "body": {
  22332. "type": "string",
  22333. "x-go-name": "Body"
  22334. },
  22335. "created_at": {
  22336. "type": "string",
  22337. "format": "date-time",
  22338. "x-go-name": "Created"
  22339. },
  22340. "dependent_issue": {
  22341. "$ref": "#/definitions/Issue"
  22342. },
  22343. "html_url": {
  22344. "type": "string",
  22345. "x-go-name": "HTMLURL"
  22346. },
  22347. "id": {
  22348. "type": "integer",
  22349. "format": "int64",
  22350. "x-go-name": "ID"
  22351. },
  22352. "issue_url": {
  22353. "type": "string",
  22354. "x-go-name": "IssueURL"
  22355. },
  22356. "label": {
  22357. "$ref": "#/definitions/Label"
  22358. },
  22359. "milestone": {
  22360. "$ref": "#/definitions/Milestone"
  22361. },
  22362. "new_ref": {
  22363. "type": "string",
  22364. "x-go-name": "NewRef"
  22365. },
  22366. "new_title": {
  22367. "type": "string",
  22368. "x-go-name": "NewTitle"
  22369. },
  22370. "old_milestone": {
  22371. "$ref": "#/definitions/Milestone"
  22372. },
  22373. "old_project_id": {
  22374. "type": "integer",
  22375. "format": "int64",
  22376. "x-go-name": "OldProjectID"
  22377. },
  22378. "old_ref": {
  22379. "type": "string",
  22380. "x-go-name": "OldRef"
  22381. },
  22382. "old_title": {
  22383. "type": "string",
  22384. "x-go-name": "OldTitle"
  22385. },
  22386. "project_id": {
  22387. "type": "integer",
  22388. "format": "int64",
  22389. "x-go-name": "ProjectID"
  22390. },
  22391. "pull_request_url": {
  22392. "type": "string",
  22393. "x-go-name": "PRURL"
  22394. },
  22395. "ref_action": {
  22396. "type": "string",
  22397. "x-go-name": "RefAction"
  22398. },
  22399. "ref_comment": {
  22400. "$ref": "#/definitions/Comment"
  22401. },
  22402. "ref_commit_sha": {
  22403. "description": "commit SHA where issue/PR was referenced",
  22404. "type": "string",
  22405. "x-go-name": "RefCommitSHA"
  22406. },
  22407. "ref_issue": {
  22408. "$ref": "#/definitions/Issue"
  22409. },
  22410. "removed_assignee": {
  22411. "description": "whether the assignees were removed or added",
  22412. "type": "boolean",
  22413. "x-go-name": "RemovedAssignee"
  22414. },
  22415. "resolve_doer": {
  22416. "$ref": "#/definitions/User"
  22417. },
  22418. "review_id": {
  22419. "type": "integer",
  22420. "format": "int64",
  22421. "x-go-name": "ReviewID"
  22422. },
  22423. "tracked_time": {
  22424. "$ref": "#/definitions/TrackedTime"
  22425. },
  22426. "type": {
  22427. "type": "string",
  22428. "x-go-name": "Type"
  22429. },
  22430. "updated_at": {
  22431. "type": "string",
  22432. "format": "date-time",
  22433. "x-go-name": "Updated"
  22434. },
  22435. "user": {
  22436. "$ref": "#/definitions/User"
  22437. }
  22438. },
  22439. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22440. },
  22441. "TopicName": {
  22442. "description": "TopicName a list of repo topic names",
  22443. "type": "object",
  22444. "properties": {
  22445. "topics": {
  22446. "type": "array",
  22447. "items": {
  22448. "type": "string"
  22449. },
  22450. "x-go-name": "TopicNames"
  22451. }
  22452. },
  22453. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22454. },
  22455. "TopicResponse": {
  22456. "description": "TopicResponse for returning topics",
  22457. "type": "object",
  22458. "properties": {
  22459. "created": {
  22460. "type": "string",
  22461. "format": "date-time",
  22462. "x-go-name": "Created"
  22463. },
  22464. "id": {
  22465. "type": "integer",
  22466. "format": "int64",
  22467. "x-go-name": "ID"
  22468. },
  22469. "repo_count": {
  22470. "type": "integer",
  22471. "format": "int64",
  22472. "x-go-name": "RepoCount"
  22473. },
  22474. "topic_name": {
  22475. "type": "string",
  22476. "x-go-name": "Name"
  22477. },
  22478. "updated": {
  22479. "type": "string",
  22480. "format": "date-time",
  22481. "x-go-name": "Updated"
  22482. }
  22483. },
  22484. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22485. },
  22486. "TrackedTime": {
  22487. "description": "TrackedTime worked time for an issue / pr",
  22488. "type": "object",
  22489. "properties": {
  22490. "created": {
  22491. "type": "string",
  22492. "format": "date-time",
  22493. "x-go-name": "Created"
  22494. },
  22495. "id": {
  22496. "type": "integer",
  22497. "format": "int64",
  22498. "x-go-name": "ID"
  22499. },
  22500. "issue": {
  22501. "$ref": "#/definitions/Issue"
  22502. },
  22503. "issue_id": {
  22504. "description": "deprecated (only for backwards compatibility)",
  22505. "type": "integer",
  22506. "format": "int64",
  22507. "x-go-name": "IssueID"
  22508. },
  22509. "time": {
  22510. "description": "Time in seconds",
  22511. "type": "integer",
  22512. "format": "int64",
  22513. "x-go-name": "Time"
  22514. },
  22515. "user_id": {
  22516. "description": "deprecated (only for backwards compatibility)",
  22517. "type": "integer",
  22518. "format": "int64",
  22519. "x-go-name": "UserID"
  22520. },
  22521. "user_name": {
  22522. "type": "string",
  22523. "x-go-name": "UserName"
  22524. }
  22525. },
  22526. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22527. },
  22528. "TransferRepoOption": {
  22529. "description": "TransferRepoOption options when transfer a repository's ownership",
  22530. "type": "object",
  22531. "required": [
  22532. "new_owner"
  22533. ],
  22534. "properties": {
  22535. "new_owner": {
  22536. "type": "string",
  22537. "x-go-name": "NewOwner"
  22538. },
  22539. "team_ids": {
  22540. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  22541. "type": "array",
  22542. "items": {
  22543. "type": "integer",
  22544. "format": "int64"
  22545. },
  22546. "x-go-name": "TeamIDs"
  22547. }
  22548. },
  22549. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22550. },
  22551. "UpdateFileOptions": {
  22552. "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)",
  22553. "type": "object",
  22554. "required": [
  22555. "sha",
  22556. "content"
  22557. ],
  22558. "properties": {
  22559. "author": {
  22560. "$ref": "#/definitions/Identity"
  22561. },
  22562. "branch": {
  22563. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  22564. "type": "string",
  22565. "x-go-name": "BranchName"
  22566. },
  22567. "committer": {
  22568. "$ref": "#/definitions/Identity"
  22569. },
  22570. "content": {
  22571. "description": "content must be base64 encoded",
  22572. "type": "string",
  22573. "x-go-name": "ContentBase64"
  22574. },
  22575. "dates": {
  22576. "$ref": "#/definitions/CommitDateOptions"
  22577. },
  22578. "from_path": {
  22579. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  22580. "type": "string",
  22581. "x-go-name": "FromPath"
  22582. },
  22583. "message": {
  22584. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  22585. "type": "string",
  22586. "x-go-name": "Message"
  22587. },
  22588. "new_branch": {
  22589. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  22590. "type": "string",
  22591. "x-go-name": "NewBranchName"
  22592. },
  22593. "sha": {
  22594. "description": "sha is the SHA for the file that already exists",
  22595. "type": "string",
  22596. "x-go-name": "SHA"
  22597. },
  22598. "signoff": {
  22599. "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
  22600. "type": "boolean",
  22601. "x-go-name": "Signoff"
  22602. }
  22603. },
  22604. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22605. },
  22606. "UpdateRepoAvatarOption": {
  22607. "description": "UpdateRepoAvatarUserOption options when updating the repo avatar",
  22608. "type": "object",
  22609. "properties": {
  22610. "image": {
  22611. "description": "image must be base64 encoded",
  22612. "type": "string",
  22613. "x-go-name": "Image"
  22614. }
  22615. },
  22616. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22617. },
  22618. "UpdateUserAvatarOption": {
  22619. "description": "UpdateUserAvatarUserOption options when updating the user avatar",
  22620. "type": "object",
  22621. "properties": {
  22622. "image": {
  22623. "description": "image must be base64 encoded",
  22624. "type": "string",
  22625. "x-go-name": "Image"
  22626. }
  22627. },
  22628. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22629. },
  22630. "User": {
  22631. "description": "User represents a user",
  22632. "type": "object",
  22633. "properties": {
  22634. "active": {
  22635. "description": "Is user active",
  22636. "type": "boolean",
  22637. "x-go-name": "IsActive"
  22638. },
  22639. "avatar_url": {
  22640. "description": "URL to the user's avatar",
  22641. "type": "string",
  22642. "x-go-name": "AvatarURL"
  22643. },
  22644. "created": {
  22645. "type": "string",
  22646. "format": "date-time",
  22647. "x-go-name": "Created"
  22648. },
  22649. "description": {
  22650. "description": "the user's description",
  22651. "type": "string",
  22652. "x-go-name": "Description"
  22653. },
  22654. "email": {
  22655. "type": "string",
  22656. "format": "email",
  22657. "x-go-name": "Email"
  22658. },
  22659. "followers_count": {
  22660. "description": "user counts",
  22661. "type": "integer",
  22662. "format": "int64",
  22663. "x-go-name": "Followers"
  22664. },
  22665. "following_count": {
  22666. "type": "integer",
  22667. "format": "int64",
  22668. "x-go-name": "Following"
  22669. },
  22670. "full_name": {
  22671. "description": "the user's full name",
  22672. "type": "string",
  22673. "x-go-name": "FullName"
  22674. },
  22675. "id": {
  22676. "description": "the user's id",
  22677. "type": "integer",
  22678. "format": "int64",
  22679. "x-go-name": "ID"
  22680. },
  22681. "is_admin": {
  22682. "description": "Is the user an administrator",
  22683. "type": "boolean",
  22684. "x-go-name": "IsAdmin"
  22685. },
  22686. "language": {
  22687. "description": "User locale",
  22688. "type": "string",
  22689. "x-go-name": "Language"
  22690. },
  22691. "last_login": {
  22692. "type": "string",
  22693. "format": "date-time",
  22694. "x-go-name": "LastLogin"
  22695. },
  22696. "location": {
  22697. "description": "the user's location",
  22698. "type": "string",
  22699. "x-go-name": "Location"
  22700. },
  22701. "login": {
  22702. "description": "the user's username",
  22703. "type": "string",
  22704. "x-go-name": "UserName"
  22705. },
  22706. "login_name": {
  22707. "description": "the user's authentication sign-in name.",
  22708. "type": "string",
  22709. "default": "empty",
  22710. "x-go-name": "LoginName"
  22711. },
  22712. "prohibit_login": {
  22713. "description": "Is user login prohibited",
  22714. "type": "boolean",
  22715. "x-go-name": "ProhibitLogin"
  22716. },
  22717. "restricted": {
  22718. "description": "Is user restricted",
  22719. "type": "boolean",
  22720. "x-go-name": "Restricted"
  22721. },
  22722. "starred_repos_count": {
  22723. "type": "integer",
  22724. "format": "int64",
  22725. "x-go-name": "StarredRepos"
  22726. },
  22727. "visibility": {
  22728. "description": "User visibility level option: public, limited, private",
  22729. "type": "string",
  22730. "x-go-name": "Visibility"
  22731. },
  22732. "website": {
  22733. "description": "the user's website",
  22734. "type": "string",
  22735. "x-go-name": "Website"
  22736. }
  22737. },
  22738. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22739. },
  22740. "UserHeatmapData": {
  22741. "description": "UserHeatmapData represents the data needed to create a heatmap",
  22742. "type": "object",
  22743. "properties": {
  22744. "contributions": {
  22745. "type": "integer",
  22746. "format": "int64",
  22747. "x-go-name": "Contributions"
  22748. },
  22749. "timestamp": {
  22750. "$ref": "#/definitions/TimeStamp"
  22751. }
  22752. },
  22753. "x-go-package": "code.gitea.io/gitea/models/activities"
  22754. },
  22755. "UserSettings": {
  22756. "description": "UserSettings represents user settings",
  22757. "type": "object",
  22758. "properties": {
  22759. "description": {
  22760. "type": "string",
  22761. "x-go-name": "Description"
  22762. },
  22763. "diff_view_style": {
  22764. "type": "string",
  22765. "x-go-name": "DiffViewStyle"
  22766. },
  22767. "full_name": {
  22768. "type": "string",
  22769. "x-go-name": "FullName"
  22770. },
  22771. "hide_activity": {
  22772. "type": "boolean",
  22773. "x-go-name": "HideActivity"
  22774. },
  22775. "hide_email": {
  22776. "description": "Privacy",
  22777. "type": "boolean",
  22778. "x-go-name": "HideEmail"
  22779. },
  22780. "language": {
  22781. "type": "string",
  22782. "x-go-name": "Language"
  22783. },
  22784. "location": {
  22785. "type": "string",
  22786. "x-go-name": "Location"
  22787. },
  22788. "theme": {
  22789. "type": "string",
  22790. "x-go-name": "Theme"
  22791. },
  22792. "website": {
  22793. "type": "string",
  22794. "x-go-name": "Website"
  22795. }
  22796. },
  22797. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22798. },
  22799. "UserSettingsOptions": {
  22800. "description": "UserSettingsOptions represents options to change user settings",
  22801. "type": "object",
  22802. "properties": {
  22803. "description": {
  22804. "type": "string",
  22805. "x-go-name": "Description"
  22806. },
  22807. "diff_view_style": {
  22808. "type": "string",
  22809. "x-go-name": "DiffViewStyle"
  22810. },
  22811. "full_name": {
  22812. "type": "string",
  22813. "x-go-name": "FullName"
  22814. },
  22815. "hide_activity": {
  22816. "type": "boolean",
  22817. "x-go-name": "HideActivity"
  22818. },
  22819. "hide_email": {
  22820. "description": "Privacy",
  22821. "type": "boolean",
  22822. "x-go-name": "HideEmail"
  22823. },
  22824. "language": {
  22825. "type": "string",
  22826. "x-go-name": "Language"
  22827. },
  22828. "location": {
  22829. "type": "string",
  22830. "x-go-name": "Location"
  22831. },
  22832. "theme": {
  22833. "type": "string",
  22834. "x-go-name": "Theme"
  22835. },
  22836. "website": {
  22837. "type": "string",
  22838. "x-go-name": "Website"
  22839. }
  22840. },
  22841. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22842. },
  22843. "WatchInfo": {
  22844. "description": "WatchInfo represents an API watch status of one repository",
  22845. "type": "object",
  22846. "properties": {
  22847. "created_at": {
  22848. "type": "string",
  22849. "format": "date-time",
  22850. "x-go-name": "CreatedAt"
  22851. },
  22852. "ignored": {
  22853. "type": "boolean",
  22854. "x-go-name": "Ignored"
  22855. },
  22856. "reason": {
  22857. "x-go-name": "Reason"
  22858. },
  22859. "repository_url": {
  22860. "type": "string",
  22861. "x-go-name": "RepositoryURL"
  22862. },
  22863. "subscribed": {
  22864. "type": "boolean",
  22865. "x-go-name": "Subscribed"
  22866. },
  22867. "url": {
  22868. "type": "string",
  22869. "x-go-name": "URL"
  22870. }
  22871. },
  22872. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22873. },
  22874. "WikiCommit": {
  22875. "description": "WikiCommit page commit/revision",
  22876. "type": "object",
  22877. "properties": {
  22878. "author": {
  22879. "$ref": "#/definitions/CommitUser"
  22880. },
  22881. "commiter": {
  22882. "$ref": "#/definitions/CommitUser"
  22883. },
  22884. "message": {
  22885. "type": "string",
  22886. "x-go-name": "Message"
  22887. },
  22888. "sha": {
  22889. "type": "string",
  22890. "x-go-name": "ID"
  22891. }
  22892. },
  22893. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22894. },
  22895. "WikiCommitList": {
  22896. "description": "WikiCommitList commit/revision list",
  22897. "type": "object",
  22898. "properties": {
  22899. "commits": {
  22900. "type": "array",
  22901. "items": {
  22902. "$ref": "#/definitions/WikiCommit"
  22903. },
  22904. "x-go-name": "WikiCommits"
  22905. },
  22906. "count": {
  22907. "type": "integer",
  22908. "format": "int64",
  22909. "x-go-name": "Count"
  22910. }
  22911. },
  22912. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22913. },
  22914. "WikiPage": {
  22915. "description": "WikiPage a wiki page",
  22916. "type": "object",
  22917. "properties": {
  22918. "commit_count": {
  22919. "type": "integer",
  22920. "format": "int64",
  22921. "x-go-name": "CommitCount"
  22922. },
  22923. "content_base64": {
  22924. "description": "Page content, base64 encoded",
  22925. "type": "string",
  22926. "x-go-name": "ContentBase64"
  22927. },
  22928. "footer": {
  22929. "type": "string",
  22930. "x-go-name": "Footer"
  22931. },
  22932. "html_url": {
  22933. "type": "string",
  22934. "x-go-name": "HTMLURL"
  22935. },
  22936. "last_commit": {
  22937. "$ref": "#/definitions/WikiCommit"
  22938. },
  22939. "sidebar": {
  22940. "type": "string",
  22941. "x-go-name": "Sidebar"
  22942. },
  22943. "sub_url": {
  22944. "type": "string",
  22945. "x-go-name": "SubURL"
  22946. },
  22947. "title": {
  22948. "type": "string",
  22949. "x-go-name": "Title"
  22950. }
  22951. },
  22952. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22953. },
  22954. "WikiPageMetaData": {
  22955. "description": "WikiPageMetaData wiki page meta information",
  22956. "type": "object",
  22957. "properties": {
  22958. "html_url": {
  22959. "type": "string",
  22960. "x-go-name": "HTMLURL"
  22961. },
  22962. "last_commit": {
  22963. "$ref": "#/definitions/WikiCommit"
  22964. },
  22965. "sub_url": {
  22966. "type": "string",
  22967. "x-go-name": "SubURL"
  22968. },
  22969. "title": {
  22970. "type": "string",
  22971. "x-go-name": "Title"
  22972. }
  22973. },
  22974. "x-go-package": "code.gitea.io/gitea/modules/structs"
  22975. }
  22976. },
  22977. "responses": {
  22978. "AccessToken": {
  22979. "description": "AccessToken represents an API access token.",
  22980. "schema": {
  22981. "$ref": "#/definitions/AccessToken"
  22982. }
  22983. },
  22984. "AccessTokenList": {
  22985. "description": "AccessTokenList represents a list of API access token.",
  22986. "schema": {
  22987. "type": "array",
  22988. "items": {
  22989. "$ref": "#/definitions/AccessToken"
  22990. }
  22991. }
  22992. },
  22993. "ActivityFeedsList": {
  22994. "description": "ActivityFeedsList",
  22995. "schema": {
  22996. "type": "array",
  22997. "items": {
  22998. "$ref": "#/definitions/Activity"
  22999. }
  23000. }
  23001. },
  23002. "ActivityPub": {
  23003. "description": "ActivityPub",
  23004. "schema": {
  23005. "$ref": "#/definitions/ActivityPub"
  23006. }
  23007. },
  23008. "AnnotatedTag": {
  23009. "description": "AnnotatedTag",
  23010. "schema": {
  23011. "$ref": "#/definitions/AnnotatedTag"
  23012. }
  23013. },
  23014. "Attachment": {
  23015. "description": "Attachment",
  23016. "schema": {
  23017. "$ref": "#/definitions/Attachment"
  23018. }
  23019. },
  23020. "AttachmentList": {
  23021. "description": "AttachmentList",
  23022. "schema": {
  23023. "type": "array",
  23024. "items": {
  23025. "$ref": "#/definitions/Attachment"
  23026. }
  23027. }
  23028. },
  23029. "Branch": {
  23030. "description": "Branch",
  23031. "schema": {
  23032. "$ref": "#/definitions/Branch"
  23033. }
  23034. },
  23035. "BranchList": {
  23036. "description": "BranchList",
  23037. "schema": {
  23038. "type": "array",
  23039. "items": {
  23040. "$ref": "#/definitions/Branch"
  23041. }
  23042. }
  23043. },
  23044. "BranchProtection": {
  23045. "description": "BranchProtection",
  23046. "schema": {
  23047. "$ref": "#/definitions/BranchProtection"
  23048. }
  23049. },
  23050. "BranchProtectionList": {
  23051. "description": "BranchProtectionList",
  23052. "schema": {
  23053. "type": "array",
  23054. "items": {
  23055. "$ref": "#/definitions/BranchProtection"
  23056. }
  23057. }
  23058. },
  23059. "ChangedFileList": {
  23060. "description": "ChangedFileList",
  23061. "schema": {
  23062. "type": "array",
  23063. "items": {
  23064. "$ref": "#/definitions/ChangedFile"
  23065. }
  23066. },
  23067. "headers": {
  23068. "X-HasMore": {
  23069. "type": "boolean",
  23070. "description": "True if there is another page"
  23071. },
  23072. "X-Page": {
  23073. "type": "integer",
  23074. "format": "int64",
  23075. "description": "The current page"
  23076. },
  23077. "X-PageCount": {
  23078. "type": "integer",
  23079. "format": "int64",
  23080. "description": "Total number of pages"
  23081. },
  23082. "X-PerPage": {
  23083. "type": "integer",
  23084. "format": "int64",
  23085. "description": "Commits per page"
  23086. },
  23087. "X-Total": {
  23088. "type": "integer",
  23089. "format": "int64",
  23090. "description": "Total commit count"
  23091. }
  23092. }
  23093. },
  23094. "CombinedStatus": {
  23095. "description": "CombinedStatus",
  23096. "schema": {
  23097. "$ref": "#/definitions/CombinedStatus"
  23098. }
  23099. },
  23100. "Comment": {
  23101. "description": "Comment",
  23102. "schema": {
  23103. "$ref": "#/definitions/Comment"
  23104. }
  23105. },
  23106. "CommentList": {
  23107. "description": "CommentList",
  23108. "schema": {
  23109. "type": "array",
  23110. "items": {
  23111. "$ref": "#/definitions/Comment"
  23112. }
  23113. }
  23114. },
  23115. "Commit": {
  23116. "description": "Commit",
  23117. "schema": {
  23118. "$ref": "#/definitions/Commit"
  23119. }
  23120. },
  23121. "CommitList": {
  23122. "description": "CommitList",
  23123. "schema": {
  23124. "type": "array",
  23125. "items": {
  23126. "$ref": "#/definitions/Commit"
  23127. }
  23128. },
  23129. "headers": {
  23130. "X-HasMore": {
  23131. "type": "boolean",
  23132. "description": "True if there is another page"
  23133. },
  23134. "X-Page": {
  23135. "type": "integer",
  23136. "format": "int64",
  23137. "description": "The current page"
  23138. },
  23139. "X-PageCount": {
  23140. "type": "integer",
  23141. "format": "int64",
  23142. "description": "Total number of pages"
  23143. },
  23144. "X-PerPage": {
  23145. "type": "integer",
  23146. "format": "int64",
  23147. "description": "Commits per page"
  23148. },
  23149. "X-Total": {
  23150. "type": "integer",
  23151. "format": "int64",
  23152. "description": "Total commit count"
  23153. }
  23154. }
  23155. },
  23156. "CommitStatus": {
  23157. "description": "CommitStatus",
  23158. "schema": {
  23159. "$ref": "#/definitions/CommitStatus"
  23160. }
  23161. },
  23162. "CommitStatusList": {
  23163. "description": "CommitStatusList",
  23164. "schema": {
  23165. "type": "array",
  23166. "items": {
  23167. "$ref": "#/definitions/CommitStatus"
  23168. }
  23169. }
  23170. },
  23171. "ContentsListResponse": {
  23172. "description": "ContentsListResponse",
  23173. "schema": {
  23174. "type": "array",
  23175. "items": {
  23176. "$ref": "#/definitions/ContentsResponse"
  23177. }
  23178. }
  23179. },
  23180. "ContentsResponse": {
  23181. "description": "ContentsResponse",
  23182. "schema": {
  23183. "$ref": "#/definitions/ContentsResponse"
  23184. }
  23185. },
  23186. "CronList": {
  23187. "description": "CronList",
  23188. "schema": {
  23189. "type": "array",
  23190. "items": {
  23191. "$ref": "#/definitions/Cron"
  23192. }
  23193. }
  23194. },
  23195. "DeployKey": {
  23196. "description": "DeployKey",
  23197. "schema": {
  23198. "$ref": "#/definitions/DeployKey"
  23199. }
  23200. },
  23201. "DeployKeyList": {
  23202. "description": "DeployKeyList",
  23203. "schema": {
  23204. "type": "array",
  23205. "items": {
  23206. "$ref": "#/definitions/DeployKey"
  23207. }
  23208. }
  23209. },
  23210. "EmailList": {
  23211. "description": "EmailList",
  23212. "schema": {
  23213. "type": "array",
  23214. "items": {
  23215. "$ref": "#/definitions/Email"
  23216. }
  23217. }
  23218. },
  23219. "EmptyRepository": {
  23220. "description": "EmptyRepository",
  23221. "schema": {
  23222. "$ref": "#/definitions/APIError"
  23223. }
  23224. },
  23225. "FileDeleteResponse": {
  23226. "description": "FileDeleteResponse",
  23227. "schema": {
  23228. "$ref": "#/definitions/FileDeleteResponse"
  23229. }
  23230. },
  23231. "FileResponse": {
  23232. "description": "FileResponse",
  23233. "schema": {
  23234. "$ref": "#/definitions/FileResponse"
  23235. }
  23236. },
  23237. "FilesResponse": {
  23238. "description": "FilesResponse",
  23239. "schema": {
  23240. "$ref": "#/definitions/FilesResponse"
  23241. }
  23242. },
  23243. "GPGKey": {
  23244. "description": "GPGKey",
  23245. "schema": {
  23246. "$ref": "#/definitions/GPGKey"
  23247. }
  23248. },
  23249. "GPGKeyList": {
  23250. "description": "GPGKeyList",
  23251. "schema": {
  23252. "type": "array",
  23253. "items": {
  23254. "$ref": "#/definitions/GPGKey"
  23255. }
  23256. }
  23257. },
  23258. "GeneralAPISettings": {
  23259. "description": "GeneralAPISettings",
  23260. "schema": {
  23261. "$ref": "#/definitions/GeneralAPISettings"
  23262. }
  23263. },
  23264. "GeneralAttachmentSettings": {
  23265. "description": "GeneralAttachmentSettings",
  23266. "schema": {
  23267. "$ref": "#/definitions/GeneralAttachmentSettings"
  23268. }
  23269. },
  23270. "GeneralRepoSettings": {
  23271. "description": "GeneralRepoSettings",
  23272. "schema": {
  23273. "$ref": "#/definitions/GeneralRepoSettings"
  23274. }
  23275. },
  23276. "GeneralUISettings": {
  23277. "description": "GeneralUISettings",
  23278. "schema": {
  23279. "$ref": "#/definitions/GeneralUISettings"
  23280. }
  23281. },
  23282. "GitBlobResponse": {
  23283. "description": "GitBlobResponse",
  23284. "schema": {
  23285. "$ref": "#/definitions/GitBlobResponse"
  23286. }
  23287. },
  23288. "GitHook": {
  23289. "description": "GitHook",
  23290. "schema": {
  23291. "$ref": "#/definitions/GitHook"
  23292. }
  23293. },
  23294. "GitHookList": {
  23295. "description": "GitHookList",
  23296. "schema": {
  23297. "type": "array",
  23298. "items": {
  23299. "$ref": "#/definitions/GitHook"
  23300. }
  23301. }
  23302. },
  23303. "GitTreeResponse": {
  23304. "description": "GitTreeResponse",
  23305. "schema": {
  23306. "$ref": "#/definitions/GitTreeResponse"
  23307. }
  23308. },
  23309. "GitignoreTemplateInfo": {
  23310. "description": "GitignoreTemplateInfo",
  23311. "schema": {
  23312. "$ref": "#/definitions/GitignoreTemplateInfo"
  23313. }
  23314. },
  23315. "GitignoreTemplateList": {
  23316. "description": "GitignoreTemplateList",
  23317. "schema": {
  23318. "type": "array",
  23319. "items": {
  23320. "type": "string"
  23321. }
  23322. }
  23323. },
  23324. "Hook": {
  23325. "description": "Hook",
  23326. "schema": {
  23327. "$ref": "#/definitions/Hook"
  23328. }
  23329. },
  23330. "HookList": {
  23331. "description": "HookList",
  23332. "schema": {
  23333. "type": "array",
  23334. "items": {
  23335. "$ref": "#/definitions/Hook"
  23336. }
  23337. }
  23338. },
  23339. "Issue": {
  23340. "description": "Issue",
  23341. "schema": {
  23342. "$ref": "#/definitions/Issue"
  23343. }
  23344. },
  23345. "IssueDeadline": {
  23346. "description": "IssueDeadline",
  23347. "schema": {
  23348. "$ref": "#/definitions/IssueDeadline"
  23349. }
  23350. },
  23351. "IssueList": {
  23352. "description": "IssueList",
  23353. "schema": {
  23354. "type": "array",
  23355. "items": {
  23356. "$ref": "#/definitions/Issue"
  23357. }
  23358. }
  23359. },
  23360. "IssueTemplates": {
  23361. "description": "IssueTemplates",
  23362. "schema": {
  23363. "type": "array",
  23364. "items": {
  23365. "$ref": "#/definitions/IssueTemplate"
  23366. }
  23367. }
  23368. },
  23369. "Label": {
  23370. "description": "Label",
  23371. "schema": {
  23372. "$ref": "#/definitions/Label"
  23373. }
  23374. },
  23375. "LabelList": {
  23376. "description": "LabelList",
  23377. "schema": {
  23378. "type": "array",
  23379. "items": {
  23380. "$ref": "#/definitions/Label"
  23381. }
  23382. }
  23383. },
  23384. "LabelTemplateInfo": {
  23385. "description": "LabelTemplateInfo",
  23386. "schema": {
  23387. "type": "array",
  23388. "items": {
  23389. "$ref": "#/definitions/LabelTemplate"
  23390. }
  23391. }
  23392. },
  23393. "LabelTemplateList": {
  23394. "description": "LabelTemplateList",
  23395. "schema": {
  23396. "type": "array",
  23397. "items": {
  23398. "type": "string"
  23399. }
  23400. }
  23401. },
  23402. "LanguageStatistics": {
  23403. "description": "LanguageStatistics",
  23404. "schema": {
  23405. "type": "object",
  23406. "additionalProperties": {
  23407. "type": "integer",
  23408. "format": "int64"
  23409. }
  23410. }
  23411. },
  23412. "LicenseTemplateInfo": {
  23413. "description": "LicenseTemplateInfo",
  23414. "schema": {
  23415. "$ref": "#/definitions/LicenseTemplateInfo"
  23416. }
  23417. },
  23418. "LicenseTemplateList": {
  23419. "description": "LicenseTemplateList",
  23420. "schema": {
  23421. "type": "array",
  23422. "items": {
  23423. "$ref": "#/definitions/LicensesTemplateListEntry"
  23424. }
  23425. }
  23426. },
  23427. "MarkdownRender": {
  23428. "description": "MarkdownRender is a rendered markdown document",
  23429. "schema": {
  23430. "type": "string"
  23431. }
  23432. },
  23433. "MarkupRender": {
  23434. "description": "MarkupRender is a rendered markup document",
  23435. "schema": {
  23436. "type": "string"
  23437. }
  23438. },
  23439. "Milestone": {
  23440. "description": "Milestone",
  23441. "schema": {
  23442. "$ref": "#/definitions/Milestone"
  23443. }
  23444. },
  23445. "MilestoneList": {
  23446. "description": "MilestoneList",
  23447. "schema": {
  23448. "type": "array",
  23449. "items": {
  23450. "$ref": "#/definitions/Milestone"
  23451. }
  23452. }
  23453. },
  23454. "NodeInfo": {
  23455. "description": "NodeInfo",
  23456. "schema": {
  23457. "$ref": "#/definitions/NodeInfo"
  23458. }
  23459. },
  23460. "Note": {
  23461. "description": "Note",
  23462. "schema": {
  23463. "$ref": "#/definitions/Note"
  23464. }
  23465. },
  23466. "NotificationCount": {
  23467. "description": "Number of unread notifications",
  23468. "schema": {
  23469. "$ref": "#/definitions/NotificationCount"
  23470. }
  23471. },
  23472. "NotificationThread": {
  23473. "description": "NotificationThread",
  23474. "schema": {
  23475. "$ref": "#/definitions/NotificationThread"
  23476. }
  23477. },
  23478. "NotificationThreadList": {
  23479. "description": "NotificationThreadList",
  23480. "schema": {
  23481. "type": "array",
  23482. "items": {
  23483. "$ref": "#/definitions/NotificationThread"
  23484. }
  23485. }
  23486. },
  23487. "OAuth2Application": {
  23488. "description": "OAuth2Application",
  23489. "schema": {
  23490. "$ref": "#/definitions/OAuth2Application"
  23491. }
  23492. },
  23493. "OAuth2ApplicationList": {
  23494. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  23495. "schema": {
  23496. "type": "array",
  23497. "items": {
  23498. "$ref": "#/definitions/OAuth2Application"
  23499. }
  23500. }
  23501. },
  23502. "Organization": {
  23503. "description": "Organization",
  23504. "schema": {
  23505. "$ref": "#/definitions/Organization"
  23506. }
  23507. },
  23508. "OrganizationList": {
  23509. "description": "OrganizationList",
  23510. "schema": {
  23511. "type": "array",
  23512. "items": {
  23513. "$ref": "#/definitions/Organization"
  23514. }
  23515. }
  23516. },
  23517. "OrganizationPermissions": {
  23518. "description": "OrganizationPermissions",
  23519. "schema": {
  23520. "$ref": "#/definitions/OrganizationPermissions"
  23521. }
  23522. },
  23523. "Package": {
  23524. "description": "Package",
  23525. "schema": {
  23526. "$ref": "#/definitions/Package"
  23527. }
  23528. },
  23529. "PackageFileList": {
  23530. "description": "PackageFileList",
  23531. "schema": {
  23532. "type": "array",
  23533. "items": {
  23534. "$ref": "#/definitions/PackageFile"
  23535. }
  23536. }
  23537. },
  23538. "PackageList": {
  23539. "description": "PackageList",
  23540. "schema": {
  23541. "type": "array",
  23542. "items": {
  23543. "$ref": "#/definitions/Package"
  23544. }
  23545. }
  23546. },
  23547. "PublicKey": {
  23548. "description": "PublicKey",
  23549. "schema": {
  23550. "$ref": "#/definitions/PublicKey"
  23551. }
  23552. },
  23553. "PublicKeyList": {
  23554. "description": "PublicKeyList",
  23555. "schema": {
  23556. "type": "array",
  23557. "items": {
  23558. "$ref": "#/definitions/PublicKey"
  23559. }
  23560. }
  23561. },
  23562. "PullRequest": {
  23563. "description": "PullRequest",
  23564. "schema": {
  23565. "$ref": "#/definitions/PullRequest"
  23566. }
  23567. },
  23568. "PullRequestList": {
  23569. "description": "PullRequestList",
  23570. "schema": {
  23571. "type": "array",
  23572. "items": {
  23573. "$ref": "#/definitions/PullRequest"
  23574. }
  23575. }
  23576. },
  23577. "PullReview": {
  23578. "description": "PullReview",
  23579. "schema": {
  23580. "$ref": "#/definitions/PullReview"
  23581. }
  23582. },
  23583. "PullReviewComment": {
  23584. "description": "PullComment",
  23585. "schema": {
  23586. "$ref": "#/definitions/PullReviewComment"
  23587. }
  23588. },
  23589. "PullReviewCommentList": {
  23590. "description": "PullCommentList",
  23591. "schema": {
  23592. "type": "array",
  23593. "items": {
  23594. "$ref": "#/definitions/PullReviewComment"
  23595. }
  23596. }
  23597. },
  23598. "PullReviewList": {
  23599. "description": "PullReviewList",
  23600. "schema": {
  23601. "type": "array",
  23602. "items": {
  23603. "$ref": "#/definitions/PullReview"
  23604. }
  23605. }
  23606. },
  23607. "PushMirror": {
  23608. "description": "PushMirror",
  23609. "schema": {
  23610. "$ref": "#/definitions/PushMirror"
  23611. }
  23612. },
  23613. "PushMirrorList": {
  23614. "description": "PushMirrorList",
  23615. "schema": {
  23616. "type": "array",
  23617. "items": {
  23618. "$ref": "#/definitions/PushMirror"
  23619. }
  23620. }
  23621. },
  23622. "Reaction": {
  23623. "description": "Reaction",
  23624. "schema": {
  23625. "$ref": "#/definitions/Reaction"
  23626. }
  23627. },
  23628. "ReactionList": {
  23629. "description": "ReactionList",
  23630. "schema": {
  23631. "type": "array",
  23632. "items": {
  23633. "$ref": "#/definitions/Reaction"
  23634. }
  23635. }
  23636. },
  23637. "Reference": {
  23638. "description": "Reference",
  23639. "schema": {
  23640. "$ref": "#/definitions/Reference"
  23641. }
  23642. },
  23643. "ReferenceList": {
  23644. "description": "ReferenceList",
  23645. "schema": {
  23646. "type": "array",
  23647. "items": {
  23648. "$ref": "#/definitions/Reference"
  23649. }
  23650. }
  23651. },
  23652. "Release": {
  23653. "description": "Release",
  23654. "schema": {
  23655. "$ref": "#/definitions/Release"
  23656. }
  23657. },
  23658. "ReleaseList": {
  23659. "description": "ReleaseList",
  23660. "schema": {
  23661. "type": "array",
  23662. "items": {
  23663. "$ref": "#/definitions/Release"
  23664. }
  23665. }
  23666. },
  23667. "RepoCollaboratorPermission": {
  23668. "description": "RepoCollaboratorPermission",
  23669. "schema": {
  23670. "$ref": "#/definitions/RepoCollaboratorPermission"
  23671. }
  23672. },
  23673. "RepoIssueConfig": {
  23674. "description": "RepoIssueConfig",
  23675. "schema": {
  23676. "$ref": "#/definitions/IssueConfig"
  23677. }
  23678. },
  23679. "RepoIssueConfigValidation": {
  23680. "description": "RepoIssueConfigValidation",
  23681. "schema": {
  23682. "$ref": "#/definitions/IssueConfigValidation"
  23683. }
  23684. },
  23685. "RepoNewIssuePinsAllowed": {
  23686. "description": "RepoNewIssuePinsAllowed",
  23687. "schema": {
  23688. "$ref": "#/definitions/NewIssuePinsAllowed"
  23689. }
  23690. },
  23691. "Repository": {
  23692. "description": "Repository",
  23693. "schema": {
  23694. "$ref": "#/definitions/Repository"
  23695. }
  23696. },
  23697. "RepositoryList": {
  23698. "description": "RepositoryList",
  23699. "schema": {
  23700. "type": "array",
  23701. "items": {
  23702. "$ref": "#/definitions/Repository"
  23703. }
  23704. }
  23705. },
  23706. "SearchResults": {
  23707. "description": "SearchResults",
  23708. "schema": {
  23709. "$ref": "#/definitions/SearchResults"
  23710. }
  23711. },
  23712. "Secret": {
  23713. "description": "Secret",
  23714. "schema": {
  23715. "$ref": "#/definitions/Secret"
  23716. }
  23717. },
  23718. "SecretList": {
  23719. "description": "SecretList",
  23720. "schema": {
  23721. "type": "array",
  23722. "items": {
  23723. "$ref": "#/definitions/Secret"
  23724. }
  23725. }
  23726. },
  23727. "ServerVersion": {
  23728. "description": "ServerVersion",
  23729. "schema": {
  23730. "$ref": "#/definitions/ServerVersion"
  23731. }
  23732. },
  23733. "StopWatch": {
  23734. "description": "StopWatch",
  23735. "schema": {
  23736. "$ref": "#/definitions/StopWatch"
  23737. }
  23738. },
  23739. "StopWatchList": {
  23740. "description": "StopWatchList",
  23741. "schema": {
  23742. "type": "array",
  23743. "items": {
  23744. "$ref": "#/definitions/StopWatch"
  23745. }
  23746. }
  23747. },
  23748. "StringSlice": {
  23749. "description": "StringSlice",
  23750. "schema": {
  23751. "type": "array",
  23752. "items": {
  23753. "type": "string"
  23754. }
  23755. }
  23756. },
  23757. "Tag": {
  23758. "description": "Tag",
  23759. "schema": {
  23760. "$ref": "#/definitions/Tag"
  23761. }
  23762. },
  23763. "TagList": {
  23764. "description": "TagList",
  23765. "schema": {
  23766. "type": "array",
  23767. "items": {
  23768. "$ref": "#/definitions/Tag"
  23769. }
  23770. }
  23771. },
  23772. "Team": {
  23773. "description": "Team",
  23774. "schema": {
  23775. "$ref": "#/definitions/Team"
  23776. }
  23777. },
  23778. "TeamList": {
  23779. "description": "TeamList",
  23780. "schema": {
  23781. "type": "array",
  23782. "items": {
  23783. "$ref": "#/definitions/Team"
  23784. }
  23785. }
  23786. },
  23787. "TimelineList": {
  23788. "description": "TimelineList",
  23789. "schema": {
  23790. "type": "array",
  23791. "items": {
  23792. "$ref": "#/definitions/TimelineComment"
  23793. }
  23794. }
  23795. },
  23796. "TopicListResponse": {
  23797. "description": "TopicListResponse",
  23798. "schema": {
  23799. "type": "array",
  23800. "items": {
  23801. "$ref": "#/definitions/TopicResponse"
  23802. }
  23803. }
  23804. },
  23805. "TopicNames": {
  23806. "description": "TopicNames",
  23807. "schema": {
  23808. "$ref": "#/definitions/TopicName"
  23809. }
  23810. },
  23811. "TrackedTime": {
  23812. "description": "TrackedTime",
  23813. "schema": {
  23814. "$ref": "#/definitions/TrackedTime"
  23815. }
  23816. },
  23817. "TrackedTimeList": {
  23818. "description": "TrackedTimeList",
  23819. "schema": {
  23820. "type": "array",
  23821. "items": {
  23822. "$ref": "#/definitions/TrackedTime"
  23823. }
  23824. }
  23825. },
  23826. "User": {
  23827. "description": "User",
  23828. "schema": {
  23829. "$ref": "#/definitions/User"
  23830. }
  23831. },
  23832. "UserHeatmapData": {
  23833. "description": "UserHeatmapData",
  23834. "schema": {
  23835. "type": "array",
  23836. "items": {
  23837. "$ref": "#/definitions/UserHeatmapData"
  23838. }
  23839. }
  23840. },
  23841. "UserList": {
  23842. "description": "UserList",
  23843. "schema": {
  23844. "type": "array",
  23845. "items": {
  23846. "$ref": "#/definitions/User"
  23847. }
  23848. }
  23849. },
  23850. "UserSettings": {
  23851. "description": "UserSettings",
  23852. "schema": {
  23853. "type": "array",
  23854. "items": {
  23855. "$ref": "#/definitions/UserSettings"
  23856. }
  23857. }
  23858. },
  23859. "WatchInfo": {
  23860. "description": "WatchInfo",
  23861. "schema": {
  23862. "$ref": "#/definitions/WatchInfo"
  23863. }
  23864. },
  23865. "WikiCommitList": {
  23866. "description": "WikiCommitList",
  23867. "schema": {
  23868. "$ref": "#/definitions/WikiCommitList"
  23869. }
  23870. },
  23871. "WikiPage": {
  23872. "description": "WikiPage",
  23873. "schema": {
  23874. "$ref": "#/definitions/WikiPage"
  23875. }
  23876. },
  23877. "WikiPageList": {
  23878. "description": "WikiPageList",
  23879. "schema": {
  23880. "type": "array",
  23881. "items": {
  23882. "$ref": "#/definitions/WikiPageMetaData"
  23883. }
  23884. }
  23885. },
  23886. "conflict": {
  23887. "description": "APIConflict is a conflict empty response"
  23888. },
  23889. "empty": {
  23890. "description": "APIEmpty is an empty response"
  23891. },
  23892. "error": {
  23893. "description": "APIError is error format response",
  23894. "headers": {
  23895. "message": {
  23896. "type": "string"
  23897. },
  23898. "url": {
  23899. "type": "string"
  23900. }
  23901. }
  23902. },
  23903. "forbidden": {
  23904. "description": "APIForbiddenError is a forbidden error response",
  23905. "headers": {
  23906. "message": {
  23907. "type": "string"
  23908. },
  23909. "url": {
  23910. "type": "string"
  23911. }
  23912. }
  23913. },
  23914. "invalidTopicsError": {
  23915. "description": "APIInvalidTopicsError is error format response to invalid topics",
  23916. "headers": {
  23917. "invalidTopics": {
  23918. "type": "array",
  23919. "items": {
  23920. "type": "string"
  23921. }
  23922. },
  23923. "message": {
  23924. "type": "string"
  23925. }
  23926. }
  23927. },
  23928. "notFound": {
  23929. "description": "APINotFound is a not found empty response"
  23930. },
  23931. "parameterBodies": {
  23932. "description": "parameterBodies",
  23933. "schema": {
  23934. "$ref": "#/definitions/CreateOrUpdateSecretOption"
  23935. }
  23936. },
  23937. "redirect": {
  23938. "description": "APIRedirect is a redirect response"
  23939. },
  23940. "string": {
  23941. "description": "APIString is a string response",
  23942. "schema": {
  23943. "type": "string"
  23944. }
  23945. },
  23946. "validationError": {
  23947. "description": "APIValidationError is error format response related to input validation",
  23948. "headers": {
  23949. "message": {
  23950. "type": "string"
  23951. },
  23952. "url": {
  23953. "type": "string"
  23954. }
  23955. }
  23956. }
  23957. },
  23958. "securityDefinitions": {
  23959. "AccessToken": {
  23960. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  23961. "type": "apiKey",
  23962. "name": "access_token",
  23963. "in": "query"
  23964. },
  23965. "AuthorizationHeaderToken": {
  23966. "description": "API tokens must be prepended with \"token\" followed by a space.",
  23967. "type": "apiKey",
  23968. "name": "Authorization",
  23969. "in": "header"
  23970. },
  23971. "BasicAuth": {
  23972. "type": "basic"
  23973. },
  23974. "SudoHeader": {
  23975. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  23976. "type": "apiKey",
  23977. "name": "Sudo",
  23978. "in": "header"
  23979. },
  23980. "SudoParam": {
  23981. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  23982. "type": "apiKey",
  23983. "name": "sudo",
  23984. "in": "query"
  23985. },
  23986. "TOTPHeader": {
  23987. "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
  23988. "type": "apiKey",
  23989. "name": "X-GITEA-OTP",
  23990. "in": "header"
  23991. },
  23992. "Token": {
  23993. "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
  23994. "type": "apiKey",
  23995. "name": "token",
  23996. "in": "query"
  23997. }
  23998. },
  23999. "security": [
  24000. {
  24001. "BasicAuth": []
  24002. },
  24003. {
  24004. "Token": []
  24005. },
  24006. {
  24007. "AccessToken": []
  24008. },
  24009. {
  24010. "AuthorizationHeaderToken": []
  24011. },
  24012. {
  24013. "SudoParam": []
  24014. },
  24015. {
  24016. "SudoHeader": []
  24017. },
  24018. {
  24019. "TOTPHeader": []
  24020. }
  24021. ]
  24022. }