1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824 |
- {
- "consumes": [
- "application/json",
- "text/plain"
- ],
- "produces": [
- "application/json",
- "text/html"
- ],
- "schemes": [
- "https",
- "http"
- ],
- "swagger": "2.0",
- "info": {
- "description": "This documentation describes the Gitea API.",
- "title": "Gitea API",
- "license": {
- "name": "MIT",
- "url": "http://opensource.org/licenses/MIT"
- },
- "version": "{{AppVer | JSEscape}}"
- },
- "basePath": "{{AppSubUrl | JSEscape}}/api/v1",
- "paths": {
- "/activitypub/user-id/{user-id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "activitypub"
- ],
- "summary": "Returns the Person actor for a user",
- "operationId": "activitypubPerson",
- "parameters": [
- {
- "type": "integer",
- "description": "user ID of the user",
- "name": "user-id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ActivityPub"
- }
- }
- }
- },
- "/activitypub/user-id/{user-id}/inbox": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "activitypub"
- ],
- "summary": "Send to the inbox",
- "operationId": "activitypubPersonInbox",
- "parameters": [
- {
- "type": "integer",
- "description": "user ID of the user",
- "name": "user-id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/admin/cron": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List cron tasks",
- "operationId": "adminCronList",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CronList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/cron/{task}": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Run cron task",
- "operationId": "adminCronRun",
- "parameters": [
- {
- "type": "string",
- "description": "task to run",
- "name": "task",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/admin/emails": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List all emails",
- "operationId": "adminGetAllEmails",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/EmailList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/emails/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Search all emails",
- "operationId": "adminSearchEmails",
- "parameters": [
- {
- "type": "string",
- "description": "keyword",
- "name": "q",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/EmailList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List system's webhooks",
- "operationId": "adminListHooks",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create a hook",
- "operationId": "adminCreateHook",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/admin/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Get a hook",
- "operationId": "adminGetHook",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete a hook",
- "operationId": "adminDeleteHook",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Update a hook",
- "operationId": "adminEditHook",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to update",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/admin/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List all organizations",
- "operationId": "adminGetAllOrgs",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/runners/registration-token": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Get an global actions runner registration token",
- "operationId": "adminGetRunnerRegistrationToken",
- "responses": {
- "200": {
- "$ref": "#/responses/RegistrationToken"
- }
- }
- }
- },
- "/admin/unadopted": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List unadopted repositories",
- "operationId": "adminUnadoptedList",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "string",
- "description": "pattern of repositories to search for",
- "name": "pattern",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/StringSlice"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/unadopted/{owner}/{repo}": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Adopt unadopted files as a repository",
- "operationId": "adminAdoptRepository",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete unadopted files",
- "operationId": "adminDeleteUnadoptedRepository",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/users": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Search users according filter conditions",
- "operationId": "adminSearchUsers",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "ID of the user's login source to search for",
- "name": "source_id",
- "in": "query"
- },
- {
- "type": "string",
- "description": "user's login name to search for",
- "name": "login_name",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create a user",
- "operationId": "adminCreateUser",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateUserOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/User"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete a user",
- "operationId": "adminDeleteUser",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to delete",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "purge the user from the system completely",
- "name": "purge",
- "in": "query"
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Edit an existing user",
- "operationId": "adminEditUser",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to edit",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditUserOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/badges": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List a user's badges",
- "operationId": "adminListUserBadges",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BadgeList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Add a badge to a user",
- "operationId": "adminAddUserBadges",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/UserBadgeOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Remove a badge from a user",
- "operationId": "adminDeleteUserBadges",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/UserBadgeOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/keys": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Add a public key on behalf of a user",
- "operationId": "adminCreatePublicKey",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "key",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PublicKey"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/keys/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete a user's public key",
- "operationId": "adminDeleteUserPublicKey",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/admin/users/{username}/orgs": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create an organization",
- "operationId": "adminCreateOrg",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user that will own the created organization",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "organization",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOrgOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Organization"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/rename": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Rename a user",
- "operationId": "adminRenameUser",
- "parameters": [
- {
- "type": "string",
- "description": "existing username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/RenameUserOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/repos": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create a repository on behalf of a user",
- "operationId": "adminCreateRepo",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user. This user will own the created repository",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "repository",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/gitignore/templates": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns a list of all gitignore templates",
- "operationId": "listGitignoresTemplates",
- "responses": {
- "200": {
- "$ref": "#/responses/GitignoreTemplateList"
- }
- }
- }
- },
- "/gitignore/templates/{name}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns information about a gitignore template",
- "operationId": "getGitignoreTemplateInfo",
- "parameters": [
- {
- "type": "string",
- "description": "name of the template",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitignoreTemplateInfo"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/label/templates": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns a list of all label templates",
- "operationId": "listLabelTemplates",
- "responses": {
- "200": {
- "$ref": "#/responses/LabelTemplateList"
- }
- }
- }
- },
- "/label/templates/{name}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns all labels in a template",
- "operationId": "getLabelTemplateInfo",
- "parameters": [
- {
- "type": "string",
- "description": "name of the template",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelTemplateInfo"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/licenses": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns a list of all license templates",
- "operationId": "listLicenseTemplates",
- "responses": {
- "200": {
- "$ref": "#/responses/LicenseTemplateList"
- }
- }
- }
- },
- "/licenses/{name}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns information about a license template",
- "operationId": "getLicenseTemplateInfo",
- "parameters": [
- {
- "type": "string",
- "description": "name of the license",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LicenseTemplateInfo"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/markdown": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Render a markdown document as HTML",
- "operationId": "renderMarkdown",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MarkdownOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MarkdownRender"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/markdown/raw": {
- "post": {
- "consumes": [
- "text/plain"
- ],
- "produces": [
- "text/html"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Render raw markdown as HTML",
- "operationId": "renderMarkdownRaw",
- "parameters": [
- {
- "description": "Request body to render",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MarkdownRender"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/markup": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Render a markup document as HTML",
- "operationId": "renderMarkup",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MarkupOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MarkupRender"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/nodeinfo": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns the nodeinfo of the Gitea application",
- "operationId": "getNodeInfo",
- "responses": {
- "200": {
- "$ref": "#/responses/NodeInfo"
- }
- }
- }
- },
- "/notifications": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "List users's notification threads",
- "operationId": "notifyGetList",
- "parameters": [
- {
- "type": "boolean",
- "description": "If true, show notifications marked as read. Default value is false",
- "name": "all",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- },
- "collectionFormat": "multi",
- "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
- "name": "status-types",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "enum": [
- "issue",
- "pull",
- "commit",
- "repository"
- ],
- "type": "string"
- },
- "collectionFormat": "multi",
- "description": "filter notifications by subject type",
- "name": "subject-type",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationThreadList"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Mark notification threads as read, pinned or unread",
- "operationId": "notifyReadList",
- "parameters": [
- {
- "type": "string",
- "format": "date-time",
- "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
- "name": "last_read_at",
- "in": "query"
- },
- {
- "type": "string",
- "description": "If true, mark all notifications on this repo. Default value is false",
- "name": "all",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- },
- "collectionFormat": "multi",
- "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
- "name": "status-types",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Status to mark notifications as, Defaults to read.",
- "name": "to-status",
- "in": "query"
- }
- ],
- "responses": {
- "205": {
- "$ref": "#/responses/NotificationThreadList"
- }
- }
- }
- },
- "/notifications/new": {
- "get": {
- "tags": [
- "notification"
- ],
- "summary": "Check if unread notifications exist",
- "operationId": "notifyNewAvailable",
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationCount"
- }
- }
- }
- },
- "/notifications/threads/{id}": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Get notification thread by ID",
- "operationId": "notifyGetThread",
- "parameters": [
- {
- "type": "string",
- "description": "id of notification thread",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationThread"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Mark notification thread as read by ID",
- "operationId": "notifyReadThread",
- "parameters": [
- {
- "type": "string",
- "description": "id of notification thread",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "default": "read",
- "description": "Status to mark notifications as",
- "name": "to-status",
- "in": "query"
- }
- ],
- "responses": {
- "205": {
- "$ref": "#/responses/NotificationThread"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/org/{org}/repos": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a repository in an organization",
- "operationId": "createOrgRepoDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "name of organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get list of organizations",
- "operationId": "orgGetAll",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create an organization",
- "operationId": "orgCreate",
- "parameters": [
- {
- "name": "organization",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOrgOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Organization"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get an organization",
- "operationId": "orgGet",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization to get",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Organization"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete an organization",
- "operationId": "orgDelete",
- "parameters": [
- {
- "type": "string",
- "description": "organization that is to be deleted",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Edit an organization",
- "operationId": "orgEdit",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization to edit",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/EditOrgOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Organization"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/actions/runners/registration-token": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get an organization's actions runner registration token",
- "operationId": "orgGetRunnerRegistrationToken",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RegistrationToken"
- }
- }
- }
- },
- "/orgs/{org}/actions/secrets": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's actions secrets",
- "operationId": "orgListActionsSecrets",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/SecretList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/actions/secrets/{secretname}": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create or Update a secret value in an organization",
- "operationId": "updateOrgSecret",
- "parameters": [
- {
- "type": "string",
- "description": "name of organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the secret",
- "name": "secretname",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateOrUpdateSecretOption"
- }
- }
- ],
- "responses": {
- "201": {
- "description": "response when creating a secret"
- },
- "204": {
- "description": "response when updating a secret"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete a secret in an organization",
- "operationId": "deleteOrgSecret",
- "parameters": [
- {
- "type": "string",
- "description": "name of organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the secret",
- "name": "secretname",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "delete one secret of the organization"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/activities/feeds": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's activity feeds",
- "operationId": "orgListActivityFeeds",
- "parameters": [
- {
- "type": "string",
- "description": "name of the org",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date",
- "description": "the date of the activities to be found",
- "name": "date",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ActivityFeedsList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/avatar": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Update Avatar",
- "operationId": "orgUpdateAvatar",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/UpdateUserAvatarOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete Avatar",
- "operationId": "orgDeleteAvatar",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/blocks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List users blocked by the organization",
- "operationId": "organizationListBlocks",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/orgs/{org}/blocks/{username}": {
- "get": {
- "tags": [
- "organization"
- ],
- "summary": "Check if a user is blocked by the organization",
- "operationId": "organizationCheckUserBlock",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "user to check",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "organization"
- ],
- "summary": "Block a user",
- "operationId": "organizationBlockUser",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "user to block",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "optional note for the block",
- "name": "note",
- "in": "query"
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "tags": [
- "organization"
- ],
- "summary": "Unblock a user",
- "operationId": "organizationUnblockUser",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "user to unblock",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's webhooks",
- "operationId": "orgListHooks",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a hook",
- "operationId": "orgCreateHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a hook",
- "operationId": "orgGetHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete a hook",
- "operationId": "orgDeleteHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Update a hook",
- "operationId": "orgEditHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to update",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's labels",
- "operationId": "orgListLabels",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a label for an organization",
- "operationId": "orgCreateLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateLabelOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Label"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}/labels/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a single label",
- "operationId": "orgGetLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "organization"
- ],
- "summary": "Delete a label",
- "operationId": "orgDeleteLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Update a label",
- "operationId": "orgEditLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditLabelOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}/members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's members",
- "operationId": "orgListMembers",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/members/{username}": {
- "get": {
- "tags": [
- "organization"
- ],
- "summary": "Check if a user is a member of an organization",
- "operationId": "orgIsMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "user is a member"
- },
- "303": {
- "description": "redirection to /orgs/{org}/public_members/{username}"
- },
- "404": {
- "description": "user is not a member"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a member from an organization",
- "operationId": "orgDeleteMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "member removed"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/public_members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's public members",
- "operationId": "orgListPublicMembers",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/public_members/{username}": {
- "get": {
- "tags": [
- "organization"
- ],
- "summary": "Check if a user is a public member of an organization",
- "operationId": "orgIsPublicMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "user is a public member"
- },
- "404": {
- "description": "user is not a public member"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Publicize a user's membership",
- "operationId": "orgPublicizeMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "membership publicized"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Conceal a user's membership",
- "operationId": "orgConcealMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's repos",
- "operationId": "orgListRepos",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a repository in an organization",
- "operationId": "createOrgRepo",
- "parameters": [
- {
- "type": "string",
- "description": "name of organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/teams": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's teams",
- "operationId": "orgListTeams",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TeamList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a team",
- "operationId": "orgCreateTeam",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateTeamOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Team"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}/teams/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Search for teams within an organization",
- "operationId": "teamSearch",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "keywords to search",
- "name": "q",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include search within team description (defaults to true)",
- "name": "include_desc",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "SearchResults of a successful search",
- "schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Team"
- }
- },
- "ok": {
- "type": "boolean"
- }
- }
- }
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/packages/{owner}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "package"
- ],
- "summary": "Gets all packages of an owner",
- "operationId": "listPackages",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the packages",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- },
- {
- "enum": [
- "alpine",
- "cargo",
- "chef",
- "composer",
- "conan",
- "conda",
- "container",
- "cran",
- "debian",
- "generic",
- "go",
- "helm",
- "maven",
- "npm",
- "nuget",
- "pub",
- "pypi",
- "rpm",
- "rubygems",
- "swift",
- "vagrant"
- ],
- "type": "string",
- "description": "package type filter",
- "name": "type",
- "in": "query"
- },
- {
- "type": "string",
- "description": "name filter",
- "name": "q",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PackageList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/packages/{owner}/{type}/{name}/{version}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "package"
- ],
- "summary": "Gets a package",
- "operationId": "getPackage",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the package",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "type of the package",
- "name": "type",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the package",
- "name": "name",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "version of the package",
- "name": "version",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Package"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "package"
- ],
- "summary": "Delete a package",
- "operationId": "deletePackage",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the package",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "type of the package",
- "name": "type",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the package",
- "name": "name",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "version of the package",
- "name": "version",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/packages/{owner}/{type}/{name}/{version}/files": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "package"
- ],
- "summary": "Gets all files of a package",
- "operationId": "listPackageFiles",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the package",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "type of the package",
- "name": "type",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the package",
- "name": "name",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "version of the package",
- "name": "version",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PackageFileList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/issues/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Search for issues across the repositories that the user has access to",
- "operationId": "issueSearchIssues",
- "parameters": [
- {
- "type": "string",
- "description": "whether issue is open or closed",
- "name": "state",
- "in": "query"
- },
- {
- "type": "string",
- "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
- "name": "labels",
- "in": "query"
- },
- {
- "type": "string",
- "description": "comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded",
- "name": "milestones",
- "in": "query"
- },
- {
- "type": "string",
- "description": "search string",
- "name": "q",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "repository to prioritize in the results",
- "name": "priority_repo_id",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter by type (issues / pulls) if set",
- "name": "type",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "filter (issues / pulls) assigned to you, default is false",
- "name": "assigned",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "filter (issues / pulls) created by you, default is false",
- "name": "created",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "filter (issues / pulls) mentioning you, default is false",
- "name": "mentioned",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "filter pulls requesting your review, default is false",
- "name": "review_requested",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "filter pulls reviewed by you, default is false",
- "name": "reviewed",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter by owner",
- "name": "owner",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter by team (requires organization owner parameter to be provided)",
- "name": "team",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- }
- }
- }
- },
- "/repos/migrate": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Migrate a remote git repository",
- "operationId": "repoMigrate",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MigrateRepoOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "409": {
- "description": "The repository with the same name already exists."
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Search for repositories",
- "operationId": "repoSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keyword",
- "name": "q",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "Limit search to repositories with keyword as topic",
- "name": "topic",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include search of keyword within repository description",
- "name": "includeDesc",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "search only for repos that the user with the given id owns or contributes to",
- "name": "uid",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "repo owner to prioritize in the results",
- "name": "priority_owner_id",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "search only for repos that belong to the given team id",
- "name": "team_id",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "search only for repos that the user with the given id has starred",
- "name": "starredBy",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include private repositories this user has access to (defaults to true)",
- "name": "private",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "show only pubic, private or all repositories (defaults to all)",
- "name": "is_private",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include template repositories this user has access to (defaults to true)",
- "name": "template",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "show only archived, non-archived or all repositories (defaults to all)",
- "name": "archived",
- "in": "query"
- },
- {
- "type": "string",
- "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
- "name": "mode",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "if `uid` is given, search only for repos that the user owns",
- "name": "exclusive",
- "in": "query"
- },
- {
- "type": "string",
- "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
- "name": "sort",
- "in": "query"
- },
- {
- "type": "string",
- "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
- "name": "order",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/SearchResults"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository",
- "operationId": "repoGet",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a repository",
- "operationId": "repoDelete",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to delete",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to delete",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a repository's properties. Only fields that are set will be changed.",
- "operationId": "repoEdit",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to edit",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to edit",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "description": "Properties of a repo that you can edit",
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditRepoOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/actions/secrets/{secretname}": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create or Update a secret value in a repository",
- "operationId": "updateRepoSecret",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repository",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repository",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the secret",
- "name": "secretname",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateOrUpdateSecretOption"
- }
- }
- ],
- "responses": {
- "201": {
- "description": "response when creating a secret"
- },
- "204": {
- "description": "response when updating a secret"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a secret in a repository",
- "operationId": "deleteRepoSecret",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repository",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repository",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the secret",
- "name": "secretname",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "delete one secret of the organization"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/activities/feeds": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's activity feeds",
- "operationId": "repoListActivityFeeds",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date",
- "description": "the date of the activities to be found",
- "name": "date",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ActivityFeedsList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/archive/{archive}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get an archive of a repository",
- "operationId": "repoGetArchive",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "the git reference for download with attached archive format (e.g. master.zip)",
- "name": "archive",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/assignees": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Return all users that have write access and can be assigned to issues",
- "operationId": "repoGetAssignees",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/avatar": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update avatar",
- "operationId": "repoUpdateAvatar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/UpdateRepoAvatarOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete avatar",
- "operationId": "repoDeleteAvatar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branch_protections": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List branch protections for a repository",
- "operationId": "repoListBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchProtectionList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a branch protections for a repository",
- "operationId": "repoCreateBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateBranchProtectionOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/BranchProtection"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branch_protections/{name}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a specific branch protection for the repository",
- "operationId": "repoGetBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of protected branch",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchProtection"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a specific branch protection for the repository",
- "operationId": "repoDeleteBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of protected branch",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
- "operationId": "repoEditBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of protected branch",
- "name": "name",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditBranchProtectionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchProtection"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branches": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's branches",
- "operationId": "repoListBranches",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a branch",
- "operationId": "repoCreateBranch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateBranchRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Branch"
- },
- "403": {
- "description": "The branch is archived or a mirror."
- },
- "404": {
- "description": "The old branch does not exist."
- },
- "409": {
- "description": "The branch with the same name already exists."
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branches/{branch}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
- "operationId": "repoGetBranch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "branch to get",
- "name": "branch",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Branch"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a specific branch from a repository",
- "operationId": "repoDeleteBranch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "branch to delete",
- "name": "branch",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's collaborators",
- "operationId": "repoListCollaborators",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators/{collaborator}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Check if a user is a collaborator of a repository",
- "operationId": "repoCheckCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator",
- "name": "collaborator",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a collaborator to a repository",
- "operationId": "repoAddCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator to add",
- "name": "collaborator",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/AddCollaboratorOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a collaborator from a repository",
- "operationId": "repoDeleteCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator to delete",
- "name": "collaborator",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators/{collaborator}/permission": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get repository permissions for a user",
- "operationId": "repoGetRepoPermissions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator",
- "name": "collaborator",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepoCollaboratorPermission"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a list of all commits from a repository",
- "operationId": "repoGetAllCommits",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "SHA or branch to start listing commits from (usually 'master')",
- "name": "sha",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filepath of a file/dir",
- "name": "path",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include diff stats for every commit (disable for speedup, default 'true')",
- "name": "stat",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include verification for every commit (disable for speedup, default 'true')",
- "name": "verification",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
- "name": "files",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results (ignored if used with 'path')",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "string",
- "description": "commits that match the given specifier will not be listed.",
- "name": "not",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommitList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/EmptyRepository"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits/{ref}/status": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's combined status, by branch/tag/commit reference",
- "operationId": "repoGetCombinedStatusByRef",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of branch/tag/commit",
- "name": "ref",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CombinedStatus"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits/{ref}/statuses": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's statuses, by branch/tag/commit reference",
- "operationId": "repoListStatusesByRef",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of branch/tag/commit",
- "name": "ref",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "oldest",
- "recentupdate",
- "leastupdate",
- "leastindex",
- "highestindex"
- ],
- "type": "string",
- "description": "type of sort",
- "name": "sort",
- "in": "query"
- },
- {
- "enum": [
- "pending",
- "success",
- "error",
- "failure",
- "warning"
- ],
- "type": "string",
- "description": "type of state",
- "name": "state",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommitStatusList"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits/{sha}/pull": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get the pull request of the commit",
- "operationId": "repoGetCommitPullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "SHA of the commit to get",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequest"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/contents": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the metadata of all the entries of the root dir",
- "operationId": "repoGetContentsList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ContentsListResponse"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Modify multiple files in a repository",
- "operationId": "repoChangeFiles",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ChangeFilesOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/FilesResponse"
- },
- "403": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/contents/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
- "operationId": "repoGetContents",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the dir, file, symlink or submodule in the repo",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ContentsResponse"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a file in a repository",
- "operationId": "repoUpdateFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to update",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/UpdateFileOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/FileResponse"
- },
- "403": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a file in a repository",
- "operationId": "repoCreateFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to create",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateFileOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/FileResponse"
- },
- "403": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a file in a repository",
- "operationId": "repoDeleteFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to delete",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DeleteFileOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/FileDeleteResponse"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/diffpatch": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Apply diff patch to repository",
- "operationId": "repoApplyDiffPatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/UpdateFileOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/FileResponse"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/editorconfig/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get the EditorConfig definitions of a file in a repository",
- "operationId": "repoGetEditorConfig",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "filepath of file to get",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/forks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's forks",
- "operationId": "listForks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Fork a repository",
- "operationId": "createFork",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to fork",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to fork",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateForkOption"
- }
- }
- ],
- "responses": {
- "202": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "The repository with the same name already exists."
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/blobs/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the blob of a repository.",
- "operationId": "GetBlob",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitBlobResponse"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/commits/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a single commit from a repository",
- "operationId": "repoGetSingleCommit",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "a git ref or commit sha",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "include diff stats for every commit (disable for speedup, default 'true')",
- "name": "stat",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include verification for every commit (disable for speedup, default 'true')",
- "name": "verification",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
- "name": "files",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Commit"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/commits/{sha}.{diffType}": {
- "get": {
- "produces": [
- "text/plain"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's diff or patch",
- "operationId": "repoDownloadCommitDiffOrPatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "SHA of the commit to get",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "diff",
- "patch"
- ],
- "type": "string",
- "description": "whether the output is diff or patch",
- "name": "diffType",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/string"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/notes/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a note corresponding to a single commit from a repository",
- "operationId": "repoGetNote",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "a git ref or commit sha",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "include verification for every commit (disable for speedup, default 'true')",
- "name": "verification",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
- "name": "files",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Note"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/refs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get specified ref or filtered repository's refs",
- "operationId": "repoListAllGitRefs",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReferenceList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/refs/{ref}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get specified ref or filtered repository's refs",
- "operationId": "repoListGitRefs",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "part or full name of the ref",
- "name": "ref",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReferenceList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/tags/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
- "operationId": "GetAnnotatedTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AnnotatedTag"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/trees/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the tree of a repository.",
- "operationId": "GetTree",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "show all directories and files",
- "name": "recursive",
- "in": "query"
- },
- {
- "type": "integer",
- "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",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "number of items per page",
- "name": "per_page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitTreeResponse"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List the hooks in a repository",
- "operationId": "repoListHooks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a hook",
- "operationId": "repoCreateHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/git": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List the Git hooks in a repository",
- "operationId": "repoListGitHooks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHookList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/git/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a Git hook",
- "operationId": "repoGetGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a Git hook in a repository",
- "operationId": "repoDeleteGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a Git hook in a repository",
- "operationId": "repoEditGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditGitHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a hook",
- "operationId": "repoGetHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a hook in a repository",
- "operationId": "repoDeleteHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a hook in a repository",
- "operationId": "repoEditHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the hook",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/{id}/tests": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Test a push webhook",
- "operationId": "repoTestHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to test",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag, indicates which commit will be loaded to the webhook payload.",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issue_config": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Returns the issue config for a repo",
- "operationId": "repoGetIssueConfig",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepoIssueConfig"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issue_config/validate": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Returns the validation information for a issue config",
- "operationId": "repoValidateIssueConfig",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepoIssueConfigValidation"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issue_templates": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get available issue templates for a repository",
- "operationId": "repoGetIssueTemplates",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueTemplates"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List a repository's issues",
- "operationId": "issueListIssues",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "closed",
- "open",
- "all"
- ],
- "type": "string",
- "description": "whether issue is open or closed",
- "name": "state",
- "in": "query"
- },
- {
- "type": "string",
- "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
- "name": "labels",
- "in": "query"
- },
- {
- "type": "string",
- "description": "search string",
- "name": "q",
- "in": "query"
- },
- {
- "enum": [
- "issues",
- "pulls"
- ],
- "type": "string",
- "description": "filter by type (issues / pulls) if set",
- "name": "type",
- "in": "query"
- },
- {
- "type": "string",
- "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",
- "name": "milestones",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show items updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show items updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Only show items which were created by the the given user",
- "name": "created_by",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Only show items for which the given user is assigned",
- "name": "assigned_by",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Only show items in which the given user was mentioned",
- "name": "mentioned_by",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "issueCreateIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateIssueOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "412": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List all comments in a repository",
- "operationId": "issueGetRepoComments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated since the provided time are returned.",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated before the provided time are returned.",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommentList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments/{id}": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a comment",
- "operationId": "issueGetComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- },
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a comment",
- "operationId": "issueDeleteComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of comment to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit a comment",
- "operationId": "issueEditComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueCommentOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- },
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments/{id}/assets": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List comment's attachments",
- "operationId": "issueListIssueCommentAttachments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AttachmentList"
- },
- "404": {
- "$ref": "#/responses/error"
- }
- }
- },
- "post": {
- "consumes": [
- "multipart/form-data"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create a comment attachment",
- "operationId": "issueCreateIssueCommentAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the attachment",
- "name": "name",
- "in": "query"
- },
- {
- "type": "file",
- "description": "attachment to upload",
- "name": "attachment",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a comment attachment",
- "operationId": "issueGetIssueCommentAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to get",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Attachment"
- },
- "404": {
- "$ref": "#/responses/error"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Delete a comment attachment",
- "operationId": "issueDeleteIssueCommentAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to delete",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit a comment attachment",
- "operationId": "issueEditIssueCommentAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to edit",
- "name": "attachment_id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditAttachmentOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- },
- "404": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a list of reactions from a comment of an issue",
- "operationId": "issueGetCommentReactions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReactionList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a reaction to a comment of an issue",
- "operationId": "issuePostCommentReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Reaction"
- },
- "201": {
- "$ref": "#/responses/Reaction"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove a reaction from a comment of an issue",
- "operationId": "issueDeleteCommentReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/pinned": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's pinned issues",
- "operationId": "repoListPinnedIssues",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get an issue",
- "operationId": "issueGetIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to get",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Issue"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete an issue",
- "operationId": "issueDelete",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of issue to delete",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "issueEditIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to edit",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "412": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/assets": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List issue's attachments",
- "operationId": "issueListIssueAttachments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AttachmentList"
- },
- "404": {
- "$ref": "#/responses/error"
- }
- }
- },
- "post": {
- "consumes": [
- "multipart/form-data"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create an issue attachment",
- "operationId": "issueCreateIssueAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the attachment",
- "name": "name",
- "in": "query"
- },
- {
- "type": "file",
- "description": "attachment to upload",
- "name": "attachment",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get an issue attachment",
- "operationId": "issueGetIssueAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to get",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Attachment"
- },
- "404": {
- "$ref": "#/responses/error"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Delete an issue attachment",
- "operationId": "issueDeleteIssueAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to delete",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit an issue attachment",
- "operationId": "issueEditIssueAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to edit",
- "name": "attachment_id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditAttachmentOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- },
- "404": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/blocks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List issues that are blocked by this issue",
- "operationId": "issueListBlocks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Block the issue given in the body by the issue in path",
- "operationId": "issueCreateIssueBlocking",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueMeta"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- },
- "404": {
- "description": "the issue does not exist"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Unblock the issue given in the body by the issue in path",
- "operationId": "issueRemoveIssueBlocking",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueMeta"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Issue"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List all comments on an issue",
- "operationId": "issueGetComments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated since the specified time are returned.",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated before the provided time are returned.",
- "name": "before",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommentList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a comment to an issue",
- "operationId": "issueCreateComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateIssueCommentOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Comment"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a comment",
- "operationId": "issueDeleteCommentDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "this parameter is ignored",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of comment to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit a comment",
- "operationId": "issueEditCommentDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "this parameter is ignored",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueCommentOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- },
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/deadline": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "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.",
- "operationId": "issueEditIssueDeadline",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to create or update a deadline on",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditDeadlineOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/IssueDeadline"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/dependencies": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List an issue's dependencies, i.e all issues that block this issue.",
- "operationId": "issueListIssueDependencies",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Make the issue in the url depend on the issue in the form.",
- "operationId": "issueCreateIssueDependencies",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueMeta"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- },
- "404": {
- "description": "the issue does not exist"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove an issue dependency",
- "operationId": "issueRemoveIssueDependencies",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueMeta"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Issue"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get an issue's labels",
- "operationId": "issueGetLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Replace an issue's labels",
- "operationId": "issueReplaceLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueLabelsOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a label to an issue",
- "operationId": "issueAddLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueLabelsOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove all labels from an issue",
- "operationId": "issueClearLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove a label from an issue",
- "operationId": "issueRemoveLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to remove",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/pin": {
- "post": {
- "tags": [
- "issue"
- ],
- "summary": "Pin an Issue",
- "operationId": "pinIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of issue to pin",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Unpin an Issue",
- "operationId": "unpinIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of issue to unpin",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/pin/{position}": {
- "patch": {
- "tags": [
- "issue"
- ],
- "summary": "Moves the Pin to the given Position",
- "operationId": "moveIssuePin",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "the new position",
- "name": "position",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/reactions": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a list reactions of an issue",
- "operationId": "issueGetIssueReactions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReactionList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a reaction to an issue",
- "operationId": "issuePostIssueReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Reaction"
- },
- "201": {
- "$ref": "#/responses/Reaction"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove a reaction from an issue",
- "operationId": "issueDeleteIssueReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Delete an issue's existing stopwatch.",
- "operationId": "issueDeleteStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to stop the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "Cannot cancel a non existent stopwatch"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Start stopwatch on an issue.",
- "operationId": "issueStartStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to create the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "Cannot start a stopwatch again if it already exists"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Stop an issue's existing stopwatch.",
- "operationId": "issueStopStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to stop the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "Cannot stop a non existent stopwatch"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get users who subscribed on an issue.",
- "operationId": "issueSubscriptions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Check if user is subscribed to an issue",
- "operationId": "issueCheckSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WatchInfo"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Subscribe user to issue",
- "operationId": "issueAddSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "user to subscribe",
- "name": "user",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Already subscribed"
- },
- "201": {
- "description": "Successfully Subscribed"
- },
- "304": {
- "description": "User can only subscribe itself if he is no admin"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Unsubscribe user from issue",
- "operationId": "issueDeleteSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "user witch unsubscribe",
- "name": "user",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Already unsubscribed"
- },
- "201": {
- "description": "Successfully Unsubscribed"
- },
- "304": {
- "description": "User can only subscribe itself if he is no admin"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/timeline": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List all comments and events on an issue",
- "operationId": "issueGetCommentsAndTimeline",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated since the specified time are returned.",
- "name": "since",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated before the provided time are returned.",
- "name": "before",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TimelineList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List an issue's tracked times",
- "operationId": "issueTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "optional filter by user (available for issue managers)",
- "name": "user",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add tracked time to a issue",
- "operationId": "issueAddTime",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/AddTimeOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTime"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Reset a tracked time of an issue",
- "operationId": "issueResetTime",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to add tracked time to",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Delete specific tracked time",
- "operationId": "issueDeleteTime",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of time to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's keys",
- "operationId": "repoListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "the key_id to search for",
- "name": "key_id",
- "in": "query"
- },
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/DeployKeyList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a key to a repository",
- "operationId": "repoCreateKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/DeployKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository's key by id",
- "operationId": "repoGetKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/DeployKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a key from a repository",
- "operationId": "repoDeleteKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get all of a repository's labels",
- "operationId": "issueListLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create a label",
- "operationId": "issueCreateLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateLabelOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Label"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/labels/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a single label",
- "operationId": "issueGetLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a label",
- "operationId": "issueDeleteLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Update a label",
- "operationId": "issueEditLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditLabelOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/languages": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get languages and number of bytes of code written",
- "operationId": "repoGetLanguages",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LanguageStatistics"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/media/{filepath}": {
- "get": {
- "tags": [
- "repository"
- ],
- "summary": "Get a file or it's LFS object from a repository",
- "operationId": "repoGetRawFileOrLFS",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "filepath of the file to get",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "Returns raw file content."
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/milestones": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get all of a repository's opened milestones",
- "operationId": "issueGetMilestonesList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "Milestone state, Recognized values are open, closed and all. Defaults to \"open\"",
- "name": "state",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter by milestone name",
- "name": "name",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MilestoneList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create a milestone",
- "operationId": "issueCreateMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateMilestoneOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Milestone"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/milestones/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a milestone",
- "operationId": "issueGetMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "the milestone to get, identified by ID and if not available by name",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Milestone"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a milestone",
- "operationId": "issueDeleteMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "the milestone to delete, identified by ID and if not available by name",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Update a milestone",
- "operationId": "issueEditMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "the milestone to edit, identified by ID and if not available by name",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditMilestoneOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Milestone"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/mirror-sync": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Sync a mirrored repository",
- "operationId": "repoMirrorSync",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to sync",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to sync",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/new_pin_allowed": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Returns if new Issue Pins are allowed",
- "operationId": "repoNewPinAllowed",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepoNewIssuePinsAllowed"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/notifications": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "List users's notification threads on a specific repo",
- "operationId": "notifyGetRepoList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "If true, show notifications marked as read. Default value is false",
- "name": "all",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- },
- "collectionFormat": "multi",
- "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
- "name": "status-types",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "enum": [
- "issue",
- "pull",
- "commit",
- "repository"
- ],
- "type": "string"
- },
- "collectionFormat": "multi",
- "description": "filter notifications by subject type",
- "name": "subject-type",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationThreadList"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Mark notification threads as read, pinned or unread on a specific repo",
- "operationId": "notifyReadRepoList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "If true, mark all notifications on this repo. Default value is false",
- "name": "all",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- },
- "collectionFormat": "multi",
- "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
- "name": "status-types",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Status to mark notifications as. Defaults to read.",
- "name": "to-status",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
- "name": "last_read_at",
- "in": "query"
- }
- ],
- "responses": {
- "205": {
- "$ref": "#/responses/NotificationThreadList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's pull requests",
- "operationId": "repoListPullRequests",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "closed",
- "open",
- "all"
- ],
- "type": "string",
- "description": "State of pull request: open or closed (optional)",
- "name": "state",
- "in": "query"
- },
- {
- "enum": [
- "oldest",
- "recentupdate",
- "leastupdate",
- "mostcomment",
- "leastcomment",
- "priority"
- ],
- "type": "string",
- "description": "Type of sort",
- "name": "sort",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "ID of the milestone",
- "name": "milestone",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "collectionFormat": "multi",
- "description": "Label IDs",
- "name": "labels",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequestList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a pull request",
- "operationId": "repoCreatePullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreatePullRequestOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PullRequest"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/pinned": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's pinned pull requests",
- "operationId": "repoListPinnedPullRequests",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequestList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{base}/{head}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a pull request by base and head",
- "operationId": "repoGetPullRequestByBaseHead",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "base of the pull request to get",
- "name": "base",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "head of the pull request to get",
- "name": "head",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequest"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a pull request",
- "operationId": "repoGetPullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to get",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequest"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "repoEditPullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to edit",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditPullRequestOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PullRequest"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/error"
- },
- "412": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}.{diffType}": {
- "get": {
- "produces": [
- "text/plain"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a pull request diff or patch",
- "operationId": "repoDownloadPullDiffOrPatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to get",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "diff",
- "patch"
- ],
- "type": "string",
- "description": "whether the output is diff or patch",
- "name": "diffType",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "whether to include binary file changes. if true, the diff is applicable with `git apply`",
- "name": "binary",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/string"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/commits": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get commits for a pull request",
- "operationId": "repoGetPullRequestCommits",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to get",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include verification for every commit (disable for speedup, default 'true')",
- "name": "verification",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include a list of affected files for every commit (disable for speedup, default 'true')",
- "name": "files",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommitList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/files": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get changed files for a pull request",
- "operationId": "repoGetPullRequestFiles",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to get",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "skip to given file",
- "name": "skip-to",
- "in": "query"
- },
- {
- "enum": [
- "ignore-all",
- "ignore-change",
- "ignore-eol",
- "show-all"
- ],
- "type": "string",
- "description": "whitespace behavior",
- "name": "whitespace",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ChangedFileList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/merge": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Check if a pull request has been merged",
- "operationId": "repoPullRequestIsMerged",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "pull request has been merged"
- },
- "404": {
- "description": "pull request has not been merged"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Merge a pull request",
- "operationId": "repoMergePullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to merge",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MergePullRequestOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/empty"
- },
- "409": {
- "$ref": "#/responses/error"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Cancel the scheduled auto merge for the given pull request",
- "operationId": "repoCancelScheduledAutoMerge",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to merge",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/requested_reviewers": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "create review requests for a pull request",
- "operationId": "repoCreatePullReviewRequests",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/PullReviewRequestOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PullReviewList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "cancel review requests for a pull request",
- "operationId": "repoDeletePullReviewRequests",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/PullReviewRequestOptions"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/reviews": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List all reviews for a pull request",
- "operationId": "repoListPullReviews",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullReviewList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a review to an pull request",
- "operationId": "repoCreatePullReview",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreatePullReviewOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullReview"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a specific review for a pull request",
- "operationId": "repoGetPullReview",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the review",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullReview"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Submit a pending review to an pull request",
- "operationId": "repoSubmitPullReview",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the review",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/SubmitPullReviewOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullReview"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a specific review from a pull request",
- "operationId": "repoDeletePullReview",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the review",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a specific review for a pull request",
- "operationId": "repoGetPullReviewComments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the review",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullReviewCommentList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Dismiss a review for a pull request",
- "operationId": "repoDismissPullReview",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the review",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DismissPullReviewOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullReview"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Cancel to dismiss a review for a pull request",
- "operationId": "repoUnDismissPullReview",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the review",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullReview"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/update": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Merge PR's baseBranch into headBranch",
- "operationId": "repoUpdatePullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to get",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "merge",
- "rebase"
- ],
- "type": "string",
- "description": "how to update pull request",
- "name": "style",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/push_mirrors": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get all push mirrors of the repository",
- "operationId": "repoListPushMirrors",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PushMirrorList"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "add a push mirror to the repository",
- "operationId": "repoAddPushMirror",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreatePushMirrorOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PushMirror"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/push_mirrors-sync": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Sync all push mirrored repository",
- "operationId": "repoPushMirrorSync",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to sync",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to sync",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/push_mirrors/{name}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get push mirror of the repository by remoteName",
- "operationId": "repoGetPushMirrorByRemoteName",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "remote name of push mirror",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PushMirror"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "deletes a push mirror from a repository by remoteName",
- "operationId": "repoDeletePushMirror",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "remote name of the pushMirror",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/raw/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a file from a repository",
- "operationId": "repoGetRawFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "filepath of the file to get",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "Returns raw file content."
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's releases",
- "operationId": "repoListReleases",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "filter (exclude / include) drafts, if you dont have repo write access none will show",
- "name": "draft",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "filter (exclude / include) pre-releases",
- "name": "pre-release",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReleaseList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a release",
- "operationId": "repoCreateRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateReleaseOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Release"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/latest": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at",
- "operationId": "repoGetLatestRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/tags/{tag}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a release by tag name",
- "operationId": "repoGetReleaseByTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "tag name of the release to get",
- "name": "tag",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a release by tag name",
- "operationId": "repoDeleteReleaseByTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "tag name of the release to delete",
- "name": "tag",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a release",
- "operationId": "repoGetRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a release",
- "operationId": "repoDeleteRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a release",
- "operationId": "repoEditRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReleaseOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}/assets": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List release's attachments",
- "operationId": "repoListReleaseAttachments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AttachmentList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "multipart/form-data",
- "application/octet-stream"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a release attachment",
- "operationId": "repoCreateReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the attachment",
- "name": "name",
- "in": "query"
- },
- {
- "type": "file",
- "description": "attachment to upload",
- "name": "attachment",
- "in": "formData"
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a release attachment",
- "operationId": "repoGetReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to get",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Attachment"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a release attachment",
- "operationId": "repoDeleteReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to delete",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a release attachment",
- "operationId": "repoEditReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to edit",
- "name": "attachment_id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditAttachmentOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/reviewers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Return all users that can be requested to review in this repo",
- "operationId": "repoGetReviewers",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/runners/registration-token": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository's actions runner registration token",
- "operationId": "repoGetRunnerRegistrationToken",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RegistrationToken"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/signing-key.gpg": {
- "get": {
- "produces": [
- "text/plain"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get signing-key.gpg for given repository",
- "operationId": "repoSigningKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "GPG armored public key",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/stargazers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's stargazers",
- "operationId": "repoListStargazers",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/statuses/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's statuses",
- "operationId": "repoListStatuses",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "oldest",
- "recentupdate",
- "leastupdate",
- "leastindex",
- "highestindex"
- ],
- "type": "string",
- "description": "type of sort",
- "name": "sort",
- "in": "query"
- },
- {
- "enum": [
- "pending",
- "success",
- "error",
- "failure",
- "warning"
- ],
- "type": "string",
- "description": "type of state",
- "name": "state",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommitStatusList"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a commit status",
- "operationId": "repoCreateStatus",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateStatusOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/CommitStatus"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/subscribers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's watchers",
- "operationId": "repoListSubscribers",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/subscription": {
- "get": {
- "tags": [
- "repository"
- ],
- "summary": "Check if the current user is watching a repo",
- "operationId": "userCurrentCheckSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WatchInfo"
- },
- "404": {
- "description": "User is not watching this repo or repo do not exist"
- }
- }
- },
- "put": {
- "tags": [
- "repository"
- ],
- "summary": "Watch a repo",
- "operationId": "userCurrentPutSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WatchInfo"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Unwatch a repo",
- "operationId": "userCurrentDeleteSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/tags": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's tags",
- "operationId": "repoListTags",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, default maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TagList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a new git tag in a repository",
- "operationId": "repoCreateTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateTagOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Tag"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/empty"
- },
- "409": {
- "$ref": "#/responses/conflict"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/tags/{tag}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get the tag of a repository by tag name",
- "operationId": "repoGetTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of tag",
- "name": "tag",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Tag"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a repository's tag by name",
- "operationId": "repoDeleteTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of tag to delete",
- "name": "tag",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/empty"
- },
- "409": {
- "$ref": "#/responses/conflict"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/teams": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's teams",
- "operationId": "repoListTeams",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TeamList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/teams/{team}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Check if a team is assigned to a repository",
- "operationId": "repoCheckTeam",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "team name",
- "name": "team",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Team"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/error"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a team to a repository",
- "operationId": "repoAddTeam",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "team name",
- "name": "team",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a team from a repository",
- "operationId": "repoDeleteTeam",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "team name",
- "name": "team",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "405": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's tracked times",
- "operationId": "repoTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "optional filter by user (available for issue managers)",
- "name": "user",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/times/{user}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a user's tracked times in a repo",
- "operationId": "userTrackedTimes",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of user",
- "name": "user",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/topics": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get list of topics that a repository has",
- "operationId": "repoListTopics",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TopicNames"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Replace list of topics for a repository",
- "operationId": "repoUpdateTopics",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/RepoTopicOptions"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/invalidTopicsError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/topics/{topic}": {
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a topic to a repository",
- "operationId": "repoAddTopic",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the topic to add",
- "name": "topic",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/invalidTopicsError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a topic from a repository",
- "operationId": "repoDeleteTopic",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the topic to delete",
- "name": "topic",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/invalidTopicsError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/transfer": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Transfer a repo ownership",
- "operationId": "repoTransfer",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to transfer",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to transfer",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "description": "Transfer Options",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/TransferRepoOption"
- }
- }
- ],
- "responses": {
- "202": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/transfer/accept": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Accept a repo transfer",
- "operationId": "acceptRepoTransfer",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to transfer",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to transfer",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "202": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/transfer/reject": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Reject a repo transfer",
- "operationId": "rejectRepoTransfer",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to transfer",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to transfer",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/wiki/new": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a wiki page",
- "operationId": "repoCreateWikiPage",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateWikiPageOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/WikiPage"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/wiki/page/{pageName}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a wiki page",
- "operationId": "repoGetWikiPage",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the page",
- "name": "pageName",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WikiPage"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a wiki page",
- "operationId": "repoDeleteWikiPage",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the page",
- "name": "pageName",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a wiki page",
- "operationId": "repoEditWikiPage",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the page",
- "name": "pageName",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateWikiPageOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WikiPage"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "423": {
- "$ref": "#/responses/repoArchivedError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/wiki/pages": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get all wiki pages",
- "operationId": "repoGetWikiPages",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WikiPageList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/wiki/revisions/{pageName}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get revisions of a wiki page",
- "operationId": "repoGetWikiPageRevisions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the page",
- "name": "pageName",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WikiCommitList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{template_owner}/{template_repo}/generate": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a repository using a template",
- "operationId": "generateRepo",
- "parameters": [
- {
- "type": "string",
- "description": "name of the template repository owner",
- "name": "template_owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the template repository",
- "name": "template_repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/GenerateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "The repository with the same name already exists."
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repositories/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository by id",
- "operationId": "repoGetByID",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the repo to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/settings/api": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "settings"
- ],
- "summary": "Get instance's global settings for api",
- "operationId": "getGeneralAPISettings",
- "responses": {
- "200": {
- "$ref": "#/responses/GeneralAPISettings"
- }
- }
- }
- },
- "/settings/attachment": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "settings"
- ],
- "summary": "Get instance's global settings for Attachment",
- "operationId": "getGeneralAttachmentSettings",
- "responses": {
- "200": {
- "$ref": "#/responses/GeneralAttachmentSettings"
- }
- }
- }
- },
- "/settings/repository": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "settings"
- ],
- "summary": "Get instance's global settings for repositories",
- "operationId": "getGeneralRepositorySettings",
- "responses": {
- "200": {
- "$ref": "#/responses/GeneralRepoSettings"
- }
- }
- }
- },
- "/settings/ui": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "settings"
- ],
- "summary": "Get instance's global settings for ui",
- "operationId": "getGeneralUISettings",
- "responses": {
- "200": {
- "$ref": "#/responses/GeneralUISettings"
- }
- }
- }
- },
- "/signing-key.gpg": {
- "get": {
- "produces": [
- "text/plain"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Get default signing-key.gpg",
- "operationId": "getSigningKey",
- "responses": {
- "200": {
- "description": "GPG armored public key",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "/teams/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a team",
- "operationId": "orgGetTeam",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Team"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "organization"
- ],
- "summary": "Delete a team",
- "operationId": "orgDeleteTeam",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "team deleted"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Edit a team",
- "operationId": "orgEditTeam",
- "parameters": [
- {
- "type": "integer",
- "description": "id of the team to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditTeamOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Team"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/teams/{id}/activities/feeds": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a team's activity feeds",
- "operationId": "orgListTeamActivityFeeds",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date",
- "description": "the date of the activities to be found",
- "name": "date",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ActivityFeedsList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/teams/{id}/members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a team's members",
- "operationId": "orgListTeamMembers",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/teams/{id}/members/{username}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a particular member of team",
- "operationId": "orgListTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the member to list",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Add a team member",
- "operationId": "orgAddTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user to add",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a team member",
- "operationId": "orgRemoveTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user to remove",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/teams/{id}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a team's repos",
- "operationId": "orgListTeamRepos",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/teams/{id}/repos/{org}/{repo}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a particular repo of team",
- "operationId": "orgListTeamRepo",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "organization that owns the repo to list",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to list",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Add a repository to a team",
- "operationId": "orgAddTeamRepository",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "organization that owns the repo to add",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to add",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "description": "This does not delete the repository, it only removes the repository from the team.",
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a repository from a team",
- "operationId": "orgRemoveTeamRepository",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "organization that owns the repo to remove",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to remove",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/topics/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "search topics via keyword",
- "operationId": "topicSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keywords to search",
- "name": "q",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TopicListResponse"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get the authenticated user",
- "operationId": "userGetCurrent",
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- }
- }
- }
- },
- "/user/actions/runners/registration-token": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get an user's actions runner registration token",
- "operationId": "userGetRunnerRegistrationToken",
- "responses": {
- "200": {
- "$ref": "#/responses/RegistrationToken"
- }
- }
- }
- },
- "/user/actions/secrets/{secretname}": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create or Update a secret value in a user scope",
- "operationId": "updateUserSecret",
- "parameters": [
- {
- "type": "string",
- "description": "name of the secret",
- "name": "secretname",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateOrUpdateSecretOption"
- }
- }
- ],
- "responses": {
- "201": {
- "description": "response when creating a secret"
- },
- "204": {
- "description": "response when updating a secret"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete a secret in a user scope",
- "operationId": "deleteUserSecret",
- "parameters": [
- {
- "type": "string",
- "description": "name of the secret",
- "name": "secretname",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "delete one secret of the user"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/applications/oauth2": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's oauth2 applications",
- "operationId": "userGetOauth2Application",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OAuth2ApplicationList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "creates a new OAuth2 application",
- "operationId": "userCreateOAuth2Application",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/OAuth2Application"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/user/applications/oauth2/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "get an OAuth2 Application",
- "operationId": "userGetOAuth2Application",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "Application ID to be found",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OAuth2Application"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "delete an OAuth2 Application",
- "operationId": "userDeleteOAuth2Application",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "token to be deleted",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "update an OAuth2 Application, this includes regenerating the client secret",
- "operationId": "userUpdateOAuth2Application",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "application to be updated",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OAuth2Application"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/avatar": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Update Avatar",
- "operationId": "userUpdateAvatar",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/UpdateUserAvatarOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete Avatar",
- "operationId": "userDeleteAvatar",
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/blocks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List users blocked by the authenticated user",
- "operationId": "userListBlocks",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/user/blocks/{username}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Check if a user is blocked by the authenticated user",
- "operationId": "userCheckUserBlock",
- "parameters": [
- {
- "type": "string",
- "description": "user to check",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "user"
- ],
- "summary": "Block a user",
- "operationId": "userBlockUser",
- "parameters": [
- {
- "type": "string",
- "description": "user to block",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "optional note for the block",
- "name": "note",
- "in": "query"
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "tags": [
- "user"
- ],
- "summary": "Unblock a user",
- "operationId": "userUnblockUser",
- "parameters": [
- {
- "type": "string",
- "description": "user to unblock",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/emails": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's email addresses",
- "operationId": "userListEmails",
- "responses": {
- "200": {
- "$ref": "#/responses/EmailList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Add email addresses",
- "operationId": "userAddEmail",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateEmailOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/EmailList"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete email addresses",
- "operationId": "userDeleteEmail",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/DeleteEmailOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/followers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's followers",
- "operationId": "userCurrentListFollowers",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/user/following": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the users that the authenticated user is following",
- "operationId": "userCurrentListFollowing",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/user/following/{username}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Check whether a user is followed by the authenticated user",
- "operationId": "userCurrentCheckFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of followed user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "user"
- ],
- "summary": "Follow a user",
- "operationId": "userCurrentPutFollow",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to follow",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "user"
- ],
- "summary": "Unfollow a user",
- "operationId": "userCurrentDeleteFollow",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to unfollow",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/gpg_key_token": {
- "get": {
- "produces": [
- "text/plain"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a Token to verify",
- "operationId": "getVerificationToken",
- "responses": {
- "200": {
- "$ref": "#/responses/string"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/gpg_key_verify": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Verify a GPG key",
- "operationId": "userVerifyGPGKey",
- "responses": {
- "201": {
- "$ref": "#/responses/GPGKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/gpg_keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's GPG keys",
- "operationId": "userCurrentListGPGKeys",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a GPG key",
- "operationId": "userCurrentPostGPGKey",
- "parameters": [
- {
- "name": "Form",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateGPGKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/GPGKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/gpg_keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a GPG key",
- "operationId": "userCurrentGetGPGKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Remove a GPG key",
- "operationId": "userCurrentDeleteGPGKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's webhooks",
- "operationId": "userListHooks",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a hook",
- "operationId": "userCreateHook",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/user/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a hook",
- "operationId": "userGetHook",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete a hook",
- "operationId": "userDeleteHook",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Update a hook",
- "operationId": "userEditHook",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to update",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/user/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's public keys",
- "operationId": "userCurrentListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a public key",
- "operationId": "userCurrentPostKey",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PublicKey"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a public key",
- "operationId": "userCurrentGetKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete a public key",
- "operationId": "userCurrentDeleteKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List the current user's organizations",
- "operationId": "orgListCurrentUserOrgs",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repos that the authenticated user owns",
- "operationId": "userCurrentListRepos",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository",
- "user"
- ],
- "summary": "Create a repository",
- "operationId": "createCurrentUserRepo",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "409": {
- "description": "The repository with the same name already exists."
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/settings": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get user settings",
- "operationId": "getUserSettings",
- "responses": {
- "200": {
- "$ref": "#/responses/UserSettings"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Update user settings",
- "operationId": "updateUserSettings",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/UserSettingsOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserSettings"
- }
- }
- }
- },
- "/user/starred": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "The repos that the authenticated user has starred",
- "operationId": "userCurrentListStarred",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/user/starred/{owner}/{repo}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Whether the authenticated is starring the repo",
- "operationId": "userCurrentCheckStarring",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "user"
- ],
- "summary": "Star the given repo",
- "operationId": "userCurrentPutStar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to star",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to star",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "user"
- ],
- "summary": "Unstar the given repo",
- "operationId": "userCurrentDeleteStar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to unstar",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to unstar",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/stopwatches": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get list of all existing stopwatches",
- "operationId": "userGetStopWatches",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/StopWatchList"
- }
- }
- }
- },
- "/user/subscriptions": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List repositories watched by the authenticated user",
- "operationId": "userCurrentListSubscriptions",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/user/teams": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List all the teams a user belongs to",
- "operationId": "userListTeams",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TeamList"
- }
- }
- }
- },
- "/user/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the current user's tracked times",
- "operationId": "userCurrentTrackedTimes",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- }
- }
- }
- },
- "/users/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Search for users",
- "operationId": "userSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keyword",
- "name": "q",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "ID of the user to search for",
- "name": "uid",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "SearchResults of a successful search",
- "schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- }
- },
- "ok": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "/users/{username}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a user",
- "operationId": "userGet",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to get",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/activities/feeds": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List a user's activity feeds",
- "operationId": "userListActivityFeeds",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "if true, only show actions performed by the requested user",
- "name": "only-performed-by",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date",
- "description": "the date of the activities to be found",
- "name": "date",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ActivityFeedsList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/followers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's followers",
- "operationId": "userListFollowers",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/following": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the users that the given user is following",
- "operationId": "userListFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/following/{target}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Check if one user is following another user",
- "operationId": "userCheckFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of following user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of followed user",
- "name": "target",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/gpg_keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's GPG keys",
- "operationId": "userListGPGKeys",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKeyList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/heatmap": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a user's heatmap",
- "operationId": "userGetHeatmapData",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to get",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserHeatmapData"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's public keys",
- "operationId": "userListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKeyList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a user's organizations",
- "operationId": "orgListUserOrgs",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/orgs/{org}/permissions": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get user permissions in organization",
- "operationId": "orgGetUserPermissions",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationPermissions"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repos owned by the given user",
- "operationId": "userListRepos",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/starred": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "The repos that the given user has starred",
- "operationId": "userListStarred",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/subscriptions": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repositories watched by a user",
- "operationId": "userListSubscriptions",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/tokens": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's access tokens",
- "operationId": "userGetTokens",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AccessTokenList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create an access token",
- "operationId": "userCreateToken",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateAccessTokenOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/AccessToken"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/users/{username}/tokens/{token}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "delete an access token",
- "operationId": "userDeleteAccessToken",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "token to be deleted, identified by ID and if not available by name",
- "name": "token",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/version": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns the version of the Gitea application",
- "operationId": "getVersion",
- "responses": {
- "200": {
- "$ref": "#/responses/ServerVersion"
- }
- }
- }
- }
- },
- "definitions": {
- "APIError": {
- "description": "APIError is an api error with a message",
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AccessToken": {
- "type": "object",
- "title": "AccessToken represents an API access token.",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "scopes": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Scopes"
- },
- "sha1": {
- "type": "string",
- "x-go-name": "Token"
- },
- "token_last_eight": {
- "type": "string",
- "x-go-name": "TokenLastEight"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Activity": {
- "type": "object",
- "properties": {
- "act_user": {
- "$ref": "#/definitions/User"
- },
- "act_user_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ActUserID"
- },
- "comment": {
- "$ref": "#/definitions/Comment"
- },
- "comment_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "CommentID"
- },
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "is_private": {
- "type": "boolean",
- "x-go-name": "IsPrivate"
- },
- "op_type": {
- "type": "string",
- "x-go-name": "OpType"
- },
- "ref_name": {
- "type": "string",
- "x-go-name": "RefName"
- },
- "repo": {
- "$ref": "#/definitions/Repository"
- },
- "repo_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RepoID"
- },
- "user_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "UserID"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ActivityPub": {
- "description": "ActivityPub type",
- "type": "object",
- "properties": {
- "@context": {
- "type": "string",
- "x-go-name": "Context"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AddCollaboratorOption": {
- "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "x-go-name": "Permission"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AddTimeOption": {
- "description": "AddTimeOption options for adding time to an issue",
- "type": "object",
- "required": [
- "time"
- ],
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "time": {
- "description": "time in seconds",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Time"
- },
- "user_name": {
- "description": "User who spent the time (optional)",
- "type": "string",
- "x-go-name": "User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AnnotatedTag": {
- "description": "AnnotatedTag represents an annotated tag",
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "object": {
- "$ref": "#/definitions/AnnotatedTagObject"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "tag": {
- "type": "string",
- "x-go-name": "Tag"
- },
- "tagger": {
- "$ref": "#/definitions/CommitUser"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AnnotatedTagObject": {
- "description": "AnnotatedTagObject contains meta information of the tag object",
- "type": "object",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Attachment": {
- "description": "Attachment a generic attachment",
- "type": "object",
- "properties": {
- "browser_download_url": {
- "type": "string",
- "x-go-name": "DownloadURL"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "download_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "DownloadCount"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "uuid": {
- "type": "string",
- "x-go-name": "UUID"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Badge": {
- "description": "Badge represents a user badge",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "image_url": {
- "type": "string",
- "x-go-name": "ImageURL"
- },
- "slug": {
- "type": "string",
- "x-go-name": "Slug"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "BadgeList": {
- "description": "BadgeList",
- "type": "object",
- "properties": {
- "body": {
- "description": "in:body",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Badge"
- },
- "x-go-name": "Body"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Branch": {
- "description": "Branch represents a repository branch",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/PayloadCommit"
- },
- "effective_branch_protection_name": {
- "type": "string",
- "x-go-name": "EffectiveBranchProtectionName"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "protected": {
- "type": "boolean",
- "x-go-name": "Protected"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- },
- "user_can_merge": {
- "type": "boolean",
- "x-go-name": "UserCanMerge"
- },
- "user_can_push": {
- "type": "boolean",
- "x-go-name": "UserCanPush"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "BranchProtection": {
- "description": "BranchProtection represents a branch protection for a repository",
- "type": "object",
- "properties": {
- "approvals_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistTeams"
- },
- "approvals_whitelist_username": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistUsernames"
- },
- "block_on_official_review_requests": {
- "type": "boolean",
- "x-go-name": "BlockOnOfficialReviewRequests"
- },
- "block_on_outdated_branch": {
- "type": "boolean",
- "x-go-name": "BlockOnOutdatedBranch"
- },
- "block_on_rejected_reviews": {
- "type": "boolean",
- "x-go-name": "BlockOnRejectedReviews"
- },
- "branch_name": {
- "description": "Deprecated: true",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "dismiss_stale_approvals": {
- "type": "boolean",
- "x-go-name": "DismissStaleApprovals"
- },
- "enable_approvals_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableApprovalsWhitelist"
- },
- "enable_merge_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableMergeWhitelist"
- },
- "enable_push": {
- "type": "boolean",
- "x-go-name": "EnablePush"
- },
- "enable_push_whitelist": {
- "type": "boolean",
- "x-go-name": "EnablePushWhitelist"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "ignore_stale_approvals": {
- "type": "boolean",
- "x-go-name": "IgnoreStaleApprovals"
- },
- "merge_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistTeams"
- },
- "merge_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistUsernames"
- },
- "protected_file_patterns": {
- "type": "string",
- "x-go-name": "ProtectedFilePatterns"
- },
- "push_whitelist_deploy_keys": {
- "type": "boolean",
- "x-go-name": "PushWhitelistDeployKeys"
- },
- "push_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistTeams"
- },
- "push_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistUsernames"
- },
- "require_signed_commits": {
- "type": "boolean",
- "x-go-name": "RequireSignedCommits"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "rule_name": {
- "type": "string",
- "x-go-name": "RuleName"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- },
- "unprotected_file_patterns": {
- "type": "string",
- "x-go-name": "UnprotectedFilePatterns"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ChangeFileOperation": {
- "description": "ChangeFileOperation for creating, updating or deleting a file",
- "type": "object",
- "required": [
- "operation",
- "path"
- ],
- "properties": {
- "content": {
- "description": "new or updated file content, must be base64 encoded",
- "type": "string",
- "x-go-name": "ContentBase64"
- },
- "from_path": {
- "description": "old path of the file to move",
- "type": "string",
- "x-go-name": "FromPath"
- },
- "operation": {
- "description": "indicates what to do with the file",
- "type": "string",
- "enum": [
- "create",
- "update",
- "delete"
- ],
- "x-go-name": "Operation"
- },
- "path": {
- "description": "path to the existing or new file",
- "type": "string",
- "x-go-name": "Path"
- },
- "sha": {
- "description": "sha is the SHA for the file that already exists, required for update or delete",
- "type": "string",
- "x-go-name": "SHA"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ChangeFilesOptions": {
- "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)",
- "type": "object",
- "required": [
- "files"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "dates": {
- "$ref": "#/definitions/CommitDateOptions"
- },
- "files": {
- "description": "list of file operations",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ChangeFileOperation"
- },
- "x-go-name": "Files"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "signoff": {
- "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
- "type": "boolean",
- "x-go-name": "Signoff"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ChangedFile": {
- "description": "ChangedFile store information about files affected by the pull request",
- "type": "object",
- "properties": {
- "additions": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Additions"
- },
- "changes": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Changes"
- },
- "contents_url": {
- "type": "string",
- "x-go-name": "ContentsURL"
- },
- "deletions": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Deletions"
- },
- "filename": {
- "type": "string",
- "x-go-name": "Filename"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "previous_filename": {
- "type": "string",
- "x-go-name": "PreviousFilename"
- },
- "raw_url": {
- "type": "string",
- "x-go-name": "RawURL"
- },
- "status": {
- "type": "string",
- "x-go-name": "Status"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CombinedStatus": {
- "description": "CombinedStatus holds the combined state of several statuses for a single commit",
- "type": "object",
- "properties": {
- "commit_url": {
- "type": "string",
- "x-go-name": "CommitURL"
- },
- "repository": {
- "$ref": "#/definitions/Repository"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "state": {
- "$ref": "#/definitions/CommitStatusState"
- },
- "statuses": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitStatus"
- },
- "x-go-name": "Statuses"
- },
- "total_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "TotalCount"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Comment": {
- "description": "Comment represents a comment on a commit or issue",
- "type": "object",
- "properties": {
- "assets": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- },
- "x-go-name": "Attachments"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "issue_url": {
- "type": "string",
- "x-go-name": "IssueURL"
- },
- "original_author": {
- "type": "string",
- "x-go-name": "OriginalAuthor"
- },
- "original_author_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OriginalAuthorID"
- },
- "pull_request_url": {
- "type": "string",
- "x-go-name": "PRURL"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Commit": {
- "type": "object",
- "title": "Commit contains information generated from a Git commit.",
- "properties": {
- "author": {
- "$ref": "#/definitions/User"
- },
- "commit": {
- "$ref": "#/definitions/RepoCommit"
- },
- "committer": {
- "$ref": "#/definitions/User"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "files": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitAffectedFiles"
- },
- "x-go-name": "Files"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "parents": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitMeta"
- },
- "x-go-name": "Parents"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "stats": {
- "$ref": "#/definitions/CommitStats"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitAffectedFiles": {
- "description": "CommitAffectedFiles store information about files affected by the commit",
- "type": "object",
- "properties": {
- "filename": {
- "type": "string",
- "x-go-name": "Filename"
- },
- "status": {
- "type": "string",
- "x-go-name": "Status"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitDateOptions": {
- "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
- "type": "object",
- "properties": {
- "author": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Author"
- },
- "committer": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Committer"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitMeta": {
- "type": "object",
- "title": "CommitMeta contains meta information of a commit in terms of API.",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitStats": {
- "description": "CommitStats is statistics for a RepoCommit",
- "type": "object",
- "properties": {
- "additions": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Additions"
- },
- "deletions": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Deletions"
- },
- "total": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Total"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitStatus": {
- "description": "CommitStatus holds a single status of a single Commit",
- "type": "object",
- "properties": {
- "context": {
- "type": "string",
- "x-go-name": "Context"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "creator": {
- "$ref": "#/definitions/User"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "status": {
- "$ref": "#/definitions/CommitStatusState"
- },
- "target_url": {
- "type": "string",
- "x-go-name": "TargetURL"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitStatusState": {
- "description": "CommitStatusState holds the state of a CommitStatus\nIt can be \"pending\", \"success\", \"error\" and \"failure\"",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitUser": {
- "type": "object",
- "title": "CommitUser contains information of a user in the context of a commit.",
- "properties": {
- "date": {
- "type": "string",
- "x-go-name": "Date"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ContentsResponse": {
- "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
- "type": "object",
- "properties": {
- "_links": {
- "$ref": "#/definitions/FileLinksResponse"
- },
- "content": {
- "description": "`content` is populated when `type` is `file`, otherwise null",
- "type": "string",
- "x-go-name": "Content"
- },
- "download_url": {
- "type": "string",
- "x-go-name": "DownloadURL"
- },
- "encoding": {
- "description": "`encoding` is populated when `type` is `file`, otherwise null",
- "type": "string",
- "x-go-name": "Encoding"
- },
- "git_url": {
- "type": "string",
- "x-go-name": "GitURL"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "last_commit_sha": {
- "type": "string",
- "x-go-name": "LastCommitSHA"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "path": {
- "type": "string",
- "x-go-name": "Path"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "submodule_git_url": {
- "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
- "type": "string",
- "x-go-name": "SubmoduleGitURL"
- },
- "target": {
- "description": "`target` is populated when `type` is `symlink`, otherwise null",
- "type": "string",
- "x-go-name": "Target"
- },
- "type": {
- "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateAccessTokenOption": {
- "description": "CreateAccessTokenOption options when create access token",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "scopes": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Scopes"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateBranchProtectionOption": {
- "description": "CreateBranchProtectionOption options for creating a branch protection",
- "type": "object",
- "properties": {
- "approvals_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistTeams"
- },
- "approvals_whitelist_username": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistUsernames"
- },
- "block_on_official_review_requests": {
- "type": "boolean",
- "x-go-name": "BlockOnOfficialReviewRequests"
- },
- "block_on_outdated_branch": {
- "type": "boolean",
- "x-go-name": "BlockOnOutdatedBranch"
- },
- "block_on_rejected_reviews": {
- "type": "boolean",
- "x-go-name": "BlockOnRejectedReviews"
- },
- "branch_name": {
- "description": "Deprecated: true",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "dismiss_stale_approvals": {
- "type": "boolean",
- "x-go-name": "DismissStaleApprovals"
- },
- "enable_approvals_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableApprovalsWhitelist"
- },
- "enable_merge_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableMergeWhitelist"
- },
- "enable_push": {
- "type": "boolean",
- "x-go-name": "EnablePush"
- },
- "enable_push_whitelist": {
- "type": "boolean",
- "x-go-name": "EnablePushWhitelist"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "ignore_stale_approvals": {
- "type": "boolean",
- "x-go-name": "IgnoreStaleApprovals"
- },
- "merge_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistTeams"
- },
- "merge_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistUsernames"
- },
- "protected_file_patterns": {
- "type": "string",
- "x-go-name": "ProtectedFilePatterns"
- },
- "push_whitelist_deploy_keys": {
- "type": "boolean",
- "x-go-name": "PushWhitelistDeployKeys"
- },
- "push_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistTeams"
- },
- "push_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistUsernames"
- },
- "require_signed_commits": {
- "type": "boolean",
- "x-go-name": "RequireSignedCommits"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "rule_name": {
- "type": "string",
- "x-go-name": "RuleName"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- },
- "unprotected_file_patterns": {
- "type": "string",
- "x-go-name": "UnprotectedFilePatterns"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateBranchRepoOption": {
- "description": "CreateBranchRepoOption options when creating a branch in a repository",
- "type": "object",
- "required": [
- "new_branch_name"
- ],
- "properties": {
- "new_branch_name": {
- "description": "Name of the branch to create",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "BranchName"
- },
- "old_branch_name": {
- "description": "Deprecated: true\nName of the old branch to create from",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "OldBranchName"
- },
- "old_ref_name": {
- "description": "Name of the old branch/tag/commit to create from",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "OldRefName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateEmailOption": {
- "description": "CreateEmailOption options when creating email addresses",
- "type": "object",
- "properties": {
- "emails": {
- "description": "email addresses to add",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Emails"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateFileOptions": {
- "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)",
- "type": "object",
- "required": [
- "content"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "content": {
- "description": "content must be base64 encoded",
- "type": "string",
- "x-go-name": "ContentBase64"
- },
- "dates": {
- "$ref": "#/definitions/CommitDateOptions"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "signoff": {
- "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
- "type": "boolean",
- "x-go-name": "Signoff"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateForkOption": {
- "description": "CreateForkOption options for creating a fork",
- "type": "object",
- "properties": {
- "name": {
- "description": "name of the forked repository",
- "type": "string",
- "x-go-name": "Name"
- },
- "organization": {
- "description": "organization name, if forking into an organization",
- "type": "string",
- "x-go-name": "Organization"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateGPGKeyOption": {
- "description": "CreateGPGKeyOption options create user GPG key",
- "type": "object",
- "required": [
- "armored_public_key"
- ],
- "properties": {
- "armored_public_key": {
- "description": "An armored GPG key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "ArmoredKey"
- },
- "armored_signature": {
- "type": "string",
- "x-go-name": "Signature"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateHookOption": {
- "description": "CreateHookOption options when create a hook",
- "type": "object",
- "required": [
- "type",
- "config"
- ],
- "properties": {
- "active": {
- "type": "boolean",
- "default": false,
- "x-go-name": "Active"
- },
- "authorization_header": {
- "type": "string",
- "x-go-name": "AuthorizationHeader"
- },
- "branch_filter": {
- "type": "string",
- "x-go-name": "BranchFilter"
- },
- "config": {
- "$ref": "#/definitions/CreateHookOptionConfig"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- },
- "type": {
- "type": "string",
- "enum": [
- "dingtalk",
- "discord",
- "gitea",
- "gogs",
- "msteams",
- "slack",
- "telegram",
- "feishu",
- "wechatwork",
- "packagist"
- ],
- "x-go-name": "Type"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateHookOptionConfig": {
- "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateIssueCommentOption": {
- "description": "CreateIssueCommentOption options for creating a comment on an issue",
- "type": "object",
- "required": [
- "body"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateIssueOption": {
- "description": "CreateIssueOption options to create one issue",
- "type": "object",
- "required": [
- "title"
- ],
- "properties": {
- "assignee": {
- "description": "deprecated",
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed": {
- "type": "boolean",
- "x-go-name": "Closed"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "labels": {
- "description": "list of label ids",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "description": "milestone id",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateKeyOption": {
- "description": "CreateKeyOption options when creating a key",
- "type": "object",
- "required": [
- "title",
- "key"
- ],
- "properties": {
- "key": {
- "description": "An armored SSH key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Key"
- },
- "read_only": {
- "description": "Describe if the key has only read access or read/write",
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "title": {
- "description": "Title of the key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateLabelOption": {
- "description": "CreateLabelOption options for creating a label",
- "type": "object",
- "required": [
- "name",
- "color"
- ],
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "#00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "exclusive": {
- "type": "boolean",
- "x-go-name": "Exclusive",
- "example": false
- },
- "is_archived": {
- "type": "boolean",
- "x-go-name": "IsArchived",
- "example": false
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateMilestoneOption": {
- "description": "CreateMilestoneOption options for creating a milestone",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "state": {
- "type": "string",
- "enum": [
- "open",
- "closed"
- ],
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateOAuth2ApplicationOptions": {
- "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
- "type": "object",
- "properties": {
- "confidential_client": {
- "type": "boolean",
- "x-go-name": "ConfidentialClient"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "redirect_uris": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "RedirectURIs"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateOrUpdateSecretOption": {
- "description": "CreateOrUpdateSecretOption options when creating or updating secret",
- "type": "object",
- "required": [
- "data"
- ],
- "properties": {
- "data": {
- "description": "Data of the secret to update",
- "type": "string",
- "x-go-name": "Data"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateOrgOption": {
- "description": "CreateOrgOption options for creating an organization",
- "type": "object",
- "required": [
- "username"
- ],
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "email": {
- "type": "string",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "repo_admin_change_team_access": {
- "type": "boolean",
- "x-go-name": "RepoAdminChangeTeamAccess"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- },
- "visibility": {
- "description": "possible values are `public` (default), `limited` or `private`",
- "type": "string",
- "enum": [
- "public",
- "limited",
- "private"
- ],
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreatePullRequestOption": {
- "description": "CreatePullRequestOption options when creating a pull request",
- "type": "object",
- "properties": {
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "base": {
- "type": "string",
- "x-go-name": "Base"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "head": {
- "type": "string",
- "x-go-name": "Head"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreatePullReviewComment": {
- "description": "CreatePullReviewComment represent a review comment for creation api",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "new_position": {
- "description": "if comment to new file line or 0",
- "type": "integer",
- "format": "int64",
- "x-go-name": "NewLineNum"
- },
- "old_position": {
- "description": "if comment to old file line or 0",
- "type": "integer",
- "format": "int64",
- "x-go-name": "OldLineNum"
- },
- "path": {
- "description": "the tree path",
- "type": "string",
- "x-go-name": "Path"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreatePullReviewOptions": {
- "description": "CreatePullReviewOptions are options to create a pull review",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "comments": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CreatePullReviewComment"
- },
- "x-go-name": "Comments"
- },
- "commit_id": {
- "type": "string",
- "x-go-name": "CommitID"
- },
- "event": {
- "$ref": "#/definitions/ReviewStateType"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreatePushMirrorOption": {
- "type": "object",
- "title": "CreatePushMirrorOption represents need information to create a push mirror of a repository.",
- "properties": {
- "interval": {
- "type": "string",
- "x-go-name": "Interval"
- },
- "remote_address": {
- "type": "string",
- "x-go-name": "RemoteAddress"
- },
- "remote_password": {
- "type": "string",
- "x-go-name": "RemotePassword"
- },
- "remote_username": {
- "type": "string",
- "x-go-name": "RemoteUsername"
- },
- "sync_on_commit": {
- "type": "boolean",
- "x-go-name": "SyncOnCommit"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateReleaseOption": {
- "description": "CreateReleaseOption options when creating a release",
- "type": "object",
- "required": [
- "tag_name"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateRepoOption": {
- "description": "CreateRepoOption options when creating repository",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "auto_init": {
- "description": "Whether the repository should be auto-initialized?",
- "type": "boolean",
- "x-go-name": "AutoInit"
- },
- "default_branch": {
- "description": "DefaultBranch of the repository (used when initializes and in template)",
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "description": {
- "description": "Description of the repository to create",
- "type": "string",
- "x-go-name": "Description"
- },
- "gitignores": {
- "description": "Gitignores to use",
- "type": "string",
- "x-go-name": "Gitignores"
- },
- "issue_labels": {
- "description": "Label-Set to use",
- "type": "string",
- "x-go-name": "IssueLabels"
- },
- "license": {
- "description": "License to use",
- "type": "string",
- "x-go-name": "License"
- },
- "name": {
- "description": "Name of the repository to create",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Name"
- },
- "object_format_name": {
- "description": "ObjectFormatName of the underlying git repository",
- "type": "string",
- "enum": [
- "sha1",
- "sha256"
- ],
- "x-go-name": "ObjectFormatName"
- },
- "private": {
- "description": "Whether the repository is private",
- "type": "boolean",
- "x-go-name": "Private"
- },
- "readme": {
- "description": "Readme of the repository to create",
- "type": "string",
- "x-go-name": "Readme"
- },
- "template": {
- "description": "Whether the repository is template",
- "type": "boolean",
- "x-go-name": "Template"
- },
- "trust_model": {
- "description": "TrustModel of the repository",
- "type": "string",
- "enum": [
- "default",
- "collaborator",
- "committer",
- "collaboratorcommitter"
- ],
- "x-go-name": "TrustModel"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateStatusOption": {
- "description": "CreateStatusOption holds the information needed to create a new CommitStatus for a Commit",
- "type": "object",
- "properties": {
- "context": {
- "type": "string",
- "x-go-name": "Context"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "state": {
- "$ref": "#/definitions/CommitStatusState"
- },
- "target_url": {
- "type": "string",
- "x-go-name": "TargetURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateTagOption": {
- "description": "CreateTagOption options when creating a tag",
- "type": "object",
- "required": [
- "tag_name"
- ],
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "target": {
- "type": "string",
- "x-go-name": "Target"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateTeamOption": {
- "description": "CreateTeamOption options for creating a team",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "can_create_org_repo": {
- "type": "boolean",
- "x-go-name": "CanCreateOrgRepo"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "includes_all_repositories": {
- "type": "boolean",
- "x-go-name": "IncludesAllRepositories"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Units",
- "example": [
- "repo.actions",
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.ext_wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
- ]
- },
- "units_map": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "UnitsMap",
- "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\"}"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateUserOption": {
- "description": "CreateUserOption create user options",
- "type": "object",
- "required": [
- "username",
- "email"
- ],
- "properties": {
- "created_at": {
- "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\".",
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "login_name": {
- "type": "string",
- "x-go-name": "LoginName"
- },
- "must_change_password": {
- "type": "boolean",
- "x-go-name": "MustChangePassword"
- },
- "password": {
- "type": "string",
- "x-go-name": "Password"
- },
- "restricted": {
- "type": "boolean",
- "x-go-name": "Restricted"
- },
- "send_notify": {
- "type": "boolean",
- "x-go-name": "SendNotify"
- },
- "source_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "SourceID"
- },
- "username": {
- "type": "string",
- "x-go-name": "Username"
- },
- "visibility": {
- "type": "string",
- "x-go-name": "Visibility"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateWikiPageOptions": {
- "description": "CreateWikiPageOptions form for creating wiki",
- "type": "object",
- "properties": {
- "content_base64": {
- "description": "content must be base64 encoded",
- "type": "string",
- "x-go-name": "ContentBase64"
- },
- "message": {
- "description": "optional commit message summarizing the change",
- "type": "string",
- "x-go-name": "Message"
- },
- "title": {
- "description": "page title. leave empty to keep unchanged",
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Cron": {
- "description": "Cron represents a Cron task",
- "type": "object",
- "properties": {
- "exec_times": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ExecTimes"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "next": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Next"
- },
- "prev": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Prev"
- },
- "schedule": {
- "type": "string",
- "x-go-name": "Schedule"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeleteEmailOption": {
- "description": "DeleteEmailOption options when deleting email addresses",
- "type": "object",
- "properties": {
- "emails": {
- "description": "email addresses to delete",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Emails"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeleteFileOptions": {
- "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)",
- "type": "object",
- "required": [
- "sha"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "dates": {
- "$ref": "#/definitions/CommitDateOptions"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "sha": {
- "description": "sha is the SHA for the file that already exists",
- "type": "string",
- "x-go-name": "SHA"
- },
- "signoff": {
- "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
- "type": "boolean",
- "x-go-name": "Signoff"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeployKey": {
- "description": "DeployKey a deploy key",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "fingerprint": {
- "type": "string",
- "x-go-name": "Fingerprint"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "key_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "KeyID"
- },
- "read_only": {
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "repository": {
- "$ref": "#/definitions/Repository"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DismissPullReviewOptions": {
- "description": "DismissPullReviewOptions are options to dismiss a pull review",
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "priors": {
- "type": "boolean",
- "x-go-name": "Priors"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditAttachmentOptions": {
- "description": "EditAttachmentOptions options for editing attachments",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditBranchProtectionOption": {
- "description": "EditBranchProtectionOption options for editing a branch protection",
- "type": "object",
- "properties": {
- "approvals_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistTeams"
- },
- "approvals_whitelist_username": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistUsernames"
- },
- "block_on_official_review_requests": {
- "type": "boolean",
- "x-go-name": "BlockOnOfficialReviewRequests"
- },
- "block_on_outdated_branch": {
- "type": "boolean",
- "x-go-name": "BlockOnOutdatedBranch"
- },
- "block_on_rejected_reviews": {
- "type": "boolean",
- "x-go-name": "BlockOnRejectedReviews"
- },
- "dismiss_stale_approvals": {
- "type": "boolean",
- "x-go-name": "DismissStaleApprovals"
- },
- "enable_approvals_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableApprovalsWhitelist"
- },
- "enable_merge_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableMergeWhitelist"
- },
- "enable_push": {
- "type": "boolean",
- "x-go-name": "EnablePush"
- },
- "enable_push_whitelist": {
- "type": "boolean",
- "x-go-name": "EnablePushWhitelist"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "ignore_stale_approvals": {
- "type": "boolean",
- "x-go-name": "IgnoreStaleApprovals"
- },
- "merge_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistTeams"
- },
- "merge_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistUsernames"
- },
- "protected_file_patterns": {
- "type": "string",
- "x-go-name": "ProtectedFilePatterns"
- },
- "push_whitelist_deploy_keys": {
- "type": "boolean",
- "x-go-name": "PushWhitelistDeployKeys"
- },
- "push_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistTeams"
- },
- "push_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistUsernames"
- },
- "require_signed_commits": {
- "type": "boolean",
- "x-go-name": "RequireSignedCommits"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- },
- "unprotected_file_patterns": {
- "type": "string",
- "x-go-name": "UnprotectedFilePatterns"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditDeadlineOption": {
- "description": "EditDeadlineOption options for creating a deadline",
- "type": "object",
- "required": [
- "due_date"
- ],
- "properties": {
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditGitHookOption": {
- "description": "EditGitHookOption options when modifying one Git hook",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditHookOption": {
- "description": "EditHookOption options when modify one hook",
- "type": "object",
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "authorization_header": {
- "type": "string",
- "x-go-name": "AuthorizationHeader"
- },
- "branch_filter": {
- "type": "string",
- "x-go-name": "BranchFilter"
- },
- "config": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "Config"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditIssueCommentOption": {
- "description": "EditIssueCommentOption options for editing a comment",
- "type": "object",
- "required": [
- "body"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditIssueOption": {
- "description": "EditIssueOption options for editing an issue",
- "type": "object",
- "properties": {
- "assignee": {
- "description": "deprecated",
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "unset_due_date": {
- "type": "boolean",
- "x-go-name": "RemoveDeadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditLabelOption": {
- "description": "EditLabelOption options for editing a label",
- "type": "object",
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "#00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "exclusive": {
- "type": "boolean",
- "x-go-name": "Exclusive",
- "example": false
- },
- "is_archived": {
- "type": "boolean",
- "x-go-name": "IsArchived",
- "example": false
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditMilestoneOption": {
- "description": "EditMilestoneOption options for editing a milestone",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditOrgOption": {
- "description": "EditOrgOption options for editing an organization",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "email": {
- "type": "string",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "repo_admin_change_team_access": {
- "type": "boolean",
- "x-go-name": "RepoAdminChangeTeamAccess"
- },
- "visibility": {
- "description": "possible values are `public`, `limited` or `private`",
- "type": "string",
- "enum": [
- "public",
- "limited",
- "private"
- ],
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditPullRequestOption": {
- "description": "EditPullRequestOption options when modify pull request",
- "type": "object",
- "properties": {
- "allow_maintainer_edit": {
- "type": "boolean",
- "x-go-name": "AllowMaintainerEdit"
- },
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "base": {
- "type": "string",
- "x-go-name": "Base"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "unset_due_date": {
- "type": "boolean",
- "x-go-name": "RemoveDeadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditReactionOption": {
- "description": "EditReactionOption contain the reaction type",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Reaction"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditReleaseOption": {
- "description": "EditReleaseOption options when editing a release",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditRepoOption": {
- "description": "EditRepoOption options when editing a repository's properties",
- "type": "object",
- "properties": {
- "allow_fast_forward_only_merge": {
- "description": "either `true` to allow fast-forward-only merging pull requests, or `false` to prevent fast-forward-only merging.",
- "type": "boolean",
- "x-go-name": "AllowFastForwardOnly"
- },
- "allow_manual_merge": {
- "description": "either `true` to allow mark pr as merged manually, or `false` to prevent it.",
- "type": "boolean",
- "x-go-name": "AllowManualMerge"
- },
- "allow_merge_commits": {
- "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
- "type": "boolean",
- "x-go-name": "AllowMerge"
- },
- "allow_rebase": {
- "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
- "type": "boolean",
- "x-go-name": "AllowRebase"
- },
- "allow_rebase_explicit": {
- "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits.",
- "type": "boolean",
- "x-go-name": "AllowRebaseMerge"
- },
- "allow_rebase_update": {
- "description": "either `true` to allow updating pull request branch by rebase, or `false` to prevent it.",
- "type": "boolean",
- "x-go-name": "AllowRebaseUpdate"
- },
- "allow_squash_merge": {
- "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
- "type": "boolean",
- "x-go-name": "AllowSquash"
- },
- "archived": {
- "description": "set to `true` to archive this repository.",
- "type": "boolean",
- "x-go-name": "Archived"
- },
- "autodetect_manual_merge": {
- "description": "either `true` to enable AutodetectManualMerge, or `false` to prevent it. Note: In some special cases, misjudgments can occur.",
- "type": "boolean",
- "x-go-name": "AutodetectManualMerge"
- },
- "default_allow_maintainer_edit": {
- "description": "set to `true` to allow edits from maintainers by default",
- "type": "boolean",
- "x-go-name": "DefaultAllowMaintainerEdit"
- },
- "default_branch": {
- "description": "sets the default branch for this repository.",
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "default_delete_branch_after_merge": {
- "description": "set to `true` to delete pr branch after merge by default",
- "type": "boolean",
- "x-go-name": "DefaultDeleteBranchAfterMerge"
- },
- "default_merge_style": {
- "description": "set to a merge style to be used by this repository: \"merge\", \"rebase\", \"rebase-merge\", \"squash\", or \"fast-forward-only\".",
- "type": "string",
- "x-go-name": "DefaultMergeStyle"
- },
- "description": {
- "description": "a short description of the repository.",
- "type": "string",
- "x-go-name": "Description"
- },
- "enable_prune": {
- "description": "enable prune - remove obsolete remote-tracking references",
- "type": "boolean",
- "x-go-name": "EnablePrune"
- },
- "external_tracker": {
- "$ref": "#/definitions/ExternalTracker"
- },
- "external_wiki": {
- "$ref": "#/definitions/ExternalWiki"
- },
- "has_actions": {
- "description": "either `true` to enable actions unit, or `false` to disable them.",
- "type": "boolean",
- "x-go-name": "HasActions"
- },
- "has_issues": {
- "description": "either `true` to enable issues for this repository or `false` to disable them.",
- "type": "boolean",
- "x-go-name": "HasIssues"
- },
- "has_packages": {
- "description": "either `true` to enable packages unit, or `false` to disable them.",
- "type": "boolean",
- "x-go-name": "HasPackages"
- },
- "has_projects": {
- "description": "either `true` to enable project unit, or `false` to disable them.",
- "type": "boolean",
- "x-go-name": "HasProjects"
- },
- "has_pull_requests": {
- "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
- "type": "boolean",
- "x-go-name": "HasPullRequests"
- },
- "has_releases": {
- "description": "either `true` to enable releases unit, or `false` to disable them.",
- "type": "boolean",
- "x-go-name": "HasReleases"
- },
- "has_wiki": {
- "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
- "type": "boolean",
- "x-go-name": "HasWiki"
- },
- "ignore_whitespace_conflicts": {
- "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace.",
- "type": "boolean",
- "x-go-name": "IgnoreWhitespaceConflicts"
- },
- "internal_tracker": {
- "$ref": "#/definitions/InternalTracker"
- },
- "mirror_interval": {
- "description": "set to a string like `8h30m0s` to set the mirror interval time",
- "type": "string",
- "x-go-name": "MirrorInterval"
- },
- "name": {
- "description": "name of the repository",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Name"
- },
- "private": {
- "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.",
- "type": "boolean",
- "x-go-name": "Private"
- },
- "projects_mode": {
- "description": "`repo` to only allow repo-level projects, `owner` to only allow owner projects, `all` to allow both.",
- "type": "string",
- "x-go-name": "ProjectsMode"
- },
- "template": {
- "description": "either `true` to make this repository a template or `false` to make it a normal repository",
- "type": "boolean",
- "x-go-name": "Template"
- },
- "website": {
- "description": "a URL with more information about the repository.",
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditTeamOption": {
- "description": "EditTeamOption options for editing a team",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "can_create_org_repo": {
- "type": "boolean",
- "x-go-name": "CanCreateOrgRepo"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "includes_all_repositories": {
- "type": "boolean",
- "x-go-name": "IncludesAllRepositories"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Units",
- "example": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
- ]
- },
- "units_map": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "UnitsMap",
- "example": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
- }
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditUserOption": {
- "description": "EditUserOption edit user options",
- "type": "object",
- "required": [
- "source_id",
- "login_name"
- ],
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "admin": {
- "type": "boolean",
- "x-go-name": "Admin"
- },
- "allow_create_organization": {
- "type": "boolean",
- "x-go-name": "AllowCreateOrganization"
- },
- "allow_git_hook": {
- "type": "boolean",
- "x-go-name": "AllowGitHook"
- },
- "allow_import_local": {
- "type": "boolean",
- "x-go-name": "AllowImportLocal"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "login_name": {
- "type": "string",
- "x-go-name": "LoginName"
- },
- "max_repo_creation": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "MaxRepoCreation"
- },
- "must_change_password": {
- "type": "boolean",
- "x-go-name": "MustChangePassword"
- },
- "password": {
- "type": "string",
- "x-go-name": "Password"
- },
- "prohibit_login": {
- "type": "boolean",
- "x-go-name": "ProhibitLogin"
- },
- "restricted": {
- "type": "boolean",
- "x-go-name": "Restricted"
- },
- "source_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "SourceID"
- },
- "visibility": {
- "type": "string",
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Email": {
- "description": "Email an email address belonging to a user",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "primary": {
- "type": "boolean",
- "x-go-name": "Primary"
- },
- "user_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "UserID"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ExternalTracker": {
- "description": "ExternalTracker represents settings for external tracker",
- "type": "object",
- "properties": {
- "external_tracker_format": {
- "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
- "type": "string",
- "x-go-name": "ExternalTrackerFormat"
- },
- "external_tracker_regexp_pattern": {
- "description": "External Issue Tracker issue regular expression",
- "type": "string",
- "x-go-name": "ExternalTrackerRegexpPattern"
- },
- "external_tracker_style": {
- "description": "External Issue Tracker Number Format, either `numeric`, `alphanumeric`, or `regexp`",
- "type": "string",
- "x-go-name": "ExternalTrackerStyle"
- },
- "external_tracker_url": {
- "description": "URL of external issue tracker.",
- "type": "string",
- "x-go-name": "ExternalTrackerURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ExternalWiki": {
- "description": "ExternalWiki represents setting for external wiki",
- "type": "object",
- "properties": {
- "external_wiki_url": {
- "description": "URL of external wiki.",
- "type": "string",
- "x-go-name": "ExternalWikiURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileCommitResponse": {
- "type": "object",
- "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
- "properties": {
- "author": {
- "$ref": "#/definitions/CommitUser"
- },
- "committer": {
- "$ref": "#/definitions/CommitUser"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "parents": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitMeta"
- },
- "x-go-name": "Parents"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "tree": {
- "$ref": "#/definitions/CommitMeta"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileDeleteResponse": {
- "description": "FileDeleteResponse contains information about a repo's file that was deleted",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/FileCommitResponse"
- },
- "content": {
- "x-go-name": "Content"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileLinksResponse": {
- "description": "FileLinksResponse contains the links for a repo's file",
- "type": "object",
- "properties": {
- "git": {
- "type": "string",
- "x-go-name": "GitURL"
- },
- "html": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "self": {
- "type": "string",
- "x-go-name": "Self"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileResponse": {
- "description": "FileResponse contains information about a repo's file",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/FileCommitResponse"
- },
- "content": {
- "$ref": "#/definitions/ContentsResponse"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FilesResponse": {
- "description": "FilesResponse contains information about multiple files from a repo",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/FileCommitResponse"
- },
- "files": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ContentsResponse"
- },
- "x-go-name": "Files"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GPGKey": {
- "description": "GPGKey a user GPG key to sign commit and tag in repository",
- "type": "object",
- "properties": {
- "can_certify": {
- "type": "boolean",
- "x-go-name": "CanCertify"
- },
- "can_encrypt_comms": {
- "type": "boolean",
- "x-go-name": "CanEncryptComms"
- },
- "can_encrypt_storage": {
- "type": "boolean",
- "x-go-name": "CanEncryptStorage"
- },
- "can_sign": {
- "type": "boolean",
- "x-go-name": "CanSign"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "emails": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKeyEmail"
- },
- "x-go-name": "Emails"
- },
- "expires_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Expires"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key_id": {
- "type": "string",
- "x-go-name": "KeyID"
- },
- "primary_key_id": {
- "type": "string",
- "x-go-name": "PrimaryKeyID"
- },
- "public_key": {
- "type": "string",
- "x-go-name": "PublicKey"
- },
- "subkeys": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKey"
- },
- "x-go-name": "SubsKey"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GPGKeyEmail": {
- "description": "GPGKeyEmail an email attached to a GPGKey",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "x-go-name": "Email"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GeneralAPISettings": {
- "description": "GeneralAPISettings contains global api settings exposed by it",
- "type": "object",
- "properties": {
- "default_git_trees_per_page": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "DefaultGitTreesPerPage"
- },
- "default_max_blob_size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "DefaultMaxBlobSize"
- },
- "default_paging_num": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "DefaultPagingNum"
- },
- "max_response_items": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "MaxResponseItems"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GeneralAttachmentSettings": {
- "description": "GeneralAttachmentSettings contains global Attachment settings exposed by API",
- "type": "object",
- "properties": {
- "allowed_types": {
- "type": "string",
- "x-go-name": "AllowedTypes"
- },
- "enabled": {
- "type": "boolean",
- "x-go-name": "Enabled"
- },
- "max_files": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "MaxFiles"
- },
- "max_size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "MaxSize"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GeneralRepoSettings": {
- "description": "GeneralRepoSettings contains global repository settings exposed by API",
- "type": "object",
- "properties": {
- "http_git_disabled": {
- "type": "boolean",
- "x-go-name": "HTTPGitDisabled"
- },
- "lfs_disabled": {
- "type": "boolean",
- "x-go-name": "LFSDisabled"
- },
- "migrations_disabled": {
- "type": "boolean",
- "x-go-name": "MigrationsDisabled"
- },
- "mirrors_disabled": {
- "type": "boolean",
- "x-go-name": "MirrorsDisabled"
- },
- "stars_disabled": {
- "type": "boolean",
- "x-go-name": "StarsDisabled"
- },
- "time_tracking_disabled": {
- "type": "boolean",
- "x-go-name": "TimeTrackingDisabled"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GeneralUISettings": {
- "description": "GeneralUISettings contains global ui settings exposed by API",
- "type": "object",
- "properties": {
- "allowed_reactions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "AllowedReactions"
- },
- "custom_emojis": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "CustomEmojis"
- },
- "default_theme": {
- "type": "string",
- "x-go-name": "DefaultTheme"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GenerateRepoOption": {
- "description": "GenerateRepoOption options when creating repository using a template",
- "type": "object",
- "required": [
- "owner",
- "name"
- ],
- "properties": {
- "avatar": {
- "description": "include avatar of the template repo",
- "type": "boolean",
- "x-go-name": "Avatar"
- },
- "default_branch": {
- "description": "Default branch of the new repository",
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "description": {
- "description": "Description of the repository to create",
- "type": "string",
- "x-go-name": "Description"
- },
- "git_content": {
- "description": "include git content of default branch in template repo",
- "type": "boolean",
- "x-go-name": "GitContent"
- },
- "git_hooks": {
- "description": "include git hooks in template repo",
- "type": "boolean",
- "x-go-name": "GitHooks"
- },
- "labels": {
- "description": "include labels in template repo",
- "type": "boolean",
- "x-go-name": "Labels"
- },
- "name": {
- "description": "Name of the repository to create",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Name"
- },
- "owner": {
- "description": "The organization or person who will own the new repository",
- "type": "string",
- "x-go-name": "Owner"
- },
- "private": {
- "description": "Whether the repository is private",
- "type": "boolean",
- "x-go-name": "Private"
- },
- "protected_branch": {
- "description": "include protected branches in template repo",
- "type": "boolean",
- "x-go-name": "ProtectedBranch"
- },
- "topics": {
- "description": "include topics in template repo",
- "type": "boolean",
- "x-go-name": "Topics"
- },
- "webhooks": {
- "description": "include webhooks in template repo",
- "type": "boolean",
- "x-go-name": "Webhooks"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitBlobResponse": {
- "description": "GitBlobResponse represents a git blob",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "encoding": {
- "type": "string",
- "x-go-name": "Encoding"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitEntry": {
- "description": "GitEntry represents a git tree",
- "type": "object",
- "properties": {
- "mode": {
- "type": "string",
- "x-go-name": "Mode"
- },
- "path": {
- "type": "string",
- "x-go-name": "Path"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitHook": {
- "description": "GitHook represents a Git repository hook",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "is_active": {
- "type": "boolean",
- "x-go-name": "IsActive"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitObject": {
- "type": "object",
- "title": "GitObject represents a Git object.",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitTreeResponse": {
- "description": "GitTreeResponse returns a git tree",
- "type": "object",
- "properties": {
- "page": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Page"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "total_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "TotalCount"
- },
- "tree": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GitEntry"
- },
- "x-go-name": "Entries"
- },
- "truncated": {
- "type": "boolean",
- "x-go-name": "Truncated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitignoreTemplateInfo": {
- "description": "GitignoreTemplateInfo name and text of a gitignore template",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "source": {
- "type": "string",
- "x-go-name": "Source"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Hook": {
- "description": "Hook a hook is a web hook when one repository changed",
- "type": "object",
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "authorization_header": {
- "type": "string",
- "x-go-name": "AuthorizationHeader"
- },
- "branch_filter": {
- "type": "string",
- "x-go-name": "BranchFilter"
- },
- "config": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "Config"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Identity": {
- "description": "Identity for a person's identity like an author or committer",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "InternalTracker": {
- "description": "InternalTracker represents settings for internal tracker",
- "type": "object",
- "properties": {
- "allow_only_contributors_to_track_time": {
- "description": "Let only contributors track time (Built-in issue tracker)",
- "type": "boolean",
- "x-go-name": "AllowOnlyContributorsToTrackTime"
- },
- "enable_issue_dependencies": {
- "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
- "type": "boolean",
- "x-go-name": "EnableIssueDependencies"
- },
- "enable_time_tracker": {
- "description": "Enable time tracking (Built-in issue tracker)",
- "type": "boolean",
- "x-go-name": "EnableTimeTracker"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Issue": {
- "description": "Issue represents an issue in a repository",
- "type": "object",
- "properties": {
- "assets": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- },
- "x-go-name": "Attachments"
- },
- "assignee": {
- "$ref": "#/definitions/User"
- },
- "assignees": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "comments": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "is_locked": {
- "type": "boolean",
- "x-go-name": "IsLocked"
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "number": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Index"
- },
- "original_author": {
- "type": "string",
- "x-go-name": "OriginalAuthor"
- },
- "original_author_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OriginalAuthorID"
- },
- "pin_order": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "PinOrder"
- },
- "pull_request": {
- "$ref": "#/definitions/PullRequestMeta"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "repository": {
- "$ref": "#/definitions/RepositoryMeta"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueConfig": {
- "type": "object",
- "properties": {
- "blank_issues_enabled": {
- "type": "boolean",
- "x-go-name": "BlankIssuesEnabled"
- },
- "contact_links": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/IssueConfigContactLink"
- },
- "x-go-name": "ContactLinks"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueConfigContactLink": {
- "type": "object",
- "properties": {
- "about": {
- "type": "string",
- "x-go-name": "About"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueConfigValidation": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "valid": {
- "type": "boolean",
- "x-go-name": "Valid"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueDeadline": {
- "description": "IssueDeadline represents an issue deadline",
- "type": "object",
- "properties": {
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueFormField": {
- "description": "IssueFormField represents a form field",
- "type": "object",
- "properties": {
- "attributes": {
- "type": "object",
- "additionalProperties": {},
- "x-go-name": "Attributes"
- },
- "id": {
- "type": "string",
- "x-go-name": "ID"
- },
- "type": {
- "$ref": "#/definitions/IssueFormFieldType"
- },
- "validations": {
- "type": "object",
- "additionalProperties": {},
- "x-go-name": "Validations"
- },
- "visible": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/IssueFormFieldVisible"
- },
- "x-go-name": "Visible"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueFormFieldType": {
- "type": "string",
- "title": "IssueFormFieldType defines issue form field type, can be \"markdown\", \"textarea\", \"input\", \"dropdown\" or \"checkboxes\"",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueFormFieldVisible": {
- "description": "IssueFormFieldVisible defines issue form field visible",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueLabelsOption": {
- "description": "IssueLabelsOption a collection of labels",
- "type": "object",
- "properties": {
- "labels": {
- "description": "list of label IDs",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueMeta": {
- "description": "IssueMeta basic issue information",
- "type": "object",
- "properties": {
- "index": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Index"
- },
- "owner": {
- "type": "string",
- "x-go-name": "Owner"
- },
- "repo": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueTemplate": {
- "description": "IssueTemplate represents an issue template for a repository",
- "type": "object",
- "properties": {
- "about": {
- "type": "string",
- "x-go-name": "About"
- },
- "body": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/IssueFormField"
- },
- "x-go-name": "Fields"
- },
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "file_name": {
- "type": "string",
- "x-go-name": "FileName"
- },
- "labels": {
- "$ref": "#/definitions/IssueTemplateLabels"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueTemplateLabels": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Label": {
- "description": "Label a label to an issue or a pr",
- "type": "object",
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "exclusive": {
- "type": "boolean",
- "x-go-name": "Exclusive",
- "example": false
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "is_archived": {
- "type": "boolean",
- "x-go-name": "IsArchived",
- "example": false
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "LabelTemplate": {
- "description": "LabelTemplate info of a Label template",
- "type": "object",
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "exclusive": {
- "type": "boolean",
- "x-go-name": "Exclusive",
- "example": false
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "LicenseTemplateInfo": {
- "description": "LicensesInfo contains information about a License",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "implementation": {
- "type": "string",
- "x-go-name": "Implementation"
- },
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "LicensesTemplateListEntry": {
- "description": "LicensesListEntry is used for the API",
- "type": "object",
- "properties": {
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "MarkdownOption": {
- "description": "MarkdownOption markdown options",
- "type": "object",
- "properties": {
- "Context": {
- "description": "Context to render\n\nin: body",
- "type": "string"
- },
- "Mode": {
- "description": "Mode to render (comment, gfm, markdown)\n\nin: body",
- "type": "string"
- },
- "Text": {
- "description": "Text markdown to render\n\nin: body",
- "type": "string"
- },
- "Wiki": {
- "description": "Is it a wiki page ?\n\nin: body",
- "type": "boolean"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "MarkupOption": {
- "description": "MarkupOption markup options",
- "type": "object",
- "properties": {
- "Context": {
- "description": "Context to render\n\nin: body",
- "type": "string"
- },
- "FilePath": {
- "description": "File path for detecting extension in file mode\n\nin: body",
- "type": "string"
- },
- "Mode": {
- "description": "Mode to render (comment, gfm, markdown, file)\n\nin: body",
- "type": "string"
- },
- "Text": {
- "description": "Text markup to render\n\nin: body",
- "type": "string"
- },
- "Wiki": {
- "description": "Is it a wiki page ?\n\nin: body",
- "type": "boolean"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "MergePullRequestOption": {
- "description": "MergePullRequestForm form for merging Pull Request",
- "type": "object",
- "required": [
- "Do"
- ],
- "properties": {
- "Do": {
- "type": "string",
- "enum": [
- "merge",
- "rebase",
- "rebase-merge",
- "squash",
- "fast-forward-only",
- "manually-merged"
- ]
- },
- "MergeCommitID": {
- "type": "string"
- },
- "MergeMessageField": {
- "type": "string"
- },
- "MergeTitleField": {
- "type": "string"
- },
- "delete_branch_after_merge": {
- "type": "boolean",
- "x-go-name": "DeleteBranchAfterMerge"
- },
- "force_merge": {
- "type": "boolean",
- "x-go-name": "ForceMerge"
- },
- "head_commit_id": {
- "type": "string",
- "x-go-name": "HeadCommitID"
- },
- "merge_when_checks_succeed": {
- "type": "boolean",
- "x-go-name": "MergeWhenChecksSucceed"
- }
- },
- "x-go-name": "MergePullRequestForm",
- "x-go-package": "code.gitea.io/gitea/services/forms"
- },
- "MigrateRepoOptions": {
- "description": "MigrateRepoOptions options for migrating repository's\nthis is used to interact with api v1",
- "type": "object",
- "required": [
- "clone_addr",
- "repo_name"
- ],
- "properties": {
- "auth_password": {
- "type": "string",
- "x-go-name": "AuthPassword"
- },
- "auth_token": {
- "type": "string",
- "x-go-name": "AuthToken"
- },
- "auth_username": {
- "type": "string",
- "x-go-name": "AuthUsername"
- },
- "clone_addr": {
- "type": "string",
- "x-go-name": "CloneAddr"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "issues": {
- "type": "boolean",
- "x-go-name": "Issues"
- },
- "labels": {
- "type": "boolean",
- "x-go-name": "Labels"
- },
- "lfs": {
- "type": "boolean",
- "x-go-name": "LFS"
- },
- "lfs_endpoint": {
- "type": "string",
- "x-go-name": "LFSEndpoint"
- },
- "milestones": {
- "type": "boolean",
- "x-go-name": "Milestones"
- },
- "mirror": {
- "type": "boolean",
- "x-go-name": "Mirror"
- },
- "mirror_interval": {
- "type": "string",
- "x-go-name": "MirrorInterval"
- },
- "private": {
- "type": "boolean",
- "x-go-name": "Private"
- },
- "pull_requests": {
- "type": "boolean",
- "x-go-name": "PullRequests"
- },
- "releases": {
- "type": "boolean",
- "x-go-name": "Releases"
- },
- "repo_name": {
- "type": "string",
- "x-go-name": "RepoName"
- },
- "repo_owner": {
- "description": "Name of User or Organisation who will own Repo after migration",
- "type": "string",
- "x-go-name": "RepoOwner"
- },
- "service": {
- "type": "string",
- "enum": [
- "git",
- "github",
- "gitea",
- "gitlab",
- "gogs",
- "onedev",
- "gitbucket",
- "codebase"
- ],
- "x-go-name": "Service"
- },
- "uid": {
- "description": "deprecated (only for backwards compatibility)",
- "type": "integer",
- "format": "int64",
- "x-go-name": "RepoOwnerID"
- },
- "wiki": {
- "type": "boolean",
- "x-go-name": "Wiki"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Milestone": {
- "description": "Milestone milestone is a collection of issues on one repository",
- "type": "object",
- "properties": {
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "closed_issues": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ClosedIssues"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "open_issues": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenIssues"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NewIssuePinsAllowed": {
- "description": "NewIssuePinsAllowed represents an API response that says if new Issue Pins are allowed",
- "type": "object",
- "properties": {
- "issues": {
- "type": "boolean",
- "x-go-name": "Issues"
- },
- "pull_requests": {
- "type": "boolean",
- "x-go-name": "PullRequests"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NodeInfo": {
- "description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
- "type": "object",
- "properties": {
- "metadata": {
- "type": "object",
- "x-go-name": "Metadata"
- },
- "openRegistrations": {
- "type": "boolean",
- "x-go-name": "OpenRegistrations"
- },
- "protocols": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Protocols"
- },
- "services": {
- "$ref": "#/definitions/NodeInfoServices"
- },
- "software": {
- "$ref": "#/definitions/NodeInfoSoftware"
- },
- "usage": {
- "$ref": "#/definitions/NodeInfoUsage"
- },
- "version": {
- "type": "string",
- "x-go-name": "Version"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NodeInfoServices": {
- "description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
- "type": "object",
- "properties": {
- "inbound": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Inbound"
- },
- "outbound": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Outbound"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NodeInfoSoftware": {
- "description": "NodeInfoSoftware contains Metadata about server software in use",
- "type": "object",
- "properties": {
- "homepage": {
- "type": "string",
- "x-go-name": "Homepage"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "repository": {
- "type": "string",
- "x-go-name": "Repository"
- },
- "version": {
- "type": "string",
- "x-go-name": "Version"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NodeInfoUsage": {
- "description": "NodeInfoUsage contains usage statistics for this server",
- "type": "object",
- "properties": {
- "localComments": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "LocalComments"
- },
- "localPosts": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "LocalPosts"
- },
- "users": {
- "$ref": "#/definitions/NodeInfoUsageUsers"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NodeInfoUsageUsers": {
- "description": "NodeInfoUsageUsers contains statistics about the users of this server",
- "type": "object",
- "properties": {
- "activeHalfyear": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ActiveHalfyear"
- },
- "activeMonth": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ActiveMonth"
- },
- "total": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Total"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Note": {
- "description": "Note contains information related to a git note",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/Commit"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NotificationCount": {
- "description": "NotificationCount number of unread notifications",
- "type": "object",
- "properties": {
- "new": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "New"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NotificationSubject": {
- "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
- "type": "object",
- "properties": {
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "latest_comment_html_url": {
- "type": "string",
- "x-go-name": "LatestCommentHTMLURL"
- },
- "latest_comment_url": {
- "type": "string",
- "x-go-name": "LatestCommentURL"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "type": {
- "$ref": "#/definitions/NotifySubjectType"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NotificationThread": {
- "description": "NotificationThread expose Notification on API",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "pinned": {
- "type": "boolean",
- "x-go-name": "Pinned"
- },
- "repository": {
- "$ref": "#/definitions/Repository"
- },
- "subject": {
- "$ref": "#/definitions/NotificationSubject"
- },
- "unread": {
- "type": "boolean",
- "x-go-name": "Unread"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "UpdatedAt"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NotifySubjectType": {
- "description": "NotifySubjectType represent type of notification subject",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "OAuth2Application": {
- "type": "object",
- "title": "OAuth2Application represents an OAuth2 application.",
- "properties": {
- "client_id": {
- "type": "string",
- "x-go-name": "ClientID"
- },
- "client_secret": {
- "type": "string",
- "x-go-name": "ClientSecret"
- },
- "confidential_client": {
- "type": "boolean",
- "x-go-name": "ConfidentialClient"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "redirect_uris": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "RedirectURIs"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Organization": {
- "description": "Organization represents an organization",
- "type": "object",
- "properties": {
- "avatar_url": {
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "email": {
- "type": "string",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "repo_admin_change_team_access": {
- "type": "boolean",
- "x-go-name": "RepoAdminChangeTeamAccess"
- },
- "username": {
- "description": "deprecated",
- "type": "string",
- "x-go-name": "UserName"
- },
- "visibility": {
- "type": "string",
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "OrganizationPermissions": {
- "description": "OrganizationPermissions list different users permissions on an organization",
- "type": "object",
- "properties": {
- "can_create_repository": {
- "type": "boolean",
- "x-go-name": "CanCreateRepository"
- },
- "can_read": {
- "type": "boolean",
- "x-go-name": "CanRead"
- },
- "can_write": {
- "type": "boolean",
- "x-go-name": "CanWrite"
- },
- "is_admin": {
- "type": "boolean",
- "x-go-name": "IsAdmin"
- },
- "is_owner": {
- "type": "boolean",
- "x-go-name": "IsOwner"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PRBranchInfo": {
- "description": "PRBranchInfo information about a branch",
- "type": "object",
- "properties": {
- "label": {
- "type": "string",
- "x-go-name": "Name"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "repo": {
- "$ref": "#/definitions/Repository"
- },
- "repo_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RepoID"
- },
- "sha": {
- "type": "string",
- "x-go-name": "Sha"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Package": {
- "description": "Package represents a package",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedAt"
- },
- "creator": {
- "$ref": "#/definitions/User"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "owner": {
- "$ref": "#/definitions/User"
- },
- "repository": {
- "$ref": "#/definitions/Repository"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "version": {
- "type": "string",
- "x-go-name": "Version"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PackageFile": {
- "description": "PackageFile represents a package file",
- "type": "object",
- "properties": {
- "Size": {
- "type": "integer",
- "format": "int64"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "md5": {
- "type": "string",
- "x-go-name": "HashMD5"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "sha1": {
- "type": "string",
- "x-go-name": "HashSHA1"
- },
- "sha256": {
- "type": "string",
- "x-go-name": "HashSHA256"
- },
- "sha512": {
- "type": "string",
- "x-go-name": "HashSHA512"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadCommit": {
- "description": "PayloadCommit represents a commit",
- "type": "object",
- "properties": {
- "added": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Added"
- },
- "author": {
- "$ref": "#/definitions/PayloadUser"
- },
- "committer": {
- "$ref": "#/definitions/PayloadUser"
- },
- "id": {
- "description": "sha1 hash of the commit",
- "type": "string",
- "x-go-name": "ID"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "modified": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Modified"
- },
- "removed": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Removed"
- },
- "timestamp": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Timestamp"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadCommitVerification": {
- "description": "PayloadCommitVerification represents the GPG verification of a commit",
- "type": "object",
- "properties": {
- "payload": {
- "type": "string",
- "x-go-name": "Payload"
- },
- "reason": {
- "type": "string",
- "x-go-name": "Reason"
- },
- "signature": {
- "type": "string",
- "x-go-name": "Signature"
- },
- "signer": {
- "$ref": "#/definitions/PayloadUser"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadUser": {
- "description": "PayloadUser represents the author or committer of a commit",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "description": "Full name of the commit author",
- "type": "string",
- "x-go-name": "Name"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Permission": {
- "description": "Permission represents a set of permissions",
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean",
- "x-go-name": "Admin"
- },
- "pull": {
- "type": "boolean",
- "x-go-name": "Pull"
- },
- "push": {
- "type": "boolean",
- "x-go-name": "Push"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PublicKey": {
- "description": "PublicKey publickey is a user key to push code to repository",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "fingerprint": {
- "type": "string",
- "x-go-name": "Fingerprint"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "key_type": {
- "type": "string",
- "x-go-name": "KeyType"
- },
- "read_only": {
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullRequest": {
- "description": "PullRequest represents a pull request",
- "type": "object",
- "properties": {
- "allow_maintainer_edit": {
- "type": "boolean",
- "x-go-name": "AllowMaintainerEdit"
- },
- "assignee": {
- "$ref": "#/definitions/User"
- },
- "assignees": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- },
- "x-go-name": "Assignees"
- },
- "base": {
- "$ref": "#/definitions/PRBranchInfo"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "comments": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "diff_url": {
- "type": "string",
- "x-go-name": "DiffURL"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "head": {
- "$ref": "#/definitions/PRBranchInfo"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "is_locked": {
- "type": "boolean",
- "x-go-name": "IsLocked"
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- },
- "x-go-name": "Labels"
- },
- "merge_base": {
- "type": "string",
- "x-go-name": "MergeBase"
- },
- "merge_commit_sha": {
- "type": "string",
- "x-go-name": "MergedCommitID"
- },
- "mergeable": {
- "type": "boolean",
- "x-go-name": "Mergeable"
- },
- "merged": {
- "type": "boolean",
- "x-go-name": "HasMerged"
- },
- "merged_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Merged"
- },
- "merged_by": {
- "$ref": "#/definitions/User"
- },
- "milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "number": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Index"
- },
- "patch_url": {
- "type": "string",
- "x-go-name": "PatchURL"
- },
- "pin_order": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "PinOrder"
- },
- "requested_reviewers": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- },
- "x-go-name": "RequestedReviewers"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullRequestMeta": {
- "description": "PullRequestMeta PR info if an issue is a PR",
- "type": "object",
- "properties": {
- "draft": {
- "type": "boolean",
- "x-go-name": "IsWorkInProgress"
- },
- "merged": {
- "type": "boolean",
- "x-go-name": "HasMerged"
- },
- "merged_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Merged"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullReview": {
- "description": "PullReview represents a pull request review",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "comments_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "CodeCommentsCount"
- },
- "commit_id": {
- "type": "string",
- "x-go-name": "CommitID"
- },
- "dismissed": {
- "type": "boolean",
- "x-go-name": "Dismissed"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "official": {
- "type": "boolean",
- "x-go-name": "Official"
- },
- "pull_request_url": {
- "type": "string",
- "x-go-name": "HTMLPullURL"
- },
- "stale": {
- "type": "boolean",
- "x-go-name": "Stale"
- },
- "state": {
- "$ref": "#/definitions/ReviewStateType"
- },
- "submitted_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Submitted"
- },
- "team": {
- "$ref": "#/definitions/Team"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullReviewComment": {
- "description": "PullReviewComment represents a comment on a pull request review",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "commit_id": {
- "type": "string",
- "x-go-name": "CommitID"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "diff_hunk": {
- "type": "string",
- "x-go-name": "DiffHunk"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "original_commit_id": {
- "type": "string",
- "x-go-name": "OrigCommitID"
- },
- "original_position": {
- "type": "integer",
- "format": "uint64",
- "x-go-name": "OldLineNum"
- },
- "path": {
- "type": "string",
- "x-go-name": "Path"
- },
- "position": {
- "type": "integer",
- "format": "uint64",
- "x-go-name": "LineNum"
- },
- "pull_request_review_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ReviewID"
- },
- "pull_request_url": {
- "type": "string",
- "x-go-name": "HTMLPullURL"
- },
- "resolver": {
- "$ref": "#/definitions/User"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullReviewRequestOptions": {
- "description": "PullReviewRequestOptions are options to add or remove pull review requests",
- "type": "object",
- "properties": {
- "reviewers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Reviewers"
- },
- "team_reviewers": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "TeamReviewers"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PushMirror": {
- "description": "PushMirror represents information of a push mirror",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedUnix"
- },
- "interval": {
- "type": "string",
- "x-go-name": "Interval"
- },
- "last_error": {
- "type": "string",
- "x-go-name": "LastError"
- },
- "last_update": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "LastUpdateUnix"
- },
- "remote_address": {
- "type": "string",
- "x-go-name": "RemoteAddress"
- },
- "remote_name": {
- "type": "string",
- "x-go-name": "RemoteName"
- },
- "repo_name": {
- "type": "string",
- "x-go-name": "RepoName"
- },
- "sync_on_commit": {
- "type": "boolean",
- "x-go-name": "SyncOnCommit"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Reaction": {
- "description": "Reaction contain one reaction",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Reaction"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Reference": {
- "type": "object",
- "title": "Reference represents a Git reference.",
- "properties": {
- "object": {
- "$ref": "#/definitions/GitObject"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Release": {
- "description": "Release represents a repository release",
- "type": "object",
- "properties": {
- "assets": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- },
- "x-go-name": "Attachments"
- },
- "author": {
- "$ref": "#/definitions/User"
- },
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedAt"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "published_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "PublishedAt"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "tarball_url": {
- "type": "string",
- "x-go-name": "TarURL"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- },
- "upload_url": {
- "type": "string",
- "x-go-name": "UploadURL"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "zipball_url": {
- "type": "string",
- "x-go-name": "ZipURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RenameUserOption": {
- "description": "RenameUserOption options when renaming a user",
- "type": "object",
- "required": [
- "new_username"
- ],
- "properties": {
- "new_username": {
- "description": "New username for this user. This name cannot be in use yet by any other user.",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "NewName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepoCollaboratorPermission": {
- "description": "RepoCollaboratorPermission to get repository permission for a collaborator",
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "x-go-name": "Permission"
- },
- "role_name": {
- "type": "string",
- "x-go-name": "RoleName"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepoCommit": {
- "type": "object",
- "title": "RepoCommit contains information of a commit in the context of a repository.",
- "properties": {
- "author": {
- "$ref": "#/definitions/CommitUser"
- },
- "committer": {
- "$ref": "#/definitions/CommitUser"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "tree": {
- "$ref": "#/definitions/CommitMeta"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepoTopicOptions": {
- "description": "RepoTopicOptions a collection of repo topic names",
- "type": "object",
- "properties": {
- "topics": {
- "description": "list of topic names",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Topics"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepoTransfer": {
- "description": "RepoTransfer represents a pending repo transfer",
- "type": "object",
- "properties": {
- "doer": {
- "$ref": "#/definitions/User"
- },
- "recipient": {
- "$ref": "#/definitions/User"
- },
- "teams": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Team"
- },
- "x-go-name": "Teams"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Repository": {
- "description": "Repository represents a repository",
- "type": "object",
- "properties": {
- "allow_fast_forward_only_merge": {
- "type": "boolean",
- "x-go-name": "AllowFastForwardOnly"
- },
- "allow_merge_commits": {
- "type": "boolean",
- "x-go-name": "AllowMerge"
- },
- "allow_rebase": {
- "type": "boolean",
- "x-go-name": "AllowRebase"
- },
- "allow_rebase_explicit": {
- "type": "boolean",
- "x-go-name": "AllowRebaseMerge"
- },
- "allow_rebase_update": {
- "type": "boolean",
- "x-go-name": "AllowRebaseUpdate"
- },
- "allow_squash_merge": {
- "type": "boolean",
- "x-go-name": "AllowSquash"
- },
- "archived": {
- "type": "boolean",
- "x-go-name": "Archived"
- },
- "archived_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "ArchivedAt"
- },
- "avatar_url": {
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "clone_url": {
- "type": "string",
- "x-go-name": "CloneURL"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "default_allow_maintainer_edit": {
- "type": "boolean",
- "x-go-name": "DefaultAllowMaintainerEdit"
- },
- "default_branch": {
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "default_delete_branch_after_merge": {
- "type": "boolean",
- "x-go-name": "DefaultDeleteBranchAfterMerge"
- },
- "default_merge_style": {
- "type": "string",
- "x-go-name": "DefaultMergeStyle"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "empty": {
- "type": "boolean",
- "x-go-name": "Empty"
- },
- "external_tracker": {
- "$ref": "#/definitions/ExternalTracker"
- },
- "external_wiki": {
- "$ref": "#/definitions/ExternalWiki"
- },
- "fork": {
- "type": "boolean",
- "x-go-name": "Fork"
- },
- "forks_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Forks"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "has_actions": {
- "type": "boolean",
- "x-go-name": "HasActions"
- },
- "has_issues": {
- "type": "boolean",
- "x-go-name": "HasIssues"
- },
- "has_packages": {
- "type": "boolean",
- "x-go-name": "HasPackages"
- },
- "has_projects": {
- "type": "boolean",
- "x-go-name": "HasProjects"
- },
- "has_pull_requests": {
- "type": "boolean",
- "x-go-name": "HasPullRequests"
- },
- "has_releases": {
- "type": "boolean",
- "x-go-name": "HasReleases"
- },
- "has_wiki": {
- "type": "boolean",
- "x-go-name": "HasWiki"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "ignore_whitespace_conflicts": {
- "type": "boolean",
- "x-go-name": "IgnoreWhitespaceConflicts"
- },
- "internal": {
- "type": "boolean",
- "x-go-name": "Internal"
- },
- "internal_tracker": {
- "$ref": "#/definitions/InternalTracker"
- },
- "language": {
- "type": "string",
- "x-go-name": "Language"
- },
- "languages_url": {
- "type": "string",
- "x-go-name": "LanguagesURL"
- },
- "link": {
- "type": "string",
- "x-go-name": "Link"
- },
- "mirror": {
- "type": "boolean",
- "x-go-name": "Mirror"
- },
- "mirror_interval": {
- "type": "string",
- "x-go-name": "MirrorInterval"
- },
- "mirror_updated": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "MirrorUpdated"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "object_format_name": {
- "description": "ObjectFormatName of the underlying git repository",
- "type": "string",
- "enum": [
- "sha1",
- "sha256"
- ],
- "x-go-name": "ObjectFormatName"
- },
- "open_issues_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenIssues"
- },
- "open_pr_counter": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenPulls"
- },
- "original_url": {
- "type": "string",
- "x-go-name": "OriginalURL"
- },
- "owner": {
- "$ref": "#/definitions/User"
- },
- "parent": {
- "$ref": "#/definitions/Repository"
- },
- "permissions": {
- "$ref": "#/definitions/Permission"
- },
- "private": {
- "type": "boolean",
- "x-go-name": "Private"
- },
- "projects_mode": {
- "type": "string",
- "x-go-name": "ProjectsMode"
- },
- "release_counter": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Releases"
- },
- "repo_transfer": {
- "$ref": "#/definitions/RepoTransfer"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "ssh_url": {
- "type": "string",
- "x-go-name": "SSHURL"
- },
- "stars_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Stars"
- },
- "template": {
- "type": "boolean",
- "x-go-name": "Template"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "watchers_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Watchers"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepositoryMeta": {
- "description": "RepositoryMeta basic repository information",
- "type": "object",
- "properties": {
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "owner": {
- "type": "string",
- "x-go-name": "Owner"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ReviewStateType": {
- "description": "ReviewStateType review state type",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "SearchResults": {
- "description": "SearchResults results of a successful search",
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Repository"
- },
- "x-go-name": "Data"
- },
- "ok": {
- "type": "boolean",
- "x-go-name": "OK"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Secret": {
- "description": "Secret represents a secret",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "name": {
- "description": "the secret's name",
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ServerVersion": {
- "description": "ServerVersion wraps the version of the server",
- "type": "object",
- "properties": {
- "version": {
- "type": "string",
- "x-go-name": "Version"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "StateType": {
- "description": "StateType issue state type",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "StopWatch": {
- "description": "StopWatch represent a running stopwatch",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "duration": {
- "type": "string",
- "x-go-name": "Duration"
- },
- "issue_index": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "IssueIndex"
- },
- "issue_title": {
- "type": "string",
- "x-go-name": "IssueTitle"
- },
- "repo_name": {
- "type": "string",
- "x-go-name": "RepoName"
- },
- "repo_owner_name": {
- "type": "string",
- "x-go-name": "RepoOwnerName"
- },
- "seconds": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Seconds"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "SubmitPullReviewOptions": {
- "description": "SubmitPullReviewOptions are options to submit a pending pull review",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "event": {
- "$ref": "#/definitions/ReviewStateType"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Tag": {
- "description": "Tag represents a repository tag",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/CommitMeta"
- },
- "id": {
- "type": "string",
- "x-go-name": "ID"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "tarball_url": {
- "type": "string",
- "x-go-name": "TarballURL"
- },
- "zipball_url": {
- "type": "string",
- "x-go-name": "ZipballURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Team": {
- "description": "Team represents a team in an organization",
- "type": "object",
- "properties": {
- "can_create_org_repo": {
- "type": "boolean",
- "x-go-name": "CanCreateOrgRepo"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "includes_all_repositories": {
- "type": "boolean",
- "x-go-name": "IncludesAllRepositories"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "organization": {
- "$ref": "#/definitions/Organization"
- },
- "permission": {
- "type": "string",
- "enum": [
- "none",
- "read",
- "write",
- "admin",
- "owner"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Units",
- "example": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.projects",
- "repo.ext_wiki"
- ]
- },
- "units_map": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "UnitsMap",
- "example": {
- "repo.code": "read",
- "repo.ext_issues": "none",
- "repo.ext_wiki": "none",
- "repo.issues": "write",
- "repo.projects": "none",
- "repo.pulls": "owner",
- "repo.releases": "none",
- "repo.wiki": "admin"
- }
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TimeStamp": {
- "description": "TimeStamp defines a timestamp",
- "type": "integer",
- "format": "int64",
- "x-go-package": "code.gitea.io/gitea/modules/timeutil"
- },
- "TimelineComment": {
- "description": "TimelineComment represents a timeline comment (comment of any type) on a commit or issue",
- "type": "object",
- "properties": {
- "assignee": {
- "$ref": "#/definitions/User"
- },
- "assignee_team": {
- "$ref": "#/definitions/Team"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "dependent_issue": {
- "$ref": "#/definitions/Issue"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "issue_url": {
- "type": "string",
- "x-go-name": "IssueURL"
- },
- "label": {
- "$ref": "#/definitions/Label"
- },
- "milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "new_ref": {
- "type": "string",
- "x-go-name": "NewRef"
- },
- "new_title": {
- "type": "string",
- "x-go-name": "NewTitle"
- },
- "old_milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "old_project_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OldProjectID"
- },
- "old_ref": {
- "type": "string",
- "x-go-name": "OldRef"
- },
- "old_title": {
- "type": "string",
- "x-go-name": "OldTitle"
- },
- "project_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ProjectID"
- },
- "pull_request_url": {
- "type": "string",
- "x-go-name": "PRURL"
- },
- "ref_action": {
- "type": "string",
- "x-go-name": "RefAction"
- },
- "ref_comment": {
- "$ref": "#/definitions/Comment"
- },
- "ref_commit_sha": {
- "description": "commit SHA where issue/PR was referenced",
- "type": "string",
- "x-go-name": "RefCommitSHA"
- },
- "ref_issue": {
- "$ref": "#/definitions/Issue"
- },
- "removed_assignee": {
- "description": "whether the assignees were removed or added",
- "type": "boolean",
- "x-go-name": "RemovedAssignee"
- },
- "resolve_doer": {
- "$ref": "#/definitions/User"
- },
- "review_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ReviewID"
- },
- "tracked_time": {
- "$ref": "#/definitions/TrackedTime"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TopicName": {
- "description": "TopicName a list of repo topic names",
- "type": "object",
- "properties": {
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "TopicNames"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TopicResponse": {
- "description": "TopicResponse for returning topics",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "repo_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RepoCount"
- },
- "topic_name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "updated": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TrackedTime": {
- "description": "TrackedTime worked time for an issue / pr",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "issue": {
- "$ref": "#/definitions/Issue"
- },
- "issue_id": {
- "description": "deprecated (only for backwards compatibility)",
- "type": "integer",
- "format": "int64",
- "x-go-name": "IssueID"
- },
- "time": {
- "description": "Time in seconds",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Time"
- },
- "user_id": {
- "description": "deprecated (only for backwards compatibility)",
- "type": "integer",
- "format": "int64",
- "x-go-name": "UserID"
- },
- "user_name": {
- "type": "string",
- "x-go-name": "UserName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TransferRepoOption": {
- "description": "TransferRepoOption options when transfer a repository's ownership",
- "type": "object",
- "required": [
- "new_owner"
- ],
- "properties": {
- "new_owner": {
- "type": "string",
- "x-go-name": "NewOwner"
- },
- "team_ids": {
- "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "TeamIDs"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UpdateFileOptions": {
- "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)",
- "type": "object",
- "required": [
- "sha",
- "content"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "content": {
- "description": "content must be base64 encoded",
- "type": "string",
- "x-go-name": "ContentBase64"
- },
- "dates": {
- "$ref": "#/definitions/CommitDateOptions"
- },
- "from_path": {
- "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
- "type": "string",
- "x-go-name": "FromPath"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "sha": {
- "description": "sha is the SHA for the file that already exists",
- "type": "string",
- "x-go-name": "SHA"
- },
- "signoff": {
- "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
- "type": "boolean",
- "x-go-name": "Signoff"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UpdateRepoAvatarOption": {
- "description": "UpdateRepoAvatarUserOption options when updating the repo avatar",
- "type": "object",
- "properties": {
- "image": {
- "description": "image must be base64 encoded",
- "type": "string",
- "x-go-name": "Image"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UpdateUserAvatarOption": {
- "description": "UpdateUserAvatarUserOption options when updating the user avatar",
- "type": "object",
- "properties": {
- "image": {
- "description": "image must be base64 encoded",
- "type": "string",
- "x-go-name": "Image"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "User": {
- "description": "User represents a user",
- "type": "object",
- "properties": {
- "active": {
- "description": "Is user active",
- "type": "boolean",
- "x-go-name": "IsActive"
- },
- "avatar_url": {
- "description": "URL to the user's avatar",
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "description": {
- "description": "the user's description",
- "type": "string",
- "x-go-name": "Description"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "followers_count": {
- "description": "user counts",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Followers"
- },
- "following_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Following"
- },
- "full_name": {
- "description": "the user's full name",
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "description": "the user's id",
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "is_admin": {
- "description": "Is the user an administrator",
- "type": "boolean",
- "x-go-name": "IsAdmin"
- },
- "language": {
- "description": "User locale",
- "type": "string",
- "x-go-name": "Language"
- },
- "last_login": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "LastLogin"
- },
- "location": {
- "description": "the user's location",
- "type": "string",
- "x-go-name": "Location"
- },
- "login": {
- "description": "the user's username",
- "type": "string",
- "x-go-name": "UserName"
- },
- "login_name": {
- "description": "the user's authentication sign-in name.",
- "type": "string",
- "default": "empty",
- "x-go-name": "LoginName"
- },
- "prohibit_login": {
- "description": "Is user login prohibited",
- "type": "boolean",
- "x-go-name": "ProhibitLogin"
- },
- "restricted": {
- "description": "Is user restricted",
- "type": "boolean",
- "x-go-name": "Restricted"
- },
- "starred_repos_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "StarredRepos"
- },
- "visibility": {
- "description": "User visibility level option: public, limited, private",
- "type": "string",
- "x-go-name": "Visibility"
- },
- "website": {
- "description": "the user's website",
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UserBadgeOption": {
- "description": "UserBadgeOption options for link between users and badges",
- "type": "object",
- "properties": {
- "badge_slugs": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "BadgeSlugs",
- "example": [
- "badge1",
- "badge2"
- ]
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UserHeatmapData": {
- "description": "UserHeatmapData represents the data needed to create a heatmap",
- "type": "object",
- "properties": {
- "contributions": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Contributions"
- },
- "timestamp": {
- "$ref": "#/definitions/TimeStamp"
- }
- },
- "x-go-package": "code.gitea.io/gitea/models/activities"
- },
- "UserSettings": {
- "description": "UserSettings represents user settings",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "diff_view_style": {
- "type": "string",
- "x-go-name": "DiffViewStyle"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "hide_activity": {
- "type": "boolean",
- "x-go-name": "HideActivity"
- },
- "hide_email": {
- "description": "Privacy",
- "type": "boolean",
- "x-go-name": "HideEmail"
- },
- "language": {
- "type": "string",
- "x-go-name": "Language"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "theme": {
- "type": "string",
- "x-go-name": "Theme"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UserSettingsOptions": {
- "description": "UserSettingsOptions represents options to change user settings",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "diff_view_style": {
- "type": "string",
- "x-go-name": "DiffViewStyle"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "hide_activity": {
- "type": "boolean",
- "x-go-name": "HideActivity"
- },
- "hide_email": {
- "description": "Privacy",
- "type": "boolean",
- "x-go-name": "HideEmail"
- },
- "language": {
- "type": "string",
- "x-go-name": "Language"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "theme": {
- "type": "string",
- "x-go-name": "Theme"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "WatchInfo": {
- "description": "WatchInfo represents an API watch status of one repository",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedAt"
- },
- "ignored": {
- "type": "boolean",
- "x-go-name": "Ignored"
- },
- "reason": {
- "x-go-name": "Reason"
- },
- "repository_url": {
- "type": "string",
- "x-go-name": "RepositoryURL"
- },
- "subscribed": {
- "type": "boolean",
- "x-go-name": "Subscribed"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "WikiCommit": {
- "description": "WikiCommit page commit/revision",
- "type": "object",
- "properties": {
- "author": {
- "$ref": "#/definitions/CommitUser"
- },
- "commiter": {
- "$ref": "#/definitions/CommitUser"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "sha": {
- "type": "string",
- "x-go-name": "ID"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "WikiCommitList": {
- "description": "WikiCommitList commit/revision list",
- "type": "object",
- "properties": {
- "commits": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/WikiCommit"
- },
- "x-go-name": "WikiCommits"
- },
- "count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Count"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "WikiPage": {
- "description": "WikiPage a wiki page",
- "type": "object",
- "properties": {
- "commit_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "CommitCount"
- },
- "content_base64": {
- "description": "Page content, base64 encoded",
- "type": "string",
- "x-go-name": "ContentBase64"
- },
- "footer": {
- "type": "string",
- "x-go-name": "Footer"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "last_commit": {
- "$ref": "#/definitions/WikiCommit"
- },
- "sidebar": {
- "type": "string",
- "x-go-name": "Sidebar"
- },
- "sub_url": {
- "type": "string",
- "x-go-name": "SubURL"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "WikiPageMetaData": {
- "description": "WikiPageMetaData wiki page meta information",
- "type": "object",
- "properties": {
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "last_commit": {
- "$ref": "#/definitions/WikiCommit"
- },
- "sub_url": {
- "type": "string",
- "x-go-name": "SubURL"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- }
- },
- "responses": {
- "AccessToken": {
- "description": "AccessToken represents an API access token.",
- "schema": {
- "$ref": "#/definitions/AccessToken"
- }
- },
- "AccessTokenList": {
- "description": "AccessTokenList represents a list of API access token.",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/AccessToken"
- }
- }
- },
- "ActivityFeedsList": {
- "description": "ActivityFeedsList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Activity"
- }
- }
- },
- "ActivityPub": {
- "description": "ActivityPub",
- "schema": {
- "$ref": "#/definitions/ActivityPub"
- }
- },
- "AnnotatedTag": {
- "description": "AnnotatedTag",
- "schema": {
- "$ref": "#/definitions/AnnotatedTag"
- }
- },
- "Attachment": {
- "description": "Attachment",
- "schema": {
- "$ref": "#/definitions/Attachment"
- }
- },
- "AttachmentList": {
- "description": "AttachmentList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- }
- }
- },
- "BadgeList": {
- "description": "BadgeList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Badge"
- }
- }
- },
- "Branch": {
- "description": "Branch",
- "schema": {
- "$ref": "#/definitions/Branch"
- }
- },
- "BranchList": {
- "description": "BranchList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Branch"
- }
- }
- },
- "BranchProtection": {
- "description": "BranchProtection",
- "schema": {
- "$ref": "#/definitions/BranchProtection"
- }
- },
- "BranchProtectionList": {
- "description": "BranchProtectionList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/BranchProtection"
- }
- }
- },
- "ChangedFileList": {
- "description": "ChangedFileList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ChangedFile"
- }
- },
- "headers": {
- "X-HasMore": {
- "type": "boolean",
- "description": "True if there is another page"
- },
- "X-Page": {
- "type": "integer",
- "format": "int64",
- "description": "The current page"
- },
- "X-PageCount": {
- "type": "integer",
- "format": "int64",
- "description": "Total number of pages"
- },
- "X-PerPage": {
- "type": "integer",
- "format": "int64",
- "description": "Commits per page"
- },
- "X-Total": {
- "type": "integer",
- "format": "int64",
- "description": "Total commit count"
- }
- }
- },
- "CombinedStatus": {
- "description": "CombinedStatus",
- "schema": {
- "$ref": "#/definitions/CombinedStatus"
- }
- },
- "Comment": {
- "description": "Comment",
- "schema": {
- "$ref": "#/definitions/Comment"
- }
- },
- "CommentList": {
- "description": "CommentList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Comment"
- }
- }
- },
- "Commit": {
- "description": "Commit",
- "schema": {
- "$ref": "#/definitions/Commit"
- }
- },
- "CommitList": {
- "description": "CommitList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Commit"
- }
- },
- "headers": {
- "X-HasMore": {
- "type": "boolean",
- "description": "True if there is another page"
- },
- "X-Page": {
- "type": "integer",
- "format": "int64",
- "description": "The current page"
- },
- "X-PageCount": {
- "type": "integer",
- "format": "int64",
- "description": "Total number of pages"
- },
- "X-PerPage": {
- "type": "integer",
- "format": "int64",
- "description": "Commits per page"
- },
- "X-Total": {
- "type": "integer",
- "format": "int64",
- "description": "Total commit count"
- }
- }
- },
- "CommitStatus": {
- "description": "CommitStatus",
- "schema": {
- "$ref": "#/definitions/CommitStatus"
- }
- },
- "CommitStatusList": {
- "description": "CommitStatusList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitStatus"
- }
- }
- },
- "ContentsListResponse": {
- "description": "ContentsListResponse",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ContentsResponse"
- }
- }
- },
- "ContentsResponse": {
- "description": "ContentsResponse",
- "schema": {
- "$ref": "#/definitions/ContentsResponse"
- }
- },
- "CronList": {
- "description": "CronList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Cron"
- }
- }
- },
- "DeployKey": {
- "description": "DeployKey",
- "schema": {
- "$ref": "#/definitions/DeployKey"
- }
- },
- "DeployKeyList": {
- "description": "DeployKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/DeployKey"
- }
- }
- },
- "EmailList": {
- "description": "EmailList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Email"
- }
- }
- },
- "EmptyRepository": {
- "description": "EmptyRepository",
- "schema": {
- "$ref": "#/definitions/APIError"
- }
- },
- "FileDeleteResponse": {
- "description": "FileDeleteResponse",
- "schema": {
- "$ref": "#/definitions/FileDeleteResponse"
- }
- },
- "FileResponse": {
- "description": "FileResponse",
- "schema": {
- "$ref": "#/definitions/FileResponse"
- }
- },
- "FilesResponse": {
- "description": "FilesResponse",
- "schema": {
- "$ref": "#/definitions/FilesResponse"
- }
- },
- "GPGKey": {
- "description": "GPGKey",
- "schema": {
- "$ref": "#/definitions/GPGKey"
- }
- },
- "GPGKeyList": {
- "description": "GPGKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKey"
- }
- }
- },
- "GeneralAPISettings": {
- "description": "GeneralAPISettings",
- "schema": {
- "$ref": "#/definitions/GeneralAPISettings"
- }
- },
- "GeneralAttachmentSettings": {
- "description": "GeneralAttachmentSettings",
- "schema": {
- "$ref": "#/definitions/GeneralAttachmentSettings"
- }
- },
- "GeneralRepoSettings": {
- "description": "GeneralRepoSettings",
- "schema": {
- "$ref": "#/definitions/GeneralRepoSettings"
- }
- },
- "GeneralUISettings": {
- "description": "GeneralUISettings",
- "schema": {
- "$ref": "#/definitions/GeneralUISettings"
- }
- },
- "GitBlobResponse": {
- "description": "GitBlobResponse",
- "schema": {
- "$ref": "#/definitions/GitBlobResponse"
- }
- },
- "GitHook": {
- "description": "GitHook",
- "schema": {
- "$ref": "#/definitions/GitHook"
- }
- },
- "GitHookList": {
- "description": "GitHookList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GitHook"
- }
- }
- },
- "GitTreeResponse": {
- "description": "GitTreeResponse",
- "schema": {
- "$ref": "#/definitions/GitTreeResponse"
- }
- },
- "GitignoreTemplateInfo": {
- "description": "GitignoreTemplateInfo",
- "schema": {
- "$ref": "#/definitions/GitignoreTemplateInfo"
- }
- },
- "GitignoreTemplateList": {
- "description": "GitignoreTemplateList",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "Hook": {
- "description": "Hook",
- "schema": {
- "$ref": "#/definitions/Hook"
- }
- },
- "HookList": {
- "description": "HookList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Hook"
- }
- }
- },
- "Issue": {
- "description": "Issue",
- "schema": {
- "$ref": "#/definitions/Issue"
- }
- },
- "IssueDeadline": {
- "description": "IssueDeadline",
- "schema": {
- "$ref": "#/definitions/IssueDeadline"
- }
- },
- "IssueList": {
- "description": "IssueList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Issue"
- }
- }
- },
- "IssueTemplates": {
- "description": "IssueTemplates",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/IssueTemplate"
- }
- }
- },
- "Label": {
- "description": "Label",
- "schema": {
- "$ref": "#/definitions/Label"
- }
- },
- "LabelList": {
- "description": "LabelList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- }
- }
- },
- "LabelTemplateInfo": {
- "description": "LabelTemplateInfo",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/LabelTemplate"
- }
- }
- },
- "LabelTemplateList": {
- "description": "LabelTemplateList",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "LanguageStatistics": {
- "description": "LanguageStatistics",
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "LicenseTemplateInfo": {
- "description": "LicenseTemplateInfo",
- "schema": {
- "$ref": "#/definitions/LicenseTemplateInfo"
- }
- },
- "LicenseTemplateList": {
- "description": "LicenseTemplateList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/LicensesTemplateListEntry"
- }
- }
- },
- "MarkdownRender": {
- "description": "MarkdownRender is a rendered markdown document",
- "schema": {
- "type": "string"
- }
- },
- "MarkupRender": {
- "description": "MarkupRender is a rendered markup document",
- "schema": {
- "type": "string"
- }
- },
- "Milestone": {
- "description": "Milestone",
- "schema": {
- "$ref": "#/definitions/Milestone"
- }
- },
- "MilestoneList": {
- "description": "MilestoneList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Milestone"
- }
- }
- },
- "NodeInfo": {
- "description": "NodeInfo",
- "schema": {
- "$ref": "#/definitions/NodeInfo"
- }
- },
- "Note": {
- "description": "Note",
- "schema": {
- "$ref": "#/definitions/Note"
- }
- },
- "NotificationCount": {
- "description": "Number of unread notifications",
- "schema": {
- "$ref": "#/definitions/NotificationCount"
- }
- },
- "NotificationThread": {
- "description": "NotificationThread",
- "schema": {
- "$ref": "#/definitions/NotificationThread"
- }
- },
- "NotificationThreadList": {
- "description": "NotificationThreadList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/NotificationThread"
- }
- }
- },
- "OAuth2Application": {
- "description": "OAuth2Application",
- "schema": {
- "$ref": "#/definitions/OAuth2Application"
- }
- },
- "OAuth2ApplicationList": {
- "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/OAuth2Application"
- }
- }
- },
- "Organization": {
- "description": "Organization",
- "schema": {
- "$ref": "#/definitions/Organization"
- }
- },
- "OrganizationList": {
- "description": "OrganizationList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Organization"
- }
- }
- },
- "OrganizationPermissions": {
- "description": "OrganizationPermissions",
- "schema": {
- "$ref": "#/definitions/OrganizationPermissions"
- }
- },
- "Package": {
- "description": "Package",
- "schema": {
- "$ref": "#/definitions/Package"
- }
- },
- "PackageFileList": {
- "description": "PackageFileList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PackageFile"
- }
- }
- },
- "PackageList": {
- "description": "PackageList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Package"
- }
- }
- },
- "PublicKey": {
- "description": "PublicKey",
- "schema": {
- "$ref": "#/definitions/PublicKey"
- }
- },
- "PublicKeyList": {
- "description": "PublicKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PublicKey"
- }
- }
- },
- "PullRequest": {
- "description": "PullRequest",
- "schema": {
- "$ref": "#/definitions/PullRequest"
- }
- },
- "PullRequestList": {
- "description": "PullRequestList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PullRequest"
- }
- }
- },
- "PullReview": {
- "description": "PullReview",
- "schema": {
- "$ref": "#/definitions/PullReview"
- }
- },
- "PullReviewComment": {
- "description": "PullComment",
- "schema": {
- "$ref": "#/definitions/PullReviewComment"
- }
- },
- "PullReviewCommentList": {
- "description": "PullCommentList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PullReviewComment"
- }
- }
- },
- "PullReviewList": {
- "description": "PullReviewList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PullReview"
- }
- }
- },
- "PushMirror": {
- "description": "PushMirror",
- "schema": {
- "$ref": "#/definitions/PushMirror"
- }
- },
- "PushMirrorList": {
- "description": "PushMirrorList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PushMirror"
- }
- }
- },
- "Reaction": {
- "description": "Reaction",
- "schema": {
- "$ref": "#/definitions/Reaction"
- }
- },
- "ReactionList": {
- "description": "ReactionList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Reaction"
- }
- }
- },
- "Reference": {
- "description": "Reference",
- "schema": {
- "$ref": "#/definitions/Reference"
- }
- },
- "ReferenceList": {
- "description": "ReferenceList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Reference"
- }
- }
- },
- "RegistrationToken": {
- "description": "RegistrationToken is response related to registeration token",
- "headers": {
- "token": {
- "type": "string"
- }
- }
- },
- "Release": {
- "description": "Release",
- "schema": {
- "$ref": "#/definitions/Release"
- }
- },
- "ReleaseList": {
- "description": "ReleaseList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Release"
- }
- }
- },
- "RepoCollaboratorPermission": {
- "description": "RepoCollaboratorPermission",
- "schema": {
- "$ref": "#/definitions/RepoCollaboratorPermission"
- }
- },
- "RepoIssueConfig": {
- "description": "RepoIssueConfig",
- "schema": {
- "$ref": "#/definitions/IssueConfig"
- }
- },
- "RepoIssueConfigValidation": {
- "description": "RepoIssueConfigValidation",
- "schema": {
- "$ref": "#/definitions/IssueConfigValidation"
- }
- },
- "RepoNewIssuePinsAllowed": {
- "description": "RepoNewIssuePinsAllowed",
- "schema": {
- "$ref": "#/definitions/NewIssuePinsAllowed"
- }
- },
- "Repository": {
- "description": "Repository",
- "schema": {
- "$ref": "#/definitions/Repository"
- }
- },
- "RepositoryList": {
- "description": "RepositoryList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Repository"
- }
- }
- },
- "SearchResults": {
- "description": "SearchResults",
- "schema": {
- "$ref": "#/definitions/SearchResults"
- }
- },
- "Secret": {
- "description": "Secret",
- "schema": {
- "$ref": "#/definitions/Secret"
- }
- },
- "SecretList": {
- "description": "SecretList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Secret"
- }
- }
- },
- "ServerVersion": {
- "description": "ServerVersion",
- "schema": {
- "$ref": "#/definitions/ServerVersion"
- }
- },
- "StopWatch": {
- "description": "StopWatch",
- "schema": {
- "$ref": "#/definitions/StopWatch"
- }
- },
- "StopWatchList": {
- "description": "StopWatchList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/StopWatch"
- }
- }
- },
- "StringSlice": {
- "description": "StringSlice",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "Tag": {
- "description": "Tag",
- "schema": {
- "$ref": "#/definitions/Tag"
- }
- },
- "TagList": {
- "description": "TagList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tag"
- }
- }
- },
- "Team": {
- "description": "Team",
- "schema": {
- "$ref": "#/definitions/Team"
- }
- },
- "TeamList": {
- "description": "TeamList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Team"
- }
- }
- },
- "TimelineList": {
- "description": "TimelineList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TimelineComment"
- }
- }
- },
- "TopicListResponse": {
- "description": "TopicListResponse",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TopicResponse"
- }
- }
- },
- "TopicNames": {
- "description": "TopicNames",
- "schema": {
- "$ref": "#/definitions/TopicName"
- }
- },
- "TrackedTime": {
- "description": "TrackedTime",
- "schema": {
- "$ref": "#/definitions/TrackedTime"
- }
- },
- "TrackedTimeList": {
- "description": "TrackedTimeList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TrackedTime"
- }
- }
- },
- "User": {
- "description": "User",
- "schema": {
- "$ref": "#/definitions/User"
- }
- },
- "UserHeatmapData": {
- "description": "UserHeatmapData",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/UserHeatmapData"
- }
- }
- },
- "UserList": {
- "description": "UserList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- }
- }
- },
- "UserSettings": {
- "description": "UserSettings",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/UserSettings"
- }
- }
- },
- "WatchInfo": {
- "description": "WatchInfo",
- "schema": {
- "$ref": "#/definitions/WatchInfo"
- }
- },
- "WikiCommitList": {
- "description": "WikiCommitList",
- "schema": {
- "$ref": "#/definitions/WikiCommitList"
- }
- },
- "WikiPage": {
- "description": "WikiPage",
- "schema": {
- "$ref": "#/definitions/WikiPage"
- }
- },
- "WikiPageList": {
- "description": "WikiPageList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/WikiPageMetaData"
- }
- }
- },
- "conflict": {
- "description": "APIConflict is a conflict empty response"
- },
- "empty": {
- "description": "APIEmpty is an empty response"
- },
- "error": {
- "description": "APIError is error format response",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "forbidden": {
- "description": "APIForbiddenError is a forbidden error response",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "invalidTopicsError": {
- "description": "APIInvalidTopicsError is error format response to invalid topics",
- "headers": {
- "invalidTopics": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "message": {
- "type": "string"
- }
- }
- },
- "notFound": {
- "description": "APINotFound is a not found empty response"
- },
- "parameterBodies": {
- "description": "parameterBodies",
- "schema": {
- "$ref": "#/definitions/BadgeList"
- }
- },
- "redirect": {
- "description": "APIRedirect is a redirect response"
- },
- "repoArchivedError": {
- "description": "APIRepoArchivedError is an error that is raised when an archived repo should be modified",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "string": {
- "description": "APIString is a string response",
- "schema": {
- "type": "string"
- }
- },
- "validationError": {
- "description": "APIValidationError is error format response related to input validation",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- }
- },
- "securityDefinitions": {
- "AccessToken": {
- "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
- "type": "apiKey",
- "name": "access_token",
- "in": "query"
- },
- "AuthorizationHeaderToken": {
- "description": "API tokens must be prepended with \"token\" followed by a space.",
- "type": "apiKey",
- "name": "Authorization",
- "in": "header"
- },
- "BasicAuth": {
- "type": "basic"
- },
- "SudoHeader": {
- "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
- "type": "apiKey",
- "name": "Sudo",
- "in": "header"
- },
- "SudoParam": {
- "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
- "type": "apiKey",
- "name": "sudo",
- "in": "query"
- },
- "TOTPHeader": {
- "description": "Must be used in combination with BasicAuth if two-factor authentication is enabled.",
- "type": "apiKey",
- "name": "X-GITEA-OTP",
- "in": "header"
- },
- "Token": {
- "description": "This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.",
- "type": "apiKey",
- "name": "token",
- "in": "query"
- }
- },
- "security": [
- {
- "BasicAuth": []
- },
- {
- "Token": []
- },
- {
- "AccessToken": []
- },
- {
- "AuthorizationHeaderToken": []
- },
- {
- "SudoParam": []
- },
- {
- "SudoHeader": []
- },
- {
- "TOTPHeader": []
- }
- ]
- }
|