all.json 184 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455
  1. {
  2. "activity": {
  3. "checkStarringRepo": {
  4. "method": "GET",
  5. "params": {
  6. "owner": { "required": true, "type": "string" },
  7. "repo": { "required": true, "type": "string" }
  8. },
  9. "url": "/user/starred/:owner/:repo"
  10. },
  11. "deleteRepoSubscription": {
  12. "method": "DELETE",
  13. "params": {
  14. "owner": { "required": true, "type": "string" },
  15. "repo": { "required": true, "type": "string" }
  16. },
  17. "url": "/repos/:owner/:repo/subscription"
  18. },
  19. "deleteThreadSubscription": {
  20. "method": "DELETE",
  21. "params": { "thread_id": { "required": true, "type": "integer" } },
  22. "url": "/notifications/threads/:thread_id/subscription"
  23. },
  24. "getRepoSubscription": {
  25. "method": "GET",
  26. "params": {
  27. "owner": { "required": true, "type": "string" },
  28. "repo": { "required": true, "type": "string" }
  29. },
  30. "url": "/repos/:owner/:repo/subscription"
  31. },
  32. "getThread": {
  33. "method": "GET",
  34. "params": { "thread_id": { "required": true, "type": "integer" } },
  35. "url": "/notifications/threads/:thread_id"
  36. },
  37. "getThreadSubscription": {
  38. "method": "GET",
  39. "params": { "thread_id": { "required": true, "type": "integer" } },
  40. "url": "/notifications/threads/:thread_id/subscription"
  41. },
  42. "listEventsForOrg": {
  43. "method": "GET",
  44. "params": {
  45. "org": { "required": true, "type": "string" },
  46. "page": { "type": "integer" },
  47. "per_page": { "type": "integer" },
  48. "username": { "required": true, "type": "string" }
  49. },
  50. "url": "/users/:username/events/orgs/:org"
  51. },
  52. "listEventsForUser": {
  53. "method": "GET",
  54. "params": {
  55. "page": { "type": "integer" },
  56. "per_page": { "type": "integer" },
  57. "username": { "required": true, "type": "string" }
  58. },
  59. "url": "/users/:username/events"
  60. },
  61. "listFeeds": { "method": "GET", "params": {}, "url": "/feeds" },
  62. "listNotifications": {
  63. "method": "GET",
  64. "params": {
  65. "all": { "type": "boolean" },
  66. "before": { "type": "string" },
  67. "page": { "type": "integer" },
  68. "participating": { "type": "boolean" },
  69. "per_page": { "type": "integer" },
  70. "since": { "type": "string" }
  71. },
  72. "url": "/notifications"
  73. },
  74. "listNotificationsForRepo": {
  75. "method": "GET",
  76. "params": {
  77. "all": { "type": "boolean" },
  78. "before": { "type": "string" },
  79. "owner": { "required": true, "type": "string" },
  80. "page": { "type": "integer" },
  81. "participating": { "type": "boolean" },
  82. "per_page": { "type": "integer" },
  83. "repo": { "required": true, "type": "string" },
  84. "since": { "type": "string" }
  85. },
  86. "url": "/repos/:owner/:repo/notifications"
  87. },
  88. "listPublicEvents": {
  89. "method": "GET",
  90. "params": {
  91. "page": { "type": "integer" },
  92. "per_page": { "type": "integer" }
  93. },
  94. "url": "/events"
  95. },
  96. "listPublicEventsForOrg": {
  97. "method": "GET",
  98. "params": {
  99. "org": { "required": true, "type": "string" },
  100. "page": { "type": "integer" },
  101. "per_page": { "type": "integer" }
  102. },
  103. "url": "/orgs/:org/events"
  104. },
  105. "listPublicEventsForRepoNetwork": {
  106. "method": "GET",
  107. "params": {
  108. "owner": { "required": true, "type": "string" },
  109. "page": { "type": "integer" },
  110. "per_page": { "type": "integer" },
  111. "repo": { "required": true, "type": "string" }
  112. },
  113. "url": "/networks/:owner/:repo/events"
  114. },
  115. "listPublicEventsForUser": {
  116. "method": "GET",
  117. "params": {
  118. "page": { "type": "integer" },
  119. "per_page": { "type": "integer" },
  120. "username": { "required": true, "type": "string" }
  121. },
  122. "url": "/users/:username/events/public"
  123. },
  124. "listReceivedEventsForUser": {
  125. "method": "GET",
  126. "params": {
  127. "page": { "type": "integer" },
  128. "per_page": { "type": "integer" },
  129. "username": { "required": true, "type": "string" }
  130. },
  131. "url": "/users/:username/received_events"
  132. },
  133. "listReceivedPublicEventsForUser": {
  134. "method": "GET",
  135. "params": {
  136. "page": { "type": "integer" },
  137. "per_page": { "type": "integer" },
  138. "username": { "required": true, "type": "string" }
  139. },
  140. "url": "/users/:username/received_events/public"
  141. },
  142. "listRepoEvents": {
  143. "method": "GET",
  144. "params": {
  145. "owner": { "required": true, "type": "string" },
  146. "page": { "type": "integer" },
  147. "per_page": { "type": "integer" },
  148. "repo": { "required": true, "type": "string" }
  149. },
  150. "url": "/repos/:owner/:repo/events"
  151. },
  152. "listReposStarredByAuthenticatedUser": {
  153. "method": "GET",
  154. "params": {
  155. "direction": { "enum": ["asc", "desc"], "type": "string" },
  156. "page": { "type": "integer" },
  157. "per_page": { "type": "integer" },
  158. "sort": { "enum": ["created", "updated"], "type": "string" }
  159. },
  160. "url": "/user/starred"
  161. },
  162. "listReposStarredByUser": {
  163. "method": "GET",
  164. "params": {
  165. "direction": { "enum": ["asc", "desc"], "type": "string" },
  166. "page": { "type": "integer" },
  167. "per_page": { "type": "integer" },
  168. "sort": { "enum": ["created", "updated"], "type": "string" },
  169. "username": { "required": true, "type": "string" }
  170. },
  171. "url": "/users/:username/starred"
  172. },
  173. "listReposWatchedByUser": {
  174. "method": "GET",
  175. "params": {
  176. "page": { "type": "integer" },
  177. "per_page": { "type": "integer" },
  178. "username": { "required": true, "type": "string" }
  179. },
  180. "url": "/users/:username/subscriptions"
  181. },
  182. "listStargazersForRepo": {
  183. "method": "GET",
  184. "params": {
  185. "owner": { "required": true, "type": "string" },
  186. "page": { "type": "integer" },
  187. "per_page": { "type": "integer" },
  188. "repo": { "required": true, "type": "string" }
  189. },
  190. "url": "/repos/:owner/:repo/stargazers"
  191. },
  192. "listWatchedReposForAuthenticatedUser": {
  193. "method": "GET",
  194. "params": {
  195. "page": { "type": "integer" },
  196. "per_page": { "type": "integer" }
  197. },
  198. "url": "/user/subscriptions"
  199. },
  200. "listWatchersForRepo": {
  201. "method": "GET",
  202. "params": {
  203. "owner": { "required": true, "type": "string" },
  204. "page": { "type": "integer" },
  205. "per_page": { "type": "integer" },
  206. "repo": { "required": true, "type": "string" }
  207. },
  208. "url": "/repos/:owner/:repo/subscribers"
  209. },
  210. "markAsRead": {
  211. "method": "PUT",
  212. "params": { "last_read_at": { "type": "string" } },
  213. "url": "/notifications"
  214. },
  215. "markNotificationsAsReadForRepo": {
  216. "method": "PUT",
  217. "params": {
  218. "last_read_at": { "type": "string" },
  219. "owner": { "required": true, "type": "string" },
  220. "repo": { "required": true, "type": "string" }
  221. },
  222. "url": "/repos/:owner/:repo/notifications"
  223. },
  224. "markThreadAsRead": {
  225. "method": "PATCH",
  226. "params": { "thread_id": { "required": true, "type": "integer" } },
  227. "url": "/notifications/threads/:thread_id"
  228. },
  229. "setRepoSubscription": {
  230. "method": "PUT",
  231. "params": {
  232. "ignored": { "type": "boolean" },
  233. "owner": { "required": true, "type": "string" },
  234. "repo": { "required": true, "type": "string" },
  235. "subscribed": { "type": "boolean" }
  236. },
  237. "url": "/repos/:owner/:repo/subscription"
  238. },
  239. "setThreadSubscription": {
  240. "method": "PUT",
  241. "params": {
  242. "ignored": { "type": "boolean" },
  243. "thread_id": { "required": true, "type": "integer" }
  244. },
  245. "url": "/notifications/threads/:thread_id/subscription"
  246. },
  247. "starRepo": {
  248. "method": "PUT",
  249. "params": {
  250. "owner": { "required": true, "type": "string" },
  251. "repo": { "required": true, "type": "string" }
  252. },
  253. "url": "/user/starred/:owner/:repo"
  254. },
  255. "unstarRepo": {
  256. "method": "DELETE",
  257. "params": {
  258. "owner": { "required": true, "type": "string" },
  259. "repo": { "required": true, "type": "string" }
  260. },
  261. "url": "/user/starred/:owner/:repo"
  262. }
  263. },
  264. "apps": {
  265. "addRepoToInstallation": {
  266. "headers": {
  267. "accept": "application/vnd.github.machine-man-preview+json"
  268. },
  269. "method": "PUT",
  270. "params": {
  271. "installation_id": { "required": true, "type": "integer" },
  272. "repository_id": { "required": true, "type": "integer" }
  273. },
  274. "url": "/user/installations/:installation_id/repositories/:repository_id"
  275. },
  276. "createContentAttachment": {
  277. "headers": { "accept": "application/vnd.github.corsair-preview+json" },
  278. "method": "POST",
  279. "params": {
  280. "body": { "required": true, "type": "string" },
  281. "content_reference_id": { "required": true, "type": "integer" },
  282. "title": { "required": true, "type": "string" }
  283. },
  284. "url": "/content_references/:content_reference_id/attachments"
  285. },
  286. "createFromManifest": {
  287. "method": "POST",
  288. "params": { "code": { "required": true, "type": "string" } },
  289. "url": "/app-manifests/:code/conversions"
  290. },
  291. "createInstallationToken": {
  292. "headers": {
  293. "accept": "application/vnd.github.machine-man-preview+json"
  294. },
  295. "method": "POST",
  296. "params": { "installation_id": { "required": true, "type": "integer" } },
  297. "url": "/app/installations/:installation_id/access_tokens"
  298. },
  299. "findOrgInstallation": {
  300. "deprecated": "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)",
  301. "headers": {
  302. "accept": "application/vnd.github.machine-man-preview+json"
  303. },
  304. "method": "GET",
  305. "params": { "org": { "required": true, "type": "string" } },
  306. "url": "/orgs/:org/installation"
  307. },
  308. "findRepoInstallation": {
  309. "deprecated": "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)",
  310. "headers": {
  311. "accept": "application/vnd.github.machine-man-preview+json"
  312. },
  313. "method": "GET",
  314. "params": {
  315. "owner": { "required": true, "type": "string" },
  316. "repo": { "required": true, "type": "string" }
  317. },
  318. "url": "/repos/:owner/:repo/installation"
  319. },
  320. "findUserInstallation": {
  321. "deprecated": "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)",
  322. "headers": {
  323. "accept": "application/vnd.github.machine-man-preview+json"
  324. },
  325. "method": "GET",
  326. "params": { "username": { "required": true, "type": "string" } },
  327. "url": "/users/:username/installation"
  328. },
  329. "getAuthenticated": {
  330. "headers": {
  331. "accept": "application/vnd.github.machine-man-preview+json"
  332. },
  333. "method": "GET",
  334. "params": {},
  335. "url": "/app"
  336. },
  337. "getBySlug": {
  338. "headers": {
  339. "accept": "application/vnd.github.machine-man-preview+json"
  340. },
  341. "method": "GET",
  342. "params": { "app_slug": { "required": true, "type": "string" } },
  343. "url": "/apps/:app_slug"
  344. },
  345. "getInstallation": {
  346. "headers": {
  347. "accept": "application/vnd.github.machine-man-preview+json"
  348. },
  349. "method": "GET",
  350. "params": { "installation_id": { "required": true, "type": "integer" } },
  351. "url": "/app/installations/:installation_id"
  352. },
  353. "getOrgInstallation": {
  354. "headers": {
  355. "accept": "application/vnd.github.machine-man-preview+json"
  356. },
  357. "method": "GET",
  358. "params": { "org": { "required": true, "type": "string" } },
  359. "url": "/orgs/:org/installation"
  360. },
  361. "getRepoInstallation": {
  362. "headers": {
  363. "accept": "application/vnd.github.machine-man-preview+json"
  364. },
  365. "method": "GET",
  366. "params": {
  367. "owner": { "required": true, "type": "string" },
  368. "repo": { "required": true, "type": "string" }
  369. },
  370. "url": "/repos/:owner/:repo/installation"
  371. },
  372. "getUserInstallation": {
  373. "headers": {
  374. "accept": "application/vnd.github.machine-man-preview+json"
  375. },
  376. "method": "GET",
  377. "params": { "username": { "required": true, "type": "string" } },
  378. "url": "/users/:username/installation"
  379. },
  380. "listInstallationReposForAuthenticatedUser": {
  381. "headers": {
  382. "accept": "application/vnd.github.machine-man-preview+json"
  383. },
  384. "method": "GET",
  385. "params": {
  386. "installation_id": { "required": true, "type": "integer" },
  387. "page": { "type": "integer" },
  388. "per_page": { "type": "integer" }
  389. },
  390. "url": "/user/installations/:installation_id/repositories"
  391. },
  392. "listInstallations": {
  393. "headers": {
  394. "accept": "application/vnd.github.machine-man-preview+json"
  395. },
  396. "method": "GET",
  397. "params": {
  398. "page": { "type": "integer" },
  399. "per_page": { "type": "integer" }
  400. },
  401. "url": "/app/installations"
  402. },
  403. "listInstallationsForAuthenticatedUser": {
  404. "headers": {
  405. "accept": "application/vnd.github.machine-man-preview+json"
  406. },
  407. "method": "GET",
  408. "params": {
  409. "page": { "type": "integer" },
  410. "per_page": { "type": "integer" }
  411. },
  412. "url": "/user/installations"
  413. },
  414. "listRepos": {
  415. "headers": {
  416. "accept": "application/vnd.github.machine-man-preview+json"
  417. },
  418. "method": "GET",
  419. "params": {
  420. "page": { "type": "integer" },
  421. "per_page": { "type": "integer" }
  422. },
  423. "url": "/installation/repositories"
  424. },
  425. "removeRepoFromInstallation": {
  426. "headers": {
  427. "accept": "application/vnd.github.machine-man-preview+json"
  428. },
  429. "method": "DELETE",
  430. "params": {
  431. "installation_id": { "required": true, "type": "integer" },
  432. "repository_id": { "required": true, "type": "integer" }
  433. },
  434. "url": "/user/installations/:installation_id/repositories/:repository_id"
  435. }
  436. },
  437. "checks": {
  438. "create": {
  439. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  440. "method": "POST",
  441. "params": {
  442. "actions": { "type": "object[]" },
  443. "actions[].description": { "required": true, "type": "string" },
  444. "actions[].identifier": { "required": true, "type": "string" },
  445. "actions[].label": { "required": true, "type": "string" },
  446. "completed_at": { "type": "string" },
  447. "conclusion": {
  448. "enum": [
  449. "success",
  450. "failure",
  451. "neutral",
  452. "cancelled",
  453. "timed_out",
  454. "action_required"
  455. ],
  456. "type": "string"
  457. },
  458. "details_url": { "type": "string" },
  459. "external_id": { "type": "string" },
  460. "head_sha": { "required": true, "type": "string" },
  461. "name": { "required": true, "type": "string" },
  462. "output": { "type": "object" },
  463. "output.annotations": { "type": "object[]" },
  464. "output.annotations[].annotation_level": {
  465. "enum": ["notice", "warning", "failure"],
  466. "required": true,
  467. "type": "string"
  468. },
  469. "output.annotations[].end_column": { "type": "integer" },
  470. "output.annotations[].end_line": {
  471. "required": true,
  472. "type": "integer"
  473. },
  474. "output.annotations[].message": { "required": true, "type": "string" },
  475. "output.annotations[].path": { "required": true, "type": "string" },
  476. "output.annotations[].raw_details": { "type": "string" },
  477. "output.annotations[].start_column": { "type": "integer" },
  478. "output.annotations[].start_line": {
  479. "required": true,
  480. "type": "integer"
  481. },
  482. "output.annotations[].title": { "type": "string" },
  483. "output.images": { "type": "object[]" },
  484. "output.images[].alt": { "required": true, "type": "string" },
  485. "output.images[].caption": { "type": "string" },
  486. "output.images[].image_url": { "required": true, "type": "string" },
  487. "output.summary": { "required": true, "type": "string" },
  488. "output.text": { "type": "string" },
  489. "output.title": { "required": true, "type": "string" },
  490. "owner": { "required": true, "type": "string" },
  491. "repo": { "required": true, "type": "string" },
  492. "started_at": { "type": "string" },
  493. "status": {
  494. "enum": ["queued", "in_progress", "completed"],
  495. "type": "string"
  496. }
  497. },
  498. "url": "/repos/:owner/:repo/check-runs"
  499. },
  500. "createSuite": {
  501. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  502. "method": "POST",
  503. "params": {
  504. "head_sha": { "required": true, "type": "string" },
  505. "owner": { "required": true, "type": "string" },
  506. "repo": { "required": true, "type": "string" }
  507. },
  508. "url": "/repos/:owner/:repo/check-suites"
  509. },
  510. "get": {
  511. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  512. "method": "GET",
  513. "params": {
  514. "check_run_id": { "required": true, "type": "integer" },
  515. "owner": { "required": true, "type": "string" },
  516. "repo": { "required": true, "type": "string" }
  517. },
  518. "url": "/repos/:owner/:repo/check-runs/:check_run_id"
  519. },
  520. "getSuite": {
  521. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  522. "method": "GET",
  523. "params": {
  524. "check_suite_id": { "required": true, "type": "integer" },
  525. "owner": { "required": true, "type": "string" },
  526. "repo": { "required": true, "type": "string" }
  527. },
  528. "url": "/repos/:owner/:repo/check-suites/:check_suite_id"
  529. },
  530. "listAnnotations": {
  531. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  532. "method": "GET",
  533. "params": {
  534. "check_run_id": { "required": true, "type": "integer" },
  535. "owner": { "required": true, "type": "string" },
  536. "page": { "type": "integer" },
  537. "per_page": { "type": "integer" },
  538. "repo": { "required": true, "type": "string" }
  539. },
  540. "url": "/repos/:owner/:repo/check-runs/:check_run_id/annotations"
  541. },
  542. "listForRef": {
  543. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  544. "method": "GET",
  545. "params": {
  546. "check_name": { "type": "string" },
  547. "filter": { "enum": ["latest", "all"], "type": "string" },
  548. "owner": { "required": true, "type": "string" },
  549. "page": { "type": "integer" },
  550. "per_page": { "type": "integer" },
  551. "ref": { "required": true, "type": "string" },
  552. "repo": { "required": true, "type": "string" },
  553. "status": {
  554. "enum": ["queued", "in_progress", "completed"],
  555. "type": "string"
  556. }
  557. },
  558. "url": "/repos/:owner/:repo/commits/:ref/check-runs"
  559. },
  560. "listForSuite": {
  561. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  562. "method": "GET",
  563. "params": {
  564. "check_name": { "type": "string" },
  565. "check_suite_id": { "required": true, "type": "integer" },
  566. "filter": { "enum": ["latest", "all"], "type": "string" },
  567. "owner": { "required": true, "type": "string" },
  568. "page": { "type": "integer" },
  569. "per_page": { "type": "integer" },
  570. "repo": { "required": true, "type": "string" },
  571. "status": {
  572. "enum": ["queued", "in_progress", "completed"],
  573. "type": "string"
  574. }
  575. },
  576. "url": "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"
  577. },
  578. "listSuitesForRef": {
  579. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  580. "method": "GET",
  581. "params": {
  582. "app_id": { "type": "integer" },
  583. "check_name": { "type": "string" },
  584. "owner": { "required": true, "type": "string" },
  585. "page": { "type": "integer" },
  586. "per_page": { "type": "integer" },
  587. "ref": { "required": true, "type": "string" },
  588. "repo": { "required": true, "type": "string" }
  589. },
  590. "url": "/repos/:owner/:repo/commits/:ref/check-suites"
  591. },
  592. "rerequestSuite": {
  593. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  594. "method": "POST",
  595. "params": {
  596. "check_suite_id": { "required": true, "type": "integer" },
  597. "owner": { "required": true, "type": "string" },
  598. "repo": { "required": true, "type": "string" }
  599. },
  600. "url": "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"
  601. },
  602. "setSuitesPreferences": {
  603. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  604. "method": "PATCH",
  605. "params": {
  606. "auto_trigger_checks": { "type": "object[]" },
  607. "auto_trigger_checks[].app_id": { "required": true, "type": "integer" },
  608. "auto_trigger_checks[].setting": {
  609. "required": true,
  610. "type": "boolean"
  611. },
  612. "owner": { "required": true, "type": "string" },
  613. "repo": { "required": true, "type": "string" }
  614. },
  615. "url": "/repos/:owner/:repo/check-suites/preferences"
  616. },
  617. "update": {
  618. "headers": { "accept": "application/vnd.github.antiope-preview+json" },
  619. "method": "PATCH",
  620. "params": {
  621. "actions": { "type": "object[]" },
  622. "actions[].description": { "required": true, "type": "string" },
  623. "actions[].identifier": { "required": true, "type": "string" },
  624. "actions[].label": { "required": true, "type": "string" },
  625. "check_run_id": { "required": true, "type": "integer" },
  626. "completed_at": { "type": "string" },
  627. "conclusion": {
  628. "enum": [
  629. "success",
  630. "failure",
  631. "neutral",
  632. "cancelled",
  633. "timed_out",
  634. "action_required"
  635. ],
  636. "type": "string"
  637. },
  638. "details_url": { "type": "string" },
  639. "external_id": { "type": "string" },
  640. "name": { "type": "string" },
  641. "output": { "type": "object" },
  642. "output.annotations": { "type": "object[]" },
  643. "output.annotations[].annotation_level": {
  644. "enum": ["notice", "warning", "failure"],
  645. "required": true,
  646. "type": "string"
  647. },
  648. "output.annotations[].end_column": { "type": "integer" },
  649. "output.annotations[].end_line": {
  650. "required": true,
  651. "type": "integer"
  652. },
  653. "output.annotations[].message": { "required": true, "type": "string" },
  654. "output.annotations[].path": { "required": true, "type": "string" },
  655. "output.annotations[].raw_details": { "type": "string" },
  656. "output.annotations[].start_column": { "type": "integer" },
  657. "output.annotations[].start_line": {
  658. "required": true,
  659. "type": "integer"
  660. },
  661. "output.annotations[].title": { "type": "string" },
  662. "output.images": { "type": "object[]" },
  663. "output.images[].alt": { "required": true, "type": "string" },
  664. "output.images[].caption": { "type": "string" },
  665. "output.images[].image_url": { "required": true, "type": "string" },
  666. "output.summary": { "required": true, "type": "string" },
  667. "output.text": { "type": "string" },
  668. "output.title": { "type": "string" },
  669. "owner": { "required": true, "type": "string" },
  670. "repo": { "required": true, "type": "string" },
  671. "started_at": { "type": "string" },
  672. "status": {
  673. "enum": ["queued", "in_progress", "completed"],
  674. "type": "string"
  675. }
  676. },
  677. "url": "/repos/:owner/:repo/check-runs/:check_run_id"
  678. }
  679. },
  680. "codesOfConduct": {
  681. "getConductCode": {
  682. "headers": {
  683. "accept": "application/vnd.github.scarlet-witch-preview+json"
  684. },
  685. "method": "GET",
  686. "params": { "key": { "required": true, "type": "string" } },
  687. "url": "/codes_of_conduct/:key"
  688. },
  689. "getForRepo": {
  690. "headers": {
  691. "accept": "application/vnd.github.scarlet-witch-preview+json"
  692. },
  693. "method": "GET",
  694. "params": {
  695. "owner": { "required": true, "type": "string" },
  696. "repo": { "required": true, "type": "string" }
  697. },
  698. "url": "/repos/:owner/:repo/community/code_of_conduct"
  699. },
  700. "listConductCodes": {
  701. "headers": {
  702. "accept": "application/vnd.github.scarlet-witch-preview+json"
  703. },
  704. "method": "GET",
  705. "params": {},
  706. "url": "/codes_of_conduct"
  707. }
  708. },
  709. "emojis": { "get": { "method": "GET", "params": {}, "url": "/emojis" } },
  710. "enterpriseAdmin": {
  711. "addAuthorizedSshKey": {
  712. "method": "POST",
  713. "params": { "authorized_key": { "required": true, "type": "string" } },
  714. "url": "/setup/api/settings/authorized-keys"
  715. },
  716. "checkConfigurationStatus": {
  717. "method": "GET",
  718. "params": {},
  719. "url": "/setup/api/configcheck"
  720. },
  721. "checkMaintenanceStatus": {
  722. "method": "GET",
  723. "params": {},
  724. "url": "/setup/api/maintenance"
  725. },
  726. "createGlobalHook": {
  727. "headers": { "accept": "application/vnd.github.superpro-preview+json" },
  728. "method": "POST",
  729. "params": {
  730. "active": { "type": "boolean" },
  731. "config": { "required": true, "type": "object" },
  732. "config.content_type": { "type": "string" },
  733. "config.insecure_ssl": { "type": "string" },
  734. "config.secret": { "type": "string" },
  735. "config.url": { "required": true, "type": "string" },
  736. "events": { "type": "string[]" },
  737. "name": { "required": true, "type": "string" }
  738. },
  739. "url": "/admin/hooks"
  740. },
  741. "createImpersonationOAuthToken": {
  742. "method": "POST",
  743. "params": {
  744. "scopes": { "type": "string[]" },
  745. "username": { "required": true, "type": "string" }
  746. },
  747. "url": "/admin/users/:username/authorizations"
  748. },
  749. "createOrg": {
  750. "method": "POST",
  751. "params": {
  752. "admin": { "required": true, "type": "string" },
  753. "login": { "required": true, "type": "string" },
  754. "profile_name": { "type": "string" }
  755. },
  756. "url": "/admin/organizations"
  757. },
  758. "createPreReceiveEnvironment": {
  759. "method": "POST",
  760. "params": {
  761. "image_url": { "required": true, "type": "string" },
  762. "name": { "required": true, "type": "string" }
  763. },
  764. "url": "/admin/pre-receive-environments"
  765. },
  766. "createPreReceiveHook": {
  767. "method": "POST",
  768. "params": {
  769. "allow_downstream_configuration": { "type": "boolean" },
  770. "enforcement": { "type": "string" },
  771. "environment": { "required": true, "type": "object" },
  772. "name": { "required": true, "type": "string" },
  773. "script": { "required": true, "type": "string" },
  774. "script_repository": { "required": true, "type": "object" }
  775. },
  776. "url": "/admin/pre-receive-hooks"
  777. },
  778. "createUser": {
  779. "method": "POST",
  780. "params": {
  781. "email": { "type": "string" },
  782. "login": { "required": true, "type": "string" }
  783. },
  784. "url": "/admin/users"
  785. },
  786. "deleteGlobalHook": {
  787. "headers": { "accept": "application/vnd.github.superpro-preview+json" },
  788. "method": "DELETE",
  789. "params": { "hook_id": { "required": true, "type": "integer" } },
  790. "url": "/admin/hooks/:hook_id"
  791. },
  792. "deleteImpersonationOAuthToken": {
  793. "method": "DELETE",
  794. "params": { "username": { "required": true, "type": "string" } },
  795. "url": "/admin/users/:username/authorizations"
  796. },
  797. "deletePreReceiveEnvironment": {
  798. "method": "DELETE",
  799. "params": {
  800. "pre_receive_environment_id": { "required": true, "type": "integer" }
  801. },
  802. "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
  803. },
  804. "deletePreReceiveHook": {
  805. "method": "DELETE",
  806. "params": {
  807. "pre_receive_hook_id": { "required": true, "type": "integer" }
  808. },
  809. "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
  810. },
  811. "deletePublicKey": {
  812. "method": "DELETE",
  813. "params": { "key_ids": { "required": true, "type": "string" } },
  814. "url": "/admin/keys/:key_ids"
  815. },
  816. "deleteUser": {
  817. "method": "DELETE",
  818. "params": { "username": { "required": true, "type": "string" } },
  819. "url": "/admin/users/:username"
  820. },
  821. "demoteSiteAdministratorToOrdinaryUser": {
  822. "method": "DELETE",
  823. "params": { "username": { "required": true, "type": "string" } },
  824. "url": "/users/:username/site_admin"
  825. },
  826. "enableOrDisableMaintenanceMode": {
  827. "method": "POST",
  828. "params": { "maintenance": { "required": true, "type": "string" } },
  829. "url": "/setup/api/maintenance"
  830. },
  831. "getGlobalHook": {
  832. "headers": { "accept": "application/vnd.github.superpro-preview+json" },
  833. "method": "GET",
  834. "params": { "hook_id": { "required": true, "type": "integer" } },
  835. "url": "/admin/hooks/:hook_id"
  836. },
  837. "getLicenseInformation": {
  838. "method": "GET",
  839. "params": {},
  840. "url": "/enterprise/settings/license"
  841. },
  842. "getPreReceiveEnvironment": {
  843. "method": "GET",
  844. "params": {
  845. "pre_receive_environment_id": { "required": true, "type": "integer" }
  846. },
  847. "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
  848. },
  849. "getPreReceiveEnvironmentDownloadStatus": {
  850. "method": "GET",
  851. "params": {
  852. "downloaded_at": { "type": "string" },
  853. "message": { "type": "string" },
  854. "pre_receive_environment_id": { "required": true, "type": "integer" },
  855. "state": { "type": "string" }
  856. },
  857. "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest"
  858. },
  859. "getPreReceiveHook": {
  860. "method": "GET",
  861. "params": {
  862. "pre_receive_hook_id": { "required": true, "type": "integer" }
  863. },
  864. "url": "/admin/pre-receive-hooks/:pre_receive_hook_id"
  865. },
  866. "getPreReceiveHookForOrg": {
  867. "method": "GET",
  868. "params": {
  869. "org": { "required": true, "type": "string" },
  870. "pre_receive_hook_id": { "required": true, "type": "integer" }
  871. },
  872. "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
  873. },
  874. "getPreReceiveHookForRepo": {
  875. "method": "GET",
  876. "params": {
  877. "owner": { "required": true, "type": "string" },
  878. "pre_receive_hook_id": { "required": true, "type": "integer" },
  879. "repo": { "required": true, "type": "string" }
  880. },
  881. "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
  882. },
  883. "getTypeStats": {
  884. "method": "GET",
  885. "params": { "type": { "required": true, "type": "string" } },
  886. "url": "/enterprise/stats/:type"
  887. },
  888. "listGlobalHooks": {
  889. "headers": { "accept": "application/vnd.github.superpro-preview+json" },
  890. "method": "GET",
  891. "params": {
  892. "page": { "type": "integer" },
  893. "per_page": { "type": "integer" }
  894. },
  895. "url": "/admin/hooks"
  896. },
  897. "listPreReceiveEnvironments": {
  898. "method": "GET",
  899. "params": {
  900. "page": { "type": "integer" },
  901. "per_page": { "type": "integer" }
  902. },
  903. "url": "/admin/pre-receive-environments"
  904. },
  905. "listPreReceiveHooks": {
  906. "method": "GET",
  907. "params": {
  908. "page": { "type": "integer" },
  909. "per_page": { "type": "integer" }
  910. },
  911. "url": "/admin/pre-receive-hooks"
  912. },
  913. "listPreReceiveHooksForOrg": {
  914. "method": "GET",
  915. "params": {
  916. "org": { "required": true, "type": "string" },
  917. "page": { "type": "integer" },
  918. "per_page": { "type": "integer" }
  919. },
  920. "url": "/orgs/:org/pre-receive-hooks"
  921. },
  922. "listPreReceiveHooksForRepo": {
  923. "method": "GET",
  924. "params": {
  925. "owner": { "required": true, "type": "string" },
  926. "page": { "type": "integer" },
  927. "per_page": { "type": "integer" },
  928. "repo": { "required": true, "type": "string" }
  929. },
  930. "url": "/repos/:owner/:repo/pre-receive-hooks"
  931. },
  932. "modifySettings": {
  933. "method": "PUT",
  934. "params": { "settings": { "required": true, "type": "string" } },
  935. "url": "/setup/api/settings"
  936. },
  937. "pingGlobalHook": {
  938. "headers": { "accept": "application/vnd.github.superpro-preview+json" },
  939. "method": "POST",
  940. "params": { "hook_id": { "required": true, "type": "integer" } },
  941. "url": "/admin/hooks/:hook_id/pings"
  942. },
  943. "promoteOrdinaryUserToSiteAdministrator": {
  944. "method": "PUT",
  945. "params": { "username": { "required": true, "type": "string" } },
  946. "url": "/users/:username/site_admin"
  947. },
  948. "queueIndexingJob": {
  949. "method": "POST",
  950. "params": { "target": { "required": true, "type": "string" } },
  951. "url": "/staff/indexing_jobs"
  952. },
  953. "removeAuthorizedSshKey": {
  954. "method": "DELETE",
  955. "params": { "authorized_key": { "required": true, "type": "string" } },
  956. "url": "/setup/api/settings/authorized-keys"
  957. },
  958. "removeEnforcementOverridesForPreReceiveHookForOrg": {
  959. "method": "DELETE",
  960. "params": {
  961. "org": { "required": true, "type": "string" },
  962. "pre_receive_hook_id": { "required": true, "type": "integer" }
  963. },
  964. "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
  965. },
  966. "removeEnforcementOverridesForPreReceiveHookForRepo": {
  967. "method": "DELETE",
  968. "params": {
  969. "owner": { "required": true, "type": "string" },
  970. "pre_receive_hook_id": { "required": true, "type": "integer" },
  971. "repo": { "required": true, "type": "string" }
  972. },
  973. "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
  974. },
  975. "renameOrg": {
  976. "method": "PATCH",
  977. "params": {
  978. "login": { "required": true, "type": "string" },
  979. "org": { "required": true, "type": "string" }
  980. },
  981. "url": "/admin/organizations/:org"
  982. },
  983. "renameUser": {
  984. "method": "PATCH",
  985. "params": {
  986. "login": { "required": true, "type": "string" },
  987. "username": { "required": true, "type": "string" }
  988. },
  989. "url": "/admin/users/:username"
  990. },
  991. "retrieveAuthorizedSshKeys": {
  992. "method": "GET",
  993. "params": {},
  994. "url": "/setup/api/settings/authorized-keys"
  995. },
  996. "retrieveSettings": {
  997. "method": "GET",
  998. "params": {},
  999. "url": "/setup/api/settings"
  1000. },
  1001. "startConfigurationProcess": {
  1002. "method": "POST",
  1003. "params": {},
  1004. "url": "/setup/api/configure"
  1005. },
  1006. "suspendUser": {
  1007. "method": "PUT",
  1008. "params": {
  1009. "reason": { "type": "string" },
  1010. "username": { "required": true, "type": "string" }
  1011. },
  1012. "url": "/users/:username/suspended"
  1013. },
  1014. "syncLdapMappingForTeam": {
  1015. "method": "POST",
  1016. "params": { "team_id": { "required": true, "type": "integer" } },
  1017. "url": "/admin/ldap/teams/:team_id/sync"
  1018. },
  1019. "syncLdapMappingForUser": {
  1020. "method": "POST",
  1021. "params": { "username": { "required": true, "type": "string" } },
  1022. "url": "/admin/ldap/users/:username/sync"
  1023. },
  1024. "triggerPreReceiveEnvironmentDownload": {
  1025. "method": "POST",
  1026. "params": {
  1027. "pre_receive_environment_id": { "required": true, "type": "integer" }
  1028. },
  1029. "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads"
  1030. },
  1031. "unsuspendUser": {
  1032. "method": "DELETE",
  1033. "params": {
  1034. "reason": { "type": "string" },
  1035. "username": { "required": true, "type": "string" }
  1036. },
  1037. "url": "/users/:username/suspended"
  1038. },
  1039. "updateGlobalHook": {
  1040. "headers": { "accept": "application/vnd.github.superpro-preview+json" },
  1041. "method": "PATCH",
  1042. "params": {
  1043. "active": { "type": "boolean" },
  1044. "config": { "type": "object" },
  1045. "config.content_type": { "type": "string" },
  1046. "config.insecure_ssl": { "type": "string" },
  1047. "config.secret": { "type": "string" },
  1048. "config.url": { "required": true, "type": "string" },
  1049. "events": { "type": "string[]" },
  1050. "hook_id": { "required": true, "type": "integer" }
  1051. },
  1052. "url": "/admin/hooks/:hook_id"
  1053. },
  1054. "updateLdapMappingForTeam": {
  1055. "method": "PATCH",
  1056. "params": {
  1057. "ldap_dn": { "type": "string" },
  1058. "team_id": { "required": true, "type": "integer" }
  1059. },
  1060. "url": "/admin/ldap/teams/:team_id/mapping"
  1061. },
  1062. "updateLdapMappingForUser": {
  1063. "method": "PATCH",
  1064. "params": {
  1065. "ldap_dn": { "type": "string" },
  1066. "username": { "required": true, "type": "string" }
  1067. },
  1068. "url": "/admin/ldap/users/:username/mapping"
  1069. },
  1070. "updatePreReceiveEnvironment": {
  1071. "method": "PATCH",
  1072. "params": {
  1073. "image_url": { "type": "string" },
  1074. "name": { "type": "string" },
  1075. "pre_receive_environment_id": { "required": true, "type": "integer" }
  1076. },
  1077. "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
  1078. },
  1079. "updatePreReceiveHook": {
  1080. "method": "PATCH",
  1081. "params": {
  1082. "pre_receive_hook_id": { "required": true, "type": "integer" }
  1083. },
  1084. "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
  1085. },
  1086. "updatePreReceiveHookEnforcementForOrg": {
  1087. "method": "PATCH",
  1088. "params": {
  1089. "org": { "required": true, "type": "string" },
  1090. "pre_receive_hook_id": { "required": true, "type": "integer" }
  1091. },
  1092. "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
  1093. },
  1094. "updatePreReceiveHookEnforcementForRepo": {
  1095. "method": "PATCH",
  1096. "params": {
  1097. "owner": { "required": true, "type": "string" },
  1098. "pre_receive_hook_id": { "required": true, "type": "integer" },
  1099. "repo": { "required": true, "type": "string" }
  1100. },
  1101. "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
  1102. },
  1103. "upgradeLicense": {
  1104. "method": "POST",
  1105. "params": { "license": { "type": "string" } },
  1106. "url": "/setup/api/upgrade"
  1107. },
  1108. "uploadLicenseForFirstTime": {
  1109. "method": "POST",
  1110. "params": {
  1111. "license": { "required": true, "type": "string" },
  1112. "password": { "type": "string" },
  1113. "settings": { "type": "string" }
  1114. },
  1115. "url": "/setup/api/start"
  1116. }
  1117. },
  1118. "gists": {
  1119. "checkIsStarred": {
  1120. "method": "GET",
  1121. "params": { "gist_id": { "required": true, "type": "string" } },
  1122. "url": "/gists/:gist_id/star"
  1123. },
  1124. "create": {
  1125. "method": "POST",
  1126. "params": {
  1127. "description": { "type": "string" },
  1128. "files": { "required": true, "type": "object" },
  1129. "files.content": { "type": "string" },
  1130. "public": { "type": "boolean" }
  1131. },
  1132. "url": "/gists"
  1133. },
  1134. "createComment": {
  1135. "method": "POST",
  1136. "params": {
  1137. "body": { "required": true, "type": "string" },
  1138. "gist_id": { "required": true, "type": "string" }
  1139. },
  1140. "url": "/gists/:gist_id/comments"
  1141. },
  1142. "delete": {
  1143. "method": "DELETE",
  1144. "params": { "gist_id": { "required": true, "type": "string" } },
  1145. "url": "/gists/:gist_id"
  1146. },
  1147. "deleteComment": {
  1148. "method": "DELETE",
  1149. "params": {
  1150. "comment_id": { "required": true, "type": "integer" },
  1151. "gist_id": { "required": true, "type": "string" }
  1152. },
  1153. "url": "/gists/:gist_id/comments/:comment_id"
  1154. },
  1155. "fork": {
  1156. "method": "POST",
  1157. "params": { "gist_id": { "required": true, "type": "string" } },
  1158. "url": "/gists/:gist_id/forks"
  1159. },
  1160. "get": {
  1161. "method": "GET",
  1162. "params": { "gist_id": { "required": true, "type": "string" } },
  1163. "url": "/gists/:gist_id"
  1164. },
  1165. "getComment": {
  1166. "method": "GET",
  1167. "params": {
  1168. "comment_id": { "required": true, "type": "integer" },
  1169. "gist_id": { "required": true, "type": "string" }
  1170. },
  1171. "url": "/gists/:gist_id/comments/:comment_id"
  1172. },
  1173. "getRevision": {
  1174. "method": "GET",
  1175. "params": {
  1176. "gist_id": { "required": true, "type": "string" },
  1177. "sha": { "required": true, "type": "string" }
  1178. },
  1179. "url": "/gists/:gist_id/:sha"
  1180. },
  1181. "list": {
  1182. "method": "GET",
  1183. "params": {
  1184. "page": { "type": "integer" },
  1185. "per_page": { "type": "integer" },
  1186. "since": { "type": "string" }
  1187. },
  1188. "url": "/gists"
  1189. },
  1190. "listComments": {
  1191. "method": "GET",
  1192. "params": {
  1193. "gist_id": { "required": true, "type": "string" },
  1194. "page": { "type": "integer" },
  1195. "per_page": { "type": "integer" }
  1196. },
  1197. "url": "/gists/:gist_id/comments"
  1198. },
  1199. "listCommits": {
  1200. "method": "GET",
  1201. "params": {
  1202. "gist_id": { "required": true, "type": "string" },
  1203. "page": { "type": "integer" },
  1204. "per_page": { "type": "integer" }
  1205. },
  1206. "url": "/gists/:gist_id/commits"
  1207. },
  1208. "listForks": {
  1209. "method": "GET",
  1210. "params": {
  1211. "gist_id": { "required": true, "type": "string" },
  1212. "page": { "type": "integer" },
  1213. "per_page": { "type": "integer" }
  1214. },
  1215. "url": "/gists/:gist_id/forks"
  1216. },
  1217. "listPublic": {
  1218. "method": "GET",
  1219. "params": {
  1220. "page": { "type": "integer" },
  1221. "per_page": { "type": "integer" },
  1222. "since": { "type": "string" }
  1223. },
  1224. "url": "/gists/public"
  1225. },
  1226. "listPublicForUser": {
  1227. "method": "GET",
  1228. "params": {
  1229. "page": { "type": "integer" },
  1230. "per_page": { "type": "integer" },
  1231. "since": { "type": "string" },
  1232. "username": { "required": true, "type": "string" }
  1233. },
  1234. "url": "/users/:username/gists"
  1235. },
  1236. "listStarred": {
  1237. "method": "GET",
  1238. "params": {
  1239. "page": { "type": "integer" },
  1240. "per_page": { "type": "integer" },
  1241. "since": { "type": "string" }
  1242. },
  1243. "url": "/gists/starred"
  1244. },
  1245. "star": {
  1246. "method": "PUT",
  1247. "params": { "gist_id": { "required": true, "type": "string" } },
  1248. "url": "/gists/:gist_id/star"
  1249. },
  1250. "unstar": {
  1251. "method": "DELETE",
  1252. "params": { "gist_id": { "required": true, "type": "string" } },
  1253. "url": "/gists/:gist_id/star"
  1254. },
  1255. "update": {
  1256. "method": "PATCH",
  1257. "params": {
  1258. "description": { "type": "string" },
  1259. "files": { "type": "object" },
  1260. "files.content": { "type": "string" },
  1261. "files.filename": { "type": "string" },
  1262. "gist_id": { "required": true, "type": "string" }
  1263. },
  1264. "url": "/gists/:gist_id"
  1265. },
  1266. "updateComment": {
  1267. "method": "PATCH",
  1268. "params": {
  1269. "body": { "required": true, "type": "string" },
  1270. "comment_id": { "required": true, "type": "integer" },
  1271. "gist_id": { "required": true, "type": "string" }
  1272. },
  1273. "url": "/gists/:gist_id/comments/:comment_id"
  1274. }
  1275. },
  1276. "git": {
  1277. "createBlob": {
  1278. "method": "POST",
  1279. "params": {
  1280. "content": { "required": true, "type": "string" },
  1281. "encoding": { "type": "string" },
  1282. "owner": { "required": true, "type": "string" },
  1283. "repo": { "required": true, "type": "string" }
  1284. },
  1285. "url": "/repos/:owner/:repo/git/blobs"
  1286. },
  1287. "createCommit": {
  1288. "method": "POST",
  1289. "params": {
  1290. "author": { "type": "object" },
  1291. "author.date": { "type": "string" },
  1292. "author.email": { "type": "string" },
  1293. "author.name": { "type": "string" },
  1294. "committer": { "type": "object" },
  1295. "committer.date": { "type": "string" },
  1296. "committer.email": { "type": "string" },
  1297. "committer.name": { "type": "string" },
  1298. "message": { "required": true, "type": "string" },
  1299. "owner": { "required": true, "type": "string" },
  1300. "parents": { "required": true, "type": "string[]" },
  1301. "repo": { "required": true, "type": "string" },
  1302. "signature": { "type": "string" },
  1303. "tree": { "required": true, "type": "string" }
  1304. },
  1305. "url": "/repos/:owner/:repo/git/commits"
  1306. },
  1307. "createRef": {
  1308. "method": "POST",
  1309. "params": {
  1310. "owner": { "required": true, "type": "string" },
  1311. "ref": { "required": true, "type": "string" },
  1312. "repo": { "required": true, "type": "string" },
  1313. "sha": { "required": true, "type": "string" }
  1314. },
  1315. "url": "/repos/:owner/:repo/git/refs"
  1316. },
  1317. "createTag": {
  1318. "method": "POST",
  1319. "params": {
  1320. "message": { "required": true, "type": "string" },
  1321. "object": { "required": true, "type": "string" },
  1322. "owner": { "required": true, "type": "string" },
  1323. "repo": { "required": true, "type": "string" },
  1324. "tag": { "required": true, "type": "string" },
  1325. "tagger": { "type": "object" },
  1326. "tagger.date": { "type": "string" },
  1327. "tagger.email": { "type": "string" },
  1328. "tagger.name": { "type": "string" },
  1329. "type": {
  1330. "enum": ["commit", "tree", "blob"],
  1331. "required": true,
  1332. "type": "string"
  1333. }
  1334. },
  1335. "url": "/repos/:owner/:repo/git/tags"
  1336. },
  1337. "createTree": {
  1338. "method": "POST",
  1339. "params": {
  1340. "base_tree": { "type": "string" },
  1341. "owner": { "required": true, "type": "string" },
  1342. "repo": { "required": true, "type": "string" },
  1343. "tree": { "required": true, "type": "object[]" },
  1344. "tree[].content": { "type": "string" },
  1345. "tree[].mode": {
  1346. "enum": ["100644", "100755", "040000", "160000", "120000"],
  1347. "type": "string"
  1348. },
  1349. "tree[].path": { "type": "string" },
  1350. "tree[].sha": { "type": "string" },
  1351. "tree[].type": { "enum": ["blob", "tree", "commit"], "type": "string" }
  1352. },
  1353. "url": "/repos/:owner/:repo/git/trees"
  1354. },
  1355. "deleteRef": {
  1356. "method": "DELETE",
  1357. "params": {
  1358. "owner": { "required": true, "type": "string" },
  1359. "ref": { "required": true, "type": "string" },
  1360. "repo": { "required": true, "type": "string" }
  1361. },
  1362. "url": "/repos/:owner/:repo/git/refs/:ref"
  1363. },
  1364. "getBlob": {
  1365. "method": "GET",
  1366. "params": {
  1367. "file_sha": { "required": true, "type": "string" },
  1368. "owner": { "required": true, "type": "string" },
  1369. "repo": { "required": true, "type": "string" }
  1370. },
  1371. "url": "/repos/:owner/:repo/git/blobs/:file_sha"
  1372. },
  1373. "getCommit": {
  1374. "method": "GET",
  1375. "params": {
  1376. "commit_sha": { "required": true, "type": "string" },
  1377. "owner": { "required": true, "type": "string" },
  1378. "repo": { "required": true, "type": "string" }
  1379. },
  1380. "url": "/repos/:owner/:repo/git/commits/:commit_sha"
  1381. },
  1382. "getRef": {
  1383. "method": "GET",
  1384. "params": {
  1385. "owner": { "required": true, "type": "string" },
  1386. "ref": { "required": true, "type": "string" },
  1387. "repo": { "required": true, "type": "string" }
  1388. },
  1389. "url": "/repos/:owner/:repo/git/refs/:ref"
  1390. },
  1391. "getTag": {
  1392. "method": "GET",
  1393. "params": {
  1394. "owner": { "required": true, "type": "string" },
  1395. "repo": { "required": true, "type": "string" },
  1396. "tag_sha": { "required": true, "type": "string" }
  1397. },
  1398. "url": "/repos/:owner/:repo/git/tags/:tag_sha"
  1399. },
  1400. "getTree": {
  1401. "method": "GET",
  1402. "params": {
  1403. "owner": { "required": true, "type": "string" },
  1404. "recursive": { "enum": ["1"], "type": "integer" },
  1405. "repo": { "required": true, "type": "string" },
  1406. "tree_sha": { "required": true, "type": "string" }
  1407. },
  1408. "url": "/repos/:owner/:repo/git/trees/:tree_sha"
  1409. },
  1410. "listRefs": {
  1411. "method": "GET",
  1412. "params": {
  1413. "namespace": { "type": "string" },
  1414. "owner": { "required": true, "type": "string" },
  1415. "page": { "type": "integer" },
  1416. "per_page": { "type": "integer" },
  1417. "repo": { "required": true, "type": "string" }
  1418. },
  1419. "url": "/repos/:owner/:repo/git/refs/:namespace"
  1420. },
  1421. "updateRef": {
  1422. "method": "PATCH",
  1423. "params": {
  1424. "force": { "type": "boolean" },
  1425. "owner": { "required": true, "type": "string" },
  1426. "ref": { "required": true, "type": "string" },
  1427. "repo": { "required": true, "type": "string" },
  1428. "sha": { "required": true, "type": "string" }
  1429. },
  1430. "url": "/repos/:owner/:repo/git/refs/:ref"
  1431. }
  1432. },
  1433. "gitignore": {
  1434. "getTemplate": {
  1435. "method": "GET",
  1436. "params": { "name": { "required": true, "type": "string" } },
  1437. "url": "/gitignore/templates/:name"
  1438. },
  1439. "listTemplates": {
  1440. "method": "GET",
  1441. "params": {},
  1442. "url": "/gitignore/templates"
  1443. }
  1444. },
  1445. "issues": {
  1446. "addAssignees": {
  1447. "method": "POST",
  1448. "params": {
  1449. "assignees": { "type": "string[]" },
  1450. "issue_number": { "required": true, "type": "integer" },
  1451. "number": {
  1452. "alias": "issue_number",
  1453. "deprecated": true,
  1454. "type": "integer"
  1455. },
  1456. "owner": { "required": true, "type": "string" },
  1457. "repo": { "required": true, "type": "string" }
  1458. },
  1459. "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
  1460. },
  1461. "addLabels": {
  1462. "method": "POST",
  1463. "params": {
  1464. "issue_number": { "required": true, "type": "integer" },
  1465. "labels": { "required": true, "type": "string[]" },
  1466. "number": {
  1467. "alias": "issue_number",
  1468. "deprecated": true,
  1469. "type": "integer"
  1470. },
  1471. "owner": { "required": true, "type": "string" },
  1472. "repo": { "required": true, "type": "string" }
  1473. },
  1474. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1475. },
  1476. "checkAssignee": {
  1477. "method": "GET",
  1478. "params": {
  1479. "assignee": { "required": true, "type": "string" },
  1480. "owner": { "required": true, "type": "string" },
  1481. "repo": { "required": true, "type": "string" }
  1482. },
  1483. "url": "/repos/:owner/:repo/assignees/:assignee"
  1484. },
  1485. "create": {
  1486. "method": "POST",
  1487. "params": {
  1488. "assignee": { "type": "string" },
  1489. "assignees": { "type": "string[]" },
  1490. "body": { "type": "string" },
  1491. "labels": { "type": "string[]" },
  1492. "milestone": { "type": "integer" },
  1493. "owner": { "required": true, "type": "string" },
  1494. "repo": { "required": true, "type": "string" },
  1495. "title": { "required": true, "type": "string" }
  1496. },
  1497. "url": "/repos/:owner/:repo/issues"
  1498. },
  1499. "createComment": {
  1500. "method": "POST",
  1501. "params": {
  1502. "body": { "required": true, "type": "string" },
  1503. "issue_number": { "required": true, "type": "integer" },
  1504. "number": {
  1505. "alias": "issue_number",
  1506. "deprecated": true,
  1507. "type": "integer"
  1508. },
  1509. "owner": { "required": true, "type": "string" },
  1510. "repo": { "required": true, "type": "string" }
  1511. },
  1512. "url": "/repos/:owner/:repo/issues/:issue_number/comments"
  1513. },
  1514. "createLabel": {
  1515. "method": "POST",
  1516. "params": {
  1517. "color": { "required": true, "type": "string" },
  1518. "description": { "type": "string" },
  1519. "name": { "required": true, "type": "string" },
  1520. "owner": { "required": true, "type": "string" },
  1521. "repo": { "required": true, "type": "string" }
  1522. },
  1523. "url": "/repos/:owner/:repo/labels"
  1524. },
  1525. "createMilestone": {
  1526. "method": "POST",
  1527. "params": {
  1528. "description": { "type": "string" },
  1529. "due_on": { "type": "string" },
  1530. "owner": { "required": true, "type": "string" },
  1531. "repo": { "required": true, "type": "string" },
  1532. "state": { "enum": ["open", "closed"], "type": "string" },
  1533. "title": { "required": true, "type": "string" }
  1534. },
  1535. "url": "/repos/:owner/:repo/milestones"
  1536. },
  1537. "deleteComment": {
  1538. "method": "DELETE",
  1539. "params": {
  1540. "comment_id": { "required": true, "type": "integer" },
  1541. "owner": { "required": true, "type": "string" },
  1542. "repo": { "required": true, "type": "string" }
  1543. },
  1544. "url": "/repos/:owner/:repo/issues/comments/:comment_id"
  1545. },
  1546. "deleteLabel": {
  1547. "method": "DELETE",
  1548. "params": {
  1549. "name": { "required": true, "type": "string" },
  1550. "owner": { "required": true, "type": "string" },
  1551. "repo": { "required": true, "type": "string" }
  1552. },
  1553. "url": "/repos/:owner/:repo/labels/:name"
  1554. },
  1555. "deleteMilestone": {
  1556. "method": "DELETE",
  1557. "params": {
  1558. "milestone_number": { "required": true, "type": "integer" },
  1559. "number": {
  1560. "alias": "milestone_number",
  1561. "deprecated": true,
  1562. "type": "integer"
  1563. },
  1564. "owner": { "required": true, "type": "string" },
  1565. "repo": { "required": true, "type": "string" }
  1566. },
  1567. "url": "/repos/:owner/:repo/milestones/:milestone_number"
  1568. },
  1569. "get": {
  1570. "method": "GET",
  1571. "params": {
  1572. "issue_number": { "required": true, "type": "integer" },
  1573. "number": {
  1574. "alias": "issue_number",
  1575. "deprecated": true,
  1576. "type": "integer"
  1577. },
  1578. "owner": { "required": true, "type": "string" },
  1579. "repo": { "required": true, "type": "string" }
  1580. },
  1581. "url": "/repos/:owner/:repo/issues/:issue_number"
  1582. },
  1583. "getComment": {
  1584. "method": "GET",
  1585. "params": {
  1586. "comment_id": { "required": true, "type": "integer" },
  1587. "owner": { "required": true, "type": "string" },
  1588. "page": { "type": "integer" },
  1589. "per_page": { "type": "integer" },
  1590. "repo": { "required": true, "type": "string" }
  1591. },
  1592. "url": "/repos/:owner/:repo/issues/comments/:comment_id"
  1593. },
  1594. "getEvent": {
  1595. "method": "GET",
  1596. "params": {
  1597. "event_id": { "required": true, "type": "integer" },
  1598. "owner": { "required": true, "type": "string" },
  1599. "repo": { "required": true, "type": "string" }
  1600. },
  1601. "url": "/repos/:owner/:repo/issues/events/:event_id"
  1602. },
  1603. "getLabel": {
  1604. "method": "GET",
  1605. "params": {
  1606. "name": { "required": true, "type": "string" },
  1607. "owner": { "required": true, "type": "string" },
  1608. "repo": { "required": true, "type": "string" }
  1609. },
  1610. "url": "/repos/:owner/:repo/labels/:name"
  1611. },
  1612. "getMilestone": {
  1613. "method": "GET",
  1614. "params": {
  1615. "milestone_number": { "required": true, "type": "integer" },
  1616. "number": {
  1617. "alias": "milestone_number",
  1618. "deprecated": true,
  1619. "type": "integer"
  1620. },
  1621. "owner": { "required": true, "type": "string" },
  1622. "repo": { "required": true, "type": "string" }
  1623. },
  1624. "url": "/repos/:owner/:repo/milestones/:milestone_number"
  1625. },
  1626. "list": {
  1627. "method": "GET",
  1628. "params": {
  1629. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1630. "filter": {
  1631. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  1632. "type": "string"
  1633. },
  1634. "labels": { "type": "string" },
  1635. "page": { "type": "integer" },
  1636. "per_page": { "type": "integer" },
  1637. "since": { "type": "string" },
  1638. "sort": {
  1639. "enum": ["created", "updated", "comments"],
  1640. "type": "string"
  1641. },
  1642. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1643. },
  1644. "url": "/issues"
  1645. },
  1646. "listAssignees": {
  1647. "method": "GET",
  1648. "params": {
  1649. "owner": { "required": true, "type": "string" },
  1650. "page": { "type": "integer" },
  1651. "per_page": { "type": "integer" },
  1652. "repo": { "required": true, "type": "string" }
  1653. },
  1654. "url": "/repos/:owner/:repo/assignees"
  1655. },
  1656. "listComments": {
  1657. "method": "GET",
  1658. "params": {
  1659. "issue_number": { "required": true, "type": "integer" },
  1660. "number": {
  1661. "alias": "issue_number",
  1662. "deprecated": true,
  1663. "type": "integer"
  1664. },
  1665. "owner": { "required": true, "type": "string" },
  1666. "page": { "type": "integer" },
  1667. "per_page": { "type": "integer" },
  1668. "repo": { "required": true, "type": "string" },
  1669. "since": { "type": "string" }
  1670. },
  1671. "url": "/repos/:owner/:repo/issues/:issue_number/comments"
  1672. },
  1673. "listCommentsForRepo": {
  1674. "method": "GET",
  1675. "params": {
  1676. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1677. "owner": { "required": true, "type": "string" },
  1678. "repo": { "required": true, "type": "string" },
  1679. "since": { "type": "string" },
  1680. "sort": { "enum": ["created", "updated"], "type": "string" }
  1681. },
  1682. "url": "/repos/:owner/:repo/issues/comments"
  1683. },
  1684. "listEvents": {
  1685. "method": "GET",
  1686. "params": {
  1687. "issue_number": { "required": true, "type": "integer" },
  1688. "number": {
  1689. "alias": "issue_number",
  1690. "deprecated": true,
  1691. "type": "integer"
  1692. },
  1693. "owner": { "required": true, "type": "string" },
  1694. "page": { "type": "integer" },
  1695. "per_page": { "type": "integer" },
  1696. "repo": { "required": true, "type": "string" }
  1697. },
  1698. "url": "/repos/:owner/:repo/issues/:issue_number/events"
  1699. },
  1700. "listEventsForRepo": {
  1701. "method": "GET",
  1702. "params": {
  1703. "owner": { "required": true, "type": "string" },
  1704. "page": { "type": "integer" },
  1705. "per_page": { "type": "integer" },
  1706. "repo": { "required": true, "type": "string" }
  1707. },
  1708. "url": "/repos/:owner/:repo/issues/events"
  1709. },
  1710. "listEventsForTimeline": {
  1711. "headers": {
  1712. "accept": "application/vnd.github.mockingbird-preview+json"
  1713. },
  1714. "method": "GET",
  1715. "params": {
  1716. "issue_number": { "required": true, "type": "integer" },
  1717. "number": {
  1718. "alias": "issue_number",
  1719. "deprecated": true,
  1720. "type": "integer"
  1721. },
  1722. "owner": { "required": true, "type": "string" },
  1723. "page": { "type": "integer" },
  1724. "per_page": { "type": "integer" },
  1725. "repo": { "required": true, "type": "string" }
  1726. },
  1727. "url": "/repos/:owner/:repo/issues/:issue_number/timeline"
  1728. },
  1729. "listForAuthenticatedUser": {
  1730. "method": "GET",
  1731. "params": {
  1732. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1733. "filter": {
  1734. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  1735. "type": "string"
  1736. },
  1737. "labels": { "type": "string" },
  1738. "page": { "type": "integer" },
  1739. "per_page": { "type": "integer" },
  1740. "since": { "type": "string" },
  1741. "sort": {
  1742. "enum": ["created", "updated", "comments"],
  1743. "type": "string"
  1744. },
  1745. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1746. },
  1747. "url": "/user/issues"
  1748. },
  1749. "listForOrg": {
  1750. "method": "GET",
  1751. "params": {
  1752. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1753. "filter": {
  1754. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  1755. "type": "string"
  1756. },
  1757. "labels": { "type": "string" },
  1758. "org": { "required": true, "type": "string" },
  1759. "page": { "type": "integer" },
  1760. "per_page": { "type": "integer" },
  1761. "since": { "type": "string" },
  1762. "sort": {
  1763. "enum": ["created", "updated", "comments"],
  1764. "type": "string"
  1765. },
  1766. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1767. },
  1768. "url": "/orgs/:org/issues"
  1769. },
  1770. "listForRepo": {
  1771. "method": "GET",
  1772. "params": {
  1773. "assignee": { "type": "string" },
  1774. "creator": { "type": "string" },
  1775. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1776. "labels": { "type": "string" },
  1777. "mentioned": { "type": "string" },
  1778. "milestone": { "type": "string" },
  1779. "owner": { "required": true, "type": "string" },
  1780. "page": { "type": "integer" },
  1781. "per_page": { "type": "integer" },
  1782. "repo": { "required": true, "type": "string" },
  1783. "since": { "type": "string" },
  1784. "sort": {
  1785. "enum": ["created", "updated", "comments"],
  1786. "type": "string"
  1787. },
  1788. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1789. },
  1790. "url": "/repos/:owner/:repo/issues"
  1791. },
  1792. "listLabelsForMilestone": {
  1793. "method": "GET",
  1794. "params": {
  1795. "milestone_number": { "required": true, "type": "integer" },
  1796. "number": {
  1797. "alias": "milestone_number",
  1798. "deprecated": true,
  1799. "type": "integer"
  1800. },
  1801. "owner": { "required": true, "type": "string" },
  1802. "page": { "type": "integer" },
  1803. "per_page": { "type": "integer" },
  1804. "repo": { "required": true, "type": "string" }
  1805. },
  1806. "url": "/repos/:owner/:repo/milestones/:milestone_number/labels"
  1807. },
  1808. "listLabelsForRepo": {
  1809. "method": "GET",
  1810. "params": {
  1811. "owner": { "required": true, "type": "string" },
  1812. "page": { "type": "integer" },
  1813. "per_page": { "type": "integer" },
  1814. "repo": { "required": true, "type": "string" }
  1815. },
  1816. "url": "/repos/:owner/:repo/labels"
  1817. },
  1818. "listLabelsOnIssue": {
  1819. "method": "GET",
  1820. "params": {
  1821. "issue_number": { "required": true, "type": "integer" },
  1822. "number": {
  1823. "alias": "issue_number",
  1824. "deprecated": true,
  1825. "type": "integer"
  1826. },
  1827. "owner": { "required": true, "type": "string" },
  1828. "page": { "type": "integer" },
  1829. "per_page": { "type": "integer" },
  1830. "repo": { "required": true, "type": "string" }
  1831. },
  1832. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1833. },
  1834. "listMilestonesForRepo": {
  1835. "method": "GET",
  1836. "params": {
  1837. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1838. "owner": { "required": true, "type": "string" },
  1839. "page": { "type": "integer" },
  1840. "per_page": { "type": "integer" },
  1841. "repo": { "required": true, "type": "string" },
  1842. "sort": { "enum": ["due_on", "completeness"], "type": "string" },
  1843. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1844. },
  1845. "url": "/repos/:owner/:repo/milestones"
  1846. },
  1847. "lock": {
  1848. "method": "PUT",
  1849. "params": {
  1850. "issue_number": { "required": true, "type": "integer" },
  1851. "lock_reason": {
  1852. "enum": ["off-topic", "too heated", "resolved", "spam"],
  1853. "type": "string"
  1854. },
  1855. "number": {
  1856. "alias": "issue_number",
  1857. "deprecated": true,
  1858. "type": "integer"
  1859. },
  1860. "owner": { "required": true, "type": "string" },
  1861. "repo": { "required": true, "type": "string" }
  1862. },
  1863. "url": "/repos/:owner/:repo/issues/:issue_number/lock"
  1864. },
  1865. "removeAssignees": {
  1866. "method": "DELETE",
  1867. "params": {
  1868. "assignees": { "type": "string[]" },
  1869. "issue_number": { "required": true, "type": "integer" },
  1870. "number": {
  1871. "alias": "issue_number",
  1872. "deprecated": true,
  1873. "type": "integer"
  1874. },
  1875. "owner": { "required": true, "type": "string" },
  1876. "repo": { "required": true, "type": "string" }
  1877. },
  1878. "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
  1879. },
  1880. "removeLabel": {
  1881. "method": "DELETE",
  1882. "params": {
  1883. "issue_number": { "required": true, "type": "integer" },
  1884. "name": { "required": true, "type": "string" },
  1885. "number": {
  1886. "alias": "issue_number",
  1887. "deprecated": true,
  1888. "type": "integer"
  1889. },
  1890. "owner": { "required": true, "type": "string" },
  1891. "repo": { "required": true, "type": "string" }
  1892. },
  1893. "url": "/repos/:owner/:repo/issues/:issue_number/labels/:name"
  1894. },
  1895. "removeLabels": {
  1896. "method": "DELETE",
  1897. "params": {
  1898. "issue_number": { "required": true, "type": "integer" },
  1899. "number": {
  1900. "alias": "issue_number",
  1901. "deprecated": true,
  1902. "type": "integer"
  1903. },
  1904. "owner": { "required": true, "type": "string" },
  1905. "repo": { "required": true, "type": "string" }
  1906. },
  1907. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1908. },
  1909. "replaceLabels": {
  1910. "method": "PUT",
  1911. "params": {
  1912. "issue_number": { "required": true, "type": "integer" },
  1913. "labels": { "type": "string[]" },
  1914. "number": {
  1915. "alias": "issue_number",
  1916. "deprecated": true,
  1917. "type": "integer"
  1918. },
  1919. "owner": { "required": true, "type": "string" },
  1920. "repo": { "required": true, "type": "string" }
  1921. },
  1922. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1923. },
  1924. "unlock": {
  1925. "method": "DELETE",
  1926. "params": {
  1927. "issue_number": { "required": true, "type": "integer" },
  1928. "number": {
  1929. "alias": "issue_number",
  1930. "deprecated": true,
  1931. "type": "integer"
  1932. },
  1933. "owner": { "required": true, "type": "string" },
  1934. "repo": { "required": true, "type": "string" }
  1935. },
  1936. "url": "/repos/:owner/:repo/issues/:issue_number/lock"
  1937. },
  1938. "update": {
  1939. "method": "PATCH",
  1940. "params": {
  1941. "assignee": { "type": "string" },
  1942. "assignees": { "type": "string[]" },
  1943. "body": { "type": "string" },
  1944. "issue_number": { "required": true, "type": "integer" },
  1945. "labels": { "type": "string[]" },
  1946. "milestone": { "allowNull": true, "type": "integer" },
  1947. "number": {
  1948. "alias": "issue_number",
  1949. "deprecated": true,
  1950. "type": "integer"
  1951. },
  1952. "owner": { "required": true, "type": "string" },
  1953. "repo": { "required": true, "type": "string" },
  1954. "state": { "enum": ["open", "closed"], "type": "string" },
  1955. "title": { "type": "string" }
  1956. },
  1957. "url": "/repos/:owner/:repo/issues/:issue_number"
  1958. },
  1959. "updateComment": {
  1960. "method": "PATCH",
  1961. "params": {
  1962. "body": { "required": true, "type": "string" },
  1963. "comment_id": { "required": true, "type": "integer" },
  1964. "owner": { "required": true, "type": "string" },
  1965. "repo": { "required": true, "type": "string" }
  1966. },
  1967. "url": "/repos/:owner/:repo/issues/comments/:comment_id"
  1968. },
  1969. "updateLabel": {
  1970. "method": "PATCH",
  1971. "params": {
  1972. "color": { "type": "string" },
  1973. "current_name": { "required": true, "type": "string" },
  1974. "description": { "type": "string" },
  1975. "name": { "type": "string" },
  1976. "owner": { "required": true, "type": "string" },
  1977. "repo": { "required": true, "type": "string" }
  1978. },
  1979. "url": "/repos/:owner/:repo/labels/:current_name"
  1980. },
  1981. "updateMilestone": {
  1982. "method": "PATCH",
  1983. "params": {
  1984. "description": { "type": "string" },
  1985. "due_on": { "type": "string" },
  1986. "milestone_number": { "required": true, "type": "integer" },
  1987. "number": {
  1988. "alias": "milestone_number",
  1989. "deprecated": true,
  1990. "type": "integer"
  1991. },
  1992. "owner": { "required": true, "type": "string" },
  1993. "repo": { "required": true, "type": "string" },
  1994. "state": { "enum": ["open", "closed"], "type": "string" },
  1995. "title": { "type": "string" }
  1996. },
  1997. "url": "/repos/:owner/:repo/milestones/:milestone_number"
  1998. }
  1999. },
  2000. "licenses": {
  2001. "get": {
  2002. "method": "GET",
  2003. "params": { "license": { "required": true, "type": "string" } },
  2004. "url": "/licenses/:license"
  2005. },
  2006. "getForRepo": {
  2007. "method": "GET",
  2008. "params": {
  2009. "owner": { "required": true, "type": "string" },
  2010. "repo": { "required": true, "type": "string" }
  2011. },
  2012. "url": "/repos/:owner/:repo/license"
  2013. },
  2014. "list": {
  2015. "deprecated": "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)",
  2016. "method": "GET",
  2017. "params": {},
  2018. "url": "/licenses"
  2019. },
  2020. "listCommonlyUsed": { "method": "GET", "params": {}, "url": "/licenses" }
  2021. },
  2022. "markdown": {
  2023. "render": {
  2024. "method": "POST",
  2025. "params": {
  2026. "context": { "type": "string" },
  2027. "mode": { "enum": ["markdown", "gfm"], "type": "string" },
  2028. "text": { "required": true, "type": "string" }
  2029. },
  2030. "url": "/markdown"
  2031. },
  2032. "renderRaw": {
  2033. "headers": { "content-type": "text/plain; charset=utf-8" },
  2034. "method": "POST",
  2035. "params": {
  2036. "data": { "mapTo": "data", "required": true, "type": "string" }
  2037. },
  2038. "url": "/markdown/raw"
  2039. }
  2040. },
  2041. "meta": { "get": { "method": "GET", "params": {}, "url": "/meta" } },
  2042. "oauthAuthorizations": {
  2043. "checkAuthorization": {
  2044. "method": "GET",
  2045. "params": {
  2046. "access_token": { "required": true, "type": "string" },
  2047. "client_id": { "required": true, "type": "string" }
  2048. },
  2049. "url": "/applications/:client_id/tokens/:access_token"
  2050. },
  2051. "createAuthorization": {
  2052. "method": "POST",
  2053. "params": {
  2054. "client_id": { "type": "string" },
  2055. "client_secret": { "type": "string" },
  2056. "fingerprint": { "type": "string" },
  2057. "note": { "required": true, "type": "string" },
  2058. "note_url": { "type": "string" },
  2059. "scopes": { "type": "string[]" }
  2060. },
  2061. "url": "/authorizations"
  2062. },
  2063. "deleteAuthorization": {
  2064. "method": "DELETE",
  2065. "params": { "authorization_id": { "required": true, "type": "integer" } },
  2066. "url": "/authorizations/:authorization_id"
  2067. },
  2068. "deleteGrant": {
  2069. "method": "DELETE",
  2070. "params": { "grant_id": { "required": true, "type": "integer" } },
  2071. "url": "/applications/grants/:grant_id"
  2072. },
  2073. "getAuthorization": {
  2074. "method": "GET",
  2075. "params": { "authorization_id": { "required": true, "type": "integer" } },
  2076. "url": "/authorizations/:authorization_id"
  2077. },
  2078. "getGrant": {
  2079. "method": "GET",
  2080. "params": { "grant_id": { "required": true, "type": "integer" } },
  2081. "url": "/applications/grants/:grant_id"
  2082. },
  2083. "getOrCreateAuthorizationForApp": {
  2084. "method": "PUT",
  2085. "params": {
  2086. "client_id": { "required": true, "type": "string" },
  2087. "client_secret": { "required": true, "type": "string" },
  2088. "fingerprint": { "type": "string" },
  2089. "note": { "type": "string" },
  2090. "note_url": { "type": "string" },
  2091. "scopes": { "type": "string[]" }
  2092. },
  2093. "url": "/authorizations/clients/:client_id"
  2094. },
  2095. "getOrCreateAuthorizationForAppAndFingerprint": {
  2096. "method": "PUT",
  2097. "params": {
  2098. "client_id": { "required": true, "type": "string" },
  2099. "client_secret": { "required": true, "type": "string" },
  2100. "fingerprint": { "required": true, "type": "string" },
  2101. "note": { "type": "string" },
  2102. "note_url": { "type": "string" },
  2103. "scopes": { "type": "string[]" }
  2104. },
  2105. "url": "/authorizations/clients/:client_id/:fingerprint"
  2106. },
  2107. "getOrCreateAuthorizationForAppFingerprint": {
  2108. "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)",
  2109. "method": "PUT",
  2110. "params": {
  2111. "client_id": { "required": true, "type": "string" },
  2112. "client_secret": { "required": true, "type": "string" },
  2113. "fingerprint": { "required": true, "type": "string" },
  2114. "note": { "type": "string" },
  2115. "note_url": { "type": "string" },
  2116. "scopes": { "type": "string[]" }
  2117. },
  2118. "url": "/authorizations/clients/:client_id/:fingerprint"
  2119. },
  2120. "listAuthorizations": {
  2121. "method": "GET",
  2122. "params": {
  2123. "page": { "type": "integer" },
  2124. "per_page": { "type": "integer" }
  2125. },
  2126. "url": "/authorizations"
  2127. },
  2128. "listGrants": {
  2129. "method": "GET",
  2130. "params": {
  2131. "page": { "type": "integer" },
  2132. "per_page": { "type": "integer" }
  2133. },
  2134. "url": "/applications/grants"
  2135. },
  2136. "resetAuthorization": {
  2137. "method": "POST",
  2138. "params": {
  2139. "access_token": { "required": true, "type": "string" },
  2140. "client_id": { "required": true, "type": "string" }
  2141. },
  2142. "url": "/applications/:client_id/tokens/:access_token"
  2143. },
  2144. "revokeAuthorizationForApplication": {
  2145. "method": "DELETE",
  2146. "params": {
  2147. "access_token": { "required": true, "type": "string" },
  2148. "client_id": { "required": true, "type": "string" }
  2149. },
  2150. "url": "/applications/:client_id/tokens/:access_token"
  2151. },
  2152. "revokeGrantForApplication": {
  2153. "method": "DELETE",
  2154. "params": {
  2155. "access_token": { "required": true, "type": "string" },
  2156. "client_id": { "required": true, "type": "string" }
  2157. },
  2158. "url": "/applications/:client_id/grants/:access_token"
  2159. },
  2160. "updateAuthorization": {
  2161. "method": "PATCH",
  2162. "params": {
  2163. "add_scopes": { "type": "string[]" },
  2164. "authorization_id": { "required": true, "type": "integer" },
  2165. "fingerprint": { "type": "string" },
  2166. "note": { "type": "string" },
  2167. "note_url": { "type": "string" },
  2168. "remove_scopes": { "type": "string[]" },
  2169. "scopes": { "type": "string[]" }
  2170. },
  2171. "url": "/authorizations/:authorization_id"
  2172. }
  2173. },
  2174. "orgs": {
  2175. "addOrUpdateMembership": {
  2176. "method": "PUT",
  2177. "params": {
  2178. "org": { "required": true, "type": "string" },
  2179. "role": { "enum": ["admin", "member"], "type": "string" },
  2180. "username": { "required": true, "type": "string" }
  2181. },
  2182. "url": "/orgs/:org/memberships/:username"
  2183. },
  2184. "checkMembership": {
  2185. "method": "GET",
  2186. "params": {
  2187. "org": { "required": true, "type": "string" },
  2188. "username": { "required": true, "type": "string" }
  2189. },
  2190. "url": "/orgs/:org/members/:username"
  2191. },
  2192. "checkPublicMembership": {
  2193. "method": "GET",
  2194. "params": {
  2195. "org": { "required": true, "type": "string" },
  2196. "username": { "required": true, "type": "string" }
  2197. },
  2198. "url": "/orgs/:org/public_members/:username"
  2199. },
  2200. "concealMembership": {
  2201. "method": "DELETE",
  2202. "params": {
  2203. "org": { "required": true, "type": "string" },
  2204. "username": { "required": true, "type": "string" }
  2205. },
  2206. "url": "/orgs/:org/public_members/:username"
  2207. },
  2208. "convertMemberToOutsideCollaborator": {
  2209. "method": "PUT",
  2210. "params": {
  2211. "org": { "required": true, "type": "string" },
  2212. "username": { "required": true, "type": "string" }
  2213. },
  2214. "url": "/orgs/:org/outside_collaborators/:username"
  2215. },
  2216. "createHook": {
  2217. "method": "POST",
  2218. "params": {
  2219. "active": { "type": "boolean" },
  2220. "config": { "required": true, "type": "object" },
  2221. "config.content_type": { "type": "string" },
  2222. "config.insecure_ssl": { "type": "string" },
  2223. "config.secret": { "type": "string" },
  2224. "config.url": { "required": true, "type": "string" },
  2225. "events": { "type": "string[]" },
  2226. "name": { "required": true, "type": "string" },
  2227. "org": { "required": true, "type": "string" }
  2228. },
  2229. "url": "/orgs/:org/hooks"
  2230. },
  2231. "deleteHook": {
  2232. "method": "DELETE",
  2233. "params": {
  2234. "hook_id": { "required": true, "type": "integer" },
  2235. "org": { "required": true, "type": "string" }
  2236. },
  2237. "url": "/orgs/:org/hooks/:hook_id"
  2238. },
  2239. "get": {
  2240. "method": "GET",
  2241. "params": { "org": { "required": true, "type": "string" } },
  2242. "url": "/orgs/:org"
  2243. },
  2244. "getHook": {
  2245. "method": "GET",
  2246. "params": {
  2247. "hook_id": { "required": true, "type": "integer" },
  2248. "org": { "required": true, "type": "string" }
  2249. },
  2250. "url": "/orgs/:org/hooks/:hook_id"
  2251. },
  2252. "getMembership": {
  2253. "method": "GET",
  2254. "params": {
  2255. "org": { "required": true, "type": "string" },
  2256. "username": { "required": true, "type": "string" }
  2257. },
  2258. "url": "/orgs/:org/memberships/:username"
  2259. },
  2260. "getMembershipForAuthenticatedUser": {
  2261. "method": "GET",
  2262. "params": { "org": { "required": true, "type": "string" } },
  2263. "url": "/user/memberships/orgs/:org"
  2264. },
  2265. "list": {
  2266. "method": "GET",
  2267. "params": {
  2268. "page": { "type": "integer" },
  2269. "per_page": { "type": "integer" },
  2270. "since": { "type": "string" }
  2271. },
  2272. "url": "/organizations"
  2273. },
  2274. "listForAuthenticatedUser": {
  2275. "method": "GET",
  2276. "params": {
  2277. "page": { "type": "integer" },
  2278. "per_page": { "type": "integer" }
  2279. },
  2280. "url": "/user/orgs"
  2281. },
  2282. "listForUser": {
  2283. "method": "GET",
  2284. "params": {
  2285. "page": { "type": "integer" },
  2286. "per_page": { "type": "integer" },
  2287. "username": { "required": true, "type": "string" }
  2288. },
  2289. "url": "/users/:username/orgs"
  2290. },
  2291. "listHooks": {
  2292. "method": "GET",
  2293. "params": {
  2294. "org": { "required": true, "type": "string" },
  2295. "page": { "type": "integer" },
  2296. "per_page": { "type": "integer" }
  2297. },
  2298. "url": "/orgs/:org/hooks"
  2299. },
  2300. "listMembers": {
  2301. "method": "GET",
  2302. "params": {
  2303. "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
  2304. "org": { "required": true, "type": "string" },
  2305. "page": { "type": "integer" },
  2306. "per_page": { "type": "integer" },
  2307. "role": { "enum": ["all", "admin", "member"], "type": "string" }
  2308. },
  2309. "url": "/orgs/:org/members"
  2310. },
  2311. "listMemberships": {
  2312. "method": "GET",
  2313. "params": {
  2314. "page": { "type": "integer" },
  2315. "per_page": { "type": "integer" },
  2316. "state": { "enum": ["active", "pending"], "type": "string" }
  2317. },
  2318. "url": "/user/memberships/orgs"
  2319. },
  2320. "listOutsideCollaborators": {
  2321. "method": "GET",
  2322. "params": {
  2323. "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
  2324. "org": { "required": true, "type": "string" },
  2325. "page": { "type": "integer" },
  2326. "per_page": { "type": "integer" }
  2327. },
  2328. "url": "/orgs/:org/outside_collaborators"
  2329. },
  2330. "listPublicMembers": {
  2331. "method": "GET",
  2332. "params": {
  2333. "org": { "required": true, "type": "string" },
  2334. "page": { "type": "integer" },
  2335. "per_page": { "type": "integer" }
  2336. },
  2337. "url": "/orgs/:org/public_members"
  2338. },
  2339. "pingHook": {
  2340. "method": "POST",
  2341. "params": {
  2342. "hook_id": { "required": true, "type": "integer" },
  2343. "org": { "required": true, "type": "string" }
  2344. },
  2345. "url": "/orgs/:org/hooks/:hook_id/pings"
  2346. },
  2347. "publicizeMembership": {
  2348. "method": "PUT",
  2349. "params": {
  2350. "org": { "required": true, "type": "string" },
  2351. "username": { "required": true, "type": "string" }
  2352. },
  2353. "url": "/orgs/:org/public_members/:username"
  2354. },
  2355. "removeMember": {
  2356. "method": "DELETE",
  2357. "params": {
  2358. "org": { "required": true, "type": "string" },
  2359. "username": { "required": true, "type": "string" }
  2360. },
  2361. "url": "/orgs/:org/members/:username"
  2362. },
  2363. "removeMembership": {
  2364. "method": "DELETE",
  2365. "params": {
  2366. "org": { "required": true, "type": "string" },
  2367. "username": { "required": true, "type": "string" }
  2368. },
  2369. "url": "/orgs/:org/memberships/:username"
  2370. },
  2371. "removeOutsideCollaborator": {
  2372. "method": "DELETE",
  2373. "params": {
  2374. "org": { "required": true, "type": "string" },
  2375. "username": { "required": true, "type": "string" }
  2376. },
  2377. "url": "/orgs/:org/outside_collaborators/:username"
  2378. },
  2379. "update": {
  2380. "method": "PATCH",
  2381. "params": {
  2382. "billing_email": { "type": "string" },
  2383. "company": { "type": "string" },
  2384. "default_repository_permission": {
  2385. "enum": ["read", "write", "admin", "none"],
  2386. "type": "string"
  2387. },
  2388. "description": { "type": "string" },
  2389. "email": { "type": "string" },
  2390. "has_organization_projects": { "type": "boolean" },
  2391. "has_repository_projects": { "type": "boolean" },
  2392. "location": { "type": "string" },
  2393. "members_allowed_repository_creation_type": {
  2394. "enum": ["all", "private", "none"],
  2395. "type": "string"
  2396. },
  2397. "members_can_create_repositories": { "type": "boolean" },
  2398. "name": { "type": "string" },
  2399. "org": { "required": true, "type": "string" }
  2400. },
  2401. "url": "/orgs/:org"
  2402. },
  2403. "updateHook": {
  2404. "method": "PATCH",
  2405. "params": {
  2406. "active": { "type": "boolean" },
  2407. "config": { "type": "object" },
  2408. "config.content_type": { "type": "string" },
  2409. "config.insecure_ssl": { "type": "string" },
  2410. "config.secret": { "type": "string" },
  2411. "config.url": { "required": true, "type": "string" },
  2412. "events": { "type": "string[]" },
  2413. "hook_id": { "required": true, "type": "integer" },
  2414. "org": { "required": true, "type": "string" }
  2415. },
  2416. "url": "/orgs/:org/hooks/:hook_id"
  2417. },
  2418. "updateMembership": {
  2419. "method": "PATCH",
  2420. "params": {
  2421. "org": { "required": true, "type": "string" },
  2422. "state": { "enum": ["active"], "required": true, "type": "string" }
  2423. },
  2424. "url": "/user/memberships/orgs/:org"
  2425. }
  2426. },
  2427. "projects": {
  2428. "addCollaborator": {
  2429. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2430. "method": "PUT",
  2431. "params": {
  2432. "permission": { "enum": ["read", "write", "admin"], "type": "string" },
  2433. "project_id": { "required": true, "type": "integer" },
  2434. "username": { "required": true, "type": "string" }
  2435. },
  2436. "url": "/projects/:project_id/collaborators/:username"
  2437. },
  2438. "createCard": {
  2439. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2440. "method": "POST",
  2441. "params": {
  2442. "column_id": { "required": true, "type": "integer" },
  2443. "content_id": { "type": "integer" },
  2444. "content_type": { "type": "string" },
  2445. "note": { "type": "string" }
  2446. },
  2447. "url": "/projects/columns/:column_id/cards"
  2448. },
  2449. "createColumn": {
  2450. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2451. "method": "POST",
  2452. "params": {
  2453. "name": { "required": true, "type": "string" },
  2454. "project_id": { "required": true, "type": "integer" }
  2455. },
  2456. "url": "/projects/:project_id/columns"
  2457. },
  2458. "createForOrg": {
  2459. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2460. "method": "POST",
  2461. "params": {
  2462. "body": { "type": "string" },
  2463. "name": { "required": true, "type": "string" },
  2464. "org": { "required": true, "type": "string" }
  2465. },
  2466. "url": "/orgs/:org/projects"
  2467. },
  2468. "createForRepo": {
  2469. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2470. "method": "POST",
  2471. "params": {
  2472. "body": { "type": "string" },
  2473. "name": { "required": true, "type": "string" },
  2474. "owner": { "required": true, "type": "string" },
  2475. "repo": { "required": true, "type": "string" }
  2476. },
  2477. "url": "/repos/:owner/:repo/projects"
  2478. },
  2479. "delete": {
  2480. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2481. "method": "DELETE",
  2482. "params": { "project_id": { "required": true, "type": "integer" } },
  2483. "url": "/projects/:project_id"
  2484. },
  2485. "deleteCard": {
  2486. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2487. "method": "DELETE",
  2488. "params": { "card_id": { "required": true, "type": "integer" } },
  2489. "url": "/projects/columns/cards/:card_id"
  2490. },
  2491. "deleteColumn": {
  2492. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2493. "method": "DELETE",
  2494. "params": { "column_id": { "required": true, "type": "integer" } },
  2495. "url": "/projects/columns/:column_id"
  2496. },
  2497. "get": {
  2498. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2499. "method": "GET",
  2500. "params": {
  2501. "page": { "type": "integer" },
  2502. "per_page": { "type": "integer" },
  2503. "project_id": { "required": true, "type": "integer" }
  2504. },
  2505. "url": "/projects/:project_id"
  2506. },
  2507. "getCard": {
  2508. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2509. "method": "GET",
  2510. "params": { "card_id": { "required": true, "type": "integer" } },
  2511. "url": "/projects/columns/cards/:card_id"
  2512. },
  2513. "getColumn": {
  2514. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2515. "method": "GET",
  2516. "params": { "column_id": { "required": true, "type": "integer" } },
  2517. "url": "/projects/columns/:column_id"
  2518. },
  2519. "listCards": {
  2520. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2521. "method": "GET",
  2522. "params": {
  2523. "archived_state": {
  2524. "enum": ["all", "archived", "not_archived"],
  2525. "type": "string"
  2526. },
  2527. "column_id": { "required": true, "type": "integer" },
  2528. "page": { "type": "integer" },
  2529. "per_page": { "type": "integer" }
  2530. },
  2531. "url": "/projects/columns/:column_id/cards"
  2532. },
  2533. "listCollaborators": {
  2534. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2535. "method": "GET",
  2536. "params": {
  2537. "affiliation": {
  2538. "enum": ["outside", "direct", "all"],
  2539. "type": "string"
  2540. },
  2541. "page": { "type": "integer" },
  2542. "per_page": { "type": "integer" },
  2543. "project_id": { "required": true, "type": "integer" }
  2544. },
  2545. "url": "/projects/:project_id/collaborators"
  2546. },
  2547. "listColumns": {
  2548. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2549. "method": "GET",
  2550. "params": {
  2551. "page": { "type": "integer" },
  2552. "per_page": { "type": "integer" },
  2553. "project_id": { "required": true, "type": "integer" }
  2554. },
  2555. "url": "/projects/:project_id/columns"
  2556. },
  2557. "listForOrg": {
  2558. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2559. "method": "GET",
  2560. "params": {
  2561. "org": { "required": true, "type": "string" },
  2562. "page": { "type": "integer" },
  2563. "per_page": { "type": "integer" },
  2564. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  2565. },
  2566. "url": "/orgs/:org/projects"
  2567. },
  2568. "listForRepo": {
  2569. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2570. "method": "GET",
  2571. "params": {
  2572. "owner": { "required": true, "type": "string" },
  2573. "page": { "type": "integer" },
  2574. "per_page": { "type": "integer" },
  2575. "repo": { "required": true, "type": "string" },
  2576. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  2577. },
  2578. "url": "/repos/:owner/:repo/projects"
  2579. },
  2580. "moveCard": {
  2581. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2582. "method": "POST",
  2583. "params": {
  2584. "card_id": { "required": true, "type": "integer" },
  2585. "column_id": { "type": "integer" },
  2586. "position": {
  2587. "required": true,
  2588. "type": "string",
  2589. "validation": "^(top|bottom|after:\\d+)$"
  2590. }
  2591. },
  2592. "url": "/projects/columns/cards/:card_id/moves"
  2593. },
  2594. "moveColumn": {
  2595. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2596. "method": "POST",
  2597. "params": {
  2598. "column_id": { "required": true, "type": "integer" },
  2599. "position": {
  2600. "required": true,
  2601. "type": "string",
  2602. "validation": "^(first|last|after:\\d+)$"
  2603. }
  2604. },
  2605. "url": "/projects/columns/:column_id/moves"
  2606. },
  2607. "removeCollaborator": {
  2608. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2609. "method": "DELETE",
  2610. "params": {
  2611. "project_id": { "required": true, "type": "integer" },
  2612. "username": { "required": true, "type": "string" }
  2613. },
  2614. "url": "/projects/:project_id/collaborators/:username"
  2615. },
  2616. "reviewUserPermissionLevel": {
  2617. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2618. "method": "GET",
  2619. "params": {
  2620. "project_id": { "required": true, "type": "integer" },
  2621. "username": { "required": true, "type": "string" }
  2622. },
  2623. "url": "/projects/:project_id/collaborators/:username/permission"
  2624. },
  2625. "update": {
  2626. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2627. "method": "PATCH",
  2628. "params": {
  2629. "body": { "type": "string" },
  2630. "name": { "type": "string" },
  2631. "organization_permission": { "type": "string" },
  2632. "private": { "type": "boolean" },
  2633. "project_id": { "required": true, "type": "integer" },
  2634. "state": { "enum": ["open", "closed"], "type": "string" }
  2635. },
  2636. "url": "/projects/:project_id"
  2637. },
  2638. "updateCard": {
  2639. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2640. "method": "PATCH",
  2641. "params": {
  2642. "archived": { "type": "boolean" },
  2643. "card_id": { "required": true, "type": "integer" },
  2644. "note": { "type": "string" }
  2645. },
  2646. "url": "/projects/columns/cards/:card_id"
  2647. },
  2648. "updateColumn": {
  2649. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2650. "method": "PATCH",
  2651. "params": {
  2652. "column_id": { "required": true, "type": "integer" },
  2653. "name": { "required": true, "type": "string" }
  2654. },
  2655. "url": "/projects/columns/:column_id"
  2656. }
  2657. },
  2658. "pulls": {
  2659. "checkIfMerged": {
  2660. "method": "GET",
  2661. "params": {
  2662. "number": {
  2663. "alias": "pull_number",
  2664. "deprecated": true,
  2665. "type": "integer"
  2666. },
  2667. "owner": { "required": true, "type": "string" },
  2668. "pull_number": { "required": true, "type": "integer" },
  2669. "repo": { "required": true, "type": "string" }
  2670. },
  2671. "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
  2672. },
  2673. "create": {
  2674. "method": "POST",
  2675. "params": {
  2676. "base": { "required": true, "type": "string" },
  2677. "body": { "type": "string" },
  2678. "head": { "required": true, "type": "string" },
  2679. "maintainer_can_modify": { "type": "boolean" },
  2680. "owner": { "required": true, "type": "string" },
  2681. "repo": { "required": true, "type": "string" },
  2682. "title": { "required": true, "type": "string" }
  2683. },
  2684. "url": "/repos/:owner/:repo/pulls"
  2685. },
  2686. "createCommentReply": {
  2687. "method": "POST",
  2688. "params": {
  2689. "body": { "required": true, "type": "string" },
  2690. "in_reply_to": { "required": true, "type": "integer" },
  2691. "number": {
  2692. "alias": "pull_number",
  2693. "deprecated": true,
  2694. "type": "integer"
  2695. },
  2696. "owner": { "required": true, "type": "string" },
  2697. "pull_number": { "required": true, "type": "integer" },
  2698. "repo": { "required": true, "type": "string" }
  2699. },
  2700. "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
  2701. },
  2702. "createFromIssue": {
  2703. "deprecated": "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request",
  2704. "method": "POST",
  2705. "params": {
  2706. "base": { "required": true, "type": "string" },
  2707. "head": { "required": true, "type": "string" },
  2708. "issue": { "required": true, "type": "integer" },
  2709. "maintainer_can_modify": { "type": "boolean" },
  2710. "owner": { "required": true, "type": "string" },
  2711. "repo": { "required": true, "type": "string" }
  2712. },
  2713. "url": "/repos/:owner/:repo/pulls"
  2714. },
  2715. "createReview": {
  2716. "method": "POST",
  2717. "params": {
  2718. "body": { "type": "string" },
  2719. "comments": { "type": "object[]" },
  2720. "comments[].body": { "required": true, "type": "string" },
  2721. "comments[].path": { "required": true, "type": "string" },
  2722. "comments[].position": { "required": true, "type": "integer" },
  2723. "commit_id": { "type": "string" },
  2724. "event": {
  2725. "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  2726. "type": "string"
  2727. },
  2728. "number": {
  2729. "alias": "pull_number",
  2730. "deprecated": true,
  2731. "type": "integer"
  2732. },
  2733. "owner": { "required": true, "type": "string" },
  2734. "pull_number": { "required": true, "type": "integer" },
  2735. "repo": { "required": true, "type": "string" }
  2736. },
  2737. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
  2738. },
  2739. "createReviewRequest": {
  2740. "method": "POST",
  2741. "params": {
  2742. "number": {
  2743. "alias": "pull_number",
  2744. "deprecated": true,
  2745. "type": "integer"
  2746. },
  2747. "owner": { "required": true, "type": "string" },
  2748. "pull_number": { "required": true, "type": "integer" },
  2749. "repo": { "required": true, "type": "string" },
  2750. "reviewers": { "type": "string[]" },
  2751. "team_reviewers": { "type": "string[]" }
  2752. },
  2753. "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  2754. },
  2755. "deleteComment": {
  2756. "method": "DELETE",
  2757. "params": {
  2758. "comment_id": { "required": true, "type": "integer" },
  2759. "owner": { "required": true, "type": "string" },
  2760. "repo": { "required": true, "type": "string" }
  2761. },
  2762. "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
  2763. },
  2764. "deletePendingReview": {
  2765. "method": "DELETE",
  2766. "params": {
  2767. "number": {
  2768. "alias": "pull_number",
  2769. "deprecated": true,
  2770. "type": "integer"
  2771. },
  2772. "owner": { "required": true, "type": "string" },
  2773. "pull_number": { "required": true, "type": "integer" },
  2774. "repo": { "required": true, "type": "string" },
  2775. "review_id": { "required": true, "type": "integer" }
  2776. },
  2777. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  2778. },
  2779. "deleteReviewRequest": {
  2780. "method": "DELETE",
  2781. "params": {
  2782. "number": {
  2783. "alias": "pull_number",
  2784. "deprecated": true,
  2785. "type": "integer"
  2786. },
  2787. "owner": { "required": true, "type": "string" },
  2788. "pull_number": { "required": true, "type": "integer" },
  2789. "repo": { "required": true, "type": "string" },
  2790. "reviewers": { "type": "string[]" },
  2791. "team_reviewers": { "type": "string[]" }
  2792. },
  2793. "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  2794. },
  2795. "dismissReview": {
  2796. "method": "PUT",
  2797. "params": {
  2798. "message": { "required": true, "type": "string" },
  2799. "number": {
  2800. "alias": "pull_number",
  2801. "deprecated": true,
  2802. "type": "integer"
  2803. },
  2804. "owner": { "required": true, "type": "string" },
  2805. "pull_number": { "required": true, "type": "integer" },
  2806. "repo": { "required": true, "type": "string" },
  2807. "review_id": { "required": true, "type": "integer" }
  2808. },
  2809. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"
  2810. },
  2811. "get": {
  2812. "method": "GET",
  2813. "params": {
  2814. "number": {
  2815. "alias": "pull_number",
  2816. "deprecated": true,
  2817. "type": "integer"
  2818. },
  2819. "owner": { "required": true, "type": "string" },
  2820. "pull_number": { "required": true, "type": "integer" },
  2821. "repo": { "required": true, "type": "string" }
  2822. },
  2823. "url": "/repos/:owner/:repo/pulls/:pull_number"
  2824. },
  2825. "getComment": {
  2826. "method": "GET",
  2827. "params": {
  2828. "comment_id": { "required": true, "type": "integer" },
  2829. "owner": { "required": true, "type": "string" },
  2830. "repo": { "required": true, "type": "string" }
  2831. },
  2832. "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
  2833. },
  2834. "getCommentsForReview": {
  2835. "method": "GET",
  2836. "params": {
  2837. "number": {
  2838. "alias": "pull_number",
  2839. "deprecated": true,
  2840. "type": "integer"
  2841. },
  2842. "owner": { "required": true, "type": "string" },
  2843. "page": { "type": "integer" },
  2844. "per_page": { "type": "integer" },
  2845. "pull_number": { "required": true, "type": "integer" },
  2846. "repo": { "required": true, "type": "string" },
  2847. "review_id": { "required": true, "type": "integer" }
  2848. },
  2849. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"
  2850. },
  2851. "getReview": {
  2852. "method": "GET",
  2853. "params": {
  2854. "number": {
  2855. "alias": "pull_number",
  2856. "deprecated": true,
  2857. "type": "integer"
  2858. },
  2859. "owner": { "required": true, "type": "string" },
  2860. "pull_number": { "required": true, "type": "integer" },
  2861. "repo": { "required": true, "type": "string" },
  2862. "review_id": { "required": true, "type": "integer" }
  2863. },
  2864. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  2865. },
  2866. "list": {
  2867. "method": "GET",
  2868. "params": {
  2869. "base": { "type": "string" },
  2870. "direction": { "enum": ["asc", "desc"], "type": "string" },
  2871. "head": { "type": "string" },
  2872. "owner": { "required": true, "type": "string" },
  2873. "page": { "type": "integer" },
  2874. "per_page": { "type": "integer" },
  2875. "repo": { "required": true, "type": "string" },
  2876. "sort": {
  2877. "enum": ["created", "updated", "popularity", "long-running"],
  2878. "type": "string"
  2879. },
  2880. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  2881. },
  2882. "url": "/repos/:owner/:repo/pulls"
  2883. },
  2884. "listComments": {
  2885. "method": "GET",
  2886. "params": {
  2887. "direction": { "enum": ["asc", "desc"], "type": "string" },
  2888. "number": {
  2889. "alias": "pull_number",
  2890. "deprecated": true,
  2891. "type": "integer"
  2892. },
  2893. "owner": { "required": true, "type": "string" },
  2894. "page": { "type": "integer" },
  2895. "per_page": { "type": "integer" },
  2896. "pull_number": { "required": true, "type": "integer" },
  2897. "repo": { "required": true, "type": "string" },
  2898. "since": { "type": "string" },
  2899. "sort": { "enum": ["created", "updated"], "type": "string" }
  2900. },
  2901. "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
  2902. },
  2903. "listCommentsForRepo": {
  2904. "method": "GET",
  2905. "params": {
  2906. "direction": { "enum": ["asc", "desc"], "type": "string" },
  2907. "owner": { "required": true, "type": "string" },
  2908. "page": { "type": "integer" },
  2909. "per_page": { "type": "integer" },
  2910. "repo": { "required": true, "type": "string" },
  2911. "since": { "type": "string" },
  2912. "sort": { "enum": ["created", "updated"], "type": "string" }
  2913. },
  2914. "url": "/repos/:owner/:repo/pulls/comments"
  2915. },
  2916. "listCommits": {
  2917. "method": "GET",
  2918. "params": {
  2919. "number": {
  2920. "alias": "pull_number",
  2921. "deprecated": true,
  2922. "type": "integer"
  2923. },
  2924. "owner": { "required": true, "type": "string" },
  2925. "page": { "type": "integer" },
  2926. "per_page": { "type": "integer" },
  2927. "pull_number": { "required": true, "type": "integer" },
  2928. "repo": { "required": true, "type": "string" }
  2929. },
  2930. "url": "/repos/:owner/:repo/pulls/:pull_number/commits"
  2931. },
  2932. "listFiles": {
  2933. "method": "GET",
  2934. "params": {
  2935. "number": {
  2936. "alias": "pull_number",
  2937. "deprecated": true,
  2938. "type": "integer"
  2939. },
  2940. "owner": { "required": true, "type": "string" },
  2941. "page": { "type": "integer" },
  2942. "per_page": { "type": "integer" },
  2943. "pull_number": { "required": true, "type": "integer" },
  2944. "repo": { "required": true, "type": "string" }
  2945. },
  2946. "url": "/repos/:owner/:repo/pulls/:pull_number/files"
  2947. },
  2948. "listReviewRequests": {
  2949. "method": "GET",
  2950. "params": {
  2951. "number": {
  2952. "alias": "pull_number",
  2953. "deprecated": true,
  2954. "type": "integer"
  2955. },
  2956. "owner": { "required": true, "type": "string" },
  2957. "page": { "type": "integer" },
  2958. "per_page": { "type": "integer" },
  2959. "pull_number": { "required": true, "type": "integer" },
  2960. "repo": { "required": true, "type": "string" }
  2961. },
  2962. "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  2963. },
  2964. "listReviews": {
  2965. "method": "GET",
  2966. "params": {
  2967. "number": {
  2968. "alias": "pull_number",
  2969. "deprecated": true,
  2970. "type": "integer"
  2971. },
  2972. "owner": { "required": true, "type": "string" },
  2973. "page": { "type": "integer" },
  2974. "per_page": { "type": "integer" },
  2975. "pull_number": { "required": true, "type": "integer" },
  2976. "repo": { "required": true, "type": "string" }
  2977. },
  2978. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
  2979. },
  2980. "merge": {
  2981. "method": "PUT",
  2982. "params": {
  2983. "commit_message": { "type": "string" },
  2984. "commit_title": { "type": "string" },
  2985. "merge_method": {
  2986. "enum": ["merge", "squash", "rebase"],
  2987. "type": "string"
  2988. },
  2989. "number": {
  2990. "alias": "pull_number",
  2991. "deprecated": true,
  2992. "type": "integer"
  2993. },
  2994. "owner": { "required": true, "type": "string" },
  2995. "pull_number": { "required": true, "type": "integer" },
  2996. "repo": { "required": true, "type": "string" },
  2997. "sha": { "type": "string" }
  2998. },
  2999. "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
  3000. },
  3001. "submitReview": {
  3002. "method": "POST",
  3003. "params": {
  3004. "body": { "type": "string" },
  3005. "event": {
  3006. "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  3007. "required": true,
  3008. "type": "string"
  3009. },
  3010. "number": {
  3011. "alias": "pull_number",
  3012. "deprecated": true,
  3013. "type": "integer"
  3014. },
  3015. "owner": { "required": true, "type": "string" },
  3016. "pull_number": { "required": true, "type": "integer" },
  3017. "repo": { "required": true, "type": "string" },
  3018. "review_id": { "required": true, "type": "integer" }
  3019. },
  3020. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"
  3021. },
  3022. "update": {
  3023. "method": "PATCH",
  3024. "params": {
  3025. "base": { "type": "string" },
  3026. "body": { "type": "string" },
  3027. "maintainer_can_modify": { "type": "boolean" },
  3028. "number": {
  3029. "alias": "pull_number",
  3030. "deprecated": true,
  3031. "type": "integer"
  3032. },
  3033. "owner": { "required": true, "type": "string" },
  3034. "pull_number": { "required": true, "type": "integer" },
  3035. "repo": { "required": true, "type": "string" },
  3036. "state": { "enum": ["open", "closed"], "type": "string" },
  3037. "title": { "type": "string" }
  3038. },
  3039. "url": "/repos/:owner/:repo/pulls/:pull_number"
  3040. },
  3041. "updateComment": {
  3042. "method": "PATCH",
  3043. "params": {
  3044. "body": { "required": true, "type": "string" },
  3045. "comment_id": { "required": true, "type": "integer" },
  3046. "owner": { "required": true, "type": "string" },
  3047. "repo": { "required": true, "type": "string" }
  3048. },
  3049. "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
  3050. }
  3051. },
  3052. "rateLimit": {
  3053. "get": { "method": "GET", "params": {}, "url": "/rate_limit" }
  3054. },
  3055. "reactions": {
  3056. "createForCommitComment": {
  3057. "headers": {
  3058. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3059. },
  3060. "method": "POST",
  3061. "params": {
  3062. "comment_id": { "required": true, "type": "integer" },
  3063. "content": {
  3064. "enum": [
  3065. "+1",
  3066. "-1",
  3067. "laugh",
  3068. "confused",
  3069. "heart",
  3070. "hooray",
  3071. "rocket",
  3072. "eyes"
  3073. ],
  3074. "required": true,
  3075. "type": "string"
  3076. },
  3077. "owner": { "required": true, "type": "string" },
  3078. "repo": { "required": true, "type": "string" }
  3079. },
  3080. "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
  3081. },
  3082. "createForIssue": {
  3083. "headers": {
  3084. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3085. },
  3086. "method": "POST",
  3087. "params": {
  3088. "content": {
  3089. "enum": [
  3090. "+1",
  3091. "-1",
  3092. "laugh",
  3093. "confused",
  3094. "heart",
  3095. "hooray",
  3096. "rocket",
  3097. "eyes"
  3098. ],
  3099. "required": true,
  3100. "type": "string"
  3101. },
  3102. "issue_number": { "required": true, "type": "integer" },
  3103. "number": {
  3104. "alias": "issue_number",
  3105. "deprecated": true,
  3106. "type": "integer"
  3107. },
  3108. "owner": { "required": true, "type": "string" },
  3109. "repo": { "required": true, "type": "string" }
  3110. },
  3111. "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
  3112. },
  3113. "createForIssueComment": {
  3114. "headers": {
  3115. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3116. },
  3117. "method": "POST",
  3118. "params": {
  3119. "comment_id": { "required": true, "type": "integer" },
  3120. "content": {
  3121. "enum": [
  3122. "+1",
  3123. "-1",
  3124. "laugh",
  3125. "confused",
  3126. "heart",
  3127. "hooray",
  3128. "rocket",
  3129. "eyes"
  3130. ],
  3131. "required": true,
  3132. "type": "string"
  3133. },
  3134. "owner": { "required": true, "type": "string" },
  3135. "repo": { "required": true, "type": "string" }
  3136. },
  3137. "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
  3138. },
  3139. "createForPullRequestReviewComment": {
  3140. "headers": {
  3141. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3142. },
  3143. "method": "POST",
  3144. "params": {
  3145. "comment_id": { "required": true, "type": "integer" },
  3146. "content": {
  3147. "enum": [
  3148. "+1",
  3149. "-1",
  3150. "laugh",
  3151. "confused",
  3152. "heart",
  3153. "hooray",
  3154. "rocket",
  3155. "eyes"
  3156. ],
  3157. "required": true,
  3158. "type": "string"
  3159. },
  3160. "owner": { "required": true, "type": "string" },
  3161. "repo": { "required": true, "type": "string" }
  3162. },
  3163. "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
  3164. },
  3165. "createForTeamDiscussion": {
  3166. "headers": {
  3167. "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  3168. },
  3169. "method": "POST",
  3170. "params": {
  3171. "content": {
  3172. "enum": [
  3173. "+1",
  3174. "-1",
  3175. "laugh",
  3176. "confused",
  3177. "heart",
  3178. "hooray",
  3179. "rocket",
  3180. "eyes"
  3181. ],
  3182. "required": true,
  3183. "type": "string"
  3184. },
  3185. "discussion_number": { "required": true, "type": "integer" },
  3186. "team_id": { "required": true, "type": "integer" }
  3187. },
  3188. "url": "/teams/:team_id/discussions/:discussion_number/reactions"
  3189. },
  3190. "createForTeamDiscussionComment": {
  3191. "headers": {
  3192. "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  3193. },
  3194. "method": "POST",
  3195. "params": {
  3196. "comment_number": { "required": true, "type": "integer" },
  3197. "content": {
  3198. "enum": [
  3199. "+1",
  3200. "-1",
  3201. "laugh",
  3202. "confused",
  3203. "heart",
  3204. "hooray",
  3205. "rocket",
  3206. "eyes"
  3207. ],
  3208. "required": true,
  3209. "type": "string"
  3210. },
  3211. "discussion_number": { "required": true, "type": "integer" },
  3212. "team_id": { "required": true, "type": "integer" }
  3213. },
  3214. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  3215. },
  3216. "delete": {
  3217. "headers": {
  3218. "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  3219. },
  3220. "method": "DELETE",
  3221. "params": { "reaction_id": { "required": true, "type": "integer" } },
  3222. "url": "/reactions/:reaction_id"
  3223. },
  3224. "listForCommitComment": {
  3225. "headers": {
  3226. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3227. },
  3228. "method": "GET",
  3229. "params": {
  3230. "comment_id": { "required": true, "type": "integer" },
  3231. "content": {
  3232. "enum": [
  3233. "+1",
  3234. "-1",
  3235. "laugh",
  3236. "confused",
  3237. "heart",
  3238. "hooray",
  3239. "rocket",
  3240. "eyes"
  3241. ],
  3242. "type": "string"
  3243. },
  3244. "owner": { "required": true, "type": "string" },
  3245. "page": { "type": "integer" },
  3246. "per_page": { "type": "integer" },
  3247. "repo": { "required": true, "type": "string" }
  3248. },
  3249. "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
  3250. },
  3251. "listForIssue": {
  3252. "headers": {
  3253. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3254. },
  3255. "method": "GET",
  3256. "params": {
  3257. "content": {
  3258. "enum": [
  3259. "+1",
  3260. "-1",
  3261. "laugh",
  3262. "confused",
  3263. "heart",
  3264. "hooray",
  3265. "rocket",
  3266. "eyes"
  3267. ],
  3268. "type": "string"
  3269. },
  3270. "issue_number": { "required": true, "type": "integer" },
  3271. "number": {
  3272. "alias": "issue_number",
  3273. "deprecated": true,
  3274. "type": "integer"
  3275. },
  3276. "owner": { "required": true, "type": "string" },
  3277. "page": { "type": "integer" },
  3278. "per_page": { "type": "integer" },
  3279. "repo": { "required": true, "type": "string" }
  3280. },
  3281. "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
  3282. },
  3283. "listForIssueComment": {
  3284. "headers": {
  3285. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3286. },
  3287. "method": "GET",
  3288. "params": {
  3289. "comment_id": { "required": true, "type": "integer" },
  3290. "content": {
  3291. "enum": [
  3292. "+1",
  3293. "-1",
  3294. "laugh",
  3295. "confused",
  3296. "heart",
  3297. "hooray",
  3298. "rocket",
  3299. "eyes"
  3300. ],
  3301. "type": "string"
  3302. },
  3303. "owner": { "required": true, "type": "string" },
  3304. "page": { "type": "integer" },
  3305. "per_page": { "type": "integer" },
  3306. "repo": { "required": true, "type": "string" }
  3307. },
  3308. "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
  3309. },
  3310. "listForPullRequestReviewComment": {
  3311. "headers": {
  3312. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3313. },
  3314. "method": "GET",
  3315. "params": {
  3316. "comment_id": { "required": true, "type": "integer" },
  3317. "content": {
  3318. "enum": [
  3319. "+1",
  3320. "-1",
  3321. "laugh",
  3322. "confused",
  3323. "heart",
  3324. "hooray",
  3325. "rocket",
  3326. "eyes"
  3327. ],
  3328. "type": "string"
  3329. },
  3330. "owner": { "required": true, "type": "string" },
  3331. "page": { "type": "integer" },
  3332. "per_page": { "type": "integer" },
  3333. "repo": { "required": true, "type": "string" }
  3334. },
  3335. "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
  3336. },
  3337. "listForTeamDiscussion": {
  3338. "headers": {
  3339. "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  3340. },
  3341. "method": "GET",
  3342. "params": {
  3343. "content": {
  3344. "enum": [
  3345. "+1",
  3346. "-1",
  3347. "laugh",
  3348. "confused",
  3349. "heart",
  3350. "hooray",
  3351. "rocket",
  3352. "eyes"
  3353. ],
  3354. "type": "string"
  3355. },
  3356. "discussion_number": { "required": true, "type": "integer" },
  3357. "page": { "type": "integer" },
  3358. "per_page": { "type": "integer" },
  3359. "team_id": { "required": true, "type": "integer" }
  3360. },
  3361. "url": "/teams/:team_id/discussions/:discussion_number/reactions"
  3362. },
  3363. "listForTeamDiscussionComment": {
  3364. "headers": {
  3365. "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  3366. },
  3367. "method": "GET",
  3368. "params": {
  3369. "comment_number": { "required": true, "type": "integer" },
  3370. "content": {
  3371. "enum": [
  3372. "+1",
  3373. "-1",
  3374. "laugh",
  3375. "confused",
  3376. "heart",
  3377. "hooray",
  3378. "rocket",
  3379. "eyes"
  3380. ],
  3381. "type": "string"
  3382. },
  3383. "discussion_number": { "required": true, "type": "integer" },
  3384. "page": { "type": "integer" },
  3385. "per_page": { "type": "integer" },
  3386. "team_id": { "required": true, "type": "integer" }
  3387. },
  3388. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  3389. }
  3390. },
  3391. "repos": {
  3392. "acceptInvitation": {
  3393. "method": "PATCH",
  3394. "params": { "invitation_id": { "required": true, "type": "integer" } },
  3395. "url": "/user/repository_invitations/:invitation_id"
  3396. },
  3397. "addCollaborator": {
  3398. "method": "PUT",
  3399. "params": {
  3400. "owner": { "required": true, "type": "string" },
  3401. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  3402. "repo": { "required": true, "type": "string" },
  3403. "username": { "required": true, "type": "string" }
  3404. },
  3405. "url": "/repos/:owner/:repo/collaborators/:username"
  3406. },
  3407. "addDeployKey": {
  3408. "method": "POST",
  3409. "params": {
  3410. "key": { "required": true, "type": "string" },
  3411. "owner": { "required": true, "type": "string" },
  3412. "read_only": { "type": "boolean" },
  3413. "repo": { "required": true, "type": "string" },
  3414. "title": { "type": "string" }
  3415. },
  3416. "url": "/repos/:owner/:repo/keys"
  3417. },
  3418. "addProtectedBranchAdminEnforcement": {
  3419. "method": "POST",
  3420. "params": {
  3421. "branch": { "required": true, "type": "string" },
  3422. "owner": { "required": true, "type": "string" },
  3423. "repo": { "required": true, "type": "string" }
  3424. },
  3425. "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  3426. },
  3427. "addProtectedBranchRequiredSignatures": {
  3428. "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
  3429. "method": "POST",
  3430. "params": {
  3431. "branch": { "required": true, "type": "string" },
  3432. "owner": { "required": true, "type": "string" },
  3433. "repo": { "required": true, "type": "string" }
  3434. },
  3435. "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  3436. },
  3437. "addProtectedBranchRequiredStatusChecksContexts": {
  3438. "method": "POST",
  3439. "params": {
  3440. "branch": { "required": true, "type": "string" },
  3441. "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
  3442. "owner": { "required": true, "type": "string" },
  3443. "repo": { "required": true, "type": "string" }
  3444. },
  3445. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  3446. },
  3447. "addProtectedBranchTeamRestrictions": {
  3448. "method": "POST",
  3449. "params": {
  3450. "branch": { "required": true, "type": "string" },
  3451. "owner": { "required": true, "type": "string" },
  3452. "repo": { "required": true, "type": "string" },
  3453. "teams": { "mapTo": "data", "required": true, "type": "string[]" }
  3454. },
  3455. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  3456. },
  3457. "addProtectedBranchUserRestrictions": {
  3458. "method": "POST",
  3459. "params": {
  3460. "branch": { "required": true, "type": "string" },
  3461. "owner": { "required": true, "type": "string" },
  3462. "repo": { "required": true, "type": "string" },
  3463. "users": { "mapTo": "data", "required": true, "type": "string[]" }
  3464. },
  3465. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  3466. },
  3467. "checkCollaborator": {
  3468. "method": "GET",
  3469. "params": {
  3470. "owner": { "required": true, "type": "string" },
  3471. "repo": { "required": true, "type": "string" },
  3472. "username": { "required": true, "type": "string" }
  3473. },
  3474. "url": "/repos/:owner/:repo/collaborators/:username"
  3475. },
  3476. "compareCommits": {
  3477. "method": "GET",
  3478. "params": {
  3479. "base": { "required": true, "type": "string" },
  3480. "head": { "required": true, "type": "string" },
  3481. "owner": { "required": true, "type": "string" },
  3482. "repo": { "required": true, "type": "string" }
  3483. },
  3484. "url": "/repos/:owner/:repo/compare/:base...:head"
  3485. },
  3486. "createCommitComment": {
  3487. "method": "POST",
  3488. "params": {
  3489. "body": { "required": true, "type": "string" },
  3490. "commit_sha": { "required": true, "type": "string" },
  3491. "line": { "type": "integer" },
  3492. "owner": { "required": true, "type": "string" },
  3493. "path": { "type": "string" },
  3494. "position": { "type": "integer" },
  3495. "repo": { "required": true, "type": "string" },
  3496. "sha": { "alias": "commit_sha", "deprecated": true, "type": "string" }
  3497. },
  3498. "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
  3499. },
  3500. "createDeployment": {
  3501. "method": "POST",
  3502. "params": {
  3503. "auto_merge": { "type": "boolean" },
  3504. "description": { "type": "string" },
  3505. "environment": { "type": "string" },
  3506. "owner": { "required": true, "type": "string" },
  3507. "payload": { "type": "string" },
  3508. "production_environment": { "type": "boolean" },
  3509. "ref": { "required": true, "type": "string" },
  3510. "repo": { "required": true, "type": "string" },
  3511. "required_contexts": { "type": "string[]" },
  3512. "task": { "type": "string" },
  3513. "transient_environment": { "type": "boolean" }
  3514. },
  3515. "url": "/repos/:owner/:repo/deployments"
  3516. },
  3517. "createDeploymentStatus": {
  3518. "method": "POST",
  3519. "params": {
  3520. "auto_inactive": { "type": "boolean" },
  3521. "deployment_id": { "required": true, "type": "integer" },
  3522. "description": { "type": "string" },
  3523. "environment": {
  3524. "enum": ["production", "staging", "qa"],
  3525. "type": "string"
  3526. },
  3527. "environment_url": { "type": "string" },
  3528. "log_url": { "type": "string" },
  3529. "owner": { "required": true, "type": "string" },
  3530. "repo": { "required": true, "type": "string" },
  3531. "state": {
  3532. "enum": [
  3533. "error",
  3534. "failure",
  3535. "inactive",
  3536. "in_progress",
  3537. "queued",
  3538. "pending",
  3539. "success"
  3540. ],
  3541. "required": true,
  3542. "type": "string"
  3543. },
  3544. "target_url": { "type": "string" }
  3545. },
  3546. "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
  3547. },
  3548. "createFile": {
  3549. "deprecated": "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
  3550. "method": "PUT",
  3551. "params": {
  3552. "author": { "type": "object" },
  3553. "author.email": { "required": true, "type": "string" },
  3554. "author.name": { "required": true, "type": "string" },
  3555. "branch": { "type": "string" },
  3556. "committer": { "type": "object" },
  3557. "committer.email": { "required": true, "type": "string" },
  3558. "committer.name": { "required": true, "type": "string" },
  3559. "content": { "required": true, "type": "string" },
  3560. "message": { "required": true, "type": "string" },
  3561. "owner": { "required": true, "type": "string" },
  3562. "path": { "required": true, "type": "string" },
  3563. "repo": { "required": true, "type": "string" },
  3564. "sha": { "type": "string" }
  3565. },
  3566. "url": "/repos/:owner/:repo/contents/:path"
  3567. },
  3568. "createForAuthenticatedUser": {
  3569. "method": "POST",
  3570. "params": {
  3571. "allow_merge_commit": { "type": "boolean" },
  3572. "allow_rebase_merge": { "type": "boolean" },
  3573. "allow_squash_merge": { "type": "boolean" },
  3574. "auto_init": { "type": "boolean" },
  3575. "description": { "type": "string" },
  3576. "gitignore_template": { "type": "string" },
  3577. "has_issues": { "type": "boolean" },
  3578. "has_projects": { "type": "boolean" },
  3579. "has_wiki": { "type": "boolean" },
  3580. "homepage": { "type": "string" },
  3581. "license_template": { "type": "string" },
  3582. "name": { "required": true, "type": "string" },
  3583. "private": { "type": "boolean" },
  3584. "team_id": { "type": "integer" }
  3585. },
  3586. "url": "/user/repos"
  3587. },
  3588. "createFork": {
  3589. "method": "POST",
  3590. "params": {
  3591. "organization": { "type": "string" },
  3592. "owner": { "required": true, "type": "string" },
  3593. "repo": { "required": true, "type": "string" }
  3594. },
  3595. "url": "/repos/:owner/:repo/forks"
  3596. },
  3597. "createHook": {
  3598. "method": "POST",
  3599. "params": {
  3600. "active": { "type": "boolean" },
  3601. "config": { "required": true, "type": "object" },
  3602. "config.content_type": { "type": "string" },
  3603. "config.insecure_ssl": { "type": "string" },
  3604. "config.secret": { "type": "string" },
  3605. "config.url": { "required": true, "type": "string" },
  3606. "events": { "type": "string[]" },
  3607. "name": { "type": "string" },
  3608. "owner": { "required": true, "type": "string" },
  3609. "repo": { "required": true, "type": "string" }
  3610. },
  3611. "url": "/repos/:owner/:repo/hooks"
  3612. },
  3613. "createInOrg": {
  3614. "method": "POST",
  3615. "params": {
  3616. "allow_merge_commit": { "type": "boolean" },
  3617. "allow_rebase_merge": { "type": "boolean" },
  3618. "allow_squash_merge": { "type": "boolean" },
  3619. "auto_init": { "type": "boolean" },
  3620. "description": { "type": "string" },
  3621. "gitignore_template": { "type": "string" },
  3622. "has_issues": { "type": "boolean" },
  3623. "has_projects": { "type": "boolean" },
  3624. "has_wiki": { "type": "boolean" },
  3625. "homepage": { "type": "string" },
  3626. "license_template": { "type": "string" },
  3627. "name": { "required": true, "type": "string" },
  3628. "org": { "required": true, "type": "string" },
  3629. "private": { "type": "boolean" },
  3630. "team_id": { "type": "integer" }
  3631. },
  3632. "url": "/orgs/:org/repos"
  3633. },
  3634. "createOrUpdateFile": {
  3635. "method": "PUT",
  3636. "params": {
  3637. "author": { "type": "object" },
  3638. "author.email": { "required": true, "type": "string" },
  3639. "author.name": { "required": true, "type": "string" },
  3640. "branch": { "type": "string" },
  3641. "committer": { "type": "object" },
  3642. "committer.email": { "required": true, "type": "string" },
  3643. "committer.name": { "required": true, "type": "string" },
  3644. "content": { "required": true, "type": "string" },
  3645. "message": { "required": true, "type": "string" },
  3646. "owner": { "required": true, "type": "string" },
  3647. "path": { "required": true, "type": "string" },
  3648. "repo": { "required": true, "type": "string" },
  3649. "sha": { "type": "string" }
  3650. },
  3651. "url": "/repos/:owner/:repo/contents/:path"
  3652. },
  3653. "createRelease": {
  3654. "method": "POST",
  3655. "params": {
  3656. "body": { "type": "string" },
  3657. "draft": { "type": "boolean" },
  3658. "name": { "type": "string" },
  3659. "owner": { "required": true, "type": "string" },
  3660. "prerelease": { "type": "boolean" },
  3661. "repo": { "required": true, "type": "string" },
  3662. "tag_name": { "required": true, "type": "string" },
  3663. "target_commitish": { "type": "string" }
  3664. },
  3665. "url": "/repos/:owner/:repo/releases"
  3666. },
  3667. "createStatus": {
  3668. "method": "POST",
  3669. "params": {
  3670. "context": { "type": "string" },
  3671. "description": { "type": "string" },
  3672. "owner": { "required": true, "type": "string" },
  3673. "repo": { "required": true, "type": "string" },
  3674. "sha": { "required": true, "type": "string" },
  3675. "state": {
  3676. "enum": ["error", "failure", "pending", "success"],
  3677. "required": true,
  3678. "type": "string"
  3679. },
  3680. "target_url": { "type": "string" }
  3681. },
  3682. "url": "/repos/:owner/:repo/statuses/:sha"
  3683. },
  3684. "declineInvitation": {
  3685. "method": "DELETE",
  3686. "params": { "invitation_id": { "required": true, "type": "integer" } },
  3687. "url": "/user/repository_invitations/:invitation_id"
  3688. },
  3689. "delete": {
  3690. "method": "DELETE",
  3691. "params": {
  3692. "owner": { "required": true, "type": "string" },
  3693. "repo": { "required": true, "type": "string" }
  3694. },
  3695. "url": "/repos/:owner/:repo"
  3696. },
  3697. "deleteCommitComment": {
  3698. "method": "DELETE",
  3699. "params": {
  3700. "comment_id": { "required": true, "type": "integer" },
  3701. "owner": { "required": true, "type": "string" },
  3702. "repo": { "required": true, "type": "string" }
  3703. },
  3704. "url": "/repos/:owner/:repo/comments/:comment_id"
  3705. },
  3706. "deleteDownload": {
  3707. "method": "DELETE",
  3708. "params": {
  3709. "download_id": { "required": true, "type": "integer" },
  3710. "owner": { "required": true, "type": "string" },
  3711. "repo": { "required": true, "type": "string" }
  3712. },
  3713. "url": "/repos/:owner/:repo/downloads/:download_id"
  3714. },
  3715. "deleteFile": {
  3716. "method": "DELETE",
  3717. "params": {
  3718. "author": { "type": "object" },
  3719. "author.email": { "type": "string" },
  3720. "author.name": { "type": "string" },
  3721. "branch": { "type": "string" },
  3722. "committer": { "type": "object" },
  3723. "committer.email": { "type": "string" },
  3724. "committer.name": { "type": "string" },
  3725. "message": { "required": true, "type": "string" },
  3726. "owner": { "required": true, "type": "string" },
  3727. "path": { "required": true, "type": "string" },
  3728. "repo": { "required": true, "type": "string" },
  3729. "sha": { "required": true, "type": "string" }
  3730. },
  3731. "url": "/repos/:owner/:repo/contents/:path"
  3732. },
  3733. "deleteHook": {
  3734. "method": "DELETE",
  3735. "params": {
  3736. "hook_id": { "required": true, "type": "integer" },
  3737. "owner": { "required": true, "type": "string" },
  3738. "repo": { "required": true, "type": "string" }
  3739. },
  3740. "url": "/repos/:owner/:repo/hooks/:hook_id"
  3741. },
  3742. "deleteInvitation": {
  3743. "method": "DELETE",
  3744. "params": {
  3745. "invitation_id": { "required": true, "type": "integer" },
  3746. "owner": { "required": true, "type": "string" },
  3747. "repo": { "required": true, "type": "string" }
  3748. },
  3749. "url": "/repos/:owner/:repo/invitations/:invitation_id"
  3750. },
  3751. "deleteRelease": {
  3752. "method": "DELETE",
  3753. "params": {
  3754. "owner": { "required": true, "type": "string" },
  3755. "release_id": { "required": true, "type": "integer" },
  3756. "repo": { "required": true, "type": "string" }
  3757. },
  3758. "url": "/repos/:owner/:repo/releases/:release_id"
  3759. },
  3760. "deleteReleaseAsset": {
  3761. "method": "DELETE",
  3762. "params": {
  3763. "asset_id": { "required": true, "type": "integer" },
  3764. "owner": { "required": true, "type": "string" },
  3765. "repo": { "required": true, "type": "string" }
  3766. },
  3767. "url": "/repos/:owner/:repo/releases/assets/:asset_id"
  3768. },
  3769. "get": {
  3770. "method": "GET",
  3771. "params": {
  3772. "owner": { "required": true, "type": "string" },
  3773. "repo": { "required": true, "type": "string" }
  3774. },
  3775. "url": "/repos/:owner/:repo"
  3776. },
  3777. "getArchiveLink": {
  3778. "method": "GET",
  3779. "params": {
  3780. "archive_format": { "required": true, "type": "string" },
  3781. "owner": { "required": true, "type": "string" },
  3782. "ref": { "required": true, "type": "string" },
  3783. "repo": { "required": true, "type": "string" }
  3784. },
  3785. "url": "/repos/:owner/:repo/:archive_format/:ref"
  3786. },
  3787. "getBranch": {
  3788. "method": "GET",
  3789. "params": {
  3790. "branch": { "required": true, "type": "string" },
  3791. "owner": { "required": true, "type": "string" },
  3792. "repo": { "required": true, "type": "string" }
  3793. },
  3794. "url": "/repos/:owner/:repo/branches/:branch"
  3795. },
  3796. "getBranchProtection": {
  3797. "method": "GET",
  3798. "params": {
  3799. "branch": { "required": true, "type": "string" },
  3800. "owner": { "required": true, "type": "string" },
  3801. "repo": { "required": true, "type": "string" }
  3802. },
  3803. "url": "/repos/:owner/:repo/branches/:branch/protection"
  3804. },
  3805. "getCodeFrequencyStats": {
  3806. "method": "GET",
  3807. "params": {
  3808. "owner": { "required": true, "type": "string" },
  3809. "repo": { "required": true, "type": "string" }
  3810. },
  3811. "url": "/repos/:owner/:repo/stats/code_frequency"
  3812. },
  3813. "getCollaboratorPermissionLevel": {
  3814. "method": "GET",
  3815. "params": {
  3816. "owner": { "required": true, "type": "string" },
  3817. "repo": { "required": true, "type": "string" },
  3818. "username": { "required": true, "type": "string" }
  3819. },
  3820. "url": "/repos/:owner/:repo/collaborators/:username/permission"
  3821. },
  3822. "getCombinedStatusForRef": {
  3823. "method": "GET",
  3824. "params": {
  3825. "owner": { "required": true, "type": "string" },
  3826. "ref": { "required": true, "type": "string" },
  3827. "repo": { "required": true, "type": "string" }
  3828. },
  3829. "url": "/repos/:owner/:repo/commits/:ref/status"
  3830. },
  3831. "getCommit": {
  3832. "method": "GET",
  3833. "params": {
  3834. "commit_sha": { "alias": "ref", "deprecated": true, "type": "string" },
  3835. "owner": { "required": true, "type": "string" },
  3836. "ref": { "required": true, "type": "string" },
  3837. "repo": { "required": true, "type": "string" },
  3838. "sha": { "alias": "ref", "deprecated": true, "type": "string" }
  3839. },
  3840. "url": "/repos/:owner/:repo/commits/:ref"
  3841. },
  3842. "getCommitActivityStats": {
  3843. "method": "GET",
  3844. "params": {
  3845. "owner": { "required": true, "type": "string" },
  3846. "repo": { "required": true, "type": "string" }
  3847. },
  3848. "url": "/repos/:owner/:repo/stats/commit_activity"
  3849. },
  3850. "getCommitComment": {
  3851. "method": "GET",
  3852. "params": {
  3853. "comment_id": { "required": true, "type": "integer" },
  3854. "owner": { "required": true, "type": "string" },
  3855. "repo": { "required": true, "type": "string" }
  3856. },
  3857. "url": "/repos/:owner/:repo/comments/:comment_id"
  3858. },
  3859. "getCommitRefSha": {
  3860. "deprecated": "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit",
  3861. "headers": { "accept": "application/vnd.github.v3.sha" },
  3862. "method": "GET",
  3863. "params": {
  3864. "owner": { "required": true, "type": "string" },
  3865. "ref": { "required": true, "type": "string" },
  3866. "repo": { "required": true, "type": "string" }
  3867. },
  3868. "url": "/repos/:owner/:repo/commits/:ref"
  3869. },
  3870. "getContents": {
  3871. "method": "GET",
  3872. "params": {
  3873. "owner": { "required": true, "type": "string" },
  3874. "path": { "required": true, "type": "string" },
  3875. "ref": { "type": "string" },
  3876. "repo": { "required": true, "type": "string" }
  3877. },
  3878. "url": "/repos/:owner/:repo/contents/:path"
  3879. },
  3880. "getContributorsStats": {
  3881. "method": "GET",
  3882. "params": {
  3883. "owner": { "required": true, "type": "string" },
  3884. "repo": { "required": true, "type": "string" }
  3885. },
  3886. "url": "/repos/:owner/:repo/stats/contributors"
  3887. },
  3888. "getDeployKey": {
  3889. "method": "GET",
  3890. "params": {
  3891. "key_id": { "required": true, "type": "integer" },
  3892. "owner": { "required": true, "type": "string" },
  3893. "repo": { "required": true, "type": "string" }
  3894. },
  3895. "url": "/repos/:owner/:repo/keys/:key_id"
  3896. },
  3897. "getDeployment": {
  3898. "method": "GET",
  3899. "params": {
  3900. "deployment_id": { "required": true, "type": "integer" },
  3901. "owner": { "required": true, "type": "string" },
  3902. "repo": { "required": true, "type": "string" }
  3903. },
  3904. "url": "/repos/:owner/:repo/deployments/:deployment_id"
  3905. },
  3906. "getDeploymentStatus": {
  3907. "method": "GET",
  3908. "params": {
  3909. "deployment_id": { "required": true, "type": "integer" },
  3910. "owner": { "required": true, "type": "string" },
  3911. "repo": { "required": true, "type": "string" },
  3912. "status_id": { "required": true, "type": "integer" }
  3913. },
  3914. "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"
  3915. },
  3916. "getDownload": {
  3917. "method": "GET",
  3918. "params": {
  3919. "download_id": { "required": true, "type": "integer" },
  3920. "owner": { "required": true, "type": "string" },
  3921. "repo": { "required": true, "type": "string" }
  3922. },
  3923. "url": "/repos/:owner/:repo/downloads/:download_id"
  3924. },
  3925. "getHook": {
  3926. "method": "GET",
  3927. "params": {
  3928. "hook_id": { "required": true, "type": "integer" },
  3929. "owner": { "required": true, "type": "string" },
  3930. "repo": { "required": true, "type": "string" }
  3931. },
  3932. "url": "/repos/:owner/:repo/hooks/:hook_id"
  3933. },
  3934. "getLatestPagesBuild": {
  3935. "method": "GET",
  3936. "params": {
  3937. "owner": { "required": true, "type": "string" },
  3938. "repo": { "required": true, "type": "string" }
  3939. },
  3940. "url": "/repos/:owner/:repo/pages/builds/latest"
  3941. },
  3942. "getLatestRelease": {
  3943. "method": "GET",
  3944. "params": {
  3945. "owner": { "required": true, "type": "string" },
  3946. "repo": { "required": true, "type": "string" }
  3947. },
  3948. "url": "/repos/:owner/:repo/releases/latest"
  3949. },
  3950. "getPages": {
  3951. "method": "GET",
  3952. "params": {
  3953. "owner": { "required": true, "type": "string" },
  3954. "repo": { "required": true, "type": "string" }
  3955. },
  3956. "url": "/repos/:owner/:repo/pages"
  3957. },
  3958. "getPagesBuild": {
  3959. "method": "GET",
  3960. "params": {
  3961. "build_id": { "required": true, "type": "integer" },
  3962. "owner": { "required": true, "type": "string" },
  3963. "repo": { "required": true, "type": "string" }
  3964. },
  3965. "url": "/repos/:owner/:repo/pages/builds/:build_id"
  3966. },
  3967. "getParticipationStats": {
  3968. "method": "GET",
  3969. "params": {
  3970. "owner": { "required": true, "type": "string" },
  3971. "repo": { "required": true, "type": "string" }
  3972. },
  3973. "url": "/repos/:owner/:repo/stats/participation"
  3974. },
  3975. "getProtectedBranchAdminEnforcement": {
  3976. "method": "GET",
  3977. "params": {
  3978. "branch": { "required": true, "type": "string" },
  3979. "owner": { "required": true, "type": "string" },
  3980. "repo": { "required": true, "type": "string" }
  3981. },
  3982. "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  3983. },
  3984. "getProtectedBranchPullRequestReviewEnforcement": {
  3985. "method": "GET",
  3986. "params": {
  3987. "branch": { "required": true, "type": "string" },
  3988. "owner": { "required": true, "type": "string" },
  3989. "repo": { "required": true, "type": "string" }
  3990. },
  3991. "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  3992. },
  3993. "getProtectedBranchRequiredSignatures": {
  3994. "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
  3995. "method": "GET",
  3996. "params": {
  3997. "branch": { "required": true, "type": "string" },
  3998. "owner": { "required": true, "type": "string" },
  3999. "repo": { "required": true, "type": "string" }
  4000. },
  4001. "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  4002. },
  4003. "getProtectedBranchRequiredStatusChecks": {
  4004. "method": "GET",
  4005. "params": {
  4006. "branch": { "required": true, "type": "string" },
  4007. "owner": { "required": true, "type": "string" },
  4008. "repo": { "required": true, "type": "string" }
  4009. },
  4010. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  4011. },
  4012. "getProtectedBranchRestrictions": {
  4013. "method": "GET",
  4014. "params": {
  4015. "branch": { "required": true, "type": "string" },
  4016. "owner": { "required": true, "type": "string" },
  4017. "repo": { "required": true, "type": "string" }
  4018. },
  4019. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
  4020. },
  4021. "getPunchCardStats": {
  4022. "method": "GET",
  4023. "params": {
  4024. "owner": { "required": true, "type": "string" },
  4025. "repo": { "required": true, "type": "string" }
  4026. },
  4027. "url": "/repos/:owner/:repo/stats/punch_card"
  4028. },
  4029. "getReadme": {
  4030. "method": "GET",
  4031. "params": {
  4032. "owner": { "required": true, "type": "string" },
  4033. "ref": { "type": "string" },
  4034. "repo": { "required": true, "type": "string" }
  4035. },
  4036. "url": "/repos/:owner/:repo/readme"
  4037. },
  4038. "getRelease": {
  4039. "method": "GET",
  4040. "params": {
  4041. "owner": { "required": true, "type": "string" },
  4042. "release_id": { "required": true, "type": "integer" },
  4043. "repo": { "required": true, "type": "string" }
  4044. },
  4045. "url": "/repos/:owner/:repo/releases/:release_id"
  4046. },
  4047. "getReleaseAsset": {
  4048. "method": "GET",
  4049. "params": {
  4050. "asset_id": { "required": true, "type": "integer" },
  4051. "owner": { "required": true, "type": "string" },
  4052. "repo": { "required": true, "type": "string" }
  4053. },
  4054. "url": "/repos/:owner/:repo/releases/assets/:asset_id"
  4055. },
  4056. "getReleaseByTag": {
  4057. "method": "GET",
  4058. "params": {
  4059. "owner": { "required": true, "type": "string" },
  4060. "repo": { "required": true, "type": "string" },
  4061. "tag": { "required": true, "type": "string" }
  4062. },
  4063. "url": "/repos/:owner/:repo/releases/tags/:tag"
  4064. },
  4065. "getTeamsWithAccessToProtectedBranch": {
  4066. "method": "GET",
  4067. "params": {
  4068. "branch": { "required": true, "type": "string" },
  4069. "owner": { "required": true, "type": "string" },
  4070. "repo": { "required": true, "type": "string" }
  4071. },
  4072. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4073. },
  4074. "getUsersWithAccessToProtectedBranch": {
  4075. "method": "GET",
  4076. "params": {
  4077. "branch": { "required": true, "type": "string" },
  4078. "owner": { "required": true, "type": "string" },
  4079. "repo": { "required": true, "type": "string" }
  4080. },
  4081. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4082. },
  4083. "list": {
  4084. "method": "GET",
  4085. "params": {
  4086. "affiliation": { "type": "string" },
  4087. "direction": { "enum": ["asc", "desc"], "type": "string" },
  4088. "page": { "type": "integer" },
  4089. "per_page": { "type": "integer" },
  4090. "sort": {
  4091. "enum": ["created", "updated", "pushed", "full_name"],
  4092. "type": "string"
  4093. },
  4094. "type": {
  4095. "enum": ["all", "owner", "public", "private", "member"],
  4096. "type": "string"
  4097. },
  4098. "visibility": { "enum": ["all", "public", "private"], "type": "string" }
  4099. },
  4100. "url": "/user/repos"
  4101. },
  4102. "listAssetsForRelease": {
  4103. "method": "GET",
  4104. "params": {
  4105. "owner": { "required": true, "type": "string" },
  4106. "page": { "type": "integer" },
  4107. "per_page": { "type": "integer" },
  4108. "release_id": { "required": true, "type": "integer" },
  4109. "repo": { "required": true, "type": "string" }
  4110. },
  4111. "url": "/repos/:owner/:repo/releases/:release_id/assets"
  4112. },
  4113. "listBranches": {
  4114. "method": "GET",
  4115. "params": {
  4116. "owner": { "required": true, "type": "string" },
  4117. "page": { "type": "integer" },
  4118. "per_page": { "type": "integer" },
  4119. "protected": { "type": "boolean" },
  4120. "repo": { "required": true, "type": "string" }
  4121. },
  4122. "url": "/repos/:owner/:repo/branches"
  4123. },
  4124. "listCollaborators": {
  4125. "method": "GET",
  4126. "params": {
  4127. "affiliation": {
  4128. "enum": ["outside", "direct", "all"],
  4129. "type": "string"
  4130. },
  4131. "owner": { "required": true, "type": "string" },
  4132. "page": { "type": "integer" },
  4133. "per_page": { "type": "integer" },
  4134. "repo": { "required": true, "type": "string" }
  4135. },
  4136. "url": "/repos/:owner/:repo/collaborators"
  4137. },
  4138. "listCommentsForCommit": {
  4139. "method": "GET",
  4140. "params": {
  4141. "commit_sha": { "required": true, "type": "string" },
  4142. "owner": { "required": true, "type": "string" },
  4143. "page": { "type": "integer" },
  4144. "per_page": { "type": "integer" },
  4145. "ref": { "alias": "commit_sha", "deprecated": true, "type": "string" },
  4146. "repo": { "required": true, "type": "string" }
  4147. },
  4148. "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
  4149. },
  4150. "listCommitComments": {
  4151. "method": "GET",
  4152. "params": {
  4153. "owner": { "required": true, "type": "string" },
  4154. "page": { "type": "integer" },
  4155. "per_page": { "type": "integer" },
  4156. "repo": { "required": true, "type": "string" }
  4157. },
  4158. "url": "/repos/:owner/:repo/comments"
  4159. },
  4160. "listCommits": {
  4161. "method": "GET",
  4162. "params": {
  4163. "author": { "type": "string" },
  4164. "owner": { "required": true, "type": "string" },
  4165. "page": { "type": "integer" },
  4166. "path": { "type": "string" },
  4167. "per_page": { "type": "integer" },
  4168. "repo": { "required": true, "type": "string" },
  4169. "sha": { "type": "string" },
  4170. "since": { "type": "string" },
  4171. "until": { "type": "string" }
  4172. },
  4173. "url": "/repos/:owner/:repo/commits"
  4174. },
  4175. "listContributors": {
  4176. "method": "GET",
  4177. "params": {
  4178. "anon": { "type": "string" },
  4179. "owner": { "required": true, "type": "string" },
  4180. "page": { "type": "integer" },
  4181. "per_page": { "type": "integer" },
  4182. "repo": { "required": true, "type": "string" }
  4183. },
  4184. "url": "/repos/:owner/:repo/contributors"
  4185. },
  4186. "listDeployKeys": {
  4187. "method": "GET",
  4188. "params": {
  4189. "owner": { "required": true, "type": "string" },
  4190. "page": { "type": "integer" },
  4191. "per_page": { "type": "integer" },
  4192. "repo": { "required": true, "type": "string" }
  4193. },
  4194. "url": "/repos/:owner/:repo/keys"
  4195. },
  4196. "listDeploymentStatuses": {
  4197. "method": "GET",
  4198. "params": {
  4199. "deployment_id": { "required": true, "type": "integer" },
  4200. "owner": { "required": true, "type": "string" },
  4201. "page": { "type": "integer" },
  4202. "per_page": { "type": "integer" },
  4203. "repo": { "required": true, "type": "string" }
  4204. },
  4205. "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
  4206. },
  4207. "listDeployments": {
  4208. "method": "GET",
  4209. "params": {
  4210. "environment": { "type": "string" },
  4211. "owner": { "required": true, "type": "string" },
  4212. "page": { "type": "integer" },
  4213. "per_page": { "type": "integer" },
  4214. "ref": { "type": "string" },
  4215. "repo": { "required": true, "type": "string" },
  4216. "sha": { "type": "string" },
  4217. "task": { "type": "string" }
  4218. },
  4219. "url": "/repos/:owner/:repo/deployments"
  4220. },
  4221. "listDownloads": {
  4222. "method": "GET",
  4223. "params": {
  4224. "owner": { "required": true, "type": "string" },
  4225. "page": { "type": "integer" },
  4226. "per_page": { "type": "integer" },
  4227. "repo": { "required": true, "type": "string" }
  4228. },
  4229. "url": "/repos/:owner/:repo/downloads"
  4230. },
  4231. "listForOrg": {
  4232. "method": "GET",
  4233. "params": {
  4234. "org": { "required": true, "type": "string" },
  4235. "page": { "type": "integer" },
  4236. "per_page": { "type": "integer" },
  4237. "type": {
  4238. "enum": ["all", "public", "private", "forks", "sources", "member"],
  4239. "type": "string"
  4240. }
  4241. },
  4242. "url": "/orgs/:org/repos"
  4243. },
  4244. "listForUser": {
  4245. "method": "GET",
  4246. "params": {
  4247. "direction": { "enum": ["asc", "desc"], "type": "string" },
  4248. "page": { "type": "integer" },
  4249. "per_page": { "type": "integer" },
  4250. "sort": {
  4251. "enum": ["created", "updated", "pushed", "full_name"],
  4252. "type": "string"
  4253. },
  4254. "type": { "enum": ["all", "owner", "member"], "type": "string" },
  4255. "username": { "required": true, "type": "string" }
  4256. },
  4257. "url": "/users/:username/repos"
  4258. },
  4259. "listForks": {
  4260. "method": "GET",
  4261. "params": {
  4262. "owner": { "required": true, "type": "string" },
  4263. "page": { "type": "integer" },
  4264. "per_page": { "type": "integer" },
  4265. "repo": { "required": true, "type": "string" },
  4266. "sort": { "enum": ["newest", "oldest", "stargazers"], "type": "string" }
  4267. },
  4268. "url": "/repos/:owner/:repo/forks"
  4269. },
  4270. "listHooks": {
  4271. "method": "GET",
  4272. "params": {
  4273. "owner": { "required": true, "type": "string" },
  4274. "page": { "type": "integer" },
  4275. "per_page": { "type": "integer" },
  4276. "repo": { "required": true, "type": "string" }
  4277. },
  4278. "url": "/repos/:owner/:repo/hooks"
  4279. },
  4280. "listInvitations": {
  4281. "method": "GET",
  4282. "params": {
  4283. "owner": { "required": true, "type": "string" },
  4284. "page": { "type": "integer" },
  4285. "per_page": { "type": "integer" },
  4286. "repo": { "required": true, "type": "string" }
  4287. },
  4288. "url": "/repos/:owner/:repo/invitations"
  4289. },
  4290. "listInvitationsForAuthenticatedUser": {
  4291. "method": "GET",
  4292. "params": {
  4293. "page": { "type": "integer" },
  4294. "per_page": { "type": "integer" }
  4295. },
  4296. "url": "/user/repository_invitations"
  4297. },
  4298. "listLanguages": {
  4299. "method": "GET",
  4300. "params": {
  4301. "owner": { "required": true, "type": "string" },
  4302. "repo": { "required": true, "type": "string" }
  4303. },
  4304. "url": "/repos/:owner/:repo/languages"
  4305. },
  4306. "listPagesBuilds": {
  4307. "method": "GET",
  4308. "params": {
  4309. "owner": { "required": true, "type": "string" },
  4310. "page": { "type": "integer" },
  4311. "per_page": { "type": "integer" },
  4312. "repo": { "required": true, "type": "string" }
  4313. },
  4314. "url": "/repos/:owner/:repo/pages/builds"
  4315. },
  4316. "listProtectedBranchRequiredStatusChecksContexts": {
  4317. "method": "GET",
  4318. "params": {
  4319. "branch": { "required": true, "type": "string" },
  4320. "owner": { "required": true, "type": "string" },
  4321. "repo": { "required": true, "type": "string" }
  4322. },
  4323. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  4324. },
  4325. "listProtectedBranchTeamRestrictions": {
  4326. "deprecated": "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)",
  4327. "method": "GET",
  4328. "params": {
  4329. "branch": { "required": true, "type": "string" },
  4330. "owner": { "required": true, "type": "string" },
  4331. "repo": { "required": true, "type": "string" }
  4332. },
  4333. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4334. },
  4335. "listProtectedBranchUserRestrictions": {
  4336. "deprecated": "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)",
  4337. "method": "GET",
  4338. "params": {
  4339. "branch": { "required": true, "type": "string" },
  4340. "owner": { "required": true, "type": "string" },
  4341. "repo": { "required": true, "type": "string" }
  4342. },
  4343. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4344. },
  4345. "listPublic": {
  4346. "method": "GET",
  4347. "params": {
  4348. "page": { "type": "integer" },
  4349. "per_page": { "type": "integer" },
  4350. "since": { "type": "string" },
  4351. "visibility": { "type": "string" }
  4352. },
  4353. "url": "/repositories"
  4354. },
  4355. "listReleases": {
  4356. "method": "GET",
  4357. "params": {
  4358. "owner": { "required": true, "type": "string" },
  4359. "page": { "type": "integer" },
  4360. "per_page": { "type": "integer" },
  4361. "repo": { "required": true, "type": "string" }
  4362. },
  4363. "url": "/repos/:owner/:repo/releases"
  4364. },
  4365. "listStatusesForRef": {
  4366. "method": "GET",
  4367. "params": {
  4368. "owner": { "required": true, "type": "string" },
  4369. "page": { "type": "integer" },
  4370. "per_page": { "type": "integer" },
  4371. "ref": { "required": true, "type": "string" },
  4372. "repo": { "required": true, "type": "string" }
  4373. },
  4374. "url": "/repos/:owner/:repo/commits/:ref/statuses"
  4375. },
  4376. "listTags": {
  4377. "method": "GET",
  4378. "params": {
  4379. "owner": { "required": true, "type": "string" },
  4380. "page": { "type": "integer" },
  4381. "per_page": { "type": "integer" },
  4382. "repo": { "required": true, "type": "string" }
  4383. },
  4384. "url": "/repos/:owner/:repo/tags"
  4385. },
  4386. "listTeams": {
  4387. "method": "GET",
  4388. "params": {
  4389. "owner": { "required": true, "type": "string" },
  4390. "page": { "type": "integer" },
  4391. "per_page": { "type": "integer" },
  4392. "repo": { "required": true, "type": "string" }
  4393. },
  4394. "url": "/repos/:owner/:repo/teams"
  4395. },
  4396. "listTeamsWithAccessToProtectedBranch": {
  4397. "deprecated": "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)",
  4398. "method": "GET",
  4399. "params": {
  4400. "branch": { "required": true, "type": "string" },
  4401. "owner": { "required": true, "type": "string" },
  4402. "repo": { "required": true, "type": "string" }
  4403. },
  4404. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4405. },
  4406. "listTopics": {
  4407. "headers": { "accept": "application/vnd.github.mercy-preview+json" },
  4408. "method": "GET",
  4409. "params": {
  4410. "owner": { "required": true, "type": "string" },
  4411. "repo": { "required": true, "type": "string" }
  4412. },
  4413. "url": "/repos/:owner/:repo/topics"
  4414. },
  4415. "listUsersWithAccessToProtectedBranch": {
  4416. "deprecated": "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)",
  4417. "method": "GET",
  4418. "params": {
  4419. "branch": { "required": true, "type": "string" },
  4420. "owner": { "required": true, "type": "string" },
  4421. "repo": { "required": true, "type": "string" }
  4422. },
  4423. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4424. },
  4425. "merge": {
  4426. "method": "POST",
  4427. "params": {
  4428. "base": { "required": true, "type": "string" },
  4429. "commit_message": { "type": "string" },
  4430. "head": { "required": true, "type": "string" },
  4431. "owner": { "required": true, "type": "string" },
  4432. "repo": { "required": true, "type": "string" }
  4433. },
  4434. "url": "/repos/:owner/:repo/merges"
  4435. },
  4436. "pingHook": {
  4437. "method": "POST",
  4438. "params": {
  4439. "hook_id": { "required": true, "type": "integer" },
  4440. "owner": { "required": true, "type": "string" },
  4441. "repo": { "required": true, "type": "string" }
  4442. },
  4443. "url": "/repos/:owner/:repo/hooks/:hook_id/pings"
  4444. },
  4445. "removeBranchProtection": {
  4446. "method": "DELETE",
  4447. "params": {
  4448. "branch": { "required": true, "type": "string" },
  4449. "owner": { "required": true, "type": "string" },
  4450. "repo": { "required": true, "type": "string" }
  4451. },
  4452. "url": "/repos/:owner/:repo/branches/:branch/protection"
  4453. },
  4454. "removeCollaborator": {
  4455. "method": "DELETE",
  4456. "params": {
  4457. "owner": { "required": true, "type": "string" },
  4458. "repo": { "required": true, "type": "string" },
  4459. "username": { "required": true, "type": "string" }
  4460. },
  4461. "url": "/repos/:owner/:repo/collaborators/:username"
  4462. },
  4463. "removeDeployKey": {
  4464. "method": "DELETE",
  4465. "params": {
  4466. "key_id": { "required": true, "type": "integer" },
  4467. "owner": { "required": true, "type": "string" },
  4468. "repo": { "required": true, "type": "string" }
  4469. },
  4470. "url": "/repos/:owner/:repo/keys/:key_id"
  4471. },
  4472. "removeProtectedBranchAdminEnforcement": {
  4473. "method": "DELETE",
  4474. "params": {
  4475. "branch": { "required": true, "type": "string" },
  4476. "owner": { "required": true, "type": "string" },
  4477. "repo": { "required": true, "type": "string" }
  4478. },
  4479. "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  4480. },
  4481. "removeProtectedBranchPullRequestReviewEnforcement": {
  4482. "method": "DELETE",
  4483. "params": {
  4484. "branch": { "required": true, "type": "string" },
  4485. "owner": { "required": true, "type": "string" },
  4486. "repo": { "required": true, "type": "string" }
  4487. },
  4488. "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  4489. },
  4490. "removeProtectedBranchRequiredSignatures": {
  4491. "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
  4492. "method": "DELETE",
  4493. "params": {
  4494. "branch": { "required": true, "type": "string" },
  4495. "owner": { "required": true, "type": "string" },
  4496. "repo": { "required": true, "type": "string" }
  4497. },
  4498. "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  4499. },
  4500. "removeProtectedBranchRequiredStatusChecks": {
  4501. "method": "DELETE",
  4502. "params": {
  4503. "branch": { "required": true, "type": "string" },
  4504. "owner": { "required": true, "type": "string" },
  4505. "repo": { "required": true, "type": "string" }
  4506. },
  4507. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  4508. },
  4509. "removeProtectedBranchRequiredStatusChecksContexts": {
  4510. "method": "DELETE",
  4511. "params": {
  4512. "branch": { "required": true, "type": "string" },
  4513. "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
  4514. "owner": { "required": true, "type": "string" },
  4515. "repo": { "required": true, "type": "string" }
  4516. },
  4517. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  4518. },
  4519. "removeProtectedBranchRestrictions": {
  4520. "method": "DELETE",
  4521. "params": {
  4522. "branch": { "required": true, "type": "string" },
  4523. "owner": { "required": true, "type": "string" },
  4524. "repo": { "required": true, "type": "string" }
  4525. },
  4526. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
  4527. },
  4528. "removeProtectedBranchTeamRestrictions": {
  4529. "method": "DELETE",
  4530. "params": {
  4531. "branch": { "required": true, "type": "string" },
  4532. "owner": { "required": true, "type": "string" },
  4533. "repo": { "required": true, "type": "string" },
  4534. "teams": { "mapTo": "data", "required": true, "type": "string[]" }
  4535. },
  4536. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4537. },
  4538. "removeProtectedBranchUserRestrictions": {
  4539. "method": "DELETE",
  4540. "params": {
  4541. "branch": { "required": true, "type": "string" },
  4542. "owner": { "required": true, "type": "string" },
  4543. "repo": { "required": true, "type": "string" },
  4544. "users": { "mapTo": "data", "required": true, "type": "string[]" }
  4545. },
  4546. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4547. },
  4548. "replaceProtectedBranchRequiredStatusChecksContexts": {
  4549. "method": "PUT",
  4550. "params": {
  4551. "branch": { "required": true, "type": "string" },
  4552. "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
  4553. "owner": { "required": true, "type": "string" },
  4554. "repo": { "required": true, "type": "string" }
  4555. },
  4556. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  4557. },
  4558. "replaceProtectedBranchTeamRestrictions": {
  4559. "method": "PUT",
  4560. "params": {
  4561. "branch": { "required": true, "type": "string" },
  4562. "owner": { "required": true, "type": "string" },
  4563. "repo": { "required": true, "type": "string" },
  4564. "teams": { "mapTo": "data", "required": true, "type": "string[]" }
  4565. },
  4566. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4567. },
  4568. "replaceProtectedBranchUserRestrictions": {
  4569. "method": "PUT",
  4570. "params": {
  4571. "branch": { "required": true, "type": "string" },
  4572. "owner": { "required": true, "type": "string" },
  4573. "repo": { "required": true, "type": "string" },
  4574. "users": { "mapTo": "data", "required": true, "type": "string[]" }
  4575. },
  4576. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4577. },
  4578. "replaceTopics": {
  4579. "headers": { "accept": "application/vnd.github.mercy-preview+json" },
  4580. "method": "PUT",
  4581. "params": {
  4582. "names": { "required": true, "type": "string[]" },
  4583. "owner": { "required": true, "type": "string" },
  4584. "repo": { "required": true, "type": "string" }
  4585. },
  4586. "url": "/repos/:owner/:repo/topics"
  4587. },
  4588. "requestPageBuild": {
  4589. "headers": {
  4590. "accept": "application/vnd.github.mister-fantastic-preview+json"
  4591. },
  4592. "method": "POST",
  4593. "params": {
  4594. "owner": { "required": true, "type": "string" },
  4595. "repo": { "required": true, "type": "string" }
  4596. },
  4597. "url": "/repos/:owner/:repo/pages/builds"
  4598. },
  4599. "testPushHook": {
  4600. "method": "POST",
  4601. "params": {
  4602. "hook_id": { "required": true, "type": "integer" },
  4603. "owner": { "required": true, "type": "string" },
  4604. "repo": { "required": true, "type": "string" }
  4605. },
  4606. "url": "/repos/:owner/:repo/hooks/:hook_id/tests"
  4607. },
  4608. "transfer": {
  4609. "headers": { "accept": "application/vnd.github.nightshade-preview+json" },
  4610. "method": "POST",
  4611. "params": {
  4612. "new_owner": { "type": "string" },
  4613. "owner": { "required": true, "type": "string" },
  4614. "repo": { "required": true, "type": "string" },
  4615. "team_ids": { "type": "integer[]" }
  4616. },
  4617. "url": "/repos/:owner/:repo/transfer"
  4618. },
  4619. "update": {
  4620. "headers": { "accept": "application/vnd.github.x-ray-preview+json" },
  4621. "method": "PATCH",
  4622. "params": {
  4623. "allow_merge_commit": { "type": "boolean" },
  4624. "allow_rebase_merge": { "type": "boolean" },
  4625. "allow_squash_merge": { "type": "boolean" },
  4626. "anonymous_access_enabled": { "type": "boolean" },
  4627. "archived": { "type": "boolean" },
  4628. "default_branch": { "type": "string" },
  4629. "description": { "type": "string" },
  4630. "has_issues": { "type": "boolean" },
  4631. "has_projects": { "type": "boolean" },
  4632. "has_wiki": { "type": "boolean" },
  4633. "homepage": { "type": "string" },
  4634. "name": { "required": true, "type": "string" },
  4635. "owner": { "required": true, "type": "string" },
  4636. "private": { "type": "boolean" },
  4637. "repo": { "required": true, "type": "string" }
  4638. },
  4639. "url": "/repos/:owner/:repo"
  4640. },
  4641. "updateBranchProtection": {
  4642. "method": "PUT",
  4643. "params": {
  4644. "branch": { "required": true, "type": "string" },
  4645. "enforce_admins": {
  4646. "allowNull": true,
  4647. "required": true,
  4648. "type": "boolean"
  4649. },
  4650. "owner": { "required": true, "type": "string" },
  4651. "repo": { "required": true, "type": "string" },
  4652. "required_pull_request_reviews": {
  4653. "allowNull": true,
  4654. "required": true,
  4655. "type": "object"
  4656. },
  4657. "required_pull_request_reviews.dismiss_stale_reviews": {
  4658. "type": "boolean"
  4659. },
  4660. "required_pull_request_reviews.dismissal_restrictions": {
  4661. "type": "object"
  4662. },
  4663. "required_pull_request_reviews.dismissal_restrictions.teams": {
  4664. "type": "string[]"
  4665. },
  4666. "required_pull_request_reviews.dismissal_restrictions.users": {
  4667. "type": "string[]"
  4668. },
  4669. "required_pull_request_reviews.require_code_owner_reviews": {
  4670. "type": "boolean"
  4671. },
  4672. "required_pull_request_reviews.required_approving_review_count": {
  4673. "type": "integer"
  4674. },
  4675. "required_status_checks": {
  4676. "allowNull": true,
  4677. "required": true,
  4678. "type": "object"
  4679. },
  4680. "required_status_checks.contexts": {
  4681. "required": true,
  4682. "type": "string[]"
  4683. },
  4684. "required_status_checks.strict": {
  4685. "required": true,
  4686. "type": "boolean"
  4687. },
  4688. "restrictions": {
  4689. "allowNull": true,
  4690. "required": true,
  4691. "type": "object"
  4692. },
  4693. "restrictions.teams": { "required": true, "type": "string[]" },
  4694. "restrictions.users": { "required": true, "type": "string[]" }
  4695. },
  4696. "url": "/repos/:owner/:repo/branches/:branch/protection"
  4697. },
  4698. "updateCommitComment": {
  4699. "method": "PATCH",
  4700. "params": {
  4701. "body": { "required": true, "type": "string" },
  4702. "comment_id": { "required": true, "type": "integer" },
  4703. "owner": { "required": true, "type": "string" },
  4704. "repo": { "required": true, "type": "string" }
  4705. },
  4706. "url": "/repos/:owner/:repo/comments/:comment_id"
  4707. },
  4708. "updateFile": {
  4709. "deprecated": "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
  4710. "method": "PUT",
  4711. "params": {
  4712. "author": { "type": "object" },
  4713. "author.email": { "required": true, "type": "string" },
  4714. "author.name": { "required": true, "type": "string" },
  4715. "branch": { "type": "string" },
  4716. "committer": { "type": "object" },
  4717. "committer.email": { "required": true, "type": "string" },
  4718. "committer.name": { "required": true, "type": "string" },
  4719. "content": { "required": true, "type": "string" },
  4720. "message": { "required": true, "type": "string" },
  4721. "owner": { "required": true, "type": "string" },
  4722. "path": { "required": true, "type": "string" },
  4723. "repo": { "required": true, "type": "string" },
  4724. "sha": { "type": "string" }
  4725. },
  4726. "url": "/repos/:owner/:repo/contents/:path"
  4727. },
  4728. "updateHook": {
  4729. "method": "PATCH",
  4730. "params": {
  4731. "active": { "type": "boolean" },
  4732. "add_events": { "type": "string[]" },
  4733. "config": { "type": "object" },
  4734. "config.content_type": { "type": "string" },
  4735. "config.insecure_ssl": { "type": "string" },
  4736. "config.secret": { "type": "string" },
  4737. "config.url": { "required": true, "type": "string" },
  4738. "events": { "type": "string[]" },
  4739. "hook_id": { "required": true, "type": "integer" },
  4740. "owner": { "required": true, "type": "string" },
  4741. "remove_events": { "type": "string[]" },
  4742. "repo": { "required": true, "type": "string" }
  4743. },
  4744. "url": "/repos/:owner/:repo/hooks/:hook_id"
  4745. },
  4746. "updateInformationAboutPagesSite": {
  4747. "method": "PUT",
  4748. "params": {
  4749. "owner": { "required": true, "type": "string" },
  4750. "repo": { "required": true, "type": "string" },
  4751. "source": {
  4752. "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""],
  4753. "type": "string"
  4754. }
  4755. },
  4756. "url": "/repos/:owner/:repo/pages"
  4757. },
  4758. "updateInvitation": {
  4759. "method": "PATCH",
  4760. "params": {
  4761. "invitation_id": { "required": true, "type": "integer" },
  4762. "owner": { "required": true, "type": "string" },
  4763. "permissions": { "enum": ["read", "write", "admin"], "type": "string" },
  4764. "repo": { "required": true, "type": "string" }
  4765. },
  4766. "url": "/repos/:owner/:repo/invitations/:invitation_id"
  4767. },
  4768. "updateProtectedBranchPullRequestReviewEnforcement": {
  4769. "method": "PATCH",
  4770. "params": {
  4771. "branch": { "required": true, "type": "string" },
  4772. "dismiss_stale_reviews": { "type": "boolean" },
  4773. "dismissal_restrictions": { "type": "object" },
  4774. "dismissal_restrictions.teams": { "type": "string[]" },
  4775. "dismissal_restrictions.users": { "type": "string[]" },
  4776. "owner": { "required": true, "type": "string" },
  4777. "repo": { "required": true, "type": "string" },
  4778. "require_code_owner_reviews": { "type": "boolean" },
  4779. "required_approving_review_count": { "type": "integer" }
  4780. },
  4781. "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  4782. },
  4783. "updateProtectedBranchRequiredStatusChecks": {
  4784. "method": "PATCH",
  4785. "params": {
  4786. "branch": { "required": true, "type": "string" },
  4787. "contexts": { "type": "string[]" },
  4788. "owner": { "required": true, "type": "string" },
  4789. "repo": { "required": true, "type": "string" },
  4790. "strict": { "type": "boolean" }
  4791. },
  4792. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  4793. },
  4794. "updateRelease": {
  4795. "method": "PATCH",
  4796. "params": {
  4797. "body": { "type": "string" },
  4798. "draft": { "type": "boolean" },
  4799. "name": { "type": "string" },
  4800. "owner": { "required": true, "type": "string" },
  4801. "prerelease": { "type": "boolean" },
  4802. "release_id": { "required": true, "type": "integer" },
  4803. "repo": { "required": true, "type": "string" },
  4804. "tag_name": { "type": "string" },
  4805. "target_commitish": { "type": "string" }
  4806. },
  4807. "url": "/repos/:owner/:repo/releases/:release_id"
  4808. },
  4809. "updateReleaseAsset": {
  4810. "method": "PATCH",
  4811. "params": {
  4812. "asset_id": { "required": true, "type": "integer" },
  4813. "label": { "type": "string" },
  4814. "name": { "type": "string" },
  4815. "owner": { "required": true, "type": "string" },
  4816. "repo": { "required": true, "type": "string" }
  4817. },
  4818. "url": "/repos/:owner/:repo/releases/assets/:asset_id"
  4819. },
  4820. "uploadReleaseAsset": {
  4821. "method": "POST",
  4822. "params": {
  4823. "file": {
  4824. "mapTo": "data",
  4825. "required": true,
  4826. "type": "string | object"
  4827. },
  4828. "headers": { "required": true, "type": "object" },
  4829. "headers.content-length": { "required": true, "type": "integer" },
  4830. "headers.content-type": { "required": true, "type": "string" },
  4831. "label": { "type": "string" },
  4832. "name": { "required": true, "type": "string" },
  4833. "url": { "required": true, "type": "string" }
  4834. },
  4835. "url": ":url"
  4836. }
  4837. },
  4838. "search": {
  4839. "code": {
  4840. "method": "GET",
  4841. "params": {
  4842. "order": { "enum": ["desc", "asc"], "type": "string" },
  4843. "page": { "type": "integer" },
  4844. "per_page": { "type": "integer" },
  4845. "q": { "required": true, "type": "string" },
  4846. "sort": { "enum": ["indexed"], "type": "string" }
  4847. },
  4848. "url": "/search/code"
  4849. },
  4850. "commits": {
  4851. "headers": { "accept": "application/vnd.github.cloak-preview+json" },
  4852. "method": "GET",
  4853. "params": {
  4854. "order": { "enum": ["desc", "asc"], "type": "string" },
  4855. "page": { "type": "integer" },
  4856. "per_page": { "type": "integer" },
  4857. "q": { "required": true, "type": "string" },
  4858. "sort": { "enum": ["author-date", "committer-date"], "type": "string" }
  4859. },
  4860. "url": "/search/commits"
  4861. },
  4862. "issues": {
  4863. "deprecated": "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)",
  4864. "method": "GET",
  4865. "params": {
  4866. "order": { "enum": ["desc", "asc"], "type": "string" },
  4867. "page": { "type": "integer" },
  4868. "per_page": { "type": "integer" },
  4869. "q": { "required": true, "type": "string" },
  4870. "sort": {
  4871. "enum": [
  4872. "comments",
  4873. "reactions",
  4874. "reactions-+1",
  4875. "reactions--1",
  4876. "reactions-smile",
  4877. "reactions-thinking_face",
  4878. "reactions-heart",
  4879. "reactions-tada",
  4880. "interactions",
  4881. "created",
  4882. "updated"
  4883. ],
  4884. "type": "string"
  4885. }
  4886. },
  4887. "url": "/search/issues"
  4888. },
  4889. "issuesAndPullRequests": {
  4890. "method": "GET",
  4891. "params": {
  4892. "order": { "enum": ["desc", "asc"], "type": "string" },
  4893. "page": { "type": "integer" },
  4894. "per_page": { "type": "integer" },
  4895. "q": { "required": true, "type": "string" },
  4896. "sort": {
  4897. "enum": [
  4898. "comments",
  4899. "reactions",
  4900. "reactions-+1",
  4901. "reactions--1",
  4902. "reactions-smile",
  4903. "reactions-thinking_face",
  4904. "reactions-heart",
  4905. "reactions-tada",
  4906. "interactions",
  4907. "created",
  4908. "updated"
  4909. ],
  4910. "type": "string"
  4911. }
  4912. },
  4913. "url": "/search/issues"
  4914. },
  4915. "labels": {
  4916. "method": "GET",
  4917. "params": {
  4918. "order": { "enum": ["desc", "asc"], "type": "string" },
  4919. "q": { "required": true, "type": "string" },
  4920. "repository_id": { "required": true, "type": "integer" },
  4921. "sort": { "enum": ["created", "updated"], "type": "string" }
  4922. },
  4923. "url": "/search/labels"
  4924. },
  4925. "repos": {
  4926. "method": "GET",
  4927. "params": {
  4928. "order": { "enum": ["desc", "asc"], "type": "string" },
  4929. "page": { "type": "integer" },
  4930. "per_page": { "type": "integer" },
  4931. "q": { "required": true, "type": "string" },
  4932. "sort": {
  4933. "enum": ["stars", "forks", "help-wanted-issues", "updated"],
  4934. "type": "string"
  4935. }
  4936. },
  4937. "url": "/search/repositories"
  4938. },
  4939. "topics": {
  4940. "method": "GET",
  4941. "params": { "q": { "required": true, "type": "string" } },
  4942. "url": "/search/topics"
  4943. },
  4944. "users": {
  4945. "method": "GET",
  4946. "params": {
  4947. "order": { "enum": ["desc", "asc"], "type": "string" },
  4948. "page": { "type": "integer" },
  4949. "per_page": { "type": "integer" },
  4950. "q": { "required": true, "type": "string" },
  4951. "sort": {
  4952. "enum": ["followers", "repositories", "joined"],
  4953. "type": "string"
  4954. }
  4955. },
  4956. "url": "/search/users"
  4957. }
  4958. },
  4959. "teams": {
  4960. "addMember": {
  4961. "deprecated": "octokit.teams.addMember() is deprecated, see https://developer.github.com/enterprise/2.16/v3/teams/members/#add-team-member",
  4962. "method": "PUT",
  4963. "params": {
  4964. "team_id": { "required": true, "type": "integer" },
  4965. "username": { "required": true, "type": "string" }
  4966. },
  4967. "url": "/teams/:team_id/members/:username"
  4968. },
  4969. "addOrUpdateMembership": {
  4970. "method": "PUT",
  4971. "params": {
  4972. "role": { "enum": ["member", "maintainer"], "type": "string" },
  4973. "team_id": { "required": true, "type": "integer" },
  4974. "username": { "required": true, "type": "string" }
  4975. },
  4976. "url": "/teams/:team_id/memberships/:username"
  4977. },
  4978. "addOrUpdateProject": {
  4979. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  4980. "method": "PUT",
  4981. "params": {
  4982. "permission": { "enum": ["read", "write", "admin"], "type": "string" },
  4983. "project_id": { "required": true, "type": "integer" },
  4984. "team_id": { "required": true, "type": "integer" }
  4985. },
  4986. "url": "/teams/:team_id/projects/:project_id"
  4987. },
  4988. "addOrUpdateRepo": {
  4989. "method": "PUT",
  4990. "params": {
  4991. "owner": { "required": true, "type": "string" },
  4992. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  4993. "repo": { "required": true, "type": "string" },
  4994. "team_id": { "required": true, "type": "integer" }
  4995. },
  4996. "url": "/teams/:team_id/repos/:owner/:repo"
  4997. },
  4998. "checkManagesRepo": {
  4999. "method": "GET",
  5000. "params": {
  5001. "owner": { "required": true, "type": "string" },
  5002. "repo": { "required": true, "type": "string" },
  5003. "team_id": { "required": true, "type": "integer" }
  5004. },
  5005. "url": "/teams/:team_id/repos/:owner/:repo"
  5006. },
  5007. "create": {
  5008. "method": "POST",
  5009. "params": {
  5010. "description": { "type": "string" },
  5011. "ldap_dn": { "type": "string" },
  5012. "maintainers": { "type": "string[]" },
  5013. "name": { "required": true, "type": "string" },
  5014. "org": { "required": true, "type": "string" },
  5015. "parent_team_id": { "type": "integer" },
  5016. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  5017. "privacy": { "enum": ["secret", "closed"], "type": "string" },
  5018. "repo_names": { "type": "string[]" }
  5019. },
  5020. "url": "/orgs/:org/teams"
  5021. },
  5022. "createDiscussion": {
  5023. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5024. "method": "POST",
  5025. "params": {
  5026. "body": { "required": true, "type": "string" },
  5027. "private": { "type": "boolean" },
  5028. "team_id": { "required": true, "type": "integer" },
  5029. "title": { "required": true, "type": "string" }
  5030. },
  5031. "url": "/teams/:team_id/discussions"
  5032. },
  5033. "createDiscussionComment": {
  5034. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5035. "method": "POST",
  5036. "params": {
  5037. "body": { "required": true, "type": "string" },
  5038. "discussion_number": { "required": true, "type": "integer" },
  5039. "team_id": { "required": true, "type": "integer" }
  5040. },
  5041. "url": "/teams/:team_id/discussions/:discussion_number/comments"
  5042. },
  5043. "delete": {
  5044. "method": "DELETE",
  5045. "params": { "team_id": { "required": true, "type": "integer" } },
  5046. "url": "/teams/:team_id"
  5047. },
  5048. "deleteDiscussion": {
  5049. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5050. "method": "DELETE",
  5051. "params": {
  5052. "discussion_number": { "required": true, "type": "integer" },
  5053. "team_id": { "required": true, "type": "integer" }
  5054. },
  5055. "url": "/teams/:team_id/discussions/:discussion_number"
  5056. },
  5057. "deleteDiscussionComment": {
  5058. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5059. "method": "DELETE",
  5060. "params": {
  5061. "comment_number": { "required": true, "type": "integer" },
  5062. "discussion_number": { "required": true, "type": "integer" },
  5063. "team_id": { "required": true, "type": "integer" }
  5064. },
  5065. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  5066. },
  5067. "get": {
  5068. "method": "GET",
  5069. "params": { "team_id": { "required": true, "type": "integer" } },
  5070. "url": "/teams/:team_id"
  5071. },
  5072. "getDiscussion": {
  5073. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5074. "method": "GET",
  5075. "params": {
  5076. "discussion_number": { "required": true, "type": "integer" },
  5077. "team_id": { "required": true, "type": "integer" }
  5078. },
  5079. "url": "/teams/:team_id/discussions/:discussion_number"
  5080. },
  5081. "getDiscussionComment": {
  5082. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5083. "method": "GET",
  5084. "params": {
  5085. "comment_number": { "required": true, "type": "integer" },
  5086. "discussion_number": { "required": true, "type": "integer" },
  5087. "team_id": { "required": true, "type": "integer" }
  5088. },
  5089. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  5090. },
  5091. "getMember": {
  5092. "deprecated": "octokit.teams.getMember() is deprecated, see https://developer.github.com/enterprise/2.16/v3/teams/members/#get-team-member",
  5093. "method": "GET",
  5094. "params": {
  5095. "team_id": { "required": true, "type": "integer" },
  5096. "username": { "required": true, "type": "string" }
  5097. },
  5098. "url": "/teams/:team_id/members/:username"
  5099. },
  5100. "getMembership": {
  5101. "method": "GET",
  5102. "params": {
  5103. "team_id": { "required": true, "type": "integer" },
  5104. "username": { "required": true, "type": "string" }
  5105. },
  5106. "url": "/teams/:team_id/memberships/:username"
  5107. },
  5108. "list": {
  5109. "method": "GET",
  5110. "params": {
  5111. "org": { "required": true, "type": "string" },
  5112. "page": { "type": "integer" },
  5113. "per_page": { "type": "integer" }
  5114. },
  5115. "url": "/orgs/:org/teams"
  5116. },
  5117. "listChild": {
  5118. "headers": { "accept": "application/vnd.github.hellcat-preview+json" },
  5119. "method": "GET",
  5120. "params": {
  5121. "page": { "type": "integer" },
  5122. "per_page": { "type": "integer" },
  5123. "team_id": { "required": true, "type": "integer" }
  5124. },
  5125. "url": "/teams/:team_id/teams"
  5126. },
  5127. "listDiscussionComments": {
  5128. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5129. "method": "GET",
  5130. "params": {
  5131. "direction": { "enum": ["asc", "desc"], "type": "string" },
  5132. "discussion_number": { "required": true, "type": "integer" },
  5133. "page": { "type": "integer" },
  5134. "per_page": { "type": "integer" },
  5135. "team_id": { "required": true, "type": "integer" }
  5136. },
  5137. "url": "/teams/:team_id/discussions/:discussion_number/comments"
  5138. },
  5139. "listDiscussions": {
  5140. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5141. "method": "GET",
  5142. "params": {
  5143. "direction": { "enum": ["asc", "desc"], "type": "string" },
  5144. "page": { "type": "integer" },
  5145. "per_page": { "type": "integer" },
  5146. "team_id": { "required": true, "type": "integer" }
  5147. },
  5148. "url": "/teams/:team_id/discussions"
  5149. },
  5150. "listForAuthenticatedUser": {
  5151. "method": "GET",
  5152. "params": {
  5153. "page": { "type": "integer" },
  5154. "per_page": { "type": "integer" }
  5155. },
  5156. "url": "/user/teams"
  5157. },
  5158. "listMembers": {
  5159. "method": "GET",
  5160. "params": {
  5161. "page": { "type": "integer" },
  5162. "per_page": { "type": "integer" },
  5163. "role": { "enum": ["member", "maintainer", "all"], "type": "string" },
  5164. "team_id": { "required": true, "type": "integer" }
  5165. },
  5166. "url": "/teams/:team_id/members"
  5167. },
  5168. "listProjects": {
  5169. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  5170. "method": "GET",
  5171. "params": {
  5172. "page": { "type": "integer" },
  5173. "per_page": { "type": "integer" },
  5174. "team_id": { "required": true, "type": "integer" }
  5175. },
  5176. "url": "/teams/:team_id/projects"
  5177. },
  5178. "listRepos": {
  5179. "method": "GET",
  5180. "params": {
  5181. "page": { "type": "integer" },
  5182. "per_page": { "type": "integer" },
  5183. "team_id": { "required": true, "type": "integer" }
  5184. },
  5185. "url": "/teams/:team_id/repos"
  5186. },
  5187. "removeMember": {
  5188. "deprecated": "octokit.teams.removeMember() is deprecated, see https://developer.github.com/enterprise/2.16/v3/teams/members/#remove-team-member",
  5189. "method": "DELETE",
  5190. "params": {
  5191. "team_id": { "required": true, "type": "integer" },
  5192. "username": { "required": true, "type": "string" }
  5193. },
  5194. "url": "/teams/:team_id/members/:username"
  5195. },
  5196. "removeMembership": {
  5197. "method": "DELETE",
  5198. "params": {
  5199. "team_id": { "required": true, "type": "integer" },
  5200. "username": { "required": true, "type": "string" }
  5201. },
  5202. "url": "/teams/:team_id/memberships/:username"
  5203. },
  5204. "removeProject": {
  5205. "method": "DELETE",
  5206. "params": {
  5207. "project_id": { "required": true, "type": "integer" },
  5208. "team_id": { "required": true, "type": "integer" }
  5209. },
  5210. "url": "/teams/:team_id/projects/:project_id"
  5211. },
  5212. "removeRepo": {
  5213. "method": "DELETE",
  5214. "params": {
  5215. "owner": { "required": true, "type": "string" },
  5216. "repo": { "required": true, "type": "string" },
  5217. "team_id": { "required": true, "type": "integer" }
  5218. },
  5219. "url": "/teams/:team_id/repos/:owner/:repo"
  5220. },
  5221. "reviewProject": {
  5222. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  5223. "method": "GET",
  5224. "params": {
  5225. "project_id": { "required": true, "type": "integer" },
  5226. "team_id": { "required": true, "type": "integer" }
  5227. },
  5228. "url": "/teams/:team_id/projects/:project_id"
  5229. },
  5230. "update": {
  5231. "method": "PATCH",
  5232. "params": {
  5233. "description": { "type": "string" },
  5234. "name": { "required": true, "type": "string" },
  5235. "parent_team_id": { "type": "integer" },
  5236. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  5237. "privacy": { "enum": ["secret", "closed"], "type": "string" },
  5238. "team_id": { "required": true, "type": "integer" }
  5239. },
  5240. "url": "/teams/:team_id"
  5241. },
  5242. "updateDiscussion": {
  5243. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5244. "method": "PATCH",
  5245. "params": {
  5246. "body": { "type": "string" },
  5247. "discussion_number": { "required": true, "type": "integer" },
  5248. "team_id": { "required": true, "type": "integer" },
  5249. "title": { "type": "string" }
  5250. },
  5251. "url": "/teams/:team_id/discussions/:discussion_number"
  5252. },
  5253. "updateDiscussionComment": {
  5254. "headers": { "accept": "application/vnd.github.echo-preview+json" },
  5255. "method": "PATCH",
  5256. "params": {
  5257. "body": { "required": true, "type": "string" },
  5258. "comment_number": { "required": true, "type": "integer" },
  5259. "discussion_number": { "required": true, "type": "integer" },
  5260. "team_id": { "required": true, "type": "integer" }
  5261. },
  5262. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  5263. }
  5264. },
  5265. "users": {
  5266. "addEmails": {
  5267. "method": "POST",
  5268. "params": { "emails": { "required": true, "type": "string[]" } },
  5269. "url": "/user/emails"
  5270. },
  5271. "checkFollowing": {
  5272. "method": "GET",
  5273. "params": { "username": { "required": true, "type": "string" } },
  5274. "url": "/user/following/:username"
  5275. },
  5276. "checkFollowingForUser": {
  5277. "method": "GET",
  5278. "params": {
  5279. "target_user": { "required": true, "type": "string" },
  5280. "username": { "required": true, "type": "string" }
  5281. },
  5282. "url": "/users/:username/following/:target_user"
  5283. },
  5284. "createGpgKey": {
  5285. "method": "POST",
  5286. "params": { "armored_public_key": { "type": "string" } },
  5287. "url": "/user/gpg_keys"
  5288. },
  5289. "createPublicKey": {
  5290. "method": "POST",
  5291. "params": { "key": { "type": "string" }, "title": { "type": "string" } },
  5292. "url": "/user/keys"
  5293. },
  5294. "deleteEmails": {
  5295. "method": "DELETE",
  5296. "params": { "emails": { "required": true, "type": "string[]" } },
  5297. "url": "/user/emails"
  5298. },
  5299. "deleteGpgKey": {
  5300. "method": "DELETE",
  5301. "params": { "gpg_key_id": { "required": true, "type": "integer" } },
  5302. "url": "/user/gpg_keys/:gpg_key_id"
  5303. },
  5304. "deletePublicKey": {
  5305. "method": "DELETE",
  5306. "params": { "key_id": { "required": true, "type": "integer" } },
  5307. "url": "/user/keys/:key_id"
  5308. },
  5309. "follow": {
  5310. "method": "PUT",
  5311. "params": { "username": { "required": true, "type": "string" } },
  5312. "url": "/user/following/:username"
  5313. },
  5314. "getAuthenticated": { "method": "GET", "params": {}, "url": "/user" },
  5315. "getByUsername": {
  5316. "method": "GET",
  5317. "params": { "username": { "required": true, "type": "string" } },
  5318. "url": "/users/:username"
  5319. },
  5320. "getContextForUser": {
  5321. "headers": { "accept": "application/vnd.github.hagar-preview+json" },
  5322. "method": "GET",
  5323. "params": {
  5324. "subject_id": { "type": "string" },
  5325. "subject_type": {
  5326. "enum": ["organization", "repository", "issue", "pull_request"],
  5327. "type": "string"
  5328. },
  5329. "username": { "required": true, "type": "string" }
  5330. },
  5331. "url": "/users/:username/hovercard"
  5332. },
  5333. "getGpgKey": {
  5334. "method": "GET",
  5335. "params": { "gpg_key_id": { "required": true, "type": "integer" } },
  5336. "url": "/user/gpg_keys/:gpg_key_id"
  5337. },
  5338. "getPublicKey": {
  5339. "method": "GET",
  5340. "params": { "key_id": { "required": true, "type": "integer" } },
  5341. "url": "/user/keys/:key_id"
  5342. },
  5343. "list": {
  5344. "method": "GET",
  5345. "params": {
  5346. "page": { "type": "integer" },
  5347. "per_page": { "type": "integer" },
  5348. "since": { "type": "string" }
  5349. },
  5350. "url": "/users"
  5351. },
  5352. "listEmails": {
  5353. "method": "GET",
  5354. "params": {
  5355. "page": { "type": "integer" },
  5356. "per_page": { "type": "integer" }
  5357. },
  5358. "url": "/user/emails"
  5359. },
  5360. "listFollowersForAuthenticatedUser": {
  5361. "method": "GET",
  5362. "params": {
  5363. "page": { "type": "integer" },
  5364. "per_page": { "type": "integer" }
  5365. },
  5366. "url": "/user/followers"
  5367. },
  5368. "listFollowersForUser": {
  5369. "method": "GET",
  5370. "params": {
  5371. "page": { "type": "integer" },
  5372. "per_page": { "type": "integer" },
  5373. "username": { "required": true, "type": "string" }
  5374. },
  5375. "url": "/users/:username/followers"
  5376. },
  5377. "listFollowingForAuthenticatedUser": {
  5378. "method": "GET",
  5379. "params": {
  5380. "page": { "type": "integer" },
  5381. "per_page": { "type": "integer" }
  5382. },
  5383. "url": "/user/following"
  5384. },
  5385. "listFollowingForUser": {
  5386. "method": "GET",
  5387. "params": {
  5388. "page": { "type": "integer" },
  5389. "per_page": { "type": "integer" },
  5390. "username": { "required": true, "type": "string" }
  5391. },
  5392. "url": "/users/:username/following"
  5393. },
  5394. "listGpgKeys": {
  5395. "method": "GET",
  5396. "params": {
  5397. "page": { "type": "integer" },
  5398. "per_page": { "type": "integer" }
  5399. },
  5400. "url": "/user/gpg_keys"
  5401. },
  5402. "listGpgKeysForUser": {
  5403. "method": "GET",
  5404. "params": {
  5405. "page": { "type": "integer" },
  5406. "per_page": { "type": "integer" },
  5407. "username": { "required": true, "type": "string" }
  5408. },
  5409. "url": "/users/:username/gpg_keys"
  5410. },
  5411. "listPublicEmails": {
  5412. "method": "GET",
  5413. "params": {
  5414. "page": { "type": "integer" },
  5415. "per_page": { "type": "integer" }
  5416. },
  5417. "url": "/user/public_emails"
  5418. },
  5419. "listPublicKeys": {
  5420. "method": "GET",
  5421. "params": {
  5422. "page": { "type": "integer" },
  5423. "per_page": { "type": "integer" }
  5424. },
  5425. "url": "/user/keys"
  5426. },
  5427. "listPublicKeysForUser": {
  5428. "method": "GET",
  5429. "params": {
  5430. "page": { "type": "integer" },
  5431. "per_page": { "type": "integer" },
  5432. "username": { "required": true, "type": "string" }
  5433. },
  5434. "url": "/users/:username/keys"
  5435. },
  5436. "unfollow": {
  5437. "method": "DELETE",
  5438. "params": { "username": { "required": true, "type": "string" } },
  5439. "url": "/user/following/:username"
  5440. },
  5441. "updateAuthenticated": {
  5442. "method": "PATCH",
  5443. "params": {
  5444. "bio": { "type": "string" },
  5445. "blog": { "type": "string" },
  5446. "company": { "type": "string" },
  5447. "email": { "type": "string" },
  5448. "hireable": { "type": "boolean" },
  5449. "location": { "type": "string" },
  5450. "name": { "type": "string" }
  5451. },
  5452. "url": "/user"
  5453. }
  5454. }
  5455. }