1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455 |
- {
- "activity": {
- "checkStarringRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/user/starred/:owner/:repo"
- },
- "deleteRepoSubscription": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/subscription"
- },
- "deleteThreadSubscription": {
- "method": "DELETE",
- "params": { "thread_id": { "required": true, "type": "integer" } },
- "url": "/notifications/threads/:thread_id/subscription"
- },
- "getRepoSubscription": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/subscription"
- },
- "getThread": {
- "method": "GET",
- "params": { "thread_id": { "required": true, "type": "integer" } },
- "url": "/notifications/threads/:thread_id"
- },
- "getThreadSubscription": {
- "method": "GET",
- "params": { "thread_id": { "required": true, "type": "integer" } },
- "url": "/notifications/threads/:thread_id/subscription"
- },
- "listEventsForOrg": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/events/orgs/:org"
- },
- "listEventsForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/events"
- },
- "listFeeds": { "method": "GET", "params": {}, "url": "/feeds" },
- "listNotifications": {
- "method": "GET",
- "params": {
- "all": { "type": "boolean" },
- "before": { "type": "string" },
- "page": { "type": "integer" },
- "participating": { "type": "boolean" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" }
- },
- "url": "/notifications"
- },
- "listNotificationsForRepo": {
- "method": "GET",
- "params": {
- "all": { "type": "boolean" },
- "before": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "participating": { "type": "boolean" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "since": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/notifications"
- },
- "listPublicEvents": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/events"
- },
- "listPublicEventsForOrg": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/orgs/:org/events"
- },
- "listPublicEventsForRepoNetwork": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/networks/:owner/:repo/events"
- },
- "listPublicEventsForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/events/public"
- },
- "listReceivedEventsForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/received_events"
- },
- "listReceivedPublicEventsForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/received_events/public"
- },
- "listRepoEvents": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/events"
- },
- "listReposStarredByAuthenticatedUser": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "sort": { "enum": ["created", "updated"], "type": "string" }
- },
- "url": "/user/starred"
- },
- "listReposStarredByUser": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "sort": { "enum": ["created", "updated"], "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/starred"
- },
- "listReposWatchedByUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/subscriptions"
- },
- "listStargazersForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/stargazers"
- },
- "listWatchedReposForAuthenticatedUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/subscriptions"
- },
- "listWatchersForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/subscribers"
- },
- "markAsRead": {
- "method": "PUT",
- "params": { "last_read_at": { "type": "string" } },
- "url": "/notifications"
- },
- "markNotificationsAsReadForRepo": {
- "method": "PUT",
- "params": {
- "last_read_at": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/notifications"
- },
- "markThreadAsRead": {
- "method": "PATCH",
- "params": { "thread_id": { "required": true, "type": "integer" } },
- "url": "/notifications/threads/:thread_id"
- },
- "setRepoSubscription": {
- "method": "PUT",
- "params": {
- "ignored": { "type": "boolean" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "subscribed": { "type": "boolean" }
- },
- "url": "/repos/:owner/:repo/subscription"
- },
- "setThreadSubscription": {
- "method": "PUT",
- "params": {
- "ignored": { "type": "boolean" },
- "thread_id": { "required": true, "type": "integer" }
- },
- "url": "/notifications/threads/:thread_id/subscription"
- },
- "starRepo": {
- "method": "PUT",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/user/starred/:owner/:repo"
- },
- "unstarRepo": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/user/starred/:owner/:repo"
- }
- },
- "apps": {
- "addRepoToInstallation": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "PUT",
- "params": {
- "installation_id": { "required": true, "type": "integer" },
- "repository_id": { "required": true, "type": "integer" }
- },
- "url": "/user/installations/:installation_id/repositories/:repository_id"
- },
- "createContentAttachment": {
- "headers": { "accept": "application/vnd.github.corsair-preview+json" },
- "method": "POST",
- "params": {
- "body": { "required": true, "type": "string" },
- "content_reference_id": { "required": true, "type": "integer" },
- "title": { "required": true, "type": "string" }
- },
- "url": "/content_references/:content_reference_id/attachments"
- },
- "createFromManifest": {
- "method": "POST",
- "params": { "code": { "required": true, "type": "string" } },
- "url": "/app-manifests/:code/conversions"
- },
- "createInstallationToken": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "POST",
- "params": { "installation_id": { "required": true, "type": "integer" } },
- "url": "/app/installations/:installation_id/access_tokens"
- },
- "findOrgInstallation": {
- "deprecated": "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)",
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": { "org": { "required": true, "type": "string" } },
- "url": "/orgs/:org/installation"
- },
- "findRepoInstallation": {
- "deprecated": "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)",
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/installation"
- },
- "findUserInstallation": {
- "deprecated": "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)",
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/users/:username/installation"
- },
- "getAuthenticated": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": {},
- "url": "/app"
- },
- "getBySlug": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": { "app_slug": { "required": true, "type": "string" } },
- "url": "/apps/:app_slug"
- },
- "getInstallation": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": { "installation_id": { "required": true, "type": "integer" } },
- "url": "/app/installations/:installation_id"
- },
- "getOrgInstallation": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": { "org": { "required": true, "type": "string" } },
- "url": "/orgs/:org/installation"
- },
- "getRepoInstallation": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/installation"
- },
- "getUserInstallation": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/users/:username/installation"
- },
- "listInstallationReposForAuthenticatedUser": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": {
- "installation_id": { "required": true, "type": "integer" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/installations/:installation_id/repositories"
- },
- "listInstallations": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/app/installations"
- },
- "listInstallationsForAuthenticatedUser": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/installations"
- },
- "listRepos": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/installation/repositories"
- },
- "removeRepoFromInstallation": {
- "headers": {
- "accept": "application/vnd.github.machine-man-preview+json"
- },
- "method": "DELETE",
- "params": {
- "installation_id": { "required": true, "type": "integer" },
- "repository_id": { "required": true, "type": "integer" }
- },
- "url": "/user/installations/:installation_id/repositories/:repository_id"
- }
- },
- "checks": {
- "create": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "POST",
- "params": {
- "actions": { "type": "object[]" },
- "actions[].description": { "required": true, "type": "string" },
- "actions[].identifier": { "required": true, "type": "string" },
- "actions[].label": { "required": true, "type": "string" },
- "completed_at": { "type": "string" },
- "conclusion": {
- "enum": [
- "success",
- "failure",
- "neutral",
- "cancelled",
- "timed_out",
- "action_required"
- ],
- "type": "string"
- },
- "details_url": { "type": "string" },
- "external_id": { "type": "string" },
- "head_sha": { "required": true, "type": "string" },
- "name": { "required": true, "type": "string" },
- "output": { "type": "object" },
- "output.annotations": { "type": "object[]" },
- "output.annotations[].annotation_level": {
- "enum": ["notice", "warning", "failure"],
- "required": true,
- "type": "string"
- },
- "output.annotations[].end_column": { "type": "integer" },
- "output.annotations[].end_line": {
- "required": true,
- "type": "integer"
- },
- "output.annotations[].message": { "required": true, "type": "string" },
- "output.annotations[].path": { "required": true, "type": "string" },
- "output.annotations[].raw_details": { "type": "string" },
- "output.annotations[].start_column": { "type": "integer" },
- "output.annotations[].start_line": {
- "required": true,
- "type": "integer"
- },
- "output.annotations[].title": { "type": "string" },
- "output.images": { "type": "object[]" },
- "output.images[].alt": { "required": true, "type": "string" },
- "output.images[].caption": { "type": "string" },
- "output.images[].image_url": { "required": true, "type": "string" },
- "output.summary": { "required": true, "type": "string" },
- "output.text": { "type": "string" },
- "output.title": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "started_at": { "type": "string" },
- "status": {
- "enum": ["queued", "in_progress", "completed"],
- "type": "string"
- }
- },
- "url": "/repos/:owner/:repo/check-runs"
- },
- "createSuite": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "POST",
- "params": {
- "head_sha": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/check-suites"
- },
- "get": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "GET",
- "params": {
- "check_run_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/check-runs/:check_run_id"
- },
- "getSuite": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "GET",
- "params": {
- "check_suite_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/check-suites/:check_suite_id"
- },
- "listAnnotations": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "GET",
- "params": {
- "check_run_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/check-runs/:check_run_id/annotations"
- },
- "listForRef": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "GET",
- "params": {
- "check_name": { "type": "string" },
- "filter": { "enum": ["latest", "all"], "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "status": {
- "enum": ["queued", "in_progress", "completed"],
- "type": "string"
- }
- },
- "url": "/repos/:owner/:repo/commits/:ref/check-runs"
- },
- "listForSuite": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "GET",
- "params": {
- "check_name": { "type": "string" },
- "check_suite_id": { "required": true, "type": "integer" },
- "filter": { "enum": ["latest", "all"], "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "status": {
- "enum": ["queued", "in_progress", "completed"],
- "type": "string"
- }
- },
- "url": "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"
- },
- "listSuitesForRef": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "GET",
- "params": {
- "app_id": { "type": "integer" },
- "check_name": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits/:ref/check-suites"
- },
- "rerequestSuite": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "POST",
- "params": {
- "check_suite_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"
- },
- "setSuitesPreferences": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "PATCH",
- "params": {
- "auto_trigger_checks": { "type": "object[]" },
- "auto_trigger_checks[].app_id": { "required": true, "type": "integer" },
- "auto_trigger_checks[].setting": {
- "required": true,
- "type": "boolean"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/check-suites/preferences"
- },
- "update": {
- "headers": { "accept": "application/vnd.github.antiope-preview+json" },
- "method": "PATCH",
- "params": {
- "actions": { "type": "object[]" },
- "actions[].description": { "required": true, "type": "string" },
- "actions[].identifier": { "required": true, "type": "string" },
- "actions[].label": { "required": true, "type": "string" },
- "check_run_id": { "required": true, "type": "integer" },
- "completed_at": { "type": "string" },
- "conclusion": {
- "enum": [
- "success",
- "failure",
- "neutral",
- "cancelled",
- "timed_out",
- "action_required"
- ],
- "type": "string"
- },
- "details_url": { "type": "string" },
- "external_id": { "type": "string" },
- "name": { "type": "string" },
- "output": { "type": "object" },
- "output.annotations": { "type": "object[]" },
- "output.annotations[].annotation_level": {
- "enum": ["notice", "warning", "failure"],
- "required": true,
- "type": "string"
- },
- "output.annotations[].end_column": { "type": "integer" },
- "output.annotations[].end_line": {
- "required": true,
- "type": "integer"
- },
- "output.annotations[].message": { "required": true, "type": "string" },
- "output.annotations[].path": { "required": true, "type": "string" },
- "output.annotations[].raw_details": { "type": "string" },
- "output.annotations[].start_column": { "type": "integer" },
- "output.annotations[].start_line": {
- "required": true,
- "type": "integer"
- },
- "output.annotations[].title": { "type": "string" },
- "output.images": { "type": "object[]" },
- "output.images[].alt": { "required": true, "type": "string" },
- "output.images[].caption": { "type": "string" },
- "output.images[].image_url": { "required": true, "type": "string" },
- "output.summary": { "required": true, "type": "string" },
- "output.text": { "type": "string" },
- "output.title": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "started_at": { "type": "string" },
- "status": {
- "enum": ["queued", "in_progress", "completed"],
- "type": "string"
- }
- },
- "url": "/repos/:owner/:repo/check-runs/:check_run_id"
- }
- },
- "codesOfConduct": {
- "getConductCode": {
- "headers": {
- "accept": "application/vnd.github.scarlet-witch-preview+json"
- },
- "method": "GET",
- "params": { "key": { "required": true, "type": "string" } },
- "url": "/codes_of_conduct/:key"
- },
- "getForRepo": {
- "headers": {
- "accept": "application/vnd.github.scarlet-witch-preview+json"
- },
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/community/code_of_conduct"
- },
- "listConductCodes": {
- "headers": {
- "accept": "application/vnd.github.scarlet-witch-preview+json"
- },
- "method": "GET",
- "params": {},
- "url": "/codes_of_conduct"
- }
- },
- "emojis": { "get": { "method": "GET", "params": {}, "url": "/emojis" } },
- "enterpriseAdmin": {
- "addAuthorizedSshKey": {
- "method": "POST",
- "params": { "authorized_key": { "required": true, "type": "string" } },
- "url": "/setup/api/settings/authorized-keys"
- },
- "checkConfigurationStatus": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/configcheck"
- },
- "checkMaintenanceStatus": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/maintenance"
- },
- "createGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "POST",
- "params": {
- "active": { "type": "boolean" },
- "config": { "required": true, "type": "object" },
- "config.content_type": { "type": "string" },
- "config.insecure_ssl": { "type": "string" },
- "config.secret": { "type": "string" },
- "config.url": { "required": true, "type": "string" },
- "events": { "type": "string[]" },
- "name": { "required": true, "type": "string" }
- },
- "url": "/admin/hooks"
- },
- "createImpersonationOAuthToken": {
- "method": "POST",
- "params": {
- "scopes": { "type": "string[]" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/admin/users/:username/authorizations"
- },
- "createOrg": {
- "method": "POST",
- "params": {
- "admin": { "required": true, "type": "string" },
- "login": { "required": true, "type": "string" },
- "profile_name": { "type": "string" }
- },
- "url": "/admin/organizations"
- },
- "createPreReceiveEnvironment": {
- "method": "POST",
- "params": {
- "image_url": { "required": true, "type": "string" },
- "name": { "required": true, "type": "string" }
- },
- "url": "/admin/pre-receive-environments"
- },
- "createPreReceiveHook": {
- "method": "POST",
- "params": {
- "allow_downstream_configuration": { "type": "boolean" },
- "enforcement": { "type": "string" },
- "environment": { "required": true, "type": "object" },
- "name": { "required": true, "type": "string" },
- "script": { "required": true, "type": "string" },
- "script_repository": { "required": true, "type": "object" }
- },
- "url": "/admin/pre-receive-hooks"
- },
- "createUser": {
- "method": "POST",
- "params": {
- "email": { "type": "string" },
- "login": { "required": true, "type": "string" }
- },
- "url": "/admin/users"
- },
- "deleteGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "DELETE",
- "params": { "hook_id": { "required": true, "type": "integer" } },
- "url": "/admin/hooks/:hook_id"
- },
- "deleteImpersonationOAuthToken": {
- "method": "DELETE",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/admin/users/:username/authorizations"
- },
- "deletePreReceiveEnvironment": {
- "method": "DELETE",
- "params": {
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
- },
- "deletePreReceiveHook": {
- "method": "DELETE",
- "params": {
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
- },
- "deletePublicKey": {
- "method": "DELETE",
- "params": { "key_ids": { "required": true, "type": "string" } },
- "url": "/admin/keys/:key_ids"
- },
- "deleteUser": {
- "method": "DELETE",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/admin/users/:username"
- },
- "demoteSiteAdministratorToOrdinaryUser": {
- "method": "DELETE",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/users/:username/site_admin"
- },
- "enableOrDisableMaintenanceMode": {
- "method": "POST",
- "params": { "maintenance": { "required": true, "type": "string" } },
- "url": "/setup/api/maintenance"
- },
- "getGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "GET",
- "params": { "hook_id": { "required": true, "type": "integer" } },
- "url": "/admin/hooks/:hook_id"
- },
- "getLicenseInformation": {
- "method": "GET",
- "params": {},
- "url": "/enterprise/settings/license"
- },
- "getPreReceiveEnvironment": {
- "method": "GET",
- "params": {
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
- },
- "getPreReceiveEnvironmentDownloadStatus": {
- "method": "GET",
- "params": {
- "downloaded_at": { "type": "string" },
- "message": { "type": "string" },
- "pre_receive_environment_id": { "required": true, "type": "integer" },
- "state": { "type": "string" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest"
- },
- "getPreReceiveHook": {
- "method": "GET",
- "params": {
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-hooks/:pre_receive_hook_id"
- },
- "getPreReceiveHookForOrg": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
- },
- "getPreReceiveHookForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
- },
- "getTypeStats": {
- "method": "GET",
- "params": { "type": { "required": true, "type": "string" } },
- "url": "/enterprise/stats/:type"
- },
- "listGlobalHooks": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/admin/hooks"
- },
- "listPreReceiveEnvironments": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/admin/pre-receive-environments"
- },
- "listPreReceiveHooks": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/admin/pre-receive-hooks"
- },
- "listPreReceiveHooksForOrg": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks"
- },
- "listPreReceiveHooksForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks"
- },
- "modifySettings": {
- "method": "PUT",
- "params": { "settings": { "required": true, "type": "string" } },
- "url": "/setup/api/settings"
- },
- "pingGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "POST",
- "params": { "hook_id": { "required": true, "type": "integer" } },
- "url": "/admin/hooks/:hook_id/pings"
- },
- "promoteOrdinaryUserToSiteAdministrator": {
- "method": "PUT",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/users/:username/site_admin"
- },
- "queueIndexingJob": {
- "method": "POST",
- "params": { "target": { "required": true, "type": "string" } },
- "url": "/staff/indexing_jobs"
- },
- "removeAuthorizedSshKey": {
- "method": "DELETE",
- "params": { "authorized_key": { "required": true, "type": "string" } },
- "url": "/setup/api/settings/authorized-keys"
- },
- "removeEnforcementOverridesForPreReceiveHookForOrg": {
- "method": "DELETE",
- "params": {
- "org": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
- },
- "removeEnforcementOverridesForPreReceiveHookForRepo": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
- },
- "renameOrg": {
- "method": "PATCH",
- "params": {
- "login": { "required": true, "type": "string" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/admin/organizations/:org"
- },
- "renameUser": {
- "method": "PATCH",
- "params": {
- "login": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/admin/users/:username"
- },
- "retrieveAuthorizedSshKeys": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/settings/authorized-keys"
- },
- "retrieveSettings": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/settings"
- },
- "startConfigurationProcess": {
- "method": "POST",
- "params": {},
- "url": "/setup/api/configure"
- },
- "suspendUser": {
- "method": "PUT",
- "params": {
- "reason": { "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/suspended"
- },
- "syncLdapMappingForTeam": {
- "method": "POST",
- "params": { "team_id": { "required": true, "type": "integer" } },
- "url": "/admin/ldap/teams/:team_id/sync"
- },
- "syncLdapMappingForUser": {
- "method": "POST",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/admin/ldap/users/:username/sync"
- },
- "triggerPreReceiveEnvironmentDownload": {
- "method": "POST",
- "params": {
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads"
- },
- "unsuspendUser": {
- "method": "DELETE",
- "params": {
- "reason": { "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/suspended"
- },
- "updateGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "PATCH",
- "params": {
- "active": { "type": "boolean" },
- "config": { "type": "object" },
- "config.content_type": { "type": "string" },
- "config.insecure_ssl": { "type": "string" },
- "config.secret": { "type": "string" },
- "config.url": { "required": true, "type": "string" },
- "events": { "type": "string[]" },
- "hook_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/hooks/:hook_id"
- },
- "updateLdapMappingForTeam": {
- "method": "PATCH",
- "params": {
- "ldap_dn": { "type": "string" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/ldap/teams/:team_id/mapping"
- },
- "updateLdapMappingForUser": {
- "method": "PATCH",
- "params": {
- "ldap_dn": { "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/admin/ldap/users/:username/mapping"
- },
- "updatePreReceiveEnvironment": {
- "method": "PATCH",
- "params": {
- "image_url": { "type": "string" },
- "name": { "type": "string" },
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
- },
- "updatePreReceiveHook": {
- "method": "PATCH",
- "params": {
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
- },
- "updatePreReceiveHookEnforcementForOrg": {
- "method": "PATCH",
- "params": {
- "org": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
- },
- "updatePreReceiveHookEnforcementForRepo": {
- "method": "PATCH",
- "params": {
- "owner": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
- },
- "upgradeLicense": {
- "method": "POST",
- "params": { "license": { "type": "string" } },
- "url": "/setup/api/upgrade"
- },
- "uploadLicenseForFirstTime": {
- "method": "POST",
- "params": {
- "license": { "required": true, "type": "string" },
- "password": { "type": "string" },
- "settings": { "type": "string" }
- },
- "url": "/setup/api/start"
- }
- },
- "gists": {
- "checkIsStarred": {
- "method": "GET",
- "params": { "gist_id": { "required": true, "type": "string" } },
- "url": "/gists/:gist_id/star"
- },
- "create": {
- "method": "POST",
- "params": {
- "description": { "type": "string" },
- "files": { "required": true, "type": "object" },
- "files.content": { "type": "string" },
- "public": { "type": "boolean" }
- },
- "url": "/gists"
- },
- "createComment": {
- "method": "POST",
- "params": {
- "body": { "required": true, "type": "string" },
- "gist_id": { "required": true, "type": "string" }
- },
- "url": "/gists/:gist_id/comments"
- },
- "delete": {
- "method": "DELETE",
- "params": { "gist_id": { "required": true, "type": "string" } },
- "url": "/gists/:gist_id"
- },
- "deleteComment": {
- "method": "DELETE",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "gist_id": { "required": true, "type": "string" }
- },
- "url": "/gists/:gist_id/comments/:comment_id"
- },
- "fork": {
- "method": "POST",
- "params": { "gist_id": { "required": true, "type": "string" } },
- "url": "/gists/:gist_id/forks"
- },
- "get": {
- "method": "GET",
- "params": { "gist_id": { "required": true, "type": "string" } },
- "url": "/gists/:gist_id"
- },
- "getComment": {
- "method": "GET",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "gist_id": { "required": true, "type": "string" }
- },
- "url": "/gists/:gist_id/comments/:comment_id"
- },
- "getRevision": {
- "method": "GET",
- "params": {
- "gist_id": { "required": true, "type": "string" },
- "sha": { "required": true, "type": "string" }
- },
- "url": "/gists/:gist_id/:sha"
- },
- "list": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" }
- },
- "url": "/gists"
- },
- "listComments": {
- "method": "GET",
- "params": {
- "gist_id": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/gists/:gist_id/comments"
- },
- "listCommits": {
- "method": "GET",
- "params": {
- "gist_id": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/gists/:gist_id/commits"
- },
- "listForks": {
- "method": "GET",
- "params": {
- "gist_id": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/gists/:gist_id/forks"
- },
- "listPublic": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" }
- },
- "url": "/gists/public"
- },
- "listPublicForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/gists"
- },
- "listStarred": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" }
- },
- "url": "/gists/starred"
- },
- "star": {
- "method": "PUT",
- "params": { "gist_id": { "required": true, "type": "string" } },
- "url": "/gists/:gist_id/star"
- },
- "unstar": {
- "method": "DELETE",
- "params": { "gist_id": { "required": true, "type": "string" } },
- "url": "/gists/:gist_id/star"
- },
- "update": {
- "method": "PATCH",
- "params": {
- "description": { "type": "string" },
- "files": { "type": "object" },
- "files.content": { "type": "string" },
- "files.filename": { "type": "string" },
- "gist_id": { "required": true, "type": "string" }
- },
- "url": "/gists/:gist_id"
- },
- "updateComment": {
- "method": "PATCH",
- "params": {
- "body": { "required": true, "type": "string" },
- "comment_id": { "required": true, "type": "integer" },
- "gist_id": { "required": true, "type": "string" }
- },
- "url": "/gists/:gist_id/comments/:comment_id"
- }
- },
- "git": {
- "createBlob": {
- "method": "POST",
- "params": {
- "content": { "required": true, "type": "string" },
- "encoding": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/blobs"
- },
- "createCommit": {
- "method": "POST",
- "params": {
- "author": { "type": "object" },
- "author.date": { "type": "string" },
- "author.email": { "type": "string" },
- "author.name": { "type": "string" },
- "committer": { "type": "object" },
- "committer.date": { "type": "string" },
- "committer.email": { "type": "string" },
- "committer.name": { "type": "string" },
- "message": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "parents": { "required": true, "type": "string[]" },
- "repo": { "required": true, "type": "string" },
- "signature": { "type": "string" },
- "tree": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/commits"
- },
- "createRef": {
- "method": "POST",
- "params": {
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/refs"
- },
- "createTag": {
- "method": "POST",
- "params": {
- "message": { "required": true, "type": "string" },
- "object": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "tag": { "required": true, "type": "string" },
- "tagger": { "type": "object" },
- "tagger.date": { "type": "string" },
- "tagger.email": { "type": "string" },
- "tagger.name": { "type": "string" },
- "type": {
- "enum": ["commit", "tree", "blob"],
- "required": true,
- "type": "string"
- }
- },
- "url": "/repos/:owner/:repo/git/tags"
- },
- "createTree": {
- "method": "POST",
- "params": {
- "base_tree": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "tree": { "required": true, "type": "object[]" },
- "tree[].content": { "type": "string" },
- "tree[].mode": {
- "enum": ["100644", "100755", "040000", "160000", "120000"],
- "type": "string"
- },
- "tree[].path": { "type": "string" },
- "tree[].sha": { "type": "string" },
- "tree[].type": { "enum": ["blob", "tree", "commit"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/trees"
- },
- "deleteRef": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/refs/:ref"
- },
- "getBlob": {
- "method": "GET",
- "params": {
- "file_sha": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/blobs/:file_sha"
- },
- "getCommit": {
- "method": "GET",
- "params": {
- "commit_sha": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/commits/:commit_sha"
- },
- "getRef": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/refs/:ref"
- },
- "getTag": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "tag_sha": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/tags/:tag_sha"
- },
- "getTree": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "recursive": { "enum": ["1"], "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "tree_sha": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/trees/:tree_sha"
- },
- "listRefs": {
- "method": "GET",
- "params": {
- "namespace": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/refs/:namespace"
- },
- "updateRef": {
- "method": "PATCH",
- "params": {
- "force": { "type": "boolean" },
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/git/refs/:ref"
- }
- },
- "gitignore": {
- "getTemplate": {
- "method": "GET",
- "params": { "name": { "required": true, "type": "string" } },
- "url": "/gitignore/templates/:name"
- },
- "listTemplates": {
- "method": "GET",
- "params": {},
- "url": "/gitignore/templates"
- }
- },
- "issues": {
- "addAssignees": {
- "method": "POST",
- "params": {
- "assignees": { "type": "string[]" },
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
- },
- "addLabels": {
- "method": "POST",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "labels": { "required": true, "type": "string[]" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- "checkAssignee": {
- "method": "GET",
- "params": {
- "assignee": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/assignees/:assignee"
- },
- "create": {
- "method": "POST",
- "params": {
- "assignee": { "type": "string" },
- "assignees": { "type": "string[]" },
- "body": { "type": "string" },
- "labels": { "type": "string[]" },
- "milestone": { "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "title": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues"
- },
- "createComment": {
- "method": "POST",
- "params": {
- "body": { "required": true, "type": "string" },
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/comments"
- },
- "createLabel": {
- "method": "POST",
- "params": {
- "color": { "required": true, "type": "string" },
- "description": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/labels"
- },
- "createMilestone": {
- "method": "POST",
- "params": {
- "description": { "type": "string" },
- "due_on": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "state": { "enum": ["open", "closed"], "type": "string" },
- "title": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/milestones"
- },
- "deleteComment": {
- "method": "DELETE",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/comments/:comment_id"
- },
- "deleteLabel": {
- "method": "DELETE",
- "params": {
- "name": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/labels/:name"
- },
- "deleteMilestone": {
- "method": "DELETE",
- "params": {
- "milestone_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "milestone_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/milestones/:milestone_number"
- },
- "get": {
- "method": "GET",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number"
- },
- "getComment": {
- "method": "GET",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/comments/:comment_id"
- },
- "getEvent": {
- "method": "GET",
- "params": {
- "event_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/events/:event_id"
- },
- "getLabel": {
- "method": "GET",
- "params": {
- "name": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/labels/:name"
- },
- "getMilestone": {
- "method": "GET",
- "params": {
- "milestone_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "milestone_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/milestones/:milestone_number"
- },
- "list": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "filter": {
- "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
- "type": "string"
- },
- "labels": { "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" },
- "sort": {
- "enum": ["created", "updated", "comments"],
- "type": "string"
- },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/issues"
- },
- "listAssignees": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/assignees"
- },
- "listComments": {
- "method": "GET",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "since": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/comments"
- },
- "listCommentsForRepo": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "since": { "type": "string" },
- "sort": { "enum": ["created", "updated"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/comments"
- },
- "listEvents": {
- "method": "GET",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/events"
- },
- "listEventsForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/events"
- },
- "listEventsForTimeline": {
- "headers": {
- "accept": "application/vnd.github.mockingbird-preview+json"
- },
- "method": "GET",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/timeline"
- },
- "listForAuthenticatedUser": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "filter": {
- "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
- "type": "string"
- },
- "labels": { "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" },
- "sort": {
- "enum": ["created", "updated", "comments"],
- "type": "string"
- },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/user/issues"
- },
- "listForOrg": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "filter": {
- "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
- "type": "string"
- },
- "labels": { "type": "string" },
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" },
- "sort": {
- "enum": ["created", "updated", "comments"],
- "type": "string"
- },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/orgs/:org/issues"
- },
- "listForRepo": {
- "method": "GET",
- "params": {
- "assignee": { "type": "string" },
- "creator": { "type": "string" },
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "labels": { "type": "string" },
- "mentioned": { "type": "string" },
- "milestone": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "since": { "type": "string" },
- "sort": {
- "enum": ["created", "updated", "comments"],
- "type": "string"
- },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues"
- },
- "listLabelsForMilestone": {
- "method": "GET",
- "params": {
- "milestone_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "milestone_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/milestones/:milestone_number/labels"
- },
- "listLabelsForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/labels"
- },
- "listLabelsOnIssue": {
- "method": "GET",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- "listMilestonesForRepo": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "sort": { "enum": ["due_on", "completeness"], "type": "string" },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/milestones"
- },
- "lock": {
- "method": "PUT",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "lock_reason": {
- "enum": ["off-topic", "too heated", "resolved", "spam"],
- "type": "string"
- },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/lock"
- },
- "removeAssignees": {
- "method": "DELETE",
- "params": {
- "assignees": { "type": "string[]" },
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
- },
- "removeLabel": {
- "method": "DELETE",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "name": { "required": true, "type": "string" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/labels/:name"
- },
- "removeLabels": {
- "method": "DELETE",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- "replaceLabels": {
- "method": "PUT",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "labels": { "type": "string[]" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- "unlock": {
- "method": "DELETE",
- "params": {
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/lock"
- },
- "update": {
- "method": "PATCH",
- "params": {
- "assignee": { "type": "string" },
- "assignees": { "type": "string[]" },
- "body": { "type": "string" },
- "issue_number": { "required": true, "type": "integer" },
- "labels": { "type": "string[]" },
- "milestone": { "allowNull": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "state": { "enum": ["open", "closed"], "type": "string" },
- "title": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number"
- },
- "updateComment": {
- "method": "PATCH",
- "params": {
- "body": { "required": true, "type": "string" },
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/comments/:comment_id"
- },
- "updateLabel": {
- "method": "PATCH",
- "params": {
- "color": { "type": "string" },
- "current_name": { "required": true, "type": "string" },
- "description": { "type": "string" },
- "name": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/labels/:current_name"
- },
- "updateMilestone": {
- "method": "PATCH",
- "params": {
- "description": { "type": "string" },
- "due_on": { "type": "string" },
- "milestone_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "milestone_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "state": { "enum": ["open", "closed"], "type": "string" },
- "title": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/milestones/:milestone_number"
- }
- },
- "licenses": {
- "get": {
- "method": "GET",
- "params": { "license": { "required": true, "type": "string" } },
- "url": "/licenses/:license"
- },
- "getForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/license"
- },
- "list": {
- "deprecated": "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)",
- "method": "GET",
- "params": {},
- "url": "/licenses"
- },
- "listCommonlyUsed": { "method": "GET", "params": {}, "url": "/licenses" }
- },
- "markdown": {
- "render": {
- "method": "POST",
- "params": {
- "context": { "type": "string" },
- "mode": { "enum": ["markdown", "gfm"], "type": "string" },
- "text": { "required": true, "type": "string" }
- },
- "url": "/markdown"
- },
- "renderRaw": {
- "headers": { "content-type": "text/plain; charset=utf-8" },
- "method": "POST",
- "params": {
- "data": { "mapTo": "data", "required": true, "type": "string" }
- },
- "url": "/markdown/raw"
- }
- },
- "meta": { "get": { "method": "GET", "params": {}, "url": "/meta" } },
- "oauthAuthorizations": {
- "checkAuthorization": {
- "method": "GET",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/tokens/:access_token"
- },
- "createAuthorization": {
- "method": "POST",
- "params": {
- "client_id": { "type": "string" },
- "client_secret": { "type": "string" },
- "fingerprint": { "type": "string" },
- "note": { "required": true, "type": "string" },
- "note_url": { "type": "string" },
- "scopes": { "type": "string[]" }
- },
- "url": "/authorizations"
- },
- "deleteAuthorization": {
- "method": "DELETE",
- "params": { "authorization_id": { "required": true, "type": "integer" } },
- "url": "/authorizations/:authorization_id"
- },
- "deleteGrant": {
- "method": "DELETE",
- "params": { "grant_id": { "required": true, "type": "integer" } },
- "url": "/applications/grants/:grant_id"
- },
- "getAuthorization": {
- "method": "GET",
- "params": { "authorization_id": { "required": true, "type": "integer" } },
- "url": "/authorizations/:authorization_id"
- },
- "getGrant": {
- "method": "GET",
- "params": { "grant_id": { "required": true, "type": "integer" } },
- "url": "/applications/grants/:grant_id"
- },
- "getOrCreateAuthorizationForApp": {
- "method": "PUT",
- "params": {
- "client_id": { "required": true, "type": "string" },
- "client_secret": { "required": true, "type": "string" },
- "fingerprint": { "type": "string" },
- "note": { "type": "string" },
- "note_url": { "type": "string" },
- "scopes": { "type": "string[]" }
- },
- "url": "/authorizations/clients/:client_id"
- },
- "getOrCreateAuthorizationForAppAndFingerprint": {
- "method": "PUT",
- "params": {
- "client_id": { "required": true, "type": "string" },
- "client_secret": { "required": true, "type": "string" },
- "fingerprint": { "required": true, "type": "string" },
- "note": { "type": "string" },
- "note_url": { "type": "string" },
- "scopes": { "type": "string[]" }
- },
- "url": "/authorizations/clients/:client_id/:fingerprint"
- },
- "getOrCreateAuthorizationForAppFingerprint": {
- "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)",
- "method": "PUT",
- "params": {
- "client_id": { "required": true, "type": "string" },
- "client_secret": { "required": true, "type": "string" },
- "fingerprint": { "required": true, "type": "string" },
- "note": { "type": "string" },
- "note_url": { "type": "string" },
- "scopes": { "type": "string[]" }
- },
- "url": "/authorizations/clients/:client_id/:fingerprint"
- },
- "listAuthorizations": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/authorizations"
- },
- "listGrants": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/applications/grants"
- },
- "resetAuthorization": {
- "method": "POST",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/tokens/:access_token"
- },
- "revokeAuthorizationForApplication": {
- "method": "DELETE",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/tokens/:access_token"
- },
- "revokeGrantForApplication": {
- "method": "DELETE",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/grants/:access_token"
- },
- "updateAuthorization": {
- "method": "PATCH",
- "params": {
- "add_scopes": { "type": "string[]" },
- "authorization_id": { "required": true, "type": "integer" },
- "fingerprint": { "type": "string" },
- "note": { "type": "string" },
- "note_url": { "type": "string" },
- "remove_scopes": { "type": "string[]" },
- "scopes": { "type": "string[]" }
- },
- "url": "/authorizations/:authorization_id"
- }
- },
- "orgs": {
- "addOrUpdateMembership": {
- "method": "PUT",
- "params": {
- "org": { "required": true, "type": "string" },
- "role": { "enum": ["admin", "member"], "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/memberships/:username"
- },
- "checkMembership": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/members/:username"
- },
- "checkPublicMembership": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/public_members/:username"
- },
- "concealMembership": {
- "method": "DELETE",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/public_members/:username"
- },
- "convertMemberToOutsideCollaborator": {
- "method": "PUT",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/outside_collaborators/:username"
- },
- "createHook": {
- "method": "POST",
- "params": {
- "active": { "type": "boolean" },
- "config": { "required": true, "type": "object" },
- "config.content_type": { "type": "string" },
- "config.insecure_ssl": { "type": "string" },
- "config.secret": { "type": "string" },
- "config.url": { "required": true, "type": "string" },
- "events": { "type": "string[]" },
- "name": { "required": true, "type": "string" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/hooks"
- },
- "deleteHook": {
- "method": "DELETE",
- "params": {
- "hook_id": { "required": true, "type": "integer" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/hooks/:hook_id"
- },
- "get": {
- "method": "GET",
- "params": { "org": { "required": true, "type": "string" } },
- "url": "/orgs/:org"
- },
- "getHook": {
- "method": "GET",
- "params": {
- "hook_id": { "required": true, "type": "integer" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/hooks/:hook_id"
- },
- "getMembership": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/memberships/:username"
- },
- "getMembershipForAuthenticatedUser": {
- "method": "GET",
- "params": { "org": { "required": true, "type": "string" } },
- "url": "/user/memberships/orgs/:org"
- },
- "list": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" }
- },
- "url": "/organizations"
- },
- "listForAuthenticatedUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/orgs"
- },
- "listForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/orgs"
- },
- "listHooks": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/orgs/:org/hooks"
- },
- "listMembers": {
- "method": "GET",
- "params": {
- "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "role": { "enum": ["all", "admin", "member"], "type": "string" }
- },
- "url": "/orgs/:org/members"
- },
- "listMemberships": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "state": { "enum": ["active", "pending"], "type": "string" }
- },
- "url": "/user/memberships/orgs"
- },
- "listOutsideCollaborators": {
- "method": "GET",
- "params": {
- "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/orgs/:org/outside_collaborators"
- },
- "listPublicMembers": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/orgs/:org/public_members"
- },
- "pingHook": {
- "method": "POST",
- "params": {
- "hook_id": { "required": true, "type": "integer" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/hooks/:hook_id/pings"
- },
- "publicizeMembership": {
- "method": "PUT",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/public_members/:username"
- },
- "removeMember": {
- "method": "DELETE",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/members/:username"
- },
- "removeMembership": {
- "method": "DELETE",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/memberships/:username"
- },
- "removeOutsideCollaborator": {
- "method": "DELETE",
- "params": {
- "org": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/outside_collaborators/:username"
- },
- "update": {
- "method": "PATCH",
- "params": {
- "billing_email": { "type": "string" },
- "company": { "type": "string" },
- "default_repository_permission": {
- "enum": ["read", "write", "admin", "none"],
- "type": "string"
- },
- "description": { "type": "string" },
- "email": { "type": "string" },
- "has_organization_projects": { "type": "boolean" },
- "has_repository_projects": { "type": "boolean" },
- "location": { "type": "string" },
- "members_allowed_repository_creation_type": {
- "enum": ["all", "private", "none"],
- "type": "string"
- },
- "members_can_create_repositories": { "type": "boolean" },
- "name": { "type": "string" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org"
- },
- "updateHook": {
- "method": "PATCH",
- "params": {
- "active": { "type": "boolean" },
- "config": { "type": "object" },
- "config.content_type": { "type": "string" },
- "config.insecure_ssl": { "type": "string" },
- "config.secret": { "type": "string" },
- "config.url": { "required": true, "type": "string" },
- "events": { "type": "string[]" },
- "hook_id": { "required": true, "type": "integer" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/hooks/:hook_id"
- },
- "updateMembership": {
- "method": "PATCH",
- "params": {
- "org": { "required": true, "type": "string" },
- "state": { "enum": ["active"], "required": true, "type": "string" }
- },
- "url": "/user/memberships/orgs/:org"
- }
- },
- "projects": {
- "addCollaborator": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "PUT",
- "params": {
- "permission": { "enum": ["read", "write", "admin"], "type": "string" },
- "project_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/projects/:project_id/collaborators/:username"
- },
- "createCard": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "POST",
- "params": {
- "column_id": { "required": true, "type": "integer" },
- "content_id": { "type": "integer" },
- "content_type": { "type": "string" },
- "note": { "type": "string" }
- },
- "url": "/projects/columns/:column_id/cards"
- },
- "createColumn": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "POST",
- "params": {
- "name": { "required": true, "type": "string" },
- "project_id": { "required": true, "type": "integer" }
- },
- "url": "/projects/:project_id/columns"
- },
- "createForOrg": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "POST",
- "params": {
- "body": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/orgs/:org/projects"
- },
- "createForRepo": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "POST",
- "params": {
- "body": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/projects"
- },
- "delete": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "DELETE",
- "params": { "project_id": { "required": true, "type": "integer" } },
- "url": "/projects/:project_id"
- },
- "deleteCard": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "DELETE",
- "params": { "card_id": { "required": true, "type": "integer" } },
- "url": "/projects/columns/cards/:card_id"
- },
- "deleteColumn": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "DELETE",
- "params": { "column_id": { "required": true, "type": "integer" } },
- "url": "/projects/columns/:column_id"
- },
- "get": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "project_id": { "required": true, "type": "integer" }
- },
- "url": "/projects/:project_id"
- },
- "getCard": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": { "card_id": { "required": true, "type": "integer" } },
- "url": "/projects/columns/cards/:card_id"
- },
- "getColumn": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": { "column_id": { "required": true, "type": "integer" } },
- "url": "/projects/columns/:column_id"
- },
- "listCards": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "archived_state": {
- "enum": ["all", "archived", "not_archived"],
- "type": "string"
- },
- "column_id": { "required": true, "type": "integer" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/projects/columns/:column_id/cards"
- },
- "listCollaborators": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "affiliation": {
- "enum": ["outside", "direct", "all"],
- "type": "string"
- },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "project_id": { "required": true, "type": "integer" }
- },
- "url": "/projects/:project_id/collaborators"
- },
- "listColumns": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "project_id": { "required": true, "type": "integer" }
- },
- "url": "/projects/:project_id/columns"
- },
- "listForOrg": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/orgs/:org/projects"
- },
- "listForRepo": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/projects"
- },
- "moveCard": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "POST",
- "params": {
- "card_id": { "required": true, "type": "integer" },
- "column_id": { "type": "integer" },
- "position": {
- "required": true,
- "type": "string",
- "validation": "^(top|bottom|after:\\d+)$"
- }
- },
- "url": "/projects/columns/cards/:card_id/moves"
- },
- "moveColumn": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "POST",
- "params": {
- "column_id": { "required": true, "type": "integer" },
- "position": {
- "required": true,
- "type": "string",
- "validation": "^(first|last|after:\\d+)$"
- }
- },
- "url": "/projects/columns/:column_id/moves"
- },
- "removeCollaborator": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "DELETE",
- "params": {
- "project_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/projects/:project_id/collaborators/:username"
- },
- "reviewUserPermissionLevel": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "project_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/projects/:project_id/collaborators/:username/permission"
- },
- "update": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "PATCH",
- "params": {
- "body": { "type": "string" },
- "name": { "type": "string" },
- "organization_permission": { "type": "string" },
- "private": { "type": "boolean" },
- "project_id": { "required": true, "type": "integer" },
- "state": { "enum": ["open", "closed"], "type": "string" }
- },
- "url": "/projects/:project_id"
- },
- "updateCard": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "PATCH",
- "params": {
- "archived": { "type": "boolean" },
- "card_id": { "required": true, "type": "integer" },
- "note": { "type": "string" }
- },
- "url": "/projects/columns/cards/:card_id"
- },
- "updateColumn": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "PATCH",
- "params": {
- "column_id": { "required": true, "type": "integer" },
- "name": { "required": true, "type": "string" }
- },
- "url": "/projects/columns/:column_id"
- }
- },
- "pulls": {
- "checkIfMerged": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
- },
- "create": {
- "method": "POST",
- "params": {
- "base": { "required": true, "type": "string" },
- "body": { "type": "string" },
- "head": { "required": true, "type": "string" },
- "maintainer_can_modify": { "type": "boolean" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "title": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls"
- },
- "createCommentReply": {
- "method": "POST",
- "params": {
- "body": { "required": true, "type": "string" },
- "in_reply_to": { "required": true, "type": "integer" },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
- },
- "createFromIssue": {
- "deprecated": "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request",
- "method": "POST",
- "params": {
- "base": { "required": true, "type": "string" },
- "head": { "required": true, "type": "string" },
- "issue": { "required": true, "type": "integer" },
- "maintainer_can_modify": { "type": "boolean" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls"
- },
- "createReview": {
- "method": "POST",
- "params": {
- "body": { "type": "string" },
- "comments": { "type": "object[]" },
- "comments[].body": { "required": true, "type": "string" },
- "comments[].path": { "required": true, "type": "string" },
- "comments[].position": { "required": true, "type": "integer" },
- "commit_id": { "type": "string" },
- "event": {
- "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
- "type": "string"
- },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
- },
- "createReviewRequest": {
- "method": "POST",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "reviewers": { "type": "string[]" },
- "team_reviewers": { "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
- },
- "deleteComment": {
- "method": "DELETE",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
- },
- "deletePendingReview": {
- "method": "DELETE",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "review_id": { "required": true, "type": "integer" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
- },
- "deleteReviewRequest": {
- "method": "DELETE",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "reviewers": { "type": "string[]" },
- "team_reviewers": { "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
- },
- "dismissReview": {
- "method": "PUT",
- "params": {
- "message": { "required": true, "type": "string" },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "review_id": { "required": true, "type": "integer" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"
- },
- "get": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number"
- },
- "getComment": {
- "method": "GET",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
- },
- "getCommentsForReview": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "review_id": { "required": true, "type": "integer" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"
- },
- "getReview": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "review_id": { "required": true, "type": "integer" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
- },
- "list": {
- "method": "GET",
- "params": {
- "base": { "type": "string" },
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "head": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "sort": {
- "enum": ["created", "updated", "popularity", "long-running"],
- "type": "string"
- },
- "state": { "enum": ["open", "closed", "all"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls"
- },
- "listComments": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "since": { "type": "string" },
- "sort": { "enum": ["created", "updated"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
- },
- "listCommentsForRepo": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "since": { "type": "string" },
- "sort": { "enum": ["created", "updated"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/comments"
- },
- "listCommits": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/commits"
- },
- "listFiles": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/files"
- },
- "listReviewRequests": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
- },
- "listReviews": {
- "method": "GET",
- "params": {
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
- },
- "merge": {
- "method": "PUT",
- "params": {
- "commit_message": { "type": "string" },
- "commit_title": { "type": "string" },
- "merge_method": {
- "enum": ["merge", "squash", "rebase"],
- "type": "string"
- },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "sha": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
- },
- "submitReview": {
- "method": "POST",
- "params": {
- "body": { "type": "string" },
- "event": {
- "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
- "required": true,
- "type": "string"
- },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "review_id": { "required": true, "type": "integer" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"
- },
- "update": {
- "method": "PATCH",
- "params": {
- "base": { "type": "string" },
- "body": { "type": "string" },
- "maintainer_can_modify": { "type": "boolean" },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "state": { "enum": ["open", "closed"], "type": "string" },
- "title": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/:pull_number"
- },
- "updateComment": {
- "method": "PATCH",
- "params": {
- "body": { "required": true, "type": "string" },
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
- }
- },
- "rateLimit": {
- "get": { "method": "GET", "params": {}, "url": "/rate_limit" }
- },
- "reactions": {
- "createForCommitComment": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "POST",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "required": true,
- "type": "string"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
- },
- "createForIssue": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "POST",
- "params": {
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "required": true,
- "type": "string"
- },
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
- },
- "createForIssueComment": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "POST",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "required": true,
- "type": "string"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
- },
- "createForPullRequestReviewComment": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "POST",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "required": true,
- "type": "string"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
- },
- "createForTeamDiscussion": {
- "headers": {
- "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "POST",
- "params": {
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "required": true,
- "type": "string"
- },
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/reactions"
- },
- "createForTeamDiscussionComment": {
- "headers": {
- "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "POST",
- "params": {
- "comment_number": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "required": true,
- "type": "string"
- },
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
- },
- "delete": {
- "headers": {
- "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "DELETE",
- "params": { "reaction_id": { "required": true, "type": "integer" } },
- "url": "/reactions/:reaction_id"
- },
- "listForCommitComment": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "GET",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "type": "string"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
- },
- "listForIssue": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "GET",
- "params": {
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "type": "string"
- },
- "issue_number": { "required": true, "type": "integer" },
- "number": {
- "alias": "issue_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
- },
- "listForIssueComment": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "GET",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "type": "string"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
- },
- "listForPullRequestReviewComment": {
- "headers": {
- "accept": "application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "GET",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "type": "string"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
- },
- "listForTeamDiscussion": {
- "headers": {
- "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "GET",
- "params": {
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "type": "string"
- },
- "discussion_number": { "required": true, "type": "integer" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/reactions"
- },
- "listForTeamDiscussionComment": {
- "headers": {
- "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
- },
- "method": "GET",
- "params": {
- "comment_number": { "required": true, "type": "integer" },
- "content": {
- "enum": [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- "type": "string"
- },
- "discussion_number": { "required": true, "type": "integer" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
- }
- },
- "repos": {
- "acceptInvitation": {
- "method": "PATCH",
- "params": { "invitation_id": { "required": true, "type": "integer" } },
- "url": "/user/repository_invitations/:invitation_id"
- },
- "addCollaborator": {
- "method": "PUT",
- "params": {
- "owner": { "required": true, "type": "string" },
- "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
- "repo": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/collaborators/:username"
- },
- "addDeployKey": {
- "method": "POST",
- "params": {
- "key": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "read_only": { "type": "boolean" },
- "repo": { "required": true, "type": "string" },
- "title": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/keys"
- },
- "addProtectedBranchAdminEnforcement": {
- "method": "POST",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
- },
- "addProtectedBranchRequiredSignatures": {
- "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
- "method": "POST",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
- },
- "addProtectedBranchRequiredStatusChecksContexts": {
- "method": "POST",
- "params": {
- "branch": { "required": true, "type": "string" },
- "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- "addProtectedBranchTeamRestrictions": {
- "method": "POST",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "teams": { "mapTo": "data", "required": true, "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- "addProtectedBranchUserRestrictions": {
- "method": "POST",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "users": { "mapTo": "data", "required": true, "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- "checkCollaborator": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/collaborators/:username"
- },
- "compareCommits": {
- "method": "GET",
- "params": {
- "base": { "required": true, "type": "string" },
- "head": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/compare/:base...:head"
- },
- "createCommitComment": {
- "method": "POST",
- "params": {
- "body": { "required": true, "type": "string" },
- "commit_sha": { "required": true, "type": "string" },
- "line": { "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "path": { "type": "string" },
- "position": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "sha": { "alias": "commit_sha", "deprecated": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
- },
- "createDeployment": {
- "method": "POST",
- "params": {
- "auto_merge": { "type": "boolean" },
- "description": { "type": "string" },
- "environment": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "payload": { "type": "string" },
- "production_environment": { "type": "boolean" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "required_contexts": { "type": "string[]" },
- "task": { "type": "string" },
- "transient_environment": { "type": "boolean" }
- },
- "url": "/repos/:owner/:repo/deployments"
- },
- "createDeploymentStatus": {
- "method": "POST",
- "params": {
- "auto_inactive": { "type": "boolean" },
- "deployment_id": { "required": true, "type": "integer" },
- "description": { "type": "string" },
- "environment": {
- "enum": ["production", "staging", "qa"],
- "type": "string"
- },
- "environment_url": { "type": "string" },
- "log_url": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "state": {
- "enum": [
- "error",
- "failure",
- "inactive",
- "in_progress",
- "queued",
- "pending",
- "success"
- ],
- "required": true,
- "type": "string"
- },
- "target_url": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
- },
- "createFile": {
- "deprecated": "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
- "method": "PUT",
- "params": {
- "author": { "type": "object" },
- "author.email": { "required": true, "type": "string" },
- "author.name": { "required": true, "type": "string" },
- "branch": { "type": "string" },
- "committer": { "type": "object" },
- "committer.email": { "required": true, "type": "string" },
- "committer.name": { "required": true, "type": "string" },
- "content": { "required": true, "type": "string" },
- "message": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "path": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/contents/:path"
- },
- "createForAuthenticatedUser": {
- "method": "POST",
- "params": {
- "allow_merge_commit": { "type": "boolean" },
- "allow_rebase_merge": { "type": "boolean" },
- "allow_squash_merge": { "type": "boolean" },
- "auto_init": { "type": "boolean" },
- "description": { "type": "string" },
- "gitignore_template": { "type": "string" },
- "has_issues": { "type": "boolean" },
- "has_projects": { "type": "boolean" },
- "has_wiki": { "type": "boolean" },
- "homepage": { "type": "string" },
- "license_template": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "private": { "type": "boolean" },
- "team_id": { "type": "integer" }
- },
- "url": "/user/repos"
- },
- "createFork": {
- "method": "POST",
- "params": {
- "organization": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/forks"
- },
- "createHook": {
- "method": "POST",
- "params": {
- "active": { "type": "boolean" },
- "config": { "required": true, "type": "object" },
- "config.content_type": { "type": "string" },
- "config.insecure_ssl": { "type": "string" },
- "config.secret": { "type": "string" },
- "config.url": { "required": true, "type": "string" },
- "events": { "type": "string[]" },
- "name": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/hooks"
- },
- "createInOrg": {
- "method": "POST",
- "params": {
- "allow_merge_commit": { "type": "boolean" },
- "allow_rebase_merge": { "type": "boolean" },
- "allow_squash_merge": { "type": "boolean" },
- "auto_init": { "type": "boolean" },
- "description": { "type": "string" },
- "gitignore_template": { "type": "string" },
- "has_issues": { "type": "boolean" },
- "has_projects": { "type": "boolean" },
- "has_wiki": { "type": "boolean" },
- "homepage": { "type": "string" },
- "license_template": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "org": { "required": true, "type": "string" },
- "private": { "type": "boolean" },
- "team_id": { "type": "integer" }
- },
- "url": "/orgs/:org/repos"
- },
- "createOrUpdateFile": {
- "method": "PUT",
- "params": {
- "author": { "type": "object" },
- "author.email": { "required": true, "type": "string" },
- "author.name": { "required": true, "type": "string" },
- "branch": { "type": "string" },
- "committer": { "type": "object" },
- "committer.email": { "required": true, "type": "string" },
- "committer.name": { "required": true, "type": "string" },
- "content": { "required": true, "type": "string" },
- "message": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "path": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/contents/:path"
- },
- "createRelease": {
- "method": "POST",
- "params": {
- "body": { "type": "string" },
- "draft": { "type": "boolean" },
- "name": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "prerelease": { "type": "boolean" },
- "repo": { "required": true, "type": "string" },
- "tag_name": { "required": true, "type": "string" },
- "target_commitish": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases"
- },
- "createStatus": {
- "method": "POST",
- "params": {
- "context": { "type": "string" },
- "description": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "required": true, "type": "string" },
- "state": {
- "enum": ["error", "failure", "pending", "success"],
- "required": true,
- "type": "string"
- },
- "target_url": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/statuses/:sha"
- },
- "declineInvitation": {
- "method": "DELETE",
- "params": { "invitation_id": { "required": true, "type": "integer" } },
- "url": "/user/repository_invitations/:invitation_id"
- },
- "delete": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo"
- },
- "deleteCommitComment": {
- "method": "DELETE",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/comments/:comment_id"
- },
- "deleteDownload": {
- "method": "DELETE",
- "params": {
- "download_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/downloads/:download_id"
- },
- "deleteFile": {
- "method": "DELETE",
- "params": {
- "author": { "type": "object" },
- "author.email": { "type": "string" },
- "author.name": { "type": "string" },
- "branch": { "type": "string" },
- "committer": { "type": "object" },
- "committer.email": { "type": "string" },
- "committer.name": { "type": "string" },
- "message": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "path": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/contents/:path"
- },
- "deleteHook": {
- "method": "DELETE",
- "params": {
- "hook_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/hooks/:hook_id"
- },
- "deleteInvitation": {
- "method": "DELETE",
- "params": {
- "invitation_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/invitations/:invitation_id"
- },
- "deleteRelease": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "release_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/:release_id"
- },
- "deleteReleaseAsset": {
- "method": "DELETE",
- "params": {
- "asset_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/assets/:asset_id"
- },
- "get": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo"
- },
- "getArchiveLink": {
- "method": "GET",
- "params": {
- "archive_format": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/:archive_format/:ref"
- },
- "getBranch": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch"
- },
- "getBranchProtection": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection"
- },
- "getCodeFrequencyStats": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/stats/code_frequency"
- },
- "getCollaboratorPermissionLevel": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/collaborators/:username/permission"
- },
- "getCombinedStatusForRef": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits/:ref/status"
- },
- "getCommit": {
- "method": "GET",
- "params": {
- "commit_sha": { "alias": "ref", "deprecated": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "alias": "ref", "deprecated": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits/:ref"
- },
- "getCommitActivityStats": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/stats/commit_activity"
- },
- "getCommitComment": {
- "method": "GET",
- "params": {
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/comments/:comment_id"
- },
- "getCommitRefSha": {
- "deprecated": "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit",
- "headers": { "accept": "application/vnd.github.v3.sha" },
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits/:ref"
- },
- "getContents": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "path": { "required": true, "type": "string" },
- "ref": { "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/contents/:path"
- },
- "getContributorsStats": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/stats/contributors"
- },
- "getDeployKey": {
- "method": "GET",
- "params": {
- "key_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/keys/:key_id"
- },
- "getDeployment": {
- "method": "GET",
- "params": {
- "deployment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/deployments/:deployment_id"
- },
- "getDeploymentStatus": {
- "method": "GET",
- "params": {
- "deployment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "status_id": { "required": true, "type": "integer" }
- },
- "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"
- },
- "getDownload": {
- "method": "GET",
- "params": {
- "download_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/downloads/:download_id"
- },
- "getHook": {
- "method": "GET",
- "params": {
- "hook_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/hooks/:hook_id"
- },
- "getLatestPagesBuild": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pages/builds/latest"
- },
- "getLatestRelease": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/latest"
- },
- "getPages": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pages"
- },
- "getPagesBuild": {
- "method": "GET",
- "params": {
- "build_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pages/builds/:build_id"
- },
- "getParticipationStats": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/stats/participation"
- },
- "getProtectedBranchAdminEnforcement": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
- },
- "getProtectedBranchPullRequestReviewEnforcement": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
- },
- "getProtectedBranchRequiredSignatures": {
- "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
- },
- "getProtectedBranchRequiredStatusChecks": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
- },
- "getProtectedBranchRestrictions": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
- },
- "getPunchCardStats": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/stats/punch_card"
- },
- "getReadme": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "ref": { "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/readme"
- },
- "getRelease": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "release_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/:release_id"
- },
- "getReleaseAsset": {
- "method": "GET",
- "params": {
- "asset_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/assets/:asset_id"
- },
- "getReleaseByTag": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "tag": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/tags/:tag"
- },
- "getTeamsWithAccessToProtectedBranch": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- "getUsersWithAccessToProtectedBranch": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- "list": {
- "method": "GET",
- "params": {
- "affiliation": { "type": "string" },
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "sort": {
- "enum": ["created", "updated", "pushed", "full_name"],
- "type": "string"
- },
- "type": {
- "enum": ["all", "owner", "public", "private", "member"],
- "type": "string"
- },
- "visibility": { "enum": ["all", "public", "private"], "type": "string" }
- },
- "url": "/user/repos"
- },
- "listAssetsForRelease": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "release_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/:release_id/assets"
- },
- "listBranches": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "protected": { "type": "boolean" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches"
- },
- "listCollaborators": {
- "method": "GET",
- "params": {
- "affiliation": {
- "enum": ["outside", "direct", "all"],
- "type": "string"
- },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/collaborators"
- },
- "listCommentsForCommit": {
- "method": "GET",
- "params": {
- "commit_sha": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "ref": { "alias": "commit_sha", "deprecated": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
- },
- "listCommitComments": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/comments"
- },
- "listCommits": {
- "method": "GET",
- "params": {
- "author": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "path": { "type": "string" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "sha": { "type": "string" },
- "since": { "type": "string" },
- "until": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits"
- },
- "listContributors": {
- "method": "GET",
- "params": {
- "anon": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/contributors"
- },
- "listDeployKeys": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/keys"
- },
- "listDeploymentStatuses": {
- "method": "GET",
- "params": {
- "deployment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
- },
- "listDeployments": {
- "method": "GET",
- "params": {
- "environment": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "ref": { "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "type": "string" },
- "task": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/deployments"
- },
- "listDownloads": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/downloads"
- },
- "listForOrg": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "type": {
- "enum": ["all", "public", "private", "forks", "sources", "member"],
- "type": "string"
- }
- },
- "url": "/orgs/:org/repos"
- },
- "listForUser": {
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "sort": {
- "enum": ["created", "updated", "pushed", "full_name"],
- "type": "string"
- },
- "type": { "enum": ["all", "owner", "member"], "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/repos"
- },
- "listForks": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "sort": { "enum": ["newest", "oldest", "stargazers"], "type": "string" }
- },
- "url": "/repos/:owner/:repo/forks"
- },
- "listHooks": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/hooks"
- },
- "listInvitations": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/invitations"
- },
- "listInvitationsForAuthenticatedUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/repository_invitations"
- },
- "listLanguages": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/languages"
- },
- "listPagesBuilds": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pages/builds"
- },
- "listProtectedBranchRequiredStatusChecksContexts": {
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- "listProtectedBranchTeamRestrictions": {
- "deprecated": "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)",
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- "listProtectedBranchUserRestrictions": {
- "deprecated": "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)",
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- "listPublic": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" },
- "visibility": { "type": "string" }
- },
- "url": "/repositories"
- },
- "listReleases": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases"
- },
- "listStatusesForRef": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "ref": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/commits/:ref/statuses"
- },
- "listTags": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/tags"
- },
- "listTeams": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/teams"
- },
- "listTeamsWithAccessToProtectedBranch": {
- "deprecated": "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)",
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- "listTopics": {
- "headers": { "accept": "application/vnd.github.mercy-preview+json" },
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/topics"
- },
- "listUsersWithAccessToProtectedBranch": {
- "deprecated": "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)",
- "method": "GET",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- "merge": {
- "method": "POST",
- "params": {
- "base": { "required": true, "type": "string" },
- "commit_message": { "type": "string" },
- "head": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/merges"
- },
- "pingHook": {
- "method": "POST",
- "params": {
- "hook_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/hooks/:hook_id/pings"
- },
- "removeBranchProtection": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection"
- },
- "removeCollaborator": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/collaborators/:username"
- },
- "removeDeployKey": {
- "method": "DELETE",
- "params": {
- "key_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/keys/:key_id"
- },
- "removeProtectedBranchAdminEnforcement": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
- },
- "removeProtectedBranchPullRequestReviewEnforcement": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
- },
- "removeProtectedBranchRequiredSignatures": {
- "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
- },
- "removeProtectedBranchRequiredStatusChecks": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
- },
- "removeProtectedBranchRequiredStatusChecksContexts": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- "removeProtectedBranchRestrictions": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
- },
- "removeProtectedBranchTeamRestrictions": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "teams": { "mapTo": "data", "required": true, "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- "removeProtectedBranchUserRestrictions": {
- "method": "DELETE",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "users": { "mapTo": "data", "required": true, "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- "replaceProtectedBranchRequiredStatusChecksContexts": {
- "method": "PUT",
- "params": {
- "branch": { "required": true, "type": "string" },
- "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- "replaceProtectedBranchTeamRestrictions": {
- "method": "PUT",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "teams": { "mapTo": "data", "required": true, "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- "replaceProtectedBranchUserRestrictions": {
- "method": "PUT",
- "params": {
- "branch": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "users": { "mapTo": "data", "required": true, "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- "replaceTopics": {
- "headers": { "accept": "application/vnd.github.mercy-preview+json" },
- "method": "PUT",
- "params": {
- "names": { "required": true, "type": "string[]" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/topics"
- },
- "requestPageBuild": {
- "headers": {
- "accept": "application/vnd.github.mister-fantastic-preview+json"
- },
- "method": "POST",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pages/builds"
- },
- "testPushHook": {
- "method": "POST",
- "params": {
- "hook_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/hooks/:hook_id/tests"
- },
- "transfer": {
- "headers": { "accept": "application/vnd.github.nightshade-preview+json" },
- "method": "POST",
- "params": {
- "new_owner": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "team_ids": { "type": "integer[]" }
- },
- "url": "/repos/:owner/:repo/transfer"
- },
- "update": {
- "headers": { "accept": "application/vnd.github.x-ray-preview+json" },
- "method": "PATCH",
- "params": {
- "allow_merge_commit": { "type": "boolean" },
- "allow_rebase_merge": { "type": "boolean" },
- "allow_squash_merge": { "type": "boolean" },
- "anonymous_access_enabled": { "type": "boolean" },
- "archived": { "type": "boolean" },
- "default_branch": { "type": "string" },
- "description": { "type": "string" },
- "has_issues": { "type": "boolean" },
- "has_projects": { "type": "boolean" },
- "has_wiki": { "type": "boolean" },
- "homepage": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "private": { "type": "boolean" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo"
- },
- "updateBranchProtection": {
- "method": "PUT",
- "params": {
- "branch": { "required": true, "type": "string" },
- "enforce_admins": {
- "allowNull": true,
- "required": true,
- "type": "boolean"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "required_pull_request_reviews": {
- "allowNull": true,
- "required": true,
- "type": "object"
- },
- "required_pull_request_reviews.dismiss_stale_reviews": {
- "type": "boolean"
- },
- "required_pull_request_reviews.dismissal_restrictions": {
- "type": "object"
- },
- "required_pull_request_reviews.dismissal_restrictions.teams": {
- "type": "string[]"
- },
- "required_pull_request_reviews.dismissal_restrictions.users": {
- "type": "string[]"
- },
- "required_pull_request_reviews.require_code_owner_reviews": {
- "type": "boolean"
- },
- "required_pull_request_reviews.required_approving_review_count": {
- "type": "integer"
- },
- "required_status_checks": {
- "allowNull": true,
- "required": true,
- "type": "object"
- },
- "required_status_checks.contexts": {
- "required": true,
- "type": "string[]"
- },
- "required_status_checks.strict": {
- "required": true,
- "type": "boolean"
- },
- "restrictions": {
- "allowNull": true,
- "required": true,
- "type": "object"
- },
- "restrictions.teams": { "required": true, "type": "string[]" },
- "restrictions.users": { "required": true, "type": "string[]" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection"
- },
- "updateCommitComment": {
- "method": "PATCH",
- "params": {
- "body": { "required": true, "type": "string" },
- "comment_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/comments/:comment_id"
- },
- "updateFile": {
- "deprecated": "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
- "method": "PUT",
- "params": {
- "author": { "type": "object" },
- "author.email": { "required": true, "type": "string" },
- "author.name": { "required": true, "type": "string" },
- "branch": { "type": "string" },
- "committer": { "type": "object" },
- "committer.email": { "required": true, "type": "string" },
- "committer.name": { "required": true, "type": "string" },
- "content": { "required": true, "type": "string" },
- "message": { "required": true, "type": "string" },
- "owner": { "required": true, "type": "string" },
- "path": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "sha": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/contents/:path"
- },
- "updateHook": {
- "method": "PATCH",
- "params": {
- "active": { "type": "boolean" },
- "add_events": { "type": "string[]" },
- "config": { "type": "object" },
- "config.content_type": { "type": "string" },
- "config.insecure_ssl": { "type": "string" },
- "config.secret": { "type": "string" },
- "config.url": { "required": true, "type": "string" },
- "events": { "type": "string[]" },
- "hook_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "remove_events": { "type": "string[]" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/hooks/:hook_id"
- },
- "updateInformationAboutPagesSite": {
- "method": "PUT",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "source": {
- "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""],
- "type": "string"
- }
- },
- "url": "/repos/:owner/:repo/pages"
- },
- "updateInvitation": {
- "method": "PATCH",
- "params": {
- "invitation_id": { "required": true, "type": "integer" },
- "owner": { "required": true, "type": "string" },
- "permissions": { "enum": ["read", "write", "admin"], "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/invitations/:invitation_id"
- },
- "updateProtectedBranchPullRequestReviewEnforcement": {
- "method": "PATCH",
- "params": {
- "branch": { "required": true, "type": "string" },
- "dismiss_stale_reviews": { "type": "boolean" },
- "dismissal_restrictions": { "type": "object" },
- "dismissal_restrictions.teams": { "type": "string[]" },
- "dismissal_restrictions.users": { "type": "string[]" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "require_code_owner_reviews": { "type": "boolean" },
- "required_approving_review_count": { "type": "integer" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
- },
- "updateProtectedBranchRequiredStatusChecks": {
- "method": "PATCH",
- "params": {
- "branch": { "required": true, "type": "string" },
- "contexts": { "type": "string[]" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "strict": { "type": "boolean" }
- },
- "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
- },
- "updateRelease": {
- "method": "PATCH",
- "params": {
- "body": { "type": "string" },
- "draft": { "type": "boolean" },
- "name": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "prerelease": { "type": "boolean" },
- "release_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" },
- "tag_name": { "type": "string" },
- "target_commitish": { "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/:release_id"
- },
- "updateReleaseAsset": {
- "method": "PATCH",
- "params": {
- "asset_id": { "required": true, "type": "integer" },
- "label": { "type": "string" },
- "name": { "type": "string" },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/releases/assets/:asset_id"
- },
- "uploadReleaseAsset": {
- "method": "POST",
- "params": {
- "file": {
- "mapTo": "data",
- "required": true,
- "type": "string | object"
- },
- "headers": { "required": true, "type": "object" },
- "headers.content-length": { "required": true, "type": "integer" },
- "headers.content-type": { "required": true, "type": "string" },
- "label": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "url": { "required": true, "type": "string" }
- },
- "url": ":url"
- }
- },
- "search": {
- "code": {
- "method": "GET",
- "params": {
- "order": { "enum": ["desc", "asc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "q": { "required": true, "type": "string" },
- "sort": { "enum": ["indexed"], "type": "string" }
- },
- "url": "/search/code"
- },
- "commits": {
- "headers": { "accept": "application/vnd.github.cloak-preview+json" },
- "method": "GET",
- "params": {
- "order": { "enum": ["desc", "asc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "q": { "required": true, "type": "string" },
- "sort": { "enum": ["author-date", "committer-date"], "type": "string" }
- },
- "url": "/search/commits"
- },
- "issues": {
- "deprecated": "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)",
- "method": "GET",
- "params": {
- "order": { "enum": ["desc", "asc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "q": { "required": true, "type": "string" },
- "sort": {
- "enum": [
- "comments",
- "reactions",
- "reactions-+1",
- "reactions--1",
- "reactions-smile",
- "reactions-thinking_face",
- "reactions-heart",
- "reactions-tada",
- "interactions",
- "created",
- "updated"
- ],
- "type": "string"
- }
- },
- "url": "/search/issues"
- },
- "issuesAndPullRequests": {
- "method": "GET",
- "params": {
- "order": { "enum": ["desc", "asc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "q": { "required": true, "type": "string" },
- "sort": {
- "enum": [
- "comments",
- "reactions",
- "reactions-+1",
- "reactions--1",
- "reactions-smile",
- "reactions-thinking_face",
- "reactions-heart",
- "reactions-tada",
- "interactions",
- "created",
- "updated"
- ],
- "type": "string"
- }
- },
- "url": "/search/issues"
- },
- "labels": {
- "method": "GET",
- "params": {
- "order": { "enum": ["desc", "asc"], "type": "string" },
- "q": { "required": true, "type": "string" },
- "repository_id": { "required": true, "type": "integer" },
- "sort": { "enum": ["created", "updated"], "type": "string" }
- },
- "url": "/search/labels"
- },
- "repos": {
- "method": "GET",
- "params": {
- "order": { "enum": ["desc", "asc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "q": { "required": true, "type": "string" },
- "sort": {
- "enum": ["stars", "forks", "help-wanted-issues", "updated"],
- "type": "string"
- }
- },
- "url": "/search/repositories"
- },
- "topics": {
- "method": "GET",
- "params": { "q": { "required": true, "type": "string" } },
- "url": "/search/topics"
- },
- "users": {
- "method": "GET",
- "params": {
- "order": { "enum": ["desc", "asc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "q": { "required": true, "type": "string" },
- "sort": {
- "enum": ["followers", "repositories", "joined"],
- "type": "string"
- }
- },
- "url": "/search/users"
- }
- },
- "teams": {
- "addMember": {
- "deprecated": "octokit.teams.addMember() is deprecated, see https://developer.github.com/enterprise/2.16/v3/teams/members/#add-team-member",
- "method": "PUT",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/members/:username"
- },
- "addOrUpdateMembership": {
- "method": "PUT",
- "params": {
- "role": { "enum": ["member", "maintainer"], "type": "string" },
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/memberships/:username"
- },
- "addOrUpdateProject": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "PUT",
- "params": {
- "permission": { "enum": ["read", "write", "admin"], "type": "string" },
- "project_id": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/projects/:project_id"
- },
- "addOrUpdateRepo": {
- "method": "PUT",
- "params": {
- "owner": { "required": true, "type": "string" },
- "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
- "repo": { "required": true, "type": "string" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/repos/:owner/:repo"
- },
- "checkManagesRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/repos/:owner/:repo"
- },
- "create": {
- "method": "POST",
- "params": {
- "description": { "type": "string" },
- "ldap_dn": { "type": "string" },
- "maintainers": { "type": "string[]" },
- "name": { "required": true, "type": "string" },
- "org": { "required": true, "type": "string" },
- "parent_team_id": { "type": "integer" },
- "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
- "privacy": { "enum": ["secret", "closed"], "type": "string" },
- "repo_names": { "type": "string[]" }
- },
- "url": "/orgs/:org/teams"
- },
- "createDiscussion": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "POST",
- "params": {
- "body": { "required": true, "type": "string" },
- "private": { "type": "boolean" },
- "team_id": { "required": true, "type": "integer" },
- "title": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/discussions"
- },
- "createDiscussionComment": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "POST",
- "params": {
- "body": { "required": true, "type": "string" },
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/comments"
- },
- "delete": {
- "method": "DELETE",
- "params": { "team_id": { "required": true, "type": "integer" } },
- "url": "/teams/:team_id"
- },
- "deleteDiscussion": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "DELETE",
- "params": {
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number"
- },
- "deleteDiscussionComment": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "DELETE",
- "params": {
- "comment_number": { "required": true, "type": "integer" },
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- "get": {
- "method": "GET",
- "params": { "team_id": { "required": true, "type": "integer" } },
- "url": "/teams/:team_id"
- },
- "getDiscussion": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "GET",
- "params": {
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number"
- },
- "getDiscussionComment": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "GET",
- "params": {
- "comment_number": { "required": true, "type": "integer" },
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- "getMember": {
- "deprecated": "octokit.teams.getMember() is deprecated, see https://developer.github.com/enterprise/2.16/v3/teams/members/#get-team-member",
- "method": "GET",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/members/:username"
- },
- "getMembership": {
- "method": "GET",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/memberships/:username"
- },
- "list": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/orgs/:org/teams"
- },
- "listChild": {
- "headers": { "accept": "application/vnd.github.hellcat-preview+json" },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/teams"
- },
- "listDiscussionComments": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "discussion_number": { "required": true, "type": "integer" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/comments"
- },
- "listDiscussions": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "GET",
- "params": {
- "direction": { "enum": ["asc", "desc"], "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions"
- },
- "listForAuthenticatedUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/teams"
- },
- "listMembers": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "role": { "enum": ["member", "maintainer", "all"], "type": "string" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/members"
- },
- "listProjects": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/projects"
- },
- "listRepos": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/repos"
- },
- "removeMember": {
- "deprecated": "octokit.teams.removeMember() is deprecated, see https://developer.github.com/enterprise/2.16/v3/teams/members/#remove-team-member",
- "method": "DELETE",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/members/:username"
- },
- "removeMembership": {
- "method": "DELETE",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/memberships/:username"
- },
- "removeProject": {
- "method": "DELETE",
- "params": {
- "project_id": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/projects/:project_id"
- },
- "removeRepo": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/repos/:owner/:repo"
- },
- "reviewProject": {
- "headers": { "accept": "application/vnd.github.inertia-preview+json" },
- "method": "GET",
- "params": {
- "project_id": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/projects/:project_id"
- },
- "update": {
- "method": "PATCH",
- "params": {
- "description": { "type": "string" },
- "name": { "required": true, "type": "string" },
- "parent_team_id": { "type": "integer" },
- "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
- "privacy": { "enum": ["secret", "closed"], "type": "string" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id"
- },
- "updateDiscussion": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "PATCH",
- "params": {
- "body": { "type": "string" },
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" },
- "title": { "type": "string" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number"
- },
- "updateDiscussionComment": {
- "headers": { "accept": "application/vnd.github.echo-preview+json" },
- "method": "PATCH",
- "params": {
- "body": { "required": true, "type": "string" },
- "comment_number": { "required": true, "type": "integer" },
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- }
- },
- "users": {
- "addEmails": {
- "method": "POST",
- "params": { "emails": { "required": true, "type": "string[]" } },
- "url": "/user/emails"
- },
- "checkFollowing": {
- "method": "GET",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/user/following/:username"
- },
- "checkFollowingForUser": {
- "method": "GET",
- "params": {
- "target_user": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/following/:target_user"
- },
- "createGpgKey": {
- "method": "POST",
- "params": { "armored_public_key": { "type": "string" } },
- "url": "/user/gpg_keys"
- },
- "createPublicKey": {
- "method": "POST",
- "params": { "key": { "type": "string" }, "title": { "type": "string" } },
- "url": "/user/keys"
- },
- "deleteEmails": {
- "method": "DELETE",
- "params": { "emails": { "required": true, "type": "string[]" } },
- "url": "/user/emails"
- },
- "deleteGpgKey": {
- "method": "DELETE",
- "params": { "gpg_key_id": { "required": true, "type": "integer" } },
- "url": "/user/gpg_keys/:gpg_key_id"
- },
- "deletePublicKey": {
- "method": "DELETE",
- "params": { "key_id": { "required": true, "type": "integer" } },
- "url": "/user/keys/:key_id"
- },
- "follow": {
- "method": "PUT",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/user/following/:username"
- },
- "getAuthenticated": { "method": "GET", "params": {}, "url": "/user" },
- "getByUsername": {
- "method": "GET",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/users/:username"
- },
- "getContextForUser": {
- "headers": { "accept": "application/vnd.github.hagar-preview+json" },
- "method": "GET",
- "params": {
- "subject_id": { "type": "string" },
- "subject_type": {
- "enum": ["organization", "repository", "issue", "pull_request"],
- "type": "string"
- },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/hovercard"
- },
- "getGpgKey": {
- "method": "GET",
- "params": { "gpg_key_id": { "required": true, "type": "integer" } },
- "url": "/user/gpg_keys/:gpg_key_id"
- },
- "getPublicKey": {
- "method": "GET",
- "params": { "key_id": { "required": true, "type": "integer" } },
- "url": "/user/keys/:key_id"
- },
- "list": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "since": { "type": "string" }
- },
- "url": "/users"
- },
- "listEmails": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/emails"
- },
- "listFollowersForAuthenticatedUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/followers"
- },
- "listFollowersForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/followers"
- },
- "listFollowingForAuthenticatedUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/following"
- },
- "listFollowingForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/following"
- },
- "listGpgKeys": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/gpg_keys"
- },
- "listGpgKeysForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/gpg_keys"
- },
- "listPublicEmails": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/public_emails"
- },
- "listPublicKeys": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/user/keys"
- },
- "listPublicKeysForUser": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/keys"
- },
- "unfollow": {
- "method": "DELETE",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/user/following/:username"
- },
- "updateAuthenticated": {
- "method": "PATCH",
- "params": {
- "bio": { "type": "string" },
- "blog": { "type": "string" },
- "company": { "type": "string" },
- "email": { "type": "string" },
- "hireable": { "type": "boolean" },
- "location": { "type": "string" },
- "name": { "type": "string" }
- },
- "url": "/user"
- }
- }
- }
|