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

v1_json.tmpl 380KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150
  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": "only include private repositories this user has access to (defaults to false)",
  1775. "name": "onlyPrivate",
  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. }
  2751. },
  2752. "post": {
  2753. "consumes": [
  2754. "application/json"
  2755. ],
  2756. "produces": [
  2757. "application/json"
  2758. ],
  2759. "tags": [
  2760. "repository"
  2761. ],
  2762. "summary": "Create a file in a repository",
  2763. "operationId": "repoCreateFile",
  2764. "parameters": [
  2765. {
  2766. "type": "string",
  2767. "description": "owner of the repo",
  2768. "name": "owner",
  2769. "in": "path",
  2770. "required": true
  2771. },
  2772. {
  2773. "type": "string",
  2774. "description": "name of the repo",
  2775. "name": "repo",
  2776. "in": "path",
  2777. "required": true
  2778. },
  2779. {
  2780. "type": "string",
  2781. "description": "path of the file to create",
  2782. "name": "filepath",
  2783. "in": "path",
  2784. "required": true
  2785. },
  2786. {
  2787. "name": "body",
  2788. "in": "body",
  2789. "required": true,
  2790. "schema": {
  2791. "$ref": "#/definitions/CreateFileOptions"
  2792. }
  2793. }
  2794. ],
  2795. "responses": {
  2796. "201": {
  2797. "$ref": "#/responses/FileResponse"
  2798. }
  2799. }
  2800. },
  2801. "delete": {
  2802. "consumes": [
  2803. "application/json"
  2804. ],
  2805. "produces": [
  2806. "application/json"
  2807. ],
  2808. "tags": [
  2809. "repository"
  2810. ],
  2811. "summary": "Delete a file in a repository",
  2812. "operationId": "repoDeleteFile",
  2813. "parameters": [
  2814. {
  2815. "type": "string",
  2816. "description": "owner of the repo",
  2817. "name": "owner",
  2818. "in": "path",
  2819. "required": true
  2820. },
  2821. {
  2822. "type": "string",
  2823. "description": "name of the repo",
  2824. "name": "repo",
  2825. "in": "path",
  2826. "required": true
  2827. },
  2828. {
  2829. "type": "string",
  2830. "description": "path of the file to delete",
  2831. "name": "filepath",
  2832. "in": "path",
  2833. "required": true
  2834. },
  2835. {
  2836. "name": "body",
  2837. "in": "body",
  2838. "required": true,
  2839. "schema": {
  2840. "$ref": "#/definitions/DeleteFileOptions"
  2841. }
  2842. }
  2843. ],
  2844. "responses": {
  2845. "200": {
  2846. "$ref": "#/responses/FileDeleteResponse"
  2847. },
  2848. "400": {
  2849. "$ref": "#/responses/error"
  2850. },
  2851. "403": {
  2852. "$ref": "#/responses/error"
  2853. },
  2854. "404": {
  2855. "$ref": "#/responses/error"
  2856. }
  2857. }
  2858. }
  2859. },
  2860. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2861. "get": {
  2862. "produces": [
  2863. "application/json"
  2864. ],
  2865. "tags": [
  2866. "repository"
  2867. ],
  2868. "summary": "Get the EditorConfig definitions of a file in a repository",
  2869. "operationId": "repoGetEditorConfig",
  2870. "parameters": [
  2871. {
  2872. "type": "string",
  2873. "description": "owner of the repo",
  2874. "name": "owner",
  2875. "in": "path",
  2876. "required": true
  2877. },
  2878. {
  2879. "type": "string",
  2880. "description": "name of the repo",
  2881. "name": "repo",
  2882. "in": "path",
  2883. "required": true
  2884. },
  2885. {
  2886. "type": "string",
  2887. "description": "filepath of file to get",
  2888. "name": "filepath",
  2889. "in": "path",
  2890. "required": true
  2891. }
  2892. ],
  2893. "responses": {
  2894. "200": {
  2895. "description": "success"
  2896. },
  2897. "404": {
  2898. "$ref": "#/responses/notFound"
  2899. }
  2900. }
  2901. }
  2902. },
  2903. "/repos/{owner}/{repo}/forks": {
  2904. "get": {
  2905. "produces": [
  2906. "application/json"
  2907. ],
  2908. "tags": [
  2909. "repository"
  2910. ],
  2911. "summary": "List a repository's forks",
  2912. "operationId": "listForks",
  2913. "parameters": [
  2914. {
  2915. "type": "string",
  2916. "description": "owner of the repo",
  2917. "name": "owner",
  2918. "in": "path",
  2919. "required": true
  2920. },
  2921. {
  2922. "type": "string",
  2923. "description": "name of the repo",
  2924. "name": "repo",
  2925. "in": "path",
  2926. "required": true
  2927. },
  2928. {
  2929. "type": "integer",
  2930. "description": "page number of results to return (1-based)",
  2931. "name": "page",
  2932. "in": "query"
  2933. },
  2934. {
  2935. "type": "integer",
  2936. "description": "page size of results, maximum page size is 50",
  2937. "name": "limit",
  2938. "in": "query"
  2939. }
  2940. ],
  2941. "responses": {
  2942. "200": {
  2943. "$ref": "#/responses/RepositoryList"
  2944. }
  2945. }
  2946. },
  2947. "post": {
  2948. "produces": [
  2949. "application/json"
  2950. ],
  2951. "tags": [
  2952. "repository"
  2953. ],
  2954. "summary": "Fork a repository",
  2955. "operationId": "createFork",
  2956. "parameters": [
  2957. {
  2958. "type": "string",
  2959. "description": "owner of the repo to fork",
  2960. "name": "owner",
  2961. "in": "path",
  2962. "required": true
  2963. },
  2964. {
  2965. "type": "string",
  2966. "description": "name of the repo to fork",
  2967. "name": "repo",
  2968. "in": "path",
  2969. "required": true
  2970. },
  2971. {
  2972. "name": "body",
  2973. "in": "body",
  2974. "schema": {
  2975. "$ref": "#/definitions/CreateForkOption"
  2976. }
  2977. }
  2978. ],
  2979. "responses": {
  2980. "202": {
  2981. "$ref": "#/responses/Repository"
  2982. },
  2983. "403": {
  2984. "$ref": "#/responses/forbidden"
  2985. },
  2986. "422": {
  2987. "$ref": "#/responses/validationError"
  2988. }
  2989. }
  2990. }
  2991. },
  2992. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  2993. "get": {
  2994. "produces": [
  2995. "application/json"
  2996. ],
  2997. "tags": [
  2998. "repository"
  2999. ],
  3000. "summary": "Gets the blob of a repository.",
  3001. "operationId": "GetBlob",
  3002. "parameters": [
  3003. {
  3004. "type": "string",
  3005. "description": "owner of the repo",
  3006. "name": "owner",
  3007. "in": "path",
  3008. "required": true
  3009. },
  3010. {
  3011. "type": "string",
  3012. "description": "name of the repo",
  3013. "name": "repo",
  3014. "in": "path",
  3015. "required": true
  3016. },
  3017. {
  3018. "type": "string",
  3019. "description": "sha of the commit",
  3020. "name": "sha",
  3021. "in": "path",
  3022. "required": true
  3023. }
  3024. ],
  3025. "responses": {
  3026. "200": {
  3027. "$ref": "#/responses/GitBlobResponse"
  3028. },
  3029. "400": {
  3030. "$ref": "#/responses/error"
  3031. }
  3032. }
  3033. }
  3034. },
  3035. "/repos/{owner}/{repo}/git/commits/{sha}": {
  3036. "get": {
  3037. "produces": [
  3038. "application/json"
  3039. ],
  3040. "tags": [
  3041. "repository"
  3042. ],
  3043. "summary": "Get a single commit from a repository",
  3044. "operationId": "repoGetSingleCommit",
  3045. "parameters": [
  3046. {
  3047. "type": "string",
  3048. "description": "owner of the repo",
  3049. "name": "owner",
  3050. "in": "path",
  3051. "required": true
  3052. },
  3053. {
  3054. "type": "string",
  3055. "description": "name of the repo",
  3056. "name": "repo",
  3057. "in": "path",
  3058. "required": true
  3059. },
  3060. {
  3061. "type": "string",
  3062. "description": "a git ref or commit sha",
  3063. "name": "sha",
  3064. "in": "path",
  3065. "required": true
  3066. }
  3067. ],
  3068. "responses": {
  3069. "200": {
  3070. "$ref": "#/responses/Commit"
  3071. },
  3072. "404": {
  3073. "$ref": "#/responses/notFound"
  3074. },
  3075. "422": {
  3076. "$ref": "#/responses/validationError"
  3077. }
  3078. }
  3079. }
  3080. },
  3081. "/repos/{owner}/{repo}/git/refs": {
  3082. "get": {
  3083. "produces": [
  3084. "application/json"
  3085. ],
  3086. "tags": [
  3087. "repository"
  3088. ],
  3089. "summary": "Get specified ref or filtered repository's refs",
  3090. "operationId": "repoListAllGitRefs",
  3091. "parameters": [
  3092. {
  3093. "type": "string",
  3094. "description": "owner of the repo",
  3095. "name": "owner",
  3096. "in": "path",
  3097. "required": true
  3098. },
  3099. {
  3100. "type": "string",
  3101. "description": "name of the repo",
  3102. "name": "repo",
  3103. "in": "path",
  3104. "required": true
  3105. }
  3106. ],
  3107. "responses": {
  3108. "200": {
  3109. "$ref": "#/responses/ReferenceList"
  3110. },
  3111. "404": {
  3112. "$ref": "#/responses/notFound"
  3113. }
  3114. }
  3115. }
  3116. },
  3117. "/repos/{owner}/{repo}/git/refs/{ref}": {
  3118. "get": {
  3119. "produces": [
  3120. "application/json"
  3121. ],
  3122. "tags": [
  3123. "repository"
  3124. ],
  3125. "summary": "Get specified ref or filtered repository's refs",
  3126. "operationId": "repoListGitRefs",
  3127. "parameters": [
  3128. {
  3129. "type": "string",
  3130. "description": "owner of the repo",
  3131. "name": "owner",
  3132. "in": "path",
  3133. "required": true
  3134. },
  3135. {
  3136. "type": "string",
  3137. "description": "name of the repo",
  3138. "name": "repo",
  3139. "in": "path",
  3140. "required": true
  3141. },
  3142. {
  3143. "type": "string",
  3144. "description": "part or full name of the ref",
  3145. "name": "ref",
  3146. "in": "path",
  3147. "required": true
  3148. }
  3149. ],
  3150. "responses": {
  3151. "200": {
  3152. "$ref": "#/responses/ReferenceList"
  3153. },
  3154. "404": {
  3155. "$ref": "#/responses/notFound"
  3156. }
  3157. }
  3158. }
  3159. },
  3160. "/repos/{owner}/{repo}/git/tags/{sha}": {
  3161. "get": {
  3162. "produces": [
  3163. "application/json"
  3164. ],
  3165. "tags": [
  3166. "repository"
  3167. ],
  3168. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  3169. "operationId": "GetTag",
  3170. "parameters": [
  3171. {
  3172. "type": "string",
  3173. "description": "owner of the repo",
  3174. "name": "owner",
  3175. "in": "path",
  3176. "required": true
  3177. },
  3178. {
  3179. "type": "string",
  3180. "description": "name of the repo",
  3181. "name": "repo",
  3182. "in": "path",
  3183. "required": true
  3184. },
  3185. {
  3186. "type": "string",
  3187. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  3188. "name": "sha",
  3189. "in": "path",
  3190. "required": true
  3191. }
  3192. ],
  3193. "responses": {
  3194. "200": {
  3195. "$ref": "#/responses/AnnotatedTag"
  3196. },
  3197. "400": {
  3198. "$ref": "#/responses/error"
  3199. }
  3200. }
  3201. }
  3202. },
  3203. "/repos/{owner}/{repo}/git/trees/{sha}": {
  3204. "get": {
  3205. "produces": [
  3206. "application/json"
  3207. ],
  3208. "tags": [
  3209. "repository"
  3210. ],
  3211. "summary": "Gets the tree of a repository.",
  3212. "operationId": "GetTree",
  3213. "parameters": [
  3214. {
  3215. "type": "string",
  3216. "description": "owner of the repo",
  3217. "name": "owner",
  3218. "in": "path",
  3219. "required": true
  3220. },
  3221. {
  3222. "type": "string",
  3223. "description": "name of the repo",
  3224. "name": "repo",
  3225. "in": "path",
  3226. "required": true
  3227. },
  3228. {
  3229. "type": "string",
  3230. "description": "sha of the commit",
  3231. "name": "sha",
  3232. "in": "path",
  3233. "required": true
  3234. },
  3235. {
  3236. "type": "boolean",
  3237. "description": "show all directories and files",
  3238. "name": "recursive",
  3239. "in": "query"
  3240. },
  3241. {
  3242. "type": "integer",
  3243. "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",
  3244. "name": "page",
  3245. "in": "query"
  3246. },
  3247. {
  3248. "type": "integer",
  3249. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  3250. "name": "per_page",
  3251. "in": "query"
  3252. }
  3253. ],
  3254. "responses": {
  3255. "200": {
  3256. "$ref": "#/responses/GitTreeResponse"
  3257. },
  3258. "400": {
  3259. "$ref": "#/responses/error"
  3260. }
  3261. }
  3262. }
  3263. },
  3264. "/repos/{owner}/{repo}/hooks": {
  3265. "get": {
  3266. "produces": [
  3267. "application/json"
  3268. ],
  3269. "tags": [
  3270. "repository"
  3271. ],
  3272. "summary": "List the hooks in a repository",
  3273. "operationId": "repoListHooks",
  3274. "parameters": [
  3275. {
  3276. "type": "string",
  3277. "description": "owner of the repo",
  3278. "name": "owner",
  3279. "in": "path",
  3280. "required": true
  3281. },
  3282. {
  3283. "type": "string",
  3284. "description": "name of the repo",
  3285. "name": "repo",
  3286. "in": "path",
  3287. "required": true
  3288. },
  3289. {
  3290. "type": "integer",
  3291. "description": "page number of results to return (1-based)",
  3292. "name": "page",
  3293. "in": "query"
  3294. },
  3295. {
  3296. "type": "integer",
  3297. "description": "page size of results, maximum page size is 50",
  3298. "name": "limit",
  3299. "in": "query"
  3300. }
  3301. ],
  3302. "responses": {
  3303. "200": {
  3304. "$ref": "#/responses/HookList"
  3305. }
  3306. }
  3307. },
  3308. "post": {
  3309. "consumes": [
  3310. "application/json"
  3311. ],
  3312. "produces": [
  3313. "application/json"
  3314. ],
  3315. "tags": [
  3316. "repository"
  3317. ],
  3318. "summary": "Create a hook",
  3319. "operationId": "repoCreateHook",
  3320. "parameters": [
  3321. {
  3322. "type": "string",
  3323. "description": "owner of the repo",
  3324. "name": "owner",
  3325. "in": "path",
  3326. "required": true
  3327. },
  3328. {
  3329. "type": "string",
  3330. "description": "name of the repo",
  3331. "name": "repo",
  3332. "in": "path",
  3333. "required": true
  3334. },
  3335. {
  3336. "name": "body",
  3337. "in": "body",
  3338. "schema": {
  3339. "$ref": "#/definitions/CreateHookOption"
  3340. }
  3341. }
  3342. ],
  3343. "responses": {
  3344. "201": {
  3345. "$ref": "#/responses/Hook"
  3346. }
  3347. }
  3348. }
  3349. },
  3350. "/repos/{owner}/{repo}/hooks/git": {
  3351. "get": {
  3352. "produces": [
  3353. "application/json"
  3354. ],
  3355. "tags": [
  3356. "repository"
  3357. ],
  3358. "summary": "List the Git hooks in a repository",
  3359. "operationId": "repoListGitHooks",
  3360. "parameters": [
  3361. {
  3362. "type": "string",
  3363. "description": "owner of the repo",
  3364. "name": "owner",
  3365. "in": "path",
  3366. "required": true
  3367. },
  3368. {
  3369. "type": "string",
  3370. "description": "name of the repo",
  3371. "name": "repo",
  3372. "in": "path",
  3373. "required": true
  3374. }
  3375. ],
  3376. "responses": {
  3377. "200": {
  3378. "$ref": "#/responses/GitHookList"
  3379. }
  3380. }
  3381. }
  3382. },
  3383. "/repos/{owner}/{repo}/hooks/git/{id}": {
  3384. "get": {
  3385. "produces": [
  3386. "application/json"
  3387. ],
  3388. "tags": [
  3389. "repository"
  3390. ],
  3391. "summary": "Get a Git hook",
  3392. "operationId": "repoGetGitHook",
  3393. "parameters": [
  3394. {
  3395. "type": "string",
  3396. "description": "owner of the repo",
  3397. "name": "owner",
  3398. "in": "path",
  3399. "required": true
  3400. },
  3401. {
  3402. "type": "string",
  3403. "description": "name of the repo",
  3404. "name": "repo",
  3405. "in": "path",
  3406. "required": true
  3407. },
  3408. {
  3409. "type": "string",
  3410. "description": "id of the hook to get",
  3411. "name": "id",
  3412. "in": "path",
  3413. "required": true
  3414. }
  3415. ],
  3416. "responses": {
  3417. "200": {
  3418. "$ref": "#/responses/GitHook"
  3419. },
  3420. "404": {
  3421. "$ref": "#/responses/notFound"
  3422. }
  3423. }
  3424. },
  3425. "delete": {
  3426. "produces": [
  3427. "application/json"
  3428. ],
  3429. "tags": [
  3430. "repository"
  3431. ],
  3432. "summary": "Delete a Git hook in a repository",
  3433. "operationId": "repoDeleteGitHook",
  3434. "parameters": [
  3435. {
  3436. "type": "string",
  3437. "description": "owner of the repo",
  3438. "name": "owner",
  3439. "in": "path",
  3440. "required": true
  3441. },
  3442. {
  3443. "type": "string",
  3444. "description": "name of the repo",
  3445. "name": "repo",
  3446. "in": "path",
  3447. "required": true
  3448. },
  3449. {
  3450. "type": "string",
  3451. "description": "id of the hook to get",
  3452. "name": "id",
  3453. "in": "path",
  3454. "required": true
  3455. }
  3456. ],
  3457. "responses": {
  3458. "204": {
  3459. "$ref": "#/responses/empty"
  3460. },
  3461. "404": {
  3462. "$ref": "#/responses/notFound"
  3463. }
  3464. }
  3465. },
  3466. "patch": {
  3467. "produces": [
  3468. "application/json"
  3469. ],
  3470. "tags": [
  3471. "repository"
  3472. ],
  3473. "summary": "Edit a Git hook in a repository",
  3474. "operationId": "repoEditGitHook",
  3475. "parameters": [
  3476. {
  3477. "type": "string",
  3478. "description": "owner of the repo",
  3479. "name": "owner",
  3480. "in": "path",
  3481. "required": true
  3482. },
  3483. {
  3484. "type": "string",
  3485. "description": "name of the repo",
  3486. "name": "repo",
  3487. "in": "path",
  3488. "required": true
  3489. },
  3490. {
  3491. "type": "string",
  3492. "description": "id of the hook to get",
  3493. "name": "id",
  3494. "in": "path",
  3495. "required": true
  3496. },
  3497. {
  3498. "name": "body",
  3499. "in": "body",
  3500. "schema": {
  3501. "$ref": "#/definitions/EditGitHookOption"
  3502. }
  3503. }
  3504. ],
  3505. "responses": {
  3506. "200": {
  3507. "$ref": "#/responses/GitHook"
  3508. },
  3509. "404": {
  3510. "$ref": "#/responses/notFound"
  3511. }
  3512. }
  3513. }
  3514. },
  3515. "/repos/{owner}/{repo}/hooks/{id}": {
  3516. "get": {
  3517. "produces": [
  3518. "application/json"
  3519. ],
  3520. "tags": [
  3521. "repository"
  3522. ],
  3523. "summary": "Get a hook",
  3524. "operationId": "repoGetHook",
  3525. "parameters": [
  3526. {
  3527. "type": "string",
  3528. "description": "owner of the repo",
  3529. "name": "owner",
  3530. "in": "path",
  3531. "required": true
  3532. },
  3533. {
  3534. "type": "string",
  3535. "description": "name of the repo",
  3536. "name": "repo",
  3537. "in": "path",
  3538. "required": true
  3539. },
  3540. {
  3541. "type": "integer",
  3542. "format": "int64",
  3543. "description": "id of the hook to get",
  3544. "name": "id",
  3545. "in": "path",
  3546. "required": true
  3547. }
  3548. ],
  3549. "responses": {
  3550. "200": {
  3551. "$ref": "#/responses/Hook"
  3552. },
  3553. "404": {
  3554. "$ref": "#/responses/notFound"
  3555. }
  3556. }
  3557. },
  3558. "delete": {
  3559. "produces": [
  3560. "application/json"
  3561. ],
  3562. "tags": [
  3563. "repository"
  3564. ],
  3565. "summary": "Delete a hook in a repository",
  3566. "operationId": "repoDeleteHook",
  3567. "parameters": [
  3568. {
  3569. "type": "string",
  3570. "description": "owner of the repo",
  3571. "name": "owner",
  3572. "in": "path",
  3573. "required": true
  3574. },
  3575. {
  3576. "type": "string",
  3577. "description": "name of the repo",
  3578. "name": "repo",
  3579. "in": "path",
  3580. "required": true
  3581. },
  3582. {
  3583. "type": "integer",
  3584. "format": "int64",
  3585. "description": "id of the hook to delete",
  3586. "name": "id",
  3587. "in": "path",
  3588. "required": true
  3589. }
  3590. ],
  3591. "responses": {
  3592. "204": {
  3593. "$ref": "#/responses/empty"
  3594. },
  3595. "404": {
  3596. "$ref": "#/responses/notFound"
  3597. }
  3598. }
  3599. },
  3600. "patch": {
  3601. "produces": [
  3602. "application/json"
  3603. ],
  3604. "tags": [
  3605. "repository"
  3606. ],
  3607. "summary": "Edit a hook in a repository",
  3608. "operationId": "repoEditHook",
  3609. "parameters": [
  3610. {
  3611. "type": "string",
  3612. "description": "owner of the repo",
  3613. "name": "owner",
  3614. "in": "path",
  3615. "required": true
  3616. },
  3617. {
  3618. "type": "string",
  3619. "description": "name of the repo",
  3620. "name": "repo",
  3621. "in": "path",
  3622. "required": true
  3623. },
  3624. {
  3625. "type": "integer",
  3626. "format": "int64",
  3627. "description": "index of the hook",
  3628. "name": "id",
  3629. "in": "path",
  3630. "required": true
  3631. },
  3632. {
  3633. "name": "body",
  3634. "in": "body",
  3635. "schema": {
  3636. "$ref": "#/definitions/EditHookOption"
  3637. }
  3638. }
  3639. ],
  3640. "responses": {
  3641. "200": {
  3642. "$ref": "#/responses/Hook"
  3643. }
  3644. }
  3645. }
  3646. },
  3647. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3648. "post": {
  3649. "produces": [
  3650. "application/json"
  3651. ],
  3652. "tags": [
  3653. "repository"
  3654. ],
  3655. "summary": "Test a push webhook",
  3656. "operationId": "repoTestHook",
  3657. "parameters": [
  3658. {
  3659. "type": "string",
  3660. "description": "owner of the repo",
  3661. "name": "owner",
  3662. "in": "path",
  3663. "required": true
  3664. },
  3665. {
  3666. "type": "string",
  3667. "description": "name of the repo",
  3668. "name": "repo",
  3669. "in": "path",
  3670. "required": true
  3671. },
  3672. {
  3673. "type": "integer",
  3674. "format": "int64",
  3675. "description": "id of the hook to test",
  3676. "name": "id",
  3677. "in": "path",
  3678. "required": true
  3679. }
  3680. ],
  3681. "responses": {
  3682. "204": {
  3683. "$ref": "#/responses/empty"
  3684. }
  3685. }
  3686. }
  3687. },
  3688. "/repos/{owner}/{repo}/issues": {
  3689. "get": {
  3690. "produces": [
  3691. "application/json"
  3692. ],
  3693. "tags": [
  3694. "issue"
  3695. ],
  3696. "summary": "List a repository's issues",
  3697. "operationId": "issueListIssues",
  3698. "parameters": [
  3699. {
  3700. "type": "string",
  3701. "description": "owner of the repo",
  3702. "name": "owner",
  3703. "in": "path",
  3704. "required": true
  3705. },
  3706. {
  3707. "type": "string",
  3708. "description": "name of the repo",
  3709. "name": "repo",
  3710. "in": "path",
  3711. "required": true
  3712. },
  3713. {
  3714. "type": "string",
  3715. "description": "whether issue is open or closed",
  3716. "name": "state",
  3717. "in": "query"
  3718. },
  3719. {
  3720. "type": "string",
  3721. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3722. "name": "labels",
  3723. "in": "query"
  3724. },
  3725. {
  3726. "type": "string",
  3727. "description": "search string",
  3728. "name": "q",
  3729. "in": "query"
  3730. },
  3731. {
  3732. "type": "string",
  3733. "description": "filter by type (issues / pulls) if set",
  3734. "name": "type",
  3735. "in": "query"
  3736. },
  3737. {
  3738. "type": "string",
  3739. "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",
  3740. "name": "milestones",
  3741. "in": "query"
  3742. },
  3743. {
  3744. "type": "integer",
  3745. "description": "page number of results to return (1-based)",
  3746. "name": "page",
  3747. "in": "query"
  3748. },
  3749. {
  3750. "type": "integer",
  3751. "description": "page size of results, maximum page size is 50",
  3752. "name": "limit",
  3753. "in": "query"
  3754. }
  3755. ],
  3756. "responses": {
  3757. "200": {
  3758. "$ref": "#/responses/IssueList"
  3759. }
  3760. }
  3761. },
  3762. "post": {
  3763. "consumes": [
  3764. "application/json"
  3765. ],
  3766. "produces": [
  3767. "application/json"
  3768. ],
  3769. "tags": [
  3770. "issue"
  3771. ],
  3772. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3773. "operationId": "issueCreateIssue",
  3774. "parameters": [
  3775. {
  3776. "type": "string",
  3777. "description": "owner of the repo",
  3778. "name": "owner",
  3779. "in": "path",
  3780. "required": true
  3781. },
  3782. {
  3783. "type": "string",
  3784. "description": "name of the repo",
  3785. "name": "repo",
  3786. "in": "path",
  3787. "required": true
  3788. },
  3789. {
  3790. "name": "body",
  3791. "in": "body",
  3792. "schema": {
  3793. "$ref": "#/definitions/CreateIssueOption"
  3794. }
  3795. }
  3796. ],
  3797. "responses": {
  3798. "201": {
  3799. "$ref": "#/responses/Issue"
  3800. },
  3801. "403": {
  3802. "$ref": "#/responses/forbidden"
  3803. },
  3804. "412": {
  3805. "$ref": "#/responses/error"
  3806. },
  3807. "422": {
  3808. "$ref": "#/responses/validationError"
  3809. }
  3810. }
  3811. }
  3812. },
  3813. "/repos/{owner}/{repo}/issues/comments": {
  3814. "get": {
  3815. "produces": [
  3816. "application/json"
  3817. ],
  3818. "tags": [
  3819. "issue"
  3820. ],
  3821. "summary": "List all comments in a repository",
  3822. "operationId": "issueGetRepoComments",
  3823. "parameters": [
  3824. {
  3825. "type": "string",
  3826. "description": "owner of the repo",
  3827. "name": "owner",
  3828. "in": "path",
  3829. "required": true
  3830. },
  3831. {
  3832. "type": "string",
  3833. "description": "name of the repo",
  3834. "name": "repo",
  3835. "in": "path",
  3836. "required": true
  3837. },
  3838. {
  3839. "type": "string",
  3840. "format": "date-time",
  3841. "description": "if provided, only comments updated since the provided time are returned.",
  3842. "name": "since",
  3843. "in": "query"
  3844. },
  3845. {
  3846. "type": "string",
  3847. "format": "date-time",
  3848. "description": "if provided, only comments updated before the provided time are returned.",
  3849. "name": "before",
  3850. "in": "query"
  3851. },
  3852. {
  3853. "type": "integer",
  3854. "description": "page number of results to return (1-based)",
  3855. "name": "page",
  3856. "in": "query"
  3857. },
  3858. {
  3859. "type": "integer",
  3860. "description": "page size of results, maximum page size is 50",
  3861. "name": "limit",
  3862. "in": "query"
  3863. }
  3864. ],
  3865. "responses": {
  3866. "200": {
  3867. "$ref": "#/responses/CommentList"
  3868. }
  3869. }
  3870. }
  3871. },
  3872. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3873. "get": {
  3874. "consumes": [
  3875. "application/json"
  3876. ],
  3877. "produces": [
  3878. "application/json"
  3879. ],
  3880. "tags": [
  3881. "issue"
  3882. ],
  3883. "summary": "Get a comment",
  3884. "operationId": "issueGetComment",
  3885. "parameters": [
  3886. {
  3887. "type": "string",
  3888. "description": "owner of the repo",
  3889. "name": "owner",
  3890. "in": "path",
  3891. "required": true
  3892. },
  3893. {
  3894. "type": "string",
  3895. "description": "name of the repo",
  3896. "name": "repo",
  3897. "in": "path",
  3898. "required": true
  3899. },
  3900. {
  3901. "type": "integer",
  3902. "format": "int64",
  3903. "description": "id of the comment",
  3904. "name": "id",
  3905. "in": "path",
  3906. "required": true
  3907. }
  3908. ],
  3909. "responses": {
  3910. "200": {
  3911. "$ref": "#/responses/Comment"
  3912. },
  3913. "204": {
  3914. "$ref": "#/responses/empty"
  3915. },
  3916. "403": {
  3917. "$ref": "#/responses/forbidden"
  3918. },
  3919. "404": {
  3920. "$ref": "#/responses/notFound"
  3921. }
  3922. }
  3923. },
  3924. "delete": {
  3925. "tags": [
  3926. "issue"
  3927. ],
  3928. "summary": "Delete a comment",
  3929. "operationId": "issueDeleteComment",
  3930. "parameters": [
  3931. {
  3932. "type": "string",
  3933. "description": "owner of the repo",
  3934. "name": "owner",
  3935. "in": "path",
  3936. "required": true
  3937. },
  3938. {
  3939. "type": "string",
  3940. "description": "name of the repo",
  3941. "name": "repo",
  3942. "in": "path",
  3943. "required": true
  3944. },
  3945. {
  3946. "type": "integer",
  3947. "format": "int64",
  3948. "description": "id of comment to delete",
  3949. "name": "id",
  3950. "in": "path",
  3951. "required": true
  3952. }
  3953. ],
  3954. "responses": {
  3955. "204": {
  3956. "$ref": "#/responses/empty"
  3957. },
  3958. "403": {
  3959. "$ref": "#/responses/forbidden"
  3960. },
  3961. "404": {
  3962. "$ref": "#/responses/notFound"
  3963. }
  3964. }
  3965. },
  3966. "patch": {
  3967. "consumes": [
  3968. "application/json"
  3969. ],
  3970. "produces": [
  3971. "application/json"
  3972. ],
  3973. "tags": [
  3974. "issue"
  3975. ],
  3976. "summary": "Edit a comment",
  3977. "operationId": "issueEditComment",
  3978. "parameters": [
  3979. {
  3980. "type": "string",
  3981. "description": "owner of the repo",
  3982. "name": "owner",
  3983. "in": "path",
  3984. "required": true
  3985. },
  3986. {
  3987. "type": "string",
  3988. "description": "name of the repo",
  3989. "name": "repo",
  3990. "in": "path",
  3991. "required": true
  3992. },
  3993. {
  3994. "type": "integer",
  3995. "format": "int64",
  3996. "description": "id of the comment to edit",
  3997. "name": "id",
  3998. "in": "path",
  3999. "required": true
  4000. },
  4001. {
  4002. "name": "body",
  4003. "in": "body",
  4004. "schema": {
  4005. "$ref": "#/definitions/EditIssueCommentOption"
  4006. }
  4007. }
  4008. ],
  4009. "responses": {
  4010. "200": {
  4011. "$ref": "#/responses/Comment"
  4012. },
  4013. "204": {
  4014. "$ref": "#/responses/empty"
  4015. },
  4016. "403": {
  4017. "$ref": "#/responses/forbidden"
  4018. },
  4019. "404": {
  4020. "$ref": "#/responses/notFound"
  4021. }
  4022. }
  4023. }
  4024. },
  4025. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  4026. "get": {
  4027. "consumes": [
  4028. "application/json"
  4029. ],
  4030. "produces": [
  4031. "application/json"
  4032. ],
  4033. "tags": [
  4034. "issue"
  4035. ],
  4036. "summary": "Get a list of reactions from a comment of an issue",
  4037. "operationId": "issueGetCommentReactions",
  4038. "parameters": [
  4039. {
  4040. "type": "string",
  4041. "description": "owner of the repo",
  4042. "name": "owner",
  4043. "in": "path",
  4044. "required": true
  4045. },
  4046. {
  4047. "type": "string",
  4048. "description": "name of the repo",
  4049. "name": "repo",
  4050. "in": "path",
  4051. "required": true
  4052. },
  4053. {
  4054. "type": "integer",
  4055. "format": "int64",
  4056. "description": "id of the comment to edit",
  4057. "name": "id",
  4058. "in": "path",
  4059. "required": true
  4060. }
  4061. ],
  4062. "responses": {
  4063. "200": {
  4064. "$ref": "#/responses/ReactionList"
  4065. },
  4066. "403": {
  4067. "$ref": "#/responses/forbidden"
  4068. }
  4069. }
  4070. },
  4071. "post": {
  4072. "consumes": [
  4073. "application/json"
  4074. ],
  4075. "produces": [
  4076. "application/json"
  4077. ],
  4078. "tags": [
  4079. "issue"
  4080. ],
  4081. "summary": "Add a reaction to a comment of an issue",
  4082. "operationId": "issuePostCommentReaction",
  4083. "parameters": [
  4084. {
  4085. "type": "string",
  4086. "description": "owner of the repo",
  4087. "name": "owner",
  4088. "in": "path",
  4089. "required": true
  4090. },
  4091. {
  4092. "type": "string",
  4093. "description": "name of the repo",
  4094. "name": "repo",
  4095. "in": "path",
  4096. "required": true
  4097. },
  4098. {
  4099. "type": "integer",
  4100. "format": "int64",
  4101. "description": "id of the comment to edit",
  4102. "name": "id",
  4103. "in": "path",
  4104. "required": true
  4105. },
  4106. {
  4107. "name": "content",
  4108. "in": "body",
  4109. "schema": {
  4110. "$ref": "#/definitions/EditReactionOption"
  4111. }
  4112. }
  4113. ],
  4114. "responses": {
  4115. "200": {
  4116. "$ref": "#/responses/Reaction"
  4117. },
  4118. "201": {
  4119. "$ref": "#/responses/Reaction"
  4120. },
  4121. "403": {
  4122. "$ref": "#/responses/forbidden"
  4123. }
  4124. }
  4125. },
  4126. "delete": {
  4127. "consumes": [
  4128. "application/json"
  4129. ],
  4130. "produces": [
  4131. "application/json"
  4132. ],
  4133. "tags": [
  4134. "issue"
  4135. ],
  4136. "summary": "Remove a reaction from a comment of an issue",
  4137. "operationId": "issueDeleteCommentReaction",
  4138. "parameters": [
  4139. {
  4140. "type": "string",
  4141. "description": "owner of the repo",
  4142. "name": "owner",
  4143. "in": "path",
  4144. "required": true
  4145. },
  4146. {
  4147. "type": "string",
  4148. "description": "name of the repo",
  4149. "name": "repo",
  4150. "in": "path",
  4151. "required": true
  4152. },
  4153. {
  4154. "type": "integer",
  4155. "format": "int64",
  4156. "description": "id of the comment to edit",
  4157. "name": "id",
  4158. "in": "path",
  4159. "required": true
  4160. },
  4161. {
  4162. "name": "content",
  4163. "in": "body",
  4164. "schema": {
  4165. "$ref": "#/definitions/EditReactionOption"
  4166. }
  4167. }
  4168. ],
  4169. "responses": {
  4170. "200": {
  4171. "$ref": "#/responses/empty"
  4172. },
  4173. "403": {
  4174. "$ref": "#/responses/forbidden"
  4175. }
  4176. }
  4177. }
  4178. },
  4179. "/repos/{owner}/{repo}/issues/{index}": {
  4180. "get": {
  4181. "produces": [
  4182. "application/json"
  4183. ],
  4184. "tags": [
  4185. "issue"
  4186. ],
  4187. "summary": "Get an issue",
  4188. "operationId": "issueGetIssue",
  4189. "parameters": [
  4190. {
  4191. "type": "string",
  4192. "description": "owner of the repo",
  4193. "name": "owner",
  4194. "in": "path",
  4195. "required": true
  4196. },
  4197. {
  4198. "type": "string",
  4199. "description": "name of the repo",
  4200. "name": "repo",
  4201. "in": "path",
  4202. "required": true
  4203. },
  4204. {
  4205. "type": "integer",
  4206. "format": "int64",
  4207. "description": "index of the issue to get",
  4208. "name": "index",
  4209. "in": "path",
  4210. "required": true
  4211. }
  4212. ],
  4213. "responses": {
  4214. "200": {
  4215. "$ref": "#/responses/Issue"
  4216. },
  4217. "404": {
  4218. "$ref": "#/responses/notFound"
  4219. }
  4220. }
  4221. },
  4222. "patch": {
  4223. "consumes": [
  4224. "application/json"
  4225. ],
  4226. "produces": [
  4227. "application/json"
  4228. ],
  4229. "tags": [
  4230. "issue"
  4231. ],
  4232. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4233. "operationId": "issueEditIssue",
  4234. "parameters": [
  4235. {
  4236. "type": "string",
  4237. "description": "owner of the repo",
  4238. "name": "owner",
  4239. "in": "path",
  4240. "required": true
  4241. },
  4242. {
  4243. "type": "string",
  4244. "description": "name of the repo",
  4245. "name": "repo",
  4246. "in": "path",
  4247. "required": true
  4248. },
  4249. {
  4250. "type": "integer",
  4251. "format": "int64",
  4252. "description": "index of the issue to edit",
  4253. "name": "index",
  4254. "in": "path",
  4255. "required": true
  4256. },
  4257. {
  4258. "name": "body",
  4259. "in": "body",
  4260. "schema": {
  4261. "$ref": "#/definitions/EditIssueOption"
  4262. }
  4263. }
  4264. ],
  4265. "responses": {
  4266. "201": {
  4267. "$ref": "#/responses/Issue"
  4268. },
  4269. "403": {
  4270. "$ref": "#/responses/forbidden"
  4271. },
  4272. "404": {
  4273. "$ref": "#/responses/notFound"
  4274. },
  4275. "412": {
  4276. "$ref": "#/responses/error"
  4277. }
  4278. }
  4279. }
  4280. },
  4281. "/repos/{owner}/{repo}/issues/{index}/comments": {
  4282. "get": {
  4283. "produces": [
  4284. "application/json"
  4285. ],
  4286. "tags": [
  4287. "issue"
  4288. ],
  4289. "summary": "List all comments on an issue",
  4290. "operationId": "issueGetComments",
  4291. "parameters": [
  4292. {
  4293. "type": "string",
  4294. "description": "owner of the repo",
  4295. "name": "owner",
  4296. "in": "path",
  4297. "required": true
  4298. },
  4299. {
  4300. "type": "string",
  4301. "description": "name of the repo",
  4302. "name": "repo",
  4303. "in": "path",
  4304. "required": true
  4305. },
  4306. {
  4307. "type": "integer",
  4308. "format": "int64",
  4309. "description": "index of the issue",
  4310. "name": "index",
  4311. "in": "path",
  4312. "required": true
  4313. },
  4314. {
  4315. "type": "string",
  4316. "format": "date-time",
  4317. "description": "if provided, only comments updated since the specified time are returned.",
  4318. "name": "since",
  4319. "in": "query"
  4320. },
  4321. {
  4322. "type": "string",
  4323. "format": "date-time",
  4324. "description": "if provided, only comments updated before the provided time are returned.",
  4325. "name": "before",
  4326. "in": "query"
  4327. }
  4328. ],
  4329. "responses": {
  4330. "200": {
  4331. "$ref": "#/responses/CommentList"
  4332. }
  4333. }
  4334. },
  4335. "post": {
  4336. "consumes": [
  4337. "application/json"
  4338. ],
  4339. "produces": [
  4340. "application/json"
  4341. ],
  4342. "tags": [
  4343. "issue"
  4344. ],
  4345. "summary": "Add a comment to an issue",
  4346. "operationId": "issueCreateComment",
  4347. "parameters": [
  4348. {
  4349. "type": "string",
  4350. "description": "owner of the repo",
  4351. "name": "owner",
  4352. "in": "path",
  4353. "required": true
  4354. },
  4355. {
  4356. "type": "string",
  4357. "description": "name of the repo",
  4358. "name": "repo",
  4359. "in": "path",
  4360. "required": true
  4361. },
  4362. {
  4363. "type": "integer",
  4364. "format": "int64",
  4365. "description": "index of the issue",
  4366. "name": "index",
  4367. "in": "path",
  4368. "required": true
  4369. },
  4370. {
  4371. "name": "body",
  4372. "in": "body",
  4373. "schema": {
  4374. "$ref": "#/definitions/CreateIssueCommentOption"
  4375. }
  4376. }
  4377. ],
  4378. "responses": {
  4379. "201": {
  4380. "$ref": "#/responses/Comment"
  4381. },
  4382. "403": {
  4383. "$ref": "#/responses/forbidden"
  4384. }
  4385. }
  4386. }
  4387. },
  4388. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  4389. "delete": {
  4390. "tags": [
  4391. "issue"
  4392. ],
  4393. "summary": "Delete a comment",
  4394. "operationId": "issueDeleteCommentDeprecated",
  4395. "deprecated": true,
  4396. "parameters": [
  4397. {
  4398. "type": "string",
  4399. "description": "owner of the repo",
  4400. "name": "owner",
  4401. "in": "path",
  4402. "required": true
  4403. },
  4404. {
  4405. "type": "string",
  4406. "description": "name of the repo",
  4407. "name": "repo",
  4408. "in": "path",
  4409. "required": true
  4410. },
  4411. {
  4412. "type": "integer",
  4413. "description": "this parameter is ignored",
  4414. "name": "index",
  4415. "in": "path",
  4416. "required": true
  4417. },
  4418. {
  4419. "type": "integer",
  4420. "format": "int64",
  4421. "description": "id of comment to delete",
  4422. "name": "id",
  4423. "in": "path",
  4424. "required": true
  4425. }
  4426. ],
  4427. "responses": {
  4428. "204": {
  4429. "$ref": "#/responses/empty"
  4430. },
  4431. "403": {
  4432. "$ref": "#/responses/forbidden"
  4433. },
  4434. "404": {
  4435. "$ref": "#/responses/notFound"
  4436. }
  4437. }
  4438. },
  4439. "patch": {
  4440. "consumes": [
  4441. "application/json"
  4442. ],
  4443. "produces": [
  4444. "application/json"
  4445. ],
  4446. "tags": [
  4447. "issue"
  4448. ],
  4449. "summary": "Edit a comment",
  4450. "operationId": "issueEditCommentDeprecated",
  4451. "deprecated": true,
  4452. "parameters": [
  4453. {
  4454. "type": "string",
  4455. "description": "owner of the repo",
  4456. "name": "owner",
  4457. "in": "path",
  4458. "required": true
  4459. },
  4460. {
  4461. "type": "string",
  4462. "description": "name of the repo",
  4463. "name": "repo",
  4464. "in": "path",
  4465. "required": true
  4466. },
  4467. {
  4468. "type": "integer",
  4469. "description": "this parameter is ignored",
  4470. "name": "index",
  4471. "in": "path",
  4472. "required": true
  4473. },
  4474. {
  4475. "type": "integer",
  4476. "format": "int64",
  4477. "description": "id of the comment to edit",
  4478. "name": "id",
  4479. "in": "path",
  4480. "required": true
  4481. },
  4482. {
  4483. "name": "body",
  4484. "in": "body",
  4485. "schema": {
  4486. "$ref": "#/definitions/EditIssueCommentOption"
  4487. }
  4488. }
  4489. ],
  4490. "responses": {
  4491. "200": {
  4492. "$ref": "#/responses/Comment"
  4493. },
  4494. "204": {
  4495. "$ref": "#/responses/empty"
  4496. },
  4497. "403": {
  4498. "$ref": "#/responses/forbidden"
  4499. },
  4500. "404": {
  4501. "$ref": "#/responses/notFound"
  4502. }
  4503. }
  4504. }
  4505. },
  4506. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4507. "post": {
  4508. "consumes": [
  4509. "application/json"
  4510. ],
  4511. "produces": [
  4512. "application/json"
  4513. ],
  4514. "tags": [
  4515. "issue"
  4516. ],
  4517. "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.",
  4518. "operationId": "issueEditIssueDeadline",
  4519. "parameters": [
  4520. {
  4521. "type": "string",
  4522. "description": "owner of the repo",
  4523. "name": "owner",
  4524. "in": "path",
  4525. "required": true
  4526. },
  4527. {
  4528. "type": "string",
  4529. "description": "name of the repo",
  4530. "name": "repo",
  4531. "in": "path",
  4532. "required": true
  4533. },
  4534. {
  4535. "type": "integer",
  4536. "format": "int64",
  4537. "description": "index of the issue to create or update a deadline on",
  4538. "name": "index",
  4539. "in": "path",
  4540. "required": true
  4541. },
  4542. {
  4543. "name": "body",
  4544. "in": "body",
  4545. "schema": {
  4546. "$ref": "#/definitions/EditDeadlineOption"
  4547. }
  4548. }
  4549. ],
  4550. "responses": {
  4551. "201": {
  4552. "$ref": "#/responses/IssueDeadline"
  4553. },
  4554. "403": {
  4555. "$ref": "#/responses/forbidden"
  4556. },
  4557. "404": {
  4558. "$ref": "#/responses/notFound"
  4559. }
  4560. }
  4561. }
  4562. },
  4563. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4564. "get": {
  4565. "produces": [
  4566. "application/json"
  4567. ],
  4568. "tags": [
  4569. "issue"
  4570. ],
  4571. "summary": "Get an issue's labels",
  4572. "operationId": "issueGetLabels",
  4573. "parameters": [
  4574. {
  4575. "type": "string",
  4576. "description": "owner of the repo",
  4577. "name": "owner",
  4578. "in": "path",
  4579. "required": true
  4580. },
  4581. {
  4582. "type": "string",
  4583. "description": "name of the repo",
  4584. "name": "repo",
  4585. "in": "path",
  4586. "required": true
  4587. },
  4588. {
  4589. "type": "integer",
  4590. "format": "int64",
  4591. "description": "index of the issue",
  4592. "name": "index",
  4593. "in": "path",
  4594. "required": true
  4595. }
  4596. ],
  4597. "responses": {
  4598. "200": {
  4599. "$ref": "#/responses/LabelList"
  4600. },
  4601. "404": {
  4602. "$ref": "#/responses/notFound"
  4603. }
  4604. }
  4605. },
  4606. "put": {
  4607. "consumes": [
  4608. "application/json"
  4609. ],
  4610. "produces": [
  4611. "application/json"
  4612. ],
  4613. "tags": [
  4614. "issue"
  4615. ],
  4616. "summary": "Replace an issue's labels",
  4617. "operationId": "issueReplaceLabels",
  4618. "parameters": [
  4619. {
  4620. "type": "string",
  4621. "description": "owner of the repo",
  4622. "name": "owner",
  4623. "in": "path",
  4624. "required": true
  4625. },
  4626. {
  4627. "type": "string",
  4628. "description": "name of the repo",
  4629. "name": "repo",
  4630. "in": "path",
  4631. "required": true
  4632. },
  4633. {
  4634. "type": "integer",
  4635. "format": "int64",
  4636. "description": "index of the issue",
  4637. "name": "index",
  4638. "in": "path",
  4639. "required": true
  4640. },
  4641. {
  4642. "name": "body",
  4643. "in": "body",
  4644. "schema": {
  4645. "$ref": "#/definitions/IssueLabelsOption"
  4646. }
  4647. }
  4648. ],
  4649. "responses": {
  4650. "200": {
  4651. "$ref": "#/responses/LabelList"
  4652. },
  4653. "403": {
  4654. "$ref": "#/responses/forbidden"
  4655. }
  4656. }
  4657. },
  4658. "post": {
  4659. "consumes": [
  4660. "application/json"
  4661. ],
  4662. "produces": [
  4663. "application/json"
  4664. ],
  4665. "tags": [
  4666. "issue"
  4667. ],
  4668. "summary": "Add a label to an issue",
  4669. "operationId": "issueAddLabel",
  4670. "parameters": [
  4671. {
  4672. "type": "string",
  4673. "description": "owner of the repo",
  4674. "name": "owner",
  4675. "in": "path",
  4676. "required": true
  4677. },
  4678. {
  4679. "type": "string",
  4680. "description": "name of the repo",
  4681. "name": "repo",
  4682. "in": "path",
  4683. "required": true
  4684. },
  4685. {
  4686. "type": "integer",
  4687. "format": "int64",
  4688. "description": "index of the issue",
  4689. "name": "index",
  4690. "in": "path",
  4691. "required": true
  4692. },
  4693. {
  4694. "name": "body",
  4695. "in": "body",
  4696. "schema": {
  4697. "$ref": "#/definitions/IssueLabelsOption"
  4698. }
  4699. }
  4700. ],
  4701. "responses": {
  4702. "200": {
  4703. "$ref": "#/responses/LabelList"
  4704. },
  4705. "403": {
  4706. "$ref": "#/responses/forbidden"
  4707. }
  4708. }
  4709. },
  4710. "delete": {
  4711. "produces": [
  4712. "application/json"
  4713. ],
  4714. "tags": [
  4715. "issue"
  4716. ],
  4717. "summary": "Remove all labels from an issue",
  4718. "operationId": "issueClearLabels",
  4719. "parameters": [
  4720. {
  4721. "type": "string",
  4722. "description": "owner of the repo",
  4723. "name": "owner",
  4724. "in": "path",
  4725. "required": true
  4726. },
  4727. {
  4728. "type": "string",
  4729. "description": "name of the repo",
  4730. "name": "repo",
  4731. "in": "path",
  4732. "required": true
  4733. },
  4734. {
  4735. "type": "integer",
  4736. "format": "int64",
  4737. "description": "index of the issue",
  4738. "name": "index",
  4739. "in": "path",
  4740. "required": true
  4741. }
  4742. ],
  4743. "responses": {
  4744. "204": {
  4745. "$ref": "#/responses/empty"
  4746. },
  4747. "403": {
  4748. "$ref": "#/responses/forbidden"
  4749. }
  4750. }
  4751. }
  4752. },
  4753. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4754. "delete": {
  4755. "produces": [
  4756. "application/json"
  4757. ],
  4758. "tags": [
  4759. "issue"
  4760. ],
  4761. "summary": "Remove a label from an issue",
  4762. "operationId": "issueRemoveLabel",
  4763. "parameters": [
  4764. {
  4765. "type": "string",
  4766. "description": "owner of the repo",
  4767. "name": "owner",
  4768. "in": "path",
  4769. "required": true
  4770. },
  4771. {
  4772. "type": "string",
  4773. "description": "name of the repo",
  4774. "name": "repo",
  4775. "in": "path",
  4776. "required": true
  4777. },
  4778. {
  4779. "type": "integer",
  4780. "format": "int64",
  4781. "description": "index of the issue",
  4782. "name": "index",
  4783. "in": "path",
  4784. "required": true
  4785. },
  4786. {
  4787. "type": "integer",
  4788. "format": "int64",
  4789. "description": "id of the label to remove",
  4790. "name": "id",
  4791. "in": "path",
  4792. "required": true
  4793. }
  4794. ],
  4795. "responses": {
  4796. "204": {
  4797. "$ref": "#/responses/empty"
  4798. },
  4799. "403": {
  4800. "$ref": "#/responses/forbidden"
  4801. },
  4802. "422": {
  4803. "$ref": "#/responses/validationError"
  4804. }
  4805. }
  4806. }
  4807. },
  4808. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4809. "get": {
  4810. "consumes": [
  4811. "application/json"
  4812. ],
  4813. "produces": [
  4814. "application/json"
  4815. ],
  4816. "tags": [
  4817. "issue"
  4818. ],
  4819. "summary": "Get a list reactions of an issue",
  4820. "operationId": "issueGetIssueReactions",
  4821. "parameters": [
  4822. {
  4823. "type": "string",
  4824. "description": "owner of the repo",
  4825. "name": "owner",
  4826. "in": "path",
  4827. "required": true
  4828. },
  4829. {
  4830. "type": "string",
  4831. "description": "name of the repo",
  4832. "name": "repo",
  4833. "in": "path",
  4834. "required": true
  4835. },
  4836. {
  4837. "type": "integer",
  4838. "format": "int64",
  4839. "description": "index of the issue",
  4840. "name": "index",
  4841. "in": "path",
  4842. "required": true
  4843. },
  4844. {
  4845. "type": "integer",
  4846. "description": "page number of results to return (1-based)",
  4847. "name": "page",
  4848. "in": "query"
  4849. },
  4850. {
  4851. "type": "integer",
  4852. "description": "page size of results, maximum page size is 50",
  4853. "name": "limit",
  4854. "in": "query"
  4855. }
  4856. ],
  4857. "responses": {
  4858. "200": {
  4859. "$ref": "#/responses/ReactionList"
  4860. },
  4861. "403": {
  4862. "$ref": "#/responses/forbidden"
  4863. }
  4864. }
  4865. },
  4866. "post": {
  4867. "consumes": [
  4868. "application/json"
  4869. ],
  4870. "produces": [
  4871. "application/json"
  4872. ],
  4873. "tags": [
  4874. "issue"
  4875. ],
  4876. "summary": "Add a reaction to an issue",
  4877. "operationId": "issuePostIssueReaction",
  4878. "parameters": [
  4879. {
  4880. "type": "string",
  4881. "description": "owner of the repo",
  4882. "name": "owner",
  4883. "in": "path",
  4884. "required": true
  4885. },
  4886. {
  4887. "type": "string",
  4888. "description": "name of the repo",
  4889. "name": "repo",
  4890. "in": "path",
  4891. "required": true
  4892. },
  4893. {
  4894. "type": "integer",
  4895. "format": "int64",
  4896. "description": "index of the issue",
  4897. "name": "index",
  4898. "in": "path",
  4899. "required": true
  4900. },
  4901. {
  4902. "name": "content",
  4903. "in": "body",
  4904. "schema": {
  4905. "$ref": "#/definitions/EditReactionOption"
  4906. }
  4907. }
  4908. ],
  4909. "responses": {
  4910. "200": {
  4911. "$ref": "#/responses/Reaction"
  4912. },
  4913. "201": {
  4914. "$ref": "#/responses/Reaction"
  4915. },
  4916. "403": {
  4917. "$ref": "#/responses/forbidden"
  4918. }
  4919. }
  4920. },
  4921. "delete": {
  4922. "consumes": [
  4923. "application/json"
  4924. ],
  4925. "produces": [
  4926. "application/json"
  4927. ],
  4928. "tags": [
  4929. "issue"
  4930. ],
  4931. "summary": "Remove a reaction from an issue",
  4932. "operationId": "issueDeleteIssueReaction",
  4933. "parameters": [
  4934. {
  4935. "type": "string",
  4936. "description": "owner of the repo",
  4937. "name": "owner",
  4938. "in": "path",
  4939. "required": true
  4940. },
  4941. {
  4942. "type": "string",
  4943. "description": "name of the repo",
  4944. "name": "repo",
  4945. "in": "path",
  4946. "required": true
  4947. },
  4948. {
  4949. "type": "integer",
  4950. "format": "int64",
  4951. "description": "index of the issue",
  4952. "name": "index",
  4953. "in": "path",
  4954. "required": true
  4955. },
  4956. {
  4957. "name": "content",
  4958. "in": "body",
  4959. "schema": {
  4960. "$ref": "#/definitions/EditReactionOption"
  4961. }
  4962. }
  4963. ],
  4964. "responses": {
  4965. "200": {
  4966. "$ref": "#/responses/empty"
  4967. },
  4968. "403": {
  4969. "$ref": "#/responses/forbidden"
  4970. }
  4971. }
  4972. }
  4973. },
  4974. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  4975. "delete": {
  4976. "consumes": [
  4977. "application/json"
  4978. ],
  4979. "produces": [
  4980. "application/json"
  4981. ],
  4982. "tags": [
  4983. "issue"
  4984. ],
  4985. "summary": "Delete an issue's existing stopwatch.",
  4986. "operationId": "issueDeleteStopWatch",
  4987. "parameters": [
  4988. {
  4989. "type": "string",
  4990. "description": "owner of the repo",
  4991. "name": "owner",
  4992. "in": "path",
  4993. "required": true
  4994. },
  4995. {
  4996. "type": "string",
  4997. "description": "name of the repo",
  4998. "name": "repo",
  4999. "in": "path",
  5000. "required": true
  5001. },
  5002. {
  5003. "type": "integer",
  5004. "format": "int64",
  5005. "description": "index of the issue to stop the stopwatch on",
  5006. "name": "index",
  5007. "in": "path",
  5008. "required": true
  5009. }
  5010. ],
  5011. "responses": {
  5012. "204": {
  5013. "$ref": "#/responses/empty"
  5014. },
  5015. "403": {
  5016. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5017. },
  5018. "404": {
  5019. "$ref": "#/responses/notFound"
  5020. },
  5021. "409": {
  5022. "description": "Cannot cancel a non existent stopwatch"
  5023. }
  5024. }
  5025. }
  5026. },
  5027. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  5028. "post": {
  5029. "consumes": [
  5030. "application/json"
  5031. ],
  5032. "produces": [
  5033. "application/json"
  5034. ],
  5035. "tags": [
  5036. "issue"
  5037. ],
  5038. "summary": "Start stopwatch on an issue.",
  5039. "operationId": "issueStartStopWatch",
  5040. "parameters": [
  5041. {
  5042. "type": "string",
  5043. "description": "owner of the repo",
  5044. "name": "owner",
  5045. "in": "path",
  5046. "required": true
  5047. },
  5048. {
  5049. "type": "string",
  5050. "description": "name of the repo",
  5051. "name": "repo",
  5052. "in": "path",
  5053. "required": true
  5054. },
  5055. {
  5056. "type": "integer",
  5057. "format": "int64",
  5058. "description": "index of the issue to create the stopwatch on",
  5059. "name": "index",
  5060. "in": "path",
  5061. "required": true
  5062. }
  5063. ],
  5064. "responses": {
  5065. "201": {
  5066. "$ref": "#/responses/empty"
  5067. },
  5068. "403": {
  5069. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5070. },
  5071. "404": {
  5072. "$ref": "#/responses/notFound"
  5073. },
  5074. "409": {
  5075. "description": "Cannot start a stopwatch again if it already exists"
  5076. }
  5077. }
  5078. }
  5079. },
  5080. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  5081. "post": {
  5082. "consumes": [
  5083. "application/json"
  5084. ],
  5085. "produces": [
  5086. "application/json"
  5087. ],
  5088. "tags": [
  5089. "issue"
  5090. ],
  5091. "summary": "Stop an issue's existing stopwatch.",
  5092. "operationId": "issueStopStopWatch",
  5093. "parameters": [
  5094. {
  5095. "type": "string",
  5096. "description": "owner of the repo",
  5097. "name": "owner",
  5098. "in": "path",
  5099. "required": true
  5100. },
  5101. {
  5102. "type": "string",
  5103. "description": "name of the repo",
  5104. "name": "repo",
  5105. "in": "path",
  5106. "required": true
  5107. },
  5108. {
  5109. "type": "integer",
  5110. "format": "int64",
  5111. "description": "index of the issue to stop the stopwatch on",
  5112. "name": "index",
  5113. "in": "path",
  5114. "required": true
  5115. }
  5116. ],
  5117. "responses": {
  5118. "201": {
  5119. "$ref": "#/responses/empty"
  5120. },
  5121. "403": {
  5122. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5123. },
  5124. "404": {
  5125. "$ref": "#/responses/notFound"
  5126. },
  5127. "409": {
  5128. "description": "Cannot stop a non existent stopwatch"
  5129. }
  5130. }
  5131. }
  5132. },
  5133. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  5134. "get": {
  5135. "consumes": [
  5136. "application/json"
  5137. ],
  5138. "produces": [
  5139. "application/json"
  5140. ],
  5141. "tags": [
  5142. "issue"
  5143. ],
  5144. "summary": "Get users who subscribed on an issue.",
  5145. "operationId": "issueSubscriptions",
  5146. "parameters": [
  5147. {
  5148. "type": "string",
  5149. "description": "owner of the repo",
  5150. "name": "owner",
  5151. "in": "path",
  5152. "required": true
  5153. },
  5154. {
  5155. "type": "string",
  5156. "description": "name of the repo",
  5157. "name": "repo",
  5158. "in": "path",
  5159. "required": true
  5160. },
  5161. {
  5162. "type": "integer",
  5163. "format": "int64",
  5164. "description": "index of the issue",
  5165. "name": "index",
  5166. "in": "path",
  5167. "required": true
  5168. },
  5169. {
  5170. "type": "integer",
  5171. "description": "page number of results to return (1-based)",
  5172. "name": "page",
  5173. "in": "query"
  5174. },
  5175. {
  5176. "type": "integer",
  5177. "description": "page size of results, maximum page size is 50",
  5178. "name": "limit",
  5179. "in": "query"
  5180. }
  5181. ],
  5182. "responses": {
  5183. "200": {
  5184. "$ref": "#/responses/UserList"
  5185. },
  5186. "404": {
  5187. "$ref": "#/responses/notFound"
  5188. }
  5189. }
  5190. }
  5191. },
  5192. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  5193. "get": {
  5194. "consumes": [
  5195. "application/json"
  5196. ],
  5197. "produces": [
  5198. "application/json"
  5199. ],
  5200. "tags": [
  5201. "issue"
  5202. ],
  5203. "summary": "Check if user is subscribed to an issue",
  5204. "operationId": "issueCheckSubscription",
  5205. "parameters": [
  5206. {
  5207. "type": "string",
  5208. "description": "owner of the repo",
  5209. "name": "owner",
  5210. "in": "path",
  5211. "required": true
  5212. },
  5213. {
  5214. "type": "string",
  5215. "description": "name of the repo",
  5216. "name": "repo",
  5217. "in": "path",
  5218. "required": true
  5219. },
  5220. {
  5221. "type": "integer",
  5222. "format": "int64",
  5223. "description": "index of the issue",
  5224. "name": "index",
  5225. "in": "path",
  5226. "required": true
  5227. }
  5228. ],
  5229. "responses": {
  5230. "200": {
  5231. "$ref": "#/responses/WatchInfo"
  5232. },
  5233. "404": {
  5234. "$ref": "#/responses/notFound"
  5235. }
  5236. }
  5237. }
  5238. },
  5239. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  5240. "put": {
  5241. "consumes": [
  5242. "application/json"
  5243. ],
  5244. "produces": [
  5245. "application/json"
  5246. ],
  5247. "tags": [
  5248. "issue"
  5249. ],
  5250. "summary": "Subscribe user to issue",
  5251. "operationId": "issueAddSubscription",
  5252. "parameters": [
  5253. {
  5254. "type": "string",
  5255. "description": "owner of the repo",
  5256. "name": "owner",
  5257. "in": "path",
  5258. "required": true
  5259. },
  5260. {
  5261. "type": "string",
  5262. "description": "name of the repo",
  5263. "name": "repo",
  5264. "in": "path",
  5265. "required": true
  5266. },
  5267. {
  5268. "type": "integer",
  5269. "format": "int64",
  5270. "description": "index of the issue",
  5271. "name": "index",
  5272. "in": "path",
  5273. "required": true
  5274. },
  5275. {
  5276. "type": "string",
  5277. "description": "user to subscribe",
  5278. "name": "user",
  5279. "in": "path",
  5280. "required": true
  5281. }
  5282. ],
  5283. "responses": {
  5284. "200": {
  5285. "description": "Already subscribed"
  5286. },
  5287. "201": {
  5288. "description": "Successfully Subscribed"
  5289. },
  5290. "304": {
  5291. "description": "User can only subscribe itself if he is no admin"
  5292. },
  5293. "404": {
  5294. "$ref": "#/responses/notFound"
  5295. }
  5296. }
  5297. },
  5298. "delete": {
  5299. "consumes": [
  5300. "application/json"
  5301. ],
  5302. "produces": [
  5303. "application/json"
  5304. ],
  5305. "tags": [
  5306. "issue"
  5307. ],
  5308. "summary": "Unsubscribe user from issue",
  5309. "operationId": "issueDeleteSubscription",
  5310. "parameters": [
  5311. {
  5312. "type": "string",
  5313. "description": "owner of the repo",
  5314. "name": "owner",
  5315. "in": "path",
  5316. "required": true
  5317. },
  5318. {
  5319. "type": "string",
  5320. "description": "name of the repo",
  5321. "name": "repo",
  5322. "in": "path",
  5323. "required": true
  5324. },
  5325. {
  5326. "type": "integer",
  5327. "format": "int64",
  5328. "description": "index of the issue",
  5329. "name": "index",
  5330. "in": "path",
  5331. "required": true
  5332. },
  5333. {
  5334. "type": "string",
  5335. "description": "user witch unsubscribe",
  5336. "name": "user",
  5337. "in": "path",
  5338. "required": true
  5339. }
  5340. ],
  5341. "responses": {
  5342. "200": {
  5343. "description": "Already unsubscribed"
  5344. },
  5345. "201": {
  5346. "description": "Successfully Unsubscribed"
  5347. },
  5348. "304": {
  5349. "description": "User can only subscribe itself if he is no admin"
  5350. },
  5351. "404": {
  5352. "$ref": "#/responses/notFound"
  5353. }
  5354. }
  5355. }
  5356. },
  5357. "/repos/{owner}/{repo}/issues/{index}/times": {
  5358. "get": {
  5359. "produces": [
  5360. "application/json"
  5361. ],
  5362. "tags": [
  5363. "issue"
  5364. ],
  5365. "summary": "List an issue's tracked times",
  5366. "operationId": "issueTrackedTimes",
  5367. "parameters": [
  5368. {
  5369. "type": "string",
  5370. "description": "owner of the repo",
  5371. "name": "owner",
  5372. "in": "path",
  5373. "required": true
  5374. },
  5375. {
  5376. "type": "string",
  5377. "description": "name of the repo",
  5378. "name": "repo",
  5379. "in": "path",
  5380. "required": true
  5381. },
  5382. {
  5383. "type": "integer",
  5384. "format": "int64",
  5385. "description": "index of the issue",
  5386. "name": "index",
  5387. "in": "path",
  5388. "required": true
  5389. },
  5390. {
  5391. "type": "string",
  5392. "format": "date-time",
  5393. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  5394. "name": "since",
  5395. "in": "query"
  5396. },
  5397. {
  5398. "type": "string",
  5399. "format": "date-time",
  5400. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  5401. "name": "before",
  5402. "in": "query"
  5403. },
  5404. {
  5405. "type": "integer",
  5406. "description": "page number of results to return (1-based)",
  5407. "name": "page",
  5408. "in": "query"
  5409. },
  5410. {
  5411. "type": "integer",
  5412. "description": "page size of results, maximum page size is 50",
  5413. "name": "limit",
  5414. "in": "query"
  5415. }
  5416. ],
  5417. "responses": {
  5418. "200": {
  5419. "$ref": "#/responses/TrackedTimeList"
  5420. },
  5421. "404": {
  5422. "$ref": "#/responses/notFound"
  5423. }
  5424. }
  5425. },
  5426. "post": {
  5427. "consumes": [
  5428. "application/json"
  5429. ],
  5430. "produces": [
  5431. "application/json"
  5432. ],
  5433. "tags": [
  5434. "issue"
  5435. ],
  5436. "summary": "Add tracked time to a issue",
  5437. "operationId": "issueAddTime",
  5438. "parameters": [
  5439. {
  5440. "type": "string",
  5441. "description": "owner of the repo",
  5442. "name": "owner",
  5443. "in": "path",
  5444. "required": true
  5445. },
  5446. {
  5447. "type": "string",
  5448. "description": "name of the repo",
  5449. "name": "repo",
  5450. "in": "path",
  5451. "required": true
  5452. },
  5453. {
  5454. "type": "integer",
  5455. "format": "int64",
  5456. "description": "index of the issue",
  5457. "name": "index",
  5458. "in": "path",
  5459. "required": true
  5460. },
  5461. {
  5462. "name": "body",
  5463. "in": "body",
  5464. "schema": {
  5465. "$ref": "#/definitions/AddTimeOption"
  5466. }
  5467. }
  5468. ],
  5469. "responses": {
  5470. "200": {
  5471. "$ref": "#/responses/TrackedTime"
  5472. },
  5473. "400": {
  5474. "$ref": "#/responses/error"
  5475. },
  5476. "403": {
  5477. "$ref": "#/responses/forbidden"
  5478. }
  5479. }
  5480. },
  5481. "delete": {
  5482. "consumes": [
  5483. "application/json"
  5484. ],
  5485. "produces": [
  5486. "application/json"
  5487. ],
  5488. "tags": [
  5489. "issue"
  5490. ],
  5491. "summary": "Reset a tracked time of an issue",
  5492. "operationId": "issueResetTime",
  5493. "parameters": [
  5494. {
  5495. "type": "string",
  5496. "description": "owner of the repo",
  5497. "name": "owner",
  5498. "in": "path",
  5499. "required": true
  5500. },
  5501. {
  5502. "type": "string",
  5503. "description": "name of the repo",
  5504. "name": "repo",
  5505. "in": "path",
  5506. "required": true
  5507. },
  5508. {
  5509. "type": "integer",
  5510. "format": "int64",
  5511. "description": "index of the issue to add tracked time to",
  5512. "name": "index",
  5513. "in": "path",
  5514. "required": true
  5515. }
  5516. ],
  5517. "responses": {
  5518. "204": {
  5519. "$ref": "#/responses/empty"
  5520. },
  5521. "400": {
  5522. "$ref": "#/responses/error"
  5523. },
  5524. "403": {
  5525. "$ref": "#/responses/forbidden"
  5526. }
  5527. }
  5528. }
  5529. },
  5530. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5531. "delete": {
  5532. "consumes": [
  5533. "application/json"
  5534. ],
  5535. "produces": [
  5536. "application/json"
  5537. ],
  5538. "tags": [
  5539. "issue"
  5540. ],
  5541. "summary": "Delete specific tracked time",
  5542. "operationId": "issueDeleteTime",
  5543. "parameters": [
  5544. {
  5545. "type": "string",
  5546. "description": "owner of the repo",
  5547. "name": "owner",
  5548. "in": "path",
  5549. "required": true
  5550. },
  5551. {
  5552. "type": "string",
  5553. "description": "name of the repo",
  5554. "name": "repo",
  5555. "in": "path",
  5556. "required": true
  5557. },
  5558. {
  5559. "type": "integer",
  5560. "format": "int64",
  5561. "description": "index of the issue",
  5562. "name": "index",
  5563. "in": "path",
  5564. "required": true
  5565. },
  5566. {
  5567. "type": "integer",
  5568. "format": "int64",
  5569. "description": "id of time to delete",
  5570. "name": "id",
  5571. "in": "path",
  5572. "required": true
  5573. }
  5574. ],
  5575. "responses": {
  5576. "204": {
  5577. "$ref": "#/responses/empty"
  5578. },
  5579. "400": {
  5580. "$ref": "#/responses/error"
  5581. },
  5582. "403": {
  5583. "$ref": "#/responses/forbidden"
  5584. }
  5585. }
  5586. }
  5587. },
  5588. "/repos/{owner}/{repo}/keys": {
  5589. "get": {
  5590. "produces": [
  5591. "application/json"
  5592. ],
  5593. "tags": [
  5594. "repository"
  5595. ],
  5596. "summary": "List a repository's keys",
  5597. "operationId": "repoListKeys",
  5598. "parameters": [
  5599. {
  5600. "type": "string",
  5601. "description": "owner of the repo",
  5602. "name": "owner",
  5603. "in": "path",
  5604. "required": true
  5605. },
  5606. {
  5607. "type": "string",
  5608. "description": "name of the repo",
  5609. "name": "repo",
  5610. "in": "path",
  5611. "required": true
  5612. },
  5613. {
  5614. "type": "integer",
  5615. "description": "the key_id to search for",
  5616. "name": "key_id",
  5617. "in": "query"
  5618. },
  5619. {
  5620. "type": "string",
  5621. "description": "fingerprint of the key",
  5622. "name": "fingerprint",
  5623. "in": "query"
  5624. },
  5625. {
  5626. "type": "integer",
  5627. "description": "page number of results to return (1-based)",
  5628. "name": "page",
  5629. "in": "query"
  5630. },
  5631. {
  5632. "type": "integer",
  5633. "description": "page size of results, maximum page size is 50",
  5634. "name": "limit",
  5635. "in": "query"
  5636. }
  5637. ],
  5638. "responses": {
  5639. "200": {
  5640. "$ref": "#/responses/DeployKeyList"
  5641. }
  5642. }
  5643. },
  5644. "post": {
  5645. "consumes": [
  5646. "application/json"
  5647. ],
  5648. "produces": [
  5649. "application/json"
  5650. ],
  5651. "tags": [
  5652. "repository"
  5653. ],
  5654. "summary": "Add a key to a repository",
  5655. "operationId": "repoCreateKey",
  5656. "parameters": [
  5657. {
  5658. "type": "string",
  5659. "description": "owner of the repo",
  5660. "name": "owner",
  5661. "in": "path",
  5662. "required": true
  5663. },
  5664. {
  5665. "type": "string",
  5666. "description": "name of the repo",
  5667. "name": "repo",
  5668. "in": "path",
  5669. "required": true
  5670. },
  5671. {
  5672. "name": "body",
  5673. "in": "body",
  5674. "schema": {
  5675. "$ref": "#/definitions/CreateKeyOption"
  5676. }
  5677. }
  5678. ],
  5679. "responses": {
  5680. "201": {
  5681. "$ref": "#/responses/DeployKey"
  5682. },
  5683. "422": {
  5684. "$ref": "#/responses/validationError"
  5685. }
  5686. }
  5687. }
  5688. },
  5689. "/repos/{owner}/{repo}/keys/{id}": {
  5690. "get": {
  5691. "produces": [
  5692. "application/json"
  5693. ],
  5694. "tags": [
  5695. "repository"
  5696. ],
  5697. "summary": "Get a repository's key by id",
  5698. "operationId": "repoGetKey",
  5699. "parameters": [
  5700. {
  5701. "type": "string",
  5702. "description": "owner of the repo",
  5703. "name": "owner",
  5704. "in": "path",
  5705. "required": true
  5706. },
  5707. {
  5708. "type": "string",
  5709. "description": "name of the repo",
  5710. "name": "repo",
  5711. "in": "path",
  5712. "required": true
  5713. },
  5714. {
  5715. "type": "integer",
  5716. "format": "int64",
  5717. "description": "id of the key to get",
  5718. "name": "id",
  5719. "in": "path",
  5720. "required": true
  5721. }
  5722. ],
  5723. "responses": {
  5724. "200": {
  5725. "$ref": "#/responses/DeployKey"
  5726. }
  5727. }
  5728. },
  5729. "delete": {
  5730. "tags": [
  5731. "repository"
  5732. ],
  5733. "summary": "Delete a key from a repository",
  5734. "operationId": "repoDeleteKey",
  5735. "parameters": [
  5736. {
  5737. "type": "string",
  5738. "description": "owner of the repo",
  5739. "name": "owner",
  5740. "in": "path",
  5741. "required": true
  5742. },
  5743. {
  5744. "type": "string",
  5745. "description": "name of the repo",
  5746. "name": "repo",
  5747. "in": "path",
  5748. "required": true
  5749. },
  5750. {
  5751. "type": "integer",
  5752. "format": "int64",
  5753. "description": "id of the key to delete",
  5754. "name": "id",
  5755. "in": "path",
  5756. "required": true
  5757. }
  5758. ],
  5759. "responses": {
  5760. "204": {
  5761. "$ref": "#/responses/empty"
  5762. },
  5763. "403": {
  5764. "$ref": "#/responses/forbidden"
  5765. }
  5766. }
  5767. }
  5768. },
  5769. "/repos/{owner}/{repo}/labels": {
  5770. "get": {
  5771. "produces": [
  5772. "application/json"
  5773. ],
  5774. "tags": [
  5775. "issue"
  5776. ],
  5777. "summary": "Get all of a repository's labels",
  5778. "operationId": "issueListLabels",
  5779. "parameters": [
  5780. {
  5781. "type": "string",
  5782. "description": "owner of the repo",
  5783. "name": "owner",
  5784. "in": "path",
  5785. "required": true
  5786. },
  5787. {
  5788. "type": "string",
  5789. "description": "name of the repo",
  5790. "name": "repo",
  5791. "in": "path",
  5792. "required": true
  5793. },
  5794. {
  5795. "type": "integer",
  5796. "description": "page number of results to return (1-based)",
  5797. "name": "page",
  5798. "in": "query"
  5799. },
  5800. {
  5801. "type": "integer",
  5802. "description": "page size of results, maximum page size is 50",
  5803. "name": "limit",
  5804. "in": "query"
  5805. }
  5806. ],
  5807. "responses": {
  5808. "200": {
  5809. "$ref": "#/responses/LabelList"
  5810. }
  5811. }
  5812. },
  5813. "post": {
  5814. "consumes": [
  5815. "application/json"
  5816. ],
  5817. "produces": [
  5818. "application/json"
  5819. ],
  5820. "tags": [
  5821. "issue"
  5822. ],
  5823. "summary": "Create a label",
  5824. "operationId": "issueCreateLabel",
  5825. "parameters": [
  5826. {
  5827. "type": "string",
  5828. "description": "owner of the repo",
  5829. "name": "owner",
  5830. "in": "path",
  5831. "required": true
  5832. },
  5833. {
  5834. "type": "string",
  5835. "description": "name of the repo",
  5836. "name": "repo",
  5837. "in": "path",
  5838. "required": true
  5839. },
  5840. {
  5841. "name": "body",
  5842. "in": "body",
  5843. "schema": {
  5844. "$ref": "#/definitions/CreateLabelOption"
  5845. }
  5846. }
  5847. ],
  5848. "responses": {
  5849. "201": {
  5850. "$ref": "#/responses/Label"
  5851. },
  5852. "422": {
  5853. "$ref": "#/responses/validationError"
  5854. }
  5855. }
  5856. }
  5857. },
  5858. "/repos/{owner}/{repo}/labels/{id}": {
  5859. "get": {
  5860. "produces": [
  5861. "application/json"
  5862. ],
  5863. "tags": [
  5864. "issue"
  5865. ],
  5866. "summary": "Get a single label",
  5867. "operationId": "issueGetLabel",
  5868. "parameters": [
  5869. {
  5870. "type": "string",
  5871. "description": "owner of the repo",
  5872. "name": "owner",
  5873. "in": "path",
  5874. "required": true
  5875. },
  5876. {
  5877. "type": "string",
  5878. "description": "name of the repo",
  5879. "name": "repo",
  5880. "in": "path",
  5881. "required": true
  5882. },
  5883. {
  5884. "type": "integer",
  5885. "format": "int64",
  5886. "description": "id of the label to get",
  5887. "name": "id",
  5888. "in": "path",
  5889. "required": true
  5890. }
  5891. ],
  5892. "responses": {
  5893. "200": {
  5894. "$ref": "#/responses/Label"
  5895. }
  5896. }
  5897. },
  5898. "delete": {
  5899. "tags": [
  5900. "issue"
  5901. ],
  5902. "summary": "Delete a label",
  5903. "operationId": "issueDeleteLabel",
  5904. "parameters": [
  5905. {
  5906. "type": "string",
  5907. "description": "owner of the repo",
  5908. "name": "owner",
  5909. "in": "path",
  5910. "required": true
  5911. },
  5912. {
  5913. "type": "string",
  5914. "description": "name of the repo",
  5915. "name": "repo",
  5916. "in": "path",
  5917. "required": true
  5918. },
  5919. {
  5920. "type": "integer",
  5921. "format": "int64",
  5922. "description": "id of the label to delete",
  5923. "name": "id",
  5924. "in": "path",
  5925. "required": true
  5926. }
  5927. ],
  5928. "responses": {
  5929. "204": {
  5930. "$ref": "#/responses/empty"
  5931. }
  5932. }
  5933. },
  5934. "patch": {
  5935. "consumes": [
  5936. "application/json"
  5937. ],
  5938. "produces": [
  5939. "application/json"
  5940. ],
  5941. "tags": [
  5942. "issue"
  5943. ],
  5944. "summary": "Update a label",
  5945. "operationId": "issueEditLabel",
  5946. "parameters": [
  5947. {
  5948. "type": "string",
  5949. "description": "owner of the repo",
  5950. "name": "owner",
  5951. "in": "path",
  5952. "required": true
  5953. },
  5954. {
  5955. "type": "string",
  5956. "description": "name of the repo",
  5957. "name": "repo",
  5958. "in": "path",
  5959. "required": true
  5960. },
  5961. {
  5962. "type": "integer",
  5963. "format": "int64",
  5964. "description": "id of the label to edit",
  5965. "name": "id",
  5966. "in": "path",
  5967. "required": true
  5968. },
  5969. {
  5970. "name": "body",
  5971. "in": "body",
  5972. "schema": {
  5973. "$ref": "#/definitions/EditLabelOption"
  5974. }
  5975. }
  5976. ],
  5977. "responses": {
  5978. "200": {
  5979. "$ref": "#/responses/Label"
  5980. },
  5981. "422": {
  5982. "$ref": "#/responses/validationError"
  5983. }
  5984. }
  5985. }
  5986. },
  5987. "/repos/{owner}/{repo}/milestones": {
  5988. "get": {
  5989. "produces": [
  5990. "application/json"
  5991. ],
  5992. "tags": [
  5993. "issue"
  5994. ],
  5995. "summary": "Get all of a repository's opened milestones",
  5996. "operationId": "issueGetMilestonesList",
  5997. "parameters": [
  5998. {
  5999. "type": "string",
  6000. "description": "owner of the repo",
  6001. "name": "owner",
  6002. "in": "path",
  6003. "required": true
  6004. },
  6005. {
  6006. "type": "string",
  6007. "description": "name of the repo",
  6008. "name": "repo",
  6009. "in": "path",
  6010. "required": true
  6011. },
  6012. {
  6013. "type": "string",
  6014. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  6015. "name": "state",
  6016. "in": "query"
  6017. },
  6018. {
  6019. "type": "integer",
  6020. "description": "page number of results to return (1-based)",
  6021. "name": "page",
  6022. "in": "query"
  6023. },
  6024. {
  6025. "type": "integer",
  6026. "description": "page size of results, maximum page size is 50",
  6027. "name": "limit",
  6028. "in": "query"
  6029. }
  6030. ],
  6031. "responses": {
  6032. "200": {
  6033. "$ref": "#/responses/MilestoneList"
  6034. }
  6035. }
  6036. },
  6037. "post": {
  6038. "consumes": [
  6039. "application/json"
  6040. ],
  6041. "produces": [
  6042. "application/json"
  6043. ],
  6044. "tags": [
  6045. "issue"
  6046. ],
  6047. "summary": "Create a milestone",
  6048. "operationId": "issueCreateMilestone",
  6049. "parameters": [
  6050. {
  6051. "type": "string",
  6052. "description": "owner of the repo",
  6053. "name": "owner",
  6054. "in": "path",
  6055. "required": true
  6056. },
  6057. {
  6058. "type": "string",
  6059. "description": "name of the repo",
  6060. "name": "repo",
  6061. "in": "path",
  6062. "required": true
  6063. },
  6064. {
  6065. "name": "body",
  6066. "in": "body",
  6067. "schema": {
  6068. "$ref": "#/definitions/CreateMilestoneOption"
  6069. }
  6070. }
  6071. ],
  6072. "responses": {
  6073. "201": {
  6074. "$ref": "#/responses/Milestone"
  6075. }
  6076. }
  6077. }
  6078. },
  6079. "/repos/{owner}/{repo}/milestones/{id}": {
  6080. "get": {
  6081. "produces": [
  6082. "application/json"
  6083. ],
  6084. "tags": [
  6085. "issue"
  6086. ],
  6087. "summary": "Get a milestone",
  6088. "operationId": "issueGetMilestone",
  6089. "parameters": [
  6090. {
  6091. "type": "string",
  6092. "description": "owner of the repo",
  6093. "name": "owner",
  6094. "in": "path",
  6095. "required": true
  6096. },
  6097. {
  6098. "type": "string",
  6099. "description": "name of the repo",
  6100. "name": "repo",
  6101. "in": "path",
  6102. "required": true
  6103. },
  6104. {
  6105. "type": "integer",
  6106. "format": "int64",
  6107. "description": "id of the milestone",
  6108. "name": "id",
  6109. "in": "path",
  6110. "required": true
  6111. }
  6112. ],
  6113. "responses": {
  6114. "200": {
  6115. "$ref": "#/responses/Milestone"
  6116. }
  6117. }
  6118. },
  6119. "delete": {
  6120. "tags": [
  6121. "issue"
  6122. ],
  6123. "summary": "Delete a milestone",
  6124. "operationId": "issueDeleteMilestone",
  6125. "parameters": [
  6126. {
  6127. "type": "string",
  6128. "description": "owner of the repo",
  6129. "name": "owner",
  6130. "in": "path",
  6131. "required": true
  6132. },
  6133. {
  6134. "type": "string",
  6135. "description": "name of the repo",
  6136. "name": "repo",
  6137. "in": "path",
  6138. "required": true
  6139. },
  6140. {
  6141. "type": "integer",
  6142. "format": "int64",
  6143. "description": "id of the milestone to delete",
  6144. "name": "id",
  6145. "in": "path",
  6146. "required": true
  6147. }
  6148. ],
  6149. "responses": {
  6150. "204": {
  6151. "$ref": "#/responses/empty"
  6152. }
  6153. }
  6154. },
  6155. "patch": {
  6156. "consumes": [
  6157. "application/json"
  6158. ],
  6159. "produces": [
  6160. "application/json"
  6161. ],
  6162. "tags": [
  6163. "issue"
  6164. ],
  6165. "summary": "Update a milestone",
  6166. "operationId": "issueEditMilestone",
  6167. "parameters": [
  6168. {
  6169. "type": "string",
  6170. "description": "owner of the repo",
  6171. "name": "owner",
  6172. "in": "path",
  6173. "required": true
  6174. },
  6175. {
  6176. "type": "string",
  6177. "description": "name of the repo",
  6178. "name": "repo",
  6179. "in": "path",
  6180. "required": true
  6181. },
  6182. {
  6183. "type": "integer",
  6184. "format": "int64",
  6185. "description": "id of the milestone",
  6186. "name": "id",
  6187. "in": "path",
  6188. "required": true
  6189. },
  6190. {
  6191. "name": "body",
  6192. "in": "body",
  6193. "schema": {
  6194. "$ref": "#/definitions/EditMilestoneOption"
  6195. }
  6196. }
  6197. ],
  6198. "responses": {
  6199. "200": {
  6200. "$ref": "#/responses/Milestone"
  6201. }
  6202. }
  6203. }
  6204. },
  6205. "/repos/{owner}/{repo}/mirror-sync": {
  6206. "post": {
  6207. "produces": [
  6208. "application/json"
  6209. ],
  6210. "tags": [
  6211. "repository"
  6212. ],
  6213. "summary": "Sync a mirrored repository",
  6214. "operationId": "repoMirrorSync",
  6215. "parameters": [
  6216. {
  6217. "type": "string",
  6218. "description": "owner of the repo to sync",
  6219. "name": "owner",
  6220. "in": "path",
  6221. "required": true
  6222. },
  6223. {
  6224. "type": "string",
  6225. "description": "name of the repo to sync",
  6226. "name": "repo",
  6227. "in": "path",
  6228. "required": true
  6229. }
  6230. ],
  6231. "responses": {
  6232. "200": {
  6233. "$ref": "#/responses/empty"
  6234. },
  6235. "403": {
  6236. "$ref": "#/responses/forbidden"
  6237. }
  6238. }
  6239. }
  6240. },
  6241. "/repos/{owner}/{repo}/notifications": {
  6242. "get": {
  6243. "consumes": [
  6244. "application/json"
  6245. ],
  6246. "produces": [
  6247. "application/json"
  6248. ],
  6249. "tags": [
  6250. "notification"
  6251. ],
  6252. "summary": "List users's notification threads on a specific repo",
  6253. "operationId": "notifyGetRepoList",
  6254. "parameters": [
  6255. {
  6256. "type": "string",
  6257. "description": "owner of the repo",
  6258. "name": "owner",
  6259. "in": "path",
  6260. "required": true
  6261. },
  6262. {
  6263. "type": "string",
  6264. "description": "name of the repo",
  6265. "name": "repo",
  6266. "in": "path",
  6267. "required": true
  6268. },
  6269. {
  6270. "type": "string",
  6271. "description": "If true, show notifications marked as read. Default value is false",
  6272. "name": "all",
  6273. "in": "query"
  6274. },
  6275. {
  6276. "type": "string",
  6277. "format": "date-time",
  6278. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  6279. "name": "since",
  6280. "in": "query"
  6281. },
  6282. {
  6283. "type": "string",
  6284. "format": "date-time",
  6285. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  6286. "name": "before",
  6287. "in": "query"
  6288. },
  6289. {
  6290. "type": "integer",
  6291. "description": "page number of results to return (1-based)",
  6292. "name": "page",
  6293. "in": "query"
  6294. },
  6295. {
  6296. "type": "integer",
  6297. "description": "page size of results, maximum page size is 50",
  6298. "name": "limit",
  6299. "in": "query"
  6300. }
  6301. ],
  6302. "responses": {
  6303. "200": {
  6304. "$ref": "#/responses/NotificationThreadList"
  6305. }
  6306. }
  6307. },
  6308. "put": {
  6309. "consumes": [
  6310. "application/json"
  6311. ],
  6312. "produces": [
  6313. "application/json"
  6314. ],
  6315. "tags": [
  6316. "notification"
  6317. ],
  6318. "summary": "Mark notification threads as read on a specific repo",
  6319. "operationId": "notifyReadRepoList",
  6320. "parameters": [
  6321. {
  6322. "type": "string",
  6323. "description": "owner of the repo",
  6324. "name": "owner",
  6325. "in": "path",
  6326. "required": true
  6327. },
  6328. {
  6329. "type": "string",
  6330. "description": "name of the repo",
  6331. "name": "repo",
  6332. "in": "path",
  6333. "required": true
  6334. },
  6335. {
  6336. "type": "string",
  6337. "format": "date-time",
  6338. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  6339. "name": "last_read_at",
  6340. "in": "query"
  6341. }
  6342. ],
  6343. "responses": {
  6344. "205": {
  6345. "$ref": "#/responses/empty"
  6346. }
  6347. }
  6348. }
  6349. },
  6350. "/repos/{owner}/{repo}/pulls": {
  6351. "get": {
  6352. "produces": [
  6353. "application/json"
  6354. ],
  6355. "tags": [
  6356. "repository"
  6357. ],
  6358. "summary": "List a repo's pull requests",
  6359. "operationId": "repoListPullRequests",
  6360. "parameters": [
  6361. {
  6362. "type": "string",
  6363. "description": "owner of the repo",
  6364. "name": "owner",
  6365. "in": "path",
  6366. "required": true
  6367. },
  6368. {
  6369. "type": "string",
  6370. "description": "name of the repo",
  6371. "name": "repo",
  6372. "in": "path",
  6373. "required": true
  6374. },
  6375. {
  6376. "enum": [
  6377. "closed",
  6378. "open",
  6379. "all"
  6380. ],
  6381. "type": "string",
  6382. "description": "State of pull request: open or closed (optional)",
  6383. "name": "state",
  6384. "in": "query"
  6385. },
  6386. {
  6387. "enum": [
  6388. "oldest",
  6389. "recentupdate",
  6390. "leastupdate",
  6391. "mostcomment",
  6392. "leastcomment",
  6393. "priority"
  6394. ],
  6395. "type": "string",
  6396. "description": "Type of sort",
  6397. "name": "sort",
  6398. "in": "query"
  6399. },
  6400. {
  6401. "type": "integer",
  6402. "format": "int64",
  6403. "description": "ID of the milestone",
  6404. "name": "milestone",
  6405. "in": "query"
  6406. },
  6407. {
  6408. "type": "array",
  6409. "items": {
  6410. "type": "integer",
  6411. "format": "int64"
  6412. },
  6413. "collectionFormat": "multi",
  6414. "description": "Label IDs",
  6415. "name": "labels",
  6416. "in": "query"
  6417. },
  6418. {
  6419. "type": "integer",
  6420. "description": "page number of results to return (1-based)",
  6421. "name": "page",
  6422. "in": "query"
  6423. },
  6424. {
  6425. "type": "integer",
  6426. "description": "page size of results, maximum page size is 50",
  6427. "name": "limit",
  6428. "in": "query"
  6429. }
  6430. ],
  6431. "responses": {
  6432. "200": {
  6433. "$ref": "#/responses/PullRequestList"
  6434. }
  6435. }
  6436. },
  6437. "post": {
  6438. "consumes": [
  6439. "application/json"
  6440. ],
  6441. "produces": [
  6442. "application/json"
  6443. ],
  6444. "tags": [
  6445. "repository"
  6446. ],
  6447. "summary": "Create a pull request",
  6448. "operationId": "repoCreatePullRequest",
  6449. "parameters": [
  6450. {
  6451. "type": "string",
  6452. "description": "owner of the repo",
  6453. "name": "owner",
  6454. "in": "path",
  6455. "required": true
  6456. },
  6457. {
  6458. "type": "string",
  6459. "description": "name of the repo",
  6460. "name": "repo",
  6461. "in": "path",
  6462. "required": true
  6463. },
  6464. {
  6465. "name": "body",
  6466. "in": "body",
  6467. "schema": {
  6468. "$ref": "#/definitions/CreatePullRequestOption"
  6469. }
  6470. }
  6471. ],
  6472. "responses": {
  6473. "201": {
  6474. "$ref": "#/responses/PullRequest"
  6475. },
  6476. "409": {
  6477. "$ref": "#/responses/error"
  6478. },
  6479. "422": {
  6480. "$ref": "#/responses/validationError"
  6481. }
  6482. }
  6483. }
  6484. },
  6485. "/repos/{owner}/{repo}/pulls/{index}": {
  6486. "get": {
  6487. "produces": [
  6488. "application/json"
  6489. ],
  6490. "tags": [
  6491. "repository"
  6492. ],
  6493. "summary": "Get a pull request",
  6494. "operationId": "repoGetPullRequest",
  6495. "parameters": [
  6496. {
  6497. "type": "string",
  6498. "description": "owner of the repo",
  6499. "name": "owner",
  6500. "in": "path",
  6501. "required": true
  6502. },
  6503. {
  6504. "type": "string",
  6505. "description": "name of the repo",
  6506. "name": "repo",
  6507. "in": "path",
  6508. "required": true
  6509. },
  6510. {
  6511. "type": "integer",
  6512. "format": "int64",
  6513. "description": "index of the pull request to get",
  6514. "name": "index",
  6515. "in": "path",
  6516. "required": true
  6517. }
  6518. ],
  6519. "responses": {
  6520. "200": {
  6521. "$ref": "#/responses/PullRequest"
  6522. },
  6523. "404": {
  6524. "$ref": "#/responses/notFound"
  6525. }
  6526. }
  6527. },
  6528. "patch": {
  6529. "consumes": [
  6530. "application/json"
  6531. ],
  6532. "produces": [
  6533. "application/json"
  6534. ],
  6535. "tags": [
  6536. "repository"
  6537. ],
  6538. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6539. "operationId": "repoEditPullRequest",
  6540. "parameters": [
  6541. {
  6542. "type": "string",
  6543. "description": "owner of the repo",
  6544. "name": "owner",
  6545. "in": "path",
  6546. "required": true
  6547. },
  6548. {
  6549. "type": "string",
  6550. "description": "name of the repo",
  6551. "name": "repo",
  6552. "in": "path",
  6553. "required": true
  6554. },
  6555. {
  6556. "type": "integer",
  6557. "format": "int64",
  6558. "description": "index of the pull request to edit",
  6559. "name": "index",
  6560. "in": "path",
  6561. "required": true
  6562. },
  6563. {
  6564. "name": "body",
  6565. "in": "body",
  6566. "schema": {
  6567. "$ref": "#/definitions/EditPullRequestOption"
  6568. }
  6569. }
  6570. ],
  6571. "responses": {
  6572. "201": {
  6573. "$ref": "#/responses/PullRequest"
  6574. },
  6575. "403": {
  6576. "$ref": "#/responses/forbidden"
  6577. },
  6578. "412": {
  6579. "$ref": "#/responses/error"
  6580. },
  6581. "422": {
  6582. "$ref": "#/responses/validationError"
  6583. }
  6584. }
  6585. }
  6586. },
  6587. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6588. "get": {
  6589. "produces": [
  6590. "application/json"
  6591. ],
  6592. "tags": [
  6593. "repository"
  6594. ],
  6595. "summary": "Check if a pull request has been merged",
  6596. "operationId": "repoPullRequestIsMerged",
  6597. "parameters": [
  6598. {
  6599. "type": "string",
  6600. "description": "owner of the repo",
  6601. "name": "owner",
  6602. "in": "path",
  6603. "required": true
  6604. },
  6605. {
  6606. "type": "string",
  6607. "description": "name of the repo",
  6608. "name": "repo",
  6609. "in": "path",
  6610. "required": true
  6611. },
  6612. {
  6613. "type": "integer",
  6614. "format": "int64",
  6615. "description": "index of the pull request",
  6616. "name": "index",
  6617. "in": "path",
  6618. "required": true
  6619. }
  6620. ],
  6621. "responses": {
  6622. "204": {
  6623. "description": "pull request has been merged"
  6624. },
  6625. "404": {
  6626. "description": "pull request has not been merged"
  6627. }
  6628. }
  6629. },
  6630. "post": {
  6631. "produces": [
  6632. "application/json"
  6633. ],
  6634. "tags": [
  6635. "repository"
  6636. ],
  6637. "summary": "Merge a pull request",
  6638. "operationId": "repoMergePullRequest",
  6639. "parameters": [
  6640. {
  6641. "type": "string",
  6642. "description": "owner of the repo",
  6643. "name": "owner",
  6644. "in": "path",
  6645. "required": true
  6646. },
  6647. {
  6648. "type": "string",
  6649. "description": "name of the repo",
  6650. "name": "repo",
  6651. "in": "path",
  6652. "required": true
  6653. },
  6654. {
  6655. "type": "integer",
  6656. "format": "int64",
  6657. "description": "index of the pull request to merge",
  6658. "name": "index",
  6659. "in": "path",
  6660. "required": true
  6661. },
  6662. {
  6663. "name": "body",
  6664. "in": "body",
  6665. "schema": {
  6666. "$ref": "#/definitions/MergePullRequestOption"
  6667. }
  6668. }
  6669. ],
  6670. "responses": {
  6671. "200": {
  6672. "$ref": "#/responses/empty"
  6673. },
  6674. "405": {
  6675. "$ref": "#/responses/empty"
  6676. },
  6677. "409": {
  6678. "$ref": "#/responses/error"
  6679. }
  6680. }
  6681. }
  6682. },
  6683. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  6684. "get": {
  6685. "produces": [
  6686. "application/json"
  6687. ],
  6688. "tags": [
  6689. "repository"
  6690. ],
  6691. "summary": "List all reviews for a pull request",
  6692. "operationId": "repoListPullReviews",
  6693. "parameters": [
  6694. {
  6695. "type": "string",
  6696. "description": "owner of the repo",
  6697. "name": "owner",
  6698. "in": "path",
  6699. "required": true
  6700. },
  6701. {
  6702. "type": "string",
  6703. "description": "name of the repo",
  6704. "name": "repo",
  6705. "in": "path",
  6706. "required": true
  6707. },
  6708. {
  6709. "type": "integer",
  6710. "format": "int64",
  6711. "description": "index of the pull request",
  6712. "name": "index",
  6713. "in": "path",
  6714. "required": true
  6715. },
  6716. {
  6717. "type": "integer",
  6718. "description": "page number of results to return (1-based)",
  6719. "name": "page",
  6720. "in": "query"
  6721. },
  6722. {
  6723. "type": "integer",
  6724. "description": "page size of results, maximum page size is 50",
  6725. "name": "limit",
  6726. "in": "query"
  6727. }
  6728. ],
  6729. "responses": {
  6730. "200": {
  6731. "$ref": "#/responses/PullReviewList"
  6732. },
  6733. "404": {
  6734. "$ref": "#/responses/notFound"
  6735. }
  6736. }
  6737. },
  6738. "post": {
  6739. "produces": [
  6740. "application/json"
  6741. ],
  6742. "tags": [
  6743. "repository"
  6744. ],
  6745. "summary": "Create a review to an pull request",
  6746. "operationId": "repoCreatePullReview",
  6747. "parameters": [
  6748. {
  6749. "type": "string",
  6750. "description": "owner of the repo",
  6751. "name": "owner",
  6752. "in": "path",
  6753. "required": true
  6754. },
  6755. {
  6756. "type": "string",
  6757. "description": "name of the repo",
  6758. "name": "repo",
  6759. "in": "path",
  6760. "required": true
  6761. },
  6762. {
  6763. "type": "integer",
  6764. "format": "int64",
  6765. "description": "index of the pull request",
  6766. "name": "index",
  6767. "in": "path",
  6768. "required": true
  6769. },
  6770. {
  6771. "name": "body",
  6772. "in": "body",
  6773. "required": true,
  6774. "schema": {
  6775. "$ref": "#/definitions/CreatePullReviewOptions"
  6776. }
  6777. }
  6778. ],
  6779. "responses": {
  6780. "200": {
  6781. "$ref": "#/responses/PullReview"
  6782. },
  6783. "404": {
  6784. "$ref": "#/responses/notFound"
  6785. },
  6786. "422": {
  6787. "$ref": "#/responses/validationError"
  6788. }
  6789. }
  6790. }
  6791. },
  6792. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  6793. "get": {
  6794. "produces": [
  6795. "application/json"
  6796. ],
  6797. "tags": [
  6798. "repository"
  6799. ],
  6800. "summary": "Get a specific review for a pull request",
  6801. "operationId": "repoGetPullReview",
  6802. "parameters": [
  6803. {
  6804. "type": "string",
  6805. "description": "owner of the repo",
  6806. "name": "owner",
  6807. "in": "path",
  6808. "required": true
  6809. },
  6810. {
  6811. "type": "string",
  6812. "description": "name of the repo",
  6813. "name": "repo",
  6814. "in": "path",
  6815. "required": true
  6816. },
  6817. {
  6818. "type": "integer",
  6819. "format": "int64",
  6820. "description": "index of the pull request",
  6821. "name": "index",
  6822. "in": "path",
  6823. "required": true
  6824. },
  6825. {
  6826. "type": "integer",
  6827. "format": "int64",
  6828. "description": "id of the review",
  6829. "name": "id",
  6830. "in": "path",
  6831. "required": true
  6832. }
  6833. ],
  6834. "responses": {
  6835. "200": {
  6836. "$ref": "#/responses/PullReview"
  6837. },
  6838. "404": {
  6839. "$ref": "#/responses/notFound"
  6840. }
  6841. }
  6842. },
  6843. "post": {
  6844. "produces": [
  6845. "application/json"
  6846. ],
  6847. "tags": [
  6848. "repository"
  6849. ],
  6850. "summary": "Submit a pending review to an pull request",
  6851. "operationId": "repoSubmitPullReview",
  6852. "parameters": [
  6853. {
  6854. "type": "string",
  6855. "description": "owner of the repo",
  6856. "name": "owner",
  6857. "in": "path",
  6858. "required": true
  6859. },
  6860. {
  6861. "type": "string",
  6862. "description": "name of the repo",
  6863. "name": "repo",
  6864. "in": "path",
  6865. "required": true
  6866. },
  6867. {
  6868. "type": "integer",
  6869. "format": "int64",
  6870. "description": "index of the pull request",
  6871. "name": "index",
  6872. "in": "path",
  6873. "required": true
  6874. },
  6875. {
  6876. "type": "integer",
  6877. "format": "int64",
  6878. "description": "id of the review",
  6879. "name": "id",
  6880. "in": "path",
  6881. "required": true
  6882. },
  6883. {
  6884. "name": "body",
  6885. "in": "body",
  6886. "required": true,
  6887. "schema": {
  6888. "$ref": "#/definitions/SubmitPullReviewOptions"
  6889. }
  6890. }
  6891. ],
  6892. "responses": {
  6893. "200": {
  6894. "$ref": "#/responses/PullReview"
  6895. },
  6896. "404": {
  6897. "$ref": "#/responses/notFound"
  6898. },
  6899. "422": {
  6900. "$ref": "#/responses/validationError"
  6901. }
  6902. }
  6903. },
  6904. "delete": {
  6905. "produces": [
  6906. "application/json"
  6907. ],
  6908. "tags": [
  6909. "repository"
  6910. ],
  6911. "summary": "Delete a specific review from a pull request",
  6912. "operationId": "repoDeletePullReview",
  6913. "parameters": [
  6914. {
  6915. "type": "string",
  6916. "description": "owner of the repo",
  6917. "name": "owner",
  6918. "in": "path",
  6919. "required": true
  6920. },
  6921. {
  6922. "type": "string",
  6923. "description": "name of the repo",
  6924. "name": "repo",
  6925. "in": "path",
  6926. "required": true
  6927. },
  6928. {
  6929. "type": "integer",
  6930. "format": "int64",
  6931. "description": "index of the pull request",
  6932. "name": "index",
  6933. "in": "path",
  6934. "required": true
  6935. },
  6936. {
  6937. "type": "integer",
  6938. "format": "int64",
  6939. "description": "id of the review",
  6940. "name": "id",
  6941. "in": "path",
  6942. "required": true
  6943. }
  6944. ],
  6945. "responses": {
  6946. "204": {
  6947. "$ref": "#/responses/empty"
  6948. },
  6949. "403": {
  6950. "$ref": "#/responses/forbidden"
  6951. },
  6952. "404": {
  6953. "$ref": "#/responses/notFound"
  6954. }
  6955. }
  6956. }
  6957. },
  6958. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  6959. "get": {
  6960. "produces": [
  6961. "application/json"
  6962. ],
  6963. "tags": [
  6964. "repository"
  6965. ],
  6966. "summary": "Get a specific review for a pull request",
  6967. "operationId": "repoGetPullReviewComments",
  6968. "parameters": [
  6969. {
  6970. "type": "string",
  6971. "description": "owner of the repo",
  6972. "name": "owner",
  6973. "in": "path",
  6974. "required": true
  6975. },
  6976. {
  6977. "type": "string",
  6978. "description": "name of the repo",
  6979. "name": "repo",
  6980. "in": "path",
  6981. "required": true
  6982. },
  6983. {
  6984. "type": "integer",
  6985. "format": "int64",
  6986. "description": "index of the pull request",
  6987. "name": "index",
  6988. "in": "path",
  6989. "required": true
  6990. },
  6991. {
  6992. "type": "integer",
  6993. "format": "int64",
  6994. "description": "id of the review",
  6995. "name": "id",
  6996. "in": "path",
  6997. "required": true
  6998. }
  6999. ],
  7000. "responses": {
  7001. "200": {
  7002. "$ref": "#/responses/PullReviewCommentList"
  7003. },
  7004. "404": {
  7005. "$ref": "#/responses/notFound"
  7006. }
  7007. }
  7008. }
  7009. },
  7010. "/repos/{owner}/{repo}/raw/{filepath}": {
  7011. "get": {
  7012. "produces": [
  7013. "application/json"
  7014. ],
  7015. "tags": [
  7016. "repository"
  7017. ],
  7018. "summary": "Get a file from a repository",
  7019. "operationId": "repoGetRawFile",
  7020. "parameters": [
  7021. {
  7022. "type": "string",
  7023. "description": "owner of the repo",
  7024. "name": "owner",
  7025. "in": "path",
  7026. "required": true
  7027. },
  7028. {
  7029. "type": "string",
  7030. "description": "name of the repo",
  7031. "name": "repo",
  7032. "in": "path",
  7033. "required": true
  7034. },
  7035. {
  7036. "type": "string",
  7037. "description": "filepath of the file to get",
  7038. "name": "filepath",
  7039. "in": "path",
  7040. "required": true
  7041. }
  7042. ],
  7043. "responses": {
  7044. "200": {
  7045. "description": "success"
  7046. },
  7047. "404": {
  7048. "$ref": "#/responses/notFound"
  7049. }
  7050. }
  7051. }
  7052. },
  7053. "/repos/{owner}/{repo}/releases": {
  7054. "get": {
  7055. "produces": [
  7056. "application/json"
  7057. ],
  7058. "tags": [
  7059. "repository"
  7060. ],
  7061. "summary": "List a repo's releases",
  7062. "operationId": "repoListReleases",
  7063. "parameters": [
  7064. {
  7065. "type": "string",
  7066. "description": "owner of the repo",
  7067. "name": "owner",
  7068. "in": "path",
  7069. "required": true
  7070. },
  7071. {
  7072. "type": "string",
  7073. "description": "name of the repo",
  7074. "name": "repo",
  7075. "in": "path",
  7076. "required": true
  7077. },
  7078. {
  7079. "type": "integer",
  7080. "description": "items count every page wants to load",
  7081. "name": "per_page",
  7082. "in": "query"
  7083. },
  7084. {
  7085. "type": "integer",
  7086. "description": "page number of results to return (1-based)",
  7087. "name": "page",
  7088. "in": "query"
  7089. },
  7090. {
  7091. "type": "integer",
  7092. "description": "page size of results, maximum page size is 50",
  7093. "name": "limit",
  7094. "in": "query"
  7095. }
  7096. ],
  7097. "responses": {
  7098. "200": {
  7099. "$ref": "#/responses/ReleaseList"
  7100. }
  7101. }
  7102. },
  7103. "post": {
  7104. "consumes": [
  7105. "application/json"
  7106. ],
  7107. "produces": [
  7108. "application/json"
  7109. ],
  7110. "tags": [
  7111. "repository"
  7112. ],
  7113. "summary": "Create a release",
  7114. "operationId": "repoCreateRelease",
  7115. "parameters": [
  7116. {
  7117. "type": "string",
  7118. "description": "owner of the repo",
  7119. "name": "owner",
  7120. "in": "path",
  7121. "required": true
  7122. },
  7123. {
  7124. "type": "string",
  7125. "description": "name of the repo",
  7126. "name": "repo",
  7127. "in": "path",
  7128. "required": true
  7129. },
  7130. {
  7131. "name": "body",
  7132. "in": "body",
  7133. "schema": {
  7134. "$ref": "#/definitions/CreateReleaseOption"
  7135. }
  7136. }
  7137. ],
  7138. "responses": {
  7139. "201": {
  7140. "$ref": "#/responses/Release"
  7141. },
  7142. "409": {
  7143. "$ref": "#/responses/error"
  7144. }
  7145. }
  7146. }
  7147. },
  7148. "/repos/{owner}/{repo}/releases/{id}": {
  7149. "get": {
  7150. "produces": [
  7151. "application/json"
  7152. ],
  7153. "tags": [
  7154. "repository"
  7155. ],
  7156. "summary": "Get a release",
  7157. "operationId": "repoGetRelease",
  7158. "parameters": [
  7159. {
  7160. "type": "string",
  7161. "description": "owner of the repo",
  7162. "name": "owner",
  7163. "in": "path",
  7164. "required": true
  7165. },
  7166. {
  7167. "type": "string",
  7168. "description": "name of the repo",
  7169. "name": "repo",
  7170. "in": "path",
  7171. "required": true
  7172. },
  7173. {
  7174. "type": "integer",
  7175. "format": "int64",
  7176. "description": "id of the release to get",
  7177. "name": "id",
  7178. "in": "path",
  7179. "required": true
  7180. }
  7181. ],
  7182. "responses": {
  7183. "200": {
  7184. "$ref": "#/responses/Release"
  7185. }
  7186. }
  7187. },
  7188. "delete": {
  7189. "tags": [
  7190. "repository"
  7191. ],
  7192. "summary": "Delete a release",
  7193. "operationId": "repoDeleteRelease",
  7194. "parameters": [
  7195. {
  7196. "type": "string",
  7197. "description": "owner of the repo",
  7198. "name": "owner",
  7199. "in": "path",
  7200. "required": true
  7201. },
  7202. {
  7203. "type": "string",
  7204. "description": "name of the repo",
  7205. "name": "repo",
  7206. "in": "path",
  7207. "required": true
  7208. },
  7209. {
  7210. "type": "integer",
  7211. "format": "int64",
  7212. "description": "id of the release to delete",
  7213. "name": "id",
  7214. "in": "path",
  7215. "required": true
  7216. }
  7217. ],
  7218. "responses": {
  7219. "204": {
  7220. "$ref": "#/responses/empty"
  7221. }
  7222. }
  7223. },
  7224. "patch": {
  7225. "consumes": [
  7226. "application/json"
  7227. ],
  7228. "produces": [
  7229. "application/json"
  7230. ],
  7231. "tags": [
  7232. "repository"
  7233. ],
  7234. "summary": "Update a release",
  7235. "operationId": "repoEditRelease",
  7236. "parameters": [
  7237. {
  7238. "type": "string",
  7239. "description": "owner of the repo",
  7240. "name": "owner",
  7241. "in": "path",
  7242. "required": true
  7243. },
  7244. {
  7245. "type": "string",
  7246. "description": "name of the repo",
  7247. "name": "repo",
  7248. "in": "path",
  7249. "required": true
  7250. },
  7251. {
  7252. "type": "integer",
  7253. "format": "int64",
  7254. "description": "id of the release to edit",
  7255. "name": "id",
  7256. "in": "path",
  7257. "required": true
  7258. },
  7259. {
  7260. "name": "body",
  7261. "in": "body",
  7262. "schema": {
  7263. "$ref": "#/definitions/EditReleaseOption"
  7264. }
  7265. }
  7266. ],
  7267. "responses": {
  7268. "200": {
  7269. "$ref": "#/responses/Release"
  7270. }
  7271. }
  7272. }
  7273. },
  7274. "/repos/{owner}/{repo}/releases/{id}/assets": {
  7275. "get": {
  7276. "produces": [
  7277. "application/json"
  7278. ],
  7279. "tags": [
  7280. "repository"
  7281. ],
  7282. "summary": "List release's attachments",
  7283. "operationId": "repoListReleaseAttachments",
  7284. "parameters": [
  7285. {
  7286. "type": "string",
  7287. "description": "owner of the repo",
  7288. "name": "owner",
  7289. "in": "path",
  7290. "required": true
  7291. },
  7292. {
  7293. "type": "string",
  7294. "description": "name of the repo",
  7295. "name": "repo",
  7296. "in": "path",
  7297. "required": true
  7298. },
  7299. {
  7300. "type": "integer",
  7301. "format": "int64",
  7302. "description": "id of the release",
  7303. "name": "id",
  7304. "in": "path",
  7305. "required": true
  7306. }
  7307. ],
  7308. "responses": {
  7309. "200": {
  7310. "$ref": "#/responses/AttachmentList"
  7311. }
  7312. }
  7313. },
  7314. "post": {
  7315. "consumes": [
  7316. "multipart/form-data"
  7317. ],
  7318. "produces": [
  7319. "application/json"
  7320. ],
  7321. "tags": [
  7322. "repository"
  7323. ],
  7324. "summary": "Create a release attachment",
  7325. "operationId": "repoCreateReleaseAttachment",
  7326. "parameters": [
  7327. {
  7328. "type": "string",
  7329. "description": "owner of the repo",
  7330. "name": "owner",
  7331. "in": "path",
  7332. "required": true
  7333. },
  7334. {
  7335. "type": "string",
  7336. "description": "name of the repo",
  7337. "name": "repo",
  7338. "in": "path",
  7339. "required": true
  7340. },
  7341. {
  7342. "type": "integer",
  7343. "format": "int64",
  7344. "description": "id of the release",
  7345. "name": "id",
  7346. "in": "path",
  7347. "required": true
  7348. },
  7349. {
  7350. "type": "string",
  7351. "description": "name of the attachment",
  7352. "name": "name",
  7353. "in": "query"
  7354. },
  7355. {
  7356. "type": "file",
  7357. "description": "attachment to upload",
  7358. "name": "attachment",
  7359. "in": "formData",
  7360. "required": true
  7361. }
  7362. ],
  7363. "responses": {
  7364. "201": {
  7365. "$ref": "#/responses/Attachment"
  7366. },
  7367. "400": {
  7368. "$ref": "#/responses/error"
  7369. }
  7370. }
  7371. }
  7372. },
  7373. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  7374. "get": {
  7375. "produces": [
  7376. "application/json"
  7377. ],
  7378. "tags": [
  7379. "repository"
  7380. ],
  7381. "summary": "Get a release attachment",
  7382. "operationId": "repoGetReleaseAttachment",
  7383. "parameters": [
  7384. {
  7385. "type": "string",
  7386. "description": "owner of the repo",
  7387. "name": "owner",
  7388. "in": "path",
  7389. "required": true
  7390. },
  7391. {
  7392. "type": "string",
  7393. "description": "name of the repo",
  7394. "name": "repo",
  7395. "in": "path",
  7396. "required": true
  7397. },
  7398. {
  7399. "type": "integer",
  7400. "format": "int64",
  7401. "description": "id of the release",
  7402. "name": "id",
  7403. "in": "path",
  7404. "required": true
  7405. },
  7406. {
  7407. "type": "integer",
  7408. "format": "int64",
  7409. "description": "id of the attachment to get",
  7410. "name": "attachment_id",
  7411. "in": "path",
  7412. "required": true
  7413. }
  7414. ],
  7415. "responses": {
  7416. "200": {
  7417. "$ref": "#/responses/Attachment"
  7418. }
  7419. }
  7420. },
  7421. "delete": {
  7422. "produces": [
  7423. "application/json"
  7424. ],
  7425. "tags": [
  7426. "repository"
  7427. ],
  7428. "summary": "Delete a release attachment",
  7429. "operationId": "repoDeleteReleaseAttachment",
  7430. "parameters": [
  7431. {
  7432. "type": "string",
  7433. "description": "owner of the repo",
  7434. "name": "owner",
  7435. "in": "path",
  7436. "required": true
  7437. },
  7438. {
  7439. "type": "string",
  7440. "description": "name of the repo",
  7441. "name": "repo",
  7442. "in": "path",
  7443. "required": true
  7444. },
  7445. {
  7446. "type": "integer",
  7447. "format": "int64",
  7448. "description": "id of the release",
  7449. "name": "id",
  7450. "in": "path",
  7451. "required": true
  7452. },
  7453. {
  7454. "type": "integer",
  7455. "format": "int64",
  7456. "description": "id of the attachment to delete",
  7457. "name": "attachment_id",
  7458. "in": "path",
  7459. "required": true
  7460. }
  7461. ],
  7462. "responses": {
  7463. "204": {
  7464. "$ref": "#/responses/empty"
  7465. }
  7466. }
  7467. },
  7468. "patch": {
  7469. "consumes": [
  7470. "application/json"
  7471. ],
  7472. "produces": [
  7473. "application/json"
  7474. ],
  7475. "tags": [
  7476. "repository"
  7477. ],
  7478. "summary": "Edit a release attachment",
  7479. "operationId": "repoEditReleaseAttachment",
  7480. "parameters": [
  7481. {
  7482. "type": "string",
  7483. "description": "owner of the repo",
  7484. "name": "owner",
  7485. "in": "path",
  7486. "required": true
  7487. },
  7488. {
  7489. "type": "string",
  7490. "description": "name of the repo",
  7491. "name": "repo",
  7492. "in": "path",
  7493. "required": true
  7494. },
  7495. {
  7496. "type": "integer",
  7497. "format": "int64",
  7498. "description": "id of the release",
  7499. "name": "id",
  7500. "in": "path",
  7501. "required": true
  7502. },
  7503. {
  7504. "type": "integer",
  7505. "format": "int64",
  7506. "description": "id of the attachment to edit",
  7507. "name": "attachment_id",
  7508. "in": "path",
  7509. "required": true
  7510. },
  7511. {
  7512. "name": "body",
  7513. "in": "body",
  7514. "schema": {
  7515. "$ref": "#/definitions/EditAttachmentOptions"
  7516. }
  7517. }
  7518. ],
  7519. "responses": {
  7520. "201": {
  7521. "$ref": "#/responses/Attachment"
  7522. }
  7523. }
  7524. }
  7525. },
  7526. "/repos/{owner}/{repo}/signing-key.gpg": {
  7527. "get": {
  7528. "produces": [
  7529. "text/plain"
  7530. ],
  7531. "tags": [
  7532. "repository"
  7533. ],
  7534. "summary": "Get signing-key.gpg for given repository",
  7535. "operationId": "repoSigningKey",
  7536. "parameters": [
  7537. {
  7538. "type": "string",
  7539. "description": "owner of the repo",
  7540. "name": "owner",
  7541. "in": "path",
  7542. "required": true
  7543. },
  7544. {
  7545. "type": "string",
  7546. "description": "name of the repo",
  7547. "name": "repo",
  7548. "in": "path",
  7549. "required": true
  7550. }
  7551. ],
  7552. "responses": {
  7553. "200": {
  7554. "description": "GPG armored public key",
  7555. "schema": {
  7556. "type": "string"
  7557. }
  7558. }
  7559. }
  7560. }
  7561. },
  7562. "/repos/{owner}/{repo}/stargazers": {
  7563. "get": {
  7564. "produces": [
  7565. "application/json"
  7566. ],
  7567. "tags": [
  7568. "repository"
  7569. ],
  7570. "summary": "List a repo's stargazers",
  7571. "operationId": "repoListStargazers",
  7572. "parameters": [
  7573. {
  7574. "type": "string",
  7575. "description": "owner of the repo",
  7576. "name": "owner",
  7577. "in": "path",
  7578. "required": true
  7579. },
  7580. {
  7581. "type": "string",
  7582. "description": "name of the repo",
  7583. "name": "repo",
  7584. "in": "path",
  7585. "required": true
  7586. },
  7587. {
  7588. "type": "integer",
  7589. "description": "page number of results to return (1-based)",
  7590. "name": "page",
  7591. "in": "query"
  7592. },
  7593. {
  7594. "type": "integer",
  7595. "description": "page size of results, maximum page size is 50",
  7596. "name": "limit",
  7597. "in": "query"
  7598. }
  7599. ],
  7600. "responses": {
  7601. "200": {
  7602. "$ref": "#/responses/UserList"
  7603. }
  7604. }
  7605. }
  7606. },
  7607. "/repos/{owner}/{repo}/statuses/{sha}": {
  7608. "get": {
  7609. "produces": [
  7610. "application/json"
  7611. ],
  7612. "tags": [
  7613. "repository"
  7614. ],
  7615. "summary": "Get a commit's statuses",
  7616. "operationId": "repoListStatuses",
  7617. "parameters": [
  7618. {
  7619. "type": "string",
  7620. "description": "owner of the repo",
  7621. "name": "owner",
  7622. "in": "path",
  7623. "required": true
  7624. },
  7625. {
  7626. "type": "string",
  7627. "description": "name of the repo",
  7628. "name": "repo",
  7629. "in": "path",
  7630. "required": true
  7631. },
  7632. {
  7633. "type": "string",
  7634. "description": "sha of the commit",
  7635. "name": "sha",
  7636. "in": "path",
  7637. "required": true
  7638. },
  7639. {
  7640. "enum": [
  7641. "oldest",
  7642. "recentupdate",
  7643. "leastupdate",
  7644. "leastindex",
  7645. "highestindex"
  7646. ],
  7647. "type": "string",
  7648. "description": "type of sort",
  7649. "name": "sort",
  7650. "in": "query"
  7651. },
  7652. {
  7653. "enum": [
  7654. "pending",
  7655. "success",
  7656. "error",
  7657. "failure",
  7658. "warning"
  7659. ],
  7660. "type": "string",
  7661. "description": "type of state",
  7662. "name": "state",
  7663. "in": "query"
  7664. },
  7665. {
  7666. "type": "integer",
  7667. "description": "page number of results to return (1-based)",
  7668. "name": "page",
  7669. "in": "query"
  7670. },
  7671. {
  7672. "type": "integer",
  7673. "description": "page size of results, maximum page size is 50",
  7674. "name": "limit",
  7675. "in": "query"
  7676. }
  7677. ],
  7678. "responses": {
  7679. "200": {
  7680. "$ref": "#/responses/StatusList"
  7681. },
  7682. "400": {
  7683. "$ref": "#/responses/error"
  7684. }
  7685. }
  7686. },
  7687. "post": {
  7688. "produces": [
  7689. "application/json"
  7690. ],
  7691. "tags": [
  7692. "repository"
  7693. ],
  7694. "summary": "Create a commit status",
  7695. "operationId": "repoCreateStatus",
  7696. "parameters": [
  7697. {
  7698. "type": "string",
  7699. "description": "owner of the repo",
  7700. "name": "owner",
  7701. "in": "path",
  7702. "required": true
  7703. },
  7704. {
  7705. "type": "string",
  7706. "description": "name of the repo",
  7707. "name": "repo",
  7708. "in": "path",
  7709. "required": true
  7710. },
  7711. {
  7712. "type": "string",
  7713. "description": "sha of the commit",
  7714. "name": "sha",
  7715. "in": "path",
  7716. "required": true
  7717. },
  7718. {
  7719. "name": "body",
  7720. "in": "body",
  7721. "schema": {
  7722. "$ref": "#/definitions/CreateStatusOption"
  7723. }
  7724. }
  7725. ],
  7726. "responses": {
  7727. "201": {
  7728. "$ref": "#/responses/Status"
  7729. },
  7730. "400": {
  7731. "$ref": "#/responses/error"
  7732. }
  7733. }
  7734. }
  7735. },
  7736. "/repos/{owner}/{repo}/subscribers": {
  7737. "get": {
  7738. "produces": [
  7739. "application/json"
  7740. ],
  7741. "tags": [
  7742. "repository"
  7743. ],
  7744. "summary": "List a repo's watchers",
  7745. "operationId": "repoListSubscribers",
  7746. "parameters": [
  7747. {
  7748. "type": "string",
  7749. "description": "owner of the repo",
  7750. "name": "owner",
  7751. "in": "path",
  7752. "required": true
  7753. },
  7754. {
  7755. "type": "string",
  7756. "description": "name of the repo",
  7757. "name": "repo",
  7758. "in": "path",
  7759. "required": true
  7760. },
  7761. {
  7762. "type": "integer",
  7763. "description": "page number of results to return (1-based)",
  7764. "name": "page",
  7765. "in": "query"
  7766. },
  7767. {
  7768. "type": "integer",
  7769. "description": "page size of results, maximum page size is 50",
  7770. "name": "limit",
  7771. "in": "query"
  7772. }
  7773. ],
  7774. "responses": {
  7775. "200": {
  7776. "$ref": "#/responses/UserList"
  7777. }
  7778. }
  7779. }
  7780. },
  7781. "/repos/{owner}/{repo}/subscription": {
  7782. "get": {
  7783. "tags": [
  7784. "repository"
  7785. ],
  7786. "summary": "Check if the current user is watching a repo",
  7787. "operationId": "userCurrentCheckSubscription",
  7788. "parameters": [
  7789. {
  7790. "type": "string",
  7791. "description": "owner of the repo",
  7792. "name": "owner",
  7793. "in": "path",
  7794. "required": true
  7795. },
  7796. {
  7797. "type": "string",
  7798. "description": "name of the repo",
  7799. "name": "repo",
  7800. "in": "path",
  7801. "required": true
  7802. }
  7803. ],
  7804. "responses": {
  7805. "200": {
  7806. "$ref": "#/responses/WatchInfo"
  7807. },
  7808. "404": {
  7809. "description": "User is not watching this repo or repo do not exist"
  7810. }
  7811. }
  7812. },
  7813. "put": {
  7814. "tags": [
  7815. "repository"
  7816. ],
  7817. "summary": "Watch a repo",
  7818. "operationId": "userCurrentPutSubscription",
  7819. "parameters": [
  7820. {
  7821. "type": "string",
  7822. "description": "owner of the repo",
  7823. "name": "owner",
  7824. "in": "path",
  7825. "required": true
  7826. },
  7827. {
  7828. "type": "string",
  7829. "description": "name of the repo",
  7830. "name": "repo",
  7831. "in": "path",
  7832. "required": true
  7833. }
  7834. ],
  7835. "responses": {
  7836. "200": {
  7837. "$ref": "#/responses/WatchInfo"
  7838. }
  7839. }
  7840. },
  7841. "delete": {
  7842. "tags": [
  7843. "repository"
  7844. ],
  7845. "summary": "Unwatch a repo",
  7846. "operationId": "userCurrentDeleteSubscription",
  7847. "parameters": [
  7848. {
  7849. "type": "string",
  7850. "description": "owner of the repo",
  7851. "name": "owner",
  7852. "in": "path",
  7853. "required": true
  7854. },
  7855. {
  7856. "type": "string",
  7857. "description": "name of the repo",
  7858. "name": "repo",
  7859. "in": "path",
  7860. "required": true
  7861. }
  7862. ],
  7863. "responses": {
  7864. "204": {
  7865. "$ref": "#/responses/empty"
  7866. }
  7867. }
  7868. }
  7869. },
  7870. "/repos/{owner}/{repo}/tags": {
  7871. "get": {
  7872. "produces": [
  7873. "application/json"
  7874. ],
  7875. "tags": [
  7876. "repository"
  7877. ],
  7878. "summary": "List a repository's tags",
  7879. "operationId": "repoListTags",
  7880. "parameters": [
  7881. {
  7882. "type": "string",
  7883. "description": "owner of the repo",
  7884. "name": "owner",
  7885. "in": "path",
  7886. "required": true
  7887. },
  7888. {
  7889. "type": "string",
  7890. "description": "name of the repo",
  7891. "name": "repo",
  7892. "in": "path",
  7893. "required": true
  7894. },
  7895. {
  7896. "type": "integer",
  7897. "description": "page number of results to return (1-based)",
  7898. "name": "page",
  7899. "in": "query"
  7900. },
  7901. {
  7902. "type": "integer",
  7903. "description": "page size of results, default maximum page size is 50",
  7904. "name": "limit",
  7905. "in": "query"
  7906. }
  7907. ],
  7908. "responses": {
  7909. "200": {
  7910. "$ref": "#/responses/TagList"
  7911. }
  7912. }
  7913. }
  7914. },
  7915. "/repos/{owner}/{repo}/times": {
  7916. "get": {
  7917. "produces": [
  7918. "application/json"
  7919. ],
  7920. "tags": [
  7921. "repository"
  7922. ],
  7923. "summary": "List a repo's tracked times",
  7924. "operationId": "repoTrackedTimes",
  7925. "parameters": [
  7926. {
  7927. "type": "string",
  7928. "description": "owner of the repo",
  7929. "name": "owner",
  7930. "in": "path",
  7931. "required": true
  7932. },
  7933. {
  7934. "type": "string",
  7935. "description": "name of the repo",
  7936. "name": "repo",
  7937. "in": "path",
  7938. "required": true
  7939. },
  7940. {
  7941. "type": "string",
  7942. "description": "optional filter by user",
  7943. "name": "user",
  7944. "in": "query"
  7945. },
  7946. {
  7947. "type": "string",
  7948. "format": "date-time",
  7949. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7950. "name": "since",
  7951. "in": "query"
  7952. },
  7953. {
  7954. "type": "string",
  7955. "format": "date-time",
  7956. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7957. "name": "before",
  7958. "in": "query"
  7959. },
  7960. {
  7961. "type": "integer",
  7962. "description": "page number of results to return (1-based)",
  7963. "name": "page",
  7964. "in": "query"
  7965. },
  7966. {
  7967. "type": "integer",
  7968. "description": "page size of results, maximum page size is 50",
  7969. "name": "limit",
  7970. "in": "query"
  7971. }
  7972. ],
  7973. "responses": {
  7974. "200": {
  7975. "$ref": "#/responses/TrackedTimeList"
  7976. },
  7977. "400": {
  7978. "$ref": "#/responses/error"
  7979. },
  7980. "403": {
  7981. "$ref": "#/responses/forbidden"
  7982. }
  7983. }
  7984. }
  7985. },
  7986. "/repos/{owner}/{repo}/times/{user}": {
  7987. "get": {
  7988. "produces": [
  7989. "application/json"
  7990. ],
  7991. "tags": [
  7992. "repository"
  7993. ],
  7994. "summary": "List a user's tracked times in a repo",
  7995. "operationId": "userTrackedTimes",
  7996. "deprecated": true,
  7997. "parameters": [
  7998. {
  7999. "type": "string",
  8000. "description": "owner of the repo",
  8001. "name": "owner",
  8002. "in": "path",
  8003. "required": true
  8004. },
  8005. {
  8006. "type": "string",
  8007. "description": "name of the repo",
  8008. "name": "repo",
  8009. "in": "path",
  8010. "required": true
  8011. },
  8012. {
  8013. "type": "string",
  8014. "description": "username of user",
  8015. "name": "user",
  8016. "in": "path",
  8017. "required": true
  8018. }
  8019. ],
  8020. "responses": {
  8021. "200": {
  8022. "$ref": "#/responses/TrackedTimeList"
  8023. },
  8024. "400": {
  8025. "$ref": "#/responses/error"
  8026. },
  8027. "403": {
  8028. "$ref": "#/responses/forbidden"
  8029. }
  8030. }
  8031. }
  8032. },
  8033. "/repos/{owner}/{repo}/topics": {
  8034. "get": {
  8035. "produces": [
  8036. "application/json"
  8037. ],
  8038. "tags": [
  8039. "repository"
  8040. ],
  8041. "summary": "Get list of topics that a repository has",
  8042. "operationId": "repoListTopics",
  8043. "parameters": [
  8044. {
  8045. "type": "string",
  8046. "description": "owner of the repo",
  8047. "name": "owner",
  8048. "in": "path",
  8049. "required": true
  8050. },
  8051. {
  8052. "type": "string",
  8053. "description": "name of the repo",
  8054. "name": "repo",
  8055. "in": "path",
  8056. "required": true
  8057. },
  8058. {
  8059. "type": "integer",
  8060. "description": "page number of results to return (1-based)",
  8061. "name": "page",
  8062. "in": "query"
  8063. },
  8064. {
  8065. "type": "integer",
  8066. "description": "page size of results, maximum page size is 50",
  8067. "name": "limit",
  8068. "in": "query"
  8069. }
  8070. ],
  8071. "responses": {
  8072. "200": {
  8073. "$ref": "#/responses/TopicNames"
  8074. }
  8075. }
  8076. },
  8077. "put": {
  8078. "produces": [
  8079. "application/json"
  8080. ],
  8081. "tags": [
  8082. "repository"
  8083. ],
  8084. "summary": "Replace list of topics for a repository",
  8085. "operationId": "repoUpdateTopics",
  8086. "parameters": [
  8087. {
  8088. "type": "string",
  8089. "description": "owner of the repo",
  8090. "name": "owner",
  8091. "in": "path",
  8092. "required": true
  8093. },
  8094. {
  8095. "type": "string",
  8096. "description": "name of the repo",
  8097. "name": "repo",
  8098. "in": "path",
  8099. "required": true
  8100. },
  8101. {
  8102. "name": "body",
  8103. "in": "body",
  8104. "schema": {
  8105. "$ref": "#/definitions/RepoTopicOptions"
  8106. }
  8107. }
  8108. ],
  8109. "responses": {
  8110. "204": {
  8111. "$ref": "#/responses/empty"
  8112. },
  8113. "422": {
  8114. "$ref": "#/responses/invalidTopicsError"
  8115. }
  8116. }
  8117. }
  8118. },
  8119. "/repos/{owner}/{repo}/topics/{topic}": {
  8120. "put": {
  8121. "produces": [
  8122. "application/json"
  8123. ],
  8124. "tags": [
  8125. "repository"
  8126. ],
  8127. "summary": "Add a topic to a repository",
  8128. "operationId": "repoAddTopíc",
  8129. "parameters": [
  8130. {
  8131. "type": "string",
  8132. "description": "owner of the repo",
  8133. "name": "owner",
  8134. "in": "path",
  8135. "required": true
  8136. },
  8137. {
  8138. "type": "string",
  8139. "description": "name of the repo",
  8140. "name": "repo",
  8141. "in": "path",
  8142. "required": true
  8143. },
  8144. {
  8145. "type": "string",
  8146. "description": "name of the topic to add",
  8147. "name": "topic",
  8148. "in": "path",
  8149. "required": true
  8150. }
  8151. ],
  8152. "responses": {
  8153. "204": {
  8154. "$ref": "#/responses/empty"
  8155. },
  8156. "422": {
  8157. "$ref": "#/responses/invalidTopicsError"
  8158. }
  8159. }
  8160. },
  8161. "delete": {
  8162. "produces": [
  8163. "application/json"
  8164. ],
  8165. "tags": [
  8166. "repository"
  8167. ],
  8168. "summary": "Delete a topic from a repository",
  8169. "operationId": "repoDeleteTopic",
  8170. "parameters": [
  8171. {
  8172. "type": "string",
  8173. "description": "owner of the repo",
  8174. "name": "owner",
  8175. "in": "path",
  8176. "required": true
  8177. },
  8178. {
  8179. "type": "string",
  8180. "description": "name of the repo",
  8181. "name": "repo",
  8182. "in": "path",
  8183. "required": true
  8184. },
  8185. {
  8186. "type": "string",
  8187. "description": "name of the topic to delete",
  8188. "name": "topic",
  8189. "in": "path",
  8190. "required": true
  8191. }
  8192. ],
  8193. "responses": {
  8194. "204": {
  8195. "$ref": "#/responses/empty"
  8196. },
  8197. "422": {
  8198. "$ref": "#/responses/invalidTopicsError"
  8199. }
  8200. }
  8201. }
  8202. },
  8203. "/repos/{owner}/{repo}/transfer": {
  8204. "post": {
  8205. "produces": [
  8206. "application/json"
  8207. ],
  8208. "tags": [
  8209. "repository"
  8210. ],
  8211. "summary": "Transfer a repo ownership",
  8212. "operationId": "repoTransfer",
  8213. "parameters": [
  8214. {
  8215. "type": "string",
  8216. "description": "owner of the repo to transfer",
  8217. "name": "owner",
  8218. "in": "path",
  8219. "required": true
  8220. },
  8221. {
  8222. "type": "string",
  8223. "description": "name of the repo to transfer",
  8224. "name": "repo",
  8225. "in": "path",
  8226. "required": true
  8227. },
  8228. {
  8229. "description": "Transfer Options",
  8230. "name": "body",
  8231. "in": "body",
  8232. "required": true,
  8233. "schema": {
  8234. "$ref": "#/definitions/TransferRepoOption"
  8235. }
  8236. }
  8237. ],
  8238. "responses": {
  8239. "202": {
  8240. "$ref": "#/responses/Repository"
  8241. },
  8242. "403": {
  8243. "$ref": "#/responses/forbidden"
  8244. },
  8245. "404": {
  8246. "$ref": "#/responses/notFound"
  8247. },
  8248. "422": {
  8249. "$ref": "#/responses/validationError"
  8250. }
  8251. }
  8252. }
  8253. },
  8254. "/repositories/{id}": {
  8255. "get": {
  8256. "produces": [
  8257. "application/json"
  8258. ],
  8259. "tags": [
  8260. "repository"
  8261. ],
  8262. "summary": "Get a repository by id",
  8263. "operationId": "repoGetByID",
  8264. "parameters": [
  8265. {
  8266. "type": "integer",
  8267. "format": "int64",
  8268. "description": "id of the repo to get",
  8269. "name": "id",
  8270. "in": "path",
  8271. "required": true
  8272. }
  8273. ],
  8274. "responses": {
  8275. "200": {
  8276. "$ref": "#/responses/Repository"
  8277. }
  8278. }
  8279. }
  8280. },
  8281. "/signing-key.gpg": {
  8282. "get": {
  8283. "produces": [
  8284. "text/plain"
  8285. ],
  8286. "tags": [
  8287. "miscellaneous"
  8288. ],
  8289. "summary": "Get default signing-key.gpg",
  8290. "operationId": "getSigningKey",
  8291. "responses": {
  8292. "200": {
  8293. "description": "GPG armored public key",
  8294. "schema": {
  8295. "type": "string"
  8296. }
  8297. }
  8298. }
  8299. }
  8300. },
  8301. "/teams/{id}": {
  8302. "get": {
  8303. "produces": [
  8304. "application/json"
  8305. ],
  8306. "tags": [
  8307. "organization"
  8308. ],
  8309. "summary": "Get a team",
  8310. "operationId": "orgGetTeam",
  8311. "parameters": [
  8312. {
  8313. "type": "integer",
  8314. "format": "int64",
  8315. "description": "id of the team to get",
  8316. "name": "id",
  8317. "in": "path",
  8318. "required": true
  8319. }
  8320. ],
  8321. "responses": {
  8322. "200": {
  8323. "$ref": "#/responses/Team"
  8324. }
  8325. }
  8326. },
  8327. "delete": {
  8328. "tags": [
  8329. "organization"
  8330. ],
  8331. "summary": "Delete a team",
  8332. "operationId": "orgDeleteTeam",
  8333. "parameters": [
  8334. {
  8335. "type": "integer",
  8336. "format": "int64",
  8337. "description": "id of the team to delete",
  8338. "name": "id",
  8339. "in": "path",
  8340. "required": true
  8341. }
  8342. ],
  8343. "responses": {
  8344. "204": {
  8345. "description": "team deleted"
  8346. }
  8347. }
  8348. },
  8349. "patch": {
  8350. "consumes": [
  8351. "application/json"
  8352. ],
  8353. "produces": [
  8354. "application/json"
  8355. ],
  8356. "tags": [
  8357. "organization"
  8358. ],
  8359. "summary": "Edit a team",
  8360. "operationId": "orgEditTeam",
  8361. "parameters": [
  8362. {
  8363. "type": "integer",
  8364. "description": "id of the team to edit",
  8365. "name": "id",
  8366. "in": "path",
  8367. "required": true
  8368. },
  8369. {
  8370. "name": "body",
  8371. "in": "body",
  8372. "schema": {
  8373. "$ref": "#/definitions/EditTeamOption"
  8374. }
  8375. }
  8376. ],
  8377. "responses": {
  8378. "200": {
  8379. "$ref": "#/responses/Team"
  8380. }
  8381. }
  8382. }
  8383. },
  8384. "/teams/{id}/members": {
  8385. "get": {
  8386. "produces": [
  8387. "application/json"
  8388. ],
  8389. "tags": [
  8390. "organization"
  8391. ],
  8392. "summary": "List a team's members",
  8393. "operationId": "orgListTeamMembers",
  8394. "parameters": [
  8395. {
  8396. "type": "integer",
  8397. "format": "int64",
  8398. "description": "id of the team",
  8399. "name": "id",
  8400. "in": "path",
  8401. "required": true
  8402. },
  8403. {
  8404. "type": "integer",
  8405. "description": "page number of results to return (1-based)",
  8406. "name": "page",
  8407. "in": "query"
  8408. },
  8409. {
  8410. "type": "integer",
  8411. "description": "page size of results, maximum page size is 50",
  8412. "name": "limit",
  8413. "in": "query"
  8414. }
  8415. ],
  8416. "responses": {
  8417. "200": {
  8418. "$ref": "#/responses/UserList"
  8419. }
  8420. }
  8421. }
  8422. },
  8423. "/teams/{id}/members/{username}": {
  8424. "get": {
  8425. "produces": [
  8426. "application/json"
  8427. ],
  8428. "tags": [
  8429. "organization"
  8430. ],
  8431. "summary": "List a particular member of team",
  8432. "operationId": "orgListTeamMember",
  8433. "parameters": [
  8434. {
  8435. "type": "integer",
  8436. "format": "int64",
  8437. "description": "id of the team",
  8438. "name": "id",
  8439. "in": "path",
  8440. "required": true
  8441. },
  8442. {
  8443. "type": "string",
  8444. "description": "username of the member to list",
  8445. "name": "username",
  8446. "in": "path",
  8447. "required": true
  8448. }
  8449. ],
  8450. "responses": {
  8451. "200": {
  8452. "$ref": "#/responses/User"
  8453. },
  8454. "404": {
  8455. "$ref": "#/responses/notFound"
  8456. }
  8457. }
  8458. },
  8459. "put": {
  8460. "produces": [
  8461. "application/json"
  8462. ],
  8463. "tags": [
  8464. "organization"
  8465. ],
  8466. "summary": "Add a team member",
  8467. "operationId": "orgAddTeamMember",
  8468. "parameters": [
  8469. {
  8470. "type": "integer",
  8471. "format": "int64",
  8472. "description": "id of the team",
  8473. "name": "id",
  8474. "in": "path",
  8475. "required": true
  8476. },
  8477. {
  8478. "type": "string",
  8479. "description": "username of the user to add",
  8480. "name": "username",
  8481. "in": "path",
  8482. "required": true
  8483. }
  8484. ],
  8485. "responses": {
  8486. "204": {
  8487. "$ref": "#/responses/empty"
  8488. },
  8489. "404": {
  8490. "$ref": "#/responses/notFound"
  8491. }
  8492. }
  8493. },
  8494. "delete": {
  8495. "produces": [
  8496. "application/json"
  8497. ],
  8498. "tags": [
  8499. "organization"
  8500. ],
  8501. "summary": "Remove a team member",
  8502. "operationId": "orgRemoveTeamMember",
  8503. "parameters": [
  8504. {
  8505. "type": "integer",
  8506. "format": "int64",
  8507. "description": "id of the team",
  8508. "name": "id",
  8509. "in": "path",
  8510. "required": true
  8511. },
  8512. {
  8513. "type": "string",
  8514. "description": "username of the user to remove",
  8515. "name": "username",
  8516. "in": "path",
  8517. "required": true
  8518. }
  8519. ],
  8520. "responses": {
  8521. "204": {
  8522. "$ref": "#/responses/empty"
  8523. },
  8524. "404": {
  8525. "$ref": "#/responses/notFound"
  8526. }
  8527. }
  8528. }
  8529. },
  8530. "/teams/{id}/repos": {
  8531. "get": {
  8532. "produces": [
  8533. "application/json"
  8534. ],
  8535. "tags": [
  8536. "organization"
  8537. ],
  8538. "summary": "List a team's repos",
  8539. "operationId": "orgListTeamRepos",
  8540. "parameters": [
  8541. {
  8542. "type": "integer",
  8543. "format": "int64",
  8544. "description": "id of the team",
  8545. "name": "id",
  8546. "in": "path",
  8547. "required": true
  8548. },
  8549. {
  8550. "type": "integer",
  8551. "description": "page number of results to return (1-based)",
  8552. "name": "page",
  8553. "in": "query"
  8554. },
  8555. {
  8556. "type": "integer",
  8557. "description": "page size of results, maximum page size is 50",
  8558. "name": "limit",
  8559. "in": "query"
  8560. }
  8561. ],
  8562. "responses": {
  8563. "200": {
  8564. "$ref": "#/responses/RepositoryList"
  8565. }
  8566. }
  8567. }
  8568. },
  8569. "/teams/{id}/repos/{org}/{repo}": {
  8570. "put": {
  8571. "produces": [
  8572. "application/json"
  8573. ],
  8574. "tags": [
  8575. "organization"
  8576. ],
  8577. "summary": "Add a repository to a team",
  8578. "operationId": "orgAddTeamRepository",
  8579. "parameters": [
  8580. {
  8581. "type": "integer",
  8582. "format": "int64",
  8583. "description": "id of the team",
  8584. "name": "id",
  8585. "in": "path",
  8586. "required": true
  8587. },
  8588. {
  8589. "type": "string",
  8590. "description": "organization that owns the repo to add",
  8591. "name": "org",
  8592. "in": "path",
  8593. "required": true
  8594. },
  8595. {
  8596. "type": "string",
  8597. "description": "name of the repo to add",
  8598. "name": "repo",
  8599. "in": "path",
  8600. "required": true
  8601. }
  8602. ],
  8603. "responses": {
  8604. "204": {
  8605. "$ref": "#/responses/empty"
  8606. },
  8607. "403": {
  8608. "$ref": "#/responses/forbidden"
  8609. }
  8610. }
  8611. },
  8612. "delete": {
  8613. "description": "This does not delete the repository, it only removes the repository from the team.",
  8614. "produces": [
  8615. "application/json"
  8616. ],
  8617. "tags": [
  8618. "organization"
  8619. ],
  8620. "summary": "Remove a repository from a team",
  8621. "operationId": "orgRemoveTeamRepository",
  8622. "parameters": [
  8623. {
  8624. "type": "integer",
  8625. "format": "int64",
  8626. "description": "id of the team",
  8627. "name": "id",
  8628. "in": "path",
  8629. "required": true
  8630. },
  8631. {
  8632. "type": "string",
  8633. "description": "organization that owns the repo to remove",
  8634. "name": "org",
  8635. "in": "path",
  8636. "required": true
  8637. },
  8638. {
  8639. "type": "string",
  8640. "description": "name of the repo to remove",
  8641. "name": "repo",
  8642. "in": "path",
  8643. "required": true
  8644. }
  8645. ],
  8646. "responses": {
  8647. "204": {
  8648. "$ref": "#/responses/empty"
  8649. },
  8650. "403": {
  8651. "$ref": "#/responses/forbidden"
  8652. }
  8653. }
  8654. }
  8655. },
  8656. "/topics/search": {
  8657. "get": {
  8658. "produces": [
  8659. "application/json"
  8660. ],
  8661. "tags": [
  8662. "repository"
  8663. ],
  8664. "summary": "search topics via keyword",
  8665. "operationId": "topicSearch",
  8666. "parameters": [
  8667. {
  8668. "type": "string",
  8669. "description": "keywords to search",
  8670. "name": "q",
  8671. "in": "query",
  8672. "required": true
  8673. },
  8674. {
  8675. "type": "integer",
  8676. "description": "page number of results to return (1-based)",
  8677. "name": "page",
  8678. "in": "query"
  8679. },
  8680. {
  8681. "type": "integer",
  8682. "description": "page size of results, maximum page size is 50",
  8683. "name": "limit",
  8684. "in": "query"
  8685. }
  8686. ],
  8687. "responses": {
  8688. "200": {
  8689. "$ref": "#/responses/TopicListResponse"
  8690. },
  8691. "403": {
  8692. "$ref": "#/responses/forbidden"
  8693. }
  8694. }
  8695. }
  8696. },
  8697. "/user": {
  8698. "get": {
  8699. "produces": [
  8700. "application/json"
  8701. ],
  8702. "tags": [
  8703. "user"
  8704. ],
  8705. "summary": "Get the authenticated user",
  8706. "operationId": "userGetCurrent",
  8707. "responses": {
  8708. "200": {
  8709. "$ref": "#/responses/User"
  8710. }
  8711. }
  8712. }
  8713. },
  8714. "/user/applications/oauth2": {
  8715. "get": {
  8716. "produces": [
  8717. "application/json"
  8718. ],
  8719. "tags": [
  8720. "user"
  8721. ],
  8722. "summary": "List the authenticated user's oauth2 applications",
  8723. "operationId": "userGetOauth2Application",
  8724. "parameters": [
  8725. {
  8726. "type": "integer",
  8727. "description": "page number of results to return (1-based)",
  8728. "name": "page",
  8729. "in": "query"
  8730. },
  8731. {
  8732. "type": "integer",
  8733. "description": "page size of results, maximum page size is 50",
  8734. "name": "limit",
  8735. "in": "query"
  8736. }
  8737. ],
  8738. "responses": {
  8739. "200": {
  8740. "$ref": "#/responses/OAuth2ApplicationList"
  8741. }
  8742. }
  8743. },
  8744. "post": {
  8745. "produces": [
  8746. "application/json"
  8747. ],
  8748. "tags": [
  8749. "user"
  8750. ],
  8751. "summary": "creates a new OAuth2 application",
  8752. "operationId": "userCreateOAuth2Application",
  8753. "parameters": [
  8754. {
  8755. "name": "body",
  8756. "in": "body",
  8757. "required": true,
  8758. "schema": {
  8759. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  8760. }
  8761. }
  8762. ],
  8763. "responses": {
  8764. "201": {
  8765. "$ref": "#/responses/OAuth2Application"
  8766. }
  8767. }
  8768. }
  8769. },
  8770. "/user/applications/oauth2/{id}": {
  8771. "get": {
  8772. "produces": [
  8773. "application/json"
  8774. ],
  8775. "tags": [
  8776. "user"
  8777. ],
  8778. "summary": "get an OAuth2 Application",
  8779. "operationId": "userGetOAuth2Application",
  8780. "parameters": [
  8781. {
  8782. "type": "integer",
  8783. "format": "int64",
  8784. "description": "Application ID to be found",
  8785. "name": "id",
  8786. "in": "path",
  8787. "required": true
  8788. }
  8789. ],
  8790. "responses": {
  8791. "200": {
  8792. "$ref": "#/responses/OAuth2Application"
  8793. }
  8794. }
  8795. },
  8796. "delete": {
  8797. "produces": [
  8798. "application/json"
  8799. ],
  8800. "tags": [
  8801. "user"
  8802. ],
  8803. "summary": "delete an OAuth2 Application",
  8804. "operationId": "userDeleteOAuth2Application",
  8805. "parameters": [
  8806. {
  8807. "type": "integer",
  8808. "format": "int64",
  8809. "description": "token to be deleted",
  8810. "name": "id",
  8811. "in": "path",
  8812. "required": true
  8813. }
  8814. ],
  8815. "responses": {
  8816. "204": {
  8817. "$ref": "#/responses/empty"
  8818. }
  8819. }
  8820. },
  8821. "patch": {
  8822. "produces": [
  8823. "application/json"
  8824. ],
  8825. "tags": [
  8826. "user"
  8827. ],
  8828. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  8829. "operationId": "userUpdateOAuth2Application",
  8830. "parameters": [
  8831. {
  8832. "type": "integer",
  8833. "format": "int64",
  8834. "description": "application to be updated",
  8835. "name": "id",
  8836. "in": "path",
  8837. "required": true
  8838. },
  8839. {
  8840. "name": "body",
  8841. "in": "body",
  8842. "required": true,
  8843. "schema": {
  8844. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  8845. }
  8846. }
  8847. ],
  8848. "responses": {
  8849. "200": {
  8850. "$ref": "#/responses/OAuth2Application"
  8851. }
  8852. }
  8853. }
  8854. },
  8855. "/user/emails": {
  8856. "get": {
  8857. "produces": [
  8858. "application/json"
  8859. ],
  8860. "tags": [
  8861. "user"
  8862. ],
  8863. "summary": "List the authenticated user's email addresses",
  8864. "operationId": "userListEmails",
  8865. "responses": {
  8866. "200": {
  8867. "$ref": "#/responses/EmailList"
  8868. }
  8869. }
  8870. },
  8871. "post": {
  8872. "produces": [
  8873. "application/json"
  8874. ],
  8875. "tags": [
  8876. "user"
  8877. ],
  8878. "summary": "Add email addresses",
  8879. "operationId": "userAddEmail",
  8880. "parameters": [
  8881. {
  8882. "name": "body",
  8883. "in": "body",
  8884. "schema": {
  8885. "$ref": "#/definitions/CreateEmailOption"
  8886. }
  8887. }
  8888. ],
  8889. "responses": {
  8890. "201": {
  8891. "$ref": "#/responses/EmailList"
  8892. },
  8893. "422": {
  8894. "$ref": "#/responses/validationError"
  8895. }
  8896. }
  8897. },
  8898. "delete": {
  8899. "produces": [
  8900. "application/json"
  8901. ],
  8902. "tags": [
  8903. "user"
  8904. ],
  8905. "summary": "Delete email addresses",
  8906. "operationId": "userDeleteEmail",
  8907. "parameters": [
  8908. {
  8909. "name": "body",
  8910. "in": "body",
  8911. "schema": {
  8912. "$ref": "#/definitions/DeleteEmailOption"
  8913. }
  8914. }
  8915. ],
  8916. "responses": {
  8917. "204": {
  8918. "$ref": "#/responses/empty"
  8919. }
  8920. }
  8921. }
  8922. },
  8923. "/user/followers": {
  8924. "get": {
  8925. "produces": [
  8926. "application/json"
  8927. ],
  8928. "tags": [
  8929. "user"
  8930. ],
  8931. "summary": "List the authenticated user's followers",
  8932. "operationId": "userCurrentListFollowers",
  8933. "parameters": [
  8934. {
  8935. "type": "integer",
  8936. "description": "page number of results to return (1-based)",
  8937. "name": "page",
  8938. "in": "query"
  8939. },
  8940. {
  8941. "type": "integer",
  8942. "description": "page size of results, maximum page size is 50",
  8943. "name": "limit",
  8944. "in": "query"
  8945. }
  8946. ],
  8947. "responses": {
  8948. "200": {
  8949. "$ref": "#/responses/UserList"
  8950. }
  8951. }
  8952. }
  8953. },
  8954. "/user/following": {
  8955. "get": {
  8956. "produces": [
  8957. "application/json"
  8958. ],
  8959. "tags": [
  8960. "user"
  8961. ],
  8962. "summary": "List the users that the authenticated user is following",
  8963. "operationId": "userCurrentListFollowing",
  8964. "parameters": [
  8965. {
  8966. "type": "integer",
  8967. "description": "page number of results to return (1-based)",
  8968. "name": "page",
  8969. "in": "query"
  8970. },
  8971. {
  8972. "type": "integer",
  8973. "description": "page size of results, maximum page size is 50",
  8974. "name": "limit",
  8975. "in": "query"
  8976. }
  8977. ],
  8978. "responses": {
  8979. "200": {
  8980. "$ref": "#/responses/UserList"
  8981. }
  8982. }
  8983. }
  8984. },
  8985. "/user/following/{username}": {
  8986. "get": {
  8987. "tags": [
  8988. "user"
  8989. ],
  8990. "summary": "Check whether a user is followed by the authenticated user",
  8991. "operationId": "userCurrentCheckFollowing",
  8992. "parameters": [
  8993. {
  8994. "type": "string",
  8995. "description": "username of followed user",
  8996. "name": "username",
  8997. "in": "path",
  8998. "required": true
  8999. }
  9000. ],
  9001. "responses": {
  9002. "204": {
  9003. "$ref": "#/responses/empty"
  9004. },
  9005. "404": {
  9006. "$ref": "#/responses/notFound"
  9007. }
  9008. }
  9009. },
  9010. "put": {
  9011. "tags": [
  9012. "user"
  9013. ],
  9014. "summary": "Follow a user",
  9015. "operationId": "userCurrentPutFollow",
  9016. "parameters": [
  9017. {
  9018. "type": "string",
  9019. "description": "username of user to follow",
  9020. "name": "username",
  9021. "in": "path",
  9022. "required": true
  9023. }
  9024. ],
  9025. "responses": {
  9026. "204": {
  9027. "$ref": "#/responses/empty"
  9028. }
  9029. }
  9030. },
  9031. "delete": {
  9032. "tags": [
  9033. "user"
  9034. ],
  9035. "summary": "Unfollow a user",
  9036. "operationId": "userCurrentDeleteFollow",
  9037. "parameters": [
  9038. {
  9039. "type": "string",
  9040. "description": "username of user to unfollow",
  9041. "name": "username",
  9042. "in": "path",
  9043. "required": true
  9044. }
  9045. ],
  9046. "responses": {
  9047. "204": {
  9048. "$ref": "#/responses/empty"
  9049. }
  9050. }
  9051. }
  9052. },
  9053. "/user/gpg_keys": {
  9054. "get": {
  9055. "produces": [
  9056. "application/json"
  9057. ],
  9058. "tags": [
  9059. "user"
  9060. ],
  9061. "summary": "List the authenticated user's GPG keys",
  9062. "operationId": "userCurrentListGPGKeys",
  9063. "parameters": [
  9064. {
  9065. "type": "integer",
  9066. "description": "page number of results to return (1-based)",
  9067. "name": "page",
  9068. "in": "query"
  9069. },
  9070. {
  9071. "type": "integer",
  9072. "description": "page size of results, maximum page size is 50",
  9073. "name": "limit",
  9074. "in": "query"
  9075. }
  9076. ],
  9077. "responses": {
  9078. "200": {
  9079. "$ref": "#/responses/GPGKeyList"
  9080. }
  9081. }
  9082. },
  9083. "post": {
  9084. "consumes": [
  9085. "application/json"
  9086. ],
  9087. "produces": [
  9088. "application/json"
  9089. ],
  9090. "tags": [
  9091. "user"
  9092. ],
  9093. "summary": "Create a GPG key",
  9094. "operationId": "userCurrentPostGPGKey",
  9095. "parameters": [
  9096. {
  9097. "name": "Form",
  9098. "in": "body",
  9099. "schema": {
  9100. "$ref": "#/definitions/CreateGPGKeyOption"
  9101. }
  9102. }
  9103. ],
  9104. "responses": {
  9105. "201": {
  9106. "$ref": "#/responses/GPGKey"
  9107. },
  9108. "422": {
  9109. "$ref": "#/responses/validationError"
  9110. }
  9111. }
  9112. }
  9113. },
  9114. "/user/gpg_keys/{id}": {
  9115. "get": {
  9116. "produces": [
  9117. "application/json"
  9118. ],
  9119. "tags": [
  9120. "user"
  9121. ],
  9122. "summary": "Get a GPG key",
  9123. "operationId": "userCurrentGetGPGKey",
  9124. "parameters": [
  9125. {
  9126. "type": "integer",
  9127. "format": "int64",
  9128. "description": "id of key to get",
  9129. "name": "id",
  9130. "in": "path",
  9131. "required": true
  9132. }
  9133. ],
  9134. "responses": {
  9135. "200": {
  9136. "$ref": "#/responses/GPGKey"
  9137. },
  9138. "404": {
  9139. "$ref": "#/responses/notFound"
  9140. }
  9141. }
  9142. },
  9143. "delete": {
  9144. "produces": [
  9145. "application/json"
  9146. ],
  9147. "tags": [
  9148. "user"
  9149. ],
  9150. "summary": "Remove a GPG key",
  9151. "operationId": "userCurrentDeleteGPGKey",
  9152. "parameters": [
  9153. {
  9154. "type": "integer",
  9155. "format": "int64",
  9156. "description": "id of key to delete",
  9157. "name": "id",
  9158. "in": "path",
  9159. "required": true
  9160. }
  9161. ],
  9162. "responses": {
  9163. "204": {
  9164. "$ref": "#/responses/empty"
  9165. },
  9166. "403": {
  9167. "$ref": "#/responses/forbidden"
  9168. }
  9169. }
  9170. }
  9171. },
  9172. "/user/keys": {
  9173. "get": {
  9174. "produces": [
  9175. "application/json"
  9176. ],
  9177. "tags": [
  9178. "user"
  9179. ],
  9180. "summary": "List the authenticated user's public keys",
  9181. "operationId": "userCurrentListKeys",
  9182. "parameters": [
  9183. {
  9184. "type": "string",
  9185. "description": "fingerprint of the key",
  9186. "name": "fingerprint",
  9187. "in": "query"
  9188. },
  9189. {
  9190. "type": "integer",
  9191. "description": "page number of results to return (1-based)",
  9192. "name": "page",
  9193. "in": "query"
  9194. },
  9195. {
  9196. "type": "integer",
  9197. "description": "page size of results, maximum page size is 50",
  9198. "name": "limit",
  9199. "in": "query"
  9200. }
  9201. ],
  9202. "responses": {
  9203. "200": {
  9204. "$ref": "#/responses/PublicKeyList"
  9205. }
  9206. }
  9207. },
  9208. "post": {
  9209. "consumes": [
  9210. "application/json"
  9211. ],
  9212. "produces": [
  9213. "application/json"
  9214. ],
  9215. "tags": [
  9216. "user"
  9217. ],
  9218. "summary": "Create a public key",
  9219. "operationId": "userCurrentPostKey",
  9220. "parameters": [
  9221. {
  9222. "name": "body",
  9223. "in": "body",
  9224. "schema": {
  9225. "$ref": "#/definitions/CreateKeyOption"
  9226. }
  9227. }
  9228. ],
  9229. "responses": {
  9230. "201": {
  9231. "$ref": "#/responses/PublicKey"
  9232. },
  9233. "422": {
  9234. "$ref": "#/responses/validationError"
  9235. }
  9236. }
  9237. }
  9238. },
  9239. "/user/keys/{id}": {
  9240. "get": {
  9241. "produces": [
  9242. "application/json"
  9243. ],
  9244. "tags": [
  9245. "user"
  9246. ],
  9247. "summary": "Get a public key",
  9248. "operationId": "userCurrentGetKey",
  9249. "parameters": [
  9250. {
  9251. "type": "integer",
  9252. "format": "int64",
  9253. "description": "id of key to get",
  9254. "name": "id",
  9255. "in": "path",
  9256. "required": true
  9257. }
  9258. ],
  9259. "responses": {
  9260. "200": {
  9261. "$ref": "#/responses/PublicKey"
  9262. },
  9263. "404": {
  9264. "$ref": "#/responses/notFound"
  9265. }
  9266. }
  9267. },
  9268. "delete": {
  9269. "produces": [
  9270. "application/json"
  9271. ],
  9272. "tags": [
  9273. "user"
  9274. ],
  9275. "summary": "Delete a public key",
  9276. "operationId": "userCurrentDeleteKey",
  9277. "parameters": [
  9278. {
  9279. "type": "integer",
  9280. "format": "int64",
  9281. "description": "id of key to delete",
  9282. "name": "id",
  9283. "in": "path",
  9284. "required": true
  9285. }
  9286. ],
  9287. "responses": {
  9288. "204": {
  9289. "$ref": "#/responses/empty"
  9290. },
  9291. "403": {
  9292. "$ref": "#/responses/forbidden"
  9293. },
  9294. "404": {
  9295. "$ref": "#/responses/notFound"
  9296. }
  9297. }
  9298. }
  9299. },
  9300. "/user/orgs": {
  9301. "get": {
  9302. "produces": [
  9303. "application/json"
  9304. ],
  9305. "tags": [
  9306. "organization"
  9307. ],
  9308. "summary": "List the current user's organizations",
  9309. "operationId": "orgListCurrentUserOrgs",
  9310. "parameters": [
  9311. {
  9312. "type": "integer",
  9313. "description": "page number of results to return (1-based)",
  9314. "name": "page",
  9315. "in": "query"
  9316. },
  9317. {
  9318. "type": "integer",
  9319. "description": "page size of results, maximum page size is 50",
  9320. "name": "limit",
  9321. "in": "query"
  9322. }
  9323. ],
  9324. "responses": {
  9325. "200": {
  9326. "$ref": "#/responses/OrganizationList"
  9327. }
  9328. }
  9329. }
  9330. },
  9331. "/user/repos": {
  9332. "get": {
  9333. "produces": [
  9334. "application/json"
  9335. ],
  9336. "tags": [
  9337. "user"
  9338. ],
  9339. "summary": "List the repos that the authenticated user owns or has access to",
  9340. "operationId": "userCurrentListRepos",
  9341. "parameters": [
  9342. {
  9343. "type": "integer",
  9344. "description": "page number of results to return (1-based)",
  9345. "name": "page",
  9346. "in": "query"
  9347. },
  9348. {
  9349. "type": "integer",
  9350. "description": "page size of results, maximum page size is 50",
  9351. "name": "limit",
  9352. "in": "query"
  9353. }
  9354. ],
  9355. "responses": {
  9356. "200": {
  9357. "$ref": "#/responses/RepositoryList"
  9358. }
  9359. }
  9360. },
  9361. "post": {
  9362. "consumes": [
  9363. "application/json"
  9364. ],
  9365. "produces": [
  9366. "application/json"
  9367. ],
  9368. "tags": [
  9369. "repository",
  9370. "user"
  9371. ],
  9372. "summary": "Create a repository",
  9373. "operationId": "createCurrentUserRepo",
  9374. "parameters": [
  9375. {
  9376. "name": "body",
  9377. "in": "body",
  9378. "schema": {
  9379. "$ref": "#/definitions/CreateRepoOption"
  9380. }
  9381. }
  9382. ],
  9383. "responses": {
  9384. "201": {
  9385. "$ref": "#/responses/Repository"
  9386. },
  9387. "409": {
  9388. "description": "The repository with the same name already exists."
  9389. },
  9390. "422": {
  9391. "$ref": "#/responses/validationError"
  9392. }
  9393. }
  9394. }
  9395. },
  9396. "/user/starred": {
  9397. "get": {
  9398. "produces": [
  9399. "application/json"
  9400. ],
  9401. "tags": [
  9402. "user"
  9403. ],
  9404. "summary": "The repos that the authenticated user has starred",
  9405. "operationId": "userCurrentListStarred",
  9406. "parameters": [
  9407. {
  9408. "type": "integer",
  9409. "description": "page number of results to return (1-based)",
  9410. "name": "page",
  9411. "in": "query"
  9412. },
  9413. {
  9414. "type": "integer",
  9415. "description": "page size of results, maximum page size is 50",
  9416. "name": "limit",
  9417. "in": "query"
  9418. }
  9419. ],
  9420. "responses": {
  9421. "200": {
  9422. "$ref": "#/responses/RepositoryList"
  9423. }
  9424. }
  9425. }
  9426. },
  9427. "/user/starred/{owner}/{repo}": {
  9428. "get": {
  9429. "tags": [
  9430. "user"
  9431. ],
  9432. "summary": "Whether the authenticated is starring the repo",
  9433. "operationId": "userCurrentCheckStarring",
  9434. "parameters": [
  9435. {
  9436. "type": "string",
  9437. "description": "owner of the repo",
  9438. "name": "owner",
  9439. "in": "path",
  9440. "required": true
  9441. },
  9442. {
  9443. "type": "string",
  9444. "description": "name of the repo",
  9445. "name": "repo",
  9446. "in": "path",
  9447. "required": true
  9448. }
  9449. ],
  9450. "responses": {
  9451. "204": {
  9452. "$ref": "#/responses/empty"
  9453. },
  9454. "404": {
  9455. "$ref": "#/responses/notFound"
  9456. }
  9457. }
  9458. },
  9459. "put": {
  9460. "tags": [
  9461. "user"
  9462. ],
  9463. "summary": "Star the given repo",
  9464. "operationId": "userCurrentPutStar",
  9465. "parameters": [
  9466. {
  9467. "type": "string",
  9468. "description": "owner of the repo to star",
  9469. "name": "owner",
  9470. "in": "path",
  9471. "required": true
  9472. },
  9473. {
  9474. "type": "string",
  9475. "description": "name of the repo to star",
  9476. "name": "repo",
  9477. "in": "path",
  9478. "required": true
  9479. }
  9480. ],
  9481. "responses": {
  9482. "204": {
  9483. "$ref": "#/responses/empty"
  9484. }
  9485. }
  9486. },
  9487. "delete": {
  9488. "tags": [
  9489. "user"
  9490. ],
  9491. "summary": "Unstar the given repo",
  9492. "operationId": "userCurrentDeleteStar",
  9493. "parameters": [
  9494. {
  9495. "type": "string",
  9496. "description": "owner of the repo to unstar",
  9497. "name": "owner",
  9498. "in": "path",
  9499. "required": true
  9500. },
  9501. {
  9502. "type": "string",
  9503. "description": "name of the repo to unstar",
  9504. "name": "repo",
  9505. "in": "path",
  9506. "required": true
  9507. }
  9508. ],
  9509. "responses": {
  9510. "204": {
  9511. "$ref": "#/responses/empty"
  9512. }
  9513. }
  9514. }
  9515. },
  9516. "/user/stopwatches": {
  9517. "get": {
  9518. "consumes": [
  9519. "application/json"
  9520. ],
  9521. "produces": [
  9522. "application/json"
  9523. ],
  9524. "tags": [
  9525. "user"
  9526. ],
  9527. "summary": "Get list of all existing stopwatches",
  9528. "operationId": "userGetStopWatches",
  9529. "parameters": [
  9530. {
  9531. "type": "integer",
  9532. "description": "page number of results to return (1-based)",
  9533. "name": "page",
  9534. "in": "query"
  9535. },
  9536. {
  9537. "type": "integer",
  9538. "description": "page size of results, maximum page size is 50",
  9539. "name": "limit",
  9540. "in": "query"
  9541. }
  9542. ],
  9543. "responses": {
  9544. "200": {
  9545. "$ref": "#/responses/StopWatchList"
  9546. }
  9547. }
  9548. }
  9549. },
  9550. "/user/subscriptions": {
  9551. "get": {
  9552. "produces": [
  9553. "application/json"
  9554. ],
  9555. "tags": [
  9556. "user"
  9557. ],
  9558. "summary": "List repositories watched by the authenticated user",
  9559. "operationId": "userCurrentListSubscriptions",
  9560. "parameters": [
  9561. {
  9562. "type": "integer",
  9563. "description": "page number of results to return (1-based)",
  9564. "name": "page",
  9565. "in": "query"
  9566. },
  9567. {
  9568. "type": "integer",
  9569. "description": "page size of results, maximum page size is 50",
  9570. "name": "limit",
  9571. "in": "query"
  9572. }
  9573. ],
  9574. "responses": {
  9575. "200": {
  9576. "$ref": "#/responses/RepositoryList"
  9577. }
  9578. }
  9579. }
  9580. },
  9581. "/user/teams": {
  9582. "get": {
  9583. "produces": [
  9584. "application/json"
  9585. ],
  9586. "tags": [
  9587. "user"
  9588. ],
  9589. "summary": "List all the teams a user belongs to",
  9590. "operationId": "userListTeams",
  9591. "parameters": [
  9592. {
  9593. "type": "integer",
  9594. "description": "page number of results to return (1-based)",
  9595. "name": "page",
  9596. "in": "query"
  9597. },
  9598. {
  9599. "type": "integer",
  9600. "description": "page size of results, maximum page size is 50",
  9601. "name": "limit",
  9602. "in": "query"
  9603. }
  9604. ],
  9605. "responses": {
  9606. "200": {
  9607. "$ref": "#/responses/TeamList"
  9608. }
  9609. }
  9610. }
  9611. },
  9612. "/user/times": {
  9613. "get": {
  9614. "produces": [
  9615. "application/json"
  9616. ],
  9617. "tags": [
  9618. "user"
  9619. ],
  9620. "summary": "List the current user's tracked times",
  9621. "operationId": "userCurrentTrackedTimes",
  9622. "parameters": [
  9623. {
  9624. "type": "string",
  9625. "format": "date-time",
  9626. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9627. "name": "since",
  9628. "in": "query"
  9629. },
  9630. {
  9631. "type": "string",
  9632. "format": "date-time",
  9633. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9634. "name": "before",
  9635. "in": "query"
  9636. }
  9637. ],
  9638. "responses": {
  9639. "200": {
  9640. "$ref": "#/responses/TrackedTimeList"
  9641. }
  9642. }
  9643. }
  9644. },
  9645. "/users/search": {
  9646. "get": {
  9647. "produces": [
  9648. "application/json"
  9649. ],
  9650. "tags": [
  9651. "user"
  9652. ],
  9653. "summary": "Search for users",
  9654. "operationId": "userSearch",
  9655. "parameters": [
  9656. {
  9657. "type": "string",
  9658. "description": "keyword",
  9659. "name": "q",
  9660. "in": "query"
  9661. },
  9662. {
  9663. "type": "integer",
  9664. "format": "int64",
  9665. "description": "ID of the user to search for",
  9666. "name": "uid",
  9667. "in": "query"
  9668. },
  9669. {
  9670. "type": "integer",
  9671. "description": "page number of results to return (1-based)",
  9672. "name": "page",
  9673. "in": "query"
  9674. },
  9675. {
  9676. "type": "integer",
  9677. "description": "page size of results, maximum page size is 50",
  9678. "name": "limit",
  9679. "in": "query"
  9680. }
  9681. ],
  9682. "responses": {
  9683. "200": {
  9684. "description": "SearchResults of a successful search",
  9685. "schema": {
  9686. "type": "object",
  9687. "properties": {
  9688. "data": {
  9689. "type": "array",
  9690. "items": {
  9691. "$ref": "#/definitions/User"
  9692. }
  9693. },
  9694. "ok": {
  9695. "type": "boolean"
  9696. }
  9697. }
  9698. }
  9699. }
  9700. }
  9701. }
  9702. },
  9703. "/users/{follower}/following/{followee}": {
  9704. "get": {
  9705. "tags": [
  9706. "user"
  9707. ],
  9708. "summary": "Check if one user is following another user",
  9709. "operationId": "userCheckFollowing",
  9710. "parameters": [
  9711. {
  9712. "type": "string",
  9713. "description": "username of following user",
  9714. "name": "follower",
  9715. "in": "path",
  9716. "required": true
  9717. },
  9718. {
  9719. "type": "string",
  9720. "description": "username of followed user",
  9721. "name": "followee",
  9722. "in": "path",
  9723. "required": true
  9724. }
  9725. ],
  9726. "responses": {
  9727. "204": {
  9728. "$ref": "#/responses/empty"
  9729. },
  9730. "404": {
  9731. "$ref": "#/responses/notFound"
  9732. }
  9733. }
  9734. }
  9735. },
  9736. "/users/{username}": {
  9737. "get": {
  9738. "produces": [
  9739. "application/json"
  9740. ],
  9741. "tags": [
  9742. "user"
  9743. ],
  9744. "summary": "Get a user",
  9745. "operationId": "userGet",
  9746. "parameters": [
  9747. {
  9748. "type": "string",
  9749. "description": "username of user to get",
  9750. "name": "username",
  9751. "in": "path",
  9752. "required": true
  9753. }
  9754. ],
  9755. "responses": {
  9756. "200": {
  9757. "$ref": "#/responses/User"
  9758. },
  9759. "404": {
  9760. "$ref": "#/responses/notFound"
  9761. }
  9762. }
  9763. }
  9764. },
  9765. "/users/{username}/followers": {
  9766. "get": {
  9767. "produces": [
  9768. "application/json"
  9769. ],
  9770. "tags": [
  9771. "user"
  9772. ],
  9773. "summary": "List the given user's followers",
  9774. "operationId": "userListFollowers",
  9775. "parameters": [
  9776. {
  9777. "type": "string",
  9778. "description": "username of user",
  9779. "name": "username",
  9780. "in": "path",
  9781. "required": true
  9782. },
  9783. {
  9784. "type": "integer",
  9785. "description": "page number of results to return (1-based)",
  9786. "name": "page",
  9787. "in": "query"
  9788. },
  9789. {
  9790. "type": "integer",
  9791. "description": "page size of results, maximum page size is 50",
  9792. "name": "limit",
  9793. "in": "query"
  9794. }
  9795. ],
  9796. "responses": {
  9797. "200": {
  9798. "$ref": "#/responses/UserList"
  9799. }
  9800. }
  9801. }
  9802. },
  9803. "/users/{username}/following": {
  9804. "get": {
  9805. "produces": [
  9806. "application/json"
  9807. ],
  9808. "tags": [
  9809. "user"
  9810. ],
  9811. "summary": "List the users that the given user is following",
  9812. "operationId": "userListFollowing",
  9813. "parameters": [
  9814. {
  9815. "type": "string",
  9816. "description": "username of user",
  9817. "name": "username",
  9818. "in": "path",
  9819. "required": true
  9820. },
  9821. {
  9822. "type": "integer",
  9823. "description": "page number of results to return (1-based)",
  9824. "name": "page",
  9825. "in": "query"
  9826. },
  9827. {
  9828. "type": "integer",
  9829. "description": "page size of results, maximum page size is 50",
  9830. "name": "limit",
  9831. "in": "query"
  9832. }
  9833. ],
  9834. "responses": {
  9835. "200": {
  9836. "$ref": "#/responses/UserList"
  9837. }
  9838. }
  9839. }
  9840. },
  9841. "/users/{username}/gpg_keys": {
  9842. "get": {
  9843. "produces": [
  9844. "application/json"
  9845. ],
  9846. "tags": [
  9847. "user"
  9848. ],
  9849. "summary": "List the given user's GPG keys",
  9850. "operationId": "userListGPGKeys",
  9851. "parameters": [
  9852. {
  9853. "type": "string",
  9854. "description": "username of user",
  9855. "name": "username",
  9856. "in": "path",
  9857. "required": true
  9858. },
  9859. {
  9860. "type": "integer",
  9861. "description": "page number of results to return (1-based)",
  9862. "name": "page",
  9863. "in": "query"
  9864. },
  9865. {
  9866. "type": "integer",
  9867. "description": "page size of results, maximum page size is 50",
  9868. "name": "limit",
  9869. "in": "query"
  9870. }
  9871. ],
  9872. "responses": {
  9873. "200": {
  9874. "$ref": "#/responses/GPGKeyList"
  9875. }
  9876. }
  9877. }
  9878. },
  9879. "/users/{username}/heatmap": {
  9880. "get": {
  9881. "produces": [
  9882. "application/json"
  9883. ],
  9884. "tags": [
  9885. "user"
  9886. ],
  9887. "summary": "Get a user's heatmap",
  9888. "operationId": "userGetHeatmapData",
  9889. "parameters": [
  9890. {
  9891. "type": "string",
  9892. "description": "username of user to get",
  9893. "name": "username",
  9894. "in": "path",
  9895. "required": true
  9896. }
  9897. ],
  9898. "responses": {
  9899. "200": {
  9900. "$ref": "#/responses/UserHeatmapData"
  9901. },
  9902. "404": {
  9903. "$ref": "#/responses/notFound"
  9904. }
  9905. }
  9906. }
  9907. },
  9908. "/users/{username}/keys": {
  9909. "get": {
  9910. "produces": [
  9911. "application/json"
  9912. ],
  9913. "tags": [
  9914. "user"
  9915. ],
  9916. "summary": "List the given user's public keys",
  9917. "operationId": "userListKeys",
  9918. "parameters": [
  9919. {
  9920. "type": "string",
  9921. "description": "username of user",
  9922. "name": "username",
  9923. "in": "path",
  9924. "required": true
  9925. },
  9926. {
  9927. "type": "string",
  9928. "description": "fingerprint of the key",
  9929. "name": "fingerprint",
  9930. "in": "query"
  9931. },
  9932. {
  9933. "type": "integer",
  9934. "description": "page number of results to return (1-based)",
  9935. "name": "page",
  9936. "in": "query"
  9937. },
  9938. {
  9939. "type": "integer",
  9940. "description": "page size of results, maximum page size is 50",
  9941. "name": "limit",
  9942. "in": "query"
  9943. }
  9944. ],
  9945. "responses": {
  9946. "200": {
  9947. "$ref": "#/responses/PublicKeyList"
  9948. }
  9949. }
  9950. }
  9951. },
  9952. "/users/{username}/orgs": {
  9953. "get": {
  9954. "produces": [
  9955. "application/json"
  9956. ],
  9957. "tags": [
  9958. "organization"
  9959. ],
  9960. "summary": "List a user's organizations",
  9961. "operationId": "orgListUserOrgs",
  9962. "parameters": [
  9963. {
  9964. "type": "string",
  9965. "description": "username of user",
  9966. "name": "username",
  9967. "in": "path",
  9968. "required": true
  9969. },
  9970. {
  9971. "type": "integer",
  9972. "description": "page number of results to return (1-based)",
  9973. "name": "page",
  9974. "in": "query"
  9975. },
  9976. {
  9977. "type": "integer",
  9978. "description": "page size of results, maximum page size is 50",
  9979. "name": "limit",
  9980. "in": "query"
  9981. }
  9982. ],
  9983. "responses": {
  9984. "200": {
  9985. "$ref": "#/responses/OrganizationList"
  9986. }
  9987. }
  9988. }
  9989. },
  9990. "/users/{username}/repos": {
  9991. "get": {
  9992. "produces": [
  9993. "application/json"
  9994. ],
  9995. "tags": [
  9996. "user"
  9997. ],
  9998. "summary": "List the repos owned by the given user",
  9999. "operationId": "userListRepos",
  10000. "parameters": [
  10001. {
  10002. "type": "string",
  10003. "description": "username of user",
  10004. "name": "username",
  10005. "in": "path",
  10006. "required": true
  10007. },
  10008. {
  10009. "type": "integer",
  10010. "description": "page number of results to return (1-based)",
  10011. "name": "page",
  10012. "in": "query"
  10013. },
  10014. {
  10015. "type": "integer",
  10016. "description": "page size of results, maximum page size is 50",
  10017. "name": "limit",
  10018. "in": "query"
  10019. }
  10020. ],
  10021. "responses": {
  10022. "200": {
  10023. "$ref": "#/responses/RepositoryList"
  10024. }
  10025. }
  10026. }
  10027. },
  10028. "/users/{username}/starred": {
  10029. "get": {
  10030. "produces": [
  10031. "application/json"
  10032. ],
  10033. "tags": [
  10034. "user"
  10035. ],
  10036. "summary": "The repos that the given user has starred",
  10037. "operationId": "userListStarred",
  10038. "parameters": [
  10039. {
  10040. "type": "string",
  10041. "description": "username of user",
  10042. "name": "username",
  10043. "in": "path",
  10044. "required": true
  10045. },
  10046. {
  10047. "type": "integer",
  10048. "description": "page number of results to return (1-based)",
  10049. "name": "page",
  10050. "in": "query"
  10051. },
  10052. {
  10053. "type": "integer",
  10054. "description": "page size of results, maximum page size is 50",
  10055. "name": "limit",
  10056. "in": "query"
  10057. }
  10058. ],
  10059. "responses": {
  10060. "200": {
  10061. "$ref": "#/responses/RepositoryList"
  10062. }
  10063. }
  10064. }
  10065. },
  10066. "/users/{username}/subscriptions": {
  10067. "get": {
  10068. "produces": [
  10069. "application/json"
  10070. ],
  10071. "tags": [
  10072. "user"
  10073. ],
  10074. "summary": "List the repositories watched by a user",
  10075. "operationId": "userListSubscriptions",
  10076. "parameters": [
  10077. {
  10078. "type": "string",
  10079. "description": "username of the user",
  10080. "name": "username",
  10081. "in": "path",
  10082. "required": true
  10083. },
  10084. {
  10085. "type": "integer",
  10086. "description": "page number of results to return (1-based)",
  10087. "name": "page",
  10088. "in": "query"
  10089. },
  10090. {
  10091. "type": "integer",
  10092. "description": "page size of results, maximum page size is 50",
  10093. "name": "limit",
  10094. "in": "query"
  10095. }
  10096. ],
  10097. "responses": {
  10098. "200": {
  10099. "$ref": "#/responses/RepositoryList"
  10100. }
  10101. }
  10102. }
  10103. },
  10104. "/users/{username}/tokens": {
  10105. "get": {
  10106. "produces": [
  10107. "application/json"
  10108. ],
  10109. "tags": [
  10110. "user"
  10111. ],
  10112. "summary": "List the authenticated user's access tokens",
  10113. "operationId": "userGetTokens",
  10114. "parameters": [
  10115. {
  10116. "type": "string",
  10117. "description": "username of user",
  10118. "name": "username",
  10119. "in": "path",
  10120. "required": true
  10121. },
  10122. {
  10123. "type": "integer",
  10124. "description": "page number of results to return (1-based)",
  10125. "name": "page",
  10126. "in": "query"
  10127. },
  10128. {
  10129. "type": "integer",
  10130. "description": "page size of results, maximum page size is 50",
  10131. "name": "limit",
  10132. "in": "query"
  10133. }
  10134. ],
  10135. "responses": {
  10136. "200": {
  10137. "$ref": "#/responses/AccessTokenList"
  10138. }
  10139. }
  10140. },
  10141. "post": {
  10142. "consumes": [
  10143. "application/json"
  10144. ],
  10145. "produces": [
  10146. "application/json"
  10147. ],
  10148. "tags": [
  10149. "user"
  10150. ],
  10151. "summary": "Create an access token",
  10152. "operationId": "userCreateToken",
  10153. "parameters": [
  10154. {
  10155. "type": "string",
  10156. "x-go-name": "Name",
  10157. "description": "username of user",
  10158. "name": "username",
  10159. "in": "path",
  10160. "required": true
  10161. },
  10162. {
  10163. "name": "accessToken",
  10164. "in": "body",
  10165. "schema": {
  10166. "type": "object",
  10167. "required": [
  10168. "name"
  10169. ],
  10170. "properties": {
  10171. "name": {
  10172. "type": "string"
  10173. }
  10174. }
  10175. }
  10176. }
  10177. ],
  10178. "responses": {
  10179. "200": {
  10180. "$ref": "#/responses/AccessToken"
  10181. }
  10182. }
  10183. }
  10184. },
  10185. "/users/{username}/tokens/{token}": {
  10186. "delete": {
  10187. "produces": [
  10188. "application/json"
  10189. ],
  10190. "tags": [
  10191. "user"
  10192. ],
  10193. "summary": "delete an access token",
  10194. "operationId": "userDeleteAccessToken",
  10195. "parameters": [
  10196. {
  10197. "type": "string",
  10198. "description": "username of user",
  10199. "name": "username",
  10200. "in": "path",
  10201. "required": true
  10202. },
  10203. {
  10204. "type": "integer",
  10205. "format": "int64",
  10206. "description": "token to be deleted",
  10207. "name": "token",
  10208. "in": "path",
  10209. "required": true
  10210. }
  10211. ],
  10212. "responses": {
  10213. "204": {
  10214. "$ref": "#/responses/empty"
  10215. }
  10216. }
  10217. }
  10218. },
  10219. "/version": {
  10220. "get": {
  10221. "produces": [
  10222. "application/json"
  10223. ],
  10224. "tags": [
  10225. "miscellaneous"
  10226. ],
  10227. "summary": "Returns the version of the Gitea application",
  10228. "operationId": "getVersion",
  10229. "responses": {
  10230. "200": {
  10231. "$ref": "#/responses/ServerVersion"
  10232. }
  10233. }
  10234. }
  10235. }
  10236. },
  10237. "definitions": {
  10238. "APIError": {
  10239. "description": "APIError is an api error with a message",
  10240. "type": "object",
  10241. "properties": {
  10242. "message": {
  10243. "type": "string",
  10244. "x-go-name": "Message"
  10245. },
  10246. "url": {
  10247. "type": "string",
  10248. "x-go-name": "URL"
  10249. }
  10250. },
  10251. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10252. },
  10253. "AccessToken": {
  10254. "type": "object",
  10255. "title": "AccessToken represents an API access token.",
  10256. "properties": {
  10257. "id": {
  10258. "type": "integer",
  10259. "format": "int64",
  10260. "x-go-name": "ID"
  10261. },
  10262. "name": {
  10263. "type": "string",
  10264. "x-go-name": "Name"
  10265. },
  10266. "sha1": {
  10267. "type": "string",
  10268. "x-go-name": "Token"
  10269. },
  10270. "token_last_eight": {
  10271. "type": "string",
  10272. "x-go-name": "TokenLastEight"
  10273. }
  10274. },
  10275. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10276. },
  10277. "AddCollaboratorOption": {
  10278. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  10279. "type": "object",
  10280. "properties": {
  10281. "permission": {
  10282. "type": "string",
  10283. "x-go-name": "Permission"
  10284. }
  10285. },
  10286. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10287. },
  10288. "AddTimeOption": {
  10289. "description": "AddTimeOption options for adding time to an issue",
  10290. "type": "object",
  10291. "required": [
  10292. "time"
  10293. ],
  10294. "properties": {
  10295. "created": {
  10296. "type": "string",
  10297. "format": "date-time",
  10298. "x-go-name": "Created"
  10299. },
  10300. "time": {
  10301. "description": "time in seconds",
  10302. "type": "integer",
  10303. "format": "int64",
  10304. "x-go-name": "Time"
  10305. },
  10306. "user_name": {
  10307. "description": "User who spent the time (optional)",
  10308. "type": "string",
  10309. "x-go-name": "User"
  10310. }
  10311. },
  10312. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10313. },
  10314. "AnnotatedTag": {
  10315. "description": "AnnotatedTag represents an annotated tag",
  10316. "type": "object",
  10317. "properties": {
  10318. "message": {
  10319. "type": "string",
  10320. "x-go-name": "Message"
  10321. },
  10322. "object": {
  10323. "$ref": "#/definitions/AnnotatedTagObject"
  10324. },
  10325. "sha": {
  10326. "type": "string",
  10327. "x-go-name": "SHA"
  10328. },
  10329. "tag": {
  10330. "type": "string",
  10331. "x-go-name": "Tag"
  10332. },
  10333. "tagger": {
  10334. "$ref": "#/definitions/CommitUser"
  10335. },
  10336. "url": {
  10337. "type": "string",
  10338. "x-go-name": "URL"
  10339. },
  10340. "verification": {
  10341. "$ref": "#/definitions/PayloadCommitVerification"
  10342. }
  10343. },
  10344. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10345. },
  10346. "AnnotatedTagObject": {
  10347. "description": "AnnotatedTagObject contains meta information of the tag object",
  10348. "type": "object",
  10349. "properties": {
  10350. "sha": {
  10351. "type": "string",
  10352. "x-go-name": "SHA"
  10353. },
  10354. "type": {
  10355. "type": "string",
  10356. "x-go-name": "Type"
  10357. },
  10358. "url": {
  10359. "type": "string",
  10360. "x-go-name": "URL"
  10361. }
  10362. },
  10363. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10364. },
  10365. "Attachment": {
  10366. "description": "Attachment a generic attachment",
  10367. "type": "object",
  10368. "properties": {
  10369. "browser_download_url": {
  10370. "type": "string",
  10371. "x-go-name": "DownloadURL"
  10372. },
  10373. "created_at": {
  10374. "type": "string",
  10375. "format": "date-time",
  10376. "x-go-name": "Created"
  10377. },
  10378. "download_count": {
  10379. "type": "integer",
  10380. "format": "int64",
  10381. "x-go-name": "DownloadCount"
  10382. },
  10383. "id": {
  10384. "type": "integer",
  10385. "format": "int64",
  10386. "x-go-name": "ID"
  10387. },
  10388. "name": {
  10389. "type": "string",
  10390. "x-go-name": "Name"
  10391. },
  10392. "size": {
  10393. "type": "integer",
  10394. "format": "int64",
  10395. "x-go-name": "Size"
  10396. },
  10397. "uuid": {
  10398. "type": "string",
  10399. "x-go-name": "UUID"
  10400. }
  10401. },
  10402. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10403. },
  10404. "Branch": {
  10405. "description": "Branch represents a repository branch",
  10406. "type": "object",
  10407. "properties": {
  10408. "commit": {
  10409. "$ref": "#/definitions/PayloadCommit"
  10410. },
  10411. "effective_branch_protection_name": {
  10412. "type": "string",
  10413. "x-go-name": "EffectiveBranchProtectionName"
  10414. },
  10415. "enable_status_check": {
  10416. "type": "boolean",
  10417. "x-go-name": "EnableStatusCheck"
  10418. },
  10419. "name": {
  10420. "type": "string",
  10421. "x-go-name": "Name"
  10422. },
  10423. "protected": {
  10424. "type": "boolean",
  10425. "x-go-name": "Protected"
  10426. },
  10427. "required_approvals": {
  10428. "type": "integer",
  10429. "format": "int64",
  10430. "x-go-name": "RequiredApprovals"
  10431. },
  10432. "status_check_contexts": {
  10433. "type": "array",
  10434. "items": {
  10435. "type": "string"
  10436. },
  10437. "x-go-name": "StatusCheckContexts"
  10438. },
  10439. "user_can_merge": {
  10440. "type": "boolean",
  10441. "x-go-name": "UserCanMerge"
  10442. },
  10443. "user_can_push": {
  10444. "type": "boolean",
  10445. "x-go-name": "UserCanPush"
  10446. }
  10447. },
  10448. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10449. },
  10450. "BranchProtection": {
  10451. "description": "BranchProtection represents a branch protection for a repository",
  10452. "type": "object",
  10453. "properties": {
  10454. "approvals_whitelist_teams": {
  10455. "type": "array",
  10456. "items": {
  10457. "type": "string"
  10458. },
  10459. "x-go-name": "ApprovalsWhitelistTeams"
  10460. },
  10461. "approvals_whitelist_username": {
  10462. "type": "array",
  10463. "items": {
  10464. "type": "string"
  10465. },
  10466. "x-go-name": "ApprovalsWhitelistUsernames"
  10467. },
  10468. "block_on_outdated_branch": {
  10469. "type": "boolean",
  10470. "x-go-name": "BlockOnOutdatedBranch"
  10471. },
  10472. "block_on_rejected_reviews": {
  10473. "type": "boolean",
  10474. "x-go-name": "BlockOnRejectedReviews"
  10475. },
  10476. "branch_name": {
  10477. "type": "string",
  10478. "x-go-name": "BranchName"
  10479. },
  10480. "created_at": {
  10481. "type": "string",
  10482. "format": "date-time",
  10483. "x-go-name": "Created"
  10484. },
  10485. "dismiss_stale_approvals": {
  10486. "type": "boolean",
  10487. "x-go-name": "DismissStaleApprovals"
  10488. },
  10489. "enable_approvals_whitelist": {
  10490. "type": "boolean",
  10491. "x-go-name": "EnableApprovalsWhitelist"
  10492. },
  10493. "enable_merge_whitelist": {
  10494. "type": "boolean",
  10495. "x-go-name": "EnableMergeWhitelist"
  10496. },
  10497. "enable_push": {
  10498. "type": "boolean",
  10499. "x-go-name": "EnablePush"
  10500. },
  10501. "enable_push_whitelist": {
  10502. "type": "boolean",
  10503. "x-go-name": "EnablePushWhitelist"
  10504. },
  10505. "enable_status_check": {
  10506. "type": "boolean",
  10507. "x-go-name": "EnableStatusCheck"
  10508. },
  10509. "merge_whitelist_teams": {
  10510. "type": "array",
  10511. "items": {
  10512. "type": "string"
  10513. },
  10514. "x-go-name": "MergeWhitelistTeams"
  10515. },
  10516. "merge_whitelist_usernames": {
  10517. "type": "array",
  10518. "items": {
  10519. "type": "string"
  10520. },
  10521. "x-go-name": "MergeWhitelistUsernames"
  10522. },
  10523. "protected_file_patterns": {
  10524. "type": "string",
  10525. "x-go-name": "ProtectedFilePatterns"
  10526. },
  10527. "push_whitelist_deploy_keys": {
  10528. "type": "boolean",
  10529. "x-go-name": "PushWhitelistDeployKeys"
  10530. },
  10531. "push_whitelist_teams": {
  10532. "type": "array",
  10533. "items": {
  10534. "type": "string"
  10535. },
  10536. "x-go-name": "PushWhitelistTeams"
  10537. },
  10538. "push_whitelist_usernames": {
  10539. "type": "array",
  10540. "items": {
  10541. "type": "string"
  10542. },
  10543. "x-go-name": "PushWhitelistUsernames"
  10544. },
  10545. "require_signed_commits": {
  10546. "type": "boolean",
  10547. "x-go-name": "RequireSignedCommits"
  10548. },
  10549. "required_approvals": {
  10550. "type": "integer",
  10551. "format": "int64",
  10552. "x-go-name": "RequiredApprovals"
  10553. },
  10554. "status_check_contexts": {
  10555. "type": "array",
  10556. "items": {
  10557. "type": "string"
  10558. },
  10559. "x-go-name": "StatusCheckContexts"
  10560. },
  10561. "updated_at": {
  10562. "type": "string",
  10563. "format": "date-time",
  10564. "x-go-name": "Updated"
  10565. }
  10566. },
  10567. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10568. },
  10569. "Comment": {
  10570. "description": "Comment represents a comment on a commit or issue",
  10571. "type": "object",
  10572. "properties": {
  10573. "body": {
  10574. "type": "string",
  10575. "x-go-name": "Body"
  10576. },
  10577. "created_at": {
  10578. "type": "string",
  10579. "format": "date-time",
  10580. "x-go-name": "Created"
  10581. },
  10582. "html_url": {
  10583. "type": "string",
  10584. "x-go-name": "HTMLURL"
  10585. },
  10586. "id": {
  10587. "type": "integer",
  10588. "format": "int64",
  10589. "x-go-name": "ID"
  10590. },
  10591. "issue_url": {
  10592. "type": "string",
  10593. "x-go-name": "IssueURL"
  10594. },
  10595. "original_author": {
  10596. "type": "string",
  10597. "x-go-name": "OriginalAuthor"
  10598. },
  10599. "original_author_id": {
  10600. "type": "integer",
  10601. "format": "int64",
  10602. "x-go-name": "OriginalAuthorID"
  10603. },
  10604. "pull_request_url": {
  10605. "type": "string",
  10606. "x-go-name": "PRURL"
  10607. },
  10608. "updated_at": {
  10609. "type": "string",
  10610. "format": "date-time",
  10611. "x-go-name": "Updated"
  10612. },
  10613. "user": {
  10614. "$ref": "#/definitions/User"
  10615. }
  10616. },
  10617. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10618. },
  10619. "Commit": {
  10620. "type": "object",
  10621. "title": "Commit contains information generated from a Git commit.",
  10622. "properties": {
  10623. "author": {
  10624. "$ref": "#/definitions/User"
  10625. },
  10626. "commit": {
  10627. "$ref": "#/definitions/RepoCommit"
  10628. },
  10629. "committer": {
  10630. "$ref": "#/definitions/User"
  10631. },
  10632. "html_url": {
  10633. "type": "string",
  10634. "x-go-name": "HTMLURL"
  10635. },
  10636. "parents": {
  10637. "type": "array",
  10638. "items": {
  10639. "$ref": "#/definitions/CommitMeta"
  10640. },
  10641. "x-go-name": "Parents"
  10642. },
  10643. "sha": {
  10644. "type": "string",
  10645. "x-go-name": "SHA"
  10646. },
  10647. "url": {
  10648. "type": "string",
  10649. "x-go-name": "URL"
  10650. }
  10651. },
  10652. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10653. },
  10654. "CommitDateOptions": {
  10655. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  10656. "type": "object",
  10657. "properties": {
  10658. "author": {
  10659. "type": "string",
  10660. "format": "date-time",
  10661. "x-go-name": "Author"
  10662. },
  10663. "committer": {
  10664. "type": "string",
  10665. "format": "date-time",
  10666. "x-go-name": "Committer"
  10667. }
  10668. },
  10669. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10670. },
  10671. "CommitMeta": {
  10672. "type": "object",
  10673. "title": "CommitMeta contains meta information of a commit in terms of API.",
  10674. "properties": {
  10675. "sha": {
  10676. "type": "string",
  10677. "x-go-name": "SHA"
  10678. },
  10679. "url": {
  10680. "type": "string",
  10681. "x-go-name": "URL"
  10682. }
  10683. },
  10684. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10685. },
  10686. "CommitUser": {
  10687. "type": "object",
  10688. "title": "CommitUser contains information of a user in the context of a commit.",
  10689. "properties": {
  10690. "date": {
  10691. "type": "string",
  10692. "x-go-name": "Date"
  10693. },
  10694. "email": {
  10695. "type": "string",
  10696. "format": "email",
  10697. "x-go-name": "Email"
  10698. },
  10699. "name": {
  10700. "type": "string",
  10701. "x-go-name": "Name"
  10702. }
  10703. },
  10704. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10705. },
  10706. "ContentsResponse": {
  10707. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  10708. "type": "object",
  10709. "properties": {
  10710. "_links": {
  10711. "$ref": "#/definitions/FileLinksResponse"
  10712. },
  10713. "content": {
  10714. "description": "`content` is populated when `type` is `file`, otherwise null",
  10715. "type": "string",
  10716. "x-go-name": "Content"
  10717. },
  10718. "download_url": {
  10719. "type": "string",
  10720. "x-go-name": "DownloadURL"
  10721. },
  10722. "encoding": {
  10723. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  10724. "type": "string",
  10725. "x-go-name": "Encoding"
  10726. },
  10727. "git_url": {
  10728. "type": "string",
  10729. "x-go-name": "GitURL"
  10730. },
  10731. "html_url": {
  10732. "type": "string",
  10733. "x-go-name": "HTMLURL"
  10734. },
  10735. "name": {
  10736. "type": "string",
  10737. "x-go-name": "Name"
  10738. },
  10739. "path": {
  10740. "type": "string",
  10741. "x-go-name": "Path"
  10742. },
  10743. "sha": {
  10744. "type": "string",
  10745. "x-go-name": "SHA"
  10746. },
  10747. "size": {
  10748. "type": "integer",
  10749. "format": "int64",
  10750. "x-go-name": "Size"
  10751. },
  10752. "submodule_git_url": {
  10753. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  10754. "type": "string",
  10755. "x-go-name": "SubmoduleGitURL"
  10756. },
  10757. "target": {
  10758. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  10759. "type": "string",
  10760. "x-go-name": "Target"
  10761. },
  10762. "type": {
  10763. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  10764. "type": "string",
  10765. "x-go-name": "Type"
  10766. },
  10767. "url": {
  10768. "type": "string",
  10769. "x-go-name": "URL"
  10770. }
  10771. },
  10772. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10773. },
  10774. "CreateBranchProtectionOption": {
  10775. "description": "CreateBranchProtectionOption options for creating a branch protection",
  10776. "type": "object",
  10777. "properties": {
  10778. "approvals_whitelist_teams": {
  10779. "type": "array",
  10780. "items": {
  10781. "type": "string"
  10782. },
  10783. "x-go-name": "ApprovalsWhitelistTeams"
  10784. },
  10785. "approvals_whitelist_username": {
  10786. "type": "array",
  10787. "items": {
  10788. "type": "string"
  10789. },
  10790. "x-go-name": "ApprovalsWhitelistUsernames"
  10791. },
  10792. "block_on_outdated_branch": {
  10793. "type": "boolean",
  10794. "x-go-name": "BlockOnOutdatedBranch"
  10795. },
  10796. "block_on_rejected_reviews": {
  10797. "type": "boolean",
  10798. "x-go-name": "BlockOnRejectedReviews"
  10799. },
  10800. "branch_name": {
  10801. "type": "string",
  10802. "x-go-name": "BranchName"
  10803. },
  10804. "dismiss_stale_approvals": {
  10805. "type": "boolean",
  10806. "x-go-name": "DismissStaleApprovals"
  10807. },
  10808. "enable_approvals_whitelist": {
  10809. "type": "boolean",
  10810. "x-go-name": "EnableApprovalsWhitelist"
  10811. },
  10812. "enable_merge_whitelist": {
  10813. "type": "boolean",
  10814. "x-go-name": "EnableMergeWhitelist"
  10815. },
  10816. "enable_push": {
  10817. "type": "boolean",
  10818. "x-go-name": "EnablePush"
  10819. },
  10820. "enable_push_whitelist": {
  10821. "type": "boolean",
  10822. "x-go-name": "EnablePushWhitelist"
  10823. },
  10824. "enable_status_check": {
  10825. "type": "boolean",
  10826. "x-go-name": "EnableStatusCheck"
  10827. },
  10828. "merge_whitelist_teams": {
  10829. "type": "array",
  10830. "items": {
  10831. "type": "string"
  10832. },
  10833. "x-go-name": "MergeWhitelistTeams"
  10834. },
  10835. "merge_whitelist_usernames": {
  10836. "type": "array",
  10837. "items": {
  10838. "type": "string"
  10839. },
  10840. "x-go-name": "MergeWhitelistUsernames"
  10841. },
  10842. "protected_file_patterns": {
  10843. "type": "string",
  10844. "x-go-name": "ProtectedFilePatterns"
  10845. },
  10846. "push_whitelist_deploy_keys": {
  10847. "type": "boolean",
  10848. "x-go-name": "PushWhitelistDeployKeys"
  10849. },
  10850. "push_whitelist_teams": {
  10851. "type": "array",
  10852. "items": {
  10853. "type": "string"
  10854. },
  10855. "x-go-name": "PushWhitelistTeams"
  10856. },
  10857. "push_whitelist_usernames": {
  10858. "type": "array",
  10859. "items": {
  10860. "type": "string"
  10861. },
  10862. "x-go-name": "PushWhitelistUsernames"
  10863. },
  10864. "require_signed_commits": {
  10865. "type": "boolean",
  10866. "x-go-name": "RequireSignedCommits"
  10867. },
  10868. "required_approvals": {
  10869. "type": "integer",
  10870. "format": "int64",
  10871. "x-go-name": "RequiredApprovals"
  10872. },
  10873. "status_check_contexts": {
  10874. "type": "array",
  10875. "items": {
  10876. "type": "string"
  10877. },
  10878. "x-go-name": "StatusCheckContexts"
  10879. }
  10880. },
  10881. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10882. },
  10883. "CreateEmailOption": {
  10884. "description": "CreateEmailOption options when creating email addresses",
  10885. "type": "object",
  10886. "properties": {
  10887. "emails": {
  10888. "description": "email addresses to add",
  10889. "type": "array",
  10890. "items": {
  10891. "type": "string"
  10892. },
  10893. "x-go-name": "Emails"
  10894. }
  10895. },
  10896. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10897. },
  10898. "CreateFileOptions": {
  10899. "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)",
  10900. "type": "object",
  10901. "required": [
  10902. "content"
  10903. ],
  10904. "properties": {
  10905. "author": {
  10906. "$ref": "#/definitions/Identity"
  10907. },
  10908. "branch": {
  10909. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10910. "type": "string",
  10911. "x-go-name": "BranchName"
  10912. },
  10913. "committer": {
  10914. "$ref": "#/definitions/Identity"
  10915. },
  10916. "content": {
  10917. "description": "content must be base64 encoded",
  10918. "type": "string",
  10919. "x-go-name": "Content"
  10920. },
  10921. "dates": {
  10922. "$ref": "#/definitions/CommitDateOptions"
  10923. },
  10924. "message": {
  10925. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10926. "type": "string",
  10927. "x-go-name": "Message"
  10928. },
  10929. "new_branch": {
  10930. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10931. "type": "string",
  10932. "x-go-name": "NewBranchName"
  10933. }
  10934. },
  10935. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10936. },
  10937. "CreateForkOption": {
  10938. "description": "CreateForkOption options for creating a fork",
  10939. "type": "object",
  10940. "properties": {
  10941. "organization": {
  10942. "description": "organization name, if forking into an organization",
  10943. "type": "string",
  10944. "x-go-name": "Organization"
  10945. }
  10946. },
  10947. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10948. },
  10949. "CreateGPGKeyOption": {
  10950. "description": "CreateGPGKeyOption options create user GPG key",
  10951. "type": "object",
  10952. "required": [
  10953. "armored_public_key"
  10954. ],
  10955. "properties": {
  10956. "armored_public_key": {
  10957. "description": "An armored GPG key to add",
  10958. "type": "string",
  10959. "uniqueItems": true,
  10960. "x-go-name": "ArmoredKey"
  10961. }
  10962. },
  10963. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10964. },
  10965. "CreateHookOption": {
  10966. "description": "CreateHookOption options when create a hook",
  10967. "type": "object",
  10968. "required": [
  10969. "type",
  10970. "config"
  10971. ],
  10972. "properties": {
  10973. "active": {
  10974. "type": "boolean",
  10975. "default": false,
  10976. "x-go-name": "Active"
  10977. },
  10978. "branch_filter": {
  10979. "type": "string",
  10980. "x-go-name": "BranchFilter"
  10981. },
  10982. "config": {
  10983. "$ref": "#/definitions/CreateHookOptionConfig"
  10984. },
  10985. "events": {
  10986. "type": "array",
  10987. "items": {
  10988. "type": "string"
  10989. },
  10990. "x-go-name": "Events"
  10991. },
  10992. "type": {
  10993. "type": "string",
  10994. "enum": [
  10995. "dingtalk",
  10996. "discord",
  10997. "gitea",
  10998. "gogs",
  10999. "msteams",
  11000. "slack",
  11001. "telegram",
  11002. "feishu"
  11003. ],
  11004. "x-go-name": "Type"
  11005. }
  11006. },
  11007. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11008. },
  11009. "CreateHookOptionConfig": {
  11010. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  11011. "type": "object",
  11012. "additionalProperties": {
  11013. "type": "string"
  11014. },
  11015. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11016. },
  11017. "CreateIssueCommentOption": {
  11018. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  11019. "type": "object",
  11020. "required": [
  11021. "body"
  11022. ],
  11023. "properties": {
  11024. "body": {
  11025. "type": "string",
  11026. "x-go-name": "Body"
  11027. }
  11028. },
  11029. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11030. },
  11031. "CreateIssueOption": {
  11032. "description": "CreateIssueOption options to create one issue",
  11033. "type": "object",
  11034. "required": [
  11035. "title"
  11036. ],
  11037. "properties": {
  11038. "assignee": {
  11039. "description": "username of assignee",
  11040. "type": "string",
  11041. "x-go-name": "Assignee"
  11042. },
  11043. "assignees": {
  11044. "type": "array",
  11045. "items": {
  11046. "type": "string"
  11047. },
  11048. "x-go-name": "Assignees"
  11049. },
  11050. "body": {
  11051. "type": "string",
  11052. "x-go-name": "Body"
  11053. },
  11054. "closed": {
  11055. "type": "boolean",
  11056. "x-go-name": "Closed"
  11057. },
  11058. "due_date": {
  11059. "type": "string",
  11060. "format": "date-time",
  11061. "x-go-name": "Deadline"
  11062. },
  11063. "labels": {
  11064. "description": "list of label ids",
  11065. "type": "array",
  11066. "items": {
  11067. "type": "integer",
  11068. "format": "int64"
  11069. },
  11070. "x-go-name": "Labels"
  11071. },
  11072. "milestone": {
  11073. "description": "milestone id",
  11074. "type": "integer",
  11075. "format": "int64",
  11076. "x-go-name": "Milestone"
  11077. },
  11078. "title": {
  11079. "type": "string",
  11080. "x-go-name": "Title"
  11081. }
  11082. },
  11083. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11084. },
  11085. "CreateKeyOption": {
  11086. "description": "CreateKeyOption options when creating a key",
  11087. "type": "object",
  11088. "required": [
  11089. "title",
  11090. "key"
  11091. ],
  11092. "properties": {
  11093. "key": {
  11094. "description": "An armored SSH key to add",
  11095. "type": "string",
  11096. "uniqueItems": true,
  11097. "x-go-name": "Key"
  11098. },
  11099. "read_only": {
  11100. "description": "Describe if the key has only read access or read/write",
  11101. "type": "boolean",
  11102. "x-go-name": "ReadOnly"
  11103. },
  11104. "title": {
  11105. "description": "Title of the key to add",
  11106. "type": "string",
  11107. "uniqueItems": true,
  11108. "x-go-name": "Title"
  11109. }
  11110. },
  11111. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11112. },
  11113. "CreateLabelOption": {
  11114. "description": "CreateLabelOption options for creating a label",
  11115. "type": "object",
  11116. "required": [
  11117. "name",
  11118. "color"
  11119. ],
  11120. "properties": {
  11121. "color": {
  11122. "type": "string",
  11123. "x-go-name": "Color",
  11124. "example": "#00aabb"
  11125. },
  11126. "description": {
  11127. "type": "string",
  11128. "x-go-name": "Description"
  11129. },
  11130. "name": {
  11131. "type": "string",
  11132. "x-go-name": "Name"
  11133. }
  11134. },
  11135. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11136. },
  11137. "CreateMilestoneOption": {
  11138. "description": "CreateMilestoneOption options for creating a milestone",
  11139. "type": "object",
  11140. "properties": {
  11141. "description": {
  11142. "type": "string",
  11143. "x-go-name": "Description"
  11144. },
  11145. "due_on": {
  11146. "type": "string",
  11147. "format": "date-time",
  11148. "x-go-name": "Deadline"
  11149. },
  11150. "title": {
  11151. "type": "string",
  11152. "x-go-name": "Title"
  11153. }
  11154. },
  11155. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11156. },
  11157. "CreateOAuth2ApplicationOptions": {
  11158. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  11159. "type": "object",
  11160. "properties": {
  11161. "name": {
  11162. "type": "string",
  11163. "x-go-name": "Name"
  11164. },
  11165. "redirect_uris": {
  11166. "type": "array",
  11167. "items": {
  11168. "type": "string"
  11169. },
  11170. "x-go-name": "RedirectURIs"
  11171. }
  11172. },
  11173. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11174. },
  11175. "CreateOrgOption": {
  11176. "description": "CreateOrgOption options for creating an organization",
  11177. "type": "object",
  11178. "required": [
  11179. "username"
  11180. ],
  11181. "properties": {
  11182. "description": {
  11183. "type": "string",
  11184. "x-go-name": "Description"
  11185. },
  11186. "full_name": {
  11187. "type": "string",
  11188. "x-go-name": "FullName"
  11189. },
  11190. "location": {
  11191. "type": "string",
  11192. "x-go-name": "Location"
  11193. },
  11194. "repo_admin_change_team_access": {
  11195. "type": "boolean",
  11196. "x-go-name": "RepoAdminChangeTeamAccess"
  11197. },
  11198. "username": {
  11199. "type": "string",
  11200. "x-go-name": "UserName"
  11201. },
  11202. "visibility": {
  11203. "description": "possible values are `public` (default), `limited` or `private`",
  11204. "type": "string",
  11205. "enum": [
  11206. "public",
  11207. "limited",
  11208. "private"
  11209. ],
  11210. "x-go-name": "Visibility"
  11211. },
  11212. "website": {
  11213. "type": "string",
  11214. "x-go-name": "Website"
  11215. }
  11216. },
  11217. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11218. },
  11219. "CreatePullRequestOption": {
  11220. "description": "CreatePullRequestOption options when creating a pull request",
  11221. "type": "object",
  11222. "properties": {
  11223. "assignee": {
  11224. "type": "string",
  11225. "x-go-name": "Assignee"
  11226. },
  11227. "assignees": {
  11228. "type": "array",
  11229. "items": {
  11230. "type": "string"
  11231. },
  11232. "x-go-name": "Assignees"
  11233. },
  11234. "base": {
  11235. "type": "string",
  11236. "x-go-name": "Base"
  11237. },
  11238. "body": {
  11239. "type": "string",
  11240. "x-go-name": "Body"
  11241. },
  11242. "due_date": {
  11243. "type": "string",
  11244. "format": "date-time",
  11245. "x-go-name": "Deadline"
  11246. },
  11247. "head": {
  11248. "type": "string",
  11249. "x-go-name": "Head"
  11250. },
  11251. "labels": {
  11252. "type": "array",
  11253. "items": {
  11254. "type": "integer",
  11255. "format": "int64"
  11256. },
  11257. "x-go-name": "Labels"
  11258. },
  11259. "milestone": {
  11260. "type": "integer",
  11261. "format": "int64",
  11262. "x-go-name": "Milestone"
  11263. },
  11264. "title": {
  11265. "type": "string",
  11266. "x-go-name": "Title"
  11267. }
  11268. },
  11269. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11270. },
  11271. "CreatePullReviewComment": {
  11272. "description": "CreatePullReviewComment represent a review comment for creation api",
  11273. "type": "object",
  11274. "properties": {
  11275. "body": {
  11276. "type": "string",
  11277. "x-go-name": "Body"
  11278. },
  11279. "new_position": {
  11280. "description": "if comment to new file line or 0",
  11281. "type": "integer",
  11282. "format": "int64",
  11283. "x-go-name": "NewLineNum"
  11284. },
  11285. "old_position": {
  11286. "description": "if comment to old file line or 0",
  11287. "type": "integer",
  11288. "format": "int64",
  11289. "x-go-name": "OldLineNum"
  11290. },
  11291. "path": {
  11292. "description": "the tree path",
  11293. "type": "string",
  11294. "x-go-name": "Path"
  11295. }
  11296. },
  11297. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11298. },
  11299. "CreatePullReviewOptions": {
  11300. "description": "CreatePullReviewOptions are options to create a pull review",
  11301. "type": "object",
  11302. "properties": {
  11303. "body": {
  11304. "type": "string",
  11305. "x-go-name": "Body"
  11306. },
  11307. "comments": {
  11308. "type": "array",
  11309. "items": {
  11310. "$ref": "#/definitions/CreatePullReviewComment"
  11311. },
  11312. "x-go-name": "Comments"
  11313. },
  11314. "commit_id": {
  11315. "type": "string",
  11316. "x-go-name": "CommitID"
  11317. },
  11318. "event": {
  11319. "$ref": "#/definitions/ReviewStateType"
  11320. }
  11321. },
  11322. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11323. },
  11324. "CreateReleaseOption": {
  11325. "description": "CreateReleaseOption options when creating a release",
  11326. "type": "object",
  11327. "required": [
  11328. "tag_name"
  11329. ],
  11330. "properties": {
  11331. "body": {
  11332. "type": "string",
  11333. "x-go-name": "Note"
  11334. },
  11335. "draft": {
  11336. "type": "boolean",
  11337. "x-go-name": "IsDraft"
  11338. },
  11339. "name": {
  11340. "type": "string",
  11341. "x-go-name": "Title"
  11342. },
  11343. "prerelease": {
  11344. "type": "boolean",
  11345. "x-go-name": "IsPrerelease"
  11346. },
  11347. "tag_name": {
  11348. "type": "string",
  11349. "x-go-name": "TagName"
  11350. },
  11351. "target_commitish": {
  11352. "type": "string",
  11353. "x-go-name": "Target"
  11354. }
  11355. },
  11356. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11357. },
  11358. "CreateRepoOption": {
  11359. "description": "CreateRepoOption options when creating repository",
  11360. "type": "object",
  11361. "required": [
  11362. "name"
  11363. ],
  11364. "properties": {
  11365. "auto_init": {
  11366. "description": "Whether the repository should be auto-intialized?",
  11367. "type": "boolean",
  11368. "x-go-name": "AutoInit"
  11369. },
  11370. "default_branch": {
  11371. "description": "DefaultBranch of the repository (used when initializes and in template)",
  11372. "type": "string",
  11373. "x-go-name": "DefaultBranch"
  11374. },
  11375. "description": {
  11376. "description": "Description of the repository to create",
  11377. "type": "string",
  11378. "x-go-name": "Description"
  11379. },
  11380. "gitignores": {
  11381. "description": "Gitignores to use",
  11382. "type": "string",
  11383. "x-go-name": "Gitignores"
  11384. },
  11385. "issue_labels": {
  11386. "description": "Issue Label set to use",
  11387. "type": "string",
  11388. "x-go-name": "IssueLabels"
  11389. },
  11390. "license": {
  11391. "description": "License to use",
  11392. "type": "string",
  11393. "x-go-name": "License"
  11394. },
  11395. "name": {
  11396. "description": "Name of the repository to create",
  11397. "type": "string",
  11398. "uniqueItems": true,
  11399. "x-go-name": "Name"
  11400. },
  11401. "private": {
  11402. "description": "Whether the repository is private",
  11403. "type": "boolean",
  11404. "x-go-name": "Private"
  11405. },
  11406. "readme": {
  11407. "description": "Readme of the repository to create",
  11408. "type": "string",
  11409. "x-go-name": "Readme"
  11410. }
  11411. },
  11412. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11413. },
  11414. "CreateStatusOption": {
  11415. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  11416. "type": "object",
  11417. "properties": {
  11418. "context": {
  11419. "type": "string",
  11420. "x-go-name": "Context"
  11421. },
  11422. "description": {
  11423. "type": "string",
  11424. "x-go-name": "Description"
  11425. },
  11426. "state": {
  11427. "$ref": "#/definitions/StatusState"
  11428. },
  11429. "target_url": {
  11430. "type": "string",
  11431. "x-go-name": "TargetURL"
  11432. }
  11433. },
  11434. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11435. },
  11436. "CreateTeamOption": {
  11437. "description": "CreateTeamOption options for creating a team",
  11438. "type": "object",
  11439. "required": [
  11440. "name"
  11441. ],
  11442. "properties": {
  11443. "can_create_org_repo": {
  11444. "type": "boolean",
  11445. "x-go-name": "CanCreateOrgRepo"
  11446. },
  11447. "description": {
  11448. "type": "string",
  11449. "x-go-name": "Description"
  11450. },
  11451. "includes_all_repositories": {
  11452. "type": "boolean",
  11453. "x-go-name": "IncludesAllRepositories"
  11454. },
  11455. "name": {
  11456. "type": "string",
  11457. "x-go-name": "Name"
  11458. },
  11459. "permission": {
  11460. "type": "string",
  11461. "enum": [
  11462. "read",
  11463. "write",
  11464. "admin"
  11465. ],
  11466. "x-go-name": "Permission"
  11467. },
  11468. "units": {
  11469. "type": "array",
  11470. "items": {
  11471. "type": "string"
  11472. },
  11473. "x-go-name": "Units",
  11474. "example": [
  11475. "repo.code",
  11476. "repo.issues",
  11477. "repo.ext_issues",
  11478. "repo.wiki",
  11479. "repo.pulls",
  11480. "repo.releases",
  11481. "repo.ext_wiki"
  11482. ]
  11483. }
  11484. },
  11485. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11486. },
  11487. "CreateUserOption": {
  11488. "description": "CreateUserOption create user options",
  11489. "type": "object",
  11490. "required": [
  11491. "username",
  11492. "email",
  11493. "password"
  11494. ],
  11495. "properties": {
  11496. "email": {
  11497. "type": "string",
  11498. "format": "email",
  11499. "x-go-name": "Email"
  11500. },
  11501. "full_name": {
  11502. "type": "string",
  11503. "x-go-name": "FullName"
  11504. },
  11505. "login_name": {
  11506. "type": "string",
  11507. "x-go-name": "LoginName"
  11508. },
  11509. "must_change_password": {
  11510. "type": "boolean",
  11511. "x-go-name": "MustChangePassword"
  11512. },
  11513. "password": {
  11514. "type": "string",
  11515. "x-go-name": "Password"
  11516. },
  11517. "send_notify": {
  11518. "type": "boolean",
  11519. "x-go-name": "SendNotify"
  11520. },
  11521. "source_id": {
  11522. "type": "integer",
  11523. "format": "int64",
  11524. "x-go-name": "SourceID"
  11525. },
  11526. "username": {
  11527. "type": "string",
  11528. "x-go-name": "Username"
  11529. }
  11530. },
  11531. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11532. },
  11533. "DeleteEmailOption": {
  11534. "description": "DeleteEmailOption options when deleting email addresses",
  11535. "type": "object",
  11536. "properties": {
  11537. "emails": {
  11538. "description": "email addresses to delete",
  11539. "type": "array",
  11540. "items": {
  11541. "type": "string"
  11542. },
  11543. "x-go-name": "Emails"
  11544. }
  11545. },
  11546. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11547. },
  11548. "DeleteFileOptions": {
  11549. "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)",
  11550. "type": "object",
  11551. "required": [
  11552. "sha"
  11553. ],
  11554. "properties": {
  11555. "author": {
  11556. "$ref": "#/definitions/Identity"
  11557. },
  11558. "branch": {
  11559. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  11560. "type": "string",
  11561. "x-go-name": "BranchName"
  11562. },
  11563. "committer": {
  11564. "$ref": "#/definitions/Identity"
  11565. },
  11566. "dates": {
  11567. "$ref": "#/definitions/CommitDateOptions"
  11568. },
  11569. "message": {
  11570. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  11571. "type": "string",
  11572. "x-go-name": "Message"
  11573. },
  11574. "new_branch": {
  11575. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  11576. "type": "string",
  11577. "x-go-name": "NewBranchName"
  11578. },
  11579. "sha": {
  11580. "description": "sha is the SHA for the file that already exists",
  11581. "type": "string",
  11582. "x-go-name": "SHA"
  11583. }
  11584. },
  11585. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11586. },
  11587. "DeployKey": {
  11588. "description": "DeployKey a deploy key",
  11589. "type": "object",
  11590. "properties": {
  11591. "created_at": {
  11592. "type": "string",
  11593. "format": "date-time",
  11594. "x-go-name": "Created"
  11595. },
  11596. "fingerprint": {
  11597. "type": "string",
  11598. "x-go-name": "Fingerprint"
  11599. },
  11600. "id": {
  11601. "type": "integer",
  11602. "format": "int64",
  11603. "x-go-name": "ID"
  11604. },
  11605. "key": {
  11606. "type": "string",
  11607. "x-go-name": "Key"
  11608. },
  11609. "key_id": {
  11610. "type": "integer",
  11611. "format": "int64",
  11612. "x-go-name": "KeyID"
  11613. },
  11614. "read_only": {
  11615. "type": "boolean",
  11616. "x-go-name": "ReadOnly"
  11617. },
  11618. "repository": {
  11619. "$ref": "#/definitions/Repository"
  11620. },
  11621. "title": {
  11622. "type": "string",
  11623. "x-go-name": "Title"
  11624. },
  11625. "url": {
  11626. "type": "string",
  11627. "x-go-name": "URL"
  11628. }
  11629. },
  11630. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11631. },
  11632. "EditAttachmentOptions": {
  11633. "description": "EditAttachmentOptions options for editing attachments",
  11634. "type": "object",
  11635. "properties": {
  11636. "name": {
  11637. "type": "string",
  11638. "x-go-name": "Name"
  11639. }
  11640. },
  11641. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11642. },
  11643. "EditBranchProtectionOption": {
  11644. "description": "EditBranchProtectionOption options for editing a branch protection",
  11645. "type": "object",
  11646. "properties": {
  11647. "approvals_whitelist_teams": {
  11648. "type": "array",
  11649. "items": {
  11650. "type": "string"
  11651. },
  11652. "x-go-name": "ApprovalsWhitelistTeams"
  11653. },
  11654. "approvals_whitelist_username": {
  11655. "type": "array",
  11656. "items": {
  11657. "type": "string"
  11658. },
  11659. "x-go-name": "ApprovalsWhitelistUsernames"
  11660. },
  11661. "block_on_outdated_branch": {
  11662. "type": "boolean",
  11663. "x-go-name": "BlockOnOutdatedBranch"
  11664. },
  11665. "block_on_rejected_reviews": {
  11666. "type": "boolean",
  11667. "x-go-name": "BlockOnRejectedReviews"
  11668. },
  11669. "dismiss_stale_approvals": {
  11670. "type": "boolean",
  11671. "x-go-name": "DismissStaleApprovals"
  11672. },
  11673. "enable_approvals_whitelist": {
  11674. "type": "boolean",
  11675. "x-go-name": "EnableApprovalsWhitelist"
  11676. },
  11677. "enable_merge_whitelist": {
  11678. "type": "boolean",
  11679. "x-go-name": "EnableMergeWhitelist"
  11680. },
  11681. "enable_push": {
  11682. "type": "boolean",
  11683. "x-go-name": "EnablePush"
  11684. },
  11685. "enable_push_whitelist": {
  11686. "type": "boolean",
  11687. "x-go-name": "EnablePushWhitelist"
  11688. },
  11689. "enable_status_check": {
  11690. "type": "boolean",
  11691. "x-go-name": "EnableStatusCheck"
  11692. },
  11693. "merge_whitelist_teams": {
  11694. "type": "array",
  11695. "items": {
  11696. "type": "string"
  11697. },
  11698. "x-go-name": "MergeWhitelistTeams"
  11699. },
  11700. "merge_whitelist_usernames": {
  11701. "type": "array",
  11702. "items": {
  11703. "type": "string"
  11704. },
  11705. "x-go-name": "MergeWhitelistUsernames"
  11706. },
  11707. "protected_file_patterns": {
  11708. "type": "string",
  11709. "x-go-name": "ProtectedFilePatterns"
  11710. },
  11711. "push_whitelist_deploy_keys": {
  11712. "type": "boolean",
  11713. "x-go-name": "PushWhitelistDeployKeys"
  11714. },
  11715. "push_whitelist_teams": {
  11716. "type": "array",
  11717. "items": {
  11718. "type": "string"
  11719. },
  11720. "x-go-name": "PushWhitelistTeams"
  11721. },
  11722. "push_whitelist_usernames": {
  11723. "type": "array",
  11724. "items": {
  11725. "type": "string"
  11726. },
  11727. "x-go-name": "PushWhitelistUsernames"
  11728. },
  11729. "require_signed_commits": {
  11730. "type": "boolean",
  11731. "x-go-name": "RequireSignedCommits"
  11732. },
  11733. "required_approvals": {
  11734. "type": "integer",
  11735. "format": "int64",
  11736. "x-go-name": "RequiredApprovals"
  11737. },
  11738. "status_check_contexts": {
  11739. "type": "array",
  11740. "items": {
  11741. "type": "string"
  11742. },
  11743. "x-go-name": "StatusCheckContexts"
  11744. }
  11745. },
  11746. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11747. },
  11748. "EditDeadlineOption": {
  11749. "description": "EditDeadlineOption options for creating a deadline",
  11750. "type": "object",
  11751. "required": [
  11752. "due_date"
  11753. ],
  11754. "properties": {
  11755. "due_date": {
  11756. "type": "string",
  11757. "format": "date-time",
  11758. "x-go-name": "Deadline"
  11759. }
  11760. },
  11761. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11762. },
  11763. "EditGitHookOption": {
  11764. "description": "EditGitHookOption options when modifying one Git hook",
  11765. "type": "object",
  11766. "properties": {
  11767. "content": {
  11768. "type": "string",
  11769. "x-go-name": "Content"
  11770. }
  11771. },
  11772. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11773. },
  11774. "EditHookOption": {
  11775. "description": "EditHookOption options when modify one hook",
  11776. "type": "object",
  11777. "properties": {
  11778. "active": {
  11779. "type": "boolean",
  11780. "x-go-name": "Active"
  11781. },
  11782. "branch_filter": {
  11783. "type": "string",
  11784. "x-go-name": "BranchFilter"
  11785. },
  11786. "config": {
  11787. "type": "object",
  11788. "additionalProperties": {
  11789. "type": "string"
  11790. },
  11791. "x-go-name": "Config"
  11792. },
  11793. "events": {
  11794. "type": "array",
  11795. "items": {
  11796. "type": "string"
  11797. },
  11798. "x-go-name": "Events"
  11799. }
  11800. },
  11801. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11802. },
  11803. "EditIssueCommentOption": {
  11804. "description": "EditIssueCommentOption options for editing a comment",
  11805. "type": "object",
  11806. "required": [
  11807. "body"
  11808. ],
  11809. "properties": {
  11810. "body": {
  11811. "type": "string",
  11812. "x-go-name": "Body"
  11813. }
  11814. },
  11815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11816. },
  11817. "EditIssueOption": {
  11818. "description": "EditIssueOption options for editing an issue",
  11819. "type": "object",
  11820. "properties": {
  11821. "assignee": {
  11822. "type": "string",
  11823. "x-go-name": "Assignee"
  11824. },
  11825. "assignees": {
  11826. "type": "array",
  11827. "items": {
  11828. "type": "string"
  11829. },
  11830. "x-go-name": "Assignees"
  11831. },
  11832. "body": {
  11833. "type": "string",
  11834. "x-go-name": "Body"
  11835. },
  11836. "due_date": {
  11837. "type": "string",
  11838. "format": "date-time",
  11839. "x-go-name": "Deadline"
  11840. },
  11841. "milestone": {
  11842. "type": "integer",
  11843. "format": "int64",
  11844. "x-go-name": "Milestone"
  11845. },
  11846. "state": {
  11847. "type": "string",
  11848. "x-go-name": "State"
  11849. },
  11850. "title": {
  11851. "type": "string",
  11852. "x-go-name": "Title"
  11853. },
  11854. "unset_due_date": {
  11855. "type": "boolean",
  11856. "x-go-name": "RemoveDeadline"
  11857. }
  11858. },
  11859. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11860. },
  11861. "EditLabelOption": {
  11862. "description": "EditLabelOption options for editing a label",
  11863. "type": "object",
  11864. "properties": {
  11865. "color": {
  11866. "type": "string",
  11867. "x-go-name": "Color"
  11868. },
  11869. "description": {
  11870. "type": "string",
  11871. "x-go-name": "Description"
  11872. },
  11873. "name": {
  11874. "type": "string",
  11875. "x-go-name": "Name"
  11876. }
  11877. },
  11878. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11879. },
  11880. "EditMilestoneOption": {
  11881. "description": "EditMilestoneOption options for editing a milestone",
  11882. "type": "object",
  11883. "properties": {
  11884. "description": {
  11885. "type": "string",
  11886. "x-go-name": "Description"
  11887. },
  11888. "due_on": {
  11889. "type": "string",
  11890. "format": "date-time",
  11891. "x-go-name": "Deadline"
  11892. },
  11893. "state": {
  11894. "type": "string",
  11895. "x-go-name": "State"
  11896. },
  11897. "title": {
  11898. "type": "string",
  11899. "x-go-name": "Title"
  11900. }
  11901. },
  11902. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11903. },
  11904. "EditOrgOption": {
  11905. "description": "EditOrgOption options for editing an organization",
  11906. "type": "object",
  11907. "properties": {
  11908. "description": {
  11909. "type": "string",
  11910. "x-go-name": "Description"
  11911. },
  11912. "full_name": {
  11913. "type": "string",
  11914. "x-go-name": "FullName"
  11915. },
  11916. "location": {
  11917. "type": "string",
  11918. "x-go-name": "Location"
  11919. },
  11920. "repo_admin_change_team_access": {
  11921. "type": "boolean",
  11922. "x-go-name": "RepoAdminChangeTeamAccess"
  11923. },
  11924. "visibility": {
  11925. "description": "possible values are `public`, `limited` or `private`",
  11926. "type": "string",
  11927. "enum": [
  11928. "public",
  11929. "limited",
  11930. "private"
  11931. ],
  11932. "x-go-name": "Visibility"
  11933. },
  11934. "website": {
  11935. "type": "string",
  11936. "x-go-name": "Website"
  11937. }
  11938. },
  11939. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11940. },
  11941. "EditPullRequestOption": {
  11942. "description": "EditPullRequestOption options when modify pull request",
  11943. "type": "object",
  11944. "properties": {
  11945. "assignee": {
  11946. "type": "string",
  11947. "x-go-name": "Assignee"
  11948. },
  11949. "assignees": {
  11950. "type": "array",
  11951. "items": {
  11952. "type": "string"
  11953. },
  11954. "x-go-name": "Assignees"
  11955. },
  11956. "body": {
  11957. "type": "string",
  11958. "x-go-name": "Body"
  11959. },
  11960. "due_date": {
  11961. "type": "string",
  11962. "format": "date-time",
  11963. "x-go-name": "Deadline"
  11964. },
  11965. "labels": {
  11966. "type": "array",
  11967. "items": {
  11968. "type": "integer",
  11969. "format": "int64"
  11970. },
  11971. "x-go-name": "Labels"
  11972. },
  11973. "milestone": {
  11974. "type": "integer",
  11975. "format": "int64",
  11976. "x-go-name": "Milestone"
  11977. },
  11978. "state": {
  11979. "type": "string",
  11980. "x-go-name": "State"
  11981. },
  11982. "title": {
  11983. "type": "string",
  11984. "x-go-name": "Title"
  11985. },
  11986. "unset_due_date": {
  11987. "type": "boolean",
  11988. "x-go-name": "RemoveDeadline"
  11989. }
  11990. },
  11991. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11992. },
  11993. "EditReactionOption": {
  11994. "description": "EditReactionOption contain the reaction type",
  11995. "type": "object",
  11996. "properties": {
  11997. "content": {
  11998. "type": "string",
  11999. "x-go-name": "Reaction"
  12000. }
  12001. },
  12002. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12003. },
  12004. "EditReleaseOption": {
  12005. "description": "EditReleaseOption options when editing a release",
  12006. "type": "object",
  12007. "properties": {
  12008. "body": {
  12009. "type": "string",
  12010. "x-go-name": "Note"
  12011. },
  12012. "draft": {
  12013. "type": "boolean",
  12014. "x-go-name": "IsDraft"
  12015. },
  12016. "name": {
  12017. "type": "string",
  12018. "x-go-name": "Title"
  12019. },
  12020. "prerelease": {
  12021. "type": "boolean",
  12022. "x-go-name": "IsPrerelease"
  12023. },
  12024. "tag_name": {
  12025. "type": "string",
  12026. "x-go-name": "TagName"
  12027. },
  12028. "target_commitish": {
  12029. "type": "string",
  12030. "x-go-name": "Target"
  12031. }
  12032. },
  12033. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12034. },
  12035. "EditRepoOption": {
  12036. "description": "EditRepoOption options when editing a repository's properties",
  12037. "type": "object",
  12038. "properties": {
  12039. "allow_merge_commits": {
  12040. "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`.",
  12041. "type": "boolean",
  12042. "x-go-name": "AllowMerge"
  12043. },
  12044. "allow_rebase": {
  12045. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  12046. "type": "boolean",
  12047. "x-go-name": "AllowRebase"
  12048. },
  12049. "allow_rebase_explicit": {
  12050. "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`.",
  12051. "type": "boolean",
  12052. "x-go-name": "AllowRebaseMerge"
  12053. },
  12054. "allow_squash_merge": {
  12055. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  12056. "type": "boolean",
  12057. "x-go-name": "AllowSquash"
  12058. },
  12059. "archived": {
  12060. "description": "set to `true` to archive this repository.",
  12061. "type": "boolean",
  12062. "x-go-name": "Archived"
  12063. },
  12064. "default_branch": {
  12065. "description": "sets the default branch for this repository.",
  12066. "type": "string",
  12067. "x-go-name": "DefaultBranch"
  12068. },
  12069. "description": {
  12070. "description": "a short description of the repository.",
  12071. "type": "string",
  12072. "x-go-name": "Description"
  12073. },
  12074. "external_tracker": {
  12075. "$ref": "#/definitions/ExternalTracker"
  12076. },
  12077. "external_wiki": {
  12078. "$ref": "#/definitions/ExternalWiki"
  12079. },
  12080. "has_issues": {
  12081. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  12082. "type": "boolean",
  12083. "x-go-name": "HasIssues"
  12084. },
  12085. "has_pull_requests": {
  12086. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  12087. "type": "boolean",
  12088. "x-go-name": "HasPullRequests"
  12089. },
  12090. "has_wiki": {
  12091. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  12092. "type": "boolean",
  12093. "x-go-name": "HasWiki"
  12094. },
  12095. "ignore_whitespace_conflicts": {
  12096. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  12097. "type": "boolean",
  12098. "x-go-name": "IgnoreWhitespaceConflicts"
  12099. },
  12100. "internal_tracker": {
  12101. "$ref": "#/definitions/InternalTracker"
  12102. },
  12103. "name": {
  12104. "description": "name of the repository",
  12105. "type": "string",
  12106. "uniqueItems": true,
  12107. "x-go-name": "Name"
  12108. },
  12109. "private": {
  12110. "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.",
  12111. "type": "boolean",
  12112. "x-go-name": "Private"
  12113. },
  12114. "template": {
  12115. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  12116. "type": "boolean",
  12117. "x-go-name": "Template"
  12118. },
  12119. "website": {
  12120. "description": "a URL with more information about the repository.",
  12121. "type": "string",
  12122. "x-go-name": "Website"
  12123. }
  12124. },
  12125. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12126. },
  12127. "EditTeamOption": {
  12128. "description": "EditTeamOption options for editing a team",
  12129. "type": "object",
  12130. "required": [
  12131. "name"
  12132. ],
  12133. "properties": {
  12134. "can_create_org_repo": {
  12135. "type": "boolean",
  12136. "x-go-name": "CanCreateOrgRepo"
  12137. },
  12138. "description": {
  12139. "type": "string",
  12140. "x-go-name": "Description"
  12141. },
  12142. "includes_all_repositories": {
  12143. "type": "boolean",
  12144. "x-go-name": "IncludesAllRepositories"
  12145. },
  12146. "name": {
  12147. "type": "string",
  12148. "x-go-name": "Name"
  12149. },
  12150. "permission": {
  12151. "type": "string",
  12152. "enum": [
  12153. "read",
  12154. "write",
  12155. "admin"
  12156. ],
  12157. "x-go-name": "Permission"
  12158. },
  12159. "units": {
  12160. "type": "array",
  12161. "items": {
  12162. "type": "string"
  12163. },
  12164. "x-go-name": "Units",
  12165. "example": [
  12166. "repo.code",
  12167. "repo.issues",
  12168. "repo.ext_issues",
  12169. "repo.wiki",
  12170. "repo.pulls",
  12171. "repo.releases",
  12172. "repo.ext_wiki"
  12173. ]
  12174. }
  12175. },
  12176. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12177. },
  12178. "EditUserOption": {
  12179. "description": "EditUserOption edit user options",
  12180. "type": "object",
  12181. "required": [
  12182. "email"
  12183. ],
  12184. "properties": {
  12185. "active": {
  12186. "type": "boolean",
  12187. "x-go-name": "Active"
  12188. },
  12189. "admin": {
  12190. "type": "boolean",
  12191. "x-go-name": "Admin"
  12192. },
  12193. "allow_create_organization": {
  12194. "type": "boolean",
  12195. "x-go-name": "AllowCreateOrganization"
  12196. },
  12197. "allow_git_hook": {
  12198. "type": "boolean",
  12199. "x-go-name": "AllowGitHook"
  12200. },
  12201. "allow_import_local": {
  12202. "type": "boolean",
  12203. "x-go-name": "AllowImportLocal"
  12204. },
  12205. "email": {
  12206. "type": "string",
  12207. "format": "email",
  12208. "x-go-name": "Email"
  12209. },
  12210. "full_name": {
  12211. "type": "string",
  12212. "x-go-name": "FullName"
  12213. },
  12214. "location": {
  12215. "type": "string",
  12216. "x-go-name": "Location"
  12217. },
  12218. "login_name": {
  12219. "type": "string",
  12220. "x-go-name": "LoginName"
  12221. },
  12222. "max_repo_creation": {
  12223. "type": "integer",
  12224. "format": "int64",
  12225. "x-go-name": "MaxRepoCreation"
  12226. },
  12227. "must_change_password": {
  12228. "type": "boolean",
  12229. "x-go-name": "MustChangePassword"
  12230. },
  12231. "password": {
  12232. "type": "string",
  12233. "x-go-name": "Password"
  12234. },
  12235. "prohibit_login": {
  12236. "type": "boolean",
  12237. "x-go-name": "ProhibitLogin"
  12238. },
  12239. "source_id": {
  12240. "type": "integer",
  12241. "format": "int64",
  12242. "x-go-name": "SourceID"
  12243. },
  12244. "website": {
  12245. "type": "string",
  12246. "x-go-name": "Website"
  12247. }
  12248. },
  12249. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12250. },
  12251. "Email": {
  12252. "description": "Email an email address belonging to a user",
  12253. "type": "object",
  12254. "properties": {
  12255. "email": {
  12256. "type": "string",
  12257. "format": "email",
  12258. "x-go-name": "Email"
  12259. },
  12260. "primary": {
  12261. "type": "boolean",
  12262. "x-go-name": "Primary"
  12263. },
  12264. "verified": {
  12265. "type": "boolean",
  12266. "x-go-name": "Verified"
  12267. }
  12268. },
  12269. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12270. },
  12271. "ExternalTracker": {
  12272. "description": "ExternalTracker represents settings for external tracker",
  12273. "type": "object",
  12274. "properties": {
  12275. "external_tracker_format": {
  12276. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  12277. "type": "string",
  12278. "x-go-name": "ExternalTrackerFormat"
  12279. },
  12280. "external_tracker_style": {
  12281. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  12282. "type": "string",
  12283. "x-go-name": "ExternalTrackerStyle"
  12284. },
  12285. "external_tracker_url": {
  12286. "description": "URL of external issue tracker.",
  12287. "type": "string",
  12288. "x-go-name": "ExternalTrackerURL"
  12289. }
  12290. },
  12291. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12292. },
  12293. "ExternalWiki": {
  12294. "description": "ExternalWiki represents setting for external wiki",
  12295. "type": "object",
  12296. "properties": {
  12297. "external_wiki_url": {
  12298. "description": "URL of external wiki.",
  12299. "type": "string",
  12300. "x-go-name": "ExternalWikiURL"
  12301. }
  12302. },
  12303. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12304. },
  12305. "FileCommitResponse": {
  12306. "type": "object",
  12307. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  12308. "properties": {
  12309. "author": {
  12310. "$ref": "#/definitions/CommitUser"
  12311. },
  12312. "committer": {
  12313. "$ref": "#/definitions/CommitUser"
  12314. },
  12315. "html_url": {
  12316. "type": "string",
  12317. "x-go-name": "HTMLURL"
  12318. },
  12319. "message": {
  12320. "type": "string",
  12321. "x-go-name": "Message"
  12322. },
  12323. "parents": {
  12324. "type": "array",
  12325. "items": {
  12326. "$ref": "#/definitions/CommitMeta"
  12327. },
  12328. "x-go-name": "Parents"
  12329. },
  12330. "sha": {
  12331. "type": "string",
  12332. "x-go-name": "SHA"
  12333. },
  12334. "tree": {
  12335. "$ref": "#/definitions/CommitMeta"
  12336. },
  12337. "url": {
  12338. "type": "string",
  12339. "x-go-name": "URL"
  12340. }
  12341. },
  12342. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12343. },
  12344. "FileDeleteResponse": {
  12345. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  12346. "type": "object",
  12347. "properties": {
  12348. "commit": {
  12349. "$ref": "#/definitions/FileCommitResponse"
  12350. },
  12351. "content": {
  12352. "type": "object",
  12353. "x-go-name": "Content"
  12354. },
  12355. "verification": {
  12356. "$ref": "#/definitions/PayloadCommitVerification"
  12357. }
  12358. },
  12359. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12360. },
  12361. "FileLinksResponse": {
  12362. "description": "FileLinksResponse contains the links for a repo's file",
  12363. "type": "object",
  12364. "properties": {
  12365. "git": {
  12366. "type": "string",
  12367. "x-go-name": "GitURL"
  12368. },
  12369. "html": {
  12370. "type": "string",
  12371. "x-go-name": "HTMLURL"
  12372. },
  12373. "self": {
  12374. "type": "string",
  12375. "x-go-name": "Self"
  12376. }
  12377. },
  12378. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12379. },
  12380. "FileResponse": {
  12381. "description": "FileResponse contains information about a repo's file",
  12382. "type": "object",
  12383. "properties": {
  12384. "commit": {
  12385. "$ref": "#/definitions/FileCommitResponse"
  12386. },
  12387. "content": {
  12388. "$ref": "#/definitions/ContentsResponse"
  12389. },
  12390. "verification": {
  12391. "$ref": "#/definitions/PayloadCommitVerification"
  12392. }
  12393. },
  12394. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12395. },
  12396. "GPGKey": {
  12397. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  12398. "type": "object",
  12399. "properties": {
  12400. "can_certify": {
  12401. "type": "boolean",
  12402. "x-go-name": "CanCertify"
  12403. },
  12404. "can_encrypt_comms": {
  12405. "type": "boolean",
  12406. "x-go-name": "CanEncryptComms"
  12407. },
  12408. "can_encrypt_storage": {
  12409. "type": "boolean",
  12410. "x-go-name": "CanEncryptStorage"
  12411. },
  12412. "can_sign": {
  12413. "type": "boolean",
  12414. "x-go-name": "CanSign"
  12415. },
  12416. "created_at": {
  12417. "type": "string",
  12418. "format": "date-time",
  12419. "x-go-name": "Created"
  12420. },
  12421. "emails": {
  12422. "type": "array",
  12423. "items": {
  12424. "$ref": "#/definitions/GPGKeyEmail"
  12425. },
  12426. "x-go-name": "Emails"
  12427. },
  12428. "expires_at": {
  12429. "type": "string",
  12430. "format": "date-time",
  12431. "x-go-name": "Expires"
  12432. },
  12433. "id": {
  12434. "type": "integer",
  12435. "format": "int64",
  12436. "x-go-name": "ID"
  12437. },
  12438. "key_id": {
  12439. "type": "string",
  12440. "x-go-name": "KeyID"
  12441. },
  12442. "primary_key_id": {
  12443. "type": "string",
  12444. "x-go-name": "PrimaryKeyID"
  12445. },
  12446. "public_key": {
  12447. "type": "string",
  12448. "x-go-name": "PublicKey"
  12449. },
  12450. "subkeys": {
  12451. "type": "array",
  12452. "items": {
  12453. "$ref": "#/definitions/GPGKey"
  12454. },
  12455. "x-go-name": "SubsKey"
  12456. }
  12457. },
  12458. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12459. },
  12460. "GPGKeyEmail": {
  12461. "description": "GPGKeyEmail an email attached to a GPGKey",
  12462. "type": "object",
  12463. "properties": {
  12464. "email": {
  12465. "type": "string",
  12466. "x-go-name": "Email"
  12467. },
  12468. "verified": {
  12469. "type": "boolean",
  12470. "x-go-name": "Verified"
  12471. }
  12472. },
  12473. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12474. },
  12475. "GitBlobResponse": {
  12476. "description": "GitBlobResponse represents a git blob",
  12477. "type": "object",
  12478. "properties": {
  12479. "content": {
  12480. "type": "string",
  12481. "x-go-name": "Content"
  12482. },
  12483. "encoding": {
  12484. "type": "string",
  12485. "x-go-name": "Encoding"
  12486. },
  12487. "sha": {
  12488. "type": "string",
  12489. "x-go-name": "SHA"
  12490. },
  12491. "size": {
  12492. "type": "integer",
  12493. "format": "int64",
  12494. "x-go-name": "Size"
  12495. },
  12496. "url": {
  12497. "type": "string",
  12498. "x-go-name": "URL"
  12499. }
  12500. },
  12501. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12502. },
  12503. "GitEntry": {
  12504. "description": "GitEntry represents a git tree",
  12505. "type": "object",
  12506. "properties": {
  12507. "mode": {
  12508. "type": "string",
  12509. "x-go-name": "Mode"
  12510. },
  12511. "path": {
  12512. "type": "string",
  12513. "x-go-name": "Path"
  12514. },
  12515. "sha": {
  12516. "type": "string",
  12517. "x-go-name": "SHA"
  12518. },
  12519. "size": {
  12520. "type": "integer",
  12521. "format": "int64",
  12522. "x-go-name": "Size"
  12523. },
  12524. "type": {
  12525. "type": "string",
  12526. "x-go-name": "Type"
  12527. },
  12528. "url": {
  12529. "type": "string",
  12530. "x-go-name": "URL"
  12531. }
  12532. },
  12533. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12534. },
  12535. "GitHook": {
  12536. "description": "GitHook represents a Git repository hook",
  12537. "type": "object",
  12538. "properties": {
  12539. "content": {
  12540. "type": "string",
  12541. "x-go-name": "Content"
  12542. },
  12543. "is_active": {
  12544. "type": "boolean",
  12545. "x-go-name": "IsActive"
  12546. },
  12547. "name": {
  12548. "type": "string",
  12549. "x-go-name": "Name"
  12550. }
  12551. },
  12552. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12553. },
  12554. "GitObject": {
  12555. "type": "object",
  12556. "title": "GitObject represents a Git object.",
  12557. "properties": {
  12558. "sha": {
  12559. "type": "string",
  12560. "x-go-name": "SHA"
  12561. },
  12562. "type": {
  12563. "type": "string",
  12564. "x-go-name": "Type"
  12565. },
  12566. "url": {
  12567. "type": "string",
  12568. "x-go-name": "URL"
  12569. }
  12570. },
  12571. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12572. },
  12573. "GitTreeResponse": {
  12574. "description": "GitTreeResponse returns a git tree",
  12575. "type": "object",
  12576. "properties": {
  12577. "page": {
  12578. "type": "integer",
  12579. "format": "int64",
  12580. "x-go-name": "Page"
  12581. },
  12582. "sha": {
  12583. "type": "string",
  12584. "x-go-name": "SHA"
  12585. },
  12586. "total_count": {
  12587. "type": "integer",
  12588. "format": "int64",
  12589. "x-go-name": "TotalCount"
  12590. },
  12591. "tree": {
  12592. "type": "array",
  12593. "items": {
  12594. "$ref": "#/definitions/GitEntry"
  12595. },
  12596. "x-go-name": "Entries"
  12597. },
  12598. "truncated": {
  12599. "type": "boolean",
  12600. "x-go-name": "Truncated"
  12601. },
  12602. "url": {
  12603. "type": "string",
  12604. "x-go-name": "URL"
  12605. }
  12606. },
  12607. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12608. },
  12609. "Hook": {
  12610. "description": "Hook a hook is a web hook when one repository changed",
  12611. "type": "object",
  12612. "properties": {
  12613. "active": {
  12614. "type": "boolean",
  12615. "x-go-name": "Active"
  12616. },
  12617. "config": {
  12618. "type": "object",
  12619. "additionalProperties": {
  12620. "type": "string"
  12621. },
  12622. "x-go-name": "Config"
  12623. },
  12624. "created_at": {
  12625. "type": "string",
  12626. "format": "date-time",
  12627. "x-go-name": "Created"
  12628. },
  12629. "events": {
  12630. "type": "array",
  12631. "items": {
  12632. "type": "string"
  12633. },
  12634. "x-go-name": "Events"
  12635. },
  12636. "id": {
  12637. "type": "integer",
  12638. "format": "int64",
  12639. "x-go-name": "ID"
  12640. },
  12641. "type": {
  12642. "type": "string",
  12643. "x-go-name": "Type"
  12644. },
  12645. "updated_at": {
  12646. "type": "string",
  12647. "format": "date-time",
  12648. "x-go-name": "Updated"
  12649. }
  12650. },
  12651. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12652. },
  12653. "Identity": {
  12654. "description": "Identity for a person's identity like an author or committer",
  12655. "type": "object",
  12656. "properties": {
  12657. "email": {
  12658. "type": "string",
  12659. "format": "email",
  12660. "x-go-name": "Email"
  12661. },
  12662. "name": {
  12663. "type": "string",
  12664. "x-go-name": "Name"
  12665. }
  12666. },
  12667. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12668. },
  12669. "InternalTracker": {
  12670. "description": "InternalTracker represents settings for internal tracker",
  12671. "type": "object",
  12672. "properties": {
  12673. "allow_only_contributors_to_track_time": {
  12674. "description": "Let only contributors track time (Built-in issue tracker)",
  12675. "type": "boolean",
  12676. "x-go-name": "AllowOnlyContributorsToTrackTime"
  12677. },
  12678. "enable_issue_dependencies": {
  12679. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  12680. "type": "boolean",
  12681. "x-go-name": "EnableIssueDependencies"
  12682. },
  12683. "enable_time_tracker": {
  12684. "description": "Enable time tracking (Built-in issue tracker)",
  12685. "type": "boolean",
  12686. "x-go-name": "EnableTimeTracker"
  12687. }
  12688. },
  12689. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12690. },
  12691. "Issue": {
  12692. "description": "Issue represents an issue in a repository",
  12693. "type": "object",
  12694. "properties": {
  12695. "assignee": {
  12696. "$ref": "#/definitions/User"
  12697. },
  12698. "assignees": {
  12699. "type": "array",
  12700. "items": {
  12701. "$ref": "#/definitions/User"
  12702. },
  12703. "x-go-name": "Assignees"
  12704. },
  12705. "body": {
  12706. "type": "string",
  12707. "x-go-name": "Body"
  12708. },
  12709. "closed_at": {
  12710. "type": "string",
  12711. "format": "date-time",
  12712. "x-go-name": "Closed"
  12713. },
  12714. "comments": {
  12715. "type": "integer",
  12716. "format": "int64",
  12717. "x-go-name": "Comments"
  12718. },
  12719. "created_at": {
  12720. "type": "string",
  12721. "format": "date-time",
  12722. "x-go-name": "Created"
  12723. },
  12724. "due_date": {
  12725. "type": "string",
  12726. "format": "date-time",
  12727. "x-go-name": "Deadline"
  12728. },
  12729. "html_url": {
  12730. "type": "string",
  12731. "x-go-name": "HTMLURL"
  12732. },
  12733. "id": {
  12734. "type": "integer",
  12735. "format": "int64",
  12736. "x-go-name": "ID"
  12737. },
  12738. "labels": {
  12739. "type": "array",
  12740. "items": {
  12741. "$ref": "#/definitions/Label"
  12742. },
  12743. "x-go-name": "Labels"
  12744. },
  12745. "milestone": {
  12746. "$ref": "#/definitions/Milestone"
  12747. },
  12748. "number": {
  12749. "type": "integer",
  12750. "format": "int64",
  12751. "x-go-name": "Index"
  12752. },
  12753. "original_author": {
  12754. "type": "string",
  12755. "x-go-name": "OriginalAuthor"
  12756. },
  12757. "original_author_id": {
  12758. "type": "integer",
  12759. "format": "int64",
  12760. "x-go-name": "OriginalAuthorID"
  12761. },
  12762. "pull_request": {
  12763. "$ref": "#/definitions/PullRequestMeta"
  12764. },
  12765. "repository": {
  12766. "$ref": "#/definitions/RepositoryMeta"
  12767. },
  12768. "state": {
  12769. "$ref": "#/definitions/StateType"
  12770. },
  12771. "title": {
  12772. "type": "string",
  12773. "x-go-name": "Title"
  12774. },
  12775. "updated_at": {
  12776. "type": "string",
  12777. "format": "date-time",
  12778. "x-go-name": "Updated"
  12779. },
  12780. "url": {
  12781. "type": "string",
  12782. "x-go-name": "URL"
  12783. },
  12784. "user": {
  12785. "$ref": "#/definitions/User"
  12786. }
  12787. },
  12788. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12789. },
  12790. "IssueDeadline": {
  12791. "description": "IssueDeadline represents an issue deadline",
  12792. "type": "object",
  12793. "properties": {
  12794. "due_date": {
  12795. "type": "string",
  12796. "format": "date-time",
  12797. "x-go-name": "Deadline"
  12798. }
  12799. },
  12800. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12801. },
  12802. "IssueLabelsOption": {
  12803. "description": "IssueLabelsOption a collection of labels",
  12804. "type": "object",
  12805. "properties": {
  12806. "labels": {
  12807. "description": "list of label IDs",
  12808. "type": "array",
  12809. "items": {
  12810. "type": "integer",
  12811. "format": "int64"
  12812. },
  12813. "x-go-name": "Labels"
  12814. }
  12815. },
  12816. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12817. },
  12818. "Label": {
  12819. "description": "Label a label to an issue or a pr",
  12820. "type": "object",
  12821. "properties": {
  12822. "color": {
  12823. "type": "string",
  12824. "x-go-name": "Color",
  12825. "example": "00aabb"
  12826. },
  12827. "description": {
  12828. "type": "string",
  12829. "x-go-name": "Description"
  12830. },
  12831. "id": {
  12832. "type": "integer",
  12833. "format": "int64",
  12834. "x-go-name": "ID"
  12835. },
  12836. "name": {
  12837. "type": "string",
  12838. "x-go-name": "Name"
  12839. },
  12840. "url": {
  12841. "type": "string",
  12842. "x-go-name": "URL"
  12843. }
  12844. },
  12845. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12846. },
  12847. "MarkdownOption": {
  12848. "description": "MarkdownOption markdown options",
  12849. "type": "object",
  12850. "properties": {
  12851. "Context": {
  12852. "description": "Context to render\n\nin: body",
  12853. "type": "string"
  12854. },
  12855. "Mode": {
  12856. "description": "Mode to render\n\nin: body",
  12857. "type": "string"
  12858. },
  12859. "Text": {
  12860. "description": "Text markdown to render\n\nin: body",
  12861. "type": "string"
  12862. },
  12863. "Wiki": {
  12864. "description": "Is it a wiki page ?\n\nin: body",
  12865. "type": "boolean"
  12866. }
  12867. },
  12868. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12869. },
  12870. "MergePullRequestOption": {
  12871. "description": "MergePullRequestForm form for merging Pull Request",
  12872. "type": "object",
  12873. "required": [
  12874. "Do"
  12875. ],
  12876. "properties": {
  12877. "Do": {
  12878. "type": "string",
  12879. "enum": [
  12880. "merge",
  12881. "rebase",
  12882. "rebase-merge",
  12883. "squash"
  12884. ]
  12885. },
  12886. "MergeMessageField": {
  12887. "type": "string"
  12888. },
  12889. "MergeTitleField": {
  12890. "type": "string"
  12891. },
  12892. "force_merge": {
  12893. "type": "boolean",
  12894. "x-go-name": "ForceMerge"
  12895. }
  12896. },
  12897. "x-go-name": "MergePullRequestForm",
  12898. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12899. },
  12900. "MigrateRepoForm": {
  12901. "description": "MigrateRepoForm form for migrating repository",
  12902. "type": "object",
  12903. "required": [
  12904. "clone_addr",
  12905. "uid",
  12906. "repo_name"
  12907. ],
  12908. "properties": {
  12909. "auth_password": {
  12910. "type": "string",
  12911. "x-go-name": "AuthPassword"
  12912. },
  12913. "auth_username": {
  12914. "type": "string",
  12915. "x-go-name": "AuthUsername"
  12916. },
  12917. "clone_addr": {
  12918. "type": "string",
  12919. "x-go-name": "CloneAddr"
  12920. },
  12921. "description": {
  12922. "type": "string",
  12923. "x-go-name": "Description"
  12924. },
  12925. "issues": {
  12926. "type": "boolean",
  12927. "x-go-name": "Issues"
  12928. },
  12929. "labels": {
  12930. "type": "boolean",
  12931. "x-go-name": "Labels"
  12932. },
  12933. "milestones": {
  12934. "type": "boolean",
  12935. "x-go-name": "Milestones"
  12936. },
  12937. "mirror": {
  12938. "type": "boolean",
  12939. "x-go-name": "Mirror"
  12940. },
  12941. "private": {
  12942. "type": "boolean",
  12943. "x-go-name": "Private"
  12944. },
  12945. "pull_requests": {
  12946. "type": "boolean",
  12947. "x-go-name": "PullRequests"
  12948. },
  12949. "releases": {
  12950. "type": "boolean",
  12951. "x-go-name": "Releases"
  12952. },
  12953. "repo_name": {
  12954. "type": "string",
  12955. "x-go-name": "RepoName"
  12956. },
  12957. "uid": {
  12958. "type": "integer",
  12959. "format": "int64",
  12960. "x-go-name": "UID"
  12961. },
  12962. "wiki": {
  12963. "type": "boolean",
  12964. "x-go-name": "Wiki"
  12965. }
  12966. },
  12967. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12968. },
  12969. "Milestone": {
  12970. "description": "Milestone milestone is a collection of issues on one repository",
  12971. "type": "object",
  12972. "properties": {
  12973. "closed_at": {
  12974. "type": "string",
  12975. "format": "date-time",
  12976. "x-go-name": "Closed"
  12977. },
  12978. "closed_issues": {
  12979. "type": "integer",
  12980. "format": "int64",
  12981. "x-go-name": "ClosedIssues"
  12982. },
  12983. "description": {
  12984. "type": "string",
  12985. "x-go-name": "Description"
  12986. },
  12987. "due_on": {
  12988. "type": "string",
  12989. "format": "date-time",
  12990. "x-go-name": "Deadline"
  12991. },
  12992. "id": {
  12993. "type": "integer",
  12994. "format": "int64",
  12995. "x-go-name": "ID"
  12996. },
  12997. "open_issues": {
  12998. "type": "integer",
  12999. "format": "int64",
  13000. "x-go-name": "OpenIssues"
  13001. },
  13002. "state": {
  13003. "$ref": "#/definitions/StateType"
  13004. },
  13005. "title": {
  13006. "type": "string",
  13007. "x-go-name": "Title"
  13008. }
  13009. },
  13010. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13011. },
  13012. "NotificationCount": {
  13013. "description": "NotificationCount number of unread notifications",
  13014. "type": "object",
  13015. "properties": {
  13016. "new": {
  13017. "type": "integer",
  13018. "format": "int64",
  13019. "x-go-name": "New"
  13020. }
  13021. },
  13022. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13023. },
  13024. "NotificationSubject": {
  13025. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  13026. "type": "object",
  13027. "properties": {
  13028. "latest_comment_url": {
  13029. "type": "string",
  13030. "x-go-name": "LatestCommentURL"
  13031. },
  13032. "title": {
  13033. "type": "string",
  13034. "x-go-name": "Title"
  13035. },
  13036. "type": {
  13037. "type": "string",
  13038. "x-go-name": "Type"
  13039. },
  13040. "url": {
  13041. "type": "string",
  13042. "x-go-name": "URL"
  13043. }
  13044. },
  13045. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13046. },
  13047. "NotificationThread": {
  13048. "description": "NotificationThread expose Notification on API",
  13049. "type": "object",
  13050. "properties": {
  13051. "id": {
  13052. "type": "integer",
  13053. "format": "int64",
  13054. "x-go-name": "ID"
  13055. },
  13056. "pinned": {
  13057. "type": "boolean",
  13058. "x-go-name": "Pinned"
  13059. },
  13060. "repository": {
  13061. "$ref": "#/definitions/Repository"
  13062. },
  13063. "subject": {
  13064. "$ref": "#/definitions/NotificationSubject"
  13065. },
  13066. "unread": {
  13067. "type": "boolean",
  13068. "x-go-name": "Unread"
  13069. },
  13070. "updated_at": {
  13071. "type": "string",
  13072. "format": "date-time",
  13073. "x-go-name": "UpdatedAt"
  13074. },
  13075. "url": {
  13076. "type": "string",
  13077. "x-go-name": "URL"
  13078. }
  13079. },
  13080. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13081. },
  13082. "OAuth2Application": {
  13083. "type": "object",
  13084. "title": "OAuth2Application represents an OAuth2 application.",
  13085. "properties": {
  13086. "client_id": {
  13087. "type": "string",
  13088. "x-go-name": "ClientID"
  13089. },
  13090. "client_secret": {
  13091. "type": "string",
  13092. "x-go-name": "ClientSecret"
  13093. },
  13094. "created": {
  13095. "type": "string",
  13096. "format": "date-time",
  13097. "x-go-name": "Created"
  13098. },
  13099. "id": {
  13100. "type": "integer",
  13101. "format": "int64",
  13102. "x-go-name": "ID"
  13103. },
  13104. "name": {
  13105. "type": "string",
  13106. "x-go-name": "Name"
  13107. },
  13108. "redirect_uris": {
  13109. "type": "array",
  13110. "items": {
  13111. "type": "string"
  13112. },
  13113. "x-go-name": "RedirectURIs"
  13114. }
  13115. },
  13116. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13117. },
  13118. "Organization": {
  13119. "description": "Organization represents an organization",
  13120. "type": "object",
  13121. "properties": {
  13122. "avatar_url": {
  13123. "type": "string",
  13124. "x-go-name": "AvatarURL"
  13125. },
  13126. "description": {
  13127. "type": "string",
  13128. "x-go-name": "Description"
  13129. },
  13130. "full_name": {
  13131. "type": "string",
  13132. "x-go-name": "FullName"
  13133. },
  13134. "id": {
  13135. "type": "integer",
  13136. "format": "int64",
  13137. "x-go-name": "ID"
  13138. },
  13139. "location": {
  13140. "type": "string",
  13141. "x-go-name": "Location"
  13142. },
  13143. "repo_admin_change_team_access": {
  13144. "type": "boolean",
  13145. "x-go-name": "RepoAdminChangeTeamAccess"
  13146. },
  13147. "username": {
  13148. "type": "string",
  13149. "x-go-name": "UserName"
  13150. },
  13151. "visibility": {
  13152. "type": "string",
  13153. "x-go-name": "Visibility"
  13154. },
  13155. "website": {
  13156. "type": "string",
  13157. "x-go-name": "Website"
  13158. }
  13159. },
  13160. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13161. },
  13162. "PRBranchInfo": {
  13163. "description": "PRBranchInfo information about a branch",
  13164. "type": "object",
  13165. "properties": {
  13166. "label": {
  13167. "type": "string",
  13168. "x-go-name": "Name"
  13169. },
  13170. "ref": {
  13171. "type": "string",
  13172. "x-go-name": "Ref"
  13173. },
  13174. "repo": {
  13175. "$ref": "#/definitions/Repository"
  13176. },
  13177. "repo_id": {
  13178. "type": "integer",
  13179. "format": "int64",
  13180. "x-go-name": "RepoID"
  13181. },
  13182. "sha": {
  13183. "type": "string",
  13184. "x-go-name": "Sha"
  13185. }
  13186. },
  13187. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13188. },
  13189. "PayloadCommit": {
  13190. "description": "PayloadCommit represents a commit",
  13191. "type": "object",
  13192. "properties": {
  13193. "added": {
  13194. "type": "array",
  13195. "items": {
  13196. "type": "string"
  13197. },
  13198. "x-go-name": "Added"
  13199. },
  13200. "author": {
  13201. "$ref": "#/definitions/PayloadUser"
  13202. },
  13203. "committer": {
  13204. "$ref": "#/definitions/PayloadUser"
  13205. },
  13206. "id": {
  13207. "description": "sha1 hash of the commit",
  13208. "type": "string",
  13209. "x-go-name": "ID"
  13210. },
  13211. "message": {
  13212. "type": "string",
  13213. "x-go-name": "Message"
  13214. },
  13215. "modified": {
  13216. "type": "array",
  13217. "items": {
  13218. "type": "string"
  13219. },
  13220. "x-go-name": "Modified"
  13221. },
  13222. "removed": {
  13223. "type": "array",
  13224. "items": {
  13225. "type": "string"
  13226. },
  13227. "x-go-name": "Removed"
  13228. },
  13229. "timestamp": {
  13230. "type": "string",
  13231. "format": "date-time",
  13232. "x-go-name": "Timestamp"
  13233. },
  13234. "url": {
  13235. "type": "string",
  13236. "x-go-name": "URL"
  13237. },
  13238. "verification": {
  13239. "$ref": "#/definitions/PayloadCommitVerification"
  13240. }
  13241. },
  13242. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13243. },
  13244. "PayloadCommitVerification": {
  13245. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  13246. "type": "object",
  13247. "properties": {
  13248. "payload": {
  13249. "type": "string",
  13250. "x-go-name": "Payload"
  13251. },
  13252. "reason": {
  13253. "type": "string",
  13254. "x-go-name": "Reason"
  13255. },
  13256. "signature": {
  13257. "type": "string",
  13258. "x-go-name": "Signature"
  13259. },
  13260. "signer": {
  13261. "$ref": "#/definitions/PayloadUser"
  13262. },
  13263. "verified": {
  13264. "type": "boolean",
  13265. "x-go-name": "Verified"
  13266. }
  13267. },
  13268. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13269. },
  13270. "PayloadUser": {
  13271. "description": "PayloadUser represents the author or committer of a commit",
  13272. "type": "object",
  13273. "properties": {
  13274. "email": {
  13275. "type": "string",
  13276. "format": "email",
  13277. "x-go-name": "Email"
  13278. },
  13279. "name": {
  13280. "description": "Full name of the commit author",
  13281. "type": "string",
  13282. "x-go-name": "Name"
  13283. },
  13284. "username": {
  13285. "type": "string",
  13286. "x-go-name": "UserName"
  13287. }
  13288. },
  13289. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13290. },
  13291. "Permission": {
  13292. "description": "Permission represents a set of permissions",
  13293. "type": "object",
  13294. "properties": {
  13295. "admin": {
  13296. "type": "boolean",
  13297. "x-go-name": "Admin"
  13298. },
  13299. "pull": {
  13300. "type": "boolean",
  13301. "x-go-name": "Pull"
  13302. },
  13303. "push": {
  13304. "type": "boolean",
  13305. "x-go-name": "Push"
  13306. }
  13307. },
  13308. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13309. },
  13310. "PublicKey": {
  13311. "description": "PublicKey publickey is a user key to push code to repository",
  13312. "type": "object",
  13313. "properties": {
  13314. "created_at": {
  13315. "type": "string",
  13316. "format": "date-time",
  13317. "x-go-name": "Created"
  13318. },
  13319. "fingerprint": {
  13320. "type": "string",
  13321. "x-go-name": "Fingerprint"
  13322. },
  13323. "id": {
  13324. "type": "integer",
  13325. "format": "int64",
  13326. "x-go-name": "ID"
  13327. },
  13328. "key": {
  13329. "type": "string",
  13330. "x-go-name": "Key"
  13331. },
  13332. "key_type": {
  13333. "type": "string",
  13334. "x-go-name": "KeyType"
  13335. },
  13336. "read_only": {
  13337. "type": "boolean",
  13338. "x-go-name": "ReadOnly"
  13339. },
  13340. "title": {
  13341. "type": "string",
  13342. "x-go-name": "Title"
  13343. },
  13344. "url": {
  13345. "type": "string",
  13346. "x-go-name": "URL"
  13347. },
  13348. "user": {
  13349. "$ref": "#/definitions/User"
  13350. }
  13351. },
  13352. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13353. },
  13354. "PullRequest": {
  13355. "description": "PullRequest represents a pull request",
  13356. "type": "object",
  13357. "properties": {
  13358. "assignee": {
  13359. "$ref": "#/definitions/User"
  13360. },
  13361. "assignees": {
  13362. "type": "array",
  13363. "items": {
  13364. "$ref": "#/definitions/User"
  13365. },
  13366. "x-go-name": "Assignees"
  13367. },
  13368. "base": {
  13369. "$ref": "#/definitions/PRBranchInfo"
  13370. },
  13371. "body": {
  13372. "type": "string",
  13373. "x-go-name": "Body"
  13374. },
  13375. "closed_at": {
  13376. "type": "string",
  13377. "format": "date-time",
  13378. "x-go-name": "Closed"
  13379. },
  13380. "comments": {
  13381. "type": "integer",
  13382. "format": "int64",
  13383. "x-go-name": "Comments"
  13384. },
  13385. "created_at": {
  13386. "type": "string",
  13387. "format": "date-time",
  13388. "x-go-name": "Created"
  13389. },
  13390. "diff_url": {
  13391. "type": "string",
  13392. "x-go-name": "DiffURL"
  13393. },
  13394. "due_date": {
  13395. "type": "string",
  13396. "format": "date-time",
  13397. "x-go-name": "Deadline"
  13398. },
  13399. "head": {
  13400. "$ref": "#/definitions/PRBranchInfo"
  13401. },
  13402. "html_url": {
  13403. "type": "string",
  13404. "x-go-name": "HTMLURL"
  13405. },
  13406. "id": {
  13407. "type": "integer",
  13408. "format": "int64",
  13409. "x-go-name": "ID"
  13410. },
  13411. "labels": {
  13412. "type": "array",
  13413. "items": {
  13414. "$ref": "#/definitions/Label"
  13415. },
  13416. "x-go-name": "Labels"
  13417. },
  13418. "merge_base": {
  13419. "type": "string",
  13420. "x-go-name": "MergeBase"
  13421. },
  13422. "merge_commit_sha": {
  13423. "type": "string",
  13424. "x-go-name": "MergedCommitID"
  13425. },
  13426. "mergeable": {
  13427. "type": "boolean",
  13428. "x-go-name": "Mergeable"
  13429. },
  13430. "merged": {
  13431. "type": "boolean",
  13432. "x-go-name": "HasMerged"
  13433. },
  13434. "merged_at": {
  13435. "type": "string",
  13436. "format": "date-time",
  13437. "x-go-name": "Merged"
  13438. },
  13439. "merged_by": {
  13440. "$ref": "#/definitions/User"
  13441. },
  13442. "milestone": {
  13443. "$ref": "#/definitions/Milestone"
  13444. },
  13445. "number": {
  13446. "type": "integer",
  13447. "format": "int64",
  13448. "x-go-name": "Index"
  13449. },
  13450. "patch_url": {
  13451. "type": "string",
  13452. "x-go-name": "PatchURL"
  13453. },
  13454. "state": {
  13455. "$ref": "#/definitions/StateType"
  13456. },
  13457. "title": {
  13458. "type": "string",
  13459. "x-go-name": "Title"
  13460. },
  13461. "updated_at": {
  13462. "type": "string",
  13463. "format": "date-time",
  13464. "x-go-name": "Updated"
  13465. },
  13466. "url": {
  13467. "type": "string",
  13468. "x-go-name": "URL"
  13469. },
  13470. "user": {
  13471. "$ref": "#/definitions/User"
  13472. }
  13473. },
  13474. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13475. },
  13476. "PullRequestMeta": {
  13477. "description": "PullRequestMeta PR info if an issue is a PR",
  13478. "type": "object",
  13479. "properties": {
  13480. "merged": {
  13481. "type": "boolean",
  13482. "x-go-name": "HasMerged"
  13483. },
  13484. "merged_at": {
  13485. "type": "string",
  13486. "format": "date-time",
  13487. "x-go-name": "Merged"
  13488. }
  13489. },
  13490. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13491. },
  13492. "PullReview": {
  13493. "description": "PullReview represents a pull request review",
  13494. "type": "object",
  13495. "properties": {
  13496. "body": {
  13497. "type": "string",
  13498. "x-go-name": "Body"
  13499. },
  13500. "comments_count": {
  13501. "type": "integer",
  13502. "format": "int64",
  13503. "x-go-name": "CodeCommentsCount"
  13504. },
  13505. "commit_id": {
  13506. "type": "string",
  13507. "x-go-name": "CommitID"
  13508. },
  13509. "html_url": {
  13510. "type": "string",
  13511. "x-go-name": "HTMLURL"
  13512. },
  13513. "id": {
  13514. "type": "integer",
  13515. "format": "int64",
  13516. "x-go-name": "ID"
  13517. },
  13518. "official": {
  13519. "type": "boolean",
  13520. "x-go-name": "Official"
  13521. },
  13522. "pull_request_url": {
  13523. "type": "string",
  13524. "x-go-name": "HTMLPullURL"
  13525. },
  13526. "stale": {
  13527. "type": "boolean",
  13528. "x-go-name": "Stale"
  13529. },
  13530. "state": {
  13531. "$ref": "#/definitions/ReviewStateType"
  13532. },
  13533. "submitted_at": {
  13534. "type": "string",
  13535. "format": "date-time",
  13536. "x-go-name": "Submitted"
  13537. },
  13538. "user": {
  13539. "$ref": "#/definitions/User"
  13540. }
  13541. },
  13542. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13543. },
  13544. "PullReviewComment": {
  13545. "description": "PullReviewComment represents a comment on a pull request review",
  13546. "type": "object",
  13547. "properties": {
  13548. "body": {
  13549. "type": "string",
  13550. "x-go-name": "Body"
  13551. },
  13552. "commit_id": {
  13553. "type": "string",
  13554. "x-go-name": "CommitID"
  13555. },
  13556. "created_at": {
  13557. "type": "string",
  13558. "format": "date-time",
  13559. "x-go-name": "Created"
  13560. },
  13561. "diff_hunk": {
  13562. "type": "string",
  13563. "x-go-name": "DiffHunk"
  13564. },
  13565. "html_url": {
  13566. "type": "string",
  13567. "x-go-name": "HTMLURL"
  13568. },
  13569. "id": {
  13570. "type": "integer",
  13571. "format": "int64",
  13572. "x-go-name": "ID"
  13573. },
  13574. "original_commit_id": {
  13575. "type": "string",
  13576. "x-go-name": "OrigCommitID"
  13577. },
  13578. "original_position": {
  13579. "type": "integer",
  13580. "format": "uint64",
  13581. "x-go-name": "OldLineNum"
  13582. },
  13583. "path": {
  13584. "type": "string",
  13585. "x-go-name": "Path"
  13586. },
  13587. "position": {
  13588. "type": "integer",
  13589. "format": "uint64",
  13590. "x-go-name": "LineNum"
  13591. },
  13592. "pull_request_review_id": {
  13593. "type": "integer",
  13594. "format": "int64",
  13595. "x-go-name": "ReviewID"
  13596. },
  13597. "pull_request_url": {
  13598. "type": "string",
  13599. "x-go-name": "HTMLPullURL"
  13600. },
  13601. "updated_at": {
  13602. "type": "string",
  13603. "format": "date-time",
  13604. "x-go-name": "Updated"
  13605. },
  13606. "user": {
  13607. "$ref": "#/definitions/User"
  13608. }
  13609. },
  13610. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13611. },
  13612. "Reaction": {
  13613. "description": "Reaction contain one reaction",
  13614. "type": "object",
  13615. "properties": {
  13616. "content": {
  13617. "type": "string",
  13618. "x-go-name": "Reaction"
  13619. },
  13620. "created_at": {
  13621. "type": "string",
  13622. "format": "date-time",
  13623. "x-go-name": "Created"
  13624. },
  13625. "user": {
  13626. "$ref": "#/definitions/User"
  13627. }
  13628. },
  13629. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13630. },
  13631. "Reference": {
  13632. "type": "object",
  13633. "title": "Reference represents a Git reference.",
  13634. "properties": {
  13635. "object": {
  13636. "$ref": "#/definitions/GitObject"
  13637. },
  13638. "ref": {
  13639. "type": "string",
  13640. "x-go-name": "Ref"
  13641. },
  13642. "url": {
  13643. "type": "string",
  13644. "x-go-name": "URL"
  13645. }
  13646. },
  13647. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13648. },
  13649. "Release": {
  13650. "description": "Release represents a repository release",
  13651. "type": "object",
  13652. "properties": {
  13653. "assets": {
  13654. "type": "array",
  13655. "items": {
  13656. "$ref": "#/definitions/Attachment"
  13657. },
  13658. "x-go-name": "Attachments"
  13659. },
  13660. "author": {
  13661. "$ref": "#/definitions/User"
  13662. },
  13663. "body": {
  13664. "type": "string",
  13665. "x-go-name": "Note"
  13666. },
  13667. "created_at": {
  13668. "type": "string",
  13669. "format": "date-time",
  13670. "x-go-name": "CreatedAt"
  13671. },
  13672. "draft": {
  13673. "type": "boolean",
  13674. "x-go-name": "IsDraft"
  13675. },
  13676. "html_url": {
  13677. "type": "string",
  13678. "x-go-name": "HTMLURL"
  13679. },
  13680. "id": {
  13681. "type": "integer",
  13682. "format": "int64",
  13683. "x-go-name": "ID"
  13684. },
  13685. "name": {
  13686. "type": "string",
  13687. "x-go-name": "Title"
  13688. },
  13689. "prerelease": {
  13690. "type": "boolean",
  13691. "x-go-name": "IsPrerelease"
  13692. },
  13693. "published_at": {
  13694. "type": "string",
  13695. "format": "date-time",
  13696. "x-go-name": "PublishedAt"
  13697. },
  13698. "tag_name": {
  13699. "type": "string",
  13700. "x-go-name": "TagName"
  13701. },
  13702. "tarball_url": {
  13703. "type": "string",
  13704. "x-go-name": "TarURL"
  13705. },
  13706. "target_commitish": {
  13707. "type": "string",
  13708. "x-go-name": "Target"
  13709. },
  13710. "url": {
  13711. "type": "string",
  13712. "x-go-name": "URL"
  13713. },
  13714. "zipball_url": {
  13715. "type": "string",
  13716. "x-go-name": "ZipURL"
  13717. }
  13718. },
  13719. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13720. },
  13721. "RepoCommit": {
  13722. "type": "object",
  13723. "title": "RepoCommit contains information of a commit in the context of a repository.",
  13724. "properties": {
  13725. "author": {
  13726. "$ref": "#/definitions/CommitUser"
  13727. },
  13728. "committer": {
  13729. "$ref": "#/definitions/CommitUser"
  13730. },
  13731. "message": {
  13732. "type": "string",
  13733. "x-go-name": "Message"
  13734. },
  13735. "tree": {
  13736. "$ref": "#/definitions/CommitMeta"
  13737. },
  13738. "url": {
  13739. "type": "string",
  13740. "x-go-name": "URL"
  13741. }
  13742. },
  13743. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13744. },
  13745. "RepoTopicOptions": {
  13746. "description": "RepoTopicOptions a collection of repo topic names",
  13747. "type": "object",
  13748. "properties": {
  13749. "topics": {
  13750. "description": "list of topic names",
  13751. "type": "array",
  13752. "items": {
  13753. "type": "string"
  13754. },
  13755. "x-go-name": "Topics"
  13756. }
  13757. },
  13758. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13759. },
  13760. "Repository": {
  13761. "description": "Repository represents a repository",
  13762. "type": "object",
  13763. "properties": {
  13764. "allow_merge_commits": {
  13765. "type": "boolean",
  13766. "x-go-name": "AllowMerge"
  13767. },
  13768. "allow_rebase": {
  13769. "type": "boolean",
  13770. "x-go-name": "AllowRebase"
  13771. },
  13772. "allow_rebase_explicit": {
  13773. "type": "boolean",
  13774. "x-go-name": "AllowRebaseMerge"
  13775. },
  13776. "allow_squash_merge": {
  13777. "type": "boolean",
  13778. "x-go-name": "AllowSquash"
  13779. },
  13780. "archived": {
  13781. "type": "boolean",
  13782. "x-go-name": "Archived"
  13783. },
  13784. "avatar_url": {
  13785. "type": "string",
  13786. "x-go-name": "AvatarURL"
  13787. },
  13788. "clone_url": {
  13789. "type": "string",
  13790. "x-go-name": "CloneURL"
  13791. },
  13792. "created_at": {
  13793. "type": "string",
  13794. "format": "date-time",
  13795. "x-go-name": "Created"
  13796. },
  13797. "default_branch": {
  13798. "type": "string",
  13799. "x-go-name": "DefaultBranch"
  13800. },
  13801. "description": {
  13802. "type": "string",
  13803. "x-go-name": "Description"
  13804. },
  13805. "empty": {
  13806. "type": "boolean",
  13807. "x-go-name": "Empty"
  13808. },
  13809. "external_tracker": {
  13810. "$ref": "#/definitions/ExternalTracker"
  13811. },
  13812. "external_wiki": {
  13813. "$ref": "#/definitions/ExternalWiki"
  13814. },
  13815. "fork": {
  13816. "type": "boolean",
  13817. "x-go-name": "Fork"
  13818. },
  13819. "forks_count": {
  13820. "type": "integer",
  13821. "format": "int64",
  13822. "x-go-name": "Forks"
  13823. },
  13824. "full_name": {
  13825. "type": "string",
  13826. "x-go-name": "FullName"
  13827. },
  13828. "has_issues": {
  13829. "type": "boolean",
  13830. "x-go-name": "HasIssues"
  13831. },
  13832. "has_pull_requests": {
  13833. "type": "boolean",
  13834. "x-go-name": "HasPullRequests"
  13835. },
  13836. "has_wiki": {
  13837. "type": "boolean",
  13838. "x-go-name": "HasWiki"
  13839. },
  13840. "html_url": {
  13841. "type": "string",
  13842. "x-go-name": "HTMLURL"
  13843. },
  13844. "id": {
  13845. "type": "integer",
  13846. "format": "int64",
  13847. "x-go-name": "ID"
  13848. },
  13849. "ignore_whitespace_conflicts": {
  13850. "type": "boolean",
  13851. "x-go-name": "IgnoreWhitespaceConflicts"
  13852. },
  13853. "internal_tracker": {
  13854. "$ref": "#/definitions/InternalTracker"
  13855. },
  13856. "mirror": {
  13857. "type": "boolean",
  13858. "x-go-name": "Mirror"
  13859. },
  13860. "name": {
  13861. "type": "string",
  13862. "x-go-name": "Name"
  13863. },
  13864. "open_issues_count": {
  13865. "type": "integer",
  13866. "format": "int64",
  13867. "x-go-name": "OpenIssues"
  13868. },
  13869. "open_pr_counter": {
  13870. "type": "integer",
  13871. "format": "int64",
  13872. "x-go-name": "OpenPulls"
  13873. },
  13874. "original_url": {
  13875. "type": "string",
  13876. "x-go-name": "OriginalURL"
  13877. },
  13878. "owner": {
  13879. "$ref": "#/definitions/User"
  13880. },
  13881. "parent": {
  13882. "$ref": "#/definitions/Repository"
  13883. },
  13884. "permissions": {
  13885. "$ref": "#/definitions/Permission"
  13886. },
  13887. "private": {
  13888. "type": "boolean",
  13889. "x-go-name": "Private"
  13890. },
  13891. "release_counter": {
  13892. "type": "integer",
  13893. "format": "int64",
  13894. "x-go-name": "Releases"
  13895. },
  13896. "size": {
  13897. "type": "integer",
  13898. "format": "int64",
  13899. "x-go-name": "Size"
  13900. },
  13901. "ssh_url": {
  13902. "type": "string",
  13903. "x-go-name": "SSHURL"
  13904. },
  13905. "stars_count": {
  13906. "type": "integer",
  13907. "format": "int64",
  13908. "x-go-name": "Stars"
  13909. },
  13910. "template": {
  13911. "type": "boolean",
  13912. "x-go-name": "Template"
  13913. },
  13914. "updated_at": {
  13915. "type": "string",
  13916. "format": "date-time",
  13917. "x-go-name": "Updated"
  13918. },
  13919. "watchers_count": {
  13920. "type": "integer",
  13921. "format": "int64",
  13922. "x-go-name": "Watchers"
  13923. },
  13924. "website": {
  13925. "type": "string",
  13926. "x-go-name": "Website"
  13927. }
  13928. },
  13929. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13930. },
  13931. "RepositoryMeta": {
  13932. "description": "RepositoryMeta basic repository information",
  13933. "type": "object",
  13934. "properties": {
  13935. "full_name": {
  13936. "type": "string",
  13937. "x-go-name": "FullName"
  13938. },
  13939. "id": {
  13940. "type": "integer",
  13941. "format": "int64",
  13942. "x-go-name": "ID"
  13943. },
  13944. "name": {
  13945. "type": "string",
  13946. "x-go-name": "Name"
  13947. },
  13948. "owner": {
  13949. "type": "string",
  13950. "x-go-name": "Owner"
  13951. }
  13952. },
  13953. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13954. },
  13955. "ReviewStateType": {
  13956. "description": "ReviewStateType review state type",
  13957. "type": "string",
  13958. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13959. },
  13960. "SearchResults": {
  13961. "description": "SearchResults results of a successful search",
  13962. "type": "object",
  13963. "properties": {
  13964. "data": {
  13965. "type": "array",
  13966. "items": {
  13967. "$ref": "#/definitions/Repository"
  13968. },
  13969. "x-go-name": "Data"
  13970. },
  13971. "ok": {
  13972. "type": "boolean",
  13973. "x-go-name": "OK"
  13974. }
  13975. },
  13976. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13977. },
  13978. "ServerVersion": {
  13979. "description": "ServerVersion wraps the version of the server",
  13980. "type": "object",
  13981. "properties": {
  13982. "version": {
  13983. "type": "string",
  13984. "x-go-name": "Version"
  13985. }
  13986. },
  13987. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13988. },
  13989. "StateType": {
  13990. "description": "StateType issue state type",
  13991. "type": "string",
  13992. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13993. },
  13994. "Status": {
  13995. "description": "Status holds a single Status of a single Commit",
  13996. "type": "object",
  13997. "properties": {
  13998. "context": {
  13999. "type": "string",
  14000. "x-go-name": "Context"
  14001. },
  14002. "created_at": {
  14003. "type": "string",
  14004. "format": "date-time",
  14005. "x-go-name": "Created"
  14006. },
  14007. "creator": {
  14008. "$ref": "#/definitions/User"
  14009. },
  14010. "description": {
  14011. "type": "string",
  14012. "x-go-name": "Description"
  14013. },
  14014. "id": {
  14015. "type": "integer",
  14016. "format": "int64",
  14017. "x-go-name": "ID"
  14018. },
  14019. "status": {
  14020. "$ref": "#/definitions/StatusState"
  14021. },
  14022. "target_url": {
  14023. "type": "string",
  14024. "x-go-name": "TargetURL"
  14025. },
  14026. "updated_at": {
  14027. "type": "string",
  14028. "format": "date-time",
  14029. "x-go-name": "Updated"
  14030. },
  14031. "url": {
  14032. "type": "string",
  14033. "x-go-name": "URL"
  14034. }
  14035. },
  14036. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14037. },
  14038. "StatusState": {
  14039. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  14040. "type": "string",
  14041. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14042. },
  14043. "StopWatch": {
  14044. "description": "StopWatch represent a running stopwatch",
  14045. "type": "object",
  14046. "properties": {
  14047. "created": {
  14048. "type": "string",
  14049. "format": "date-time",
  14050. "x-go-name": "Created"
  14051. },
  14052. "issue_index": {
  14053. "type": "integer",
  14054. "format": "int64",
  14055. "x-go-name": "IssueIndex"
  14056. }
  14057. },
  14058. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14059. },
  14060. "SubmitPullReviewOptions": {
  14061. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  14062. "type": "object",
  14063. "properties": {
  14064. "body": {
  14065. "type": "string",
  14066. "x-go-name": "Body"
  14067. },
  14068. "event": {
  14069. "$ref": "#/definitions/ReviewStateType"
  14070. }
  14071. },
  14072. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14073. },
  14074. "Tag": {
  14075. "description": "Tag represents a repository tag",
  14076. "type": "object",
  14077. "properties": {
  14078. "commit": {
  14079. "$ref": "#/definitions/CommitMeta"
  14080. },
  14081. "id": {
  14082. "type": "string",
  14083. "x-go-name": "ID"
  14084. },
  14085. "name": {
  14086. "type": "string",
  14087. "x-go-name": "Name"
  14088. },
  14089. "tarball_url": {
  14090. "type": "string",
  14091. "x-go-name": "TarballURL"
  14092. },
  14093. "zipball_url": {
  14094. "type": "string",
  14095. "x-go-name": "ZipballURL"
  14096. }
  14097. },
  14098. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14099. },
  14100. "Team": {
  14101. "description": "Team represents a team in an organization",
  14102. "type": "object",
  14103. "properties": {
  14104. "can_create_org_repo": {
  14105. "type": "boolean",
  14106. "x-go-name": "CanCreateOrgRepo"
  14107. },
  14108. "description": {
  14109. "type": "string",
  14110. "x-go-name": "Description"
  14111. },
  14112. "id": {
  14113. "type": "integer",
  14114. "format": "int64",
  14115. "x-go-name": "ID"
  14116. },
  14117. "includes_all_repositories": {
  14118. "type": "boolean",
  14119. "x-go-name": "IncludesAllRepositories"
  14120. },
  14121. "name": {
  14122. "type": "string",
  14123. "x-go-name": "Name"
  14124. },
  14125. "organization": {
  14126. "$ref": "#/definitions/Organization"
  14127. },
  14128. "permission": {
  14129. "type": "string",
  14130. "enum": [
  14131. "none",
  14132. "read",
  14133. "write",
  14134. "admin",
  14135. "owner"
  14136. ],
  14137. "x-go-name": "Permission"
  14138. },
  14139. "units": {
  14140. "type": "array",
  14141. "items": {
  14142. "type": "string"
  14143. },
  14144. "x-go-name": "Units",
  14145. "example": [
  14146. "repo.code",
  14147. "repo.issues",
  14148. "repo.ext_issues",
  14149. "repo.wiki",
  14150. "repo.pulls",
  14151. "repo.releases",
  14152. "repo.ext_wiki"
  14153. ]
  14154. }
  14155. },
  14156. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14157. },
  14158. "TimeStamp": {
  14159. "description": "TimeStamp defines a timestamp",
  14160. "type": "integer",
  14161. "format": "int64",
  14162. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  14163. },
  14164. "TopicName": {
  14165. "description": "TopicName a list of repo topic names",
  14166. "type": "object",
  14167. "properties": {
  14168. "topics": {
  14169. "type": "array",
  14170. "items": {
  14171. "type": "string"
  14172. },
  14173. "x-go-name": "TopicNames"
  14174. }
  14175. },
  14176. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14177. },
  14178. "TopicResponse": {
  14179. "description": "TopicResponse for returning topics",
  14180. "type": "object",
  14181. "properties": {
  14182. "created": {
  14183. "type": "string",
  14184. "format": "date-time",
  14185. "x-go-name": "Created"
  14186. },
  14187. "id": {
  14188. "type": "integer",
  14189. "format": "int64",
  14190. "x-go-name": "ID"
  14191. },
  14192. "repo_count": {
  14193. "type": "integer",
  14194. "format": "int64",
  14195. "x-go-name": "RepoCount"
  14196. },
  14197. "topic_name": {
  14198. "type": "string",
  14199. "x-go-name": "Name"
  14200. },
  14201. "updated": {
  14202. "type": "string",
  14203. "format": "date-time",
  14204. "x-go-name": "Updated"
  14205. }
  14206. },
  14207. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14208. },
  14209. "TrackedTime": {
  14210. "description": "TrackedTime worked time for an issue / pr",
  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. "issue": {
  14224. "$ref": "#/definitions/Issue"
  14225. },
  14226. "issue_id": {
  14227. "description": "deprecated (only for backwards compatibility)",
  14228. "type": "integer",
  14229. "format": "int64",
  14230. "x-go-name": "IssueID"
  14231. },
  14232. "time": {
  14233. "description": "Time in seconds",
  14234. "type": "integer",
  14235. "format": "int64",
  14236. "x-go-name": "Time"
  14237. },
  14238. "user_id": {
  14239. "description": "deprecated (only for backwards compatibility)",
  14240. "type": "integer",
  14241. "format": "int64",
  14242. "x-go-name": "UserID"
  14243. },
  14244. "user_name": {
  14245. "type": "string",
  14246. "x-go-name": "UserName"
  14247. }
  14248. },
  14249. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14250. },
  14251. "TransferRepoOption": {
  14252. "description": "TransferRepoOption options when transfer a repository's ownership",
  14253. "type": "object",
  14254. "required": [
  14255. "new_owner"
  14256. ],
  14257. "properties": {
  14258. "new_owner": {
  14259. "type": "string",
  14260. "x-go-name": "NewOwner"
  14261. },
  14262. "team_ids": {
  14263. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  14264. "type": "array",
  14265. "items": {
  14266. "type": "integer",
  14267. "format": "int64"
  14268. },
  14269. "x-go-name": "TeamIDs"
  14270. }
  14271. },
  14272. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14273. },
  14274. "UpdateFileOptions": {
  14275. "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)",
  14276. "type": "object",
  14277. "required": [
  14278. "sha",
  14279. "content"
  14280. ],
  14281. "properties": {
  14282. "author": {
  14283. "$ref": "#/definitions/Identity"
  14284. },
  14285. "branch": {
  14286. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  14287. "type": "string",
  14288. "x-go-name": "BranchName"
  14289. },
  14290. "committer": {
  14291. "$ref": "#/definitions/Identity"
  14292. },
  14293. "content": {
  14294. "description": "content must be base64 encoded",
  14295. "type": "string",
  14296. "x-go-name": "Content"
  14297. },
  14298. "dates": {
  14299. "$ref": "#/definitions/CommitDateOptions"
  14300. },
  14301. "from_path": {
  14302. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  14303. "type": "string",
  14304. "x-go-name": "FromPath"
  14305. },
  14306. "message": {
  14307. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  14308. "type": "string",
  14309. "x-go-name": "Message"
  14310. },
  14311. "new_branch": {
  14312. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  14313. "type": "string",
  14314. "x-go-name": "NewBranchName"
  14315. },
  14316. "sha": {
  14317. "description": "sha is the SHA for the file that already exists",
  14318. "type": "string",
  14319. "x-go-name": "SHA"
  14320. }
  14321. },
  14322. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14323. },
  14324. "User": {
  14325. "description": "User represents a user",
  14326. "type": "object",
  14327. "properties": {
  14328. "avatar_url": {
  14329. "description": "URL to the user's avatar",
  14330. "type": "string",
  14331. "x-go-name": "AvatarURL"
  14332. },
  14333. "created": {
  14334. "type": "string",
  14335. "format": "date-time",
  14336. "x-go-name": "Created"
  14337. },
  14338. "email": {
  14339. "type": "string",
  14340. "format": "email",
  14341. "x-go-name": "Email"
  14342. },
  14343. "full_name": {
  14344. "description": "the user's full name",
  14345. "type": "string",
  14346. "x-go-name": "FullName"
  14347. },
  14348. "id": {
  14349. "description": "the user's id",
  14350. "type": "integer",
  14351. "format": "int64",
  14352. "x-go-name": "ID"
  14353. },
  14354. "is_admin": {
  14355. "description": "Is the user an administrator",
  14356. "type": "boolean",
  14357. "x-go-name": "IsAdmin"
  14358. },
  14359. "language": {
  14360. "description": "User locale",
  14361. "type": "string",
  14362. "x-go-name": "Language"
  14363. },
  14364. "last_login": {
  14365. "type": "string",
  14366. "format": "date-time",
  14367. "x-go-name": "LastLogin"
  14368. },
  14369. "login": {
  14370. "description": "the user's username",
  14371. "type": "string",
  14372. "x-go-name": "UserName"
  14373. }
  14374. },
  14375. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14376. },
  14377. "UserHeatmapData": {
  14378. "description": "UserHeatmapData represents the data needed to create a heatmap",
  14379. "type": "object",
  14380. "properties": {
  14381. "contributions": {
  14382. "type": "integer",
  14383. "format": "int64",
  14384. "x-go-name": "Contributions"
  14385. },
  14386. "timestamp": {
  14387. "$ref": "#/definitions/TimeStamp"
  14388. }
  14389. },
  14390. "x-go-package": "code.gitea.io/gitea/models"
  14391. },
  14392. "WatchInfo": {
  14393. "description": "WatchInfo represents an API watch status of one repository",
  14394. "type": "object",
  14395. "properties": {
  14396. "created_at": {
  14397. "type": "string",
  14398. "format": "date-time",
  14399. "x-go-name": "CreatedAt"
  14400. },
  14401. "ignored": {
  14402. "type": "boolean",
  14403. "x-go-name": "Ignored"
  14404. },
  14405. "reason": {
  14406. "type": "object",
  14407. "x-go-name": "Reason"
  14408. },
  14409. "repository_url": {
  14410. "type": "string",
  14411. "x-go-name": "RepositoryURL"
  14412. },
  14413. "subscribed": {
  14414. "type": "boolean",
  14415. "x-go-name": "Subscribed"
  14416. },
  14417. "url": {
  14418. "type": "string",
  14419. "x-go-name": "URL"
  14420. }
  14421. },
  14422. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14423. }
  14424. },
  14425. "responses": {
  14426. "AccessToken": {
  14427. "description": "AccessToken represents an API access token.",
  14428. "headers": {
  14429. "id": {
  14430. "type": "integer",
  14431. "format": "int64"
  14432. },
  14433. "name": {
  14434. "type": "string"
  14435. },
  14436. "sha1": {
  14437. "type": "string"
  14438. },
  14439. "token_last_eight": {
  14440. "type": "string"
  14441. }
  14442. }
  14443. },
  14444. "AccessTokenList": {
  14445. "description": "AccessTokenList represents a list of API access token.",
  14446. "schema": {
  14447. "type": "array",
  14448. "items": {
  14449. "$ref": "#/definitions/AccessToken"
  14450. }
  14451. }
  14452. },
  14453. "AnnotatedTag": {
  14454. "description": "AnnotatedTag",
  14455. "schema": {
  14456. "$ref": "#/definitions/AnnotatedTag"
  14457. }
  14458. },
  14459. "Attachment": {
  14460. "description": "Attachment",
  14461. "schema": {
  14462. "$ref": "#/definitions/Attachment"
  14463. }
  14464. },
  14465. "AttachmentList": {
  14466. "description": "AttachmentList",
  14467. "schema": {
  14468. "type": "array",
  14469. "items": {
  14470. "$ref": "#/definitions/Attachment"
  14471. }
  14472. }
  14473. },
  14474. "Branch": {
  14475. "description": "Branch",
  14476. "schema": {
  14477. "$ref": "#/definitions/Branch"
  14478. }
  14479. },
  14480. "BranchList": {
  14481. "description": "BranchList",
  14482. "schema": {
  14483. "type": "array",
  14484. "items": {
  14485. "$ref": "#/definitions/Branch"
  14486. }
  14487. }
  14488. },
  14489. "BranchProtection": {
  14490. "description": "BranchProtection",
  14491. "schema": {
  14492. "$ref": "#/definitions/BranchProtection"
  14493. }
  14494. },
  14495. "BranchProtectionList": {
  14496. "description": "BranchProtectionList",
  14497. "schema": {
  14498. "type": "array",
  14499. "items": {
  14500. "$ref": "#/definitions/BranchProtection"
  14501. }
  14502. }
  14503. },
  14504. "Comment": {
  14505. "description": "Comment",
  14506. "schema": {
  14507. "$ref": "#/definitions/Comment"
  14508. }
  14509. },
  14510. "CommentList": {
  14511. "description": "CommentList",
  14512. "schema": {
  14513. "type": "array",
  14514. "items": {
  14515. "$ref": "#/definitions/Comment"
  14516. }
  14517. }
  14518. },
  14519. "Commit": {
  14520. "description": "Commit",
  14521. "schema": {
  14522. "$ref": "#/definitions/Commit"
  14523. }
  14524. },
  14525. "CommitList": {
  14526. "description": "CommitList",
  14527. "schema": {
  14528. "type": "array",
  14529. "items": {
  14530. "$ref": "#/definitions/Commit"
  14531. }
  14532. },
  14533. "headers": {
  14534. "X-HasMore": {
  14535. "type": "boolean",
  14536. "description": "True if there is another page"
  14537. },
  14538. "X-Page": {
  14539. "type": "integer",
  14540. "format": "int64",
  14541. "description": "The current page"
  14542. },
  14543. "X-PageCount": {
  14544. "type": "integer",
  14545. "format": "int64",
  14546. "description": "Total number of pages"
  14547. },
  14548. "X-PerPage": {
  14549. "type": "integer",
  14550. "format": "int64",
  14551. "description": "Commits per page"
  14552. },
  14553. "X-Total": {
  14554. "type": "integer",
  14555. "format": "int64",
  14556. "description": "Total commit count"
  14557. }
  14558. }
  14559. },
  14560. "ContentsListResponse": {
  14561. "description": "ContentsListResponse",
  14562. "schema": {
  14563. "type": "array",
  14564. "items": {
  14565. "$ref": "#/definitions/ContentsResponse"
  14566. }
  14567. }
  14568. },
  14569. "ContentsResponse": {
  14570. "description": "ContentsResponse",
  14571. "schema": {
  14572. "$ref": "#/definitions/ContentsResponse"
  14573. }
  14574. },
  14575. "DeployKey": {
  14576. "description": "DeployKey",
  14577. "schema": {
  14578. "$ref": "#/definitions/DeployKey"
  14579. }
  14580. },
  14581. "DeployKeyList": {
  14582. "description": "DeployKeyList",
  14583. "schema": {
  14584. "type": "array",
  14585. "items": {
  14586. "$ref": "#/definitions/DeployKey"
  14587. }
  14588. }
  14589. },
  14590. "EmailList": {
  14591. "description": "EmailList",
  14592. "schema": {
  14593. "type": "array",
  14594. "items": {
  14595. "$ref": "#/definitions/Email"
  14596. }
  14597. }
  14598. },
  14599. "EmptyRepository": {
  14600. "description": "EmptyRepository",
  14601. "schema": {
  14602. "$ref": "#/definitions/APIError"
  14603. }
  14604. },
  14605. "FileDeleteResponse": {
  14606. "description": "FileDeleteResponse",
  14607. "schema": {
  14608. "$ref": "#/definitions/FileDeleteResponse"
  14609. }
  14610. },
  14611. "FileResponse": {
  14612. "description": "FileResponse",
  14613. "schema": {
  14614. "$ref": "#/definitions/FileResponse"
  14615. }
  14616. },
  14617. "GPGKey": {
  14618. "description": "GPGKey",
  14619. "schema": {
  14620. "$ref": "#/definitions/GPGKey"
  14621. }
  14622. },
  14623. "GPGKeyList": {
  14624. "description": "GPGKeyList",
  14625. "schema": {
  14626. "type": "array",
  14627. "items": {
  14628. "$ref": "#/definitions/GPGKey"
  14629. }
  14630. }
  14631. },
  14632. "GitBlobResponse": {
  14633. "description": "GitBlobResponse",
  14634. "schema": {
  14635. "$ref": "#/definitions/GitBlobResponse"
  14636. }
  14637. },
  14638. "GitHook": {
  14639. "description": "GitHook",
  14640. "schema": {
  14641. "$ref": "#/definitions/GitHook"
  14642. }
  14643. },
  14644. "GitHookList": {
  14645. "description": "GitHookList",
  14646. "schema": {
  14647. "type": "array",
  14648. "items": {
  14649. "$ref": "#/definitions/GitHook"
  14650. }
  14651. }
  14652. },
  14653. "GitTreeResponse": {
  14654. "description": "GitTreeResponse",
  14655. "schema": {
  14656. "$ref": "#/definitions/GitTreeResponse"
  14657. }
  14658. },
  14659. "Hook": {
  14660. "description": "Hook",
  14661. "schema": {
  14662. "$ref": "#/definitions/Hook"
  14663. }
  14664. },
  14665. "HookList": {
  14666. "description": "HookList",
  14667. "schema": {
  14668. "type": "array",
  14669. "items": {
  14670. "$ref": "#/definitions/Hook"
  14671. }
  14672. }
  14673. },
  14674. "Issue": {
  14675. "description": "Issue",
  14676. "schema": {
  14677. "$ref": "#/definitions/Issue"
  14678. }
  14679. },
  14680. "IssueDeadline": {
  14681. "description": "IssueDeadline",
  14682. "schema": {
  14683. "$ref": "#/definitions/IssueDeadline"
  14684. }
  14685. },
  14686. "IssueList": {
  14687. "description": "IssueList",
  14688. "schema": {
  14689. "type": "array",
  14690. "items": {
  14691. "$ref": "#/definitions/Issue"
  14692. }
  14693. }
  14694. },
  14695. "Label": {
  14696. "description": "Label",
  14697. "schema": {
  14698. "$ref": "#/definitions/Label"
  14699. }
  14700. },
  14701. "LabelList": {
  14702. "description": "LabelList",
  14703. "schema": {
  14704. "type": "array",
  14705. "items": {
  14706. "$ref": "#/definitions/Label"
  14707. }
  14708. }
  14709. },
  14710. "MarkdownRender": {
  14711. "description": "MarkdownRender is a rendered markdown document",
  14712. "schema": {
  14713. "type": "string"
  14714. }
  14715. },
  14716. "Milestone": {
  14717. "description": "Milestone",
  14718. "schema": {
  14719. "$ref": "#/definitions/Milestone"
  14720. }
  14721. },
  14722. "MilestoneList": {
  14723. "description": "MilestoneList",
  14724. "schema": {
  14725. "type": "array",
  14726. "items": {
  14727. "$ref": "#/definitions/Milestone"
  14728. }
  14729. }
  14730. },
  14731. "NotificationCount": {
  14732. "description": "Number of unread notifications",
  14733. "schema": {
  14734. "$ref": "#/definitions/NotificationCount"
  14735. }
  14736. },
  14737. "NotificationThread": {
  14738. "description": "NotificationThread",
  14739. "schema": {
  14740. "$ref": "#/definitions/NotificationThread"
  14741. }
  14742. },
  14743. "NotificationThreadList": {
  14744. "description": "NotificationThreadList",
  14745. "schema": {
  14746. "type": "array",
  14747. "items": {
  14748. "$ref": "#/definitions/NotificationThread"
  14749. }
  14750. }
  14751. },
  14752. "OAuth2Application": {
  14753. "description": "OAuth2Application",
  14754. "schema": {
  14755. "$ref": "#/definitions/OAuth2Application"
  14756. }
  14757. },
  14758. "OAuth2ApplicationList": {
  14759. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  14760. "schema": {
  14761. "type": "array",
  14762. "items": {
  14763. "$ref": "#/definitions/OAuth2Application"
  14764. }
  14765. }
  14766. },
  14767. "Organization": {
  14768. "description": "Organization",
  14769. "schema": {
  14770. "$ref": "#/definitions/Organization"
  14771. }
  14772. },
  14773. "OrganizationList": {
  14774. "description": "OrganizationList",
  14775. "schema": {
  14776. "type": "array",
  14777. "items": {
  14778. "$ref": "#/definitions/Organization"
  14779. }
  14780. }
  14781. },
  14782. "PublicKey": {
  14783. "description": "PublicKey",
  14784. "schema": {
  14785. "$ref": "#/definitions/PublicKey"
  14786. }
  14787. },
  14788. "PublicKeyList": {
  14789. "description": "PublicKeyList",
  14790. "schema": {
  14791. "type": "array",
  14792. "items": {
  14793. "$ref": "#/definitions/PublicKey"
  14794. }
  14795. }
  14796. },
  14797. "PullRequest": {
  14798. "description": "PullRequest",
  14799. "schema": {
  14800. "$ref": "#/definitions/PullRequest"
  14801. }
  14802. },
  14803. "PullRequestList": {
  14804. "description": "PullRequestList",
  14805. "schema": {
  14806. "type": "array",
  14807. "items": {
  14808. "$ref": "#/definitions/PullRequest"
  14809. }
  14810. }
  14811. },
  14812. "PullReview": {
  14813. "description": "PullReview",
  14814. "schema": {
  14815. "$ref": "#/definitions/PullReview"
  14816. }
  14817. },
  14818. "PullReviewComment": {
  14819. "description": "PullComment",
  14820. "schema": {
  14821. "$ref": "#/definitions/PullReviewComment"
  14822. }
  14823. },
  14824. "PullReviewCommentList": {
  14825. "description": "PullCommentList",
  14826. "schema": {
  14827. "type": "array",
  14828. "items": {
  14829. "$ref": "#/definitions/PullReviewComment"
  14830. }
  14831. }
  14832. },
  14833. "PullReviewList": {
  14834. "description": "PullReviewList",
  14835. "schema": {
  14836. "type": "array",
  14837. "items": {
  14838. "$ref": "#/definitions/PullReview"
  14839. }
  14840. }
  14841. },
  14842. "Reaction": {
  14843. "description": "Reaction",
  14844. "schema": {
  14845. "$ref": "#/definitions/Reaction"
  14846. }
  14847. },
  14848. "ReactionList": {
  14849. "description": "ReactionList",
  14850. "schema": {
  14851. "type": "array",
  14852. "items": {
  14853. "$ref": "#/definitions/Reaction"
  14854. }
  14855. }
  14856. },
  14857. "Reference": {
  14858. "description": "Reference",
  14859. "schema": {
  14860. "$ref": "#/definitions/Reference"
  14861. }
  14862. },
  14863. "ReferenceList": {
  14864. "description": "ReferenceList",
  14865. "schema": {
  14866. "type": "array",
  14867. "items": {
  14868. "$ref": "#/definitions/Reference"
  14869. }
  14870. }
  14871. },
  14872. "Release": {
  14873. "description": "Release",
  14874. "schema": {
  14875. "$ref": "#/definitions/Release"
  14876. }
  14877. },
  14878. "ReleaseList": {
  14879. "description": "ReleaseList",
  14880. "schema": {
  14881. "type": "array",
  14882. "items": {
  14883. "$ref": "#/definitions/Release"
  14884. }
  14885. }
  14886. },
  14887. "Repository": {
  14888. "description": "Repository",
  14889. "schema": {
  14890. "$ref": "#/definitions/Repository"
  14891. }
  14892. },
  14893. "RepositoryList": {
  14894. "description": "RepositoryList",
  14895. "schema": {
  14896. "type": "array",
  14897. "items": {
  14898. "$ref": "#/definitions/Repository"
  14899. }
  14900. }
  14901. },
  14902. "SearchResults": {
  14903. "description": "SearchResults",
  14904. "schema": {
  14905. "$ref": "#/definitions/SearchResults"
  14906. }
  14907. },
  14908. "ServerVersion": {
  14909. "description": "ServerVersion",
  14910. "schema": {
  14911. "$ref": "#/definitions/ServerVersion"
  14912. }
  14913. },
  14914. "Status": {
  14915. "description": "Status",
  14916. "schema": {
  14917. "$ref": "#/definitions/Status"
  14918. }
  14919. },
  14920. "StatusList": {
  14921. "description": "StatusList",
  14922. "schema": {
  14923. "type": "array",
  14924. "items": {
  14925. "$ref": "#/definitions/Status"
  14926. }
  14927. }
  14928. },
  14929. "StopWatch": {
  14930. "description": "StopWatch",
  14931. "schema": {
  14932. "$ref": "#/definitions/StopWatch"
  14933. }
  14934. },
  14935. "StopWatchList": {
  14936. "description": "StopWatchList",
  14937. "schema": {
  14938. "type": "array",
  14939. "items": {
  14940. "$ref": "#/definitions/StopWatch"
  14941. }
  14942. }
  14943. },
  14944. "Tag": {
  14945. "description": "Tag",
  14946. "schema": {
  14947. "$ref": "#/definitions/Tag"
  14948. }
  14949. },
  14950. "TagList": {
  14951. "description": "TagList",
  14952. "schema": {
  14953. "type": "array",
  14954. "items": {
  14955. "$ref": "#/definitions/Tag"
  14956. }
  14957. }
  14958. },
  14959. "Team": {
  14960. "description": "Team",
  14961. "schema": {
  14962. "$ref": "#/definitions/Team"
  14963. }
  14964. },
  14965. "TeamList": {
  14966. "description": "TeamList",
  14967. "schema": {
  14968. "type": "array",
  14969. "items": {
  14970. "$ref": "#/definitions/Team"
  14971. }
  14972. }
  14973. },
  14974. "TopicListResponse": {
  14975. "description": "TopicListResponse",
  14976. "schema": {
  14977. "type": "array",
  14978. "items": {
  14979. "$ref": "#/definitions/TopicResponse"
  14980. }
  14981. }
  14982. },
  14983. "TopicNames": {
  14984. "description": "TopicNames",
  14985. "schema": {
  14986. "$ref": "#/definitions/TopicName"
  14987. }
  14988. },
  14989. "TrackedTime": {
  14990. "description": "TrackedTime",
  14991. "schema": {
  14992. "$ref": "#/definitions/TrackedTime"
  14993. }
  14994. },
  14995. "TrackedTimeList": {
  14996. "description": "TrackedTimeList",
  14997. "schema": {
  14998. "type": "array",
  14999. "items": {
  15000. "$ref": "#/definitions/TrackedTime"
  15001. }
  15002. }
  15003. },
  15004. "User": {
  15005. "description": "User",
  15006. "schema": {
  15007. "$ref": "#/definitions/User"
  15008. }
  15009. },
  15010. "UserHeatmapData": {
  15011. "description": "UserHeatmapData",
  15012. "schema": {
  15013. "type": "array",
  15014. "items": {
  15015. "$ref": "#/definitions/UserHeatmapData"
  15016. }
  15017. }
  15018. },
  15019. "UserList": {
  15020. "description": "UserList",
  15021. "schema": {
  15022. "type": "array",
  15023. "items": {
  15024. "$ref": "#/definitions/User"
  15025. }
  15026. }
  15027. },
  15028. "WatchInfo": {
  15029. "description": "WatchInfo",
  15030. "schema": {
  15031. "$ref": "#/definitions/WatchInfo"
  15032. }
  15033. },
  15034. "empty": {
  15035. "description": "APIEmpty is an empty response"
  15036. },
  15037. "error": {
  15038. "description": "APIError is error format response",
  15039. "headers": {
  15040. "message": {
  15041. "type": "string"
  15042. },
  15043. "url": {
  15044. "type": "string"
  15045. }
  15046. }
  15047. },
  15048. "forbidden": {
  15049. "description": "APIForbiddenError is a forbidden error response",
  15050. "headers": {
  15051. "message": {
  15052. "type": "string"
  15053. },
  15054. "url": {
  15055. "type": "string"
  15056. }
  15057. }
  15058. },
  15059. "invalidTopicsError": {
  15060. "description": "APIInvalidTopicsError is error format response to invalid topics",
  15061. "headers": {
  15062. "invalidTopics": {
  15063. "type": "array",
  15064. "items": {
  15065. "type": "string"
  15066. }
  15067. },
  15068. "message": {
  15069. "type": "string"
  15070. }
  15071. }
  15072. },
  15073. "notFound": {
  15074. "description": "APINotFound is a not found empty response"
  15075. },
  15076. "parameterBodies": {
  15077. "description": "parameterBodies",
  15078. "schema": {
  15079. "$ref": "#/definitions/SubmitPullReviewOptions"
  15080. }
  15081. },
  15082. "redirect": {
  15083. "description": "APIRedirect is a redirect response"
  15084. },
  15085. "validationError": {
  15086. "description": "APIValidationError is error format response related to input validation",
  15087. "headers": {
  15088. "message": {
  15089. "type": "string"
  15090. },
  15091. "url": {
  15092. "type": "string"
  15093. }
  15094. }
  15095. }
  15096. },
  15097. "securityDefinitions": {
  15098. "AccessToken": {
  15099. "type": "apiKey",
  15100. "name": "access_token",
  15101. "in": "query"
  15102. },
  15103. "AuthorizationHeaderToken": {
  15104. "description": "API tokens must be prepended with \"token\" followed by a space.",
  15105. "type": "apiKey",
  15106. "name": "Authorization",
  15107. "in": "header"
  15108. },
  15109. "BasicAuth": {
  15110. "type": "basic"
  15111. },
  15112. "SudoHeader": {
  15113. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  15114. "type": "apiKey",
  15115. "name": "Sudo",
  15116. "in": "header"
  15117. },
  15118. "SudoParam": {
  15119. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  15120. "type": "apiKey",
  15121. "name": "sudo",
  15122. "in": "query"
  15123. },
  15124. "Token": {
  15125. "type": "apiKey",
  15126. "name": "token",
  15127. "in": "query"
  15128. }
  15129. },
  15130. "security": [
  15131. {
  15132. "BasicAuth": []
  15133. },
  15134. {
  15135. "Token": []
  15136. },
  15137. {
  15138. "AccessToken": []
  15139. },
  15140. {
  15141. "AuthorizationHeaderToken": []
  15142. },
  15143. {
  15144. "SudoParam": []
  15145. },
  15146. {
  15147. "SudoHeader": []
  15148. }
  15149. ]
  15150. }