Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API.",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "1.1.1"
  23. },
  24. "basePath": "{{AppSubUrl}}/api/v1",
  25. "paths": {
  26. "/admin/orgs": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "admin"
  33. ],
  34. "summary": "List all organizations",
  35. "operationId": "adminGetAllOrgs",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "page number of results to return (1-based)",
  40. "name": "page",
  41. "in": "query"
  42. },
  43. {
  44. "type": "integer",
  45. "description": "page size of results, maximum page size is 50",
  46. "name": "limit",
  47. "in": "query"
  48. }
  49. ],
  50. "responses": {
  51. "200": {
  52. "$ref": "#/responses/OrganizationList"
  53. },
  54. "403": {
  55. "$ref": "#/responses/forbidden"
  56. }
  57. }
  58. }
  59. },
  60. "/admin/users": {
  61. "get": {
  62. "produces": [
  63. "application/json"
  64. ],
  65. "tags": [
  66. "admin"
  67. ],
  68. "summary": "List all users",
  69. "operationId": "adminGetAllUsers",
  70. "parameters": [
  71. {
  72. "type": "integer",
  73. "description": "page number of results to return (1-based)",
  74. "name": "page",
  75. "in": "query"
  76. },
  77. {
  78. "type": "integer",
  79. "description": "page size of results, maximum page size is 50",
  80. "name": "limit",
  81. "in": "query"
  82. }
  83. ],
  84. "responses": {
  85. "200": {
  86. "$ref": "#/responses/UserList"
  87. },
  88. "403": {
  89. "$ref": "#/responses/forbidden"
  90. }
  91. }
  92. },
  93. "post": {
  94. "consumes": [
  95. "application/json"
  96. ],
  97. "produces": [
  98. "application/json"
  99. ],
  100. "tags": [
  101. "admin"
  102. ],
  103. "summary": "Create a user",
  104. "operationId": "adminCreateUser",
  105. "parameters": [
  106. {
  107. "name": "body",
  108. "in": "body",
  109. "schema": {
  110. "$ref": "#/definitions/CreateUserOption"
  111. }
  112. }
  113. ],
  114. "responses": {
  115. "201": {
  116. "$ref": "#/responses/User"
  117. },
  118. "400": {
  119. "$ref": "#/responses/error"
  120. },
  121. "403": {
  122. "$ref": "#/responses/forbidden"
  123. },
  124. "422": {
  125. "$ref": "#/responses/validationError"
  126. }
  127. }
  128. }
  129. },
  130. "/admin/users/{username}": {
  131. "delete": {
  132. "produces": [
  133. "application/json"
  134. ],
  135. "tags": [
  136. "admin"
  137. ],
  138. "summary": "Delete a user",
  139. "operationId": "adminDeleteUser",
  140. "parameters": [
  141. {
  142. "type": "string",
  143. "description": "username of user to delete",
  144. "name": "username",
  145. "in": "path",
  146. "required": true
  147. }
  148. ],
  149. "responses": {
  150. "204": {
  151. "$ref": "#/responses/empty"
  152. },
  153. "403": {
  154. "$ref": "#/responses/forbidden"
  155. },
  156. "422": {
  157. "$ref": "#/responses/validationError"
  158. }
  159. }
  160. },
  161. "patch": {
  162. "consumes": [
  163. "application/json"
  164. ],
  165. "produces": [
  166. "application/json"
  167. ],
  168. "tags": [
  169. "admin"
  170. ],
  171. "summary": "Edit an existing user",
  172. "operationId": "adminEditUser",
  173. "parameters": [
  174. {
  175. "type": "string",
  176. "description": "username of user to edit",
  177. "name": "username",
  178. "in": "path",
  179. "required": true
  180. },
  181. {
  182. "name": "body",
  183. "in": "body",
  184. "schema": {
  185. "$ref": "#/definitions/EditUserOption"
  186. }
  187. }
  188. ],
  189. "responses": {
  190. "200": {
  191. "$ref": "#/responses/User"
  192. },
  193. "403": {
  194. "$ref": "#/responses/forbidden"
  195. },
  196. "422": {
  197. "$ref": "#/responses/validationError"
  198. }
  199. }
  200. }
  201. },
  202. "/admin/users/{username}/keys": {
  203. "post": {
  204. "consumes": [
  205. "application/json"
  206. ],
  207. "produces": [
  208. "application/json"
  209. ],
  210. "tags": [
  211. "admin"
  212. ],
  213. "summary": "Add a public key on behalf of a user",
  214. "operationId": "adminCreatePublicKey",
  215. "parameters": [
  216. {
  217. "type": "string",
  218. "description": "username of the user",
  219. "name": "username",
  220. "in": "path",
  221. "required": true
  222. },
  223. {
  224. "name": "key",
  225. "in": "body",
  226. "schema": {
  227. "$ref": "#/definitions/CreateKeyOption"
  228. }
  229. }
  230. ],
  231. "responses": {
  232. "201": {
  233. "$ref": "#/responses/PublicKey"
  234. },
  235. "403": {
  236. "$ref": "#/responses/forbidden"
  237. },
  238. "422": {
  239. "$ref": "#/responses/validationError"
  240. }
  241. }
  242. }
  243. },
  244. "/admin/users/{username}/keys/{id}": {
  245. "delete": {
  246. "produces": [
  247. "application/json"
  248. ],
  249. "tags": [
  250. "admin"
  251. ],
  252. "summary": "Delete a user's public key",
  253. "operationId": "adminDeleteUserPublicKey",
  254. "parameters": [
  255. {
  256. "type": "string",
  257. "description": "username of user",
  258. "name": "username",
  259. "in": "path",
  260. "required": true
  261. },
  262. {
  263. "type": "integer",
  264. "format": "int64",
  265. "description": "id of the key to delete",
  266. "name": "id",
  267. "in": "path",
  268. "required": true
  269. }
  270. ],
  271. "responses": {
  272. "204": {
  273. "$ref": "#/responses/empty"
  274. },
  275. "403": {
  276. "$ref": "#/responses/forbidden"
  277. },
  278. "404": {
  279. "$ref": "#/responses/notFound"
  280. }
  281. }
  282. }
  283. },
  284. "/admin/users/{username}/orgs": {
  285. "post": {
  286. "consumes": [
  287. "application/json"
  288. ],
  289. "produces": [
  290. "application/json"
  291. ],
  292. "tags": [
  293. "admin"
  294. ],
  295. "summary": "Create an organization",
  296. "operationId": "adminCreateOrg",
  297. "parameters": [
  298. {
  299. "type": "string",
  300. "description": "username of the user that will own the created organization",
  301. "name": "username",
  302. "in": "path",
  303. "required": true
  304. },
  305. {
  306. "name": "organization",
  307. "in": "body",
  308. "required": true,
  309. "schema": {
  310. "$ref": "#/definitions/CreateOrgOption"
  311. }
  312. }
  313. ],
  314. "responses": {
  315. "201": {
  316. "$ref": "#/responses/Organization"
  317. },
  318. "403": {
  319. "$ref": "#/responses/forbidden"
  320. },
  321. "422": {
  322. "$ref": "#/responses/validationError"
  323. }
  324. }
  325. }
  326. },
  327. "/admin/users/{username}/repos": {
  328. "post": {
  329. "consumes": [
  330. "application/json"
  331. ],
  332. "produces": [
  333. "application/json"
  334. ],
  335. "tags": [
  336. "admin"
  337. ],
  338. "summary": "Create a repository on behalf of a user",
  339. "operationId": "adminCreateRepo",
  340. "parameters": [
  341. {
  342. "type": "string",
  343. "description": "username of the user. This user will own the created repository",
  344. "name": "username",
  345. "in": "path",
  346. "required": true
  347. },
  348. {
  349. "name": "repository",
  350. "in": "body",
  351. "required": true,
  352. "schema": {
  353. "$ref": "#/definitions/CreateRepoOption"
  354. }
  355. }
  356. ],
  357. "responses": {
  358. "201": {
  359. "$ref": "#/responses/Repository"
  360. },
  361. "403": {
  362. "$ref": "#/responses/forbidden"
  363. },
  364. "404": {
  365. "$ref": "#/responses/notFound"
  366. },
  367. "409": {
  368. "$ref": "#/responses/error"
  369. },
  370. "422": {
  371. "$ref": "#/responses/validationError"
  372. }
  373. }
  374. }
  375. },
  376. "/markdown": {
  377. "post": {
  378. "consumes": [
  379. "application/json"
  380. ],
  381. "produces": [
  382. "text/html"
  383. ],
  384. "tags": [
  385. "miscellaneous"
  386. ],
  387. "summary": "Render a markdown document as HTML",
  388. "operationId": "renderMarkdown",
  389. "parameters": [
  390. {
  391. "name": "body",
  392. "in": "body",
  393. "schema": {
  394. "$ref": "#/definitions/MarkdownOption"
  395. }
  396. }
  397. ],
  398. "responses": {
  399. "200": {
  400. "$ref": "#/responses/MarkdownRender"
  401. },
  402. "422": {
  403. "$ref": "#/responses/validationError"
  404. }
  405. }
  406. }
  407. },
  408. "/markdown/raw": {
  409. "post": {
  410. "consumes": [
  411. "text/plain"
  412. ],
  413. "produces": [
  414. "text/html"
  415. ],
  416. "tags": [
  417. "miscellaneous"
  418. ],
  419. "summary": "Render raw markdown as HTML",
  420. "operationId": "renderMarkdownRaw",
  421. "parameters": [
  422. {
  423. "description": "Request body to render",
  424. "name": "body",
  425. "in": "body",
  426. "required": true,
  427. "schema": {
  428. "type": "string"
  429. }
  430. }
  431. ],
  432. "responses": {
  433. "200": {
  434. "$ref": "#/responses/MarkdownRender"
  435. },
  436. "422": {
  437. "$ref": "#/responses/validationError"
  438. }
  439. }
  440. }
  441. },
  442. "/notifications": {
  443. "get": {
  444. "consumes": [
  445. "application/json"
  446. ],
  447. "produces": [
  448. "application/json"
  449. ],
  450. "tags": [
  451. "notification"
  452. ],
  453. "summary": "List users's notification threads",
  454. "operationId": "notifyGetList",
  455. "parameters": [
  456. {
  457. "type": "string",
  458. "description": "If true, show notifications marked as read. Default value is false",
  459. "name": "all",
  460. "in": "query"
  461. },
  462. {
  463. "type": "string",
  464. "format": "date-time",
  465. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  466. "name": "since",
  467. "in": "query"
  468. },
  469. {
  470. "type": "string",
  471. "format": "date-time",
  472. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  473. "name": "before",
  474. "in": "query"
  475. },
  476. {
  477. "type": "integer",
  478. "description": "page number of results to return (1-based)",
  479. "name": "page",
  480. "in": "query"
  481. },
  482. {
  483. "type": "integer",
  484. "description": "page size of results, maximum page size is 50",
  485. "name": "limit",
  486. "in": "query"
  487. }
  488. ],
  489. "responses": {
  490. "200": {
  491. "$ref": "#/responses/NotificationThreadList"
  492. }
  493. }
  494. },
  495. "put": {
  496. "consumes": [
  497. "application/json"
  498. ],
  499. "produces": [
  500. "application/json"
  501. ],
  502. "tags": [
  503. "notification"
  504. ],
  505. "summary": "Mark notification threads as read",
  506. "operationId": "notifyReadList",
  507. "parameters": [
  508. {
  509. "type": "string",
  510. "format": "date-time",
  511. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  512. "name": "last_read_at",
  513. "in": "query"
  514. }
  515. ],
  516. "responses": {
  517. "205": {
  518. "$ref": "#/responses/empty"
  519. }
  520. }
  521. }
  522. },
  523. "/notifications/new": {
  524. "get": {
  525. "tags": [
  526. "notification"
  527. ],
  528. "summary": "Check if unread notifications exist",
  529. "operationId": "notifyNewAvailable",
  530. "responses": {
  531. "200": {
  532. "$ref": "#/responses/NotificationCount"
  533. }
  534. }
  535. }
  536. },
  537. "/notifications/threads/{id}": {
  538. "get": {
  539. "consumes": [
  540. "application/json"
  541. ],
  542. "produces": [
  543. "application/json"
  544. ],
  545. "tags": [
  546. "notification"
  547. ],
  548. "summary": "Get notification thread by ID",
  549. "operationId": "notifyGetThread",
  550. "parameters": [
  551. {
  552. "type": "string",
  553. "description": "id of notification thread",
  554. "name": "id",
  555. "in": "path",
  556. "required": true
  557. }
  558. ],
  559. "responses": {
  560. "200": {
  561. "$ref": "#/responses/NotificationThread"
  562. },
  563. "403": {
  564. "$ref": "#/responses/forbidden"
  565. },
  566. "404": {
  567. "$ref": "#/responses/notFound"
  568. }
  569. }
  570. },
  571. "patch": {
  572. "consumes": [
  573. "application/json"
  574. ],
  575. "produces": [
  576. "application/json"
  577. ],
  578. "tags": [
  579. "notification"
  580. ],
  581. "summary": "Mark notification thread as read by ID",
  582. "operationId": "notifyReadThread",
  583. "parameters": [
  584. {
  585. "type": "string",
  586. "description": "id of notification thread",
  587. "name": "id",
  588. "in": "path",
  589. "required": true
  590. }
  591. ],
  592. "responses": {
  593. "205": {
  594. "$ref": "#/responses/empty"
  595. },
  596. "403": {
  597. "$ref": "#/responses/forbidden"
  598. },
  599. "404": {
  600. "$ref": "#/responses/notFound"
  601. }
  602. }
  603. }
  604. },
  605. "/org/{org}/repos": {
  606. "post": {
  607. "consumes": [
  608. "application/json"
  609. ],
  610. "produces": [
  611. "application/json"
  612. ],
  613. "tags": [
  614. "organization"
  615. ],
  616. "summary": "Create a repository in an organization",
  617. "operationId": "createOrgRepoDeprecated",
  618. "deprecated": true,
  619. "parameters": [
  620. {
  621. "type": "string",
  622. "description": "name of organization",
  623. "name": "org",
  624. "in": "path",
  625. "required": true
  626. },
  627. {
  628. "name": "body",
  629. "in": "body",
  630. "schema": {
  631. "$ref": "#/definitions/CreateRepoOption"
  632. }
  633. }
  634. ],
  635. "responses": {
  636. "201": {
  637. "$ref": "#/responses/Repository"
  638. },
  639. "403": {
  640. "$ref": "#/responses/forbidden"
  641. },
  642. "422": {
  643. "$ref": "#/responses/validationError"
  644. }
  645. }
  646. }
  647. },
  648. "/orgs": {
  649. "get": {
  650. "produces": [
  651. "application/json"
  652. ],
  653. "tags": [
  654. "organization"
  655. ],
  656. "summary": "Get list of organizations",
  657. "operationId": "orgGetAll",
  658. "parameters": [
  659. {
  660. "type": "integer",
  661. "description": "page number of results to return (1-based)",
  662. "name": "page",
  663. "in": "query"
  664. },
  665. {
  666. "type": "integer",
  667. "description": "page size of results, maximum page size is 50",
  668. "name": "limit",
  669. "in": "query"
  670. }
  671. ],
  672. "responses": {
  673. "200": {
  674. "$ref": "#/responses/OrganizationList"
  675. }
  676. }
  677. },
  678. "post": {
  679. "consumes": [
  680. "application/json"
  681. ],
  682. "produces": [
  683. "application/json"
  684. ],
  685. "tags": [
  686. "organization"
  687. ],
  688. "summary": "Create an organization",
  689. "operationId": "orgCreate",
  690. "parameters": [
  691. {
  692. "name": "organization",
  693. "in": "body",
  694. "required": true,
  695. "schema": {
  696. "$ref": "#/definitions/CreateOrgOption"
  697. }
  698. }
  699. ],
  700. "responses": {
  701. "201": {
  702. "$ref": "#/responses/Organization"
  703. },
  704. "403": {
  705. "$ref": "#/responses/forbidden"
  706. },
  707. "422": {
  708. "$ref": "#/responses/validationError"
  709. }
  710. }
  711. }
  712. },
  713. "/orgs/{org}": {
  714. "get": {
  715. "produces": [
  716. "application/json"
  717. ],
  718. "tags": [
  719. "organization"
  720. ],
  721. "summary": "Get an organization",
  722. "operationId": "orgGet",
  723. "parameters": [
  724. {
  725. "type": "string",
  726. "description": "name of the organization to get",
  727. "name": "org",
  728. "in": "path",
  729. "required": true
  730. }
  731. ],
  732. "responses": {
  733. "200": {
  734. "$ref": "#/responses/Organization"
  735. }
  736. }
  737. },
  738. "delete": {
  739. "produces": [
  740. "application/json"
  741. ],
  742. "tags": [
  743. "organization"
  744. ],
  745. "summary": "Delete an organization",
  746. "operationId": "orgDelete",
  747. "parameters": [
  748. {
  749. "type": "string",
  750. "description": "organization that is to be deleted",
  751. "name": "org",
  752. "in": "path",
  753. "required": true
  754. }
  755. ],
  756. "responses": {
  757. "204": {
  758. "$ref": "#/responses/empty"
  759. }
  760. }
  761. },
  762. "patch": {
  763. "consumes": [
  764. "application/json"
  765. ],
  766. "produces": [
  767. "application/json"
  768. ],
  769. "tags": [
  770. "organization"
  771. ],
  772. "summary": "Edit an organization",
  773. "operationId": "orgEdit",
  774. "parameters": [
  775. {
  776. "type": "string",
  777. "description": "name of the organization to edit",
  778. "name": "org",
  779. "in": "path",
  780. "required": true
  781. },
  782. {
  783. "name": "body",
  784. "in": "body",
  785. "required": true,
  786. "schema": {
  787. "$ref": "#/definitions/EditOrgOption"
  788. }
  789. }
  790. ],
  791. "responses": {
  792. "200": {
  793. "$ref": "#/responses/Organization"
  794. }
  795. }
  796. }
  797. },
  798. "/orgs/{org}/hooks": {
  799. "get": {
  800. "produces": [
  801. "application/json"
  802. ],
  803. "tags": [
  804. "organization"
  805. ],
  806. "summary": "List an organization's webhooks",
  807. "operationId": "orgListHooks",
  808. "parameters": [
  809. {
  810. "type": "string",
  811. "description": "name of the organization",
  812. "name": "org",
  813. "in": "path",
  814. "required": true
  815. },
  816. {
  817. "type": "integer",
  818. "description": "page number of results to return (1-based)",
  819. "name": "page",
  820. "in": "query"
  821. },
  822. {
  823. "type": "integer",
  824. "description": "page size of results, maximum page size is 50",
  825. "name": "limit",
  826. "in": "query"
  827. }
  828. ],
  829. "responses": {
  830. "200": {
  831. "$ref": "#/responses/HookList"
  832. }
  833. }
  834. }
  835. },
  836. "/orgs/{org}/hooks/": {
  837. "post": {
  838. "consumes": [
  839. "application/json"
  840. ],
  841. "produces": [
  842. "application/json"
  843. ],
  844. "tags": [
  845. "organization"
  846. ],
  847. "summary": "Create a hook",
  848. "operationId": "orgCreateHook",
  849. "parameters": [
  850. {
  851. "type": "string",
  852. "description": "name of the organization",
  853. "name": "org",
  854. "in": "path",
  855. "required": true
  856. },
  857. {
  858. "name": "body",
  859. "in": "body",
  860. "required": true,
  861. "schema": {
  862. "$ref": "#/definitions/CreateHookOption"
  863. }
  864. }
  865. ],
  866. "responses": {
  867. "201": {
  868. "$ref": "#/responses/Hook"
  869. }
  870. }
  871. }
  872. },
  873. "/orgs/{org}/hooks/{id}": {
  874. "get": {
  875. "produces": [
  876. "application/json"
  877. ],
  878. "tags": [
  879. "organization"
  880. ],
  881. "summary": "Get a hook",
  882. "operationId": "orgGetHook",
  883. "parameters": [
  884. {
  885. "type": "string",
  886. "description": "name of the organization",
  887. "name": "org",
  888. "in": "path",
  889. "required": true
  890. },
  891. {
  892. "type": "integer",
  893. "format": "int64",
  894. "description": "id of the hook to get",
  895. "name": "id",
  896. "in": "path",
  897. "required": true
  898. }
  899. ],
  900. "responses": {
  901. "200": {
  902. "$ref": "#/responses/Hook"
  903. }
  904. }
  905. },
  906. "delete": {
  907. "produces": [
  908. "application/json"
  909. ],
  910. "tags": [
  911. "organization"
  912. ],
  913. "summary": "Delete a hook",
  914. "operationId": "orgDeleteHook",
  915. "parameters": [
  916. {
  917. "type": "string",
  918. "description": "name of the organization",
  919. "name": "org",
  920. "in": "path",
  921. "required": true
  922. },
  923. {
  924. "type": "integer",
  925. "format": "int64",
  926. "description": "id of the hook to delete",
  927. "name": "id",
  928. "in": "path",
  929. "required": true
  930. }
  931. ],
  932. "responses": {
  933. "204": {
  934. "$ref": "#/responses/empty"
  935. }
  936. }
  937. },
  938. "patch": {
  939. "consumes": [
  940. "application/json"
  941. ],
  942. "produces": [
  943. "application/json"
  944. ],
  945. "tags": [
  946. "organization"
  947. ],
  948. "summary": "Update a hook",
  949. "operationId": "orgEditHook",
  950. "parameters": [
  951. {
  952. "type": "string",
  953. "description": "name of the organization",
  954. "name": "org",
  955. "in": "path",
  956. "required": true
  957. },
  958. {
  959. "type": "integer",
  960. "format": "int64",
  961. "description": "id of the hook to update",
  962. "name": "id",
  963. "in": "path",
  964. "required": true
  965. },
  966. {
  967. "name": "body",
  968. "in": "body",
  969. "schema": {
  970. "$ref": "#/definitions/EditHookOption"
  971. }
  972. }
  973. ],
  974. "responses": {
  975. "200": {
  976. "$ref": "#/responses/Hook"
  977. }
  978. }
  979. }
  980. },
  981. "/orgs/{org}/labels": {
  982. "get": {
  983. "produces": [
  984. "application/json"
  985. ],
  986. "tags": [
  987. "organization"
  988. ],
  989. "summary": "List an organization's labels",
  990. "operationId": "orgListLabels",
  991. "parameters": [
  992. {
  993. "type": "string",
  994. "description": "name of the organization",
  995. "name": "org",
  996. "in": "path",
  997. "required": true
  998. },
  999. {
  1000. "type": "integer",
  1001. "description": "page number of results to return (1-based)",
  1002. "name": "page",
  1003. "in": "query"
  1004. },
  1005. {
  1006. "type": "integer",
  1007. "description": "page size of results, maximum page size is 50",
  1008. "name": "limit",
  1009. "in": "query"
  1010. }
  1011. ],
  1012. "responses": {
  1013. "200": {
  1014. "$ref": "#/responses/LabelList"
  1015. }
  1016. }
  1017. },
  1018. "post": {
  1019. "consumes": [
  1020. "application/json"
  1021. ],
  1022. "produces": [
  1023. "application/json"
  1024. ],
  1025. "tags": [
  1026. "organization"
  1027. ],
  1028. "summary": "Create a label for an organization",
  1029. "operationId": "orgCreateLabel",
  1030. "parameters": [
  1031. {
  1032. "type": "string",
  1033. "description": "name of the organization",
  1034. "name": "org",
  1035. "in": "path",
  1036. "required": true
  1037. },
  1038. {
  1039. "name": "body",
  1040. "in": "body",
  1041. "schema": {
  1042. "$ref": "#/definitions/CreateLabelOption"
  1043. }
  1044. }
  1045. ],
  1046. "responses": {
  1047. "201": {
  1048. "$ref": "#/responses/Label"
  1049. },
  1050. "422": {
  1051. "$ref": "#/responses/validationError"
  1052. }
  1053. }
  1054. }
  1055. },
  1056. "/orgs/{org}/labels/{id}": {
  1057. "get": {
  1058. "produces": [
  1059. "application/json"
  1060. ],
  1061. "tags": [
  1062. "organization"
  1063. ],
  1064. "summary": "Get a single label",
  1065. "operationId": "orgGetLabel",
  1066. "parameters": [
  1067. {
  1068. "type": "string",
  1069. "description": "name of the organization",
  1070. "name": "org",
  1071. "in": "path",
  1072. "required": true
  1073. },
  1074. {
  1075. "type": "integer",
  1076. "format": "int64",
  1077. "description": "id of the label to get",
  1078. "name": "id",
  1079. "in": "path",
  1080. "required": true
  1081. }
  1082. ],
  1083. "responses": {
  1084. "200": {
  1085. "$ref": "#/responses/Label"
  1086. }
  1087. }
  1088. },
  1089. "delete": {
  1090. "tags": [
  1091. "organization"
  1092. ],
  1093. "summary": "Delete a label",
  1094. "operationId": "orgDeleteLabel",
  1095. "parameters": [
  1096. {
  1097. "type": "string",
  1098. "description": "name of the organization",
  1099. "name": "org",
  1100. "in": "path",
  1101. "required": true
  1102. },
  1103. {
  1104. "type": "integer",
  1105. "format": "int64",
  1106. "description": "id of the label to delete",
  1107. "name": "id",
  1108. "in": "path",
  1109. "required": true
  1110. }
  1111. ],
  1112. "responses": {
  1113. "204": {
  1114. "$ref": "#/responses/empty"
  1115. }
  1116. }
  1117. },
  1118. "patch": {
  1119. "consumes": [
  1120. "application/json"
  1121. ],
  1122. "produces": [
  1123. "application/json"
  1124. ],
  1125. "tags": [
  1126. "organization"
  1127. ],
  1128. "summary": "Update a label",
  1129. "operationId": "orgEditLabel",
  1130. "parameters": [
  1131. {
  1132. "type": "string",
  1133. "description": "name of the organization",
  1134. "name": "org",
  1135. "in": "path",
  1136. "required": true
  1137. },
  1138. {
  1139. "type": "integer",
  1140. "format": "int64",
  1141. "description": "id of the label to edit",
  1142. "name": "id",
  1143. "in": "path",
  1144. "required": true
  1145. },
  1146. {
  1147. "name": "body",
  1148. "in": "body",
  1149. "schema": {
  1150. "$ref": "#/definitions/EditLabelOption"
  1151. }
  1152. }
  1153. ],
  1154. "responses": {
  1155. "200": {
  1156. "$ref": "#/responses/Label"
  1157. },
  1158. "422": {
  1159. "$ref": "#/responses/validationError"
  1160. }
  1161. }
  1162. }
  1163. },
  1164. "/orgs/{org}/members": {
  1165. "get": {
  1166. "produces": [
  1167. "application/json"
  1168. ],
  1169. "tags": [
  1170. "organization"
  1171. ],
  1172. "summary": "List an organization's members",
  1173. "operationId": "orgListMembers",
  1174. "parameters": [
  1175. {
  1176. "type": "string",
  1177. "description": "name of the organization",
  1178. "name": "org",
  1179. "in": "path",
  1180. "required": true
  1181. },
  1182. {
  1183. "type": "integer",
  1184. "description": "page number of results to return (1-based)",
  1185. "name": "page",
  1186. "in": "query"
  1187. },
  1188. {
  1189. "type": "integer",
  1190. "description": "page size of results, maximum page size is 50",
  1191. "name": "limit",
  1192. "in": "query"
  1193. }
  1194. ],
  1195. "responses": {
  1196. "200": {
  1197. "$ref": "#/responses/UserList"
  1198. }
  1199. }
  1200. }
  1201. },
  1202. "/orgs/{org}/members/{username}": {
  1203. "get": {
  1204. "tags": [
  1205. "organization"
  1206. ],
  1207. "summary": "Check if a user is a member of an organization",
  1208. "operationId": "orgIsMember",
  1209. "parameters": [
  1210. {
  1211. "type": "string",
  1212. "description": "name of the organization",
  1213. "name": "org",
  1214. "in": "path",
  1215. "required": true
  1216. },
  1217. {
  1218. "type": "string",
  1219. "description": "username of the user",
  1220. "name": "username",
  1221. "in": "path",
  1222. "required": true
  1223. }
  1224. ],
  1225. "responses": {
  1226. "204": {
  1227. "description": "user is a member"
  1228. },
  1229. "302": {
  1230. "description": "redirection to /orgs/{org}/public_members/{username}"
  1231. },
  1232. "404": {
  1233. "description": "user is not a member"
  1234. }
  1235. }
  1236. },
  1237. "delete": {
  1238. "produces": [
  1239. "application/json"
  1240. ],
  1241. "tags": [
  1242. "organization"
  1243. ],
  1244. "summary": "Remove a member from an organization",
  1245. "operationId": "orgDeleteMember",
  1246. "parameters": [
  1247. {
  1248. "type": "string",
  1249. "description": "name of the organization",
  1250. "name": "org",
  1251. "in": "path",
  1252. "required": true
  1253. },
  1254. {
  1255. "type": "string",
  1256. "description": "username of the user",
  1257. "name": "username",
  1258. "in": "path",
  1259. "required": true
  1260. }
  1261. ],
  1262. "responses": {
  1263. "204": {
  1264. "description": "member removed"
  1265. }
  1266. }
  1267. }
  1268. },
  1269. "/orgs/{org}/public_members": {
  1270. "get": {
  1271. "produces": [
  1272. "application/json"
  1273. ],
  1274. "tags": [
  1275. "organization"
  1276. ],
  1277. "summary": "List an organization's public members",
  1278. "operationId": "orgListPublicMembers",
  1279. "parameters": [
  1280. {
  1281. "type": "string",
  1282. "description": "name of the organization",
  1283. "name": "org",
  1284. "in": "path",
  1285. "required": true
  1286. },
  1287. {
  1288. "type": "integer",
  1289. "description": "page number of results to return (1-based)",
  1290. "name": "page",
  1291. "in": "query"
  1292. },
  1293. {
  1294. "type": "integer",
  1295. "description": "page size of results, maximum page size is 50",
  1296. "name": "limit",
  1297. "in": "query"
  1298. }
  1299. ],
  1300. "responses": {
  1301. "200": {
  1302. "$ref": "#/responses/UserList"
  1303. }
  1304. }
  1305. }
  1306. },
  1307. "/orgs/{org}/public_members/{username}": {
  1308. "get": {
  1309. "tags": [
  1310. "organization"
  1311. ],
  1312. "summary": "Check if a user is a public member of an organization",
  1313. "operationId": "orgIsPublicMember",
  1314. "parameters": [
  1315. {
  1316. "type": "string",
  1317. "description": "name of the organization",
  1318. "name": "org",
  1319. "in": "path",
  1320. "required": true
  1321. },
  1322. {
  1323. "type": "string",
  1324. "description": "username of the user",
  1325. "name": "username",
  1326. "in": "path",
  1327. "required": true
  1328. }
  1329. ],
  1330. "responses": {
  1331. "204": {
  1332. "description": "user is a public member"
  1333. },
  1334. "404": {
  1335. "description": "user is not a public member"
  1336. }
  1337. }
  1338. },
  1339. "put": {
  1340. "produces": [
  1341. "application/json"
  1342. ],
  1343. "tags": [
  1344. "organization"
  1345. ],
  1346. "summary": "Publicize a user's membership",
  1347. "operationId": "orgPublicizeMember",
  1348. "parameters": [
  1349. {
  1350. "type": "string",
  1351. "description": "name of the organization",
  1352. "name": "org",
  1353. "in": "path",
  1354. "required": true
  1355. },
  1356. {
  1357. "type": "string",
  1358. "description": "username of the user",
  1359. "name": "username",
  1360. "in": "path",
  1361. "required": true
  1362. }
  1363. ],
  1364. "responses": {
  1365. "204": {
  1366. "description": "membership publicized"
  1367. },
  1368. "403": {
  1369. "$ref": "#/responses/forbidden"
  1370. }
  1371. }
  1372. },
  1373. "delete": {
  1374. "produces": [
  1375. "application/json"
  1376. ],
  1377. "tags": [
  1378. "organization"
  1379. ],
  1380. "summary": "Conceal a user's membership",
  1381. "operationId": "orgConcealMember",
  1382. "parameters": [
  1383. {
  1384. "type": "string",
  1385. "description": "name of the organization",
  1386. "name": "org",
  1387. "in": "path",
  1388. "required": true
  1389. },
  1390. {
  1391. "type": "string",
  1392. "description": "username of the user",
  1393. "name": "username",
  1394. "in": "path",
  1395. "required": true
  1396. }
  1397. ],
  1398. "responses": {
  1399. "204": {
  1400. "$ref": "#/responses/empty"
  1401. },
  1402. "403": {
  1403. "$ref": "#/responses/forbidden"
  1404. }
  1405. }
  1406. }
  1407. },
  1408. "/orgs/{org}/repos": {
  1409. "get": {
  1410. "produces": [
  1411. "application/json"
  1412. ],
  1413. "tags": [
  1414. "organization"
  1415. ],
  1416. "summary": "List an organization's repos",
  1417. "operationId": "orgListRepos",
  1418. "parameters": [
  1419. {
  1420. "type": "string",
  1421. "description": "name of the organization",
  1422. "name": "org",
  1423. "in": "path",
  1424. "required": true
  1425. },
  1426. {
  1427. "type": "integer",
  1428. "description": "page number of results to return (1-based)",
  1429. "name": "page",
  1430. "in": "query"
  1431. },
  1432. {
  1433. "type": "integer",
  1434. "description": "page size of results, maximum page size is 50",
  1435. "name": "limit",
  1436. "in": "query"
  1437. }
  1438. ],
  1439. "responses": {
  1440. "200": {
  1441. "$ref": "#/responses/RepositoryList"
  1442. }
  1443. }
  1444. },
  1445. "post": {
  1446. "consumes": [
  1447. "application/json"
  1448. ],
  1449. "produces": [
  1450. "application/json"
  1451. ],
  1452. "tags": [
  1453. "organization"
  1454. ],
  1455. "summary": "Create a repository in an organization",
  1456. "operationId": "createOrgRepo",
  1457. "parameters": [
  1458. {
  1459. "type": "string",
  1460. "description": "name of organization",
  1461. "name": "org",
  1462. "in": "path",
  1463. "required": true
  1464. },
  1465. {
  1466. "name": "body",
  1467. "in": "body",
  1468. "schema": {
  1469. "$ref": "#/definitions/CreateRepoOption"
  1470. }
  1471. }
  1472. ],
  1473. "responses": {
  1474. "201": {
  1475. "$ref": "#/responses/Repository"
  1476. },
  1477. "403": {
  1478. "$ref": "#/responses/forbidden"
  1479. },
  1480. "404": {
  1481. "$ref": "#/responses/notFound"
  1482. }
  1483. }
  1484. }
  1485. },
  1486. "/orgs/{org}/teams": {
  1487. "get": {
  1488. "produces": [
  1489. "application/json"
  1490. ],
  1491. "tags": [
  1492. "organization"
  1493. ],
  1494. "summary": "List an organization's teams",
  1495. "operationId": "orgListTeams",
  1496. "parameters": [
  1497. {
  1498. "type": "string",
  1499. "description": "name of the organization",
  1500. "name": "org",
  1501. "in": "path",
  1502. "required": true
  1503. },
  1504. {
  1505. "type": "integer",
  1506. "description": "page number of results to return (1-based)",
  1507. "name": "page",
  1508. "in": "query"
  1509. },
  1510. {
  1511. "type": "integer",
  1512. "description": "page size of results, maximum page size is 50",
  1513. "name": "limit",
  1514. "in": "query"
  1515. }
  1516. ],
  1517. "responses": {
  1518. "200": {
  1519. "$ref": "#/responses/TeamList"
  1520. }
  1521. }
  1522. },
  1523. "post": {
  1524. "consumes": [
  1525. "application/json"
  1526. ],
  1527. "produces": [
  1528. "application/json"
  1529. ],
  1530. "tags": [
  1531. "organization"
  1532. ],
  1533. "summary": "Create a team",
  1534. "operationId": "orgCreateTeam",
  1535. "parameters": [
  1536. {
  1537. "type": "string",
  1538. "description": "name of the organization",
  1539. "name": "org",
  1540. "in": "path",
  1541. "required": true
  1542. },
  1543. {
  1544. "name": "body",
  1545. "in": "body",
  1546. "schema": {
  1547. "$ref": "#/definitions/CreateTeamOption"
  1548. }
  1549. }
  1550. ],
  1551. "responses": {
  1552. "201": {
  1553. "$ref": "#/responses/Team"
  1554. },
  1555. "422": {
  1556. "$ref": "#/responses/validationError"
  1557. }
  1558. }
  1559. }
  1560. },
  1561. "/orgs/{org}/teams/search": {
  1562. "get": {
  1563. "produces": [
  1564. "application/json"
  1565. ],
  1566. "tags": [
  1567. "organization"
  1568. ],
  1569. "summary": "Search for teams within an organization",
  1570. "operationId": "teamSearch",
  1571. "parameters": [
  1572. {
  1573. "type": "string",
  1574. "description": "name of the organization",
  1575. "name": "org",
  1576. "in": "path",
  1577. "required": true
  1578. },
  1579. {
  1580. "type": "string",
  1581. "description": "keywords to search",
  1582. "name": "q",
  1583. "in": "query"
  1584. },
  1585. {
  1586. "type": "boolean",
  1587. "description": "include search within team description (defaults to true)",
  1588. "name": "include_desc",
  1589. "in": "query"
  1590. },
  1591. {
  1592. "type": "integer",
  1593. "description": "page number of results to return (1-based)",
  1594. "name": "page",
  1595. "in": "query"
  1596. },
  1597. {
  1598. "type": "integer",
  1599. "description": "page size of results, maximum page size is 50",
  1600. "name": "limit",
  1601. "in": "query"
  1602. }
  1603. ],
  1604. "responses": {
  1605. "200": {
  1606. "description": "SearchResults of a successful search",
  1607. "schema": {
  1608. "type": "object",
  1609. "properties": {
  1610. "data": {
  1611. "type": "array",
  1612. "items": {
  1613. "$ref": "#/definitions/Team"
  1614. }
  1615. },
  1616. "ok": {
  1617. "type": "boolean"
  1618. }
  1619. }
  1620. }
  1621. }
  1622. }
  1623. }
  1624. },
  1625. "/repos/issues/search": {
  1626. "get": {
  1627. "produces": [
  1628. "application/json"
  1629. ],
  1630. "tags": [
  1631. "issue"
  1632. ],
  1633. "summary": "Search for issues across the repositories that the user has access to",
  1634. "operationId": "issueSearchIssues",
  1635. "parameters": [
  1636. {
  1637. "type": "string",
  1638. "description": "whether issue is open or closed",
  1639. "name": "state",
  1640. "in": "query"
  1641. },
  1642. {
  1643. "type": "string",
  1644. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1645. "name": "labels",
  1646. "in": "query"
  1647. },
  1648. {
  1649. "type": "string",
  1650. "description": "search string",
  1651. "name": "q",
  1652. "in": "query"
  1653. },
  1654. {
  1655. "type": "integer",
  1656. "format": "int64",
  1657. "description": "repository to prioritize in the results",
  1658. "name": "priority_repo_id",
  1659. "in": "query"
  1660. },
  1661. {
  1662. "type": "string",
  1663. "description": "filter by type (issues / pulls) if set",
  1664. "name": "type",
  1665. "in": "query"
  1666. },
  1667. {
  1668. "type": "integer",
  1669. "description": "page number of requested issues",
  1670. "name": "page",
  1671. "in": "query"
  1672. }
  1673. ],
  1674. "responses": {
  1675. "200": {
  1676. "$ref": "#/responses/IssueList"
  1677. }
  1678. }
  1679. }
  1680. },
  1681. "/repos/migrate": {
  1682. "post": {
  1683. "consumes": [
  1684. "application/json"
  1685. ],
  1686. "produces": [
  1687. "application/json"
  1688. ],
  1689. "tags": [
  1690. "repository"
  1691. ],
  1692. "summary": "Migrate a remote git repository",
  1693. "operationId": "repoMigrate",
  1694. "parameters": [
  1695. {
  1696. "name": "body",
  1697. "in": "body",
  1698. "schema": {
  1699. "$ref": "#/definitions/MigrateRepoForm"
  1700. }
  1701. }
  1702. ],
  1703. "responses": {
  1704. "201": {
  1705. "$ref": "#/responses/Repository"
  1706. },
  1707. "403": {
  1708. "$ref": "#/responses/forbidden"
  1709. },
  1710. "422": {
  1711. "$ref": "#/responses/validationError"
  1712. }
  1713. }
  1714. }
  1715. },
  1716. "/repos/search": {
  1717. "get": {
  1718. "produces": [
  1719. "application/json"
  1720. ],
  1721. "tags": [
  1722. "repository"
  1723. ],
  1724. "summary": "Search for repositories",
  1725. "operationId": "repoSearch",
  1726. "parameters": [
  1727. {
  1728. "type": "string",
  1729. "description": "keyword",
  1730. "name": "q",
  1731. "in": "query"
  1732. },
  1733. {
  1734. "type": "boolean",
  1735. "description": "Limit search to repositories with keyword as topic",
  1736. "name": "topic",
  1737. "in": "query"
  1738. },
  1739. {
  1740. "type": "boolean",
  1741. "description": "include search of keyword within repository description",
  1742. "name": "includeDesc",
  1743. "in": "query"
  1744. },
  1745. {
  1746. "type": "integer",
  1747. "format": "int64",
  1748. "description": "search only for repos that the user with the given id owns or contributes to",
  1749. "name": "uid",
  1750. "in": "query"
  1751. },
  1752. {
  1753. "type": "integer",
  1754. "format": "int64",
  1755. "description": "repo owner to prioritize in the results",
  1756. "name": "priority_owner_id",
  1757. "in": "query"
  1758. },
  1759. {
  1760. "type": "integer",
  1761. "format": "int64",
  1762. "description": "search only for repos that the user with the given id has starred",
  1763. "name": "starredBy",
  1764. "in": "query"
  1765. },
  1766. {
  1767. "type": "boolean",
  1768. "description": "include private repositories this user has access to (defaults to true)",
  1769. "name": "private",
  1770. "in": "query"
  1771. },
  1772. {
  1773. "type": "boolean",
  1774. "description": "show only pubic, private or all repositories (defaults to all)",
  1775. "name": "is_private",
  1776. "in": "query"
  1777. },
  1778. {
  1779. "type": "boolean",
  1780. "description": "include template repositories this user has access to (defaults to true)",
  1781. "name": "template",
  1782. "in": "query"
  1783. },
  1784. {
  1785. "type": "boolean",
  1786. "description": "show only archived, non-archived or all repositories (defaults to all)",
  1787. "name": "archived",
  1788. "in": "query"
  1789. },
  1790. {
  1791. "type": "string",
  1792. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1793. "name": "mode",
  1794. "in": "query"
  1795. },
  1796. {
  1797. "type": "boolean",
  1798. "description": "if `uid` is given, search only for repos that the user owns",
  1799. "name": "exclusive",
  1800. "in": "query"
  1801. },
  1802. {
  1803. "type": "string",
  1804. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1805. "name": "sort",
  1806. "in": "query"
  1807. },
  1808. {
  1809. "type": "string",
  1810. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1811. "name": "order",
  1812. "in": "query"
  1813. },
  1814. {
  1815. "type": "integer",
  1816. "description": "page number of results to return (1-based)",
  1817. "name": "page",
  1818. "in": "query"
  1819. },
  1820. {
  1821. "type": "integer",
  1822. "description": "page size of results, maximum page size is 50",
  1823. "name": "limit",
  1824. "in": "query"
  1825. }
  1826. ],
  1827. "responses": {
  1828. "200": {
  1829. "$ref": "#/responses/SearchResults"
  1830. },
  1831. "422": {
  1832. "$ref": "#/responses/validationError"
  1833. }
  1834. }
  1835. }
  1836. },
  1837. "/repos/{owner}/{repo}": {
  1838. "get": {
  1839. "produces": [
  1840. "application/json"
  1841. ],
  1842. "tags": [
  1843. "repository"
  1844. ],
  1845. "summary": "Get a repository",
  1846. "operationId": "repoGet",
  1847. "parameters": [
  1848. {
  1849. "type": "string",
  1850. "description": "owner of the repo",
  1851. "name": "owner",
  1852. "in": "path",
  1853. "required": true
  1854. },
  1855. {
  1856. "type": "string",
  1857. "description": "name of the repo",
  1858. "name": "repo",
  1859. "in": "path",
  1860. "required": true
  1861. }
  1862. ],
  1863. "responses": {
  1864. "200": {
  1865. "$ref": "#/responses/Repository"
  1866. }
  1867. }
  1868. },
  1869. "delete": {
  1870. "produces": [
  1871. "application/json"
  1872. ],
  1873. "tags": [
  1874. "repository"
  1875. ],
  1876. "summary": "Delete a repository",
  1877. "operationId": "repoDelete",
  1878. "parameters": [
  1879. {
  1880. "type": "string",
  1881. "description": "owner of the repo to delete",
  1882. "name": "owner",
  1883. "in": "path",
  1884. "required": true
  1885. },
  1886. {
  1887. "type": "string",
  1888. "description": "name of the repo to delete",
  1889. "name": "repo",
  1890. "in": "path",
  1891. "required": true
  1892. }
  1893. ],
  1894. "responses": {
  1895. "204": {
  1896. "$ref": "#/responses/empty"
  1897. },
  1898. "403": {
  1899. "$ref": "#/responses/forbidden"
  1900. }
  1901. }
  1902. },
  1903. "patch": {
  1904. "produces": [
  1905. "application/json"
  1906. ],
  1907. "tags": [
  1908. "repository"
  1909. ],
  1910. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1911. "operationId": "repoEdit",
  1912. "parameters": [
  1913. {
  1914. "type": "string",
  1915. "description": "owner of the repo to edit",
  1916. "name": "owner",
  1917. "in": "path",
  1918. "required": true
  1919. },
  1920. {
  1921. "type": "string",
  1922. "description": "name of the repo to edit",
  1923. "name": "repo",
  1924. "in": "path",
  1925. "required": true
  1926. },
  1927. {
  1928. "description": "Properties of a repo that you can edit",
  1929. "name": "body",
  1930. "in": "body",
  1931. "schema": {
  1932. "$ref": "#/definitions/EditRepoOption"
  1933. }
  1934. }
  1935. ],
  1936. "responses": {
  1937. "200": {
  1938. "$ref": "#/responses/Repository"
  1939. },
  1940. "403": {
  1941. "$ref": "#/responses/forbidden"
  1942. },
  1943. "422": {
  1944. "$ref": "#/responses/validationError"
  1945. }
  1946. }
  1947. }
  1948. },
  1949. "/repos/{owner}/{repo}/archive/{archive}": {
  1950. "get": {
  1951. "produces": [
  1952. "application/json"
  1953. ],
  1954. "tags": [
  1955. "repository"
  1956. ],
  1957. "summary": "Get an archive of a repository",
  1958. "operationId": "repoGetArchive",
  1959. "parameters": [
  1960. {
  1961. "type": "string",
  1962. "description": "owner of the repo",
  1963. "name": "owner",
  1964. "in": "path",
  1965. "required": true
  1966. },
  1967. {
  1968. "type": "string",
  1969. "description": "name of the repo",
  1970. "name": "repo",
  1971. "in": "path",
  1972. "required": true
  1973. },
  1974. {
  1975. "type": "string",
  1976. "description": "archive to download, consisting of a git reference and archive",
  1977. "name": "archive",
  1978. "in": "path",
  1979. "required": true
  1980. }
  1981. ],
  1982. "responses": {
  1983. "200": {
  1984. "description": "success"
  1985. },
  1986. "404": {
  1987. "$ref": "#/responses/notFound"
  1988. }
  1989. }
  1990. }
  1991. },
  1992. "/repos/{owner}/{repo}/branch_protections": {
  1993. "get": {
  1994. "produces": [
  1995. "application/json"
  1996. ],
  1997. "tags": [
  1998. "repository"
  1999. ],
  2000. "summary": "List branch protections for a repository",
  2001. "operationId": "repoListBranchProtection",
  2002. "parameters": [
  2003. {
  2004. "type": "string",
  2005. "description": "owner of the repo",
  2006. "name": "owner",
  2007. "in": "path",
  2008. "required": true
  2009. },
  2010. {
  2011. "type": "string",
  2012. "description": "name of the repo",
  2013. "name": "repo",
  2014. "in": "path",
  2015. "required": true
  2016. }
  2017. ],
  2018. "responses": {
  2019. "200": {
  2020. "$ref": "#/responses/BranchProtectionList"
  2021. }
  2022. }
  2023. },
  2024. "post": {
  2025. "consumes": [
  2026. "application/json"
  2027. ],
  2028. "produces": [
  2029. "application/json"
  2030. ],
  2031. "tags": [
  2032. "repository"
  2033. ],
  2034. "summary": "Create a branch protections for a repository",
  2035. "operationId": "repoCreateBranchProtection",
  2036. "parameters": [
  2037. {
  2038. "type": "string",
  2039. "description": "owner of the repo",
  2040. "name": "owner",
  2041. "in": "path",
  2042. "required": true
  2043. },
  2044. {
  2045. "type": "string",
  2046. "description": "name of the repo",
  2047. "name": "repo",
  2048. "in": "path",
  2049. "required": true
  2050. },
  2051. {
  2052. "name": "body",
  2053. "in": "body",
  2054. "schema": {
  2055. "$ref": "#/definitions/CreateBranchProtectionOption"
  2056. }
  2057. }
  2058. ],
  2059. "responses": {
  2060. "201": {
  2061. "$ref": "#/responses/BranchProtection"
  2062. },
  2063. "403": {
  2064. "$ref": "#/responses/forbidden"
  2065. },
  2066. "404": {
  2067. "$ref": "#/responses/notFound"
  2068. },
  2069. "422": {
  2070. "$ref": "#/responses/validationError"
  2071. }
  2072. }
  2073. }
  2074. },
  2075. "/repos/{owner}/{repo}/branch_protections/{name}": {
  2076. "get": {
  2077. "produces": [
  2078. "application/json"
  2079. ],
  2080. "tags": [
  2081. "repository"
  2082. ],
  2083. "summary": "Get a specific branch protection for the repository",
  2084. "operationId": "repoGetBranchProtection",
  2085. "parameters": [
  2086. {
  2087. "type": "string",
  2088. "description": "owner of the repo",
  2089. "name": "owner",
  2090. "in": "path",
  2091. "required": true
  2092. },
  2093. {
  2094. "type": "string",
  2095. "description": "name of the repo",
  2096. "name": "repo",
  2097. "in": "path",
  2098. "required": true
  2099. },
  2100. {
  2101. "type": "string",
  2102. "description": "name of protected branch",
  2103. "name": "name",
  2104. "in": "path",
  2105. "required": true
  2106. }
  2107. ],
  2108. "responses": {
  2109. "200": {
  2110. "$ref": "#/responses/BranchProtection"
  2111. },
  2112. "404": {
  2113. "$ref": "#/responses/notFound"
  2114. }
  2115. }
  2116. },
  2117. "delete": {
  2118. "produces": [
  2119. "application/json"
  2120. ],
  2121. "tags": [
  2122. "repository"
  2123. ],
  2124. "summary": "Delete a specific branch protection for the repository",
  2125. "operationId": "repoDeleteBranchProtection",
  2126. "parameters": [
  2127. {
  2128. "type": "string",
  2129. "description": "owner of the repo",
  2130. "name": "owner",
  2131. "in": "path",
  2132. "required": true
  2133. },
  2134. {
  2135. "type": "string",
  2136. "description": "name of the repo",
  2137. "name": "repo",
  2138. "in": "path",
  2139. "required": true
  2140. },
  2141. {
  2142. "type": "string",
  2143. "description": "name of protected branch",
  2144. "name": "name",
  2145. "in": "path",
  2146. "required": true
  2147. }
  2148. ],
  2149. "responses": {
  2150. "204": {
  2151. "$ref": "#/responses/empty"
  2152. },
  2153. "404": {
  2154. "$ref": "#/responses/notFound"
  2155. }
  2156. }
  2157. },
  2158. "patch": {
  2159. "consumes": [
  2160. "application/json"
  2161. ],
  2162. "produces": [
  2163. "application/json"
  2164. ],
  2165. "tags": [
  2166. "repository"
  2167. ],
  2168. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  2169. "operationId": "repoEditBranchProtection",
  2170. "parameters": [
  2171. {
  2172. "type": "string",
  2173. "description": "owner of the repo",
  2174. "name": "owner",
  2175. "in": "path",
  2176. "required": true
  2177. },
  2178. {
  2179. "type": "string",
  2180. "description": "name of the repo",
  2181. "name": "repo",
  2182. "in": "path",
  2183. "required": true
  2184. },
  2185. {
  2186. "type": "string",
  2187. "description": "name of protected branch",
  2188. "name": "name",
  2189. "in": "path",
  2190. "required": true
  2191. },
  2192. {
  2193. "name": "body",
  2194. "in": "body",
  2195. "schema": {
  2196. "$ref": "#/definitions/EditBranchProtectionOption"
  2197. }
  2198. }
  2199. ],
  2200. "responses": {
  2201. "200": {
  2202. "$ref": "#/responses/BranchProtection"
  2203. },
  2204. "404": {
  2205. "$ref": "#/responses/notFound"
  2206. },
  2207. "422": {
  2208. "$ref": "#/responses/validationError"
  2209. }
  2210. }
  2211. }
  2212. },
  2213. "/repos/{owner}/{repo}/branches": {
  2214. "get": {
  2215. "produces": [
  2216. "application/json"
  2217. ],
  2218. "tags": [
  2219. "repository"
  2220. ],
  2221. "summary": "List a repository's branches",
  2222. "operationId": "repoListBranches",
  2223. "parameters": [
  2224. {
  2225. "type": "string",
  2226. "description": "owner of the repo",
  2227. "name": "owner",
  2228. "in": "path",
  2229. "required": true
  2230. },
  2231. {
  2232. "type": "string",
  2233. "description": "name of the repo",
  2234. "name": "repo",
  2235. "in": "path",
  2236. "required": true
  2237. }
  2238. ],
  2239. "responses": {
  2240. "200": {
  2241. "$ref": "#/responses/BranchList"
  2242. }
  2243. }
  2244. }
  2245. },
  2246. "/repos/{owner}/{repo}/branches/{branch}": {
  2247. "get": {
  2248. "produces": [
  2249. "application/json"
  2250. ],
  2251. "tags": [
  2252. "repository"
  2253. ],
  2254. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  2255. "operationId": "repoGetBranch",
  2256. "parameters": [
  2257. {
  2258. "type": "string",
  2259. "description": "owner of the repo",
  2260. "name": "owner",
  2261. "in": "path",
  2262. "required": true
  2263. },
  2264. {
  2265. "type": "string",
  2266. "description": "name of the repo",
  2267. "name": "repo",
  2268. "in": "path",
  2269. "required": true
  2270. },
  2271. {
  2272. "type": "string",
  2273. "description": "branch to get",
  2274. "name": "branch",
  2275. "in": "path",
  2276. "required": true
  2277. }
  2278. ],
  2279. "responses": {
  2280. "200": {
  2281. "$ref": "#/responses/Branch"
  2282. }
  2283. }
  2284. },
  2285. "delete": {
  2286. "produces": [
  2287. "application/json"
  2288. ],
  2289. "tags": [
  2290. "repository"
  2291. ],
  2292. "summary": "Delete a specific branch from a repository",
  2293. "operationId": "repoDeleteBranch",
  2294. "parameters": [
  2295. {
  2296. "type": "string",
  2297. "description": "owner of the repo",
  2298. "name": "owner",
  2299. "in": "path",
  2300. "required": true
  2301. },
  2302. {
  2303. "type": "string",
  2304. "description": "name of the repo",
  2305. "name": "repo",
  2306. "in": "path",
  2307. "required": true
  2308. },
  2309. {
  2310. "type": "string",
  2311. "description": "branch to delete",
  2312. "name": "branch",
  2313. "in": "path",
  2314. "required": true
  2315. }
  2316. ],
  2317. "responses": {
  2318. "204": {
  2319. "$ref": "#/responses/empty"
  2320. },
  2321. "403": {
  2322. "$ref": "#/responses/error"
  2323. }
  2324. }
  2325. }
  2326. },
  2327. "/repos/{owner}/{repo}/collaborators": {
  2328. "get": {
  2329. "produces": [
  2330. "application/json"
  2331. ],
  2332. "tags": [
  2333. "repository"
  2334. ],
  2335. "summary": "List a repository's collaborators",
  2336. "operationId": "repoListCollaborators",
  2337. "parameters": [
  2338. {
  2339. "type": "string",
  2340. "description": "owner of the repo",
  2341. "name": "owner",
  2342. "in": "path",
  2343. "required": true
  2344. },
  2345. {
  2346. "type": "string",
  2347. "description": "name of the repo",
  2348. "name": "repo",
  2349. "in": "path",
  2350. "required": true
  2351. },
  2352. {
  2353. "type": "integer",
  2354. "description": "page number of results to return (1-based)",
  2355. "name": "page",
  2356. "in": "query"
  2357. },
  2358. {
  2359. "type": "integer",
  2360. "description": "page size of results, maximum page size is 50",
  2361. "name": "limit",
  2362. "in": "query"
  2363. }
  2364. ],
  2365. "responses": {
  2366. "200": {
  2367. "$ref": "#/responses/UserList"
  2368. }
  2369. }
  2370. }
  2371. },
  2372. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  2373. "get": {
  2374. "produces": [
  2375. "application/json"
  2376. ],
  2377. "tags": [
  2378. "repository"
  2379. ],
  2380. "summary": "Check if a user is a collaborator of a repository",
  2381. "operationId": "repoCheckCollaborator",
  2382. "parameters": [
  2383. {
  2384. "type": "string",
  2385. "description": "owner of the repo",
  2386. "name": "owner",
  2387. "in": "path",
  2388. "required": true
  2389. },
  2390. {
  2391. "type": "string",
  2392. "description": "name of the repo",
  2393. "name": "repo",
  2394. "in": "path",
  2395. "required": true
  2396. },
  2397. {
  2398. "type": "string",
  2399. "description": "username of the collaborator",
  2400. "name": "collaborator",
  2401. "in": "path",
  2402. "required": true
  2403. }
  2404. ],
  2405. "responses": {
  2406. "204": {
  2407. "$ref": "#/responses/empty"
  2408. },
  2409. "404": {
  2410. "$ref": "#/responses/notFound"
  2411. },
  2412. "422": {
  2413. "$ref": "#/responses/validationError"
  2414. }
  2415. }
  2416. },
  2417. "put": {
  2418. "produces": [
  2419. "application/json"
  2420. ],
  2421. "tags": [
  2422. "repository"
  2423. ],
  2424. "summary": "Add a collaborator to a repository",
  2425. "operationId": "repoAddCollaborator",
  2426. "parameters": [
  2427. {
  2428. "type": "string",
  2429. "description": "owner of the repo",
  2430. "name": "owner",
  2431. "in": "path",
  2432. "required": true
  2433. },
  2434. {
  2435. "type": "string",
  2436. "description": "name of the repo",
  2437. "name": "repo",
  2438. "in": "path",
  2439. "required": true
  2440. },
  2441. {
  2442. "type": "string",
  2443. "description": "username of the collaborator to add",
  2444. "name": "collaborator",
  2445. "in": "path",
  2446. "required": true
  2447. },
  2448. {
  2449. "name": "body",
  2450. "in": "body",
  2451. "schema": {
  2452. "$ref": "#/definitions/AddCollaboratorOption"
  2453. }
  2454. }
  2455. ],
  2456. "responses": {
  2457. "204": {
  2458. "$ref": "#/responses/empty"
  2459. },
  2460. "422": {
  2461. "$ref": "#/responses/validationError"
  2462. }
  2463. }
  2464. },
  2465. "delete": {
  2466. "produces": [
  2467. "application/json"
  2468. ],
  2469. "tags": [
  2470. "repository"
  2471. ],
  2472. "summary": "Delete a collaborator from a repository",
  2473. "operationId": "repoDeleteCollaborator",
  2474. "parameters": [
  2475. {
  2476. "type": "string",
  2477. "description": "owner of the repo",
  2478. "name": "owner",
  2479. "in": "path",
  2480. "required": true
  2481. },
  2482. {
  2483. "type": "string",
  2484. "description": "name of the repo",
  2485. "name": "repo",
  2486. "in": "path",
  2487. "required": true
  2488. },
  2489. {
  2490. "type": "string",
  2491. "description": "username of the collaborator to delete",
  2492. "name": "collaborator",
  2493. "in": "path",
  2494. "required": true
  2495. }
  2496. ],
  2497. "responses": {
  2498. "204": {
  2499. "$ref": "#/responses/empty"
  2500. },
  2501. "422": {
  2502. "$ref": "#/responses/validationError"
  2503. }
  2504. }
  2505. }
  2506. },
  2507. "/repos/{owner}/{repo}/commits": {
  2508. "get": {
  2509. "produces": [
  2510. "application/json"
  2511. ],
  2512. "tags": [
  2513. "repository"
  2514. ],
  2515. "summary": "Get a list of all commits from a repository",
  2516. "operationId": "repoGetAllCommits",
  2517. "parameters": [
  2518. {
  2519. "type": "string",
  2520. "description": "owner of the repo",
  2521. "name": "owner",
  2522. "in": "path",
  2523. "required": true
  2524. },
  2525. {
  2526. "type": "string",
  2527. "description": "name of the repo",
  2528. "name": "repo",
  2529. "in": "path",
  2530. "required": true
  2531. },
  2532. {
  2533. "type": "string",
  2534. "description": "SHA or branch to start listing commits from (usually 'master')",
  2535. "name": "sha",
  2536. "in": "query"
  2537. },
  2538. {
  2539. "type": "integer",
  2540. "description": "page number of results to return (1-based)",
  2541. "name": "page",
  2542. "in": "query"
  2543. },
  2544. {
  2545. "type": "integer",
  2546. "description": "page size of results, maximum page size is 50",
  2547. "name": "limit",
  2548. "in": "query"
  2549. }
  2550. ],
  2551. "responses": {
  2552. "200": {
  2553. "$ref": "#/responses/CommitList"
  2554. },
  2555. "404": {
  2556. "$ref": "#/responses/notFound"
  2557. },
  2558. "409": {
  2559. "$ref": "#/responses/EmptyRepository"
  2560. }
  2561. }
  2562. }
  2563. },
  2564. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2565. "get": {
  2566. "produces": [
  2567. "application/json"
  2568. ],
  2569. "tags": [
  2570. "repository"
  2571. ],
  2572. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2573. "operationId": "repoGetCombinedStatusByRef",
  2574. "parameters": [
  2575. {
  2576. "type": "string",
  2577. "description": "owner of the repo",
  2578. "name": "owner",
  2579. "in": "path",
  2580. "required": true
  2581. },
  2582. {
  2583. "type": "string",
  2584. "description": "name of the repo",
  2585. "name": "repo",
  2586. "in": "path",
  2587. "required": true
  2588. },
  2589. {
  2590. "type": "string",
  2591. "description": "name of branch/tag/commit",
  2592. "name": "ref",
  2593. "in": "path",
  2594. "required": true
  2595. },
  2596. {
  2597. "type": "integer",
  2598. "description": "page number of results",
  2599. "name": "page",
  2600. "in": "query"
  2601. }
  2602. ],
  2603. "responses": {
  2604. "200": {
  2605. "$ref": "#/responses/Status"
  2606. },
  2607. "400": {
  2608. "$ref": "#/responses/error"
  2609. }
  2610. }
  2611. }
  2612. },
  2613. "/repos/{owner}/{repo}/contents": {
  2614. "get": {
  2615. "produces": [
  2616. "application/json"
  2617. ],
  2618. "tags": [
  2619. "repository"
  2620. ],
  2621. "summary": "Gets the metadata of all the entries of the root dir",
  2622. "operationId": "repoGetContentsList",
  2623. "parameters": [
  2624. {
  2625. "type": "string",
  2626. "description": "owner of the repo",
  2627. "name": "owner",
  2628. "in": "path",
  2629. "required": true
  2630. },
  2631. {
  2632. "type": "string",
  2633. "description": "name of the repo",
  2634. "name": "repo",
  2635. "in": "path",
  2636. "required": true
  2637. },
  2638. {
  2639. "type": "string",
  2640. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2641. "name": "ref",
  2642. "in": "query"
  2643. }
  2644. ],
  2645. "responses": {
  2646. "200": {
  2647. "$ref": "#/responses/ContentsListResponse"
  2648. },
  2649. "404": {
  2650. "$ref": "#/responses/notFound"
  2651. }
  2652. }
  2653. }
  2654. },
  2655. "/repos/{owner}/{repo}/contents/{filepath}": {
  2656. "get": {
  2657. "produces": [
  2658. "application/json"
  2659. ],
  2660. "tags": [
  2661. "repository"
  2662. ],
  2663. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  2664. "operationId": "repoGetContents",
  2665. "parameters": [
  2666. {
  2667. "type": "string",
  2668. "description": "owner of the repo",
  2669. "name": "owner",
  2670. "in": "path",
  2671. "required": true
  2672. },
  2673. {
  2674. "type": "string",
  2675. "description": "name of the repo",
  2676. "name": "repo",
  2677. "in": "path",
  2678. "required": true
  2679. },
  2680. {
  2681. "type": "string",
  2682. "description": "path of the dir, file, symlink or submodule in the repo",
  2683. "name": "filepath",
  2684. "in": "path",
  2685. "required": true
  2686. },
  2687. {
  2688. "type": "string",
  2689. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2690. "name": "ref",
  2691. "in": "query"
  2692. }
  2693. ],
  2694. "responses": {
  2695. "200": {
  2696. "$ref": "#/responses/ContentsResponse"
  2697. },
  2698. "404": {
  2699. "$ref": "#/responses/notFound"
  2700. }
  2701. }
  2702. },
  2703. "put": {
  2704. "consumes": [
  2705. "application/json"
  2706. ],
  2707. "produces": [
  2708. "application/json"
  2709. ],
  2710. "tags": [
  2711. "repository"
  2712. ],
  2713. "summary": "Update a file in a repository",
  2714. "operationId": "repoUpdateFile",
  2715. "parameters": [
  2716. {
  2717. "type": "string",
  2718. "description": "owner of the repo",
  2719. "name": "owner",
  2720. "in": "path",
  2721. "required": true
  2722. },
  2723. {
  2724. "type": "string",
  2725. "description": "name of the repo",
  2726. "name": "repo",
  2727. "in": "path",
  2728. "required": true
  2729. },
  2730. {
  2731. "type": "string",
  2732. "description": "path of the file to update",
  2733. "name": "filepath",
  2734. "in": "path",
  2735. "required": true
  2736. },
  2737. {
  2738. "name": "body",
  2739. "in": "body",
  2740. "required": true,
  2741. "schema": {
  2742. "$ref": "#/definitions/UpdateFileOptions"
  2743. }
  2744. }
  2745. ],
  2746. "responses": {
  2747. "200": {
  2748. "$ref": "#/responses/FileResponse"
  2749. },
  2750. "403": {
  2751. "$ref": "#/responses/error"
  2752. },
  2753. "404": {
  2754. "$ref": "#/responses/notFound"
  2755. },
  2756. "422": {
  2757. "$ref": "#/responses/error"
  2758. }
  2759. }
  2760. },
  2761. "post": {
  2762. "consumes": [
  2763. "application/json"
  2764. ],
  2765. "produces": [
  2766. "application/json"
  2767. ],
  2768. "tags": [
  2769. "repository"
  2770. ],
  2771. "summary": "Create a file in a repository",
  2772. "operationId": "repoCreateFile",
  2773. "parameters": [
  2774. {
  2775. "type": "string",
  2776. "description": "owner of the repo",
  2777. "name": "owner",
  2778. "in": "path",
  2779. "required": true
  2780. },
  2781. {
  2782. "type": "string",
  2783. "description": "name of the repo",
  2784. "name": "repo",
  2785. "in": "path",
  2786. "required": true
  2787. },
  2788. {
  2789. "type": "string",
  2790. "description": "path of the file to create",
  2791. "name": "filepath",
  2792. "in": "path",
  2793. "required": true
  2794. },
  2795. {
  2796. "name": "body",
  2797. "in": "body",
  2798. "required": true,
  2799. "schema": {
  2800. "$ref": "#/definitions/CreateFileOptions"
  2801. }
  2802. }
  2803. ],
  2804. "responses": {
  2805. "201": {
  2806. "$ref": "#/responses/FileResponse"
  2807. },
  2808. "403": {
  2809. "$ref": "#/responses/error"
  2810. },
  2811. "404": {
  2812. "$ref": "#/responses/notFound"
  2813. },
  2814. "422": {
  2815. "$ref": "#/responses/error"
  2816. }
  2817. }
  2818. },
  2819. "delete": {
  2820. "consumes": [
  2821. "application/json"
  2822. ],
  2823. "produces": [
  2824. "application/json"
  2825. ],
  2826. "tags": [
  2827. "repository"
  2828. ],
  2829. "summary": "Delete a file in a repository",
  2830. "operationId": "repoDeleteFile",
  2831. "parameters": [
  2832. {
  2833. "type": "string",
  2834. "description": "owner of the repo",
  2835. "name": "owner",
  2836. "in": "path",
  2837. "required": true
  2838. },
  2839. {
  2840. "type": "string",
  2841. "description": "name of the repo",
  2842. "name": "repo",
  2843. "in": "path",
  2844. "required": true
  2845. },
  2846. {
  2847. "type": "string",
  2848. "description": "path of the file to delete",
  2849. "name": "filepath",
  2850. "in": "path",
  2851. "required": true
  2852. },
  2853. {
  2854. "name": "body",
  2855. "in": "body",
  2856. "required": true,
  2857. "schema": {
  2858. "$ref": "#/definitions/DeleteFileOptions"
  2859. }
  2860. }
  2861. ],
  2862. "responses": {
  2863. "200": {
  2864. "$ref": "#/responses/FileDeleteResponse"
  2865. },
  2866. "400": {
  2867. "$ref": "#/responses/error"
  2868. },
  2869. "403": {
  2870. "$ref": "#/responses/error"
  2871. },
  2872. "404": {
  2873. "$ref": "#/responses/error"
  2874. }
  2875. }
  2876. }
  2877. },
  2878. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2879. "get": {
  2880. "produces": [
  2881. "application/json"
  2882. ],
  2883. "tags": [
  2884. "repository"
  2885. ],
  2886. "summary": "Get the EditorConfig definitions of a file in a repository",
  2887. "operationId": "repoGetEditorConfig",
  2888. "parameters": [
  2889. {
  2890. "type": "string",
  2891. "description": "owner of the repo",
  2892. "name": "owner",
  2893. "in": "path",
  2894. "required": true
  2895. },
  2896. {
  2897. "type": "string",
  2898. "description": "name of the repo",
  2899. "name": "repo",
  2900. "in": "path",
  2901. "required": true
  2902. },
  2903. {
  2904. "type": "string",
  2905. "description": "filepath of file to get",
  2906. "name": "filepath",
  2907. "in": "path",
  2908. "required": true
  2909. }
  2910. ],
  2911. "responses": {
  2912. "200": {
  2913. "description": "success"
  2914. },
  2915. "404": {
  2916. "$ref": "#/responses/notFound"
  2917. }
  2918. }
  2919. }
  2920. },
  2921. "/repos/{owner}/{repo}/forks": {
  2922. "get": {
  2923. "produces": [
  2924. "application/json"
  2925. ],
  2926. "tags": [
  2927. "repository"
  2928. ],
  2929. "summary": "List a repository's forks",
  2930. "operationId": "listForks",
  2931. "parameters": [
  2932. {
  2933. "type": "string",
  2934. "description": "owner of the repo",
  2935. "name": "owner",
  2936. "in": "path",
  2937. "required": true
  2938. },
  2939. {
  2940. "type": "string",
  2941. "description": "name of the repo",
  2942. "name": "repo",
  2943. "in": "path",
  2944. "required": true
  2945. },
  2946. {
  2947. "type": "integer",
  2948. "description": "page number of results to return (1-based)",
  2949. "name": "page",
  2950. "in": "query"
  2951. },
  2952. {
  2953. "type": "integer",
  2954. "description": "page size of results, maximum page size is 50",
  2955. "name": "limit",
  2956. "in": "query"
  2957. }
  2958. ],
  2959. "responses": {
  2960. "200": {
  2961. "$ref": "#/responses/RepositoryList"
  2962. }
  2963. }
  2964. },
  2965. "post": {
  2966. "produces": [
  2967. "application/json"
  2968. ],
  2969. "tags": [
  2970. "repository"
  2971. ],
  2972. "summary": "Fork a repository",
  2973. "operationId": "createFork",
  2974. "parameters": [
  2975. {
  2976. "type": "string",
  2977. "description": "owner of the repo to fork",
  2978. "name": "owner",
  2979. "in": "path",
  2980. "required": true
  2981. },
  2982. {
  2983. "type": "string",
  2984. "description": "name of the repo to fork",
  2985. "name": "repo",
  2986. "in": "path",
  2987. "required": true
  2988. },
  2989. {
  2990. "name": "body",
  2991. "in": "body",
  2992. "schema": {
  2993. "$ref": "#/definitions/CreateForkOption"
  2994. }
  2995. }
  2996. ],
  2997. "responses": {
  2998. "202": {
  2999. "$ref": "#/responses/Repository"
  3000. },
  3001. "403": {
  3002. "$ref": "#/responses/forbidden"
  3003. },
  3004. "422": {
  3005. "$ref": "#/responses/validationError"
  3006. }
  3007. }
  3008. }
  3009. },
  3010. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  3011. "get": {
  3012. "produces": [
  3013. "application/json"
  3014. ],
  3015. "tags": [
  3016. "repository"
  3017. ],
  3018. "summary": "Gets the blob of a repository.",
  3019. "operationId": "GetBlob",
  3020. "parameters": [
  3021. {
  3022. "type": "string",
  3023. "description": "owner of the repo",
  3024. "name": "owner",
  3025. "in": "path",
  3026. "required": true
  3027. },
  3028. {
  3029. "type": "string",
  3030. "description": "name of the repo",
  3031. "name": "repo",
  3032. "in": "path",
  3033. "required": true
  3034. },
  3035. {
  3036. "type": "string",
  3037. "description": "sha of the commit",
  3038. "name": "sha",
  3039. "in": "path",
  3040. "required": true
  3041. }
  3042. ],
  3043. "responses": {
  3044. "200": {
  3045. "$ref": "#/responses/GitBlobResponse"
  3046. },
  3047. "400": {
  3048. "$ref": "#/responses/error"
  3049. }
  3050. }
  3051. }
  3052. },
  3053. "/repos/{owner}/{repo}/git/commits/{sha}": {
  3054. "get": {
  3055. "produces": [
  3056. "application/json"
  3057. ],
  3058. "tags": [
  3059. "repository"
  3060. ],
  3061. "summary": "Get a single commit from a repository",
  3062. "operationId": "repoGetSingleCommit",
  3063. "parameters": [
  3064. {
  3065. "type": "string",
  3066. "description": "owner of the repo",
  3067. "name": "owner",
  3068. "in": "path",
  3069. "required": true
  3070. },
  3071. {
  3072. "type": "string",
  3073. "description": "name of the repo",
  3074. "name": "repo",
  3075. "in": "path",
  3076. "required": true
  3077. },
  3078. {
  3079. "type": "string",
  3080. "description": "a git ref or commit sha",
  3081. "name": "sha",
  3082. "in": "path",
  3083. "required": true
  3084. }
  3085. ],
  3086. "responses": {
  3087. "200": {
  3088. "$ref": "#/responses/Commit"
  3089. },
  3090. "404": {
  3091. "$ref": "#/responses/notFound"
  3092. },
  3093. "422": {
  3094. "$ref": "#/responses/validationError"
  3095. }
  3096. }
  3097. }
  3098. },
  3099. "/repos/{owner}/{repo}/git/refs": {
  3100. "get": {
  3101. "produces": [
  3102. "application/json"
  3103. ],
  3104. "tags": [
  3105. "repository"
  3106. ],
  3107. "summary": "Get specified ref or filtered repository's refs",
  3108. "operationId": "repoListAllGitRefs",
  3109. "parameters": [
  3110. {
  3111. "type": "string",
  3112. "description": "owner of the repo",
  3113. "name": "owner",
  3114. "in": "path",
  3115. "required": true
  3116. },
  3117. {
  3118. "type": "string",
  3119. "description": "name of the repo",
  3120. "name": "repo",
  3121. "in": "path",
  3122. "required": true
  3123. }
  3124. ],
  3125. "responses": {
  3126. "200": {
  3127. "$ref": "#/responses/ReferenceList"
  3128. },
  3129. "404": {
  3130. "$ref": "#/responses/notFound"
  3131. }
  3132. }
  3133. }
  3134. },
  3135. "/repos/{owner}/{repo}/git/refs/{ref}": {
  3136. "get": {
  3137. "produces": [
  3138. "application/json"
  3139. ],
  3140. "tags": [
  3141. "repository"
  3142. ],
  3143. "summary": "Get specified ref or filtered repository's refs",
  3144. "operationId": "repoListGitRefs",
  3145. "parameters": [
  3146. {
  3147. "type": "string",
  3148. "description": "owner of the repo",
  3149. "name": "owner",
  3150. "in": "path",
  3151. "required": true
  3152. },
  3153. {
  3154. "type": "string",
  3155. "description": "name of the repo",
  3156. "name": "repo",
  3157. "in": "path",
  3158. "required": true
  3159. },
  3160. {
  3161. "type": "string",
  3162. "description": "part or full name of the ref",
  3163. "name": "ref",
  3164. "in": "path",
  3165. "required": true
  3166. }
  3167. ],
  3168. "responses": {
  3169. "200": {
  3170. "$ref": "#/responses/ReferenceList"
  3171. },
  3172. "404": {
  3173. "$ref": "#/responses/notFound"
  3174. }
  3175. }
  3176. }
  3177. },
  3178. "/repos/{owner}/{repo}/git/tags/{sha}": {
  3179. "get": {
  3180. "produces": [
  3181. "application/json"
  3182. ],
  3183. "tags": [
  3184. "repository"
  3185. ],
  3186. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  3187. "operationId": "GetTag",
  3188. "parameters": [
  3189. {
  3190. "type": "string",
  3191. "description": "owner of the repo",
  3192. "name": "owner",
  3193. "in": "path",
  3194. "required": true
  3195. },
  3196. {
  3197. "type": "string",
  3198. "description": "name of the repo",
  3199. "name": "repo",
  3200. "in": "path",
  3201. "required": true
  3202. },
  3203. {
  3204. "type": "string",
  3205. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  3206. "name": "sha",
  3207. "in": "path",
  3208. "required": true
  3209. }
  3210. ],
  3211. "responses": {
  3212. "200": {
  3213. "$ref": "#/responses/AnnotatedTag"
  3214. },
  3215. "400": {
  3216. "$ref": "#/responses/error"
  3217. }
  3218. }
  3219. }
  3220. },
  3221. "/repos/{owner}/{repo}/git/trees/{sha}": {
  3222. "get": {
  3223. "produces": [
  3224. "application/json"
  3225. ],
  3226. "tags": [
  3227. "repository"
  3228. ],
  3229. "summary": "Gets the tree of a repository.",
  3230. "operationId": "GetTree",
  3231. "parameters": [
  3232. {
  3233. "type": "string",
  3234. "description": "owner of the repo",
  3235. "name": "owner",
  3236. "in": "path",
  3237. "required": true
  3238. },
  3239. {
  3240. "type": "string",
  3241. "description": "name of the repo",
  3242. "name": "repo",
  3243. "in": "path",
  3244. "required": true
  3245. },
  3246. {
  3247. "type": "string",
  3248. "description": "sha of the commit",
  3249. "name": "sha",
  3250. "in": "path",
  3251. "required": true
  3252. },
  3253. {
  3254. "type": "boolean",
  3255. "description": "show all directories and files",
  3256. "name": "recursive",
  3257. "in": "query"
  3258. },
  3259. {
  3260. "type": "integer",
  3261. "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",
  3262. "name": "page",
  3263. "in": "query"
  3264. },
  3265. {
  3266. "type": "integer",
  3267. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  3268. "name": "per_page",
  3269. "in": "query"
  3270. }
  3271. ],
  3272. "responses": {
  3273. "200": {
  3274. "$ref": "#/responses/GitTreeResponse"
  3275. },
  3276. "400": {
  3277. "$ref": "#/responses/error"
  3278. }
  3279. }
  3280. }
  3281. },
  3282. "/repos/{owner}/{repo}/hooks": {
  3283. "get": {
  3284. "produces": [
  3285. "application/json"
  3286. ],
  3287. "tags": [
  3288. "repository"
  3289. ],
  3290. "summary": "List the hooks in a repository",
  3291. "operationId": "repoListHooks",
  3292. "parameters": [
  3293. {
  3294. "type": "string",
  3295. "description": "owner of the repo",
  3296. "name": "owner",
  3297. "in": "path",
  3298. "required": true
  3299. },
  3300. {
  3301. "type": "string",
  3302. "description": "name of the repo",
  3303. "name": "repo",
  3304. "in": "path",
  3305. "required": true
  3306. },
  3307. {
  3308. "type": "integer",
  3309. "description": "page number of results to return (1-based)",
  3310. "name": "page",
  3311. "in": "query"
  3312. },
  3313. {
  3314. "type": "integer",
  3315. "description": "page size of results, maximum page size is 50",
  3316. "name": "limit",
  3317. "in": "query"
  3318. }
  3319. ],
  3320. "responses": {
  3321. "200": {
  3322. "$ref": "#/responses/HookList"
  3323. }
  3324. }
  3325. },
  3326. "post": {
  3327. "consumes": [
  3328. "application/json"
  3329. ],
  3330. "produces": [
  3331. "application/json"
  3332. ],
  3333. "tags": [
  3334. "repository"
  3335. ],
  3336. "summary": "Create a hook",
  3337. "operationId": "repoCreateHook",
  3338. "parameters": [
  3339. {
  3340. "type": "string",
  3341. "description": "owner of the repo",
  3342. "name": "owner",
  3343. "in": "path",
  3344. "required": true
  3345. },
  3346. {
  3347. "type": "string",
  3348. "description": "name of the repo",
  3349. "name": "repo",
  3350. "in": "path",
  3351. "required": true
  3352. },
  3353. {
  3354. "name": "body",
  3355. "in": "body",
  3356. "schema": {
  3357. "$ref": "#/definitions/CreateHookOption"
  3358. }
  3359. }
  3360. ],
  3361. "responses": {
  3362. "201": {
  3363. "$ref": "#/responses/Hook"
  3364. }
  3365. }
  3366. }
  3367. },
  3368. "/repos/{owner}/{repo}/hooks/git": {
  3369. "get": {
  3370. "produces": [
  3371. "application/json"
  3372. ],
  3373. "tags": [
  3374. "repository"
  3375. ],
  3376. "summary": "List the Git hooks in a repository",
  3377. "operationId": "repoListGitHooks",
  3378. "parameters": [
  3379. {
  3380. "type": "string",
  3381. "description": "owner of the repo",
  3382. "name": "owner",
  3383. "in": "path",
  3384. "required": true
  3385. },
  3386. {
  3387. "type": "string",
  3388. "description": "name of the repo",
  3389. "name": "repo",
  3390. "in": "path",
  3391. "required": true
  3392. }
  3393. ],
  3394. "responses": {
  3395. "200": {
  3396. "$ref": "#/responses/GitHookList"
  3397. }
  3398. }
  3399. }
  3400. },
  3401. "/repos/{owner}/{repo}/hooks/git/{id}": {
  3402. "get": {
  3403. "produces": [
  3404. "application/json"
  3405. ],
  3406. "tags": [
  3407. "repository"
  3408. ],
  3409. "summary": "Get a Git hook",
  3410. "operationId": "repoGetGitHook",
  3411. "parameters": [
  3412. {
  3413. "type": "string",
  3414. "description": "owner of the repo",
  3415. "name": "owner",
  3416. "in": "path",
  3417. "required": true
  3418. },
  3419. {
  3420. "type": "string",
  3421. "description": "name of the repo",
  3422. "name": "repo",
  3423. "in": "path",
  3424. "required": true
  3425. },
  3426. {
  3427. "type": "string",
  3428. "description": "id of the hook to get",
  3429. "name": "id",
  3430. "in": "path",
  3431. "required": true
  3432. }
  3433. ],
  3434. "responses": {
  3435. "200": {
  3436. "$ref": "#/responses/GitHook"
  3437. },
  3438. "404": {
  3439. "$ref": "#/responses/notFound"
  3440. }
  3441. }
  3442. },
  3443. "delete": {
  3444. "produces": [
  3445. "application/json"
  3446. ],
  3447. "tags": [
  3448. "repository"
  3449. ],
  3450. "summary": "Delete a Git hook in a repository",
  3451. "operationId": "repoDeleteGitHook",
  3452. "parameters": [
  3453. {
  3454. "type": "string",
  3455. "description": "owner of the repo",
  3456. "name": "owner",
  3457. "in": "path",
  3458. "required": true
  3459. },
  3460. {
  3461. "type": "string",
  3462. "description": "name of the repo",
  3463. "name": "repo",
  3464. "in": "path",
  3465. "required": true
  3466. },
  3467. {
  3468. "type": "string",
  3469. "description": "id of the hook to get",
  3470. "name": "id",
  3471. "in": "path",
  3472. "required": true
  3473. }
  3474. ],
  3475. "responses": {
  3476. "204": {
  3477. "$ref": "#/responses/empty"
  3478. },
  3479. "404": {
  3480. "$ref": "#/responses/notFound"
  3481. }
  3482. }
  3483. },
  3484. "patch": {
  3485. "produces": [
  3486. "application/json"
  3487. ],
  3488. "tags": [
  3489. "repository"
  3490. ],
  3491. "summary": "Edit a Git hook in a repository",
  3492. "operationId": "repoEditGitHook",
  3493. "parameters": [
  3494. {
  3495. "type": "string",
  3496. "description": "owner of the repo",
  3497. "name": "owner",
  3498. "in": "path",
  3499. "required": true
  3500. },
  3501. {
  3502. "type": "string",
  3503. "description": "name of the repo",
  3504. "name": "repo",
  3505. "in": "path",
  3506. "required": true
  3507. },
  3508. {
  3509. "type": "string",
  3510. "description": "id of the hook to get",
  3511. "name": "id",
  3512. "in": "path",
  3513. "required": true
  3514. },
  3515. {
  3516. "name": "body",
  3517. "in": "body",
  3518. "schema": {
  3519. "$ref": "#/definitions/EditGitHookOption"
  3520. }
  3521. }
  3522. ],
  3523. "responses": {
  3524. "200": {
  3525. "$ref": "#/responses/GitHook"
  3526. },
  3527. "404": {
  3528. "$ref": "#/responses/notFound"
  3529. }
  3530. }
  3531. }
  3532. },
  3533. "/repos/{owner}/{repo}/hooks/{id}": {
  3534. "get": {
  3535. "produces": [
  3536. "application/json"
  3537. ],
  3538. "tags": [
  3539. "repository"
  3540. ],
  3541. "summary": "Get a hook",
  3542. "operationId": "repoGetHook",
  3543. "parameters": [
  3544. {
  3545. "type": "string",
  3546. "description": "owner of the repo",
  3547. "name": "owner",
  3548. "in": "path",
  3549. "required": true
  3550. },
  3551. {
  3552. "type": "string",
  3553. "description": "name of the repo",
  3554. "name": "repo",
  3555. "in": "path",
  3556. "required": true
  3557. },
  3558. {
  3559. "type": "integer",
  3560. "format": "int64",
  3561. "description": "id of the hook to get",
  3562. "name": "id",
  3563. "in": "path",
  3564. "required": true
  3565. }
  3566. ],
  3567. "responses": {
  3568. "200": {
  3569. "$ref": "#/responses/Hook"
  3570. },
  3571. "404": {
  3572. "$ref": "#/responses/notFound"
  3573. }
  3574. }
  3575. },
  3576. "delete": {
  3577. "produces": [
  3578. "application/json"
  3579. ],
  3580. "tags": [
  3581. "repository"
  3582. ],
  3583. "summary": "Delete a hook in a repository",
  3584. "operationId": "repoDeleteHook",
  3585. "parameters": [
  3586. {
  3587. "type": "string",
  3588. "description": "owner of the repo",
  3589. "name": "owner",
  3590. "in": "path",
  3591. "required": true
  3592. },
  3593. {
  3594. "type": "string",
  3595. "description": "name of the repo",
  3596. "name": "repo",
  3597. "in": "path",
  3598. "required": true
  3599. },
  3600. {
  3601. "type": "integer",
  3602. "format": "int64",
  3603. "description": "id of the hook to delete",
  3604. "name": "id",
  3605. "in": "path",
  3606. "required": true
  3607. }
  3608. ],
  3609. "responses": {
  3610. "204": {
  3611. "$ref": "#/responses/empty"
  3612. },
  3613. "404": {
  3614. "$ref": "#/responses/notFound"
  3615. }
  3616. }
  3617. },
  3618. "patch": {
  3619. "produces": [
  3620. "application/json"
  3621. ],
  3622. "tags": [
  3623. "repository"
  3624. ],
  3625. "summary": "Edit a hook in a repository",
  3626. "operationId": "repoEditHook",
  3627. "parameters": [
  3628. {
  3629. "type": "string",
  3630. "description": "owner of the repo",
  3631. "name": "owner",
  3632. "in": "path",
  3633. "required": true
  3634. },
  3635. {
  3636. "type": "string",
  3637. "description": "name of the repo",
  3638. "name": "repo",
  3639. "in": "path",
  3640. "required": true
  3641. },
  3642. {
  3643. "type": "integer",
  3644. "format": "int64",
  3645. "description": "index of the hook",
  3646. "name": "id",
  3647. "in": "path",
  3648. "required": true
  3649. },
  3650. {
  3651. "name": "body",
  3652. "in": "body",
  3653. "schema": {
  3654. "$ref": "#/definitions/EditHookOption"
  3655. }
  3656. }
  3657. ],
  3658. "responses": {
  3659. "200": {
  3660. "$ref": "#/responses/Hook"
  3661. }
  3662. }
  3663. }
  3664. },
  3665. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3666. "post": {
  3667. "produces": [
  3668. "application/json"
  3669. ],
  3670. "tags": [
  3671. "repository"
  3672. ],
  3673. "summary": "Test a push webhook",
  3674. "operationId": "repoTestHook",
  3675. "parameters": [
  3676. {
  3677. "type": "string",
  3678. "description": "owner of the repo",
  3679. "name": "owner",
  3680. "in": "path",
  3681. "required": true
  3682. },
  3683. {
  3684. "type": "string",
  3685. "description": "name of the repo",
  3686. "name": "repo",
  3687. "in": "path",
  3688. "required": true
  3689. },
  3690. {
  3691. "type": "integer",
  3692. "format": "int64",
  3693. "description": "id of the hook to test",
  3694. "name": "id",
  3695. "in": "path",
  3696. "required": true
  3697. }
  3698. ],
  3699. "responses": {
  3700. "204": {
  3701. "$ref": "#/responses/empty"
  3702. }
  3703. }
  3704. }
  3705. },
  3706. "/repos/{owner}/{repo}/issues": {
  3707. "get": {
  3708. "produces": [
  3709. "application/json"
  3710. ],
  3711. "tags": [
  3712. "issue"
  3713. ],
  3714. "summary": "List a repository's issues",
  3715. "operationId": "issueListIssues",
  3716. "parameters": [
  3717. {
  3718. "type": "string",
  3719. "description": "owner of the repo",
  3720. "name": "owner",
  3721. "in": "path",
  3722. "required": true
  3723. },
  3724. {
  3725. "type": "string",
  3726. "description": "name of the repo",
  3727. "name": "repo",
  3728. "in": "path",
  3729. "required": true
  3730. },
  3731. {
  3732. "type": "string",
  3733. "description": "whether issue is open or closed",
  3734. "name": "state",
  3735. "in": "query"
  3736. },
  3737. {
  3738. "type": "string",
  3739. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3740. "name": "labels",
  3741. "in": "query"
  3742. },
  3743. {
  3744. "type": "string",
  3745. "description": "search string",
  3746. "name": "q",
  3747. "in": "query"
  3748. },
  3749. {
  3750. "type": "string",
  3751. "description": "filter by type (issues / pulls) if set",
  3752. "name": "type",
  3753. "in": "query"
  3754. },
  3755. {
  3756. "type": "string",
  3757. "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",
  3758. "name": "milestones",
  3759. "in": "query"
  3760. },
  3761. {
  3762. "type": "integer",
  3763. "description": "page number of results to return (1-based)",
  3764. "name": "page",
  3765. "in": "query"
  3766. },
  3767. {
  3768. "type": "integer",
  3769. "description": "page size of results, maximum page size is 50",
  3770. "name": "limit",
  3771. "in": "query"
  3772. }
  3773. ],
  3774. "responses": {
  3775. "200": {
  3776. "$ref": "#/responses/IssueList"
  3777. }
  3778. }
  3779. },
  3780. "post": {
  3781. "consumes": [
  3782. "application/json"
  3783. ],
  3784. "produces": [
  3785. "application/json"
  3786. ],
  3787. "tags": [
  3788. "issue"
  3789. ],
  3790. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3791. "operationId": "issueCreateIssue",
  3792. "parameters": [
  3793. {
  3794. "type": "string",
  3795. "description": "owner of the repo",
  3796. "name": "owner",
  3797. "in": "path",
  3798. "required": true
  3799. },
  3800. {
  3801. "type": "string",
  3802. "description": "name of the repo",
  3803. "name": "repo",
  3804. "in": "path",
  3805. "required": true
  3806. },
  3807. {
  3808. "name": "body",
  3809. "in": "body",
  3810. "schema": {
  3811. "$ref": "#/definitions/CreateIssueOption"
  3812. }
  3813. }
  3814. ],
  3815. "responses": {
  3816. "201": {
  3817. "$ref": "#/responses/Issue"
  3818. },
  3819. "403": {
  3820. "$ref": "#/responses/forbidden"
  3821. },
  3822. "412": {
  3823. "$ref": "#/responses/error"
  3824. },
  3825. "422": {
  3826. "$ref": "#/responses/validationError"
  3827. }
  3828. }
  3829. }
  3830. },
  3831. "/repos/{owner}/{repo}/issues/comments": {
  3832. "get": {
  3833. "produces": [
  3834. "application/json"
  3835. ],
  3836. "tags": [
  3837. "issue"
  3838. ],
  3839. "summary": "List all comments in a repository",
  3840. "operationId": "issueGetRepoComments",
  3841. "parameters": [
  3842. {
  3843. "type": "string",
  3844. "description": "owner of the repo",
  3845. "name": "owner",
  3846. "in": "path",
  3847. "required": true
  3848. },
  3849. {
  3850. "type": "string",
  3851. "description": "name of the repo",
  3852. "name": "repo",
  3853. "in": "path",
  3854. "required": true
  3855. },
  3856. {
  3857. "type": "string",
  3858. "format": "date-time",
  3859. "description": "if provided, only comments updated since the provided time are returned.",
  3860. "name": "since",
  3861. "in": "query"
  3862. },
  3863. {
  3864. "type": "string",
  3865. "format": "date-time",
  3866. "description": "if provided, only comments updated before the provided time are returned.",
  3867. "name": "before",
  3868. "in": "query"
  3869. },
  3870. {
  3871. "type": "integer",
  3872. "description": "page number of results to return (1-based)",
  3873. "name": "page",
  3874. "in": "query"
  3875. },
  3876. {
  3877. "type": "integer",
  3878. "description": "page size of results, maximum page size is 50",
  3879. "name": "limit",
  3880. "in": "query"
  3881. }
  3882. ],
  3883. "responses": {
  3884. "200": {
  3885. "$ref": "#/responses/CommentList"
  3886. }
  3887. }
  3888. }
  3889. },
  3890. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3891. "get": {
  3892. "consumes": [
  3893. "application/json"
  3894. ],
  3895. "produces": [
  3896. "application/json"
  3897. ],
  3898. "tags": [
  3899. "issue"
  3900. ],
  3901. "summary": "Get a comment",
  3902. "operationId": "issueGetComment",
  3903. "parameters": [
  3904. {
  3905. "type": "string",
  3906. "description": "owner of the repo",
  3907. "name": "owner",
  3908. "in": "path",
  3909. "required": true
  3910. },
  3911. {
  3912. "type": "string",
  3913. "description": "name of the repo",
  3914. "name": "repo",
  3915. "in": "path",
  3916. "required": true
  3917. },
  3918. {
  3919. "type": "integer",
  3920. "format": "int64",
  3921. "description": "id of the comment",
  3922. "name": "id",
  3923. "in": "path",
  3924. "required": true
  3925. }
  3926. ],
  3927. "responses": {
  3928. "200": {
  3929. "$ref": "#/responses/Comment"
  3930. },
  3931. "204": {
  3932. "$ref": "#/responses/empty"
  3933. },
  3934. "403": {
  3935. "$ref": "#/responses/forbidden"
  3936. },
  3937. "404": {
  3938. "$ref": "#/responses/notFound"
  3939. }
  3940. }
  3941. },
  3942. "delete": {
  3943. "tags": [
  3944. "issue"
  3945. ],
  3946. "summary": "Delete a comment",
  3947. "operationId": "issueDeleteComment",
  3948. "parameters": [
  3949. {
  3950. "type": "string",
  3951. "description": "owner of the repo",
  3952. "name": "owner",
  3953. "in": "path",
  3954. "required": true
  3955. },
  3956. {
  3957. "type": "string",
  3958. "description": "name of the repo",
  3959. "name": "repo",
  3960. "in": "path",
  3961. "required": true
  3962. },
  3963. {
  3964. "type": "integer",
  3965. "format": "int64",
  3966. "description": "id of comment to delete",
  3967. "name": "id",
  3968. "in": "path",
  3969. "required": true
  3970. }
  3971. ],
  3972. "responses": {
  3973. "204": {
  3974. "$ref": "#/responses/empty"
  3975. },
  3976. "403": {
  3977. "$ref": "#/responses/forbidden"
  3978. },
  3979. "404": {
  3980. "$ref": "#/responses/notFound"
  3981. }
  3982. }
  3983. },
  3984. "patch": {
  3985. "consumes": [
  3986. "application/json"
  3987. ],
  3988. "produces": [
  3989. "application/json"
  3990. ],
  3991. "tags": [
  3992. "issue"
  3993. ],
  3994. "summary": "Edit a comment",
  3995. "operationId": "issueEditComment",
  3996. "parameters": [
  3997. {
  3998. "type": "string",
  3999. "description": "owner of the repo",
  4000. "name": "owner",
  4001. "in": "path",
  4002. "required": true
  4003. },
  4004. {
  4005. "type": "string",
  4006. "description": "name of the repo",
  4007. "name": "repo",
  4008. "in": "path",
  4009. "required": true
  4010. },
  4011. {
  4012. "type": "integer",
  4013. "format": "int64",
  4014. "description": "id of the comment to edit",
  4015. "name": "id",
  4016. "in": "path",
  4017. "required": true
  4018. },
  4019. {
  4020. "name": "body",
  4021. "in": "body",
  4022. "schema": {
  4023. "$ref": "#/definitions/EditIssueCommentOption"
  4024. }
  4025. }
  4026. ],
  4027. "responses": {
  4028. "200": {
  4029. "$ref": "#/responses/Comment"
  4030. },
  4031. "204": {
  4032. "$ref": "#/responses/empty"
  4033. },
  4034. "403": {
  4035. "$ref": "#/responses/forbidden"
  4036. },
  4037. "404": {
  4038. "$ref": "#/responses/notFound"
  4039. }
  4040. }
  4041. }
  4042. },
  4043. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  4044. "get": {
  4045. "consumes": [
  4046. "application/json"
  4047. ],
  4048. "produces": [
  4049. "application/json"
  4050. ],
  4051. "tags": [
  4052. "issue"
  4053. ],
  4054. "summary": "Get a list of reactions from a comment of an issue",
  4055. "operationId": "issueGetCommentReactions",
  4056. "parameters": [
  4057. {
  4058. "type": "string",
  4059. "description": "owner of the repo",
  4060. "name": "owner",
  4061. "in": "path",
  4062. "required": true
  4063. },
  4064. {
  4065. "type": "string",
  4066. "description": "name of the repo",
  4067. "name": "repo",
  4068. "in": "path",
  4069. "required": true
  4070. },
  4071. {
  4072. "type": "integer",
  4073. "format": "int64",
  4074. "description": "id of the comment to edit",
  4075. "name": "id",
  4076. "in": "path",
  4077. "required": true
  4078. }
  4079. ],
  4080. "responses": {
  4081. "200": {
  4082. "$ref": "#/responses/ReactionList"
  4083. },
  4084. "403": {
  4085. "$ref": "#/responses/forbidden"
  4086. }
  4087. }
  4088. },
  4089. "post": {
  4090. "consumes": [
  4091. "application/json"
  4092. ],
  4093. "produces": [
  4094. "application/json"
  4095. ],
  4096. "tags": [
  4097. "issue"
  4098. ],
  4099. "summary": "Add a reaction to a comment of an issue",
  4100. "operationId": "issuePostCommentReaction",
  4101. "parameters": [
  4102. {
  4103. "type": "string",
  4104. "description": "owner of the repo",
  4105. "name": "owner",
  4106. "in": "path",
  4107. "required": true
  4108. },
  4109. {
  4110. "type": "string",
  4111. "description": "name of the repo",
  4112. "name": "repo",
  4113. "in": "path",
  4114. "required": true
  4115. },
  4116. {
  4117. "type": "integer",
  4118. "format": "int64",
  4119. "description": "id of the comment to edit",
  4120. "name": "id",
  4121. "in": "path",
  4122. "required": true
  4123. },
  4124. {
  4125. "name": "content",
  4126. "in": "body",
  4127. "schema": {
  4128. "$ref": "#/definitions/EditReactionOption"
  4129. }
  4130. }
  4131. ],
  4132. "responses": {
  4133. "200": {
  4134. "$ref": "#/responses/Reaction"
  4135. },
  4136. "201": {
  4137. "$ref": "#/responses/Reaction"
  4138. },
  4139. "403": {
  4140. "$ref": "#/responses/forbidden"
  4141. }
  4142. }
  4143. },
  4144. "delete": {
  4145. "consumes": [
  4146. "application/json"
  4147. ],
  4148. "produces": [
  4149. "application/json"
  4150. ],
  4151. "tags": [
  4152. "issue"
  4153. ],
  4154. "summary": "Remove a reaction from a comment of an issue",
  4155. "operationId": "issueDeleteCommentReaction",
  4156. "parameters": [
  4157. {
  4158. "type": "string",
  4159. "description": "owner of the repo",
  4160. "name": "owner",
  4161. "in": "path",
  4162. "required": true
  4163. },
  4164. {
  4165. "type": "string",
  4166. "description": "name of the repo",
  4167. "name": "repo",
  4168. "in": "path",
  4169. "required": true
  4170. },
  4171. {
  4172. "type": "integer",
  4173. "format": "int64",
  4174. "description": "id of the comment to edit",
  4175. "name": "id",
  4176. "in": "path",
  4177. "required": true
  4178. },
  4179. {
  4180. "name": "content",
  4181. "in": "body",
  4182. "schema": {
  4183. "$ref": "#/definitions/EditReactionOption"
  4184. }
  4185. }
  4186. ],
  4187. "responses": {
  4188. "200": {
  4189. "$ref": "#/responses/empty"
  4190. },
  4191. "403": {
  4192. "$ref": "#/responses/forbidden"
  4193. }
  4194. }
  4195. }
  4196. },
  4197. "/repos/{owner}/{repo}/issues/{index}": {
  4198. "get": {
  4199. "produces": [
  4200. "application/json"
  4201. ],
  4202. "tags": [
  4203. "issue"
  4204. ],
  4205. "summary": "Get an issue",
  4206. "operationId": "issueGetIssue",
  4207. "parameters": [
  4208. {
  4209. "type": "string",
  4210. "description": "owner of the repo",
  4211. "name": "owner",
  4212. "in": "path",
  4213. "required": true
  4214. },
  4215. {
  4216. "type": "string",
  4217. "description": "name of the repo",
  4218. "name": "repo",
  4219. "in": "path",
  4220. "required": true
  4221. },
  4222. {
  4223. "type": "integer",
  4224. "format": "int64",
  4225. "description": "index of the issue to get",
  4226. "name": "index",
  4227. "in": "path",
  4228. "required": true
  4229. }
  4230. ],
  4231. "responses": {
  4232. "200": {
  4233. "$ref": "#/responses/Issue"
  4234. },
  4235. "404": {
  4236. "$ref": "#/responses/notFound"
  4237. }
  4238. }
  4239. },
  4240. "patch": {
  4241. "consumes": [
  4242. "application/json"
  4243. ],
  4244. "produces": [
  4245. "application/json"
  4246. ],
  4247. "tags": [
  4248. "issue"
  4249. ],
  4250. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4251. "operationId": "issueEditIssue",
  4252. "parameters": [
  4253. {
  4254. "type": "string",
  4255. "description": "owner of the repo",
  4256. "name": "owner",
  4257. "in": "path",
  4258. "required": true
  4259. },
  4260. {
  4261. "type": "string",
  4262. "description": "name of the repo",
  4263. "name": "repo",
  4264. "in": "path",
  4265. "required": true
  4266. },
  4267. {
  4268. "type": "integer",
  4269. "format": "int64",
  4270. "description": "index of the issue to edit",
  4271. "name": "index",
  4272. "in": "path",
  4273. "required": true
  4274. },
  4275. {
  4276. "name": "body",
  4277. "in": "body",
  4278. "schema": {
  4279. "$ref": "#/definitions/EditIssueOption"
  4280. }
  4281. }
  4282. ],
  4283. "responses": {
  4284. "201": {
  4285. "$ref": "#/responses/Issue"
  4286. },
  4287. "403": {
  4288. "$ref": "#/responses/forbidden"
  4289. },
  4290. "404": {
  4291. "$ref": "#/responses/notFound"
  4292. },
  4293. "412": {
  4294. "$ref": "#/responses/error"
  4295. }
  4296. }
  4297. }
  4298. },
  4299. "/repos/{owner}/{repo}/issues/{index}/comments": {
  4300. "get": {
  4301. "produces": [
  4302. "application/json"
  4303. ],
  4304. "tags": [
  4305. "issue"
  4306. ],
  4307. "summary": "List all comments on an issue",
  4308. "operationId": "issueGetComments",
  4309. "parameters": [
  4310. {
  4311. "type": "string",
  4312. "description": "owner of the repo",
  4313. "name": "owner",
  4314. "in": "path",
  4315. "required": true
  4316. },
  4317. {
  4318. "type": "string",
  4319. "description": "name of the repo",
  4320. "name": "repo",
  4321. "in": "path",
  4322. "required": true
  4323. },
  4324. {
  4325. "type": "integer",
  4326. "format": "int64",
  4327. "description": "index of the issue",
  4328. "name": "index",
  4329. "in": "path",
  4330. "required": true
  4331. },
  4332. {
  4333. "type": "string",
  4334. "format": "date-time",
  4335. "description": "if provided, only comments updated since the specified time are returned.",
  4336. "name": "since",
  4337. "in": "query"
  4338. },
  4339. {
  4340. "type": "string",
  4341. "format": "date-time",
  4342. "description": "if provided, only comments updated before the provided time are returned.",
  4343. "name": "before",
  4344. "in": "query"
  4345. }
  4346. ],
  4347. "responses": {
  4348. "200": {
  4349. "$ref": "#/responses/CommentList"
  4350. }
  4351. }
  4352. },
  4353. "post": {
  4354. "consumes": [
  4355. "application/json"
  4356. ],
  4357. "produces": [
  4358. "application/json"
  4359. ],
  4360. "tags": [
  4361. "issue"
  4362. ],
  4363. "summary": "Add a comment to an issue",
  4364. "operationId": "issueCreateComment",
  4365. "parameters": [
  4366. {
  4367. "type": "string",
  4368. "description": "owner of the repo",
  4369. "name": "owner",
  4370. "in": "path",
  4371. "required": true
  4372. },
  4373. {
  4374. "type": "string",
  4375. "description": "name of the repo",
  4376. "name": "repo",
  4377. "in": "path",
  4378. "required": true
  4379. },
  4380. {
  4381. "type": "integer",
  4382. "format": "int64",
  4383. "description": "index of the issue",
  4384. "name": "index",
  4385. "in": "path",
  4386. "required": true
  4387. },
  4388. {
  4389. "name": "body",
  4390. "in": "body",
  4391. "schema": {
  4392. "$ref": "#/definitions/CreateIssueCommentOption"
  4393. }
  4394. }
  4395. ],
  4396. "responses": {
  4397. "201": {
  4398. "$ref": "#/responses/Comment"
  4399. },
  4400. "403": {
  4401. "$ref": "#/responses/forbidden"
  4402. }
  4403. }
  4404. }
  4405. },
  4406. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  4407. "delete": {
  4408. "tags": [
  4409. "issue"
  4410. ],
  4411. "summary": "Delete a comment",
  4412. "operationId": "issueDeleteCommentDeprecated",
  4413. "deprecated": true,
  4414. "parameters": [
  4415. {
  4416. "type": "string",
  4417. "description": "owner of the repo",
  4418. "name": "owner",
  4419. "in": "path",
  4420. "required": true
  4421. },
  4422. {
  4423. "type": "string",
  4424. "description": "name of the repo",
  4425. "name": "repo",
  4426. "in": "path",
  4427. "required": true
  4428. },
  4429. {
  4430. "type": "integer",
  4431. "description": "this parameter is ignored",
  4432. "name": "index",
  4433. "in": "path",
  4434. "required": true
  4435. },
  4436. {
  4437. "type": "integer",
  4438. "format": "int64",
  4439. "description": "id of comment to delete",
  4440. "name": "id",
  4441. "in": "path",
  4442. "required": true
  4443. }
  4444. ],
  4445. "responses": {
  4446. "204": {
  4447. "$ref": "#/responses/empty"
  4448. },
  4449. "403": {
  4450. "$ref": "#/responses/forbidden"
  4451. },
  4452. "404": {
  4453. "$ref": "#/responses/notFound"
  4454. }
  4455. }
  4456. },
  4457. "patch": {
  4458. "consumes": [
  4459. "application/json"
  4460. ],
  4461. "produces": [
  4462. "application/json"
  4463. ],
  4464. "tags": [
  4465. "issue"
  4466. ],
  4467. "summary": "Edit a comment",
  4468. "operationId": "issueEditCommentDeprecated",
  4469. "deprecated": true,
  4470. "parameters": [
  4471. {
  4472. "type": "string",
  4473. "description": "owner of the repo",
  4474. "name": "owner",
  4475. "in": "path",
  4476. "required": true
  4477. },
  4478. {
  4479. "type": "string",
  4480. "description": "name of the repo",
  4481. "name": "repo",
  4482. "in": "path",
  4483. "required": true
  4484. },
  4485. {
  4486. "type": "integer",
  4487. "description": "this parameter is ignored",
  4488. "name": "index",
  4489. "in": "path",
  4490. "required": true
  4491. },
  4492. {
  4493. "type": "integer",
  4494. "format": "int64",
  4495. "description": "id of the comment to edit",
  4496. "name": "id",
  4497. "in": "path",
  4498. "required": true
  4499. },
  4500. {
  4501. "name": "body",
  4502. "in": "body",
  4503. "schema": {
  4504. "$ref": "#/definitions/EditIssueCommentOption"
  4505. }
  4506. }
  4507. ],
  4508. "responses": {
  4509. "200": {
  4510. "$ref": "#/responses/Comment"
  4511. },
  4512. "204": {
  4513. "$ref": "#/responses/empty"
  4514. },
  4515. "403": {
  4516. "$ref": "#/responses/forbidden"
  4517. },
  4518. "404": {
  4519. "$ref": "#/responses/notFound"
  4520. }
  4521. }
  4522. }
  4523. },
  4524. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4525. "post": {
  4526. "consumes": [
  4527. "application/json"
  4528. ],
  4529. "produces": [
  4530. "application/json"
  4531. ],
  4532. "tags": [
  4533. "issue"
  4534. ],
  4535. "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.",
  4536. "operationId": "issueEditIssueDeadline",
  4537. "parameters": [
  4538. {
  4539. "type": "string",
  4540. "description": "owner of the repo",
  4541. "name": "owner",
  4542. "in": "path",
  4543. "required": true
  4544. },
  4545. {
  4546. "type": "string",
  4547. "description": "name of the repo",
  4548. "name": "repo",
  4549. "in": "path",
  4550. "required": true
  4551. },
  4552. {
  4553. "type": "integer",
  4554. "format": "int64",
  4555. "description": "index of the issue to create or update a deadline on",
  4556. "name": "index",
  4557. "in": "path",
  4558. "required": true
  4559. },
  4560. {
  4561. "name": "body",
  4562. "in": "body",
  4563. "schema": {
  4564. "$ref": "#/definitions/EditDeadlineOption"
  4565. }
  4566. }
  4567. ],
  4568. "responses": {
  4569. "201": {
  4570. "$ref": "#/responses/IssueDeadline"
  4571. },
  4572. "403": {
  4573. "$ref": "#/responses/forbidden"
  4574. },
  4575. "404": {
  4576. "$ref": "#/responses/notFound"
  4577. }
  4578. }
  4579. }
  4580. },
  4581. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4582. "get": {
  4583. "produces": [
  4584. "application/json"
  4585. ],
  4586. "tags": [
  4587. "issue"
  4588. ],
  4589. "summary": "Get an issue's labels",
  4590. "operationId": "issueGetLabels",
  4591. "parameters": [
  4592. {
  4593. "type": "string",
  4594. "description": "owner of the repo",
  4595. "name": "owner",
  4596. "in": "path",
  4597. "required": true
  4598. },
  4599. {
  4600. "type": "string",
  4601. "description": "name of the repo",
  4602. "name": "repo",
  4603. "in": "path",
  4604. "required": true
  4605. },
  4606. {
  4607. "type": "integer",
  4608. "format": "int64",
  4609. "description": "index of the issue",
  4610. "name": "index",
  4611. "in": "path",
  4612. "required": true
  4613. }
  4614. ],
  4615. "responses": {
  4616. "200": {
  4617. "$ref": "#/responses/LabelList"
  4618. },
  4619. "404": {
  4620. "$ref": "#/responses/notFound"
  4621. }
  4622. }
  4623. },
  4624. "put": {
  4625. "consumes": [
  4626. "application/json"
  4627. ],
  4628. "produces": [
  4629. "application/json"
  4630. ],
  4631. "tags": [
  4632. "issue"
  4633. ],
  4634. "summary": "Replace an issue's labels",
  4635. "operationId": "issueReplaceLabels",
  4636. "parameters": [
  4637. {
  4638. "type": "string",
  4639. "description": "owner of the repo",
  4640. "name": "owner",
  4641. "in": "path",
  4642. "required": true
  4643. },
  4644. {
  4645. "type": "string",
  4646. "description": "name of the repo",
  4647. "name": "repo",
  4648. "in": "path",
  4649. "required": true
  4650. },
  4651. {
  4652. "type": "integer",
  4653. "format": "int64",
  4654. "description": "index of the issue",
  4655. "name": "index",
  4656. "in": "path",
  4657. "required": true
  4658. },
  4659. {
  4660. "name": "body",
  4661. "in": "body",
  4662. "schema": {
  4663. "$ref": "#/definitions/IssueLabelsOption"
  4664. }
  4665. }
  4666. ],
  4667. "responses": {
  4668. "200": {
  4669. "$ref": "#/responses/LabelList"
  4670. },
  4671. "403": {
  4672. "$ref": "#/responses/forbidden"
  4673. }
  4674. }
  4675. },
  4676. "post": {
  4677. "consumes": [
  4678. "application/json"
  4679. ],
  4680. "produces": [
  4681. "application/json"
  4682. ],
  4683. "tags": [
  4684. "issue"
  4685. ],
  4686. "summary": "Add a label to an issue",
  4687. "operationId": "issueAddLabel",
  4688. "parameters": [
  4689. {
  4690. "type": "string",
  4691. "description": "owner of the repo",
  4692. "name": "owner",
  4693. "in": "path",
  4694. "required": true
  4695. },
  4696. {
  4697. "type": "string",
  4698. "description": "name of the repo",
  4699. "name": "repo",
  4700. "in": "path",
  4701. "required": true
  4702. },
  4703. {
  4704. "type": "integer",
  4705. "format": "int64",
  4706. "description": "index of the issue",
  4707. "name": "index",
  4708. "in": "path",
  4709. "required": true
  4710. },
  4711. {
  4712. "name": "body",
  4713. "in": "body",
  4714. "schema": {
  4715. "$ref": "#/definitions/IssueLabelsOption"
  4716. }
  4717. }
  4718. ],
  4719. "responses": {
  4720. "200": {
  4721. "$ref": "#/responses/LabelList"
  4722. },
  4723. "403": {
  4724. "$ref": "#/responses/forbidden"
  4725. }
  4726. }
  4727. },
  4728. "delete": {
  4729. "produces": [
  4730. "application/json"
  4731. ],
  4732. "tags": [
  4733. "issue"
  4734. ],
  4735. "summary": "Remove all labels from an issue",
  4736. "operationId": "issueClearLabels",
  4737. "parameters": [
  4738. {
  4739. "type": "string",
  4740. "description": "owner of the repo",
  4741. "name": "owner",
  4742. "in": "path",
  4743. "required": true
  4744. },
  4745. {
  4746. "type": "string",
  4747. "description": "name of the repo",
  4748. "name": "repo",
  4749. "in": "path",
  4750. "required": true
  4751. },
  4752. {
  4753. "type": "integer",
  4754. "format": "int64",
  4755. "description": "index of the issue",
  4756. "name": "index",
  4757. "in": "path",
  4758. "required": true
  4759. }
  4760. ],
  4761. "responses": {
  4762. "204": {
  4763. "$ref": "#/responses/empty"
  4764. },
  4765. "403": {
  4766. "$ref": "#/responses/forbidden"
  4767. }
  4768. }
  4769. }
  4770. },
  4771. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4772. "delete": {
  4773. "produces": [
  4774. "application/json"
  4775. ],
  4776. "tags": [
  4777. "issue"
  4778. ],
  4779. "summary": "Remove a label from an issue",
  4780. "operationId": "issueRemoveLabel",
  4781. "parameters": [
  4782. {
  4783. "type": "string",
  4784. "description": "owner of the repo",
  4785. "name": "owner",
  4786. "in": "path",
  4787. "required": true
  4788. },
  4789. {
  4790. "type": "string",
  4791. "description": "name of the repo",
  4792. "name": "repo",
  4793. "in": "path",
  4794. "required": true
  4795. },
  4796. {
  4797. "type": "integer",
  4798. "format": "int64",
  4799. "description": "index of the issue",
  4800. "name": "index",
  4801. "in": "path",
  4802. "required": true
  4803. },
  4804. {
  4805. "type": "integer",
  4806. "format": "int64",
  4807. "description": "id of the label to remove",
  4808. "name": "id",
  4809. "in": "path",
  4810. "required": true
  4811. }
  4812. ],
  4813. "responses": {
  4814. "204": {
  4815. "$ref": "#/responses/empty"
  4816. },
  4817. "403": {
  4818. "$ref": "#/responses/forbidden"
  4819. },
  4820. "422": {
  4821. "$ref": "#/responses/validationError"
  4822. }
  4823. }
  4824. }
  4825. },
  4826. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4827. "get": {
  4828. "consumes": [
  4829. "application/json"
  4830. ],
  4831. "produces": [
  4832. "application/json"
  4833. ],
  4834. "tags": [
  4835. "issue"
  4836. ],
  4837. "summary": "Get a list reactions of an issue",
  4838. "operationId": "issueGetIssueReactions",
  4839. "parameters": [
  4840. {
  4841. "type": "string",
  4842. "description": "owner of the repo",
  4843. "name": "owner",
  4844. "in": "path",
  4845. "required": true
  4846. },
  4847. {
  4848. "type": "string",
  4849. "description": "name of the repo",
  4850. "name": "repo",
  4851. "in": "path",
  4852. "required": true
  4853. },
  4854. {
  4855. "type": "integer",
  4856. "format": "int64",
  4857. "description": "index of the issue",
  4858. "name": "index",
  4859. "in": "path",
  4860. "required": true
  4861. },
  4862. {
  4863. "type": "integer",
  4864. "description": "page number of results to return (1-based)",
  4865. "name": "page",
  4866. "in": "query"
  4867. },
  4868. {
  4869. "type": "integer",
  4870. "description": "page size of results, maximum page size is 50",
  4871. "name": "limit",
  4872. "in": "query"
  4873. }
  4874. ],
  4875. "responses": {
  4876. "200": {
  4877. "$ref": "#/responses/ReactionList"
  4878. },
  4879. "403": {
  4880. "$ref": "#/responses/forbidden"
  4881. }
  4882. }
  4883. },
  4884. "post": {
  4885. "consumes": [
  4886. "application/json"
  4887. ],
  4888. "produces": [
  4889. "application/json"
  4890. ],
  4891. "tags": [
  4892. "issue"
  4893. ],
  4894. "summary": "Add a reaction to an issue",
  4895. "operationId": "issuePostIssueReaction",
  4896. "parameters": [
  4897. {
  4898. "type": "string",
  4899. "description": "owner of the repo",
  4900. "name": "owner",
  4901. "in": "path",
  4902. "required": true
  4903. },
  4904. {
  4905. "type": "string",
  4906. "description": "name of the repo",
  4907. "name": "repo",
  4908. "in": "path",
  4909. "required": true
  4910. },
  4911. {
  4912. "type": "integer",
  4913. "format": "int64",
  4914. "description": "index of the issue",
  4915. "name": "index",
  4916. "in": "path",
  4917. "required": true
  4918. },
  4919. {
  4920. "name": "content",
  4921. "in": "body",
  4922. "schema": {
  4923. "$ref": "#/definitions/EditReactionOption"
  4924. }
  4925. }
  4926. ],
  4927. "responses": {
  4928. "200": {
  4929. "$ref": "#/responses/Reaction"
  4930. },
  4931. "201": {
  4932. "$ref": "#/responses/Reaction"
  4933. },
  4934. "403": {
  4935. "$ref": "#/responses/forbidden"
  4936. }
  4937. }
  4938. },
  4939. "delete": {
  4940. "consumes": [
  4941. "application/json"
  4942. ],
  4943. "produces": [
  4944. "application/json"
  4945. ],
  4946. "tags": [
  4947. "issue"
  4948. ],
  4949. "summary": "Remove a reaction from an issue",
  4950. "operationId": "issueDeleteIssueReaction",
  4951. "parameters": [
  4952. {
  4953. "type": "string",
  4954. "description": "owner of the repo",
  4955. "name": "owner",
  4956. "in": "path",
  4957. "required": true
  4958. },
  4959. {
  4960. "type": "string",
  4961. "description": "name of the repo",
  4962. "name": "repo",
  4963. "in": "path",
  4964. "required": true
  4965. },
  4966. {
  4967. "type": "integer",
  4968. "format": "int64",
  4969. "description": "index of the issue",
  4970. "name": "index",
  4971. "in": "path",
  4972. "required": true
  4973. },
  4974. {
  4975. "name": "content",
  4976. "in": "body",
  4977. "schema": {
  4978. "$ref": "#/definitions/EditReactionOption"
  4979. }
  4980. }
  4981. ],
  4982. "responses": {
  4983. "200": {
  4984. "$ref": "#/responses/empty"
  4985. },
  4986. "403": {
  4987. "$ref": "#/responses/forbidden"
  4988. }
  4989. }
  4990. }
  4991. },
  4992. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  4993. "delete": {
  4994. "consumes": [
  4995. "application/json"
  4996. ],
  4997. "produces": [
  4998. "application/json"
  4999. ],
  5000. "tags": [
  5001. "issue"
  5002. ],
  5003. "summary": "Delete an issue's existing stopwatch.",
  5004. "operationId": "issueDeleteStopWatch",
  5005. "parameters": [
  5006. {
  5007. "type": "string",
  5008. "description": "owner of the repo",
  5009. "name": "owner",
  5010. "in": "path",
  5011. "required": true
  5012. },
  5013. {
  5014. "type": "string",
  5015. "description": "name of the repo",
  5016. "name": "repo",
  5017. "in": "path",
  5018. "required": true
  5019. },
  5020. {
  5021. "type": "integer",
  5022. "format": "int64",
  5023. "description": "index of the issue to stop the stopwatch on",
  5024. "name": "index",
  5025. "in": "path",
  5026. "required": true
  5027. }
  5028. ],
  5029. "responses": {
  5030. "204": {
  5031. "$ref": "#/responses/empty"
  5032. },
  5033. "403": {
  5034. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5035. },
  5036. "404": {
  5037. "$ref": "#/responses/notFound"
  5038. },
  5039. "409": {
  5040. "description": "Cannot cancel a non existent stopwatch"
  5041. }
  5042. }
  5043. }
  5044. },
  5045. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  5046. "post": {
  5047. "consumes": [
  5048. "application/json"
  5049. ],
  5050. "produces": [
  5051. "application/json"
  5052. ],
  5053. "tags": [
  5054. "issue"
  5055. ],
  5056. "summary": "Start stopwatch on an issue.",
  5057. "operationId": "issueStartStopWatch",
  5058. "parameters": [
  5059. {
  5060. "type": "string",
  5061. "description": "owner of the repo",
  5062. "name": "owner",
  5063. "in": "path",
  5064. "required": true
  5065. },
  5066. {
  5067. "type": "string",
  5068. "description": "name of the repo",
  5069. "name": "repo",
  5070. "in": "path",
  5071. "required": true
  5072. },
  5073. {
  5074. "type": "integer",
  5075. "format": "int64",
  5076. "description": "index of the issue to create the stopwatch on",
  5077. "name": "index",
  5078. "in": "path",
  5079. "required": true
  5080. }
  5081. ],
  5082. "responses": {
  5083. "201": {
  5084. "$ref": "#/responses/empty"
  5085. },
  5086. "403": {
  5087. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5088. },
  5089. "404": {
  5090. "$ref": "#/responses/notFound"
  5091. },
  5092. "409": {
  5093. "description": "Cannot start a stopwatch again if it already exists"
  5094. }
  5095. }
  5096. }
  5097. },
  5098. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  5099. "post": {
  5100. "consumes": [
  5101. "application/json"
  5102. ],
  5103. "produces": [
  5104. "application/json"
  5105. ],
  5106. "tags": [
  5107. "issue"
  5108. ],
  5109. "summary": "Stop an issue's existing stopwatch.",
  5110. "operationId": "issueStopStopWatch",
  5111. "parameters": [
  5112. {
  5113. "type": "string",
  5114. "description": "owner of the repo",
  5115. "name": "owner",
  5116. "in": "path",
  5117. "required": true
  5118. },
  5119. {
  5120. "type": "string",
  5121. "description": "name of the repo",
  5122. "name": "repo",
  5123. "in": "path",
  5124. "required": true
  5125. },
  5126. {
  5127. "type": "integer",
  5128. "format": "int64",
  5129. "description": "index of the issue to stop the stopwatch on",
  5130. "name": "index",
  5131. "in": "path",
  5132. "required": true
  5133. }
  5134. ],
  5135. "responses": {
  5136. "201": {
  5137. "$ref": "#/responses/empty"
  5138. },
  5139. "403": {
  5140. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5141. },
  5142. "404": {
  5143. "$ref": "#/responses/notFound"
  5144. },
  5145. "409": {
  5146. "description": "Cannot stop a non existent stopwatch"
  5147. }
  5148. }
  5149. }
  5150. },
  5151. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  5152. "get": {
  5153. "consumes": [
  5154. "application/json"
  5155. ],
  5156. "produces": [
  5157. "application/json"
  5158. ],
  5159. "tags": [
  5160. "issue"
  5161. ],
  5162. "summary": "Get users who subscribed on an issue.",
  5163. "operationId": "issueSubscriptions",
  5164. "parameters": [
  5165. {
  5166. "type": "string",
  5167. "description": "owner of the repo",
  5168. "name": "owner",
  5169. "in": "path",
  5170. "required": true
  5171. },
  5172. {
  5173. "type": "string",
  5174. "description": "name of the repo",
  5175. "name": "repo",
  5176. "in": "path",
  5177. "required": true
  5178. },
  5179. {
  5180. "type": "integer",
  5181. "format": "int64",
  5182. "description": "index of the issue",
  5183. "name": "index",
  5184. "in": "path",
  5185. "required": true
  5186. },
  5187. {
  5188. "type": "integer",
  5189. "description": "page number of results to return (1-based)",
  5190. "name": "page",
  5191. "in": "query"
  5192. },
  5193. {
  5194. "type": "integer",
  5195. "description": "page size of results, maximum page size is 50",
  5196. "name": "limit",
  5197. "in": "query"
  5198. }
  5199. ],
  5200. "responses": {
  5201. "200": {
  5202. "$ref": "#/responses/UserList"
  5203. },
  5204. "404": {
  5205. "$ref": "#/responses/notFound"
  5206. }
  5207. }
  5208. }
  5209. },
  5210. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  5211. "get": {
  5212. "consumes": [
  5213. "application/json"
  5214. ],
  5215. "produces": [
  5216. "application/json"
  5217. ],
  5218. "tags": [
  5219. "issue"
  5220. ],
  5221. "summary": "Check if user is subscribed to an issue",
  5222. "operationId": "issueCheckSubscription",
  5223. "parameters": [
  5224. {
  5225. "type": "string",
  5226. "description": "owner of the repo",
  5227. "name": "owner",
  5228. "in": "path",
  5229. "required": true
  5230. },
  5231. {
  5232. "type": "string",
  5233. "description": "name of the repo",
  5234. "name": "repo",
  5235. "in": "path",
  5236. "required": true
  5237. },
  5238. {
  5239. "type": "integer",
  5240. "format": "int64",
  5241. "description": "index of the issue",
  5242. "name": "index",
  5243. "in": "path",
  5244. "required": true
  5245. }
  5246. ],
  5247. "responses": {
  5248. "200": {
  5249. "$ref": "#/responses/WatchInfo"
  5250. },
  5251. "404": {
  5252. "$ref": "#/responses/notFound"
  5253. }
  5254. }
  5255. }
  5256. },
  5257. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  5258. "put": {
  5259. "consumes": [
  5260. "application/json"
  5261. ],
  5262. "produces": [
  5263. "application/json"
  5264. ],
  5265. "tags": [
  5266. "issue"
  5267. ],
  5268. "summary": "Subscribe user to issue",
  5269. "operationId": "issueAddSubscription",
  5270. "parameters": [
  5271. {
  5272. "type": "string",
  5273. "description": "owner of the repo",
  5274. "name": "owner",
  5275. "in": "path",
  5276. "required": true
  5277. },
  5278. {
  5279. "type": "string",
  5280. "description": "name of the repo",
  5281. "name": "repo",
  5282. "in": "path",
  5283. "required": true
  5284. },
  5285. {
  5286. "type": "integer",
  5287. "format": "int64",
  5288. "description": "index of the issue",
  5289. "name": "index",
  5290. "in": "path",
  5291. "required": true
  5292. },
  5293. {
  5294. "type": "string",
  5295. "description": "user to subscribe",
  5296. "name": "user",
  5297. "in": "path",
  5298. "required": true
  5299. }
  5300. ],
  5301. "responses": {
  5302. "200": {
  5303. "description": "Already subscribed"
  5304. },
  5305. "201": {
  5306. "description": "Successfully Subscribed"
  5307. },
  5308. "304": {
  5309. "description": "User can only subscribe itself if he is no admin"
  5310. },
  5311. "404": {
  5312. "$ref": "#/responses/notFound"
  5313. }
  5314. }
  5315. },
  5316. "delete": {
  5317. "consumes": [
  5318. "application/json"
  5319. ],
  5320. "produces": [
  5321. "application/json"
  5322. ],
  5323. "tags": [
  5324. "issue"
  5325. ],
  5326. "summary": "Unsubscribe user from issue",
  5327. "operationId": "issueDeleteSubscription",
  5328. "parameters": [
  5329. {
  5330. "type": "string",
  5331. "description": "owner of the repo",
  5332. "name": "owner",
  5333. "in": "path",
  5334. "required": true
  5335. },
  5336. {
  5337. "type": "string",
  5338. "description": "name of the repo",
  5339. "name": "repo",
  5340. "in": "path",
  5341. "required": true
  5342. },
  5343. {
  5344. "type": "integer",
  5345. "format": "int64",
  5346. "description": "index of the issue",
  5347. "name": "index",
  5348. "in": "path",
  5349. "required": true
  5350. },
  5351. {
  5352. "type": "string",
  5353. "description": "user witch unsubscribe",
  5354. "name": "user",
  5355. "in": "path",
  5356. "required": true
  5357. }
  5358. ],
  5359. "responses": {
  5360. "200": {
  5361. "description": "Already unsubscribed"
  5362. },
  5363. "201": {
  5364. "description": "Successfully Unsubscribed"
  5365. },
  5366. "304": {
  5367. "description": "User can only subscribe itself if he is no admin"
  5368. },
  5369. "404": {
  5370. "$ref": "#/responses/notFound"
  5371. }
  5372. }
  5373. }
  5374. },
  5375. "/repos/{owner}/{repo}/issues/{index}/times": {
  5376. "get": {
  5377. "produces": [
  5378. "application/json"
  5379. ],
  5380. "tags": [
  5381. "issue"
  5382. ],
  5383. "summary": "List an issue's tracked times",
  5384. "operationId": "issueTrackedTimes",
  5385. "parameters": [
  5386. {
  5387. "type": "string",
  5388. "description": "owner of the repo",
  5389. "name": "owner",
  5390. "in": "path",
  5391. "required": true
  5392. },
  5393. {
  5394. "type": "string",
  5395. "description": "name of the repo",
  5396. "name": "repo",
  5397. "in": "path",
  5398. "required": true
  5399. },
  5400. {
  5401. "type": "integer",
  5402. "format": "int64",
  5403. "description": "index of the issue",
  5404. "name": "index",
  5405. "in": "path",
  5406. "required": true
  5407. },
  5408. {
  5409. "type": "string",
  5410. "format": "date-time",
  5411. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  5412. "name": "since",
  5413. "in": "query"
  5414. },
  5415. {
  5416. "type": "string",
  5417. "format": "date-time",
  5418. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  5419. "name": "before",
  5420. "in": "query"
  5421. },
  5422. {
  5423. "type": "integer",
  5424. "description": "page number of results to return (1-based)",
  5425. "name": "page",
  5426. "in": "query"
  5427. },
  5428. {
  5429. "type": "integer",
  5430. "description": "page size of results, maximum page size is 50",
  5431. "name": "limit",
  5432. "in": "query"
  5433. }
  5434. ],
  5435. "responses": {
  5436. "200": {
  5437. "$ref": "#/responses/TrackedTimeList"
  5438. },
  5439. "404": {
  5440. "$ref": "#/responses/notFound"
  5441. }
  5442. }
  5443. },
  5444. "post": {
  5445. "consumes": [
  5446. "application/json"
  5447. ],
  5448. "produces": [
  5449. "application/json"
  5450. ],
  5451. "tags": [
  5452. "issue"
  5453. ],
  5454. "summary": "Add tracked time to a issue",
  5455. "operationId": "issueAddTime",
  5456. "parameters": [
  5457. {
  5458. "type": "string",
  5459. "description": "owner of the repo",
  5460. "name": "owner",
  5461. "in": "path",
  5462. "required": true
  5463. },
  5464. {
  5465. "type": "string",
  5466. "description": "name of the repo",
  5467. "name": "repo",
  5468. "in": "path",
  5469. "required": true
  5470. },
  5471. {
  5472. "type": "integer",
  5473. "format": "int64",
  5474. "description": "index of the issue",
  5475. "name": "index",
  5476. "in": "path",
  5477. "required": true
  5478. },
  5479. {
  5480. "name": "body",
  5481. "in": "body",
  5482. "schema": {
  5483. "$ref": "#/definitions/AddTimeOption"
  5484. }
  5485. }
  5486. ],
  5487. "responses": {
  5488. "200": {
  5489. "$ref": "#/responses/TrackedTime"
  5490. },
  5491. "400": {
  5492. "$ref": "#/responses/error"
  5493. },
  5494. "403": {
  5495. "$ref": "#/responses/forbidden"
  5496. }
  5497. }
  5498. },
  5499. "delete": {
  5500. "consumes": [
  5501. "application/json"
  5502. ],
  5503. "produces": [
  5504. "application/json"
  5505. ],
  5506. "tags": [
  5507. "issue"
  5508. ],
  5509. "summary": "Reset a tracked time of an issue",
  5510. "operationId": "issueResetTime",
  5511. "parameters": [
  5512. {
  5513. "type": "string",
  5514. "description": "owner of the repo",
  5515. "name": "owner",
  5516. "in": "path",
  5517. "required": true
  5518. },
  5519. {
  5520. "type": "string",
  5521. "description": "name of the repo",
  5522. "name": "repo",
  5523. "in": "path",
  5524. "required": true
  5525. },
  5526. {
  5527. "type": "integer",
  5528. "format": "int64",
  5529. "description": "index of the issue to add tracked time to",
  5530. "name": "index",
  5531. "in": "path",
  5532. "required": true
  5533. }
  5534. ],
  5535. "responses": {
  5536. "204": {
  5537. "$ref": "#/responses/empty"
  5538. },
  5539. "400": {
  5540. "$ref": "#/responses/error"
  5541. },
  5542. "403": {
  5543. "$ref": "#/responses/forbidden"
  5544. }
  5545. }
  5546. }
  5547. },
  5548. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5549. "delete": {
  5550. "consumes": [
  5551. "application/json"
  5552. ],
  5553. "produces": [
  5554. "application/json"
  5555. ],
  5556. "tags": [
  5557. "issue"
  5558. ],
  5559. "summary": "Delete specific tracked time",
  5560. "operationId": "issueDeleteTime",
  5561. "parameters": [
  5562. {
  5563. "type": "string",
  5564. "description": "owner of the repo",
  5565. "name": "owner",
  5566. "in": "path",
  5567. "required": true
  5568. },
  5569. {
  5570. "type": "string",
  5571. "description": "name of the repo",
  5572. "name": "repo",
  5573. "in": "path",
  5574. "required": true
  5575. },
  5576. {
  5577. "type": "integer",
  5578. "format": "int64",
  5579. "description": "index of the issue",
  5580. "name": "index",
  5581. "in": "path",
  5582. "required": true
  5583. },
  5584. {
  5585. "type": "integer",
  5586. "format": "int64",
  5587. "description": "id of time to delete",
  5588. "name": "id",
  5589. "in": "path",
  5590. "required": true
  5591. }
  5592. ],
  5593. "responses": {
  5594. "204": {
  5595. "$ref": "#/responses/empty"
  5596. },
  5597. "400": {
  5598. "$ref": "#/responses/error"
  5599. },
  5600. "403": {
  5601. "$ref": "#/responses/forbidden"
  5602. }
  5603. }
  5604. }
  5605. },
  5606. "/repos/{owner}/{repo}/keys": {
  5607. "get": {
  5608. "produces": [
  5609. "application/json"
  5610. ],
  5611. "tags": [
  5612. "repository"
  5613. ],
  5614. "summary": "List a repository's keys",
  5615. "operationId": "repoListKeys",
  5616. "parameters": [
  5617. {
  5618. "type": "string",
  5619. "description": "owner of the repo",
  5620. "name": "owner",
  5621. "in": "path",
  5622. "required": true
  5623. },
  5624. {
  5625. "type": "string",
  5626. "description": "name of the repo",
  5627. "name": "repo",
  5628. "in": "path",
  5629. "required": true
  5630. },
  5631. {
  5632. "type": "integer",
  5633. "description": "the key_id to search for",
  5634. "name": "key_id",
  5635. "in": "query"
  5636. },
  5637. {
  5638. "type": "string",
  5639. "description": "fingerprint of the key",
  5640. "name": "fingerprint",
  5641. "in": "query"
  5642. },
  5643. {
  5644. "type": "integer",
  5645. "description": "page number of results to return (1-based)",
  5646. "name": "page",
  5647. "in": "query"
  5648. },
  5649. {
  5650. "type": "integer",
  5651. "description": "page size of results, maximum page size is 50",
  5652. "name": "limit",
  5653. "in": "query"
  5654. }
  5655. ],
  5656. "responses": {
  5657. "200": {
  5658. "$ref": "#/responses/DeployKeyList"
  5659. }
  5660. }
  5661. },
  5662. "post": {
  5663. "consumes": [
  5664. "application/json"
  5665. ],
  5666. "produces": [
  5667. "application/json"
  5668. ],
  5669. "tags": [
  5670. "repository"
  5671. ],
  5672. "summary": "Add a key to a repository",
  5673. "operationId": "repoCreateKey",
  5674. "parameters": [
  5675. {
  5676. "type": "string",
  5677. "description": "owner of the repo",
  5678. "name": "owner",
  5679. "in": "path",
  5680. "required": true
  5681. },
  5682. {
  5683. "type": "string",
  5684. "description": "name of the repo",
  5685. "name": "repo",
  5686. "in": "path",
  5687. "required": true
  5688. },
  5689. {
  5690. "name": "body",
  5691. "in": "body",
  5692. "schema": {
  5693. "$ref": "#/definitions/CreateKeyOption"
  5694. }
  5695. }
  5696. ],
  5697. "responses": {
  5698. "201": {
  5699. "$ref": "#/responses/DeployKey"
  5700. },
  5701. "422": {
  5702. "$ref": "#/responses/validationError"
  5703. }
  5704. }
  5705. }
  5706. },
  5707. "/repos/{owner}/{repo}/keys/{id}": {
  5708. "get": {
  5709. "produces": [
  5710. "application/json"
  5711. ],
  5712. "tags": [
  5713. "repository"
  5714. ],
  5715. "summary": "Get a repository's key by id",
  5716. "operationId": "repoGetKey",
  5717. "parameters": [
  5718. {
  5719. "type": "string",
  5720. "description": "owner of the repo",
  5721. "name": "owner",
  5722. "in": "path",
  5723. "required": true
  5724. },
  5725. {
  5726. "type": "string",
  5727. "description": "name of the repo",
  5728. "name": "repo",
  5729. "in": "path",
  5730. "required": true
  5731. },
  5732. {
  5733. "type": "integer",
  5734. "format": "int64",
  5735. "description": "id of the key to get",
  5736. "name": "id",
  5737. "in": "path",
  5738. "required": true
  5739. }
  5740. ],
  5741. "responses": {
  5742. "200": {
  5743. "$ref": "#/responses/DeployKey"
  5744. }
  5745. }
  5746. },
  5747. "delete": {
  5748. "tags": [
  5749. "repository"
  5750. ],
  5751. "summary": "Delete a key from a repository",
  5752. "operationId": "repoDeleteKey",
  5753. "parameters": [
  5754. {
  5755. "type": "string",
  5756. "description": "owner of the repo",
  5757. "name": "owner",
  5758. "in": "path",
  5759. "required": true
  5760. },
  5761. {
  5762. "type": "string",
  5763. "description": "name of the repo",
  5764. "name": "repo",
  5765. "in": "path",
  5766. "required": true
  5767. },
  5768. {
  5769. "type": "integer",
  5770. "format": "int64",
  5771. "description": "id of the key to delete",
  5772. "name": "id",
  5773. "in": "path",
  5774. "required": true
  5775. }
  5776. ],
  5777. "responses": {
  5778. "204": {
  5779. "$ref": "#/responses/empty"
  5780. },
  5781. "403": {
  5782. "$ref": "#/responses/forbidden"
  5783. }
  5784. }
  5785. }
  5786. },
  5787. "/repos/{owner}/{repo}/labels": {
  5788. "get": {
  5789. "produces": [
  5790. "application/json"
  5791. ],
  5792. "tags": [
  5793. "issue"
  5794. ],
  5795. "summary": "Get all of a repository's labels",
  5796. "operationId": "issueListLabels",
  5797. "parameters": [
  5798. {
  5799. "type": "string",
  5800. "description": "owner of the repo",
  5801. "name": "owner",
  5802. "in": "path",
  5803. "required": true
  5804. },
  5805. {
  5806. "type": "string",
  5807. "description": "name of the repo",
  5808. "name": "repo",
  5809. "in": "path",
  5810. "required": true
  5811. },
  5812. {
  5813. "type": "integer",
  5814. "description": "page number of results to return (1-based)",
  5815. "name": "page",
  5816. "in": "query"
  5817. },
  5818. {
  5819. "type": "integer",
  5820. "description": "page size of results, maximum page size is 50",
  5821. "name": "limit",
  5822. "in": "query"
  5823. }
  5824. ],
  5825. "responses": {
  5826. "200": {
  5827. "$ref": "#/responses/LabelList"
  5828. }
  5829. }
  5830. },
  5831. "post": {
  5832. "consumes": [
  5833. "application/json"
  5834. ],
  5835. "produces": [
  5836. "application/json"
  5837. ],
  5838. "tags": [
  5839. "issue"
  5840. ],
  5841. "summary": "Create a label",
  5842. "operationId": "issueCreateLabel",
  5843. "parameters": [
  5844. {
  5845. "type": "string",
  5846. "description": "owner of the repo",
  5847. "name": "owner",
  5848. "in": "path",
  5849. "required": true
  5850. },
  5851. {
  5852. "type": "string",
  5853. "description": "name of the repo",
  5854. "name": "repo",
  5855. "in": "path",
  5856. "required": true
  5857. },
  5858. {
  5859. "name": "body",
  5860. "in": "body",
  5861. "schema": {
  5862. "$ref": "#/definitions/CreateLabelOption"
  5863. }
  5864. }
  5865. ],
  5866. "responses": {
  5867. "201": {
  5868. "$ref": "#/responses/Label"
  5869. },
  5870. "422": {
  5871. "$ref": "#/responses/validationError"
  5872. }
  5873. }
  5874. }
  5875. },
  5876. "/repos/{owner}/{repo}/labels/{id}": {
  5877. "get": {
  5878. "produces": [
  5879. "application/json"
  5880. ],
  5881. "tags": [
  5882. "issue"
  5883. ],
  5884. "summary": "Get a single label",
  5885. "operationId": "issueGetLabel",
  5886. "parameters": [
  5887. {
  5888. "type": "string",
  5889. "description": "owner of the repo",
  5890. "name": "owner",
  5891. "in": "path",
  5892. "required": true
  5893. },
  5894. {
  5895. "type": "string",
  5896. "description": "name of the repo",
  5897. "name": "repo",
  5898. "in": "path",
  5899. "required": true
  5900. },
  5901. {
  5902. "type": "integer",
  5903. "format": "int64",
  5904. "description": "id of the label to get",
  5905. "name": "id",
  5906. "in": "path",
  5907. "required": true
  5908. }
  5909. ],
  5910. "responses": {
  5911. "200": {
  5912. "$ref": "#/responses/Label"
  5913. }
  5914. }
  5915. },
  5916. "delete": {
  5917. "tags": [
  5918. "issue"
  5919. ],
  5920. "summary": "Delete a label",
  5921. "operationId": "issueDeleteLabel",
  5922. "parameters": [
  5923. {
  5924. "type": "string",
  5925. "description": "owner of the repo",
  5926. "name": "owner",
  5927. "in": "path",
  5928. "required": true
  5929. },
  5930. {
  5931. "type": "string",
  5932. "description": "name of the repo",
  5933. "name": "repo",
  5934. "in": "path",
  5935. "required": true
  5936. },
  5937. {
  5938. "type": "integer",
  5939. "format": "int64",
  5940. "description": "id of the label to delete",
  5941. "name": "id",
  5942. "in": "path",
  5943. "required": true
  5944. }
  5945. ],
  5946. "responses": {
  5947. "204": {
  5948. "$ref": "#/responses/empty"
  5949. }
  5950. }
  5951. },
  5952. "patch": {
  5953. "consumes": [
  5954. "application/json"
  5955. ],
  5956. "produces": [
  5957. "application/json"
  5958. ],
  5959. "tags": [
  5960. "issue"
  5961. ],
  5962. "summary": "Update a label",
  5963. "operationId": "issueEditLabel",
  5964. "parameters": [
  5965. {
  5966. "type": "string",
  5967. "description": "owner of the repo",
  5968. "name": "owner",
  5969. "in": "path",
  5970. "required": true
  5971. },
  5972. {
  5973. "type": "string",
  5974. "description": "name of the repo",
  5975. "name": "repo",
  5976. "in": "path",
  5977. "required": true
  5978. },
  5979. {
  5980. "type": "integer",
  5981. "format": "int64",
  5982. "description": "id of the label to edit",
  5983. "name": "id",
  5984. "in": "path",
  5985. "required": true
  5986. },
  5987. {
  5988. "name": "body",
  5989. "in": "body",
  5990. "schema": {
  5991. "$ref": "#/definitions/EditLabelOption"
  5992. }
  5993. }
  5994. ],
  5995. "responses": {
  5996. "200": {
  5997. "$ref": "#/responses/Label"
  5998. },
  5999. "422": {
  6000. "$ref": "#/responses/validationError"
  6001. }
  6002. }
  6003. }
  6004. },
  6005. "/repos/{owner}/{repo}/milestones": {
  6006. "get": {
  6007. "produces": [
  6008. "application/json"
  6009. ],
  6010. "tags": [
  6011. "issue"
  6012. ],
  6013. "summary": "Get all of a repository's opened milestones",
  6014. "operationId": "issueGetMilestonesList",
  6015. "parameters": [
  6016. {
  6017. "type": "string",
  6018. "description": "owner of the repo",
  6019. "name": "owner",
  6020. "in": "path",
  6021. "required": true
  6022. },
  6023. {
  6024. "type": "string",
  6025. "description": "name of the repo",
  6026. "name": "repo",
  6027. "in": "path",
  6028. "required": true
  6029. },
  6030. {
  6031. "type": "string",
  6032. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  6033. "name": "state",
  6034. "in": "query"
  6035. },
  6036. {
  6037. "type": "integer",
  6038. "description": "page number of results to return (1-based)",
  6039. "name": "page",
  6040. "in": "query"
  6041. },
  6042. {
  6043. "type": "integer",
  6044. "description": "page size of results, maximum page size is 50",
  6045. "name": "limit",
  6046. "in": "query"
  6047. }
  6048. ],
  6049. "responses": {
  6050. "200": {
  6051. "$ref": "#/responses/MilestoneList"
  6052. }
  6053. }
  6054. },
  6055. "post": {
  6056. "consumes": [
  6057. "application/json"
  6058. ],
  6059. "produces": [
  6060. "application/json"
  6061. ],
  6062. "tags": [
  6063. "issue"
  6064. ],
  6065. "summary": "Create a milestone",
  6066. "operationId": "issueCreateMilestone",
  6067. "parameters": [
  6068. {
  6069. "type": "string",
  6070. "description": "owner of the repo",
  6071. "name": "owner",
  6072. "in": "path",
  6073. "required": true
  6074. },
  6075. {
  6076. "type": "string",
  6077. "description": "name of the repo",
  6078. "name": "repo",
  6079. "in": "path",
  6080. "required": true
  6081. },
  6082. {
  6083. "name": "body",
  6084. "in": "body",
  6085. "schema": {
  6086. "$ref": "#/definitions/CreateMilestoneOption"
  6087. }
  6088. }
  6089. ],
  6090. "responses": {
  6091. "201": {
  6092. "$ref": "#/responses/Milestone"
  6093. }
  6094. }
  6095. }
  6096. },
  6097. "/repos/{owner}/{repo}/milestones/{id}": {
  6098. "get": {
  6099. "produces": [
  6100. "application/json"
  6101. ],
  6102. "tags": [
  6103. "issue"
  6104. ],
  6105. "summary": "Get a milestone",
  6106. "operationId": "issueGetMilestone",
  6107. "parameters": [
  6108. {
  6109. "type": "string",
  6110. "description": "owner of the repo",
  6111. "name": "owner",
  6112. "in": "path",
  6113. "required": true
  6114. },
  6115. {
  6116. "type": "string",
  6117. "description": "name of the repo",
  6118. "name": "repo",
  6119. "in": "path",
  6120. "required": true
  6121. },
  6122. {
  6123. "type": "integer",
  6124. "format": "int64",
  6125. "description": "id of the milestone",
  6126. "name": "id",
  6127. "in": "path",
  6128. "required": true
  6129. }
  6130. ],
  6131. "responses": {
  6132. "200": {
  6133. "$ref": "#/responses/Milestone"
  6134. }
  6135. }
  6136. },
  6137. "delete": {
  6138. "tags": [
  6139. "issue"
  6140. ],
  6141. "summary": "Delete a milestone",
  6142. "operationId": "issueDeleteMilestone",
  6143. "parameters": [
  6144. {
  6145. "type": "string",
  6146. "description": "owner of the repo",
  6147. "name": "owner",
  6148. "in": "path",
  6149. "required": true
  6150. },
  6151. {
  6152. "type": "string",
  6153. "description": "name of the repo",
  6154. "name": "repo",
  6155. "in": "path",
  6156. "required": true
  6157. },
  6158. {
  6159. "type": "integer",
  6160. "format": "int64",
  6161. "description": "id of the milestone to delete",
  6162. "name": "id",
  6163. "in": "path",
  6164. "required": true
  6165. }
  6166. ],
  6167. "responses": {
  6168. "204": {
  6169. "$ref": "#/responses/empty"
  6170. }
  6171. }
  6172. },
  6173. "patch": {
  6174. "consumes": [
  6175. "application/json"
  6176. ],
  6177. "produces": [
  6178. "application/json"
  6179. ],
  6180. "tags": [
  6181. "issue"
  6182. ],
  6183. "summary": "Update a milestone",
  6184. "operationId": "issueEditMilestone",
  6185. "parameters": [
  6186. {
  6187. "type": "string",
  6188. "description": "owner of the repo",
  6189. "name": "owner",
  6190. "in": "path",
  6191. "required": true
  6192. },
  6193. {
  6194. "type": "string",
  6195. "description": "name of the repo",
  6196. "name": "repo",
  6197. "in": "path",
  6198. "required": true
  6199. },
  6200. {
  6201. "type": "integer",
  6202. "format": "int64",
  6203. "description": "id of the milestone",
  6204. "name": "id",
  6205. "in": "path",
  6206. "required": true
  6207. },
  6208. {
  6209. "name": "body",
  6210. "in": "body",
  6211. "schema": {
  6212. "$ref": "#/definitions/EditMilestoneOption"
  6213. }
  6214. }
  6215. ],
  6216. "responses": {
  6217. "200": {
  6218. "$ref": "#/responses/Milestone"
  6219. }
  6220. }
  6221. }
  6222. },
  6223. "/repos/{owner}/{repo}/mirror-sync": {
  6224. "post": {
  6225. "produces": [
  6226. "application/json"
  6227. ],
  6228. "tags": [
  6229. "repository"
  6230. ],
  6231. "summary": "Sync a mirrored repository",
  6232. "operationId": "repoMirrorSync",
  6233. "parameters": [
  6234. {
  6235. "type": "string",
  6236. "description": "owner of the repo to sync",
  6237. "name": "owner",
  6238. "in": "path",
  6239. "required": true
  6240. },
  6241. {
  6242. "type": "string",
  6243. "description": "name of the repo to sync",
  6244. "name": "repo",
  6245. "in": "path",
  6246. "required": true
  6247. }
  6248. ],
  6249. "responses": {
  6250. "200": {
  6251. "$ref": "#/responses/empty"
  6252. },
  6253. "403": {
  6254. "$ref": "#/responses/forbidden"
  6255. }
  6256. }
  6257. }
  6258. },
  6259. "/repos/{owner}/{repo}/notifications": {
  6260. "get": {
  6261. "consumes": [
  6262. "application/json"
  6263. ],
  6264. "produces": [
  6265. "application/json"
  6266. ],
  6267. "tags": [
  6268. "notification"
  6269. ],
  6270. "summary": "List users's notification threads on a specific repo",
  6271. "operationId": "notifyGetRepoList",
  6272. "parameters": [
  6273. {
  6274. "type": "string",
  6275. "description": "owner of the repo",
  6276. "name": "owner",
  6277. "in": "path",
  6278. "required": true
  6279. },
  6280. {
  6281. "type": "string",
  6282. "description": "name of the repo",
  6283. "name": "repo",
  6284. "in": "path",
  6285. "required": true
  6286. },
  6287. {
  6288. "type": "string",
  6289. "description": "If true, show notifications marked as read. Default value is false",
  6290. "name": "all",
  6291. "in": "query"
  6292. },
  6293. {
  6294. "type": "string",
  6295. "format": "date-time",
  6296. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  6297. "name": "since",
  6298. "in": "query"
  6299. },
  6300. {
  6301. "type": "string",
  6302. "format": "date-time",
  6303. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  6304. "name": "before",
  6305. "in": "query"
  6306. },
  6307. {
  6308. "type": "integer",
  6309. "description": "page number of results to return (1-based)",
  6310. "name": "page",
  6311. "in": "query"
  6312. },
  6313. {
  6314. "type": "integer",
  6315. "description": "page size of results, maximum page size is 50",
  6316. "name": "limit",
  6317. "in": "query"
  6318. }
  6319. ],
  6320. "responses": {
  6321. "200": {
  6322. "$ref": "#/responses/NotificationThreadList"
  6323. }
  6324. }
  6325. },
  6326. "put": {
  6327. "consumes": [
  6328. "application/json"
  6329. ],
  6330. "produces": [
  6331. "application/json"
  6332. ],
  6333. "tags": [
  6334. "notification"
  6335. ],
  6336. "summary": "Mark notification threads as read on a specific repo",
  6337. "operationId": "notifyReadRepoList",
  6338. "parameters": [
  6339. {
  6340. "type": "string",
  6341. "description": "owner of the repo",
  6342. "name": "owner",
  6343. "in": "path",
  6344. "required": true
  6345. },
  6346. {
  6347. "type": "string",
  6348. "description": "name of the repo",
  6349. "name": "repo",
  6350. "in": "path",
  6351. "required": true
  6352. },
  6353. {
  6354. "type": "string",
  6355. "format": "date-time",
  6356. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  6357. "name": "last_read_at",
  6358. "in": "query"
  6359. }
  6360. ],
  6361. "responses": {
  6362. "205": {
  6363. "$ref": "#/responses/empty"
  6364. }
  6365. }
  6366. }
  6367. },
  6368. "/repos/{owner}/{repo}/pulls": {
  6369. "get": {
  6370. "produces": [
  6371. "application/json"
  6372. ],
  6373. "tags": [
  6374. "repository"
  6375. ],
  6376. "summary": "List a repo's pull requests",
  6377. "operationId": "repoListPullRequests",
  6378. "parameters": [
  6379. {
  6380. "type": "string",
  6381. "description": "owner of the repo",
  6382. "name": "owner",
  6383. "in": "path",
  6384. "required": true
  6385. },
  6386. {
  6387. "type": "string",
  6388. "description": "name of the repo",
  6389. "name": "repo",
  6390. "in": "path",
  6391. "required": true
  6392. },
  6393. {
  6394. "enum": [
  6395. "closed",
  6396. "open",
  6397. "all"
  6398. ],
  6399. "type": "string",
  6400. "description": "State of pull request: open or closed (optional)",
  6401. "name": "state",
  6402. "in": "query"
  6403. },
  6404. {
  6405. "enum": [
  6406. "oldest",
  6407. "recentupdate",
  6408. "leastupdate",
  6409. "mostcomment",
  6410. "leastcomment",
  6411. "priority"
  6412. ],
  6413. "type": "string",
  6414. "description": "Type of sort",
  6415. "name": "sort",
  6416. "in": "query"
  6417. },
  6418. {
  6419. "type": "integer",
  6420. "format": "int64",
  6421. "description": "ID of the milestone",
  6422. "name": "milestone",
  6423. "in": "query"
  6424. },
  6425. {
  6426. "type": "array",
  6427. "items": {
  6428. "type": "integer",
  6429. "format": "int64"
  6430. },
  6431. "collectionFormat": "multi",
  6432. "description": "Label IDs",
  6433. "name": "labels",
  6434. "in": "query"
  6435. },
  6436. {
  6437. "type": "integer",
  6438. "description": "page number of results to return (1-based)",
  6439. "name": "page",
  6440. "in": "query"
  6441. },
  6442. {
  6443. "type": "integer",
  6444. "description": "page size of results, maximum page size is 50",
  6445. "name": "limit",
  6446. "in": "query"
  6447. }
  6448. ],
  6449. "responses": {
  6450. "200": {
  6451. "$ref": "#/responses/PullRequestList"
  6452. }
  6453. }
  6454. },
  6455. "post": {
  6456. "consumes": [
  6457. "application/json"
  6458. ],
  6459. "produces": [
  6460. "application/json"
  6461. ],
  6462. "tags": [
  6463. "repository"
  6464. ],
  6465. "summary": "Create a pull request",
  6466. "operationId": "repoCreatePullRequest",
  6467. "parameters": [
  6468. {
  6469. "type": "string",
  6470. "description": "owner of the repo",
  6471. "name": "owner",
  6472. "in": "path",
  6473. "required": true
  6474. },
  6475. {
  6476. "type": "string",
  6477. "description": "name of the repo",
  6478. "name": "repo",
  6479. "in": "path",
  6480. "required": true
  6481. },
  6482. {
  6483. "name": "body",
  6484. "in": "body",
  6485. "schema": {
  6486. "$ref": "#/definitions/CreatePullRequestOption"
  6487. }
  6488. }
  6489. ],
  6490. "responses": {
  6491. "201": {
  6492. "$ref": "#/responses/PullRequest"
  6493. },
  6494. "409": {
  6495. "$ref": "#/responses/error"
  6496. },
  6497. "422": {
  6498. "$ref": "#/responses/validationError"
  6499. }
  6500. }
  6501. }
  6502. },
  6503. "/repos/{owner}/{repo}/pulls/{index}": {
  6504. "get": {
  6505. "produces": [
  6506. "application/json"
  6507. ],
  6508. "tags": [
  6509. "repository"
  6510. ],
  6511. "summary": "Get a pull request",
  6512. "operationId": "repoGetPullRequest",
  6513. "parameters": [
  6514. {
  6515. "type": "string",
  6516. "description": "owner of the repo",
  6517. "name": "owner",
  6518. "in": "path",
  6519. "required": true
  6520. },
  6521. {
  6522. "type": "string",
  6523. "description": "name of the repo",
  6524. "name": "repo",
  6525. "in": "path",
  6526. "required": true
  6527. },
  6528. {
  6529. "type": "integer",
  6530. "format": "int64",
  6531. "description": "index of the pull request to get",
  6532. "name": "index",
  6533. "in": "path",
  6534. "required": true
  6535. }
  6536. ],
  6537. "responses": {
  6538. "200": {
  6539. "$ref": "#/responses/PullRequest"
  6540. },
  6541. "404": {
  6542. "$ref": "#/responses/notFound"
  6543. }
  6544. }
  6545. },
  6546. "patch": {
  6547. "consumes": [
  6548. "application/json"
  6549. ],
  6550. "produces": [
  6551. "application/json"
  6552. ],
  6553. "tags": [
  6554. "repository"
  6555. ],
  6556. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6557. "operationId": "repoEditPullRequest",
  6558. "parameters": [
  6559. {
  6560. "type": "string",
  6561. "description": "owner of the repo",
  6562. "name": "owner",
  6563. "in": "path",
  6564. "required": true
  6565. },
  6566. {
  6567. "type": "string",
  6568. "description": "name of the repo",
  6569. "name": "repo",
  6570. "in": "path",
  6571. "required": true
  6572. },
  6573. {
  6574. "type": "integer",
  6575. "format": "int64",
  6576. "description": "index of the pull request to edit",
  6577. "name": "index",
  6578. "in": "path",
  6579. "required": true
  6580. },
  6581. {
  6582. "name": "body",
  6583. "in": "body",
  6584. "schema": {
  6585. "$ref": "#/definitions/EditPullRequestOption"
  6586. }
  6587. }
  6588. ],
  6589. "responses": {
  6590. "201": {
  6591. "$ref": "#/responses/PullRequest"
  6592. },
  6593. "403": {
  6594. "$ref": "#/responses/forbidden"
  6595. },
  6596. "409": {
  6597. "$ref": "#/responses/error"
  6598. },
  6599. "412": {
  6600. "$ref": "#/responses/error"
  6601. },
  6602. "422": {
  6603. "$ref": "#/responses/validationError"
  6604. }
  6605. }
  6606. }
  6607. },
  6608. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6609. "get": {
  6610. "produces": [
  6611. "application/json"
  6612. ],
  6613. "tags": [
  6614. "repository"
  6615. ],
  6616. "summary": "Check if a pull request has been merged",
  6617. "operationId": "repoPullRequestIsMerged",
  6618. "parameters": [
  6619. {
  6620. "type": "string",
  6621. "description": "owner of the repo",
  6622. "name": "owner",
  6623. "in": "path",
  6624. "required": true
  6625. },
  6626. {
  6627. "type": "string",
  6628. "description": "name of the repo",
  6629. "name": "repo",
  6630. "in": "path",
  6631. "required": true
  6632. },
  6633. {
  6634. "type": "integer",
  6635. "format": "int64",
  6636. "description": "index of the pull request",
  6637. "name": "index",
  6638. "in": "path",
  6639. "required": true
  6640. }
  6641. ],
  6642. "responses": {
  6643. "204": {
  6644. "description": "pull request has been merged"
  6645. },
  6646. "404": {
  6647. "description": "pull request has not been merged"
  6648. }
  6649. }
  6650. },
  6651. "post": {
  6652. "produces": [
  6653. "application/json"
  6654. ],
  6655. "tags": [
  6656. "repository"
  6657. ],
  6658. "summary": "Merge a pull request",
  6659. "operationId": "repoMergePullRequest",
  6660. "parameters": [
  6661. {
  6662. "type": "string",
  6663. "description": "owner of the repo",
  6664. "name": "owner",
  6665. "in": "path",
  6666. "required": true
  6667. },
  6668. {
  6669. "type": "string",
  6670. "description": "name of the repo",
  6671. "name": "repo",
  6672. "in": "path",
  6673. "required": true
  6674. },
  6675. {
  6676. "type": "integer",
  6677. "format": "int64",
  6678. "description": "index of the pull request to merge",
  6679. "name": "index",
  6680. "in": "path",
  6681. "required": true
  6682. },
  6683. {
  6684. "name": "body",
  6685. "in": "body",
  6686. "schema": {
  6687. "$ref": "#/definitions/MergePullRequestOption"
  6688. }
  6689. }
  6690. ],
  6691. "responses": {
  6692. "200": {
  6693. "$ref": "#/responses/empty"
  6694. },
  6695. "405": {
  6696. "$ref": "#/responses/empty"
  6697. },
  6698. "409": {
  6699. "$ref": "#/responses/error"
  6700. }
  6701. }
  6702. }
  6703. },
  6704. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  6705. "get": {
  6706. "produces": [
  6707. "application/json"
  6708. ],
  6709. "tags": [
  6710. "repository"
  6711. ],
  6712. "summary": "List all reviews for a pull request",
  6713. "operationId": "repoListPullReviews",
  6714. "parameters": [
  6715. {
  6716. "type": "string",
  6717. "description": "owner of the repo",
  6718. "name": "owner",
  6719. "in": "path",
  6720. "required": true
  6721. },
  6722. {
  6723. "type": "string",
  6724. "description": "name of the repo",
  6725. "name": "repo",
  6726. "in": "path",
  6727. "required": true
  6728. },
  6729. {
  6730. "type": "integer",
  6731. "format": "int64",
  6732. "description": "index of the pull request",
  6733. "name": "index",
  6734. "in": "path",
  6735. "required": true
  6736. },
  6737. {
  6738. "type": "integer",
  6739. "description": "page number of results to return (1-based)",
  6740. "name": "page",
  6741. "in": "query"
  6742. },
  6743. {
  6744. "type": "integer",
  6745. "description": "page size of results, maximum page size is 50",
  6746. "name": "limit",
  6747. "in": "query"
  6748. }
  6749. ],
  6750. "responses": {
  6751. "200": {
  6752. "$ref": "#/responses/PullReviewList"
  6753. },
  6754. "404": {
  6755. "$ref": "#/responses/notFound"
  6756. }
  6757. }
  6758. },
  6759. "post": {
  6760. "produces": [
  6761. "application/json"
  6762. ],
  6763. "tags": [
  6764. "repository"
  6765. ],
  6766. "summary": "Create a review to an pull request",
  6767. "operationId": "repoCreatePullReview",
  6768. "parameters": [
  6769. {
  6770. "type": "string",
  6771. "description": "owner of the repo",
  6772. "name": "owner",
  6773. "in": "path",
  6774. "required": true
  6775. },
  6776. {
  6777. "type": "string",
  6778. "description": "name of the repo",
  6779. "name": "repo",
  6780. "in": "path",
  6781. "required": true
  6782. },
  6783. {
  6784. "type": "integer",
  6785. "format": "int64",
  6786. "description": "index of the pull request",
  6787. "name": "index",
  6788. "in": "path",
  6789. "required": true
  6790. },
  6791. {
  6792. "name": "body",
  6793. "in": "body",
  6794. "required": true,
  6795. "schema": {
  6796. "$ref": "#/definitions/CreatePullReviewOptions"
  6797. }
  6798. }
  6799. ],
  6800. "responses": {
  6801. "200": {
  6802. "$ref": "#/responses/PullReview"
  6803. },
  6804. "404": {
  6805. "$ref": "#/responses/notFound"
  6806. },
  6807. "422": {
  6808. "$ref": "#/responses/validationError"
  6809. }
  6810. }
  6811. }
  6812. },
  6813. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  6814. "get": {
  6815. "produces": [
  6816. "application/json"
  6817. ],
  6818. "tags": [
  6819. "repository"
  6820. ],
  6821. "summary": "Get a specific review for a pull request",
  6822. "operationId": "repoGetPullReview",
  6823. "parameters": [
  6824. {
  6825. "type": "string",
  6826. "description": "owner of the repo",
  6827. "name": "owner",
  6828. "in": "path",
  6829. "required": true
  6830. },
  6831. {
  6832. "type": "string",
  6833. "description": "name of the repo",
  6834. "name": "repo",
  6835. "in": "path",
  6836. "required": true
  6837. },
  6838. {
  6839. "type": "integer",
  6840. "format": "int64",
  6841. "description": "index of the pull request",
  6842. "name": "index",
  6843. "in": "path",
  6844. "required": true
  6845. },
  6846. {
  6847. "type": "integer",
  6848. "format": "int64",
  6849. "description": "id of the review",
  6850. "name": "id",
  6851. "in": "path",
  6852. "required": true
  6853. }
  6854. ],
  6855. "responses": {
  6856. "200": {
  6857. "$ref": "#/responses/PullReview"
  6858. },
  6859. "404": {
  6860. "$ref": "#/responses/notFound"
  6861. }
  6862. }
  6863. },
  6864. "post": {
  6865. "produces": [
  6866. "application/json"
  6867. ],
  6868. "tags": [
  6869. "repository"
  6870. ],
  6871. "summary": "Submit a pending review to an pull request",
  6872. "operationId": "repoSubmitPullReview",
  6873. "parameters": [
  6874. {
  6875. "type": "string",
  6876. "description": "owner of the repo",
  6877. "name": "owner",
  6878. "in": "path",
  6879. "required": true
  6880. },
  6881. {
  6882. "type": "string",
  6883. "description": "name of the repo",
  6884. "name": "repo",
  6885. "in": "path",
  6886. "required": true
  6887. },
  6888. {
  6889. "type": "integer",
  6890. "format": "int64",
  6891. "description": "index of the pull request",
  6892. "name": "index",
  6893. "in": "path",
  6894. "required": true
  6895. },
  6896. {
  6897. "type": "integer",
  6898. "format": "int64",
  6899. "description": "id of the review",
  6900. "name": "id",
  6901. "in": "path",
  6902. "required": true
  6903. },
  6904. {
  6905. "name": "body",
  6906. "in": "body",
  6907. "required": true,
  6908. "schema": {
  6909. "$ref": "#/definitions/SubmitPullReviewOptions"
  6910. }
  6911. }
  6912. ],
  6913. "responses": {
  6914. "200": {
  6915. "$ref": "#/responses/PullReview"
  6916. },
  6917. "404": {
  6918. "$ref": "#/responses/notFound"
  6919. },
  6920. "422": {
  6921. "$ref": "#/responses/validationError"
  6922. }
  6923. }
  6924. },
  6925. "delete": {
  6926. "produces": [
  6927. "application/json"
  6928. ],
  6929. "tags": [
  6930. "repository"
  6931. ],
  6932. "summary": "Delete a specific review from a pull request",
  6933. "operationId": "repoDeletePullReview",
  6934. "parameters": [
  6935. {
  6936. "type": "string",
  6937. "description": "owner of the repo",
  6938. "name": "owner",
  6939. "in": "path",
  6940. "required": true
  6941. },
  6942. {
  6943. "type": "string",
  6944. "description": "name of the repo",
  6945. "name": "repo",
  6946. "in": "path",
  6947. "required": true
  6948. },
  6949. {
  6950. "type": "integer",
  6951. "format": "int64",
  6952. "description": "index of the pull request",
  6953. "name": "index",
  6954. "in": "path",
  6955. "required": true
  6956. },
  6957. {
  6958. "type": "integer",
  6959. "format": "int64",
  6960. "description": "id of the review",
  6961. "name": "id",
  6962. "in": "path",
  6963. "required": true
  6964. }
  6965. ],
  6966. "responses": {
  6967. "204": {
  6968. "$ref": "#/responses/empty"
  6969. },
  6970. "403": {
  6971. "$ref": "#/responses/forbidden"
  6972. },
  6973. "404": {
  6974. "$ref": "#/responses/notFound"
  6975. }
  6976. }
  6977. }
  6978. },
  6979. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  6980. "get": {
  6981. "produces": [
  6982. "application/json"
  6983. ],
  6984. "tags": [
  6985. "repository"
  6986. ],
  6987. "summary": "Get a specific review for a pull request",
  6988. "operationId": "repoGetPullReviewComments",
  6989. "parameters": [
  6990. {
  6991. "type": "string",
  6992. "description": "owner of the repo",
  6993. "name": "owner",
  6994. "in": "path",
  6995. "required": true
  6996. },
  6997. {
  6998. "type": "string",
  6999. "description": "name of the repo",
  7000. "name": "repo",
  7001. "in": "path",
  7002. "required": true
  7003. },
  7004. {
  7005. "type": "integer",
  7006. "format": "int64",
  7007. "description": "index of the pull request",
  7008. "name": "index",
  7009. "in": "path",
  7010. "required": true
  7011. },
  7012. {
  7013. "type": "integer",
  7014. "format": "int64",
  7015. "description": "id of the review",
  7016. "name": "id",
  7017. "in": "path",
  7018. "required": true
  7019. }
  7020. ],
  7021. "responses": {
  7022. "200": {
  7023. "$ref": "#/responses/PullReviewCommentList"
  7024. },
  7025. "404": {
  7026. "$ref": "#/responses/notFound"
  7027. }
  7028. }
  7029. }
  7030. },
  7031. "/repos/{owner}/{repo}/raw/{filepath}": {
  7032. "get": {
  7033. "produces": [
  7034. "application/json"
  7035. ],
  7036. "tags": [
  7037. "repository"
  7038. ],
  7039. "summary": "Get a file from a repository",
  7040. "operationId": "repoGetRawFile",
  7041. "parameters": [
  7042. {
  7043. "type": "string",
  7044. "description": "owner of the repo",
  7045. "name": "owner",
  7046. "in": "path",
  7047. "required": true
  7048. },
  7049. {
  7050. "type": "string",
  7051. "description": "name of the repo",
  7052. "name": "repo",
  7053. "in": "path",
  7054. "required": true
  7055. },
  7056. {
  7057. "type": "string",
  7058. "description": "filepath of the file to get",
  7059. "name": "filepath",
  7060. "in": "path",
  7061. "required": true
  7062. }
  7063. ],
  7064. "responses": {
  7065. "200": {
  7066. "description": "success"
  7067. },
  7068. "404": {
  7069. "$ref": "#/responses/notFound"
  7070. }
  7071. }
  7072. }
  7073. },
  7074. "/repos/{owner}/{repo}/releases": {
  7075. "get": {
  7076. "produces": [
  7077. "application/json"
  7078. ],
  7079. "tags": [
  7080. "repository"
  7081. ],
  7082. "summary": "List a repo's releases",
  7083. "operationId": "repoListReleases",
  7084. "parameters": [
  7085. {
  7086. "type": "string",
  7087. "description": "owner of the repo",
  7088. "name": "owner",
  7089. "in": "path",
  7090. "required": true
  7091. },
  7092. {
  7093. "type": "string",
  7094. "description": "name of the repo",
  7095. "name": "repo",
  7096. "in": "path",
  7097. "required": true
  7098. },
  7099. {
  7100. "type": "integer",
  7101. "description": "items count every page wants to load",
  7102. "name": "per_page",
  7103. "in": "query"
  7104. },
  7105. {
  7106. "type": "integer",
  7107. "description": "page number of results to return (1-based)",
  7108. "name": "page",
  7109. "in": "query"
  7110. },
  7111. {
  7112. "type": "integer",
  7113. "description": "page size of results, maximum page size is 50",
  7114. "name": "limit",
  7115. "in": "query"
  7116. }
  7117. ],
  7118. "responses": {
  7119. "200": {
  7120. "$ref": "#/responses/ReleaseList"
  7121. }
  7122. }
  7123. },
  7124. "post": {
  7125. "consumes": [
  7126. "application/json"
  7127. ],
  7128. "produces": [
  7129. "application/json"
  7130. ],
  7131. "tags": [
  7132. "repository"
  7133. ],
  7134. "summary": "Create a release",
  7135. "operationId": "repoCreateRelease",
  7136. "parameters": [
  7137. {
  7138. "type": "string",
  7139. "description": "owner of the repo",
  7140. "name": "owner",
  7141. "in": "path",
  7142. "required": true
  7143. },
  7144. {
  7145. "type": "string",
  7146. "description": "name of the repo",
  7147. "name": "repo",
  7148. "in": "path",
  7149. "required": true
  7150. },
  7151. {
  7152. "name": "body",
  7153. "in": "body",
  7154. "schema": {
  7155. "$ref": "#/definitions/CreateReleaseOption"
  7156. }
  7157. }
  7158. ],
  7159. "responses": {
  7160. "201": {
  7161. "$ref": "#/responses/Release"
  7162. },
  7163. "409": {
  7164. "$ref": "#/responses/error"
  7165. }
  7166. }
  7167. }
  7168. },
  7169. "/repos/{owner}/{repo}/releases/{id}": {
  7170. "get": {
  7171. "produces": [
  7172. "application/json"
  7173. ],
  7174. "tags": [
  7175. "repository"
  7176. ],
  7177. "summary": "Get a release",
  7178. "operationId": "repoGetRelease",
  7179. "parameters": [
  7180. {
  7181. "type": "string",
  7182. "description": "owner of the repo",
  7183. "name": "owner",
  7184. "in": "path",
  7185. "required": true
  7186. },
  7187. {
  7188. "type": "string",
  7189. "description": "name of the repo",
  7190. "name": "repo",
  7191. "in": "path",
  7192. "required": true
  7193. },
  7194. {
  7195. "type": "integer",
  7196. "format": "int64",
  7197. "description": "id of the release to get",
  7198. "name": "id",
  7199. "in": "path",
  7200. "required": true
  7201. }
  7202. ],
  7203. "responses": {
  7204. "200": {
  7205. "$ref": "#/responses/Release"
  7206. }
  7207. }
  7208. },
  7209. "delete": {
  7210. "tags": [
  7211. "repository"
  7212. ],
  7213. "summary": "Delete a release",
  7214. "operationId": "repoDeleteRelease",
  7215. "parameters": [
  7216. {
  7217. "type": "string",
  7218. "description": "owner of the repo",
  7219. "name": "owner",
  7220. "in": "path",
  7221. "required": true
  7222. },
  7223. {
  7224. "type": "string",
  7225. "description": "name of the repo",
  7226. "name": "repo",
  7227. "in": "path",
  7228. "required": true
  7229. },
  7230. {
  7231. "type": "integer",
  7232. "format": "int64",
  7233. "description": "id of the release to delete",
  7234. "name": "id",
  7235. "in": "path",
  7236. "required": true
  7237. }
  7238. ],
  7239. "responses": {
  7240. "204": {
  7241. "$ref": "#/responses/empty"
  7242. }
  7243. }
  7244. },
  7245. "patch": {
  7246. "consumes": [
  7247. "application/json"
  7248. ],
  7249. "produces": [
  7250. "application/json"
  7251. ],
  7252. "tags": [
  7253. "repository"
  7254. ],
  7255. "summary": "Update a release",
  7256. "operationId": "repoEditRelease",
  7257. "parameters": [
  7258. {
  7259. "type": "string",
  7260. "description": "owner of the repo",
  7261. "name": "owner",
  7262. "in": "path",
  7263. "required": true
  7264. },
  7265. {
  7266. "type": "string",
  7267. "description": "name of the repo",
  7268. "name": "repo",
  7269. "in": "path",
  7270. "required": true
  7271. },
  7272. {
  7273. "type": "integer",
  7274. "format": "int64",
  7275. "description": "id of the release to edit",
  7276. "name": "id",
  7277. "in": "path",
  7278. "required": true
  7279. },
  7280. {
  7281. "name": "body",
  7282. "in": "body",
  7283. "schema": {
  7284. "$ref": "#/definitions/EditReleaseOption"
  7285. }
  7286. }
  7287. ],
  7288. "responses": {
  7289. "200": {
  7290. "$ref": "#/responses/Release"
  7291. }
  7292. }
  7293. }
  7294. },
  7295. "/repos/{owner}/{repo}/releases/{id}/assets": {
  7296. "get": {
  7297. "produces": [
  7298. "application/json"
  7299. ],
  7300. "tags": [
  7301. "repository"
  7302. ],
  7303. "summary": "List release's attachments",
  7304. "operationId": "repoListReleaseAttachments",
  7305. "parameters": [
  7306. {
  7307. "type": "string",
  7308. "description": "owner of the repo",
  7309. "name": "owner",
  7310. "in": "path",
  7311. "required": true
  7312. },
  7313. {
  7314. "type": "string",
  7315. "description": "name of the repo",
  7316. "name": "repo",
  7317. "in": "path",
  7318. "required": true
  7319. },
  7320. {
  7321. "type": "integer",
  7322. "format": "int64",
  7323. "description": "id of the release",
  7324. "name": "id",
  7325. "in": "path",
  7326. "required": true
  7327. }
  7328. ],
  7329. "responses": {
  7330. "200": {
  7331. "$ref": "#/responses/AttachmentList"
  7332. }
  7333. }
  7334. },
  7335. "post": {
  7336. "consumes": [
  7337. "multipart/form-data"
  7338. ],
  7339. "produces": [
  7340. "application/json"
  7341. ],
  7342. "tags": [
  7343. "repository"
  7344. ],
  7345. "summary": "Create a release attachment",
  7346. "operationId": "repoCreateReleaseAttachment",
  7347. "parameters": [
  7348. {
  7349. "type": "string",
  7350. "description": "owner of the repo",
  7351. "name": "owner",
  7352. "in": "path",
  7353. "required": true
  7354. },
  7355. {
  7356. "type": "string",
  7357. "description": "name of the repo",
  7358. "name": "repo",
  7359. "in": "path",
  7360. "required": true
  7361. },
  7362. {
  7363. "type": "integer",
  7364. "format": "int64",
  7365. "description": "id of the release",
  7366. "name": "id",
  7367. "in": "path",
  7368. "required": true
  7369. },
  7370. {
  7371. "type": "string",
  7372. "description": "name of the attachment",
  7373. "name": "name",
  7374. "in": "query"
  7375. },
  7376. {
  7377. "type": "file",
  7378. "description": "attachment to upload",
  7379. "name": "attachment",
  7380. "in": "formData",
  7381. "required": true
  7382. }
  7383. ],
  7384. "responses": {
  7385. "201": {
  7386. "$ref": "#/responses/Attachment"
  7387. },
  7388. "400": {
  7389. "$ref": "#/responses/error"
  7390. }
  7391. }
  7392. }
  7393. },
  7394. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  7395. "get": {
  7396. "produces": [
  7397. "application/json"
  7398. ],
  7399. "tags": [
  7400. "repository"
  7401. ],
  7402. "summary": "Get a release attachment",
  7403. "operationId": "repoGetReleaseAttachment",
  7404. "parameters": [
  7405. {
  7406. "type": "string",
  7407. "description": "owner of the repo",
  7408. "name": "owner",
  7409. "in": "path",
  7410. "required": true
  7411. },
  7412. {
  7413. "type": "string",
  7414. "description": "name of the repo",
  7415. "name": "repo",
  7416. "in": "path",
  7417. "required": true
  7418. },
  7419. {
  7420. "type": "integer",
  7421. "format": "int64",
  7422. "description": "id of the release",
  7423. "name": "id",
  7424. "in": "path",
  7425. "required": true
  7426. },
  7427. {
  7428. "type": "integer",
  7429. "format": "int64",
  7430. "description": "id of the attachment to get",
  7431. "name": "attachment_id",
  7432. "in": "path",
  7433. "required": true
  7434. }
  7435. ],
  7436. "responses": {
  7437. "200": {
  7438. "$ref": "#/responses/Attachment"
  7439. }
  7440. }
  7441. },
  7442. "delete": {
  7443. "produces": [
  7444. "application/json"
  7445. ],
  7446. "tags": [
  7447. "repository"
  7448. ],
  7449. "summary": "Delete a release attachment",
  7450. "operationId": "repoDeleteReleaseAttachment",
  7451. "parameters": [
  7452. {
  7453. "type": "string",
  7454. "description": "owner of the repo",
  7455. "name": "owner",
  7456. "in": "path",
  7457. "required": true
  7458. },
  7459. {
  7460. "type": "string",
  7461. "description": "name of the repo",
  7462. "name": "repo",
  7463. "in": "path",
  7464. "required": true
  7465. },
  7466. {
  7467. "type": "integer",
  7468. "format": "int64",
  7469. "description": "id of the release",
  7470. "name": "id",
  7471. "in": "path",
  7472. "required": true
  7473. },
  7474. {
  7475. "type": "integer",
  7476. "format": "int64",
  7477. "description": "id of the attachment to delete",
  7478. "name": "attachment_id",
  7479. "in": "path",
  7480. "required": true
  7481. }
  7482. ],
  7483. "responses": {
  7484. "204": {
  7485. "$ref": "#/responses/empty"
  7486. }
  7487. }
  7488. },
  7489. "patch": {
  7490. "consumes": [
  7491. "application/json"
  7492. ],
  7493. "produces": [
  7494. "application/json"
  7495. ],
  7496. "tags": [
  7497. "repository"
  7498. ],
  7499. "summary": "Edit a release attachment",
  7500. "operationId": "repoEditReleaseAttachment",
  7501. "parameters": [
  7502. {
  7503. "type": "string",
  7504. "description": "owner of the repo",
  7505. "name": "owner",
  7506. "in": "path",
  7507. "required": true
  7508. },
  7509. {
  7510. "type": "string",
  7511. "description": "name of the repo",
  7512. "name": "repo",
  7513. "in": "path",
  7514. "required": true
  7515. },
  7516. {
  7517. "type": "integer",
  7518. "format": "int64",
  7519. "description": "id of the release",
  7520. "name": "id",
  7521. "in": "path",
  7522. "required": true
  7523. },
  7524. {
  7525. "type": "integer",
  7526. "format": "int64",
  7527. "description": "id of the attachment to edit",
  7528. "name": "attachment_id",
  7529. "in": "path",
  7530. "required": true
  7531. },
  7532. {
  7533. "name": "body",
  7534. "in": "body",
  7535. "schema": {
  7536. "$ref": "#/definitions/EditAttachmentOptions"
  7537. }
  7538. }
  7539. ],
  7540. "responses": {
  7541. "201": {
  7542. "$ref": "#/responses/Attachment"
  7543. }
  7544. }
  7545. }
  7546. },
  7547. "/repos/{owner}/{repo}/signing-key.gpg": {
  7548. "get": {
  7549. "produces": [
  7550. "text/plain"
  7551. ],
  7552. "tags": [
  7553. "repository"
  7554. ],
  7555. "summary": "Get signing-key.gpg for given repository",
  7556. "operationId": "repoSigningKey",
  7557. "parameters": [
  7558. {
  7559. "type": "string",
  7560. "description": "owner of the repo",
  7561. "name": "owner",
  7562. "in": "path",
  7563. "required": true
  7564. },
  7565. {
  7566. "type": "string",
  7567. "description": "name of the repo",
  7568. "name": "repo",
  7569. "in": "path",
  7570. "required": true
  7571. }
  7572. ],
  7573. "responses": {
  7574. "200": {
  7575. "description": "GPG armored public key",
  7576. "schema": {
  7577. "type": "string"
  7578. }
  7579. }
  7580. }
  7581. }
  7582. },
  7583. "/repos/{owner}/{repo}/stargazers": {
  7584. "get": {
  7585. "produces": [
  7586. "application/json"
  7587. ],
  7588. "tags": [
  7589. "repository"
  7590. ],
  7591. "summary": "List a repo's stargazers",
  7592. "operationId": "repoListStargazers",
  7593. "parameters": [
  7594. {
  7595. "type": "string",
  7596. "description": "owner of the repo",
  7597. "name": "owner",
  7598. "in": "path",
  7599. "required": true
  7600. },
  7601. {
  7602. "type": "string",
  7603. "description": "name of the repo",
  7604. "name": "repo",
  7605. "in": "path",
  7606. "required": true
  7607. },
  7608. {
  7609. "type": "integer",
  7610. "description": "page number of results to return (1-based)",
  7611. "name": "page",
  7612. "in": "query"
  7613. },
  7614. {
  7615. "type": "integer",
  7616. "description": "page size of results, maximum page size is 50",
  7617. "name": "limit",
  7618. "in": "query"
  7619. }
  7620. ],
  7621. "responses": {
  7622. "200": {
  7623. "$ref": "#/responses/UserList"
  7624. }
  7625. }
  7626. }
  7627. },
  7628. "/repos/{owner}/{repo}/statuses/{sha}": {
  7629. "get": {
  7630. "produces": [
  7631. "application/json"
  7632. ],
  7633. "tags": [
  7634. "repository"
  7635. ],
  7636. "summary": "Get a commit's statuses",
  7637. "operationId": "repoListStatuses",
  7638. "parameters": [
  7639. {
  7640. "type": "string",
  7641. "description": "owner of the repo",
  7642. "name": "owner",
  7643. "in": "path",
  7644. "required": true
  7645. },
  7646. {
  7647. "type": "string",
  7648. "description": "name of the repo",
  7649. "name": "repo",
  7650. "in": "path",
  7651. "required": true
  7652. },
  7653. {
  7654. "type": "string",
  7655. "description": "sha of the commit",
  7656. "name": "sha",
  7657. "in": "path",
  7658. "required": true
  7659. },
  7660. {
  7661. "enum": [
  7662. "oldest",
  7663. "recentupdate",
  7664. "leastupdate",
  7665. "leastindex",
  7666. "highestindex"
  7667. ],
  7668. "type": "string",
  7669. "description": "type of sort",
  7670. "name": "sort",
  7671. "in": "query"
  7672. },
  7673. {
  7674. "enum": [
  7675. "pending",
  7676. "success",
  7677. "error",
  7678. "failure",
  7679. "warning"
  7680. ],
  7681. "type": "string",
  7682. "description": "type of state",
  7683. "name": "state",
  7684. "in": "query"
  7685. },
  7686. {
  7687. "type": "integer",
  7688. "description": "page number of results to return (1-based)",
  7689. "name": "page",
  7690. "in": "query"
  7691. },
  7692. {
  7693. "type": "integer",
  7694. "description": "page size of results, maximum page size is 50",
  7695. "name": "limit",
  7696. "in": "query"
  7697. }
  7698. ],
  7699. "responses": {
  7700. "200": {
  7701. "$ref": "#/responses/StatusList"
  7702. },
  7703. "400": {
  7704. "$ref": "#/responses/error"
  7705. }
  7706. }
  7707. },
  7708. "post": {
  7709. "produces": [
  7710. "application/json"
  7711. ],
  7712. "tags": [
  7713. "repository"
  7714. ],
  7715. "summary": "Create a commit status",
  7716. "operationId": "repoCreateStatus",
  7717. "parameters": [
  7718. {
  7719. "type": "string",
  7720. "description": "owner of the repo",
  7721. "name": "owner",
  7722. "in": "path",
  7723. "required": true
  7724. },
  7725. {
  7726. "type": "string",
  7727. "description": "name of the repo",
  7728. "name": "repo",
  7729. "in": "path",
  7730. "required": true
  7731. },
  7732. {
  7733. "type": "string",
  7734. "description": "sha of the commit",
  7735. "name": "sha",
  7736. "in": "path",
  7737. "required": true
  7738. },
  7739. {
  7740. "name": "body",
  7741. "in": "body",
  7742. "schema": {
  7743. "$ref": "#/definitions/CreateStatusOption"
  7744. }
  7745. }
  7746. ],
  7747. "responses": {
  7748. "201": {
  7749. "$ref": "#/responses/Status"
  7750. },
  7751. "400": {
  7752. "$ref": "#/responses/error"
  7753. }
  7754. }
  7755. }
  7756. },
  7757. "/repos/{owner}/{repo}/subscribers": {
  7758. "get": {
  7759. "produces": [
  7760. "application/json"
  7761. ],
  7762. "tags": [
  7763. "repository"
  7764. ],
  7765. "summary": "List a repo's watchers",
  7766. "operationId": "repoListSubscribers",
  7767. "parameters": [
  7768. {
  7769. "type": "string",
  7770. "description": "owner of the repo",
  7771. "name": "owner",
  7772. "in": "path",
  7773. "required": true
  7774. },
  7775. {
  7776. "type": "string",
  7777. "description": "name of the repo",
  7778. "name": "repo",
  7779. "in": "path",
  7780. "required": true
  7781. },
  7782. {
  7783. "type": "integer",
  7784. "description": "page number of results to return (1-based)",
  7785. "name": "page",
  7786. "in": "query"
  7787. },
  7788. {
  7789. "type": "integer",
  7790. "description": "page size of results, maximum page size is 50",
  7791. "name": "limit",
  7792. "in": "query"
  7793. }
  7794. ],
  7795. "responses": {
  7796. "200": {
  7797. "$ref": "#/responses/UserList"
  7798. }
  7799. }
  7800. }
  7801. },
  7802. "/repos/{owner}/{repo}/subscription": {
  7803. "get": {
  7804. "tags": [
  7805. "repository"
  7806. ],
  7807. "summary": "Check if the current user is watching a repo",
  7808. "operationId": "userCurrentCheckSubscription",
  7809. "parameters": [
  7810. {
  7811. "type": "string",
  7812. "description": "owner of the repo",
  7813. "name": "owner",
  7814. "in": "path",
  7815. "required": true
  7816. },
  7817. {
  7818. "type": "string",
  7819. "description": "name of the repo",
  7820. "name": "repo",
  7821. "in": "path",
  7822. "required": true
  7823. }
  7824. ],
  7825. "responses": {
  7826. "200": {
  7827. "$ref": "#/responses/WatchInfo"
  7828. },
  7829. "404": {
  7830. "description": "User is not watching this repo or repo do not exist"
  7831. }
  7832. }
  7833. },
  7834. "put": {
  7835. "tags": [
  7836. "repository"
  7837. ],
  7838. "summary": "Watch a repo",
  7839. "operationId": "userCurrentPutSubscription",
  7840. "parameters": [
  7841. {
  7842. "type": "string",
  7843. "description": "owner of the repo",
  7844. "name": "owner",
  7845. "in": "path",
  7846. "required": true
  7847. },
  7848. {
  7849. "type": "string",
  7850. "description": "name of the repo",
  7851. "name": "repo",
  7852. "in": "path",
  7853. "required": true
  7854. }
  7855. ],
  7856. "responses": {
  7857. "200": {
  7858. "$ref": "#/responses/WatchInfo"
  7859. }
  7860. }
  7861. },
  7862. "delete": {
  7863. "tags": [
  7864. "repository"
  7865. ],
  7866. "summary": "Unwatch a repo",
  7867. "operationId": "userCurrentDeleteSubscription",
  7868. "parameters": [
  7869. {
  7870. "type": "string",
  7871. "description": "owner of the repo",
  7872. "name": "owner",
  7873. "in": "path",
  7874. "required": true
  7875. },
  7876. {
  7877. "type": "string",
  7878. "description": "name of the repo",
  7879. "name": "repo",
  7880. "in": "path",
  7881. "required": true
  7882. }
  7883. ],
  7884. "responses": {
  7885. "204": {
  7886. "$ref": "#/responses/empty"
  7887. }
  7888. }
  7889. }
  7890. },
  7891. "/repos/{owner}/{repo}/tags": {
  7892. "get": {
  7893. "produces": [
  7894. "application/json"
  7895. ],
  7896. "tags": [
  7897. "repository"
  7898. ],
  7899. "summary": "List a repository's tags",
  7900. "operationId": "repoListTags",
  7901. "parameters": [
  7902. {
  7903. "type": "string",
  7904. "description": "owner of the repo",
  7905. "name": "owner",
  7906. "in": "path",
  7907. "required": true
  7908. },
  7909. {
  7910. "type": "string",
  7911. "description": "name of the repo",
  7912. "name": "repo",
  7913. "in": "path",
  7914. "required": true
  7915. },
  7916. {
  7917. "type": "integer",
  7918. "description": "page number of results to return (1-based)",
  7919. "name": "page",
  7920. "in": "query"
  7921. },
  7922. {
  7923. "type": "integer",
  7924. "description": "page size of results, default maximum page size is 50",
  7925. "name": "limit",
  7926. "in": "query"
  7927. }
  7928. ],
  7929. "responses": {
  7930. "200": {
  7931. "$ref": "#/responses/TagList"
  7932. }
  7933. }
  7934. }
  7935. },
  7936. "/repos/{owner}/{repo}/times": {
  7937. "get": {
  7938. "produces": [
  7939. "application/json"
  7940. ],
  7941. "tags": [
  7942. "repository"
  7943. ],
  7944. "summary": "List a repo's tracked times",
  7945. "operationId": "repoTrackedTimes",
  7946. "parameters": [
  7947. {
  7948. "type": "string",
  7949. "description": "owner of the repo",
  7950. "name": "owner",
  7951. "in": "path",
  7952. "required": true
  7953. },
  7954. {
  7955. "type": "string",
  7956. "description": "name of the repo",
  7957. "name": "repo",
  7958. "in": "path",
  7959. "required": true
  7960. },
  7961. {
  7962. "type": "string",
  7963. "description": "optional filter by user",
  7964. "name": "user",
  7965. "in": "query"
  7966. },
  7967. {
  7968. "type": "string",
  7969. "format": "date-time",
  7970. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7971. "name": "since",
  7972. "in": "query"
  7973. },
  7974. {
  7975. "type": "string",
  7976. "format": "date-time",
  7977. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7978. "name": "before",
  7979. "in": "query"
  7980. },
  7981. {
  7982. "type": "integer",
  7983. "description": "page number of results to return (1-based)",
  7984. "name": "page",
  7985. "in": "query"
  7986. },
  7987. {
  7988. "type": "integer",
  7989. "description": "page size of results, maximum page size is 50",
  7990. "name": "limit",
  7991. "in": "query"
  7992. }
  7993. ],
  7994. "responses": {
  7995. "200": {
  7996. "$ref": "#/responses/TrackedTimeList"
  7997. },
  7998. "400": {
  7999. "$ref": "#/responses/error"
  8000. },
  8001. "403": {
  8002. "$ref": "#/responses/forbidden"
  8003. }
  8004. }
  8005. }
  8006. },
  8007. "/repos/{owner}/{repo}/times/{user}": {
  8008. "get": {
  8009. "produces": [
  8010. "application/json"
  8011. ],
  8012. "tags": [
  8013. "repository"
  8014. ],
  8015. "summary": "List a user's tracked times in a repo",
  8016. "operationId": "userTrackedTimes",
  8017. "deprecated": true,
  8018. "parameters": [
  8019. {
  8020. "type": "string",
  8021. "description": "owner of the repo",
  8022. "name": "owner",
  8023. "in": "path",
  8024. "required": true
  8025. },
  8026. {
  8027. "type": "string",
  8028. "description": "name of the repo",
  8029. "name": "repo",
  8030. "in": "path",
  8031. "required": true
  8032. },
  8033. {
  8034. "type": "string",
  8035. "description": "username of user",
  8036. "name": "user",
  8037. "in": "path",
  8038. "required": true
  8039. }
  8040. ],
  8041. "responses": {
  8042. "200": {
  8043. "$ref": "#/responses/TrackedTimeList"
  8044. },
  8045. "400": {
  8046. "$ref": "#/responses/error"
  8047. },
  8048. "403": {
  8049. "$ref": "#/responses/forbidden"
  8050. }
  8051. }
  8052. }
  8053. },
  8054. "/repos/{owner}/{repo}/topics": {
  8055. "get": {
  8056. "produces": [
  8057. "application/json"
  8058. ],
  8059. "tags": [
  8060. "repository"
  8061. ],
  8062. "summary": "Get list of topics that a repository has",
  8063. "operationId": "repoListTopics",
  8064. "parameters": [
  8065. {
  8066. "type": "string",
  8067. "description": "owner of the repo",
  8068. "name": "owner",
  8069. "in": "path",
  8070. "required": true
  8071. },
  8072. {
  8073. "type": "string",
  8074. "description": "name of the repo",
  8075. "name": "repo",
  8076. "in": "path",
  8077. "required": true
  8078. },
  8079. {
  8080. "type": "integer",
  8081. "description": "page number of results to return (1-based)",
  8082. "name": "page",
  8083. "in": "query"
  8084. },
  8085. {
  8086. "type": "integer",
  8087. "description": "page size of results, maximum page size is 50",
  8088. "name": "limit",
  8089. "in": "query"
  8090. }
  8091. ],
  8092. "responses": {
  8093. "200": {
  8094. "$ref": "#/responses/TopicNames"
  8095. }
  8096. }
  8097. },
  8098. "put": {
  8099. "produces": [
  8100. "application/json"
  8101. ],
  8102. "tags": [
  8103. "repository"
  8104. ],
  8105. "summary": "Replace list of topics for a repository",
  8106. "operationId": "repoUpdateTopics",
  8107. "parameters": [
  8108. {
  8109. "type": "string",
  8110. "description": "owner of the repo",
  8111. "name": "owner",
  8112. "in": "path",
  8113. "required": true
  8114. },
  8115. {
  8116. "type": "string",
  8117. "description": "name of the repo",
  8118. "name": "repo",
  8119. "in": "path",
  8120. "required": true
  8121. },
  8122. {
  8123. "name": "body",
  8124. "in": "body",
  8125. "schema": {
  8126. "$ref": "#/definitions/RepoTopicOptions"
  8127. }
  8128. }
  8129. ],
  8130. "responses": {
  8131. "204": {
  8132. "$ref": "#/responses/empty"
  8133. },
  8134. "422": {
  8135. "$ref": "#/responses/invalidTopicsError"
  8136. }
  8137. }
  8138. }
  8139. },
  8140. "/repos/{owner}/{repo}/topics/{topic}": {
  8141. "put": {
  8142. "produces": [
  8143. "application/json"
  8144. ],
  8145. "tags": [
  8146. "repository"
  8147. ],
  8148. "summary": "Add a topic to a repository",
  8149. "operationId": "repoAddTopíc",
  8150. "parameters": [
  8151. {
  8152. "type": "string",
  8153. "description": "owner of the repo",
  8154. "name": "owner",
  8155. "in": "path",
  8156. "required": true
  8157. },
  8158. {
  8159. "type": "string",
  8160. "description": "name of the repo",
  8161. "name": "repo",
  8162. "in": "path",
  8163. "required": true
  8164. },
  8165. {
  8166. "type": "string",
  8167. "description": "name of the topic to add",
  8168. "name": "topic",
  8169. "in": "path",
  8170. "required": true
  8171. }
  8172. ],
  8173. "responses": {
  8174. "204": {
  8175. "$ref": "#/responses/empty"
  8176. },
  8177. "422": {
  8178. "$ref": "#/responses/invalidTopicsError"
  8179. }
  8180. }
  8181. },
  8182. "delete": {
  8183. "produces": [
  8184. "application/json"
  8185. ],
  8186. "tags": [
  8187. "repository"
  8188. ],
  8189. "summary": "Delete a topic from a repository",
  8190. "operationId": "repoDeleteTopic",
  8191. "parameters": [
  8192. {
  8193. "type": "string",
  8194. "description": "owner of the repo",
  8195. "name": "owner",
  8196. "in": "path",
  8197. "required": true
  8198. },
  8199. {
  8200. "type": "string",
  8201. "description": "name of the repo",
  8202. "name": "repo",
  8203. "in": "path",
  8204. "required": true
  8205. },
  8206. {
  8207. "type": "string",
  8208. "description": "name of the topic to delete",
  8209. "name": "topic",
  8210. "in": "path",
  8211. "required": true
  8212. }
  8213. ],
  8214. "responses": {
  8215. "204": {
  8216. "$ref": "#/responses/empty"
  8217. },
  8218. "422": {
  8219. "$ref": "#/responses/invalidTopicsError"
  8220. }
  8221. }
  8222. }
  8223. },
  8224. "/repos/{owner}/{repo}/transfer": {
  8225. "post": {
  8226. "produces": [
  8227. "application/json"
  8228. ],
  8229. "tags": [
  8230. "repository"
  8231. ],
  8232. "summary": "Transfer a repo ownership",
  8233. "operationId": "repoTransfer",
  8234. "parameters": [
  8235. {
  8236. "type": "string",
  8237. "description": "owner of the repo to transfer",
  8238. "name": "owner",
  8239. "in": "path",
  8240. "required": true
  8241. },
  8242. {
  8243. "type": "string",
  8244. "description": "name of the repo to transfer",
  8245. "name": "repo",
  8246. "in": "path",
  8247. "required": true
  8248. },
  8249. {
  8250. "description": "Transfer Options",
  8251. "name": "body",
  8252. "in": "body",
  8253. "required": true,
  8254. "schema": {
  8255. "$ref": "#/definitions/TransferRepoOption"
  8256. }
  8257. }
  8258. ],
  8259. "responses": {
  8260. "202": {
  8261. "$ref": "#/responses/Repository"
  8262. },
  8263. "403": {
  8264. "$ref": "#/responses/forbidden"
  8265. },
  8266. "404": {
  8267. "$ref": "#/responses/notFound"
  8268. },
  8269. "422": {
  8270. "$ref": "#/responses/validationError"
  8271. }
  8272. }
  8273. }
  8274. },
  8275. "/repositories/{id}": {
  8276. "get": {
  8277. "produces": [
  8278. "application/json"
  8279. ],
  8280. "tags": [
  8281. "repository"
  8282. ],
  8283. "summary": "Get a repository by id",
  8284. "operationId": "repoGetByID",
  8285. "parameters": [
  8286. {
  8287. "type": "integer",
  8288. "format": "int64",
  8289. "description": "id of the repo to get",
  8290. "name": "id",
  8291. "in": "path",
  8292. "required": true
  8293. }
  8294. ],
  8295. "responses": {
  8296. "200": {
  8297. "$ref": "#/responses/Repository"
  8298. }
  8299. }
  8300. }
  8301. },
  8302. "/signing-key.gpg": {
  8303. "get": {
  8304. "produces": [
  8305. "text/plain"
  8306. ],
  8307. "tags": [
  8308. "miscellaneous"
  8309. ],
  8310. "summary": "Get default signing-key.gpg",
  8311. "operationId": "getSigningKey",
  8312. "responses": {
  8313. "200": {
  8314. "description": "GPG armored public key",
  8315. "schema": {
  8316. "type": "string"
  8317. }
  8318. }
  8319. }
  8320. }
  8321. },
  8322. "/teams/{id}": {
  8323. "get": {
  8324. "produces": [
  8325. "application/json"
  8326. ],
  8327. "tags": [
  8328. "organization"
  8329. ],
  8330. "summary": "Get a team",
  8331. "operationId": "orgGetTeam",
  8332. "parameters": [
  8333. {
  8334. "type": "integer",
  8335. "format": "int64",
  8336. "description": "id of the team to get",
  8337. "name": "id",
  8338. "in": "path",
  8339. "required": true
  8340. }
  8341. ],
  8342. "responses": {
  8343. "200": {
  8344. "$ref": "#/responses/Team"
  8345. }
  8346. }
  8347. },
  8348. "delete": {
  8349. "tags": [
  8350. "organization"
  8351. ],
  8352. "summary": "Delete a team",
  8353. "operationId": "orgDeleteTeam",
  8354. "parameters": [
  8355. {
  8356. "type": "integer",
  8357. "format": "int64",
  8358. "description": "id of the team to delete",
  8359. "name": "id",
  8360. "in": "path",
  8361. "required": true
  8362. }
  8363. ],
  8364. "responses": {
  8365. "204": {
  8366. "description": "team deleted"
  8367. }
  8368. }
  8369. },
  8370. "patch": {
  8371. "consumes": [
  8372. "application/json"
  8373. ],
  8374. "produces": [
  8375. "application/json"
  8376. ],
  8377. "tags": [
  8378. "organization"
  8379. ],
  8380. "summary": "Edit a team",
  8381. "operationId": "orgEditTeam",
  8382. "parameters": [
  8383. {
  8384. "type": "integer",
  8385. "description": "id of the team to edit",
  8386. "name": "id",
  8387. "in": "path",
  8388. "required": true
  8389. },
  8390. {
  8391. "name": "body",
  8392. "in": "body",
  8393. "schema": {
  8394. "$ref": "#/definitions/EditTeamOption"
  8395. }
  8396. }
  8397. ],
  8398. "responses": {
  8399. "200": {
  8400. "$ref": "#/responses/Team"
  8401. }
  8402. }
  8403. }
  8404. },
  8405. "/teams/{id}/members": {
  8406. "get": {
  8407. "produces": [
  8408. "application/json"
  8409. ],
  8410. "tags": [
  8411. "organization"
  8412. ],
  8413. "summary": "List a team's members",
  8414. "operationId": "orgListTeamMembers",
  8415. "parameters": [
  8416. {
  8417. "type": "integer",
  8418. "format": "int64",
  8419. "description": "id of the team",
  8420. "name": "id",
  8421. "in": "path",
  8422. "required": true
  8423. },
  8424. {
  8425. "type": "integer",
  8426. "description": "page number of results to return (1-based)",
  8427. "name": "page",
  8428. "in": "query"
  8429. },
  8430. {
  8431. "type": "integer",
  8432. "description": "page size of results, maximum page size is 50",
  8433. "name": "limit",
  8434. "in": "query"
  8435. }
  8436. ],
  8437. "responses": {
  8438. "200": {
  8439. "$ref": "#/responses/UserList"
  8440. }
  8441. }
  8442. }
  8443. },
  8444. "/teams/{id}/members/{username}": {
  8445. "get": {
  8446. "produces": [
  8447. "application/json"
  8448. ],
  8449. "tags": [
  8450. "organization"
  8451. ],
  8452. "summary": "List a particular member of team",
  8453. "operationId": "orgListTeamMember",
  8454. "parameters": [
  8455. {
  8456. "type": "integer",
  8457. "format": "int64",
  8458. "description": "id of the team",
  8459. "name": "id",
  8460. "in": "path",
  8461. "required": true
  8462. },
  8463. {
  8464. "type": "string",
  8465. "description": "username of the member to list",
  8466. "name": "username",
  8467. "in": "path",
  8468. "required": true
  8469. }
  8470. ],
  8471. "responses": {
  8472. "200": {
  8473. "$ref": "#/responses/User"
  8474. },
  8475. "404": {
  8476. "$ref": "#/responses/notFound"
  8477. }
  8478. }
  8479. },
  8480. "put": {
  8481. "produces": [
  8482. "application/json"
  8483. ],
  8484. "tags": [
  8485. "organization"
  8486. ],
  8487. "summary": "Add a team member",
  8488. "operationId": "orgAddTeamMember",
  8489. "parameters": [
  8490. {
  8491. "type": "integer",
  8492. "format": "int64",
  8493. "description": "id of the team",
  8494. "name": "id",
  8495. "in": "path",
  8496. "required": true
  8497. },
  8498. {
  8499. "type": "string",
  8500. "description": "username of the user to add",
  8501. "name": "username",
  8502. "in": "path",
  8503. "required": true
  8504. }
  8505. ],
  8506. "responses": {
  8507. "204": {
  8508. "$ref": "#/responses/empty"
  8509. },
  8510. "404": {
  8511. "$ref": "#/responses/notFound"
  8512. }
  8513. }
  8514. },
  8515. "delete": {
  8516. "produces": [
  8517. "application/json"
  8518. ],
  8519. "tags": [
  8520. "organization"
  8521. ],
  8522. "summary": "Remove a team member",
  8523. "operationId": "orgRemoveTeamMember",
  8524. "parameters": [
  8525. {
  8526. "type": "integer",
  8527. "format": "int64",
  8528. "description": "id of the team",
  8529. "name": "id",
  8530. "in": "path",
  8531. "required": true
  8532. },
  8533. {
  8534. "type": "string",
  8535. "description": "username of the user to remove",
  8536. "name": "username",
  8537. "in": "path",
  8538. "required": true
  8539. }
  8540. ],
  8541. "responses": {
  8542. "204": {
  8543. "$ref": "#/responses/empty"
  8544. },
  8545. "404": {
  8546. "$ref": "#/responses/notFound"
  8547. }
  8548. }
  8549. }
  8550. },
  8551. "/teams/{id}/repos": {
  8552. "get": {
  8553. "produces": [
  8554. "application/json"
  8555. ],
  8556. "tags": [
  8557. "organization"
  8558. ],
  8559. "summary": "List a team's repos",
  8560. "operationId": "orgListTeamRepos",
  8561. "parameters": [
  8562. {
  8563. "type": "integer",
  8564. "format": "int64",
  8565. "description": "id of the team",
  8566. "name": "id",
  8567. "in": "path",
  8568. "required": true
  8569. },
  8570. {
  8571. "type": "integer",
  8572. "description": "page number of results to return (1-based)",
  8573. "name": "page",
  8574. "in": "query"
  8575. },
  8576. {
  8577. "type": "integer",
  8578. "description": "page size of results, maximum page size is 50",
  8579. "name": "limit",
  8580. "in": "query"
  8581. }
  8582. ],
  8583. "responses": {
  8584. "200": {
  8585. "$ref": "#/responses/RepositoryList"
  8586. }
  8587. }
  8588. }
  8589. },
  8590. "/teams/{id}/repos/{org}/{repo}": {
  8591. "put": {
  8592. "produces": [
  8593. "application/json"
  8594. ],
  8595. "tags": [
  8596. "organization"
  8597. ],
  8598. "summary": "Add a repository to a team",
  8599. "operationId": "orgAddTeamRepository",
  8600. "parameters": [
  8601. {
  8602. "type": "integer",
  8603. "format": "int64",
  8604. "description": "id of the team",
  8605. "name": "id",
  8606. "in": "path",
  8607. "required": true
  8608. },
  8609. {
  8610. "type": "string",
  8611. "description": "organization that owns the repo to add",
  8612. "name": "org",
  8613. "in": "path",
  8614. "required": true
  8615. },
  8616. {
  8617. "type": "string",
  8618. "description": "name of the repo to add",
  8619. "name": "repo",
  8620. "in": "path",
  8621. "required": true
  8622. }
  8623. ],
  8624. "responses": {
  8625. "204": {
  8626. "$ref": "#/responses/empty"
  8627. },
  8628. "403": {
  8629. "$ref": "#/responses/forbidden"
  8630. }
  8631. }
  8632. },
  8633. "delete": {
  8634. "description": "This does not delete the repository, it only removes the repository from the team.",
  8635. "produces": [
  8636. "application/json"
  8637. ],
  8638. "tags": [
  8639. "organization"
  8640. ],
  8641. "summary": "Remove a repository from a team",
  8642. "operationId": "orgRemoveTeamRepository",
  8643. "parameters": [
  8644. {
  8645. "type": "integer",
  8646. "format": "int64",
  8647. "description": "id of the team",
  8648. "name": "id",
  8649. "in": "path",
  8650. "required": true
  8651. },
  8652. {
  8653. "type": "string",
  8654. "description": "organization that owns the repo to remove",
  8655. "name": "org",
  8656. "in": "path",
  8657. "required": true
  8658. },
  8659. {
  8660. "type": "string",
  8661. "description": "name of the repo to remove",
  8662. "name": "repo",
  8663. "in": "path",
  8664. "required": true
  8665. }
  8666. ],
  8667. "responses": {
  8668. "204": {
  8669. "$ref": "#/responses/empty"
  8670. },
  8671. "403": {
  8672. "$ref": "#/responses/forbidden"
  8673. }
  8674. }
  8675. }
  8676. },
  8677. "/topics/search": {
  8678. "get": {
  8679. "produces": [
  8680. "application/json"
  8681. ],
  8682. "tags": [
  8683. "repository"
  8684. ],
  8685. "summary": "search topics via keyword",
  8686. "operationId": "topicSearch",
  8687. "parameters": [
  8688. {
  8689. "type": "string",
  8690. "description": "keywords to search",
  8691. "name": "q",
  8692. "in": "query",
  8693. "required": true
  8694. },
  8695. {
  8696. "type": "integer",
  8697. "description": "page number of results to return (1-based)",
  8698. "name": "page",
  8699. "in": "query"
  8700. },
  8701. {
  8702. "type": "integer",
  8703. "description": "page size of results, maximum page size is 50",
  8704. "name": "limit",
  8705. "in": "query"
  8706. }
  8707. ],
  8708. "responses": {
  8709. "200": {
  8710. "$ref": "#/responses/TopicListResponse"
  8711. },
  8712. "403": {
  8713. "$ref": "#/responses/forbidden"
  8714. }
  8715. }
  8716. }
  8717. },
  8718. "/user": {
  8719. "get": {
  8720. "produces": [
  8721. "application/json"
  8722. ],
  8723. "tags": [
  8724. "user"
  8725. ],
  8726. "summary": "Get the authenticated user",
  8727. "operationId": "userGetCurrent",
  8728. "responses": {
  8729. "200": {
  8730. "$ref": "#/responses/User"
  8731. }
  8732. }
  8733. }
  8734. },
  8735. "/user/applications/oauth2": {
  8736. "get": {
  8737. "produces": [
  8738. "application/json"
  8739. ],
  8740. "tags": [
  8741. "user"
  8742. ],
  8743. "summary": "List the authenticated user's oauth2 applications",
  8744. "operationId": "userGetOauth2Application",
  8745. "parameters": [
  8746. {
  8747. "type": "integer",
  8748. "description": "page number of results to return (1-based)",
  8749. "name": "page",
  8750. "in": "query"
  8751. },
  8752. {
  8753. "type": "integer",
  8754. "description": "page size of results, maximum page size is 50",
  8755. "name": "limit",
  8756. "in": "query"
  8757. }
  8758. ],
  8759. "responses": {
  8760. "200": {
  8761. "$ref": "#/responses/OAuth2ApplicationList"
  8762. }
  8763. }
  8764. },
  8765. "post": {
  8766. "produces": [
  8767. "application/json"
  8768. ],
  8769. "tags": [
  8770. "user"
  8771. ],
  8772. "summary": "creates a new OAuth2 application",
  8773. "operationId": "userCreateOAuth2Application",
  8774. "parameters": [
  8775. {
  8776. "name": "body",
  8777. "in": "body",
  8778. "required": true,
  8779. "schema": {
  8780. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  8781. }
  8782. }
  8783. ],
  8784. "responses": {
  8785. "201": {
  8786. "$ref": "#/responses/OAuth2Application"
  8787. }
  8788. }
  8789. }
  8790. },
  8791. "/user/applications/oauth2/{id}": {
  8792. "get": {
  8793. "produces": [
  8794. "application/json"
  8795. ],
  8796. "tags": [
  8797. "user"
  8798. ],
  8799. "summary": "get an OAuth2 Application",
  8800. "operationId": "userGetOAuth2Application",
  8801. "parameters": [
  8802. {
  8803. "type": "integer",
  8804. "format": "int64",
  8805. "description": "Application ID to be found",
  8806. "name": "id",
  8807. "in": "path",
  8808. "required": true
  8809. }
  8810. ],
  8811. "responses": {
  8812. "200": {
  8813. "$ref": "#/responses/OAuth2Application"
  8814. }
  8815. }
  8816. },
  8817. "delete": {
  8818. "produces": [
  8819. "application/json"
  8820. ],
  8821. "tags": [
  8822. "user"
  8823. ],
  8824. "summary": "delete an OAuth2 Application",
  8825. "operationId": "userDeleteOAuth2Application",
  8826. "parameters": [
  8827. {
  8828. "type": "integer",
  8829. "format": "int64",
  8830. "description": "token to be deleted",
  8831. "name": "id",
  8832. "in": "path",
  8833. "required": true
  8834. }
  8835. ],
  8836. "responses": {
  8837. "204": {
  8838. "$ref": "#/responses/empty"
  8839. }
  8840. }
  8841. },
  8842. "patch": {
  8843. "produces": [
  8844. "application/json"
  8845. ],
  8846. "tags": [
  8847. "user"
  8848. ],
  8849. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  8850. "operationId": "userUpdateOAuth2Application",
  8851. "parameters": [
  8852. {
  8853. "type": "integer",
  8854. "format": "int64",
  8855. "description": "application to be updated",
  8856. "name": "id",
  8857. "in": "path",
  8858. "required": true
  8859. },
  8860. {
  8861. "name": "body",
  8862. "in": "body",
  8863. "required": true,
  8864. "schema": {
  8865. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  8866. }
  8867. }
  8868. ],
  8869. "responses": {
  8870. "200": {
  8871. "$ref": "#/responses/OAuth2Application"
  8872. }
  8873. }
  8874. }
  8875. },
  8876. "/user/emails": {
  8877. "get": {
  8878. "produces": [
  8879. "application/json"
  8880. ],
  8881. "tags": [
  8882. "user"
  8883. ],
  8884. "summary": "List the authenticated user's email addresses",
  8885. "operationId": "userListEmails",
  8886. "responses": {
  8887. "200": {
  8888. "$ref": "#/responses/EmailList"
  8889. }
  8890. }
  8891. },
  8892. "post": {
  8893. "produces": [
  8894. "application/json"
  8895. ],
  8896. "tags": [
  8897. "user"
  8898. ],
  8899. "summary": "Add email addresses",
  8900. "operationId": "userAddEmail",
  8901. "parameters": [
  8902. {
  8903. "name": "body",
  8904. "in": "body",
  8905. "schema": {
  8906. "$ref": "#/definitions/CreateEmailOption"
  8907. }
  8908. }
  8909. ],
  8910. "responses": {
  8911. "201": {
  8912. "$ref": "#/responses/EmailList"
  8913. },
  8914. "422": {
  8915. "$ref": "#/responses/validationError"
  8916. }
  8917. }
  8918. },
  8919. "delete": {
  8920. "produces": [
  8921. "application/json"
  8922. ],
  8923. "tags": [
  8924. "user"
  8925. ],
  8926. "summary": "Delete email addresses",
  8927. "operationId": "userDeleteEmail",
  8928. "parameters": [
  8929. {
  8930. "name": "body",
  8931. "in": "body",
  8932. "schema": {
  8933. "$ref": "#/definitions/DeleteEmailOption"
  8934. }
  8935. }
  8936. ],
  8937. "responses": {
  8938. "204": {
  8939. "$ref": "#/responses/empty"
  8940. }
  8941. }
  8942. }
  8943. },
  8944. "/user/followers": {
  8945. "get": {
  8946. "produces": [
  8947. "application/json"
  8948. ],
  8949. "tags": [
  8950. "user"
  8951. ],
  8952. "summary": "List the authenticated user's followers",
  8953. "operationId": "userCurrentListFollowers",
  8954. "parameters": [
  8955. {
  8956. "type": "integer",
  8957. "description": "page number of results to return (1-based)",
  8958. "name": "page",
  8959. "in": "query"
  8960. },
  8961. {
  8962. "type": "integer",
  8963. "description": "page size of results, maximum page size is 50",
  8964. "name": "limit",
  8965. "in": "query"
  8966. }
  8967. ],
  8968. "responses": {
  8969. "200": {
  8970. "$ref": "#/responses/UserList"
  8971. }
  8972. }
  8973. }
  8974. },
  8975. "/user/following": {
  8976. "get": {
  8977. "produces": [
  8978. "application/json"
  8979. ],
  8980. "tags": [
  8981. "user"
  8982. ],
  8983. "summary": "List the users that the authenticated user is following",
  8984. "operationId": "userCurrentListFollowing",
  8985. "parameters": [
  8986. {
  8987. "type": "integer",
  8988. "description": "page number of results to return (1-based)",
  8989. "name": "page",
  8990. "in": "query"
  8991. },
  8992. {
  8993. "type": "integer",
  8994. "description": "page size of results, maximum page size is 50",
  8995. "name": "limit",
  8996. "in": "query"
  8997. }
  8998. ],
  8999. "responses": {
  9000. "200": {
  9001. "$ref": "#/responses/UserList"
  9002. }
  9003. }
  9004. }
  9005. },
  9006. "/user/following/{username}": {
  9007. "get": {
  9008. "tags": [
  9009. "user"
  9010. ],
  9011. "summary": "Check whether a user is followed by the authenticated user",
  9012. "operationId": "userCurrentCheckFollowing",
  9013. "parameters": [
  9014. {
  9015. "type": "string",
  9016. "description": "username of followed user",
  9017. "name": "username",
  9018. "in": "path",
  9019. "required": true
  9020. }
  9021. ],
  9022. "responses": {
  9023. "204": {
  9024. "$ref": "#/responses/empty"
  9025. },
  9026. "404": {
  9027. "$ref": "#/responses/notFound"
  9028. }
  9029. }
  9030. },
  9031. "put": {
  9032. "tags": [
  9033. "user"
  9034. ],
  9035. "summary": "Follow a user",
  9036. "operationId": "userCurrentPutFollow",
  9037. "parameters": [
  9038. {
  9039. "type": "string",
  9040. "description": "username of user to follow",
  9041. "name": "username",
  9042. "in": "path",
  9043. "required": true
  9044. }
  9045. ],
  9046. "responses": {
  9047. "204": {
  9048. "$ref": "#/responses/empty"
  9049. }
  9050. }
  9051. },
  9052. "delete": {
  9053. "tags": [
  9054. "user"
  9055. ],
  9056. "summary": "Unfollow a user",
  9057. "operationId": "userCurrentDeleteFollow",
  9058. "parameters": [
  9059. {
  9060. "type": "string",
  9061. "description": "username of user to unfollow",
  9062. "name": "username",
  9063. "in": "path",
  9064. "required": true
  9065. }
  9066. ],
  9067. "responses": {
  9068. "204": {
  9069. "$ref": "#/responses/empty"
  9070. }
  9071. }
  9072. }
  9073. },
  9074. "/user/gpg_keys": {
  9075. "get": {
  9076. "produces": [
  9077. "application/json"
  9078. ],
  9079. "tags": [
  9080. "user"
  9081. ],
  9082. "summary": "List the authenticated user's GPG keys",
  9083. "operationId": "userCurrentListGPGKeys",
  9084. "parameters": [
  9085. {
  9086. "type": "integer",
  9087. "description": "page number of results to return (1-based)",
  9088. "name": "page",
  9089. "in": "query"
  9090. },
  9091. {
  9092. "type": "integer",
  9093. "description": "page size of results, maximum page size is 50",
  9094. "name": "limit",
  9095. "in": "query"
  9096. }
  9097. ],
  9098. "responses": {
  9099. "200": {
  9100. "$ref": "#/responses/GPGKeyList"
  9101. }
  9102. }
  9103. },
  9104. "post": {
  9105. "consumes": [
  9106. "application/json"
  9107. ],
  9108. "produces": [
  9109. "application/json"
  9110. ],
  9111. "tags": [
  9112. "user"
  9113. ],
  9114. "summary": "Create a GPG key",
  9115. "operationId": "userCurrentPostGPGKey",
  9116. "parameters": [
  9117. {
  9118. "name": "Form",
  9119. "in": "body",
  9120. "schema": {
  9121. "$ref": "#/definitions/CreateGPGKeyOption"
  9122. }
  9123. }
  9124. ],
  9125. "responses": {
  9126. "201": {
  9127. "$ref": "#/responses/GPGKey"
  9128. },
  9129. "404": {
  9130. "$ref": "#/responses/notFound"
  9131. },
  9132. "422": {
  9133. "$ref": "#/responses/validationError"
  9134. }
  9135. }
  9136. }
  9137. },
  9138. "/user/gpg_keys/{id}": {
  9139. "get": {
  9140. "produces": [
  9141. "application/json"
  9142. ],
  9143. "tags": [
  9144. "user"
  9145. ],
  9146. "summary": "Get a GPG key",
  9147. "operationId": "userCurrentGetGPGKey",
  9148. "parameters": [
  9149. {
  9150. "type": "integer",
  9151. "format": "int64",
  9152. "description": "id of key to get",
  9153. "name": "id",
  9154. "in": "path",
  9155. "required": true
  9156. }
  9157. ],
  9158. "responses": {
  9159. "200": {
  9160. "$ref": "#/responses/GPGKey"
  9161. },
  9162. "404": {
  9163. "$ref": "#/responses/notFound"
  9164. }
  9165. }
  9166. },
  9167. "delete": {
  9168. "produces": [
  9169. "application/json"
  9170. ],
  9171. "tags": [
  9172. "user"
  9173. ],
  9174. "summary": "Remove a GPG key",
  9175. "operationId": "userCurrentDeleteGPGKey",
  9176. "parameters": [
  9177. {
  9178. "type": "integer",
  9179. "format": "int64",
  9180. "description": "id of key to delete",
  9181. "name": "id",
  9182. "in": "path",
  9183. "required": true
  9184. }
  9185. ],
  9186. "responses": {
  9187. "204": {
  9188. "$ref": "#/responses/empty"
  9189. },
  9190. "403": {
  9191. "$ref": "#/responses/forbidden"
  9192. },
  9193. "404": {
  9194. "$ref": "#/responses/notFound"
  9195. }
  9196. }
  9197. }
  9198. },
  9199. "/user/keys": {
  9200. "get": {
  9201. "produces": [
  9202. "application/json"
  9203. ],
  9204. "tags": [
  9205. "user"
  9206. ],
  9207. "summary": "List the authenticated user's public keys",
  9208. "operationId": "userCurrentListKeys",
  9209. "parameters": [
  9210. {
  9211. "type": "string",
  9212. "description": "fingerprint of the key",
  9213. "name": "fingerprint",
  9214. "in": "query"
  9215. },
  9216. {
  9217. "type": "integer",
  9218. "description": "page number of results to return (1-based)",
  9219. "name": "page",
  9220. "in": "query"
  9221. },
  9222. {
  9223. "type": "integer",
  9224. "description": "page size of results, maximum page size is 50",
  9225. "name": "limit",
  9226. "in": "query"
  9227. }
  9228. ],
  9229. "responses": {
  9230. "200": {
  9231. "$ref": "#/responses/PublicKeyList"
  9232. }
  9233. }
  9234. },
  9235. "post": {
  9236. "consumes": [
  9237. "application/json"
  9238. ],
  9239. "produces": [
  9240. "application/json"
  9241. ],
  9242. "tags": [
  9243. "user"
  9244. ],
  9245. "summary": "Create a public key",
  9246. "operationId": "userCurrentPostKey",
  9247. "parameters": [
  9248. {
  9249. "name": "body",
  9250. "in": "body",
  9251. "schema": {
  9252. "$ref": "#/definitions/CreateKeyOption"
  9253. }
  9254. }
  9255. ],
  9256. "responses": {
  9257. "201": {
  9258. "$ref": "#/responses/PublicKey"
  9259. },
  9260. "422": {
  9261. "$ref": "#/responses/validationError"
  9262. }
  9263. }
  9264. }
  9265. },
  9266. "/user/keys/{id}": {
  9267. "get": {
  9268. "produces": [
  9269. "application/json"
  9270. ],
  9271. "tags": [
  9272. "user"
  9273. ],
  9274. "summary": "Get a public key",
  9275. "operationId": "userCurrentGetKey",
  9276. "parameters": [
  9277. {
  9278. "type": "integer",
  9279. "format": "int64",
  9280. "description": "id of key to get",
  9281. "name": "id",
  9282. "in": "path",
  9283. "required": true
  9284. }
  9285. ],
  9286. "responses": {
  9287. "200": {
  9288. "$ref": "#/responses/PublicKey"
  9289. },
  9290. "404": {
  9291. "$ref": "#/responses/notFound"
  9292. }
  9293. }
  9294. },
  9295. "delete": {
  9296. "produces": [
  9297. "application/json"
  9298. ],
  9299. "tags": [
  9300. "user"
  9301. ],
  9302. "summary": "Delete a public key",
  9303. "operationId": "userCurrentDeleteKey",
  9304. "parameters": [
  9305. {
  9306. "type": "integer",
  9307. "format": "int64",
  9308. "description": "id of key to delete",
  9309. "name": "id",
  9310. "in": "path",
  9311. "required": true
  9312. }
  9313. ],
  9314. "responses": {
  9315. "204": {
  9316. "$ref": "#/responses/empty"
  9317. },
  9318. "403": {
  9319. "$ref": "#/responses/forbidden"
  9320. },
  9321. "404": {
  9322. "$ref": "#/responses/notFound"
  9323. }
  9324. }
  9325. }
  9326. },
  9327. "/user/orgs": {
  9328. "get": {
  9329. "produces": [
  9330. "application/json"
  9331. ],
  9332. "tags": [
  9333. "organization"
  9334. ],
  9335. "summary": "List the current user's organizations",
  9336. "operationId": "orgListCurrentUserOrgs",
  9337. "parameters": [
  9338. {
  9339. "type": "integer",
  9340. "description": "page number of results to return (1-based)",
  9341. "name": "page",
  9342. "in": "query"
  9343. },
  9344. {
  9345. "type": "integer",
  9346. "description": "page size of results, maximum page size is 50",
  9347. "name": "limit",
  9348. "in": "query"
  9349. }
  9350. ],
  9351. "responses": {
  9352. "200": {
  9353. "$ref": "#/responses/OrganizationList"
  9354. }
  9355. }
  9356. }
  9357. },
  9358. "/user/repos": {
  9359. "get": {
  9360. "produces": [
  9361. "application/json"
  9362. ],
  9363. "tags": [
  9364. "user"
  9365. ],
  9366. "summary": "List the repos that the authenticated user owns or has access to",
  9367. "operationId": "userCurrentListRepos",
  9368. "parameters": [
  9369. {
  9370. "type": "integer",
  9371. "description": "page number of results to return (1-based)",
  9372. "name": "page",
  9373. "in": "query"
  9374. },
  9375. {
  9376. "type": "integer",
  9377. "description": "page size of results, maximum page size is 50",
  9378. "name": "limit",
  9379. "in": "query"
  9380. }
  9381. ],
  9382. "responses": {
  9383. "200": {
  9384. "$ref": "#/responses/RepositoryList"
  9385. }
  9386. }
  9387. },
  9388. "post": {
  9389. "consumes": [
  9390. "application/json"
  9391. ],
  9392. "produces": [
  9393. "application/json"
  9394. ],
  9395. "tags": [
  9396. "repository",
  9397. "user"
  9398. ],
  9399. "summary": "Create a repository",
  9400. "operationId": "createCurrentUserRepo",
  9401. "parameters": [
  9402. {
  9403. "name": "body",
  9404. "in": "body",
  9405. "schema": {
  9406. "$ref": "#/definitions/CreateRepoOption"
  9407. }
  9408. }
  9409. ],
  9410. "responses": {
  9411. "201": {
  9412. "$ref": "#/responses/Repository"
  9413. },
  9414. "409": {
  9415. "description": "The repository with the same name already exists."
  9416. },
  9417. "422": {
  9418. "$ref": "#/responses/validationError"
  9419. }
  9420. }
  9421. }
  9422. },
  9423. "/user/starred": {
  9424. "get": {
  9425. "produces": [
  9426. "application/json"
  9427. ],
  9428. "tags": [
  9429. "user"
  9430. ],
  9431. "summary": "The repos that the authenticated user has starred",
  9432. "operationId": "userCurrentListStarred",
  9433. "parameters": [
  9434. {
  9435. "type": "integer",
  9436. "description": "page number of results to return (1-based)",
  9437. "name": "page",
  9438. "in": "query"
  9439. },
  9440. {
  9441. "type": "integer",
  9442. "description": "page size of results, maximum page size is 50",
  9443. "name": "limit",
  9444. "in": "query"
  9445. }
  9446. ],
  9447. "responses": {
  9448. "200": {
  9449. "$ref": "#/responses/RepositoryList"
  9450. }
  9451. }
  9452. }
  9453. },
  9454. "/user/starred/{owner}/{repo}": {
  9455. "get": {
  9456. "tags": [
  9457. "user"
  9458. ],
  9459. "summary": "Whether the authenticated is starring the repo",
  9460. "operationId": "userCurrentCheckStarring",
  9461. "parameters": [
  9462. {
  9463. "type": "string",
  9464. "description": "owner of the repo",
  9465. "name": "owner",
  9466. "in": "path",
  9467. "required": true
  9468. },
  9469. {
  9470. "type": "string",
  9471. "description": "name of the repo",
  9472. "name": "repo",
  9473. "in": "path",
  9474. "required": true
  9475. }
  9476. ],
  9477. "responses": {
  9478. "204": {
  9479. "$ref": "#/responses/empty"
  9480. },
  9481. "404": {
  9482. "$ref": "#/responses/notFound"
  9483. }
  9484. }
  9485. },
  9486. "put": {
  9487. "tags": [
  9488. "user"
  9489. ],
  9490. "summary": "Star the given repo",
  9491. "operationId": "userCurrentPutStar",
  9492. "parameters": [
  9493. {
  9494. "type": "string",
  9495. "description": "owner of the repo to star",
  9496. "name": "owner",
  9497. "in": "path",
  9498. "required": true
  9499. },
  9500. {
  9501. "type": "string",
  9502. "description": "name of the repo to star",
  9503. "name": "repo",
  9504. "in": "path",
  9505. "required": true
  9506. }
  9507. ],
  9508. "responses": {
  9509. "204": {
  9510. "$ref": "#/responses/empty"
  9511. }
  9512. }
  9513. },
  9514. "delete": {
  9515. "tags": [
  9516. "user"
  9517. ],
  9518. "summary": "Unstar the given repo",
  9519. "operationId": "userCurrentDeleteStar",
  9520. "parameters": [
  9521. {
  9522. "type": "string",
  9523. "description": "owner of the repo to unstar",
  9524. "name": "owner",
  9525. "in": "path",
  9526. "required": true
  9527. },
  9528. {
  9529. "type": "string",
  9530. "description": "name of the repo to unstar",
  9531. "name": "repo",
  9532. "in": "path",
  9533. "required": true
  9534. }
  9535. ],
  9536. "responses": {
  9537. "204": {
  9538. "$ref": "#/responses/empty"
  9539. }
  9540. }
  9541. }
  9542. },
  9543. "/user/stopwatches": {
  9544. "get": {
  9545. "consumes": [
  9546. "application/json"
  9547. ],
  9548. "produces": [
  9549. "application/json"
  9550. ],
  9551. "tags": [
  9552. "user"
  9553. ],
  9554. "summary": "Get list of all existing stopwatches",
  9555. "operationId": "userGetStopWatches",
  9556. "parameters": [
  9557. {
  9558. "type": "integer",
  9559. "description": "page number of results to return (1-based)",
  9560. "name": "page",
  9561. "in": "query"
  9562. },
  9563. {
  9564. "type": "integer",
  9565. "description": "page size of results, maximum page size is 50",
  9566. "name": "limit",
  9567. "in": "query"
  9568. }
  9569. ],
  9570. "responses": {
  9571. "200": {
  9572. "$ref": "#/responses/StopWatchList"
  9573. }
  9574. }
  9575. }
  9576. },
  9577. "/user/subscriptions": {
  9578. "get": {
  9579. "produces": [
  9580. "application/json"
  9581. ],
  9582. "tags": [
  9583. "user"
  9584. ],
  9585. "summary": "List repositories watched by the authenticated user",
  9586. "operationId": "userCurrentListSubscriptions",
  9587. "parameters": [
  9588. {
  9589. "type": "integer",
  9590. "description": "page number of results to return (1-based)",
  9591. "name": "page",
  9592. "in": "query"
  9593. },
  9594. {
  9595. "type": "integer",
  9596. "description": "page size of results, maximum page size is 50",
  9597. "name": "limit",
  9598. "in": "query"
  9599. }
  9600. ],
  9601. "responses": {
  9602. "200": {
  9603. "$ref": "#/responses/RepositoryList"
  9604. }
  9605. }
  9606. }
  9607. },
  9608. "/user/teams": {
  9609. "get": {
  9610. "produces": [
  9611. "application/json"
  9612. ],
  9613. "tags": [
  9614. "user"
  9615. ],
  9616. "summary": "List all the teams a user belongs to",
  9617. "operationId": "userListTeams",
  9618. "parameters": [
  9619. {
  9620. "type": "integer",
  9621. "description": "page number of results to return (1-based)",
  9622. "name": "page",
  9623. "in": "query"
  9624. },
  9625. {
  9626. "type": "integer",
  9627. "description": "page size of results, maximum page size is 50",
  9628. "name": "limit",
  9629. "in": "query"
  9630. }
  9631. ],
  9632. "responses": {
  9633. "200": {
  9634. "$ref": "#/responses/TeamList"
  9635. }
  9636. }
  9637. }
  9638. },
  9639. "/user/times": {
  9640. "get": {
  9641. "produces": [
  9642. "application/json"
  9643. ],
  9644. "tags": [
  9645. "user"
  9646. ],
  9647. "summary": "List the current user's tracked times",
  9648. "operationId": "userCurrentTrackedTimes",
  9649. "parameters": [
  9650. {
  9651. "type": "string",
  9652. "format": "date-time",
  9653. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9654. "name": "since",
  9655. "in": "query"
  9656. },
  9657. {
  9658. "type": "string",
  9659. "format": "date-time",
  9660. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9661. "name": "before",
  9662. "in": "query"
  9663. }
  9664. ],
  9665. "responses": {
  9666. "200": {
  9667. "$ref": "#/responses/TrackedTimeList"
  9668. }
  9669. }
  9670. }
  9671. },
  9672. "/users/search": {
  9673. "get": {
  9674. "produces": [
  9675. "application/json"
  9676. ],
  9677. "tags": [
  9678. "user"
  9679. ],
  9680. "summary": "Search for users",
  9681. "operationId": "userSearch",
  9682. "parameters": [
  9683. {
  9684. "type": "string",
  9685. "description": "keyword",
  9686. "name": "q",
  9687. "in": "query"
  9688. },
  9689. {
  9690. "type": "integer",
  9691. "format": "int64",
  9692. "description": "ID of the user to search for",
  9693. "name": "uid",
  9694. "in": "query"
  9695. },
  9696. {
  9697. "type": "integer",
  9698. "description": "page number of results to return (1-based)",
  9699. "name": "page",
  9700. "in": "query"
  9701. },
  9702. {
  9703. "type": "integer",
  9704. "description": "page size of results, maximum page size is 50",
  9705. "name": "limit",
  9706. "in": "query"
  9707. }
  9708. ],
  9709. "responses": {
  9710. "200": {
  9711. "description": "SearchResults of a successful search",
  9712. "schema": {
  9713. "type": "object",
  9714. "properties": {
  9715. "data": {
  9716. "type": "array",
  9717. "items": {
  9718. "$ref": "#/definitions/User"
  9719. }
  9720. },
  9721. "ok": {
  9722. "type": "boolean"
  9723. }
  9724. }
  9725. }
  9726. }
  9727. }
  9728. }
  9729. },
  9730. "/users/{follower}/following/{followee}": {
  9731. "get": {
  9732. "tags": [
  9733. "user"
  9734. ],
  9735. "summary": "Check if one user is following another user",
  9736. "operationId": "userCheckFollowing",
  9737. "parameters": [
  9738. {
  9739. "type": "string",
  9740. "description": "username of following user",
  9741. "name": "follower",
  9742. "in": "path",
  9743. "required": true
  9744. },
  9745. {
  9746. "type": "string",
  9747. "description": "username of followed user",
  9748. "name": "followee",
  9749. "in": "path",
  9750. "required": true
  9751. }
  9752. ],
  9753. "responses": {
  9754. "204": {
  9755. "$ref": "#/responses/empty"
  9756. },
  9757. "404": {
  9758. "$ref": "#/responses/notFound"
  9759. }
  9760. }
  9761. }
  9762. },
  9763. "/users/{username}": {
  9764. "get": {
  9765. "produces": [
  9766. "application/json"
  9767. ],
  9768. "tags": [
  9769. "user"
  9770. ],
  9771. "summary": "Get a user",
  9772. "operationId": "userGet",
  9773. "parameters": [
  9774. {
  9775. "type": "string",
  9776. "description": "username of user to get",
  9777. "name": "username",
  9778. "in": "path",
  9779. "required": true
  9780. }
  9781. ],
  9782. "responses": {
  9783. "200": {
  9784. "$ref": "#/responses/User"
  9785. },
  9786. "404": {
  9787. "$ref": "#/responses/notFound"
  9788. }
  9789. }
  9790. }
  9791. },
  9792. "/users/{username}/followers": {
  9793. "get": {
  9794. "produces": [
  9795. "application/json"
  9796. ],
  9797. "tags": [
  9798. "user"
  9799. ],
  9800. "summary": "List the given user's followers",
  9801. "operationId": "userListFollowers",
  9802. "parameters": [
  9803. {
  9804. "type": "string",
  9805. "description": "username of user",
  9806. "name": "username",
  9807. "in": "path",
  9808. "required": true
  9809. },
  9810. {
  9811. "type": "integer",
  9812. "description": "page number of results to return (1-based)",
  9813. "name": "page",
  9814. "in": "query"
  9815. },
  9816. {
  9817. "type": "integer",
  9818. "description": "page size of results, maximum page size is 50",
  9819. "name": "limit",
  9820. "in": "query"
  9821. }
  9822. ],
  9823. "responses": {
  9824. "200": {
  9825. "$ref": "#/responses/UserList"
  9826. }
  9827. }
  9828. }
  9829. },
  9830. "/users/{username}/following": {
  9831. "get": {
  9832. "produces": [
  9833. "application/json"
  9834. ],
  9835. "tags": [
  9836. "user"
  9837. ],
  9838. "summary": "List the users that the given user is following",
  9839. "operationId": "userListFollowing",
  9840. "parameters": [
  9841. {
  9842. "type": "string",
  9843. "description": "username of user",
  9844. "name": "username",
  9845. "in": "path",
  9846. "required": true
  9847. },
  9848. {
  9849. "type": "integer",
  9850. "description": "page number of results to return (1-based)",
  9851. "name": "page",
  9852. "in": "query"
  9853. },
  9854. {
  9855. "type": "integer",
  9856. "description": "page size of results, maximum page size is 50",
  9857. "name": "limit",
  9858. "in": "query"
  9859. }
  9860. ],
  9861. "responses": {
  9862. "200": {
  9863. "$ref": "#/responses/UserList"
  9864. }
  9865. }
  9866. }
  9867. },
  9868. "/users/{username}/gpg_keys": {
  9869. "get": {
  9870. "produces": [
  9871. "application/json"
  9872. ],
  9873. "tags": [
  9874. "user"
  9875. ],
  9876. "summary": "List the given user's GPG keys",
  9877. "operationId": "userListGPGKeys",
  9878. "parameters": [
  9879. {
  9880. "type": "string",
  9881. "description": "username of user",
  9882. "name": "username",
  9883. "in": "path",
  9884. "required": true
  9885. },
  9886. {
  9887. "type": "integer",
  9888. "description": "page number of results to return (1-based)",
  9889. "name": "page",
  9890. "in": "query"
  9891. },
  9892. {
  9893. "type": "integer",
  9894. "description": "page size of results, maximum page size is 50",
  9895. "name": "limit",
  9896. "in": "query"
  9897. }
  9898. ],
  9899. "responses": {
  9900. "200": {
  9901. "$ref": "#/responses/GPGKeyList"
  9902. }
  9903. }
  9904. }
  9905. },
  9906. "/users/{username}/heatmap": {
  9907. "get": {
  9908. "produces": [
  9909. "application/json"
  9910. ],
  9911. "tags": [
  9912. "user"
  9913. ],
  9914. "summary": "Get a user's heatmap",
  9915. "operationId": "userGetHeatmapData",
  9916. "parameters": [
  9917. {
  9918. "type": "string",
  9919. "description": "username of user to get",
  9920. "name": "username",
  9921. "in": "path",
  9922. "required": true
  9923. }
  9924. ],
  9925. "responses": {
  9926. "200": {
  9927. "$ref": "#/responses/UserHeatmapData"
  9928. },
  9929. "404": {
  9930. "$ref": "#/responses/notFound"
  9931. }
  9932. }
  9933. }
  9934. },
  9935. "/users/{username}/keys": {
  9936. "get": {
  9937. "produces": [
  9938. "application/json"
  9939. ],
  9940. "tags": [
  9941. "user"
  9942. ],
  9943. "summary": "List the given user's public keys",
  9944. "operationId": "userListKeys",
  9945. "parameters": [
  9946. {
  9947. "type": "string",
  9948. "description": "username of user",
  9949. "name": "username",
  9950. "in": "path",
  9951. "required": true
  9952. },
  9953. {
  9954. "type": "string",
  9955. "description": "fingerprint of the key",
  9956. "name": "fingerprint",
  9957. "in": "query"
  9958. },
  9959. {
  9960. "type": "integer",
  9961. "description": "page number of results to return (1-based)",
  9962. "name": "page",
  9963. "in": "query"
  9964. },
  9965. {
  9966. "type": "integer",
  9967. "description": "page size of results, maximum page size is 50",
  9968. "name": "limit",
  9969. "in": "query"
  9970. }
  9971. ],
  9972. "responses": {
  9973. "200": {
  9974. "$ref": "#/responses/PublicKeyList"
  9975. }
  9976. }
  9977. }
  9978. },
  9979. "/users/{username}/orgs": {
  9980. "get": {
  9981. "produces": [
  9982. "application/json"
  9983. ],
  9984. "tags": [
  9985. "organization"
  9986. ],
  9987. "summary": "List a user's organizations",
  9988. "operationId": "orgListUserOrgs",
  9989. "parameters": [
  9990. {
  9991. "type": "string",
  9992. "description": "username of user",
  9993. "name": "username",
  9994. "in": "path",
  9995. "required": true
  9996. },
  9997. {
  9998. "type": "integer",
  9999. "description": "page number of results to return (1-based)",
  10000. "name": "page",
  10001. "in": "query"
  10002. },
  10003. {
  10004. "type": "integer",
  10005. "description": "page size of results, maximum page size is 50",
  10006. "name": "limit",
  10007. "in": "query"
  10008. }
  10009. ],
  10010. "responses": {
  10011. "200": {
  10012. "$ref": "#/responses/OrganizationList"
  10013. }
  10014. }
  10015. }
  10016. },
  10017. "/users/{username}/repos": {
  10018. "get": {
  10019. "produces": [
  10020. "application/json"
  10021. ],
  10022. "tags": [
  10023. "user"
  10024. ],
  10025. "summary": "List the repos owned by the given user",
  10026. "operationId": "userListRepos",
  10027. "parameters": [
  10028. {
  10029. "type": "string",
  10030. "description": "username of user",
  10031. "name": "username",
  10032. "in": "path",
  10033. "required": true
  10034. },
  10035. {
  10036. "type": "integer",
  10037. "description": "page number of results to return (1-based)",
  10038. "name": "page",
  10039. "in": "query"
  10040. },
  10041. {
  10042. "type": "integer",
  10043. "description": "page size of results, maximum page size is 50",
  10044. "name": "limit",
  10045. "in": "query"
  10046. }
  10047. ],
  10048. "responses": {
  10049. "200": {
  10050. "$ref": "#/responses/RepositoryList"
  10051. }
  10052. }
  10053. }
  10054. },
  10055. "/users/{username}/starred": {
  10056. "get": {
  10057. "produces": [
  10058. "application/json"
  10059. ],
  10060. "tags": [
  10061. "user"
  10062. ],
  10063. "summary": "The repos that the given user has starred",
  10064. "operationId": "userListStarred",
  10065. "parameters": [
  10066. {
  10067. "type": "string",
  10068. "description": "username of user",
  10069. "name": "username",
  10070. "in": "path",
  10071. "required": true
  10072. },
  10073. {
  10074. "type": "integer",
  10075. "description": "page number of results to return (1-based)",
  10076. "name": "page",
  10077. "in": "query"
  10078. },
  10079. {
  10080. "type": "integer",
  10081. "description": "page size of results, maximum page size is 50",
  10082. "name": "limit",
  10083. "in": "query"
  10084. }
  10085. ],
  10086. "responses": {
  10087. "200": {
  10088. "$ref": "#/responses/RepositoryList"
  10089. }
  10090. }
  10091. }
  10092. },
  10093. "/users/{username}/subscriptions": {
  10094. "get": {
  10095. "produces": [
  10096. "application/json"
  10097. ],
  10098. "tags": [
  10099. "user"
  10100. ],
  10101. "summary": "List the repositories watched by a user",
  10102. "operationId": "userListSubscriptions",
  10103. "parameters": [
  10104. {
  10105. "type": "string",
  10106. "description": "username of the user",
  10107. "name": "username",
  10108. "in": "path",
  10109. "required": true
  10110. },
  10111. {
  10112. "type": "integer",
  10113. "description": "page number of results to return (1-based)",
  10114. "name": "page",
  10115. "in": "query"
  10116. },
  10117. {
  10118. "type": "integer",
  10119. "description": "page size of results, maximum page size is 50",
  10120. "name": "limit",
  10121. "in": "query"
  10122. }
  10123. ],
  10124. "responses": {
  10125. "200": {
  10126. "$ref": "#/responses/RepositoryList"
  10127. }
  10128. }
  10129. }
  10130. },
  10131. "/users/{username}/tokens": {
  10132. "get": {
  10133. "produces": [
  10134. "application/json"
  10135. ],
  10136. "tags": [
  10137. "user"
  10138. ],
  10139. "summary": "List the authenticated user's access tokens",
  10140. "operationId": "userGetTokens",
  10141. "parameters": [
  10142. {
  10143. "type": "string",
  10144. "description": "username of user",
  10145. "name": "username",
  10146. "in": "path",
  10147. "required": true
  10148. },
  10149. {
  10150. "type": "integer",
  10151. "description": "page number of results to return (1-based)",
  10152. "name": "page",
  10153. "in": "query"
  10154. },
  10155. {
  10156. "type": "integer",
  10157. "description": "page size of results, maximum page size is 50",
  10158. "name": "limit",
  10159. "in": "query"
  10160. }
  10161. ],
  10162. "responses": {
  10163. "200": {
  10164. "$ref": "#/responses/AccessTokenList"
  10165. }
  10166. }
  10167. },
  10168. "post": {
  10169. "consumes": [
  10170. "application/json"
  10171. ],
  10172. "produces": [
  10173. "application/json"
  10174. ],
  10175. "tags": [
  10176. "user"
  10177. ],
  10178. "summary": "Create an access token",
  10179. "operationId": "userCreateToken",
  10180. "parameters": [
  10181. {
  10182. "type": "string",
  10183. "x-go-name": "Name",
  10184. "description": "username of user",
  10185. "name": "username",
  10186. "in": "path",
  10187. "required": true
  10188. },
  10189. {
  10190. "name": "accessToken",
  10191. "in": "body",
  10192. "schema": {
  10193. "type": "object",
  10194. "required": [
  10195. "name"
  10196. ],
  10197. "properties": {
  10198. "name": {
  10199. "type": "string"
  10200. }
  10201. }
  10202. }
  10203. }
  10204. ],
  10205. "responses": {
  10206. "200": {
  10207. "$ref": "#/responses/AccessToken"
  10208. }
  10209. }
  10210. }
  10211. },
  10212. "/users/{username}/tokens/{token}": {
  10213. "delete": {
  10214. "produces": [
  10215. "application/json"
  10216. ],
  10217. "tags": [
  10218. "user"
  10219. ],
  10220. "summary": "delete an access token",
  10221. "operationId": "userDeleteAccessToken",
  10222. "parameters": [
  10223. {
  10224. "type": "string",
  10225. "description": "username of user",
  10226. "name": "username",
  10227. "in": "path",
  10228. "required": true
  10229. },
  10230. {
  10231. "type": "integer",
  10232. "format": "int64",
  10233. "description": "token to be deleted",
  10234. "name": "token",
  10235. "in": "path",
  10236. "required": true
  10237. }
  10238. ],
  10239. "responses": {
  10240. "204": {
  10241. "$ref": "#/responses/empty"
  10242. }
  10243. }
  10244. }
  10245. },
  10246. "/version": {
  10247. "get": {
  10248. "produces": [
  10249. "application/json"
  10250. ],
  10251. "tags": [
  10252. "miscellaneous"
  10253. ],
  10254. "summary": "Returns the version of the Gitea application",
  10255. "operationId": "getVersion",
  10256. "responses": {
  10257. "200": {
  10258. "$ref": "#/responses/ServerVersion"
  10259. }
  10260. }
  10261. }
  10262. }
  10263. },
  10264. "definitions": {
  10265. "APIError": {
  10266. "description": "APIError is an api error with a message",
  10267. "type": "object",
  10268. "properties": {
  10269. "message": {
  10270. "type": "string",
  10271. "x-go-name": "Message"
  10272. },
  10273. "url": {
  10274. "type": "string",
  10275. "x-go-name": "URL"
  10276. }
  10277. },
  10278. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10279. },
  10280. "AccessToken": {
  10281. "type": "object",
  10282. "title": "AccessToken represents an API access token.",
  10283. "properties": {
  10284. "id": {
  10285. "type": "integer",
  10286. "format": "int64",
  10287. "x-go-name": "ID"
  10288. },
  10289. "name": {
  10290. "type": "string",
  10291. "x-go-name": "Name"
  10292. },
  10293. "sha1": {
  10294. "type": "string",
  10295. "x-go-name": "Token"
  10296. },
  10297. "token_last_eight": {
  10298. "type": "string",
  10299. "x-go-name": "TokenLastEight"
  10300. }
  10301. },
  10302. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10303. },
  10304. "AddCollaboratorOption": {
  10305. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  10306. "type": "object",
  10307. "properties": {
  10308. "permission": {
  10309. "type": "string",
  10310. "x-go-name": "Permission"
  10311. }
  10312. },
  10313. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10314. },
  10315. "AddTimeOption": {
  10316. "description": "AddTimeOption options for adding time to an issue",
  10317. "type": "object",
  10318. "required": [
  10319. "time"
  10320. ],
  10321. "properties": {
  10322. "created": {
  10323. "type": "string",
  10324. "format": "date-time",
  10325. "x-go-name": "Created"
  10326. },
  10327. "time": {
  10328. "description": "time in seconds",
  10329. "type": "integer",
  10330. "format": "int64",
  10331. "x-go-name": "Time"
  10332. },
  10333. "user_name": {
  10334. "description": "User who spent the time (optional)",
  10335. "type": "string",
  10336. "x-go-name": "User"
  10337. }
  10338. },
  10339. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10340. },
  10341. "AnnotatedTag": {
  10342. "description": "AnnotatedTag represents an annotated tag",
  10343. "type": "object",
  10344. "properties": {
  10345. "message": {
  10346. "type": "string",
  10347. "x-go-name": "Message"
  10348. },
  10349. "object": {
  10350. "$ref": "#/definitions/AnnotatedTagObject"
  10351. },
  10352. "sha": {
  10353. "type": "string",
  10354. "x-go-name": "SHA"
  10355. },
  10356. "tag": {
  10357. "type": "string",
  10358. "x-go-name": "Tag"
  10359. },
  10360. "tagger": {
  10361. "$ref": "#/definitions/CommitUser"
  10362. },
  10363. "url": {
  10364. "type": "string",
  10365. "x-go-name": "URL"
  10366. },
  10367. "verification": {
  10368. "$ref": "#/definitions/PayloadCommitVerification"
  10369. }
  10370. },
  10371. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10372. },
  10373. "AnnotatedTagObject": {
  10374. "description": "AnnotatedTagObject contains meta information of the tag object",
  10375. "type": "object",
  10376. "properties": {
  10377. "sha": {
  10378. "type": "string",
  10379. "x-go-name": "SHA"
  10380. },
  10381. "type": {
  10382. "type": "string",
  10383. "x-go-name": "Type"
  10384. },
  10385. "url": {
  10386. "type": "string",
  10387. "x-go-name": "URL"
  10388. }
  10389. },
  10390. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10391. },
  10392. "Attachment": {
  10393. "description": "Attachment a generic attachment",
  10394. "type": "object",
  10395. "properties": {
  10396. "browser_download_url": {
  10397. "type": "string",
  10398. "x-go-name": "DownloadURL"
  10399. },
  10400. "created_at": {
  10401. "type": "string",
  10402. "format": "date-time",
  10403. "x-go-name": "Created"
  10404. },
  10405. "download_count": {
  10406. "type": "integer",
  10407. "format": "int64",
  10408. "x-go-name": "DownloadCount"
  10409. },
  10410. "id": {
  10411. "type": "integer",
  10412. "format": "int64",
  10413. "x-go-name": "ID"
  10414. },
  10415. "name": {
  10416. "type": "string",
  10417. "x-go-name": "Name"
  10418. },
  10419. "size": {
  10420. "type": "integer",
  10421. "format": "int64",
  10422. "x-go-name": "Size"
  10423. },
  10424. "uuid": {
  10425. "type": "string",
  10426. "x-go-name": "UUID"
  10427. }
  10428. },
  10429. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10430. },
  10431. "Branch": {
  10432. "description": "Branch represents a repository branch",
  10433. "type": "object",
  10434. "properties": {
  10435. "commit": {
  10436. "$ref": "#/definitions/PayloadCommit"
  10437. },
  10438. "effective_branch_protection_name": {
  10439. "type": "string",
  10440. "x-go-name": "EffectiveBranchProtectionName"
  10441. },
  10442. "enable_status_check": {
  10443. "type": "boolean",
  10444. "x-go-name": "EnableStatusCheck"
  10445. },
  10446. "name": {
  10447. "type": "string",
  10448. "x-go-name": "Name"
  10449. },
  10450. "protected": {
  10451. "type": "boolean",
  10452. "x-go-name": "Protected"
  10453. },
  10454. "required_approvals": {
  10455. "type": "integer",
  10456. "format": "int64",
  10457. "x-go-name": "RequiredApprovals"
  10458. },
  10459. "status_check_contexts": {
  10460. "type": "array",
  10461. "items": {
  10462. "type": "string"
  10463. },
  10464. "x-go-name": "StatusCheckContexts"
  10465. },
  10466. "user_can_merge": {
  10467. "type": "boolean",
  10468. "x-go-name": "UserCanMerge"
  10469. },
  10470. "user_can_push": {
  10471. "type": "boolean",
  10472. "x-go-name": "UserCanPush"
  10473. }
  10474. },
  10475. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10476. },
  10477. "BranchProtection": {
  10478. "description": "BranchProtection represents a branch protection for a repository",
  10479. "type": "object",
  10480. "properties": {
  10481. "approvals_whitelist_teams": {
  10482. "type": "array",
  10483. "items": {
  10484. "type": "string"
  10485. },
  10486. "x-go-name": "ApprovalsWhitelistTeams"
  10487. },
  10488. "approvals_whitelist_username": {
  10489. "type": "array",
  10490. "items": {
  10491. "type": "string"
  10492. },
  10493. "x-go-name": "ApprovalsWhitelistUsernames"
  10494. },
  10495. "block_on_outdated_branch": {
  10496. "type": "boolean",
  10497. "x-go-name": "BlockOnOutdatedBranch"
  10498. },
  10499. "block_on_rejected_reviews": {
  10500. "type": "boolean",
  10501. "x-go-name": "BlockOnRejectedReviews"
  10502. },
  10503. "branch_name": {
  10504. "type": "string",
  10505. "x-go-name": "BranchName"
  10506. },
  10507. "created_at": {
  10508. "type": "string",
  10509. "format": "date-time",
  10510. "x-go-name": "Created"
  10511. },
  10512. "dismiss_stale_approvals": {
  10513. "type": "boolean",
  10514. "x-go-name": "DismissStaleApprovals"
  10515. },
  10516. "enable_approvals_whitelist": {
  10517. "type": "boolean",
  10518. "x-go-name": "EnableApprovalsWhitelist"
  10519. },
  10520. "enable_merge_whitelist": {
  10521. "type": "boolean",
  10522. "x-go-name": "EnableMergeWhitelist"
  10523. },
  10524. "enable_push": {
  10525. "type": "boolean",
  10526. "x-go-name": "EnablePush"
  10527. },
  10528. "enable_push_whitelist": {
  10529. "type": "boolean",
  10530. "x-go-name": "EnablePushWhitelist"
  10531. },
  10532. "enable_status_check": {
  10533. "type": "boolean",
  10534. "x-go-name": "EnableStatusCheck"
  10535. },
  10536. "merge_whitelist_teams": {
  10537. "type": "array",
  10538. "items": {
  10539. "type": "string"
  10540. },
  10541. "x-go-name": "MergeWhitelistTeams"
  10542. },
  10543. "merge_whitelist_usernames": {
  10544. "type": "array",
  10545. "items": {
  10546. "type": "string"
  10547. },
  10548. "x-go-name": "MergeWhitelistUsernames"
  10549. },
  10550. "protected_file_patterns": {
  10551. "type": "string",
  10552. "x-go-name": "ProtectedFilePatterns"
  10553. },
  10554. "push_whitelist_deploy_keys": {
  10555. "type": "boolean",
  10556. "x-go-name": "PushWhitelistDeployKeys"
  10557. },
  10558. "push_whitelist_teams": {
  10559. "type": "array",
  10560. "items": {
  10561. "type": "string"
  10562. },
  10563. "x-go-name": "PushWhitelistTeams"
  10564. },
  10565. "push_whitelist_usernames": {
  10566. "type": "array",
  10567. "items": {
  10568. "type": "string"
  10569. },
  10570. "x-go-name": "PushWhitelistUsernames"
  10571. },
  10572. "require_signed_commits": {
  10573. "type": "boolean",
  10574. "x-go-name": "RequireSignedCommits"
  10575. },
  10576. "required_approvals": {
  10577. "type": "integer",
  10578. "format": "int64",
  10579. "x-go-name": "RequiredApprovals"
  10580. },
  10581. "status_check_contexts": {
  10582. "type": "array",
  10583. "items": {
  10584. "type": "string"
  10585. },
  10586. "x-go-name": "StatusCheckContexts"
  10587. },
  10588. "updated_at": {
  10589. "type": "string",
  10590. "format": "date-time",
  10591. "x-go-name": "Updated"
  10592. }
  10593. },
  10594. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10595. },
  10596. "Comment": {
  10597. "description": "Comment represents a comment on a commit or issue",
  10598. "type": "object",
  10599. "properties": {
  10600. "body": {
  10601. "type": "string",
  10602. "x-go-name": "Body"
  10603. },
  10604. "created_at": {
  10605. "type": "string",
  10606. "format": "date-time",
  10607. "x-go-name": "Created"
  10608. },
  10609. "html_url": {
  10610. "type": "string",
  10611. "x-go-name": "HTMLURL"
  10612. },
  10613. "id": {
  10614. "type": "integer",
  10615. "format": "int64",
  10616. "x-go-name": "ID"
  10617. },
  10618. "issue_url": {
  10619. "type": "string",
  10620. "x-go-name": "IssueURL"
  10621. },
  10622. "original_author": {
  10623. "type": "string",
  10624. "x-go-name": "OriginalAuthor"
  10625. },
  10626. "original_author_id": {
  10627. "type": "integer",
  10628. "format": "int64",
  10629. "x-go-name": "OriginalAuthorID"
  10630. },
  10631. "pull_request_url": {
  10632. "type": "string",
  10633. "x-go-name": "PRURL"
  10634. },
  10635. "updated_at": {
  10636. "type": "string",
  10637. "format": "date-time",
  10638. "x-go-name": "Updated"
  10639. },
  10640. "user": {
  10641. "$ref": "#/definitions/User"
  10642. }
  10643. },
  10644. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10645. },
  10646. "Commit": {
  10647. "type": "object",
  10648. "title": "Commit contains information generated from a Git commit.",
  10649. "properties": {
  10650. "author": {
  10651. "$ref": "#/definitions/User"
  10652. },
  10653. "commit": {
  10654. "$ref": "#/definitions/RepoCommit"
  10655. },
  10656. "committer": {
  10657. "$ref": "#/definitions/User"
  10658. },
  10659. "html_url": {
  10660. "type": "string",
  10661. "x-go-name": "HTMLURL"
  10662. },
  10663. "parents": {
  10664. "type": "array",
  10665. "items": {
  10666. "$ref": "#/definitions/CommitMeta"
  10667. },
  10668. "x-go-name": "Parents"
  10669. },
  10670. "sha": {
  10671. "type": "string",
  10672. "x-go-name": "SHA"
  10673. },
  10674. "url": {
  10675. "type": "string",
  10676. "x-go-name": "URL"
  10677. }
  10678. },
  10679. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10680. },
  10681. "CommitDateOptions": {
  10682. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  10683. "type": "object",
  10684. "properties": {
  10685. "author": {
  10686. "type": "string",
  10687. "format": "date-time",
  10688. "x-go-name": "Author"
  10689. },
  10690. "committer": {
  10691. "type": "string",
  10692. "format": "date-time",
  10693. "x-go-name": "Committer"
  10694. }
  10695. },
  10696. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10697. },
  10698. "CommitMeta": {
  10699. "type": "object",
  10700. "title": "CommitMeta contains meta information of a commit in terms of API.",
  10701. "properties": {
  10702. "sha": {
  10703. "type": "string",
  10704. "x-go-name": "SHA"
  10705. },
  10706. "url": {
  10707. "type": "string",
  10708. "x-go-name": "URL"
  10709. }
  10710. },
  10711. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10712. },
  10713. "CommitUser": {
  10714. "type": "object",
  10715. "title": "CommitUser contains information of a user in the context of a commit.",
  10716. "properties": {
  10717. "date": {
  10718. "type": "string",
  10719. "x-go-name": "Date"
  10720. },
  10721. "email": {
  10722. "type": "string",
  10723. "format": "email",
  10724. "x-go-name": "Email"
  10725. },
  10726. "name": {
  10727. "type": "string",
  10728. "x-go-name": "Name"
  10729. }
  10730. },
  10731. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10732. },
  10733. "ContentsResponse": {
  10734. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  10735. "type": "object",
  10736. "properties": {
  10737. "_links": {
  10738. "$ref": "#/definitions/FileLinksResponse"
  10739. },
  10740. "content": {
  10741. "description": "`content` is populated when `type` is `file`, otherwise null",
  10742. "type": "string",
  10743. "x-go-name": "Content"
  10744. },
  10745. "download_url": {
  10746. "type": "string",
  10747. "x-go-name": "DownloadURL"
  10748. },
  10749. "encoding": {
  10750. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  10751. "type": "string",
  10752. "x-go-name": "Encoding"
  10753. },
  10754. "git_url": {
  10755. "type": "string",
  10756. "x-go-name": "GitURL"
  10757. },
  10758. "html_url": {
  10759. "type": "string",
  10760. "x-go-name": "HTMLURL"
  10761. },
  10762. "name": {
  10763. "type": "string",
  10764. "x-go-name": "Name"
  10765. },
  10766. "path": {
  10767. "type": "string",
  10768. "x-go-name": "Path"
  10769. },
  10770. "sha": {
  10771. "type": "string",
  10772. "x-go-name": "SHA"
  10773. },
  10774. "size": {
  10775. "type": "integer",
  10776. "format": "int64",
  10777. "x-go-name": "Size"
  10778. },
  10779. "submodule_git_url": {
  10780. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  10781. "type": "string",
  10782. "x-go-name": "SubmoduleGitURL"
  10783. },
  10784. "target": {
  10785. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  10786. "type": "string",
  10787. "x-go-name": "Target"
  10788. },
  10789. "type": {
  10790. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  10791. "type": "string",
  10792. "x-go-name": "Type"
  10793. },
  10794. "url": {
  10795. "type": "string",
  10796. "x-go-name": "URL"
  10797. }
  10798. },
  10799. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10800. },
  10801. "CreateBranchProtectionOption": {
  10802. "description": "CreateBranchProtectionOption options for creating a branch protection",
  10803. "type": "object",
  10804. "properties": {
  10805. "approvals_whitelist_teams": {
  10806. "type": "array",
  10807. "items": {
  10808. "type": "string"
  10809. },
  10810. "x-go-name": "ApprovalsWhitelistTeams"
  10811. },
  10812. "approvals_whitelist_username": {
  10813. "type": "array",
  10814. "items": {
  10815. "type": "string"
  10816. },
  10817. "x-go-name": "ApprovalsWhitelistUsernames"
  10818. },
  10819. "block_on_outdated_branch": {
  10820. "type": "boolean",
  10821. "x-go-name": "BlockOnOutdatedBranch"
  10822. },
  10823. "block_on_rejected_reviews": {
  10824. "type": "boolean",
  10825. "x-go-name": "BlockOnRejectedReviews"
  10826. },
  10827. "branch_name": {
  10828. "type": "string",
  10829. "x-go-name": "BranchName"
  10830. },
  10831. "dismiss_stale_approvals": {
  10832. "type": "boolean",
  10833. "x-go-name": "DismissStaleApprovals"
  10834. },
  10835. "enable_approvals_whitelist": {
  10836. "type": "boolean",
  10837. "x-go-name": "EnableApprovalsWhitelist"
  10838. },
  10839. "enable_merge_whitelist": {
  10840. "type": "boolean",
  10841. "x-go-name": "EnableMergeWhitelist"
  10842. },
  10843. "enable_push": {
  10844. "type": "boolean",
  10845. "x-go-name": "EnablePush"
  10846. },
  10847. "enable_push_whitelist": {
  10848. "type": "boolean",
  10849. "x-go-name": "EnablePushWhitelist"
  10850. },
  10851. "enable_status_check": {
  10852. "type": "boolean",
  10853. "x-go-name": "EnableStatusCheck"
  10854. },
  10855. "merge_whitelist_teams": {
  10856. "type": "array",
  10857. "items": {
  10858. "type": "string"
  10859. },
  10860. "x-go-name": "MergeWhitelistTeams"
  10861. },
  10862. "merge_whitelist_usernames": {
  10863. "type": "array",
  10864. "items": {
  10865. "type": "string"
  10866. },
  10867. "x-go-name": "MergeWhitelistUsernames"
  10868. },
  10869. "protected_file_patterns": {
  10870. "type": "string",
  10871. "x-go-name": "ProtectedFilePatterns"
  10872. },
  10873. "push_whitelist_deploy_keys": {
  10874. "type": "boolean",
  10875. "x-go-name": "PushWhitelistDeployKeys"
  10876. },
  10877. "push_whitelist_teams": {
  10878. "type": "array",
  10879. "items": {
  10880. "type": "string"
  10881. },
  10882. "x-go-name": "PushWhitelistTeams"
  10883. },
  10884. "push_whitelist_usernames": {
  10885. "type": "array",
  10886. "items": {
  10887. "type": "string"
  10888. },
  10889. "x-go-name": "PushWhitelistUsernames"
  10890. },
  10891. "require_signed_commits": {
  10892. "type": "boolean",
  10893. "x-go-name": "RequireSignedCommits"
  10894. },
  10895. "required_approvals": {
  10896. "type": "integer",
  10897. "format": "int64",
  10898. "x-go-name": "RequiredApprovals"
  10899. },
  10900. "status_check_contexts": {
  10901. "type": "array",
  10902. "items": {
  10903. "type": "string"
  10904. },
  10905. "x-go-name": "StatusCheckContexts"
  10906. }
  10907. },
  10908. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10909. },
  10910. "CreateEmailOption": {
  10911. "description": "CreateEmailOption options when creating email addresses",
  10912. "type": "object",
  10913. "properties": {
  10914. "emails": {
  10915. "description": "email addresses to add",
  10916. "type": "array",
  10917. "items": {
  10918. "type": "string"
  10919. },
  10920. "x-go-name": "Emails"
  10921. }
  10922. },
  10923. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10924. },
  10925. "CreateFileOptions": {
  10926. "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)",
  10927. "type": "object",
  10928. "required": [
  10929. "content"
  10930. ],
  10931. "properties": {
  10932. "author": {
  10933. "$ref": "#/definitions/Identity"
  10934. },
  10935. "branch": {
  10936. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10937. "type": "string",
  10938. "x-go-name": "BranchName"
  10939. },
  10940. "committer": {
  10941. "$ref": "#/definitions/Identity"
  10942. },
  10943. "content": {
  10944. "description": "content must be base64 encoded",
  10945. "type": "string",
  10946. "x-go-name": "Content"
  10947. },
  10948. "dates": {
  10949. "$ref": "#/definitions/CommitDateOptions"
  10950. },
  10951. "message": {
  10952. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10953. "type": "string",
  10954. "x-go-name": "Message"
  10955. },
  10956. "new_branch": {
  10957. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10958. "type": "string",
  10959. "x-go-name": "NewBranchName"
  10960. }
  10961. },
  10962. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10963. },
  10964. "CreateForkOption": {
  10965. "description": "CreateForkOption options for creating a fork",
  10966. "type": "object",
  10967. "properties": {
  10968. "organization": {
  10969. "description": "organization name, if forking into an organization",
  10970. "type": "string",
  10971. "x-go-name": "Organization"
  10972. }
  10973. },
  10974. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10975. },
  10976. "CreateGPGKeyOption": {
  10977. "description": "CreateGPGKeyOption options create user GPG key",
  10978. "type": "object",
  10979. "required": [
  10980. "armored_public_key"
  10981. ],
  10982. "properties": {
  10983. "armored_public_key": {
  10984. "description": "An armored GPG key to add",
  10985. "type": "string",
  10986. "uniqueItems": true,
  10987. "x-go-name": "ArmoredKey"
  10988. }
  10989. },
  10990. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10991. },
  10992. "CreateHookOption": {
  10993. "description": "CreateHookOption options when create a hook",
  10994. "type": "object",
  10995. "required": [
  10996. "type",
  10997. "config"
  10998. ],
  10999. "properties": {
  11000. "active": {
  11001. "type": "boolean",
  11002. "default": false,
  11003. "x-go-name": "Active"
  11004. },
  11005. "branch_filter": {
  11006. "type": "string",
  11007. "x-go-name": "BranchFilter"
  11008. },
  11009. "config": {
  11010. "$ref": "#/definitions/CreateHookOptionConfig"
  11011. },
  11012. "events": {
  11013. "type": "array",
  11014. "items": {
  11015. "type": "string"
  11016. },
  11017. "x-go-name": "Events"
  11018. },
  11019. "type": {
  11020. "type": "string",
  11021. "enum": [
  11022. "dingtalk",
  11023. "discord",
  11024. "gitea",
  11025. "gogs",
  11026. "msteams",
  11027. "slack",
  11028. "telegram",
  11029. "feishu"
  11030. ],
  11031. "x-go-name": "Type"
  11032. }
  11033. },
  11034. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11035. },
  11036. "CreateHookOptionConfig": {
  11037. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  11038. "type": "object",
  11039. "additionalProperties": {
  11040. "type": "string"
  11041. },
  11042. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11043. },
  11044. "CreateIssueCommentOption": {
  11045. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  11046. "type": "object",
  11047. "required": [
  11048. "body"
  11049. ],
  11050. "properties": {
  11051. "body": {
  11052. "type": "string",
  11053. "x-go-name": "Body"
  11054. }
  11055. },
  11056. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11057. },
  11058. "CreateIssueOption": {
  11059. "description": "CreateIssueOption options to create one issue",
  11060. "type": "object",
  11061. "required": [
  11062. "title"
  11063. ],
  11064. "properties": {
  11065. "assignee": {
  11066. "description": "username of assignee",
  11067. "type": "string",
  11068. "x-go-name": "Assignee"
  11069. },
  11070. "assignees": {
  11071. "type": "array",
  11072. "items": {
  11073. "type": "string"
  11074. },
  11075. "x-go-name": "Assignees"
  11076. },
  11077. "body": {
  11078. "type": "string",
  11079. "x-go-name": "Body"
  11080. },
  11081. "closed": {
  11082. "type": "boolean",
  11083. "x-go-name": "Closed"
  11084. },
  11085. "due_date": {
  11086. "type": "string",
  11087. "format": "date-time",
  11088. "x-go-name": "Deadline"
  11089. },
  11090. "labels": {
  11091. "description": "list of label ids",
  11092. "type": "array",
  11093. "items": {
  11094. "type": "integer",
  11095. "format": "int64"
  11096. },
  11097. "x-go-name": "Labels"
  11098. },
  11099. "milestone": {
  11100. "description": "milestone id",
  11101. "type": "integer",
  11102. "format": "int64",
  11103. "x-go-name": "Milestone"
  11104. },
  11105. "title": {
  11106. "type": "string",
  11107. "x-go-name": "Title"
  11108. }
  11109. },
  11110. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11111. },
  11112. "CreateKeyOption": {
  11113. "description": "CreateKeyOption options when creating a key",
  11114. "type": "object",
  11115. "required": [
  11116. "title",
  11117. "key"
  11118. ],
  11119. "properties": {
  11120. "key": {
  11121. "description": "An armored SSH key to add",
  11122. "type": "string",
  11123. "uniqueItems": true,
  11124. "x-go-name": "Key"
  11125. },
  11126. "read_only": {
  11127. "description": "Describe if the key has only read access or read/write",
  11128. "type": "boolean",
  11129. "x-go-name": "ReadOnly"
  11130. },
  11131. "title": {
  11132. "description": "Title of the key to add",
  11133. "type": "string",
  11134. "uniqueItems": true,
  11135. "x-go-name": "Title"
  11136. }
  11137. },
  11138. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11139. },
  11140. "CreateLabelOption": {
  11141. "description": "CreateLabelOption options for creating a label",
  11142. "type": "object",
  11143. "required": [
  11144. "name",
  11145. "color"
  11146. ],
  11147. "properties": {
  11148. "color": {
  11149. "type": "string",
  11150. "x-go-name": "Color",
  11151. "example": "#00aabb"
  11152. },
  11153. "description": {
  11154. "type": "string",
  11155. "x-go-name": "Description"
  11156. },
  11157. "name": {
  11158. "type": "string",
  11159. "x-go-name": "Name"
  11160. }
  11161. },
  11162. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11163. },
  11164. "CreateMilestoneOption": {
  11165. "description": "CreateMilestoneOption options for creating a milestone",
  11166. "type": "object",
  11167. "properties": {
  11168. "description": {
  11169. "type": "string",
  11170. "x-go-name": "Description"
  11171. },
  11172. "due_on": {
  11173. "type": "string",
  11174. "format": "date-time",
  11175. "x-go-name": "Deadline"
  11176. },
  11177. "title": {
  11178. "type": "string",
  11179. "x-go-name": "Title"
  11180. }
  11181. },
  11182. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11183. },
  11184. "CreateOAuth2ApplicationOptions": {
  11185. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  11186. "type": "object",
  11187. "properties": {
  11188. "name": {
  11189. "type": "string",
  11190. "x-go-name": "Name"
  11191. },
  11192. "redirect_uris": {
  11193. "type": "array",
  11194. "items": {
  11195. "type": "string"
  11196. },
  11197. "x-go-name": "RedirectURIs"
  11198. }
  11199. },
  11200. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11201. },
  11202. "CreateOrgOption": {
  11203. "description": "CreateOrgOption options for creating an organization",
  11204. "type": "object",
  11205. "required": [
  11206. "username"
  11207. ],
  11208. "properties": {
  11209. "description": {
  11210. "type": "string",
  11211. "x-go-name": "Description"
  11212. },
  11213. "full_name": {
  11214. "type": "string",
  11215. "x-go-name": "FullName"
  11216. },
  11217. "location": {
  11218. "type": "string",
  11219. "x-go-name": "Location"
  11220. },
  11221. "repo_admin_change_team_access": {
  11222. "type": "boolean",
  11223. "x-go-name": "RepoAdminChangeTeamAccess"
  11224. },
  11225. "username": {
  11226. "type": "string",
  11227. "x-go-name": "UserName"
  11228. },
  11229. "visibility": {
  11230. "description": "possible values are `public` (default), `limited` or `private`",
  11231. "type": "string",
  11232. "enum": [
  11233. "public",
  11234. "limited",
  11235. "private"
  11236. ],
  11237. "x-go-name": "Visibility"
  11238. },
  11239. "website": {
  11240. "type": "string",
  11241. "x-go-name": "Website"
  11242. }
  11243. },
  11244. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11245. },
  11246. "CreatePullRequestOption": {
  11247. "description": "CreatePullRequestOption options when creating a pull request",
  11248. "type": "object",
  11249. "properties": {
  11250. "assignee": {
  11251. "type": "string",
  11252. "x-go-name": "Assignee"
  11253. },
  11254. "assignees": {
  11255. "type": "array",
  11256. "items": {
  11257. "type": "string"
  11258. },
  11259. "x-go-name": "Assignees"
  11260. },
  11261. "base": {
  11262. "type": "string",
  11263. "x-go-name": "Base"
  11264. },
  11265. "body": {
  11266. "type": "string",
  11267. "x-go-name": "Body"
  11268. },
  11269. "due_date": {
  11270. "type": "string",
  11271. "format": "date-time",
  11272. "x-go-name": "Deadline"
  11273. },
  11274. "head": {
  11275. "type": "string",
  11276. "x-go-name": "Head"
  11277. },
  11278. "labels": {
  11279. "type": "array",
  11280. "items": {
  11281. "type": "integer",
  11282. "format": "int64"
  11283. },
  11284. "x-go-name": "Labels"
  11285. },
  11286. "milestone": {
  11287. "type": "integer",
  11288. "format": "int64",
  11289. "x-go-name": "Milestone"
  11290. },
  11291. "title": {
  11292. "type": "string",
  11293. "x-go-name": "Title"
  11294. }
  11295. },
  11296. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11297. },
  11298. "CreatePullReviewComment": {
  11299. "description": "CreatePullReviewComment represent a review comment for creation api",
  11300. "type": "object",
  11301. "properties": {
  11302. "body": {
  11303. "type": "string",
  11304. "x-go-name": "Body"
  11305. },
  11306. "new_position": {
  11307. "description": "if comment to new file line or 0",
  11308. "type": "integer",
  11309. "format": "int64",
  11310. "x-go-name": "NewLineNum"
  11311. },
  11312. "old_position": {
  11313. "description": "if comment to old file line or 0",
  11314. "type": "integer",
  11315. "format": "int64",
  11316. "x-go-name": "OldLineNum"
  11317. },
  11318. "path": {
  11319. "description": "the tree path",
  11320. "type": "string",
  11321. "x-go-name": "Path"
  11322. }
  11323. },
  11324. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11325. },
  11326. "CreatePullReviewOptions": {
  11327. "description": "CreatePullReviewOptions are options to create a pull review",
  11328. "type": "object",
  11329. "properties": {
  11330. "body": {
  11331. "type": "string",
  11332. "x-go-name": "Body"
  11333. },
  11334. "comments": {
  11335. "type": "array",
  11336. "items": {
  11337. "$ref": "#/definitions/CreatePullReviewComment"
  11338. },
  11339. "x-go-name": "Comments"
  11340. },
  11341. "commit_id": {
  11342. "type": "string",
  11343. "x-go-name": "CommitID"
  11344. },
  11345. "event": {
  11346. "$ref": "#/definitions/ReviewStateType"
  11347. }
  11348. },
  11349. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11350. },
  11351. "CreateReleaseOption": {
  11352. "description": "CreateReleaseOption options when creating a release",
  11353. "type": "object",
  11354. "required": [
  11355. "tag_name"
  11356. ],
  11357. "properties": {
  11358. "body": {
  11359. "type": "string",
  11360. "x-go-name": "Note"
  11361. },
  11362. "draft": {
  11363. "type": "boolean",
  11364. "x-go-name": "IsDraft"
  11365. },
  11366. "name": {
  11367. "type": "string",
  11368. "x-go-name": "Title"
  11369. },
  11370. "prerelease": {
  11371. "type": "boolean",
  11372. "x-go-name": "IsPrerelease"
  11373. },
  11374. "tag_name": {
  11375. "type": "string",
  11376. "x-go-name": "TagName"
  11377. },
  11378. "target_commitish": {
  11379. "type": "string",
  11380. "x-go-name": "Target"
  11381. }
  11382. },
  11383. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11384. },
  11385. "CreateRepoOption": {
  11386. "description": "CreateRepoOption options when creating repository",
  11387. "type": "object",
  11388. "required": [
  11389. "name"
  11390. ],
  11391. "properties": {
  11392. "auto_init": {
  11393. "description": "Whether the repository should be auto-intialized?",
  11394. "type": "boolean",
  11395. "x-go-name": "AutoInit"
  11396. },
  11397. "default_branch": {
  11398. "description": "DefaultBranch of the repository (used when initializes and in template)",
  11399. "type": "string",
  11400. "x-go-name": "DefaultBranch"
  11401. },
  11402. "description": {
  11403. "description": "Description of the repository to create",
  11404. "type": "string",
  11405. "x-go-name": "Description"
  11406. },
  11407. "gitignores": {
  11408. "description": "Gitignores to use",
  11409. "type": "string",
  11410. "x-go-name": "Gitignores"
  11411. },
  11412. "issue_labels": {
  11413. "description": "Issue Label set to use",
  11414. "type": "string",
  11415. "x-go-name": "IssueLabels"
  11416. },
  11417. "license": {
  11418. "description": "License to use",
  11419. "type": "string",
  11420. "x-go-name": "License"
  11421. },
  11422. "name": {
  11423. "description": "Name of the repository to create",
  11424. "type": "string",
  11425. "uniqueItems": true,
  11426. "x-go-name": "Name"
  11427. },
  11428. "private": {
  11429. "description": "Whether the repository is private",
  11430. "type": "boolean",
  11431. "x-go-name": "Private"
  11432. },
  11433. "readme": {
  11434. "description": "Readme of the repository to create",
  11435. "type": "string",
  11436. "x-go-name": "Readme"
  11437. }
  11438. },
  11439. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11440. },
  11441. "CreateStatusOption": {
  11442. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  11443. "type": "object",
  11444. "properties": {
  11445. "context": {
  11446. "type": "string",
  11447. "x-go-name": "Context"
  11448. },
  11449. "description": {
  11450. "type": "string",
  11451. "x-go-name": "Description"
  11452. },
  11453. "state": {
  11454. "$ref": "#/definitions/StatusState"
  11455. },
  11456. "target_url": {
  11457. "type": "string",
  11458. "x-go-name": "TargetURL"
  11459. }
  11460. },
  11461. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11462. },
  11463. "CreateTeamOption": {
  11464. "description": "CreateTeamOption options for creating a team",
  11465. "type": "object",
  11466. "required": [
  11467. "name"
  11468. ],
  11469. "properties": {
  11470. "can_create_org_repo": {
  11471. "type": "boolean",
  11472. "x-go-name": "CanCreateOrgRepo"
  11473. },
  11474. "description": {
  11475. "type": "string",
  11476. "x-go-name": "Description"
  11477. },
  11478. "includes_all_repositories": {
  11479. "type": "boolean",
  11480. "x-go-name": "IncludesAllRepositories"
  11481. },
  11482. "name": {
  11483. "type": "string",
  11484. "x-go-name": "Name"
  11485. },
  11486. "permission": {
  11487. "type": "string",
  11488. "enum": [
  11489. "read",
  11490. "write",
  11491. "admin"
  11492. ],
  11493. "x-go-name": "Permission"
  11494. },
  11495. "units": {
  11496. "type": "array",
  11497. "items": {
  11498. "type": "string"
  11499. },
  11500. "x-go-name": "Units",
  11501. "example": [
  11502. "repo.code",
  11503. "repo.issues",
  11504. "repo.ext_issues",
  11505. "repo.wiki",
  11506. "repo.pulls",
  11507. "repo.releases",
  11508. "repo.ext_wiki"
  11509. ]
  11510. }
  11511. },
  11512. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11513. },
  11514. "CreateUserOption": {
  11515. "description": "CreateUserOption create user options",
  11516. "type": "object",
  11517. "required": [
  11518. "username",
  11519. "email",
  11520. "password"
  11521. ],
  11522. "properties": {
  11523. "email": {
  11524. "type": "string",
  11525. "format": "email",
  11526. "x-go-name": "Email"
  11527. },
  11528. "full_name": {
  11529. "type": "string",
  11530. "x-go-name": "FullName"
  11531. },
  11532. "login_name": {
  11533. "type": "string",
  11534. "x-go-name": "LoginName"
  11535. },
  11536. "must_change_password": {
  11537. "type": "boolean",
  11538. "x-go-name": "MustChangePassword"
  11539. },
  11540. "password": {
  11541. "type": "string",
  11542. "x-go-name": "Password"
  11543. },
  11544. "send_notify": {
  11545. "type": "boolean",
  11546. "x-go-name": "SendNotify"
  11547. },
  11548. "source_id": {
  11549. "type": "integer",
  11550. "format": "int64",
  11551. "x-go-name": "SourceID"
  11552. },
  11553. "username": {
  11554. "type": "string",
  11555. "x-go-name": "Username"
  11556. }
  11557. },
  11558. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11559. },
  11560. "DeleteEmailOption": {
  11561. "description": "DeleteEmailOption options when deleting email addresses",
  11562. "type": "object",
  11563. "properties": {
  11564. "emails": {
  11565. "description": "email addresses to delete",
  11566. "type": "array",
  11567. "items": {
  11568. "type": "string"
  11569. },
  11570. "x-go-name": "Emails"
  11571. }
  11572. },
  11573. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11574. },
  11575. "DeleteFileOptions": {
  11576. "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)",
  11577. "type": "object",
  11578. "required": [
  11579. "sha"
  11580. ],
  11581. "properties": {
  11582. "author": {
  11583. "$ref": "#/definitions/Identity"
  11584. },
  11585. "branch": {
  11586. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  11587. "type": "string",
  11588. "x-go-name": "BranchName"
  11589. },
  11590. "committer": {
  11591. "$ref": "#/definitions/Identity"
  11592. },
  11593. "dates": {
  11594. "$ref": "#/definitions/CommitDateOptions"
  11595. },
  11596. "message": {
  11597. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  11598. "type": "string",
  11599. "x-go-name": "Message"
  11600. },
  11601. "new_branch": {
  11602. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  11603. "type": "string",
  11604. "x-go-name": "NewBranchName"
  11605. },
  11606. "sha": {
  11607. "description": "sha is the SHA for the file that already exists",
  11608. "type": "string",
  11609. "x-go-name": "SHA"
  11610. }
  11611. },
  11612. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11613. },
  11614. "DeployKey": {
  11615. "description": "DeployKey a deploy key",
  11616. "type": "object",
  11617. "properties": {
  11618. "created_at": {
  11619. "type": "string",
  11620. "format": "date-time",
  11621. "x-go-name": "Created"
  11622. },
  11623. "fingerprint": {
  11624. "type": "string",
  11625. "x-go-name": "Fingerprint"
  11626. },
  11627. "id": {
  11628. "type": "integer",
  11629. "format": "int64",
  11630. "x-go-name": "ID"
  11631. },
  11632. "key": {
  11633. "type": "string",
  11634. "x-go-name": "Key"
  11635. },
  11636. "key_id": {
  11637. "type": "integer",
  11638. "format": "int64",
  11639. "x-go-name": "KeyID"
  11640. },
  11641. "read_only": {
  11642. "type": "boolean",
  11643. "x-go-name": "ReadOnly"
  11644. },
  11645. "repository": {
  11646. "$ref": "#/definitions/Repository"
  11647. },
  11648. "title": {
  11649. "type": "string",
  11650. "x-go-name": "Title"
  11651. },
  11652. "url": {
  11653. "type": "string",
  11654. "x-go-name": "URL"
  11655. }
  11656. },
  11657. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11658. },
  11659. "EditAttachmentOptions": {
  11660. "description": "EditAttachmentOptions options for editing attachments",
  11661. "type": "object",
  11662. "properties": {
  11663. "name": {
  11664. "type": "string",
  11665. "x-go-name": "Name"
  11666. }
  11667. },
  11668. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11669. },
  11670. "EditBranchProtectionOption": {
  11671. "description": "EditBranchProtectionOption options for editing a branch protection",
  11672. "type": "object",
  11673. "properties": {
  11674. "approvals_whitelist_teams": {
  11675. "type": "array",
  11676. "items": {
  11677. "type": "string"
  11678. },
  11679. "x-go-name": "ApprovalsWhitelistTeams"
  11680. },
  11681. "approvals_whitelist_username": {
  11682. "type": "array",
  11683. "items": {
  11684. "type": "string"
  11685. },
  11686. "x-go-name": "ApprovalsWhitelistUsernames"
  11687. },
  11688. "block_on_outdated_branch": {
  11689. "type": "boolean",
  11690. "x-go-name": "BlockOnOutdatedBranch"
  11691. },
  11692. "block_on_rejected_reviews": {
  11693. "type": "boolean",
  11694. "x-go-name": "BlockOnRejectedReviews"
  11695. },
  11696. "dismiss_stale_approvals": {
  11697. "type": "boolean",
  11698. "x-go-name": "DismissStaleApprovals"
  11699. },
  11700. "enable_approvals_whitelist": {
  11701. "type": "boolean",
  11702. "x-go-name": "EnableApprovalsWhitelist"
  11703. },
  11704. "enable_merge_whitelist": {
  11705. "type": "boolean",
  11706. "x-go-name": "EnableMergeWhitelist"
  11707. },
  11708. "enable_push": {
  11709. "type": "boolean",
  11710. "x-go-name": "EnablePush"
  11711. },
  11712. "enable_push_whitelist": {
  11713. "type": "boolean",
  11714. "x-go-name": "EnablePushWhitelist"
  11715. },
  11716. "enable_status_check": {
  11717. "type": "boolean",
  11718. "x-go-name": "EnableStatusCheck"
  11719. },
  11720. "merge_whitelist_teams": {
  11721. "type": "array",
  11722. "items": {
  11723. "type": "string"
  11724. },
  11725. "x-go-name": "MergeWhitelistTeams"
  11726. },
  11727. "merge_whitelist_usernames": {
  11728. "type": "array",
  11729. "items": {
  11730. "type": "string"
  11731. },
  11732. "x-go-name": "MergeWhitelistUsernames"
  11733. },
  11734. "protected_file_patterns": {
  11735. "type": "string",
  11736. "x-go-name": "ProtectedFilePatterns"
  11737. },
  11738. "push_whitelist_deploy_keys": {
  11739. "type": "boolean",
  11740. "x-go-name": "PushWhitelistDeployKeys"
  11741. },
  11742. "push_whitelist_teams": {
  11743. "type": "array",
  11744. "items": {
  11745. "type": "string"
  11746. },
  11747. "x-go-name": "PushWhitelistTeams"
  11748. },
  11749. "push_whitelist_usernames": {
  11750. "type": "array",
  11751. "items": {
  11752. "type": "string"
  11753. },
  11754. "x-go-name": "PushWhitelistUsernames"
  11755. },
  11756. "require_signed_commits": {
  11757. "type": "boolean",
  11758. "x-go-name": "RequireSignedCommits"
  11759. },
  11760. "required_approvals": {
  11761. "type": "integer",
  11762. "format": "int64",
  11763. "x-go-name": "RequiredApprovals"
  11764. },
  11765. "status_check_contexts": {
  11766. "type": "array",
  11767. "items": {
  11768. "type": "string"
  11769. },
  11770. "x-go-name": "StatusCheckContexts"
  11771. }
  11772. },
  11773. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11774. },
  11775. "EditDeadlineOption": {
  11776. "description": "EditDeadlineOption options for creating a deadline",
  11777. "type": "object",
  11778. "required": [
  11779. "due_date"
  11780. ],
  11781. "properties": {
  11782. "due_date": {
  11783. "type": "string",
  11784. "format": "date-time",
  11785. "x-go-name": "Deadline"
  11786. }
  11787. },
  11788. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11789. },
  11790. "EditGitHookOption": {
  11791. "description": "EditGitHookOption options when modifying one Git hook",
  11792. "type": "object",
  11793. "properties": {
  11794. "content": {
  11795. "type": "string",
  11796. "x-go-name": "Content"
  11797. }
  11798. },
  11799. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11800. },
  11801. "EditHookOption": {
  11802. "description": "EditHookOption options when modify one hook",
  11803. "type": "object",
  11804. "properties": {
  11805. "active": {
  11806. "type": "boolean",
  11807. "x-go-name": "Active"
  11808. },
  11809. "branch_filter": {
  11810. "type": "string",
  11811. "x-go-name": "BranchFilter"
  11812. },
  11813. "config": {
  11814. "type": "object",
  11815. "additionalProperties": {
  11816. "type": "string"
  11817. },
  11818. "x-go-name": "Config"
  11819. },
  11820. "events": {
  11821. "type": "array",
  11822. "items": {
  11823. "type": "string"
  11824. },
  11825. "x-go-name": "Events"
  11826. }
  11827. },
  11828. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11829. },
  11830. "EditIssueCommentOption": {
  11831. "description": "EditIssueCommentOption options for editing a comment",
  11832. "type": "object",
  11833. "required": [
  11834. "body"
  11835. ],
  11836. "properties": {
  11837. "body": {
  11838. "type": "string",
  11839. "x-go-name": "Body"
  11840. }
  11841. },
  11842. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11843. },
  11844. "EditIssueOption": {
  11845. "description": "EditIssueOption options for editing an issue",
  11846. "type": "object",
  11847. "properties": {
  11848. "assignee": {
  11849. "type": "string",
  11850. "x-go-name": "Assignee"
  11851. },
  11852. "assignees": {
  11853. "type": "array",
  11854. "items": {
  11855. "type": "string"
  11856. },
  11857. "x-go-name": "Assignees"
  11858. },
  11859. "body": {
  11860. "type": "string",
  11861. "x-go-name": "Body"
  11862. },
  11863. "due_date": {
  11864. "type": "string",
  11865. "format": "date-time",
  11866. "x-go-name": "Deadline"
  11867. },
  11868. "milestone": {
  11869. "type": "integer",
  11870. "format": "int64",
  11871. "x-go-name": "Milestone"
  11872. },
  11873. "state": {
  11874. "type": "string",
  11875. "x-go-name": "State"
  11876. },
  11877. "title": {
  11878. "type": "string",
  11879. "x-go-name": "Title"
  11880. },
  11881. "unset_due_date": {
  11882. "type": "boolean",
  11883. "x-go-name": "RemoveDeadline"
  11884. }
  11885. },
  11886. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11887. },
  11888. "EditLabelOption": {
  11889. "description": "EditLabelOption options for editing a label",
  11890. "type": "object",
  11891. "properties": {
  11892. "color": {
  11893. "type": "string",
  11894. "x-go-name": "Color"
  11895. },
  11896. "description": {
  11897. "type": "string",
  11898. "x-go-name": "Description"
  11899. },
  11900. "name": {
  11901. "type": "string",
  11902. "x-go-name": "Name"
  11903. }
  11904. },
  11905. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11906. },
  11907. "EditMilestoneOption": {
  11908. "description": "EditMilestoneOption options for editing a milestone",
  11909. "type": "object",
  11910. "properties": {
  11911. "description": {
  11912. "type": "string",
  11913. "x-go-name": "Description"
  11914. },
  11915. "due_on": {
  11916. "type": "string",
  11917. "format": "date-time",
  11918. "x-go-name": "Deadline"
  11919. },
  11920. "state": {
  11921. "type": "string",
  11922. "x-go-name": "State"
  11923. },
  11924. "title": {
  11925. "type": "string",
  11926. "x-go-name": "Title"
  11927. }
  11928. },
  11929. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11930. },
  11931. "EditOrgOption": {
  11932. "description": "EditOrgOption options for editing an organization",
  11933. "type": "object",
  11934. "properties": {
  11935. "description": {
  11936. "type": "string",
  11937. "x-go-name": "Description"
  11938. },
  11939. "full_name": {
  11940. "type": "string",
  11941. "x-go-name": "FullName"
  11942. },
  11943. "location": {
  11944. "type": "string",
  11945. "x-go-name": "Location"
  11946. },
  11947. "repo_admin_change_team_access": {
  11948. "type": "boolean",
  11949. "x-go-name": "RepoAdminChangeTeamAccess"
  11950. },
  11951. "visibility": {
  11952. "description": "possible values are `public`, `limited` or `private`",
  11953. "type": "string",
  11954. "enum": [
  11955. "public",
  11956. "limited",
  11957. "private"
  11958. ],
  11959. "x-go-name": "Visibility"
  11960. },
  11961. "website": {
  11962. "type": "string",
  11963. "x-go-name": "Website"
  11964. }
  11965. },
  11966. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11967. },
  11968. "EditPullRequestOption": {
  11969. "description": "EditPullRequestOption options when modify pull request",
  11970. "type": "object",
  11971. "properties": {
  11972. "assignee": {
  11973. "type": "string",
  11974. "x-go-name": "Assignee"
  11975. },
  11976. "assignees": {
  11977. "type": "array",
  11978. "items": {
  11979. "type": "string"
  11980. },
  11981. "x-go-name": "Assignees"
  11982. },
  11983. "base": {
  11984. "type": "string",
  11985. "x-go-name": "Base"
  11986. },
  11987. "body": {
  11988. "type": "string",
  11989. "x-go-name": "Body"
  11990. },
  11991. "due_date": {
  11992. "type": "string",
  11993. "format": "date-time",
  11994. "x-go-name": "Deadline"
  11995. },
  11996. "labels": {
  11997. "type": "array",
  11998. "items": {
  11999. "type": "integer",
  12000. "format": "int64"
  12001. },
  12002. "x-go-name": "Labels"
  12003. },
  12004. "milestone": {
  12005. "type": "integer",
  12006. "format": "int64",
  12007. "x-go-name": "Milestone"
  12008. },
  12009. "state": {
  12010. "type": "string",
  12011. "x-go-name": "State"
  12012. },
  12013. "title": {
  12014. "type": "string",
  12015. "x-go-name": "Title"
  12016. },
  12017. "unset_due_date": {
  12018. "type": "boolean",
  12019. "x-go-name": "RemoveDeadline"
  12020. }
  12021. },
  12022. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12023. },
  12024. "EditReactionOption": {
  12025. "description": "EditReactionOption contain the reaction type",
  12026. "type": "object",
  12027. "properties": {
  12028. "content": {
  12029. "type": "string",
  12030. "x-go-name": "Reaction"
  12031. }
  12032. },
  12033. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12034. },
  12035. "EditReleaseOption": {
  12036. "description": "EditReleaseOption options when editing a release",
  12037. "type": "object",
  12038. "properties": {
  12039. "body": {
  12040. "type": "string",
  12041. "x-go-name": "Note"
  12042. },
  12043. "draft": {
  12044. "type": "boolean",
  12045. "x-go-name": "IsDraft"
  12046. },
  12047. "name": {
  12048. "type": "string",
  12049. "x-go-name": "Title"
  12050. },
  12051. "prerelease": {
  12052. "type": "boolean",
  12053. "x-go-name": "IsPrerelease"
  12054. },
  12055. "tag_name": {
  12056. "type": "string",
  12057. "x-go-name": "TagName"
  12058. },
  12059. "target_commitish": {
  12060. "type": "string",
  12061. "x-go-name": "Target"
  12062. }
  12063. },
  12064. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12065. },
  12066. "EditRepoOption": {
  12067. "description": "EditRepoOption options when editing a repository's properties",
  12068. "type": "object",
  12069. "properties": {
  12070. "allow_merge_commits": {
  12071. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.",
  12072. "type": "boolean",
  12073. "x-go-name": "AllowMerge"
  12074. },
  12075. "allow_rebase": {
  12076. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  12077. "type": "boolean",
  12078. "x-go-name": "AllowRebase"
  12079. },
  12080. "allow_rebase_explicit": {
  12081. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.",
  12082. "type": "boolean",
  12083. "x-go-name": "AllowRebaseMerge"
  12084. },
  12085. "allow_squash_merge": {
  12086. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  12087. "type": "boolean",
  12088. "x-go-name": "AllowSquash"
  12089. },
  12090. "archived": {
  12091. "description": "set to `true` to archive this repository.",
  12092. "type": "boolean",
  12093. "x-go-name": "Archived"
  12094. },
  12095. "default_branch": {
  12096. "description": "sets the default branch for this repository.",
  12097. "type": "string",
  12098. "x-go-name": "DefaultBranch"
  12099. },
  12100. "description": {
  12101. "description": "a short description of the repository.",
  12102. "type": "string",
  12103. "x-go-name": "Description"
  12104. },
  12105. "external_tracker": {
  12106. "$ref": "#/definitions/ExternalTracker"
  12107. },
  12108. "external_wiki": {
  12109. "$ref": "#/definitions/ExternalWiki"
  12110. },
  12111. "has_issues": {
  12112. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  12113. "type": "boolean",
  12114. "x-go-name": "HasIssues"
  12115. },
  12116. "has_pull_requests": {
  12117. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  12118. "type": "boolean",
  12119. "x-go-name": "HasPullRequests"
  12120. },
  12121. "has_wiki": {
  12122. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  12123. "type": "boolean",
  12124. "x-go-name": "HasWiki"
  12125. },
  12126. "ignore_whitespace_conflicts": {
  12127. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  12128. "type": "boolean",
  12129. "x-go-name": "IgnoreWhitespaceConflicts"
  12130. },
  12131. "internal_tracker": {
  12132. "$ref": "#/definitions/InternalTracker"
  12133. },
  12134. "name": {
  12135. "description": "name of the repository",
  12136. "type": "string",
  12137. "uniqueItems": true,
  12138. "x-go-name": "Name"
  12139. },
  12140. "private": {
  12141. "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.",
  12142. "type": "boolean",
  12143. "x-go-name": "Private"
  12144. },
  12145. "template": {
  12146. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  12147. "type": "boolean",
  12148. "x-go-name": "Template"
  12149. },
  12150. "website": {
  12151. "description": "a URL with more information about the repository.",
  12152. "type": "string",
  12153. "x-go-name": "Website"
  12154. }
  12155. },
  12156. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12157. },
  12158. "EditTeamOption": {
  12159. "description": "EditTeamOption options for editing a team",
  12160. "type": "object",
  12161. "required": [
  12162. "name"
  12163. ],
  12164. "properties": {
  12165. "can_create_org_repo": {
  12166. "type": "boolean",
  12167. "x-go-name": "CanCreateOrgRepo"
  12168. },
  12169. "description": {
  12170. "type": "string",
  12171. "x-go-name": "Description"
  12172. },
  12173. "includes_all_repositories": {
  12174. "type": "boolean",
  12175. "x-go-name": "IncludesAllRepositories"
  12176. },
  12177. "name": {
  12178. "type": "string",
  12179. "x-go-name": "Name"
  12180. },
  12181. "permission": {
  12182. "type": "string",
  12183. "enum": [
  12184. "read",
  12185. "write",
  12186. "admin"
  12187. ],
  12188. "x-go-name": "Permission"
  12189. },
  12190. "units": {
  12191. "type": "array",
  12192. "items": {
  12193. "type": "string"
  12194. },
  12195. "x-go-name": "Units",
  12196. "example": [
  12197. "repo.code",
  12198. "repo.issues",
  12199. "repo.ext_issues",
  12200. "repo.wiki",
  12201. "repo.pulls",
  12202. "repo.releases",
  12203. "repo.ext_wiki"
  12204. ]
  12205. }
  12206. },
  12207. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12208. },
  12209. "EditUserOption": {
  12210. "description": "EditUserOption edit user options",
  12211. "type": "object",
  12212. "required": [
  12213. "email"
  12214. ],
  12215. "properties": {
  12216. "active": {
  12217. "type": "boolean",
  12218. "x-go-name": "Active"
  12219. },
  12220. "admin": {
  12221. "type": "boolean",
  12222. "x-go-name": "Admin"
  12223. },
  12224. "allow_create_organization": {
  12225. "type": "boolean",
  12226. "x-go-name": "AllowCreateOrganization"
  12227. },
  12228. "allow_git_hook": {
  12229. "type": "boolean",
  12230. "x-go-name": "AllowGitHook"
  12231. },
  12232. "allow_import_local": {
  12233. "type": "boolean",
  12234. "x-go-name": "AllowImportLocal"
  12235. },
  12236. "email": {
  12237. "type": "string",
  12238. "format": "email",
  12239. "x-go-name": "Email"
  12240. },
  12241. "full_name": {
  12242. "type": "string",
  12243. "x-go-name": "FullName"
  12244. },
  12245. "location": {
  12246. "type": "string",
  12247. "x-go-name": "Location"
  12248. },
  12249. "login_name": {
  12250. "type": "string",
  12251. "x-go-name": "LoginName"
  12252. },
  12253. "max_repo_creation": {
  12254. "type": "integer",
  12255. "format": "int64",
  12256. "x-go-name": "MaxRepoCreation"
  12257. },
  12258. "must_change_password": {
  12259. "type": "boolean",
  12260. "x-go-name": "MustChangePassword"
  12261. },
  12262. "password": {
  12263. "type": "string",
  12264. "x-go-name": "Password"
  12265. },
  12266. "prohibit_login": {
  12267. "type": "boolean",
  12268. "x-go-name": "ProhibitLogin"
  12269. },
  12270. "source_id": {
  12271. "type": "integer",
  12272. "format": "int64",
  12273. "x-go-name": "SourceID"
  12274. },
  12275. "website": {
  12276. "type": "string",
  12277. "x-go-name": "Website"
  12278. }
  12279. },
  12280. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12281. },
  12282. "Email": {
  12283. "description": "Email an email address belonging to a user",
  12284. "type": "object",
  12285. "properties": {
  12286. "email": {
  12287. "type": "string",
  12288. "format": "email",
  12289. "x-go-name": "Email"
  12290. },
  12291. "primary": {
  12292. "type": "boolean",
  12293. "x-go-name": "Primary"
  12294. },
  12295. "verified": {
  12296. "type": "boolean",
  12297. "x-go-name": "Verified"
  12298. }
  12299. },
  12300. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12301. },
  12302. "ExternalTracker": {
  12303. "description": "ExternalTracker represents settings for external tracker",
  12304. "type": "object",
  12305. "properties": {
  12306. "external_tracker_format": {
  12307. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  12308. "type": "string",
  12309. "x-go-name": "ExternalTrackerFormat"
  12310. },
  12311. "external_tracker_style": {
  12312. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  12313. "type": "string",
  12314. "x-go-name": "ExternalTrackerStyle"
  12315. },
  12316. "external_tracker_url": {
  12317. "description": "URL of external issue tracker.",
  12318. "type": "string",
  12319. "x-go-name": "ExternalTrackerURL"
  12320. }
  12321. },
  12322. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12323. },
  12324. "ExternalWiki": {
  12325. "description": "ExternalWiki represents setting for external wiki",
  12326. "type": "object",
  12327. "properties": {
  12328. "external_wiki_url": {
  12329. "description": "URL of external wiki.",
  12330. "type": "string",
  12331. "x-go-name": "ExternalWikiURL"
  12332. }
  12333. },
  12334. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12335. },
  12336. "FileCommitResponse": {
  12337. "type": "object",
  12338. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  12339. "properties": {
  12340. "author": {
  12341. "$ref": "#/definitions/CommitUser"
  12342. },
  12343. "committer": {
  12344. "$ref": "#/definitions/CommitUser"
  12345. },
  12346. "html_url": {
  12347. "type": "string",
  12348. "x-go-name": "HTMLURL"
  12349. },
  12350. "message": {
  12351. "type": "string",
  12352. "x-go-name": "Message"
  12353. },
  12354. "parents": {
  12355. "type": "array",
  12356. "items": {
  12357. "$ref": "#/definitions/CommitMeta"
  12358. },
  12359. "x-go-name": "Parents"
  12360. },
  12361. "sha": {
  12362. "type": "string",
  12363. "x-go-name": "SHA"
  12364. },
  12365. "tree": {
  12366. "$ref": "#/definitions/CommitMeta"
  12367. },
  12368. "url": {
  12369. "type": "string",
  12370. "x-go-name": "URL"
  12371. }
  12372. },
  12373. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12374. },
  12375. "FileDeleteResponse": {
  12376. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  12377. "type": "object",
  12378. "properties": {
  12379. "commit": {
  12380. "$ref": "#/definitions/FileCommitResponse"
  12381. },
  12382. "content": {
  12383. "type": "object",
  12384. "x-go-name": "Content"
  12385. },
  12386. "verification": {
  12387. "$ref": "#/definitions/PayloadCommitVerification"
  12388. }
  12389. },
  12390. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12391. },
  12392. "FileLinksResponse": {
  12393. "description": "FileLinksResponse contains the links for a repo's file",
  12394. "type": "object",
  12395. "properties": {
  12396. "git": {
  12397. "type": "string",
  12398. "x-go-name": "GitURL"
  12399. },
  12400. "html": {
  12401. "type": "string",
  12402. "x-go-name": "HTMLURL"
  12403. },
  12404. "self": {
  12405. "type": "string",
  12406. "x-go-name": "Self"
  12407. }
  12408. },
  12409. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12410. },
  12411. "FileResponse": {
  12412. "description": "FileResponse contains information about a repo's file",
  12413. "type": "object",
  12414. "properties": {
  12415. "commit": {
  12416. "$ref": "#/definitions/FileCommitResponse"
  12417. },
  12418. "content": {
  12419. "$ref": "#/definitions/ContentsResponse"
  12420. },
  12421. "verification": {
  12422. "$ref": "#/definitions/PayloadCommitVerification"
  12423. }
  12424. },
  12425. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12426. },
  12427. "GPGKey": {
  12428. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  12429. "type": "object",
  12430. "properties": {
  12431. "can_certify": {
  12432. "type": "boolean",
  12433. "x-go-name": "CanCertify"
  12434. },
  12435. "can_encrypt_comms": {
  12436. "type": "boolean",
  12437. "x-go-name": "CanEncryptComms"
  12438. },
  12439. "can_encrypt_storage": {
  12440. "type": "boolean",
  12441. "x-go-name": "CanEncryptStorage"
  12442. },
  12443. "can_sign": {
  12444. "type": "boolean",
  12445. "x-go-name": "CanSign"
  12446. },
  12447. "created_at": {
  12448. "type": "string",
  12449. "format": "date-time",
  12450. "x-go-name": "Created"
  12451. },
  12452. "emails": {
  12453. "type": "array",
  12454. "items": {
  12455. "$ref": "#/definitions/GPGKeyEmail"
  12456. },
  12457. "x-go-name": "Emails"
  12458. },
  12459. "expires_at": {
  12460. "type": "string",
  12461. "format": "date-time",
  12462. "x-go-name": "Expires"
  12463. },
  12464. "id": {
  12465. "type": "integer",
  12466. "format": "int64",
  12467. "x-go-name": "ID"
  12468. },
  12469. "key_id": {
  12470. "type": "string",
  12471. "x-go-name": "KeyID"
  12472. },
  12473. "primary_key_id": {
  12474. "type": "string",
  12475. "x-go-name": "PrimaryKeyID"
  12476. },
  12477. "public_key": {
  12478. "type": "string",
  12479. "x-go-name": "PublicKey"
  12480. },
  12481. "subkeys": {
  12482. "type": "array",
  12483. "items": {
  12484. "$ref": "#/definitions/GPGKey"
  12485. },
  12486. "x-go-name": "SubsKey"
  12487. }
  12488. },
  12489. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12490. },
  12491. "GPGKeyEmail": {
  12492. "description": "GPGKeyEmail an email attached to a GPGKey",
  12493. "type": "object",
  12494. "properties": {
  12495. "email": {
  12496. "type": "string",
  12497. "x-go-name": "Email"
  12498. },
  12499. "verified": {
  12500. "type": "boolean",
  12501. "x-go-name": "Verified"
  12502. }
  12503. },
  12504. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12505. },
  12506. "GitBlobResponse": {
  12507. "description": "GitBlobResponse represents a git blob",
  12508. "type": "object",
  12509. "properties": {
  12510. "content": {
  12511. "type": "string",
  12512. "x-go-name": "Content"
  12513. },
  12514. "encoding": {
  12515. "type": "string",
  12516. "x-go-name": "Encoding"
  12517. },
  12518. "sha": {
  12519. "type": "string",
  12520. "x-go-name": "SHA"
  12521. },
  12522. "size": {
  12523. "type": "integer",
  12524. "format": "int64",
  12525. "x-go-name": "Size"
  12526. },
  12527. "url": {
  12528. "type": "string",
  12529. "x-go-name": "URL"
  12530. }
  12531. },
  12532. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12533. },
  12534. "GitEntry": {
  12535. "description": "GitEntry represents a git tree",
  12536. "type": "object",
  12537. "properties": {
  12538. "mode": {
  12539. "type": "string",
  12540. "x-go-name": "Mode"
  12541. },
  12542. "path": {
  12543. "type": "string",
  12544. "x-go-name": "Path"
  12545. },
  12546. "sha": {
  12547. "type": "string",
  12548. "x-go-name": "SHA"
  12549. },
  12550. "size": {
  12551. "type": "integer",
  12552. "format": "int64",
  12553. "x-go-name": "Size"
  12554. },
  12555. "type": {
  12556. "type": "string",
  12557. "x-go-name": "Type"
  12558. },
  12559. "url": {
  12560. "type": "string",
  12561. "x-go-name": "URL"
  12562. }
  12563. },
  12564. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12565. },
  12566. "GitHook": {
  12567. "description": "GitHook represents a Git repository hook",
  12568. "type": "object",
  12569. "properties": {
  12570. "content": {
  12571. "type": "string",
  12572. "x-go-name": "Content"
  12573. },
  12574. "is_active": {
  12575. "type": "boolean",
  12576. "x-go-name": "IsActive"
  12577. },
  12578. "name": {
  12579. "type": "string",
  12580. "x-go-name": "Name"
  12581. }
  12582. },
  12583. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12584. },
  12585. "GitObject": {
  12586. "type": "object",
  12587. "title": "GitObject represents a Git object.",
  12588. "properties": {
  12589. "sha": {
  12590. "type": "string",
  12591. "x-go-name": "SHA"
  12592. },
  12593. "type": {
  12594. "type": "string",
  12595. "x-go-name": "Type"
  12596. },
  12597. "url": {
  12598. "type": "string",
  12599. "x-go-name": "URL"
  12600. }
  12601. },
  12602. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12603. },
  12604. "GitTreeResponse": {
  12605. "description": "GitTreeResponse returns a git tree",
  12606. "type": "object",
  12607. "properties": {
  12608. "page": {
  12609. "type": "integer",
  12610. "format": "int64",
  12611. "x-go-name": "Page"
  12612. },
  12613. "sha": {
  12614. "type": "string",
  12615. "x-go-name": "SHA"
  12616. },
  12617. "total_count": {
  12618. "type": "integer",
  12619. "format": "int64",
  12620. "x-go-name": "TotalCount"
  12621. },
  12622. "tree": {
  12623. "type": "array",
  12624. "items": {
  12625. "$ref": "#/definitions/GitEntry"
  12626. },
  12627. "x-go-name": "Entries"
  12628. },
  12629. "truncated": {
  12630. "type": "boolean",
  12631. "x-go-name": "Truncated"
  12632. },
  12633. "url": {
  12634. "type": "string",
  12635. "x-go-name": "URL"
  12636. }
  12637. },
  12638. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12639. },
  12640. "Hook": {
  12641. "description": "Hook a hook is a web hook when one repository changed",
  12642. "type": "object",
  12643. "properties": {
  12644. "active": {
  12645. "type": "boolean",
  12646. "x-go-name": "Active"
  12647. },
  12648. "config": {
  12649. "type": "object",
  12650. "additionalProperties": {
  12651. "type": "string"
  12652. },
  12653. "x-go-name": "Config"
  12654. },
  12655. "created_at": {
  12656. "type": "string",
  12657. "format": "date-time",
  12658. "x-go-name": "Created"
  12659. },
  12660. "events": {
  12661. "type": "array",
  12662. "items": {
  12663. "type": "string"
  12664. },
  12665. "x-go-name": "Events"
  12666. },
  12667. "id": {
  12668. "type": "integer",
  12669. "format": "int64",
  12670. "x-go-name": "ID"
  12671. },
  12672. "type": {
  12673. "type": "string",
  12674. "x-go-name": "Type"
  12675. },
  12676. "updated_at": {
  12677. "type": "string",
  12678. "format": "date-time",
  12679. "x-go-name": "Updated"
  12680. }
  12681. },
  12682. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12683. },
  12684. "Identity": {
  12685. "description": "Identity for a person's identity like an author or committer",
  12686. "type": "object",
  12687. "properties": {
  12688. "email": {
  12689. "type": "string",
  12690. "format": "email",
  12691. "x-go-name": "Email"
  12692. },
  12693. "name": {
  12694. "type": "string",
  12695. "x-go-name": "Name"
  12696. }
  12697. },
  12698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12699. },
  12700. "InternalTracker": {
  12701. "description": "InternalTracker represents settings for internal tracker",
  12702. "type": "object",
  12703. "properties": {
  12704. "allow_only_contributors_to_track_time": {
  12705. "description": "Let only contributors track time (Built-in issue tracker)",
  12706. "type": "boolean",
  12707. "x-go-name": "AllowOnlyContributorsToTrackTime"
  12708. },
  12709. "enable_issue_dependencies": {
  12710. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  12711. "type": "boolean",
  12712. "x-go-name": "EnableIssueDependencies"
  12713. },
  12714. "enable_time_tracker": {
  12715. "description": "Enable time tracking (Built-in issue tracker)",
  12716. "type": "boolean",
  12717. "x-go-name": "EnableTimeTracker"
  12718. }
  12719. },
  12720. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12721. },
  12722. "Issue": {
  12723. "description": "Issue represents an issue in a repository",
  12724. "type": "object",
  12725. "properties": {
  12726. "assignee": {
  12727. "$ref": "#/definitions/User"
  12728. },
  12729. "assignees": {
  12730. "type": "array",
  12731. "items": {
  12732. "$ref": "#/definitions/User"
  12733. },
  12734. "x-go-name": "Assignees"
  12735. },
  12736. "body": {
  12737. "type": "string",
  12738. "x-go-name": "Body"
  12739. },
  12740. "closed_at": {
  12741. "type": "string",
  12742. "format": "date-time",
  12743. "x-go-name": "Closed"
  12744. },
  12745. "comments": {
  12746. "type": "integer",
  12747. "format": "int64",
  12748. "x-go-name": "Comments"
  12749. },
  12750. "created_at": {
  12751. "type": "string",
  12752. "format": "date-time",
  12753. "x-go-name": "Created"
  12754. },
  12755. "due_date": {
  12756. "type": "string",
  12757. "format": "date-time",
  12758. "x-go-name": "Deadline"
  12759. },
  12760. "html_url": {
  12761. "type": "string",
  12762. "x-go-name": "HTMLURL"
  12763. },
  12764. "id": {
  12765. "type": "integer",
  12766. "format": "int64",
  12767. "x-go-name": "ID"
  12768. },
  12769. "labels": {
  12770. "type": "array",
  12771. "items": {
  12772. "$ref": "#/definitions/Label"
  12773. },
  12774. "x-go-name": "Labels"
  12775. },
  12776. "milestone": {
  12777. "$ref": "#/definitions/Milestone"
  12778. },
  12779. "number": {
  12780. "type": "integer",
  12781. "format": "int64",
  12782. "x-go-name": "Index"
  12783. },
  12784. "original_author": {
  12785. "type": "string",
  12786. "x-go-name": "OriginalAuthor"
  12787. },
  12788. "original_author_id": {
  12789. "type": "integer",
  12790. "format": "int64",
  12791. "x-go-name": "OriginalAuthorID"
  12792. },
  12793. "pull_request": {
  12794. "$ref": "#/definitions/PullRequestMeta"
  12795. },
  12796. "repository": {
  12797. "$ref": "#/definitions/RepositoryMeta"
  12798. },
  12799. "state": {
  12800. "$ref": "#/definitions/StateType"
  12801. },
  12802. "title": {
  12803. "type": "string",
  12804. "x-go-name": "Title"
  12805. },
  12806. "updated_at": {
  12807. "type": "string",
  12808. "format": "date-time",
  12809. "x-go-name": "Updated"
  12810. },
  12811. "url": {
  12812. "type": "string",
  12813. "x-go-name": "URL"
  12814. },
  12815. "user": {
  12816. "$ref": "#/definitions/User"
  12817. }
  12818. },
  12819. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12820. },
  12821. "IssueDeadline": {
  12822. "description": "IssueDeadline represents an issue deadline",
  12823. "type": "object",
  12824. "properties": {
  12825. "due_date": {
  12826. "type": "string",
  12827. "format": "date-time",
  12828. "x-go-name": "Deadline"
  12829. }
  12830. },
  12831. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12832. },
  12833. "IssueLabelsOption": {
  12834. "description": "IssueLabelsOption a collection of labels",
  12835. "type": "object",
  12836. "properties": {
  12837. "labels": {
  12838. "description": "list of label IDs",
  12839. "type": "array",
  12840. "items": {
  12841. "type": "integer",
  12842. "format": "int64"
  12843. },
  12844. "x-go-name": "Labels"
  12845. }
  12846. },
  12847. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12848. },
  12849. "Label": {
  12850. "description": "Label a label to an issue or a pr",
  12851. "type": "object",
  12852. "properties": {
  12853. "color": {
  12854. "type": "string",
  12855. "x-go-name": "Color",
  12856. "example": "00aabb"
  12857. },
  12858. "description": {
  12859. "type": "string",
  12860. "x-go-name": "Description"
  12861. },
  12862. "id": {
  12863. "type": "integer",
  12864. "format": "int64",
  12865. "x-go-name": "ID"
  12866. },
  12867. "name": {
  12868. "type": "string",
  12869. "x-go-name": "Name"
  12870. },
  12871. "url": {
  12872. "type": "string",
  12873. "x-go-name": "URL"
  12874. }
  12875. },
  12876. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12877. },
  12878. "MarkdownOption": {
  12879. "description": "MarkdownOption markdown options",
  12880. "type": "object",
  12881. "properties": {
  12882. "Context": {
  12883. "description": "Context to render\n\nin: body",
  12884. "type": "string"
  12885. },
  12886. "Mode": {
  12887. "description": "Mode to render\n\nin: body",
  12888. "type": "string"
  12889. },
  12890. "Text": {
  12891. "description": "Text markdown to render\n\nin: body",
  12892. "type": "string"
  12893. },
  12894. "Wiki": {
  12895. "description": "Is it a wiki page ?\n\nin: body",
  12896. "type": "boolean"
  12897. }
  12898. },
  12899. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12900. },
  12901. "MergePullRequestOption": {
  12902. "description": "MergePullRequestForm form for merging Pull Request",
  12903. "type": "object",
  12904. "required": [
  12905. "Do"
  12906. ],
  12907. "properties": {
  12908. "Do": {
  12909. "type": "string",
  12910. "enum": [
  12911. "merge",
  12912. "rebase",
  12913. "rebase-merge",
  12914. "squash"
  12915. ]
  12916. },
  12917. "MergeMessageField": {
  12918. "type": "string"
  12919. },
  12920. "MergeTitleField": {
  12921. "type": "string"
  12922. },
  12923. "force_merge": {
  12924. "type": "boolean",
  12925. "x-go-name": "ForceMerge"
  12926. }
  12927. },
  12928. "x-go-name": "MergePullRequestForm",
  12929. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12930. },
  12931. "MigrateRepoForm": {
  12932. "description": "MigrateRepoForm form for migrating repository",
  12933. "type": "object",
  12934. "required": [
  12935. "clone_addr",
  12936. "uid",
  12937. "repo_name"
  12938. ],
  12939. "properties": {
  12940. "auth_password": {
  12941. "type": "string",
  12942. "x-go-name": "AuthPassword"
  12943. },
  12944. "auth_username": {
  12945. "type": "string",
  12946. "x-go-name": "AuthUsername"
  12947. },
  12948. "clone_addr": {
  12949. "type": "string",
  12950. "x-go-name": "CloneAddr"
  12951. },
  12952. "description": {
  12953. "type": "string",
  12954. "x-go-name": "Description"
  12955. },
  12956. "issues": {
  12957. "type": "boolean",
  12958. "x-go-name": "Issues"
  12959. },
  12960. "labels": {
  12961. "type": "boolean",
  12962. "x-go-name": "Labels"
  12963. },
  12964. "milestones": {
  12965. "type": "boolean",
  12966. "x-go-name": "Milestones"
  12967. },
  12968. "mirror": {
  12969. "type": "boolean",
  12970. "x-go-name": "Mirror"
  12971. },
  12972. "private": {
  12973. "type": "boolean",
  12974. "x-go-name": "Private"
  12975. },
  12976. "pull_requests": {
  12977. "type": "boolean",
  12978. "x-go-name": "PullRequests"
  12979. },
  12980. "releases": {
  12981. "type": "boolean",
  12982. "x-go-name": "Releases"
  12983. },
  12984. "repo_name": {
  12985. "type": "string",
  12986. "x-go-name": "RepoName"
  12987. },
  12988. "uid": {
  12989. "type": "integer",
  12990. "format": "int64",
  12991. "x-go-name": "UID"
  12992. },
  12993. "wiki": {
  12994. "type": "boolean",
  12995. "x-go-name": "Wiki"
  12996. }
  12997. },
  12998. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12999. },
  13000. "Milestone": {
  13001. "description": "Milestone milestone is a collection of issues on one repository",
  13002. "type": "object",
  13003. "properties": {
  13004. "closed_at": {
  13005. "type": "string",
  13006. "format": "date-time",
  13007. "x-go-name": "Closed"
  13008. },
  13009. "closed_issues": {
  13010. "type": "integer",
  13011. "format": "int64",
  13012. "x-go-name": "ClosedIssues"
  13013. },
  13014. "description": {
  13015. "type": "string",
  13016. "x-go-name": "Description"
  13017. },
  13018. "due_on": {
  13019. "type": "string",
  13020. "format": "date-time",
  13021. "x-go-name": "Deadline"
  13022. },
  13023. "id": {
  13024. "type": "integer",
  13025. "format": "int64",
  13026. "x-go-name": "ID"
  13027. },
  13028. "open_issues": {
  13029. "type": "integer",
  13030. "format": "int64",
  13031. "x-go-name": "OpenIssues"
  13032. },
  13033. "state": {
  13034. "$ref": "#/definitions/StateType"
  13035. },
  13036. "title": {
  13037. "type": "string",
  13038. "x-go-name": "Title"
  13039. }
  13040. },
  13041. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13042. },
  13043. "NotificationCount": {
  13044. "description": "NotificationCount number of unread notifications",
  13045. "type": "object",
  13046. "properties": {
  13047. "new": {
  13048. "type": "integer",
  13049. "format": "int64",
  13050. "x-go-name": "New"
  13051. }
  13052. },
  13053. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13054. },
  13055. "NotificationSubject": {
  13056. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  13057. "type": "object",
  13058. "properties": {
  13059. "latest_comment_url": {
  13060. "type": "string",
  13061. "x-go-name": "LatestCommentURL"
  13062. },
  13063. "title": {
  13064. "type": "string",
  13065. "x-go-name": "Title"
  13066. },
  13067. "type": {
  13068. "type": "string",
  13069. "x-go-name": "Type"
  13070. },
  13071. "url": {
  13072. "type": "string",
  13073. "x-go-name": "URL"
  13074. }
  13075. },
  13076. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13077. },
  13078. "NotificationThread": {
  13079. "description": "NotificationThread expose Notification on API",
  13080. "type": "object",
  13081. "properties": {
  13082. "id": {
  13083. "type": "integer",
  13084. "format": "int64",
  13085. "x-go-name": "ID"
  13086. },
  13087. "pinned": {
  13088. "type": "boolean",
  13089. "x-go-name": "Pinned"
  13090. },
  13091. "repository": {
  13092. "$ref": "#/definitions/Repository"
  13093. },
  13094. "subject": {
  13095. "$ref": "#/definitions/NotificationSubject"
  13096. },
  13097. "unread": {
  13098. "type": "boolean",
  13099. "x-go-name": "Unread"
  13100. },
  13101. "updated_at": {
  13102. "type": "string",
  13103. "format": "date-time",
  13104. "x-go-name": "UpdatedAt"
  13105. },
  13106. "url": {
  13107. "type": "string",
  13108. "x-go-name": "URL"
  13109. }
  13110. },
  13111. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13112. },
  13113. "OAuth2Application": {
  13114. "type": "object",
  13115. "title": "OAuth2Application represents an OAuth2 application.",
  13116. "properties": {
  13117. "client_id": {
  13118. "type": "string",
  13119. "x-go-name": "ClientID"
  13120. },
  13121. "client_secret": {
  13122. "type": "string",
  13123. "x-go-name": "ClientSecret"
  13124. },
  13125. "created": {
  13126. "type": "string",
  13127. "format": "date-time",
  13128. "x-go-name": "Created"
  13129. },
  13130. "id": {
  13131. "type": "integer",
  13132. "format": "int64",
  13133. "x-go-name": "ID"
  13134. },
  13135. "name": {
  13136. "type": "string",
  13137. "x-go-name": "Name"
  13138. },
  13139. "redirect_uris": {
  13140. "type": "array",
  13141. "items": {
  13142. "type": "string"
  13143. },
  13144. "x-go-name": "RedirectURIs"
  13145. }
  13146. },
  13147. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13148. },
  13149. "Organization": {
  13150. "description": "Organization represents an organization",
  13151. "type": "object",
  13152. "properties": {
  13153. "avatar_url": {
  13154. "type": "string",
  13155. "x-go-name": "AvatarURL"
  13156. },
  13157. "description": {
  13158. "type": "string",
  13159. "x-go-name": "Description"
  13160. },
  13161. "full_name": {
  13162. "type": "string",
  13163. "x-go-name": "FullName"
  13164. },
  13165. "id": {
  13166. "type": "integer",
  13167. "format": "int64",
  13168. "x-go-name": "ID"
  13169. },
  13170. "location": {
  13171. "type": "string",
  13172. "x-go-name": "Location"
  13173. },
  13174. "repo_admin_change_team_access": {
  13175. "type": "boolean",
  13176. "x-go-name": "RepoAdminChangeTeamAccess"
  13177. },
  13178. "username": {
  13179. "type": "string",
  13180. "x-go-name": "UserName"
  13181. },
  13182. "visibility": {
  13183. "type": "string",
  13184. "x-go-name": "Visibility"
  13185. },
  13186. "website": {
  13187. "type": "string",
  13188. "x-go-name": "Website"
  13189. }
  13190. },
  13191. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13192. },
  13193. "PRBranchInfo": {
  13194. "description": "PRBranchInfo information about a branch",
  13195. "type": "object",
  13196. "properties": {
  13197. "label": {
  13198. "type": "string",
  13199. "x-go-name": "Name"
  13200. },
  13201. "ref": {
  13202. "type": "string",
  13203. "x-go-name": "Ref"
  13204. },
  13205. "repo": {
  13206. "$ref": "#/definitions/Repository"
  13207. },
  13208. "repo_id": {
  13209. "type": "integer",
  13210. "format": "int64",
  13211. "x-go-name": "RepoID"
  13212. },
  13213. "sha": {
  13214. "type": "string",
  13215. "x-go-name": "Sha"
  13216. }
  13217. },
  13218. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13219. },
  13220. "PayloadCommit": {
  13221. "description": "PayloadCommit represents a commit",
  13222. "type": "object",
  13223. "properties": {
  13224. "added": {
  13225. "type": "array",
  13226. "items": {
  13227. "type": "string"
  13228. },
  13229. "x-go-name": "Added"
  13230. },
  13231. "author": {
  13232. "$ref": "#/definitions/PayloadUser"
  13233. },
  13234. "committer": {
  13235. "$ref": "#/definitions/PayloadUser"
  13236. },
  13237. "id": {
  13238. "description": "sha1 hash of the commit",
  13239. "type": "string",
  13240. "x-go-name": "ID"
  13241. },
  13242. "message": {
  13243. "type": "string",
  13244. "x-go-name": "Message"
  13245. },
  13246. "modified": {
  13247. "type": "array",
  13248. "items": {
  13249. "type": "string"
  13250. },
  13251. "x-go-name": "Modified"
  13252. },
  13253. "removed": {
  13254. "type": "array",
  13255. "items": {
  13256. "type": "string"
  13257. },
  13258. "x-go-name": "Removed"
  13259. },
  13260. "timestamp": {
  13261. "type": "string",
  13262. "format": "date-time",
  13263. "x-go-name": "Timestamp"
  13264. },
  13265. "url": {
  13266. "type": "string",
  13267. "x-go-name": "URL"
  13268. },
  13269. "verification": {
  13270. "$ref": "#/definitions/PayloadCommitVerification"
  13271. }
  13272. },
  13273. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13274. },
  13275. "PayloadCommitVerification": {
  13276. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  13277. "type": "object",
  13278. "properties": {
  13279. "payload": {
  13280. "type": "string",
  13281. "x-go-name": "Payload"
  13282. },
  13283. "reason": {
  13284. "type": "string",
  13285. "x-go-name": "Reason"
  13286. },
  13287. "signature": {
  13288. "type": "string",
  13289. "x-go-name": "Signature"
  13290. },
  13291. "signer": {
  13292. "$ref": "#/definitions/PayloadUser"
  13293. },
  13294. "verified": {
  13295. "type": "boolean",
  13296. "x-go-name": "Verified"
  13297. }
  13298. },
  13299. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13300. },
  13301. "PayloadUser": {
  13302. "description": "PayloadUser represents the author or committer of a commit",
  13303. "type": "object",
  13304. "properties": {
  13305. "email": {
  13306. "type": "string",
  13307. "format": "email",
  13308. "x-go-name": "Email"
  13309. },
  13310. "name": {
  13311. "description": "Full name of the commit author",
  13312. "type": "string",
  13313. "x-go-name": "Name"
  13314. },
  13315. "username": {
  13316. "type": "string",
  13317. "x-go-name": "UserName"
  13318. }
  13319. },
  13320. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13321. },
  13322. "Permission": {
  13323. "description": "Permission represents a set of permissions",
  13324. "type": "object",
  13325. "properties": {
  13326. "admin": {
  13327. "type": "boolean",
  13328. "x-go-name": "Admin"
  13329. },
  13330. "pull": {
  13331. "type": "boolean",
  13332. "x-go-name": "Pull"
  13333. },
  13334. "push": {
  13335. "type": "boolean",
  13336. "x-go-name": "Push"
  13337. }
  13338. },
  13339. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13340. },
  13341. "PublicKey": {
  13342. "description": "PublicKey publickey is a user key to push code to repository",
  13343. "type": "object",
  13344. "properties": {
  13345. "created_at": {
  13346. "type": "string",
  13347. "format": "date-time",
  13348. "x-go-name": "Created"
  13349. },
  13350. "fingerprint": {
  13351. "type": "string",
  13352. "x-go-name": "Fingerprint"
  13353. },
  13354. "id": {
  13355. "type": "integer",
  13356. "format": "int64",
  13357. "x-go-name": "ID"
  13358. },
  13359. "key": {
  13360. "type": "string",
  13361. "x-go-name": "Key"
  13362. },
  13363. "key_type": {
  13364. "type": "string",
  13365. "x-go-name": "KeyType"
  13366. },
  13367. "read_only": {
  13368. "type": "boolean",
  13369. "x-go-name": "ReadOnly"
  13370. },
  13371. "title": {
  13372. "type": "string",
  13373. "x-go-name": "Title"
  13374. },
  13375. "url": {
  13376. "type": "string",
  13377. "x-go-name": "URL"
  13378. },
  13379. "user": {
  13380. "$ref": "#/definitions/User"
  13381. }
  13382. },
  13383. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13384. },
  13385. "PullRequest": {
  13386. "description": "PullRequest represents a pull request",
  13387. "type": "object",
  13388. "properties": {
  13389. "assignee": {
  13390. "$ref": "#/definitions/User"
  13391. },
  13392. "assignees": {
  13393. "type": "array",
  13394. "items": {
  13395. "$ref": "#/definitions/User"
  13396. },
  13397. "x-go-name": "Assignees"
  13398. },
  13399. "base": {
  13400. "$ref": "#/definitions/PRBranchInfo"
  13401. },
  13402. "body": {
  13403. "type": "string",
  13404. "x-go-name": "Body"
  13405. },
  13406. "closed_at": {
  13407. "type": "string",
  13408. "format": "date-time",
  13409. "x-go-name": "Closed"
  13410. },
  13411. "comments": {
  13412. "type": "integer",
  13413. "format": "int64",
  13414. "x-go-name": "Comments"
  13415. },
  13416. "created_at": {
  13417. "type": "string",
  13418. "format": "date-time",
  13419. "x-go-name": "Created"
  13420. },
  13421. "diff_url": {
  13422. "type": "string",
  13423. "x-go-name": "DiffURL"
  13424. },
  13425. "due_date": {
  13426. "type": "string",
  13427. "format": "date-time",
  13428. "x-go-name": "Deadline"
  13429. },
  13430. "head": {
  13431. "$ref": "#/definitions/PRBranchInfo"
  13432. },
  13433. "html_url": {
  13434. "type": "string",
  13435. "x-go-name": "HTMLURL"
  13436. },
  13437. "id": {
  13438. "type": "integer",
  13439. "format": "int64",
  13440. "x-go-name": "ID"
  13441. },
  13442. "labels": {
  13443. "type": "array",
  13444. "items": {
  13445. "$ref": "#/definitions/Label"
  13446. },
  13447. "x-go-name": "Labels"
  13448. },
  13449. "merge_base": {
  13450. "type": "string",
  13451. "x-go-name": "MergeBase"
  13452. },
  13453. "merge_commit_sha": {
  13454. "type": "string",
  13455. "x-go-name": "MergedCommitID"
  13456. },
  13457. "mergeable": {
  13458. "type": "boolean",
  13459. "x-go-name": "Mergeable"
  13460. },
  13461. "merged": {
  13462. "type": "boolean",
  13463. "x-go-name": "HasMerged"
  13464. },
  13465. "merged_at": {
  13466. "type": "string",
  13467. "format": "date-time",
  13468. "x-go-name": "Merged"
  13469. },
  13470. "merged_by": {
  13471. "$ref": "#/definitions/User"
  13472. },
  13473. "milestone": {
  13474. "$ref": "#/definitions/Milestone"
  13475. },
  13476. "number": {
  13477. "type": "integer",
  13478. "format": "int64",
  13479. "x-go-name": "Index"
  13480. },
  13481. "patch_url": {
  13482. "type": "string",
  13483. "x-go-name": "PatchURL"
  13484. },
  13485. "state": {
  13486. "$ref": "#/definitions/StateType"
  13487. },
  13488. "title": {
  13489. "type": "string",
  13490. "x-go-name": "Title"
  13491. },
  13492. "updated_at": {
  13493. "type": "string",
  13494. "format": "date-time",
  13495. "x-go-name": "Updated"
  13496. },
  13497. "url": {
  13498. "type": "string",
  13499. "x-go-name": "URL"
  13500. },
  13501. "user": {
  13502. "$ref": "#/definitions/User"
  13503. }
  13504. },
  13505. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13506. },
  13507. "PullRequestMeta": {
  13508. "description": "PullRequestMeta PR info if an issue is a PR",
  13509. "type": "object",
  13510. "properties": {
  13511. "merged": {
  13512. "type": "boolean",
  13513. "x-go-name": "HasMerged"
  13514. },
  13515. "merged_at": {
  13516. "type": "string",
  13517. "format": "date-time",
  13518. "x-go-name": "Merged"
  13519. }
  13520. },
  13521. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13522. },
  13523. "PullReview": {
  13524. "description": "PullReview represents a pull request review",
  13525. "type": "object",
  13526. "properties": {
  13527. "body": {
  13528. "type": "string",
  13529. "x-go-name": "Body"
  13530. },
  13531. "comments_count": {
  13532. "type": "integer",
  13533. "format": "int64",
  13534. "x-go-name": "CodeCommentsCount"
  13535. },
  13536. "commit_id": {
  13537. "type": "string",
  13538. "x-go-name": "CommitID"
  13539. },
  13540. "html_url": {
  13541. "type": "string",
  13542. "x-go-name": "HTMLURL"
  13543. },
  13544. "id": {
  13545. "type": "integer",
  13546. "format": "int64",
  13547. "x-go-name": "ID"
  13548. },
  13549. "official": {
  13550. "type": "boolean",
  13551. "x-go-name": "Official"
  13552. },
  13553. "pull_request_url": {
  13554. "type": "string",
  13555. "x-go-name": "HTMLPullURL"
  13556. },
  13557. "stale": {
  13558. "type": "boolean",
  13559. "x-go-name": "Stale"
  13560. },
  13561. "state": {
  13562. "$ref": "#/definitions/ReviewStateType"
  13563. },
  13564. "submitted_at": {
  13565. "type": "string",
  13566. "format": "date-time",
  13567. "x-go-name": "Submitted"
  13568. },
  13569. "user": {
  13570. "$ref": "#/definitions/User"
  13571. }
  13572. },
  13573. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13574. },
  13575. "PullReviewComment": {
  13576. "description": "PullReviewComment represents a comment on a pull request review",
  13577. "type": "object",
  13578. "properties": {
  13579. "body": {
  13580. "type": "string",
  13581. "x-go-name": "Body"
  13582. },
  13583. "commit_id": {
  13584. "type": "string",
  13585. "x-go-name": "CommitID"
  13586. },
  13587. "created_at": {
  13588. "type": "string",
  13589. "format": "date-time",
  13590. "x-go-name": "Created"
  13591. },
  13592. "diff_hunk": {
  13593. "type": "string",
  13594. "x-go-name": "DiffHunk"
  13595. },
  13596. "html_url": {
  13597. "type": "string",
  13598. "x-go-name": "HTMLURL"
  13599. },
  13600. "id": {
  13601. "type": "integer",
  13602. "format": "int64",
  13603. "x-go-name": "ID"
  13604. },
  13605. "original_commit_id": {
  13606. "type": "string",
  13607. "x-go-name": "OrigCommitID"
  13608. },
  13609. "original_position": {
  13610. "type": "integer",
  13611. "format": "uint64",
  13612. "x-go-name": "OldLineNum"
  13613. },
  13614. "path": {
  13615. "type": "string",
  13616. "x-go-name": "Path"
  13617. },
  13618. "position": {
  13619. "type": "integer",
  13620. "format": "uint64",
  13621. "x-go-name": "LineNum"
  13622. },
  13623. "pull_request_review_id": {
  13624. "type": "integer",
  13625. "format": "int64",
  13626. "x-go-name": "ReviewID"
  13627. },
  13628. "pull_request_url": {
  13629. "type": "string",
  13630. "x-go-name": "HTMLPullURL"
  13631. },
  13632. "updated_at": {
  13633. "type": "string",
  13634. "format": "date-time",
  13635. "x-go-name": "Updated"
  13636. },
  13637. "user": {
  13638. "$ref": "#/definitions/User"
  13639. }
  13640. },
  13641. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13642. },
  13643. "Reaction": {
  13644. "description": "Reaction contain one reaction",
  13645. "type": "object",
  13646. "properties": {
  13647. "content": {
  13648. "type": "string",
  13649. "x-go-name": "Reaction"
  13650. },
  13651. "created_at": {
  13652. "type": "string",
  13653. "format": "date-time",
  13654. "x-go-name": "Created"
  13655. },
  13656. "user": {
  13657. "$ref": "#/definitions/User"
  13658. }
  13659. },
  13660. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13661. },
  13662. "Reference": {
  13663. "type": "object",
  13664. "title": "Reference represents a Git reference.",
  13665. "properties": {
  13666. "object": {
  13667. "$ref": "#/definitions/GitObject"
  13668. },
  13669. "ref": {
  13670. "type": "string",
  13671. "x-go-name": "Ref"
  13672. },
  13673. "url": {
  13674. "type": "string",
  13675. "x-go-name": "URL"
  13676. }
  13677. },
  13678. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13679. },
  13680. "Release": {
  13681. "description": "Release represents a repository release",
  13682. "type": "object",
  13683. "properties": {
  13684. "assets": {
  13685. "type": "array",
  13686. "items": {
  13687. "$ref": "#/definitions/Attachment"
  13688. },
  13689. "x-go-name": "Attachments"
  13690. },
  13691. "author": {
  13692. "$ref": "#/definitions/User"
  13693. },
  13694. "body": {
  13695. "type": "string",
  13696. "x-go-name": "Note"
  13697. },
  13698. "created_at": {
  13699. "type": "string",
  13700. "format": "date-time",
  13701. "x-go-name": "CreatedAt"
  13702. },
  13703. "draft": {
  13704. "type": "boolean",
  13705. "x-go-name": "IsDraft"
  13706. },
  13707. "html_url": {
  13708. "type": "string",
  13709. "x-go-name": "HTMLURL"
  13710. },
  13711. "id": {
  13712. "type": "integer",
  13713. "format": "int64",
  13714. "x-go-name": "ID"
  13715. },
  13716. "name": {
  13717. "type": "string",
  13718. "x-go-name": "Title"
  13719. },
  13720. "prerelease": {
  13721. "type": "boolean",
  13722. "x-go-name": "IsPrerelease"
  13723. },
  13724. "published_at": {
  13725. "type": "string",
  13726. "format": "date-time",
  13727. "x-go-name": "PublishedAt"
  13728. },
  13729. "tag_name": {
  13730. "type": "string",
  13731. "x-go-name": "TagName"
  13732. },
  13733. "tarball_url": {
  13734. "type": "string",
  13735. "x-go-name": "TarURL"
  13736. },
  13737. "target_commitish": {
  13738. "type": "string",
  13739. "x-go-name": "Target"
  13740. },
  13741. "url": {
  13742. "type": "string",
  13743. "x-go-name": "URL"
  13744. },
  13745. "zipball_url": {
  13746. "type": "string",
  13747. "x-go-name": "ZipURL"
  13748. }
  13749. },
  13750. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13751. },
  13752. "RepoCommit": {
  13753. "type": "object",
  13754. "title": "RepoCommit contains information of a commit in the context of a repository.",
  13755. "properties": {
  13756. "author": {
  13757. "$ref": "#/definitions/CommitUser"
  13758. },
  13759. "committer": {
  13760. "$ref": "#/definitions/CommitUser"
  13761. },
  13762. "message": {
  13763. "type": "string",
  13764. "x-go-name": "Message"
  13765. },
  13766. "tree": {
  13767. "$ref": "#/definitions/CommitMeta"
  13768. },
  13769. "url": {
  13770. "type": "string",
  13771. "x-go-name": "URL"
  13772. }
  13773. },
  13774. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13775. },
  13776. "RepoTopicOptions": {
  13777. "description": "RepoTopicOptions a collection of repo topic names",
  13778. "type": "object",
  13779. "properties": {
  13780. "topics": {
  13781. "description": "list of topic names",
  13782. "type": "array",
  13783. "items": {
  13784. "type": "string"
  13785. },
  13786. "x-go-name": "Topics"
  13787. }
  13788. },
  13789. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13790. },
  13791. "Repository": {
  13792. "description": "Repository represents a repository",
  13793. "type": "object",
  13794. "properties": {
  13795. "allow_merge_commits": {
  13796. "type": "boolean",
  13797. "x-go-name": "AllowMerge"
  13798. },
  13799. "allow_rebase": {
  13800. "type": "boolean",
  13801. "x-go-name": "AllowRebase"
  13802. },
  13803. "allow_rebase_explicit": {
  13804. "type": "boolean",
  13805. "x-go-name": "AllowRebaseMerge"
  13806. },
  13807. "allow_squash_merge": {
  13808. "type": "boolean",
  13809. "x-go-name": "AllowSquash"
  13810. },
  13811. "archived": {
  13812. "type": "boolean",
  13813. "x-go-name": "Archived"
  13814. },
  13815. "avatar_url": {
  13816. "type": "string",
  13817. "x-go-name": "AvatarURL"
  13818. },
  13819. "clone_url": {
  13820. "type": "string",
  13821. "x-go-name": "CloneURL"
  13822. },
  13823. "created_at": {
  13824. "type": "string",
  13825. "format": "date-time",
  13826. "x-go-name": "Created"
  13827. },
  13828. "default_branch": {
  13829. "type": "string",
  13830. "x-go-name": "DefaultBranch"
  13831. },
  13832. "description": {
  13833. "type": "string",
  13834. "x-go-name": "Description"
  13835. },
  13836. "empty": {
  13837. "type": "boolean",
  13838. "x-go-name": "Empty"
  13839. },
  13840. "external_tracker": {
  13841. "$ref": "#/definitions/ExternalTracker"
  13842. },
  13843. "external_wiki": {
  13844. "$ref": "#/definitions/ExternalWiki"
  13845. },
  13846. "fork": {
  13847. "type": "boolean",
  13848. "x-go-name": "Fork"
  13849. },
  13850. "forks_count": {
  13851. "type": "integer",
  13852. "format": "int64",
  13853. "x-go-name": "Forks"
  13854. },
  13855. "full_name": {
  13856. "type": "string",
  13857. "x-go-name": "FullName"
  13858. },
  13859. "has_issues": {
  13860. "type": "boolean",
  13861. "x-go-name": "HasIssues"
  13862. },
  13863. "has_pull_requests": {
  13864. "type": "boolean",
  13865. "x-go-name": "HasPullRequests"
  13866. },
  13867. "has_wiki": {
  13868. "type": "boolean",
  13869. "x-go-name": "HasWiki"
  13870. },
  13871. "html_url": {
  13872. "type": "string",
  13873. "x-go-name": "HTMLURL"
  13874. },
  13875. "id": {
  13876. "type": "integer",
  13877. "format": "int64",
  13878. "x-go-name": "ID"
  13879. },
  13880. "ignore_whitespace_conflicts": {
  13881. "type": "boolean",
  13882. "x-go-name": "IgnoreWhitespaceConflicts"
  13883. },
  13884. "internal_tracker": {
  13885. "$ref": "#/definitions/InternalTracker"
  13886. },
  13887. "mirror": {
  13888. "type": "boolean",
  13889. "x-go-name": "Mirror"
  13890. },
  13891. "name": {
  13892. "type": "string",
  13893. "x-go-name": "Name"
  13894. },
  13895. "open_issues_count": {
  13896. "type": "integer",
  13897. "format": "int64",
  13898. "x-go-name": "OpenIssues"
  13899. },
  13900. "open_pr_counter": {
  13901. "type": "integer",
  13902. "format": "int64",
  13903. "x-go-name": "OpenPulls"
  13904. },
  13905. "original_url": {
  13906. "type": "string",
  13907. "x-go-name": "OriginalURL"
  13908. },
  13909. "owner": {
  13910. "$ref": "#/definitions/User"
  13911. },
  13912. "parent": {
  13913. "$ref": "#/definitions/Repository"
  13914. },
  13915. "permissions": {
  13916. "$ref": "#/definitions/Permission"
  13917. },
  13918. "private": {
  13919. "type": "boolean",
  13920. "x-go-name": "Private"
  13921. },
  13922. "release_counter": {
  13923. "type": "integer",
  13924. "format": "int64",
  13925. "x-go-name": "Releases"
  13926. },
  13927. "size": {
  13928. "type": "integer",
  13929. "format": "int64",
  13930. "x-go-name": "Size"
  13931. },
  13932. "ssh_url": {
  13933. "type": "string",
  13934. "x-go-name": "SSHURL"
  13935. },
  13936. "stars_count": {
  13937. "type": "integer",
  13938. "format": "int64",
  13939. "x-go-name": "Stars"
  13940. },
  13941. "template": {
  13942. "type": "boolean",
  13943. "x-go-name": "Template"
  13944. },
  13945. "updated_at": {
  13946. "type": "string",
  13947. "format": "date-time",
  13948. "x-go-name": "Updated"
  13949. },
  13950. "watchers_count": {
  13951. "type": "integer",
  13952. "format": "int64",
  13953. "x-go-name": "Watchers"
  13954. },
  13955. "website": {
  13956. "type": "string",
  13957. "x-go-name": "Website"
  13958. }
  13959. },
  13960. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13961. },
  13962. "RepositoryMeta": {
  13963. "description": "RepositoryMeta basic repository information",
  13964. "type": "object",
  13965. "properties": {
  13966. "full_name": {
  13967. "type": "string",
  13968. "x-go-name": "FullName"
  13969. },
  13970. "id": {
  13971. "type": "integer",
  13972. "format": "int64",
  13973. "x-go-name": "ID"
  13974. },
  13975. "name": {
  13976. "type": "string",
  13977. "x-go-name": "Name"
  13978. },
  13979. "owner": {
  13980. "type": "string",
  13981. "x-go-name": "Owner"
  13982. }
  13983. },
  13984. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13985. },
  13986. "ReviewStateType": {
  13987. "description": "ReviewStateType review state type",
  13988. "type": "string",
  13989. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13990. },
  13991. "SearchResults": {
  13992. "description": "SearchResults results of a successful search",
  13993. "type": "object",
  13994. "properties": {
  13995. "data": {
  13996. "type": "array",
  13997. "items": {
  13998. "$ref": "#/definitions/Repository"
  13999. },
  14000. "x-go-name": "Data"
  14001. },
  14002. "ok": {
  14003. "type": "boolean",
  14004. "x-go-name": "OK"
  14005. }
  14006. },
  14007. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14008. },
  14009. "ServerVersion": {
  14010. "description": "ServerVersion wraps the version of the server",
  14011. "type": "object",
  14012. "properties": {
  14013. "version": {
  14014. "type": "string",
  14015. "x-go-name": "Version"
  14016. }
  14017. },
  14018. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14019. },
  14020. "StateType": {
  14021. "description": "StateType issue state type",
  14022. "type": "string",
  14023. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14024. },
  14025. "Status": {
  14026. "description": "Status holds a single Status of a single Commit",
  14027. "type": "object",
  14028. "properties": {
  14029. "context": {
  14030. "type": "string",
  14031. "x-go-name": "Context"
  14032. },
  14033. "created_at": {
  14034. "type": "string",
  14035. "format": "date-time",
  14036. "x-go-name": "Created"
  14037. },
  14038. "creator": {
  14039. "$ref": "#/definitions/User"
  14040. },
  14041. "description": {
  14042. "type": "string",
  14043. "x-go-name": "Description"
  14044. },
  14045. "id": {
  14046. "type": "integer",
  14047. "format": "int64",
  14048. "x-go-name": "ID"
  14049. },
  14050. "status": {
  14051. "$ref": "#/definitions/StatusState"
  14052. },
  14053. "target_url": {
  14054. "type": "string",
  14055. "x-go-name": "TargetURL"
  14056. },
  14057. "updated_at": {
  14058. "type": "string",
  14059. "format": "date-time",
  14060. "x-go-name": "Updated"
  14061. },
  14062. "url": {
  14063. "type": "string",
  14064. "x-go-name": "URL"
  14065. }
  14066. },
  14067. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14068. },
  14069. "StatusState": {
  14070. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  14071. "type": "string",
  14072. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14073. },
  14074. "StopWatch": {
  14075. "description": "StopWatch represent a running stopwatch",
  14076. "type": "object",
  14077. "properties": {
  14078. "created": {
  14079. "type": "string",
  14080. "format": "date-time",
  14081. "x-go-name": "Created"
  14082. },
  14083. "issue_index": {
  14084. "type": "integer",
  14085. "format": "int64",
  14086. "x-go-name": "IssueIndex"
  14087. }
  14088. },
  14089. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14090. },
  14091. "SubmitPullReviewOptions": {
  14092. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  14093. "type": "object",
  14094. "properties": {
  14095. "body": {
  14096. "type": "string",
  14097. "x-go-name": "Body"
  14098. },
  14099. "event": {
  14100. "$ref": "#/definitions/ReviewStateType"
  14101. }
  14102. },
  14103. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14104. },
  14105. "Tag": {
  14106. "description": "Tag represents a repository tag",
  14107. "type": "object",
  14108. "properties": {
  14109. "commit": {
  14110. "$ref": "#/definitions/CommitMeta"
  14111. },
  14112. "id": {
  14113. "type": "string",
  14114. "x-go-name": "ID"
  14115. },
  14116. "name": {
  14117. "type": "string",
  14118. "x-go-name": "Name"
  14119. },
  14120. "tarball_url": {
  14121. "type": "string",
  14122. "x-go-name": "TarballURL"
  14123. },
  14124. "zipball_url": {
  14125. "type": "string",
  14126. "x-go-name": "ZipballURL"
  14127. }
  14128. },
  14129. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14130. },
  14131. "Team": {
  14132. "description": "Team represents a team in an organization",
  14133. "type": "object",
  14134. "properties": {
  14135. "can_create_org_repo": {
  14136. "type": "boolean",
  14137. "x-go-name": "CanCreateOrgRepo"
  14138. },
  14139. "description": {
  14140. "type": "string",
  14141. "x-go-name": "Description"
  14142. },
  14143. "id": {
  14144. "type": "integer",
  14145. "format": "int64",
  14146. "x-go-name": "ID"
  14147. },
  14148. "includes_all_repositories": {
  14149. "type": "boolean",
  14150. "x-go-name": "IncludesAllRepositories"
  14151. },
  14152. "name": {
  14153. "type": "string",
  14154. "x-go-name": "Name"
  14155. },
  14156. "organization": {
  14157. "$ref": "#/definitions/Organization"
  14158. },
  14159. "permission": {
  14160. "type": "string",
  14161. "enum": [
  14162. "none",
  14163. "read",
  14164. "write",
  14165. "admin",
  14166. "owner"
  14167. ],
  14168. "x-go-name": "Permission"
  14169. },
  14170. "units": {
  14171. "type": "array",
  14172. "items": {
  14173. "type": "string"
  14174. },
  14175. "x-go-name": "Units",
  14176. "example": [
  14177. "repo.code",
  14178. "repo.issues",
  14179. "repo.ext_issues",
  14180. "repo.wiki",
  14181. "repo.pulls",
  14182. "repo.releases",
  14183. "repo.ext_wiki"
  14184. ]
  14185. }
  14186. },
  14187. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14188. },
  14189. "TimeStamp": {
  14190. "description": "TimeStamp defines a timestamp",
  14191. "type": "integer",
  14192. "format": "int64",
  14193. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  14194. },
  14195. "TopicName": {
  14196. "description": "TopicName a list of repo topic names",
  14197. "type": "object",
  14198. "properties": {
  14199. "topics": {
  14200. "type": "array",
  14201. "items": {
  14202. "type": "string"
  14203. },
  14204. "x-go-name": "TopicNames"
  14205. }
  14206. },
  14207. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14208. },
  14209. "TopicResponse": {
  14210. "description": "TopicResponse for returning topics",
  14211. "type": "object",
  14212. "properties": {
  14213. "created": {
  14214. "type": "string",
  14215. "format": "date-time",
  14216. "x-go-name": "Created"
  14217. },
  14218. "id": {
  14219. "type": "integer",
  14220. "format": "int64",
  14221. "x-go-name": "ID"
  14222. },
  14223. "repo_count": {
  14224. "type": "integer",
  14225. "format": "int64",
  14226. "x-go-name": "RepoCount"
  14227. },
  14228. "topic_name": {
  14229. "type": "string",
  14230. "x-go-name": "Name"
  14231. },
  14232. "updated": {
  14233. "type": "string",
  14234. "format": "date-time",
  14235. "x-go-name": "Updated"
  14236. }
  14237. },
  14238. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14239. },
  14240. "TrackedTime": {
  14241. "description": "TrackedTime worked time for an issue / pr",
  14242. "type": "object",
  14243. "properties": {
  14244. "created": {
  14245. "type": "string",
  14246. "format": "date-time",
  14247. "x-go-name": "Created"
  14248. },
  14249. "id": {
  14250. "type": "integer",
  14251. "format": "int64",
  14252. "x-go-name": "ID"
  14253. },
  14254. "issue": {
  14255. "$ref": "#/definitions/Issue"
  14256. },
  14257. "issue_id": {
  14258. "description": "deprecated (only for backwards compatibility)",
  14259. "type": "integer",
  14260. "format": "int64",
  14261. "x-go-name": "IssueID"
  14262. },
  14263. "time": {
  14264. "description": "Time in seconds",
  14265. "type": "integer",
  14266. "format": "int64",
  14267. "x-go-name": "Time"
  14268. },
  14269. "user_id": {
  14270. "description": "deprecated (only for backwards compatibility)",
  14271. "type": "integer",
  14272. "format": "int64",
  14273. "x-go-name": "UserID"
  14274. },
  14275. "user_name": {
  14276. "type": "string",
  14277. "x-go-name": "UserName"
  14278. }
  14279. },
  14280. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14281. },
  14282. "TransferRepoOption": {
  14283. "description": "TransferRepoOption options when transfer a repository's ownership",
  14284. "type": "object",
  14285. "required": [
  14286. "new_owner"
  14287. ],
  14288. "properties": {
  14289. "new_owner": {
  14290. "type": "string",
  14291. "x-go-name": "NewOwner"
  14292. },
  14293. "team_ids": {
  14294. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  14295. "type": "array",
  14296. "items": {
  14297. "type": "integer",
  14298. "format": "int64"
  14299. },
  14300. "x-go-name": "TeamIDs"
  14301. }
  14302. },
  14303. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14304. },
  14305. "UpdateFileOptions": {
  14306. "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)",
  14307. "type": "object",
  14308. "required": [
  14309. "sha",
  14310. "content"
  14311. ],
  14312. "properties": {
  14313. "author": {
  14314. "$ref": "#/definitions/Identity"
  14315. },
  14316. "branch": {
  14317. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  14318. "type": "string",
  14319. "x-go-name": "BranchName"
  14320. },
  14321. "committer": {
  14322. "$ref": "#/definitions/Identity"
  14323. },
  14324. "content": {
  14325. "description": "content must be base64 encoded",
  14326. "type": "string",
  14327. "x-go-name": "Content"
  14328. },
  14329. "dates": {
  14330. "$ref": "#/definitions/CommitDateOptions"
  14331. },
  14332. "from_path": {
  14333. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  14334. "type": "string",
  14335. "x-go-name": "FromPath"
  14336. },
  14337. "message": {
  14338. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  14339. "type": "string",
  14340. "x-go-name": "Message"
  14341. },
  14342. "new_branch": {
  14343. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  14344. "type": "string",
  14345. "x-go-name": "NewBranchName"
  14346. },
  14347. "sha": {
  14348. "description": "sha is the SHA for the file that already exists",
  14349. "type": "string",
  14350. "x-go-name": "SHA"
  14351. }
  14352. },
  14353. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14354. },
  14355. "User": {
  14356. "description": "User represents a user",
  14357. "type": "object",
  14358. "properties": {
  14359. "avatar_url": {
  14360. "description": "URL to the user's avatar",
  14361. "type": "string",
  14362. "x-go-name": "AvatarURL"
  14363. },
  14364. "created": {
  14365. "type": "string",
  14366. "format": "date-time",
  14367. "x-go-name": "Created"
  14368. },
  14369. "email": {
  14370. "type": "string",
  14371. "format": "email",
  14372. "x-go-name": "Email"
  14373. },
  14374. "full_name": {
  14375. "description": "the user's full name",
  14376. "type": "string",
  14377. "x-go-name": "FullName"
  14378. },
  14379. "id": {
  14380. "description": "the user's id",
  14381. "type": "integer",
  14382. "format": "int64",
  14383. "x-go-name": "ID"
  14384. },
  14385. "is_admin": {
  14386. "description": "Is the user an administrator",
  14387. "type": "boolean",
  14388. "x-go-name": "IsAdmin"
  14389. },
  14390. "language": {
  14391. "description": "User locale",
  14392. "type": "string",
  14393. "x-go-name": "Language"
  14394. },
  14395. "last_login": {
  14396. "type": "string",
  14397. "format": "date-time",
  14398. "x-go-name": "LastLogin"
  14399. },
  14400. "login": {
  14401. "description": "the user's username",
  14402. "type": "string",
  14403. "x-go-name": "UserName"
  14404. }
  14405. },
  14406. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14407. },
  14408. "UserHeatmapData": {
  14409. "description": "UserHeatmapData represents the data needed to create a heatmap",
  14410. "type": "object",
  14411. "properties": {
  14412. "contributions": {
  14413. "type": "integer",
  14414. "format": "int64",
  14415. "x-go-name": "Contributions"
  14416. },
  14417. "timestamp": {
  14418. "$ref": "#/definitions/TimeStamp"
  14419. }
  14420. },
  14421. "x-go-package": "code.gitea.io/gitea/models"
  14422. },
  14423. "WatchInfo": {
  14424. "description": "WatchInfo represents an API watch status of one repository",
  14425. "type": "object",
  14426. "properties": {
  14427. "created_at": {
  14428. "type": "string",
  14429. "format": "date-time",
  14430. "x-go-name": "CreatedAt"
  14431. },
  14432. "ignored": {
  14433. "type": "boolean",
  14434. "x-go-name": "Ignored"
  14435. },
  14436. "reason": {
  14437. "type": "object",
  14438. "x-go-name": "Reason"
  14439. },
  14440. "repository_url": {
  14441. "type": "string",
  14442. "x-go-name": "RepositoryURL"
  14443. },
  14444. "subscribed": {
  14445. "type": "boolean",
  14446. "x-go-name": "Subscribed"
  14447. },
  14448. "url": {
  14449. "type": "string",
  14450. "x-go-name": "URL"
  14451. }
  14452. },
  14453. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14454. }
  14455. },
  14456. "responses": {
  14457. "AccessToken": {
  14458. "description": "AccessToken represents an API access token.",
  14459. "headers": {
  14460. "id": {
  14461. "type": "integer",
  14462. "format": "int64"
  14463. },
  14464. "name": {
  14465. "type": "string"
  14466. },
  14467. "sha1": {
  14468. "type": "string"
  14469. },
  14470. "token_last_eight": {
  14471. "type": "string"
  14472. }
  14473. }
  14474. },
  14475. "AccessTokenList": {
  14476. "description": "AccessTokenList represents a list of API access token.",
  14477. "schema": {
  14478. "type": "array",
  14479. "items": {
  14480. "$ref": "#/definitions/AccessToken"
  14481. }
  14482. }
  14483. },
  14484. "AnnotatedTag": {
  14485. "description": "AnnotatedTag",
  14486. "schema": {
  14487. "$ref": "#/definitions/AnnotatedTag"
  14488. }
  14489. },
  14490. "Attachment": {
  14491. "description": "Attachment",
  14492. "schema": {
  14493. "$ref": "#/definitions/Attachment"
  14494. }
  14495. },
  14496. "AttachmentList": {
  14497. "description": "AttachmentList",
  14498. "schema": {
  14499. "type": "array",
  14500. "items": {
  14501. "$ref": "#/definitions/Attachment"
  14502. }
  14503. }
  14504. },
  14505. "Branch": {
  14506. "description": "Branch",
  14507. "schema": {
  14508. "$ref": "#/definitions/Branch"
  14509. }
  14510. },
  14511. "BranchList": {
  14512. "description": "BranchList",
  14513. "schema": {
  14514. "type": "array",
  14515. "items": {
  14516. "$ref": "#/definitions/Branch"
  14517. }
  14518. }
  14519. },
  14520. "BranchProtection": {
  14521. "description": "BranchProtection",
  14522. "schema": {
  14523. "$ref": "#/definitions/BranchProtection"
  14524. }
  14525. },
  14526. "BranchProtectionList": {
  14527. "description": "BranchProtectionList",
  14528. "schema": {
  14529. "type": "array",
  14530. "items": {
  14531. "$ref": "#/definitions/BranchProtection"
  14532. }
  14533. }
  14534. },
  14535. "Comment": {
  14536. "description": "Comment",
  14537. "schema": {
  14538. "$ref": "#/definitions/Comment"
  14539. }
  14540. },
  14541. "CommentList": {
  14542. "description": "CommentList",
  14543. "schema": {
  14544. "type": "array",
  14545. "items": {
  14546. "$ref": "#/definitions/Comment"
  14547. }
  14548. }
  14549. },
  14550. "Commit": {
  14551. "description": "Commit",
  14552. "schema": {
  14553. "$ref": "#/definitions/Commit"
  14554. }
  14555. },
  14556. "CommitList": {
  14557. "description": "CommitList",
  14558. "schema": {
  14559. "type": "array",
  14560. "items": {
  14561. "$ref": "#/definitions/Commit"
  14562. }
  14563. },
  14564. "headers": {
  14565. "X-HasMore": {
  14566. "type": "boolean",
  14567. "description": "True if there is another page"
  14568. },
  14569. "X-Page": {
  14570. "type": "integer",
  14571. "format": "int64",
  14572. "description": "The current page"
  14573. },
  14574. "X-PageCount": {
  14575. "type": "integer",
  14576. "format": "int64",
  14577. "description": "Total number of pages"
  14578. },
  14579. "X-PerPage": {
  14580. "type": "integer",
  14581. "format": "int64",
  14582. "description": "Commits per page"
  14583. },
  14584. "X-Total": {
  14585. "type": "integer",
  14586. "format": "int64",
  14587. "description": "Total commit count"
  14588. }
  14589. }
  14590. },
  14591. "ContentsListResponse": {
  14592. "description": "ContentsListResponse",
  14593. "schema": {
  14594. "type": "array",
  14595. "items": {
  14596. "$ref": "#/definitions/ContentsResponse"
  14597. }
  14598. }
  14599. },
  14600. "ContentsResponse": {
  14601. "description": "ContentsResponse",
  14602. "schema": {
  14603. "$ref": "#/definitions/ContentsResponse"
  14604. }
  14605. },
  14606. "DeployKey": {
  14607. "description": "DeployKey",
  14608. "schema": {
  14609. "$ref": "#/definitions/DeployKey"
  14610. }
  14611. },
  14612. "DeployKeyList": {
  14613. "description": "DeployKeyList",
  14614. "schema": {
  14615. "type": "array",
  14616. "items": {
  14617. "$ref": "#/definitions/DeployKey"
  14618. }
  14619. }
  14620. },
  14621. "EmailList": {
  14622. "description": "EmailList",
  14623. "schema": {
  14624. "type": "array",
  14625. "items": {
  14626. "$ref": "#/definitions/Email"
  14627. }
  14628. }
  14629. },
  14630. "EmptyRepository": {
  14631. "description": "EmptyRepository",
  14632. "schema": {
  14633. "$ref": "#/definitions/APIError"
  14634. }
  14635. },
  14636. "FileDeleteResponse": {
  14637. "description": "FileDeleteResponse",
  14638. "schema": {
  14639. "$ref": "#/definitions/FileDeleteResponse"
  14640. }
  14641. },
  14642. "FileResponse": {
  14643. "description": "FileResponse",
  14644. "schema": {
  14645. "$ref": "#/definitions/FileResponse"
  14646. }
  14647. },
  14648. "GPGKey": {
  14649. "description": "GPGKey",
  14650. "schema": {
  14651. "$ref": "#/definitions/GPGKey"
  14652. }
  14653. },
  14654. "GPGKeyList": {
  14655. "description": "GPGKeyList",
  14656. "schema": {
  14657. "type": "array",
  14658. "items": {
  14659. "$ref": "#/definitions/GPGKey"
  14660. }
  14661. }
  14662. },
  14663. "GitBlobResponse": {
  14664. "description": "GitBlobResponse",
  14665. "schema": {
  14666. "$ref": "#/definitions/GitBlobResponse"
  14667. }
  14668. },
  14669. "GitHook": {
  14670. "description": "GitHook",
  14671. "schema": {
  14672. "$ref": "#/definitions/GitHook"
  14673. }
  14674. },
  14675. "GitHookList": {
  14676. "description": "GitHookList",
  14677. "schema": {
  14678. "type": "array",
  14679. "items": {
  14680. "$ref": "#/definitions/GitHook"
  14681. }
  14682. }
  14683. },
  14684. "GitTreeResponse": {
  14685. "description": "GitTreeResponse",
  14686. "schema": {
  14687. "$ref": "#/definitions/GitTreeResponse"
  14688. }
  14689. },
  14690. "Hook": {
  14691. "description": "Hook",
  14692. "schema": {
  14693. "$ref": "#/definitions/Hook"
  14694. }
  14695. },
  14696. "HookList": {
  14697. "description": "HookList",
  14698. "schema": {
  14699. "type": "array",
  14700. "items": {
  14701. "$ref": "#/definitions/Hook"
  14702. }
  14703. }
  14704. },
  14705. "Issue": {
  14706. "description": "Issue",
  14707. "schema": {
  14708. "$ref": "#/definitions/Issue"
  14709. }
  14710. },
  14711. "IssueDeadline": {
  14712. "description": "IssueDeadline",
  14713. "schema": {
  14714. "$ref": "#/definitions/IssueDeadline"
  14715. }
  14716. },
  14717. "IssueList": {
  14718. "description": "IssueList",
  14719. "schema": {
  14720. "type": "array",
  14721. "items": {
  14722. "$ref": "#/definitions/Issue"
  14723. }
  14724. }
  14725. },
  14726. "Label": {
  14727. "description": "Label",
  14728. "schema": {
  14729. "$ref": "#/definitions/Label"
  14730. }
  14731. },
  14732. "LabelList": {
  14733. "description": "LabelList",
  14734. "schema": {
  14735. "type": "array",
  14736. "items": {
  14737. "$ref": "#/definitions/Label"
  14738. }
  14739. }
  14740. },
  14741. "MarkdownRender": {
  14742. "description": "MarkdownRender is a rendered markdown document",
  14743. "schema": {
  14744. "type": "string"
  14745. }
  14746. },
  14747. "Milestone": {
  14748. "description": "Milestone",
  14749. "schema": {
  14750. "$ref": "#/definitions/Milestone"
  14751. }
  14752. },
  14753. "MilestoneList": {
  14754. "description": "MilestoneList",
  14755. "schema": {
  14756. "type": "array",
  14757. "items": {
  14758. "$ref": "#/definitions/Milestone"
  14759. }
  14760. }
  14761. },
  14762. "NotificationCount": {
  14763. "description": "Number of unread notifications",
  14764. "schema": {
  14765. "$ref": "#/definitions/NotificationCount"
  14766. }
  14767. },
  14768. "NotificationThread": {
  14769. "description": "NotificationThread",
  14770. "schema": {
  14771. "$ref": "#/definitions/NotificationThread"
  14772. }
  14773. },
  14774. "NotificationThreadList": {
  14775. "description": "NotificationThreadList",
  14776. "schema": {
  14777. "type": "array",
  14778. "items": {
  14779. "$ref": "#/definitions/NotificationThread"
  14780. }
  14781. }
  14782. },
  14783. "OAuth2Application": {
  14784. "description": "OAuth2Application",
  14785. "schema": {
  14786. "$ref": "#/definitions/OAuth2Application"
  14787. }
  14788. },
  14789. "OAuth2ApplicationList": {
  14790. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  14791. "schema": {
  14792. "type": "array",
  14793. "items": {
  14794. "$ref": "#/definitions/OAuth2Application"
  14795. }
  14796. }
  14797. },
  14798. "Organization": {
  14799. "description": "Organization",
  14800. "schema": {
  14801. "$ref": "#/definitions/Organization"
  14802. }
  14803. },
  14804. "OrganizationList": {
  14805. "description": "OrganizationList",
  14806. "schema": {
  14807. "type": "array",
  14808. "items": {
  14809. "$ref": "#/definitions/Organization"
  14810. }
  14811. }
  14812. },
  14813. "PublicKey": {
  14814. "description": "PublicKey",
  14815. "schema": {
  14816. "$ref": "#/definitions/PublicKey"
  14817. }
  14818. },
  14819. "PublicKeyList": {
  14820. "description": "PublicKeyList",
  14821. "schema": {
  14822. "type": "array",
  14823. "items": {
  14824. "$ref": "#/definitions/PublicKey"
  14825. }
  14826. }
  14827. },
  14828. "PullRequest": {
  14829. "description": "PullRequest",
  14830. "schema": {
  14831. "$ref": "#/definitions/PullRequest"
  14832. }
  14833. },
  14834. "PullRequestList": {
  14835. "description": "PullRequestList",
  14836. "schema": {
  14837. "type": "array",
  14838. "items": {
  14839. "$ref": "#/definitions/PullRequest"
  14840. }
  14841. }
  14842. },
  14843. "PullReview": {
  14844. "description": "PullReview",
  14845. "schema": {
  14846. "$ref": "#/definitions/PullReview"
  14847. }
  14848. },
  14849. "PullReviewComment": {
  14850. "description": "PullComment",
  14851. "schema": {
  14852. "$ref": "#/definitions/PullReviewComment"
  14853. }
  14854. },
  14855. "PullReviewCommentList": {
  14856. "description": "PullCommentList",
  14857. "schema": {
  14858. "type": "array",
  14859. "items": {
  14860. "$ref": "#/definitions/PullReviewComment"
  14861. }
  14862. }
  14863. },
  14864. "PullReviewList": {
  14865. "description": "PullReviewList",
  14866. "schema": {
  14867. "type": "array",
  14868. "items": {
  14869. "$ref": "#/definitions/PullReview"
  14870. }
  14871. }
  14872. },
  14873. "Reaction": {
  14874. "description": "Reaction",
  14875. "schema": {
  14876. "$ref": "#/definitions/Reaction"
  14877. }
  14878. },
  14879. "ReactionList": {
  14880. "description": "ReactionList",
  14881. "schema": {
  14882. "type": "array",
  14883. "items": {
  14884. "$ref": "#/definitions/Reaction"
  14885. }
  14886. }
  14887. },
  14888. "Reference": {
  14889. "description": "Reference",
  14890. "schema": {
  14891. "$ref": "#/definitions/Reference"
  14892. }
  14893. },
  14894. "ReferenceList": {
  14895. "description": "ReferenceList",
  14896. "schema": {
  14897. "type": "array",
  14898. "items": {
  14899. "$ref": "#/definitions/Reference"
  14900. }
  14901. }
  14902. },
  14903. "Release": {
  14904. "description": "Release",
  14905. "schema": {
  14906. "$ref": "#/definitions/Release"
  14907. }
  14908. },
  14909. "ReleaseList": {
  14910. "description": "ReleaseList",
  14911. "schema": {
  14912. "type": "array",
  14913. "items": {
  14914. "$ref": "#/definitions/Release"
  14915. }
  14916. }
  14917. },
  14918. "Repository": {
  14919. "description": "Repository",
  14920. "schema": {
  14921. "$ref": "#/definitions/Repository"
  14922. }
  14923. },
  14924. "RepositoryList": {
  14925. "description": "RepositoryList",
  14926. "schema": {
  14927. "type": "array",
  14928. "items": {
  14929. "$ref": "#/definitions/Repository"
  14930. }
  14931. }
  14932. },
  14933. "SearchResults": {
  14934. "description": "SearchResults",
  14935. "schema": {
  14936. "$ref": "#/definitions/SearchResults"
  14937. }
  14938. },
  14939. "ServerVersion": {
  14940. "description": "ServerVersion",
  14941. "schema": {
  14942. "$ref": "#/definitions/ServerVersion"
  14943. }
  14944. },
  14945. "Status": {
  14946. "description": "Status",
  14947. "schema": {
  14948. "$ref": "#/definitions/Status"
  14949. }
  14950. },
  14951. "StatusList": {
  14952. "description": "StatusList",
  14953. "schema": {
  14954. "type": "array",
  14955. "items": {
  14956. "$ref": "#/definitions/Status"
  14957. }
  14958. }
  14959. },
  14960. "StopWatch": {
  14961. "description": "StopWatch",
  14962. "schema": {
  14963. "$ref": "#/definitions/StopWatch"
  14964. }
  14965. },
  14966. "StopWatchList": {
  14967. "description": "StopWatchList",
  14968. "schema": {
  14969. "type": "array",
  14970. "items": {
  14971. "$ref": "#/definitions/StopWatch"
  14972. }
  14973. }
  14974. },
  14975. "Tag": {
  14976. "description": "Tag",
  14977. "schema": {
  14978. "$ref": "#/definitions/Tag"
  14979. }
  14980. },
  14981. "TagList": {
  14982. "description": "TagList",
  14983. "schema": {
  14984. "type": "array",
  14985. "items": {
  14986. "$ref": "#/definitions/Tag"
  14987. }
  14988. }
  14989. },
  14990. "Team": {
  14991. "description": "Team",
  14992. "schema": {
  14993. "$ref": "#/definitions/Team"
  14994. }
  14995. },
  14996. "TeamList": {
  14997. "description": "TeamList",
  14998. "schema": {
  14999. "type": "array",
  15000. "items": {
  15001. "$ref": "#/definitions/Team"
  15002. }
  15003. }
  15004. },
  15005. "TopicListResponse": {
  15006. "description": "TopicListResponse",
  15007. "schema": {
  15008. "type": "array",
  15009. "items": {
  15010. "$ref": "#/definitions/TopicResponse"
  15011. }
  15012. }
  15013. },
  15014. "TopicNames": {
  15015. "description": "TopicNames",
  15016. "schema": {
  15017. "$ref": "#/definitions/TopicName"
  15018. }
  15019. },
  15020. "TrackedTime": {
  15021. "description": "TrackedTime",
  15022. "schema": {
  15023. "$ref": "#/definitions/TrackedTime"
  15024. }
  15025. },
  15026. "TrackedTimeList": {
  15027. "description": "TrackedTimeList",
  15028. "schema": {
  15029. "type": "array",
  15030. "items": {
  15031. "$ref": "#/definitions/TrackedTime"
  15032. }
  15033. }
  15034. },
  15035. "User": {
  15036. "description": "User",
  15037. "schema": {
  15038. "$ref": "#/definitions/User"
  15039. }
  15040. },
  15041. "UserHeatmapData": {
  15042. "description": "UserHeatmapData",
  15043. "schema": {
  15044. "type": "array",
  15045. "items": {
  15046. "$ref": "#/definitions/UserHeatmapData"
  15047. }
  15048. }
  15049. },
  15050. "UserList": {
  15051. "description": "UserList",
  15052. "schema": {
  15053. "type": "array",
  15054. "items": {
  15055. "$ref": "#/definitions/User"
  15056. }
  15057. }
  15058. },
  15059. "WatchInfo": {
  15060. "description": "WatchInfo",
  15061. "schema": {
  15062. "$ref": "#/definitions/WatchInfo"
  15063. }
  15064. },
  15065. "empty": {
  15066. "description": "APIEmpty is an empty response"
  15067. },
  15068. "error": {
  15069. "description": "APIError is error format response",
  15070. "headers": {
  15071. "message": {
  15072. "type": "string"
  15073. },
  15074. "url": {
  15075. "type": "string"
  15076. }
  15077. }
  15078. },
  15079. "forbidden": {
  15080. "description": "APIForbiddenError is a forbidden error response",
  15081. "headers": {
  15082. "message": {
  15083. "type": "string"
  15084. },
  15085. "url": {
  15086. "type": "string"
  15087. }
  15088. }
  15089. },
  15090. "invalidTopicsError": {
  15091. "description": "APIInvalidTopicsError is error format response to invalid topics",
  15092. "headers": {
  15093. "invalidTopics": {
  15094. "type": "array",
  15095. "items": {
  15096. "type": "string"
  15097. }
  15098. },
  15099. "message": {
  15100. "type": "string"
  15101. }
  15102. }
  15103. },
  15104. "notFound": {
  15105. "description": "APINotFound is a not found empty response"
  15106. },
  15107. "parameterBodies": {
  15108. "description": "parameterBodies",
  15109. "schema": {
  15110. "$ref": "#/definitions/SubmitPullReviewOptions"
  15111. }
  15112. },
  15113. "redirect": {
  15114. "description": "APIRedirect is a redirect response"
  15115. },
  15116. "validationError": {
  15117. "description": "APIValidationError is error format response related to input validation",
  15118. "headers": {
  15119. "message": {
  15120. "type": "string"
  15121. },
  15122. "url": {
  15123. "type": "string"
  15124. }
  15125. }
  15126. }
  15127. },
  15128. "securityDefinitions": {
  15129. "AccessToken": {
  15130. "type": "apiKey",
  15131. "name": "access_token",
  15132. "in": "query"
  15133. },
  15134. "AuthorizationHeaderToken": {
  15135. "description": "API tokens must be prepended with \"token\" followed by a space.",
  15136. "type": "apiKey",
  15137. "name": "Authorization",
  15138. "in": "header"
  15139. },
  15140. "BasicAuth": {
  15141. "type": "basic"
  15142. },
  15143. "SudoHeader": {
  15144. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  15145. "type": "apiKey",
  15146. "name": "Sudo",
  15147. "in": "header"
  15148. },
  15149. "SudoParam": {
  15150. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  15151. "type": "apiKey",
  15152. "name": "sudo",
  15153. "in": "query"
  15154. },
  15155. "Token": {
  15156. "type": "apiKey",
  15157. "name": "token",
  15158. "in": "query"
  15159. }
  15160. },
  15161. "security": [
  15162. {
  15163. "BasicAuth": []
  15164. },
  15165. {
  15166. "Token": []
  15167. },
  15168. {
  15169. "AccessToken": []
  15170. },
  15171. {
  15172. "AuthorizationHeaderToken": []
  15173. },
  15174. {
  15175. "SudoParam": []
  15176. },
  15177. {
  15178. "SudoHeader": []
  15179. }
  15180. ]
  15181. }