index.js 287 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196
  1. 'use strict';
  2. Object.defineProperty(exports, '__esModule', { value: true });
  3. var deprecation = require('deprecation');
  4. var endpointsByScope = {
  5. actions: {
  6. cancelWorkflowRun: {
  7. method: "POST",
  8. params: {
  9. owner: {
  10. required: true,
  11. type: "string"
  12. },
  13. repo: {
  14. required: true,
  15. type: "string"
  16. },
  17. run_id: {
  18. required: true,
  19. type: "integer"
  20. }
  21. },
  22. url: "/repos/:owner/:repo/actions/runs/:run_id/cancel"
  23. },
  24. createOrUpdateSecretForRepo: {
  25. method: "PUT",
  26. params: {
  27. encrypted_value: {
  28. type: "string"
  29. },
  30. key_id: {
  31. type: "string"
  32. },
  33. name: {
  34. required: true,
  35. type: "string"
  36. },
  37. owner: {
  38. required: true,
  39. type: "string"
  40. },
  41. repo: {
  42. required: true,
  43. type: "string"
  44. }
  45. },
  46. url: "/repos/:owner/:repo/actions/secrets/:name"
  47. },
  48. createRegistrationToken: {
  49. method: "POST",
  50. params: {
  51. owner: {
  52. required: true,
  53. type: "string"
  54. },
  55. repo: {
  56. required: true,
  57. type: "string"
  58. }
  59. },
  60. url: "/repos/:owner/:repo/actions/runners/registration-token"
  61. },
  62. createRemoveToken: {
  63. method: "POST",
  64. params: {
  65. owner: {
  66. required: true,
  67. type: "string"
  68. },
  69. repo: {
  70. required: true,
  71. type: "string"
  72. }
  73. },
  74. url: "/repos/:owner/:repo/actions/runners/remove-token"
  75. },
  76. deleteArtifact: {
  77. method: "DELETE",
  78. params: {
  79. artifact_id: {
  80. required: true,
  81. type: "integer"
  82. },
  83. owner: {
  84. required: true,
  85. type: "string"
  86. },
  87. repo: {
  88. required: true,
  89. type: "string"
  90. }
  91. },
  92. url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"
  93. },
  94. deleteSecretFromRepo: {
  95. method: "DELETE",
  96. params: {
  97. name: {
  98. required: true,
  99. type: "string"
  100. },
  101. owner: {
  102. required: true,
  103. type: "string"
  104. },
  105. repo: {
  106. required: true,
  107. type: "string"
  108. }
  109. },
  110. url: "/repos/:owner/:repo/actions/secrets/:name"
  111. },
  112. downloadArtifact: {
  113. method: "GET",
  114. params: {
  115. archive_format: {
  116. required: true,
  117. type: "string"
  118. },
  119. artifact_id: {
  120. required: true,
  121. type: "integer"
  122. },
  123. owner: {
  124. required: true,
  125. type: "string"
  126. },
  127. repo: {
  128. required: true,
  129. type: "string"
  130. }
  131. },
  132. url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"
  133. },
  134. getArtifact: {
  135. method: "GET",
  136. params: {
  137. artifact_id: {
  138. required: true,
  139. type: "integer"
  140. },
  141. owner: {
  142. required: true,
  143. type: "string"
  144. },
  145. repo: {
  146. required: true,
  147. type: "string"
  148. }
  149. },
  150. url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"
  151. },
  152. getPublicKey: {
  153. method: "GET",
  154. params: {
  155. owner: {
  156. required: true,
  157. type: "string"
  158. },
  159. repo: {
  160. required: true,
  161. type: "string"
  162. }
  163. },
  164. url: "/repos/:owner/:repo/actions/secrets/public-key"
  165. },
  166. getSecret: {
  167. method: "GET",
  168. params: {
  169. name: {
  170. required: true,
  171. type: "string"
  172. },
  173. owner: {
  174. required: true,
  175. type: "string"
  176. },
  177. page: {
  178. type: "integer"
  179. },
  180. per_page: {
  181. type: "integer"
  182. },
  183. repo: {
  184. required: true,
  185. type: "string"
  186. }
  187. },
  188. url: "/repos/:owner/:repo/actions/secrets/:name"
  189. },
  190. getSelfHostedRunner: {
  191. method: "GET",
  192. params: {
  193. owner: {
  194. required: true,
  195. type: "string"
  196. },
  197. repo: {
  198. required: true,
  199. type: "string"
  200. },
  201. runner_id: {
  202. required: true,
  203. type: "integer"
  204. }
  205. },
  206. url: "/repos/:owner/:repo/actions/runners/:runner_id"
  207. },
  208. getWorkflow: {
  209. method: "GET",
  210. params: {
  211. owner: {
  212. required: true,
  213. type: "string"
  214. },
  215. repo: {
  216. required: true,
  217. type: "string"
  218. },
  219. workflow_id: {
  220. required: true,
  221. type: "integer"
  222. }
  223. },
  224. url: "/repos/:owner/:repo/actions/workflows/:workflow_id"
  225. },
  226. getWorkflowJob: {
  227. method: "GET",
  228. params: {
  229. job_id: {
  230. required: true,
  231. type: "integer"
  232. },
  233. owner: {
  234. required: true,
  235. type: "string"
  236. },
  237. repo: {
  238. required: true,
  239. type: "string"
  240. }
  241. },
  242. url: "/repos/:owner/:repo/actions/jobs/:job_id"
  243. },
  244. getWorkflowRun: {
  245. method: "GET",
  246. params: {
  247. owner: {
  248. required: true,
  249. type: "string"
  250. },
  251. repo: {
  252. required: true,
  253. type: "string"
  254. },
  255. run_id: {
  256. required: true,
  257. type: "integer"
  258. }
  259. },
  260. url: "/repos/:owner/:repo/actions/runs/:run_id"
  261. },
  262. listDownloadsForSelfHostedRunnerApplication: {
  263. method: "GET",
  264. params: {
  265. owner: {
  266. required: true,
  267. type: "string"
  268. },
  269. repo: {
  270. required: true,
  271. type: "string"
  272. }
  273. },
  274. url: "/repos/:owner/:repo/actions/runners/downloads"
  275. },
  276. listJobsForWorkflowRun: {
  277. method: "GET",
  278. params: {
  279. owner: {
  280. required: true,
  281. type: "string"
  282. },
  283. page: {
  284. type: "integer"
  285. },
  286. per_page: {
  287. type: "integer"
  288. },
  289. repo: {
  290. required: true,
  291. type: "string"
  292. },
  293. run_id: {
  294. required: true,
  295. type: "integer"
  296. }
  297. },
  298. url: "/repos/:owner/:repo/actions/runs/:run_id/jobs"
  299. },
  300. listRepoWorkflowRuns: {
  301. method: "GET",
  302. params: {
  303. actor: {
  304. type: "string"
  305. },
  306. branch: {
  307. type: "string"
  308. },
  309. event: {
  310. type: "string"
  311. },
  312. owner: {
  313. required: true,
  314. type: "string"
  315. },
  316. page: {
  317. type: "integer"
  318. },
  319. per_page: {
  320. type: "integer"
  321. },
  322. repo: {
  323. required: true,
  324. type: "string"
  325. },
  326. status: {
  327. enum: ["completed", "status", "conclusion"],
  328. type: "string"
  329. }
  330. },
  331. url: "/repos/:owner/:repo/actions/runs"
  332. },
  333. listRepoWorkflows: {
  334. method: "GET",
  335. params: {
  336. owner: {
  337. required: true,
  338. type: "string"
  339. },
  340. page: {
  341. type: "integer"
  342. },
  343. per_page: {
  344. type: "integer"
  345. },
  346. repo: {
  347. required: true,
  348. type: "string"
  349. }
  350. },
  351. url: "/repos/:owner/:repo/actions/workflows"
  352. },
  353. listSecretsForRepo: {
  354. method: "GET",
  355. params: {
  356. owner: {
  357. required: true,
  358. type: "string"
  359. },
  360. page: {
  361. type: "integer"
  362. },
  363. per_page: {
  364. type: "integer"
  365. },
  366. repo: {
  367. required: true,
  368. type: "string"
  369. }
  370. },
  371. url: "/repos/:owner/:repo/actions/secrets"
  372. },
  373. listSelfHostedRunnersForRepo: {
  374. method: "GET",
  375. params: {
  376. owner: {
  377. required: true,
  378. type: "string"
  379. },
  380. page: {
  381. type: "integer"
  382. },
  383. per_page: {
  384. type: "integer"
  385. },
  386. repo: {
  387. required: true,
  388. type: "string"
  389. }
  390. },
  391. url: "/repos/:owner/:repo/actions/runners"
  392. },
  393. listWorkflowJobLogs: {
  394. method: "GET",
  395. params: {
  396. job_id: {
  397. required: true,
  398. type: "integer"
  399. },
  400. owner: {
  401. required: true,
  402. type: "string"
  403. },
  404. page: {
  405. type: "integer"
  406. },
  407. per_page: {
  408. type: "integer"
  409. },
  410. repo: {
  411. required: true,
  412. type: "string"
  413. }
  414. },
  415. url: "/repos/:owner/:repo/actions/jobs/:job_id/logs"
  416. },
  417. listWorkflowRunArtifacts: {
  418. method: "GET",
  419. params: {
  420. owner: {
  421. required: true,
  422. type: "string"
  423. },
  424. page: {
  425. type: "integer"
  426. },
  427. per_page: {
  428. type: "integer"
  429. },
  430. repo: {
  431. required: true,
  432. type: "string"
  433. },
  434. run_id: {
  435. required: true,
  436. type: "integer"
  437. }
  438. },
  439. url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts"
  440. },
  441. listWorkflowRunLogs: {
  442. method: "GET",
  443. params: {
  444. owner: {
  445. required: true,
  446. type: "string"
  447. },
  448. page: {
  449. type: "integer"
  450. },
  451. per_page: {
  452. type: "integer"
  453. },
  454. repo: {
  455. required: true,
  456. type: "string"
  457. },
  458. run_id: {
  459. required: true,
  460. type: "integer"
  461. }
  462. },
  463. url: "/repos/:owner/:repo/actions/runs/:run_id/logs"
  464. },
  465. listWorkflowRuns: {
  466. method: "GET",
  467. params: {
  468. actor: {
  469. type: "string"
  470. },
  471. branch: {
  472. type: "string"
  473. },
  474. event: {
  475. type: "string"
  476. },
  477. owner: {
  478. required: true,
  479. type: "string"
  480. },
  481. page: {
  482. type: "integer"
  483. },
  484. per_page: {
  485. type: "integer"
  486. },
  487. repo: {
  488. required: true,
  489. type: "string"
  490. },
  491. status: {
  492. enum: ["completed", "status", "conclusion"],
  493. type: "string"
  494. },
  495. workflow_id: {
  496. required: true,
  497. type: "integer"
  498. }
  499. },
  500. url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs"
  501. },
  502. reRunWorkflow: {
  503. method: "POST",
  504. params: {
  505. owner: {
  506. required: true,
  507. type: "string"
  508. },
  509. repo: {
  510. required: true,
  511. type: "string"
  512. },
  513. run_id: {
  514. required: true,
  515. type: "integer"
  516. }
  517. },
  518. url: "/repos/:owner/:repo/actions/runs/:run_id/rerun"
  519. },
  520. removeSelfHostedRunner: {
  521. method: "DELETE",
  522. params: {
  523. owner: {
  524. required: true,
  525. type: "string"
  526. },
  527. repo: {
  528. required: true,
  529. type: "string"
  530. },
  531. runner_id: {
  532. required: true,
  533. type: "integer"
  534. }
  535. },
  536. url: "/repos/:owner/:repo/actions/runners/:runner_id"
  537. }
  538. },
  539. activity: {
  540. checkStarringRepo: {
  541. method: "GET",
  542. params: {
  543. owner: {
  544. required: true,
  545. type: "string"
  546. },
  547. repo: {
  548. required: true,
  549. type: "string"
  550. }
  551. },
  552. url: "/user/starred/:owner/:repo"
  553. },
  554. deleteRepoSubscription: {
  555. method: "DELETE",
  556. params: {
  557. owner: {
  558. required: true,
  559. type: "string"
  560. },
  561. repo: {
  562. required: true,
  563. type: "string"
  564. }
  565. },
  566. url: "/repos/:owner/:repo/subscription"
  567. },
  568. deleteThreadSubscription: {
  569. method: "DELETE",
  570. params: {
  571. thread_id: {
  572. required: true,
  573. type: "integer"
  574. }
  575. },
  576. url: "/notifications/threads/:thread_id/subscription"
  577. },
  578. getRepoSubscription: {
  579. method: "GET",
  580. params: {
  581. owner: {
  582. required: true,
  583. type: "string"
  584. },
  585. repo: {
  586. required: true,
  587. type: "string"
  588. }
  589. },
  590. url: "/repos/:owner/:repo/subscription"
  591. },
  592. getThread: {
  593. method: "GET",
  594. params: {
  595. thread_id: {
  596. required: true,
  597. type: "integer"
  598. }
  599. },
  600. url: "/notifications/threads/:thread_id"
  601. },
  602. getThreadSubscription: {
  603. method: "GET",
  604. params: {
  605. thread_id: {
  606. required: true,
  607. type: "integer"
  608. }
  609. },
  610. url: "/notifications/threads/:thread_id/subscription"
  611. },
  612. listEventsForOrg: {
  613. method: "GET",
  614. params: {
  615. org: {
  616. required: true,
  617. type: "string"
  618. },
  619. page: {
  620. type: "integer"
  621. },
  622. per_page: {
  623. type: "integer"
  624. },
  625. username: {
  626. required: true,
  627. type: "string"
  628. }
  629. },
  630. url: "/users/:username/events/orgs/:org"
  631. },
  632. listEventsForUser: {
  633. method: "GET",
  634. params: {
  635. page: {
  636. type: "integer"
  637. },
  638. per_page: {
  639. type: "integer"
  640. },
  641. username: {
  642. required: true,
  643. type: "string"
  644. }
  645. },
  646. url: "/users/:username/events"
  647. },
  648. listFeeds: {
  649. method: "GET",
  650. params: {},
  651. url: "/feeds"
  652. },
  653. listNotifications: {
  654. method: "GET",
  655. params: {
  656. all: {
  657. type: "boolean"
  658. },
  659. before: {
  660. type: "string"
  661. },
  662. page: {
  663. type: "integer"
  664. },
  665. participating: {
  666. type: "boolean"
  667. },
  668. per_page: {
  669. type: "integer"
  670. },
  671. since: {
  672. type: "string"
  673. }
  674. },
  675. url: "/notifications"
  676. },
  677. listNotificationsForRepo: {
  678. method: "GET",
  679. params: {
  680. all: {
  681. type: "boolean"
  682. },
  683. before: {
  684. type: "string"
  685. },
  686. owner: {
  687. required: true,
  688. type: "string"
  689. },
  690. page: {
  691. type: "integer"
  692. },
  693. participating: {
  694. type: "boolean"
  695. },
  696. per_page: {
  697. type: "integer"
  698. },
  699. repo: {
  700. required: true,
  701. type: "string"
  702. },
  703. since: {
  704. type: "string"
  705. }
  706. },
  707. url: "/repos/:owner/:repo/notifications"
  708. },
  709. listPublicEvents: {
  710. method: "GET",
  711. params: {
  712. page: {
  713. type: "integer"
  714. },
  715. per_page: {
  716. type: "integer"
  717. }
  718. },
  719. url: "/events"
  720. },
  721. listPublicEventsForOrg: {
  722. method: "GET",
  723. params: {
  724. org: {
  725. required: true,
  726. type: "string"
  727. },
  728. page: {
  729. type: "integer"
  730. },
  731. per_page: {
  732. type: "integer"
  733. }
  734. },
  735. url: "/orgs/:org/events"
  736. },
  737. listPublicEventsForRepoNetwork: {
  738. method: "GET",
  739. params: {
  740. owner: {
  741. required: true,
  742. type: "string"
  743. },
  744. page: {
  745. type: "integer"
  746. },
  747. per_page: {
  748. type: "integer"
  749. },
  750. repo: {
  751. required: true,
  752. type: "string"
  753. }
  754. },
  755. url: "/networks/:owner/:repo/events"
  756. },
  757. listPublicEventsForUser: {
  758. method: "GET",
  759. params: {
  760. page: {
  761. type: "integer"
  762. },
  763. per_page: {
  764. type: "integer"
  765. },
  766. username: {
  767. required: true,
  768. type: "string"
  769. }
  770. },
  771. url: "/users/:username/events/public"
  772. },
  773. listReceivedEventsForUser: {
  774. method: "GET",
  775. params: {
  776. page: {
  777. type: "integer"
  778. },
  779. per_page: {
  780. type: "integer"
  781. },
  782. username: {
  783. required: true,
  784. type: "string"
  785. }
  786. },
  787. url: "/users/:username/received_events"
  788. },
  789. listReceivedPublicEventsForUser: {
  790. method: "GET",
  791. params: {
  792. page: {
  793. type: "integer"
  794. },
  795. per_page: {
  796. type: "integer"
  797. },
  798. username: {
  799. required: true,
  800. type: "string"
  801. }
  802. },
  803. url: "/users/:username/received_events/public"
  804. },
  805. listRepoEvents: {
  806. method: "GET",
  807. params: {
  808. owner: {
  809. required: true,
  810. type: "string"
  811. },
  812. page: {
  813. type: "integer"
  814. },
  815. per_page: {
  816. type: "integer"
  817. },
  818. repo: {
  819. required: true,
  820. type: "string"
  821. }
  822. },
  823. url: "/repos/:owner/:repo/events"
  824. },
  825. listReposStarredByAuthenticatedUser: {
  826. method: "GET",
  827. params: {
  828. direction: {
  829. enum: ["asc", "desc"],
  830. type: "string"
  831. },
  832. page: {
  833. type: "integer"
  834. },
  835. per_page: {
  836. type: "integer"
  837. },
  838. sort: {
  839. enum: ["created", "updated"],
  840. type: "string"
  841. }
  842. },
  843. url: "/user/starred"
  844. },
  845. listReposStarredByUser: {
  846. method: "GET",
  847. params: {
  848. direction: {
  849. enum: ["asc", "desc"],
  850. type: "string"
  851. },
  852. page: {
  853. type: "integer"
  854. },
  855. per_page: {
  856. type: "integer"
  857. },
  858. sort: {
  859. enum: ["created", "updated"],
  860. type: "string"
  861. },
  862. username: {
  863. required: true,
  864. type: "string"
  865. }
  866. },
  867. url: "/users/:username/starred"
  868. },
  869. listReposWatchedByUser: {
  870. method: "GET",
  871. params: {
  872. page: {
  873. type: "integer"
  874. },
  875. per_page: {
  876. type: "integer"
  877. },
  878. username: {
  879. required: true,
  880. type: "string"
  881. }
  882. },
  883. url: "/users/:username/subscriptions"
  884. },
  885. listStargazersForRepo: {
  886. method: "GET",
  887. params: {
  888. owner: {
  889. required: true,
  890. type: "string"
  891. },
  892. page: {
  893. type: "integer"
  894. },
  895. per_page: {
  896. type: "integer"
  897. },
  898. repo: {
  899. required: true,
  900. type: "string"
  901. }
  902. },
  903. url: "/repos/:owner/:repo/stargazers"
  904. },
  905. listWatchedReposForAuthenticatedUser: {
  906. method: "GET",
  907. params: {
  908. page: {
  909. type: "integer"
  910. },
  911. per_page: {
  912. type: "integer"
  913. }
  914. },
  915. url: "/user/subscriptions"
  916. },
  917. listWatchersForRepo: {
  918. method: "GET",
  919. params: {
  920. owner: {
  921. required: true,
  922. type: "string"
  923. },
  924. page: {
  925. type: "integer"
  926. },
  927. per_page: {
  928. type: "integer"
  929. },
  930. repo: {
  931. required: true,
  932. type: "string"
  933. }
  934. },
  935. url: "/repos/:owner/:repo/subscribers"
  936. },
  937. markAsRead: {
  938. method: "PUT",
  939. params: {
  940. last_read_at: {
  941. type: "string"
  942. }
  943. },
  944. url: "/notifications"
  945. },
  946. markNotificationsAsReadForRepo: {
  947. method: "PUT",
  948. params: {
  949. last_read_at: {
  950. type: "string"
  951. },
  952. owner: {
  953. required: true,
  954. type: "string"
  955. },
  956. repo: {
  957. required: true,
  958. type: "string"
  959. }
  960. },
  961. url: "/repos/:owner/:repo/notifications"
  962. },
  963. markThreadAsRead: {
  964. method: "PATCH",
  965. params: {
  966. thread_id: {
  967. required: true,
  968. type: "integer"
  969. }
  970. },
  971. url: "/notifications/threads/:thread_id"
  972. },
  973. setRepoSubscription: {
  974. method: "PUT",
  975. params: {
  976. ignored: {
  977. type: "boolean"
  978. },
  979. owner: {
  980. required: true,
  981. type: "string"
  982. },
  983. repo: {
  984. required: true,
  985. type: "string"
  986. },
  987. subscribed: {
  988. type: "boolean"
  989. }
  990. },
  991. url: "/repos/:owner/:repo/subscription"
  992. },
  993. setThreadSubscription: {
  994. method: "PUT",
  995. params: {
  996. ignored: {
  997. type: "boolean"
  998. },
  999. thread_id: {
  1000. required: true,
  1001. type: "integer"
  1002. }
  1003. },
  1004. url: "/notifications/threads/:thread_id/subscription"
  1005. },
  1006. starRepo: {
  1007. method: "PUT",
  1008. params: {
  1009. owner: {
  1010. required: true,
  1011. type: "string"
  1012. },
  1013. repo: {
  1014. required: true,
  1015. type: "string"
  1016. }
  1017. },
  1018. url: "/user/starred/:owner/:repo"
  1019. },
  1020. unstarRepo: {
  1021. method: "DELETE",
  1022. params: {
  1023. owner: {
  1024. required: true,
  1025. type: "string"
  1026. },
  1027. repo: {
  1028. required: true,
  1029. type: "string"
  1030. }
  1031. },
  1032. url: "/user/starred/:owner/:repo"
  1033. }
  1034. },
  1035. apps: {
  1036. addRepoToInstallation: {
  1037. headers: {
  1038. accept: "application/vnd.github.machine-man-preview+json"
  1039. },
  1040. method: "PUT",
  1041. params: {
  1042. installation_id: {
  1043. required: true,
  1044. type: "integer"
  1045. },
  1046. repository_id: {
  1047. required: true,
  1048. type: "integer"
  1049. }
  1050. },
  1051. url: "/user/installations/:installation_id/repositories/:repository_id"
  1052. },
  1053. checkAccountIsAssociatedWithAny: {
  1054. method: "GET",
  1055. params: {
  1056. account_id: {
  1057. required: true,
  1058. type: "integer"
  1059. }
  1060. },
  1061. url: "/marketplace_listing/accounts/:account_id"
  1062. },
  1063. checkAccountIsAssociatedWithAnyStubbed: {
  1064. method: "GET",
  1065. params: {
  1066. account_id: {
  1067. required: true,
  1068. type: "integer"
  1069. }
  1070. },
  1071. url: "/marketplace_listing/stubbed/accounts/:account_id"
  1072. },
  1073. checkAuthorization: {
  1074. deprecated: "octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization",
  1075. method: "GET",
  1076. params: {
  1077. access_token: {
  1078. required: true,
  1079. type: "string"
  1080. },
  1081. client_id: {
  1082. required: true,
  1083. type: "string"
  1084. }
  1085. },
  1086. url: "/applications/:client_id/tokens/:access_token"
  1087. },
  1088. checkToken: {
  1089. headers: {
  1090. accept: "application/vnd.github.doctor-strange-preview+json"
  1091. },
  1092. method: "POST",
  1093. params: {
  1094. access_token: {
  1095. type: "string"
  1096. },
  1097. client_id: {
  1098. required: true,
  1099. type: "string"
  1100. }
  1101. },
  1102. url: "/applications/:client_id/token"
  1103. },
  1104. createContentAttachment: {
  1105. headers: {
  1106. accept: "application/vnd.github.corsair-preview+json"
  1107. },
  1108. method: "POST",
  1109. params: {
  1110. body: {
  1111. required: true,
  1112. type: "string"
  1113. },
  1114. content_reference_id: {
  1115. required: true,
  1116. type: "integer"
  1117. },
  1118. title: {
  1119. required: true,
  1120. type: "string"
  1121. }
  1122. },
  1123. url: "/content_references/:content_reference_id/attachments"
  1124. },
  1125. createFromManifest: {
  1126. headers: {
  1127. accept: "application/vnd.github.fury-preview+json"
  1128. },
  1129. method: "POST",
  1130. params: {
  1131. code: {
  1132. required: true,
  1133. type: "string"
  1134. }
  1135. },
  1136. url: "/app-manifests/:code/conversions"
  1137. },
  1138. createInstallationToken: {
  1139. headers: {
  1140. accept: "application/vnd.github.machine-man-preview+json"
  1141. },
  1142. method: "POST",
  1143. params: {
  1144. installation_id: {
  1145. required: true,
  1146. type: "integer"
  1147. },
  1148. permissions: {
  1149. type: "object"
  1150. },
  1151. repository_ids: {
  1152. type: "integer[]"
  1153. }
  1154. },
  1155. url: "/app/installations/:installation_id/access_tokens"
  1156. },
  1157. deleteAuthorization: {
  1158. headers: {
  1159. accept: "application/vnd.github.doctor-strange-preview+json"
  1160. },
  1161. method: "DELETE",
  1162. params: {
  1163. access_token: {
  1164. type: "string"
  1165. },
  1166. client_id: {
  1167. required: true,
  1168. type: "string"
  1169. }
  1170. },
  1171. url: "/applications/:client_id/grant"
  1172. },
  1173. deleteInstallation: {
  1174. headers: {
  1175. accept: "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json"
  1176. },
  1177. method: "DELETE",
  1178. params: {
  1179. installation_id: {
  1180. required: true,
  1181. type: "integer"
  1182. }
  1183. },
  1184. url: "/app/installations/:installation_id"
  1185. },
  1186. deleteToken: {
  1187. headers: {
  1188. accept: "application/vnd.github.doctor-strange-preview+json"
  1189. },
  1190. method: "DELETE",
  1191. params: {
  1192. access_token: {
  1193. type: "string"
  1194. },
  1195. client_id: {
  1196. required: true,
  1197. type: "string"
  1198. }
  1199. },
  1200. url: "/applications/:client_id/token"
  1201. },
  1202. findOrgInstallation: {
  1203. deprecated: "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)",
  1204. headers: {
  1205. accept: "application/vnd.github.machine-man-preview+json"
  1206. },
  1207. method: "GET",
  1208. params: {
  1209. org: {
  1210. required: true,
  1211. type: "string"
  1212. }
  1213. },
  1214. url: "/orgs/:org/installation"
  1215. },
  1216. findRepoInstallation: {
  1217. deprecated: "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)",
  1218. headers: {
  1219. accept: "application/vnd.github.machine-man-preview+json"
  1220. },
  1221. method: "GET",
  1222. params: {
  1223. owner: {
  1224. required: true,
  1225. type: "string"
  1226. },
  1227. repo: {
  1228. required: true,
  1229. type: "string"
  1230. }
  1231. },
  1232. url: "/repos/:owner/:repo/installation"
  1233. },
  1234. findUserInstallation: {
  1235. deprecated: "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)",
  1236. headers: {
  1237. accept: "application/vnd.github.machine-man-preview+json"
  1238. },
  1239. method: "GET",
  1240. params: {
  1241. username: {
  1242. required: true,
  1243. type: "string"
  1244. }
  1245. },
  1246. url: "/users/:username/installation"
  1247. },
  1248. getAuthenticated: {
  1249. headers: {
  1250. accept: "application/vnd.github.machine-man-preview+json"
  1251. },
  1252. method: "GET",
  1253. params: {},
  1254. url: "/app"
  1255. },
  1256. getBySlug: {
  1257. headers: {
  1258. accept: "application/vnd.github.machine-man-preview+json"
  1259. },
  1260. method: "GET",
  1261. params: {
  1262. app_slug: {
  1263. required: true,
  1264. type: "string"
  1265. }
  1266. },
  1267. url: "/apps/:app_slug"
  1268. },
  1269. getInstallation: {
  1270. headers: {
  1271. accept: "application/vnd.github.machine-man-preview+json"
  1272. },
  1273. method: "GET",
  1274. params: {
  1275. installation_id: {
  1276. required: true,
  1277. type: "integer"
  1278. }
  1279. },
  1280. url: "/app/installations/:installation_id"
  1281. },
  1282. getOrgInstallation: {
  1283. headers: {
  1284. accept: "application/vnd.github.machine-man-preview+json"
  1285. },
  1286. method: "GET",
  1287. params: {
  1288. org: {
  1289. required: true,
  1290. type: "string"
  1291. }
  1292. },
  1293. url: "/orgs/:org/installation"
  1294. },
  1295. getRepoInstallation: {
  1296. headers: {
  1297. accept: "application/vnd.github.machine-man-preview+json"
  1298. },
  1299. method: "GET",
  1300. params: {
  1301. owner: {
  1302. required: true,
  1303. type: "string"
  1304. },
  1305. repo: {
  1306. required: true,
  1307. type: "string"
  1308. }
  1309. },
  1310. url: "/repos/:owner/:repo/installation"
  1311. },
  1312. getUserInstallation: {
  1313. headers: {
  1314. accept: "application/vnd.github.machine-man-preview+json"
  1315. },
  1316. method: "GET",
  1317. params: {
  1318. username: {
  1319. required: true,
  1320. type: "string"
  1321. }
  1322. },
  1323. url: "/users/:username/installation"
  1324. },
  1325. listAccountsUserOrOrgOnPlan: {
  1326. method: "GET",
  1327. params: {
  1328. direction: {
  1329. enum: ["asc", "desc"],
  1330. type: "string"
  1331. },
  1332. page: {
  1333. type: "integer"
  1334. },
  1335. per_page: {
  1336. type: "integer"
  1337. },
  1338. plan_id: {
  1339. required: true,
  1340. type: "integer"
  1341. },
  1342. sort: {
  1343. enum: ["created", "updated"],
  1344. type: "string"
  1345. }
  1346. },
  1347. url: "/marketplace_listing/plans/:plan_id/accounts"
  1348. },
  1349. listAccountsUserOrOrgOnPlanStubbed: {
  1350. method: "GET",
  1351. params: {
  1352. direction: {
  1353. enum: ["asc", "desc"],
  1354. type: "string"
  1355. },
  1356. page: {
  1357. type: "integer"
  1358. },
  1359. per_page: {
  1360. type: "integer"
  1361. },
  1362. plan_id: {
  1363. required: true,
  1364. type: "integer"
  1365. },
  1366. sort: {
  1367. enum: ["created", "updated"],
  1368. type: "string"
  1369. }
  1370. },
  1371. url: "/marketplace_listing/stubbed/plans/:plan_id/accounts"
  1372. },
  1373. listInstallationReposForAuthenticatedUser: {
  1374. headers: {
  1375. accept: "application/vnd.github.machine-man-preview+json"
  1376. },
  1377. method: "GET",
  1378. params: {
  1379. installation_id: {
  1380. required: true,
  1381. type: "integer"
  1382. },
  1383. page: {
  1384. type: "integer"
  1385. },
  1386. per_page: {
  1387. type: "integer"
  1388. }
  1389. },
  1390. url: "/user/installations/:installation_id/repositories"
  1391. },
  1392. listInstallations: {
  1393. headers: {
  1394. accept: "application/vnd.github.machine-man-preview+json"
  1395. },
  1396. method: "GET",
  1397. params: {
  1398. page: {
  1399. type: "integer"
  1400. },
  1401. per_page: {
  1402. type: "integer"
  1403. }
  1404. },
  1405. url: "/app/installations"
  1406. },
  1407. listInstallationsForAuthenticatedUser: {
  1408. headers: {
  1409. accept: "application/vnd.github.machine-man-preview+json"
  1410. },
  1411. method: "GET",
  1412. params: {
  1413. page: {
  1414. type: "integer"
  1415. },
  1416. per_page: {
  1417. type: "integer"
  1418. }
  1419. },
  1420. url: "/user/installations"
  1421. },
  1422. listMarketplacePurchasesForAuthenticatedUser: {
  1423. method: "GET",
  1424. params: {
  1425. page: {
  1426. type: "integer"
  1427. },
  1428. per_page: {
  1429. type: "integer"
  1430. }
  1431. },
  1432. url: "/user/marketplace_purchases"
  1433. },
  1434. listMarketplacePurchasesForAuthenticatedUserStubbed: {
  1435. method: "GET",
  1436. params: {
  1437. page: {
  1438. type: "integer"
  1439. },
  1440. per_page: {
  1441. type: "integer"
  1442. }
  1443. },
  1444. url: "/user/marketplace_purchases/stubbed"
  1445. },
  1446. listPlans: {
  1447. method: "GET",
  1448. params: {
  1449. page: {
  1450. type: "integer"
  1451. },
  1452. per_page: {
  1453. type: "integer"
  1454. }
  1455. },
  1456. url: "/marketplace_listing/plans"
  1457. },
  1458. listPlansStubbed: {
  1459. method: "GET",
  1460. params: {
  1461. page: {
  1462. type: "integer"
  1463. },
  1464. per_page: {
  1465. type: "integer"
  1466. }
  1467. },
  1468. url: "/marketplace_listing/stubbed/plans"
  1469. },
  1470. listRepos: {
  1471. headers: {
  1472. accept: "application/vnd.github.machine-man-preview+json"
  1473. },
  1474. method: "GET",
  1475. params: {
  1476. page: {
  1477. type: "integer"
  1478. },
  1479. per_page: {
  1480. type: "integer"
  1481. }
  1482. },
  1483. url: "/installation/repositories"
  1484. },
  1485. removeRepoFromInstallation: {
  1486. headers: {
  1487. accept: "application/vnd.github.machine-man-preview+json"
  1488. },
  1489. method: "DELETE",
  1490. params: {
  1491. installation_id: {
  1492. required: true,
  1493. type: "integer"
  1494. },
  1495. repository_id: {
  1496. required: true,
  1497. type: "integer"
  1498. }
  1499. },
  1500. url: "/user/installations/:installation_id/repositories/:repository_id"
  1501. },
  1502. resetAuthorization: {
  1503. deprecated: "octokit.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization",
  1504. method: "POST",
  1505. params: {
  1506. access_token: {
  1507. required: true,
  1508. type: "string"
  1509. },
  1510. client_id: {
  1511. required: true,
  1512. type: "string"
  1513. }
  1514. },
  1515. url: "/applications/:client_id/tokens/:access_token"
  1516. },
  1517. resetToken: {
  1518. headers: {
  1519. accept: "application/vnd.github.doctor-strange-preview+json"
  1520. },
  1521. method: "PATCH",
  1522. params: {
  1523. access_token: {
  1524. type: "string"
  1525. },
  1526. client_id: {
  1527. required: true,
  1528. type: "string"
  1529. }
  1530. },
  1531. url: "/applications/:client_id/token"
  1532. },
  1533. revokeAuthorizationForApplication: {
  1534. deprecated: "octokit.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application",
  1535. method: "DELETE",
  1536. params: {
  1537. access_token: {
  1538. required: true,
  1539. type: "string"
  1540. },
  1541. client_id: {
  1542. required: true,
  1543. type: "string"
  1544. }
  1545. },
  1546. url: "/applications/:client_id/tokens/:access_token"
  1547. },
  1548. revokeGrantForApplication: {
  1549. deprecated: "octokit.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application",
  1550. method: "DELETE",
  1551. params: {
  1552. access_token: {
  1553. required: true,
  1554. type: "string"
  1555. },
  1556. client_id: {
  1557. required: true,
  1558. type: "string"
  1559. }
  1560. },
  1561. url: "/applications/:client_id/grants/:access_token"
  1562. },
  1563. revokeInstallationToken: {
  1564. headers: {
  1565. accept: "application/vnd.github.gambit-preview+json"
  1566. },
  1567. method: "DELETE",
  1568. params: {},
  1569. url: "/installation/token"
  1570. }
  1571. },
  1572. checks: {
  1573. create: {
  1574. headers: {
  1575. accept: "application/vnd.github.antiope-preview+json"
  1576. },
  1577. method: "POST",
  1578. params: {
  1579. actions: {
  1580. type: "object[]"
  1581. },
  1582. "actions[].description": {
  1583. required: true,
  1584. type: "string"
  1585. },
  1586. "actions[].identifier": {
  1587. required: true,
  1588. type: "string"
  1589. },
  1590. "actions[].label": {
  1591. required: true,
  1592. type: "string"
  1593. },
  1594. completed_at: {
  1595. type: "string"
  1596. },
  1597. conclusion: {
  1598. enum: ["success", "failure", "neutral", "cancelled", "timed_out", "action_required"],
  1599. type: "string"
  1600. },
  1601. details_url: {
  1602. type: "string"
  1603. },
  1604. external_id: {
  1605. type: "string"
  1606. },
  1607. head_sha: {
  1608. required: true,
  1609. type: "string"
  1610. },
  1611. name: {
  1612. required: true,
  1613. type: "string"
  1614. },
  1615. output: {
  1616. type: "object"
  1617. },
  1618. "output.annotations": {
  1619. type: "object[]"
  1620. },
  1621. "output.annotations[].annotation_level": {
  1622. enum: ["notice", "warning", "failure"],
  1623. required: true,
  1624. type: "string"
  1625. },
  1626. "output.annotations[].end_column": {
  1627. type: "integer"
  1628. },
  1629. "output.annotations[].end_line": {
  1630. required: true,
  1631. type: "integer"
  1632. },
  1633. "output.annotations[].message": {
  1634. required: true,
  1635. type: "string"
  1636. },
  1637. "output.annotations[].path": {
  1638. required: true,
  1639. type: "string"
  1640. },
  1641. "output.annotations[].raw_details": {
  1642. type: "string"
  1643. },
  1644. "output.annotations[].start_column": {
  1645. type: "integer"
  1646. },
  1647. "output.annotations[].start_line": {
  1648. required: true,
  1649. type: "integer"
  1650. },
  1651. "output.annotations[].title": {
  1652. type: "string"
  1653. },
  1654. "output.images": {
  1655. type: "object[]"
  1656. },
  1657. "output.images[].alt": {
  1658. required: true,
  1659. type: "string"
  1660. },
  1661. "output.images[].caption": {
  1662. type: "string"
  1663. },
  1664. "output.images[].image_url": {
  1665. required: true,
  1666. type: "string"
  1667. },
  1668. "output.summary": {
  1669. required: true,
  1670. type: "string"
  1671. },
  1672. "output.text": {
  1673. type: "string"
  1674. },
  1675. "output.title": {
  1676. required: true,
  1677. type: "string"
  1678. },
  1679. owner: {
  1680. required: true,
  1681. type: "string"
  1682. },
  1683. repo: {
  1684. required: true,
  1685. type: "string"
  1686. },
  1687. started_at: {
  1688. type: "string"
  1689. },
  1690. status: {
  1691. enum: ["queued", "in_progress", "completed"],
  1692. type: "string"
  1693. }
  1694. },
  1695. url: "/repos/:owner/:repo/check-runs"
  1696. },
  1697. createSuite: {
  1698. headers: {
  1699. accept: "application/vnd.github.antiope-preview+json"
  1700. },
  1701. method: "POST",
  1702. params: {
  1703. head_sha: {
  1704. required: true,
  1705. type: "string"
  1706. },
  1707. owner: {
  1708. required: true,
  1709. type: "string"
  1710. },
  1711. repo: {
  1712. required: true,
  1713. type: "string"
  1714. }
  1715. },
  1716. url: "/repos/:owner/:repo/check-suites"
  1717. },
  1718. get: {
  1719. headers: {
  1720. accept: "application/vnd.github.antiope-preview+json"
  1721. },
  1722. method: "GET",
  1723. params: {
  1724. check_run_id: {
  1725. required: true,
  1726. type: "integer"
  1727. },
  1728. owner: {
  1729. required: true,
  1730. type: "string"
  1731. },
  1732. repo: {
  1733. required: true,
  1734. type: "string"
  1735. }
  1736. },
  1737. url: "/repos/:owner/:repo/check-runs/:check_run_id"
  1738. },
  1739. getSuite: {
  1740. headers: {
  1741. accept: "application/vnd.github.antiope-preview+json"
  1742. },
  1743. method: "GET",
  1744. params: {
  1745. check_suite_id: {
  1746. required: true,
  1747. type: "integer"
  1748. },
  1749. owner: {
  1750. required: true,
  1751. type: "string"
  1752. },
  1753. repo: {
  1754. required: true,
  1755. type: "string"
  1756. }
  1757. },
  1758. url: "/repos/:owner/:repo/check-suites/:check_suite_id"
  1759. },
  1760. listAnnotations: {
  1761. headers: {
  1762. accept: "application/vnd.github.antiope-preview+json"
  1763. },
  1764. method: "GET",
  1765. params: {
  1766. check_run_id: {
  1767. required: true,
  1768. type: "integer"
  1769. },
  1770. owner: {
  1771. required: true,
  1772. type: "string"
  1773. },
  1774. page: {
  1775. type: "integer"
  1776. },
  1777. per_page: {
  1778. type: "integer"
  1779. },
  1780. repo: {
  1781. required: true,
  1782. type: "string"
  1783. }
  1784. },
  1785. url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations"
  1786. },
  1787. listForRef: {
  1788. headers: {
  1789. accept: "application/vnd.github.antiope-preview+json"
  1790. },
  1791. method: "GET",
  1792. params: {
  1793. check_name: {
  1794. type: "string"
  1795. },
  1796. filter: {
  1797. enum: ["latest", "all"],
  1798. type: "string"
  1799. },
  1800. owner: {
  1801. required: true,
  1802. type: "string"
  1803. },
  1804. page: {
  1805. type: "integer"
  1806. },
  1807. per_page: {
  1808. type: "integer"
  1809. },
  1810. ref: {
  1811. required: true,
  1812. type: "string"
  1813. },
  1814. repo: {
  1815. required: true,
  1816. type: "string"
  1817. },
  1818. status: {
  1819. enum: ["queued", "in_progress", "completed"],
  1820. type: "string"
  1821. }
  1822. },
  1823. url: "/repos/:owner/:repo/commits/:ref/check-runs"
  1824. },
  1825. listForSuite: {
  1826. headers: {
  1827. accept: "application/vnd.github.antiope-preview+json"
  1828. },
  1829. method: "GET",
  1830. params: {
  1831. check_name: {
  1832. type: "string"
  1833. },
  1834. check_suite_id: {
  1835. required: true,
  1836. type: "integer"
  1837. },
  1838. filter: {
  1839. enum: ["latest", "all"],
  1840. type: "string"
  1841. },
  1842. owner: {
  1843. required: true,
  1844. type: "string"
  1845. },
  1846. page: {
  1847. type: "integer"
  1848. },
  1849. per_page: {
  1850. type: "integer"
  1851. },
  1852. repo: {
  1853. required: true,
  1854. type: "string"
  1855. },
  1856. status: {
  1857. enum: ["queued", "in_progress", "completed"],
  1858. type: "string"
  1859. }
  1860. },
  1861. url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"
  1862. },
  1863. listSuitesForRef: {
  1864. headers: {
  1865. accept: "application/vnd.github.antiope-preview+json"
  1866. },
  1867. method: "GET",
  1868. params: {
  1869. app_id: {
  1870. type: "integer"
  1871. },
  1872. check_name: {
  1873. type: "string"
  1874. },
  1875. owner: {
  1876. required: true,
  1877. type: "string"
  1878. },
  1879. page: {
  1880. type: "integer"
  1881. },
  1882. per_page: {
  1883. type: "integer"
  1884. },
  1885. ref: {
  1886. required: true,
  1887. type: "string"
  1888. },
  1889. repo: {
  1890. required: true,
  1891. type: "string"
  1892. }
  1893. },
  1894. url: "/repos/:owner/:repo/commits/:ref/check-suites"
  1895. },
  1896. rerequestSuite: {
  1897. headers: {
  1898. accept: "application/vnd.github.antiope-preview+json"
  1899. },
  1900. method: "POST",
  1901. params: {
  1902. check_suite_id: {
  1903. required: true,
  1904. type: "integer"
  1905. },
  1906. owner: {
  1907. required: true,
  1908. type: "string"
  1909. },
  1910. repo: {
  1911. required: true,
  1912. type: "string"
  1913. }
  1914. },
  1915. url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"
  1916. },
  1917. setSuitesPreferences: {
  1918. headers: {
  1919. accept: "application/vnd.github.antiope-preview+json"
  1920. },
  1921. method: "PATCH",
  1922. params: {
  1923. auto_trigger_checks: {
  1924. type: "object[]"
  1925. },
  1926. "auto_trigger_checks[].app_id": {
  1927. required: true,
  1928. type: "integer"
  1929. },
  1930. "auto_trigger_checks[].setting": {
  1931. required: true,
  1932. type: "boolean"
  1933. },
  1934. owner: {
  1935. required: true,
  1936. type: "string"
  1937. },
  1938. repo: {
  1939. required: true,
  1940. type: "string"
  1941. }
  1942. },
  1943. url: "/repos/:owner/:repo/check-suites/preferences"
  1944. },
  1945. update: {
  1946. headers: {
  1947. accept: "application/vnd.github.antiope-preview+json"
  1948. },
  1949. method: "PATCH",
  1950. params: {
  1951. actions: {
  1952. type: "object[]"
  1953. },
  1954. "actions[].description": {
  1955. required: true,
  1956. type: "string"
  1957. },
  1958. "actions[].identifier": {
  1959. required: true,
  1960. type: "string"
  1961. },
  1962. "actions[].label": {
  1963. required: true,
  1964. type: "string"
  1965. },
  1966. check_run_id: {
  1967. required: true,
  1968. type: "integer"
  1969. },
  1970. completed_at: {
  1971. type: "string"
  1972. },
  1973. conclusion: {
  1974. enum: ["success", "failure", "neutral", "cancelled", "timed_out", "action_required"],
  1975. type: "string"
  1976. },
  1977. details_url: {
  1978. type: "string"
  1979. },
  1980. external_id: {
  1981. type: "string"
  1982. },
  1983. name: {
  1984. type: "string"
  1985. },
  1986. output: {
  1987. type: "object"
  1988. },
  1989. "output.annotations": {
  1990. type: "object[]"
  1991. },
  1992. "output.annotations[].annotation_level": {
  1993. enum: ["notice", "warning", "failure"],
  1994. required: true,
  1995. type: "string"
  1996. },
  1997. "output.annotations[].end_column": {
  1998. type: "integer"
  1999. },
  2000. "output.annotations[].end_line": {
  2001. required: true,
  2002. type: "integer"
  2003. },
  2004. "output.annotations[].message": {
  2005. required: true,
  2006. type: "string"
  2007. },
  2008. "output.annotations[].path": {
  2009. required: true,
  2010. type: "string"
  2011. },
  2012. "output.annotations[].raw_details": {
  2013. type: "string"
  2014. },
  2015. "output.annotations[].start_column": {
  2016. type: "integer"
  2017. },
  2018. "output.annotations[].start_line": {
  2019. required: true,
  2020. type: "integer"
  2021. },
  2022. "output.annotations[].title": {
  2023. type: "string"
  2024. },
  2025. "output.images": {
  2026. type: "object[]"
  2027. },
  2028. "output.images[].alt": {
  2029. required: true,
  2030. type: "string"
  2031. },
  2032. "output.images[].caption": {
  2033. type: "string"
  2034. },
  2035. "output.images[].image_url": {
  2036. required: true,
  2037. type: "string"
  2038. },
  2039. "output.summary": {
  2040. required: true,
  2041. type: "string"
  2042. },
  2043. "output.text": {
  2044. type: "string"
  2045. },
  2046. "output.title": {
  2047. type: "string"
  2048. },
  2049. owner: {
  2050. required: true,
  2051. type: "string"
  2052. },
  2053. repo: {
  2054. required: true,
  2055. type: "string"
  2056. },
  2057. started_at: {
  2058. type: "string"
  2059. },
  2060. status: {
  2061. enum: ["queued", "in_progress", "completed"],
  2062. type: "string"
  2063. }
  2064. },
  2065. url: "/repos/:owner/:repo/check-runs/:check_run_id"
  2066. }
  2067. },
  2068. codesOfConduct: {
  2069. getConductCode: {
  2070. headers: {
  2071. accept: "application/vnd.github.scarlet-witch-preview+json"
  2072. },
  2073. method: "GET",
  2074. params: {
  2075. key: {
  2076. required: true,
  2077. type: "string"
  2078. }
  2079. },
  2080. url: "/codes_of_conduct/:key"
  2081. },
  2082. getForRepo: {
  2083. headers: {
  2084. accept: "application/vnd.github.scarlet-witch-preview+json"
  2085. },
  2086. method: "GET",
  2087. params: {
  2088. owner: {
  2089. required: true,
  2090. type: "string"
  2091. },
  2092. repo: {
  2093. required: true,
  2094. type: "string"
  2095. }
  2096. },
  2097. url: "/repos/:owner/:repo/community/code_of_conduct"
  2098. },
  2099. listConductCodes: {
  2100. headers: {
  2101. accept: "application/vnd.github.scarlet-witch-preview+json"
  2102. },
  2103. method: "GET",
  2104. params: {},
  2105. url: "/codes_of_conduct"
  2106. }
  2107. },
  2108. emojis: {
  2109. get: {
  2110. method: "GET",
  2111. params: {},
  2112. url: "/emojis"
  2113. }
  2114. },
  2115. gists: {
  2116. checkIsStarred: {
  2117. method: "GET",
  2118. params: {
  2119. gist_id: {
  2120. required: true,
  2121. type: "string"
  2122. }
  2123. },
  2124. url: "/gists/:gist_id/star"
  2125. },
  2126. create: {
  2127. method: "POST",
  2128. params: {
  2129. description: {
  2130. type: "string"
  2131. },
  2132. files: {
  2133. required: true,
  2134. type: "object"
  2135. },
  2136. "files.content": {
  2137. type: "string"
  2138. },
  2139. public: {
  2140. type: "boolean"
  2141. }
  2142. },
  2143. url: "/gists"
  2144. },
  2145. createComment: {
  2146. method: "POST",
  2147. params: {
  2148. body: {
  2149. required: true,
  2150. type: "string"
  2151. },
  2152. gist_id: {
  2153. required: true,
  2154. type: "string"
  2155. }
  2156. },
  2157. url: "/gists/:gist_id/comments"
  2158. },
  2159. delete: {
  2160. method: "DELETE",
  2161. params: {
  2162. gist_id: {
  2163. required: true,
  2164. type: "string"
  2165. }
  2166. },
  2167. url: "/gists/:gist_id"
  2168. },
  2169. deleteComment: {
  2170. method: "DELETE",
  2171. params: {
  2172. comment_id: {
  2173. required: true,
  2174. type: "integer"
  2175. },
  2176. gist_id: {
  2177. required: true,
  2178. type: "string"
  2179. }
  2180. },
  2181. url: "/gists/:gist_id/comments/:comment_id"
  2182. },
  2183. fork: {
  2184. method: "POST",
  2185. params: {
  2186. gist_id: {
  2187. required: true,
  2188. type: "string"
  2189. }
  2190. },
  2191. url: "/gists/:gist_id/forks"
  2192. },
  2193. get: {
  2194. method: "GET",
  2195. params: {
  2196. gist_id: {
  2197. required: true,
  2198. type: "string"
  2199. }
  2200. },
  2201. url: "/gists/:gist_id"
  2202. },
  2203. getComment: {
  2204. method: "GET",
  2205. params: {
  2206. comment_id: {
  2207. required: true,
  2208. type: "integer"
  2209. },
  2210. gist_id: {
  2211. required: true,
  2212. type: "string"
  2213. }
  2214. },
  2215. url: "/gists/:gist_id/comments/:comment_id"
  2216. },
  2217. getRevision: {
  2218. method: "GET",
  2219. params: {
  2220. gist_id: {
  2221. required: true,
  2222. type: "string"
  2223. },
  2224. sha: {
  2225. required: true,
  2226. type: "string"
  2227. }
  2228. },
  2229. url: "/gists/:gist_id/:sha"
  2230. },
  2231. list: {
  2232. method: "GET",
  2233. params: {
  2234. page: {
  2235. type: "integer"
  2236. },
  2237. per_page: {
  2238. type: "integer"
  2239. },
  2240. since: {
  2241. type: "string"
  2242. }
  2243. },
  2244. url: "/gists"
  2245. },
  2246. listComments: {
  2247. method: "GET",
  2248. params: {
  2249. gist_id: {
  2250. required: true,
  2251. type: "string"
  2252. },
  2253. page: {
  2254. type: "integer"
  2255. },
  2256. per_page: {
  2257. type: "integer"
  2258. }
  2259. },
  2260. url: "/gists/:gist_id/comments"
  2261. },
  2262. listCommits: {
  2263. method: "GET",
  2264. params: {
  2265. gist_id: {
  2266. required: true,
  2267. type: "string"
  2268. },
  2269. page: {
  2270. type: "integer"
  2271. },
  2272. per_page: {
  2273. type: "integer"
  2274. }
  2275. },
  2276. url: "/gists/:gist_id/commits"
  2277. },
  2278. listForks: {
  2279. method: "GET",
  2280. params: {
  2281. gist_id: {
  2282. required: true,
  2283. type: "string"
  2284. },
  2285. page: {
  2286. type: "integer"
  2287. },
  2288. per_page: {
  2289. type: "integer"
  2290. }
  2291. },
  2292. url: "/gists/:gist_id/forks"
  2293. },
  2294. listPublic: {
  2295. method: "GET",
  2296. params: {
  2297. page: {
  2298. type: "integer"
  2299. },
  2300. per_page: {
  2301. type: "integer"
  2302. },
  2303. since: {
  2304. type: "string"
  2305. }
  2306. },
  2307. url: "/gists/public"
  2308. },
  2309. listPublicForUser: {
  2310. method: "GET",
  2311. params: {
  2312. page: {
  2313. type: "integer"
  2314. },
  2315. per_page: {
  2316. type: "integer"
  2317. },
  2318. since: {
  2319. type: "string"
  2320. },
  2321. username: {
  2322. required: true,
  2323. type: "string"
  2324. }
  2325. },
  2326. url: "/users/:username/gists"
  2327. },
  2328. listStarred: {
  2329. method: "GET",
  2330. params: {
  2331. page: {
  2332. type: "integer"
  2333. },
  2334. per_page: {
  2335. type: "integer"
  2336. },
  2337. since: {
  2338. type: "string"
  2339. }
  2340. },
  2341. url: "/gists/starred"
  2342. },
  2343. star: {
  2344. method: "PUT",
  2345. params: {
  2346. gist_id: {
  2347. required: true,
  2348. type: "string"
  2349. }
  2350. },
  2351. url: "/gists/:gist_id/star"
  2352. },
  2353. unstar: {
  2354. method: "DELETE",
  2355. params: {
  2356. gist_id: {
  2357. required: true,
  2358. type: "string"
  2359. }
  2360. },
  2361. url: "/gists/:gist_id/star"
  2362. },
  2363. update: {
  2364. method: "PATCH",
  2365. params: {
  2366. description: {
  2367. type: "string"
  2368. },
  2369. files: {
  2370. type: "object"
  2371. },
  2372. "files.content": {
  2373. type: "string"
  2374. },
  2375. "files.filename": {
  2376. type: "string"
  2377. },
  2378. gist_id: {
  2379. required: true,
  2380. type: "string"
  2381. }
  2382. },
  2383. url: "/gists/:gist_id"
  2384. },
  2385. updateComment: {
  2386. method: "PATCH",
  2387. params: {
  2388. body: {
  2389. required: true,
  2390. type: "string"
  2391. },
  2392. comment_id: {
  2393. required: true,
  2394. type: "integer"
  2395. },
  2396. gist_id: {
  2397. required: true,
  2398. type: "string"
  2399. }
  2400. },
  2401. url: "/gists/:gist_id/comments/:comment_id"
  2402. }
  2403. },
  2404. git: {
  2405. createBlob: {
  2406. method: "POST",
  2407. params: {
  2408. content: {
  2409. required: true,
  2410. type: "string"
  2411. },
  2412. encoding: {
  2413. type: "string"
  2414. },
  2415. owner: {
  2416. required: true,
  2417. type: "string"
  2418. },
  2419. repo: {
  2420. required: true,
  2421. type: "string"
  2422. }
  2423. },
  2424. url: "/repos/:owner/:repo/git/blobs"
  2425. },
  2426. createCommit: {
  2427. method: "POST",
  2428. params: {
  2429. author: {
  2430. type: "object"
  2431. },
  2432. "author.date": {
  2433. type: "string"
  2434. },
  2435. "author.email": {
  2436. type: "string"
  2437. },
  2438. "author.name": {
  2439. type: "string"
  2440. },
  2441. committer: {
  2442. type: "object"
  2443. },
  2444. "committer.date": {
  2445. type: "string"
  2446. },
  2447. "committer.email": {
  2448. type: "string"
  2449. },
  2450. "committer.name": {
  2451. type: "string"
  2452. },
  2453. message: {
  2454. required: true,
  2455. type: "string"
  2456. },
  2457. owner: {
  2458. required: true,
  2459. type: "string"
  2460. },
  2461. parents: {
  2462. required: true,
  2463. type: "string[]"
  2464. },
  2465. repo: {
  2466. required: true,
  2467. type: "string"
  2468. },
  2469. signature: {
  2470. type: "string"
  2471. },
  2472. tree: {
  2473. required: true,
  2474. type: "string"
  2475. }
  2476. },
  2477. url: "/repos/:owner/:repo/git/commits"
  2478. },
  2479. createRef: {
  2480. method: "POST",
  2481. params: {
  2482. owner: {
  2483. required: true,
  2484. type: "string"
  2485. },
  2486. ref: {
  2487. required: true,
  2488. type: "string"
  2489. },
  2490. repo: {
  2491. required: true,
  2492. type: "string"
  2493. },
  2494. sha: {
  2495. required: true,
  2496. type: "string"
  2497. }
  2498. },
  2499. url: "/repos/:owner/:repo/git/refs"
  2500. },
  2501. createTag: {
  2502. method: "POST",
  2503. params: {
  2504. message: {
  2505. required: true,
  2506. type: "string"
  2507. },
  2508. object: {
  2509. required: true,
  2510. type: "string"
  2511. },
  2512. owner: {
  2513. required: true,
  2514. type: "string"
  2515. },
  2516. repo: {
  2517. required: true,
  2518. type: "string"
  2519. },
  2520. tag: {
  2521. required: true,
  2522. type: "string"
  2523. },
  2524. tagger: {
  2525. type: "object"
  2526. },
  2527. "tagger.date": {
  2528. type: "string"
  2529. },
  2530. "tagger.email": {
  2531. type: "string"
  2532. },
  2533. "tagger.name": {
  2534. type: "string"
  2535. },
  2536. type: {
  2537. enum: ["commit", "tree", "blob"],
  2538. required: true,
  2539. type: "string"
  2540. }
  2541. },
  2542. url: "/repos/:owner/:repo/git/tags"
  2543. },
  2544. createTree: {
  2545. method: "POST",
  2546. params: {
  2547. base_tree: {
  2548. type: "string"
  2549. },
  2550. owner: {
  2551. required: true,
  2552. type: "string"
  2553. },
  2554. repo: {
  2555. required: true,
  2556. type: "string"
  2557. },
  2558. tree: {
  2559. required: true,
  2560. type: "object[]"
  2561. },
  2562. "tree[].content": {
  2563. type: "string"
  2564. },
  2565. "tree[].mode": {
  2566. enum: ["100644", "100755", "040000", "160000", "120000"],
  2567. type: "string"
  2568. },
  2569. "tree[].path": {
  2570. type: "string"
  2571. },
  2572. "tree[].sha": {
  2573. allowNull: true,
  2574. type: "string"
  2575. },
  2576. "tree[].type": {
  2577. enum: ["blob", "tree", "commit"],
  2578. type: "string"
  2579. }
  2580. },
  2581. url: "/repos/:owner/:repo/git/trees"
  2582. },
  2583. deleteRef: {
  2584. method: "DELETE",
  2585. params: {
  2586. owner: {
  2587. required: true,
  2588. type: "string"
  2589. },
  2590. ref: {
  2591. required: true,
  2592. type: "string"
  2593. },
  2594. repo: {
  2595. required: true,
  2596. type: "string"
  2597. }
  2598. },
  2599. url: "/repos/:owner/:repo/git/refs/:ref"
  2600. },
  2601. getBlob: {
  2602. method: "GET",
  2603. params: {
  2604. file_sha: {
  2605. required: true,
  2606. type: "string"
  2607. },
  2608. owner: {
  2609. required: true,
  2610. type: "string"
  2611. },
  2612. repo: {
  2613. required: true,
  2614. type: "string"
  2615. }
  2616. },
  2617. url: "/repos/:owner/:repo/git/blobs/:file_sha"
  2618. },
  2619. getCommit: {
  2620. method: "GET",
  2621. params: {
  2622. commit_sha: {
  2623. required: true,
  2624. type: "string"
  2625. },
  2626. owner: {
  2627. required: true,
  2628. type: "string"
  2629. },
  2630. repo: {
  2631. required: true,
  2632. type: "string"
  2633. }
  2634. },
  2635. url: "/repos/:owner/:repo/git/commits/:commit_sha"
  2636. },
  2637. getRef: {
  2638. method: "GET",
  2639. params: {
  2640. owner: {
  2641. required: true,
  2642. type: "string"
  2643. },
  2644. ref: {
  2645. required: true,
  2646. type: "string"
  2647. },
  2648. repo: {
  2649. required: true,
  2650. type: "string"
  2651. }
  2652. },
  2653. url: "/repos/:owner/:repo/git/ref/:ref"
  2654. },
  2655. getTag: {
  2656. method: "GET",
  2657. params: {
  2658. owner: {
  2659. required: true,
  2660. type: "string"
  2661. },
  2662. repo: {
  2663. required: true,
  2664. type: "string"
  2665. },
  2666. tag_sha: {
  2667. required: true,
  2668. type: "string"
  2669. }
  2670. },
  2671. url: "/repos/:owner/:repo/git/tags/:tag_sha"
  2672. },
  2673. getTree: {
  2674. method: "GET",
  2675. params: {
  2676. owner: {
  2677. required: true,
  2678. type: "string"
  2679. },
  2680. recursive: {
  2681. enum: ["1"],
  2682. type: "integer"
  2683. },
  2684. repo: {
  2685. required: true,
  2686. type: "string"
  2687. },
  2688. tree_sha: {
  2689. required: true,
  2690. type: "string"
  2691. }
  2692. },
  2693. url: "/repos/:owner/:repo/git/trees/:tree_sha"
  2694. },
  2695. listMatchingRefs: {
  2696. method: "GET",
  2697. params: {
  2698. owner: {
  2699. required: true,
  2700. type: "string"
  2701. },
  2702. page: {
  2703. type: "integer"
  2704. },
  2705. per_page: {
  2706. type: "integer"
  2707. },
  2708. ref: {
  2709. required: true,
  2710. type: "string"
  2711. },
  2712. repo: {
  2713. required: true,
  2714. type: "string"
  2715. }
  2716. },
  2717. url: "/repos/:owner/:repo/git/matching-refs/:ref"
  2718. },
  2719. listRefs: {
  2720. method: "GET",
  2721. params: {
  2722. namespace: {
  2723. type: "string"
  2724. },
  2725. owner: {
  2726. required: true,
  2727. type: "string"
  2728. },
  2729. page: {
  2730. type: "integer"
  2731. },
  2732. per_page: {
  2733. type: "integer"
  2734. },
  2735. repo: {
  2736. required: true,
  2737. type: "string"
  2738. }
  2739. },
  2740. url: "/repos/:owner/:repo/git/refs/:namespace"
  2741. },
  2742. updateRef: {
  2743. method: "PATCH",
  2744. params: {
  2745. force: {
  2746. type: "boolean"
  2747. },
  2748. owner: {
  2749. required: true,
  2750. type: "string"
  2751. },
  2752. ref: {
  2753. required: true,
  2754. type: "string"
  2755. },
  2756. repo: {
  2757. required: true,
  2758. type: "string"
  2759. },
  2760. sha: {
  2761. required: true,
  2762. type: "string"
  2763. }
  2764. },
  2765. url: "/repos/:owner/:repo/git/refs/:ref"
  2766. }
  2767. },
  2768. gitignore: {
  2769. getTemplate: {
  2770. method: "GET",
  2771. params: {
  2772. name: {
  2773. required: true,
  2774. type: "string"
  2775. }
  2776. },
  2777. url: "/gitignore/templates/:name"
  2778. },
  2779. listTemplates: {
  2780. method: "GET",
  2781. params: {},
  2782. url: "/gitignore/templates"
  2783. }
  2784. },
  2785. interactions: {
  2786. addOrUpdateRestrictionsForOrg: {
  2787. headers: {
  2788. accept: "application/vnd.github.sombra-preview+json"
  2789. },
  2790. method: "PUT",
  2791. params: {
  2792. limit: {
  2793. enum: ["existing_users", "contributors_only", "collaborators_only"],
  2794. required: true,
  2795. type: "string"
  2796. },
  2797. org: {
  2798. required: true,
  2799. type: "string"
  2800. }
  2801. },
  2802. url: "/orgs/:org/interaction-limits"
  2803. },
  2804. addOrUpdateRestrictionsForRepo: {
  2805. headers: {
  2806. accept: "application/vnd.github.sombra-preview+json"
  2807. },
  2808. method: "PUT",
  2809. params: {
  2810. limit: {
  2811. enum: ["existing_users", "contributors_only", "collaborators_only"],
  2812. required: true,
  2813. type: "string"
  2814. },
  2815. owner: {
  2816. required: true,
  2817. type: "string"
  2818. },
  2819. repo: {
  2820. required: true,
  2821. type: "string"
  2822. }
  2823. },
  2824. url: "/repos/:owner/:repo/interaction-limits"
  2825. },
  2826. getRestrictionsForOrg: {
  2827. headers: {
  2828. accept: "application/vnd.github.sombra-preview+json"
  2829. },
  2830. method: "GET",
  2831. params: {
  2832. org: {
  2833. required: true,
  2834. type: "string"
  2835. }
  2836. },
  2837. url: "/orgs/:org/interaction-limits"
  2838. },
  2839. getRestrictionsForRepo: {
  2840. headers: {
  2841. accept: "application/vnd.github.sombra-preview+json"
  2842. },
  2843. method: "GET",
  2844. params: {
  2845. owner: {
  2846. required: true,
  2847. type: "string"
  2848. },
  2849. repo: {
  2850. required: true,
  2851. type: "string"
  2852. }
  2853. },
  2854. url: "/repos/:owner/:repo/interaction-limits"
  2855. },
  2856. removeRestrictionsForOrg: {
  2857. headers: {
  2858. accept: "application/vnd.github.sombra-preview+json"
  2859. },
  2860. method: "DELETE",
  2861. params: {
  2862. org: {
  2863. required: true,
  2864. type: "string"
  2865. }
  2866. },
  2867. url: "/orgs/:org/interaction-limits"
  2868. },
  2869. removeRestrictionsForRepo: {
  2870. headers: {
  2871. accept: "application/vnd.github.sombra-preview+json"
  2872. },
  2873. method: "DELETE",
  2874. params: {
  2875. owner: {
  2876. required: true,
  2877. type: "string"
  2878. },
  2879. repo: {
  2880. required: true,
  2881. type: "string"
  2882. }
  2883. },
  2884. url: "/repos/:owner/:repo/interaction-limits"
  2885. }
  2886. },
  2887. issues: {
  2888. addAssignees: {
  2889. method: "POST",
  2890. params: {
  2891. assignees: {
  2892. type: "string[]"
  2893. },
  2894. issue_number: {
  2895. required: true,
  2896. type: "integer"
  2897. },
  2898. number: {
  2899. alias: "issue_number",
  2900. deprecated: true,
  2901. type: "integer"
  2902. },
  2903. owner: {
  2904. required: true,
  2905. type: "string"
  2906. },
  2907. repo: {
  2908. required: true,
  2909. type: "string"
  2910. }
  2911. },
  2912. url: "/repos/:owner/:repo/issues/:issue_number/assignees"
  2913. },
  2914. addLabels: {
  2915. method: "POST",
  2916. params: {
  2917. issue_number: {
  2918. required: true,
  2919. type: "integer"
  2920. },
  2921. labels: {
  2922. required: true,
  2923. type: "string[]"
  2924. },
  2925. number: {
  2926. alias: "issue_number",
  2927. deprecated: true,
  2928. type: "integer"
  2929. },
  2930. owner: {
  2931. required: true,
  2932. type: "string"
  2933. },
  2934. repo: {
  2935. required: true,
  2936. type: "string"
  2937. }
  2938. },
  2939. url: "/repos/:owner/:repo/issues/:issue_number/labels"
  2940. },
  2941. checkAssignee: {
  2942. method: "GET",
  2943. params: {
  2944. assignee: {
  2945. required: true,
  2946. type: "string"
  2947. },
  2948. owner: {
  2949. required: true,
  2950. type: "string"
  2951. },
  2952. repo: {
  2953. required: true,
  2954. type: "string"
  2955. }
  2956. },
  2957. url: "/repos/:owner/:repo/assignees/:assignee"
  2958. },
  2959. create: {
  2960. method: "POST",
  2961. params: {
  2962. assignee: {
  2963. type: "string"
  2964. },
  2965. assignees: {
  2966. type: "string[]"
  2967. },
  2968. body: {
  2969. type: "string"
  2970. },
  2971. labels: {
  2972. type: "string[]"
  2973. },
  2974. milestone: {
  2975. type: "integer"
  2976. },
  2977. owner: {
  2978. required: true,
  2979. type: "string"
  2980. },
  2981. repo: {
  2982. required: true,
  2983. type: "string"
  2984. },
  2985. title: {
  2986. required: true,
  2987. type: "string"
  2988. }
  2989. },
  2990. url: "/repos/:owner/:repo/issues"
  2991. },
  2992. createComment: {
  2993. method: "POST",
  2994. params: {
  2995. body: {
  2996. required: true,
  2997. type: "string"
  2998. },
  2999. issue_number: {
  3000. required: true,
  3001. type: "integer"
  3002. },
  3003. number: {
  3004. alias: "issue_number",
  3005. deprecated: true,
  3006. type: "integer"
  3007. },
  3008. owner: {
  3009. required: true,
  3010. type: "string"
  3011. },
  3012. repo: {
  3013. required: true,
  3014. type: "string"
  3015. }
  3016. },
  3017. url: "/repos/:owner/:repo/issues/:issue_number/comments"
  3018. },
  3019. createLabel: {
  3020. method: "POST",
  3021. params: {
  3022. color: {
  3023. required: true,
  3024. type: "string"
  3025. },
  3026. description: {
  3027. type: "string"
  3028. },
  3029. name: {
  3030. required: true,
  3031. type: "string"
  3032. },
  3033. owner: {
  3034. required: true,
  3035. type: "string"
  3036. },
  3037. repo: {
  3038. required: true,
  3039. type: "string"
  3040. }
  3041. },
  3042. url: "/repos/:owner/:repo/labels"
  3043. },
  3044. createMilestone: {
  3045. method: "POST",
  3046. params: {
  3047. description: {
  3048. type: "string"
  3049. },
  3050. due_on: {
  3051. type: "string"
  3052. },
  3053. owner: {
  3054. required: true,
  3055. type: "string"
  3056. },
  3057. repo: {
  3058. required: true,
  3059. type: "string"
  3060. },
  3061. state: {
  3062. enum: ["open", "closed"],
  3063. type: "string"
  3064. },
  3065. title: {
  3066. required: true,
  3067. type: "string"
  3068. }
  3069. },
  3070. url: "/repos/:owner/:repo/milestones"
  3071. },
  3072. deleteComment: {
  3073. method: "DELETE",
  3074. params: {
  3075. comment_id: {
  3076. required: true,
  3077. type: "integer"
  3078. },
  3079. owner: {
  3080. required: true,
  3081. type: "string"
  3082. },
  3083. repo: {
  3084. required: true,
  3085. type: "string"
  3086. }
  3087. },
  3088. url: "/repos/:owner/:repo/issues/comments/:comment_id"
  3089. },
  3090. deleteLabel: {
  3091. method: "DELETE",
  3092. params: {
  3093. name: {
  3094. required: true,
  3095. type: "string"
  3096. },
  3097. owner: {
  3098. required: true,
  3099. type: "string"
  3100. },
  3101. repo: {
  3102. required: true,
  3103. type: "string"
  3104. }
  3105. },
  3106. url: "/repos/:owner/:repo/labels/:name"
  3107. },
  3108. deleteMilestone: {
  3109. method: "DELETE",
  3110. params: {
  3111. milestone_number: {
  3112. required: true,
  3113. type: "integer"
  3114. },
  3115. number: {
  3116. alias: "milestone_number",
  3117. deprecated: true,
  3118. type: "integer"
  3119. },
  3120. owner: {
  3121. required: true,
  3122. type: "string"
  3123. },
  3124. repo: {
  3125. required: true,
  3126. type: "string"
  3127. }
  3128. },
  3129. url: "/repos/:owner/:repo/milestones/:milestone_number"
  3130. },
  3131. get: {
  3132. method: "GET",
  3133. params: {
  3134. issue_number: {
  3135. required: true,
  3136. type: "integer"
  3137. },
  3138. number: {
  3139. alias: "issue_number",
  3140. deprecated: true,
  3141. type: "integer"
  3142. },
  3143. owner: {
  3144. required: true,
  3145. type: "string"
  3146. },
  3147. repo: {
  3148. required: true,
  3149. type: "string"
  3150. }
  3151. },
  3152. url: "/repos/:owner/:repo/issues/:issue_number"
  3153. },
  3154. getComment: {
  3155. method: "GET",
  3156. params: {
  3157. comment_id: {
  3158. required: true,
  3159. type: "integer"
  3160. },
  3161. owner: {
  3162. required: true,
  3163. type: "string"
  3164. },
  3165. repo: {
  3166. required: true,
  3167. type: "string"
  3168. }
  3169. },
  3170. url: "/repos/:owner/:repo/issues/comments/:comment_id"
  3171. },
  3172. getEvent: {
  3173. method: "GET",
  3174. params: {
  3175. event_id: {
  3176. required: true,
  3177. type: "integer"
  3178. },
  3179. owner: {
  3180. required: true,
  3181. type: "string"
  3182. },
  3183. repo: {
  3184. required: true,
  3185. type: "string"
  3186. }
  3187. },
  3188. url: "/repos/:owner/:repo/issues/events/:event_id"
  3189. },
  3190. getLabel: {
  3191. method: "GET",
  3192. params: {
  3193. name: {
  3194. required: true,
  3195. type: "string"
  3196. },
  3197. owner: {
  3198. required: true,
  3199. type: "string"
  3200. },
  3201. repo: {
  3202. required: true,
  3203. type: "string"
  3204. }
  3205. },
  3206. url: "/repos/:owner/:repo/labels/:name"
  3207. },
  3208. getMilestone: {
  3209. method: "GET",
  3210. params: {
  3211. milestone_number: {
  3212. required: true,
  3213. type: "integer"
  3214. },
  3215. number: {
  3216. alias: "milestone_number",
  3217. deprecated: true,
  3218. type: "integer"
  3219. },
  3220. owner: {
  3221. required: true,
  3222. type: "string"
  3223. },
  3224. repo: {
  3225. required: true,
  3226. type: "string"
  3227. }
  3228. },
  3229. url: "/repos/:owner/:repo/milestones/:milestone_number"
  3230. },
  3231. list: {
  3232. method: "GET",
  3233. params: {
  3234. direction: {
  3235. enum: ["asc", "desc"],
  3236. type: "string"
  3237. },
  3238. filter: {
  3239. enum: ["assigned", "created", "mentioned", "subscribed", "all"],
  3240. type: "string"
  3241. },
  3242. labels: {
  3243. type: "string"
  3244. },
  3245. page: {
  3246. type: "integer"
  3247. },
  3248. per_page: {
  3249. type: "integer"
  3250. },
  3251. since: {
  3252. type: "string"
  3253. },
  3254. sort: {
  3255. enum: ["created", "updated", "comments"],
  3256. type: "string"
  3257. },
  3258. state: {
  3259. enum: ["open", "closed", "all"],
  3260. type: "string"
  3261. }
  3262. },
  3263. url: "/issues"
  3264. },
  3265. listAssignees: {
  3266. method: "GET",
  3267. params: {
  3268. owner: {
  3269. required: true,
  3270. type: "string"
  3271. },
  3272. page: {
  3273. type: "integer"
  3274. },
  3275. per_page: {
  3276. type: "integer"
  3277. },
  3278. repo: {
  3279. required: true,
  3280. type: "string"
  3281. }
  3282. },
  3283. url: "/repos/:owner/:repo/assignees"
  3284. },
  3285. listComments: {
  3286. method: "GET",
  3287. params: {
  3288. issue_number: {
  3289. required: true,
  3290. type: "integer"
  3291. },
  3292. number: {
  3293. alias: "issue_number",
  3294. deprecated: true,
  3295. type: "integer"
  3296. },
  3297. owner: {
  3298. required: true,
  3299. type: "string"
  3300. },
  3301. page: {
  3302. type: "integer"
  3303. },
  3304. per_page: {
  3305. type: "integer"
  3306. },
  3307. repo: {
  3308. required: true,
  3309. type: "string"
  3310. },
  3311. since: {
  3312. type: "string"
  3313. }
  3314. },
  3315. url: "/repos/:owner/:repo/issues/:issue_number/comments"
  3316. },
  3317. listCommentsForRepo: {
  3318. method: "GET",
  3319. params: {
  3320. direction: {
  3321. enum: ["asc", "desc"],
  3322. type: "string"
  3323. },
  3324. owner: {
  3325. required: true,
  3326. type: "string"
  3327. },
  3328. repo: {
  3329. required: true,
  3330. type: "string"
  3331. },
  3332. since: {
  3333. type: "string"
  3334. },
  3335. sort: {
  3336. enum: ["created", "updated"],
  3337. type: "string"
  3338. }
  3339. },
  3340. url: "/repos/:owner/:repo/issues/comments"
  3341. },
  3342. listEvents: {
  3343. method: "GET",
  3344. params: {
  3345. issue_number: {
  3346. required: true,
  3347. type: "integer"
  3348. },
  3349. number: {
  3350. alias: "issue_number",
  3351. deprecated: true,
  3352. type: "integer"
  3353. },
  3354. owner: {
  3355. required: true,
  3356. type: "string"
  3357. },
  3358. page: {
  3359. type: "integer"
  3360. },
  3361. per_page: {
  3362. type: "integer"
  3363. },
  3364. repo: {
  3365. required: true,
  3366. type: "string"
  3367. }
  3368. },
  3369. url: "/repos/:owner/:repo/issues/:issue_number/events"
  3370. },
  3371. listEventsForRepo: {
  3372. method: "GET",
  3373. params: {
  3374. owner: {
  3375. required: true,
  3376. type: "string"
  3377. },
  3378. page: {
  3379. type: "integer"
  3380. },
  3381. per_page: {
  3382. type: "integer"
  3383. },
  3384. repo: {
  3385. required: true,
  3386. type: "string"
  3387. }
  3388. },
  3389. url: "/repos/:owner/:repo/issues/events"
  3390. },
  3391. listEventsForTimeline: {
  3392. headers: {
  3393. accept: "application/vnd.github.mockingbird-preview+json"
  3394. },
  3395. method: "GET",
  3396. params: {
  3397. issue_number: {
  3398. required: true,
  3399. type: "integer"
  3400. },
  3401. number: {
  3402. alias: "issue_number",
  3403. deprecated: true,
  3404. type: "integer"
  3405. },
  3406. owner: {
  3407. required: true,
  3408. type: "string"
  3409. },
  3410. page: {
  3411. type: "integer"
  3412. },
  3413. per_page: {
  3414. type: "integer"
  3415. },
  3416. repo: {
  3417. required: true,
  3418. type: "string"
  3419. }
  3420. },
  3421. url: "/repos/:owner/:repo/issues/:issue_number/timeline"
  3422. },
  3423. listForAuthenticatedUser: {
  3424. method: "GET",
  3425. params: {
  3426. direction: {
  3427. enum: ["asc", "desc"],
  3428. type: "string"
  3429. },
  3430. filter: {
  3431. enum: ["assigned", "created", "mentioned", "subscribed", "all"],
  3432. type: "string"
  3433. },
  3434. labels: {
  3435. type: "string"
  3436. },
  3437. page: {
  3438. type: "integer"
  3439. },
  3440. per_page: {
  3441. type: "integer"
  3442. },
  3443. since: {
  3444. type: "string"
  3445. },
  3446. sort: {
  3447. enum: ["created", "updated", "comments"],
  3448. type: "string"
  3449. },
  3450. state: {
  3451. enum: ["open", "closed", "all"],
  3452. type: "string"
  3453. }
  3454. },
  3455. url: "/user/issues"
  3456. },
  3457. listForOrg: {
  3458. method: "GET",
  3459. params: {
  3460. direction: {
  3461. enum: ["asc", "desc"],
  3462. type: "string"
  3463. },
  3464. filter: {
  3465. enum: ["assigned", "created", "mentioned", "subscribed", "all"],
  3466. type: "string"
  3467. },
  3468. labels: {
  3469. type: "string"
  3470. },
  3471. org: {
  3472. required: true,
  3473. type: "string"
  3474. },
  3475. page: {
  3476. type: "integer"
  3477. },
  3478. per_page: {
  3479. type: "integer"
  3480. },
  3481. since: {
  3482. type: "string"
  3483. },
  3484. sort: {
  3485. enum: ["created", "updated", "comments"],
  3486. type: "string"
  3487. },
  3488. state: {
  3489. enum: ["open", "closed", "all"],
  3490. type: "string"
  3491. }
  3492. },
  3493. url: "/orgs/:org/issues"
  3494. },
  3495. listForRepo: {
  3496. method: "GET",
  3497. params: {
  3498. assignee: {
  3499. type: "string"
  3500. },
  3501. creator: {
  3502. type: "string"
  3503. },
  3504. direction: {
  3505. enum: ["asc", "desc"],
  3506. type: "string"
  3507. },
  3508. labels: {
  3509. type: "string"
  3510. },
  3511. mentioned: {
  3512. type: "string"
  3513. },
  3514. milestone: {
  3515. type: "string"
  3516. },
  3517. owner: {
  3518. required: true,
  3519. type: "string"
  3520. },
  3521. page: {
  3522. type: "integer"
  3523. },
  3524. per_page: {
  3525. type: "integer"
  3526. },
  3527. repo: {
  3528. required: true,
  3529. type: "string"
  3530. },
  3531. since: {
  3532. type: "string"
  3533. },
  3534. sort: {
  3535. enum: ["created", "updated", "comments"],
  3536. type: "string"
  3537. },
  3538. state: {
  3539. enum: ["open", "closed", "all"],
  3540. type: "string"
  3541. }
  3542. },
  3543. url: "/repos/:owner/:repo/issues"
  3544. },
  3545. listLabelsForMilestone: {
  3546. method: "GET",
  3547. params: {
  3548. milestone_number: {
  3549. required: true,
  3550. type: "integer"
  3551. },
  3552. number: {
  3553. alias: "milestone_number",
  3554. deprecated: true,
  3555. type: "integer"
  3556. },
  3557. owner: {
  3558. required: true,
  3559. type: "string"
  3560. },
  3561. page: {
  3562. type: "integer"
  3563. },
  3564. per_page: {
  3565. type: "integer"
  3566. },
  3567. repo: {
  3568. required: true,
  3569. type: "string"
  3570. }
  3571. },
  3572. url: "/repos/:owner/:repo/milestones/:milestone_number/labels"
  3573. },
  3574. listLabelsForRepo: {
  3575. method: "GET",
  3576. params: {
  3577. owner: {
  3578. required: true,
  3579. type: "string"
  3580. },
  3581. page: {
  3582. type: "integer"
  3583. },
  3584. per_page: {
  3585. type: "integer"
  3586. },
  3587. repo: {
  3588. required: true,
  3589. type: "string"
  3590. }
  3591. },
  3592. url: "/repos/:owner/:repo/labels"
  3593. },
  3594. listLabelsOnIssue: {
  3595. method: "GET",
  3596. params: {
  3597. issue_number: {
  3598. required: true,
  3599. type: "integer"
  3600. },
  3601. number: {
  3602. alias: "issue_number",
  3603. deprecated: true,
  3604. type: "integer"
  3605. },
  3606. owner: {
  3607. required: true,
  3608. type: "string"
  3609. },
  3610. page: {
  3611. type: "integer"
  3612. },
  3613. per_page: {
  3614. type: "integer"
  3615. },
  3616. repo: {
  3617. required: true,
  3618. type: "string"
  3619. }
  3620. },
  3621. url: "/repos/:owner/:repo/issues/:issue_number/labels"
  3622. },
  3623. listMilestonesForRepo: {
  3624. method: "GET",
  3625. params: {
  3626. direction: {
  3627. enum: ["asc", "desc"],
  3628. type: "string"
  3629. },
  3630. owner: {
  3631. required: true,
  3632. type: "string"
  3633. },
  3634. page: {
  3635. type: "integer"
  3636. },
  3637. per_page: {
  3638. type: "integer"
  3639. },
  3640. repo: {
  3641. required: true,
  3642. type: "string"
  3643. },
  3644. sort: {
  3645. enum: ["due_on", "completeness"],
  3646. type: "string"
  3647. },
  3648. state: {
  3649. enum: ["open", "closed", "all"],
  3650. type: "string"
  3651. }
  3652. },
  3653. url: "/repos/:owner/:repo/milestones"
  3654. },
  3655. lock: {
  3656. method: "PUT",
  3657. params: {
  3658. issue_number: {
  3659. required: true,
  3660. type: "integer"
  3661. },
  3662. lock_reason: {
  3663. enum: ["off-topic", "too heated", "resolved", "spam"],
  3664. type: "string"
  3665. },
  3666. number: {
  3667. alias: "issue_number",
  3668. deprecated: true,
  3669. type: "integer"
  3670. },
  3671. owner: {
  3672. required: true,
  3673. type: "string"
  3674. },
  3675. repo: {
  3676. required: true,
  3677. type: "string"
  3678. }
  3679. },
  3680. url: "/repos/:owner/:repo/issues/:issue_number/lock"
  3681. },
  3682. removeAssignees: {
  3683. method: "DELETE",
  3684. params: {
  3685. assignees: {
  3686. type: "string[]"
  3687. },
  3688. issue_number: {
  3689. required: true,
  3690. type: "integer"
  3691. },
  3692. number: {
  3693. alias: "issue_number",
  3694. deprecated: true,
  3695. type: "integer"
  3696. },
  3697. owner: {
  3698. required: true,
  3699. type: "string"
  3700. },
  3701. repo: {
  3702. required: true,
  3703. type: "string"
  3704. }
  3705. },
  3706. url: "/repos/:owner/:repo/issues/:issue_number/assignees"
  3707. },
  3708. removeLabel: {
  3709. method: "DELETE",
  3710. params: {
  3711. issue_number: {
  3712. required: true,
  3713. type: "integer"
  3714. },
  3715. name: {
  3716. required: true,
  3717. type: "string"
  3718. },
  3719. number: {
  3720. alias: "issue_number",
  3721. deprecated: true,
  3722. type: "integer"
  3723. },
  3724. owner: {
  3725. required: true,
  3726. type: "string"
  3727. },
  3728. repo: {
  3729. required: true,
  3730. type: "string"
  3731. }
  3732. },
  3733. url: "/repos/:owner/:repo/issues/:issue_number/labels/:name"
  3734. },
  3735. removeLabels: {
  3736. method: "DELETE",
  3737. params: {
  3738. issue_number: {
  3739. required: true,
  3740. type: "integer"
  3741. },
  3742. number: {
  3743. alias: "issue_number",
  3744. deprecated: true,
  3745. type: "integer"
  3746. },
  3747. owner: {
  3748. required: true,
  3749. type: "string"
  3750. },
  3751. repo: {
  3752. required: true,
  3753. type: "string"
  3754. }
  3755. },
  3756. url: "/repos/:owner/:repo/issues/:issue_number/labels"
  3757. },
  3758. replaceLabels: {
  3759. method: "PUT",
  3760. params: {
  3761. issue_number: {
  3762. required: true,
  3763. type: "integer"
  3764. },
  3765. labels: {
  3766. type: "string[]"
  3767. },
  3768. number: {
  3769. alias: "issue_number",
  3770. deprecated: true,
  3771. type: "integer"
  3772. },
  3773. owner: {
  3774. required: true,
  3775. type: "string"
  3776. },
  3777. repo: {
  3778. required: true,
  3779. type: "string"
  3780. }
  3781. },
  3782. url: "/repos/:owner/:repo/issues/:issue_number/labels"
  3783. },
  3784. unlock: {
  3785. method: "DELETE",
  3786. params: {
  3787. issue_number: {
  3788. required: true,
  3789. type: "integer"
  3790. },
  3791. number: {
  3792. alias: "issue_number",
  3793. deprecated: true,
  3794. type: "integer"
  3795. },
  3796. owner: {
  3797. required: true,
  3798. type: "string"
  3799. },
  3800. repo: {
  3801. required: true,
  3802. type: "string"
  3803. }
  3804. },
  3805. url: "/repos/:owner/:repo/issues/:issue_number/lock"
  3806. },
  3807. update: {
  3808. method: "PATCH",
  3809. params: {
  3810. assignee: {
  3811. type: "string"
  3812. },
  3813. assignees: {
  3814. type: "string[]"
  3815. },
  3816. body: {
  3817. type: "string"
  3818. },
  3819. issue_number: {
  3820. required: true,
  3821. type: "integer"
  3822. },
  3823. labels: {
  3824. type: "string[]"
  3825. },
  3826. milestone: {
  3827. allowNull: true,
  3828. type: "integer"
  3829. },
  3830. number: {
  3831. alias: "issue_number",
  3832. deprecated: true,
  3833. type: "integer"
  3834. },
  3835. owner: {
  3836. required: true,
  3837. type: "string"
  3838. },
  3839. repo: {
  3840. required: true,
  3841. type: "string"
  3842. },
  3843. state: {
  3844. enum: ["open", "closed"],
  3845. type: "string"
  3846. },
  3847. title: {
  3848. type: "string"
  3849. }
  3850. },
  3851. url: "/repos/:owner/:repo/issues/:issue_number"
  3852. },
  3853. updateComment: {
  3854. method: "PATCH",
  3855. params: {
  3856. body: {
  3857. required: true,
  3858. type: "string"
  3859. },
  3860. comment_id: {
  3861. required: true,
  3862. type: "integer"
  3863. },
  3864. owner: {
  3865. required: true,
  3866. type: "string"
  3867. },
  3868. repo: {
  3869. required: true,
  3870. type: "string"
  3871. }
  3872. },
  3873. url: "/repos/:owner/:repo/issues/comments/:comment_id"
  3874. },
  3875. updateLabel: {
  3876. method: "PATCH",
  3877. params: {
  3878. color: {
  3879. type: "string"
  3880. },
  3881. current_name: {
  3882. required: true,
  3883. type: "string"
  3884. },
  3885. description: {
  3886. type: "string"
  3887. },
  3888. name: {
  3889. type: "string"
  3890. },
  3891. owner: {
  3892. required: true,
  3893. type: "string"
  3894. },
  3895. repo: {
  3896. required: true,
  3897. type: "string"
  3898. }
  3899. },
  3900. url: "/repos/:owner/:repo/labels/:current_name"
  3901. },
  3902. updateMilestone: {
  3903. method: "PATCH",
  3904. params: {
  3905. description: {
  3906. type: "string"
  3907. },
  3908. due_on: {
  3909. type: "string"
  3910. },
  3911. milestone_number: {
  3912. required: true,
  3913. type: "integer"
  3914. },
  3915. number: {
  3916. alias: "milestone_number",
  3917. deprecated: true,
  3918. type: "integer"
  3919. },
  3920. owner: {
  3921. required: true,
  3922. type: "string"
  3923. },
  3924. repo: {
  3925. required: true,
  3926. type: "string"
  3927. },
  3928. state: {
  3929. enum: ["open", "closed"],
  3930. type: "string"
  3931. },
  3932. title: {
  3933. type: "string"
  3934. }
  3935. },
  3936. url: "/repos/:owner/:repo/milestones/:milestone_number"
  3937. }
  3938. },
  3939. licenses: {
  3940. get: {
  3941. method: "GET",
  3942. params: {
  3943. license: {
  3944. required: true,
  3945. type: "string"
  3946. }
  3947. },
  3948. url: "/licenses/:license"
  3949. },
  3950. getForRepo: {
  3951. method: "GET",
  3952. params: {
  3953. owner: {
  3954. required: true,
  3955. type: "string"
  3956. },
  3957. repo: {
  3958. required: true,
  3959. type: "string"
  3960. }
  3961. },
  3962. url: "/repos/:owner/:repo/license"
  3963. },
  3964. list: {
  3965. deprecated: "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)",
  3966. method: "GET",
  3967. params: {},
  3968. url: "/licenses"
  3969. },
  3970. listCommonlyUsed: {
  3971. method: "GET",
  3972. params: {},
  3973. url: "/licenses"
  3974. }
  3975. },
  3976. markdown: {
  3977. render: {
  3978. method: "POST",
  3979. params: {
  3980. context: {
  3981. type: "string"
  3982. },
  3983. mode: {
  3984. enum: ["markdown", "gfm"],
  3985. type: "string"
  3986. },
  3987. text: {
  3988. required: true,
  3989. type: "string"
  3990. }
  3991. },
  3992. url: "/markdown"
  3993. },
  3994. renderRaw: {
  3995. headers: {
  3996. "content-type": "text/plain; charset=utf-8"
  3997. },
  3998. method: "POST",
  3999. params: {
  4000. data: {
  4001. mapTo: "data",
  4002. required: true,
  4003. type: "string"
  4004. }
  4005. },
  4006. url: "/markdown/raw"
  4007. }
  4008. },
  4009. meta: {
  4010. get: {
  4011. method: "GET",
  4012. params: {},
  4013. url: "/meta"
  4014. }
  4015. },
  4016. migrations: {
  4017. cancelImport: {
  4018. method: "DELETE",
  4019. params: {
  4020. owner: {
  4021. required: true,
  4022. type: "string"
  4023. },
  4024. repo: {
  4025. required: true,
  4026. type: "string"
  4027. }
  4028. },
  4029. url: "/repos/:owner/:repo/import"
  4030. },
  4031. deleteArchiveForAuthenticatedUser: {
  4032. headers: {
  4033. accept: "application/vnd.github.wyandotte-preview+json"
  4034. },
  4035. method: "DELETE",
  4036. params: {
  4037. migration_id: {
  4038. required: true,
  4039. type: "integer"
  4040. }
  4041. },
  4042. url: "/user/migrations/:migration_id/archive"
  4043. },
  4044. deleteArchiveForOrg: {
  4045. headers: {
  4046. accept: "application/vnd.github.wyandotte-preview+json"
  4047. },
  4048. method: "DELETE",
  4049. params: {
  4050. migration_id: {
  4051. required: true,
  4052. type: "integer"
  4053. },
  4054. org: {
  4055. required: true,
  4056. type: "string"
  4057. }
  4058. },
  4059. url: "/orgs/:org/migrations/:migration_id/archive"
  4060. },
  4061. downloadArchiveForOrg: {
  4062. headers: {
  4063. accept: "application/vnd.github.wyandotte-preview+json"
  4064. },
  4065. method: "GET",
  4066. params: {
  4067. migration_id: {
  4068. required: true,
  4069. type: "integer"
  4070. },
  4071. org: {
  4072. required: true,
  4073. type: "string"
  4074. }
  4075. },
  4076. url: "/orgs/:org/migrations/:migration_id/archive"
  4077. },
  4078. getArchiveForAuthenticatedUser: {
  4079. headers: {
  4080. accept: "application/vnd.github.wyandotte-preview+json"
  4081. },
  4082. method: "GET",
  4083. params: {
  4084. migration_id: {
  4085. required: true,
  4086. type: "integer"
  4087. }
  4088. },
  4089. url: "/user/migrations/:migration_id/archive"
  4090. },
  4091. getArchiveForOrg: {
  4092. deprecated: "octokit.migrations.getArchiveForOrg() has been renamed to octokit.migrations.downloadArchiveForOrg() (2020-01-27)",
  4093. headers: {
  4094. accept: "application/vnd.github.wyandotte-preview+json"
  4095. },
  4096. method: "GET",
  4097. params: {
  4098. migration_id: {
  4099. required: true,
  4100. type: "integer"
  4101. },
  4102. org: {
  4103. required: true,
  4104. type: "string"
  4105. }
  4106. },
  4107. url: "/orgs/:org/migrations/:migration_id/archive"
  4108. },
  4109. getCommitAuthors: {
  4110. method: "GET",
  4111. params: {
  4112. owner: {
  4113. required: true,
  4114. type: "string"
  4115. },
  4116. repo: {
  4117. required: true,
  4118. type: "string"
  4119. },
  4120. since: {
  4121. type: "string"
  4122. }
  4123. },
  4124. url: "/repos/:owner/:repo/import/authors"
  4125. },
  4126. getImportProgress: {
  4127. method: "GET",
  4128. params: {
  4129. owner: {
  4130. required: true,
  4131. type: "string"
  4132. },
  4133. repo: {
  4134. required: true,
  4135. type: "string"
  4136. }
  4137. },
  4138. url: "/repos/:owner/:repo/import"
  4139. },
  4140. getLargeFiles: {
  4141. method: "GET",
  4142. params: {
  4143. owner: {
  4144. required: true,
  4145. type: "string"
  4146. },
  4147. repo: {
  4148. required: true,
  4149. type: "string"
  4150. }
  4151. },
  4152. url: "/repos/:owner/:repo/import/large_files"
  4153. },
  4154. getStatusForAuthenticatedUser: {
  4155. headers: {
  4156. accept: "application/vnd.github.wyandotte-preview+json"
  4157. },
  4158. method: "GET",
  4159. params: {
  4160. migration_id: {
  4161. required: true,
  4162. type: "integer"
  4163. }
  4164. },
  4165. url: "/user/migrations/:migration_id"
  4166. },
  4167. getStatusForOrg: {
  4168. headers: {
  4169. accept: "application/vnd.github.wyandotte-preview+json"
  4170. },
  4171. method: "GET",
  4172. params: {
  4173. migration_id: {
  4174. required: true,
  4175. type: "integer"
  4176. },
  4177. org: {
  4178. required: true,
  4179. type: "string"
  4180. }
  4181. },
  4182. url: "/orgs/:org/migrations/:migration_id"
  4183. },
  4184. listForAuthenticatedUser: {
  4185. headers: {
  4186. accept: "application/vnd.github.wyandotte-preview+json"
  4187. },
  4188. method: "GET",
  4189. params: {
  4190. page: {
  4191. type: "integer"
  4192. },
  4193. per_page: {
  4194. type: "integer"
  4195. }
  4196. },
  4197. url: "/user/migrations"
  4198. },
  4199. listForOrg: {
  4200. headers: {
  4201. accept: "application/vnd.github.wyandotte-preview+json"
  4202. },
  4203. method: "GET",
  4204. params: {
  4205. org: {
  4206. required: true,
  4207. type: "string"
  4208. },
  4209. page: {
  4210. type: "integer"
  4211. },
  4212. per_page: {
  4213. type: "integer"
  4214. }
  4215. },
  4216. url: "/orgs/:org/migrations"
  4217. },
  4218. listReposForOrg: {
  4219. headers: {
  4220. accept: "application/vnd.github.wyandotte-preview+json"
  4221. },
  4222. method: "GET",
  4223. params: {
  4224. migration_id: {
  4225. required: true,
  4226. type: "integer"
  4227. },
  4228. org: {
  4229. required: true,
  4230. type: "string"
  4231. },
  4232. page: {
  4233. type: "integer"
  4234. },
  4235. per_page: {
  4236. type: "integer"
  4237. }
  4238. },
  4239. url: "/orgs/:org/migrations/:migration_id/repositories"
  4240. },
  4241. listReposForUser: {
  4242. headers: {
  4243. accept: "application/vnd.github.wyandotte-preview+json"
  4244. },
  4245. method: "GET",
  4246. params: {
  4247. migration_id: {
  4248. required: true,
  4249. type: "integer"
  4250. },
  4251. page: {
  4252. type: "integer"
  4253. },
  4254. per_page: {
  4255. type: "integer"
  4256. }
  4257. },
  4258. url: "/user/:migration_id/repositories"
  4259. },
  4260. mapCommitAuthor: {
  4261. method: "PATCH",
  4262. params: {
  4263. author_id: {
  4264. required: true,
  4265. type: "integer"
  4266. },
  4267. email: {
  4268. type: "string"
  4269. },
  4270. name: {
  4271. type: "string"
  4272. },
  4273. owner: {
  4274. required: true,
  4275. type: "string"
  4276. },
  4277. repo: {
  4278. required: true,
  4279. type: "string"
  4280. }
  4281. },
  4282. url: "/repos/:owner/:repo/import/authors/:author_id"
  4283. },
  4284. setLfsPreference: {
  4285. method: "PATCH",
  4286. params: {
  4287. owner: {
  4288. required: true,
  4289. type: "string"
  4290. },
  4291. repo: {
  4292. required: true,
  4293. type: "string"
  4294. },
  4295. use_lfs: {
  4296. enum: ["opt_in", "opt_out"],
  4297. required: true,
  4298. type: "string"
  4299. }
  4300. },
  4301. url: "/repos/:owner/:repo/import/lfs"
  4302. },
  4303. startForAuthenticatedUser: {
  4304. method: "POST",
  4305. params: {
  4306. exclude_attachments: {
  4307. type: "boolean"
  4308. },
  4309. lock_repositories: {
  4310. type: "boolean"
  4311. },
  4312. repositories: {
  4313. required: true,
  4314. type: "string[]"
  4315. }
  4316. },
  4317. url: "/user/migrations"
  4318. },
  4319. startForOrg: {
  4320. method: "POST",
  4321. params: {
  4322. exclude_attachments: {
  4323. type: "boolean"
  4324. },
  4325. lock_repositories: {
  4326. type: "boolean"
  4327. },
  4328. org: {
  4329. required: true,
  4330. type: "string"
  4331. },
  4332. repositories: {
  4333. required: true,
  4334. type: "string[]"
  4335. }
  4336. },
  4337. url: "/orgs/:org/migrations"
  4338. },
  4339. startImport: {
  4340. method: "PUT",
  4341. params: {
  4342. owner: {
  4343. required: true,
  4344. type: "string"
  4345. },
  4346. repo: {
  4347. required: true,
  4348. type: "string"
  4349. },
  4350. tfvc_project: {
  4351. type: "string"
  4352. },
  4353. vcs: {
  4354. enum: ["subversion", "git", "mercurial", "tfvc"],
  4355. type: "string"
  4356. },
  4357. vcs_password: {
  4358. type: "string"
  4359. },
  4360. vcs_url: {
  4361. required: true,
  4362. type: "string"
  4363. },
  4364. vcs_username: {
  4365. type: "string"
  4366. }
  4367. },
  4368. url: "/repos/:owner/:repo/import"
  4369. },
  4370. unlockRepoForAuthenticatedUser: {
  4371. headers: {
  4372. accept: "application/vnd.github.wyandotte-preview+json"
  4373. },
  4374. method: "DELETE",
  4375. params: {
  4376. migration_id: {
  4377. required: true,
  4378. type: "integer"
  4379. },
  4380. repo_name: {
  4381. required: true,
  4382. type: "string"
  4383. }
  4384. },
  4385. url: "/user/migrations/:migration_id/repos/:repo_name/lock"
  4386. },
  4387. unlockRepoForOrg: {
  4388. headers: {
  4389. accept: "application/vnd.github.wyandotte-preview+json"
  4390. },
  4391. method: "DELETE",
  4392. params: {
  4393. migration_id: {
  4394. required: true,
  4395. type: "integer"
  4396. },
  4397. org: {
  4398. required: true,
  4399. type: "string"
  4400. },
  4401. repo_name: {
  4402. required: true,
  4403. type: "string"
  4404. }
  4405. },
  4406. url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock"
  4407. },
  4408. updateImport: {
  4409. method: "PATCH",
  4410. params: {
  4411. owner: {
  4412. required: true,
  4413. type: "string"
  4414. },
  4415. repo: {
  4416. required: true,
  4417. type: "string"
  4418. },
  4419. vcs_password: {
  4420. type: "string"
  4421. },
  4422. vcs_username: {
  4423. type: "string"
  4424. }
  4425. },
  4426. url: "/repos/:owner/:repo/import"
  4427. }
  4428. },
  4429. oauthAuthorizations: {
  4430. checkAuthorization: {
  4431. deprecated: "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)",
  4432. method: "GET",
  4433. params: {
  4434. access_token: {
  4435. required: true,
  4436. type: "string"
  4437. },
  4438. client_id: {
  4439. required: true,
  4440. type: "string"
  4441. }
  4442. },
  4443. url: "/applications/:client_id/tokens/:access_token"
  4444. },
  4445. createAuthorization: {
  4446. deprecated: "octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization",
  4447. method: "POST",
  4448. params: {
  4449. client_id: {
  4450. type: "string"
  4451. },
  4452. client_secret: {
  4453. type: "string"
  4454. },
  4455. fingerprint: {
  4456. type: "string"
  4457. },
  4458. note: {
  4459. required: true,
  4460. type: "string"
  4461. },
  4462. note_url: {
  4463. type: "string"
  4464. },
  4465. scopes: {
  4466. type: "string[]"
  4467. }
  4468. },
  4469. url: "/authorizations"
  4470. },
  4471. deleteAuthorization: {
  4472. deprecated: "octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization",
  4473. method: "DELETE",
  4474. params: {
  4475. authorization_id: {
  4476. required: true,
  4477. type: "integer"
  4478. }
  4479. },
  4480. url: "/authorizations/:authorization_id"
  4481. },
  4482. deleteGrant: {
  4483. deprecated: "octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant",
  4484. method: "DELETE",
  4485. params: {
  4486. grant_id: {
  4487. required: true,
  4488. type: "integer"
  4489. }
  4490. },
  4491. url: "/applications/grants/:grant_id"
  4492. },
  4493. getAuthorization: {
  4494. deprecated: "octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization",
  4495. method: "GET",
  4496. params: {
  4497. authorization_id: {
  4498. required: true,
  4499. type: "integer"
  4500. }
  4501. },
  4502. url: "/authorizations/:authorization_id"
  4503. },
  4504. getGrant: {
  4505. deprecated: "octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant",
  4506. method: "GET",
  4507. params: {
  4508. grant_id: {
  4509. required: true,
  4510. type: "integer"
  4511. }
  4512. },
  4513. url: "/applications/grants/:grant_id"
  4514. },
  4515. getOrCreateAuthorizationForApp: {
  4516. deprecated: "octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app",
  4517. method: "PUT",
  4518. params: {
  4519. client_id: {
  4520. required: true,
  4521. type: "string"
  4522. },
  4523. client_secret: {
  4524. required: true,
  4525. type: "string"
  4526. },
  4527. fingerprint: {
  4528. type: "string"
  4529. },
  4530. note: {
  4531. type: "string"
  4532. },
  4533. note_url: {
  4534. type: "string"
  4535. },
  4536. scopes: {
  4537. type: "string[]"
  4538. }
  4539. },
  4540. url: "/authorizations/clients/:client_id"
  4541. },
  4542. getOrCreateAuthorizationForAppAndFingerprint: {
  4543. deprecated: "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint",
  4544. method: "PUT",
  4545. params: {
  4546. client_id: {
  4547. required: true,
  4548. type: "string"
  4549. },
  4550. client_secret: {
  4551. required: true,
  4552. type: "string"
  4553. },
  4554. fingerprint: {
  4555. required: true,
  4556. type: "string"
  4557. },
  4558. note: {
  4559. type: "string"
  4560. },
  4561. note_url: {
  4562. type: "string"
  4563. },
  4564. scopes: {
  4565. type: "string[]"
  4566. }
  4567. },
  4568. url: "/authorizations/clients/:client_id/:fingerprint"
  4569. },
  4570. getOrCreateAuthorizationForAppFingerprint: {
  4571. deprecated: "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)",
  4572. method: "PUT",
  4573. params: {
  4574. client_id: {
  4575. required: true,
  4576. type: "string"
  4577. },
  4578. client_secret: {
  4579. required: true,
  4580. type: "string"
  4581. },
  4582. fingerprint: {
  4583. required: true,
  4584. type: "string"
  4585. },
  4586. note: {
  4587. type: "string"
  4588. },
  4589. note_url: {
  4590. type: "string"
  4591. },
  4592. scopes: {
  4593. type: "string[]"
  4594. }
  4595. },
  4596. url: "/authorizations/clients/:client_id/:fingerprint"
  4597. },
  4598. listAuthorizations: {
  4599. deprecated: "octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations",
  4600. method: "GET",
  4601. params: {
  4602. page: {
  4603. type: "integer"
  4604. },
  4605. per_page: {
  4606. type: "integer"
  4607. }
  4608. },
  4609. url: "/authorizations"
  4610. },
  4611. listGrants: {
  4612. deprecated: "octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants",
  4613. method: "GET",
  4614. params: {
  4615. page: {
  4616. type: "integer"
  4617. },
  4618. per_page: {
  4619. type: "integer"
  4620. }
  4621. },
  4622. url: "/applications/grants"
  4623. },
  4624. resetAuthorization: {
  4625. deprecated: "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)",
  4626. method: "POST",
  4627. params: {
  4628. access_token: {
  4629. required: true,
  4630. type: "string"
  4631. },
  4632. client_id: {
  4633. required: true,
  4634. type: "string"
  4635. }
  4636. },
  4637. url: "/applications/:client_id/tokens/:access_token"
  4638. },
  4639. revokeAuthorizationForApplication: {
  4640. deprecated: "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)",
  4641. method: "DELETE",
  4642. params: {
  4643. access_token: {
  4644. required: true,
  4645. type: "string"
  4646. },
  4647. client_id: {
  4648. required: true,
  4649. type: "string"
  4650. }
  4651. },
  4652. url: "/applications/:client_id/tokens/:access_token"
  4653. },
  4654. revokeGrantForApplication: {
  4655. deprecated: "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)",
  4656. method: "DELETE",
  4657. params: {
  4658. access_token: {
  4659. required: true,
  4660. type: "string"
  4661. },
  4662. client_id: {
  4663. required: true,
  4664. type: "string"
  4665. }
  4666. },
  4667. url: "/applications/:client_id/grants/:access_token"
  4668. },
  4669. updateAuthorization: {
  4670. deprecated: "octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization",
  4671. method: "PATCH",
  4672. params: {
  4673. add_scopes: {
  4674. type: "string[]"
  4675. },
  4676. authorization_id: {
  4677. required: true,
  4678. type: "integer"
  4679. },
  4680. fingerprint: {
  4681. type: "string"
  4682. },
  4683. note: {
  4684. type: "string"
  4685. },
  4686. note_url: {
  4687. type: "string"
  4688. },
  4689. remove_scopes: {
  4690. type: "string[]"
  4691. },
  4692. scopes: {
  4693. type: "string[]"
  4694. }
  4695. },
  4696. url: "/authorizations/:authorization_id"
  4697. }
  4698. },
  4699. orgs: {
  4700. addOrUpdateMembership: {
  4701. method: "PUT",
  4702. params: {
  4703. org: {
  4704. required: true,
  4705. type: "string"
  4706. },
  4707. role: {
  4708. enum: ["admin", "member"],
  4709. type: "string"
  4710. },
  4711. username: {
  4712. required: true,
  4713. type: "string"
  4714. }
  4715. },
  4716. url: "/orgs/:org/memberships/:username"
  4717. },
  4718. blockUser: {
  4719. method: "PUT",
  4720. params: {
  4721. org: {
  4722. required: true,
  4723. type: "string"
  4724. },
  4725. username: {
  4726. required: true,
  4727. type: "string"
  4728. }
  4729. },
  4730. url: "/orgs/:org/blocks/:username"
  4731. },
  4732. checkBlockedUser: {
  4733. method: "GET",
  4734. params: {
  4735. org: {
  4736. required: true,
  4737. type: "string"
  4738. },
  4739. username: {
  4740. required: true,
  4741. type: "string"
  4742. }
  4743. },
  4744. url: "/orgs/:org/blocks/:username"
  4745. },
  4746. checkMembership: {
  4747. method: "GET",
  4748. params: {
  4749. org: {
  4750. required: true,
  4751. type: "string"
  4752. },
  4753. username: {
  4754. required: true,
  4755. type: "string"
  4756. }
  4757. },
  4758. url: "/orgs/:org/members/:username"
  4759. },
  4760. checkPublicMembership: {
  4761. method: "GET",
  4762. params: {
  4763. org: {
  4764. required: true,
  4765. type: "string"
  4766. },
  4767. username: {
  4768. required: true,
  4769. type: "string"
  4770. }
  4771. },
  4772. url: "/orgs/:org/public_members/:username"
  4773. },
  4774. concealMembership: {
  4775. method: "DELETE",
  4776. params: {
  4777. org: {
  4778. required: true,
  4779. type: "string"
  4780. },
  4781. username: {
  4782. required: true,
  4783. type: "string"
  4784. }
  4785. },
  4786. url: "/orgs/:org/public_members/:username"
  4787. },
  4788. convertMemberToOutsideCollaborator: {
  4789. method: "PUT",
  4790. params: {
  4791. org: {
  4792. required: true,
  4793. type: "string"
  4794. },
  4795. username: {
  4796. required: true,
  4797. type: "string"
  4798. }
  4799. },
  4800. url: "/orgs/:org/outside_collaborators/:username"
  4801. },
  4802. createHook: {
  4803. method: "POST",
  4804. params: {
  4805. active: {
  4806. type: "boolean"
  4807. },
  4808. config: {
  4809. required: true,
  4810. type: "object"
  4811. },
  4812. "config.content_type": {
  4813. type: "string"
  4814. },
  4815. "config.insecure_ssl": {
  4816. type: "string"
  4817. },
  4818. "config.secret": {
  4819. type: "string"
  4820. },
  4821. "config.url": {
  4822. required: true,
  4823. type: "string"
  4824. },
  4825. events: {
  4826. type: "string[]"
  4827. },
  4828. name: {
  4829. required: true,
  4830. type: "string"
  4831. },
  4832. org: {
  4833. required: true,
  4834. type: "string"
  4835. }
  4836. },
  4837. url: "/orgs/:org/hooks"
  4838. },
  4839. createInvitation: {
  4840. method: "POST",
  4841. params: {
  4842. email: {
  4843. type: "string"
  4844. },
  4845. invitee_id: {
  4846. type: "integer"
  4847. },
  4848. org: {
  4849. required: true,
  4850. type: "string"
  4851. },
  4852. role: {
  4853. enum: ["admin", "direct_member", "billing_manager"],
  4854. type: "string"
  4855. },
  4856. team_ids: {
  4857. type: "integer[]"
  4858. }
  4859. },
  4860. url: "/orgs/:org/invitations"
  4861. },
  4862. deleteHook: {
  4863. method: "DELETE",
  4864. params: {
  4865. hook_id: {
  4866. required: true,
  4867. type: "integer"
  4868. },
  4869. org: {
  4870. required: true,
  4871. type: "string"
  4872. }
  4873. },
  4874. url: "/orgs/:org/hooks/:hook_id"
  4875. },
  4876. get: {
  4877. method: "GET",
  4878. params: {
  4879. org: {
  4880. required: true,
  4881. type: "string"
  4882. }
  4883. },
  4884. url: "/orgs/:org"
  4885. },
  4886. getHook: {
  4887. method: "GET",
  4888. params: {
  4889. hook_id: {
  4890. required: true,
  4891. type: "integer"
  4892. },
  4893. org: {
  4894. required: true,
  4895. type: "string"
  4896. }
  4897. },
  4898. url: "/orgs/:org/hooks/:hook_id"
  4899. },
  4900. getMembership: {
  4901. method: "GET",
  4902. params: {
  4903. org: {
  4904. required: true,
  4905. type: "string"
  4906. },
  4907. username: {
  4908. required: true,
  4909. type: "string"
  4910. }
  4911. },
  4912. url: "/orgs/:org/memberships/:username"
  4913. },
  4914. getMembershipForAuthenticatedUser: {
  4915. method: "GET",
  4916. params: {
  4917. org: {
  4918. required: true,
  4919. type: "string"
  4920. }
  4921. },
  4922. url: "/user/memberships/orgs/:org"
  4923. },
  4924. list: {
  4925. method: "GET",
  4926. params: {
  4927. page: {
  4928. type: "integer"
  4929. },
  4930. per_page: {
  4931. type: "integer"
  4932. },
  4933. since: {
  4934. type: "integer"
  4935. }
  4936. },
  4937. url: "/organizations"
  4938. },
  4939. listBlockedUsers: {
  4940. method: "GET",
  4941. params: {
  4942. org: {
  4943. required: true,
  4944. type: "string"
  4945. }
  4946. },
  4947. url: "/orgs/:org/blocks"
  4948. },
  4949. listForAuthenticatedUser: {
  4950. method: "GET",
  4951. params: {
  4952. page: {
  4953. type: "integer"
  4954. },
  4955. per_page: {
  4956. type: "integer"
  4957. }
  4958. },
  4959. url: "/user/orgs"
  4960. },
  4961. listForUser: {
  4962. method: "GET",
  4963. params: {
  4964. page: {
  4965. type: "integer"
  4966. },
  4967. per_page: {
  4968. type: "integer"
  4969. },
  4970. username: {
  4971. required: true,
  4972. type: "string"
  4973. }
  4974. },
  4975. url: "/users/:username/orgs"
  4976. },
  4977. listHooks: {
  4978. method: "GET",
  4979. params: {
  4980. org: {
  4981. required: true,
  4982. type: "string"
  4983. },
  4984. page: {
  4985. type: "integer"
  4986. },
  4987. per_page: {
  4988. type: "integer"
  4989. }
  4990. },
  4991. url: "/orgs/:org/hooks"
  4992. },
  4993. listInstallations: {
  4994. headers: {
  4995. accept: "application/vnd.github.machine-man-preview+json"
  4996. },
  4997. method: "GET",
  4998. params: {
  4999. org: {
  5000. required: true,
  5001. type: "string"
  5002. },
  5003. page: {
  5004. type: "integer"
  5005. },
  5006. per_page: {
  5007. type: "integer"
  5008. }
  5009. },
  5010. url: "/orgs/:org/installations"
  5011. },
  5012. listInvitationTeams: {
  5013. method: "GET",
  5014. params: {
  5015. invitation_id: {
  5016. required: true,
  5017. type: "integer"
  5018. },
  5019. org: {
  5020. required: true,
  5021. type: "string"
  5022. },
  5023. page: {
  5024. type: "integer"
  5025. },
  5026. per_page: {
  5027. type: "integer"
  5028. }
  5029. },
  5030. url: "/orgs/:org/invitations/:invitation_id/teams"
  5031. },
  5032. listMembers: {
  5033. method: "GET",
  5034. params: {
  5035. filter: {
  5036. enum: ["2fa_disabled", "all"],
  5037. type: "string"
  5038. },
  5039. org: {
  5040. required: true,
  5041. type: "string"
  5042. },
  5043. page: {
  5044. type: "integer"
  5045. },
  5046. per_page: {
  5047. type: "integer"
  5048. },
  5049. role: {
  5050. enum: ["all", "admin", "member"],
  5051. type: "string"
  5052. }
  5053. },
  5054. url: "/orgs/:org/members"
  5055. },
  5056. listMemberships: {
  5057. method: "GET",
  5058. params: {
  5059. page: {
  5060. type: "integer"
  5061. },
  5062. per_page: {
  5063. type: "integer"
  5064. },
  5065. state: {
  5066. enum: ["active", "pending"],
  5067. type: "string"
  5068. }
  5069. },
  5070. url: "/user/memberships/orgs"
  5071. },
  5072. listOutsideCollaborators: {
  5073. method: "GET",
  5074. params: {
  5075. filter: {
  5076. enum: ["2fa_disabled", "all"],
  5077. type: "string"
  5078. },
  5079. org: {
  5080. required: true,
  5081. type: "string"
  5082. },
  5083. page: {
  5084. type: "integer"
  5085. },
  5086. per_page: {
  5087. type: "integer"
  5088. }
  5089. },
  5090. url: "/orgs/:org/outside_collaborators"
  5091. },
  5092. listPendingInvitations: {
  5093. method: "GET",
  5094. params: {
  5095. org: {
  5096. required: true,
  5097. type: "string"
  5098. },
  5099. page: {
  5100. type: "integer"
  5101. },
  5102. per_page: {
  5103. type: "integer"
  5104. }
  5105. },
  5106. url: "/orgs/:org/invitations"
  5107. },
  5108. listPublicMembers: {
  5109. method: "GET",
  5110. params: {
  5111. org: {
  5112. required: true,
  5113. type: "string"
  5114. },
  5115. page: {
  5116. type: "integer"
  5117. },
  5118. per_page: {
  5119. type: "integer"
  5120. }
  5121. },
  5122. url: "/orgs/:org/public_members"
  5123. },
  5124. pingHook: {
  5125. method: "POST",
  5126. params: {
  5127. hook_id: {
  5128. required: true,
  5129. type: "integer"
  5130. },
  5131. org: {
  5132. required: true,
  5133. type: "string"
  5134. }
  5135. },
  5136. url: "/orgs/:org/hooks/:hook_id/pings"
  5137. },
  5138. publicizeMembership: {
  5139. method: "PUT",
  5140. params: {
  5141. org: {
  5142. required: true,
  5143. type: "string"
  5144. },
  5145. username: {
  5146. required: true,
  5147. type: "string"
  5148. }
  5149. },
  5150. url: "/orgs/:org/public_members/:username"
  5151. },
  5152. removeMember: {
  5153. method: "DELETE",
  5154. params: {
  5155. org: {
  5156. required: true,
  5157. type: "string"
  5158. },
  5159. username: {
  5160. required: true,
  5161. type: "string"
  5162. }
  5163. },
  5164. url: "/orgs/:org/members/:username"
  5165. },
  5166. removeMembership: {
  5167. method: "DELETE",
  5168. params: {
  5169. org: {
  5170. required: true,
  5171. type: "string"
  5172. },
  5173. username: {
  5174. required: true,
  5175. type: "string"
  5176. }
  5177. },
  5178. url: "/orgs/:org/memberships/:username"
  5179. },
  5180. removeOutsideCollaborator: {
  5181. method: "DELETE",
  5182. params: {
  5183. org: {
  5184. required: true,
  5185. type: "string"
  5186. },
  5187. username: {
  5188. required: true,
  5189. type: "string"
  5190. }
  5191. },
  5192. url: "/orgs/:org/outside_collaborators/:username"
  5193. },
  5194. unblockUser: {
  5195. method: "DELETE",
  5196. params: {
  5197. org: {
  5198. required: true,
  5199. type: "string"
  5200. },
  5201. username: {
  5202. required: true,
  5203. type: "string"
  5204. }
  5205. },
  5206. url: "/orgs/:org/blocks/:username"
  5207. },
  5208. update: {
  5209. method: "PATCH",
  5210. params: {
  5211. billing_email: {
  5212. type: "string"
  5213. },
  5214. company: {
  5215. type: "string"
  5216. },
  5217. default_repository_permission: {
  5218. enum: ["read", "write", "admin", "none"],
  5219. type: "string"
  5220. },
  5221. description: {
  5222. type: "string"
  5223. },
  5224. email: {
  5225. type: "string"
  5226. },
  5227. has_organization_projects: {
  5228. type: "boolean"
  5229. },
  5230. has_repository_projects: {
  5231. type: "boolean"
  5232. },
  5233. location: {
  5234. type: "string"
  5235. },
  5236. members_allowed_repository_creation_type: {
  5237. enum: ["all", "private", "none"],
  5238. type: "string"
  5239. },
  5240. members_can_create_internal_repositories: {
  5241. type: "boolean"
  5242. },
  5243. members_can_create_private_repositories: {
  5244. type: "boolean"
  5245. },
  5246. members_can_create_public_repositories: {
  5247. type: "boolean"
  5248. },
  5249. members_can_create_repositories: {
  5250. type: "boolean"
  5251. },
  5252. name: {
  5253. type: "string"
  5254. },
  5255. org: {
  5256. required: true,
  5257. type: "string"
  5258. }
  5259. },
  5260. url: "/orgs/:org"
  5261. },
  5262. updateHook: {
  5263. method: "PATCH",
  5264. params: {
  5265. active: {
  5266. type: "boolean"
  5267. },
  5268. config: {
  5269. type: "object"
  5270. },
  5271. "config.content_type": {
  5272. type: "string"
  5273. },
  5274. "config.insecure_ssl": {
  5275. type: "string"
  5276. },
  5277. "config.secret": {
  5278. type: "string"
  5279. },
  5280. "config.url": {
  5281. required: true,
  5282. type: "string"
  5283. },
  5284. events: {
  5285. type: "string[]"
  5286. },
  5287. hook_id: {
  5288. required: true,
  5289. type: "integer"
  5290. },
  5291. org: {
  5292. required: true,
  5293. type: "string"
  5294. }
  5295. },
  5296. url: "/orgs/:org/hooks/:hook_id"
  5297. },
  5298. updateMembership: {
  5299. method: "PATCH",
  5300. params: {
  5301. org: {
  5302. required: true,
  5303. type: "string"
  5304. },
  5305. state: {
  5306. enum: ["active"],
  5307. required: true,
  5308. type: "string"
  5309. }
  5310. },
  5311. url: "/user/memberships/orgs/:org"
  5312. }
  5313. },
  5314. projects: {
  5315. addCollaborator: {
  5316. headers: {
  5317. accept: "application/vnd.github.inertia-preview+json"
  5318. },
  5319. method: "PUT",
  5320. params: {
  5321. permission: {
  5322. enum: ["read", "write", "admin"],
  5323. type: "string"
  5324. },
  5325. project_id: {
  5326. required: true,
  5327. type: "integer"
  5328. },
  5329. username: {
  5330. required: true,
  5331. type: "string"
  5332. }
  5333. },
  5334. url: "/projects/:project_id/collaborators/:username"
  5335. },
  5336. createCard: {
  5337. headers: {
  5338. accept: "application/vnd.github.inertia-preview+json"
  5339. },
  5340. method: "POST",
  5341. params: {
  5342. column_id: {
  5343. required: true,
  5344. type: "integer"
  5345. },
  5346. content_id: {
  5347. type: "integer"
  5348. },
  5349. content_type: {
  5350. type: "string"
  5351. },
  5352. note: {
  5353. type: "string"
  5354. }
  5355. },
  5356. url: "/projects/columns/:column_id/cards"
  5357. },
  5358. createColumn: {
  5359. headers: {
  5360. accept: "application/vnd.github.inertia-preview+json"
  5361. },
  5362. method: "POST",
  5363. params: {
  5364. name: {
  5365. required: true,
  5366. type: "string"
  5367. },
  5368. project_id: {
  5369. required: true,
  5370. type: "integer"
  5371. }
  5372. },
  5373. url: "/projects/:project_id/columns"
  5374. },
  5375. createForAuthenticatedUser: {
  5376. headers: {
  5377. accept: "application/vnd.github.inertia-preview+json"
  5378. },
  5379. method: "POST",
  5380. params: {
  5381. body: {
  5382. type: "string"
  5383. },
  5384. name: {
  5385. required: true,
  5386. type: "string"
  5387. }
  5388. },
  5389. url: "/user/projects"
  5390. },
  5391. createForOrg: {
  5392. headers: {
  5393. accept: "application/vnd.github.inertia-preview+json"
  5394. },
  5395. method: "POST",
  5396. params: {
  5397. body: {
  5398. type: "string"
  5399. },
  5400. name: {
  5401. required: true,
  5402. type: "string"
  5403. },
  5404. org: {
  5405. required: true,
  5406. type: "string"
  5407. }
  5408. },
  5409. url: "/orgs/:org/projects"
  5410. },
  5411. createForRepo: {
  5412. headers: {
  5413. accept: "application/vnd.github.inertia-preview+json"
  5414. },
  5415. method: "POST",
  5416. params: {
  5417. body: {
  5418. type: "string"
  5419. },
  5420. name: {
  5421. required: true,
  5422. type: "string"
  5423. },
  5424. owner: {
  5425. required: true,
  5426. type: "string"
  5427. },
  5428. repo: {
  5429. required: true,
  5430. type: "string"
  5431. }
  5432. },
  5433. url: "/repos/:owner/:repo/projects"
  5434. },
  5435. delete: {
  5436. headers: {
  5437. accept: "application/vnd.github.inertia-preview+json"
  5438. },
  5439. method: "DELETE",
  5440. params: {
  5441. project_id: {
  5442. required: true,
  5443. type: "integer"
  5444. }
  5445. },
  5446. url: "/projects/:project_id"
  5447. },
  5448. deleteCard: {
  5449. headers: {
  5450. accept: "application/vnd.github.inertia-preview+json"
  5451. },
  5452. method: "DELETE",
  5453. params: {
  5454. card_id: {
  5455. required: true,
  5456. type: "integer"
  5457. }
  5458. },
  5459. url: "/projects/columns/cards/:card_id"
  5460. },
  5461. deleteColumn: {
  5462. headers: {
  5463. accept: "application/vnd.github.inertia-preview+json"
  5464. },
  5465. method: "DELETE",
  5466. params: {
  5467. column_id: {
  5468. required: true,
  5469. type: "integer"
  5470. }
  5471. },
  5472. url: "/projects/columns/:column_id"
  5473. },
  5474. get: {
  5475. headers: {
  5476. accept: "application/vnd.github.inertia-preview+json"
  5477. },
  5478. method: "GET",
  5479. params: {
  5480. project_id: {
  5481. required: true,
  5482. type: "integer"
  5483. }
  5484. },
  5485. url: "/projects/:project_id"
  5486. },
  5487. getCard: {
  5488. headers: {
  5489. accept: "application/vnd.github.inertia-preview+json"
  5490. },
  5491. method: "GET",
  5492. params: {
  5493. card_id: {
  5494. required: true,
  5495. type: "integer"
  5496. }
  5497. },
  5498. url: "/projects/columns/cards/:card_id"
  5499. },
  5500. getColumn: {
  5501. headers: {
  5502. accept: "application/vnd.github.inertia-preview+json"
  5503. },
  5504. method: "GET",
  5505. params: {
  5506. column_id: {
  5507. required: true,
  5508. type: "integer"
  5509. }
  5510. },
  5511. url: "/projects/columns/:column_id"
  5512. },
  5513. listCards: {
  5514. headers: {
  5515. accept: "application/vnd.github.inertia-preview+json"
  5516. },
  5517. method: "GET",
  5518. params: {
  5519. archived_state: {
  5520. enum: ["all", "archived", "not_archived"],
  5521. type: "string"
  5522. },
  5523. column_id: {
  5524. required: true,
  5525. type: "integer"
  5526. },
  5527. page: {
  5528. type: "integer"
  5529. },
  5530. per_page: {
  5531. type: "integer"
  5532. }
  5533. },
  5534. url: "/projects/columns/:column_id/cards"
  5535. },
  5536. listCollaborators: {
  5537. headers: {
  5538. accept: "application/vnd.github.inertia-preview+json"
  5539. },
  5540. method: "GET",
  5541. params: {
  5542. affiliation: {
  5543. enum: ["outside", "direct", "all"],
  5544. type: "string"
  5545. },
  5546. page: {
  5547. type: "integer"
  5548. },
  5549. per_page: {
  5550. type: "integer"
  5551. },
  5552. project_id: {
  5553. required: true,
  5554. type: "integer"
  5555. }
  5556. },
  5557. url: "/projects/:project_id/collaborators"
  5558. },
  5559. listColumns: {
  5560. headers: {
  5561. accept: "application/vnd.github.inertia-preview+json"
  5562. },
  5563. method: "GET",
  5564. params: {
  5565. page: {
  5566. type: "integer"
  5567. },
  5568. per_page: {
  5569. type: "integer"
  5570. },
  5571. project_id: {
  5572. required: true,
  5573. type: "integer"
  5574. }
  5575. },
  5576. url: "/projects/:project_id/columns"
  5577. },
  5578. listForOrg: {
  5579. headers: {
  5580. accept: "application/vnd.github.inertia-preview+json"
  5581. },
  5582. method: "GET",
  5583. params: {
  5584. org: {
  5585. required: true,
  5586. type: "string"
  5587. },
  5588. page: {
  5589. type: "integer"
  5590. },
  5591. per_page: {
  5592. type: "integer"
  5593. },
  5594. state: {
  5595. enum: ["open", "closed", "all"],
  5596. type: "string"
  5597. }
  5598. },
  5599. url: "/orgs/:org/projects"
  5600. },
  5601. listForRepo: {
  5602. headers: {
  5603. accept: "application/vnd.github.inertia-preview+json"
  5604. },
  5605. method: "GET",
  5606. params: {
  5607. owner: {
  5608. required: true,
  5609. type: "string"
  5610. },
  5611. page: {
  5612. type: "integer"
  5613. },
  5614. per_page: {
  5615. type: "integer"
  5616. },
  5617. repo: {
  5618. required: true,
  5619. type: "string"
  5620. },
  5621. state: {
  5622. enum: ["open", "closed", "all"],
  5623. type: "string"
  5624. }
  5625. },
  5626. url: "/repos/:owner/:repo/projects"
  5627. },
  5628. listForUser: {
  5629. headers: {
  5630. accept: "application/vnd.github.inertia-preview+json"
  5631. },
  5632. method: "GET",
  5633. params: {
  5634. page: {
  5635. type: "integer"
  5636. },
  5637. per_page: {
  5638. type: "integer"
  5639. },
  5640. state: {
  5641. enum: ["open", "closed", "all"],
  5642. type: "string"
  5643. },
  5644. username: {
  5645. required: true,
  5646. type: "string"
  5647. }
  5648. },
  5649. url: "/users/:username/projects"
  5650. },
  5651. moveCard: {
  5652. headers: {
  5653. accept: "application/vnd.github.inertia-preview+json"
  5654. },
  5655. method: "POST",
  5656. params: {
  5657. card_id: {
  5658. required: true,
  5659. type: "integer"
  5660. },
  5661. column_id: {
  5662. type: "integer"
  5663. },
  5664. position: {
  5665. required: true,
  5666. type: "string",
  5667. validation: "^(top|bottom|after:\\d+)$"
  5668. }
  5669. },
  5670. url: "/projects/columns/cards/:card_id/moves"
  5671. },
  5672. moveColumn: {
  5673. headers: {
  5674. accept: "application/vnd.github.inertia-preview+json"
  5675. },
  5676. method: "POST",
  5677. params: {
  5678. column_id: {
  5679. required: true,
  5680. type: "integer"
  5681. },
  5682. position: {
  5683. required: true,
  5684. type: "string",
  5685. validation: "^(first|last|after:\\d+)$"
  5686. }
  5687. },
  5688. url: "/projects/columns/:column_id/moves"
  5689. },
  5690. removeCollaborator: {
  5691. headers: {
  5692. accept: "application/vnd.github.inertia-preview+json"
  5693. },
  5694. method: "DELETE",
  5695. params: {
  5696. project_id: {
  5697. required: true,
  5698. type: "integer"
  5699. },
  5700. username: {
  5701. required: true,
  5702. type: "string"
  5703. }
  5704. },
  5705. url: "/projects/:project_id/collaborators/:username"
  5706. },
  5707. reviewUserPermissionLevel: {
  5708. headers: {
  5709. accept: "application/vnd.github.inertia-preview+json"
  5710. },
  5711. method: "GET",
  5712. params: {
  5713. project_id: {
  5714. required: true,
  5715. type: "integer"
  5716. },
  5717. username: {
  5718. required: true,
  5719. type: "string"
  5720. }
  5721. },
  5722. url: "/projects/:project_id/collaborators/:username/permission"
  5723. },
  5724. update: {
  5725. headers: {
  5726. accept: "application/vnd.github.inertia-preview+json"
  5727. },
  5728. method: "PATCH",
  5729. params: {
  5730. body: {
  5731. type: "string"
  5732. },
  5733. name: {
  5734. type: "string"
  5735. },
  5736. organization_permission: {
  5737. type: "string"
  5738. },
  5739. private: {
  5740. type: "boolean"
  5741. },
  5742. project_id: {
  5743. required: true,
  5744. type: "integer"
  5745. },
  5746. state: {
  5747. enum: ["open", "closed"],
  5748. type: "string"
  5749. }
  5750. },
  5751. url: "/projects/:project_id"
  5752. },
  5753. updateCard: {
  5754. headers: {
  5755. accept: "application/vnd.github.inertia-preview+json"
  5756. },
  5757. method: "PATCH",
  5758. params: {
  5759. archived: {
  5760. type: "boolean"
  5761. },
  5762. card_id: {
  5763. required: true,
  5764. type: "integer"
  5765. },
  5766. note: {
  5767. type: "string"
  5768. }
  5769. },
  5770. url: "/projects/columns/cards/:card_id"
  5771. },
  5772. updateColumn: {
  5773. headers: {
  5774. accept: "application/vnd.github.inertia-preview+json"
  5775. },
  5776. method: "PATCH",
  5777. params: {
  5778. column_id: {
  5779. required: true,
  5780. type: "integer"
  5781. },
  5782. name: {
  5783. required: true,
  5784. type: "string"
  5785. }
  5786. },
  5787. url: "/projects/columns/:column_id"
  5788. }
  5789. },
  5790. pulls: {
  5791. checkIfMerged: {
  5792. method: "GET",
  5793. params: {
  5794. number: {
  5795. alias: "pull_number",
  5796. deprecated: true,
  5797. type: "integer"
  5798. },
  5799. owner: {
  5800. required: true,
  5801. type: "string"
  5802. },
  5803. pull_number: {
  5804. required: true,
  5805. type: "integer"
  5806. },
  5807. repo: {
  5808. required: true,
  5809. type: "string"
  5810. }
  5811. },
  5812. url: "/repos/:owner/:repo/pulls/:pull_number/merge"
  5813. },
  5814. create: {
  5815. method: "POST",
  5816. params: {
  5817. base: {
  5818. required: true,
  5819. type: "string"
  5820. },
  5821. body: {
  5822. type: "string"
  5823. },
  5824. draft: {
  5825. type: "boolean"
  5826. },
  5827. head: {
  5828. required: true,
  5829. type: "string"
  5830. },
  5831. maintainer_can_modify: {
  5832. type: "boolean"
  5833. },
  5834. owner: {
  5835. required: true,
  5836. type: "string"
  5837. },
  5838. repo: {
  5839. required: true,
  5840. type: "string"
  5841. },
  5842. title: {
  5843. required: true,
  5844. type: "string"
  5845. }
  5846. },
  5847. url: "/repos/:owner/:repo/pulls"
  5848. },
  5849. createComment: {
  5850. method: "POST",
  5851. params: {
  5852. body: {
  5853. required: true,
  5854. type: "string"
  5855. },
  5856. commit_id: {
  5857. required: true,
  5858. type: "string"
  5859. },
  5860. in_reply_to: {
  5861. deprecated: true,
  5862. description: "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.",
  5863. type: "integer"
  5864. },
  5865. line: {
  5866. type: "integer"
  5867. },
  5868. number: {
  5869. alias: "pull_number",
  5870. deprecated: true,
  5871. type: "integer"
  5872. },
  5873. owner: {
  5874. required: true,
  5875. type: "string"
  5876. },
  5877. path: {
  5878. required: true,
  5879. type: "string"
  5880. },
  5881. position: {
  5882. type: "integer"
  5883. },
  5884. pull_number: {
  5885. required: true,
  5886. type: "integer"
  5887. },
  5888. repo: {
  5889. required: true,
  5890. type: "string"
  5891. },
  5892. side: {
  5893. enum: ["LEFT", "RIGHT"],
  5894. type: "string"
  5895. },
  5896. start_line: {
  5897. type: "integer"
  5898. },
  5899. start_side: {
  5900. enum: ["LEFT", "RIGHT", "side"],
  5901. type: "string"
  5902. }
  5903. },
  5904. url: "/repos/:owner/:repo/pulls/:pull_number/comments"
  5905. },
  5906. createCommentReply: {
  5907. deprecated: "octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)",
  5908. method: "POST",
  5909. params: {
  5910. body: {
  5911. required: true,
  5912. type: "string"
  5913. },
  5914. commit_id: {
  5915. required: true,
  5916. type: "string"
  5917. },
  5918. in_reply_to: {
  5919. deprecated: true,
  5920. description: "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.",
  5921. type: "integer"
  5922. },
  5923. line: {
  5924. type: "integer"
  5925. },
  5926. number: {
  5927. alias: "pull_number",
  5928. deprecated: true,
  5929. type: "integer"
  5930. },
  5931. owner: {
  5932. required: true,
  5933. type: "string"
  5934. },
  5935. path: {
  5936. required: true,
  5937. type: "string"
  5938. },
  5939. position: {
  5940. type: "integer"
  5941. },
  5942. pull_number: {
  5943. required: true,
  5944. type: "integer"
  5945. },
  5946. repo: {
  5947. required: true,
  5948. type: "string"
  5949. },
  5950. side: {
  5951. enum: ["LEFT", "RIGHT"],
  5952. type: "string"
  5953. },
  5954. start_line: {
  5955. type: "integer"
  5956. },
  5957. start_side: {
  5958. enum: ["LEFT", "RIGHT", "side"],
  5959. type: "string"
  5960. }
  5961. },
  5962. url: "/repos/:owner/:repo/pulls/:pull_number/comments"
  5963. },
  5964. createFromIssue: {
  5965. deprecated: "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request",
  5966. method: "POST",
  5967. params: {
  5968. base: {
  5969. required: true,
  5970. type: "string"
  5971. },
  5972. draft: {
  5973. type: "boolean"
  5974. },
  5975. head: {
  5976. required: true,
  5977. type: "string"
  5978. },
  5979. issue: {
  5980. required: true,
  5981. type: "integer"
  5982. },
  5983. maintainer_can_modify: {
  5984. type: "boolean"
  5985. },
  5986. owner: {
  5987. required: true,
  5988. type: "string"
  5989. },
  5990. repo: {
  5991. required: true,
  5992. type: "string"
  5993. }
  5994. },
  5995. url: "/repos/:owner/:repo/pulls"
  5996. },
  5997. createReview: {
  5998. method: "POST",
  5999. params: {
  6000. body: {
  6001. type: "string"
  6002. },
  6003. comments: {
  6004. type: "object[]"
  6005. },
  6006. "comments[].body": {
  6007. required: true,
  6008. type: "string"
  6009. },
  6010. "comments[].path": {
  6011. required: true,
  6012. type: "string"
  6013. },
  6014. "comments[].position": {
  6015. required: true,
  6016. type: "integer"
  6017. },
  6018. commit_id: {
  6019. type: "string"
  6020. },
  6021. event: {
  6022. enum: ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  6023. type: "string"
  6024. },
  6025. number: {
  6026. alias: "pull_number",
  6027. deprecated: true,
  6028. type: "integer"
  6029. },
  6030. owner: {
  6031. required: true,
  6032. type: "string"
  6033. },
  6034. pull_number: {
  6035. required: true,
  6036. type: "integer"
  6037. },
  6038. repo: {
  6039. required: true,
  6040. type: "string"
  6041. }
  6042. },
  6043. url: "/repos/:owner/:repo/pulls/:pull_number/reviews"
  6044. },
  6045. createReviewCommentReply: {
  6046. method: "POST",
  6047. params: {
  6048. body: {
  6049. required: true,
  6050. type: "string"
  6051. },
  6052. comment_id: {
  6053. required: true,
  6054. type: "integer"
  6055. },
  6056. owner: {
  6057. required: true,
  6058. type: "string"
  6059. },
  6060. pull_number: {
  6061. required: true,
  6062. type: "integer"
  6063. },
  6064. repo: {
  6065. required: true,
  6066. type: "string"
  6067. }
  6068. },
  6069. url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"
  6070. },
  6071. createReviewRequest: {
  6072. method: "POST",
  6073. params: {
  6074. number: {
  6075. alias: "pull_number",
  6076. deprecated: true,
  6077. type: "integer"
  6078. },
  6079. owner: {
  6080. required: true,
  6081. type: "string"
  6082. },
  6083. pull_number: {
  6084. required: true,
  6085. type: "integer"
  6086. },
  6087. repo: {
  6088. required: true,
  6089. type: "string"
  6090. },
  6091. reviewers: {
  6092. type: "string[]"
  6093. },
  6094. team_reviewers: {
  6095. type: "string[]"
  6096. }
  6097. },
  6098. url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  6099. },
  6100. deleteComment: {
  6101. method: "DELETE",
  6102. params: {
  6103. comment_id: {
  6104. required: true,
  6105. type: "integer"
  6106. },
  6107. owner: {
  6108. required: true,
  6109. type: "string"
  6110. },
  6111. repo: {
  6112. required: true,
  6113. type: "string"
  6114. }
  6115. },
  6116. url: "/repos/:owner/:repo/pulls/comments/:comment_id"
  6117. },
  6118. deletePendingReview: {
  6119. method: "DELETE",
  6120. params: {
  6121. number: {
  6122. alias: "pull_number",
  6123. deprecated: true,
  6124. type: "integer"
  6125. },
  6126. owner: {
  6127. required: true,
  6128. type: "string"
  6129. },
  6130. pull_number: {
  6131. required: true,
  6132. type: "integer"
  6133. },
  6134. repo: {
  6135. required: true,
  6136. type: "string"
  6137. },
  6138. review_id: {
  6139. required: true,
  6140. type: "integer"
  6141. }
  6142. },
  6143. url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  6144. },
  6145. deleteReviewRequest: {
  6146. method: "DELETE",
  6147. params: {
  6148. number: {
  6149. alias: "pull_number",
  6150. deprecated: true,
  6151. type: "integer"
  6152. },
  6153. owner: {
  6154. required: true,
  6155. type: "string"
  6156. },
  6157. pull_number: {
  6158. required: true,
  6159. type: "integer"
  6160. },
  6161. repo: {
  6162. required: true,
  6163. type: "string"
  6164. },
  6165. reviewers: {
  6166. type: "string[]"
  6167. },
  6168. team_reviewers: {
  6169. type: "string[]"
  6170. }
  6171. },
  6172. url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  6173. },
  6174. dismissReview: {
  6175. method: "PUT",
  6176. params: {
  6177. message: {
  6178. required: true,
  6179. type: "string"
  6180. },
  6181. number: {
  6182. alias: "pull_number",
  6183. deprecated: true,
  6184. type: "integer"
  6185. },
  6186. owner: {
  6187. required: true,
  6188. type: "string"
  6189. },
  6190. pull_number: {
  6191. required: true,
  6192. type: "integer"
  6193. },
  6194. repo: {
  6195. required: true,
  6196. type: "string"
  6197. },
  6198. review_id: {
  6199. required: true,
  6200. type: "integer"
  6201. }
  6202. },
  6203. url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"
  6204. },
  6205. get: {
  6206. method: "GET",
  6207. params: {
  6208. number: {
  6209. alias: "pull_number",
  6210. deprecated: true,
  6211. type: "integer"
  6212. },
  6213. owner: {
  6214. required: true,
  6215. type: "string"
  6216. },
  6217. pull_number: {
  6218. required: true,
  6219. type: "integer"
  6220. },
  6221. repo: {
  6222. required: true,
  6223. type: "string"
  6224. }
  6225. },
  6226. url: "/repos/:owner/:repo/pulls/:pull_number"
  6227. },
  6228. getComment: {
  6229. method: "GET",
  6230. params: {
  6231. comment_id: {
  6232. required: true,
  6233. type: "integer"
  6234. },
  6235. owner: {
  6236. required: true,
  6237. type: "string"
  6238. },
  6239. repo: {
  6240. required: true,
  6241. type: "string"
  6242. }
  6243. },
  6244. url: "/repos/:owner/:repo/pulls/comments/:comment_id"
  6245. },
  6246. getCommentsForReview: {
  6247. method: "GET",
  6248. params: {
  6249. number: {
  6250. alias: "pull_number",
  6251. deprecated: true,
  6252. type: "integer"
  6253. },
  6254. owner: {
  6255. required: true,
  6256. type: "string"
  6257. },
  6258. page: {
  6259. type: "integer"
  6260. },
  6261. per_page: {
  6262. type: "integer"
  6263. },
  6264. pull_number: {
  6265. required: true,
  6266. type: "integer"
  6267. },
  6268. repo: {
  6269. required: true,
  6270. type: "string"
  6271. },
  6272. review_id: {
  6273. required: true,
  6274. type: "integer"
  6275. }
  6276. },
  6277. url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"
  6278. },
  6279. getReview: {
  6280. method: "GET",
  6281. params: {
  6282. number: {
  6283. alias: "pull_number",
  6284. deprecated: true,
  6285. type: "integer"
  6286. },
  6287. owner: {
  6288. required: true,
  6289. type: "string"
  6290. },
  6291. pull_number: {
  6292. required: true,
  6293. type: "integer"
  6294. },
  6295. repo: {
  6296. required: true,
  6297. type: "string"
  6298. },
  6299. review_id: {
  6300. required: true,
  6301. type: "integer"
  6302. }
  6303. },
  6304. url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  6305. },
  6306. list: {
  6307. method: "GET",
  6308. params: {
  6309. base: {
  6310. type: "string"
  6311. },
  6312. direction: {
  6313. enum: ["asc", "desc"],
  6314. type: "string"
  6315. },
  6316. head: {
  6317. type: "string"
  6318. },
  6319. owner: {
  6320. required: true,
  6321. type: "string"
  6322. },
  6323. page: {
  6324. type: "integer"
  6325. },
  6326. per_page: {
  6327. type: "integer"
  6328. },
  6329. repo: {
  6330. required: true,
  6331. type: "string"
  6332. },
  6333. sort: {
  6334. enum: ["created", "updated", "popularity", "long-running"],
  6335. type: "string"
  6336. },
  6337. state: {
  6338. enum: ["open", "closed", "all"],
  6339. type: "string"
  6340. }
  6341. },
  6342. url: "/repos/:owner/:repo/pulls"
  6343. },
  6344. listComments: {
  6345. method: "GET",
  6346. params: {
  6347. direction: {
  6348. enum: ["asc", "desc"],
  6349. type: "string"
  6350. },
  6351. number: {
  6352. alias: "pull_number",
  6353. deprecated: true,
  6354. type: "integer"
  6355. },
  6356. owner: {
  6357. required: true,
  6358. type: "string"
  6359. },
  6360. page: {
  6361. type: "integer"
  6362. },
  6363. per_page: {
  6364. type: "integer"
  6365. },
  6366. pull_number: {
  6367. required: true,
  6368. type: "integer"
  6369. },
  6370. repo: {
  6371. required: true,
  6372. type: "string"
  6373. },
  6374. since: {
  6375. type: "string"
  6376. },
  6377. sort: {
  6378. enum: ["created", "updated"],
  6379. type: "string"
  6380. }
  6381. },
  6382. url: "/repos/:owner/:repo/pulls/:pull_number/comments"
  6383. },
  6384. listCommentsForRepo: {
  6385. method: "GET",
  6386. params: {
  6387. direction: {
  6388. enum: ["asc", "desc"],
  6389. type: "string"
  6390. },
  6391. owner: {
  6392. required: true,
  6393. type: "string"
  6394. },
  6395. page: {
  6396. type: "integer"
  6397. },
  6398. per_page: {
  6399. type: "integer"
  6400. },
  6401. repo: {
  6402. required: true,
  6403. type: "string"
  6404. },
  6405. since: {
  6406. type: "string"
  6407. },
  6408. sort: {
  6409. enum: ["created", "updated"],
  6410. type: "string"
  6411. }
  6412. },
  6413. url: "/repos/:owner/:repo/pulls/comments"
  6414. },
  6415. listCommits: {
  6416. method: "GET",
  6417. params: {
  6418. number: {
  6419. alias: "pull_number",
  6420. deprecated: true,
  6421. type: "integer"
  6422. },
  6423. owner: {
  6424. required: true,
  6425. type: "string"
  6426. },
  6427. page: {
  6428. type: "integer"
  6429. },
  6430. per_page: {
  6431. type: "integer"
  6432. },
  6433. pull_number: {
  6434. required: true,
  6435. type: "integer"
  6436. },
  6437. repo: {
  6438. required: true,
  6439. type: "string"
  6440. }
  6441. },
  6442. url: "/repos/:owner/:repo/pulls/:pull_number/commits"
  6443. },
  6444. listFiles: {
  6445. method: "GET",
  6446. params: {
  6447. number: {
  6448. alias: "pull_number",
  6449. deprecated: true,
  6450. type: "integer"
  6451. },
  6452. owner: {
  6453. required: true,
  6454. type: "string"
  6455. },
  6456. page: {
  6457. type: "integer"
  6458. },
  6459. per_page: {
  6460. type: "integer"
  6461. },
  6462. pull_number: {
  6463. required: true,
  6464. type: "integer"
  6465. },
  6466. repo: {
  6467. required: true,
  6468. type: "string"
  6469. }
  6470. },
  6471. url: "/repos/:owner/:repo/pulls/:pull_number/files"
  6472. },
  6473. listReviewRequests: {
  6474. method: "GET",
  6475. params: {
  6476. number: {
  6477. alias: "pull_number",
  6478. deprecated: true,
  6479. type: "integer"
  6480. },
  6481. owner: {
  6482. required: true,
  6483. type: "string"
  6484. },
  6485. page: {
  6486. type: "integer"
  6487. },
  6488. per_page: {
  6489. type: "integer"
  6490. },
  6491. pull_number: {
  6492. required: true,
  6493. type: "integer"
  6494. },
  6495. repo: {
  6496. required: true,
  6497. type: "string"
  6498. }
  6499. },
  6500. url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  6501. },
  6502. listReviews: {
  6503. method: "GET",
  6504. params: {
  6505. number: {
  6506. alias: "pull_number",
  6507. deprecated: true,
  6508. type: "integer"
  6509. },
  6510. owner: {
  6511. required: true,
  6512. type: "string"
  6513. },
  6514. page: {
  6515. type: "integer"
  6516. },
  6517. per_page: {
  6518. type: "integer"
  6519. },
  6520. pull_number: {
  6521. required: true,
  6522. type: "integer"
  6523. },
  6524. repo: {
  6525. required: true,
  6526. type: "string"
  6527. }
  6528. },
  6529. url: "/repos/:owner/:repo/pulls/:pull_number/reviews"
  6530. },
  6531. merge: {
  6532. method: "PUT",
  6533. params: {
  6534. commit_message: {
  6535. type: "string"
  6536. },
  6537. commit_title: {
  6538. type: "string"
  6539. },
  6540. merge_method: {
  6541. enum: ["merge", "squash", "rebase"],
  6542. type: "string"
  6543. },
  6544. number: {
  6545. alias: "pull_number",
  6546. deprecated: true,
  6547. type: "integer"
  6548. },
  6549. owner: {
  6550. required: true,
  6551. type: "string"
  6552. },
  6553. pull_number: {
  6554. required: true,
  6555. type: "integer"
  6556. },
  6557. repo: {
  6558. required: true,
  6559. type: "string"
  6560. },
  6561. sha: {
  6562. type: "string"
  6563. }
  6564. },
  6565. url: "/repos/:owner/:repo/pulls/:pull_number/merge"
  6566. },
  6567. submitReview: {
  6568. method: "POST",
  6569. params: {
  6570. body: {
  6571. type: "string"
  6572. },
  6573. event: {
  6574. enum: ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  6575. required: true,
  6576. type: "string"
  6577. },
  6578. number: {
  6579. alias: "pull_number",
  6580. deprecated: true,
  6581. type: "integer"
  6582. },
  6583. owner: {
  6584. required: true,
  6585. type: "string"
  6586. },
  6587. pull_number: {
  6588. required: true,
  6589. type: "integer"
  6590. },
  6591. repo: {
  6592. required: true,
  6593. type: "string"
  6594. },
  6595. review_id: {
  6596. required: true,
  6597. type: "integer"
  6598. }
  6599. },
  6600. url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"
  6601. },
  6602. update: {
  6603. method: "PATCH",
  6604. params: {
  6605. base: {
  6606. type: "string"
  6607. },
  6608. body: {
  6609. type: "string"
  6610. },
  6611. maintainer_can_modify: {
  6612. type: "boolean"
  6613. },
  6614. number: {
  6615. alias: "pull_number",
  6616. deprecated: true,
  6617. type: "integer"
  6618. },
  6619. owner: {
  6620. required: true,
  6621. type: "string"
  6622. },
  6623. pull_number: {
  6624. required: true,
  6625. type: "integer"
  6626. },
  6627. repo: {
  6628. required: true,
  6629. type: "string"
  6630. },
  6631. state: {
  6632. enum: ["open", "closed"],
  6633. type: "string"
  6634. },
  6635. title: {
  6636. type: "string"
  6637. }
  6638. },
  6639. url: "/repos/:owner/:repo/pulls/:pull_number"
  6640. },
  6641. updateBranch: {
  6642. headers: {
  6643. accept: "application/vnd.github.lydian-preview+json"
  6644. },
  6645. method: "PUT",
  6646. params: {
  6647. expected_head_sha: {
  6648. type: "string"
  6649. },
  6650. owner: {
  6651. required: true,
  6652. type: "string"
  6653. },
  6654. pull_number: {
  6655. required: true,
  6656. type: "integer"
  6657. },
  6658. repo: {
  6659. required: true,
  6660. type: "string"
  6661. }
  6662. },
  6663. url: "/repos/:owner/:repo/pulls/:pull_number/update-branch"
  6664. },
  6665. updateComment: {
  6666. method: "PATCH",
  6667. params: {
  6668. body: {
  6669. required: true,
  6670. type: "string"
  6671. },
  6672. comment_id: {
  6673. required: true,
  6674. type: "integer"
  6675. },
  6676. owner: {
  6677. required: true,
  6678. type: "string"
  6679. },
  6680. repo: {
  6681. required: true,
  6682. type: "string"
  6683. }
  6684. },
  6685. url: "/repos/:owner/:repo/pulls/comments/:comment_id"
  6686. },
  6687. updateReview: {
  6688. method: "PUT",
  6689. params: {
  6690. body: {
  6691. required: true,
  6692. type: "string"
  6693. },
  6694. number: {
  6695. alias: "pull_number",
  6696. deprecated: true,
  6697. type: "integer"
  6698. },
  6699. owner: {
  6700. required: true,
  6701. type: "string"
  6702. },
  6703. pull_number: {
  6704. required: true,
  6705. type: "integer"
  6706. },
  6707. repo: {
  6708. required: true,
  6709. type: "string"
  6710. },
  6711. review_id: {
  6712. required: true,
  6713. type: "integer"
  6714. }
  6715. },
  6716. url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  6717. }
  6718. },
  6719. rateLimit: {
  6720. get: {
  6721. method: "GET",
  6722. params: {},
  6723. url: "/rate_limit"
  6724. }
  6725. },
  6726. reactions: {
  6727. createForCommitComment: {
  6728. headers: {
  6729. accept: "application/vnd.github.squirrel-girl-preview+json"
  6730. },
  6731. method: "POST",
  6732. params: {
  6733. comment_id: {
  6734. required: true,
  6735. type: "integer"
  6736. },
  6737. content: {
  6738. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6739. required: true,
  6740. type: "string"
  6741. },
  6742. owner: {
  6743. required: true,
  6744. type: "string"
  6745. },
  6746. repo: {
  6747. required: true,
  6748. type: "string"
  6749. }
  6750. },
  6751. url: "/repos/:owner/:repo/comments/:comment_id/reactions"
  6752. },
  6753. createForIssue: {
  6754. headers: {
  6755. accept: "application/vnd.github.squirrel-girl-preview+json"
  6756. },
  6757. method: "POST",
  6758. params: {
  6759. content: {
  6760. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6761. required: true,
  6762. type: "string"
  6763. },
  6764. issue_number: {
  6765. required: true,
  6766. type: "integer"
  6767. },
  6768. number: {
  6769. alias: "issue_number",
  6770. deprecated: true,
  6771. type: "integer"
  6772. },
  6773. owner: {
  6774. required: true,
  6775. type: "string"
  6776. },
  6777. repo: {
  6778. required: true,
  6779. type: "string"
  6780. }
  6781. },
  6782. url: "/repos/:owner/:repo/issues/:issue_number/reactions"
  6783. },
  6784. createForIssueComment: {
  6785. headers: {
  6786. accept: "application/vnd.github.squirrel-girl-preview+json"
  6787. },
  6788. method: "POST",
  6789. params: {
  6790. comment_id: {
  6791. required: true,
  6792. type: "integer"
  6793. },
  6794. content: {
  6795. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6796. required: true,
  6797. type: "string"
  6798. },
  6799. owner: {
  6800. required: true,
  6801. type: "string"
  6802. },
  6803. repo: {
  6804. required: true,
  6805. type: "string"
  6806. }
  6807. },
  6808. url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
  6809. },
  6810. createForPullRequestReviewComment: {
  6811. headers: {
  6812. accept: "application/vnd.github.squirrel-girl-preview+json"
  6813. },
  6814. method: "POST",
  6815. params: {
  6816. comment_id: {
  6817. required: true,
  6818. type: "integer"
  6819. },
  6820. content: {
  6821. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6822. required: true,
  6823. type: "string"
  6824. },
  6825. owner: {
  6826. required: true,
  6827. type: "string"
  6828. },
  6829. repo: {
  6830. required: true,
  6831. type: "string"
  6832. }
  6833. },
  6834. url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
  6835. },
  6836. createForTeamDiscussion: {
  6837. deprecated: "octokit.reactions.createForTeamDiscussion() has been renamed to octokit.reactions.createForTeamDiscussionLegacy() (2020-01-16)",
  6838. headers: {
  6839. accept: "application/vnd.github.squirrel-girl-preview+json"
  6840. },
  6841. method: "POST",
  6842. params: {
  6843. content: {
  6844. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6845. required: true,
  6846. type: "string"
  6847. },
  6848. discussion_number: {
  6849. required: true,
  6850. type: "integer"
  6851. },
  6852. team_id: {
  6853. required: true,
  6854. type: "integer"
  6855. }
  6856. },
  6857. url: "/teams/:team_id/discussions/:discussion_number/reactions"
  6858. },
  6859. createForTeamDiscussionComment: {
  6860. deprecated: "octokit.reactions.createForTeamDiscussionComment() has been renamed to octokit.reactions.createForTeamDiscussionCommentLegacy() (2020-01-16)",
  6861. headers: {
  6862. accept: "application/vnd.github.squirrel-girl-preview+json"
  6863. },
  6864. method: "POST",
  6865. params: {
  6866. comment_number: {
  6867. required: true,
  6868. type: "integer"
  6869. },
  6870. content: {
  6871. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6872. required: true,
  6873. type: "string"
  6874. },
  6875. discussion_number: {
  6876. required: true,
  6877. type: "integer"
  6878. },
  6879. team_id: {
  6880. required: true,
  6881. type: "integer"
  6882. }
  6883. },
  6884. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  6885. },
  6886. createForTeamDiscussionCommentInOrg: {
  6887. headers: {
  6888. accept: "application/vnd.github.squirrel-girl-preview+json"
  6889. },
  6890. method: "POST",
  6891. params: {
  6892. comment_number: {
  6893. required: true,
  6894. type: "integer"
  6895. },
  6896. content: {
  6897. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6898. required: true,
  6899. type: "string"
  6900. },
  6901. discussion_number: {
  6902. required: true,
  6903. type: "integer"
  6904. },
  6905. org: {
  6906. required: true,
  6907. type: "string"
  6908. },
  6909. team_slug: {
  6910. required: true,
  6911. type: "string"
  6912. }
  6913. },
  6914. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"
  6915. },
  6916. createForTeamDiscussionCommentLegacy: {
  6917. deprecated: "octokit.reactions.createForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy",
  6918. headers: {
  6919. accept: "application/vnd.github.squirrel-girl-preview+json"
  6920. },
  6921. method: "POST",
  6922. params: {
  6923. comment_number: {
  6924. required: true,
  6925. type: "integer"
  6926. },
  6927. content: {
  6928. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6929. required: true,
  6930. type: "string"
  6931. },
  6932. discussion_number: {
  6933. required: true,
  6934. type: "integer"
  6935. },
  6936. team_id: {
  6937. required: true,
  6938. type: "integer"
  6939. }
  6940. },
  6941. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  6942. },
  6943. createForTeamDiscussionInOrg: {
  6944. headers: {
  6945. accept: "application/vnd.github.squirrel-girl-preview+json"
  6946. },
  6947. method: "POST",
  6948. params: {
  6949. content: {
  6950. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6951. required: true,
  6952. type: "string"
  6953. },
  6954. discussion_number: {
  6955. required: true,
  6956. type: "integer"
  6957. },
  6958. org: {
  6959. required: true,
  6960. type: "string"
  6961. },
  6962. team_slug: {
  6963. required: true,
  6964. type: "string"
  6965. }
  6966. },
  6967. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"
  6968. },
  6969. createForTeamDiscussionLegacy: {
  6970. deprecated: "octokit.reactions.createForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy",
  6971. headers: {
  6972. accept: "application/vnd.github.squirrel-girl-preview+json"
  6973. },
  6974. method: "POST",
  6975. params: {
  6976. content: {
  6977. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  6978. required: true,
  6979. type: "string"
  6980. },
  6981. discussion_number: {
  6982. required: true,
  6983. type: "integer"
  6984. },
  6985. team_id: {
  6986. required: true,
  6987. type: "integer"
  6988. }
  6989. },
  6990. url: "/teams/:team_id/discussions/:discussion_number/reactions"
  6991. },
  6992. delete: {
  6993. headers: {
  6994. accept: "application/vnd.github.squirrel-girl-preview+json"
  6995. },
  6996. method: "DELETE",
  6997. params: {
  6998. reaction_id: {
  6999. required: true,
  7000. type: "integer"
  7001. }
  7002. },
  7003. url: "/reactions/:reaction_id"
  7004. },
  7005. listForCommitComment: {
  7006. headers: {
  7007. accept: "application/vnd.github.squirrel-girl-preview+json"
  7008. },
  7009. method: "GET",
  7010. params: {
  7011. comment_id: {
  7012. required: true,
  7013. type: "integer"
  7014. },
  7015. content: {
  7016. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7017. type: "string"
  7018. },
  7019. owner: {
  7020. required: true,
  7021. type: "string"
  7022. },
  7023. page: {
  7024. type: "integer"
  7025. },
  7026. per_page: {
  7027. type: "integer"
  7028. },
  7029. repo: {
  7030. required: true,
  7031. type: "string"
  7032. }
  7033. },
  7034. url: "/repos/:owner/:repo/comments/:comment_id/reactions"
  7035. },
  7036. listForIssue: {
  7037. headers: {
  7038. accept: "application/vnd.github.squirrel-girl-preview+json"
  7039. },
  7040. method: "GET",
  7041. params: {
  7042. content: {
  7043. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7044. type: "string"
  7045. },
  7046. issue_number: {
  7047. required: true,
  7048. type: "integer"
  7049. },
  7050. number: {
  7051. alias: "issue_number",
  7052. deprecated: true,
  7053. type: "integer"
  7054. },
  7055. owner: {
  7056. required: true,
  7057. type: "string"
  7058. },
  7059. page: {
  7060. type: "integer"
  7061. },
  7062. per_page: {
  7063. type: "integer"
  7064. },
  7065. repo: {
  7066. required: true,
  7067. type: "string"
  7068. }
  7069. },
  7070. url: "/repos/:owner/:repo/issues/:issue_number/reactions"
  7071. },
  7072. listForIssueComment: {
  7073. headers: {
  7074. accept: "application/vnd.github.squirrel-girl-preview+json"
  7075. },
  7076. method: "GET",
  7077. params: {
  7078. comment_id: {
  7079. required: true,
  7080. type: "integer"
  7081. },
  7082. content: {
  7083. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7084. type: "string"
  7085. },
  7086. owner: {
  7087. required: true,
  7088. type: "string"
  7089. },
  7090. page: {
  7091. type: "integer"
  7092. },
  7093. per_page: {
  7094. type: "integer"
  7095. },
  7096. repo: {
  7097. required: true,
  7098. type: "string"
  7099. }
  7100. },
  7101. url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
  7102. },
  7103. listForPullRequestReviewComment: {
  7104. headers: {
  7105. accept: "application/vnd.github.squirrel-girl-preview+json"
  7106. },
  7107. method: "GET",
  7108. params: {
  7109. comment_id: {
  7110. required: true,
  7111. type: "integer"
  7112. },
  7113. content: {
  7114. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7115. type: "string"
  7116. },
  7117. owner: {
  7118. required: true,
  7119. type: "string"
  7120. },
  7121. page: {
  7122. type: "integer"
  7123. },
  7124. per_page: {
  7125. type: "integer"
  7126. },
  7127. repo: {
  7128. required: true,
  7129. type: "string"
  7130. }
  7131. },
  7132. url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
  7133. },
  7134. listForTeamDiscussion: {
  7135. deprecated: "octokit.reactions.listForTeamDiscussion() has been renamed to octokit.reactions.listForTeamDiscussionLegacy() (2020-01-16)",
  7136. headers: {
  7137. accept: "application/vnd.github.squirrel-girl-preview+json"
  7138. },
  7139. method: "GET",
  7140. params: {
  7141. content: {
  7142. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7143. type: "string"
  7144. },
  7145. discussion_number: {
  7146. required: true,
  7147. type: "integer"
  7148. },
  7149. page: {
  7150. type: "integer"
  7151. },
  7152. per_page: {
  7153. type: "integer"
  7154. },
  7155. team_id: {
  7156. required: true,
  7157. type: "integer"
  7158. }
  7159. },
  7160. url: "/teams/:team_id/discussions/:discussion_number/reactions"
  7161. },
  7162. listForTeamDiscussionComment: {
  7163. deprecated: "octokit.reactions.listForTeamDiscussionComment() has been renamed to octokit.reactions.listForTeamDiscussionCommentLegacy() (2020-01-16)",
  7164. headers: {
  7165. accept: "application/vnd.github.squirrel-girl-preview+json"
  7166. },
  7167. method: "GET",
  7168. params: {
  7169. comment_number: {
  7170. required: true,
  7171. type: "integer"
  7172. },
  7173. content: {
  7174. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7175. type: "string"
  7176. },
  7177. discussion_number: {
  7178. required: true,
  7179. type: "integer"
  7180. },
  7181. page: {
  7182. type: "integer"
  7183. },
  7184. per_page: {
  7185. type: "integer"
  7186. },
  7187. team_id: {
  7188. required: true,
  7189. type: "integer"
  7190. }
  7191. },
  7192. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  7193. },
  7194. listForTeamDiscussionCommentInOrg: {
  7195. headers: {
  7196. accept: "application/vnd.github.squirrel-girl-preview+json"
  7197. },
  7198. method: "GET",
  7199. params: {
  7200. comment_number: {
  7201. required: true,
  7202. type: "integer"
  7203. },
  7204. content: {
  7205. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7206. type: "string"
  7207. },
  7208. discussion_number: {
  7209. required: true,
  7210. type: "integer"
  7211. },
  7212. org: {
  7213. required: true,
  7214. type: "string"
  7215. },
  7216. page: {
  7217. type: "integer"
  7218. },
  7219. per_page: {
  7220. type: "integer"
  7221. },
  7222. team_slug: {
  7223. required: true,
  7224. type: "string"
  7225. }
  7226. },
  7227. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"
  7228. },
  7229. listForTeamDiscussionCommentLegacy: {
  7230. deprecated: "octokit.reactions.listForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy",
  7231. headers: {
  7232. accept: "application/vnd.github.squirrel-girl-preview+json"
  7233. },
  7234. method: "GET",
  7235. params: {
  7236. comment_number: {
  7237. required: true,
  7238. type: "integer"
  7239. },
  7240. content: {
  7241. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7242. type: "string"
  7243. },
  7244. discussion_number: {
  7245. required: true,
  7246. type: "integer"
  7247. },
  7248. page: {
  7249. type: "integer"
  7250. },
  7251. per_page: {
  7252. type: "integer"
  7253. },
  7254. team_id: {
  7255. required: true,
  7256. type: "integer"
  7257. }
  7258. },
  7259. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  7260. },
  7261. listForTeamDiscussionInOrg: {
  7262. headers: {
  7263. accept: "application/vnd.github.squirrel-girl-preview+json"
  7264. },
  7265. method: "GET",
  7266. params: {
  7267. content: {
  7268. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7269. type: "string"
  7270. },
  7271. discussion_number: {
  7272. required: true,
  7273. type: "integer"
  7274. },
  7275. org: {
  7276. required: true,
  7277. type: "string"
  7278. },
  7279. page: {
  7280. type: "integer"
  7281. },
  7282. per_page: {
  7283. type: "integer"
  7284. },
  7285. team_slug: {
  7286. required: true,
  7287. type: "string"
  7288. }
  7289. },
  7290. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"
  7291. },
  7292. listForTeamDiscussionLegacy: {
  7293. deprecated: "octokit.reactions.listForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy",
  7294. headers: {
  7295. accept: "application/vnd.github.squirrel-girl-preview+json"
  7296. },
  7297. method: "GET",
  7298. params: {
  7299. content: {
  7300. enum: ["+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", "eyes"],
  7301. type: "string"
  7302. },
  7303. discussion_number: {
  7304. required: true,
  7305. type: "integer"
  7306. },
  7307. page: {
  7308. type: "integer"
  7309. },
  7310. per_page: {
  7311. type: "integer"
  7312. },
  7313. team_id: {
  7314. required: true,
  7315. type: "integer"
  7316. }
  7317. },
  7318. url: "/teams/:team_id/discussions/:discussion_number/reactions"
  7319. }
  7320. },
  7321. repos: {
  7322. acceptInvitation: {
  7323. method: "PATCH",
  7324. params: {
  7325. invitation_id: {
  7326. required: true,
  7327. type: "integer"
  7328. }
  7329. },
  7330. url: "/user/repository_invitations/:invitation_id"
  7331. },
  7332. addCollaborator: {
  7333. method: "PUT",
  7334. params: {
  7335. owner: {
  7336. required: true,
  7337. type: "string"
  7338. },
  7339. permission: {
  7340. enum: ["pull", "push", "admin"],
  7341. type: "string"
  7342. },
  7343. repo: {
  7344. required: true,
  7345. type: "string"
  7346. },
  7347. username: {
  7348. required: true,
  7349. type: "string"
  7350. }
  7351. },
  7352. url: "/repos/:owner/:repo/collaborators/:username"
  7353. },
  7354. addDeployKey: {
  7355. method: "POST",
  7356. params: {
  7357. key: {
  7358. required: true,
  7359. type: "string"
  7360. },
  7361. owner: {
  7362. required: true,
  7363. type: "string"
  7364. },
  7365. read_only: {
  7366. type: "boolean"
  7367. },
  7368. repo: {
  7369. required: true,
  7370. type: "string"
  7371. },
  7372. title: {
  7373. type: "string"
  7374. }
  7375. },
  7376. url: "/repos/:owner/:repo/keys"
  7377. },
  7378. addProtectedBranchAdminEnforcement: {
  7379. method: "POST",
  7380. params: {
  7381. branch: {
  7382. required: true,
  7383. type: "string"
  7384. },
  7385. owner: {
  7386. required: true,
  7387. type: "string"
  7388. },
  7389. repo: {
  7390. required: true,
  7391. type: "string"
  7392. }
  7393. },
  7394. url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  7395. },
  7396. addProtectedBranchAppRestrictions: {
  7397. method: "POST",
  7398. params: {
  7399. apps: {
  7400. mapTo: "data",
  7401. required: true,
  7402. type: "string[]"
  7403. },
  7404. branch: {
  7405. required: true,
  7406. type: "string"
  7407. },
  7408. owner: {
  7409. required: true,
  7410. type: "string"
  7411. },
  7412. repo: {
  7413. required: true,
  7414. type: "string"
  7415. }
  7416. },
  7417. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  7418. },
  7419. addProtectedBranchRequiredSignatures: {
  7420. headers: {
  7421. accept: "application/vnd.github.zzzax-preview+json"
  7422. },
  7423. method: "POST",
  7424. params: {
  7425. branch: {
  7426. required: true,
  7427. type: "string"
  7428. },
  7429. owner: {
  7430. required: true,
  7431. type: "string"
  7432. },
  7433. repo: {
  7434. required: true,
  7435. type: "string"
  7436. }
  7437. },
  7438. url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  7439. },
  7440. addProtectedBranchRequiredStatusChecksContexts: {
  7441. method: "POST",
  7442. params: {
  7443. branch: {
  7444. required: true,
  7445. type: "string"
  7446. },
  7447. contexts: {
  7448. mapTo: "data",
  7449. required: true,
  7450. type: "string[]"
  7451. },
  7452. owner: {
  7453. required: true,
  7454. type: "string"
  7455. },
  7456. repo: {
  7457. required: true,
  7458. type: "string"
  7459. }
  7460. },
  7461. url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  7462. },
  7463. addProtectedBranchTeamRestrictions: {
  7464. method: "POST",
  7465. params: {
  7466. branch: {
  7467. required: true,
  7468. type: "string"
  7469. },
  7470. owner: {
  7471. required: true,
  7472. type: "string"
  7473. },
  7474. repo: {
  7475. required: true,
  7476. type: "string"
  7477. },
  7478. teams: {
  7479. mapTo: "data",
  7480. required: true,
  7481. type: "string[]"
  7482. }
  7483. },
  7484. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  7485. },
  7486. addProtectedBranchUserRestrictions: {
  7487. method: "POST",
  7488. params: {
  7489. branch: {
  7490. required: true,
  7491. type: "string"
  7492. },
  7493. owner: {
  7494. required: true,
  7495. type: "string"
  7496. },
  7497. repo: {
  7498. required: true,
  7499. type: "string"
  7500. },
  7501. users: {
  7502. mapTo: "data",
  7503. required: true,
  7504. type: "string[]"
  7505. }
  7506. },
  7507. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  7508. },
  7509. checkCollaborator: {
  7510. method: "GET",
  7511. params: {
  7512. owner: {
  7513. required: true,
  7514. type: "string"
  7515. },
  7516. repo: {
  7517. required: true,
  7518. type: "string"
  7519. },
  7520. username: {
  7521. required: true,
  7522. type: "string"
  7523. }
  7524. },
  7525. url: "/repos/:owner/:repo/collaborators/:username"
  7526. },
  7527. checkVulnerabilityAlerts: {
  7528. headers: {
  7529. accept: "application/vnd.github.dorian-preview+json"
  7530. },
  7531. method: "GET",
  7532. params: {
  7533. owner: {
  7534. required: true,
  7535. type: "string"
  7536. },
  7537. repo: {
  7538. required: true,
  7539. type: "string"
  7540. }
  7541. },
  7542. url: "/repos/:owner/:repo/vulnerability-alerts"
  7543. },
  7544. compareCommits: {
  7545. method: "GET",
  7546. params: {
  7547. base: {
  7548. required: true,
  7549. type: "string"
  7550. },
  7551. head: {
  7552. required: true,
  7553. type: "string"
  7554. },
  7555. owner: {
  7556. required: true,
  7557. type: "string"
  7558. },
  7559. repo: {
  7560. required: true,
  7561. type: "string"
  7562. }
  7563. },
  7564. url: "/repos/:owner/:repo/compare/:base...:head"
  7565. },
  7566. createCommitComment: {
  7567. method: "POST",
  7568. params: {
  7569. body: {
  7570. required: true,
  7571. type: "string"
  7572. },
  7573. commit_sha: {
  7574. required: true,
  7575. type: "string"
  7576. },
  7577. line: {
  7578. type: "integer"
  7579. },
  7580. owner: {
  7581. required: true,
  7582. type: "string"
  7583. },
  7584. path: {
  7585. type: "string"
  7586. },
  7587. position: {
  7588. type: "integer"
  7589. },
  7590. repo: {
  7591. required: true,
  7592. type: "string"
  7593. },
  7594. sha: {
  7595. alias: "commit_sha",
  7596. deprecated: true,
  7597. type: "string"
  7598. }
  7599. },
  7600. url: "/repos/:owner/:repo/commits/:commit_sha/comments"
  7601. },
  7602. createDeployment: {
  7603. method: "POST",
  7604. params: {
  7605. auto_merge: {
  7606. type: "boolean"
  7607. },
  7608. description: {
  7609. type: "string"
  7610. },
  7611. environment: {
  7612. type: "string"
  7613. },
  7614. owner: {
  7615. required: true,
  7616. type: "string"
  7617. },
  7618. payload: {
  7619. type: "string"
  7620. },
  7621. production_environment: {
  7622. type: "boolean"
  7623. },
  7624. ref: {
  7625. required: true,
  7626. type: "string"
  7627. },
  7628. repo: {
  7629. required: true,
  7630. type: "string"
  7631. },
  7632. required_contexts: {
  7633. type: "string[]"
  7634. },
  7635. task: {
  7636. type: "string"
  7637. },
  7638. transient_environment: {
  7639. type: "boolean"
  7640. }
  7641. },
  7642. url: "/repos/:owner/:repo/deployments"
  7643. },
  7644. createDeploymentStatus: {
  7645. method: "POST",
  7646. params: {
  7647. auto_inactive: {
  7648. type: "boolean"
  7649. },
  7650. deployment_id: {
  7651. required: true,
  7652. type: "integer"
  7653. },
  7654. description: {
  7655. type: "string"
  7656. },
  7657. environment: {
  7658. enum: ["production", "staging", "qa"],
  7659. type: "string"
  7660. },
  7661. environment_url: {
  7662. type: "string"
  7663. },
  7664. log_url: {
  7665. type: "string"
  7666. },
  7667. owner: {
  7668. required: true,
  7669. type: "string"
  7670. },
  7671. repo: {
  7672. required: true,
  7673. type: "string"
  7674. },
  7675. state: {
  7676. enum: ["error", "failure", "inactive", "in_progress", "queued", "pending", "success"],
  7677. required: true,
  7678. type: "string"
  7679. },
  7680. target_url: {
  7681. type: "string"
  7682. }
  7683. },
  7684. url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"
  7685. },
  7686. createDispatchEvent: {
  7687. method: "POST",
  7688. params: {
  7689. client_payload: {
  7690. type: "object"
  7691. },
  7692. event_type: {
  7693. type: "string"
  7694. },
  7695. owner: {
  7696. required: true,
  7697. type: "string"
  7698. },
  7699. repo: {
  7700. required: true,
  7701. type: "string"
  7702. }
  7703. },
  7704. url: "/repos/:owner/:repo/dispatches"
  7705. },
  7706. createFile: {
  7707. deprecated: "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
  7708. method: "PUT",
  7709. params: {
  7710. author: {
  7711. type: "object"
  7712. },
  7713. "author.email": {
  7714. required: true,
  7715. type: "string"
  7716. },
  7717. "author.name": {
  7718. required: true,
  7719. type: "string"
  7720. },
  7721. branch: {
  7722. type: "string"
  7723. },
  7724. committer: {
  7725. type: "object"
  7726. },
  7727. "committer.email": {
  7728. required: true,
  7729. type: "string"
  7730. },
  7731. "committer.name": {
  7732. required: true,
  7733. type: "string"
  7734. },
  7735. content: {
  7736. required: true,
  7737. type: "string"
  7738. },
  7739. message: {
  7740. required: true,
  7741. type: "string"
  7742. },
  7743. owner: {
  7744. required: true,
  7745. type: "string"
  7746. },
  7747. path: {
  7748. required: true,
  7749. type: "string"
  7750. },
  7751. repo: {
  7752. required: true,
  7753. type: "string"
  7754. },
  7755. sha: {
  7756. type: "string"
  7757. }
  7758. },
  7759. url: "/repos/:owner/:repo/contents/:path"
  7760. },
  7761. createForAuthenticatedUser: {
  7762. method: "POST",
  7763. params: {
  7764. allow_merge_commit: {
  7765. type: "boolean"
  7766. },
  7767. allow_rebase_merge: {
  7768. type: "boolean"
  7769. },
  7770. allow_squash_merge: {
  7771. type: "boolean"
  7772. },
  7773. auto_init: {
  7774. type: "boolean"
  7775. },
  7776. delete_branch_on_merge: {
  7777. type: "boolean"
  7778. },
  7779. description: {
  7780. type: "string"
  7781. },
  7782. gitignore_template: {
  7783. type: "string"
  7784. },
  7785. has_issues: {
  7786. type: "boolean"
  7787. },
  7788. has_projects: {
  7789. type: "boolean"
  7790. },
  7791. has_wiki: {
  7792. type: "boolean"
  7793. },
  7794. homepage: {
  7795. type: "string"
  7796. },
  7797. is_template: {
  7798. type: "boolean"
  7799. },
  7800. license_template: {
  7801. type: "string"
  7802. },
  7803. name: {
  7804. required: true,
  7805. type: "string"
  7806. },
  7807. private: {
  7808. type: "boolean"
  7809. },
  7810. team_id: {
  7811. type: "integer"
  7812. },
  7813. visibility: {
  7814. enum: ["public", "private", "visibility", "internal"],
  7815. type: "string"
  7816. }
  7817. },
  7818. url: "/user/repos"
  7819. },
  7820. createFork: {
  7821. method: "POST",
  7822. params: {
  7823. organization: {
  7824. type: "string"
  7825. },
  7826. owner: {
  7827. required: true,
  7828. type: "string"
  7829. },
  7830. repo: {
  7831. required: true,
  7832. type: "string"
  7833. }
  7834. },
  7835. url: "/repos/:owner/:repo/forks"
  7836. },
  7837. createHook: {
  7838. method: "POST",
  7839. params: {
  7840. active: {
  7841. type: "boolean"
  7842. },
  7843. config: {
  7844. required: true,
  7845. type: "object"
  7846. },
  7847. "config.content_type": {
  7848. type: "string"
  7849. },
  7850. "config.insecure_ssl": {
  7851. type: "string"
  7852. },
  7853. "config.secret": {
  7854. type: "string"
  7855. },
  7856. "config.url": {
  7857. required: true,
  7858. type: "string"
  7859. },
  7860. events: {
  7861. type: "string[]"
  7862. },
  7863. name: {
  7864. type: "string"
  7865. },
  7866. owner: {
  7867. required: true,
  7868. type: "string"
  7869. },
  7870. repo: {
  7871. required: true,
  7872. type: "string"
  7873. }
  7874. },
  7875. url: "/repos/:owner/:repo/hooks"
  7876. },
  7877. createInOrg: {
  7878. method: "POST",
  7879. params: {
  7880. allow_merge_commit: {
  7881. type: "boolean"
  7882. },
  7883. allow_rebase_merge: {
  7884. type: "boolean"
  7885. },
  7886. allow_squash_merge: {
  7887. type: "boolean"
  7888. },
  7889. auto_init: {
  7890. type: "boolean"
  7891. },
  7892. delete_branch_on_merge: {
  7893. type: "boolean"
  7894. },
  7895. description: {
  7896. type: "string"
  7897. },
  7898. gitignore_template: {
  7899. type: "string"
  7900. },
  7901. has_issues: {
  7902. type: "boolean"
  7903. },
  7904. has_projects: {
  7905. type: "boolean"
  7906. },
  7907. has_wiki: {
  7908. type: "boolean"
  7909. },
  7910. homepage: {
  7911. type: "string"
  7912. },
  7913. is_template: {
  7914. type: "boolean"
  7915. },
  7916. license_template: {
  7917. type: "string"
  7918. },
  7919. name: {
  7920. required: true,
  7921. type: "string"
  7922. },
  7923. org: {
  7924. required: true,
  7925. type: "string"
  7926. },
  7927. private: {
  7928. type: "boolean"
  7929. },
  7930. team_id: {
  7931. type: "integer"
  7932. },
  7933. visibility: {
  7934. enum: ["public", "private", "visibility", "internal"],
  7935. type: "string"
  7936. }
  7937. },
  7938. url: "/orgs/:org/repos"
  7939. },
  7940. createOrUpdateFile: {
  7941. method: "PUT",
  7942. params: {
  7943. author: {
  7944. type: "object"
  7945. },
  7946. "author.email": {
  7947. required: true,
  7948. type: "string"
  7949. },
  7950. "author.name": {
  7951. required: true,
  7952. type: "string"
  7953. },
  7954. branch: {
  7955. type: "string"
  7956. },
  7957. committer: {
  7958. type: "object"
  7959. },
  7960. "committer.email": {
  7961. required: true,
  7962. type: "string"
  7963. },
  7964. "committer.name": {
  7965. required: true,
  7966. type: "string"
  7967. },
  7968. content: {
  7969. required: true,
  7970. type: "string"
  7971. },
  7972. message: {
  7973. required: true,
  7974. type: "string"
  7975. },
  7976. owner: {
  7977. required: true,
  7978. type: "string"
  7979. },
  7980. path: {
  7981. required: true,
  7982. type: "string"
  7983. },
  7984. repo: {
  7985. required: true,
  7986. type: "string"
  7987. },
  7988. sha: {
  7989. type: "string"
  7990. }
  7991. },
  7992. url: "/repos/:owner/:repo/contents/:path"
  7993. },
  7994. createRelease: {
  7995. method: "POST",
  7996. params: {
  7997. body: {
  7998. type: "string"
  7999. },
  8000. draft: {
  8001. type: "boolean"
  8002. },
  8003. name: {
  8004. type: "string"
  8005. },
  8006. owner: {
  8007. required: true,
  8008. type: "string"
  8009. },
  8010. prerelease: {
  8011. type: "boolean"
  8012. },
  8013. repo: {
  8014. required: true,
  8015. type: "string"
  8016. },
  8017. tag_name: {
  8018. required: true,
  8019. type: "string"
  8020. },
  8021. target_commitish: {
  8022. type: "string"
  8023. }
  8024. },
  8025. url: "/repos/:owner/:repo/releases"
  8026. },
  8027. createStatus: {
  8028. method: "POST",
  8029. params: {
  8030. context: {
  8031. type: "string"
  8032. },
  8033. description: {
  8034. type: "string"
  8035. },
  8036. owner: {
  8037. required: true,
  8038. type: "string"
  8039. },
  8040. repo: {
  8041. required: true,
  8042. type: "string"
  8043. },
  8044. sha: {
  8045. required: true,
  8046. type: "string"
  8047. },
  8048. state: {
  8049. enum: ["error", "failure", "pending", "success"],
  8050. required: true,
  8051. type: "string"
  8052. },
  8053. target_url: {
  8054. type: "string"
  8055. }
  8056. },
  8057. url: "/repos/:owner/:repo/statuses/:sha"
  8058. },
  8059. createUsingTemplate: {
  8060. headers: {
  8061. accept: "application/vnd.github.baptiste-preview+json"
  8062. },
  8063. method: "POST",
  8064. params: {
  8065. description: {
  8066. type: "string"
  8067. },
  8068. name: {
  8069. required: true,
  8070. type: "string"
  8071. },
  8072. owner: {
  8073. type: "string"
  8074. },
  8075. private: {
  8076. type: "boolean"
  8077. },
  8078. template_owner: {
  8079. required: true,
  8080. type: "string"
  8081. },
  8082. template_repo: {
  8083. required: true,
  8084. type: "string"
  8085. }
  8086. },
  8087. url: "/repos/:template_owner/:template_repo/generate"
  8088. },
  8089. declineInvitation: {
  8090. method: "DELETE",
  8091. params: {
  8092. invitation_id: {
  8093. required: true,
  8094. type: "integer"
  8095. }
  8096. },
  8097. url: "/user/repository_invitations/:invitation_id"
  8098. },
  8099. delete: {
  8100. method: "DELETE",
  8101. params: {
  8102. owner: {
  8103. required: true,
  8104. type: "string"
  8105. },
  8106. repo: {
  8107. required: true,
  8108. type: "string"
  8109. }
  8110. },
  8111. url: "/repos/:owner/:repo"
  8112. },
  8113. deleteCommitComment: {
  8114. method: "DELETE",
  8115. params: {
  8116. comment_id: {
  8117. required: true,
  8118. type: "integer"
  8119. },
  8120. owner: {
  8121. required: true,
  8122. type: "string"
  8123. },
  8124. repo: {
  8125. required: true,
  8126. type: "string"
  8127. }
  8128. },
  8129. url: "/repos/:owner/:repo/comments/:comment_id"
  8130. },
  8131. deleteDownload: {
  8132. method: "DELETE",
  8133. params: {
  8134. download_id: {
  8135. required: true,
  8136. type: "integer"
  8137. },
  8138. owner: {
  8139. required: true,
  8140. type: "string"
  8141. },
  8142. repo: {
  8143. required: true,
  8144. type: "string"
  8145. }
  8146. },
  8147. url: "/repos/:owner/:repo/downloads/:download_id"
  8148. },
  8149. deleteFile: {
  8150. method: "DELETE",
  8151. params: {
  8152. author: {
  8153. type: "object"
  8154. },
  8155. "author.email": {
  8156. type: "string"
  8157. },
  8158. "author.name": {
  8159. type: "string"
  8160. },
  8161. branch: {
  8162. type: "string"
  8163. },
  8164. committer: {
  8165. type: "object"
  8166. },
  8167. "committer.email": {
  8168. type: "string"
  8169. },
  8170. "committer.name": {
  8171. type: "string"
  8172. },
  8173. message: {
  8174. required: true,
  8175. type: "string"
  8176. },
  8177. owner: {
  8178. required: true,
  8179. type: "string"
  8180. },
  8181. path: {
  8182. required: true,
  8183. type: "string"
  8184. },
  8185. repo: {
  8186. required: true,
  8187. type: "string"
  8188. },
  8189. sha: {
  8190. required: true,
  8191. type: "string"
  8192. }
  8193. },
  8194. url: "/repos/:owner/:repo/contents/:path"
  8195. },
  8196. deleteHook: {
  8197. method: "DELETE",
  8198. params: {
  8199. hook_id: {
  8200. required: true,
  8201. type: "integer"
  8202. },
  8203. owner: {
  8204. required: true,
  8205. type: "string"
  8206. },
  8207. repo: {
  8208. required: true,
  8209. type: "string"
  8210. }
  8211. },
  8212. url: "/repos/:owner/:repo/hooks/:hook_id"
  8213. },
  8214. deleteInvitation: {
  8215. method: "DELETE",
  8216. params: {
  8217. invitation_id: {
  8218. required: true,
  8219. type: "integer"
  8220. },
  8221. owner: {
  8222. required: true,
  8223. type: "string"
  8224. },
  8225. repo: {
  8226. required: true,
  8227. type: "string"
  8228. }
  8229. },
  8230. url: "/repos/:owner/:repo/invitations/:invitation_id"
  8231. },
  8232. deleteRelease: {
  8233. method: "DELETE",
  8234. params: {
  8235. owner: {
  8236. required: true,
  8237. type: "string"
  8238. },
  8239. release_id: {
  8240. required: true,
  8241. type: "integer"
  8242. },
  8243. repo: {
  8244. required: true,
  8245. type: "string"
  8246. }
  8247. },
  8248. url: "/repos/:owner/:repo/releases/:release_id"
  8249. },
  8250. deleteReleaseAsset: {
  8251. method: "DELETE",
  8252. params: {
  8253. asset_id: {
  8254. required: true,
  8255. type: "integer"
  8256. },
  8257. owner: {
  8258. required: true,
  8259. type: "string"
  8260. },
  8261. repo: {
  8262. required: true,
  8263. type: "string"
  8264. }
  8265. },
  8266. url: "/repos/:owner/:repo/releases/assets/:asset_id"
  8267. },
  8268. disableAutomatedSecurityFixes: {
  8269. headers: {
  8270. accept: "application/vnd.github.london-preview+json"
  8271. },
  8272. method: "DELETE",
  8273. params: {
  8274. owner: {
  8275. required: true,
  8276. type: "string"
  8277. },
  8278. repo: {
  8279. required: true,
  8280. type: "string"
  8281. }
  8282. },
  8283. url: "/repos/:owner/:repo/automated-security-fixes"
  8284. },
  8285. disablePagesSite: {
  8286. headers: {
  8287. accept: "application/vnd.github.switcheroo-preview+json"
  8288. },
  8289. method: "DELETE",
  8290. params: {
  8291. owner: {
  8292. required: true,
  8293. type: "string"
  8294. },
  8295. repo: {
  8296. required: true,
  8297. type: "string"
  8298. }
  8299. },
  8300. url: "/repos/:owner/:repo/pages"
  8301. },
  8302. disableVulnerabilityAlerts: {
  8303. headers: {
  8304. accept: "application/vnd.github.dorian-preview+json"
  8305. },
  8306. method: "DELETE",
  8307. params: {
  8308. owner: {
  8309. required: true,
  8310. type: "string"
  8311. },
  8312. repo: {
  8313. required: true,
  8314. type: "string"
  8315. }
  8316. },
  8317. url: "/repos/:owner/:repo/vulnerability-alerts"
  8318. },
  8319. enableAutomatedSecurityFixes: {
  8320. headers: {
  8321. accept: "application/vnd.github.london-preview+json"
  8322. },
  8323. method: "PUT",
  8324. params: {
  8325. owner: {
  8326. required: true,
  8327. type: "string"
  8328. },
  8329. repo: {
  8330. required: true,
  8331. type: "string"
  8332. }
  8333. },
  8334. url: "/repos/:owner/:repo/automated-security-fixes"
  8335. },
  8336. enablePagesSite: {
  8337. headers: {
  8338. accept: "application/vnd.github.switcheroo-preview+json"
  8339. },
  8340. method: "POST",
  8341. params: {
  8342. owner: {
  8343. required: true,
  8344. type: "string"
  8345. },
  8346. repo: {
  8347. required: true,
  8348. type: "string"
  8349. },
  8350. source: {
  8351. type: "object"
  8352. },
  8353. "source.branch": {
  8354. enum: ["master", "gh-pages"],
  8355. type: "string"
  8356. },
  8357. "source.path": {
  8358. type: "string"
  8359. }
  8360. },
  8361. url: "/repos/:owner/:repo/pages"
  8362. },
  8363. enableVulnerabilityAlerts: {
  8364. headers: {
  8365. accept: "application/vnd.github.dorian-preview+json"
  8366. },
  8367. method: "PUT",
  8368. params: {
  8369. owner: {
  8370. required: true,
  8371. type: "string"
  8372. },
  8373. repo: {
  8374. required: true,
  8375. type: "string"
  8376. }
  8377. },
  8378. url: "/repos/:owner/:repo/vulnerability-alerts"
  8379. },
  8380. get: {
  8381. method: "GET",
  8382. params: {
  8383. owner: {
  8384. required: true,
  8385. type: "string"
  8386. },
  8387. repo: {
  8388. required: true,
  8389. type: "string"
  8390. }
  8391. },
  8392. url: "/repos/:owner/:repo"
  8393. },
  8394. getAppsWithAccessToProtectedBranch: {
  8395. method: "GET",
  8396. params: {
  8397. branch: {
  8398. required: true,
  8399. type: "string"
  8400. },
  8401. owner: {
  8402. required: true,
  8403. type: "string"
  8404. },
  8405. repo: {
  8406. required: true,
  8407. type: "string"
  8408. }
  8409. },
  8410. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  8411. },
  8412. getArchiveLink: {
  8413. method: "GET",
  8414. params: {
  8415. archive_format: {
  8416. required: true,
  8417. type: "string"
  8418. },
  8419. owner: {
  8420. required: true,
  8421. type: "string"
  8422. },
  8423. ref: {
  8424. required: true,
  8425. type: "string"
  8426. },
  8427. repo: {
  8428. required: true,
  8429. type: "string"
  8430. }
  8431. },
  8432. url: "/repos/:owner/:repo/:archive_format/:ref"
  8433. },
  8434. getBranch: {
  8435. method: "GET",
  8436. params: {
  8437. branch: {
  8438. required: true,
  8439. type: "string"
  8440. },
  8441. owner: {
  8442. required: true,
  8443. type: "string"
  8444. },
  8445. repo: {
  8446. required: true,
  8447. type: "string"
  8448. }
  8449. },
  8450. url: "/repos/:owner/:repo/branches/:branch"
  8451. },
  8452. getBranchProtection: {
  8453. method: "GET",
  8454. params: {
  8455. branch: {
  8456. required: true,
  8457. type: "string"
  8458. },
  8459. owner: {
  8460. required: true,
  8461. type: "string"
  8462. },
  8463. repo: {
  8464. required: true,
  8465. type: "string"
  8466. }
  8467. },
  8468. url: "/repos/:owner/:repo/branches/:branch/protection"
  8469. },
  8470. getClones: {
  8471. method: "GET",
  8472. params: {
  8473. owner: {
  8474. required: true,
  8475. type: "string"
  8476. },
  8477. per: {
  8478. enum: ["day", "week"],
  8479. type: "string"
  8480. },
  8481. repo: {
  8482. required: true,
  8483. type: "string"
  8484. }
  8485. },
  8486. url: "/repos/:owner/:repo/traffic/clones"
  8487. },
  8488. getCodeFrequencyStats: {
  8489. method: "GET",
  8490. params: {
  8491. owner: {
  8492. required: true,
  8493. type: "string"
  8494. },
  8495. repo: {
  8496. required: true,
  8497. type: "string"
  8498. }
  8499. },
  8500. url: "/repos/:owner/:repo/stats/code_frequency"
  8501. },
  8502. getCollaboratorPermissionLevel: {
  8503. method: "GET",
  8504. params: {
  8505. owner: {
  8506. required: true,
  8507. type: "string"
  8508. },
  8509. repo: {
  8510. required: true,
  8511. type: "string"
  8512. },
  8513. username: {
  8514. required: true,
  8515. type: "string"
  8516. }
  8517. },
  8518. url: "/repos/:owner/:repo/collaborators/:username/permission"
  8519. },
  8520. getCombinedStatusForRef: {
  8521. method: "GET",
  8522. params: {
  8523. owner: {
  8524. required: true,
  8525. type: "string"
  8526. },
  8527. ref: {
  8528. required: true,
  8529. type: "string"
  8530. },
  8531. repo: {
  8532. required: true,
  8533. type: "string"
  8534. }
  8535. },
  8536. url: "/repos/:owner/:repo/commits/:ref/status"
  8537. },
  8538. getCommit: {
  8539. method: "GET",
  8540. params: {
  8541. commit_sha: {
  8542. alias: "ref",
  8543. deprecated: true,
  8544. type: "string"
  8545. },
  8546. owner: {
  8547. required: true,
  8548. type: "string"
  8549. },
  8550. ref: {
  8551. required: true,
  8552. type: "string"
  8553. },
  8554. repo: {
  8555. required: true,
  8556. type: "string"
  8557. },
  8558. sha: {
  8559. alias: "ref",
  8560. deprecated: true,
  8561. type: "string"
  8562. }
  8563. },
  8564. url: "/repos/:owner/:repo/commits/:ref"
  8565. },
  8566. getCommitActivityStats: {
  8567. method: "GET",
  8568. params: {
  8569. owner: {
  8570. required: true,
  8571. type: "string"
  8572. },
  8573. repo: {
  8574. required: true,
  8575. type: "string"
  8576. }
  8577. },
  8578. url: "/repos/:owner/:repo/stats/commit_activity"
  8579. },
  8580. getCommitComment: {
  8581. method: "GET",
  8582. params: {
  8583. comment_id: {
  8584. required: true,
  8585. type: "integer"
  8586. },
  8587. owner: {
  8588. required: true,
  8589. type: "string"
  8590. },
  8591. repo: {
  8592. required: true,
  8593. type: "string"
  8594. }
  8595. },
  8596. url: "/repos/:owner/:repo/comments/:comment_id"
  8597. },
  8598. getCommitRefSha: {
  8599. deprecated: "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit",
  8600. headers: {
  8601. accept: "application/vnd.github.v3.sha"
  8602. },
  8603. method: "GET",
  8604. params: {
  8605. owner: {
  8606. required: true,
  8607. type: "string"
  8608. },
  8609. ref: {
  8610. required: true,
  8611. type: "string"
  8612. },
  8613. repo: {
  8614. required: true,
  8615. type: "string"
  8616. }
  8617. },
  8618. url: "/repos/:owner/:repo/commits/:ref"
  8619. },
  8620. getContents: {
  8621. method: "GET",
  8622. params: {
  8623. owner: {
  8624. required: true,
  8625. type: "string"
  8626. },
  8627. path: {
  8628. required: true,
  8629. type: "string"
  8630. },
  8631. ref: {
  8632. type: "string"
  8633. },
  8634. repo: {
  8635. required: true,
  8636. type: "string"
  8637. }
  8638. },
  8639. url: "/repos/:owner/:repo/contents/:path"
  8640. },
  8641. getContributorsStats: {
  8642. method: "GET",
  8643. params: {
  8644. owner: {
  8645. required: true,
  8646. type: "string"
  8647. },
  8648. repo: {
  8649. required: true,
  8650. type: "string"
  8651. }
  8652. },
  8653. url: "/repos/:owner/:repo/stats/contributors"
  8654. },
  8655. getDeployKey: {
  8656. method: "GET",
  8657. params: {
  8658. key_id: {
  8659. required: true,
  8660. type: "integer"
  8661. },
  8662. owner: {
  8663. required: true,
  8664. type: "string"
  8665. },
  8666. repo: {
  8667. required: true,
  8668. type: "string"
  8669. }
  8670. },
  8671. url: "/repos/:owner/:repo/keys/:key_id"
  8672. },
  8673. getDeployment: {
  8674. method: "GET",
  8675. params: {
  8676. deployment_id: {
  8677. required: true,
  8678. type: "integer"
  8679. },
  8680. owner: {
  8681. required: true,
  8682. type: "string"
  8683. },
  8684. repo: {
  8685. required: true,
  8686. type: "string"
  8687. }
  8688. },
  8689. url: "/repos/:owner/:repo/deployments/:deployment_id"
  8690. },
  8691. getDeploymentStatus: {
  8692. method: "GET",
  8693. params: {
  8694. deployment_id: {
  8695. required: true,
  8696. type: "integer"
  8697. },
  8698. owner: {
  8699. required: true,
  8700. type: "string"
  8701. },
  8702. repo: {
  8703. required: true,
  8704. type: "string"
  8705. },
  8706. status_id: {
  8707. required: true,
  8708. type: "integer"
  8709. }
  8710. },
  8711. url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"
  8712. },
  8713. getDownload: {
  8714. method: "GET",
  8715. params: {
  8716. download_id: {
  8717. required: true,
  8718. type: "integer"
  8719. },
  8720. owner: {
  8721. required: true,
  8722. type: "string"
  8723. },
  8724. repo: {
  8725. required: true,
  8726. type: "string"
  8727. }
  8728. },
  8729. url: "/repos/:owner/:repo/downloads/:download_id"
  8730. },
  8731. getHook: {
  8732. method: "GET",
  8733. params: {
  8734. hook_id: {
  8735. required: true,
  8736. type: "integer"
  8737. },
  8738. owner: {
  8739. required: true,
  8740. type: "string"
  8741. },
  8742. repo: {
  8743. required: true,
  8744. type: "string"
  8745. }
  8746. },
  8747. url: "/repos/:owner/:repo/hooks/:hook_id"
  8748. },
  8749. getLatestPagesBuild: {
  8750. method: "GET",
  8751. params: {
  8752. owner: {
  8753. required: true,
  8754. type: "string"
  8755. },
  8756. repo: {
  8757. required: true,
  8758. type: "string"
  8759. }
  8760. },
  8761. url: "/repos/:owner/:repo/pages/builds/latest"
  8762. },
  8763. getLatestRelease: {
  8764. method: "GET",
  8765. params: {
  8766. owner: {
  8767. required: true,
  8768. type: "string"
  8769. },
  8770. repo: {
  8771. required: true,
  8772. type: "string"
  8773. }
  8774. },
  8775. url: "/repos/:owner/:repo/releases/latest"
  8776. },
  8777. getPages: {
  8778. method: "GET",
  8779. params: {
  8780. owner: {
  8781. required: true,
  8782. type: "string"
  8783. },
  8784. repo: {
  8785. required: true,
  8786. type: "string"
  8787. }
  8788. },
  8789. url: "/repos/:owner/:repo/pages"
  8790. },
  8791. getPagesBuild: {
  8792. method: "GET",
  8793. params: {
  8794. build_id: {
  8795. required: true,
  8796. type: "integer"
  8797. },
  8798. owner: {
  8799. required: true,
  8800. type: "string"
  8801. },
  8802. repo: {
  8803. required: true,
  8804. type: "string"
  8805. }
  8806. },
  8807. url: "/repos/:owner/:repo/pages/builds/:build_id"
  8808. },
  8809. getParticipationStats: {
  8810. method: "GET",
  8811. params: {
  8812. owner: {
  8813. required: true,
  8814. type: "string"
  8815. },
  8816. repo: {
  8817. required: true,
  8818. type: "string"
  8819. }
  8820. },
  8821. url: "/repos/:owner/:repo/stats/participation"
  8822. },
  8823. getProtectedBranchAdminEnforcement: {
  8824. method: "GET",
  8825. params: {
  8826. branch: {
  8827. required: true,
  8828. type: "string"
  8829. },
  8830. owner: {
  8831. required: true,
  8832. type: "string"
  8833. },
  8834. repo: {
  8835. required: true,
  8836. type: "string"
  8837. }
  8838. },
  8839. url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  8840. },
  8841. getProtectedBranchPullRequestReviewEnforcement: {
  8842. method: "GET",
  8843. params: {
  8844. branch: {
  8845. required: true,
  8846. type: "string"
  8847. },
  8848. owner: {
  8849. required: true,
  8850. type: "string"
  8851. },
  8852. repo: {
  8853. required: true,
  8854. type: "string"
  8855. }
  8856. },
  8857. url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  8858. },
  8859. getProtectedBranchRequiredSignatures: {
  8860. headers: {
  8861. accept: "application/vnd.github.zzzax-preview+json"
  8862. },
  8863. method: "GET",
  8864. params: {
  8865. branch: {
  8866. required: true,
  8867. type: "string"
  8868. },
  8869. owner: {
  8870. required: true,
  8871. type: "string"
  8872. },
  8873. repo: {
  8874. required: true,
  8875. type: "string"
  8876. }
  8877. },
  8878. url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  8879. },
  8880. getProtectedBranchRequiredStatusChecks: {
  8881. method: "GET",
  8882. params: {
  8883. branch: {
  8884. required: true,
  8885. type: "string"
  8886. },
  8887. owner: {
  8888. required: true,
  8889. type: "string"
  8890. },
  8891. repo: {
  8892. required: true,
  8893. type: "string"
  8894. }
  8895. },
  8896. url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  8897. },
  8898. getProtectedBranchRestrictions: {
  8899. method: "GET",
  8900. params: {
  8901. branch: {
  8902. required: true,
  8903. type: "string"
  8904. },
  8905. owner: {
  8906. required: true,
  8907. type: "string"
  8908. },
  8909. repo: {
  8910. required: true,
  8911. type: "string"
  8912. }
  8913. },
  8914. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"
  8915. },
  8916. getPunchCardStats: {
  8917. method: "GET",
  8918. params: {
  8919. owner: {
  8920. required: true,
  8921. type: "string"
  8922. },
  8923. repo: {
  8924. required: true,
  8925. type: "string"
  8926. }
  8927. },
  8928. url: "/repos/:owner/:repo/stats/punch_card"
  8929. },
  8930. getReadme: {
  8931. method: "GET",
  8932. params: {
  8933. owner: {
  8934. required: true,
  8935. type: "string"
  8936. },
  8937. ref: {
  8938. type: "string"
  8939. },
  8940. repo: {
  8941. required: true,
  8942. type: "string"
  8943. }
  8944. },
  8945. url: "/repos/:owner/:repo/readme"
  8946. },
  8947. getRelease: {
  8948. method: "GET",
  8949. params: {
  8950. owner: {
  8951. required: true,
  8952. type: "string"
  8953. },
  8954. release_id: {
  8955. required: true,
  8956. type: "integer"
  8957. },
  8958. repo: {
  8959. required: true,
  8960. type: "string"
  8961. }
  8962. },
  8963. url: "/repos/:owner/:repo/releases/:release_id"
  8964. },
  8965. getReleaseAsset: {
  8966. method: "GET",
  8967. params: {
  8968. asset_id: {
  8969. required: true,
  8970. type: "integer"
  8971. },
  8972. owner: {
  8973. required: true,
  8974. type: "string"
  8975. },
  8976. repo: {
  8977. required: true,
  8978. type: "string"
  8979. }
  8980. },
  8981. url: "/repos/:owner/:repo/releases/assets/:asset_id"
  8982. },
  8983. getReleaseByTag: {
  8984. method: "GET",
  8985. params: {
  8986. owner: {
  8987. required: true,
  8988. type: "string"
  8989. },
  8990. repo: {
  8991. required: true,
  8992. type: "string"
  8993. },
  8994. tag: {
  8995. required: true,
  8996. type: "string"
  8997. }
  8998. },
  8999. url: "/repos/:owner/:repo/releases/tags/:tag"
  9000. },
  9001. getTeamsWithAccessToProtectedBranch: {
  9002. method: "GET",
  9003. params: {
  9004. branch: {
  9005. required: true,
  9006. type: "string"
  9007. },
  9008. owner: {
  9009. required: true,
  9010. type: "string"
  9011. },
  9012. repo: {
  9013. required: true,
  9014. type: "string"
  9015. }
  9016. },
  9017. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  9018. },
  9019. getTopPaths: {
  9020. method: "GET",
  9021. params: {
  9022. owner: {
  9023. required: true,
  9024. type: "string"
  9025. },
  9026. repo: {
  9027. required: true,
  9028. type: "string"
  9029. }
  9030. },
  9031. url: "/repos/:owner/:repo/traffic/popular/paths"
  9032. },
  9033. getTopReferrers: {
  9034. method: "GET",
  9035. params: {
  9036. owner: {
  9037. required: true,
  9038. type: "string"
  9039. },
  9040. repo: {
  9041. required: true,
  9042. type: "string"
  9043. }
  9044. },
  9045. url: "/repos/:owner/:repo/traffic/popular/referrers"
  9046. },
  9047. getUsersWithAccessToProtectedBranch: {
  9048. method: "GET",
  9049. params: {
  9050. branch: {
  9051. required: true,
  9052. type: "string"
  9053. },
  9054. owner: {
  9055. required: true,
  9056. type: "string"
  9057. },
  9058. repo: {
  9059. required: true,
  9060. type: "string"
  9061. }
  9062. },
  9063. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  9064. },
  9065. getViews: {
  9066. method: "GET",
  9067. params: {
  9068. owner: {
  9069. required: true,
  9070. type: "string"
  9071. },
  9072. per: {
  9073. enum: ["day", "week"],
  9074. type: "string"
  9075. },
  9076. repo: {
  9077. required: true,
  9078. type: "string"
  9079. }
  9080. },
  9081. url: "/repos/:owner/:repo/traffic/views"
  9082. },
  9083. list: {
  9084. method: "GET",
  9085. params: {
  9086. affiliation: {
  9087. type: "string"
  9088. },
  9089. direction: {
  9090. enum: ["asc", "desc"],
  9091. type: "string"
  9092. },
  9093. page: {
  9094. type: "integer"
  9095. },
  9096. per_page: {
  9097. type: "integer"
  9098. },
  9099. sort: {
  9100. enum: ["created", "updated", "pushed", "full_name"],
  9101. type: "string"
  9102. },
  9103. type: {
  9104. enum: ["all", "owner", "public", "private", "member"],
  9105. type: "string"
  9106. },
  9107. visibility: {
  9108. enum: ["all", "public", "private"],
  9109. type: "string"
  9110. }
  9111. },
  9112. url: "/user/repos"
  9113. },
  9114. listAppsWithAccessToProtectedBranch: {
  9115. deprecated: "octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)",
  9116. method: "GET",
  9117. params: {
  9118. branch: {
  9119. required: true,
  9120. type: "string"
  9121. },
  9122. owner: {
  9123. required: true,
  9124. type: "string"
  9125. },
  9126. repo: {
  9127. required: true,
  9128. type: "string"
  9129. }
  9130. },
  9131. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  9132. },
  9133. listAssetsForRelease: {
  9134. method: "GET",
  9135. params: {
  9136. owner: {
  9137. required: true,
  9138. type: "string"
  9139. },
  9140. page: {
  9141. type: "integer"
  9142. },
  9143. per_page: {
  9144. type: "integer"
  9145. },
  9146. release_id: {
  9147. required: true,
  9148. type: "integer"
  9149. },
  9150. repo: {
  9151. required: true,
  9152. type: "string"
  9153. }
  9154. },
  9155. url: "/repos/:owner/:repo/releases/:release_id/assets"
  9156. },
  9157. listBranches: {
  9158. method: "GET",
  9159. params: {
  9160. owner: {
  9161. required: true,
  9162. type: "string"
  9163. },
  9164. page: {
  9165. type: "integer"
  9166. },
  9167. per_page: {
  9168. type: "integer"
  9169. },
  9170. protected: {
  9171. type: "boolean"
  9172. },
  9173. repo: {
  9174. required: true,
  9175. type: "string"
  9176. }
  9177. },
  9178. url: "/repos/:owner/:repo/branches"
  9179. },
  9180. listBranchesForHeadCommit: {
  9181. headers: {
  9182. accept: "application/vnd.github.groot-preview+json"
  9183. },
  9184. method: "GET",
  9185. params: {
  9186. commit_sha: {
  9187. required: true,
  9188. type: "string"
  9189. },
  9190. owner: {
  9191. required: true,
  9192. type: "string"
  9193. },
  9194. repo: {
  9195. required: true,
  9196. type: "string"
  9197. }
  9198. },
  9199. url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"
  9200. },
  9201. listCollaborators: {
  9202. method: "GET",
  9203. params: {
  9204. affiliation: {
  9205. enum: ["outside", "direct", "all"],
  9206. type: "string"
  9207. },
  9208. owner: {
  9209. required: true,
  9210. type: "string"
  9211. },
  9212. page: {
  9213. type: "integer"
  9214. },
  9215. per_page: {
  9216. type: "integer"
  9217. },
  9218. repo: {
  9219. required: true,
  9220. type: "string"
  9221. }
  9222. },
  9223. url: "/repos/:owner/:repo/collaborators"
  9224. },
  9225. listCommentsForCommit: {
  9226. method: "GET",
  9227. params: {
  9228. commit_sha: {
  9229. required: true,
  9230. type: "string"
  9231. },
  9232. owner: {
  9233. required: true,
  9234. type: "string"
  9235. },
  9236. page: {
  9237. type: "integer"
  9238. },
  9239. per_page: {
  9240. type: "integer"
  9241. },
  9242. ref: {
  9243. alias: "commit_sha",
  9244. deprecated: true,
  9245. type: "string"
  9246. },
  9247. repo: {
  9248. required: true,
  9249. type: "string"
  9250. }
  9251. },
  9252. url: "/repos/:owner/:repo/commits/:commit_sha/comments"
  9253. },
  9254. listCommitComments: {
  9255. method: "GET",
  9256. params: {
  9257. owner: {
  9258. required: true,
  9259. type: "string"
  9260. },
  9261. page: {
  9262. type: "integer"
  9263. },
  9264. per_page: {
  9265. type: "integer"
  9266. },
  9267. repo: {
  9268. required: true,
  9269. type: "string"
  9270. }
  9271. },
  9272. url: "/repos/:owner/:repo/comments"
  9273. },
  9274. listCommits: {
  9275. method: "GET",
  9276. params: {
  9277. author: {
  9278. type: "string"
  9279. },
  9280. owner: {
  9281. required: true,
  9282. type: "string"
  9283. },
  9284. page: {
  9285. type: "integer"
  9286. },
  9287. path: {
  9288. type: "string"
  9289. },
  9290. per_page: {
  9291. type: "integer"
  9292. },
  9293. repo: {
  9294. required: true,
  9295. type: "string"
  9296. },
  9297. sha: {
  9298. type: "string"
  9299. },
  9300. since: {
  9301. type: "string"
  9302. },
  9303. until: {
  9304. type: "string"
  9305. }
  9306. },
  9307. url: "/repos/:owner/:repo/commits"
  9308. },
  9309. listContributors: {
  9310. method: "GET",
  9311. params: {
  9312. anon: {
  9313. type: "string"
  9314. },
  9315. owner: {
  9316. required: true,
  9317. type: "string"
  9318. },
  9319. page: {
  9320. type: "integer"
  9321. },
  9322. per_page: {
  9323. type: "integer"
  9324. },
  9325. repo: {
  9326. required: true,
  9327. type: "string"
  9328. }
  9329. },
  9330. url: "/repos/:owner/:repo/contributors"
  9331. },
  9332. listDeployKeys: {
  9333. method: "GET",
  9334. params: {
  9335. owner: {
  9336. required: true,
  9337. type: "string"
  9338. },
  9339. page: {
  9340. type: "integer"
  9341. },
  9342. per_page: {
  9343. type: "integer"
  9344. },
  9345. repo: {
  9346. required: true,
  9347. type: "string"
  9348. }
  9349. },
  9350. url: "/repos/:owner/:repo/keys"
  9351. },
  9352. listDeploymentStatuses: {
  9353. method: "GET",
  9354. params: {
  9355. deployment_id: {
  9356. required: true,
  9357. type: "integer"
  9358. },
  9359. owner: {
  9360. required: true,
  9361. type: "string"
  9362. },
  9363. page: {
  9364. type: "integer"
  9365. },
  9366. per_page: {
  9367. type: "integer"
  9368. },
  9369. repo: {
  9370. required: true,
  9371. type: "string"
  9372. }
  9373. },
  9374. url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"
  9375. },
  9376. listDeployments: {
  9377. method: "GET",
  9378. params: {
  9379. environment: {
  9380. type: "string"
  9381. },
  9382. owner: {
  9383. required: true,
  9384. type: "string"
  9385. },
  9386. page: {
  9387. type: "integer"
  9388. },
  9389. per_page: {
  9390. type: "integer"
  9391. },
  9392. ref: {
  9393. type: "string"
  9394. },
  9395. repo: {
  9396. required: true,
  9397. type: "string"
  9398. },
  9399. sha: {
  9400. type: "string"
  9401. },
  9402. task: {
  9403. type: "string"
  9404. }
  9405. },
  9406. url: "/repos/:owner/:repo/deployments"
  9407. },
  9408. listDownloads: {
  9409. method: "GET",
  9410. params: {
  9411. owner: {
  9412. required: true,
  9413. type: "string"
  9414. },
  9415. page: {
  9416. type: "integer"
  9417. },
  9418. per_page: {
  9419. type: "integer"
  9420. },
  9421. repo: {
  9422. required: true,
  9423. type: "string"
  9424. }
  9425. },
  9426. url: "/repos/:owner/:repo/downloads"
  9427. },
  9428. listForOrg: {
  9429. method: "GET",
  9430. params: {
  9431. direction: {
  9432. enum: ["asc", "desc"],
  9433. type: "string"
  9434. },
  9435. org: {
  9436. required: true,
  9437. type: "string"
  9438. },
  9439. page: {
  9440. type: "integer"
  9441. },
  9442. per_page: {
  9443. type: "integer"
  9444. },
  9445. sort: {
  9446. enum: ["created", "updated", "pushed", "full_name"],
  9447. type: "string"
  9448. },
  9449. type: {
  9450. enum: ["all", "public", "private", "forks", "sources", "member", "internal"],
  9451. type: "string"
  9452. }
  9453. },
  9454. url: "/orgs/:org/repos"
  9455. },
  9456. listForUser: {
  9457. method: "GET",
  9458. params: {
  9459. direction: {
  9460. enum: ["asc", "desc"],
  9461. type: "string"
  9462. },
  9463. page: {
  9464. type: "integer"
  9465. },
  9466. per_page: {
  9467. type: "integer"
  9468. },
  9469. sort: {
  9470. enum: ["created", "updated", "pushed", "full_name"],
  9471. type: "string"
  9472. },
  9473. type: {
  9474. enum: ["all", "owner", "member"],
  9475. type: "string"
  9476. },
  9477. username: {
  9478. required: true,
  9479. type: "string"
  9480. }
  9481. },
  9482. url: "/users/:username/repos"
  9483. },
  9484. listForks: {
  9485. method: "GET",
  9486. params: {
  9487. owner: {
  9488. required: true,
  9489. type: "string"
  9490. },
  9491. page: {
  9492. type: "integer"
  9493. },
  9494. per_page: {
  9495. type: "integer"
  9496. },
  9497. repo: {
  9498. required: true,
  9499. type: "string"
  9500. },
  9501. sort: {
  9502. enum: ["newest", "oldest", "stargazers"],
  9503. type: "string"
  9504. }
  9505. },
  9506. url: "/repos/:owner/:repo/forks"
  9507. },
  9508. listHooks: {
  9509. method: "GET",
  9510. params: {
  9511. owner: {
  9512. required: true,
  9513. type: "string"
  9514. },
  9515. page: {
  9516. type: "integer"
  9517. },
  9518. per_page: {
  9519. type: "integer"
  9520. },
  9521. repo: {
  9522. required: true,
  9523. type: "string"
  9524. }
  9525. },
  9526. url: "/repos/:owner/:repo/hooks"
  9527. },
  9528. listInvitations: {
  9529. method: "GET",
  9530. params: {
  9531. owner: {
  9532. required: true,
  9533. type: "string"
  9534. },
  9535. page: {
  9536. type: "integer"
  9537. },
  9538. per_page: {
  9539. type: "integer"
  9540. },
  9541. repo: {
  9542. required: true,
  9543. type: "string"
  9544. }
  9545. },
  9546. url: "/repos/:owner/:repo/invitations"
  9547. },
  9548. listInvitationsForAuthenticatedUser: {
  9549. method: "GET",
  9550. params: {
  9551. page: {
  9552. type: "integer"
  9553. },
  9554. per_page: {
  9555. type: "integer"
  9556. }
  9557. },
  9558. url: "/user/repository_invitations"
  9559. },
  9560. listLanguages: {
  9561. method: "GET",
  9562. params: {
  9563. owner: {
  9564. required: true,
  9565. type: "string"
  9566. },
  9567. repo: {
  9568. required: true,
  9569. type: "string"
  9570. }
  9571. },
  9572. url: "/repos/:owner/:repo/languages"
  9573. },
  9574. listPagesBuilds: {
  9575. method: "GET",
  9576. params: {
  9577. owner: {
  9578. required: true,
  9579. type: "string"
  9580. },
  9581. page: {
  9582. type: "integer"
  9583. },
  9584. per_page: {
  9585. type: "integer"
  9586. },
  9587. repo: {
  9588. required: true,
  9589. type: "string"
  9590. }
  9591. },
  9592. url: "/repos/:owner/:repo/pages/builds"
  9593. },
  9594. listProtectedBranchRequiredStatusChecksContexts: {
  9595. method: "GET",
  9596. params: {
  9597. branch: {
  9598. required: true,
  9599. type: "string"
  9600. },
  9601. owner: {
  9602. required: true,
  9603. type: "string"
  9604. },
  9605. repo: {
  9606. required: true,
  9607. type: "string"
  9608. }
  9609. },
  9610. url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  9611. },
  9612. listProtectedBranchTeamRestrictions: {
  9613. deprecated: "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)",
  9614. method: "GET",
  9615. params: {
  9616. branch: {
  9617. required: true,
  9618. type: "string"
  9619. },
  9620. owner: {
  9621. required: true,
  9622. type: "string"
  9623. },
  9624. repo: {
  9625. required: true,
  9626. type: "string"
  9627. }
  9628. },
  9629. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  9630. },
  9631. listProtectedBranchUserRestrictions: {
  9632. deprecated: "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)",
  9633. method: "GET",
  9634. params: {
  9635. branch: {
  9636. required: true,
  9637. type: "string"
  9638. },
  9639. owner: {
  9640. required: true,
  9641. type: "string"
  9642. },
  9643. repo: {
  9644. required: true,
  9645. type: "string"
  9646. }
  9647. },
  9648. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  9649. },
  9650. listPublic: {
  9651. method: "GET",
  9652. params: {
  9653. page: {
  9654. type: "integer"
  9655. },
  9656. per_page: {
  9657. type: "integer"
  9658. },
  9659. since: {
  9660. type: "integer"
  9661. }
  9662. },
  9663. url: "/repositories"
  9664. },
  9665. listPullRequestsAssociatedWithCommit: {
  9666. headers: {
  9667. accept: "application/vnd.github.groot-preview+json"
  9668. },
  9669. method: "GET",
  9670. params: {
  9671. commit_sha: {
  9672. required: true,
  9673. type: "string"
  9674. },
  9675. owner: {
  9676. required: true,
  9677. type: "string"
  9678. },
  9679. page: {
  9680. type: "integer"
  9681. },
  9682. per_page: {
  9683. type: "integer"
  9684. },
  9685. repo: {
  9686. required: true,
  9687. type: "string"
  9688. }
  9689. },
  9690. url: "/repos/:owner/:repo/commits/:commit_sha/pulls"
  9691. },
  9692. listReleases: {
  9693. method: "GET",
  9694. params: {
  9695. owner: {
  9696. required: true,
  9697. type: "string"
  9698. },
  9699. page: {
  9700. type: "integer"
  9701. },
  9702. per_page: {
  9703. type: "integer"
  9704. },
  9705. repo: {
  9706. required: true,
  9707. type: "string"
  9708. }
  9709. },
  9710. url: "/repos/:owner/:repo/releases"
  9711. },
  9712. listStatusesForRef: {
  9713. method: "GET",
  9714. params: {
  9715. owner: {
  9716. required: true,
  9717. type: "string"
  9718. },
  9719. page: {
  9720. type: "integer"
  9721. },
  9722. per_page: {
  9723. type: "integer"
  9724. },
  9725. ref: {
  9726. required: true,
  9727. type: "string"
  9728. },
  9729. repo: {
  9730. required: true,
  9731. type: "string"
  9732. }
  9733. },
  9734. url: "/repos/:owner/:repo/commits/:ref/statuses"
  9735. },
  9736. listTags: {
  9737. method: "GET",
  9738. params: {
  9739. owner: {
  9740. required: true,
  9741. type: "string"
  9742. },
  9743. page: {
  9744. type: "integer"
  9745. },
  9746. per_page: {
  9747. type: "integer"
  9748. },
  9749. repo: {
  9750. required: true,
  9751. type: "string"
  9752. }
  9753. },
  9754. url: "/repos/:owner/:repo/tags"
  9755. },
  9756. listTeams: {
  9757. method: "GET",
  9758. params: {
  9759. owner: {
  9760. required: true,
  9761. type: "string"
  9762. },
  9763. page: {
  9764. type: "integer"
  9765. },
  9766. per_page: {
  9767. type: "integer"
  9768. },
  9769. repo: {
  9770. required: true,
  9771. type: "string"
  9772. }
  9773. },
  9774. url: "/repos/:owner/:repo/teams"
  9775. },
  9776. listTeamsWithAccessToProtectedBranch: {
  9777. deprecated: "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)",
  9778. method: "GET",
  9779. params: {
  9780. branch: {
  9781. required: true,
  9782. type: "string"
  9783. },
  9784. owner: {
  9785. required: true,
  9786. type: "string"
  9787. },
  9788. repo: {
  9789. required: true,
  9790. type: "string"
  9791. }
  9792. },
  9793. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  9794. },
  9795. listTopics: {
  9796. headers: {
  9797. accept: "application/vnd.github.mercy-preview+json"
  9798. },
  9799. method: "GET",
  9800. params: {
  9801. owner: {
  9802. required: true,
  9803. type: "string"
  9804. },
  9805. repo: {
  9806. required: true,
  9807. type: "string"
  9808. }
  9809. },
  9810. url: "/repos/:owner/:repo/topics"
  9811. },
  9812. listUsersWithAccessToProtectedBranch: {
  9813. deprecated: "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)",
  9814. method: "GET",
  9815. params: {
  9816. branch: {
  9817. required: true,
  9818. type: "string"
  9819. },
  9820. owner: {
  9821. required: true,
  9822. type: "string"
  9823. },
  9824. repo: {
  9825. required: true,
  9826. type: "string"
  9827. }
  9828. },
  9829. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  9830. },
  9831. merge: {
  9832. method: "POST",
  9833. params: {
  9834. base: {
  9835. required: true,
  9836. type: "string"
  9837. },
  9838. commit_message: {
  9839. type: "string"
  9840. },
  9841. head: {
  9842. required: true,
  9843. type: "string"
  9844. },
  9845. owner: {
  9846. required: true,
  9847. type: "string"
  9848. },
  9849. repo: {
  9850. required: true,
  9851. type: "string"
  9852. }
  9853. },
  9854. url: "/repos/:owner/:repo/merges"
  9855. },
  9856. pingHook: {
  9857. method: "POST",
  9858. params: {
  9859. hook_id: {
  9860. required: true,
  9861. type: "integer"
  9862. },
  9863. owner: {
  9864. required: true,
  9865. type: "string"
  9866. },
  9867. repo: {
  9868. required: true,
  9869. type: "string"
  9870. }
  9871. },
  9872. url: "/repos/:owner/:repo/hooks/:hook_id/pings"
  9873. },
  9874. removeBranchProtection: {
  9875. method: "DELETE",
  9876. params: {
  9877. branch: {
  9878. required: true,
  9879. type: "string"
  9880. },
  9881. owner: {
  9882. required: true,
  9883. type: "string"
  9884. },
  9885. repo: {
  9886. required: true,
  9887. type: "string"
  9888. }
  9889. },
  9890. url: "/repos/:owner/:repo/branches/:branch/protection"
  9891. },
  9892. removeCollaborator: {
  9893. method: "DELETE",
  9894. params: {
  9895. owner: {
  9896. required: true,
  9897. type: "string"
  9898. },
  9899. repo: {
  9900. required: true,
  9901. type: "string"
  9902. },
  9903. username: {
  9904. required: true,
  9905. type: "string"
  9906. }
  9907. },
  9908. url: "/repos/:owner/:repo/collaborators/:username"
  9909. },
  9910. removeDeployKey: {
  9911. method: "DELETE",
  9912. params: {
  9913. key_id: {
  9914. required: true,
  9915. type: "integer"
  9916. },
  9917. owner: {
  9918. required: true,
  9919. type: "string"
  9920. },
  9921. repo: {
  9922. required: true,
  9923. type: "string"
  9924. }
  9925. },
  9926. url: "/repos/:owner/:repo/keys/:key_id"
  9927. },
  9928. removeProtectedBranchAdminEnforcement: {
  9929. method: "DELETE",
  9930. params: {
  9931. branch: {
  9932. required: true,
  9933. type: "string"
  9934. },
  9935. owner: {
  9936. required: true,
  9937. type: "string"
  9938. },
  9939. repo: {
  9940. required: true,
  9941. type: "string"
  9942. }
  9943. },
  9944. url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  9945. },
  9946. removeProtectedBranchAppRestrictions: {
  9947. method: "DELETE",
  9948. params: {
  9949. apps: {
  9950. mapTo: "data",
  9951. required: true,
  9952. type: "string[]"
  9953. },
  9954. branch: {
  9955. required: true,
  9956. type: "string"
  9957. },
  9958. owner: {
  9959. required: true,
  9960. type: "string"
  9961. },
  9962. repo: {
  9963. required: true,
  9964. type: "string"
  9965. }
  9966. },
  9967. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  9968. },
  9969. removeProtectedBranchPullRequestReviewEnforcement: {
  9970. method: "DELETE",
  9971. params: {
  9972. branch: {
  9973. required: true,
  9974. type: "string"
  9975. },
  9976. owner: {
  9977. required: true,
  9978. type: "string"
  9979. },
  9980. repo: {
  9981. required: true,
  9982. type: "string"
  9983. }
  9984. },
  9985. url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  9986. },
  9987. removeProtectedBranchRequiredSignatures: {
  9988. headers: {
  9989. accept: "application/vnd.github.zzzax-preview+json"
  9990. },
  9991. method: "DELETE",
  9992. params: {
  9993. branch: {
  9994. required: true,
  9995. type: "string"
  9996. },
  9997. owner: {
  9998. required: true,
  9999. type: "string"
  10000. },
  10001. repo: {
  10002. required: true,
  10003. type: "string"
  10004. }
  10005. },
  10006. url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  10007. },
  10008. removeProtectedBranchRequiredStatusChecks: {
  10009. method: "DELETE",
  10010. params: {
  10011. branch: {
  10012. required: true,
  10013. type: "string"
  10014. },
  10015. owner: {
  10016. required: true,
  10017. type: "string"
  10018. },
  10019. repo: {
  10020. required: true,
  10021. type: "string"
  10022. }
  10023. },
  10024. url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  10025. },
  10026. removeProtectedBranchRequiredStatusChecksContexts: {
  10027. method: "DELETE",
  10028. params: {
  10029. branch: {
  10030. required: true,
  10031. type: "string"
  10032. },
  10033. contexts: {
  10034. mapTo: "data",
  10035. required: true,
  10036. type: "string[]"
  10037. },
  10038. owner: {
  10039. required: true,
  10040. type: "string"
  10041. },
  10042. repo: {
  10043. required: true,
  10044. type: "string"
  10045. }
  10046. },
  10047. url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  10048. },
  10049. removeProtectedBranchRestrictions: {
  10050. method: "DELETE",
  10051. params: {
  10052. branch: {
  10053. required: true,
  10054. type: "string"
  10055. },
  10056. owner: {
  10057. required: true,
  10058. type: "string"
  10059. },
  10060. repo: {
  10061. required: true,
  10062. type: "string"
  10063. }
  10064. },
  10065. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"
  10066. },
  10067. removeProtectedBranchTeamRestrictions: {
  10068. method: "DELETE",
  10069. params: {
  10070. branch: {
  10071. required: true,
  10072. type: "string"
  10073. },
  10074. owner: {
  10075. required: true,
  10076. type: "string"
  10077. },
  10078. repo: {
  10079. required: true,
  10080. type: "string"
  10081. },
  10082. teams: {
  10083. mapTo: "data",
  10084. required: true,
  10085. type: "string[]"
  10086. }
  10087. },
  10088. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  10089. },
  10090. removeProtectedBranchUserRestrictions: {
  10091. method: "DELETE",
  10092. params: {
  10093. branch: {
  10094. required: true,
  10095. type: "string"
  10096. },
  10097. owner: {
  10098. required: true,
  10099. type: "string"
  10100. },
  10101. repo: {
  10102. required: true,
  10103. type: "string"
  10104. },
  10105. users: {
  10106. mapTo: "data",
  10107. required: true,
  10108. type: "string[]"
  10109. }
  10110. },
  10111. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  10112. },
  10113. replaceProtectedBranchAppRestrictions: {
  10114. method: "PUT",
  10115. params: {
  10116. apps: {
  10117. mapTo: "data",
  10118. required: true,
  10119. type: "string[]"
  10120. },
  10121. branch: {
  10122. required: true,
  10123. type: "string"
  10124. },
  10125. owner: {
  10126. required: true,
  10127. type: "string"
  10128. },
  10129. repo: {
  10130. required: true,
  10131. type: "string"
  10132. }
  10133. },
  10134. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  10135. },
  10136. replaceProtectedBranchRequiredStatusChecksContexts: {
  10137. method: "PUT",
  10138. params: {
  10139. branch: {
  10140. required: true,
  10141. type: "string"
  10142. },
  10143. contexts: {
  10144. mapTo: "data",
  10145. required: true,
  10146. type: "string[]"
  10147. },
  10148. owner: {
  10149. required: true,
  10150. type: "string"
  10151. },
  10152. repo: {
  10153. required: true,
  10154. type: "string"
  10155. }
  10156. },
  10157. url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  10158. },
  10159. replaceProtectedBranchTeamRestrictions: {
  10160. method: "PUT",
  10161. params: {
  10162. branch: {
  10163. required: true,
  10164. type: "string"
  10165. },
  10166. owner: {
  10167. required: true,
  10168. type: "string"
  10169. },
  10170. repo: {
  10171. required: true,
  10172. type: "string"
  10173. },
  10174. teams: {
  10175. mapTo: "data",
  10176. required: true,
  10177. type: "string[]"
  10178. }
  10179. },
  10180. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  10181. },
  10182. replaceProtectedBranchUserRestrictions: {
  10183. method: "PUT",
  10184. params: {
  10185. branch: {
  10186. required: true,
  10187. type: "string"
  10188. },
  10189. owner: {
  10190. required: true,
  10191. type: "string"
  10192. },
  10193. repo: {
  10194. required: true,
  10195. type: "string"
  10196. },
  10197. users: {
  10198. mapTo: "data",
  10199. required: true,
  10200. type: "string[]"
  10201. }
  10202. },
  10203. url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  10204. },
  10205. replaceTopics: {
  10206. headers: {
  10207. accept: "application/vnd.github.mercy-preview+json"
  10208. },
  10209. method: "PUT",
  10210. params: {
  10211. names: {
  10212. required: true,
  10213. type: "string[]"
  10214. },
  10215. owner: {
  10216. required: true,
  10217. type: "string"
  10218. },
  10219. repo: {
  10220. required: true,
  10221. type: "string"
  10222. }
  10223. },
  10224. url: "/repos/:owner/:repo/topics"
  10225. },
  10226. requestPageBuild: {
  10227. method: "POST",
  10228. params: {
  10229. owner: {
  10230. required: true,
  10231. type: "string"
  10232. },
  10233. repo: {
  10234. required: true,
  10235. type: "string"
  10236. }
  10237. },
  10238. url: "/repos/:owner/:repo/pages/builds"
  10239. },
  10240. retrieveCommunityProfileMetrics: {
  10241. method: "GET",
  10242. params: {
  10243. owner: {
  10244. required: true,
  10245. type: "string"
  10246. },
  10247. repo: {
  10248. required: true,
  10249. type: "string"
  10250. }
  10251. },
  10252. url: "/repos/:owner/:repo/community/profile"
  10253. },
  10254. testPushHook: {
  10255. method: "POST",
  10256. params: {
  10257. hook_id: {
  10258. required: true,
  10259. type: "integer"
  10260. },
  10261. owner: {
  10262. required: true,
  10263. type: "string"
  10264. },
  10265. repo: {
  10266. required: true,
  10267. type: "string"
  10268. }
  10269. },
  10270. url: "/repos/:owner/:repo/hooks/:hook_id/tests"
  10271. },
  10272. transfer: {
  10273. method: "POST",
  10274. params: {
  10275. new_owner: {
  10276. type: "string"
  10277. },
  10278. owner: {
  10279. required: true,
  10280. type: "string"
  10281. },
  10282. repo: {
  10283. required: true,
  10284. type: "string"
  10285. },
  10286. team_ids: {
  10287. type: "integer[]"
  10288. }
  10289. },
  10290. url: "/repos/:owner/:repo/transfer"
  10291. },
  10292. update: {
  10293. method: "PATCH",
  10294. params: {
  10295. allow_merge_commit: {
  10296. type: "boolean"
  10297. },
  10298. allow_rebase_merge: {
  10299. type: "boolean"
  10300. },
  10301. allow_squash_merge: {
  10302. type: "boolean"
  10303. },
  10304. archived: {
  10305. type: "boolean"
  10306. },
  10307. default_branch: {
  10308. type: "string"
  10309. },
  10310. delete_branch_on_merge: {
  10311. type: "boolean"
  10312. },
  10313. description: {
  10314. type: "string"
  10315. },
  10316. has_issues: {
  10317. type: "boolean"
  10318. },
  10319. has_projects: {
  10320. type: "boolean"
  10321. },
  10322. has_wiki: {
  10323. type: "boolean"
  10324. },
  10325. homepage: {
  10326. type: "string"
  10327. },
  10328. is_template: {
  10329. type: "boolean"
  10330. },
  10331. name: {
  10332. type: "string"
  10333. },
  10334. owner: {
  10335. required: true,
  10336. type: "string"
  10337. },
  10338. private: {
  10339. type: "boolean"
  10340. },
  10341. repo: {
  10342. required: true,
  10343. type: "string"
  10344. },
  10345. visibility: {
  10346. enum: ["public", "private", "visibility", "internal"],
  10347. type: "string"
  10348. }
  10349. },
  10350. url: "/repos/:owner/:repo"
  10351. },
  10352. updateBranchProtection: {
  10353. method: "PUT",
  10354. params: {
  10355. allow_deletions: {
  10356. type: "boolean"
  10357. },
  10358. allow_force_pushes: {
  10359. allowNull: true,
  10360. type: "boolean"
  10361. },
  10362. branch: {
  10363. required: true,
  10364. type: "string"
  10365. },
  10366. enforce_admins: {
  10367. allowNull: true,
  10368. required: true,
  10369. type: "boolean"
  10370. },
  10371. owner: {
  10372. required: true,
  10373. type: "string"
  10374. },
  10375. repo: {
  10376. required: true,
  10377. type: "string"
  10378. },
  10379. required_linear_history: {
  10380. type: "boolean"
  10381. },
  10382. required_pull_request_reviews: {
  10383. allowNull: true,
  10384. required: true,
  10385. type: "object"
  10386. },
  10387. "required_pull_request_reviews.dismiss_stale_reviews": {
  10388. type: "boolean"
  10389. },
  10390. "required_pull_request_reviews.dismissal_restrictions": {
  10391. type: "object"
  10392. },
  10393. "required_pull_request_reviews.dismissal_restrictions.teams": {
  10394. type: "string[]"
  10395. },
  10396. "required_pull_request_reviews.dismissal_restrictions.users": {
  10397. type: "string[]"
  10398. },
  10399. "required_pull_request_reviews.require_code_owner_reviews": {
  10400. type: "boolean"
  10401. },
  10402. "required_pull_request_reviews.required_approving_review_count": {
  10403. type: "integer"
  10404. },
  10405. required_status_checks: {
  10406. allowNull: true,
  10407. required: true,
  10408. type: "object"
  10409. },
  10410. "required_status_checks.contexts": {
  10411. required: true,
  10412. type: "string[]"
  10413. },
  10414. "required_status_checks.strict": {
  10415. required: true,
  10416. type: "boolean"
  10417. },
  10418. restrictions: {
  10419. allowNull: true,
  10420. required: true,
  10421. type: "object"
  10422. },
  10423. "restrictions.apps": {
  10424. type: "string[]"
  10425. },
  10426. "restrictions.teams": {
  10427. required: true,
  10428. type: "string[]"
  10429. },
  10430. "restrictions.users": {
  10431. required: true,
  10432. type: "string[]"
  10433. }
  10434. },
  10435. url: "/repos/:owner/:repo/branches/:branch/protection"
  10436. },
  10437. updateCommitComment: {
  10438. method: "PATCH",
  10439. params: {
  10440. body: {
  10441. required: true,
  10442. type: "string"
  10443. },
  10444. comment_id: {
  10445. required: true,
  10446. type: "integer"
  10447. },
  10448. owner: {
  10449. required: true,
  10450. type: "string"
  10451. },
  10452. repo: {
  10453. required: true,
  10454. type: "string"
  10455. }
  10456. },
  10457. url: "/repos/:owner/:repo/comments/:comment_id"
  10458. },
  10459. updateFile: {
  10460. deprecated: "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
  10461. method: "PUT",
  10462. params: {
  10463. author: {
  10464. type: "object"
  10465. },
  10466. "author.email": {
  10467. required: true,
  10468. type: "string"
  10469. },
  10470. "author.name": {
  10471. required: true,
  10472. type: "string"
  10473. },
  10474. branch: {
  10475. type: "string"
  10476. },
  10477. committer: {
  10478. type: "object"
  10479. },
  10480. "committer.email": {
  10481. required: true,
  10482. type: "string"
  10483. },
  10484. "committer.name": {
  10485. required: true,
  10486. type: "string"
  10487. },
  10488. content: {
  10489. required: true,
  10490. type: "string"
  10491. },
  10492. message: {
  10493. required: true,
  10494. type: "string"
  10495. },
  10496. owner: {
  10497. required: true,
  10498. type: "string"
  10499. },
  10500. path: {
  10501. required: true,
  10502. type: "string"
  10503. },
  10504. repo: {
  10505. required: true,
  10506. type: "string"
  10507. },
  10508. sha: {
  10509. type: "string"
  10510. }
  10511. },
  10512. url: "/repos/:owner/:repo/contents/:path"
  10513. },
  10514. updateHook: {
  10515. method: "PATCH",
  10516. params: {
  10517. active: {
  10518. type: "boolean"
  10519. },
  10520. add_events: {
  10521. type: "string[]"
  10522. },
  10523. config: {
  10524. type: "object"
  10525. },
  10526. "config.content_type": {
  10527. type: "string"
  10528. },
  10529. "config.insecure_ssl": {
  10530. type: "string"
  10531. },
  10532. "config.secret": {
  10533. type: "string"
  10534. },
  10535. "config.url": {
  10536. required: true,
  10537. type: "string"
  10538. },
  10539. events: {
  10540. type: "string[]"
  10541. },
  10542. hook_id: {
  10543. required: true,
  10544. type: "integer"
  10545. },
  10546. owner: {
  10547. required: true,
  10548. type: "string"
  10549. },
  10550. remove_events: {
  10551. type: "string[]"
  10552. },
  10553. repo: {
  10554. required: true,
  10555. type: "string"
  10556. }
  10557. },
  10558. url: "/repos/:owner/:repo/hooks/:hook_id"
  10559. },
  10560. updateInformationAboutPagesSite: {
  10561. method: "PUT",
  10562. params: {
  10563. cname: {
  10564. type: "string"
  10565. },
  10566. owner: {
  10567. required: true,
  10568. type: "string"
  10569. },
  10570. repo: {
  10571. required: true,
  10572. type: "string"
  10573. },
  10574. source: {
  10575. enum: ['"gh-pages"', '"master"', '"master /docs"'],
  10576. type: "string"
  10577. }
  10578. },
  10579. url: "/repos/:owner/:repo/pages"
  10580. },
  10581. updateInvitation: {
  10582. method: "PATCH",
  10583. params: {
  10584. invitation_id: {
  10585. required: true,
  10586. type: "integer"
  10587. },
  10588. owner: {
  10589. required: true,
  10590. type: "string"
  10591. },
  10592. permissions: {
  10593. enum: ["read", "write", "admin"],
  10594. type: "string"
  10595. },
  10596. repo: {
  10597. required: true,
  10598. type: "string"
  10599. }
  10600. },
  10601. url: "/repos/:owner/:repo/invitations/:invitation_id"
  10602. },
  10603. updateProtectedBranchPullRequestReviewEnforcement: {
  10604. method: "PATCH",
  10605. params: {
  10606. branch: {
  10607. required: true,
  10608. type: "string"
  10609. },
  10610. dismiss_stale_reviews: {
  10611. type: "boolean"
  10612. },
  10613. dismissal_restrictions: {
  10614. type: "object"
  10615. },
  10616. "dismissal_restrictions.teams": {
  10617. type: "string[]"
  10618. },
  10619. "dismissal_restrictions.users": {
  10620. type: "string[]"
  10621. },
  10622. owner: {
  10623. required: true,
  10624. type: "string"
  10625. },
  10626. repo: {
  10627. required: true,
  10628. type: "string"
  10629. },
  10630. require_code_owner_reviews: {
  10631. type: "boolean"
  10632. },
  10633. required_approving_review_count: {
  10634. type: "integer"
  10635. }
  10636. },
  10637. url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  10638. },
  10639. updateProtectedBranchRequiredStatusChecks: {
  10640. method: "PATCH",
  10641. params: {
  10642. branch: {
  10643. required: true,
  10644. type: "string"
  10645. },
  10646. contexts: {
  10647. type: "string[]"
  10648. },
  10649. owner: {
  10650. required: true,
  10651. type: "string"
  10652. },
  10653. repo: {
  10654. required: true,
  10655. type: "string"
  10656. },
  10657. strict: {
  10658. type: "boolean"
  10659. }
  10660. },
  10661. url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  10662. },
  10663. updateRelease: {
  10664. method: "PATCH",
  10665. params: {
  10666. body: {
  10667. type: "string"
  10668. },
  10669. draft: {
  10670. type: "boolean"
  10671. },
  10672. name: {
  10673. type: "string"
  10674. },
  10675. owner: {
  10676. required: true,
  10677. type: "string"
  10678. },
  10679. prerelease: {
  10680. type: "boolean"
  10681. },
  10682. release_id: {
  10683. required: true,
  10684. type: "integer"
  10685. },
  10686. repo: {
  10687. required: true,
  10688. type: "string"
  10689. },
  10690. tag_name: {
  10691. type: "string"
  10692. },
  10693. target_commitish: {
  10694. type: "string"
  10695. }
  10696. },
  10697. url: "/repos/:owner/:repo/releases/:release_id"
  10698. },
  10699. updateReleaseAsset: {
  10700. method: "PATCH",
  10701. params: {
  10702. asset_id: {
  10703. required: true,
  10704. type: "integer"
  10705. },
  10706. label: {
  10707. type: "string"
  10708. },
  10709. name: {
  10710. type: "string"
  10711. },
  10712. owner: {
  10713. required: true,
  10714. type: "string"
  10715. },
  10716. repo: {
  10717. required: true,
  10718. type: "string"
  10719. }
  10720. },
  10721. url: "/repos/:owner/:repo/releases/assets/:asset_id"
  10722. },
  10723. uploadReleaseAsset: {
  10724. method: "POST",
  10725. params: {
  10726. data: {
  10727. mapTo: "data",
  10728. required: true,
  10729. type: "string | object"
  10730. },
  10731. file: {
  10732. alias: "data",
  10733. deprecated: true,
  10734. type: "string | object"
  10735. },
  10736. headers: {
  10737. required: true,
  10738. type: "object"
  10739. },
  10740. "headers.content-length": {
  10741. required: true,
  10742. type: "integer"
  10743. },
  10744. "headers.content-type": {
  10745. required: true,
  10746. type: "string"
  10747. },
  10748. label: {
  10749. type: "string"
  10750. },
  10751. name: {
  10752. required: true,
  10753. type: "string"
  10754. },
  10755. url: {
  10756. required: true,
  10757. type: "string"
  10758. }
  10759. },
  10760. url: ":url"
  10761. }
  10762. },
  10763. search: {
  10764. code: {
  10765. method: "GET",
  10766. params: {
  10767. order: {
  10768. enum: ["desc", "asc"],
  10769. type: "string"
  10770. },
  10771. page: {
  10772. type: "integer"
  10773. },
  10774. per_page: {
  10775. type: "integer"
  10776. },
  10777. q: {
  10778. required: true,
  10779. type: "string"
  10780. },
  10781. sort: {
  10782. enum: ["indexed"],
  10783. type: "string"
  10784. }
  10785. },
  10786. url: "/search/code"
  10787. },
  10788. commits: {
  10789. headers: {
  10790. accept: "application/vnd.github.cloak-preview+json"
  10791. },
  10792. method: "GET",
  10793. params: {
  10794. order: {
  10795. enum: ["desc", "asc"],
  10796. type: "string"
  10797. },
  10798. page: {
  10799. type: "integer"
  10800. },
  10801. per_page: {
  10802. type: "integer"
  10803. },
  10804. q: {
  10805. required: true,
  10806. type: "string"
  10807. },
  10808. sort: {
  10809. enum: ["author-date", "committer-date"],
  10810. type: "string"
  10811. }
  10812. },
  10813. url: "/search/commits"
  10814. },
  10815. issues: {
  10816. deprecated: "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)",
  10817. method: "GET",
  10818. params: {
  10819. order: {
  10820. enum: ["desc", "asc"],
  10821. type: "string"
  10822. },
  10823. page: {
  10824. type: "integer"
  10825. },
  10826. per_page: {
  10827. type: "integer"
  10828. },
  10829. q: {
  10830. required: true,
  10831. type: "string"
  10832. },
  10833. sort: {
  10834. enum: ["comments", "reactions", "reactions-+1", "reactions--1", "reactions-smile", "reactions-thinking_face", "reactions-heart", "reactions-tada", "interactions", "created", "updated"],
  10835. type: "string"
  10836. }
  10837. },
  10838. url: "/search/issues"
  10839. },
  10840. issuesAndPullRequests: {
  10841. method: "GET",
  10842. params: {
  10843. order: {
  10844. enum: ["desc", "asc"],
  10845. type: "string"
  10846. },
  10847. page: {
  10848. type: "integer"
  10849. },
  10850. per_page: {
  10851. type: "integer"
  10852. },
  10853. q: {
  10854. required: true,
  10855. type: "string"
  10856. },
  10857. sort: {
  10858. enum: ["comments", "reactions", "reactions-+1", "reactions--1", "reactions-smile", "reactions-thinking_face", "reactions-heart", "reactions-tada", "interactions", "created", "updated"],
  10859. type: "string"
  10860. }
  10861. },
  10862. url: "/search/issues"
  10863. },
  10864. labels: {
  10865. method: "GET",
  10866. params: {
  10867. order: {
  10868. enum: ["desc", "asc"],
  10869. type: "string"
  10870. },
  10871. q: {
  10872. required: true,
  10873. type: "string"
  10874. },
  10875. repository_id: {
  10876. required: true,
  10877. type: "integer"
  10878. },
  10879. sort: {
  10880. enum: ["created", "updated"],
  10881. type: "string"
  10882. }
  10883. },
  10884. url: "/search/labels"
  10885. },
  10886. repos: {
  10887. method: "GET",
  10888. params: {
  10889. order: {
  10890. enum: ["desc", "asc"],
  10891. type: "string"
  10892. },
  10893. page: {
  10894. type: "integer"
  10895. },
  10896. per_page: {
  10897. type: "integer"
  10898. },
  10899. q: {
  10900. required: true,
  10901. type: "string"
  10902. },
  10903. sort: {
  10904. enum: ["stars", "forks", "help-wanted-issues", "updated"],
  10905. type: "string"
  10906. }
  10907. },
  10908. url: "/search/repositories"
  10909. },
  10910. topics: {
  10911. method: "GET",
  10912. params: {
  10913. q: {
  10914. required: true,
  10915. type: "string"
  10916. }
  10917. },
  10918. url: "/search/topics"
  10919. },
  10920. users: {
  10921. method: "GET",
  10922. params: {
  10923. order: {
  10924. enum: ["desc", "asc"],
  10925. type: "string"
  10926. },
  10927. page: {
  10928. type: "integer"
  10929. },
  10930. per_page: {
  10931. type: "integer"
  10932. },
  10933. q: {
  10934. required: true,
  10935. type: "string"
  10936. },
  10937. sort: {
  10938. enum: ["followers", "repositories", "joined"],
  10939. type: "string"
  10940. }
  10941. },
  10942. url: "/search/users"
  10943. }
  10944. },
  10945. teams: {
  10946. addMember: {
  10947. deprecated: "octokit.teams.addMember() has been renamed to octokit.teams.addMemberLegacy() (2020-01-16)",
  10948. method: "PUT",
  10949. params: {
  10950. team_id: {
  10951. required: true,
  10952. type: "integer"
  10953. },
  10954. username: {
  10955. required: true,
  10956. type: "string"
  10957. }
  10958. },
  10959. url: "/teams/:team_id/members/:username"
  10960. },
  10961. addMemberLegacy: {
  10962. deprecated: "octokit.teams.addMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy",
  10963. method: "PUT",
  10964. params: {
  10965. team_id: {
  10966. required: true,
  10967. type: "integer"
  10968. },
  10969. username: {
  10970. required: true,
  10971. type: "string"
  10972. }
  10973. },
  10974. url: "/teams/:team_id/members/:username"
  10975. },
  10976. addOrUpdateMembership: {
  10977. deprecated: "octokit.teams.addOrUpdateMembership() has been renamed to octokit.teams.addOrUpdateMembershipLegacy() (2020-01-16)",
  10978. method: "PUT",
  10979. params: {
  10980. role: {
  10981. enum: ["member", "maintainer"],
  10982. type: "string"
  10983. },
  10984. team_id: {
  10985. required: true,
  10986. type: "integer"
  10987. },
  10988. username: {
  10989. required: true,
  10990. type: "string"
  10991. }
  10992. },
  10993. url: "/teams/:team_id/memberships/:username"
  10994. },
  10995. addOrUpdateMembershipInOrg: {
  10996. method: "PUT",
  10997. params: {
  10998. org: {
  10999. required: true,
  11000. type: "string"
  11001. },
  11002. role: {
  11003. enum: ["member", "maintainer"],
  11004. type: "string"
  11005. },
  11006. team_slug: {
  11007. required: true,
  11008. type: "string"
  11009. },
  11010. username: {
  11011. required: true,
  11012. type: "string"
  11013. }
  11014. },
  11015. url: "/orgs/:org/teams/:team_slug/memberships/:username"
  11016. },
  11017. addOrUpdateMembershipLegacy: {
  11018. deprecated: "octokit.teams.addOrUpdateMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy",
  11019. method: "PUT",
  11020. params: {
  11021. role: {
  11022. enum: ["member", "maintainer"],
  11023. type: "string"
  11024. },
  11025. team_id: {
  11026. required: true,
  11027. type: "integer"
  11028. },
  11029. username: {
  11030. required: true,
  11031. type: "string"
  11032. }
  11033. },
  11034. url: "/teams/:team_id/memberships/:username"
  11035. },
  11036. addOrUpdateProject: {
  11037. deprecated: "octokit.teams.addOrUpdateProject() has been renamed to octokit.teams.addOrUpdateProjectLegacy() (2020-01-16)",
  11038. headers: {
  11039. accept: "application/vnd.github.inertia-preview+json"
  11040. },
  11041. method: "PUT",
  11042. params: {
  11043. permission: {
  11044. enum: ["read", "write", "admin"],
  11045. type: "string"
  11046. },
  11047. project_id: {
  11048. required: true,
  11049. type: "integer"
  11050. },
  11051. team_id: {
  11052. required: true,
  11053. type: "integer"
  11054. }
  11055. },
  11056. url: "/teams/:team_id/projects/:project_id"
  11057. },
  11058. addOrUpdateProjectInOrg: {
  11059. headers: {
  11060. accept: "application/vnd.github.inertia-preview+json"
  11061. },
  11062. method: "PUT",
  11063. params: {
  11064. org: {
  11065. required: true,
  11066. type: "string"
  11067. },
  11068. permission: {
  11069. enum: ["read", "write", "admin"],
  11070. type: "string"
  11071. },
  11072. project_id: {
  11073. required: true,
  11074. type: "integer"
  11075. },
  11076. team_slug: {
  11077. required: true,
  11078. type: "string"
  11079. }
  11080. },
  11081. url: "/orgs/:org/teams/:team_slug/projects/:project_id"
  11082. },
  11083. addOrUpdateProjectLegacy: {
  11084. deprecated: "octokit.teams.addOrUpdateProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy",
  11085. headers: {
  11086. accept: "application/vnd.github.inertia-preview+json"
  11087. },
  11088. method: "PUT",
  11089. params: {
  11090. permission: {
  11091. enum: ["read", "write", "admin"],
  11092. type: "string"
  11093. },
  11094. project_id: {
  11095. required: true,
  11096. type: "integer"
  11097. },
  11098. team_id: {
  11099. required: true,
  11100. type: "integer"
  11101. }
  11102. },
  11103. url: "/teams/:team_id/projects/:project_id"
  11104. },
  11105. addOrUpdateRepo: {
  11106. deprecated: "octokit.teams.addOrUpdateRepo() has been renamed to octokit.teams.addOrUpdateRepoLegacy() (2020-01-16)",
  11107. method: "PUT",
  11108. params: {
  11109. owner: {
  11110. required: true,
  11111. type: "string"
  11112. },
  11113. permission: {
  11114. enum: ["pull", "push", "admin"],
  11115. type: "string"
  11116. },
  11117. repo: {
  11118. required: true,
  11119. type: "string"
  11120. },
  11121. team_id: {
  11122. required: true,
  11123. type: "integer"
  11124. }
  11125. },
  11126. url: "/teams/:team_id/repos/:owner/:repo"
  11127. },
  11128. addOrUpdateRepoInOrg: {
  11129. method: "PUT",
  11130. params: {
  11131. org: {
  11132. required: true,
  11133. type: "string"
  11134. },
  11135. owner: {
  11136. required: true,
  11137. type: "string"
  11138. },
  11139. permission: {
  11140. enum: ["pull", "push", "admin"],
  11141. type: "string"
  11142. },
  11143. repo: {
  11144. required: true,
  11145. type: "string"
  11146. },
  11147. team_slug: {
  11148. required: true,
  11149. type: "string"
  11150. }
  11151. },
  11152. url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"
  11153. },
  11154. addOrUpdateRepoLegacy: {
  11155. deprecated: "octokit.teams.addOrUpdateRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy",
  11156. method: "PUT",
  11157. params: {
  11158. owner: {
  11159. required: true,
  11160. type: "string"
  11161. },
  11162. permission: {
  11163. enum: ["pull", "push", "admin"],
  11164. type: "string"
  11165. },
  11166. repo: {
  11167. required: true,
  11168. type: "string"
  11169. },
  11170. team_id: {
  11171. required: true,
  11172. type: "integer"
  11173. }
  11174. },
  11175. url: "/teams/:team_id/repos/:owner/:repo"
  11176. },
  11177. checkManagesRepo: {
  11178. deprecated: "octokit.teams.checkManagesRepo() has been renamed to octokit.teams.checkManagesRepoLegacy() (2020-01-16)",
  11179. method: "GET",
  11180. params: {
  11181. owner: {
  11182. required: true,
  11183. type: "string"
  11184. },
  11185. repo: {
  11186. required: true,
  11187. type: "string"
  11188. },
  11189. team_id: {
  11190. required: true,
  11191. type: "integer"
  11192. }
  11193. },
  11194. url: "/teams/:team_id/repos/:owner/:repo"
  11195. },
  11196. checkManagesRepoInOrg: {
  11197. method: "GET",
  11198. params: {
  11199. org: {
  11200. required: true,
  11201. type: "string"
  11202. },
  11203. owner: {
  11204. required: true,
  11205. type: "string"
  11206. },
  11207. repo: {
  11208. required: true,
  11209. type: "string"
  11210. },
  11211. team_slug: {
  11212. required: true,
  11213. type: "string"
  11214. }
  11215. },
  11216. url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"
  11217. },
  11218. checkManagesRepoLegacy: {
  11219. deprecated: "octokit.teams.checkManagesRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy",
  11220. method: "GET",
  11221. params: {
  11222. owner: {
  11223. required: true,
  11224. type: "string"
  11225. },
  11226. repo: {
  11227. required: true,
  11228. type: "string"
  11229. },
  11230. team_id: {
  11231. required: true,
  11232. type: "integer"
  11233. }
  11234. },
  11235. url: "/teams/:team_id/repos/:owner/:repo"
  11236. },
  11237. create: {
  11238. method: "POST",
  11239. params: {
  11240. description: {
  11241. type: "string"
  11242. },
  11243. maintainers: {
  11244. type: "string[]"
  11245. },
  11246. name: {
  11247. required: true,
  11248. type: "string"
  11249. },
  11250. org: {
  11251. required: true,
  11252. type: "string"
  11253. },
  11254. parent_team_id: {
  11255. type: "integer"
  11256. },
  11257. permission: {
  11258. enum: ["pull", "push", "admin"],
  11259. type: "string"
  11260. },
  11261. privacy: {
  11262. enum: ["secret", "closed"],
  11263. type: "string"
  11264. },
  11265. repo_names: {
  11266. type: "string[]"
  11267. }
  11268. },
  11269. url: "/orgs/:org/teams"
  11270. },
  11271. createDiscussion: {
  11272. deprecated: "octokit.teams.createDiscussion() has been renamed to octokit.teams.createDiscussionLegacy() (2020-01-16)",
  11273. method: "POST",
  11274. params: {
  11275. body: {
  11276. required: true,
  11277. type: "string"
  11278. },
  11279. private: {
  11280. type: "boolean"
  11281. },
  11282. team_id: {
  11283. required: true,
  11284. type: "integer"
  11285. },
  11286. title: {
  11287. required: true,
  11288. type: "string"
  11289. }
  11290. },
  11291. url: "/teams/:team_id/discussions"
  11292. },
  11293. createDiscussionComment: {
  11294. deprecated: "octokit.teams.createDiscussionComment() has been renamed to octokit.teams.createDiscussionCommentLegacy() (2020-01-16)",
  11295. method: "POST",
  11296. params: {
  11297. body: {
  11298. required: true,
  11299. type: "string"
  11300. },
  11301. discussion_number: {
  11302. required: true,
  11303. type: "integer"
  11304. },
  11305. team_id: {
  11306. required: true,
  11307. type: "integer"
  11308. }
  11309. },
  11310. url: "/teams/:team_id/discussions/:discussion_number/comments"
  11311. },
  11312. createDiscussionCommentInOrg: {
  11313. method: "POST",
  11314. params: {
  11315. body: {
  11316. required: true,
  11317. type: "string"
  11318. },
  11319. discussion_number: {
  11320. required: true,
  11321. type: "integer"
  11322. },
  11323. org: {
  11324. required: true,
  11325. type: "string"
  11326. },
  11327. team_slug: {
  11328. required: true,
  11329. type: "string"
  11330. }
  11331. },
  11332. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"
  11333. },
  11334. createDiscussionCommentLegacy: {
  11335. deprecated: "octokit.teams.createDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy",
  11336. method: "POST",
  11337. params: {
  11338. body: {
  11339. required: true,
  11340. type: "string"
  11341. },
  11342. discussion_number: {
  11343. required: true,
  11344. type: "integer"
  11345. },
  11346. team_id: {
  11347. required: true,
  11348. type: "integer"
  11349. }
  11350. },
  11351. url: "/teams/:team_id/discussions/:discussion_number/comments"
  11352. },
  11353. createDiscussionInOrg: {
  11354. method: "POST",
  11355. params: {
  11356. body: {
  11357. required: true,
  11358. type: "string"
  11359. },
  11360. org: {
  11361. required: true,
  11362. type: "string"
  11363. },
  11364. private: {
  11365. type: "boolean"
  11366. },
  11367. team_slug: {
  11368. required: true,
  11369. type: "string"
  11370. },
  11371. title: {
  11372. required: true,
  11373. type: "string"
  11374. }
  11375. },
  11376. url: "/orgs/:org/teams/:team_slug/discussions"
  11377. },
  11378. createDiscussionLegacy: {
  11379. deprecated: "octokit.teams.createDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy",
  11380. method: "POST",
  11381. params: {
  11382. body: {
  11383. required: true,
  11384. type: "string"
  11385. },
  11386. private: {
  11387. type: "boolean"
  11388. },
  11389. team_id: {
  11390. required: true,
  11391. type: "integer"
  11392. },
  11393. title: {
  11394. required: true,
  11395. type: "string"
  11396. }
  11397. },
  11398. url: "/teams/:team_id/discussions"
  11399. },
  11400. delete: {
  11401. deprecated: "octokit.teams.delete() has been renamed to octokit.teams.deleteLegacy() (2020-01-16)",
  11402. method: "DELETE",
  11403. params: {
  11404. team_id: {
  11405. required: true,
  11406. type: "integer"
  11407. }
  11408. },
  11409. url: "/teams/:team_id"
  11410. },
  11411. deleteDiscussion: {
  11412. deprecated: "octokit.teams.deleteDiscussion() has been renamed to octokit.teams.deleteDiscussionLegacy() (2020-01-16)",
  11413. method: "DELETE",
  11414. params: {
  11415. discussion_number: {
  11416. required: true,
  11417. type: "integer"
  11418. },
  11419. team_id: {
  11420. required: true,
  11421. type: "integer"
  11422. }
  11423. },
  11424. url: "/teams/:team_id/discussions/:discussion_number"
  11425. },
  11426. deleteDiscussionComment: {
  11427. deprecated: "octokit.teams.deleteDiscussionComment() has been renamed to octokit.teams.deleteDiscussionCommentLegacy() (2020-01-16)",
  11428. method: "DELETE",
  11429. params: {
  11430. comment_number: {
  11431. required: true,
  11432. type: "integer"
  11433. },
  11434. discussion_number: {
  11435. required: true,
  11436. type: "integer"
  11437. },
  11438. team_id: {
  11439. required: true,
  11440. type: "integer"
  11441. }
  11442. },
  11443. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  11444. },
  11445. deleteDiscussionCommentInOrg: {
  11446. method: "DELETE",
  11447. params: {
  11448. comment_number: {
  11449. required: true,
  11450. type: "integer"
  11451. },
  11452. discussion_number: {
  11453. required: true,
  11454. type: "integer"
  11455. },
  11456. org: {
  11457. required: true,
  11458. type: "string"
  11459. },
  11460. team_slug: {
  11461. required: true,
  11462. type: "string"
  11463. }
  11464. },
  11465. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"
  11466. },
  11467. deleteDiscussionCommentLegacy: {
  11468. deprecated: "octokit.teams.deleteDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy",
  11469. method: "DELETE",
  11470. params: {
  11471. comment_number: {
  11472. required: true,
  11473. type: "integer"
  11474. },
  11475. discussion_number: {
  11476. required: true,
  11477. type: "integer"
  11478. },
  11479. team_id: {
  11480. required: true,
  11481. type: "integer"
  11482. }
  11483. },
  11484. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  11485. },
  11486. deleteDiscussionInOrg: {
  11487. method: "DELETE",
  11488. params: {
  11489. discussion_number: {
  11490. required: true,
  11491. type: "integer"
  11492. },
  11493. org: {
  11494. required: true,
  11495. type: "string"
  11496. },
  11497. team_slug: {
  11498. required: true,
  11499. type: "string"
  11500. }
  11501. },
  11502. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"
  11503. },
  11504. deleteDiscussionLegacy: {
  11505. deprecated: "octokit.teams.deleteDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy",
  11506. method: "DELETE",
  11507. params: {
  11508. discussion_number: {
  11509. required: true,
  11510. type: "integer"
  11511. },
  11512. team_id: {
  11513. required: true,
  11514. type: "integer"
  11515. }
  11516. },
  11517. url: "/teams/:team_id/discussions/:discussion_number"
  11518. },
  11519. deleteInOrg: {
  11520. method: "DELETE",
  11521. params: {
  11522. org: {
  11523. required: true,
  11524. type: "string"
  11525. },
  11526. team_slug: {
  11527. required: true,
  11528. type: "string"
  11529. }
  11530. },
  11531. url: "/orgs/:org/teams/:team_slug"
  11532. },
  11533. deleteLegacy: {
  11534. deprecated: "octokit.teams.deleteLegacy() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy",
  11535. method: "DELETE",
  11536. params: {
  11537. team_id: {
  11538. required: true,
  11539. type: "integer"
  11540. }
  11541. },
  11542. url: "/teams/:team_id"
  11543. },
  11544. get: {
  11545. deprecated: "octokit.teams.get() has been renamed to octokit.teams.getLegacy() (2020-01-16)",
  11546. method: "GET",
  11547. params: {
  11548. team_id: {
  11549. required: true,
  11550. type: "integer"
  11551. }
  11552. },
  11553. url: "/teams/:team_id"
  11554. },
  11555. getByName: {
  11556. method: "GET",
  11557. params: {
  11558. org: {
  11559. required: true,
  11560. type: "string"
  11561. },
  11562. team_slug: {
  11563. required: true,
  11564. type: "string"
  11565. }
  11566. },
  11567. url: "/orgs/:org/teams/:team_slug"
  11568. },
  11569. getDiscussion: {
  11570. deprecated: "octokit.teams.getDiscussion() has been renamed to octokit.teams.getDiscussionLegacy() (2020-01-16)",
  11571. method: "GET",
  11572. params: {
  11573. discussion_number: {
  11574. required: true,
  11575. type: "integer"
  11576. },
  11577. team_id: {
  11578. required: true,
  11579. type: "integer"
  11580. }
  11581. },
  11582. url: "/teams/:team_id/discussions/:discussion_number"
  11583. },
  11584. getDiscussionComment: {
  11585. deprecated: "octokit.teams.getDiscussionComment() has been renamed to octokit.teams.getDiscussionCommentLegacy() (2020-01-16)",
  11586. method: "GET",
  11587. params: {
  11588. comment_number: {
  11589. required: true,
  11590. type: "integer"
  11591. },
  11592. discussion_number: {
  11593. required: true,
  11594. type: "integer"
  11595. },
  11596. team_id: {
  11597. required: true,
  11598. type: "integer"
  11599. }
  11600. },
  11601. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  11602. },
  11603. getDiscussionCommentInOrg: {
  11604. method: "GET",
  11605. params: {
  11606. comment_number: {
  11607. required: true,
  11608. type: "integer"
  11609. },
  11610. discussion_number: {
  11611. required: true,
  11612. type: "integer"
  11613. },
  11614. org: {
  11615. required: true,
  11616. type: "string"
  11617. },
  11618. team_slug: {
  11619. required: true,
  11620. type: "string"
  11621. }
  11622. },
  11623. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"
  11624. },
  11625. getDiscussionCommentLegacy: {
  11626. deprecated: "octokit.teams.getDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy",
  11627. method: "GET",
  11628. params: {
  11629. comment_number: {
  11630. required: true,
  11631. type: "integer"
  11632. },
  11633. discussion_number: {
  11634. required: true,
  11635. type: "integer"
  11636. },
  11637. team_id: {
  11638. required: true,
  11639. type: "integer"
  11640. }
  11641. },
  11642. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  11643. },
  11644. getDiscussionInOrg: {
  11645. method: "GET",
  11646. params: {
  11647. discussion_number: {
  11648. required: true,
  11649. type: "integer"
  11650. },
  11651. org: {
  11652. required: true,
  11653. type: "string"
  11654. },
  11655. team_slug: {
  11656. required: true,
  11657. type: "string"
  11658. }
  11659. },
  11660. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"
  11661. },
  11662. getDiscussionLegacy: {
  11663. deprecated: "octokit.teams.getDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy",
  11664. method: "GET",
  11665. params: {
  11666. discussion_number: {
  11667. required: true,
  11668. type: "integer"
  11669. },
  11670. team_id: {
  11671. required: true,
  11672. type: "integer"
  11673. }
  11674. },
  11675. url: "/teams/:team_id/discussions/:discussion_number"
  11676. },
  11677. getLegacy: {
  11678. deprecated: "octokit.teams.getLegacy() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy",
  11679. method: "GET",
  11680. params: {
  11681. team_id: {
  11682. required: true,
  11683. type: "integer"
  11684. }
  11685. },
  11686. url: "/teams/:team_id"
  11687. },
  11688. getMember: {
  11689. deprecated: "octokit.teams.getMember() has been renamed to octokit.teams.getMemberLegacy() (2020-01-16)",
  11690. method: "GET",
  11691. params: {
  11692. team_id: {
  11693. required: true,
  11694. type: "integer"
  11695. },
  11696. username: {
  11697. required: true,
  11698. type: "string"
  11699. }
  11700. },
  11701. url: "/teams/:team_id/members/:username"
  11702. },
  11703. getMemberLegacy: {
  11704. deprecated: "octokit.teams.getMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy",
  11705. method: "GET",
  11706. params: {
  11707. team_id: {
  11708. required: true,
  11709. type: "integer"
  11710. },
  11711. username: {
  11712. required: true,
  11713. type: "string"
  11714. }
  11715. },
  11716. url: "/teams/:team_id/members/:username"
  11717. },
  11718. getMembership: {
  11719. deprecated: "octokit.teams.getMembership() has been renamed to octokit.teams.getMembershipLegacy() (2020-01-16)",
  11720. method: "GET",
  11721. params: {
  11722. team_id: {
  11723. required: true,
  11724. type: "integer"
  11725. },
  11726. username: {
  11727. required: true,
  11728. type: "string"
  11729. }
  11730. },
  11731. url: "/teams/:team_id/memberships/:username"
  11732. },
  11733. getMembershipInOrg: {
  11734. method: "GET",
  11735. params: {
  11736. org: {
  11737. required: true,
  11738. type: "string"
  11739. },
  11740. team_slug: {
  11741. required: true,
  11742. type: "string"
  11743. },
  11744. username: {
  11745. required: true,
  11746. type: "string"
  11747. }
  11748. },
  11749. url: "/orgs/:org/teams/:team_slug/memberships/:username"
  11750. },
  11751. getMembershipLegacy: {
  11752. deprecated: "octokit.teams.getMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy",
  11753. method: "GET",
  11754. params: {
  11755. team_id: {
  11756. required: true,
  11757. type: "integer"
  11758. },
  11759. username: {
  11760. required: true,
  11761. type: "string"
  11762. }
  11763. },
  11764. url: "/teams/:team_id/memberships/:username"
  11765. },
  11766. list: {
  11767. method: "GET",
  11768. params: {
  11769. org: {
  11770. required: true,
  11771. type: "string"
  11772. },
  11773. page: {
  11774. type: "integer"
  11775. },
  11776. per_page: {
  11777. type: "integer"
  11778. }
  11779. },
  11780. url: "/orgs/:org/teams"
  11781. },
  11782. listChild: {
  11783. deprecated: "octokit.teams.listChild() has been renamed to octokit.teams.listChildLegacy() (2020-01-16)",
  11784. method: "GET",
  11785. params: {
  11786. page: {
  11787. type: "integer"
  11788. },
  11789. per_page: {
  11790. type: "integer"
  11791. },
  11792. team_id: {
  11793. required: true,
  11794. type: "integer"
  11795. }
  11796. },
  11797. url: "/teams/:team_id/teams"
  11798. },
  11799. listChildInOrg: {
  11800. method: "GET",
  11801. params: {
  11802. org: {
  11803. required: true,
  11804. type: "string"
  11805. },
  11806. page: {
  11807. type: "integer"
  11808. },
  11809. per_page: {
  11810. type: "integer"
  11811. },
  11812. team_slug: {
  11813. required: true,
  11814. type: "string"
  11815. }
  11816. },
  11817. url: "/orgs/:org/teams/:team_slug/teams"
  11818. },
  11819. listChildLegacy: {
  11820. deprecated: "octokit.teams.listChildLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy",
  11821. method: "GET",
  11822. params: {
  11823. page: {
  11824. type: "integer"
  11825. },
  11826. per_page: {
  11827. type: "integer"
  11828. },
  11829. team_id: {
  11830. required: true,
  11831. type: "integer"
  11832. }
  11833. },
  11834. url: "/teams/:team_id/teams"
  11835. },
  11836. listDiscussionComments: {
  11837. deprecated: "octokit.teams.listDiscussionComments() has been renamed to octokit.teams.listDiscussionCommentsLegacy() (2020-01-16)",
  11838. method: "GET",
  11839. params: {
  11840. direction: {
  11841. enum: ["asc", "desc"],
  11842. type: "string"
  11843. },
  11844. discussion_number: {
  11845. required: true,
  11846. type: "integer"
  11847. },
  11848. page: {
  11849. type: "integer"
  11850. },
  11851. per_page: {
  11852. type: "integer"
  11853. },
  11854. team_id: {
  11855. required: true,
  11856. type: "integer"
  11857. }
  11858. },
  11859. url: "/teams/:team_id/discussions/:discussion_number/comments"
  11860. },
  11861. listDiscussionCommentsInOrg: {
  11862. method: "GET",
  11863. params: {
  11864. direction: {
  11865. enum: ["asc", "desc"],
  11866. type: "string"
  11867. },
  11868. discussion_number: {
  11869. required: true,
  11870. type: "integer"
  11871. },
  11872. org: {
  11873. required: true,
  11874. type: "string"
  11875. },
  11876. page: {
  11877. type: "integer"
  11878. },
  11879. per_page: {
  11880. type: "integer"
  11881. },
  11882. team_slug: {
  11883. required: true,
  11884. type: "string"
  11885. }
  11886. },
  11887. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"
  11888. },
  11889. listDiscussionCommentsLegacy: {
  11890. deprecated: "octokit.teams.listDiscussionCommentsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy",
  11891. method: "GET",
  11892. params: {
  11893. direction: {
  11894. enum: ["asc", "desc"],
  11895. type: "string"
  11896. },
  11897. discussion_number: {
  11898. required: true,
  11899. type: "integer"
  11900. },
  11901. page: {
  11902. type: "integer"
  11903. },
  11904. per_page: {
  11905. type: "integer"
  11906. },
  11907. team_id: {
  11908. required: true,
  11909. type: "integer"
  11910. }
  11911. },
  11912. url: "/teams/:team_id/discussions/:discussion_number/comments"
  11913. },
  11914. listDiscussions: {
  11915. deprecated: "octokit.teams.listDiscussions() has been renamed to octokit.teams.listDiscussionsLegacy() (2020-01-16)",
  11916. method: "GET",
  11917. params: {
  11918. direction: {
  11919. enum: ["asc", "desc"],
  11920. type: "string"
  11921. },
  11922. page: {
  11923. type: "integer"
  11924. },
  11925. per_page: {
  11926. type: "integer"
  11927. },
  11928. team_id: {
  11929. required: true,
  11930. type: "integer"
  11931. }
  11932. },
  11933. url: "/teams/:team_id/discussions"
  11934. },
  11935. listDiscussionsInOrg: {
  11936. method: "GET",
  11937. params: {
  11938. direction: {
  11939. enum: ["asc", "desc"],
  11940. type: "string"
  11941. },
  11942. org: {
  11943. required: true,
  11944. type: "string"
  11945. },
  11946. page: {
  11947. type: "integer"
  11948. },
  11949. per_page: {
  11950. type: "integer"
  11951. },
  11952. team_slug: {
  11953. required: true,
  11954. type: "string"
  11955. }
  11956. },
  11957. url: "/orgs/:org/teams/:team_slug/discussions"
  11958. },
  11959. listDiscussionsLegacy: {
  11960. deprecated: "octokit.teams.listDiscussionsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy",
  11961. method: "GET",
  11962. params: {
  11963. direction: {
  11964. enum: ["asc", "desc"],
  11965. type: "string"
  11966. },
  11967. page: {
  11968. type: "integer"
  11969. },
  11970. per_page: {
  11971. type: "integer"
  11972. },
  11973. team_id: {
  11974. required: true,
  11975. type: "integer"
  11976. }
  11977. },
  11978. url: "/teams/:team_id/discussions"
  11979. },
  11980. listForAuthenticatedUser: {
  11981. method: "GET",
  11982. params: {
  11983. page: {
  11984. type: "integer"
  11985. },
  11986. per_page: {
  11987. type: "integer"
  11988. }
  11989. },
  11990. url: "/user/teams"
  11991. },
  11992. listMembers: {
  11993. deprecated: "octokit.teams.listMembers() has been renamed to octokit.teams.listMembersLegacy() (2020-01-16)",
  11994. method: "GET",
  11995. params: {
  11996. page: {
  11997. type: "integer"
  11998. },
  11999. per_page: {
  12000. type: "integer"
  12001. },
  12002. role: {
  12003. enum: ["member", "maintainer", "all"],
  12004. type: "string"
  12005. },
  12006. team_id: {
  12007. required: true,
  12008. type: "integer"
  12009. }
  12010. },
  12011. url: "/teams/:team_id/members"
  12012. },
  12013. listMembersInOrg: {
  12014. method: "GET",
  12015. params: {
  12016. org: {
  12017. required: true,
  12018. type: "string"
  12019. },
  12020. page: {
  12021. type: "integer"
  12022. },
  12023. per_page: {
  12024. type: "integer"
  12025. },
  12026. role: {
  12027. enum: ["member", "maintainer", "all"],
  12028. type: "string"
  12029. },
  12030. team_slug: {
  12031. required: true,
  12032. type: "string"
  12033. }
  12034. },
  12035. url: "/orgs/:org/teams/:team_slug/members"
  12036. },
  12037. listMembersLegacy: {
  12038. deprecated: "octokit.teams.listMembersLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy",
  12039. method: "GET",
  12040. params: {
  12041. page: {
  12042. type: "integer"
  12043. },
  12044. per_page: {
  12045. type: "integer"
  12046. },
  12047. role: {
  12048. enum: ["member", "maintainer", "all"],
  12049. type: "string"
  12050. },
  12051. team_id: {
  12052. required: true,
  12053. type: "integer"
  12054. }
  12055. },
  12056. url: "/teams/:team_id/members"
  12057. },
  12058. listPendingInvitations: {
  12059. deprecated: "octokit.teams.listPendingInvitations() has been renamed to octokit.teams.listPendingInvitationsLegacy() (2020-01-16)",
  12060. method: "GET",
  12061. params: {
  12062. page: {
  12063. type: "integer"
  12064. },
  12065. per_page: {
  12066. type: "integer"
  12067. },
  12068. team_id: {
  12069. required: true,
  12070. type: "integer"
  12071. }
  12072. },
  12073. url: "/teams/:team_id/invitations"
  12074. },
  12075. listPendingInvitationsInOrg: {
  12076. method: "GET",
  12077. params: {
  12078. org: {
  12079. required: true,
  12080. type: "string"
  12081. },
  12082. page: {
  12083. type: "integer"
  12084. },
  12085. per_page: {
  12086. type: "integer"
  12087. },
  12088. team_slug: {
  12089. required: true,
  12090. type: "string"
  12091. }
  12092. },
  12093. url: "/orgs/:org/teams/:team_slug/invitations"
  12094. },
  12095. listPendingInvitationsLegacy: {
  12096. deprecated: "octokit.teams.listPendingInvitationsLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy",
  12097. method: "GET",
  12098. params: {
  12099. page: {
  12100. type: "integer"
  12101. },
  12102. per_page: {
  12103. type: "integer"
  12104. },
  12105. team_id: {
  12106. required: true,
  12107. type: "integer"
  12108. }
  12109. },
  12110. url: "/teams/:team_id/invitations"
  12111. },
  12112. listProjects: {
  12113. deprecated: "octokit.teams.listProjects() has been renamed to octokit.teams.listProjectsLegacy() (2020-01-16)",
  12114. headers: {
  12115. accept: "application/vnd.github.inertia-preview+json"
  12116. },
  12117. method: "GET",
  12118. params: {
  12119. page: {
  12120. type: "integer"
  12121. },
  12122. per_page: {
  12123. type: "integer"
  12124. },
  12125. team_id: {
  12126. required: true,
  12127. type: "integer"
  12128. }
  12129. },
  12130. url: "/teams/:team_id/projects"
  12131. },
  12132. listProjectsInOrg: {
  12133. headers: {
  12134. accept: "application/vnd.github.inertia-preview+json"
  12135. },
  12136. method: "GET",
  12137. params: {
  12138. org: {
  12139. required: true,
  12140. type: "string"
  12141. },
  12142. page: {
  12143. type: "integer"
  12144. },
  12145. per_page: {
  12146. type: "integer"
  12147. },
  12148. team_slug: {
  12149. required: true,
  12150. type: "string"
  12151. }
  12152. },
  12153. url: "/orgs/:org/teams/:team_slug/projects"
  12154. },
  12155. listProjectsLegacy: {
  12156. deprecated: "octokit.teams.listProjectsLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy",
  12157. headers: {
  12158. accept: "application/vnd.github.inertia-preview+json"
  12159. },
  12160. method: "GET",
  12161. params: {
  12162. page: {
  12163. type: "integer"
  12164. },
  12165. per_page: {
  12166. type: "integer"
  12167. },
  12168. team_id: {
  12169. required: true,
  12170. type: "integer"
  12171. }
  12172. },
  12173. url: "/teams/:team_id/projects"
  12174. },
  12175. listRepos: {
  12176. deprecated: "octokit.teams.listRepos() has been renamed to octokit.teams.listReposLegacy() (2020-01-16)",
  12177. method: "GET",
  12178. params: {
  12179. page: {
  12180. type: "integer"
  12181. },
  12182. per_page: {
  12183. type: "integer"
  12184. },
  12185. team_id: {
  12186. required: true,
  12187. type: "integer"
  12188. }
  12189. },
  12190. url: "/teams/:team_id/repos"
  12191. },
  12192. listReposInOrg: {
  12193. method: "GET",
  12194. params: {
  12195. org: {
  12196. required: true,
  12197. type: "string"
  12198. },
  12199. page: {
  12200. type: "integer"
  12201. },
  12202. per_page: {
  12203. type: "integer"
  12204. },
  12205. team_slug: {
  12206. required: true,
  12207. type: "string"
  12208. }
  12209. },
  12210. url: "/orgs/:org/teams/:team_slug/repos"
  12211. },
  12212. listReposLegacy: {
  12213. deprecated: "octokit.teams.listReposLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy",
  12214. method: "GET",
  12215. params: {
  12216. page: {
  12217. type: "integer"
  12218. },
  12219. per_page: {
  12220. type: "integer"
  12221. },
  12222. team_id: {
  12223. required: true,
  12224. type: "integer"
  12225. }
  12226. },
  12227. url: "/teams/:team_id/repos"
  12228. },
  12229. removeMember: {
  12230. deprecated: "octokit.teams.removeMember() has been renamed to octokit.teams.removeMemberLegacy() (2020-01-16)",
  12231. method: "DELETE",
  12232. params: {
  12233. team_id: {
  12234. required: true,
  12235. type: "integer"
  12236. },
  12237. username: {
  12238. required: true,
  12239. type: "string"
  12240. }
  12241. },
  12242. url: "/teams/:team_id/members/:username"
  12243. },
  12244. removeMemberLegacy: {
  12245. deprecated: "octokit.teams.removeMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy",
  12246. method: "DELETE",
  12247. params: {
  12248. team_id: {
  12249. required: true,
  12250. type: "integer"
  12251. },
  12252. username: {
  12253. required: true,
  12254. type: "string"
  12255. }
  12256. },
  12257. url: "/teams/:team_id/members/:username"
  12258. },
  12259. removeMembership: {
  12260. deprecated: "octokit.teams.removeMembership() has been renamed to octokit.teams.removeMembershipLegacy() (2020-01-16)",
  12261. method: "DELETE",
  12262. params: {
  12263. team_id: {
  12264. required: true,
  12265. type: "integer"
  12266. },
  12267. username: {
  12268. required: true,
  12269. type: "string"
  12270. }
  12271. },
  12272. url: "/teams/:team_id/memberships/:username"
  12273. },
  12274. removeMembershipInOrg: {
  12275. method: "DELETE",
  12276. params: {
  12277. org: {
  12278. required: true,
  12279. type: "string"
  12280. },
  12281. team_slug: {
  12282. required: true,
  12283. type: "string"
  12284. },
  12285. username: {
  12286. required: true,
  12287. type: "string"
  12288. }
  12289. },
  12290. url: "/orgs/:org/teams/:team_slug/memberships/:username"
  12291. },
  12292. removeMembershipLegacy: {
  12293. deprecated: "octokit.teams.removeMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy",
  12294. method: "DELETE",
  12295. params: {
  12296. team_id: {
  12297. required: true,
  12298. type: "integer"
  12299. },
  12300. username: {
  12301. required: true,
  12302. type: "string"
  12303. }
  12304. },
  12305. url: "/teams/:team_id/memberships/:username"
  12306. },
  12307. removeProject: {
  12308. deprecated: "octokit.teams.removeProject() has been renamed to octokit.teams.removeProjectLegacy() (2020-01-16)",
  12309. method: "DELETE",
  12310. params: {
  12311. project_id: {
  12312. required: true,
  12313. type: "integer"
  12314. },
  12315. team_id: {
  12316. required: true,
  12317. type: "integer"
  12318. }
  12319. },
  12320. url: "/teams/:team_id/projects/:project_id"
  12321. },
  12322. removeProjectInOrg: {
  12323. method: "DELETE",
  12324. params: {
  12325. org: {
  12326. required: true,
  12327. type: "string"
  12328. },
  12329. project_id: {
  12330. required: true,
  12331. type: "integer"
  12332. },
  12333. team_slug: {
  12334. required: true,
  12335. type: "string"
  12336. }
  12337. },
  12338. url: "/orgs/:org/teams/:team_slug/projects/:project_id"
  12339. },
  12340. removeProjectLegacy: {
  12341. deprecated: "octokit.teams.removeProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy",
  12342. method: "DELETE",
  12343. params: {
  12344. project_id: {
  12345. required: true,
  12346. type: "integer"
  12347. },
  12348. team_id: {
  12349. required: true,
  12350. type: "integer"
  12351. }
  12352. },
  12353. url: "/teams/:team_id/projects/:project_id"
  12354. },
  12355. removeRepo: {
  12356. deprecated: "octokit.teams.removeRepo() has been renamed to octokit.teams.removeRepoLegacy() (2020-01-16)",
  12357. method: "DELETE",
  12358. params: {
  12359. owner: {
  12360. required: true,
  12361. type: "string"
  12362. },
  12363. repo: {
  12364. required: true,
  12365. type: "string"
  12366. },
  12367. team_id: {
  12368. required: true,
  12369. type: "integer"
  12370. }
  12371. },
  12372. url: "/teams/:team_id/repos/:owner/:repo"
  12373. },
  12374. removeRepoInOrg: {
  12375. method: "DELETE",
  12376. params: {
  12377. org: {
  12378. required: true,
  12379. type: "string"
  12380. },
  12381. owner: {
  12382. required: true,
  12383. type: "string"
  12384. },
  12385. repo: {
  12386. required: true,
  12387. type: "string"
  12388. },
  12389. team_slug: {
  12390. required: true,
  12391. type: "string"
  12392. }
  12393. },
  12394. url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"
  12395. },
  12396. removeRepoLegacy: {
  12397. deprecated: "octokit.teams.removeRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy",
  12398. method: "DELETE",
  12399. params: {
  12400. owner: {
  12401. required: true,
  12402. type: "string"
  12403. },
  12404. repo: {
  12405. required: true,
  12406. type: "string"
  12407. },
  12408. team_id: {
  12409. required: true,
  12410. type: "integer"
  12411. }
  12412. },
  12413. url: "/teams/:team_id/repos/:owner/:repo"
  12414. },
  12415. reviewProject: {
  12416. deprecated: "octokit.teams.reviewProject() has been renamed to octokit.teams.reviewProjectLegacy() (2020-01-16)",
  12417. headers: {
  12418. accept: "application/vnd.github.inertia-preview+json"
  12419. },
  12420. method: "GET",
  12421. params: {
  12422. project_id: {
  12423. required: true,
  12424. type: "integer"
  12425. },
  12426. team_id: {
  12427. required: true,
  12428. type: "integer"
  12429. }
  12430. },
  12431. url: "/teams/:team_id/projects/:project_id"
  12432. },
  12433. reviewProjectInOrg: {
  12434. headers: {
  12435. accept: "application/vnd.github.inertia-preview+json"
  12436. },
  12437. method: "GET",
  12438. params: {
  12439. org: {
  12440. required: true,
  12441. type: "string"
  12442. },
  12443. project_id: {
  12444. required: true,
  12445. type: "integer"
  12446. },
  12447. team_slug: {
  12448. required: true,
  12449. type: "string"
  12450. }
  12451. },
  12452. url: "/orgs/:org/teams/:team_slug/projects/:project_id"
  12453. },
  12454. reviewProjectLegacy: {
  12455. deprecated: "octokit.teams.reviewProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy",
  12456. headers: {
  12457. accept: "application/vnd.github.inertia-preview+json"
  12458. },
  12459. method: "GET",
  12460. params: {
  12461. project_id: {
  12462. required: true,
  12463. type: "integer"
  12464. },
  12465. team_id: {
  12466. required: true,
  12467. type: "integer"
  12468. }
  12469. },
  12470. url: "/teams/:team_id/projects/:project_id"
  12471. },
  12472. update: {
  12473. deprecated: "octokit.teams.update() has been renamed to octokit.teams.updateLegacy() (2020-01-16)",
  12474. method: "PATCH",
  12475. params: {
  12476. description: {
  12477. type: "string"
  12478. },
  12479. name: {
  12480. required: true,
  12481. type: "string"
  12482. },
  12483. parent_team_id: {
  12484. type: "integer"
  12485. },
  12486. permission: {
  12487. enum: ["pull", "push", "admin"],
  12488. type: "string"
  12489. },
  12490. privacy: {
  12491. enum: ["secret", "closed"],
  12492. type: "string"
  12493. },
  12494. team_id: {
  12495. required: true,
  12496. type: "integer"
  12497. }
  12498. },
  12499. url: "/teams/:team_id"
  12500. },
  12501. updateDiscussion: {
  12502. deprecated: "octokit.teams.updateDiscussion() has been renamed to octokit.teams.updateDiscussionLegacy() (2020-01-16)",
  12503. method: "PATCH",
  12504. params: {
  12505. body: {
  12506. type: "string"
  12507. },
  12508. discussion_number: {
  12509. required: true,
  12510. type: "integer"
  12511. },
  12512. team_id: {
  12513. required: true,
  12514. type: "integer"
  12515. },
  12516. title: {
  12517. type: "string"
  12518. }
  12519. },
  12520. url: "/teams/:team_id/discussions/:discussion_number"
  12521. },
  12522. updateDiscussionComment: {
  12523. deprecated: "octokit.teams.updateDiscussionComment() has been renamed to octokit.teams.updateDiscussionCommentLegacy() (2020-01-16)",
  12524. method: "PATCH",
  12525. params: {
  12526. body: {
  12527. required: true,
  12528. type: "string"
  12529. },
  12530. comment_number: {
  12531. required: true,
  12532. type: "integer"
  12533. },
  12534. discussion_number: {
  12535. required: true,
  12536. type: "integer"
  12537. },
  12538. team_id: {
  12539. required: true,
  12540. type: "integer"
  12541. }
  12542. },
  12543. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  12544. },
  12545. updateDiscussionCommentInOrg: {
  12546. method: "PATCH",
  12547. params: {
  12548. body: {
  12549. required: true,
  12550. type: "string"
  12551. },
  12552. comment_number: {
  12553. required: true,
  12554. type: "integer"
  12555. },
  12556. discussion_number: {
  12557. required: true,
  12558. type: "integer"
  12559. },
  12560. org: {
  12561. required: true,
  12562. type: "string"
  12563. },
  12564. team_slug: {
  12565. required: true,
  12566. type: "string"
  12567. }
  12568. },
  12569. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"
  12570. },
  12571. updateDiscussionCommentLegacy: {
  12572. deprecated: "octokit.teams.updateDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy",
  12573. method: "PATCH",
  12574. params: {
  12575. body: {
  12576. required: true,
  12577. type: "string"
  12578. },
  12579. comment_number: {
  12580. required: true,
  12581. type: "integer"
  12582. },
  12583. discussion_number: {
  12584. required: true,
  12585. type: "integer"
  12586. },
  12587. team_id: {
  12588. required: true,
  12589. type: "integer"
  12590. }
  12591. },
  12592. url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  12593. },
  12594. updateDiscussionInOrg: {
  12595. method: "PATCH",
  12596. params: {
  12597. body: {
  12598. type: "string"
  12599. },
  12600. discussion_number: {
  12601. required: true,
  12602. type: "integer"
  12603. },
  12604. org: {
  12605. required: true,
  12606. type: "string"
  12607. },
  12608. team_slug: {
  12609. required: true,
  12610. type: "string"
  12611. },
  12612. title: {
  12613. type: "string"
  12614. }
  12615. },
  12616. url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"
  12617. },
  12618. updateDiscussionLegacy: {
  12619. deprecated: "octokit.teams.updateDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy",
  12620. method: "PATCH",
  12621. params: {
  12622. body: {
  12623. type: "string"
  12624. },
  12625. discussion_number: {
  12626. required: true,
  12627. type: "integer"
  12628. },
  12629. team_id: {
  12630. required: true,
  12631. type: "integer"
  12632. },
  12633. title: {
  12634. type: "string"
  12635. }
  12636. },
  12637. url: "/teams/:team_id/discussions/:discussion_number"
  12638. },
  12639. updateInOrg: {
  12640. method: "PATCH",
  12641. params: {
  12642. description: {
  12643. type: "string"
  12644. },
  12645. name: {
  12646. required: true,
  12647. type: "string"
  12648. },
  12649. org: {
  12650. required: true,
  12651. type: "string"
  12652. },
  12653. parent_team_id: {
  12654. type: "integer"
  12655. },
  12656. permission: {
  12657. enum: ["pull", "push", "admin"],
  12658. type: "string"
  12659. },
  12660. privacy: {
  12661. enum: ["secret", "closed"],
  12662. type: "string"
  12663. },
  12664. team_slug: {
  12665. required: true,
  12666. type: "string"
  12667. }
  12668. },
  12669. url: "/orgs/:org/teams/:team_slug"
  12670. },
  12671. updateLegacy: {
  12672. deprecated: "octokit.teams.updateLegacy() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy",
  12673. method: "PATCH",
  12674. params: {
  12675. description: {
  12676. type: "string"
  12677. },
  12678. name: {
  12679. required: true,
  12680. type: "string"
  12681. },
  12682. parent_team_id: {
  12683. type: "integer"
  12684. },
  12685. permission: {
  12686. enum: ["pull", "push", "admin"],
  12687. type: "string"
  12688. },
  12689. privacy: {
  12690. enum: ["secret", "closed"],
  12691. type: "string"
  12692. },
  12693. team_id: {
  12694. required: true,
  12695. type: "integer"
  12696. }
  12697. },
  12698. url: "/teams/:team_id"
  12699. }
  12700. },
  12701. users: {
  12702. addEmails: {
  12703. method: "POST",
  12704. params: {
  12705. emails: {
  12706. required: true,
  12707. type: "string[]"
  12708. }
  12709. },
  12710. url: "/user/emails"
  12711. },
  12712. block: {
  12713. method: "PUT",
  12714. params: {
  12715. username: {
  12716. required: true,
  12717. type: "string"
  12718. }
  12719. },
  12720. url: "/user/blocks/:username"
  12721. },
  12722. checkBlocked: {
  12723. method: "GET",
  12724. params: {
  12725. username: {
  12726. required: true,
  12727. type: "string"
  12728. }
  12729. },
  12730. url: "/user/blocks/:username"
  12731. },
  12732. checkFollowing: {
  12733. method: "GET",
  12734. params: {
  12735. username: {
  12736. required: true,
  12737. type: "string"
  12738. }
  12739. },
  12740. url: "/user/following/:username"
  12741. },
  12742. checkFollowingForUser: {
  12743. method: "GET",
  12744. params: {
  12745. target_user: {
  12746. required: true,
  12747. type: "string"
  12748. },
  12749. username: {
  12750. required: true,
  12751. type: "string"
  12752. }
  12753. },
  12754. url: "/users/:username/following/:target_user"
  12755. },
  12756. createGpgKey: {
  12757. method: "POST",
  12758. params: {
  12759. armored_public_key: {
  12760. type: "string"
  12761. }
  12762. },
  12763. url: "/user/gpg_keys"
  12764. },
  12765. createPublicKey: {
  12766. method: "POST",
  12767. params: {
  12768. key: {
  12769. type: "string"
  12770. },
  12771. title: {
  12772. type: "string"
  12773. }
  12774. },
  12775. url: "/user/keys"
  12776. },
  12777. deleteEmails: {
  12778. method: "DELETE",
  12779. params: {
  12780. emails: {
  12781. required: true,
  12782. type: "string[]"
  12783. }
  12784. },
  12785. url: "/user/emails"
  12786. },
  12787. deleteGpgKey: {
  12788. method: "DELETE",
  12789. params: {
  12790. gpg_key_id: {
  12791. required: true,
  12792. type: "integer"
  12793. }
  12794. },
  12795. url: "/user/gpg_keys/:gpg_key_id"
  12796. },
  12797. deletePublicKey: {
  12798. method: "DELETE",
  12799. params: {
  12800. key_id: {
  12801. required: true,
  12802. type: "integer"
  12803. }
  12804. },
  12805. url: "/user/keys/:key_id"
  12806. },
  12807. follow: {
  12808. method: "PUT",
  12809. params: {
  12810. username: {
  12811. required: true,
  12812. type: "string"
  12813. }
  12814. },
  12815. url: "/user/following/:username"
  12816. },
  12817. getAuthenticated: {
  12818. method: "GET",
  12819. params: {},
  12820. url: "/user"
  12821. },
  12822. getByUsername: {
  12823. method: "GET",
  12824. params: {
  12825. username: {
  12826. required: true,
  12827. type: "string"
  12828. }
  12829. },
  12830. url: "/users/:username"
  12831. },
  12832. getContextForUser: {
  12833. method: "GET",
  12834. params: {
  12835. subject_id: {
  12836. type: "string"
  12837. },
  12838. subject_type: {
  12839. enum: ["organization", "repository", "issue", "pull_request"],
  12840. type: "string"
  12841. },
  12842. username: {
  12843. required: true,
  12844. type: "string"
  12845. }
  12846. },
  12847. url: "/users/:username/hovercard"
  12848. },
  12849. getGpgKey: {
  12850. method: "GET",
  12851. params: {
  12852. gpg_key_id: {
  12853. required: true,
  12854. type: "integer"
  12855. }
  12856. },
  12857. url: "/user/gpg_keys/:gpg_key_id"
  12858. },
  12859. getPublicKey: {
  12860. method: "GET",
  12861. params: {
  12862. key_id: {
  12863. required: true,
  12864. type: "integer"
  12865. }
  12866. },
  12867. url: "/user/keys/:key_id"
  12868. },
  12869. list: {
  12870. method: "GET",
  12871. params: {
  12872. page: {
  12873. type: "integer"
  12874. },
  12875. per_page: {
  12876. type: "integer"
  12877. },
  12878. since: {
  12879. type: "string"
  12880. }
  12881. },
  12882. url: "/users"
  12883. },
  12884. listBlocked: {
  12885. method: "GET",
  12886. params: {},
  12887. url: "/user/blocks"
  12888. },
  12889. listEmails: {
  12890. method: "GET",
  12891. params: {
  12892. page: {
  12893. type: "integer"
  12894. },
  12895. per_page: {
  12896. type: "integer"
  12897. }
  12898. },
  12899. url: "/user/emails"
  12900. },
  12901. listFollowersForAuthenticatedUser: {
  12902. method: "GET",
  12903. params: {
  12904. page: {
  12905. type: "integer"
  12906. },
  12907. per_page: {
  12908. type: "integer"
  12909. }
  12910. },
  12911. url: "/user/followers"
  12912. },
  12913. listFollowersForUser: {
  12914. method: "GET",
  12915. params: {
  12916. page: {
  12917. type: "integer"
  12918. },
  12919. per_page: {
  12920. type: "integer"
  12921. },
  12922. username: {
  12923. required: true,
  12924. type: "string"
  12925. }
  12926. },
  12927. url: "/users/:username/followers"
  12928. },
  12929. listFollowingForAuthenticatedUser: {
  12930. method: "GET",
  12931. params: {
  12932. page: {
  12933. type: "integer"
  12934. },
  12935. per_page: {
  12936. type: "integer"
  12937. }
  12938. },
  12939. url: "/user/following"
  12940. },
  12941. listFollowingForUser: {
  12942. method: "GET",
  12943. params: {
  12944. page: {
  12945. type: "integer"
  12946. },
  12947. per_page: {
  12948. type: "integer"
  12949. },
  12950. username: {
  12951. required: true,
  12952. type: "string"
  12953. }
  12954. },
  12955. url: "/users/:username/following"
  12956. },
  12957. listGpgKeys: {
  12958. method: "GET",
  12959. params: {
  12960. page: {
  12961. type: "integer"
  12962. },
  12963. per_page: {
  12964. type: "integer"
  12965. }
  12966. },
  12967. url: "/user/gpg_keys"
  12968. },
  12969. listGpgKeysForUser: {
  12970. method: "GET",
  12971. params: {
  12972. page: {
  12973. type: "integer"
  12974. },
  12975. per_page: {
  12976. type: "integer"
  12977. },
  12978. username: {
  12979. required: true,
  12980. type: "string"
  12981. }
  12982. },
  12983. url: "/users/:username/gpg_keys"
  12984. },
  12985. listPublicEmails: {
  12986. method: "GET",
  12987. params: {
  12988. page: {
  12989. type: "integer"
  12990. },
  12991. per_page: {
  12992. type: "integer"
  12993. }
  12994. },
  12995. url: "/user/public_emails"
  12996. },
  12997. listPublicKeys: {
  12998. method: "GET",
  12999. params: {
  13000. page: {
  13001. type: "integer"
  13002. },
  13003. per_page: {
  13004. type: "integer"
  13005. }
  13006. },
  13007. url: "/user/keys"
  13008. },
  13009. listPublicKeysForUser: {
  13010. method: "GET",
  13011. params: {
  13012. page: {
  13013. type: "integer"
  13014. },
  13015. per_page: {
  13016. type: "integer"
  13017. },
  13018. username: {
  13019. required: true,
  13020. type: "string"
  13021. }
  13022. },
  13023. url: "/users/:username/keys"
  13024. },
  13025. togglePrimaryEmailVisibility: {
  13026. method: "PATCH",
  13027. params: {
  13028. email: {
  13029. required: true,
  13030. type: "string"
  13031. },
  13032. visibility: {
  13033. required: true,
  13034. type: "string"
  13035. }
  13036. },
  13037. url: "/user/email/visibility"
  13038. },
  13039. unblock: {
  13040. method: "DELETE",
  13041. params: {
  13042. username: {
  13043. required: true,
  13044. type: "string"
  13045. }
  13046. },
  13047. url: "/user/blocks/:username"
  13048. },
  13049. unfollow: {
  13050. method: "DELETE",
  13051. params: {
  13052. username: {
  13053. required: true,
  13054. type: "string"
  13055. }
  13056. },
  13057. url: "/user/following/:username"
  13058. },
  13059. updateAuthenticated: {
  13060. method: "PATCH",
  13061. params: {
  13062. bio: {
  13063. type: "string"
  13064. },
  13065. blog: {
  13066. type: "string"
  13067. },
  13068. company: {
  13069. type: "string"
  13070. },
  13071. email: {
  13072. type: "string"
  13073. },
  13074. hireable: {
  13075. type: "boolean"
  13076. },
  13077. location: {
  13078. type: "string"
  13079. },
  13080. name: {
  13081. type: "string"
  13082. }
  13083. },
  13084. url: "/user"
  13085. }
  13086. }
  13087. };
  13088. const VERSION = "2.4.0";
  13089. function registerEndpoints(octokit, routes) {
  13090. Object.keys(routes).forEach(namespaceName => {
  13091. if (!octokit[namespaceName]) {
  13092. octokit[namespaceName] = {};
  13093. }
  13094. Object.keys(routes[namespaceName]).forEach(apiName => {
  13095. const apiOptions = routes[namespaceName][apiName];
  13096. const endpointDefaults = ["method", "url", "headers"].reduce((map, key) => {
  13097. if (typeof apiOptions[key] !== "undefined") {
  13098. map[key] = apiOptions[key];
  13099. }
  13100. return map;
  13101. }, {});
  13102. endpointDefaults.request = {
  13103. validate: apiOptions.params
  13104. };
  13105. let request = octokit.request.defaults(endpointDefaults); // patch request & endpoint methods to support deprecated parameters.
  13106. // Not the most elegant solution, but we don’t want to move deprecation
  13107. // logic into octokit/endpoint.js as it’s out of scope
  13108. const hasDeprecatedParam = Object.keys(apiOptions.params || {}).find(key => apiOptions.params[key].deprecated);
  13109. if (hasDeprecatedParam) {
  13110. const patch = patchForDeprecation.bind(null, octokit, apiOptions);
  13111. request = patch(octokit.request.defaults(endpointDefaults), `.${namespaceName}.${apiName}()`);
  13112. request.endpoint = patch(request.endpoint, `.${namespaceName}.${apiName}.endpoint()`);
  13113. request.endpoint.merge = patch(request.endpoint.merge, `.${namespaceName}.${apiName}.endpoint.merge()`);
  13114. }
  13115. if (apiOptions.deprecated) {
  13116. octokit[namespaceName][apiName] = Object.assign(function deprecatedEndpointMethod() {
  13117. octokit.log.warn(new deprecation.Deprecation(`[@octokit/rest] ${apiOptions.deprecated}`));
  13118. octokit[namespaceName][apiName] = request;
  13119. return request.apply(null, arguments);
  13120. }, request);
  13121. return;
  13122. }
  13123. octokit[namespaceName][apiName] = request;
  13124. });
  13125. });
  13126. }
  13127. function patchForDeprecation(octokit, apiOptions, method, methodName) {
  13128. const patchedMethod = options => {
  13129. options = Object.assign({}, options);
  13130. Object.keys(options).forEach(key => {
  13131. if (apiOptions.params[key] && apiOptions.params[key].deprecated) {
  13132. const aliasKey = apiOptions.params[key].alias;
  13133. octokit.log.warn(new deprecation.Deprecation(`[@octokit/rest] "${key}" parameter is deprecated for "${methodName}". Use "${aliasKey}" instead`));
  13134. if (!(aliasKey in options)) {
  13135. options[aliasKey] = options[key];
  13136. }
  13137. delete options[key];
  13138. }
  13139. });
  13140. return method(options);
  13141. };
  13142. Object.keys(method).forEach(key => {
  13143. patchedMethod[key] = method[key];
  13144. });
  13145. return patchedMethod;
  13146. }
  13147. /**
  13148. * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary
  13149. * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is
  13150. * done, we will remove the registerEndpoints methods and return the methods
  13151. * directly as with the other plugins. At that point we will also remove the
  13152. * legacy workarounds and deprecations.
  13153. *
  13154. * See the plan at
  13155. * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1
  13156. */
  13157. function restEndpointMethods(octokit) {
  13158. // @ts-ignore
  13159. octokit.registerEndpoints = registerEndpoints.bind(null, octokit);
  13160. registerEndpoints(octokit, endpointsByScope); // Aliasing scopes for backward compatibility
  13161. // See https://github.com/octokit/rest.js/pull/1134
  13162. [["gitdata", "git"], ["authorization", "oauthAuthorizations"], ["pullRequests", "pulls"]].forEach(([deprecatedScope, scope]) => {
  13163. Object.defineProperty(octokit, deprecatedScope, {
  13164. get() {
  13165. octokit.log.warn( // @ts-ignore
  13166. new deprecation.Deprecation(`[@octokit/plugin-rest-endpoint-methods] "octokit.${deprecatedScope}.*" methods are deprecated, use "octokit.${scope}.*" instead`)); // @ts-ignore
  13167. return octokit[scope];
  13168. }
  13169. });
  13170. });
  13171. return {};
  13172. }
  13173. restEndpointMethods.VERSION = VERSION;
  13174. exports.restEndpointMethods = restEndpointMethods;
  13175. //# sourceMappingURL=index.js.map