all.json 188 KB

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